ASDinCloudDocs
API ReferenceBank accounts

Bank accounts

View as Markdown

The bank account object

View as Markdown

Bank accounts identify where payments are received or paid out in the workspace.

Attributes

idinteger
Identifier assigned by the API.
namestring
Display name, up to 128 characters.
currencystring
One of EUR, USD, or GBP. Defaults to EUR on creation.
ibanstring or null
Account IBAN, up to 34 characters.
bicstring or null
Bank identifier code, up to 11 characters.
providerstring or null
Provider name, up to 32 characters.
external_refstring or null
Reference in your provider, up to 64 characters.
is_activeinteger
Use 1 for active or 0 for inactive. Defaults to 1 on creation.
selectedboolean
Set true to make this the selected account. This clears the flag on other accounts.

List bank accounts

View as Markdown
GET/api/v1/bank_accounts

Lists bank account records in the workspace.

Permissions

Send your API key in X-API-Key. Required permissions are Bank accounts → Read.

Query parameters

qstring
Search by name or IBAN.
is_activestring
Use true for active rows or false for inactive rows.
lengthinteger
Number of records to return.
startinteger
Zero-based offset.
drawstring
Optional request marker echoed in the response.
sortstring
Sort by id, name, iban, currency, is_active, selected, tsc, or tsu. Prefix the field name with a minus sign for descending order.
orderstring
Direction for unprefixed sort fields. Use asc or desc.

Returns

Returns items in data, counts before and after text search, and the optional draw marker.

Errors

401
The API key is missing or invalid.
403
The API key lacks the required permission.

Retrieve a bank account

View as Markdown
GET/api/v1/bank_accounts/{id}

Returns one bank account by ID.

Permissions

Send your API key in X-API-Key. Required permissions are Bank accounts → Read.

Path parameters

idintegerRequired
ID of the bank account.

Returns

The bank account is returned in data.

Errors

401
The API key is missing or invalid.
403
The API key lacks the required permission.
404
The requested record was not found.

Create a bank account

View as Markdown
POST/api/v1/bank_accounts

Creates a bank account.

Permissions

Send your API key in X-API-Key. Required permissions are Bank accounts → Write.

Body parameters

namestringRequired
Display name, up to 128 characters.
currencystring
One of EUR, USD, or GBP. Defaults to EUR on creation.
ibanstring or null
Account IBAN, up to 34 characters.
bicstring or null
Bank identifier code, up to 11 characters.
providerstring or null
Provider name, up to 32 characters.
external_refstring or null
Reference in your provider, up to 64 characters.
is_activeinteger
Use 1 for active or 0 for inactive. Defaults to 1 on creation.
selectedboolean
Set true to make this the selected account. This clears the flag on other accounts.

Returns

The created bank account is returned in data.

Errors

401
The API key is missing or invalid.
403
The API key lacks the required permission.
422
One or more fields failed validation.
500
The change could not be saved.

Update a bank account

View as Markdown
PATCH / PUT / POST/api/v1/bank_accounts/{id}

Updates a bank account by ID.

Permissions

Send your API key in X-API-Key. Required permissions are Bank accounts → Write.

Path parameters

idintegerRequired
ID of the bank account.

Body parameters

namestring
Display name, up to 128 characters.
currencystring
One of EUR, USD, or GBP. Defaults to EUR on creation.
ibanstring or null
Account IBAN, up to 34 characters.
bicstring or null
Bank identifier code, up to 11 characters.
providerstring or null
Provider name, up to 32 characters.
external_refstring or null
Reference in your provider, up to 64 characters.
is_activeinteger
Use 1 for active or 0 for inactive. Defaults to 1 on creation.
selectedboolean
Set true to make this the selected account. This clears the flag on other accounts.

Returns

Returns a successful update response.

Errors

401
The API key is missing or invalid.
403
The API key lacks the required permission.
404
The requested record was not found.
422
One or more fields failed validation.
500
The change could not be saved.

Delete a bank account

View as Markdown
DELETE/api/v1/bank_accounts/{id}
POST/api/v1/bank_accounts/{id}/delete

Removes a bank account when it can be safely removed.

Permissions

Send your API key in X-API-Key. Required permissions are Bank accounts → Write.

Path parameters

idintegerRequired
ID of the bank account.

Returns

Returns a successful removal response.

Errors

401
The API key is missing or invalid.
403
The API key lacks the required permission.
404
The requested record was not found.
400
The record is in use or could not be removed.