# Tills

The till is a cash register where money is kept, and where customers pay for what they have bought.

# The Till Object

# Sample

{
  "id": "8cd1956b",
  "business_date": "2019-02-22",
  "opening_amount": 1000,
  "closing_amount": 400,
  "opened_at": "2019-02-22 08:55:00",
  "closed_at": "2019-02-22 23:55:00",
  "estimated_cash": 300,
  "variance": 100,
  "user": {
    "id": "8fmlgmf"
  },
  "device": {
    "id": "8fmfp09r"
  },
  "branch": {
    "id": "8fdrg56"
  },
  "created_at": "2019-02-23 07:28:29",
  "updated_at": "2019-02-23 07:28:29"
}

# Attributes

Field	Type	Rule	Description
`id`	`string`		Unique identifier for the till
`business_date*`	`string`		The business date of the till.
`opening_amount*`	`double`		The opening amount of the till.
`closing_amount`	`double`		The closing amount of the till.
`opened_at*`	`string`		Time `YYYY-MM-DD HH-MM-SS` in UTC at which the till was opened.
`closed_at`	`string`		Time `YYYY-MM-DD HH-MM-SS` in UTC at which the till was closed.
`estimated_cash`	`double`		`Opening Amount` + `Sum of Cash payment method` - `Total cash Return`
`variance`	`double`		Difference between recorded cash and actual cash
`user*`	`object`	`includable`	The User object attached to the till.
`device*`	`object`	`includable`	The Device of the till.
`branch*`	`object`	`includable`	The Branch object attached to the till.
`created_at`	`string`	`sortable`	Time `YYYY-MM-DD HH-MM-SS` in UTC at which the object was created.
`updated_at`	`string`	`sortable`	Time `YYYY-MM-DD HH-MM-SS` in UTC at which the object was updated.

# List Tills

GET /tills

# Scope

operations.read

# Filters

user_id
device_id
branch_id
business_date
updated_after
is_deleted
created_on
updated_on

# Response

{
  "data": [
    {
      "id": "8cd1956b",
      "business_date": "2019-02-22",
      "opening_amount": 1000,
      "closing_amount": 400,
      "opened_at": "2019-02-22 08:55:00",
      "closed_at": "2019-02-22 23:55:00",
      "estimated_cash": 300,
      "variance": 100,
      "user": {
        "id": "8fmlgmf"
      },
      "device": {
        "id": "8fmfp09r"
      },
      "branch": {
        "id": "8fdrg56"
      },
      "created_at": "2019-02-23 07:28:29",
      "updated_at": "2019-02-23 07:28:29"
    }
  ]
}

# Get Till

GET /tills/{tillId}

# Scope

operations.read

# Response

{
  "id": "8cd1956b",
  "business_date": "2019-02-22",
  "opening_amount": 1000,
  "closing_amount": 400,
  "opened_at": "2019-02-22 08:55:00",
  "closed_at": "2019-02-22 23:55:00",
  "estimated_cash": 300,
  "variance": 100,
  "user": {
    "id": "8fmlgmf"
  },
  "device": {
    "id": "8fmfp09r"
  },
  "branch": {
    "id": "8fdrg56"
  },
  "created_at": "2019-02-23 07:28:29",
  "updated_at": "2019-02-23 07:28:29"
}

# Create Till

POST /tills

# Scope

operations.write

# Request

{
    "business_date": "2019-02-22",
    "opening_amount": 1000,
    "closing_amount": 400,
    "opened_at": "2019-02-22 08:55:00",
    "closed_at": "2019-02-22 23:55:00",
    "estimated_cash": 300,
    "variance": 100,
    "user_id": "8cd1956b",
    "device_id": "8cd1956b",
    "branch_id": "8cd1956b"
}

# Response

{
  "id": "8cd1956b",
  "business_date": "2019-02-22",
  "opening_amount": 1000,
  "closing_amount": 400,
  "opened_at": "2019-02-22 08:55:00",
  "closed_at": "2019-02-22 23:55:00",
  "estimated_cash": 300,
  "variance": 100,
  "user": {
    "id": "8fmlgmf"
  },
  "device": {
    "id": "8fmfp09r"
  },
  "branch": {
    "id": "8fdrg56"
  },
  "created_at": "2019-02-23 07:28:29",
  "updated_at": "2019-02-23 07:28:29"
}

← Taxes Timed Events →