API reference › Finance › Payables

Retrieve specific payable for logged-in provider user

GET /v1/finance/my-payables/{id}

Scope
finance:read
Roles
admin, service-provider, scheduler

Fetches detailed information about a specific payable for the authenticated provider user only.

Parameters

Path parameters

NameTypeDescription
id requiredstring

Payable ID

Example PAY-1T4MQI.

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

Example request

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

Try it

Responses

200 Payable retrieved successfully

Payable retrieved successfully

JSON
{
  "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"
      }
    ],
    "attachments": [
      {
        "id": 1,
        "fileName": "payable.pdf",
        "filePath": "path/to/file"
      }
    ],
    "compensation_summary": {
      "workitems": [
        {
          "id": "ASG-002-01",
          "name": "Medical Appointment",
          "type": "assignment",
          "pay_time_basis": "scheduled_time",
          "hours_used_for_pay": 14.5,
          "pay_rate": 25,
          "services_charge": 362.5,
          "hours": 14.5,
          "rate": 25,
          "unit": "hour",
          "expenses_total": 37.5,
          "all_expenses_total": 60,
          "service_cost": 362.5,
          "total_payment": 400,
          "expenses_breakdown": [
            null
          ]
        }
      ],
      "service_cost": 400,
      "expenses_total": 37.5,
      "all_expenses_total": 60,
      "total": 865,
      "payable_status": "Payable Approved"
    },
    "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": [
      {}
    ],
    "billable_entities_billing": [
      {
        "id": "ASG-YZXCIT",
        "billing_mode": "bill",
        "bill_service": true,
        "bill_expenses": true,
        "bill_admin_fee": true,
        "adminFeeBreakdown": {
          "feeSource": "calculated",
          "clients": [
            null
          ],
          "providers": [
            null
          ]
        }
      }
    ],
    "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 (158)

3 top-level fields; 1 hold nested fields, listed below.

FieldTypeDescription
successboolean

Example true.

messagestring

Example Payable retrieved successfully..

