Skip to content
HeyX API

Create Invoice

Required scope: invoice:create

The invoice lines, currency, totals, customer, and portfolio are derived from the immutable commercial order revision. integrationId identifies a connected accounting integration configured in HeyX.

Generated Reference
POST /public-api/publicapi.v1.Invoice/CreateInvoice

Creates or returns the provider draft for an immutable order revision. Reusing idempotency_key with different input is rejected.

Request CreateInvoiceRequest
Response CreateInvoiceResponse

CreateInvoiceRequest

Field Type
integration_id string
order_id string
expected_order_version int32
idempotency_key string

CreateInvoiceResponse

Field Type
invoice Invoice

Related Types

Invoice

Field Type
id string
portfolio_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 
{
  "integrationId": "<accounting-integration-id>",
  "orderId": "<commercial-order-id>",
  "expectedOrderVersion": 2,
  "idempotencyKey": "erp-invoice-order-123-v2"
}

Retry an ambiguous timeout with the same idempotency key and identical input. Reusing the key with different input is rejected. Creation does not send the invoice.

HeyX API