An Invoice Credit Note is a financial transaction representing a reduction that can be applied against one or multiple invoices issued to Customers.
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 |
Property | Data Model | Description |
---|---|---|
contact | Contacts | The contact that made the credit note |
currency | Currencies | The currency of the credit note |
payments | Invoice Payments | The invoice payments where this credit note has been applied to |
addresses | Addresses | The addresses associated with the credit note |
line_items | Line Items | The line items associated with the credit note |
Property | Type | Description |
---|---|---|
platform_id | string | Platform's ID for the address |
type | enum | The type of address. Values are: BILLING , SHIPPING . |
data_model | string | The 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_id | string | The unique identifier for the data model associated with this address |
street | string | The street information of the address |
locality | string | The locality or neighborhood information of the address |
city | string | The city information of the address |
state | string | The state or region information of the address |
country | string | The country information of the address |
pincode | string | The postal or zip code of the address |
updated_at | date | The date and time at which the address information was last updated in the accounting platform |
Property | Type | Description |
---|---|---|
platform_id | string | Platform ID associated with this line item |
item_id | string | The platform ID of the item associated with this line item |
tax_id | string | The platform ID of the tax associated with this line item |
account_id | string | The platform ID of the account associated with this line item |
line_item_type | enum | The 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_id | string | The platform ID of the associated data model |
description | string | The description for this line item |
quantity | float | The quantity of the product/service for this line item |
unit_amount | float | Price per unit for this line item |
sub_total | float | The pre tax total value for this line item |
tax_amount | float | The tax amount for this line item |
total_amount | float | The total value of this line item |
tracking_category_ids | object | The tracking category Ids associated with this line item |
Property | Data Model | Description |
---|---|---|
item | Items | The item associated with this line item |
tax_rate | Tax Rates | The tax associated with this line item |
account | Accounts | The account associated to the invoice |