---
title: "Retrieve a till balance"
method: GET
path: "/api/business/{businessId}/branch/{branchId}/till/{tillId}/balance"
tags: ["Till"]
---

# Retrieve a till balance

`GET /api/business/{businessId}/branch/{branchId}/till/{tillId}/balance`

## Request

- Base URL: `http://api-gateway-eu.phorest.com/third-party-api-server`
- URL: `http://api-gateway-eu.phorest.com/third-party-api-server/api/business/{businessId}/branch/{branchId}/till/{tillId}/balance`
- Auth: HTTP basic
- TypeScript: <https://skmtc.dev/phorest/apis/third-party-api/docs/api/business/:businessId/branch/:branchId/till/:tillId/balance/get.ts> (a function with typed inputs; its response is checked against the schema)

Get a till balance for the specified business id, client id and till id

## Path parameters

- `businessId` string, required
- `branchId` string, required
- `tillId` string, required

## Query parameters

- `include_integrated_payments` boolean

## Response `200`

Till balance retrieved

- TillBalanceResponse
  - `balances` PaymentAmount[]
    - `type` 'CASH' | 'CREDIT' | 'DEBIT' | 'PHOREST_PAY_CREDIT_CARD' | 'PHOREST_PAY_DEBIT_CARD' | 'CHEQUE' | 'VOUCHER' | 'ACCOUNT' | 'MEMBERSHIP' | 'APPOINTMENT_DEPOSIT' | 'OTHER'
    - `supplementalPaymentTypeRef` string, uri
    - `amount` number
  - `integratedPaymentsTotals` IntegratedPaymentTotal[]
    - `name` string
    - `localizedName` string
    - `amount` number

## Other responses

- `400`: Bad Request
- `404`: Business, branch, or till with the specified ids don't exist
- `429`: Request rate limit exceeded. Current limit set to 100 rps.
- `500`: Internal Server Error

## Changes

- **2026-11-03** `beea6ef29634`: 2 info
  - added the non-success response with the status `404`
  - added the non-success response with the status `429`

[Operation history](https://skmtc.dev/phorest/apis/third-party-api/changes/api/business/:businessId/branch/:branchId/till/:tillId/balance/get.md)

---

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