> ## Documentation Index
> Fetch the complete documentation index at: https://integrations.docs.commenda.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Overview

> An Invoice Credit Note is a financial transaction representing a reduction that can be applied against one or multiple invoices issued to Customers.

**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

| Property          | Type   | Description                                                                                                             |
| ----------------- | ------ | ----------------------------------------------------------------------------------------------------------------------- |
| platform\_id      | string | The Platform's ID for the credit note                                                                                   |
| contact\_id       | string | The accounting platform's unique identifier for the contact associated with this credit note                            |
| currency\_id      | string | The Platform's ID of the currency for the credit note                                                                   |
| invoice\_ids      | object | An Array of invoice platform IDs associated with the credit note                                                        |
| document\_number  | string | Reference number for the credit note                                                                                    |
| total\_amount     | float  | Total amount of credit note                                                                                             |
| remaining\_credit | float  | The balance amount remaining on the credit note                                                                         |
| posted\_date      | date   | Date on which the credit note was posted                                                                                |
| status            | enum   | The status of the credit note. Values are: `DRAFT`, `SUBMITTED`, `PARTIALLY_PAID`, `PAID`, `OVERDUE`, `VOID`, `UNKNOWN` |
| memo              | string | Description of the credit note                                                                                          |
| updated\_at       | date   | The date at which the information was updated on the accounting platform                                                |

### Expandable Attributes

You can expand the following attributes to get the related data

| Property    | Data Model                                                                          | Description                                                     |
| ----------- | ----------------------------------------------------------------------------------- | --------------------------------------------------------------- |
| contact     | [Contacts](/api-reference/v3/accounting/contacts/overview)                          | The contact that made the credit note                           |
| currency    | [Currencies](/api-reference/v3/accounting/currencies/overview)                      | The currency of the credit note                                 |
| payments    | [Invoice Payments](/api-reference/v3/accounting/invoice-payments/overview)          | The invoice payments where this credit note has been applied to |
| addresses   | [Addresses](/api-reference/v3/accounting/invoice-credit-notes/overview#addresses)   | The addresses associated with the credit note                   |
| line\_items | [Line Items](/api-reference/v3/accounting/invoice-credit-notes/overview#line-items) | The line items associated with the credit note                  |

<Snippet file="addresses_snippet.mdx" />

<Snippet file="line_items_snippet.mdx" />

<ResponseExample name="The Invoice Credit Notes Object">
  ```json The Invoice Credit Notes Response Object theme={null}
  {
    "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"
  }
  ```
</ResponseExample>