Invoice Credit Notes

An invoice credit note is issued to a customer to record credit.

Overview

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. See Invoice Credit Notes endpoint for more details.

Data Model

Field

Type

Description

id

string

Identifier for the invoice credit notes, unique to the business in the accounting service provider.

customerRef

Reference Types

Reference to the customer the invoice has been issued to.

postedDate
sortable

string
See Date

Date of the invoice credit note as recorded in the accounting service provider.

allocatedOnDate
sortable

string
See Date

Date the invoice credit note was fully refunded or allocated.

currencyRef

Reference Types

Currency of the invoice credit note.

Pushing data will fail if the business has not enabled or does not support multiple currency. Leaving this blank would default to the business' default currency.

currencyRate

decimal

Rate between the currency of the invoice credit note and the base currency of the business. Not applicable when multi-currency is not supported.

lines

array

An array of invoice credit note lines.

status
sortable, filterable

string

Current status of an invoice credit note.

subTotal

decimal

Value of the invoice credit note, including discounts and excluding tax.

taxAmount

decimal

Any tax applied to the invoice credit note amount.

totalAmount
sortable, filterable

decimal

Amount of the invoice credit note, inclusive of tax.

remainingCredit
sortable, filterable

decimal

Amount of the invoice credit note that is still outstanding.

discountPercentage

decimal

Percentage rate of any discount applied to the invoice credit note.

totalDiscount

decimal

Total value of any discounts applied.

memo

string

User-friendly reference for the invoice credit note.

payments

array

An array of invoice credit note payments.

sourceModifiedData

string
See Date

Date the record was last changed in the accounting service provider.

Lines

Field

Type

Description

description

string

Friendly name of the goods or services received.

unitAmount

decimal

Price of each unit of goods or services.

quantity

decimal

Number of units of goods or services.

discountAmount

decimal

Numerical value of any discounts applied.

discountPercentage

decimal

Percentage rate (from 0 to 100) of any discounts applied to the unit amount.

subTotal

decimal

Amount of the line, inclusive of discounts but exclusive of tax.

taxAmount

decimal

Amount of tax for the line.

totalAmount

decimal

Total amount of the line, inclusive of discounts and tax.

accountRef

Reference Types

Reference to the account to which the line item is linked to.

taxRateRef

Reference Types

Reference to the tax rate to which the line item is linked to.

inventoryRef

Reference Types

Reference to the product or inventory item to which the line item is linked to.

Payments

Field

Type

Description

amount

decimal

Payment amount in the currency of the invoice credit note.

paymentId

string

Identifier of the invoice payments data type.

date

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.

Example Data

{
  "data":
  [
    {
      "id": "1",
      "customerRef":
      {
        "id": "1",
        "name": "Railz Financial"
      },      
      "postedDate": "2021-03-09T10:18:29.985Z",
      "allocatedOnDate": "2021-03-09T10:18:29.985Z",
      "currencyRef":
      {
        "id": "CAD",
        "name": "Canadian Dollar"
      },
      "currencyRate": 1.13,
      "lines":
      [
        {
          "description": "Services rendered.",
          "unitAmount": 100.5,
          "quantity": 3,
          "discountAmount": 0,
          "subTotal": 301.5,
          "taxAmount": 20.5,
          "totalAmount": 322,
          "discountPercentage": 10.5,
          "taxRateRef":
          {
            "id": "1",
            "name": "HST",
            "effectiveTaxRate": 13
          },
          "inventoryRef":
          {
            "id": "1",
            "name": "Digital Services"
          },
          "accountRef":
          {
            "id": "145",
            "name": "Depreciation Expense"
          }
        }
      ],
      "totalDiscount": 322,
      "discountPercentage": 322,
      "subTotal": 301.5,
      "taxAmount": 20.5,
      "totalAmount": 322,
      "remainingCredit": 322,
      "status": "open",
      "memo": "Example invoice memo.",
      "payments":
      [
        {
          "amount": 50.5,
          "paymentId": "50",
          "date": "2021-03-09T10:18:29.985Z"
        }
      ],
      "sourceModifiedDate": "2021-03-09T10:18:29.985Z"
    }
  ]
}

Did this page help you?