Sign in
StatementJob

Cancel StatementJob

Cancel the StatementJob with the given UUID.

Use this endpoint to halt the execution of a specific StatementJob identified by its UUID. This operation may be useful if you need to stop a StatementJob due to unforeseen issues or changes.

post/organizations/{orgId}/statementjobs/{id}/cancel

Path parameters

orgIdstring required

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

idstring required

The unique identifier (UUID) of the StatementJob to cancel.

Response

Returns the cancelled 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 / response's property format changed from url to no format for status

      response-property-type-changed

    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    • ○

      added the optional property / to the response with the 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