exports

Create Export

Request Export

Request an async export of data. The export will be processed in the background and you will receive an email with a download link when it's ready.

If a pending/processing export with the same type and filters exists, returns that instead of creating a duplicate.

post/v2/exports

Request

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

Request body

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
format'csv' | 'json' nullable

Journal entry file format; defaults to csv

filtersobject nullable

Optional filter criteria for the export

business_unit_id__instring[] nullable

Filter export data to specific business units

Response

Successful Response

was_existingboolean required

True if an existing pending export was returned instead of creating new

Changes

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