> ## Documentation Index > Fetch the complete documentation index at: https://docs.m3ter.com/llms.txt > Use this file to discover all available pages before exploring further. # Billjobs ## List BillJobs **Function name:** `m3ter_ListBillJobs` **Category:** READ **HTTP method:** GET (paginated) **Destination:** m3ter 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`. ### Parameters | Name | Label | Type | Required | Description | Constraints | | -------------------------- | ---------------- | ----------------------- | :------: | ------------------------------------------ | --------------------------------------------------------------------- | | `integrationCredentialsId` | Credentials | M3terEntityParameter | Yes | The m3ter credentials to use. | m3terEntity: IntegrationCredentials, authType: M3TER\_SIGNED\_REQUEST | | `statePath` | State Path | StateVariableParameter | No | State variable to store the response. | - | | `queryParams` | Query Parameters | KeyValueLookupParameter | No | Query parameters to include in the request | allowedValues: active,status | ### Exits | Exit | Description | | ------- | -------------------------------------------------------------------------------- | | `NEXT` | The API call succeeded. | | `ERROR` | The API call failed. Error details are stored in the `m3shError` state variable. | ## Create BillJob **Function name:** `m3ter_CreateBillJob` **Category:** WRITE **HTTP method:** POST **Destination:** m3ter Create a new BillJob to handle asynchronous bill calculations for a specific Organization. This operation allows you to initiate the processing of bills according to specified parameters. For example, create a BillJob to run only those bills where `billingFrequency` is `MONTHLY`. Note that if you want to run a BillJob for all billing frequencies, simply omit the `billingFrequency` request parameter. Once created, the BillJob's progress can be monitored: * In the Running Tasks panel in the m3ter Console - for more details, see [Running Bills Manually](https://www.m3ter.com/docs/guides/billing-and-usage-data/running-viewing-and-managing-bills/running-bills-and-viewing-bill-details#running-bills-manually) * Queried using the [List BillJobs](https://docs.m3ter.com/api/billjob/list-billjobs) endpoint. **NOTES:** * **Consolidated bills**. If you've already run billing with the Consolidate bills option disabled for your Organization but you then enable it, subsequent Bills for specific bill dates will now start afresh and not update earlier non-consolidated Bills for the same bill date. To avoid any billing conflicts, you might want to archive these earlier versions or delete them entirely. * **Maximum concurrent BillJobs**. If you already have 10 BillJobs currently running, and try to create another one, you'll get an HTTP 429 response (Too many requests). When one of the existing BillJobs has completed, you'll be able to submit another job ### Parameters | Name | Label | Type | Required | Description | Constraints | | -------------------------- | ------------ | ---------------------- | :------: | -------------------------------------- | --------------------------------------------------------------------- | | `integrationCredentialsId` | Credentials | M3terEntityParameter | Yes | The m3ter credentials to use. | m3terEntity: IntegrationCredentials, authType: M3TER\_SIGNED\_REQUEST | | `requestPath` | Request Path | StateVariableParameter | Yes | State variable containing the request. | - | | `statePath` | State Path | StateVariableParameter | No | State variable to store the response. | - | ### Exits | Exit | Description | | ------- | -------------------------------------------------------------------------------- | | `NEXT` | The API call succeeded. | | `ERROR` | The API call failed. Error details are stored in the `m3shError` state variable. | ## Cancel BillJob **Function name:** `m3ter_CancelBillJob` **Category:** WRITE **HTTP method:** POST **Destination:** m3ter Cancel an ongoing BillJob for the given Organization and BillJob UUID. This endpoint allows you to halt the processing of a specific BillJob, which might be necessary if there are changes in billing requirements or other operational considerations. ### Parameters | Name | Label | Type | Required | Description | Constraints | | -------------------------- | ----------- | ---------------------- | :------: | ------------------------------------------------------ | --------------------------------------------------------------------- | | `integrationCredentialsId` | Credentials | M3terEntityParameter | Yes | The m3ter credentials to use. | m3terEntity: IntegrationCredentials, authType: M3TER\_SIGNED\_REQUEST | | `id` | id | LookupParameter | Yes | The unique identifier (UUID) of the BillJob to cancel. | - | | `statePath` | State Path | StateVariableParameter | No | State variable to store the response. | - | ### Exits | Exit | Description | | ------- | -------------------------------------------------------------------------------- | | `NEXT` | The API call succeeded. | | `ERROR` | The API call failed. Error details are stored in the `m3shError` state variable. | ## Create Recalculation BillJob **Function name:** `m3ter_RecalculateBillJob` **Category:** WRITE **HTTP method:** POST **Destination:** m3ter Create a new BillJob specifically to recalculate existing bills for a given Organization. This operation is essential when adjustments or corrections are required in previously calculated bills. The recalculated bills when the BillJob is complete can be checked in the m3ter Console Bill Management page or queried by using the [List Bills](https://docs.m3ter.com/api/bill/list-bills) operation. **NOTE:** * **Response Schema**. The response schema for this call is dynamic. This means that the response might not contain all of the parameters listed. If set to null,the parameter is hidden to help simplify the output as well as to reduce its size and improve performance. ### Parameters | Name | Label | Type | Required | Description | Constraints | | -------------------------- | ------------ | ---------------------- | :------: | -------------------------------------- | --------------------------------------------------------------------- | | `integrationCredentialsId` | Credentials | M3terEntityParameter | Yes | The m3ter credentials to use. | m3terEntity: IntegrationCredentials, authType: M3TER\_SIGNED\_REQUEST | | `requestPath` | Request Path | StateVariableParameter | Yes | State variable containing the request. | - | | `statePath` | State Path | StateVariableParameter | No | State variable to store the response. | - | ### Exits | Exit | Description | | ------- | -------------------------------------------------------------------------------- | | `NEXT` | The API call succeeded. | | `ERROR` | The API call failed. Error details are stored in the `m3shError` state variable. | ## Retrieve BillJob **Function name:** `m3ter_GetBillJob` **Category:** READ **HTTP method:** GET **Destination:** m3ter Retrieve a Bill Job for the given UUID. ### Parameters | Name | Label | Type | Required | Description | Constraints | | -------------------------- | ----------- | ---------------------- | :------: | ------------------------------------- | --------------------------------------------------------------------- | | `integrationCredentialsId` | Credentials | M3terEntityParameter | Yes | The m3ter credentials to use. | m3terEntity: IntegrationCredentials, authType: M3TER\_SIGNED\_REQUEST | | `id` | id | LookupParameter | Yes | The UUID of the Bill Job to retrieve. | - | | `statePath` | State Path | StateVariableParameter | No | State variable to store the response. | - | ### Exits | Exit | Description | | ------- | -------------------------------------------------------------------------------- | | `NEXT` | The API call succeeded. | | `ERROR` | The API call failed. Error details are stored in the `m3shError` state variable. |