Skip to main content
GET
List bills

Authorizations

X-API-Key
string
header
required

User API key authentication. Create a key under Settings → API keys in the Slash dashboard (https://app.slash.com/global-settings/api-keys) and send the x-legal-entity header naming the legal entity to act on with every request. Keys scoped to a legal entity are rejected with 403 user_api_key_required.

Headers

The legal entity to act on. Required on every request; a user API key can act on any legal entity its user has access to.

Pattern: ^le_[a-zA-Z0-9]+$

Query Parameters

cursor
string

The opaque metadata.nextCursor value from the previous page. It carries that page's filters, page size and ordering, so pass it on its own; see Pagination.

limit
integer

Number of items per page, from 1 to 100. The page size is carried inside metadata.nextCursor, so later pages keep the same size unless limit is passed again to change it.

Required range: 1 <= x <= 100
status
enum<string>[]

Return only bills in these statuses.

Available options:
draft,
pending_approval,
rejected,
scheduled,
payment_pending,
paid,
payment_failed,
partially_paid
vendorContactId
string

Return only bills for one vendor contact.

invoiceNumber
string

Return only bills with exactly this invoice number. Invoice numbers aren't unique, so combine it with vendorContactId to find one vendor's invoice.

Maximum string length: 255
ownerUserId
string

Return only bills owned by one user.

source
enum<string>

Return only bills that entered Slash this way.

Available options:
manual,
email,
carrier_account,
api
overdue
boolean

true returns only unpaid bills whose due date has passed; false excludes them.

hasDocument
boolean

true returns only bills with at least one document attached; false only bills without one.

dueFrom
string<date>

Return only bills due on or after this YYYY-MM-DD date.

dueTo
string<date>

Return only bills due on or before this YYYY-MM-DD date.

invoiceDateFrom
string<date>

Return only bills invoiced on or after this YYYY-MM-DD date.

invoiceDateTo
string<date>

Return only bills invoiced on or before this YYYY-MM-DD date.

amountMin
integer

Return only bills whose total is at least this many minor units.

Required range: x >= 0
amountMax
integer

Return only bills whose total is at most this many minor units.

Required range: x >= 0
includeSummary
boolean

true adds a summary with the count, total, outstanding balance, and aging buckets of every bill the filters match, not just the current page, one entry per currency.

Response

A page of bills.

items
Bill · object[]
required
metadata
PaginationMetadata · object
required
summary
BillSummary · object

Totals over every bill the list filters match, one entry per currency. Present only when includeSummary=true. The aging buckets are the accounts-payable aging report: outstanding balances grouped by whole days past due as of asOf. Bills with nothing outstanding are counted in count and total but not aged.