Get My Teller Till List

Overview

Retrieves the list of tills belonging to the currently authenticated teller.

Command

GetMyTellerTillListQuery

Endpoint

POST /api/bpm/cmd

Request Headers

Authorization: Bearer {access_token}
Content-Type: application/json
X-Tenant-Id: {tenant_id}

Request Body

{
  "cmd": "GetMyTellerTillListQuery",
  "data": {
    "status": "Open",
    "currencyCode": "NGN",
    "pageNumber": 1,
    "pageSize": 20
  }
}

Request Parameters

Parameter	Type	Required	Description
cmd	string	Yes	Must be "GetMyTellerTillListQuery"
data	object	Yes	Filter criteria
↳ status	string	No	Filter by till status (Open, Closed)
↳ currencyCode	string	No	Filter by currency
↳ pageNumber	integer	No	Page number for pagination (default: 1)
↳ pageSize	integer	No	Number of records per page (default: 20)

Response

Success Response (200 OK)

{
  "success": true,
  "message": "My till list retrieved successfully",
  "data": {
    "tills": [
      {
        "tillId": "string",
        "branchId": "string",
        "branchName": "string",
        "currencyCode": "string",
        "currentBalance": "decimal",
        "openingBalance": "decimal",
        "status": "string",
        "shiftStartTime": "datetime",
        "transactionCount": "integer",
        "lastTransactionTime": "datetime"
      }
    ],
    "pagination": {
      "currentPage": 1,
      "pageSize": 20,
      "totalRecords": 5,
      "totalPages": 1
    }
  }
}

Error Responses

400 Bad Request

{
  "success": false,
  "message": "Invalid filter parameters"
}

401 Unauthorized

{
  "success": false,
  "message": "User is not a registered teller"
}

Business Rules

1. Only shows tills for the authenticated teller
2. Includes both open and closed tills
3. Results sorted by most recent first
4. Real-time balance information

Code Example

async function getMyTellerTills(status = 'Open') {
  const response = await fetch('/api/bpm/cmd', {
    method: 'POST',
    headers: {
      'Authorization': `Bearer ${accessToken}`,
      'Content-Type': 'application/json',
      'X-Tenant-Id': tenantId
    },
    body: JSON.stringify({
      commandType: 'GetMyTellerTillListQuery',
      data: {
        status: status,
        pageNumber: 1,
        pageSize: 10
      }
    })
  });
  
  return await response.json();
}

Related Commands

• Get Teller Till List - View all tills
• Open Teller Till - Open new till
• Get Teller Till Transaction List - View till transactions

Notes

• Useful for tellers to monitor their own till status
• Check for open tills before opening a new one
• Review transaction history regularly
• Ensure all tills are properly closed at end of shift