API reference › Finance › Pro formas
Retrieve a specific pro forma invoice
GET /v1/finance/pro-formas/{pro_forma}
- Scope
finance:read- Roles
- admin, scheduler
Fetches detailed information about a specific pro forma including line items and client details.
Parameters
Path parameters
| Name | Type | Description |
|---|---|---|
pro_forma required | string | Pro forma ID Example |
Query parameters
| Name | Type | Description |
|---|---|---|
for_duplicate | boolean | If true, automatically zero amounts if the pro forma is accepted (for duplication purposes) Example |
Every call also sends Authorization and X-Tenant-ID; see Getting started.
Example request
curl "https://api.fetchfido.ai/v1/finance/pro-formas/{pro_forma}" \
-H "Authorization: Bearer $FIDO_API_KEY" \
-H "X-Tenant-ID: $FIDO_TENANT_ID"Try it
Responses
200 Pro forma retrieved successfully
Pro forma retrieved successfully
{
"success": true,
"message": "Pro forma retrieved successfully.",
"data": {
"id": 1,
"proFormaNumber": "PRF-20250101-0001",
"client": {
"id": "CLT-12345",
"name": "John Doe"
},
"status": "sent",
"issueDate": "2025-01-01",
"dueDate": "2025-01-15",
"total": 150,
"receiptAcknowledgedAt": "2026-07-31 12:00:00",
"receiptAcknowledgedBy": {
"id": "CLT-12345",
"name": "Jane Client",
"image": null
},
"paymentSection": {
"mode": "external_url",
"externalUrl": "https://pay.example/PF-1",
"instructionsHtml": "string",
"label": "Payment"
},
"lineItems": [
{
"id": 1,
"name": "Service Fee",
"amount": 150,
"type": "charges"
}
],
"currency": {
"code": "USD",
"symbol": "$",
"label": "US Dollar"
},
"line_items": [
{
"id": 0,
"amount": 0,
"name": "string",
"description": "string",
"type": {
"id": 1,
"label": "Example"
}
}
],
"summary": {},
"payment_terms": {
"id": 1,
"label": "Example"
},
"issue_date": "2025-01-15",
"due_date": "2025-01-30",
"expiry_date": "string",
"is_expired": true,
"paid_at": "2025-01-20 14:05:00",
"updatedAt": "string",
"correctedAt": "string",
"notes": "string",
"internalNotes": "string",
"is_published": true,
"actions": [
"string"
],
"documents": {},
"refunds": [
{}
],
"billable_entities": [
{}
],
"billable_entities_billing": [
{
"id": "ASG-YZXCIT",
"billing_mode": "bill",
"bill_service": true,
"bill_expenses": true,
"bill_admin_fee": true,
"adminFeeBreakdown": {
"feeSource": "calculated",
"clients": [
null
],
"providers": [
null
]
}
}
],
"attempts": [
{}
],
"customFields": {},
"payment_rollup": {},
"approvalStatus": "string",
"approvedBy": {},
"approvedAt": "string",
"approvalDeadlineAt": "string",
"requiresApproval": true,
"rejectionReason": "string",
"terminal_reason_code": "string",
"terminal_reason": "string",
"reversed_from_paid_at": "string",
"reverse_reason_code": {
"id": 1,
"label": "Example"
},
"reverse_reason": "string",
"reverse_payment_handling": {
"id": 1,
"label": "Example"
},
"fieldIsLocked": {},
"canOverrideLocks": true,
"overrideLocksApplied": true,
"promptResendOnSave": true,
"overpaymentGuard": true,
"hasOverpayment": true,
"overpaymentAmount": 0,
"is_corrected": true
}
}Response fields (94)
3 top-level fields; 1 hold nested fields, listed below.
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |
data | object (91 nested) | Fields every finance document detail shares. Each document type adds its own party and summary fields on top. Some keys appear only for some types or roles, as noted; portal callers (client, consumer, provider) never see internalNotes. |
Nested fields
data 91 fields
| Field | Type | Description |
|---|---|---|
data.id | integer | Example |
data.proFormaNumber | string | Example |
data.client | object | |
data.client.id | string | Example |
data.client.name | string | Example |
data.status | string | Example |
data.issueDate | string (date) | Example |
data.dueDate | string (date) | Example |
data.total | number (float) | Example |
data.receiptAcknowledgedAt | string or null | Formatted like issue_date/paid_at via presentation settings (admin: Y-m-d H:i:s; portal: org date format). Example |
data.receiptAcknowledgedBy | object or null | |
data.receiptAcknowledgedBy.id | string | Example |
data.receiptAcknowledgedBy.name | string | Example |
data.receiptAcknowledgedBy.image | string or null | |
data.paymentSection | object or null | Client list/detail: present when actions includes initiate_payment (absent otherwise). |
data.paymentSection.mode | string | One of: |
data.paymentSection.externalUrl | string or null | Example |
data.paymentSection.instructionsHtml | string or null | |
data.paymentSection.label | string | Example |
data.lineItems | array of object | |
data.lineItems[].id | integer | Example |
data.lineItems[].name | string | Example |
data.lineItems[].amount | number (float) | Example |
data.lineItems[].type | string | Example |
data.currency | object | |
data.currency.code | string | Example |
data.currency.symbol | string | Example |
data.currency.label | string | Example |
data.line_items | array of object | |
data.line_items[].id | integer | |
data.line_items[].amount | number | |
data.line_items[].name | string or null | |
data.line_items[].description | string or null | |
data.line_items[].type | object | |
data.line_items[].type.id | integer or string | Example |
data.line_items[].type.label | string or null | Example |
data.summary | object | Totals for display: services and expense charges, tax, discount, payments applied, total and balance due. Admin and scheduler callers get the internal breakdown as well. |
data.payment_terms | object | |
data.payment_terms.id | integer or string | Example |
data.payment_terms.label | string or null | Example |
data.issue_date | string or null | Example |
data.due_date | string or null | Null on an organization summary invoice. Example |
data.expiry_date | string or null | Pro formas and payment statements only. |
data.is_expired | boolean or null | Pro formas only. |
data.paid_at | string or null | Example |
data.updatedAt | string or null | In the organization's date and time format. |
data.correctedAt | string or null | |
data.notes | string or null | |
data.internalNotes | string or null | Staff only. |
data.is_published | boolean | |
data.actions | array of string | Actions the caller may take on this document now, such as send, mark_paid, void, download or send_message. |
data.documents | object or null | Attached files. |
data.refunds | array of object | Invoices only. |
data.billable_entities | array of object or null | Linked assignments and shifts, with is_deleted when the work item was removed. |
data.billable_entities_billing | array of object | |
data.billable_entities_billing[].id | string | A work item listed in billable_entities. Example |
data.billable_entities_billing[].billing_mode | string or null | One of: |
data.billable_entities_billing[].bill_service | boolean or null | |
data.billable_entities_billing[].bill_expenses | boolean or null | Example |
data.billable_entities_billing[].bill_admin_fee | boolean or null | Example |
data.billable_entities_billing[].adminFeeBreakdown | object or null | |
data.billable_entities_billing[].adminFeeBreakdown.feeSource | string or null | One of: |
data.billable_entities_billing[].adminFeeBreakdown.clients | array of object or null | |
data.billable_entities_billing[].adminFeeBreakdown.providers | array of object or null | |
data.attempts | array of object | Delivery and payment attempts on the document. |
data.customFields | object or null | |
data.payment_rollup | object or null | Pro formas and payment statements: Unpaid, Partially Paid or Paid, with the amounts behind it. |
data.approvalStatus | string or null | Invoices and pro formas, staff only. |
data.approvedBy | object or null | Invoices and pro formas, staff only. |
data.approvedAt | string or null | |
data.approvalDeadlineAt | string or null | |
data.requiresApproval | boolean or null | |
data.rejectionReason | string or null | Rejected pro formas only. |
data.terminal_reason_code | string or null | Why a canceled or void document ended. |
data.terminal_reason | string or null | |
data.reversed_from_paid_at | string or null | Invoices only. |
data.reverse_reason_code | object | Invoices only. |
data.reverse_reason_code.id | integer or string | Example |
data.reverse_reason_code.label | string or null | Example |
data.reverse_reason | string or null | Invoices only. |
data.reverse_payment_handling | object | Invoices only. |
data.reverse_payment_handling.id | integer or string | Example |
data.reverse_payment_handling.label | string or null | Example |
data.fieldIsLocked | object | Per field: {disabled, reason, sensitive}. Drives which fields an edit may change. |
data.canOverrideLocks | boolean | |
data.overrideLocksApplied | boolean | True when the request sent override_locks=true and the caller may override. |
data.promptResendOnSave | boolean | A save should ask whether to resend the document. |
data.overpaymentGuard | boolean | |
data.hasOverpayment | boolean | |
data.overpaymentAmount | number or null | |
data.is_corrected | boolean |
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 |
404 Not found
Pro forma not found
{
"success": false,
"message": "Pro forma not found."
}Response fields (2)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | 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 |