{
  "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": null,
  "currency": {
    "data": {
      "platform_id": "3770712000000000099",
      "name": "Indian Rupee",
      "code": "INR",
      "symbol": "₹",
      "is_base_currency": true,
      "exchange_rate": 0,
      "updated_at": "2023-09-22T00:00:00.000Z"
    }
  },
  "line_items": {
    "data": [
      {
        "platform_id": "1234567890123456789",
        "line_item_type": "EXPENSE",
        "line_item_type_id": "1234567890123456789",
        "tracking_category_ids": [],
        "item_id": "1234567890123456789",
        "tax_id": null,
        "account_id": "1234567890123456789",
        "description": "Line Items Description",
        "quantity": 123,
        "unit_amount": 150.0,
        "total_amount": 150.0,
        "sub_total": 150.0,
        "tax_amount": 0,
        "total_discount": 0,
        "updated_at": "2023-02-17T00:00:00.000Z"
      }
    ]
  },
  "updated_at": "2023-09-22T00:00:00.000Z"
}

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.

​
Attributes

​
platform_id
string
required

The accounting Platform’s ID for the credit note

​
invoice_id
string[]
required

An Array of Invoices Id’s associated with the credit note

​
contact_id
string
required

The accounting platform’s unique identifier for the contact associated with this credit note

​
currency_id
string

The Accounting Platform’s unique ID for the currency

​
document_number
string
required

Reference number for the credit note

​
total_amount
float
required

Total amount of credit note

​
remaining_credit
float
required

The balance amount remaining on the credit note

​
posted_date
date
required

Date on which the credit note was posted

​
status
enum
required

The status of the credit note. Values are: DRAFT, SUBMITTED, PARTIALLY_PAID, PAID, OVERDUE, VOID, UNKNOWN.

​
memo
string
required

Description of the credit note

​
currency
string
required

Currency of the credit note

​
line_Items
Line Item
required

An array of Credit Note Line Items

​
updated_at
date
required

The last ISO 8601 timestamp that the data was updated at

​
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
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
currencystringCurrency of the credit note
line_ItemsLine ItemAn array of Credit Note Line Items
invoicesInvoicesAn Array of Invoices associated with the credit note
contactContactThe contact associated with this credit note
updated_atdateThe last ISO 8601 timestamp that the data was updated at
{
  "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": null,
  "currency": {
    "data": {
      "platform_id": "3770712000000000099",
      "name": "Indian Rupee",
      "code": "INR",
      "symbol": "₹",
      "is_base_currency": true,
      "exchange_rate": 0,
      "updated_at": "2023-09-22T00:00:00.000Z"
    }
  },
  "line_items": {
    "data": [
      {
        "platform_id": "1234567890123456789",
        "line_item_type": "EXPENSE",
        "line_item_type_id": "1234567890123456789",
        "tracking_category_ids": [],
        "item_id": "1234567890123456789",
        "tax_id": null,
        "account_id": "1234567890123456789",
        "description": "Line Items Description",
        "quantity": 123,
        "unit_amount": 150.0,
        "total_amount": 150.0,
        "sub_total": 150.0,
        "tax_amount": 0,
        "total_discount": 0,
        "updated_at": "2023-02-17T00:00:00.000Z"
      }
    ]
  },
  "updated_at": "2023-09-22T00:00:00.000Z"
}
OverviewGet All Invoice Credit Notes