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
| Name | Type | Description |
|---|---|---|
type | string | Optional output format. One of: |
ids | string | Comma-separated list of payable IDs to export. If not provided, exports all payables. Example |
format | string |
One of: |
Every call also sends Authorization and X-Tenant-ID; see Getting started.
Example request
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.
{
"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)
| Field | Type | Description |
|---|---|---|
queued | boolean | Example |
export_id | string | Example |
message | string | Example |
401 Not signed in
Missing, invalid or expired API key.
{
"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)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |
errors | any or null | Null on this status. |
code | string | Machine-readable reason, for branching on in client code. One of: |
403 Not allowed
The caller's role may not export payables.
{
"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)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |
errors | any or null | Null on this status. |
code | string | Always empty on this status. Example |
429 Too many requests
Rate limit exceeded. See Retry-After.
{
"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)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |
errors | any or null | Null on this status. |
code | string | Machine-readable reason, for branching on in client code. One of: |
500 Server error
Export failed
{
"success": false,
"message": "An unexpected error occurred."
}Response fields (2)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |