Skip to navigation

Get invoice

View as Markdown

Get invoice by id

Retrieves the full invoice record for the given :id path parameter, scoped to the authenticated user/account.

Auth

x-api-key header with Merchant.invoice.read. Also accepts all internal auth methods (JWT user, POS JWT, limited JWT).

Path params

  • id (required): the invoice id.

Notas: Handler accepts an AuthOrPosUser (user or POS session). Response mirrors the Prisma Invoices model.

Authentication

x-api-keystring
API Key authentication via header

Path parameters

idstringRequired
Id of the invoice to retrieve.

Headers

x-application-account-idstringOptional

Scope the request to a specific store / account instead of the one resolved from the API key. Aliases: the x-account-id header, or the application_account_id / account_id query parameter.