REST API v2.8

Cash Registers

Handle cash registers for a site.

Get Cash Registers

Endpoint

GET sites/{siteid}/cashregisters

Parameters

start

The index of the item to start fromDefault: 0

num

The number of items returnedDefault: 10

HTTP Response Status

200

OK. Returns data (see below).

400

Bad Request. Invalid syntax, missing required argument or invalid request.

401

Unauthorized. Authorization failed.

404

Resource not found. The url is invalid.

429

Too Many Requests.

500

Internal Server Error.

Returns

Returns an envelope with items of type posregister.

Example

Request

GET https://api.mysitoo.com/v2/accounts/1500/sites/1/cashregisters.json

Response

{ "totalcount": 1, "items": [ { "registerid": "{3CCB9848-155A-49E1-7CA8-5F7F78FC3067}", "manufacturerid": "SITOO3CCB9848155A49E17CA85F7F78FC3067", "registerkey": "SII0000001500001", "company": "Sitoo AB", "companyid": "556677-8899", "address": "Sveav\u00e4gen 33", "address2": "", "zip": "111 34", "city": "Stockholm", "state": "", "countryid": "se", "currencycode": "SEK", "receiptlanguagetag": "sv", "storesettingid": 1, "warehouseid": 1, "salestaxgroupid": null } ] }

Get Cash Register

Endpoint

GET sites/{siteid}/cashregisters/{registerid}

HTTP Response Status

200

OK. Returns data (see below).

400

Bad Request. Invalid syntax, missing required argument or invalid request.

401

Unauthorized. Authorization failed.

404

Resource not found. The url is invalid.

429

Too Many Requests.

500

Internal Server Error.

Returns

Returns an item of type posregister.

Example

Request

GET https://api.mysitoo.com/v2/accounts/1500/sites/1/cashregisters/{3CCB9848-155A-49E1-7CA8-5F7F78FC3067}.json

Response

{ "registerid": "{3CCB9848-155A-49E1-7CA8-5F7F78FC3067}", "manufacturerid": "SITOO3CCB9848155A49E17CA85F7F78FC3067", "registerkey": "SII0000001500001", "company": "Sitoo AB", "companyid": "556677-8899", "address": "Sveav\u00e4gen 33", "address2": "", "zip": "111 34", "city": "Stockholm", "state": "", "countryid": "se", "currencycode": "SEK", "receiptlanguagetag": "sv", "storesettingid": 1, "warehouseid": 1, "salestaxgroupid": null }

Get Z-Reports

Endpoint

GET sites/{siteid}/cashregisters/{registerid}/zreports

Parameters

datecreatedfrom

Filter on z-reports with datecreated starting from the timestamp provided

datecreatedto

Filter on z-reports with datecreated ending before the timestamp provided

start

The index of the item to start fromDefault: 0

num

The number of items returnedDefault: 10

HTTP Response Status

200

OK. Returns data (see below).

400

Bad Request. Invalid syntax, missing required argument or invalid request.

401

Unauthorized. Authorization failed.

404

Resource not found. The url is invalid.

429

Too Many Requests.

500

Internal Server Error.

Returns

Returns an envelope with items of type poszreport for a cash register.

Example

Request

GET https://api.mysitoo.com/v2/accounts/1500/sites/1/cashregisters/{3CCB9848-155A-49E1-7CA8-5F7F78FC3067}/zreports.json?num=1

Response

{ "totalcount": 2, "items": [ { "zreportid": 2, "registerid": "{3CCB9848-155A-49E1-7CA8-5F7F78FC3067}", "manufacturerid": "SITOO3CCB9848155A49E17CA85F7F78FC3067", "registerkey": "SII0000001500001", "registernumber": 1, "datecreated": 1463041164, "company": "Sitoo AB", "companyid": "556677-8899", "address": "Sveav\u00e4gen 33", "address2": "", "address3": "111 34 Stockholm", "staff": "", "comment": "", "moneysalestotal": "9825.00", "moneysalestotalnet": "7868.60", "numsales": 5, "numsalesitems": 13, "vatgroupssales": [ { "vatvalue": 6, "moneytotal": "60.00", "moneytotalnet": "56.60", "moneytotalvat": "3.40" }, { "vatvalue": 25, "moneytotal": "9765.00", "moneytotalnet": "7812.00", "moneytotalvat": "1953.00" } ], "productgroupssales": [ { "name": "Books", "vatvalue": 6, "numtotal": 5, "moneytotal": "60.00", "moneytotalnet": "56.60", "moneytotalvat": "3.40" }, { "name": "Common Goods", "vatvalue": 25, "numtotal": 8, "moneytotal": "9765.00", "moneytotalnet": "7812.00", "moneytotalvat": "1953.00" } ], "moneyrefundtotal": "4980.00", "moneyrefundtotalnet": "3984.00", "numrefund": 2, "numrefunditems": 2, "vatgroupsrefund": [ { "vatvalue": 25, "moneytotal": "4980.00", "moneytotalnet": "3984.00", "moneytotalvat": "996.00" } ], "productgroupsrefund": [ { "name": "Common Goods", "vatvalue": 25, "numtotal": 2, "moneytotal": "4980.00", "moneytotalnet": "3984.00", "moneytotalvat": "996.00" } ], "moneyroundoff": "0.00", "salestaxessales": [], "salestaxesrefund": [], "moneysummarysales": "9825.00", "moneysummaryrefund": "4980.00", "moneysummarysubtotal": "4845.00", "moneysummarysalestax": "0.00", "moneysummaryroundoff": "0.00", "moneysummarytotal": "4845.00", "paymentssales": [ { "name": "Card", "moneytotal": "5010.00", "subpayments": [ { "name": "Visa", "moneysubtotal": "3000.00" }, { "name": "Mastercard", "moneysubtotal": "1510.00" }, { "name": "", "moneysubtotal": "500.00" } ] }, { "name": "Cash", "moneytotal": "4800.00", "subpayments": null }, { "name": "Other", "moneytotal": "15.00", "subpayments": null } ], "paymentsrefund": [ { "name": "Card", "moneytotal": "2975.00", "subpayments": [ { "name": "Visa", "moneysubtotal": "2975.00" } ] }, { "name": "Cash", "moneytotal": "1990.00", "subpayments": null }, { "name": "Other", "moneytotal": "15.00", "subpayments": null } ], "moneycash_in": "1000.00", "moneycash_salesrefunds": "2810.00", "moneycash_petty": "0.00", "moneycash_bank": "0.00", "moneycash_expected": "0.00", "moneycash_counted": "3810.00", "moneycash_diff": "0.00", "moneycash_bankfinal": "0.00", "moneycash_out": "3810.00", "moneydiscount": "15.00", "numsalestypeproduct": 13, "numsalestypeservice": 0, "numsalestypegiftcard": 0, "numreceipts": 5, "numopendrawer": 2, "numpractice": 0, "moneypractice": "0.00", "moneygrandtotalsales": "18287.50", "moneygrandtotalrefund": "6970.00", "moneygrandtotalnet": "11317.50" } ] }

