Create StatementJob
Changed onThis endpoint creates a StatementJob for a single bill within an Organization using the Bill UUID.
The Bill Statement is generated asynchronously:
- The default format for generating the Statement is in JSON format and according to the Bill Statement Definition you've specified at either Organization level or Account level.
- If you also want to generate the Statement in CSV format, use the includeCsvFormat request body parameter.
- The response body provides a time-bound pre-signed URL, which you can use to download the JSON format Statement.
- When you have generated a Statement for a Bill, you can also obtain a time-bound pre-signed download URL using either the Retrieve Bill Statement in JSON Format and Retrieve Bill Statement in CSV Format calls found in the Bill section of this API Reference.
Notes:
- If the response to the Create StatementJob call shows the statementJobStatus as PENDING or RUNNING, you will not receive the pre-signed URL in the response. Wait a few minutes to allow the StatementJob to complete and then use the Get StatmentJob call in this section to obtain the pre-signed download URL for the generated Bill Statement.
- When you have submitted a StatementJob and a Bill Statement has been generated, you can also download the Statement directly from a Bill Details page in the Console. See Working with Bill Statements in our user Documentation.
Request
- Base URLhttps://api.m3ter.com
- AuthOAuth 2Authorization codehttps://m3ter.auth.us-east-1.amazoncognito.com/oauth2/authorize, token URL https://m3ter.auth.us-east-1.amazoncognito.com/oauth2/tokenClient credentialsToken URL /oauth/token
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Path parameters
The unique identifier (UUID) of your Organization. The Organization represents your company as a direct customer of our service.
Request body
Response
Returns the created StatementJob
Changes
- breaking
the
request property type changed from no type toobject - breaking
the
response's property type changed from no type toobjectfor status - info
added the new optional request property
/ - info
added the optional property
/to the response with the status
- breaking
- breaking
the
/response's property format changed fromurlto no format for 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
- breaking