List Pro-Formas

Required scope: proforma:read

Lists pro-forma documents for one customer. Optionally restrict to one orderId. pageSize is capped at 100. Pro-formas are off-ledger previews, not booked invoices.

Generated Reference

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

Lists pro-forma documents for one customer with bounded pagination.

Request ListProFormasRequest

Response ListProFormasResponse

ListProFormasRequest

Field	Type	Description
customer_id	string	Customer whose pro-formas to list.
order_id	optional string	Restrict to pro-formas for one order.
page	int32	Zero-based page index.
page_size	int32	Page size, capped server-side.

ListProFormasResponse

Field	Type	Description
pro_formas	repeated ProForma	Pro-formas on the requested page.
total	int32	Total pro-formas matching the filters.

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

{
  "customerId": "<customer-id>",
  "orderId": "<order-id>",
  "page": 0,
  "pageSize": 50
}

Response

{
  "proFormas": [
    {
      "id": "<pro-forma-id>",
      "customerId": "<customer-id>",
      "orderId": "<order-id>",
      "orderVersion": 2,
      "status": "PUBLIC_PRO_FORMA_STATUS_DRAFT",
      "totalMinor": "151200",
      "currency": "EUR",
      "createdAt": "1737936000"
    }
  ],
  "total": 1
}