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

NameTypeDescription
pro_forma requiredstring

Pro forma ID

Example PF-ABC123.

Query parameters

NameTypeDescription
for_duplicateboolean

If true, automatically zero amounts if the pro forma is accepted (for duplication purposes)

Example false.

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

Example request

Shell
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

JSON
{
  "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.

FieldTypeDescription
successboolean

Example true.

messagestring

Example Pro forma retrieved successfully..

dataobject (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
FieldTypeDescription
data.idinteger

Example 1.

data.proFormaNumberstring

Example PRF-20250101-0001.

data.clientobject
data.client.idstring

Example CLT-12345.

data.client.namestring

Example John Doe.

data.statusstring

Example sent.

data.issueDatestring (date)

Example 2025-01-01.

data.dueDatestring (date)

Example 2025-01-15.

data.totalnumber (float)

Example 150.

data.receiptAcknowledgedAtstring or null

Formatted like issue_date/paid_at via presentation settings (admin: Y-m-d H:i:s; portal: org date format).

Example 2026-07-31 12:00:00.

data.receiptAcknowledgedByobject or null
data.receiptAcknowledgedBy.idstring

Example CLT-12345.

data.receiptAcknowledgedBy.namestring

Example Jane Client.

data.receiptAcknowledgedBy.imagestring or null
data.paymentSectionobject or null

Client list/detail: present when actions includes initiate_payment (absent otherwise).

data.paymentSection.modestring

One of: external_url, custom_instructions. Example external_url.

data.paymentSection.externalUrlstring or null

Example https://pay.example/PF-1.

data.paymentSection.instructionsHtmlstring or null
data.paymentSection.labelstring

Example Payment.

data.lineItemsarray of object
data.lineItems[].idinteger

Example 1.

data.lineItems[].namestring

Example Service Fee.

data.lineItems[].amountnumber (float)

Example 150.

data.lineItems[].typestring

Example charges.

data.currencyobject
data.currency.codestring

Example USD.

data.currency.symbolstring

Example $.

data.currency.labelstring

Example US Dollar.

data.line_itemsarray of object
data.line_items[].idinteger
data.line_items[].amountnumber
data.line_items[].namestring or null
data.line_items[].descriptionstring or null
data.line_items[].typeobject
data.line_items[].type.idinteger or string

Example 1.

data.line_items[].type.labelstring or null

Example Example.

data.summaryobject

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_termsobject
data.payment_terms.idinteger or string

Example 1.

data.payment_terms.labelstring or null

Example Example.

data.issue_datestring or null

Example 2025-01-15.

data.due_datestring or null

Null on an organization summary invoice.

Example 2025-01-30.

data.expiry_datestring or null

Pro formas and payment statements only.

data.is_expiredboolean or null

Pro formas only.

data.paid_atstring or null

Example 2025-01-20 14:05:00.

data.updatedAtstring or null

In the organization's date and time format.

data.correctedAtstring or null
data.notesstring or null
data.internalNotesstring or null

Staff only.

data.is_publishedboolean
data.actionsarray of string

Actions the caller may take on this document now, such as send, mark_paid, void, download or send_message.

data.documentsobject or null

Attached files.

data.refundsarray of object

Invoices only.

data.billable_entitiesarray of object or null

Linked assignments and shifts, with is_deleted when the work item was removed.

data.billable_entities_billingarray of object
data.billable_entities_billing[].idstring

A work item listed in billable_entities.

Example ASG-YZXCIT.

data.billable_entities_billing[].billing_modestring or null

One of: bill, reference. Example bill.

data.billable_entities_billing[].bill_serviceboolean or null
data.billable_entities_billing[].bill_expensesboolean or null

Example true.

data.billable_entities_billing[].bill_admin_feeboolean or null

Example true.

data.billable_entities_billing[].adminFeeBreakdownobject or null
data.billable_entities_billing[].adminFeeBreakdown.feeSourcestring or null

One of: calculated, manual.

data.billable_entities_billing[].adminFeeBreakdown.clientsarray of object or null
data.billable_entities_billing[].adminFeeBreakdown.providersarray of object or null
data.attemptsarray of object

Delivery and payment attempts on the document.

data.customFieldsobject or null
data.payment_rollupobject or null

Pro formas and payment statements: Unpaid, Partially Paid or Paid, with the amounts behind it.

data.approvalStatusstring or null

Invoices and pro formas, staff only.

data.approvedByobject or null

Invoices and pro formas, staff only.

data.approvedAtstring or null
data.approvalDeadlineAtstring or null
data.requiresApprovalboolean or null
data.rejectionReasonstring or null

Rejected pro formas only.

data.terminal_reason_codestring or null

Why a canceled or void document ended.

data.terminal_reasonstring or null
data.reversed_from_paid_atstring or null

Invoices only.

data.reverse_reason_codeobject

Invoices only.

data.reverse_reason_code.idinteger or string

Example 1.

data.reverse_reason_code.labelstring or null

Example Example.

data.reverse_reasonstring or null

Invoices only.

data.reverse_payment_handlingobject

Invoices only.

data.reverse_payment_handling.idinteger or string

Example 1.

data.reverse_payment_handling.labelstring or null

Example Example.

data.fieldIsLockedobject

Per field: {disabled, reason, sensitive}. Drives which fields an edit may change.

data.canOverrideLocksboolean
data.overrideLocksAppliedboolean

True when the request sent override_locks=true and the caller may override.

data.promptResendOnSaveboolean

A save should ask whether to resend the document.

data.overpaymentGuardboolean
data.hasOverpaymentboolean
data.overpaymentAmountnumber or null
data.is_correctedboolean
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 .

404 Not found

Pro forma not found

JSON
{
  "success": false,
  "message": "Pro forma not found."
}
Response fields (2)
FieldTypeDescription
successboolean

Example false.

messagestring

Example Pro forma not found..

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..