Bill Credit Notes

A Bill Credit Note represents a refund or credit for goods or services that have been bought from a Vendors. For example, if a vendor was unable to complete an order that was placed by a business, or delivered invalid goods, they could issue a bill credit note.

The Bill Credit Note Object

Property

Type

Description

id

string

Unique identifier for the bill credit note.

vendor_id

string

Unique identifier for the vendor that's posting a bill credit note.

posted_at

string

The posted ISO 8601 date

allocated_at

string

The allocated ISO 8601 date

currency

string

The ISO-4217 currency code

currency_rate

number

Conversion rate between the currency of the bill credit note and the base currency.

line_items

object[]

Array of detailed information on each line item associated with the bill credit note. See example API response below.

total_discount

number

Total value of any discounts applied.

discount_percentage

number

Percentage rate of any discount applied to the bill credit note.

sub_total

number

Total amount of the bill credit note, including discounts but excluding tax.

tax_amount

number

Total tax amount of the bill credit note.

total_amount

number

Total amount of credit from the vendor including all discounts and tax.

remaining_credit

number

Outstanding amount for the bill credit note.

status

string

Current state of a bill credit note, one of:

  • draft
  • submitted
  • paid
  • void

memo

string

Description of the bill credit note.

payments

object[]

Array of associated payments for the bill credit note.

{
      "id": "1",
      "vendor_id": "1",
      "posted_at": "2021-03-09T10:18:29.985Z",
      "allocated_at": "2021-03-09T10:18:29.985Z",
      "currency": "USD",
      "currency_rate": 1.13,
      "line_items": [
        {
          "description": "Services rendered.",
          "unit_amount": 100.5,
          "quantity": 3,
          "discount_amount": 0,
          "sub_total": 301.5,
          "tax_amount": 20.5,
          "total_amount": 322,
          "discount_percentage": 10.5,
          "tax_rate_id": "123",
          "item_id": "1",
          "account_id": "132"
        }
      ],
      "total_discount": 322,
      "discount_percentage": 322,
      "sub_total": 301.5,
      "tax_amount": 20.5,
      "total_amount": 322,
      "remaining_credit": 322,
      "status": "open",
      "memo": "Example bill memo.",
      "payments": [
        {
          "amount": 50.5,
          "id": "50"
        }
      ]
    }