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 (2.1, 2.2, or 2.3).

string

ubl_json

required

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

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

buyer_contact_id

required

UUID of the address book contact this invoice was issued to, if any.

string | null

branding_profile_id

required

UUID of the branding profile used for the PDF; null means the company default profile.

string | null

related_invoice_id

required

string | null

payment_status

required

string | null

total_paid_cents

required

integer

is_test

required

boolean

metadata_json

required

Public invoice metadata, e.g. the delivery method. Always a JSON object.

object

key

additional properties

delivery_method

required

Delivery method selected when sending: auto, peppol, email, etc.

peppol_response

Final Peppol access-point response for the send attempt.

mlr_sent_at

required

Timestamp the Message Level Response was forwarded, if any.

mls

required

Outbound Message Level Response verdict from the recipient’s access point:

• verdict: received_ap (delivered) | received_ab (delivered with note) | received_re (rejected)
• received_at: ISO 8601 timestamp the MLR was processed by the AP
• error_details: rejection reason if verdict is received_re Null until the recipient AP returns an MLR or 72h elapses.

string | null

documents

Array<object>

DocumentResource

object

id

required

string

type

required

string

status

required

string

original_filename

required

string

mime_type

required

string

size

required

integer

human_size

required

string

has_thumbnail

required

boolean

is_image

required

boolean

tags

Array<object>

TagResource

object

id

required

string

name

required

string

slug

required

string

is_generic

required

boolean

created_at

required

string

documentable_key

required

string | null

documentable_id

required

integer | null

uploaded_by

Array

metadata

required

string

is_deletable

required

boolean

deletable_reason

required

string | null

created_at

required

string

checksum

string

virus_scanned_at

string | null

updated_at

string

created_at

required

ISO 8601 timestamp when the invoice was created.

string | null

updated_at

required

ISO 8601 timestamp when the invoice was last updated.

string | null

deleted_at

required

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

string | null

public_access_revoked_at

required

ISO 8601 timestamp when the public (signed-URL) link was revoked, or null if active.

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.