M3m3ter-com
BillJob

List BillJobs

Changed on

Retrieve a list of BillJobs.

This endpoint retrieves a list of BillJobs for the specified Organization. The list can be paginated for easier management, and allows you to query and filter based on various parameters, such as BillJob status and whether or not BillJob remains active.

get/organizations/{orgId}/billjobs

Request

Path parameters

orgIdstring required

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

Query parameters

pageSizeinteger

Specifies the maximum number of BillJobs to retrieve per page.

nextTokenstring

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

activestring

Boolean filter to retrieve only active BillJobs and exclude completed or cancelled BillJobs from the results.

  • TRUE - only active BillJobs.
  • FALSE - all BillJobs including completed and cancelled BillJobs.
statusstring

Filter BillJobs by specific status. Allows for targeted retrieval of BillJobs based on their current processing status.

Possible states are:

  • PENDING
  • INITIALIZING
  • RUNNING
  • COMPLETE
  • CANCELLED

Response

Returns list of BillJobs

nextTokenstring

Example response

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

Changes

  • 85c514abc692Revision changes
    • breaking

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

  • 9f9e5f3dbde7Revision changes
    • breaking

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

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status