Bill credit notes

Explore the Bill Credit Notes endpoints in Swagger.

View the coverage for bill credit notes in the Data Coverage Explorer.

Overview

A bill credit note is issued by a supplier for the purpose of recording credit. For example, if a supplier was unable to fulfil an order that was placed by a business, or delivered damaged goods, they would issue a bill credit note. A bill credit note reduces the amount a business owes to the supplier. It can be refunded to the business or used to pay off future bills.

In the Codat API, a bill credit note is an accounts payable record issued by a supplier.

A bill credit note includes details of:

  • The original and remaining credit.
  • Any allocations of the credit against other records, such as bills.
  • The supplier that issued the bill credit note.

Data model

Field

Type

Description

id

string

Identifier for the bill credit note that is unique to a company in the accounting platform.

billCreditNoteNumber

string

Friendly reference for the bill credit note.

supplierRef

reference type

Supplier that issued the bill credit note.

totalAmount

decimal

Total amount of credit that has been applied to the business' account with the supplier, including discounts and tax.

totalDiscount

decimal

Total value of any discounts applied.

subTotal

decimal

Total amount of the bill credit note, including discounts but excluding tax.

totalTaxAmount

decimal

Amount of tax included in the bill credit note.

discountPercentage

decimal

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

remainingCredit

decimal

Amount of the bill credit note that is still outstanding.

status

string

Current state of the bill credit note, either:

  • Draft - Not yet confirmed in the accounting system

  • Submitted - Confirmed and with an outstanding balance

  • Paid - Allocated or refunded in full

  • Void - Invalid or void

issueDate

string
See date

Date the bill credit note was issued by the supplier.

allocatedOnDate

string
See date

Date the bill credit note was fully refunded or allocated.

currency

string
See currency

Currency of the bill credit note.

currencyRate

decimal
See currency rate

Conversion rate between the currency of the bill credit note and the base currency of the company.

lineItems

An array of BillCreditNoteLineItems.

paymentAllocations

An array of CreditNotePaymentAllocations.

modifiedDate

string
See date

Date the record was last updated in the Codat system.

sourceModifiedDate

string
See date

Date the record was last updated in the accounting system.

note

string

Any additional information about the bill credit note.

Line items

Details of each line of the bill credit note.

Field

Type

Description

description

string

Friendly name of each line item. For example, the goods or service for which credit has been received.

unitAmount

decimal

Unit price of the goods or service.

quantity

decimal

Number of units of the goods or service for which credit has been received.

discountAmount

decimal

Value of any discounts applied.

subTotal

decimal

Amount of credit associated with the line item, including discounts but excluding tax.

taxAmount

decimal

Amount of tax associated with the line item.

totalAmount

decimal

Total amount of the line item, including discounts and tax.

accountRef

reference type

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

discountPercentage

decimal

Percentage rate of any discount applied to the line item.

taxRateRef

reference type

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

itemRef

reference type

Reference to the item the line is linked to.

trackingCategoryRefs

reference type

Reference to the tracking categories to which the line item is linked.

Payment allocations

Field

Type

Description

payment

id

string

note

string

reference

string

accountRef

Reference type

currency

string
See currency

currencyRate

decimal
See currency rate

paidOnDate

string
See date

totalAmount

decimal

allocation

currency

string
See currency

currencyRate

decimal
See currency rate

allocatedOnDate

string
See date

totalAmount

decimal

🚧

Requirements for reference fields

The reference fields customerRef, accountRef, and taxRateRef are only populated if the corresponding data type has been synchronised. If you see null values for these fields, please complete a new sync for the corresponding data type. For example, sync the customers data type for customerRef.

Example data

{
    "id": "6a0e9dfb-87b0-47d3-aaaf-9753ae9e757d",
    "billCreditNoteNumber": "14763237",
    "totalAmount": 693,
    "remainingCredit": 693,
    "status": "Submitted",
    "issueDate": "2019-02-18T16:03:07.268Z",
  "note": "Track separately",  
    "currency": "USD",
    "lineItems": [
        {
            "description": "AcmeMagnet",
            "unitAmount": 25,
            "discountAmount": 0,
            "quantity": 4,
            "subTotal": 100,
            "taxAmount": 10,
            "totalAmount": 110,
            "itemRef": {
                "id": "3"
            },
            "taxRateRef": {
                "id": "6c88aff3-7cb9-4980-a3d3-443e72e02498"
            },
            "accountRef": {
                "id": "3f267b10-757d-44c0-bef9-20f70cc8fbe3"
            },
            "trackingCategoryRefs": [
                {
                    "id": "department_1",
                    "name": "ACMERockets"
                },
                {
                    "id": "costcode_2",
                    "name": "ACM2-ACMESigns"
                }
            ]
        },
        {
            "description": "ACMEDisintegratingPistol",
            "unitAmount": 25,
            "discountAmount": 0,
            "quantity": 3,
            "subTotal": 75,
            "taxAmount": 7.5,
            "totalAmount": 82.5,
            "itemRef": {
                "id": "3abf0883-03f7-44c6-bc15-1372522d25e1"
            },
            "taxRateRef": {
                "id": "6c88aff3-7cb9-4980-a3d3-443e72e02498"
            },
            "accountRef": {
                "id": "3f267b10-757d-44c0-bef9-20f70cc8fbe3"
            }
        },
        {
            "description": "ACMEWhippedCreamDispenser",
            "unitAmount": 52,
            "discountAmount": 0,
            "quantity": 6,
            "subTotal": 312,
            "taxAmount": 31.2,
            "totalAmount": 343.2,
            "itemRef": {
                "id": "3691f3d9-0ff7-4358-8a93-bed31c1b4b03"
            },
            "taxRateRef": {
                "id": "6c88aff3-7cb9-4980-a3d3-443e72e02498"
            },
            "accountRef": {
                "id": "3f267b10-757d-44c0-bef9-20f70cc8fbe3"
            }
        },
        {
            "description": "ACMEJetPropelledPogoStick",
            "unitAmount": 130,
            "discountAmount": 0,
            "quantity": 1,
            "subTotal": 130,
            "taxAmount": 27.3,
            "totalAmount": 157.3,
            "itemRef": {
                "id": "075410d4-7edc-4936-ba52-9e1e43cbe300"
            },
            "taxRateRef": {
                "id": "d606732b-db18-44d7-823b-7f15f42c32ea"
            },
            "accountRef": {
                "id": "3f267b10-757d-44c0-bef9-20f70cc8fbe3"
            }
        }
    ],
    "supplierRef": {
        "id": "67C6A7A1-5E84-4AC4-B950-24A114E379D0",
        "supplierName": "Chin's Gas and Oil"
    }
}

Did this page help you?