API reference › Finance › Payables
Get detailed information for multiple payables
GET /v1/finance/payables-details
- Scope
finance:read- Roles
- admin, scheduler
Retrieves comprehensive details for multiple payables including provider information, assignments, shifts, financial summary, and line items. Used for selecting payables to include in payment statements.
Parameters
Query parameters
| Name | Type | Description |
|---|---|---|
ids required | string | Comma-separated list of Payable IDs to get details for Example |
Every call also sends Authorization and X-Tenant-ID; see Getting started.
Example request
curl "https://api.fetchfido.ai/v1/finance/payables-details?ids=PAYB-12345,PAYB-67890" \
-H "Authorization: Bearer $FIDO_API_KEY" \
-H "X-Tenant-ID: $FIDO_TENANT_ID"Try it
Responses
200 Payable details retrieved successfully
Payable details retrieved successfully
{
"success": true,
"message": "Payable details retrieved successfully",
"data": [
{
"id": "PAYB-12345",
"selectedPayableSummary": {
"id": "PAYB-12345",
"provider": {
"id": "SP-12345",
"name": "Archer Moon",
"email": "amanda890@ideo.com",
"phone": "(123) 456-7890"
},
"financialSummary": {
"totalPayableAmount": 178.5
},
"status": "Sent",
"total": 178.5,
"is_paid": false,
"paid_label": null
}
}
]
}Response fields (17)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |
data | array of object | |
data[].id | string | Payable id for list selection Example |
data[].selectedPayableSummary | object | Expanded payable card, mirroring invoice selectedInvoiceSummary. Same item shape as payment statement selectedPayablesSummary: provider profile block (contact info + role), per-assignment/shift Service Breakdown with itemized expenses, financialSummary and paymentHistory. |
data[].selectedPayableSummary.id | string | Example |
data[].selectedPayableSummary.provider | object | |
data[].selectedPayableSummary.provider.id | string | Example |
data[].selectedPayableSummary.provider.name | string | Example |
data[].selectedPayableSummary.provider.email | string | Example |
data[].selectedPayableSummary.provider.phone | string | Example |
data[].selectedPayableSummary.financialSummary | object | |
data[].selectedPayableSummary.financialSummary.totalPayableAmount | number (float) | Example |
data[].selectedPayableSummary.status | string | Example |
data[].selectedPayableSummary.total | number (float) | Example |
data[].selectedPayableSummary.is_paid | boolean | True if this payable is paid (status PAYABLE_PAID or balance_due <= 0 and paid_amount > 0). Exclude it from the payment statement total and charges. Example |
data[].selectedPayableSummary.paid_label | string or null | 'Paid in payable' when is_paid is true; null otherwise. |
400 Bad request
Missing required parameter
{
"success": false,
"message": "Missing required parameter: ids"
}Response fields (2)
| Field | Type | Description |
|---|---|---|
success | boolean | 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
Scope, tenant, IP allow-list or RBAC check failed.
{
"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
Internal server error
{
"success": false,
"message": "An unexpected error occurred"
}Response fields (2)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |