API reference › Finance › Payables

Retrieve payables by provider ID

GET /v1/finance/payables/by-provider/{provider_id}

Scope
finance:read
Roles
admin, scheduler

Fetches all matching payables for a specific provider with filtering and sorting options (no pagination).

Parameters

Path parameters

NameTypeDescription
provider_id requiredstring

Provider ID

Example USR-12345.

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

Example request

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

Try it

Responses

200 Payables retrieved successfully (non-paginated list)

Payables retrieved successfully (non-paginated list)

JSON
{
  "success": true,
  "message": "Payables retrieved successfully.",
  "data": [
    {
      "is_paid": 0,
      "paid_label": "Paid in payable",
      "provider": {
        "id": "string",
        "name": "Example name",
        "email": "user@example.com",
        "logo": "https://cdn.example.com/image.png",
        "onlineStatus": "online"
      },
      "paymentTerms": {
        "id": 1,
        "label": "Example label",
        "value": "string"
      },
      "issueDate": "2026-01-15",
      "dueDate": "2026-01-15",
      "approvedAt": "2026-01-15 09:00:00",
      "approvalDate": "2026-01-15",
      "taxPercentage": 0,
      "discountAmount": 0,
      "subtotal": 0,
      "paidAmount": 0,
      "balanceDue": 0,
      "assignmentIds": [
        null
      ],
      "shiftIds": [
        null
      ]
    }
  ]
}
Response fields (26)

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

FieldTypeDescription
successboolean

Example true.

messagestring

Example Payables retrieved successfully..

dataarray of object (23 nested)

Nested fields

data 23 fields
FieldTypeDescription
data[].is_paidnumber

Example 0.

data[].paid_labelstring or null

Example Paid in payable.

data[].providerobject or null
data[].provider.idstring
data[].provider.namestring

Example Example name.

data[].provider.emailstring

Example user@example.com.

data[].provider.logostring

Example https://cdn.example.com/image.png.

data[].provider.onlineStatusstring

Example online.

data[].paymentTermsobject or null
data[].paymentTerms.idinteger or null

Example 1.

data[].paymentTerms.labelstring or null

Example Example label.

data[].paymentTerms.valuestring or null
data[].issueDatestring or null

Example 2026-01-15.

data[].dueDatestring or null

Example 2026-01-15.

data[].approvedAtstring or null

Example 2026-01-15 09:00:00.

data[].approvalDatestring or null

Example 2026-01-15.

data[].taxPercentagenumber or null

Example 0.

data[].discountAmountnumber

Example 0.

data[].subtotalnumber

Example 0.

data[].paidAmountnumber

Example 0.

data[].balanceDuenumber

Example 0.

data[].assignmentIdsarray of any or null
data[].shiftIdsarray of any or null
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

Provider not found or no payables found

JSON
{
  "success": false,
  "message": "No payables found for this provider."
}
Response fields (2)
FieldTypeDescription
successboolean

Example false.

messagestring

Example No payables found for this provider..

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..