Get a single customer by accounting ID

get

https://api.benjipays.com/v2/customers/{customerId}

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

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

customerId

string

required

length between 1 and 200

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

Query Params

include

string

enum

When accounting, nests the full stored customer 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

200Customer detail

401Unauthorized

403Forbidden — missing required OAuth scope (organizations:customers:read) and/or insufficient live mapping permission on the API key owner (e.g. companyAdmin). Scope and mapping are independent gates; see response detail.

404Customer not found

429Too Many Requests