Skip to main content
The Invoice Credit Notes Data Model is designed to standardise and simplify the management of credit note information across various accounting platforms.
  • Unified credit note properties: The model consolidates essential credit note details, such as customer ID, document number, total amount, and currency, making it easier to work with credit note data from different platforms.
  • Detailed status tracking: The model supports various credit note statuses, including draft, submitted, partially paid, paid, overdue, void, and unknown, for better organisation and reporting.
  • Line item integration: Credit notes can include an array of associated line items, ensuring comprehensive representation of credit note details and relationships to other data models.

​
Properties Supported

PropertyTypeDescription
platform_idstringThe Platform’s ID for the credit note
contact_idstringThe accounting platform’s unique identifier for the contact associated with this credit note
currency_idstringThe Platform’s ID of the currency for the credit note
invoice_idsobjectAn Array of invoice platform IDs associated with the credit note
document_numberstringReference number for the credit note
total_amountfloatTotal amount of credit note
remaining_creditfloatThe balance amount remaining on the credit note
posted_datedateDate on which the credit note was posted
statusenumThe status of the credit note. Values are: DRAFT, SUBMITTED, PARTIALLY_PAID, PAID, OVERDUE, VOID, UNKNOWN
memostringDescription of the credit note
updated_atdateThe date at which the information was updated on the accounting platform

​
Expandable Attributes

You can expand the following attributes to get the related data
PropertyData ModelDescription
contactContactsThe contact that made the credit note
currencyCurrenciesThe currency of the credit note
paymentsInvoice PaymentsThe invoice payments where this credit note has been applied to
addressesAddressesThe addresses associated with the credit note
line_itemsLine ItemsThe line items associated with the credit note

​
Addresses

PropertyTypeDescription
platform_idstringPlatform's ID for the address
typeenumThe type of address. Values are: BILLING, SHIPPING.
data_modelstringThe data model to which this address is linked. Values are COMPANY_INFO, CONTACTS, INVOICES, BILLS, EXPENSES, BILL_CREDIT_NOTES, INVOICE_CREDIT_NOTES, SALES_ORDERS, PURCHASE_ORDERS
data_model_idstringThe unique identifier for the data model associated with this address
streetstringThe street information of the address
localitystringThe locality or neighborhood information of the address
citystringThe city information of the address
statestringThe state or region information of the address
countrystringThe country information of the address
pincodestringThe postal or zip code of the address
updated_atdateThe date and time at which the address information was last updated in the accounting platform

​
Line Items

PropertyTypeDescription
platform_idstringPlatform ID associated with this line item
item_idstringThe platform ID of the item associated with this line item
tax_idstringThe platform ID of the tax associated with this line item
account_idstringThe platform ID of the account associated with this line item
line_item_typeenumThe data model linked to the line item. Values are: BILLS, INVOICES, INVOICE_CREDIT_NOTES, BILL_CREDIT_NOTES, EXPENSES, PURCHASE_ORDERS,SALES_ORDERS,GOODS_RECEIPT_NOTES
line_item_type_idstringThe platform ID of the associated data model
descriptionstringThe description for this line item
quantityfloatThe quantity of the product/service for this line item
unit_amountfloatPrice per unit for this line item
sub_totalfloatThe pre tax total value for this line item
tax_amountfloatThe tax amount for this line item
total_amountfloatThe total value of this line item
tracking_category_idsobjectThe tracking category Ids associated with this line item

​
Line Items Expandable Attributes

You can expand the following attributes to get the related line item data
PropertyData ModelDescription
itemItemsThe item associated with this line item
tax_rateTax RatesThe tax associated with this line item
accountAccountsThe account associated to the invoice
{
  "platform_id": "3770712000001365001",
  "invoice_ids": ["3770712000001365001"],
  "contact_id": "3770712000000225001",
  "currency_id": "3770712000000000099",
  "document_number": "CN-00029",
  "total_amount": 49,
  "remaining_credit": 49,
  "posted_date": "2023-04-16T00:00:00.000Z",
  "status": "SUBMITTED",
  "memo": "Payment for Services",
  "updated_at": "2023-09-22T00:00:00.000Z"
}