Cash Registers

Get Cash Registers

get /sites/{siteid}/cashregisters
PARAMETERS
siteid
integer
path
REQUIRED
start
integer
query

The index of the item to start from

Default: 0
num
integer
query

The number of items returned

Default: 10
RETURNS

Returns an envelope with items of type posregister.

gethttps://api.mysitoo.com/v2/accounts/1500/sites/1/cashregisters.json
RESPONSE JSON
{
"totalcount": 1,
"items": [
{
"registerid": "{3CCB9848-155A-49E1-7CA8-5F7F78FC3067}",
"manufacturerid": "SITOO3CCB9848155A49E17CA85F7F78FC3067",
"registerkey": "SII0000001500001",
"company": "Sitoo",
"companyid": "556677-8899",
"address": "240 W Broadway",
"address2": "",
"zip": "10012",
"city": "New York",
"state": "NY",
"countryid": "us",
"currencycode": "USD",
"receiptlanguagetag": "en",
"storesettingid": 1,
"warehouseid": 1,
"salestaxgroupid": null
}
]
}
HTTP Status Code Summary
200Returns an envelope with items of type posregister.
400Bad Request. Invalid syntax, missing required argument or invalid request.
401Unauthorized. Authorization failed.
404Resource not found. The url is invalid.
429Too Many Requests.
500Internal Server Error.

Get Cash Register

get /sites/{siteid}/cashregisters/{registerid}
PARAMETERS
siteid
integer
path
REQUIRED
registerid
string
path
REQUIRED
RETURNS

Returns an item of type posregister.

gethttps://api.mysitoo.com/v2/accounts/1500/sites/1/cashregisters/{3CCB9848-155A-49E1-7CA8-5F7F78FC3067}.json
RESPONSE JSON
{
"registerid": "{3CCB9848-155A-49E1-7CA8-5F7F78FC3067}",
"manufacturerid": "SITOO3CCB9848155A49E17CA85F7F78FC3067",
"registerkey": "SII0000001500001",
"company": "Sitoo",
"companyid": "556677-8899",
"address": "240 W Broadway",
"address2": "",
"zip": "10012",
"city": "New York",
"state": "NY",
"countryid": "us",
"currencycode": "USD",
"receiptlanguagetag": "en",
"storesettingid": 1,
"warehouseid": 1,
"salestaxgroupid": null
}
HTTP Status Code Summary
200Returns an item of type posregister.
400Bad Request. Invalid syntax, missing required argument or invalid request.
401Unauthorized. Authorization failed.
404Resource not found. The url is invalid.
429Too Many Requests.
500Internal Server Error.

Get Z-Reports

get /sites/{siteid}/cashregisters/{registerid}/zreports
PARAMETERS
siteid
integer
path
REQUIRED
registerid
string
path
REQUIRED
datecreatedfrom
integer
query

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

timestamp
datecreatedto
integer
query

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

timestamp
start
integer
query

The index of the item to start from

Default: 0
num
integer
query

The number of items returned

Default: 10
RETURNS

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

