Introduction
Guides
API Reference
SPI CRM v2
SPI CRM v1
SPI Events
SPI Gift Card
SPI Payment
SPI Product Search
Shipments v3
Purchase Prices v3

Z-reports

Get POS Z-reports

get /pos-z-reports

Endpoint for retrieving POS Z-reports. The items returned are always sorted by dateadded in ascending order. Note! The maximum number of items returned is 500. If maximum number of items is returned, either try using a narrower filter for your query, or simply use the dateadded property for the last retrieved item to filter out the next items.

PARAMETERS
eshopid
array (integer)
query

Filter on eshopid. Use comma as separator for multiple values.

Example: /pos-z-reports?eshopid=1,2
store_id
array (string)
query

Filter on store_id (external ID of the Store in Sitoo). Use comma as separator for multiple values.

Example: /pos-z-reports?store_id=100,299
registerid
array (string)
query

Filter on z-reports generated from a specific registerid. Use comma as separator for multiple values.

Example: /pos-z-reports?registerid={DBFA5E0C-0BB4-431C-9EB3-471F88AE222E},{7460F103-24F2-4775-A945-A3534732F7B8}
dateaddedfrom
integer
query

Filter on z-reports with dateadded starting on or after the timestamp provided.

dateaddedto
integer
query

Filter on z-reports with dateadded ending on or before the timestamp provided.

Returns

Returns an array with objects of type PosZReport

PosZReport
array
gethttps://api.mysitoo.com/v2/accounts/1500/pos-z-reports?dateaddedfrom=1618225274&dateaddedto=1618225275
RESPONSE JSON
[
  {
    "zreportid": 2,
    "registerid": "{3CCB9848-155A-49E1-7CA8-5F7F78FC3067}",
    "manufacturerid": "SITOO3CCB9848155A49E17CA85F7F78FC3067",
    "registerkey": "SII0000001500001",
    "registernumber": 1,
    "datecreated": 1587110959,
    "dateopened": 1587110444,
    "dateadded": 1618225274,
    "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",
    "currencyconversions": [],
    "moneygrandtotalsales": "71807.56",
    "moneygrandtotalrefund": "0.00",
    "moneygrandtotalnet": "71807.56"
  }
]
HTTP Status Code Summary
200Returns an array with objects 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.

Get POS Z-report

get /pos-z-reports/{registerid}/{zreportid}

Endpoint for retrieving one POS Z-report.

PARAMETERS
registerid
string
path
REQUIRED

The ID of the register.

zreportid
integer
path
REQUIRED

The ID of the POS Z-report.

Returns

Returns an object of type PosZReport

PosZReport
gethttps://api.mysitoo.com/v2/accounts/1500/pos-z-reports/{3CCB9848-155A-49E1-7CA8-5F7F78FC3067}/2
RESPONSE JSON
{
  "zreportid": 2,
  "registerid": "{3CCB9848-155A-49E1-7CA8-5F7F78FC3067}",
  "manufacturerid": "SITOO3CCB9848155A49E17CA85F7F78FC3067",
  "registerkey": "SII0000001500001",
  "registernumber": 1,
  "datecreated": 1587110959,
  "dateopened": 1587110444,
  "dateadded": 1618225274,
  "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",
  "currencyconversions": [],
  "moneygrandtotalsales": "71807.56",
  "moneygrandtotalrefund": "0.00",
  "moneygrandtotalnet": "71807.56"
}
HTTP Status Code Summary
200Returns an object 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.

Get Store Z-reports

get /store-z-reports

Endpoint for retrieving aggregated z-reports for stores. The items returned are always sorted by day_created in descending order. Also note that the store_id property for POS Z-reports missing a valid value will all be aggregated to a Store Z-report with the store_id value of NO_STORE. Note! If the day filter is not provided, then the number of returned items is limited to 100.

PARAMETERS
store_id
array (string)
query

Filter on store_id (external ID of the Store in Sitoo). Use comma as separator for multiple values.

Example: /store-z-reports?store_id=100,299
day
string
query

Filter on day

Returns

Returns an array with objects of type StoreZReport

