API reference › Finance › Payables
Retrieve a specific payable
GET /v1/finance/payables/{payable}
- Scope
finance:read- Roles
- admin, scheduler
Fetches detailed information about a specific payable including line items, billable_entities (linkage), billable_entities_pay_calc (per-entity pay metrics), compensation_summary, and attachments.
Parameters
Path parameters
| Name | Type | Description |
|---|---|---|
payable required | string | Payable ID Example |
Query parameters
| Name | Type | Description |
|---|---|---|
for_duplicate | boolean | If true, automatically zero amounts if the payable is paid (for duplication purposes) Example |
Every call also sends Authorization and X-Tenant-ID; see Getting started.
Example request
curl "https://api.fetchfido.ai/v1/finance/payables/{payable}" \
-H "Authorization: Bearer $FIDO_API_KEY" \
-H "X-Tenant-ID: $FIDO_TENANT_ID"Try it
Responses
200 Payable retrieved successfully
Payable retrieved successfully
{
"success": true,
"message": "Payable retrieved successfully.",
"data": {
"id": "PAY-ABC123",
"provider": {
"id": "USR-12345",
"name": "John Doe",
"email": "user@example.com"
},
"status": "paid",
"issueDate": "2025-01-01",
"approvalDate": "2025-01-15",
"subtotal": 150,
"taxAmount": 15,
"taxPercentage": 10,
"discountAmount": 10,
"total": 160,
"paidAmount": 160,
"balanceDue": 0,
"notes": "Approved for provider payout",
"paymentAcknowledgedAt": "2026-07-31 12:00:00",
"paymentAcknowledgedBy": {
"id": "USR-12345",
"name": "John Provider",
"image": null
},
"lineItems": [
{
"id": 1,
"title": "Shift Payment",
"description": "Payment for shift work",
"quantity": 1,
"unitPrice": 150,
"total": 150
}
],
"billable_entities": [
{
"type": "assignment",
"id": "ASG-M3PCU1",
"is_deleted": false
}
],
"billable_entities_pay_calc": [
{
"type": "assignment",
"id": "ASG-M3PCU1",
"pay_time_basis": {
"id": "string",
"label": "string",
"isCustom": false
},
"derived_hours_used_for_pay": 0,
"hours_used_for_pay": 0,
"is_hours_overridden": false,
"derived_pay_rate": 0,
"pay_rate": 0,
"is_pay_rate_overridden": false,
"services_charge": 0,
"pay_rate_breakdown": {
"base_rate": 45,
"base_hours": 8,
"rules_applied": [
null
],
"rate_lines": [
null
],
"summary": {
"total_hours": 8,
"total_service_charge": 382.5,
"effective_pay_rate": 47.81,
"line_count": 2
},
"effective_pay_rate": 46.67,
"total_service_charge": 360,
"source": "check_in",
"rate_source": "provider_rate",
"rate_source_label": "Provider Pay Rate",
"rate_source_description": "Driven by this provider's own custom pay rate configuration.",
"rate_source_is_mixed": false,
"rate_configuration": {
"source": null,
"label": "Default Pay Rate",
"description": "Driven by the organization default provider pay rate configuration.",
"is_mixed": false,
"rows": null
}
},
"rate_rules_suppressed": false,
"hours_override_reason": "string",
"pay_rate_override_reason": "string"
}
],
"compensation_summary": {
"workitems": [
{
"id": "ASG-12345",
"name": "Assignment Title",
"type": "assignment",
"pay_time_basis": "scheduled_time",
"hours_used_for_pay": 4,
"pay_rate": 65,
"services_charge": 260,
"service_cost": 260,
"expenses_total": 0,
"total_payment": 260
}
],
"service_cost": 260,
"expenses_total": 0,
"total": 260
},
"selectedPayableSummary": {},
"attachments": [
{
"id": 1,
"fileName": "payable.pdf",
"filePath": "path/to/file"
}
],
"billable_entities_billing": [
{}
],
"currency": {
"code": "USD",
"symbol": "$",
"label": "US Dollar"
},
"line_items": [
{
"id": 0,
"amount": 0,
"name": "string",
"description": "string",
"type": {
"id": 1,
"label": "Example"
}
}
],
"summary": {},
"payment_terms": {
"id": 1,
"label": "Example"
},
"issue_date": "2025-01-15",
"due_date": "2025-01-30",
"expiry_date": "string",
"is_expired": true,
"paid_at": "2025-01-20 14:05:00",
"updatedAt": "string",
"correctedAt": "string",
"internalNotes": "string",
"is_published": true,
"actions": [
"string"
],
"documents": {},
"refunds": [
{}
],
"attempts": [
{}
],
"customFields": {},
"payment_rollup": {},
"approvalStatus": "string",
"approvedBy": {},
"approvedAt": "string",
"approvalDeadlineAt": "string",
"requiresApproval": true,
"rejectionReason": "string",
"terminal_reason_code": "string",
"terminal_reason": "string",
"paymentSection": {},
"reversed_from_paid_at": "string",
"reverse_reason_code": {
"id": 1,
"label": "Example"
},
"reverse_reason": "string",
"reverse_payment_handling": {
"id": 1,
"label": "Example"
},
"fieldIsLocked": {},
"canOverrideLocks": true,
"overrideLocksApplied": true,
"promptResendOnSave": true,
"overpaymentGuard": true,
"hasOverpayment": true,
"overpaymentAmount": 0,
"is_corrected": true
}
}Response fields (143)
3 top-level fields; 1 hold nested fields, listed below.
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |
data | object (140 nested) | Fields every finance document detail shares. Each document type adds its own party and summary fields on top. Some keys appear only for some types or roles, as noted; portal callers (client, consumer, provider) never see internalNotes. |
Nested fields
data 140 fields
| Field | Type | Description |
|---|---|---|
data.id | string | Example |
data.provider | object | |
data.provider.id | string | Example |
data.provider.name | string | Example |
data.provider.email | string | Example |
data.status | string | Example |
data.issueDate | string (date) | Example |
data.approvalDate | string (date) | Example |
data.subtotal | number (float) | Example |
data.taxAmount | number (float) | Example |
data.taxPercentage | number (float) | Example |
data.discountAmount | number (float) | Example |
data.total | number (float) | Example |
data.paidAmount | number (float) | Example |
data.balanceDue | number (float) | Example |
data.notes | string | Example |
data.paymentAcknowledgedAt | string or null | Formatted like issue_date/paid_at via presentation settings (admin: Y-m-d H:i:s; portal: org date format). Example |
data.paymentAcknowledgedBy | object or null | |
data.paymentAcknowledgedBy.id | string | Example |
data.paymentAcknowledgedBy.name | string | Example |
data.paymentAcknowledgedBy.image | string or null | |
data.lineItems | array of object | |
data.lineItems[].id | integer | Example |
data.lineItems[].title | string | Example |
data.lineItems[].description | string | Example |
data.lineItems[].quantity | number (float) | Example |
data.lineItems[].unitPrice | number (float) | Example |
data.lineItems[].total | number (float) | Example |
data.billable_entities | array of object | |
data.billable_entities[].type | string | One of: |
data.billable_entities[].id | string | Example |
data.billable_entities[].is_deleted | boolean | Example |
data.billable_entities_pay_calc | array of object | |
data.billable_entities_pay_calc[].type | string | One of: |
data.billable_entities_pay_calc[].id | string | Example |
data.billable_entities_pay_calc[].pay_time_basis | object or null | |
data.billable_entities_pay_calc[].pay_time_basis.id | string | |
data.billable_entities_pay_calc[].pay_time_basis.label | string | |
data.billable_entities_pay_calc[].pay_time_basis.isCustom | boolean | Example |
data.billable_entities_pay_calc[].derived_hours_used_for_pay | number (float) or null | |
data.billable_entities_pay_calc[].hours_used_for_pay | number (float) or null | |
data.billable_entities_pay_calc[].is_hours_overridden | boolean | Example |
data.billable_entities_pay_calc[].derived_pay_rate | number (float) or null | |
data.billable_entities_pay_calc[].pay_rate | number (float) or null | |
data.billable_entities_pay_calc[].is_pay_rate_overridden | boolean | Example |
data.billable_entities_pay_calc[].services_charge | number (float) or null | |
data.billable_entities_pay_calc[].pay_rate_breakdown | object or null | |
data.billable_entities_pay_calc[].pay_rate_breakdown.base_rate | number (float) | Example |
data.billable_entities_pay_calc[].pay_rate_breakdown.base_hours | number (float) | Example |
data.billable_entities_pay_calc[].pay_rate_breakdown.rules_applied | array of object | |
data.billable_entities_pay_calc[].pay_rate_breakdown.rate_lines | array of object | |
data.billable_entities_pay_calc[].pay_rate_breakdown.summary | object | |
data.billable_entities_pay_calc[].pay_rate_breakdown.effective_pay_rate | number (float) | Example |
data.billable_entities_pay_calc[].pay_rate_breakdown.total_service_charge | number (float) | Example |
data.billable_entities_pay_calc[].pay_rate_breakdown.source | string | Which time basis priced the lines — not where the rate came from; see rate_source. One of: |
data.billable_entities_pay_calc[].pay_rate_breakdown.rate_source | string or null | Which rate configuration drove this pay calculation. Null when the lines disagree (see rate_source_is_mixed) or nothing is stamped. One of: |
data.billable_entities_pay_calc[].pay_rate_breakdown.rate_source_label | string or null | Display name — 'Provider Pay Rate', 'Default Pay Rate', 'Fallback Pay Rate', or 'Mixed Rate Configuration'. Example |
data.billable_entities_pay_calc[].pay_rate_breakdown.rate_source_description | string or null | Example |
data.billable_entities_pay_calc[].pay_rate_breakdown.rate_source_is_mixed | boolean | True when the lines were priced from more than one rate configuration. Example |
data.billable_entities_pay_calc[].pay_rate_breakdown.rate_configuration | object or null | Which rate configuration drove this calculation — backs the 'Rate rules applied' expansion, and expands rate_source with the per-combination rows behind it. Read-only, derived from the estimated-pay-rate rows stamped at pricing time. Absent when the pay rate was overridden, and on documents whose work items have no stamped rows. |
data.billable_entities_pay_calc[].rate_rules_suppressed | boolean | Example |
data.billable_entities_pay_calc[].hours_override_reason | string or null | Latest hours override reason (mirrors save input when is_hours_overridden). |
data.billable_entities_pay_calc[].pay_rate_override_reason | string or null | Latest pay rate override reason (mirrors save input when is_pay_rate_overridden). |
data.compensation_summary | object | |
data.compensation_summary.workitems | array of object | |
data.compensation_summary.workitems[].id | string | Example |
data.compensation_summary.workitems[].name | string | Example |
data.compensation_summary.workitems[].type | string | Example |
data.compensation_summary.workitems[].pay_time_basis | string or null | Example |
data.compensation_summary.workitems[].hours_used_for_pay | number (float) | Example |
data.compensation_summary.workitems[].pay_rate | number (float) | Example |
data.compensation_summary.workitems[].services_charge | number (float) | Example |
data.compensation_summary.workitems[].service_cost | number (float) | Example |
data.compensation_summary.workitems[].expenses_total | number (float) | Example |
data.compensation_summary.workitems[].total_payment | number (float) | Example |
data.compensation_summary.service_cost | number (float) | Example |
data.compensation_summary.expenses_total | number (float) | Example |
data.compensation_summary.total | number (float) | 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.attachments | array of object | |
data.attachments[].id | integer | Example |
data.attachments[].fileName | string | Example |
data.attachments[].filePath | string | Example |
data.billable_entities_billing | array of object | Per work-item billing intent, with the adminFeeBreakdown stored for each work item. |
data.currency | object | |
data.currency.code | string | Example |
data.currency.symbol | string | Example |
data.currency.label | string | Example |
data.line_items | array of object | |
data.line_items[].id | integer | |
data.line_items[].amount | number | |
data.line_items[].name | string or null | |
data.line_items[].description | string or null | |
data.line_items[].type | object | |
data.line_items[].type.id | integer or string | Example |
data.line_items[].type.label | string or null | Example |
data.summary | object | Totals for display: services and expense charges, tax, discount, payments applied, total and balance due. Admin and scheduler callers get the internal breakdown as well. |
data.payment_terms | object | |
data.payment_terms.id | integer or string | Example |
data.payment_terms.label | string or null | Example |
data.issue_date | string or null | Example |
data.due_date | string or null | Null on an organization summary invoice. Example |
data.expiry_date | string or null | Pro formas and payment statements only. |
data.is_expired | boolean or null | Pro formas only. |
data.paid_at | string or null | Example |
data.updatedAt | string or null | In the organization's date and time format. |
data.correctedAt | string or null | |
data.internalNotes | string or null | Staff only. |
data.is_published | boolean | |
data.actions | array of string | Actions the caller may take on this document now, such as send, mark_paid, void, download or send_message. |
data.documents | object or null | Attached files. |
data.refunds | array of object | Invoices only. |
data.attempts | array of object | Delivery and payment attempts on the document. |
data.customFields | object or null | |
data.payment_rollup | object or null | Pro formas and payment statements: Unpaid, Partially Paid or Paid, with the amounts behind it. |
data.approvalStatus | string or null | Invoices and pro formas, staff only. |
data.approvedBy | object or null | Invoices and pro formas, staff only. |
data.approvedAt | string or null | |
data.approvalDeadlineAt | string or null | |
data.requiresApproval | boolean or null | |
data.rejectionReason | string or null | Rejected pro formas only. |
data.terminal_reason_code | string or null | Why a canceled or void document ended. |
data.terminal_reason | string or null | |
data.paymentSection | object or null | Present when the caller can pay or record a payment. |
data.reversed_from_paid_at | string or null | Invoices only. |
data.reverse_reason_code | object | Invoices only. |
data.reverse_reason_code.id | integer or string | Example |
data.reverse_reason_code.label | string or null | Example |
data.reverse_reason | string or null | Invoices only. |
data.reverse_payment_handling | object | Invoices only. |
data.reverse_payment_handling.id | integer or string | Example |
data.reverse_payment_handling.label | string or null | Example |
data.fieldIsLocked | object | Per field: {disabled, reason, sensitive}. Drives which fields an edit may change. |
data.canOverrideLocks | boolean | |
data.overrideLocksApplied | boolean | True when the request sent override_locks=true and the caller may override. |
data.promptResendOnSave | boolean | A save should ask whether to resend the document. |
data.overpaymentGuard | boolean | |
data.hasOverpayment | boolean | |
data.overpaymentAmount | number or null | |
data.is_corrected | boolean |
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 |
404 Not found
Payable not found
{
"success": false,
"message": "Payable not found."
}Response fields (2)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | 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 |