Sign in
latestSwagger 2.02026-08-20196638916.1 KB

23d8982b533d

BETA
General.Reports Generation Jobs

Fetch reports generation job

Fetch reports generation job

get/api/v1/reports-generation-jobs/{id}

Path parameters

idstring required

Response

Successful.

createdTimestring required

Time of job creation in ISO-8601 format (UTC).

errorstring

If an error occurred during job processing this will contain the error message.

This is a free-form text and it is not supposed to be parsed programmatically.

idstring required

An unique identifier of the job.

status'PENDING, TEMPORARY_ERROR, PERMANENT_ERROR, COMPLETED' required

Status of the job.

TEMPORARY_ERROR status indicates that the reports generation may be retried at a later time.

PERMANENT_ERROR status indicates that an non-retryable error has occurred and support should be contacted.

COMPLETED status indicates that a job had completed successfully.

This does not mean that all reports were successfully generated.

Any (or even all) triggered reports might have failed and still the job itself might be in COMPLETED state.

updatedTimestring required

Time when the job status was last updated in ISO-8601 format (UTC).

Example response

{
  "createdTime": "2022-10-31T11:55:45Z",
  "error": "An internal error occurred. Please contact support.",
  "id": "caecb48254664234814135346de6082a",
  "reports": [
    {
      "error": "Insufficient data to generate the report. At least 3 full months of transactions are required.",
      "id": "bc875eead4554e77b8dc1644b222e027",
      "status": "PRECONDITION_FAILED",
      "type": "INCOME_CHECK"
    }
  ],
  "status": "COMPLETED",
  "updatedTime": "2022-10-31T12:01:32Z"
}