StoreZReport
array
gethttps://api.mysitoo.com/v2/accounts/1500/store-z-reports?day=2021-02-17
RESPONSE JSON
[
  {
    "store_zreport_id": "b86a9d9e-6d58-4dce-a75f-ff63cdc459bc",
    "currency_code": "SEK",
    "store_id": "200",
    "store_name": "Sitoo Concept Store",
    "day_created": "2021-03-17",
    "date_created": 1615977763,
    "register_zreports": [
      {
        "registerid": "{3CCB9848-155A-49E1-7CA8-5F7F78FC3067}",
        "zreportid": 24
      },
      {
        "registerid": "{562A1F6B-68E6-2028-2F71-A177E0E75214}",
        "zreportid": 28
      }
    ],
    "data": {
      "moneysalestotal": "2248.00",
      "moneysalestotalnet": "1798.40",
      "numsales": 5,
      "numsalesitems": 5,
      "vatgroupssales": [
        {
          "moneytotal": "2248.00",
          "moneytotalnet": "1798.40",
          "moneytotalvat": "449.60",
          "vatvalue": 25
        }
      ],
      "productgroupssales": [
        {
          "moneytotal": "2248.00",
          "moneytotalnet": "1798.40",
          "moneytotalvat": "449.60",
          "name": "Standard",
          "numtotal": 5,
          "vatvalue": 25
        }
      ],
      "moneyrefundtotal": "0.00",
      "moneyrefundtotalnet": "0.00",
      "numrefund": 0,
      "numrefunditems": 0,
      "vatgroupsrefund": [],
      "productgroupsrefund": [],
      "moneyroundoff": "0.00",
      "salestaxessales": [],
      "salestaxesrefund": [],
      "moneysummarysales": "2248.00",
      "moneysummaryrefund": "0.00",
      "moneysummarysubtotal": "2248.00",
      "moneysummarysalestax": "0.00",
      "moneysummaryroundoff": "0.00",
      "moneysummarytotal": "2248.00",
      "paymentssales": [
        {
          "moneytotal": "2248.00",
          "name": "Cash"
        }
      ],
      "paymentsrefund": [],
      "discountssales": [
        {
          "moneytotal": "300.00",
          "moneytotalnet": "240.00",
          "moneytotalvat": "60.00"
        }
      ],
      "discountsrefund": [],
      "moneycash_in": "48778.00",
      "moneycash_salesrefunds": "2248.00",
      "moneycash_petty": "0.00",
      "moneycash_bank": "0.00",
      "moneycash_expected": "51026.00",
      "moneycash_counted": "51026.00",
      "moneycash_diff": "0.00",
      "moneycash_bankfinal": "0.00",
      "moneycash_out": "51026.00",
      "moneydiscount": "300.00",
      "numsalestypeproduct": 5,
      "numsalestypeservice": 0,
      "numsalestypegiftcard": 0,
      "numreceipts": 5,
      "numopendrawer": 0,
      "numpractice": 0,
      "moneypractice": "0.00",
      "currencyconversions": []
    }
  }
]
HTTP Status Code Summary
200Returns an array with objects of type StoreZReport
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 Store Z-report

get /store-z-reports/{store_zreport_id}

Endpoint for retrieving an aggregated Store Z-report.

PARAMETERS
store_zreport_id
string
path
REQUIRED

The ID of the Store Z-report.

Returns

Returns an object of type StoreZReport

