API reference › Finance › Payables

Export payables

GET /v1/finance/export/payables

Scope
finance:read
Roles
admin, service-provider, scheduler
Rate limit
heavy

Lower rate limit: this route counts against the exports and reports limit. See Rate limits.

Exports payable data to a CSV file with optional filtering by specific payable IDs.

Parameters

Query parameters

NameTypeDescription
typestring

Optional output format. csv downloads the file as CSV; omitted or xlsx keeps the default XLSX.

One of: xlsx, csv. Default "xlsx".

idsstring

Comma-separated list of payable IDs to export. If not provided, exports all payables.

Example PAY-001,PAY-002,PAY-003.

formatstring

relational returns a multi-sheet workbook with the line items on their own sheets; anything else returns the flat one-row-per-document sheet. A relational export is always XLSX, even with type=csv.

One of: flat, relational. Default "flat".

Every call also sends Authorization and X-Tenant-ID; see Getting started.

Example request

Shell
curl "https://api.fetchfido.ai/v1/finance/export/payables" \
  -H "Authorization: Bearer $FIDO_API_KEY" \
  -H "X-Tenant-ID: $FIDO_TENANT_ID"

Try it

Responses

200 Up to the async threshold (config exports

Up to the async threshold (config exports.async_threshold, default 100 rows) the file downloads directly. Above it the export is queued and a JSON notice comes back instead; the file is delivered by in-app and email notification.

JSON
{
  "queued": true,
  "export_id": "9d3c1f8e-2b7a-4c55-9a1e-3f6d2b8c7e10",
  "message": "Exporting 1,250 records. You'll receive an in-app and email notification once your file is ready to download."
}
Response fields (3)
FieldTypeDescription
queuedboolean

Example true.

export_idstring

Example 9d3c1f8e-2b7a-4c55-9a1e-3f6d2b8c7e10.

messagestring

Example Exporting 1,250 records. You'll receive an in-app and email notification once your file is ready to download..

401 Not signed in

Missing, invalid or expired API key.

JSON
{
  "success": false,
  "message": "Invalid API key. Org and user tier keys must send an X-Tenant-ID header naming the organization the key was issued for.",
  "errors": null,
  "code": "API_KEY_MISSING"
}
Response fields (4)
FieldTypeDescription
successboolean

Example false.

messagestring

Example Invalid API key. Org and user tier keys must send an X-Tenant-ID header naming the organization the key was issued for..

errorsany or null

Null on this status.

codestring

Machine-readable reason, for branching on in client code.

One of: API_KEY_MISSING, API_KEY_INVALID, API_KEY_EXPIRED. Example API_KEY_MISSING.

403 Not allowed

The caller's role may not export payables.

JSON
{
  "success": false,
  "message": "You don't have permission to access this endpoint. This API key is missing the 'finance:read' scope.",
  "errors": null,
  "code": ""
}
Response fields (4)
FieldTypeDescription
successboolean

Example false.

messagestring

Example You don't have permission to access this endpoint. This API key is missing the 'finance:read' scope..

errorsany or null

Null on this status.

codestring

Always empty on this status.

Example .

429 Too many requests

Rate limit exceeded. See Retry-After.

JSON
{
  "success": false,
  "message": "You've exceeded this API key's rate limit of 120 requests per minute. Try again in 37 seconds.",
  "errors": null,
  "code": "RATE_LIMITED"
}
Response fields (4)
FieldTypeDescription
successboolean

Example false.

messagestring

Example You've exceeded this API key's rate limit of 120 requests per minute. Try again in 37 seconds..

errorsany or null

Null on this status.

codestring

Machine-readable reason, for branching on in client code.

One of: RATE_LIMITED. Example RATE_LIMITED.

500 Server error

Export failed

JSON
{
  "success": false,
  "message": "An unexpected error occurred."
}
Response fields (2)
FieldTypeDescription
successboolean

Example false.

messagestring

Example An unexpected error occurred..