API reference › Finance › Pro formas

Convert accepted pro forma to invoice

POST /v1/finance/pro-formas/{id}/convert-to-invoice

Scope
finance:write
Roles
admin, scheduler

Converts an accepted pro forma invoice into a regular invoice. Requires proforma to be in PROFORMA_ACCEPTED status and not already converted.

Parameters

Path parameters

NameTypeDescription
id requiredstring

Pro forma ID

Example PF-ABC123.

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

Example request

Shell
curl -X POST "https://api.fetchfido.ai/v1/finance/pro-formas/{id}/convert-to-invoice" \
  -H "Authorization: Bearer $FIDO_API_KEY" \
  -H "X-Tenant-ID: $FIDO_TENANT_ID"

Try it

Responses

200 Pro forma converted to invoice successfully

Pro forma converted to invoice successfully

JSON
{
  "success": true,
  "message": "Pro forma converted to invoice successfully.",
  "data": {
    "invoice_id": "INV-ABC123",
    "pro_forma_id": "PF-ABC123"
  }
}
Response fields (5)
FieldTypeDescription
successboolean

Example true.

messagestring

Example Pro forma converted to invoice successfully..

dataobject
data.invoice_idstring

ID of the converted invoice (reused or newly created)

Example INV-ABC123.

data.pro_forma_idstring

Example PF-ABC123.

400 Bad request

Invalid pro forma status or already converted

JSON
{
  "success": false,
  "message": "Only accepted pro formas can be converted to invoices."
}
Response fields (2)
FieldTypeDescription
successboolean

Example false.

messagestring

Possible messages: 'Only accepted pro formas can be converted to invoices.' or 'This pro forma has already been converted to an invoice.'

Example Only accepted pro formas can be converted to invoices..

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:write' 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:write' 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

Unexpected error

JSON
{
  "success": false,
  "errors": "Conversion failed",
  "message": "Unable to convert pro forma to invoice. Please try again."
}
Response fields (3)
FieldTypeDescription
successboolean

Example false.

errorsstring or null

Null in production. The exception message only when the application runs with debug on.

Example Conversion failed.

messagestring

Example Unable to convert pro forma to invoice. Please try again..