Get a single invoice by accounting ID

get

https://api.benjipays.com/v2/invoices/{invoiceId}

Returns the Benji summary DTO for an invoice by its accounting system ID (id on the invoice object). Pass ?include=accounting to nest the full stored invoice under data.accounting (fields from the accounting system plus our own).

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

invoiceId

string

required

length between 1 and 200

The accounting system invoice ID (e.g. the QuickBooks Id, Xero InvoiceID, or Business Central id). This is the value exposed as id on the invoice object.

Query Params

include

string

enum

When accounting, nests the full stored invoice under data.accounting (fields from the accounting system plus our own). Only available on the detail route.

Allowed:

Headers

X-Request-ID

uuid

Optional client-supplied unique ID for one request. The server generates a UUID v4 if omitted and always echoes the value in the response.

X-Correlation-ID

uuid

Optional ID that flows across service boundaries for distributed tracing. The server generates a UUID v4 if omitted and always echoes the value in the response.

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

application/problem+json

200Invoice detail (summary DTO; optional nested accounting)

401Unauthorized — invalid or missing authentication, or API access is not active for this organization (disabled or missing).

403Forbidden — missing required OAuth scope (organizations:invoices:read), insufficient live mapping permission on the API key owner (e.g. companyAdmin), and/or free trial ended without billing enabled. Scope, mapping, and billing state are independent gates; see response detail.

404Invoice not found

429Too Many Requests