Invoice Credit Notes

An Invoice Credit Note is a financial transaction representing a reduction that can be applied against one or multiple invoices issued to Customers. From the Invoice Credit Notes endpoint, you can retrieve a list of all invoice credit notes for a specified business.

The Invoice Credit Note Object

Property

Type

Description

id

string

Unique ID for the invoice credit note.

posted_at

string

The posted date in ISO 8601

allocated_at

string

The allocated date in ISO 8601

currency

string

The ISO-4217 currency code

currency_rate

number

Rate between the currency of the invoice and the base currency.

line_items

object[]

Array of line items in the invoice credit note.

total_discount

number

Total discount amount.

discount_percentage

number

Percentage of discount given to a customer

sub_total

number

Total invoice credit note amount, excluding taxes

tax_amount

number

Total tax amount.

total_amount

number

Total amount of the invoice credit note.

remaining_credit

number

Amount outstanding for the credit note.

status

string

Current state of a credit note, one of:

  • draft
  • submitted
  • paid
  • partially_paid
  • void
  • unknown

memo

string

Description.

payments

object[]

Array of payment objects associated with the invoice credit note.

{
      "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,
          "item_id": "12",
          "account_id": "123"
        }
      ],
      "total_discount": 322,
      "discount_percentage": 322,
      "sub_total": 301.5,
      "tax_amount": 20.5,
      "total_amount": 322,
      "remaining_credit": 322,
      "status": "open",
      "memo": "Example memo.",
      "payments": [
        {
          "amount": 50.5,
          "id": "50"
        }
      ]
    }