dataobject (155 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 155 fields
FieldTypeDescription
data.idstring

Example PAY-ABC123.

data.providerobject
data.provider.idstring

Example USR-12345.

data.provider.namestring

Example John Doe.

data.provider.emailstring

Example user@example.com.

data.statusstring

Example paid.

data.issueDatestring (date)

Example 2025-01-01.

data.approvalDatestring (date)

Example 2025-01-15.

data.subtotalnumber (float)

Example 150.

data.taxAmountnumber (float)

Example 15.

data.taxPercentagenumber (float)

Example 10.

data.discountAmountnumber (float)

Example 10.

data.totalnumber (float)

Example 160.

data.paidAmountnumber (float)

Example 160.

data.balanceDuenumber (float)

Example 0.

data.notesstring

Example Approved for provider payout.

data.paymentAcknowledgedAtstring or null

Formatted like issue_date/paid_at via presentation settings (admin: Y-m-d H:i:s; portal: org date format).

Example 2026-07-31 12:00:00.

data.paymentAcknowledgedByobject or null
data.paymentAcknowledgedBy.idstring

Example USR-12345.

data.paymentAcknowledgedBy.namestring

Example John Provider.

data.paymentAcknowledgedBy.imagestring or null
data.lineItemsarray of object
data.lineItems[].idinteger

Example 1.

data.lineItems[].titlestring

Example Shift Payment.

data.lineItems[].descriptionstring

Example Payment for shift work.

data.lineItems[].quantitynumber (float)

Example 1.

data.lineItems[].unitPricenumber (float)

Example 150.

data.lineItems[].totalnumber (float)

Example 150.

data.billable_entitiesarray of object
data.billable_entities[].typestring

One of: assignment, shift. Example assignment.

data.billable_entities[].idstring

Example ASG-M3PCU1.

data.billable_entities[].is_deletedboolean

Example false.

data.billable_entities_pay_calcarray of object
data.billable_entities_pay_calc[].typestring

One of: assignment, shift. Example assignment.

data.billable_entities_pay_calc[].idstring

Example ASG-M3PCU1.

data.billable_entities_pay_calc[].pay_time_basisobject or null
data.billable_entities_pay_calc[].pay_time_basis.idstring
data.billable_entities_pay_calc[].pay_time_basis.labelstring
data.billable_entities_pay_calc[].pay_time_basis.isCustomboolean

Example false.

data.billable_entities_pay_calc[].derived_hours_used_for_paynumber (float) or null
data.billable_entities_pay_calc[].hours_used_for_paynumber (float) or null
data.billable_entities_pay_calc[].is_hours_overriddenboolean

Example false.

data.billable_entities_pay_calc[].derived_pay_ratenumber (float) or null
data.billable_entities_pay_calc[].pay_ratenumber (float) or null
data.billable_entities_pay_calc[].is_pay_rate_overriddenboolean

Example false.

data.billable_entities_pay_calc[].services_chargenumber (float) or null
data.billable_entities_pay_calc[].pay_rate_breakdownobject or null
data.billable_entities_pay_calc[].pay_rate_breakdown.base_ratenumber (float)

Example 45.

data.billable_entities_pay_calc[].pay_rate_breakdown.base_hoursnumber (float)

Example 8.

data.billable_entities_pay_calc[].pay_rate_breakdown.rules_appliedarray of object
data.billable_entities_pay_calc[].pay_rate_breakdown.rate_linesarray of object
data.billable_entities_pay_calc[].pay_rate_breakdown.summaryobject
data.billable_entities_pay_calc[].pay_rate_breakdown.effective_pay_ratenumber (float)

Example 46.67.

data.billable_entities_pay_calc[].pay_rate_breakdown.total_service_chargenumber (float)

Example 360.

data.billable_entities_pay_calc[].pay_rate_breakdown.sourcestring

Which time basis priced the lines — not where the rate came from; see rate_source.

One of: check_in, estimated_pay.

data.billable_entities_pay_calc[].pay_rate_breakdown.rate_sourcestring 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: provider_rate, default_rate, fallback_rate. Example provider_rate.

data.billable_entities_pay_calc[].pay_rate_breakdown.rate_source_labelstring or null

Display name — 'Provider Pay Rate', 'Default Pay Rate', 'Fallback Pay Rate', or 'Mixed Rate Configuration'.

Example Provider Pay Rate.

data.billable_entities_pay_calc[].pay_rate_breakdown.rate_source_descriptionstring or null

Example Driven by this provider's own custom pay rate configuration..

data.billable_entities_pay_calc[].pay_rate_breakdown.rate_source_is_mixedboolean

True when the lines were priced from more than one rate configuration.

Example false.

data.billable_entities_pay_calc[].pay_rate_breakdown.rate_configurationobject 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_suppressedboolean

Example false.

data.billable_entities_pay_calc[].hours_override_reasonstring or null

Latest hours override reason (mirrors save input when is_hours_overridden).

data.billable_entities_pay_calc[].pay_rate_override_reasonstring or null

Latest pay rate override reason (mirrors save input when is_pay_rate_overridden).

data.attachmentsarray of object
data.attachments[].idinteger

Example 1.

data.attachments[].fileNamestring

Example payable.pdf.

data.attachments[].filePathstring

Example path/to/file.

data.compensation_summaryobject

Compensation breakdown for this payable

data.compensation_summary.workitemsarray of object
data.compensation_summary.workitems[].idstring

Example ASG-002-01.

data.compensation_summary.workitems[].namestring

Example Medical Appointment.

data.compensation_summary.workitems[].typestring

Example assignment.

data.compensation_summary.workitems[].pay_time_basisstring or null

Example scheduled_time.

data.compensation_summary.workitems[].hours_used_for_paynumber (float)

Example 14.5.

data.compensation_summary.workitems[].pay_ratenumber (float)

Example 25.

data.compensation_summary.workitems[].services_chargenumber (float)

Example 362.5.

data.compensation_summary.workitems[].hoursnumber (float)

Example 14.5.

data.compensation_summary.workitems[].ratenumber (float)

Example 25.

data.compensation_summary.workitems[].unitstring

Example hour.

data.compensation_summary.workitems[].expenses_totalnumber (float)

Example 37.5.

data.compensation_summary.workitems[].all_expenses_totalnumber (float)

Sum of all provider expenses for this work item across all statuses

Example 60.

data.compensation_summary.workitems[].service_costnumber (float)

Example 362.5.

data.compensation_summary.workitems[].total_paymentnumber (float)

Example 400.

data.compensation_summary.workitems[].expenses_breakdownarray of object

Per-expense breakdown for this work item

data.compensation_summary.service_costnumber (float)

Example 400.

data.compensation_summary.expenses_totalnumber (float)

Approved expenses total (used in total)

Example 37.5.

data.compensation_summary.all_expenses_totalnumber (float)

All expenses total across all statuses

Example 60.

data.compensation_summary.totalnumber (float)

Example 865.

data.compensation_summary.payable_statusstring or null

Example Payable Approved.

data.currencyobject
data.currency.codestring

Example USD.

data.currency.symbolstring

Example $.

data.currency.labelstring

Example US Dollar.

data.line_itemsarray of object
data.line_items[].idinteger
data.line_items[].amountnumber
data.line_items[].namestring or null
data.line_items[].descriptionstring or null
data.line_items[].typeobject
data.line_items[].type.idinteger or string

Example 1.

data.line_items[].type.labelstring or null

Example Example.

data.summaryobject

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_termsobject
data.payment_terms.idinteger or string

Example 1.

data.payment_terms.labelstring or null

Example Example.

data.issue_datestring or null

Example 2025-01-15.

data.due_datestring or null

Null on an organization summary invoice.

Example 2025-01-30.

data.expiry_datestring or null

Pro formas and payment statements only.

data.is_expiredboolean or null

Pro formas only.

data.paid_atstring or null

Example 2025-01-20 14:05:00.

data.updatedAtstring or null

In the organization's date and time format.

data.correctedAtstring or null
data.internalNotesstring or null

Staff only.

data.is_publishedboolean
data.actionsarray of string

Actions the caller may take on this document now, such as send, mark_paid, void, download or send_message.

data.documentsobject or null

Attached files.

data.refundsarray of object

Invoices only.

data.billable_entities_billingarray of object
data.billable_entities_billing[].idstring

A work item listed in billable_entities.

Example ASG-YZXCIT.

data.billable_entities_billing[].billing_modestring or null

One of: bill, reference. Example bill.

data.billable_entities_billing[].bill_serviceboolean or null
data.billable_entities_billing[].bill_expensesboolean or null

Example true.

data.billable_entities_billing[].bill_admin_feeboolean or null

Example true.

data.billable_entities_billing[].adminFeeBreakdownobject or null
data.billable_entities_billing[].adminFeeBreakdown.feeSourcestring or null

One of: calculated, manual.

data.billable_entities_billing[].adminFeeBreakdown.clientsarray of object or null
data.billable_entities_billing[].adminFeeBreakdown.providersarray of object or null
data.attemptsarray of object

Delivery and payment attempts on the document.

data.customFieldsobject or null
data.payment_rollupobject or null

Pro formas and payment statements: Unpaid, Partially Paid or Paid, with the amounts behind it.

data.approvalStatusstring or null

Invoices and pro formas, staff only.

data.approvedByobject or null

Invoices and pro formas, staff only.

data.approvedAtstring or null
data.approvalDeadlineAtstring or null
data.requiresApprovalboolean or null
data.rejectionReasonstring or null

Rejected pro formas only.

data.terminal_reason_codestring or null

Why a canceled or void document ended.

data.terminal_reasonstring or null
data.paymentSectionobject or null

Present when the caller can pay or record a payment.

data.reversed_from_paid_atstring or null

Invoices only.

data.reverse_reason_codeobject

Invoices only.

data.reverse_reason_code.idinteger or string

Example 1.

data.reverse_reason_code.labelstring or null

Example Example.

data.reverse_reasonstring or null

Invoices only.

data.reverse_payment_handlingobject

Invoices only.

data.reverse_payment_handling.idinteger or string

Example 1.

data.reverse_payment_handling.labelstring or null

Example Example.

data.fieldIsLockedobject

Per field: {disabled, reason, sensitive}. Drives which fields an edit may change.

data.canOverrideLocksboolean
data.overrideLocksAppliedboolean

True when the request sent override_locks=true and the caller may override.

data.promptResendOnSaveboolean

A save should ask whether to resend the document.

data.overpaymentGuardboolean
data.hasOverpaymentboolean
data.overpaymentAmountnumber or null
data.is_correctedboolean
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

Scope, tenant, IP allow-list or RBAC check failed.

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 .

404 Not found

Payable not found or not owned by user

JSON
{
  "success": false,
  "message": "Payable not found."
}
Response fields (2)
FieldTypeDescription
successboolean

Example false.

messagestring

Example Payable not found..

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

Internal Server Error

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

Example false.

messagestring

Example An unexpected error occurred..