Show menu
Login

till_session

The till_session Endpoint

A till session is a period of trading within a particular venue. Usually KOBAS customers operate a till session per trading day, but sometimes customers run a till session for lunch and a till session for the evening, and some customers run a till session for a whole weekend. When Closing Tasks are performed it is usual to compare the theoretical takings figures exposed by the EPoS systems with the cash and PDQ declarations, thus arriving at a variance.

While KOBAS Cloud will request that theoretical total cash and total cards figures be declared during the Closing Tasks process, it is possible for EPoS systems to notify KOBAS Cloud of those figures when the till session is finalised and the Z report is generated. Doing so simplifies the Closing Tasks process and reduces the possibility of human error.

 

Data information

The following attributes may be saved with POST or PUT requests. Key fields are mandatory with all requests. Other attributes may be available with GET requests. The KAPI may expose or remove other attributes at any time; only changes to those listed below will be notified in advance.

Attribute Type Key Description
sessionid Unsigned int Yes The till session id – must be unique per venueid
venueid Unsigned int Yes The venue id
startdate YYYY-MM-DD hh:mm:ss No Timestamp at the point the till session was started
enddate YYYY-MM-DD hh:mm:ss No Timestamp at the point the till session was finalised and Z report was produced
led Text No Comma separated string of EPoS item category lead types (e.g. “wet,food”)
consumptionmodes Text No Comma separated string of EPoS consumption modes in this session (e.g. “eatin,takeaway,wet”)
meta Array No An array of till session metadata (see below)

 

Till Session Metadata

KOBAS Cloud will accept meta data. It allows for name/value pairs (e.g. totalcash : £200.50) where each data pack may also be associated with a user id or a till name. Data without a userid or till set will be interpreted as the session total for that name/value. The minimum required data is tillz, tax, totalcash and totalcard.

 

Example JSON PUT Transmission

