Sign in
StatementJob

Create a StatementJob

This 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.
post/organizations/{orgId}/statementjobs

Path parameters

orgIdstring required

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

Request body

versioninteger

The version number of the entity:

  • Create entity: Not valid for initial insertion of new entity - do not use for Create. On initial Create, version is set at 1 and listed in the response.
  • Update Entity: On Update, version is required and must match the existing version because a check is performed to ensure sequential versioning is preserved. Version is incremented by 1 and listed in the response.
billIdstring required

The unique identifier (UUID) of the bill associated with the StatementJob.

includeCsvFormatboolean

A Boolean value indicating whether the generated statement includes a CSV format.

  • TRUE - includes the statement in CSV format.
  • FALSE - no CSV format statement.

Response

Returns the created StatementJob

idstring required

The UUID of the entity.

versioninteger

The version number:

  • Create: On initial Create to insert a new entity, the version is set at 1 in the response.
  • Update: On successful Update, the version is incremented by 1 in the response.
statementJobStatus'PENDING' | 'RUNNING' | 'COMPLETE' | 'CANCELLED' | 'FAILED'

The current status of the StatementJob. The status helps track the progress and outcome of a StatementJob.

billIdstring

The unique identifier (UUID) of the bill associated with the StatementJob.

orgIdstring

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

includeCsvFormatboolean

A Boolean value indicating whether the generated statement includes a CSV format.

  • TRUE - includes the statement in CSV format.
  • FALSE - no CSV format statement.
presignedJsonStatementUrlstring

The URL to access the generated statement in JSON format. This URL is temporary and has a limited lifetime.

jsonStatementStatus'LATEST' | 'STALE' | 'INVALIDATED'
presignedCsvStatementUrlstring
csvStatementStatus'LATEST' | 'STALE' | 'INVALIDATED'
dtCreatedstring date-time

The date and time (in ISO-8601 format) when the StatementJob was created.

dtLastModifiedstring date-time

The date and time (in ISO-8601 format) when the StatementJob was last modified.

createdBystring

The unique identifier (UUID) of the user who created this StatementJob.

lastModifiedBystring

The unique identifier (UUID) of the user who last modified this StatementJob.

Changes

Changed in 2 of the 10 revisions of this API.14

  • ac93d1a9e6d913See the full diff
    • ▲

      the allOf[subschema #2]/presignedJsonStatementUrl response's property type/format changed from string/url to string/ for status 200

      response-property-type-changed

    • ○

      added the optional property allOf[subschema #2]/csvStatementStatus to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property allOf[subschema #2]/jsonStatementStatus to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property allOf[subschema #2]/presignedCsvStatementUrl to the response with the 200 status

      response-optional-property-added

    This revision also has 3 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 9f9e5f3dbde71See the full diff
    • ○

      endpoint added

      endpoint-added

    This revision also has 53 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog