v1

latestOpenAPI 3.0.12026-07-24310590875.6 KB

organizations

Get list of billing statements

Get a list of billing statements for the organization. BILL generates a monthly billing invoice statement for all the billing activities in the organization.

In the request, set invoiceDateFrom and invoiceDateTo to get the billing invoice statements for the specified date range.

You can set max and page in the request only when both invoiceDateFrom and invoiceDateTo are not set. 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/organizations/{organizationId}/billing-statements

Path parameters

organizationIdstring required

BILL-generated ID of the organization. The value begins with 008.

Example:{{organization_id}}

Query parameters

maxinteger nullable

Maximum number of results. You can set max only when both invoiceDateFrom and invoiceDateTo are not set.

invoiceDateFromstring nullable

Billing invoice start date. The value is in the yyyy-MM-dd format. This field is required if invoiceDateTo is set.

invoiceDateTostring nullable

Billing invoice end date. The value is in the yyyy-MM-dd format. This field is required if invoiceDateFrom is set.

pagestring nullable

Next page of results. You can set page only when both invoiceDateFrom and invoiceDateTo are not set.

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 billing statements response

nextPagestring

prevPagestring