Skip to content

Relationships

Schema relationships
graph LR
    CreditNotes -->|"contact"| Contacts
    CreditNotes -->|"company"| CompanyInfo
    CreditNotes -->|"payments"| Payments
    CreditNotes -->|"tracking_categories"| TrackingCategories

Properties

idstring
required·

The unique identifier for credit notes

companystring

The company of the credit note

References: CompanyInfo → id
contactstring

The contact of the credit note

References: Contacts → id
created_atstring · date-time

This represents the date when the credit note was created

currencystring

The currency of the credit note

line_itemsobject[]

The line items of the credit note

accountstring

The ID of the account

currencystring

The currency of the line item

descriptionstring

The description of the line item

exchange_ratenumber

The exchange rate of the currency for the line item

idstring

The unique identifier for line item

itemstring

The ID of the item

namestring

The name of the line item

quantitynumber

The quantity of the line item

tax_ratestring

The ID of the tax rate

total_line_amountnumber

The total line amount of the line item.

tracking_categoriesobject[]

Tracking categories of the line item

3 properties
idstring

The ID of the tracking category

namestring

The name of the tracking category

optionstring

The option of the tracking category

typestring

The type of the line item

unit_pricenumber

The unit price of the line item

numberstring

The number of the credit note

paymentsstring[]

The payments of the credit note

References: Payments → id
remaining_creditnumber

The remaining credit of the credit note

remote_dataRecord<string, any>

Raw data returned from the remote API call.

statusstring

The status of the credit note

Possible values:
paidsubmittedauthorisedvoided
total_amountnumber

The total amount of the credit note

tracking_categoriesobject[]

Tracking categories of the credit notes

idstring

The ID of the tracking category

namestring

The name of the tracking category

optionstring

The option of the tracking category

transaction_datestring · date-time

The transaction date of the credit note

updated_atstring · date-time

This represents the date when the credit note was updated