gethttps://api.mysitoo.com/v2/accounts/1500/sites/1/cashregisters/{3CCB9848-155A-49E1-7CA8-5F7F78FC3067}/zreports.json?num=1
RESPONSE JSON
{
"totalcount": 2,
"items": [
{
"zreportid": 2,
"registerid": "{3CCB9848-155A-49E1-7CA8-5F7F78FC3067}",
"manufacturerid": "SITOO3CCB9848155A49E17CA85F7F78FC3067",
"registerkey": "SII0000001500001",
"registernumber": 1,
"datecreated": 1587110959,
"dateopened": 1587110444,
"eshopid": 1,
"store_id": "200",
"store_name": "Sitoo Concept Store",
"company": "Sitoo",
"companyid": "556677-8899",
"address": "240 W Broadway",
"address2": "",
"address3": "New York NY 10012",
"currencycode": "USD",
"staff": "Staff",
"staffuserid": "{441A73D1-5DA7-685D-7E40-445D90C97E9B}",
"comment": "",
"moneysalestotal": "40463.75",
"moneysalestotalnet": "32373.15",
"numsales": 3,
"numsalesitems": 7,
"vatgroupssales": [
{
"vatvalue": 6,
"moneytotal": "14.98",
"moneytotalnet": "14.13",
"moneytotalvat": "0.85"
},
{
"vatvalue": 25,
"moneytotal": "40448.77",
"moneytotalnet": "32359.02",
"moneytotalvat": "8089.75"
}
],
"productgroupssales": [
{
"name": "Books",
"vatvalue": 6,
"numtotal": 1,
"moneytotal": "14.98",
"moneytotalnet": "14.13",
"moneytotalvat": "0.85"
},
{
"name": "Common Goods",
"vatvalue": 25,
"numtotal": 6,
"moneytotal": "40448.77",
"moneytotalnet": "32359.02",
"moneytotalvat": "8089.75"
}
],
"moneyrefundtotal": "0.00",
"moneyrefundtotalnet": "0.00",
"numrefund": 0,
"numrefunditems": 0,
"vatgroupsrefund": [],
"productgroupsrefund": [],
"moneyroundoff": "0.00",
"salestaxessales": [],
"salestaxesrefund": [],
"moneysummarysales": "40463.75",
"moneysummaryrefund": "0.00",
"moneysummarysubtotal": "40463.75",
"moneysummarysalestax": "0.00",
"moneysummaryroundoff": "0.00",
"moneysummarytotal": "40463.75",
"paymentssales": [
{
"name": "Cash",
"moneytotal": "28673.75",
"subpayments": []
},
{
"name": "Gift Card",
"moneytotal": "300.00",
"subpayments": []
},
{
"name": "Other",
"moneytotal": "11490.00",
"subpayments": []
}
],
"paymentsrefund": [],
"discountssales": [
{
"vouchercode": "",
"moneytotal": "20.00",
"moneytotalnet": "16.00",
"moneytotalvat": "4.00"
},
{
"vouchercode": "discount-manual",
"moneytotal": "100.00",
"moneytotalnet": "80.00",
"moneytotalvat": "20.00"
}
],
"discountsrefund": [],
"moneycash_in": "31214.11",
"moneycash_salesrefunds": "28673.75",
"moneycash_petty": "0.00",
"moneycash_bank": "-10000.00",
"moneycash_expected": "49887.86",
"moneycash_counted": "49888.00",
"moneycash_diff": "0.14",
"moneycash_bankfinal": "0.00",
"moneycash_out": "49888.00",
"moneydiscount": "120.00",
"numsalestypeproduct": 7,
"numsalestypeservice": 0,
"numsalestypegiftcard": 0,
"numreceipts": 3,
"numopendrawer": 3,
"numpractice": 0,
"moneypractice": "0.00",
"moneygrandtotalsales": "71807.56",
"moneygrandtotalrefund": "0.00",
"moneygrandtotalnet": "71807.56"
}
]
}
HTTP Status Code Summary
200Returns an envelope with items of type poszreport for a cash register.
400Bad Request. Invalid syntax, missing required argument or invalid request.
401Unauthorized. Authorization failed.
404Resource not found. The url is invalid.
429Too Many Requests.
500Internal Server Error.

Get Z-Report

get /sites/{siteid}/cashregisters/{registerid}/zreports/{zreportid}
PARAMETERS
siteid
integer
path
REQUIRED
registerid
string
path
REQUIRED
zreportid
integer
path
REQUIRED
RETURNS

Returns an item of type poszreport.

