Skip to main content
POST
cURL

Authorizations

Authorization
string
header
required

Bearer token: a Platform API Key (format: ak_live::) or a Personal Access Token (format: rgo-...). PATs always act as the token owner.

Body

application/json
label
string
required
Maximum string length: 120
iban
string
required
Maximum string length: 34
Pattern: IBAN_SHAPE
bic
string | null

The three optional details below accept null as well as a value: null is how an edit clears one. Without it there is no way to express "this account no longer has a BIC" or "this account is no longer tied to a currency" — an omitted field means "leave alone" to the update path, so a cleared input would save successfully and change nothing.

Maximum string length: 11
bankName
string | null
Maximum string length: 255
currency
string | null

ISO 4217. Null for an account usable with any currency.

Pattern: /^[A-Za-z]{3}$/
Example:

"CHF"

isDefault
boolean

Response

id
string
required
label
string
required

What the seller calls it, e.g. "CHF Konto" or "Hauptkonto".

iban
string
required
isDefault
boolean
required

Used when a document names no account and no currency match is found.

companyId
string
required
createdAt
string<date-time>
required
updatedAt
string<date-time>
required
bic
string | null
bankName
string | null
currency
string | null

ISO 4217 the account is held in. Null means "use for anything" — the point of the feature is matching an invoice's currency to an account, but a seller with one account per currency plus a catch-all should not be forced to label the catch-all.