read

Start an export of one entity's books: XAF 4.0, XAF 3.2 or every finance table as CSV in a ZIP.

Answers 202 with the export job (id, status queued, status_url); the file is produced after the response. xaf-4.0 and xaf-3.2 are the Dutch auditfile of one fiscal year (fiscal_year_id, or year = the calendar year the fiscal year starts in); csv-zip is every finance table of the entity with a manifest of row counts and SHA-256 checksums, and takes no year. Pass an Idempotency-Key header (or idempotency_key): a retry with the same key and the same arguments answers the same job; the same key with different arguments is refused with idempotency_conflict. An export reads the books and is never sent anywhere: the file is downloadable by this app for 7 days.

post/api/v1/finance/exports

Request

  • Base URL: https://app.magistry.io
  • URL: https://app.magistry.io/api/v1/finance/exports
  • 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)

Request body

entity_idstring uuid required

The entity, one of those this app was granted (GET /api/v1/finance/entities lists them). In a GET query string entity is accepted too.

format'xaf-4.0' | 'xaf-3.2' | 'csv-zip' required

What to produce.

fiscal_year_idstring uuid

The fiscal year of an XAF export (GET /api/v1/finance/periods lists them).

yearinteger

Instead of fiscal_year_id: the calendar year the fiscal year starts in.

idempotency_keystring

Same as the Idempotency-Key header; give one of the two.

Response

The job an earlier request with the same idempotency key started.

okboolean required
resultunknown required

Changes

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