Get Till Id Details

Retrieve detailed information for a specific till within your organization.


Prerequisites

  • Authentication: Basic or OAuth credentials
  • Default access group

Resource information

URI/v2/organization/till/{TILL ID}
HTTP MethodGET
PaginationNo
Batch supportNo
Rate limit informationNone

API endpoint example

https://eu.api.capillarytech.com/v2/organization/till/75161978

Path Parameter

NameTypeDescription
idintegerUnique identifier of the till to fetch

Example Request

curl --location 'https://eu.api.capillarytech.com/v2/organization/till/75161978' \
  --header 'Authorization: Basic Z2VvcmdlLmpvaG5zb246OTg4OTU2NWI4ODVhMmY4ZWE1MTk1MjA2NWEwYTEzNzg=' \
  --header 'Content-Type: application/json'

Success Response (200)

{
  "id": 75161978,
  "code": "aditi",
  "description": "Description of the till",  // Updated
  "name": "aditi",
  "type": "TILL",
  "referenceId": -1,
  "adminType": "Administration type of the till",  // Updated
  "isActive": true,
  "isOuEnabled": false,
  "timeZoneId": 191,
  "currencyId": 95,
  "languageId": 148,
  "customField": [],
  "default": false,
  "warnings": []
}

Response Fields

ParameterData TypeDescription
idintegerUnique identifier for the till.
codestringCode for the till.
descriptionstringDescription of the till.
namestringName of the till.
typestringType of the till.
referenceIdintegerExternal or upstream reference (if any); -1 indicates none.
adminTypestringAdministration type of the till (Admin/General).
isActivebooleanIndicates if the till is active.
isOuEnabledbooleanIndicates if the Organizational Unit (OU) is enabled for the till.
timeZoneIdintegerTime zone ID for the till.
currencyIdintegerCurrency ID for the till.
languageIdintegerLanguage ID for the till.
customFieldarrayCustom field and its details associated with the till.
defaultbooleantrue if this till is marked as the default for its org unit; false otherwise.
warningsarrayList of warnings related to the till.

Note:

  • For updates or to add custom fields, see the “Update Till” section in the API Reference.
Language
Credentials
Basic
base64
:
URL
Click Try It! to start a request and see the response here!