> ## 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 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 Notes Attributes

| Property                  | Type    | Description                                                                      |
| ------------------------- | ------- | -------------------------------------------------------------------------------- |
| `rootfi_id`               | integer | Unique identifier assigned by Commenda for this invoice credit note              |
| `rootfi_created_at`       | string  | Timestamp when this record was created in Commenda's system (ISO 8601)           |
| `rootfi_updated_at`       | string  | Timestamp when this record was last updated in Commenda's system (ISO 8601)      |
| `rootfi_integration_type` | enum    |                                                                                  |
| `platform_id`             | string  | Unique identifier for this invoice credit note in the source accounting platform |
| `contact_id`              | string  | The contact ID of the invoice credit note                                        |
| `document_number`         | string  | The document number of the invoice credit note                                   |
| `total_amount`            | double  | The total amount of the invoice credit note                                      |
| `total_discount`          | double  |                                                                                  |
| `remaining_credit`        | double  | The remaining credit amount of the invoice credit note                           |
| `shipping_amount`         | double  |                                                                                  |
| `posted_date`             | string  | The posted date of the invoice credit note                                       |
| `currency_id`             | enum    | ISO 4217 currency code                                                           |
| `memo`                    | string  | The memo or notes of the invoice credit note                                     |
| `status`                  | enum    | The status of the invoice credit note                                            |
| `invoice_ids`             | array   | The invoice IDs associated with the invoice credit note                          |
| `updated_at`              | string  | The date and time the invoice credit note was last updated                       |

### Status Enum Values

| Value            | Description                                                       |
| ---------------- | ----------------------------------------------------------------- |
| `DRAFT`          | Invoice credit note is in draft status and has not been finalized |
| `SUBMITTED`      | Invoice credit note has been submitted but not yet paid           |
| `PARTIALLY_PAID` | Invoice credit note has received partial payment                  |
| `PAID`           | Invoice credit note has been fully paid                           |
| `OVERDUE`        | Invoice credit note has passed its due date without payment       |
| `VOID`           | Invoice credit note has been voided or canceled                   |
| `UNKNOWN`        | Status cannot be determined from the platform                     |

## Expandable Attributes

Use the `expand` query parameter to include related objects:

* `expand=contact` — includes the related Contact object(s).
* `expand=currency` — includes the related Currency object(s).
* `expand=line_items` — includes the related Line Items object(s).

## Properties Supported

Fields accepted when creating or updating a record:

| Property           | Type   | Description                                                                      |
| ------------------ | ------ | -------------------------------------------------------------------------------- |
| `platform_id`      | string | Unique identifier for this invoice credit note in the source accounting platform |
| `contact_id`       | string | The contact ID of the invoice credit note                                        |
| `document_number`  | string | The document number of the invoice credit note                                   |
| `total_amount`     | double | The total amount of the invoice credit note                                      |
| `total_discount`   | double |                                                                                  |
| `remaining_credit` | double | The remaining credit amount of the invoice credit note                           |
| `shipping_amount`  | double |                                                                                  |
| `posted_date`      | string | The posted date of the invoice credit note                                       |
| `currency_id`      | enum   | ISO 4217 currency code                                                           |
| `memo`             | string | The memo or notes of the invoice credit note                                     |
| `status`           | enum   | The status of the invoice credit note                                            |
| `invoice_ids`      | array  | The invoice IDs associated with the invoice credit note                          |
| `updated_at`       | string | The date and time the invoice credit note was last updated                       |