Get Z-Report

Endpoint

GET sites/{siteid}/cashregisters/{registerid}/zreports/{zreportid}

HTTP Response Status

200

OK. Returns data (see below).

400

Bad Request. Invalid syntax, missing required argument or invalid request.

401

Unauthorized. Authorization failed.

404

Resource not found. The url is invalid.

429

Too Many Requests.

500

Internal Server Error.

Returns

Returns an item of type poszreport.

Example

Request

GET https://api.mysitoo.com/v2/accounts/1500/sites/1/cashregisters/{3CCB9848-155A-49E1-7CA8-5F7F78FC3067}/zreports/2.json

Response

{ "zreportid": 2, "registerid": "{3CCB9848-155A-49E1-7CA8-5F7F78FC3067}", "manufacturerid": "SITOO3CCB9848155A49E17CA85F7F78FC3067", "registerkey": "SII0000001500001", "registernumber": 1, "datecreated": 1463041164, "company": "Sitoo AB", "companyid": "556677-8899", "address": "Sveav\u00e4gen 33", "address2": "", "address3": "111 34 Stockholm", "staff": "", "comment": "", "moneysalestotal": "9825.00", "moneysalestotalnet": "7868.60", "numsales": 5, "numsalesitems": 13, "vatgroupssales": [ { "vatvalue": 6, "moneytotal": "60.00", "moneytotalnet": "56.60", "moneytotalvat": "3.40" }, { "vatvalue": 25, "moneytotal": "9765.00", "moneytotalnet": "7812.00", "moneytotalvat": "1953.00" } ], "productgroupssales": [ { "name": "Books", "vatvalue": 6, "numtotal": 5, "moneytotal": "60.00", "moneytotalnet": "56.60", "moneytotalvat": "3.40" }, { "name": "Common Goods", "vatvalue": 25, "numtotal": 8, "moneytotal": "9765.00", "moneytotalnet": "7812.00", "moneytotalvat": "1953.00" } ], "moneyrefundtotal": "4980.00", "moneyrefundtotalnet": "3984.00", "numrefund": 2, "numrefunditems": 2, "vatgroupsrefund": [ { "vatvalue": 25, "moneytotal": "4980.00", "moneytotalnet": "3984.00", "moneytotalvat": "996.00" } ], "productgroupsrefund": [ { "name": "Common Goods", "vatvalue": 25, "numtotal": 2, "moneytotal": "4980.00", "moneytotalnet": "3984.00", "moneytotalvat": "996.00" } ], "moneyroundoff": "0.00", "salestaxessales": [], "salestaxesrefund": [], "moneysummarysales": "9825.00", "moneysummaryrefund": "4980.00", "moneysummarysubtotal": "4845.00", "moneysummarysalestax": "0.00", "moneysummaryroundoff": "0.00", "moneysummarytotal": "4845.00", "paymentssales": [ { "name": "Card", "moneytotal": "5010.00", "subpayments": [ { "name": "Visa", "moneysubtotal": "3000.00" }, { "name": "Mastercard", "moneysubtotal": "1510.00" }, { "name": "", "moneysubtotal": "500.00" } ] }, { "name": "Cash", "moneytotal": "4800.00", "subpayments": null }, { "name": "Other", "moneytotal": "15.00", "subpayments": null } ], "paymentsrefund": [ { "name": "Card", "moneytotal": "2975.00", "subpayments": [ { "name": "Visa", "moneysubtotal": "2975.00" } ] }, { "name": "Cash", "moneytotal": "1990.00", "subpayments": null }, { "name": "Other", "moneytotal": "15.00", "subpayments": null } ], "moneycash_in": "1000.00", "moneycash_salesrefunds": "2810.00", "moneycash_petty": "0.00", "moneycash_bank": "0.00", "moneycash_expected": "0.00", "moneycash_counted": "3810.00", "moneycash_diff": "0.00", "moneycash_bankfinal": "0.00", "moneycash_out": "3810.00", "moneydiscount": "15.00", "numsalestypeproduct": 13, "numsalestypeservice": 0, "numsalestypegiftcard": 0, "numreceipts": 5, "numopendrawer": 2, "numpractice": 0, "moneypractice": "0.00", "moneygrandtotalsales": "18287.50", "moneygrandtotalrefund": "6970.00", "moneygrandtotalnet": "11317.50" }