Get Invoice

Required scope: invoice:read

Returns the invoice drafted for one order revision on a given accounting integration. integrationId identifies a connected accounting integration and expectedOrderVersion is the order revision the invoice was drafted for. Line amounts are integer minor currency units.

Generated Reference

POST /public-api/publicapi.v1.Invoice/GetInvoice

Returns the provider draft for an immutable order revision. Keyed by order and integration, not by invoice ID.

Request GetInvoiceRequest

Response GetInvoiceResponse

GetInvoiceRequest

Field	Type	Description
`order_id`	`string`	Order whose invoice to fetch.
`integration_id`	`string`	Accounting integration that owns the invoice.
`expected_order_version`	`int32`	Order revision the invoice was drafted for.

GetInvoiceResponse

Field	Type	Description
`invoice`	`Invoice`	The requested invoice.

Related Types

Invoice

Field	Type	Description
`id`	`string`
`customer_id`	`string`
`order_id`	`string`
`order_version`	`int32`
`integration_id`	`string`
`business_state`	`InvoiceBusinessState`
`delivery_state`	`InvoiceDeliveryState`
`sync_state`	`InvoiceSyncState`
`total_minor`	`int64`
`currency`	`string`
`external_number`	`optional string`
`external_url`	`optional string`
`created_at`	`int64`
`updated_at`	`int64`
`lines`	`repeated InvoiceLine`	Invoice line items, in document order.
`invoice_date`	`optional int64`	Invoice issue date as unix seconds, when set by the provider.
`due_date`	`optional int64`	Payment due date as unix seconds, when set by the provider.
`sent_at`	`optional int64`	Time the invoice was sent to the customer as unix seconds, when sent.

InvoiceLine

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

Request

{
  "orderId": "<order-id>",
  "integrationId": "<accounting-integration-id>",
  "expectedOrderVersion": 2
}

Response

{
  "invoice": {
    "id": "<invoice-id>",
    "orderId": "<order-id>",
    "status": "PUBLIC_INVOICE_STATUS_DRAFT",
    "currency": "EUR",
    "invoiceDate": "1737936000",
    "dueDate": "1740528000",
    "lines": [
      { "description": "Solar panel", "quantity": 8, "unitPriceMinor": "18900", "vatRate": 0.21 }
    ]
  }
}