{
   "startdate":"2014-02-13 10:23:09",
   "enddate":"2014-02-13 12:00:11",
   "led":"food,tobacco,wet",
   "consumptionmodes":"eatin,takeaway,delivery",
   "meta":[
      {
         "name":"10pmgrosssales",
         "value":"140.00",
         "user":"0",
         "till":""
      },
      {
         "name":"10pmgrosssales",
         "value":"140.00",
         "user":"0",
         "till":"192.168.1.70"
      },
      {
         "name":"10pmgrosssales",
         "value":"140.00",
         "user":"1000",
         "till":""
      },
      {
         "name":"averagetransactionvalue",
         "value":"140.00",
         "user":"0",
         "till":""
      },
      {
         "name":"averagetransactionvalue",
         "value":"140.00",
         "user":"0",
         "till":"192.168.1.70"
      },
      {
         "name":"averagetransactionvalue",
         "value":"140.00",
         "user":"1000",
         "till":""
      },
      {
         "name":"covers",
         "value":"0.00",
         "user":"0",
         "till":""
      },
      {
         "name":"covers",
         "value":"0.00",
         "user":"0",
         "till":"192.168.1.70"
      },
      {
         "name":"covers",
         "value":"0.00",
         "user":"1000",
         "till":""
      },
      {
         "name":"deliverygrosssales",
         "value":"0.00",
         "user":"0",
         "till":""
      },
      {
         "name":"deliverygrosssales",
         "value":"0.00",
         "user":"0",
         "till":"192.168.1.70"
      },
      {
         "name":"deliverygrosssales",
         "value":"0.00",
         "user":"1000",
         "till":""
      },
      {
         "name":"deliverynetsales",
         "value":"0.00",
         "user":"0",
         "till":""
      },
      {
         "name":"deliverynetsales",
         "value":"0.00",
         "user":"0",
         "till":"192.168.1.70"
      },
      {
         "name":"deliverynetsales",
         "value":"0.00",
         "user":"1000",
         "till":""
      },
      {
         "name":"eatingrosssales",
         "value":"140.00",
         "user":"0",
         "till":""
      },
      {
         "name":"eatingrosssales",
         "value":"140.00",
         "user":"0",
         "till":"192.168.1.70"
      },
      {
         "name":"eatingrosssales",
         "value":"140.00",
         "user":"1000",
         "till":""
      },
      {
         "name":"eatinnetsales",
         "value":"116.67",
         "user":"0",
         "till":""
      },
      {
         "name":"eatinnetsales",
         "value":"116.67",
         "user":"0",
         "till":"192.168.1.70"
      },
      {
         "name":"eatinnetsales",
         "value":"116.67",
         "user":"1000",
         "till":""
      },
      {
         "name":"foodgrosssales",
         "value":"0.00",
         "user":"0",
         "till":""
      },
      {
         "name":"foodgrosssales",
         "value":"0.00",
         "user":"0",
         "till":"192.168.1.70"
      },
      {
         "name":"foodgrosssales",
         "value":"0.00",
         "user":"1000",
         "till":""
      },
      {
         "name":"foodnetsales",
         "value":"0.00",
         "user":"0",
         "till":""
      },
      {
         "name":"foodnetsales",
         "value":"0.00",
         "user":"0",
         "till":"192.168.1.70"
      },
      {
         "name":"foodnetsales",
         "value":"0.00",
         "user":"1000",
         "till":""
      },
      {
         "name":"foodrefunds",
         "value":"0.00",
         "user":"0",
         "till":""
      },
      {
         "name":"foodrefunds",
         "value":"0.00",
         "user":"0",
         "till":"192.168.1.70"
      },
      {
         "name":"foodrefunds",
         "value":"0.00",
         "user":"1000",
         "till":""
      },
      {
         "name":"midnightgrosssales",
         "value":"140.00",
         "user":"0",
         "till":""
      },
      {
         "name":"midnightgrosssales",
         "value":"140.00",
         "user":"0",
         "till":"192.168.1.70"
      },
      {
         "name":"midnightgrosssales",
         "value":"140.00",
         "user":"1000",
         "till":""
      },
      {
         "name":"promosales",
         "value":"0.00",
         "user":"0",
         "till":""
      },
      {
         "name":"promosales",
         "value":"0.00",
         "user":"0",
         "till":"192.168.1.70"
      },
      {
         "name":"promosales",
         "value":"0.00",
         "user":"1000",
         "till":""
      },
      {
         "name":"service-card",
         "value":"0.00",
         "user":"0",
         "till":""
      },
      {
         "name":"service-card",
         "value":"0.00",
         "user":"0",
         "till":"192.168.1.70"
      },
      {
         "name":"service-card",
         "value":"0.00",
         "user":"1000",
         "till":""
      },
      {
         "name":"service-cash",
         "value":"0.00",
         "user":"0",
         "till":""
      },
      {
         "name":"service-cash",
         "value":"0.00",
         "user":"0",
         "till":"192.168.1.70"
      },
      {
         "name":"service-cash",
         "value":"0.00",
         "user":"1000",
         "till":""
      },
      {
         "name":"service-earned",
         "value":"0.00",
         "user":"0",
         "till":""
      },
      {
         "name":"service-earned",
         "value":"0.00",
         "user":"0",
         "till":"192.168.1.70"
      },
      {
         "name":"service-earned",
         "value":"0.00",
         "user":"1000",
         "till":""
      },
      {
         "name":"taboutstandingcredit",
         "value":"0.00",
         "user":"0",
         "till":""
      },
      {
         "name":"taboutstandingcredit",
         "value":"0.00",
         "user":"0",
         "till":"192.168.1.70"
      },
      {
         "name":"taboutstandingcredit",
         "value":"0.00",
         "user":"1000",
         "till":""
      },
      {
         "name":"tabscreated",
         "value":"0.00",
         "user":"0",
         "till":""
      },
      {
         "name":"tabscreated",
         "value":"0.00",
         "user":"0",
         "till":"192.168.1.70"
      },
      {
         "name":"tabscreated",
         "value":"0.00",
         "user":"1000",
         "till":""
      },
      {
         "name":"tabstotal",
         "value":"0.00",
         "user":"0",
         "till":""
      },
      {
         "name":"tabstotal",
         "value":"0.00",
         "user":"0",
         "till":"192.168.1.70"
      },
      {
         "name":"tabstotal",
         "value":"0.00",
         "user":"1000",
         "till":""
      },
      {
         "name":"takeawaygrosssales",
         "value":"0.00",
         "user":"0",
         "till":""
      },
      {
         "name":"takeawaygrosssales",
         "value":"0.00",
         "user":"0",
         "till":"192.168.1.70"
      },
      {
         "name":"takeawaygrosssales",
         "value":"0.00",
         "user":"1000",
         "till":""
      },
      {
         "name":"takeawaynetsales",
         "value":"0.00",
         "user":"0",
         "till":""
      },
      {
         "name":"takeawaynetsales",
         "value":"0.00",
         "user":"0",
         "till":"192.168.1.70"
      },
      {
         "name":"takeawaynetsales",
         "value":"0.00",
         "user":"1000",
         "till":""
      },
      {
         "name":"tax",
         "value":"23.33",
         "user":"0",
         "till":""
      },
      {
         "name":"tillz",
         "value":"140.00",
         "user":"0",
         "till":""
      },
      {
         "name":"tips-card",
         "value":"0.00",
         "user":"0",
         "till":""
      },
      {
         "name":"tips-card",
         "value":"0.00",
         "user":"0",
         "till":"192.168.1.70"
      },
      {
         "name":"tips-card",
         "value":"0.00",
         "user":"1000",
         "till":""
      },
      {
         "name":"tobaccogrosssales",
         "value":"0.00",
         "user":"0",
         "till":""
      },
      {
         "name":"tobaccogrosssales",
         "value":"0.00",
         "user":"0",
         "till":"192.168.1.70"
      },
      {
         "name":"tobaccogrosssales",
         "value":"0.00",
         "user":"1000",
         "till":""
      },
      {
         "name":"tobacconetsales",
         "value":"0.00",
         "user":"0",
         "till":""
      },
      {
         "name":"tobacconetsales",
         "value":"0.00",
         "user":"0",
         "till":"192.168.1.70"
      },
      {
         "name":"tobacconetsales",
         "value":"0.00",
         "user":"1000",
         "till":""
      },
      {
         "name":"tobaccorefunds",
         "value":"0.00",
         "user":"0",
         "till":""
      },
      {
         "name":"tobaccorefunds",
         "value":"0.00",
         "user":"0",
         "till":"192.168.1.70"
      },
      {
         "name":"tobaccorefunds",
         "value":"0.00",
         "user":"1000",
         "till":""
      },
      {
         "name":"totalcards",
         "value":"140.00",
         "user":"0",
         "till":""
      },
      {
         "name":"totalcards",
         "value":"140.00",
         "user":"0",
         "till":"192.168.1.70"
      },
      {
         "name":"totalcards",
         "value":"140.00",
         "user":"1000",
         "till":""
      },
      {
         "name":"totalcash",
         "value":"0.00",
         "user":"0",
         "till":""
      },
      {
         "name":"totalcash",
         "value":"0.00",
         "user":"0",
         "till":"192.168.1.70"
      },
      {
         "name":"totalcash",
         "value":"0.00",
         "user":"1000",
         "till":""
      },
      {
         "name":"totalcomps",
         "value":"0.00",
         "user":"0",
         "till":""
      },
      {
         "name":"totalcomps",
         "value":"0.00",
         "user":"0",
         "till":"192.168.1.70"
      },
      {
         "name":"totalcomps",
         "value":"0.00",
         "user":"1000",
         "till":""
      },
      {
         "name":"totaldirectors",
         "value":"0.00",
         "user":"0",
         "till":""
      },
      {
         "name":"totaldirectors",
         "value":"0.00",
         "user":"0",
         "till":"192.168.1.70"
      },
      {
         "name":"totaldirectors",
         "value":"0.00",
         "user":"1000",
         "till":""
      },
      {
         "name":"totalfixeddiscounts",
         "value":"0.00",
         "user":"0",
         "till":""
      },
      {
         "name":"totalfixeddiscounts",
         "value":"0.00",
         "user":"0",
         "till":"192.168.1.70"
      },
      {
         "name":"totalfixeddiscounts",
         "value":"0.00",
         "user":"1000",
         "till":""
      },
      {
         "name":"totalgrosssales",
         "value":"140.00",
         "user":"0",
         "till":""
      },
      {
         "name":"totalgrosssales",
         "value":"140.00",
         "user":"0",
         "till":"192.168.1.70"
      },
      {
         "name":"totalgrosssales",
         "value":"140.00",
         "user":"1000",
         "till":""
      },
      {
         "name":"totalitemssold",
         "value":"7.00",
         "user":"0",
         "till":""
      },
      {
         "name":"totalitemssold",
         "value":"7.00",
         "user":"0",
         "till":"192.168.1.70"
      },
      {
         "name":"totalitemssold",
         "value":"7.00",
         "user":"1000",
         "till":""
      },
      {
         "name":"totalnetsales",
         "value":"116.67",
         "user":"0",
         "till":""
      },
      {
         "name":"totalnetsales",
         "value":"116.67",
         "user":"0",
         "till":"192.168.1.70"
      },
      {
         "name":"totalnetsales",
         "value":"116.67",
         "user":"1000",
         "till":""
      },
      {
         "name":"totalorders",
         "value":"1.00",
         "user":"0",
         "till":""
      },
      {
         "name":"totalorders",
         "value":"1.00",
         "user":"0",
         "till":"192.168.1.70"
      },
      {
         "name":"totalorders",
         "value":"1.00",
         "user":"1000",
         "till":""
      },
      {
         "name":"totalrefunds",
         "value":"0.00",
         "user":"0",
         "till":""
      },
      {
         "name":"totalrefunds",
         "value":"0.00",
         "user":"0",
         "till":"192.168.1.70"
      },
      {
         "name":"totalrefunds",
         "value":"0.00",
         "user":"1000",
         "till":""
      },
      {
         "name":"totalvouchers",
         "value":"0.00",
         "user":"0",
         "till":""
      },
      {
         "name":"totalvouchers",
         "value":"0.00",
         "user":"0",
         "till":"192.168.1.70"
      },
      {
         "name":"totalvouchers",
         "value":"0.00",
         "user":"1000",
         "till":""
      },
      {
         "name":"totalwaste",
         "value":"0.00",
         "user":"0",
         "till":""
      },
      {
         "name":"totalwaste",
         "value":"0.00",
         "user":"0",
         "till":"192.168.1.70"
      },
      {
         "name":"totalwaste",
         "value":"0.00",
         "user":"1000",
         "till":""
      },
      {
         "name":"wetgrosssales",
         "value":"140.00",
         "user":"0",
         "till":""
      },
      {
         "name":"wetgrosssales",
         "value":"0.00",
         "user":"0",
         "till":"192.168.1.70"
      },
      {
         "name":"wetgrosssales",
         "value":"0.00",
         "user":"1000",
         "till":""
      },
      {
         "name":"wetnetsales",
         "value":"116.67",
         "user":"0",
         "till":""
      },
      {
         "name":"wetnetsales",
         "value":"0.00",
         "user":"0",
         "till":"192.168.1.70"
      },
      {
         "name":"wetnetsales",
         "value":"0.00",
         "user":"1000",
         "till":""
      },
      {
         "name":"wetrefunds",
         "value":"0.00",
         "user":"0",
         "till":""
      },
      {
         "name":"wetrefunds",
         "value":"0.00",
         "user":"0",
         "till":"192.168.1.70"
      },
      {
         "name":"wetrefunds",
         "value":"0.00",
         "user":"1000",
         "till":""
      }
   ],
   "venueid":"1",
   "sessionid":"74"
}