Skip to main content

List BILL Payments

GET 
/api/billcom/payments

List the payments mirrored from a BILL.com organization, newest first, with the bills each payment was applied to.

Not yet available to API tokens

This endpoint currently requires session authentication; Personal Access Token scope support is in progress.

Authentication: Requires Bearer token.

Required: integration_instance_id — the BILL.com instance to read. An unknown ID returns 404.

Search: filter[search] matches the payment ID (exact) and the BILL payment ID. Restrict it with search_columns (id, billcom_id) and force exact matching with search_strict_columns.

Filters: each column below can be filtered with filter[{column}.{operator}]=value (a bare filter[{column}]=value is an implicit is), or combined into an AND/OR tree passed as filter_groups — base64-encoded JSON shaped like {"conjunction":"and","children":[{"type":"condition","condition":{"column":"…","operator":"is","value":"…"}}]}. A column/operator pair that is not listed returns HTTP 400.

Filterable columns: billcom_id, single_status, funding_account_type — text; id, amount — numeric; process_date — date (Y-m-d); created_at — date-time.

Operators: text columns accept contains, does_not_contain, is, is_not, is_one_of, is_not_one_of, starts_with, does_not_start_with, ends_with, does_not_end_with, is_empty, is_not_empty; numeric columns accept is, is_not, is_one_of, is_not_one_of, greater_than, less_than, greater_than_or_equal, less_than_or_equal, between, is_empty, is_not_empty; date and date-time columns accept is, is_not, before, after, on_or_before, on_or_after, between, is_empty, is_not_empty, today, yesterday, tomorrow.

Sorting: sort, prefix with - for descending. Default -process_date, then -id. Allowed: id, billcom_id, single_status, amount, process_date, funding_account_type, created_at.

Pagination: page, per_page (default 10).

Allocations: each entry in allocations is the share of the payment applied to one BILL bill. payment_recorded is true once a matching payment has been recorded against the SKU.io payable (payment_id is that payment). applied_to describes the bill — its invoice_number, plus link_type_label (Bill or Purchase Invoice), link_reference, link_route and link_id for the linked SKU.io document (null when the bill is unlinked). applied_to itself is null when the BILL bill has not been synced into SKU.io.

Request​

Responses​

OK

Response Headers
    Content-Type