API reference › Finance › Invoices

Retrieve a list of invoices

GET /v1/finance/invoices

Scope
finance:read
Roles
admin, scheduler

Fetches a paginated list of invoices based on search criteria, filters, and sorting options.

Parameters

Query parameters

NameTypeDescription
searchstring

Search query to filter invoices by specified columns.

Example INV-001.

columnsstring

Comma-separated list of columns to search in (e.g., 'invoice,client,status,total').

Example invoice,client.

statusstring

Filter invoices by status.

One of: draft, sent, paid, overdue, canceled. Example paid.

clientIdstring

Filter invoices by client ID.

Example CLT-12345.

isOrganizationInvoiceboolean

Filter by invoice ownership scope. true = organization invoices, false = client invoices.

Example true.

invoiceTypestring

Filter by how the invoice was created: manual or system_generated (accepts enum value or label, e.g. system_generated or System generated).

One of: manual, system_generated. Example manual.

startDatestring (date)

Filter invoices created on or after this date (YYYY-MM-DD).

Example 2025-01-01.

endDatestring (date)

Filter invoices created on or before this date (YYYY-MM-DD).

Example 2025-12-31.

dueWithinDaysinteger

Filter invoices whose due_date falls within the next N days (today through today+N).

One of: 1, 3, 7. Example 7.

sortBystring

Sort invoices by a specific field (e.g., 'created_at', 'total').

Example created_at.

sortOrderstring

Sorting order: ascending ('asc') or descending ('desc').

One of: asc, desc. Example desc.

perPageinteger

Number of invoices to retrieve per page.

Example 10.

isPublishedboolean

Filter by the Publication Status column: true for published, false for drafts.

Example true.

approvalStatusstring

Filter invoices by internal approval status.

One of: pending, approved, rejected, cancelled. Example pending.

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

Example request

Shell
curl "https://api.fetchfido.ai/v1/finance/invoices" \
  -H "Authorization: Bearer $FIDO_API_KEY" \
  -H "X-Tenant-ID: $FIDO_TENANT_ID"

Try it

Responses

200 Invoices retrieved successfully

Invoices retrieved successfully

JSON
{
  "success": true,
  "data": [
    {
      "is_paid": true,
      "paid_label": "Paid in invoice",
      "isOrganizationInvoice": true,
      "billTo": "string",
      "clientsBreakdown": {
        "clients": [
          {
            "id": "CLT-12345",
            "name": "Client A",
            "logo": null,
            "totalBilledAmount": 250.5
          }
        ],
        "totalBilledToClients": 500.75
      },
      "client": {
        "id": "CLT-12345",
        "name": "John Doe",
        "email": "user@example.com"
      },
      "paymentTerms": {
        "id": 1,
        "label": "Example label"
      },
      "issueDate": "2026-01-15",
      "dueDate": "2026-01-15",
      "taxPercentage": 0,
      "discountAmount": 0,
      "subtotal": 0,
      "clientPaidAmount": "string",
      "orgCoveredAmount": 0,
      "creditsApplied": 0,
      "balanceDue": "string",
      "payableBalanceDue": "string",
      "assignmentIds": [
        null
      ],
      "shiftIds": [
        null
      ]
    }
  ],
  "meta": {
    "currentPage": 1,
    "lastPage": 5,
    "perPage": 10,
    "total": 50
  }
}
Response fields (37)

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

FieldTypeDescription
successboolean

Example true.

dataarray of object (30 nested)
metaobject (4 nested)

Nested fields

data 30 fields
FieldTypeDescription
data[].is_paidboolean

Example true.

data[].paid_labelstring or null

Example Paid in invoice.

data[].isOrganizationInvoiceboolean

Example true.

data[].billTostring
data[].clientsBreakdownobject or null

Present for organization invoices with linked work items.

data[].clientsBreakdown.clientsarray of object
data[].clientsBreakdown.clients[].idstring

Example CLT-12345.

data[].clientsBreakdown.clients[].namestring

Example Client A.

data[].clientsBreakdown.clients[].logostring or null
data[].clientsBreakdown.clients[].totalBilledAmountnumber (float)

Example 250.5.

data[].clientsBreakdown.totalBilledToClientsnumber (float)

Example 500.75.

data[].clientobject
data[].client.idstring

Example CLT-12345.

data[].client.namestring

Example John Doe.

data[].client.emailstring

Example user@example.com.

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

Example 1.

data[].paymentTerms.labelstring

Example Example label.

data[].issueDatestring or null

Example 2026-01-15.

data[].dueDatestring or null

Example 2026-01-15.

data[].taxPercentagenumber or null

Example 0.

data[].discountAmountnumber

Example 0.

data[].subtotalnumber

Example 0.

data[].clientPaidAmountstring
data[].orgCoveredAmountnumber

Example 0.

data[].creditsAppliednumber

Example 0.

data[].balanceDuestring
data[].payableBalanceDuestring
data[].assignmentIdsarray of any or null
data[].shiftIdsarray of any or null
meta 4 fields
FieldTypeDescription
meta.currentPageinteger

Example 1.

meta.lastPageinteger

Example 5.

meta.perPageinteger

Example 10.

meta.totalinteger

Example 50.

400 Bad request

Bad Request - Invalid query parameters

JSON
{
  "success": false,
  "message": "Invalid parameters."
}
Response fields (2)
FieldTypeDescription
successboolean

Example false.

messagestring

Example Invalid parameters..

401 Not signed in

Unauthorized - Authentication required

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 .

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