Bill Credit Notes

The Bill Credit Note Object

A Bill Credit Note is a financial transaction representing a refund or credit of payment or part of a payment for goods or services that have been bought from a Vendor. From the Bill Credit Notes endpoint, you can retrieve a list of all bill credit notes for a specified business.

Field

Type

Description

id

string

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

vendorRef

Reference Types

Vendor that issued the bill credit note.

postedDate
sortable

string
See Date

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

allocatedOnDate
sortable

string
See Date

Date the bill credit note was fully refunded or allocated.

currencyRef

Reference Types

Currency of the bill 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 bill credit note and the base currency of the business. Not applicable when multi-currency is not supported.

lines

array

An array of bill credit note lines.

status
sortable, filterable

string

Current status of a bill credit note.

subTotal

decimal

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

taxAmount

decimal

Any tax applied to the bill credit note amount.

totalAmount
sortable, filterable

decimal

Amount of the bill credit note, inclusive of tax.

remainingCredit
sortable, filterable

decimal

Amount of the bill credit note that is still outstanding.

discountPercentage

decimal

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

totalDiscount

decimal

Total value of any discounts applied.

memo

string

User-friendly reference for the bill credit note.

payments

array

An array of bill credit note payments.

sourceModifiedDate
sortable, filterable

string
See Date

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

Lines

FieldTypeDescription
descriptionstringFriendly name of the goods or services received.
unitAmountdecimalPrice of each unit of goods or services.
quantityintegerNumber of units of goods or services.
discountAmountdecimalNumerical value of any discounts applied.
discountPercentagedecimalPercentage rate (from 0 to 100) of any discounts applied to the unit amount.
subTotaldecimalAmount of the line, inclusive of discounts but exclusive of tax.
taxAmountdecimalAmount of tax for the line.
totalAmountdecimalTotal amount of the line, inclusive of discounts and tax.
accountRefReference TypesReference to the account to which the line item is linked to.
taxRateRefReference TypesReference to the tax rate to which the line item is linked to.
inventoryRefReference TypesReference to the product or inventory item to which the line item is linked to.
trackingCategoryRefReference TypesReference to the tracking category to which the line item is linked to.

Payments

Field

Type

Description

amount

decimal

Payment amount in the currency of the bill credit note.

paymentId

string

Identifier of the bill payments data type.

date

string
See Date.

Date of the payment.

Bill Credit Note Status

  • open - Bill Credit Note is no longer a draft. It has been processed and/or sent to the vendor. In this state, it will impact the ledger.
  • partiallyPaid - The remaining credit against the bill credit note is positive, but less than the total bill credit note amount.
  • paid - Bill Credit Note has been applied or refunded in full.
  • void - A Bill Credit Note can become void by being deleted, refunded, written off, or cancelled.
  • draft - Bill Credit Note is yet to be authorized and sent by the vendor, 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 bill credit note. This can be due to missing values in the accounting service provider or unavailable in the data we received.