BIbill
payments

Get list of payments

Changed on

Get a list of payment objects. By default, you get 20 results on one page of results. Set max in your request to get up to 100 results on one page.

See Search operations with lists in the Guides section for filtering, sorting, and pagination examples.

get/v3/payments

Request

  • Base URL
    https://gateway.stage.bill.com/connect
  • URL
    https://gateway.stage.bill.com/connect/v3/payments
  • Auth
    none declared

Query parameters

maxinteger nullable

Maximum number of results

Example:10
sortstring nullable

Field name and sort order. Both simple and compound sorting is available.

The format is sort={field_01}:{sort_order},{field_02}:{sort_order}.

NOTE: Sorting occurs in the specified order.

Example:createdTime:desc
filtersstring nullable

Field name, operator, and value. Both simple and compound filtering is available.

The format is filters={field_01}:{op}:{value},{field_02}:{op}:{value}.

Example:id:eq:{{payment_id}}
pagestring nullable

Next page of results.

When a list has multiple pages, the nextPage and prevPage values in the response enable you to navigate between the pages of results. Set page as the nextPage or prevPage value for navigation.

Headers

sessionIdstring nullable

API session ID generated with /v3/login

Example:{{session_id}}
devKeystring nullable

Developer key generated with your BILL developer account

Example:{{developer_key}}

Response

Get list of payments response

nextPagestring
prevPagestring
countinteger

Total number of payments matching the list request, across all pages of results.

totalAmountnumber

Sum of the amounts of all payments matching the list request, across all pages of results. This value is in the organization's base currency.

Changes

  • 54edddceb0a5Revision changes
    • warning

      added the new PARTIALLY_SETTLED enum value to the ////////// response property for the response status

    • info

      added subschema #2 to the response body allOf list for the response status