Sign in
Bill

List Bills

Retrieve a list of Bills.

This endpoint retrieves a list of all Bills for the given Account within the specified Organization. Optional filters can be applied such as by date range, lock status, or other attributes. The list can also be paginated for easier management.

get/organizations/{orgId}/bills

Path parameters

orgIdstring required

The unique identifier (UUID) of your Organization. The Organization represents your company as a direct customer of our service.

Query parameters

pageSizeinteger

Specifies the maximum number of Bills to retrieve per page.

nextTokenstring

The nextToken for multi-page retrievals. It is used to fetch the next page of Bills in a paginated list.

accountIdstring

Optional filter. An Account ID - returns the Bills for the single specified Account.

lockedboolean

Boolean flag specifying whether to include Bills with "locked" status.

  • TRUE - the list inlcudes "locked" Bills.
  • FALSE - excludes "locked" Bills from the list.
excludeLineItemsboolean

Exclude Line Items

includeBillTotalboolean

Include Bill Total

status'PENDING' | 'APPROVED'

Indicates whether the Bill has passed human/manual approval.

  • Pending - Bill has not yet been passed by a human reviewer.
  • Approved - Bill has been approved after manual review.

Only include Bills having the given status

billDatestring

The specific date in ISO 8601 format for which you want to retrieve Bills.

billDateStartstring

Only include Bills with bill dates equal to or later than this date.

billDateEndstring

Only include Bills with bill dates earlier than this date.

externalInvoiceDateStartstring

Only include Bills with external invoice dates equal to or later than this date.

externalInvoiceDateEndstring

Only include Bills with external invoice dates earlier than this date.

idsstring[]

Optional filter. The list of Bill IDs to retrieve.

billJobIdstring

List Bill entities by the bill job that last calculated them.

additionalstring[]

Comma separated list of additional fields.

billingFrequencystring nullable

Response

Returns the requested list of Bills

nextTokenstring

Example response

{
  "data": [
    {
      "timezone": "UTC",
      "currencyConversions": [
        {
          "from": "EUR",
          "to": "USD",
          "multiplier": 1.12
        }
      ]
    }
  ]
}

Changes

Changed in 3 of the 10 revisions of this API.237

  • ac93d1a9e6d912See the full diff
    • ●

      added the new AD_HOC enum value to the data/items/lineItems/items/lineItemType response property for the response status 200

      response-property-enum-value-added

    • ○

      added the new optional query request parameter billJobId

      new-optional-request-parameter

    • ○

      added the optional property data/items/statementStale to the response with the 200 status

      response-optional-property-added

    This revision also has 3 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 9f9e5f3dbde713See the full diff
    • ▲

      the response's body type/format changed from / to object/ for status 200

      response-body-type-changed

    • ○

      added the new optional query request parameter additional

      new-optional-request-parameter

    • ○

      added the optional property data to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property nextToken to the response with the 200 status

      response-optional-property-added

    This revision also has 53 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 9433593378b5122See the full diff
    • ▲

      the response's body type/format changed from object/ to / for status 200

      response-body-type-changed

    • ●

      removed the optional property data from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property nextToken from the response with the 200 status

      response-optional-property-removed

    • ○

      added the new optional query request parameter excludeLineItems

      new-optional-request-parameter

    • ○

      added the new optional query request parameter includeBillTotal

      new-optional-request-parameter

    This revision also has 41 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog