Invoices

List invoices

The List invoices endpoint returns a list of invoices for a given company's connection.

Invoices are itemized records of goods sold or services provided to a customer.

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

Useful queries

Outstanding invoices - query = amountDue > 0
Invoices due after a certain date: query = dueDate > 2021-01-28

Tips and traps

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

get/companies/{companyId}/data/invoices

Query parameters

pageinteger

Example:1

Page number. Read more.

pageSizeinteger

Example:100

Number of records to return in a page. Read more.

querystring

Codat query string. Read more.

orderBystring

Example:-modifiedDate

Field to order results by. Read more.

Response

Success

pageNumberinteger required

Current page number.

pageSizeinteger required

Number of items to return in results array.

totalResultsinteger required

Total number of items.

_linksLinks required— unresolved $ref

Example response

{
  "pageNumber": 1,
  "pageSize": 10,
  "totalResults": 1,
  "_links": {
    "self": {
      "href": "/companies/{id}/data/{dataType}"
    },
    "current": {
      "href": "/companies/{id}/data/{dataType}?page=1&pageSize=10"
    }
  }
}

Changes

Changed in 3 of the 51 revisions of this API.52

Feb 13, 20244bfab0afa6ca9See the full diff
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
Jan 31, 202499ac1a5377641See the full diff
- ○
  response property allOf[subschema #1]/results/items/allOf[subschema #1]/lineItems/items/trackingCategoryRefs reactivated
  response-property-reactivated
Jan 8, 20240fcc5f736d8642See the full diff
- ○
  removed the accountTransactions enum value from the ////// response property for the response status
  response-property-enum-value-removed
- ○
  removed the balanceSheet enum value from the ////// response property for the response status
  response-property-enum-value-removed
- ○
  removed the bankAccounts enum value from the ////// response property for the response status
  response-property-enum-value-removed
- ○
  removed the bankTransactions enum value from the ////// response property for the response status
  response-property-enum-value-removed
- ○
  removed the banking-accountBalances enum value from the ////// response property for the response status
  response-property-enum-value-removed
- ○
  removed the banking-accounts enum value from the ////// response property for the response status
  response-property-enum-value-removed
- ○
  removed the banking-transactionCategories enum value from the ////// response property for the response status
  response-property-enum-value-removed
- ○
  removed the banking-transactions enum value from the ////// response property for the response status
  response-property-enum-value-removed
- ○
  removed the billCreditNotes enum value from the ////// response property for the response status
  response-property-enum-value-removed
- ○
  removed the billPayments enum value from the ////// response property for the response status
  response-property-enum-value-removed
- ○
  removed the bills enum value from the ////// response property for the response status
  response-property-enum-value-removed
- ○
  removed the cashFlowStatement enum value from the ////// response property for the response status
  response-property-enum-value-removed
- ○
  removed the chartOfAccounts enum value from the ////// response property for the response status
  response-property-enum-value-removed
- ○
  removed the commerce-companyInfo enum value from the ////// response property for the response status
  response-property-enum-value-removed
- ○
  removed the commerce-customers enum value from the ////// response property for the response status
  response-property-enum-value-removed
- ○
  removed the commerce-disputes enum value from the ////// response property for the response status
  response-property-enum-value-removed
- ○
  removed the commerce-locations enum value from the ////// response property for the response status
  response-property-enum-value-removed
- ○
  removed the commerce-orders enum value from the ////// response property for the response status
  response-property-enum-value-removed
- ○
  removed the commerce-paymentMethods enum value from the ////// response property for the response status
  response-property-enum-value-removed
- ○
  removed the commerce-payments enum value from the ////// response property for the response status
  response-property-enum-value-removed
- ○
  removed the commerce-productCategories enum value from the ////// response property for the response status
  response-property-enum-value-removed
- ○
  removed the commerce-products enum value from the ////// response property for the response status
  response-property-enum-value-removed
- ○
  removed the commerce-taxComponents enum value from the ////// response property for the response status
  response-property-enum-value-removed
- ○
  removed the commerce-transactions enum value from the ////// response property for the response status
  response-property-enum-value-removed
- ○
  removed the company enum value from the ////// response property for the response status
  response-property-enum-value-removed
- ○
  removed the creditNotes enum value from the ////// response property for the response status
  response-property-enum-value-removed
- ○
  removed the customers enum value from the ////// response property for the response status
  response-property-enum-value-removed
- ○
  removed the directCosts enum value from the ////// response property for the response status
  response-property-enum-value-removed
- ○
  removed the directIncomes enum value from the ////// response property for the response status
  response-property-enum-value-removed
- ○
  removed the invoices enum value from the ////// response property for the response status
  response-property-enum-value-removed
- ○
  removed the itemReceipts enum value from the ////// response property for the response status
  response-property-enum-value-removed
- ○
  removed the items enum value from the ////// response property for the response status
  response-property-enum-value-removed
- ○
  removed the journalEntries enum value from the ////// response property for the response status
  response-property-enum-value-removed
- ○
  removed the journals enum value from the ////// response property for the response status
  response-property-enum-value-removed
- ○
  removed the paymentMethods enum value from the ////// response property for the response status
  response-property-enum-value-removed
- ○
  removed the payments enum value from the ////// response property for the response status
  response-property-enum-value-removed
- ○
  removed the profitAndLoss enum value from the ////// response property for the response status
  response-property-enum-value-removed
- ○
  removed the purchaseOrders enum value from the ////// response property for the response status
  response-property-enum-value-removed
- ○
  removed the suppliers enum value from the ////// response property for the response status
  response-property-enum-value-removed
- ○
  removed the taxRates enum value from the ////// response property for the response status
  response-property-enum-value-removed
- ○
  removed the trackingCategories enum value from the ////// response property for the response status
  response-property-enum-value-removed
- ○
  removed the transfers enum value from the ////// response property for the response status
  response-property-enum-value-removed

Full history