Skip to main content
GET
/
organizations
/
{orgId}
/
billjobs
List BillJobs
curl --request GET \
  --url https://api.m3ter.com/organizations/{orgId}/billjobs \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "<string>",
      "version": 123,
      "lastDateInBillingPeriod": "2023-12-25",
      "billingFrequency": "DAILY",
      "billFrequencyInterval": 123,
      "billDate": "2023-12-25",
      "externalInvoiceDate": "2023-12-25",
      "dueDate": "2023-12-25",
      "accountIds": [
        "<string>"
      ],
      "billIds": [
        "<string>"
      ],
      "targetCurrency": "<string>",
      "currencyConversions": [
        {
          "from": "EUR",
          "to": "USD",
          "multiplier": 1.12
        }
      ],
      "timezone": "UTC",
      "yearEpoch": "2023-12-25",
      "monthEpoch": "2023-12-25",
      "weekEpoch": "2023-12-25",
      "dayEpoch": "2023-12-25",
      "status": "PENDING",
      "total": 123,
      "pending": 123,
      "type": "CREATE",
      "dtCreated": "2023-11-07T05:31:56Z",
      "dtLastModified": "2023-11-07T05:31:56Z",
      "createdBy": "<string>",
      "lastModifiedBy": "<string>"
    }
  ],
  "nextToken": "<string>"
}

Authorizations

​
Authorization
string
header
required

m3ter supports machine to machine authentication using the clientCredentials OAuth2 flow.

The authorizationCode flow controls access for human users via the m3ter Console application.

Path Parameters

​
orgId
string
required

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

Query Parameters

​
pageSize
integer<int32>

Specifies the maximum number of BillJobs to retrieve per page.

Required range: 1 <= x <= 100
​
nextToken
string

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

​
active
string

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.
​
status
string

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

​
data
object[]
​
nextToken
string