Skip to main content
GET
List bills
List Bills supports cursor-based pagination through sort_by, sort_order, cursor, limit, and show_total_count. Responses include bill records in data and pagination details in meta.pagination; see Pagination for the shared response contract.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

businessId
string<uuid>
required

The UUID of the business to fetch bills for.

Query Parameters

reference_number
string

Filter by exact reference number match. Returns only records with this exact reference number.

reference_numbers
string

Comma-separated list of reference numbers to filter bills by. Only bills with reference numbers matching any value in this list will be returned.

status
enum<string>

Filter bills by status.

Available options:
RECEIVED,
PARTIALLY_PAID,
PAID,
VOIDED
Example:

"RECEIVED"

due_at_start
string<date-time>

Filter bills by due date. Bills with a due date on or after this date will be included. Bills without a set due date will not be included. ISO 8601 date format.

due_at_end
string<date-time>

Filter bills by due date. Bills with a due date on or before this date will be included. Bills without a set due date will not be included. ISO 8601 date format.

received_at_start
string<date-time>

Filter bills by received date. Bills received on or after this date will be included. ISO 8601 date format.

received_at_end
string<date-time>

Filter bills by received date. Bills received on or before this date will be included. ISO 8601 date format.

vendor_id
string<uuid>

Filter bills by Layer vendor id.

vendor_external_id
string

Filter bills by vendor external id. Either the vendor_id or the vendor_external_id can be provided.

min_amount
integer<int64>

Filter bills by minimum total amount (in positive cents).

max_amount
integer<int64>

Filter bills by maximum total amount (in positive cents).

memo_contains
string

Filter bills by memo text. Returns bills where the memo contains this value.

is_expense
boolean

Filter to expenses (true) or standard bills (false).

sort_by
string

Field to sort by. Eligible sort keys include imported_at and updated_at.

sort_order
enum<string>

Sort direction.

Available options:
asc,
desc
cursor
string

Pagination cursor returned from the previous page.

limit
integer
default:100

Maximum number of bills to return.

show_total_count
boolean
default:false

Whether to include total count in pagination metadata.

Response

200 - application/json

Success.

data
object[]
required
meta
object

Request metadata. Present on paginated list responses.