gethttps://api.mysitoo.com/v2/accounts/1500/sites/1/cashregisters/{3CCB9848-155A-49E1-7CA8-5F7F78FC3067}/zreports/2.json
RESPONSE JSON
{
"zreportid": 2,
"registerid": "{3CCB9848-155A-49E1-7CA8-5F7F78FC3067}",
"manufacturerid": "SITOO3CCB9848155A49E17CA85F7F78FC3067",
"registerkey": "SII0000001500001",
"registernumber": 1,
"datecreated": 1587110959,
"dateopened": 1587110444,
"eshopid": 1,
"store_id": "200",
"store_name": "Sitoo Concept Store",
"company": "Sitoo",
"companyid": "556677-8899",
"address": "240 W Broadway",
"address2": "",
"address3": "New York NY 10012",
"currencycode": "USD",
"staff": "Staff",
"staffuserid": "{441A73D1-5DA7-685D-7E40-445D90C97E9B}",
"comment": "",
"moneysalestotal": "40463.75",
"moneysalestotalnet": "32373.15",
"numsales": 3,
"numsalesitems": 7,
"vatgroupssales": [
{
"vatvalue": 6,
"moneytotal": "14.98",
"moneytotalnet": "14.13",
"moneytotalvat": "0.85"
},
{
"vatvalue": 25,
"moneytotal": "40448.77",
"moneytotalnet": "32359.02",
"moneytotalvat": "8089.75"
}
],
"productgroupssales": [
{
"name": "Books",
"vatvalue": 6,
"numtotal": 1,
"moneytotal": "14.98",
"moneytotalnet": "14.13",
"moneytotalvat": "0.85"
},
{
"name": "Common Goods",
"vatvalue": 25,
"numtotal": 6,
"moneytotal": "40448.77",
"moneytotalnet": "32359.02",
"moneytotalvat": "8089.75"
}
],
"moneyrefundtotal": "0.00",
"moneyrefundtotalnet": "0.00",
"numrefund": 0,
"numrefunditems": 0,
"vatgroupsrefund": [],
"productgroupsrefund": [],
"moneyroundoff": "0.00",
"salestaxessales": [],
"salestaxesrefund": [],
"moneysummarysales": "40463.75",
"moneysummaryrefund": "0.00",
"moneysummarysubtotal": "40463.75",
"moneysummarysalestax": "0.00",
"moneysummaryroundoff": "0.00",
"moneysummarytotal": "40463.75",
"paymentssales": [
{
"name": "Cash",
"moneytotal": "28673.75",
"subpayments": []
},
{
"name": "Gift Card",
"moneytotal": "300.00",
"subpayments": []
},
{
"name": "Other",
"moneytotal": "11490.00",
"subpayments": []
}
],
"paymentsrefund": [],
"discountssales": [
{
"vouchercode": "",
"moneytotal": "20.00",
"moneytotalnet": "16.00",
"moneytotalvat": "4.00"
},
{
"vouchercode": "discount-manual",
"moneytotal": "100.00",
"moneytotalnet": "80.00",
"moneytotalvat": "20.00"
}
],
"discountsrefund": [],
"moneycash_in": "31214.11",
"moneycash_salesrefunds": "28673.75",
"moneycash_petty": "0.00",
"moneycash_bank": "-10000.00",
"moneycash_expected": "49887.86",
"moneycash_counted": "49888.00",
"moneycash_diff": "0.14",
"moneycash_bankfinal": "0.00",
"moneycash_out": "49888.00",
"moneydiscount": "120.00",
"numsalestypeproduct": 7,
"numsalestypeservice": 0,
"numsalestypegiftcard": 0,
"numreceipts": 3,
"numopendrawer": 3,
"numpractice": 0,
"moneypractice": "0.00",
"moneygrandtotalsales": "71807.56",
"moneygrandtotalrefund": "0.00",
"moneygrandtotalnet": "71807.56"
}
HTTP Status Code Summary
200Returns an item of type poszreport.
400Bad Request. Invalid syntax, missing required argument or invalid request.
401Unauthorized. Authorization failed.
404Resource not found. The url is invalid.
429Too Many Requests.
500Internal Server Error.

Objects

money
string

Pattern: ^[-+]?[0-9]+\.[0-9]{2}$

posregister
object

Cash register. Point of Sale (POS).

PROPERTIES
registerid
string
READ ONLY

Unique ID for this Cash Register.

manufacturerid
string
READ ONLY

Manufacturer ID for this Cash Register used by the Tax Authorities (In Swedish: Tillverkningsnummer).

registerkey
string
READ ONLY

Key for this Cash Register used by the Tax Authorities (In Swedish: Kassabeteckning).

company
string
READ ONLY

Company Name.

companyid
string
READ ONLY

Company ID.

address
string
READ ONLY

Address line 1.

address2
string
READ ONLY

Address line 2.

zip
string
READ ONLY

Zip.

city
string
READ ONLY

City.

state
string
READ ONLY

State.

countryid
string
READ ONLY

Country ID (ISO 3166-1, alpha-2).

currencycode
string
READ ONLY

Currency code (ISO 4217, alpha-3).

receiptlanguagetag
string
READ ONLY

Language used for receipts printed by the Cash Register (RFC 5646, BCP 47).

storesettingid
integer
READ ONLY

The ID for the store setting used by the Cash Register.

warehouseid
integer
READ ONLY

The ID for the warehouse used by the Cash Register.

salestaxgroupid
integer
READ ONLY

The ID for the salestaxgroup used by the Cash Register.

poszreport
object

Z-report for Sitoo POS Cash Register.

PROPERTIES
zreportid
integer
READ ONLY

ID for this report (report number).

registerid
string
READ ONLY

Unique ID for this Cash Register.

manufacturerid
string
READ ONLY

Manufacturer ID for this Cash Register.

registerkey
string
READ ONLY

