Skip to main content
GET
Entity accounts

Overview

Accounts are child resources of person and company entities. Use them to register multiple accounts per customer, including accounts in different currencies. Every account has a client-defined externalId, an ISO 4217 currency, and at least one payment identifier. Account data is isolated to the current organization.

Endpoints

Reading requires entities:read. Mutations require entities:edit with the legacy entities:write fallback.

Account fields

At least one of accountNumber, cbu, cvu, iban, or alias is required when creating an account.

Create example

Setting isPrimary: true removes the primary flag from other accounts of the same entity and currency.

Errors