API reference › Finance › Pro formas

Retrieve a list of pro forma invoices

GET /v1/finance/pro-formas

Scope
finance:read
Roles
admin, scheduler

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

Parameters

Query parameters

NameTypeDescription
searchstring

Search query to filter pro formas by specified columns.

Example PRF-001.

columnsstring

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

Example proForma,client.

statusstring

Filter pro formas by status.

One of: draft, sent, approved, rejected, converted. Example sent.

clientIdstring

Filter pro formas by client ID.

Example CLT-12345.

startDatestring (date)

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

Example 2025-01-01.

endDatestring (date)

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

Example 2025-12-31.

sortBystring

Sort pro formas 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 pro formas to retrieve per page.

Example 10.

typestring

Filter by document generation type (manual or system_generated). Same as proformaType; takes precedence if both are sent.

One of: manual, system_generated. Example manual.

proformaTypestring

Filter by manual vs system_generated. Ignored if type is set.

One of: manual, system_generated. Example manual.

approvalStatusstring

Filter pro formas by internal approval status.

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

isPublishedboolean

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

Example true.

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

Example request

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

Try it

Responses

200 Pro formas retrieved successfully

Pro formas retrieved successfully

JSON
{
  "success": true,
  "data": [
    {
      "is_paid": true,
      "paid_label": "Paid in pro forma",
      "client": {
        "id": "CLT-12345",
        "name": "John Doe",
        "email": "user@example.com"
      },
      "issueDate": "2026-01-15",
      "dueDate": "2026-01-15",
      "paymentTerms": {
        "id": 1,
        "label": "Example label"
      },
      "taxPercentage": 0,
      "discountAmount": 0,
      "subtotal": 0,
      "balanceDue": 0,
      "expiryDate": "2026-01-15",
      "isExpired": true,
      "invoiceIds": [
        null
      ],
      "assignmentIds": [
        null
      ],
      "shiftIds": [
        null
      ]
    }
  ],
  "meta": {
    "currentPage": 1,
    "lastPage": 5,
    "perPage": 10,
    "total": 50
  }
}
Response fields (27)

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

FieldTypeDescription
successboolean

Example true.

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

Nested fields

data 20 fields
FieldTypeDescription
data[].is_paidboolean

Example true.

data[].paid_labelstring or null

Example Paid in pro forma.

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

Example CLT-12345.

data[].client.namestring

Example John Doe.

data[].client.emailstring

Example user@example.com.

data[].issueDatestring or null

Example 2026-01-15.

data[].dueDatestring or null

Example 2026-01-15.

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

Example 1.

data[].paymentTerms.labelstring

Example Example label.

data[].taxPercentagenumber or null

Example 0.

data[].discountAmountnumber

Example 0.

data[].subtotalnumber

Example 0.

data[].balanceDuenumber

Example 0.

data[].expiryDatestring or null

Example 2026-01-15.

data[].isExpiredboolean

Example true.

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