Developers
qashio.com

Get company summary

GET/public/v1/erp/company/summary
Bearer token

Tell you who the token belongs to and how much money the company holds, broken down by where it sits.

Returns the profile of the company bound to your access token, together with a four-way split of its balance: funds held in the company's own funding account, funds distributed to pool accounts, funds loaded onto cards, and funds held by subsidiaries. All figures are reported in the company's own currency, and the four components add up exactly to company_balance. Use this as the headline figure in a dashboard, or as a reconciliation check before and after a bulk top-up.

Input

None beyond the access token.

Response

A single object.

FieldTypeDescription
company_external_idstringQashio identifier for the company
company_namestringCompany trading name, falling back to the legal name
currencystringReporting currency for every amount below (ISO 4217)
company_funding_balancenumberBalance in the company's main funding account
pool_accounts_balancenumberCombined balance across all pool accounts
cards_balancenumberCombined balance loaded onto cards
subsidiaries_balancenumberCombined balance held by subsidiary companies
company_balancenumberTotal of the four figures above
Response schema from the OpenAPI document
FieldTypeDescription
status_codeinteger
successboolean
dataobject
company_namestring
company_external_idstring
currencystring
company_funding_balancenumber
pool_accounts_balancenumber
cards_balancenumber
subsidiaries_balancenumber
company_balancenumber
metaobject
request_idstring
timestampstring

Errors

401, 403, 404 (company is not linked to an ERP record).


ERP master data

These four endpoints expose the reference data Qashio holds in sync with your accounting system. They are read-only: records are created and updated by the ERP sync, not through this API.

  • 401Unauthorized - missing or invalid Bearer token

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