read

The state of one export job, and the SHA-256 of its file once it is produced.

status is queued, running, succeeded or failed. A failed job carries failure.code (a refusal by the auditfile codec names the accounts in failure.detail.subjects and what to add in failure.detail.hint); a job that could not finish in time is failed with timed_out. A succeeded job carries file (name, bytes, sha256, complete, and the choices the writer made that the books do not state) and download_url. Only the app that started a job sees it, and only while it still holds the entity.

The GET form of finance_export_status: the same arguments as query parameters.

get/api/v1/finance/exports/status

Request

  • Base URL: https://app.magistry.io
  • URL: https://app.magistry.io/api/v1/finance/exports/status
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://app.magistry.io/api/oauth/authorize, token URL https://app.magistry.io/api/oauth/token, scopes: finance:read)

Query parameters

export_idstring uuid required

The id POST /api/v1/finance/exports returned.

Response

Result

okboolean required
resultunknown required

Changes

No recorded changes to this operation across all 2 revisions of this API.