Invoice Credit Notes

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.

FieldTypeDescription
id
sortable, filterable
string Identifier for the invoice credit note, unique for the business in the accounting service.
customerRefReference TypesReference 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 stringISO-4217 currency code of the invoice credit note.
currencyRate decimalRate to convert the total amount of the transaction into the base currency for the business at the time of the transaction.
lines arrayAn array of invoice credit note lines.
totalDiscount
sortable, filterable
decimalTotal amount of discounts applied to the invoice credit note.
discountPercentage
sortable, filterable
decimalDiscount percentage applied to the invoice credit note.
subTotal
sortable, filterable
decimalAmount of the invoice credit note, inclusive of discounts but exclusive of tax.
taxAmountdecimalAmount of tax on the invoice credit note.
totalAmount
sortable, filterable
decimalTotal amount of the invoice credit note, inclusive of tax.
remainingCredit
sortable, filterable
decimalAmount of the invoice credit note that is still outstanding.
status
sortable, filterable
stringCurrent status of an invoice credit note.
memo stringAny additional information or business notes about the invoice credit note.
payments arrayAn array of payment allocations.
sourceModifiedDate
sortable, filterable
string
See Date
The date on which this record was last modified in the accounting service.

Lines

FieldTypeDescription
descriptionstringDescription of the line item.
unitAmount
sortable, filterable
decimalLine item unit amount.
quantity
sortable, filterable
integerLine item quantity.
discountAmount
sortable, filterable
decimalLine item discount amount.
discountPercentage
sortable, filterable
decimalLine item discount percentage.
taxAmount
sortable, filterable
decimalLine item tax amount.
amount
sortable, filterable
decimalLine item total amount, inclusive of discounts & tax.
accountRefReference TypesReference to the account the line item is linked to.
taxRateRefReference TypesReference to the tax rate the line item is linked to.
inventoryRefReference TypesReference to the product or inventory the line item is linked to.
trackingCategoryRefsReference TypesReference to the tracking categories associated with this line item, e.g. classes or departments.

Payments

FieldTypeDescription
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.