StoreZReport
gethttps://api.mysitoo.com/v2/accounts/1500/store-z-reports/b86a9d9e-6d58-4dce-a75f-ff63cdc459bc
RESPONSE JSON
{
  "store_zreport_id": "b86a9d9e-6d58-4dce-a75f-ff63cdc459bc",
  "currency_code": "SEK",
  "store_id": "200",
  "store_name": "Sitoo Concept Store",
  "day_created": "2021-03-17",
  "date_created": 1615977763,
  "register_zreports": [
    {
      "registerid": "{3CCB9848-155A-49E1-7CA8-5F7F78FC3067}",
      "zreportid": 24
    },
    {
      "registerid": "{562A1F6B-68E6-2028-2F71-A177E0E75214}",
      "zreportid": 28
    }
  ],
  "data": {
    "moneysalestotal": "2248.00",
    "moneysalestotalnet": "1798.40",
    "numsales": 5,
    "numsalesitems": 5,
    "vatgroupssales": [
      {
        "moneytotal": "2248.00",
        "moneytotalnet": "1798.40",
        "moneytotalvat": "449.60",
        "vatvalue": 25
      }
    ],
    "productgroupssales": [
      {
        "moneytotal": "2248.00",
        "moneytotalnet": "1798.40",
        "moneytotalvat": "449.60",
        "name": "Standard",
        "numtotal": 5,
        "vatvalue": 25
      }
    ],
    "moneyrefundtotal": "0.00",
    "moneyrefundtotalnet": "0.00",
    "numrefund": 0,
    "numrefunditems": 0,
    "vatgroupsrefund": [],
    "productgroupsrefund": [],
    "moneyroundoff": "0.00",
    "salestaxessales": [],
    "salestaxesrefund": [],
    "moneysummarysales": "2248.00",
    "moneysummaryrefund": "0.00",
    "moneysummarysubtotal": "2248.00",
    "moneysummarysalestax": "0.00",
    "moneysummaryroundoff": "0.00",
    "moneysummarytotal": "2248.00",
    "paymentssales": [
      {
        "moneytotal": "2248.00",
        "name": "Cash"
      }
    ],
    "paymentsrefund": [],
    "discountssales": [
      {
        "moneytotal": "300.00",
        "moneytotalnet": "240.00",
        "moneytotalvat": "60.00"
      }
    ],
    "discountsrefund": [],
    "moneycash_in": "48778.00",
    "moneycash_salesrefunds": "2248.00",
    "moneycash_petty": "0.00",
    "moneycash_bank": "0.00",
    "moneycash_expected": "51026.00",
    "moneycash_counted": "51026.00",
    "moneycash_diff": "0.00",
    "moneycash_bankfinal": "0.00",
    "moneycash_out": "51026.00",
    "moneydiscount": "300.00",
    "numsalestypeproduct": 5,
    "numsalestypeservice": 0,
    "numsalestypegiftcard": 0,
    "numreceipts": 5,
    "numopendrawer": 0,
    "numpractice": 0,
    "moneypractice": "0.00",
    "currencyconversions": []
  }
}
HTTP Status Code Summary
200Returns an object of type StoreZReport
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 Store Z-report Configuration

get /store-z-reports/config

Endpoint for retrieving configuration for Store Z-report service

Returns

Returns an object of type StoreZReportConfig

StoreZReportConfig
gethttps://api.mysitoo.com/v2/accounts/1500/store-z-reports/config
RESPONSE JSON
{
  "aggregation_active": true,
  "hour_of_day": 22,
  "time_zone": "Europe/Stockholm"
}
HTTP Status Code Summary
200Returns an object of type StoreZReportConfig
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.

Set Store Z-report Configuration

put /store-z-reports/config

Endpoint for setting configuration for Store Z-report service

REQUEST BODY
object
REQUIRED

StoreZReportConfig object

StoreZReportConfig
Returns

Returns the updated object of type StoreZReportConfig

StoreZReportConfig
puthttps://api.mysitoo.com/v2/accounts/1500/store-z-reports/config
{
  "aggregation_active": true,
  "hour_of_day": 22,
  "time_zone": "Europe/Stockholm"
}
RESPONSE JSON
{
  "aggregation_active": true,
  "hour_of_day": 22,
  "time_zone": "Europe/Stockholm"
}
HTTP Status Code Summary
200Returns the updated object of type StoreZReportConfig
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}$
Example: "123.00"

PosZReport
object

Z-report for Sitoo POS Cash Register.

PROPERTIES
zreportid
integer

ID for this report (report number).

registerid
string

Unique ID for this Cash Register.

manufacturerid
string

Manufacturer ID for this Cash Register.

registerkey
string

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

registernumber
integer

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

datecreated
integer

Timestamp for when this report was created.

dateopened
integer
nullable

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

dateadded
integer

Unix timestamp for when this report was added from the client to Sitoo Platform.

eshopid
integer

Eshop ID (Eshop ID for the POS Z-report in Sitoo)

store_id
string
nullable

Store ID (external ID of the Store in Sitoo)

store_name
string
nullable

The name of the store

company
string

Company Name.

companyid
string

Company ID.

address
string

Address line 1 (street address).

address2
string

Address line 2 (c/o or similar).

address3
string

Address line 3 (zip, city and state).

currencycode
string

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

staff
string

The name of the staff that produced the report.

staffuserid
string

The user ID for the staff that produced the report.

comment
string

The comment that the staff entered for the report.

moneysalestotal
Money

The total gross money value for sales.

moneysalestotalnet
Money

The total net money value for sales.

numsales
integer

The total number of sales.

numsalesitems
integer

The total number of items in sales.

vatgroupssales
array
(ZReportVatGroup)

