MEmeow
Bills

List Bills

Returns a paginated list of bills with optional status filtering.

get/bills

Request

Query parameters

statusesBillStatusEnum[] nullable

Filter to one or more bill statuses, as a list. Omit to return every status.

contact_idstring[] nullable

Filter to one or more vendor contacts, as a list. Use list_contacts to find contact IDs.

number
OR
string
number
OR
string
bill_date_fromstring date nullable

Only return bills dated on or after this date.

bill_date_tostring date nullable

Only return bills dated on or before this date.

due_date_fromstring date nullable

Only return bills due on or after this date.

due_date_tostring date nullable

Only return bills due on or before this date.

searchstring nullable

Free-text search over vendor name and bill number.

sort_by'VENDOR_NAME' | 'STATUS' | 'AMOUNT' | 'PAYMENT_DATE' | 'BILL_DATE' | 'CREATED_TIME' | 'BILL_DUE_DATE' | 'INVOICE_NUMBER' | 'DESCRIPTION' | 'PAYMENT_TYPE' | 'CATEGORY'

Field to sort by. Defaults to the bill's due date.

sort_descendingboolean

Sort descending instead of ascending.

limitinteger

Maximum number of results to return.

offsetstring nullable

Opaque offset identifier for pagination. Use the nextOffset from a previous response.

Headers

x-entity-idstring uuid

Optional entity_id to scope requests to a specific entity.

Response

Successful Response

Example response

{
  "page": {
    "nextOffset": "qwer123454q2f"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.