STstuut
exports

Get Export

Get Export

Retrieve details of a specific export including download URL if ready. Users can only access their own exports unless they are org admins.

get/v2/exports/{export_id}

Request

  • Base URL
    https://api.stuut.ai (the document declares no server; this is the origin it was published from)
  • Auth
    HTTP bearer

Path parameters

export_idstring required

Response

Successful Response

idstring required
export_type'invoice' | 'partner' | 'payment' | 'analytics' | 'bank_transaction' | 'credit_memo' | 'customer_transaction' | 'invoice_pdf' | 'audit_log' | 'ask_stuut_table' | 'journal_entry' | 'ar_aging' | 'collections_readiness' required
status'pending' | 'processing' | 'completed' | 'failed' required
filtersobject nullable required
format'csv' | 'json' nullable required
error_code'limit_exceeded' | 'timed_out' | 'generation_failed' required
record_countinteger nullable required

Number of rows included in the export. Journal exports in both CSV and JSON skip events without accounting snapshots and can complete with those events omitted. The response does not include a skipped-event count.

download_urlstring nullable required
created_atstring date-time required
started_atstring date-time required
completed_atstring date-time required
report_config_idstring nullable required

The report config this export was sent for, when it is a report send.

Changes

No recorded changes to this operation across all 1 revision of this API.