Sales grouped by vat values. See ZReportVatGroup for fields.

productgroupssales
array
(ZReportProductGroup)

Sales grouped by product group. See ZReportProductGroup for fields.

moneysalesnotdeliveredtotal
Money

The total gross money value for sales not delivered.

moneysalesnotdeliveredtotalnet
Money

The total net money value for sales not delivered.

numsalesnotdelivered
integer

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

numsalesnotdelivereditems
integer

The total number of items in sales not delivered.

vatgroupssalesnotdelivered
array
(ZReportVatGroup)

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

productgroupssalesnotdelivered
array
(ZReportProductGroup)

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

moneyrefundtotal
Money

The total gross money value for refunds.

moneyrefundtotalnet
Money

The total net money value for refunds.

numrefund
integer

The total number of refunds.

numrefunditems
integer

The total number of items in refunds.

vatgroupsrefund
array
(ZReportVatGroup)

Refunds grouped by vat values. See ZReportVatGroup for fields.

productgroupsrefund
array
(ZReportProductGroup)

Refunds grouped by product group. See ZReportProductGroup for fields.

moneyroundoff
Money

The total money value for roundoff.

salestaxessales
array
(ZReportSalesTax)

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

salestaxesrefund
array
(ZReportSalesTax)

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

moneysalestaxinadvance
Money

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

moneysummarysales
Money

The total money value for sales.

moneysummaryrefund
Money

The total money value for refunds.

moneysummarysubtotal
Money

The sub total money value (moneysummarysales - moneysummaryrefund).

moneysummarysalestax
Money

The sub total money value for sales tax.

moneysummaryroundoff
Money

The total money value for roundoff.

moneysummarytotal
Money

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

paymentssales
array
(ZReportPayment)

All payments for sales. See ZReportPayment for fields.

paymentsrefund
array
(ZReportPayment)

All payments for refunds. See ZReportPayment for fields.

discountssales
array
(ZReportDiscount)

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

discountssalesnotdelivered
array
(ZReportDiscount)

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

discountsrefund
array
(ZReportDiscount)

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

moneycash_in
Money

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

moneycash_salesrefunds
Money

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

moneycash_petty
Money

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

moneycash_bank
Money

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

moneycash_expected
Money

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

moneycash_counted
Money

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

moneycash_diff
Money

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

moneycash_bankfinal
Money

The amount of cash banked after cash had been counted.

moneycash_out
Money

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

moneydiscount
Money

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

numsalestypeproduct
integer

The total number of items of type "product".

numsalestypeservice
integer

The total number of items of type "service".

numsalestypegiftcard
integer

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

numreceipts
integer

The total number of receipts.

numopendrawer
integer

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

numpractice
integer

The total number of transactions made in practice mode.

moneypractice
Money

The total money value of transactions made in practice mode.

currencyconversions
array
(ZReportCurrencyConversion)

Contains details about foreign currencies. See ZReportCurrencyConversion for fields.

moneygrandtotalsales
Money

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

moneygrandtotalrefund
Money

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

moneygrandtotalnet
Money

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

cashdiff_reasoncode
string

An optional reason code added when there is a difference between the expected and the counted cash when closing the register.

cashdiff_reasoncomment
string

An optional comment on the reason for a difference between the expected and the counted cash when closing the register.

StoreZReport
object

PROPERTIES
store_zreport_id
string
READ ONLY

UUID for the Store Z-report

currency_code
string

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

store_id
string

Store ID (external ID of the Store in Sitoo). All POS Z-reports without a proper store_id will be aggregated to a Store Z-report with the store_id value of NO_STORE.

store_name
string

The name of the store

day_created
string

The day that this report was created

Pattern: ^[0-9]{4}-[0-9]{2}-[0-9]{2}$
date_created
integer

Unix timestamp for when this report was created.

register_zreports
array
(object)
data
StoreZReportData

The aggregated data for this Store Z-report

moneysalestotal
Money

The total gross money value for sales.

moneysalestotalnet
Money

The total net money value for sales.

numsales
integer

The total number of sales.

numsalesitems
integer

The total number of items in sales.

vatgroupssales
array

Sales grouped by vat values. See ZReportVatGroup for fields.

productgroupssales
array

Sales grouped by product group. See ZReportProductGroup for fields.

moneysalesnotdeliveredtotal
Money

The total gross money value for sales not delivered.

moneysalesnotdeliveredtotalnet
Money

