CreditNotes Object

---

id

string

REQUIRED · 

The unique identifier for credit notes

number

string

The number of the credit note

status

string

The status of the credit note

All possible enum values:

• paid
• submitted
• authorised
• voided

transaction_date

string · date-time

The transaction date of the credit note

contact

string

The contact of the credit note

company

string

The company of the credit note

total_amount

number

The total amount of the credit note

remaining_credit

number

The remaining credit of the credit note

line_items

object[]

The line items of the credit note

id

string

The unique identifier for line item

name

string

The name of the line item

description

string

The description of the line item

item

string

The ID of the item

account

string

The ID of the account

quantity

number

The quantity of the line item

unit_price

number

The unit price of the line item

tax_rate

string

The ID of the tax rate

total_line_amount

number

The total line amount of the line item.

type

string

The type of the line item

tracking_categories

object[]

Tracking categories of the line item

id

string

The ID of the tracking category

name

string

The name of the tracking category

option

string

The option of the tracking category

currency

string

The currency of the line item

exchange_rate

number

The exchange rate of the currency for the line item

currency

string

The currency of the credit note

payments

string[]

The payments of the credit note

created_at

string · date-time

This represents the date when the credit note was created

updated_at

string · date-time

This represents the date when the credit note was updated

tracking_categories

object[]

Tracking categories of the credit notes

id

string

The ID of the tracking category

name

string

The name of the tracking category

option

string

The option of the tracking category

remote_data

object

Raw data returned from the remote API call.