The Invoice Credit Note object
An Invoice Credit Note is a financial transaction representing a reduction that can be applied against one or multiple invoices issued to a Customers. From the Invoice Credit Notes endpoint, you can retrieve a list of all invoice credit notes for a specified business.
| Field | Type | Description |
|---|---|---|
| id sortable, filterable | string | Identifier for the invoice credit note, unique for the business in the accounting service. |
| customerRef | Reference Types | Reference to the customer the invoice credit note was issued to. |
| postedDate sortable, filterable | string See Date | Date on which the invoice credit note was posted to the accounting service, and had an impact on the general ledger. This may be different from the creation date. |
| allocatedOnDate sortable, filterable | string See Date | Date the invoice credit note was fully refunded or allocated. |
| currency | string | ISO-4217 currency code of the invoice credit note. |
| currencyRate | decimal | Rate to convert the total amount of the transaction into the base currency for the business at the time of the transaction. |
| lines | array | An array of invoice credit note lines. |
| totalDiscount sortable, filterable | decimal | Total amount of discounts applied to the invoice credit note. |
| discountPercentage sortable, filterable | decimal | Discount percentage applied to the invoice credit note. |
| subTotal sortable, filterable | decimal | Amount of the invoice credit note, inclusive of discounts but exclusive of tax. |
| taxAmount | decimal | Amount of tax on the invoice credit note. |
| totalAmount sortable, filterable | decimal | Total amount of the invoice credit note, inclusive of tax. |
| remainingCredit sortable, filterable | decimal | Amount of the invoice credit note that is still outstanding. |
| status sortable, filterable | string | Current status of an invoice credit note. |
| memo | string | Any additional information or business notes about the invoice credit note. |
| payments | array | An array of payment allocations. |
| sourceModifiedDate sortable, filterable | string See Date | The date on which this record was last modified in the accounting service. |
Lines
| Field | Type | Description |
|---|---|---|
| description | string | Description of the line item. |
| unitAmount sortable, filterable | decimal | Line item unit amount. |
| quantity sortable, filterable | integer | Line item quantity. |
| discountAmount sortable, filterable | decimal | Line item discount amount. |
| discountPercentage sortable, filterable | decimal | Line item discount percentage. |
| taxAmount sortable, filterable | decimal | Line item tax amount. |
| amount sortable, filterable | decimal | Line item total amount, inclusive of discounts & tax. |
| accountRef | Reference Types | Reference to the account the line item is linked to. |
| taxRateRef | Reference Types | Reference to the tax rate the line item is linked to. |
| inventoryRef | Reference Types | Reference to the product or inventory the line item is linked to. |
| trackingCategoryRefs | Reference Types | Reference to the tracking categories associated with this line item, e.g. classes or departments. |
Payments
| Field | Type | Description |
|---|---|---|
| amount sortable, filterable | decimal | Total amount that was paid. |
| paymentId sortable, filterable | string | Identifier of the allocated payment. |
| date sortable, filterable | string See Date. | Date of the payment. |
Invoice Credit Note Status
open- Invoice Credit Note is no longer a draft. It has been processed and/or sent to the customer. In this state, it will impact the ledger.partiallyPaid- The remaining credit against the invoice credit note is positive, but less than the total invoice credit note amount.paid- Invoice Credit Note has been applied or refunded in full.void- A Invoice Credit Note can become void by being deleted, refunded, written off, or cancelled.draft- Invoice Credit Note is yet to be authorized and sent by the customer, and will not be used in any reports. It may contain incomplete line items.unknown- Railz was not able to recognize the status of the invoice credit note. This can be due to missing values in the accounting service provider or unavailable in the data we received.