Skip to main content
The Invoice Credit Notes Data Model represents a financial transaction that can be applied against one or multiple invoices issued to customers. This unified model standardizes and simplifies the management of credit note information across various accounting platforms.
  • Unified credit note properties: Essential credit note details, such as contact ID, document number, total amount, and currency, are standardized across different accounting 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

​
Attributes

​
Invoice Credit Note Attributes

PropertyTypeDescription
rootfi_idintegerUnique identifier assigned by Commenda for this invoice credit note
rootfi_created_atstringTimestamp when this record was created in Commenda’s system (ISO 8601)
rootfi_updated_atstringTimestamp when this record was last updated in Commenda’s system (ISO 8601)
rootfi_company_idintegerCompany identifier this invoice credit note belongs to within Commenda
platform_idstringUnique identifier for this invoice credit note in the source accounting platform
platform_unique_idstringAlternative unique identifier from the platform (some platforms provide multiple IDs)
contact_idstringThe contact ID of the invoice credit note
currency_idstringThe currency ID of the invoice credit note
invoice_idsarrayThe invoice IDs associated with the invoice credit note
document_numberstringThe document number of the invoice credit note
total_amountdoubleThe total amount of the invoice credit note
remaining_creditdoubleThe remaining credit amount of the invoice credit note
posted_datestringThe posted date of the invoice credit note
statusenumThe status of the invoice credit note
memostringThe memo or notes of the invoice credit note
updated_atstringThe date and time the invoice credit note was last updated
line_itemsarrayThe line items of the invoice credit note

​
Status Enum Values

ValueDescription
draftInvoice credit note is in draft status and has not been finalized
submittedInvoice credit note has been submitted but not yet paid
partially_paidInvoice credit note has received partial payment
paidInvoice credit note has been fully paid
overdueInvoice credit note has passed its due date without payment
voidInvoice credit note has been voided or cancelled
unknownStatus cannot be determined from the platform

​
Expandable Attributes

Use the expand query parameter to include related objects:
  • expand=contact - Includes full Contact object details
  • expand=currency - Includes full Currency object details
  • expand=payments - Includes all InvoicePayment objects where this credit note has been applied
  • expand=line_items - Includes detailed LineItem objects

​
Properties Supported

PropertyTypeDescription
platform_idstringThe Platform’s ID for the credit note
contact_idstringThe contact ID of the invoice credit note
currency_idstringThe currency ID of the invoice credit note
invoice_idsarrayThe invoice IDs associated with the invoice credit note
document_numberstringThe document number of the invoice credit note
total_amountdoubleThe total amount of the invoice credit note
remaining_creditdoubleThe remaining credit amount of the invoice credit note
posted_datestringThe posted date of the invoice credit note
statusenumThe status of the invoice credit note
memostringThe memo or notes of the invoice credit note
line_itemsarrayThe line items of the invoice credit note
updated_atstringThe date and time the invoice credit note was last updated

​
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
{
  "rootfi_id": 123,
  "rootfi_created_at": "2024-01-25T09:00:00Z",
  "rootfi_updated_at": "2024-01-25T09:00:00Z",
  "rootfi_company_id": 456,
  "platform_id": "123456_1",
  "platform_unique_id": "123456",
  "invoice_ids": ["123456"],
  "contact_id": "123456",
  "currency_id": "123456",
  "document_number": "CN-00029",
  "total_amount": 49.0,
  "remaining_credit": 49.0,
  "posted_date": "2023-04-16T00:00:00.000Z",
  "status": "submitted",
  "memo": "Payment for Services",
  "updated_at": "2023-09-22T00:00:00.000Z",
  "line_items": []
}