Get Invoice

GET

/invoices/{id}

Retrieve a single invoice by its UUID, including all fields and related company/user data. Requires the invoice:read scope.

Authorizations

• apiKey

Parameters

Path Parameters

id

required

string

uuid

required

string format: uuid

The UUID of the invoice.

Responses

200

Full invoice object with company and user relations.

object

data

required

InvoiceResource

object

id

required

Unique invoice identifier (UUID).

string

company_id

required

UUID of the company that owns this invoice.

string

user_id

required

UUID of the user who created the invoice, if applicable.

string | null

state

required

Current workflow state: draft, approved, sending, sent, delivered, failed, or cancelled.

string

direction

required

Invoice direction: outgoing (sent by company) or incoming (received).

string

amount

required

Invoice total amount in cents.

integer

currency

required

ISO 4217 currency code (e.g. EUR, USD).

string

ubl_version

required

UBL specification version used. Peppol BIS 3.0 binds to UBL 2.1.

string

ubl_json

required

Full invoice data in structured UBL JSON format (header, seller, buyer, items, totals, etc.).

object | null

metadata_json

required

Additional metadata such as delivery details, error info, or processing history.

object | null

delivery_network_id

required

Delivery network used: peppol, ksef, or email.

string | null

business_entity_id

required

UUID of the business entity (seller identity) used for this invoice.

string | null

related_invoice_id

required

string | null

payment_status

required

string

total_paid_cents

required

integer

is_test

required

boolean

created_at

required

ISO 8601 timestamp when the invoice was created.

string

updated_at

required

ISO 8601 timestamp when the invoice was last updated.

string

deleted_at

required

ISO 8601 timestamp when the invoice was soft-deleted, or null.

string | null

404

Invoice not found or does not belong to your company.

object

message

required

string

Allowed value: Invoice not found.

422

API key is not associated with a company.

object

message

required

string

Allowed value: User must belong to a company.