getFinancialStatementPeriodSeries

READ

Multi-period financial statement balances: one column per bucket, powered by the accountTreeBalancePeriodSeries RPC (snapshot-based, single journal scan).

POST /api/v1/accounting/getFinancialStatementPeriodSeries

curl -X POST '<your-host>/api/v1/accounting/getFinancialStatementPeriodSeries' \
  -H 'Authorization: Bearer <api-key>' \
  -H 'Content-Type: application/json' \
  -d '{
    "buckets": []
  }'

Response

{
  "results": [
    {
      "accountType": "Bank",
      "active": true,
      "class": "Expense",
      "companyGroupId": "string",
      "consolidatedRate": "Average",
      "createdAt": "string",
      "createdBy": "string",
      "customFields": "…",
      "id": "string",
      "incomeBalance": "Balance Sheet",
      "isGroup": true,
      "isSystem": true,
      "name": "string",
      "number": "string",
      "parentId": "string",
      "tags": [
        "string"
      ],
      "updatedAt": "string",
      "updatedBy": "string",
      "periods": {
        "…": {
          "netChange": 0,
          "balanceAtDate": 0,
          "translatedBalance": 0,
          "translatedNetChange": 0,
          "exchangeRate": 0
        }
      }
    }
  ],
  "count": null
}

Parameters

ParameterType

Input schema

schema

{
  "type": "object",
  "properties": {
    "buckets": {
      "type": "array",
      "items": {}
    },
    "includeCurrentYearEarnings": {
      "type": "boolean"
    },
    "translate": {
      "type": "object",
      "properties": {
        "targetCurrency": {
          "type": "string"
        }
      },
      "required": [
        "targetCurrency"
      ]
    }
  },
  "required": [
    "buckets"
  ]
}