The endpoint
- GET /api/v1/closing/{clientId}/actualStock
returns the client's stock of means of payment. The stock is calculated based on previous bookings (cash opening, deposits, withdrawals,...). For vouchers (single/multi-purpose), the amount of all vouchers is returned.
Attention: The cash balance is not automatically transferred to the next day. If you want to start again with a cash balance, you need to post it again via POST /api/v1/closing/{clientId}/book/openingStock. This is mandatory in different countries.
Result
After execution, the current balance of the cash register is returned as the response.
Usage
This endpoint is used to obtain the current balance of cash and cash equivalents.
Prerequisites
You need a valid clientId to perform the operation.
Form Fields:
Field | Description | Examples |
clientId | The uniqueClientId of the cash register (from RetailForce system) | aa227e71-6775-45d0-ba73-85da33c34d37 |
Response
Possible responses:
Code | Description | Examples |
200 | Amount of today's cash balance | - |
Comments
0 comments
Please sign in to leave a comment.