The total net money value for sales not delivered.

numsalesnotdelivered
integer

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

numsalesnotdelivereditems
integer

The total number of items in sales not delivered.

vatgroupssalesnotdelivered
array

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

productgroupssalesnotdelivered
array

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

moneyrefundtotal
Money

The total gross money value for refunds.

moneyrefundtotalnet
Money

The total net money value for refunds.

numrefund
integer

The total number of refunds.

numrefunditems
integer

The total number of items in refunds.

vatgroupsrefund
array

Refunds grouped by vat values. See ZReportVatGroup for fields.

PROPERTIES
vatvalue
number
moneytotal
moneytotalnet
moneytotalvat
productgroupsrefund
array

Refunds grouped by product group. See ZReportProductGroup for fields.

moneyroundoff
Money

The total money value for roundoff.

salestaxessales
array

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

salestaxesrefund
array

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

moneysalestaxinadvance
Money

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

moneysummarysales
Money

The total money value for sales.

moneysummaryrefund
Money

The total money value for refunds.

moneysummarysubtotal
Money

The sub total money value (moneysummarysales - moneysummaryrefund).

moneysummarysalestax
Money

The sub total money value for sales tax.

moneysummaryroundoff
Money

The total money value for roundoff.

moneysummarytotal
Money

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

paymentssales
array

All payments for sales. See ZReportPayment for fields.

paymentsrefund
array

All payments for refunds. See ZReportPayment for fields.

discountssales
array

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

discountssalesnotdelivered
array

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

discountsrefund
array

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

moneycash_in
Money

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

moneycash_salesrefunds
Money

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

moneycash_petty
Money

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

moneycash_bank
Money

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

moneycash_expected
Money

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

moneycash_counted
Money

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

moneycash_diff
Money

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

moneycash_bankfinal
Money

The amount of cash banked after cash had been counted.

moneycash_out
Money

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

moneydiscount
Money

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

numsalestypeproduct
integer

The total number of items of type "Product".

numsalestypeservice
integer

The total number of items of type "Service".

numsalestypegiftcard
integer

The total number of items of type "GiftCard".

numreceipts
integer

The total number of receipts.

numopendrawer
integer

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

numpractice
integer

The total number of transactions made in practice mode.

moneypractice
Money

The total money value of transactions made in practice mode.

currencyconversions
array

Contains details about foreign currencies. See ZReportCurrencyConversion for fields.

StoreZReportConfig
object

Configuration for running the Store Z-report aggregation service

PROPERTIES
aggregation_active
boolean

Boolean value indicating if aggregation of POS Z-reports to Store Z-report should run or not

Default: false
hour_of_day
integer

The hour of the day (for the time_zone specified) that the service should run

Minimum: 0
Maximum: 23
time_zone
string

The timezone to be used for the aggregation to decide when the service should run

StoreZReportData
object

PROPERTIES
moneysalestotal
Money

The total gross money value for sales.

moneysalestotalnet
Money

The total net money value for sales.

numsales
integer

The total number of sales.

numsalesitems
integer

The total number of items in sales.

vatgroupssales
array
(ZReportVatGroup)

Sales grouped by vat values. See ZReportVatGroup for fields.

productgroupssales
array
(ZReportProductGroup)

Sales grouped by product group. See ZReportProductGroup for fields.

moneysalesnotdeliveredtotal
Money

The total gross money value for sales not delivered.

moneysalesnotdeliveredtotalnet
Money

The total net money value for sales not delivered.

numsalesnotdelivered
integer

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

numsalesnotdelivereditems
integer

The total number of items in sales not delivered.

vatgroupssalesnotdelivered
array
(ZReportVatGroup)

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

productgroupssalesnotdelivered
array
(ZReportProductGroup)

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

moneyrefundtotal
Money

The total gross money value for refunds.

moneyrefundtotalnet
Money

The total net money value for refunds.

numrefund
integer

The total number of refunds.

numrefunditems
integer

The total number of items in refunds.

vatgroupsrefund
array
(ZReportVatGroup)

Refunds grouped by vat values. See ZReportVatGroup for fields.

productgroupsrefund
array
(ZReportProductGroup)

Refunds grouped by product group. See ZReportProductGroup for fields.

moneyroundoff
Money

The total money value for roundoff.

salestaxessales
array
(ZReportSalesTax)

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

salestaxesrefund
array
(ZReportSalesTax)

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

