The Bill Credit Note object
Beta API Versions
API versions labelled as Beta are not subject to our standard versioning policy. As such, they may undergo small breaking changes until they are transitioned to the stable version. We encourage you to exercise caution when using Beta API versions and take the necessary steps to ensure a smooth integration into your applications
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 sortable, filterable | string | Identifier for the bill credit note, unique for the business in the accounting service. |
| vendorRef | Reference Types | Reference to the vendor that issued the bill credit note. |
| postedDate sortable, filterable | string See Date | Date on which the bill 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 bill credit note was fully refunded or allocated. |
| currency | string | ISO-4217 currency code of the bill 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 bill credit note lines. |
| totalDiscount sortable, filterable | decimal | Total amount of discounts applied to the bill credit note. |
| discountPercentage sortable, filterable | decimal | Discount percentage applied to the bill credit note. |
| subTotal sortable, filterable | decimal | Amount of the bill credit note, inclusive of discounts but exclusive of tax. |
| taxAmount sortable, filterable | decimal | Any tax applied to the bill credit note amount. |
| totalAmount sortable, filterable | decimal | Amount of tax on the bill credit note. |
| remainingCredit sortable, filterable | decimal | Amount of the bill credit note that is still outstanding. |
| status sortable, filterable | string | Current status of a bill credit note. |
| memo | string | Any additional information or business notes about the bill 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. |
| 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. |
| trackingCategoryRefs | Reference Types | Reference to the tracking category to which the line item is linked to. |
Payments
| Field | Type | Description |
|---|---|---|
| amount sortable, filterable | decimal | Payment amount in the currency of the bill credit note. |
| paymentId sortable, filterable | string | Identifier of the bill payments data type. |
| date sortable, filterable | 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.