Skip to main content
GET
/
consumers
/
{consumer_id}
/
accounting
/
bookyears
Get Bookyears
curl --request GET \
  --url https://api.chift.eu/consumers/{consumer_id}/accounting/bookyears \
  --header 'Authorization: Bearer <token>'
{
  "items": [
    {
      "name": "<string>",
      "start": "2023-12-25",
      "end": "2023-12-25",
      "closed": true
    }
  ],
  "total": 1,
  "page": 2,
  "size": 2
}

Authorizations

​
Authorization
string
header
required

This access token needs to be included in each of your request to the Chift API.

Path Parameters

​
consumer_id
string<uuid>
required

Query Parameters

​
page
integer
default:1

Page number Page number

Required range: x >= 1
​
size
integer
default:50

Page size Page size

Required range: 1 <= x <= 100
​
folder_id
string | null

Id of the accounting folder instance. A folder represents a legal entity within the system. Required when the multiple folders feature is enabled.

Response

Successful Response

​
items
BookYear · object[]
required
​
total
integer
required
Required range: x >= 0
​
page
integer
required
Required range: x >= 1
​
size
integer
required
Required range: x >= 1