List vendor bills

Operation ID: vendorBills

Group: Accounting › Vendor Bills

Open in the interactive reference

GET /accounting/vendor-bills

Read-only: Reads and returns; changes nothing.

Lists vendor bills, without their line items. To filter by vendor or legal entity, or to read line items, use POST accounting/vendor-bills/search.

Parameters

Name In Type Required Description
Api-Version header string · v1 yes The API version this request targets, named by its public identifier. Required on every request; omitting it, or naming a version this company does not have, is answered with 400. This document describes version v1.

Query surface

Response

200 Success

Under data, an array of vendorBillsRow:

Field Type Required Filter Sort Description
id string no Exact (eq, ne), Range (gt, gte, lt, lte, between), Any of (in, notIn), Pattern (like) yes The unique identifier for the vendor bill.
vendorBillNumber string | null no Exact (eq, ne), Range (gt, gte, lt, lte, between), Any of (in, notIn), Pattern (like) yes The vendor bill number. Stable across edits.
billNumber string | null no Exact (eq, ne), Range (gt, gte, lt, lte, between), Any of (in, notIn), Pattern (like) yes The vendor-issued invoice number, as printed on the bill. It is not unique across vendors.
billDate date | null no Exact (eq, ne), Range (gt, gte, lt, lte, between), Any of (in, notIn) yes The date printed on the vendor's invoice. Format YYYY-MM-DD.
serviceDate date | null no Exact (eq, ne), Range (gt, gte, lt, lte, between), Any of (in, notIn) yes The date the goods or services were delivered. Format YYYY-MM-DD. Absent when not recorded.
dueDate date | null no Exact (eq, ne), Range (gt, gte, lt, lte, between), Any of (in, notIn) yes The date payment is due. Format YYYY-MM-DD.
currency string | null no Exact (eq, ne), Range (gt, gte, lt, lte, between), Any of (in, notIn), Pattern (like) yes The currency the bill is denominated in. Format ISO 4217, for example 'USD'. Governs total, amountPaid and openAmount.
status string | null no Exact (eq, ne), Range (gt, gte, lt, lte, between), Any of (in, notIn), Pattern (like) yes The approval status. Values include 'pendingApproval', 'approved', 'rejected', 'voided' and 'reversed'.
paymentStatus string | null no Exact (eq, ne), Range (gt, gte, lt, lte, between), Any of (in, notIn), Pattern (like) yes The payment status. Values include 'unpaid', 'partiallyPaid', 'fullyPaid', 'pending', 'notApplicable' and 'voided'.
postingStatus string | null no Exact (eq, ne), Range (gt, gte, lt, lte, between), Any of (in, notIn), Pattern (like) yes The accounting posting status, defined by the accounting subsystem, for example 'notPosted', 'posted' or 'postingFailed'.
paymentTerms string | null no Exact (eq, ne), Range (gt, gte, lt, lte, between), Any of (in, notIn), Pattern (like) yes The payment-terms key applied to this bill, for example 'net30', 'net60' or 'dueOnReceipt'.
total decimal | null no no yes The total bill amount, gross, in the bill currency.
amountPaid decimal | null no no yes The cumulative amount paid against this bill so far, in the bill currency.
openAmount decimal | null no no yes The outstanding amount still owed, total minus amountPaid, in the bill currency.
payableAmount decimal | null no no yes Amount owed to the vendor, in the bill currency (see currency): the bill lines — a reverse-charge line at its net amount, any other at its gross amount — less withholding tax. An AP aging starts from it.
markAsPaid boolean | null no Exact (eq, ne), Range (gt, gte, lt, lte, between), Any of (in, notIn) no True when the bill was marked as paid without a recorded payment. An AP aging leaves such bills out.
externalVendorBillId string | null no Exact (eq, ne), Range (gt, gte, lt, lte, between), Any of (in, notIn), Pattern (like) no The identifier this bill has in the upstream system that produced it. It is not unique.
vendorName string | null no no no The name of the vendor this bill is from.
vendorId string | null no Exact (eq, ne), Range (gt, gte, lt, lte, between), Any of (in, notIn), Pattern (like) no The vendor the bill is from.
entityName string | null no no no The name of the legal entity this bill is posted under.
entityId string | null no Exact (eq, ne), Range (gt, gte, lt, lte, between), Any of (in, notIn), Pattern (like) no The legal entity the bill is addressed to.
lastModifiedDate date-time | null no Exact (eq, ne), Range (gt, gte, lt, lte, between), Any of (in, notIn) yes The date and time the vendor bill last changed, in UTC. Format YYYY-MM-DDTHH:mm:ss.sssZ. 
{
  "data": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "vendorBillNumber": "<vendorBillNumber>",
      "billNumber": "<billNumber>",
      "billDate": "2026-01-15",
      "serviceDate": "2026-01-15",
      "dueDate": "2026-01-15",
      "currency": "<currency>",
      "status": "<status>",
      "paymentStatus": "<paymentStatus>",
      "postingStatus": "<postingStatus>",
      "paymentTerms": "<paymentTerms>",
      "total": "19.99",
      "amountPaid": "19.99",
      "openAmount": "19.99",
      "payableAmount": "19.99",
      "markAsPaid": true,
      "externalVendorBillId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "vendorName": "<vendorName>",
      "vendorId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "entityName": "<entityName>",
      "entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "lastModifiedDate": "2026-01-15T09:30:00.000Z"
    }
  ],
  "pagination": {
    "hasMore": true,
    "nextCursor": "<nextCursor>"
  }
}

Statuses