List bills (accounts payable)

Returns one page of a Books instance's bills: accounts payable (AP), money the organization owes vendors. Each item has its id, referenceNumber (the bill number), vendor (the vendor the bill is owed to, with its id and name; omitted when the bill has no recorded vendor), effectiveDate (bill date), dueDate, status, displayStatus, grossAmount (total of all lines), amountRemaining (still owed after applied payments), lines (each with its ledger ID, i.e. general ledger (GL) account, description, and amount), and paymentApplications (each a line entry ID, such as a bank transaction's line, and the amount of it applied). status is the stored lifecycle status (draft, open, processing, paid, cancelled); displayStatus is what users see, which also distinguishes overdue (open and past due) and partiallyPaid (open with some payment applied). A vendor's id is a Books counterparty ID, which is not a recipient ID. Amounts are in dollars. Each response is one page of at most limit items (default 100, at most 1000). To see every match, pass nextPageToken back as pageToken with the same other parameters, and repeat until a response has no nextPageToken. To read specific bills by ID, pass their IDs as ids. To discover ledger IDs, use getBooksLedgers.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
uuid

The Books instance to act on. Required for agent organization tokens; defaults to the token organization's instance.

date

Only return bills dated on or after this date (inclusive, YYYY-MM-DD).

date

Only return bills dated on or before this date (inclusive, YYYY-MM-DD).

date

Only return bills due on or after this date (inclusive, YYYY-MM-DD).

date

Only return bills due on or before this date (inclusive, YYYY-MM-DD).

status
array of strings

Comma-separated list of stored statuses to include.

status
Allowed:
displayStatus
array of strings

Comma-separated list of display statuses to include, such as overdue or partiallyPaid.

displayStatus
Allowed:
vendorIds
array of uuids

Comma-separated list of at most 100 distinct vendor (Books counterparty) IDs.

vendorIds
ids
array of strings

Comma-separated list of at most 100 distinct bill IDs. Use it to read specific bills.

ids
string

Only return bills with this reference number.

double

Only return bills with exactly this gross amount. minGrossAmount and maxGrossAmount are ignored when this is set.

double

Only return bills with a gross amount of at least this value.

double

Only return bills with a gross amount of at most this value.

double

Only return bills with exactly this amount remaining. minAmountRemaining and maxAmountRemaining are ignored when this is set.

double

Only return bills with an amount remaining of at least this value.

double

Only return bills with an amount remaining of at most this value.

string

Search text, 3 to 100 characters.

sort
array of strings

Comma-separated list of sort keys, applied in order. Defaults to effectiveDateDesc.

sort
string

The nextPageToken or prevPageToken from a previous response, to fetch that page.

integer
1 to 1000
Defaults to 100

The maximum number of bills to return per page, from 1 to 1000. Defaults to 100.

Responses

400

Invalid limit or pageToken or sort or keywords or maxAmountRemaining or minAmountRemaining or amountRemaining or maxGrossAmount or minGrossAmount or grossAmount or referenceNumber or ids or vendorIds or displayStatus or status or dueDateEnd or dueDateStart or effectiveDateEnd or effectiveDateStart or booksId

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json