Get Pro-Forma

Required scope: proforma:read

Returns one pro-forma document by its stable ID: status, total, currency, line items, and the linked invoice ID once it is converted. A pro-forma is an off-ledger preview, not a booked invoice. Amounts are integer minor currency units.

Generated Reference

POST /public-api/publicapi.v1.ProForma/GetProForma

Returns a pro-forma document by its stable identifier.

Request GetProFormaRequest

Response GetProFormaResponse

GetProFormaRequest

Field	Type	Description
id	string	Stable identifier of the pro-forma to fetch.

GetProFormaResponse

Field	Type	Description
pro_forma	ProForma	The requested pro-forma.

Related Types

ProForma

Field	Type	Description
id	string	Stable pro-forma identifier.
customer_id	string	Customer the pro-forma belongs to.
order_id	string	Order the pro-forma was generated from.
order_version	int32	Order revision snapshotted into the pro-forma.
status	ProFormaStatus	Pro-forma lifecycle status.
total_minor	int64	Total amount in minor currency units.
currency	string	ISO 4217 currency code.
lines	repeated ProFormaLine	Pro-forma line items, in document order.
invoice_id	optional string	Linked invoice identifier once the pro-forma is converted, when set.
created_at	int64	Creation time as unix seconds.
finalized_at	optional int64	Finalization time as unix seconds, when finalized.

ProFormaLine

Field	Type	Description
description	string	Human-readable line description.
quantity	int32	Quantity on this line.
unit_price_minor	int64	Unit price in minor currency units.
vat_rate	double	VAT rate applied to this line as a fraction (for example 0.21 for 21%).

Request

{
  "id": "<pro-forma-id>"
}

Response

{
  "proForma": {
    "id": "<pro-forma-id>",
    "customerId": "<customer-id>",
    "orderId": "<order-id>",
    "orderVersion": 2,
    "status": "PUBLIC_PRO_FORMA_STATUS_FINALIZED",
    "totalMinor": "151200",
    "currency": "EUR",
    "lines": [
      { "description": "Solar panel", "quantity": 8, "unitPriceMinor": "18900", "vatRate": 0.21 }
    ],
    "invoiceId": "<invoice-id>",
    "createdAt": "1737936000",
    "finalizedAt": "1737939600"
  }
}