Key for this Cash Register used by the Tax Authorities and also printed on receipts.

registernumber
integer
READ ONLY

Number for this Cash Register (E.g 1, 2, 3...).

datecreated
READ ONLY

Timestamp for when this report was created.

dateopened
READ ONLY

Timestamp for when the register was opened or null if generated with legacy versions of Sitoo POS.

eshopid
integer
READ ONLY

Eshop ID

store_id
string
READ ONLY

Store ID (external ID of the Store in Sitoo)

store_name
string
READ ONLY

The name of the store

company
string
READ ONLY

Company Name.

companyid
string
READ ONLY

Company ID.

address
string
READ ONLY

Address line 1 (street address).

address2
string
READ ONLY

Address line 2 (c/o or similar).

address3
string
READ ONLY

Address line 3 (zip, city and state).

currencycode
string
READ ONLY

Currency for the report. (ISO 4217, alpha-3 uppercased)

staff
string
READ ONLY

The name of the staff that produced the report.

staffuserid
string
READ ONLY

The user ID for the staff that produced the report.

comment
string
READ ONLY

The comment that the staff entered for the report.

moneysalestotal
READ ONLY

The total gross money value for sales.

moneysalestotalnet
READ ONLY

The total net money value for sales.

numsales
integer
READ ONLY

The total number of sales.

numsalesitems
integer
READ ONLY

The total number of items in sales.

vatgroupssales
READ ONLY

Sales grouped by vat values. See poszreportvatgroup for fields.

productgroupssales
READ ONLY

Sales grouped by product group. See poszreportproductgroup for fields.

moneysalesnotdeliveredtotal
READ ONLY

The total gross money value for sales not delivered.

moneysalesnotdeliveredtotalnet
READ ONLY

The total net money value for sales not delivered.

numsalesnotdelivered
integer
READ ONLY

The total number of sales where not all items were delivered.

numsalesnotdelivereditems
integer
READ ONLY

The total number of items in sales not delivered.

vatgroupssalesnotdelivered
READ ONLY

Sales not delivered grouped by vat values. See poszreportvatgroup for fields.

productgroupssalesnotdelivered
READ ONLY

Sales not delivered grouped by product group. See poszreportproductgroup for fields.

moneyrefundtotal
READ ONLY

The total gross money value for refunds.

moneyrefundtotalnet
READ ONLY

The total net money value for refunds.

numrefund
integer
READ ONLY

The total number of refunds.

numrefunditems
integer
READ ONLY

The total number of items in refunds.

vatgroupsrefund
READ ONLY

Refunds grouped by vat values. See poszreportvatgroup for fields.

productgroupsrefund
READ ONLY

Refunds grouped by product group. See poszreportproductgroup for fields.

moneyroundoff
READ ONLY

The total money value for roundoff.

salestaxessales
READ ONLY

Collected sales taxes for sales grouped by name, code and taxvalue. See poszreportsalestax for fields.

salestaxesrefund
READ ONLY

Collected sales taxes for refunds grouped by name, code and taxvalue. See poszreportsalestax for fields.

moneysalestaxinadvance
READ ONLY

The total value of sales tax collected for items not delivered (if applicable).

moneysummarysales
READ ONLY

The total money value for sales.

moneysummaryrefund
READ ONLY

The total money value for refunds.

moneysummarysubtotal
READ ONLY

The sub total money value (moneysummarysales - moneysummaryrefund).

moneysummarysalestax
READ ONLY

The sub total money value for sales tax.

moneysummaryroundoff
READ ONLY

The total money value for roundoff.

moneysummarytotal
READ ONLY

The total money value for the report (moneysummarysubtotal + moneysummarysalestax + moneysummaryroundoff).

paymentssales
READ ONLY

All payments for sales. See poszreportpayment for fields.

paymentsrefund
READ ONLY

All payments for refunds. See poszreportpayment for fields.

discountssales
READ ONLY

Discounts grouped by vouchercode for sales. See poszreportdiscount for fields.

discountssalesnotdelivered
READ ONLY

Discounts grouped by vouchercode for sales not delivered. See poszreportdiscount for fields.

discountsrefund
READ ONLY

Discounts grouped by vouchercode for refunds. See poszreportdiscount for fields.

moneycash_in
READ ONLY

The entered money value for cash in the register when it was opened.

moneycash_salesrefunds
READ ONLY

The total amount of cash from sales/refunds for register since it was opened.

moneycash_petty
READ ONLY

