COcodatio
Bills

Get bill

Changed on

The Get bill endpoint returns a single bill for a given billId.

Bills are invoices that represent the SMB's financial obligations to their supplier for a purchase of goods or services.

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

Tips and traps

To access the paymentAllocations property, ensure that the billPayments data type is queued and cached in Codat before retrieving bills from Codat's cache.

get/companies/{companyId}/data/bills/{billId}

Request

  • Base URL
    https://api.codat.io
  • Auth
    API key in header Authorization

Response

Success

idstring

Identifier for the bill, unique for the company in the accounting software.

referencestring nullable

User-friendly reference for the bill.

supplierRefSupplierRef (unresolved $ref)
purchaseOrderRefsPurchaseOrderRef[] nullable(unresolved $ref)
issueDatestring required

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.

dueDatestring

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)
lineItemsBillLineItem[] nullable(unresolved $ref)

Array of Bill line items.

statusBillStatus required(unresolved $ref)
subTotalnumber required

Total amount of the bill, excluding any taxes.

taxAmountnumber required

Amount of tax on the bill.

totalAmountnumber required

Amount of the bill, including tax.

amountDuenumber nullable

Amount outstanding on the bill.

notestring nullable

Any private, company notes about the bill, such as payment information.

paymentAllocationsItems[] nullable(unresolved $ref)

An array of payment allocations.

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>.

Changes

  • e26d39d895b9Revision changes
    • breaking

      the response property /// became nullable for the status

    • breaking

      the response property /// became optional for the status

    • breaking

      the response property /// became optional for the status

  • 2faca7013054Revision changes
    • warning

      added the new bills enum value to the ///// response property for the response status