M3m3ter-com
Bill

List Bills

Changed on

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

Request

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 date equal to or later than this date (in ISO-8601 format).

billDateEndstring

Only include Bills with bill dates earlier than this date (in ISO-8601 format).

externalInvoiceDateStartstring

Only include Bills with external invoice dates equal to or later than this date (in ISO-8601 format).

externalInvoiceDateEndstring

Only include Bills with external invoice dates earlier than this date (in ISO-8601 format).

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

Only include Bills using the specified bill frequency:

  • DAILY
  • WEEKLY
  • MONTHLY
  • ANNUALLY

IMPORTANT!: Can only be used with the billDate query parameter.

Response

Returns the requested list of Bills

nextTokenstring

Example response

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

Changes

  • 85c514abc692Revision changes
    • breaking

      the ////// response's property type changed from no type to object for status

    • info

      query request parameter includeBillTotal was deprecated

    • info

      for the query request parameter ids, the type was generalized from array to string

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

  • ac93d1a9e6d9Revision changes
    • warning

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

    • info

      added the new optional query request parameter billJobId

    • info

      added the optional property // to the response with the status