v1

latestOpenAPI 3.1.0Copyright Pismo2026-07-247702,7523.1 MB

Buckets

Get account buckets

Get one or all buckets for a specific tenant. Buckets are accumulators that are related to an accounting script. Buckets can have their values changed with each related accounting entry.

get/v1/buckets

Query parameters

pageSizeinteger

Maximum number of accounting event types per page.

pageOffsetinteger

Number to offset page resuts. For example, value 2 returns the third page. Defaults to 0, which returns the first page.

accountIdinteger

Account ID

namestring

Bucket name

Response

has_nextboolean

Indicates whether there are more pages after the current page.

Example response

{
  "items": [
    {
      "name": "bacen_pre_2039",
      "account": 123456,
      "value": 100,
      "updated_at": "2021-06-26"
    }
  ]
}