StatementJob

List Statement Jobs

Changed on

Retrieve a list of StatementJobs.

Retrieves a list of all StatementJobs for a specific Organization. You can filter the results based on:

  • StatementJob status.
  • Whether StatementJob is neither completed nor cancelled but remains active.
  • The ID of the Bill the StatementJob is associated with.

You can also paginate the results for easier management.

WARNING!

  • You can use only one of the valid Query parameters: active, status, or billId in any call. If you use more than one of these Query parameters in the same call, then a 400 Bad Request is returned with an error message.
get/organizations/{orgId}/statementjobs

Request

Path parameters

orgIdstring required

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

Query parameters

pageSizeinteger

Specifies the maximum number of StatementJobs to retrieve per page.

nextTokenstring

The nextToken for multi-page retrievals. It is used to fetch the next page of StatementJobs in a paginated list.

activestring

Boolean filter on whether to only retrieve active (i.e. not completed/cancelled) StatementJobs.

  • TRUE - only active StatementJobs retrieved.
  • FALSE - all StatementJobs retrieved.
statusstring

Filter using the StatementJobs status. Possible values:

  • PENDING
  • RUNNING
  • COMPLETE
  • CANCELLED
  • FAILED
billIdstring

Filter Statement Jobs by billId

Response

Returns list of StatementJobs

nextTokenstring

Changes

    • breaking

      the // response's property type changed from no type to object for status

    • info

      added the optional property /// to the response with the status

    • breaking

      the /// response's property format changed from url to 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