List Xero accounts for deposits

get

https://api.benjipays.com/v2/accounting-accounts

Returns live Xero chart accounts for the organization on the API key. purpose=prepayment returns the revenue-account set. The id is the value accepted as revenueAccountId on the deposit charge. purpose=overpayment returns bank accounts only. QuickBooks and Business Central return 400. These are not gateway deposit or refund accounts.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

purpose

string

enum

required

Which deposit the account is for. prepayment returns Xero revenue accounts (the id accepted as revenueAccountId). overpayment returns Xero bank accounts only.

Allowed:

limit

integer

1 to 1000

Defaults to 20

offset

integer

0 to 9007199254740991

Defaults to 0

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

200Paginated Xero chart-account list

400Bad request — missing or unknown purpose, or the organization is not Xero.

401Unauthorized

403Forbidden — missing scope organizations:accounting-accounts:read or the API key owner is not companyAdmin.

404Organization not found

429Too Many Requests