Cashbook Account API

Introduction

The cashbook accounts API provide endpoints to manage and fetch cashbook accounts used to create cashbook entries
using the cashbook entries API. They are defined as codes used to represent the reason of money movement done internally in a retail store. The account codes need to be defined internally by the business making use of them, these represent an incoming or outgoing money from a vault or cash register which are associated to a settlement. There are cashbook accounts relevant to the different kind of settlements they can be booked for: cash register or vault. The API so far offers two endpoints to get the available cashbook accounts for the two types of settlements.

For more details about this API usage check our API documentation

Preparation

  • Have an authenticated token from the authentication service, this token should be used as an authorization bearer token header for every request done in this API (more information about the authorization service here).

Get cashbook accounts for cash register settlements

In order to get the available cashbook accounts for cash register settlements a GET request need to be done using the path /cashbookaccounts/cashregister, no request body is required.

Example response:

{
"revenueAccounts": [
{
"code": "170",
"description": "Sonstige_Erträge"
},
{
"code": "171",
"description": "Ertrag_Getränkeautom"
},
{
"code": "172",
"description": "Ertrag_Vermietung"
}
],
"expensesAccounts": [
{
"code": "102",
"description": "Reinigungsmaterial"
},
{
"code": "103",
"description": "Büromaterial"
},
{
"code": "104",
"description": "Porto"
}
],
"apiResponseStatus": {
"responseCode": "I06202",
"message": "Cashbook accounts retrieved successfully."
}
}

Here are some important observations in the response:

  • revenueAccounts contains a list of cashbook accounts that represent a positive income of cash in the cash drawer (income).
  • expensesAccounts contains a list of cashbook accounts that represent a negative outcome of cash in the cash drawer (expense).
  • description tells what the cashbook account is supposed to represent in the internal business rules.
  • code is the specific code to be used to create cashbook entries in the cashbook entry API, the user needs to be aware the account used is to record an income or expense.

Get cashbook accounts for vault settlements

In order to get the available cashbook accounts for vault settlements a GET request need to be done using the path /cashbookaccounts/vault, no request body is required.

Example response:

{
"revenueAccounts": [
{
"code": "181",
"description": "Geldeinlage_bei_Neueröffnung"
},
{
"code": "186",
"description": "Rollengeldeinlage"
},
{
"code": "510",
"description": "Gutscheinausgabe"
}
],
"expensesAccounts": [
{
"code": "151",
"description": "Geldabgabe_für_Neueröffnung"
},
{
"code": "166",
"description": "Wechselgeld_an_Geldtransport"
}
],
"apiResponseStatus": {
"responseCode": "I06202",
"message": "Cashbook accounts retrieved successfully."
}
}

Here are some important observations in the response:

  • revenueAccounts contains a list of cashbook accounts that represent a positive income of cash in the vault (income).
  • expensesAccounts contains a list of cashbook accounts that represent a negative outcome of cash in the vault (expense).
  • description tells what the cashbook account is supposed to represent in the internal business rules.
  • code is the specific code to be used to create cashbook entries in the cashbook entry API, the user needs to be aware the account used is to record an income or expense.