---
title: "View cash register balance"
method: GET
path: "/api/v1/cashRegisters/{id}/balance"
tags: ["Point Of Sale"]
---

# View cash register balance

`GET /api/v1/cashRegisters/{id}/balance`

## Request

- Base URL: `https://xentral.xentral.biz`
- URL: `https://xentral.xentral.biz/api/v1/cashRegisters/{id}/balance`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/xentral/apis/xentral-api/docs/api/v1/cashRegisters/:id/balance/get.ts> (a function with typed inputs; its response is checked against the schema)

Retrieves the balance of a cash register.

## Path parameters

- `id` string, required: Resource identifier.

## Response `200`

Operation completed successfully.

- object
  - `data` object, required
    - `openingBalance` string
    - `targetAmount` string

## Other responses

- `400`: IETF RFC 9457 Problem API compliant response
- `401`: Unable to authenticate the client
- `403`: Unable to authorize the client
- `404`: Resource was not found or not enough access privileges
- `406`: Requested resource representation does not exist.
- `429`: Too many API calls made.

---

[API](https://skmtc.dev/xentral/apis/xentral-api.md) - [All operations](https://skmtc.dev/xentral/apis/xentral-api/llms.txt) - [OpenAPI document](https://skmtc.dev/xentral/apis/xentral-api/revisions/ebe5ba2a4ed8?raw)