Sign in
latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-041351024.8 MB

21d41189c461

Bill credit notes

Get bill credit note

The Get bill credit note endpoint returns a single bill credit note for a given billCreditNoteId.

Bill credit notes are issued by a supplier for the purpose of recording credit.

Before using this endpoint, you must have retrieved data for the company.

get/companies/{companyId}/data/billCreditNotes/{billCreditNoteId}

Response

Success

idstring

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

billCreditNoteNumberstring nullable

Friendly reference for the bill credit note.

supplierRefSupplierRef — unresolved $ref
withholdingTaxItems[] nullable— unresolved $ref
totalAmountnumber required

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

totalDiscountnumber required

Total value of any discounts applied.

subTotalnumber required

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

totalTaxAmountnumber required

Amount of tax included in the bill credit note.

discountPercentagenumber required

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

remainingCreditnumber

Amount of the bill credit note that is still outstanding.

statusBillCreditNoteStatus required— unresolved $ref
issueDatestring

In Codat's data model, dates and times are represented using the <a class="external" href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601 standard</a>. Date and time fields are formatted as strings; for example:

2020-10-08T22:40:50Z
2021-01-01T00:00:00

When syncing data that contains DateTime fields from Codat, make sure you support the following cases when reading time information:

  • Coordinated Universal Time (UTC): 2021-11-15T06:00:00Z
  • Unqualified local time: 2021-11-15T01:00:00
  • UTC time offsets: 2021-11-15T01:00:00-05:00

Time zones

Not all dates from Codat will contain information about time zones.
Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced.

allocatedOnDatestring

In Codat's data model, dates and times are represented using the <a class="external" href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601 standard</a>. Date and time fields are formatted as strings; for example:

2020-10-08T22:40:50Z
2021-01-01T00:00:00

When syncing data that contains DateTime fields from Codat, make sure you support the following cases when reading time information:

  • Coordinated Universal Time (UTC): 2021-11-15T06:00:00Z
  • Unqualified local time: 2021-11-15T01:00:00
  • UTC time offsets: 2021-11-15T01:00:00-05:00

Time zones

Not all dates from Codat will contain information about time zones.
Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced.

currencyCurrency — unresolved $ref
currencyRateCurrencyRate — unresolved $ref
lineItemsBillCreditNoteLineItem[] nullable— unresolved $ref

An array of line

paymentAllocationsItems[] nullable— unresolved $ref

An array of payment allocations.

createdFromRefsInvoiceTo[] nullable— unresolved $ref

An array of records the credit note was created from.

notestring nullable

Any additional information about the bill credit note.

modifiedDatestring

The date when the record was last fetched from the accounting software, commerce software, or open banking provider and updated in Codat’s data cache.

Use it to identify and retrieve records that have changed since your last fetch. For example, filtering modifiedDate to today will provide new records updated in Codat today.

This date is populated for all data types except for attachments, balance sheets, company information, and profit & loss reports (read more).

In Codat's data model, dates and times are represented using the <a class="external" href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601 standard</a>.

sourceModifiedDatestring

The date when a record was last modified in the accounting software, usually by the business or a business process. For example, when payments are made against an invoice.

It is not populated (read more) when:

  • Pulling attachments
  • The accounting software does not provide modification dates for a data type
  • A record has been deleted from the source platform and Codat doesn't have a record of when the deletion occurred
  • A record has been voided. For certain platforms that soft delete records, isDeleted metadata is used to identify void records

In Codat's data model, dates and times are represented using the <a class="external" href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601 standard</a>.

Example response

{
  "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"
        }
      ],
      "createdFromLineRef": [
        {
          "id": "8462",
          "dataType": "bill",
          "lineNumber": 1
        }
      ]
    },
    {
      "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"
  },
  "createdFromLineRef": {
    "id": "8462",
    "dataType": "bills",
    "line": 1
  }
}