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
| Name | Type | Description |
|---|---|---|
client_id required | string | Client ID Example |
Query parameters
| Name | Type | Description |
|---|---|---|
search | string | Search query to filter pro formas Example |
columns | string | Comma-separated list of columns to search in Example |
statusId | integer | Filter by status ID Example |
startDate | string (date) | Filter from this date (YYYY-MM-DD) Example |
endDate | string (date) | Filter until this date (YYYY-MM-DD) Example |
sortBy | string | Sort by field Example |
sortOrder | string | Sort order One of: |
perPage | integer | Items per page Example |
Every call also sends Authorization and X-Tenant-ID; see Getting started.
Example request
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.
{
"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.
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
data | array of object (25 nested) | Pro forma rows, the same shape the pro forma list returns. |
meta | object (4 nested) |
Nested fields
data 25 fields
| Field | Type | Description |
|---|---|---|
data[].id | string | Example |
data[].is_paid | boolean | Example |
data[].paid_label | string or null | |
data[].client | object | |
data[].client.id | string | Example |
data[].client.name | string | Example |
data[].client.email | string or null | |
data[].client.logo | string or null | |
data[].client.onlineStatus | string or null | |
data[].issueDate | string or null | Example |
data[].dueDate | string or null | Example |
data[].expiryDate | string or null | Example |
data[].isExpired | boolean | Example |
data[].paymentTerms | object | |
data[].paymentTerms.id | integer or string | Example |
data[].paymentTerms.label | string or null | Example |
data[].taxPercentage | number (float) or null | Example |
data[].discountAmount | number (float) or null | Example |
data[].subtotal | number (float) | Example |
data[].balanceDue | number (float) | Example |
data[].portal_accessible | boolean | Example |
data[].invoiceIds | array of object | |
data[].invoiceIds[].id | string | Example |
data[].assignmentIds | array of string | |
data[].shiftIds | array of string |
meta 4 fields
| Field | Type | Description |
|---|---|---|
meta.currentPage | integer | Example |
meta.lastPage | integer | Example |
meta.perPage | integer | Example |
meta.total | integer | Example |
401 Not signed in
Missing, invalid or expired API key.
{
"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)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |
errors | any or null | Null on this status. |
code | string | Machine-readable reason, for branching on in client code. One of: |
403 Not allowed
Scope, tenant, IP allow-list or RBAC check failed.
{
"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)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |
errors | any or null | Null on this status. |
code | string | Always empty on this status. Example |
429 Too many requests
Rate limit exceeded. See Retry-After.
{
"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)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |
errors | any or null | Null on this status. |
code | string | Machine-readable reason, for branching on in client code. One of: |
500 Server error
Server error
{
"success": false,
"message": "An unexpected error occurred — please try again.",
"errors": null,
"code": ""
}Response fields (4)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |
errors | string or null | Null in production. The exception message only when the application runs with debug on, so nothing is leaked to an integrator. |
code | string | Always empty: the server-error response carries no error code. Example |