- 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
Bill Credit Notes Attributes
| Property | Type | Description |
|---|---|---|
rootfi_id | integer | Unique identifier assigned by Commenda for this bill 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 bill credit note in the source accounting platform |
contact_id | string | The contact ID of the bill credit note |
document_number | string | The document number of the bill credit note |
total_amount | double | The total amount of the bill credit note |
remaining_credit | double | The remaining credit amount of the bill credit note |
posted_date | string | The posted date of the bill credit note |
currency_id | enum | ISO 4217 currency code |
memo | string | The memo or notes of the bill credit note |
status | enum | The status of the bill credit note |
bill_ids | array | The bill IDs associated with the bill credit note |
updated_at | string | The date and time the bill credit note was last updated |
Status Enum Values
| Value | Description |
|---|---|
DRAFT | Bill credit note is in draft status and has not been finalized |
SUBMITTED | Bill credit note has been submitted but not yet paid |
PARTIALLY_PAID | Bill credit note has received partial payment |
PAID | Bill credit note has been fully paid |
OVERDUE | Bill credit note has passed its due date without payment |
VOID | Bill credit note has been voided or canceled |
UNKNOWN | Status cannot be determined from the platform |
Expandable Attributes
Use theexpand 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 bill credit note in the source accounting platform |
contact_id | string | The contact ID of the bill credit note |
document_number | string | The document number of the bill credit note |
total_amount | double | The total amount of the bill credit note |
remaining_credit | double | The remaining credit amount of the bill credit note |
posted_date | string | The posted date of the bill credit note |
currency_id | enum | ISO 4217 currency code |
memo | string | The memo or notes of the bill credit note |
status | enum | The status of the bill credit note |
bill_ids | array | The bill IDs associated with the bill credit note |
updated_at | string | The date and time the bill credit note was last updated |