List account balances

List account balances

GEThttps://apione.zwapgrid.com/accounting/api/v1/consents/{consentId}/accountbalances

Path parameters

consentId*string (uuid)

The consent for which you wish to list account balances.

Query parameters

Header parameters

Response

200401403404501

OK

Body

application/json

metaPagedResultMetadata (object)

datanullable array of AccountBalanceSummaryDto (object)

Request

JavaScriptCurlPython

const response = await fetch('https://apione.zwapgrid.com/accounting/api/v1/consents/{consentId}/accountbalances', {
    method: 'GET',
    headers: {
      "x-correlation-id": "123e4567-e89b-12d3-a456-426614174000"
    },
});
const data = await response.json();

Response

200401403404

{
  "meta": {},
  "data": [
    {
      "accountingAccount": {
        "id": "text",
        "accountingAccountId": "text",
        "name": "text",
        "descriptions": [
          {
            "text": "text",
            "languageId": "text"
          }
        ],
        "accountingAccountTypeCode": {
          "code": "text",
          "listId": "text"
        }
      },
      "active": false,
      "balance": {
        "baseCurrencies": [
          {
            "currencyId": "text",
            "baseAmount": 0
          }
        ],
        "accountBalancePeriod": {
          "startDate": "text",
          "endDate": "text"
        }
      }
    }
  ]
}

NOTE: some systems only support yearly balance, in that case API.1 will override EndDate parameter to last month of the year.