moneysalestaxinadvance
Money

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

moneysummarysales
Money

The total money value for sales.

moneysummaryrefund
Money

The total money value for refunds.

moneysummarysubtotal
Money

The sub total money value (moneysummarysales - moneysummaryrefund).

moneysummarysalestax
Money

The sub total money value for sales tax.

moneysummaryroundoff
Money

The total money value for roundoff.

moneysummarytotal
Money

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

paymentssales
array
(ZReportPayment)

All payments for sales. See ZReportPayment for fields.

paymentsrefund
array
(ZReportPayment)

All payments for refunds. See ZReportPayment for fields.

discountssales
array
(ZReportDiscount)

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

discountssalesnotdelivered
array
(ZReportDiscount)

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

discountsrefund
array
(ZReportDiscount)

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

moneycash_in
Money

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

moneycash_salesrefunds
Money

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

moneycash_petty
Money

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

moneycash_bank
Money

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

moneycash_expected
Money

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

moneycash_counted
Money

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

moneycash_diff
Money

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

moneycash_bankfinal
Money

The amount of cash banked after cash had been counted.

moneycash_out
Money

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

moneydiscount
Money

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

numsalestypeproduct
integer

The total number of items of type "Product".

numsalestypeservice
integer

The total number of items of type "Service".

numsalestypegiftcard
integer

The total number of items of type "GiftCard".

numreceipts
integer

The total number of receipts.

numopendrawer
integer

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

numpractice
integer

The total number of transactions made in practice mode.

moneypractice
Money

The total money value of transactions made in practice mode.

currencyconversions
array
(ZReportCurrencyConversion)

Contains details about foreign currencies. See ZReportCurrencyConversion for fields.

ZReportCurrencyConversion
object

Contains details about a foreign currency with conversion to the default (base) currency.

PROPERTIES
currency_code
string

The currency code of the foreign currency (3-letter ISO 4217).

Pattern: ^[A-Z]{3}$
money_expected
Money

The calculated amount for cash in the register in the foreign currency before it was counted.

money_counted
Money

The counted amount for cash in the register in the foreign currency when closing.

money_expected_base
Money

The calculated amount for cash in the register before it was counted, converted to the default currency.

money_counted_base
Money

The counted amount for cash in the register when closing, converted to the default currency.

ZReportDiscount
object

Contains the discount details for a Z-report.

PROPERTIES
vouchercode
string

The vouchercode of the discount group.

moneytotal
Money

The total gross money value for the discount group.

moneytotalnet
Money

The total net money value for the discount group.

moneytotalvat
Money

The total vat money value for the discount group.

ZReportPayment
object

Contains the payment details for a Z-report.

PROPERTIES
name
string

The name of the payment.

moneytotal
Money

The total money value of the payment.

moneycaptured
Money
nullable

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

moneyinadvance
Money
nullable

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

moneyreserved
Money
nullable

The reserved amount.

subpayments
array
(ZReportSubPayment)

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

ZReportProductGroup
object

Contains the product group details for a Z-report.

PROPERTIES
name
string

The name of the product group.

vatvalue
number

The vat value for the product group.

numtotal
integer

The total number of items for the product group.

moneytotal
Money

The total gross money value for the product group.

moneytotalnet
Money

The total net money value for the product group.

moneytotalvat
Money

The total vat money value for the product group.

ZReportSalesTax
object

Contains the sales tax details for a Z-report.

PROPERTIES
name
string

The name of the sales tax.

code
string

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

externalid
string

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

groupregion
string

The region of the salestaxgroup this salestax item belongs to.

moneytotal
Money

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

moneytax
Money

The total net money value for this sales tax.

decimaltaxvalue
string

The tax value in percent.

ZReportSubPayment
object

Contains the details for a sub payment of ZReportPayment.

PROPERTIES
name
string

The name of the sub payment.

moneysubtotal
Money

The money value of the sub payment.

moneycaptured
Money
nullable

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

moneyinadvance
Money
nullable

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

moneyreserved
Money
nullable

The reserved amount.

ZReportVatGroup
object

Contains the VAT details for a Z-report.

PROPERTIES
vatvalue
number

The vat value for the vat group.

moneytotal
Money

The total gross money value for the vat group.

moneytotalnet
Money

The total net money value for the vat group.

moneytotalvat
Money

The total vat money value for the vat group.

Copyright © 2024 Sitoo AB. All rights reserved.