The total petty cash change for register since it was opened.

moneycash_bank
READ ONLY

The total banking cash change for register since it was opened.

moneycash_expected
READ ONLY

The calculated money value for cash in the register before it was counted.

moneycash_counted
READ ONLY

The counted money value for cash in the register when closing.

moneycash_diff
READ ONLY

The difference in money value for cash between expected and counted values.

moneycash_bankfinal
READ ONLY

The amount of cash banked after cash had been counted.

moneycash_out
READ ONLY

The money value for cash in the register after it was closed.

moneydiscount
READ ONLY

The total money amount for discounts of sales (incl. VAT). For discount details see discountssales and discountsrefund.

numsalestypeproduct
integer
READ ONLY

The total number of items of type "product".

numsalestypeservice
integer
READ ONLY

The total number of items of type "service".

numsalestypegiftcard
integer
READ ONLY

The total number of items of type "gift card".

numreceipts
integer
READ ONLY

The total number of receipts.

numopendrawer
integer
READ ONLY

The total number of time the cash register drawer was opened (except for normal transactions).

numpractice
integer
READ ONLY

The total number of transactions made in practice mode.

moneypractice
READ ONLY

The total money value of transactions made in practice mode.

moneygrandtotalsales
READ ONLY

The total money value for sales since the start of the cash register.

moneygrandtotalrefund
READ ONLY

The total money value for refunds since the start of the cash register.

moneygrandtotalnet
READ ONLY

The summary total money value since the start of the cash register (moneygrandtotalsales - moneygrandtotalrefund).

poszreportdiscount
object

Contains the discount details for a poszreport.

PROPERTIES
vouchercode
string
READ ONLY

The vouchercode of the discount group.

moneytotal
READ ONLY

The total gross money value for the discount group.

moneytotalnet
READ ONLY

The total net money value for the discount group.

moneytotalvat
READ ONLY

The total vat money value for the discount group.

poszreportpayment
object

Contains the payment details for a poszreport.

PROPERTIES
name
string
READ ONLY

The name of the payment.

moneytotal
READ ONLY

The total money value of the payment.

moneycaptured
READ ONLY

The amount captured for the payment. The difference between total and captured is the reserved amount.

moneyinadvance
READ ONLY

The amount captured for the payment for items that were not delivered at the time of purchase (payment in advance).

moneyreserved
READ ONLY

The reserved amount.

subpayments
READ ONLY

A specification of different payments within the payment type (if applicable). See poszreportsubpayment for fields.

poszreportproductgroup
object

Contains the product group details for a poszreport.

PROPERTIES
name
string
READ ONLY

The name of the product group.

vatvalue
number
READ ONLY

The vat value for the product group.

numtotal
integer
READ ONLY

The total number of items for the product group.

moneytotal
READ ONLY

The total gross money value for the product group.

moneytotalnet
READ ONLY

The total net money value for the product group.

moneytotalvat
READ ONLY

The total vat money value for the product group.

poszreportsalestax
object

Contains the sales tax details for a poszreport.

PROPERTIES
name
string
READ ONLY

The name of the sales tax.

code
string
READ ONLY

An identifier that can be used to specify the sales tax.

externalid
string
READ ONLY

A custom value to make it easier to export to external systems.

groupregion
string
READ ONLY

The region of the salestaxgroup this salestax item belongs to.

moneytotal
READ ONLY

The total sales the collected tax is calculated on. (ie. the sales with no tax)

moneytax
READ ONLY

The total net money value for this sales tax.

decimaltaxvalue
string
READ ONLY

The tax value in percent.

poszreportsubpayment
object

Contains the details for a sub payment of poszreportpayment.

PROPERTIES
name
string
READ ONLY

The name of the sub payment.

moneysubtotal
READ ONLY

The money value of the sub payment.

moneycaptured
READ ONLY

The amount captured for the payment. The difference between total and captured is the reserved amount.

moneyinadvance
READ ONLY

The amount captured for the payment for items that were not delivered at the time of purchase (payment in advance).

moneyreserved
READ ONLY

The reserved amount.

poszreportvatgroup
object

Contains the VAT details for a poszreport.

PROPERTIES
vatvalue
number
READ ONLY

The vat value for the vat group.

moneytotal
READ ONLY

The total gross money value for the vat group.

moneytotalnet
READ ONLY

The total net money value for the vat group.

moneytotalvat
READ ONLY

The total vat money value for the vat group.

timestamp
integer

Number of seconds since the Unix Epoch.