Vendor Bills

GET /accounting/vendor-bills

Group: Accounting › Vendor Bills · Operation ID: vendorBills

Returns a list of vendor bills. Each entry is the bill header. Read one bill with its line items from GET accounting/vendor-bills/:id or POST accounting/vendor-bills/search.

Open in the interactive reference

Parameters

Name	In	Type	Required	Description
`Api-Version`	header	`"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

id — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
vendorBillNumber — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
billNumber — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
billDate — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
serviceDate — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
dueDate — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
currency — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
status — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
paymentStatus — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
postingStatus — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
paymentTerms — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
externalVendorBillId — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
lastModifiedDate — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
Orderable: id, vendorBillNumber, billNumber, billDate, serviceDate, dueDate, currency, status, paymentStatus, postingStatus, paymentTerms, total, amountPaid, openAmount, lastModifiedDate
Selectable: id, vendorBillNumber, billNumber, billDate, serviceDate, dueDate, currency, status, paymentStatus, postingStatus, paymentTerms, total, amountPaid, openAmount, externalVendorBillId, vendorName, entityName, lastModifiedDate

Response

200 Success

Under data, an array of vendorBillsRow:

Field	Type	Required	Description
`id`	string	no	The unique identifier for the vendor bill.
`vendorBillNumber`	string or null	no	The vendor bill number. Stable across edits.
`billNumber`	string or null	no	The vendor-issued invoice number, as printed on the bill. It is not unique across vendors.
`billDate`	string (date) or null	no	The date printed on the vendor's invoice. Format YYYY-MM-DD.
`serviceDate`	string (date) or null	no	The date the goods or services were delivered. Format YYYY-MM-DD. Absent when not recorded.
`dueDate`	string (date) or null	no	The date payment is due. Format YYYY-MM-DD.
`currency`	string or null	no	The currency the bill is denominated in. Format ISO 4217, for example 'USD'. Governs total, amountPaid and openAmount.
`status`	string or null	no	The approval status. Values include 'pendingApproval', 'approved', 'rejected', 'voided' and 'reversed'.
`paymentStatus`	string or null	no	The payment status. Values include 'unpaid', 'partiallyPaid', 'fullyPaid', 'pending', 'notApplicable' and 'voided'.
`postingStatus`	string or null	no	The accounting posting status, defined by the accounting subsystem, for example 'notPosted', 'posted' or 'postingFailed'.
`paymentTerms`	string or null	no	The payment-terms key applied to this bill, for example 'net30', 'net60' or 'dueOnReceipt'.
`total`	string (decimal) or null	no	The total bill amount, gross, in the bill currency.
`amountPaid`	string (decimal) or null	no	The cumulative amount paid against this bill so far, in the bill currency.
`openAmount`	string (decimal) or null	no	The outstanding amount still owed, total minus amountPaid, in the bill currency.
`externalVendorBillId`	string or null	no	The identifier this bill has in the upstream system that produced it. It is not unique.
`vendorName`	string or null	no	The name of the vendor this bill is from.
`entityName`	string or null	no	The name of the legal entity this bill is posted under.
`lastModifiedDate`	string (date-time) or null	no	The date and time the vendor bill last changed, in UTC. Format YYYY-MM-DDTHH:mm:ss.sssZ.

Statuses

400 — Invalid request or business failure
401 — Missing or invalid access token
403 — Not authorized
404 — Not found
429 — Too many requests
500 — Internal server error