Get company balance summary
GET
/company/summaryReturns the consolidated balance summary for the company in the companyId header, broken down across company funding, pool accounts, cards, and subsidiaries.
Header parameters
companyIdstringrequiredID of the company to filter records
x-api-keystringrequiredPlease provide a valid API Key
Response
| Field | Type | Description |
|---|---|---|
companyExternalId | string | |
companyName | string | |
currency | string | |
companyFundingBalance | number | |
poolAccountsBalance | number | |
cardsBalance | number | |
subsidiariesBalance | number | |
companyBalance | number |
Errors
400Bad Request
Every error carries an errors[] array and a meta.request_id. See Errors for the full envelope.