Developers
qashio.com

Get pool account by id

GET/public/v1/erp/pool_accounts/{poolAccountId}
Bearer token

Retrieve one pool account with its full funding and control configuration.

Returns a single pool account. The payload is the list entry plus how the account is topped up, the balance thresholds that trigger an automatic top-up, who is alerted when the balance runs low, and the spend controls applied to cards funded by it.

Path parameters

poolAccountIdstringrequired

the account identifier.

Response

One pool account object. All list fields, plus:

FieldTypeDescription
topup_configurationobject{ topup_type, auto_topup_enabled, auto_topup_amount, topup_frequency }
balance_and_topup_configurationobject{ topup_source, auto_topup_enabled, auto_topup_threshold, auto_topup_amount }
low_balance_alert_configurationobject{ alert_threshold_amount, notification_recipients }
spend_controlsobjectSpend limits applied to cards on this account
Response schema from the OpenAPI document
FieldTypeDescription
status_codeinteger
successboolean
dataobject
idstring
account_namestring
company_namestring
statusstring
currencystring
topup_typestring
allowed_max_balancestring
low_balance_notification_activeboolean
low_balance_notification_amountstring
spend_controlsstring
created_atstring
created_byobject
namestring
user_idstring
account_managersobject[]
idstring
namestring
labelstring
codestring
erp_internal_idstring
erp_codestring
topup_configurationobject
topup_typestring
auto_topup_enabledboolean
auto_topup_amountstring
topup_frequencystring
balance_and_topup_configurationobject
topup_sourcestring
auto_topup_enabledboolean
auto_topup_thresholdstring
auto_topup_amountstring
low_balance_alert_configurationobject
alert_threshold_amountstring
notification_recipientsobject[]
metaobject
request_idstring
timestampstring
6 nested fields
data.low_balance_alert_configuration.notification_recipients[].idstring
data.low_balance_alert_configuration.notification_recipients[].namestring
data.low_balance_alert_configuration.notification_recipients[].labelstring
data.low_balance_alert_configuration.notification_recipients[].codestring
data.low_balance_alert_configuration.notification_recipients[].erp_internal_idstring
data.low_balance_alert_configuration.notification_recipients[].erp_codestring

Errors

401, 403, 404.

  • 401Unauthorized - missing or invalid Bearer token
  • 404Not Found

Every error carries an errors[] array and a meta.request_id. See Errors for the full envelope.

This request takes no parameters.

Response

Send the request to see the response.

Esc

Start here

IntroductionIntegration walkthroughAuthenticationConventions

Popular endpoints

POSTExchange code for tokens/oauth2/tokenGETGet company summary/public/v1/erp/company/summaryGETList bank accounts/public/v1/erp/bank_accountsGETList cards/public/v1/erp/cardsGETList chart of accounts/public/v1/erp/chart_of_accounts