API reference › Finance › Pro formas

Retrieve pro formas by client ID

GET /v1/finance/pro-formas/by-client/{client_id}

Scope
finance:read
Roles
admin, scheduler

Fetches a paginated list of pro formas for a specific client with filtering and sorting options.

Parameters

Path parameters

NameTypeDescription
client_id requiredstring

Client ID

Example CLT-12345.

Query parameters

NameTypeDescription
searchstring

Search query to filter pro formas

Example PF-001.

columnsstring

Comma-separated list of columns to search in

Example proForma,client.

statusIdinteger

Filter by status ID

Example 1.

startDatestring (date)

Filter from this date (YYYY-MM-DD)

Example 2025-01-01.

endDatestring (date)

Filter until this date (YYYY-MM-DD)

Example 2025-12-31.

sortBystring

Sort by field

Example created_at.

sortOrderstring

Sort order

One of: asc, desc. Example desc.

perPageinteger

Items per page

Example 10.

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

Example request

Shell
curl "https://api.fetchfido.ai/v1/finance/pro-formas/by-client/{client_id}" \
  -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": [
    {
      "id": "PF-1IU6BD",
      "is_paid": false,
      "paid_label": "string",
      "client": {
        "id": "CLT-N3B72G",
        "name": "Example label",
        "email": "string",
        "logo": "string",
        "onlineStatus": "string"
      },
      "issueDate": "01/15/2025",
      "dueDate": "01/30/2025",
      "expiryDate": "02/15/2025",
      "isExpired": false,
      "paymentTerms": {
        "id": 1,
        "label": "Example label"
      },
      "taxPercentage": 8.25,
      "discountAmount": 0,
      "subtotal": 1250.5,
      "balanceDue": 1250.5,
      "portal_accessible": true,
      "invoiceIds": [
        {
          "id": "INV-QKPWQ9"
        }
      ],
      "assignmentIds": [
        "ASG-SA2IVL"
      ],
      "shiftIds": [
        "SFT-9D2KQ1"
      ]
    }
  ],
  "meta": {
    "currentPage": 1,
    "lastPage": 4,
    "perPage": 10,
    "total": 37
  }
}
Response fields (32)

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

FieldTypeDescription
successboolean

Example true.

dataarray of object (25 nested)

Pro forma rows, the same shape the pro forma list returns.

metaobject (4 nested)

Nested fields

data 25 fields
FieldTypeDescription
data[].idstring

Example PF-1IU6BD.

data[].is_paidboolean

Example false.

data[].paid_labelstring or null
data[].clientobject
data[].client.idstring

Example CLT-N3B72G.

data[].client.namestring

Example Example label.

data[].client.emailstring or null
data[].client.logostring or null
data[].client.onlineStatusstring or null
data[].issueDatestring or null

Example 01/15/2025.

data[].dueDatestring or null

Example 01/30/2025.

data[].expiryDatestring or null

Example 02/15/2025.

data[].isExpiredboolean

Example false.

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

Example 1.

data[].paymentTerms.labelstring or null

Example Example label.

data[].taxPercentagenumber (float) or null

Example 8.25.

data[].discountAmountnumber (float) or null

Example 0.

data[].subtotalnumber (float)

Example 1250.5.

data[].balanceDuenumber (float)

Example 1250.5.

data[].portal_accessibleboolean

Example true.

data[].invoiceIdsarray of object
data[].invoiceIds[].idstring

Example INV-QKPWQ9.

data[].assignmentIdsarray of string
data[].shiftIdsarray of string
meta 4 fields
FieldTypeDescription
meta.currentPageinteger

Example 1.

meta.lastPageinteger

Example 4.

meta.perPageinteger

Example 10.

meta.totalinteger

Example 37.

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 .

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

Server error

JSON
{
  "success": false,
  "message": "An unexpected error occurred — please try again.",
  "errors": null,
  "code": ""
}
Response fields (4)
FieldTypeDescription
successboolean

Example false.

messagestring

Example An unexpected error occurred — please try again..

errorsstring or null

Null in production. The exception message only when the application runs with debug on, so nothing is leaked to an integrator.

codestring

Always empty: the server-error response carries no error code.

Example .