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
Exits
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
- Queried using the List BillJobs endpoint.
- 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
Exits
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
Exits
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 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
Exits
Retrieve BillJob
Function name:m3ter_GetBillJob
Category: READ
HTTP method: GET
Destination: m3ter
Retrieve a Bill Job for the given UUID.