API reference › Finance › Pro formas
Retrieve pro formas for the authenticated user
GET /v1/finance/my-proformas
- Scope
finance:read- Roles
- admin, client, scheduler
Fetches a paginated list of pro formas for the current user (client) based on their role.
Parameters
Query parameters
| Name | Type | Description |
|---|---|---|
search | string | Search query to filter pro formas by pro forma number, client name, or email. Example |
status | string | Filter pro formas by status. One of: |
type | string | Filter by document generation type (manual or system_generated). Same as proformaType; takes precedence if both are sent. One of: |
proformaType | string | Filter by manual vs system_generated. Ignored if type is set. One of: |
startDate | string (date) | Filter pro formas created on or after this date (YYYY-MM-DD). Example |
endDate | string (date) | Filter pro formas created on or before this date (YYYY-MM-DD). Example |
sortBy | string | Sort pro formas by a specific field (e.g., 'created_at', 'total'). Example |
sortOrder | string | Sorting order: ascending ('asc') or descending ('desc'). One of: |
perPage | integer | Number of pro formas to retrieve per page. Example |
Every call also sends Authorization and X-Tenant-ID; see Getting started.
Example request
curl "https://api.fetchfido.ai/v1/finance/my-proformas" \
-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": [
{
"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": [
{
"id": "INV-ABC123",
"portal_accessible": false
}
],
"assignmentIds": [
null
],
"shiftIds": [
null
]
}
],
"meta": {
"currentPage": 1,
"lastPage": 5,
"perPage": 10,
"total": 50
}
}Response fields (29)
3 top-level fields; 2 hold nested fields, listed below.
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
data | array of object (22 nested) | |
meta | object (4 nested) |
Nested fields
data 22 fields
| Field | Type | Description |
|---|---|---|
data[].is_paid | boolean | Example |
data[].paid_label | string or null | Example |
data[].client | object | |
data[].client.id | string | Example |
data[].client.name | string | Example |
data[].client.email | string | Example |
data[].issueDate | string or null | Example |
data[].dueDate | string or null | Example |
data[].paymentTerms | object or null | |
data[].paymentTerms.id | integer | Example |
data[].paymentTerms.label | string | Example |
data[].taxPercentage | number or null | Example |
data[].discountAmount | number | Example |
data[].subtotal | number | Example |
data[].balanceDue | number | Example |
data[].expiryDate | string or null | Example |
data[].isExpired | boolean | Example |
data[].invoiceIds | array of object | Selected invoices on the pro forma with per-item portal linkability |
data[].invoiceIds[].id | string | Example |
data[].invoiceIds[].portal_accessible | boolean | When false, hide View in client portal and render inline from selectedInvoicesSummary on detail Example |
data[].assignmentIds | array of any | |
data[].shiftIds | array of any |
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
Unauthorized - Authentication required
{
"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
Internal Server Error
{
"success": false,
"message": "An unexpected error occurred."
}Response fields (2)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |