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

Journals

Get Journal Entries

get /journal-entries

Endpoint for retrieving journal entries for a POS. The items returned are sorted by date_type in sort_order order.

PARAMETERS
register_id
string
query
REQUIRED

Filter journal entries generated from a specific cash register ID.

Example: /journal-entries?register_id={2AA484B4-2B5F-55AB-128A-7DB46E573357}
date_from
integer
query

Filter on journal entries with date starting on or after the Unix timestamp provided (inclusive).

date_to
integer
query

Filter on journal entries with date ending on or before the Unix timestamp provided (inclusive).

date_type
string
query

Type of date to filter on when using date_from and date_to filters.

Available values:
  • created
  • added
Default: "created"
sort_order
string
query

Sort order for journal entries. Note that this just controls the direction the entries are sorted (ascending or descending), the property used to sort on is controlled by date_type.

SortOrder
type
string
query

Filter on journal entry type

JournalEntryType
num
integer
query

Number of items to return.

Default: 10
next
string
query

The next cursor from previous request to continue pagination.

Returns

Successful. Returns an envelope for journal entries.

JournalEntryEnvelope
gethttps://journals.sitooapis.com/v3/journal-entries?register_id={2AA484B4-2B5F-55AB-128A-7DB46E573357}
RESPONSE JSON
{
  "items": [
    {
      "data": {
        "staff": "POS Staff",
        "staffuserid": "{25BA93F6-64A3-2D33-1B4B-7462658F6B3C}"
      },
      "dateadded": 1672386301,
      "datecreated": 1672386296,
      "id": 1,
      "ispractice": false,
      "registerid": "{2AA484B4-2B5F-55AB-128A-7DB46E573357}",
      "registerkey": "SIE0000150100023",
      "type": "login"
    },
    {
      "data": {
        "currencycode": "SEK",
        "moneycash": "5000.00",
        "staff": "POS Staff",
        "staffuserid": "{25BA93F6-64A3-2D33-1B4B-7462658F6B3C}"
      },
      "dateadded": 1672386301,
      "datecreated": 1672386301,
      "id": 2,
      "ispractice": false,
      "registerid": "{2AA484B4-2B5F-55AB-128A-7DB46E573357}",
      "registerkey": "SIE0000150100023",
      "type": "cash-start"
    },
    {
      "data": {
        "additionaldata": {
          "pos-receiptid": "SIE000015010002310000",
          "pos-staff-externalid": "PS",
          "pos-staff-userid": "{25BA93F6-64A3-2D33-1B4B-7462658F6B3C}",
          "pos-timezone": "Europe/Stockholm",
          "store-externalgroupid": "NORDIC",
          "store-externalid": "200",
          "store-name": "Sitoo Concept Store"
        },
        "comment": "",
        "currencycode": "SEK",
        "isrefund": false,
        "items": [
          {
            "additionaldata": {
              "item-delivered": "true",
              "item-productid": "16",
              "product-group-name": "Standard"
            },
            "decimalunitquantity": "0.000",
            "discounts": [
              {
                "discountname": "3 FOR 2 (LIMITED)",
                "id": 21,
                "moneytotal": "142.00",
                "moneyvat": "28.40"
              }
            ],
            "moneydiscount": "0.00",
            "moneytotal": "426.00",
            "moneyunitprice": "142.00",
            "moneyvat": "85.20",
            "printrow": [],
            "printsection": [],
            "productgroupname": "Standard",
            "productgrouptype": 10,
            "productname": "Deco Coat B/W",
            "quantity": 3,
            "salestaxes": [],
            "sku": "597330-S",
            "vatid": 2,
            "vatvalue": 25
          }
        ],
        "moneyroundoff": "0.00",
        "moneysalestaxinadvance": "0.00",
        "moneytotal": "284.00",
        "payments": [
          {
            "additionaldata": {
              "payment-method": "cash",
              "payment-reftype": "cash"
            },
            "moneycaptured": "284.00",
            "moneyinadvance": "0.00",
            "moneytotal": "284.00",
            "paymentexternalid": "CASH",
            "paymentmethod": 100,
            "paymentname": "Cash",
            "printrow": [],
            "printsection": []
          }
        ],
        "posname": "Sitoo POS",
        "posversion": "1.64",
        "printsection": [],
        "quantitytotal": 3,
        "receiptnumber": 10000,
        "salestaxsummary": [],
        "staff": "POS Staff",
        "staffuserid": "{25BA93F6-64A3-2D33-1B4B-7462658F6B3C}",
        "vatsummary": [
          {
            "moneynet": "227.20",
            "moneyvat": "56.80",
            "vatvalue": 25
          }
        ]
      },
      "dateadded": 1672386311,
      "datecreated": 1672386311,
      "id": 8,
      "ispractice": false,
      "registerid": "{2AA484B4-2B5F-55AB-128A-7DB46E573357}",
      "registerkey": "SIE0000150100023",
      "type": "receipt"
    }
  ],
  "next": ""
}
HTTP Status Code Summary
200Successful. Returns an envelope for journal entries.
400Invalid request. Data sent from client is invalid.
401Missing or bad authentication.
403User is not authorized to perform operation.
404The specified resource was not found.
429Too Many Requests.
500Internal Server Error.

Objects

DecimalQuantity
string

Pattern: ^[-+]?[0-9]+\.[0-9]{3}$
Example: "12.345"

ErrorCode
string

Error code describing the data and depending on value, the error_data property will contain the following additional information:

Error codeAdditional info
field-missingfield
field-unknownfield
field-readonlyfield
field-typefield
field-validationfield
condition-failednone
othernone

ErrorMessage
object

Error object returned when a request is not successful

PROPERTIES
request_id
string
REQUIRED

ID of request

Example: ""123e4567-e89b-12d3-a456-426614174000""
error_code
ErrorCode
REQUIRED

The error code returned.

error_data
object
REQUIRED

More data depending on the error code

<*>
string

JournalCart
object

Cart details for a journal entry.

PROPERTIES
staff
string
REQUIRED

The name of the staff that generated the entry.

staffuserid
string
REQUIRED

The user ID for the staff that generated the entry.

id
string
REQUIRED

Unique ID for the cart. Will be same during a session (until cart is cleared or committed).

quantitytotal
integer
REQUIRED

The total item quantity for the cart.

moneytotal
Money
REQUIRED

The total amount for the cart (what to pay).

moneydiscount
Money
REQUIRED

The total discount for the cart (already removed from moneytotal).

additionaldata
object

Additional data for the cart.

<*>
string
Additional properties can exist with a value of type string

JournalCartItem
object

Cart item details for a journal entry.

PROPERTIES
staff
string
REQUIRED

The name of the staff that generated the entry.

staffuserid
string
REQUIRED

The user ID for the staff that generated the entry.

item_index
integer
REQUIRED

The zero-based index of the item in the cart. Note that the index of an item in the cart will change if one before it in the list is removed.

Minimum: 0
sku
string
REQUIRED

The product SKU for the item.

quantity
integer

The quantity for the item.

moneytotal
Money

The total amount for the item (what to pay).

moneydiscount
Money

The total discount for the item (already removed from moneytotal).

decimalunitquantity
DecimalQuantity

The unit quantity decimal value for the item (if applicable).

note
string

The note for the item.

additionaldata
object

Additional data for this receipt item.

<*>
string
Additional properties can exist with a value of type string
cart_id
string
REQUIRED

Unique ID for the cart. Will be same during a session (until cart is cleared or committed).

cart_quantitytotal
integer
REQUIRED

The total item quantity for the cart.

cart_moneytotal
Money
REQUIRED

The total amount for the cart (what to pay).

cart_moneydiscount
Money
REQUIRED

The total discount for the cart (already removed from cart_moneytotal).

JournalCartPayment
object

Cart payment details for a journal entry.

PROPERTIES
staff
string
REQUIRED

The name of the staff that generated the entry.

staffuserid
string
REQUIRED

The user ID for the staff that generated the entry.

payment_index
integer
REQUIRED

The zero-based index of the payment in the cart. Note that the index of an payment in the cart will change if one before it in the list is removed.

Minimum: 0
paymentname
string
REQUIRED

The name of the payment.

paymentmethod
PaymentMethod
REQUIRED

The method used for this payment.

moneytotal
Money
REQUIRED

The total amount for the payment.

moneycaptured
Money
REQUIRED

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

additionaldata
object

Additional data for this payment.

rollback-success
string

Indicates the outcome in case of a payment rollback. Only for journal entry type cart-payment-remove. Possible values are:

  • true
  • false
nets-sitooreference
string

The Sitoo reference of a cancelled Nets payment. Only for journal entry types cart-payment-cancel and cart-payment-remove.

<*>
string
Additional properties can exist with a value of type string
cart_id
string
REQUIRED

Unique ID for the cart. Will be same during a session (until cart is cleared or committed).

JournalCash
object

A journal entry of type Cash Transaction.

Types:

  • cash-bank
  • cash-bank-final
  • cash-counted
  • cash-petty
  • cash-start
PROPERTIES
staff
string
REQUIRED

The name of the staff that generated the entry.

staffuserid
string
REQUIRED

The user ID for the staff that generated the entry.

currencycode
string
REQUIRED

Currency Code for the cash transaction (3-letter ISO 4217).

moneycash
Money
REQUIRED

The amount of money for the cash transaction. Negative values indicate withdrawals.

comment
string

Comment for the cash transaction.

additionaldata
object

Additional data for the cash transaction. Dictionary object <string, string>.

reasoncode
string

Reason Code for the cash transaction

<*>
string
Additional properties can exist with a value of type string

JournalCtuError
object

A journal entry of type Control Unit Error.

PROPERTIES
errortext
string
REQUIRED

The error message received from the Control Unit.

JournalData

The data for a journal entry based on the type. See the JournalEntryType enum for details.

oneOf:

JournalEntry
object

A journal entry for a Sitoo POS (Cash Register).

PROPERTIES
type
JournalEntryType
REQUIRED

The discriminator property for which object is contained in the data property.

id
integer
REQUIRED

The ID generated by the POS client for this entry. Note! All clients will have these in the order of when they were created, but for some clients the IDs will not be in sequence.

dateadded
integer
(int64)
READ ONLY

Unix timestamp for when the entry was added to the backup service. Useful for cases when a POS has been offline for a period of time and an external integration is running a continuous service to fetch new journal entries.

datecreated
integer
(int64)
REQUIRED

Unix timestamp for when the entry was created on the POS client.

registerid
string
REQUIRED

The ID for the POS that generated the entry.

registerkey
string
REQUIRED

The key for the POS that generated the entry.

ispractice
boolean
REQUIRED

If true, then this entry was generated in practice mode.

data
JournalData
REQUIRED

The data property will hold the specific data for the type of journal entry.

JournalEntryEnvelope
object

Envelope for Journal Entries.

PROPERTIES
items
array
(JournalEntry)
REQUIRED

Matching journal entries sorted by parameters date_type and sort_order.

next
string
REQUIRED

Next cursor, used to continue pagination. Empty string will be returned if all data has been delivered.

JournalEntryType
string

The type of journal entry. The type determines what type of object is stored in the data property of the JournalEntry object.

JournalPrintout
object

A journal entry of type Printout.

PROPERTIES
staff
string
REQUIRED

The name of the staff that generated the entry.

staffuserid
string
REQUIRED

The user ID for the staff that generated the entry.

type
string
REQUIRED

The type of printout.

VALUES
delivery
gift-receipt
order
receipt-refund
receipt-refund-electronic
receipt-refund-store-copy
receipt-sale
receipt-sale-electronic
receipt-sale-store-copy
report-x
report-z
receiptid
string

The receipt ID for the printout (where applicable)

orderid
integer

The order ID for the printout (where applicable)

zreportid
integer

The z-report ID for the printout (where applicable)

additionaldata
object

Additional data for this printout.

<*>
string
Additional properties can exist with a value of type string

JournalReceipt
object

A journal entry of type Receipt.

PROPERTIES
receiptnumber
integer
REQUIRED

The receipt number. Incremental number, unique to a cash register. Used together with the registerkey to produce the receipt ID (receiptid = "<registerkey><receiptnumber>") which is the unique reference to the receipt.

moneytotal
Money
REQUIRED

The total amount for this receipt.

quantitytotal
integer
REQUIRED

The total item quantity for this receipt.

moneysubtotal
Money

The sub total amount before sales tax for the receipt (if applicable).

moneyroundoff
Money
REQUIRED

The roundoff amount for the receipt.

currencycode
string
REQUIRED

Currency code for the receipt (3-letter ISO 4217).

isrefund
boolean
REQUIRED

True if the receipt is for a refund.

staff
string
REQUIRED

The name of the staff that handled the transaction.

staffuserid
string
REQUIRED

The user ID for the staff that handled the transaction.

creditorderid
integer

Order ID in Sitoo for the purchase that a refund is referencing.

items
array
(JournalReceiptItem)
REQUIRED

An array of JournalReceiptItem with the items for the receipt.

payments
array
(JournalReceiptPayment)
REQUIRED

An array of JournalReceiptPayment with the payments for the receipt.

vatsummary
array
(JournalReceiptVat)
REQUIRED

An array of JournalReceiptVat with the VAT details for the receipt.

salestaxsummary
array
(JournalReceiptSalesTax)
REQUIRED

An array of JournalReceiptSalesTax with the sales tax details for the receipt.

moneysalestaxinadvance
Money
REQUIRED

The amount for the sales tax for not delivered items.

customer
JournalReceiptCustomer

The customer for the receipt, object of type JournalReceiptCustomer.

additionaldata
object

Additional data for this receipt.

crm-channelid
string

ID for the CRM channel used (Applicable for systems using multiple CRM channels)

crm-customerid
string

ID for the customer in the CRM system

crm-membernumber
string

Member Number for the customer in the CRM system

ctu-code
string

Code generated from the Control Unit used for the purchase

ctu-id
string

ID for the Control Unit used for the purchase

delivery-pickup-externalid
string

External ID for the Warehouse where the pickup should be made

delivery-pickup-warehouseid
string

Warehouse ID where the pickup should be made

influencer-influencercode
string

Code used to activate influencer voucher

influencer-influencername
string

Name of influencer

pos-receiptid
string

Receipt ID for the purchase

pos-refund-initiation-mode
string

The initiation mode for the return/refund

  • scanner-receiptid Receipt ID barcode scanned
  • scanner-receiptid-giftreceipt Gift receipt ID barcode scanned
  • latest-purchase Latest purchase
  • search-orderid Search for order ID
  • search-externalid Search for order external ID
  • search-receiptid Search for receipt ID
  • search-receiptid-giftreceipt Search using gift receipt
  • order-list Returned from list view of orders
  • crm-transaction-list Returned from list of previous purchases for customer
  • manual Manual return
pos-refund-receiptid
string

Receipt ID for the refund that was done in connection to this purchase

pos-sourceorderid
string

ID for the order that was the source for this purchase (Booking or POSParked)

pos-staff-userid
string

User ID for the POS staff that handled the transaction

pos-staff-userid-helpers
string

User ID(s) for extra POS staff that were part of handling the cart (excluding the staff that handled the transaction). If multiple IDs are provided, they will be separated by comma.

pos-staff-externalid
string

External ID for the POS staff that handled the transaction

pos-staff2-externalid
string

External ID for the POS staff that handled secondary authorization of the transaction

pos-staffsales-userid
string

User ID for the POS staff that is responsible for the sale (or refund)

pos-staffsales-externalid
string

External ID for the POS staff that is responsible for the sale (or refund)

pos-staffsales-name
string

Name for the POS staff that is responsible for the sale (or refund)

pos-timezone
string

The timezone for the POS that generated the transaction

refundreasoncode-comment
string

Comment for refund

refundreasoncode-reasoncode
string

Reason code for refund

reserve-warehouseid
string

Warehouse ID where items not delivered in this purchase will be reserved

serviceorder-id
string

ID of the service order being paid for

store-externalid
string

External ID for the store where the purchase was made

store-externalgroupid
string

External Group ID for the store where the purchase was made

store-name
string

Name of the store where the purchase was made

voyado-contactid
string

Contact ID from Voyado for the customer that made the purchase

voyado-membernumber
string

Member Number from Voyado for the customer that made the purchase

pos-emergency-mode
string

A value of "true" indicates that the POS was set to emergency mode when the purchase was made

<*>
string
Additional properties can exist with a value of type string
printsection
array
(PrintLine)
REQUIRED

An array of PrintLine.

comment
string

A comment/note associated with the receipt.

posname
string
REQUIRED

The name of the cash register that generated the receipt.

posversion
string
REQUIRED

The version of the cash register that generated the receipt.

JournalReceiptCustomer
object

A customer for a JournalReceipt.

PROPERTIES
id
string

The ID for the customer.

email
string

The email for the customer.

namefirst
string

The first name for the customer.

namelast
string

The last name for the customer.

personalid
string

The personal ID for the customer.

companyid
string

The company ID for the customer.

company
string

The company for the customer.

mobile
string

The mobile phone number for the customer.

customerref
string

Reference for the customer.

invoice_address
string

Invoice address for the customer.

invoice_address2
string

Extra invoice address field for the customer.

invoice_zip
string

Invoice zip/postal code for the customer.

invoice_city
string

Invoice city for the customer.

invoice_state
string

Invoice state/region for the customer.

invoice_countryid
string

Invoice country ID for the customer.

delivery_address
string

Delivery address for the customer.

delivery_address2
string

Extra delivery address field for the customer.

delivery_zip
string

Delivery zip/postal code for the customer.

delivery_city
string

Delivery city for the customer.

delivery_state
string

Delivery state/region for the customer.

delivery_countryid
string

Delivery country ID for the customer.

JournalReceiptItem
object

An item containing the product and item details for a JournalReceipt.

PROPERTIES
sku
string
REQUIRED

The product SKU for the item.

productname
string
REQUIRED

The product name for the item.

variant
string

The product variant information for the item (e.g. "Size: M").

discountname
string

The discount name for the item.

note
string

The note for the item.

productgrouptype
integer
REQUIRED

The product group type.

  • 10 Product
  • 20 Service
  • 30 GiftCard
productgroupname
string
REQUIRED

The product group name for the item.

unitlabel
string

The unit label for the item.

quantity
integer
REQUIRED

The number of items purchased.

moneytotal
Money
REQUIRED

The total amount for the item.

moneydiscount
Money
REQUIRED

The discount amount for the item (Including VAT).

moneyvat
Money
REQUIRED

The VAT amount for the item.

moneyunitprice
Money
REQUIRED

The unit price amount for the item.

decimalunitquantity
DecimalQuantity

The unit quantity decimal value for the item (if applicable).

vatid
integer
REQUIRED

The VAT ID for the item.

vatvalue
number
(double)
REQUIRED

The VAT value for the item.

discounts
array
(JournalReceiptItemDiscount)
REQUIRED

An array of JournalReceiptItemDiscount applied to this item.

salestaxes
array
(JournalReceiptSalesTax)
REQUIRED

An array of JournalReceiptSalesTax applied to this item.

additionaldata
object

Additional data for this receipt item.

giftcard-cardnumber
string

Card number of giftcard purchased

item-delivered
string

A value of "false" indicates that the item was not delivered at the time of the purchase.

item-imei
string

The unique IMEI number for this item

item-imei2
string

The unique IMEI2 number for this item

item-productid
string

Product ID for this item

item-serial
string

The unique serial number for this item

item-vatid
string

ID for the Product Group (VAT) for this item

item-voucherid
string

ID used for discount

item-vouchercode
string

Group used for discount

item-voucherpercentage
string

Percentage used for discount

pos-originalsales-orderitemid
string

ID/Index referring to the item from the original purchase being returned

pricelist-externalid
string

External ID for the price list used

product-group-name
string

The name of the product group for this item

reasoncode-manualdiscount
string

Reason code for manual discount on item

reasoncode-manualprice
string

Reason code for manual price change on item

reasoncode-return
string

Reason code for return of item (Either reclaim or refund)

return-warehouseid
string

ID for the warehouse that the item was returned to (if other than the register warehouse)

<*>
string
Additional properties can exist with a value of type string
printrow
array
(PrintLine)
REQUIRED

An array of PrintLine.

printsection
array
(PrintLine)
REQUIRED

An array of PrintLine.

JournalReceiptItemDiscount
object

A discount for a JournalReceiptItem.

PROPERTIES
id
integer
REQUIRED

The ID for the discount (voucherid in Sitoo Vouchers).

discountname
string
REQUIRED

The name of the discount (vouchername in Sitoo Vouchers).

discountgroup
string

The group name for the discount ("vouchercode" in Sitoo Vouchers).

moneytotal
Money
REQUIRED

The total money amount of the discount.

moneyvat
Money
REQUIRED

The total money VAT amount for the discount

additionaldata
object

Additional data for this discount.

crm-bonuscheckid
string

ID of bonus check used

crm-promotionid
string

ID of promotion used

customcrm-bonuscheckid
string

ID of bonus check used

customcrm-promotionid
string

ID of promotion used

pricelist-externalid
string

External ID for the price list used

<*>
string
Additional properties can exist with a value of type string

JournalReceiptPayment
object

A payment for a JournalReceipt.

PROPERTIES
paymentname
string
REQUIRED

The name of the payment.

paymentmethod
PaymentMethod
REQUIRED

The method used for this payment.

paymentexternalid
string

External ID for the payment (if applicable).

moneytotal
Money
REQUIRED

The total amount of the payment.

moneycaptured
Money
REQUIRED

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

moneyinadvance
Money
REQUIRED

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

additionaldata
object

Additional data for this payment.

adyen-cardalias
string

Adyen card number token

adyen-cardtype
string

Adyen card type

adyen-paymentmethod
string

Adyen payment method

adyen-paymentmethodvariant
string

Adyen payment method variant

adyen-pspreference
string

Adyen PSP reference

adyen-tenderreference
string

Adyen tender reference

adyen-txdate
string

Adyen transaction date (ISO-8601)

bambora-host2t-internalreference
string

Internal reference for the payment in Bambora Terminal

bambora-host2t-terminalid
string

ID for the Bambora Terminal

coiney-transactionref
string

Transaction reference for Coiney payment

custompayment-mobile
string

Mobile number used for custom payment

custompayment-paymentid
string

ID for custom payment

foreign-currency-amount
string

The amount for the payment in the currency specified by foreign-currency-code

foreign-currency-code
string

The foreign currency used for the payment (ISO 4217, alpha-3 uppercased)

foreign-currency-exchange-rate
string

The exchange rate for the payment where the default currency is quoted against the currency specified by foreign-currency-code

giftcard-cardnumber
string

Card number of giftcard used for payment

giftcard-cardnumber-display
string

The masked card number of giftcard used for payment

izettle-panhash
string

PAN hash value for iZettle

izettle-sitooreference
string

The Sitoo instance reference for the payment in iZettle

klarna-klarnareference
string

Klarna order reference

klarna-merchantid
string

Klarna merchant ID

klarna-orderid
string

Klarna order ID

klarnav2-id
string

Klarna ID for payment made with legacy v2 API

mobile
string

Mobile number used for payment

mobilepay-paymentid
string

The ID for the MobilePay payment

nets-amount
string

The amount for the payment in Nets Terminal

nets-issuerid
string

Property issuerId from LocalModeEventArgs in Nets Terminal

nets-sitooreference
string

The Sitoo instance reference for the payment in Nets Terminal

nets-terminalid
string

Property terminalID from LocalModeEventArgs in Nets Terminal

payment-cardmaskedpan
string

Masked PAN for card

payment-cardproductname
string

Product name for card

payment-cardissuer
string

Issuer of card

payment-method
string

The payment method used for this payment

payment-refid
string

The reference transaction id for the payment

payment-reftype
string

The reference type for the payment

pos-originalsales-payment-index
string

Index referring to the payment from the original purchase being returned

swish-paymentid
string

The ID for the Swish payment

verifone-lpp-reference-number
string

Reference number for the payment in Verifone Terminal

verifone-card-masked-pan
string

The masked card number for the payment in Verifone Terminal

virtual-payment
string

A value of "true" indicates that the payment is not a real transaction, but simply an exchange done between 2 purchases

<*>
string
Additional properties can exist with a value of type string
printrow
array
(PrintLine)
REQUIRED

An array of PrintLine.

printsection
array
(PrintLine)
REQUIRED

An array of PrintLine.

JournalReceiptSalesTax
object

Sales tax details for JournalReceipt and JournalReceiptItem.

PROPERTIES
id
integer
REQUIRED

The ID of the sales tax.

name
string
REQUIRED

The name of the sales tax.

code
string

The code used for the sales tax.

externalid
string

External ID for the salestaxproductgrouprule that was used for the sales tax.

groupregion
string

The region for the salestaxgroup that was used for the sales tax.

decimalvalue
DecimalQuantity
REQUIRED

The tax percentage used for the sales tax.

moneytotal
Money
REQUIRED

The total amount that the sales tax was applied towards.

moneytax
Money
REQUIRED

The amount taxed for the sales tax.

JournalReceiptVat
object

The VAT details for a JournalReceipt.

PROPERTIES
vatvalue
number
(double)
REQUIRED

The vat value in percentage.

moneyvat
Money
REQUIRED

The amount for the receipt VAT.

moneynet
Money
REQUIRED

The amount that the receipt VAT was calculated from.

JournalXReport
object

PROPERTIES
manufacturerid
string
REQUIRED

Manufacturer ID for the Cash Register.

dateopened
integer
(int64)
REQUIRED

Timestamp for when the register was opened.

eshopid
integer
REQUIRED

Eshop ID (Eshop ID for the journal report in Sitoo)

store_id
string

Store ID (external ID of the Store in Sitoo)

store_name
string

The name of the store

company
string
REQUIRED

Company Name.

companyid
string
REQUIRED

Company ID.

address
string
REQUIRED

Address line 1 (street address).

address2
string
REQUIRED

Address line 2 (c/o or similar).

address3
string
REQUIRED

Address line 3 (zip, city and state).

currencycode
string
REQUIRED

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

staff
string
REQUIRED

The name of the staff that produced the report.

staffuserid
string
REQUIRED

The user ID for the staff that produced the report.

comment
string

The comment that the staff entered for the report.

moneysalestotal
Money
REQUIRED

The total gross amount for sales.

moneysalestotalnet
Money
REQUIRED

The total net amount for sales.

numsales
integer
REQUIRED

The total number of sales.

numsalesitems
integer
REQUIRED

The total number of items in sales.

vatgroupssales
array
(JournalReportVatGroup)
REQUIRED

Sales grouped by vat values. See JournalReportVatGroup for fields.

productgroupssales
array
(JournalReportProductGroup)
REQUIRED

Sales grouped by product group. See JournalReportProductGroup for fields.

moneysalesnotdeliveredtotal
Money
REQUIRED

The total gross amount for sales not delivered.

moneysalesnotdeliveredtotalnet
Money
REQUIRED

The total net amount for sales not delivered.

numsalesnotdelivered
integer
REQUIRED

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

numsalesnotdelivereditems
integer
REQUIRED

The total number of items in sales not delivered.

vatgroupssalesnotdelivered
array
(JournalReportVatGroup)
REQUIRED

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

productgroupssalesnotdelivered
array
(JournalReportProductGroup)
REQUIRED

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

moneyrefundtotal
Money
REQUIRED

The total gross amount for refunds.

moneyrefundtotalnet
Money
REQUIRED

The total net amount for refunds.

numrefund
integer
REQUIRED

The total number of refunds.

numrefunditems
integer
REQUIRED

The total number of items in refunds.

vatgroupsrefund
array
(JournalReportVatGroup)
REQUIRED

Refunds grouped by vat values. See JournalReportVatGroup for fields.

productgroupsrefund
array
(JournalReportProductGroup)
REQUIRED

Refunds grouped by product group. See JournalReportProductGroup for fields.

moneyroundoff
Money
REQUIRED

The total amount for roundoff.

salestaxessales
array
(JournalReportSalesTax)
REQUIRED

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

salestaxesrefund
array
(JournalReportSalesTax)
REQUIRED

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

moneysalestaxinadvance
Money
REQUIRED

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

moneysummarysales
Money
REQUIRED

The total amount for sales.

moneysummaryrefund
Money
REQUIRED

The total amount for refunds.

moneysummarysubtotal
Money
REQUIRED

The sub total amount (moneysummarysales - moneysummaryrefund).

moneysummarysalestax
Money
REQUIRED

The sub total amount for sales tax.

moneysummaryroundoff
Money
REQUIRED

The total amount for roundoff.

moneysummarytotal
Money
REQUIRED

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

paymentssales
array
(JournalReportPayment)
REQUIRED

All payments for sales. See JournalReportPayment for fields.

paymentsrefund
array
(JournalReportPayment)
REQUIRED

All payments for refunds. See JournalReportPayment for fields.

discountssales
array
(JournalReportDiscount)
REQUIRED

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

discountssalesnotdelivered
array
(JournalReportDiscount)
REQUIRED

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

discountsrefund
array
(JournalReportDiscount)
REQUIRED

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

moneycash_in
Money
REQUIRED

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

moneycash_salesrefunds
Money
REQUIRED

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

moneycash_petty
Money
REQUIRED

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

moneycash_bank
Money
REQUIRED

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

moneycash_expected
Money
REQUIRED

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

moneycash_counted
Money
REQUIRED

The counted amount for cash in the register when closing.

moneycash_diff
Money
REQUIRED

The difference in amount for cash between expected and counted values.

moneycash_bankfinal
Money
REQUIRED

The amount of cash banked after cash had been counted.

moneycash_out
Money
REQUIRED

The amount for cash in the register after it was closed.

moneydiscount
Money
REQUIRED

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

cash_bankfinal_bag_id
string

The money bank bag ID for the counted cash.

numsalestypeproduct
integer
REQUIRED

The total number of items of type "product".

numsalestypeservice
integer
REQUIRED

The total number of items of type "service".

numsalestypegiftcard
integer
REQUIRED

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

numreceipts
integer
REQUIRED

The total number of receipts.

numopendrawer
integer
REQUIRED

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

numpractice
integer
REQUIRED

The total number of transactions made in practice mode.

moneypractice
Money
REQUIRED

The total amount of transactions made in practice mode.

currencyconversions
array
(JournalReportCurrencyConversion)

Contains details about foreign currencies. See JournalReportCurrencyConversion for fields.

moneygrandtotalsales
Money
REQUIRED

The total amount for sales since the start of the cash register.

moneygrandtotalrefund
Money
REQUIRED

The total amount for refunds since the start of the cash register.

moneygrandtotalnet
Money
REQUIRED

The summary total amount 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.

zreportid
integer
nullable
READ ONLY
REQUIRED

Not used, this value is always null for X-Reports.

JournalZReport
object

PROPERTIES
manufacturerid
string
REQUIRED

Manufacturer ID for the Cash Register.

dateopened
integer
(int64)
REQUIRED

Timestamp for when the register was opened.

eshopid
integer
REQUIRED

Eshop ID (Eshop ID for the journal report in Sitoo)

store_id
string

Store ID (external ID of the Store in Sitoo)

store_name
string

The name of the store

company
string
REQUIRED

Company Name.

companyid
string
REQUIRED

Company ID.

address
string
REQUIRED

Address line 1 (street address).

address2
string
REQUIRED

Address line 2 (c/o or similar).

address3
string
REQUIRED

Address line 3 (zip, city and state).

currencycode
string
REQUIRED

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

staff
string
REQUIRED

The name of the staff that produced the report.

staffuserid
string
REQUIRED

The user ID for the staff that produced the report.

comment
string

The comment that the staff entered for the report.

moneysalestotal
Money
REQUIRED

The total gross amount for sales.

moneysalestotalnet
Money
REQUIRED

The total net amount for sales.

numsales
integer
REQUIRED

The total number of sales.

numsalesitems
integer
REQUIRED

The total number of items in sales.

vatgroupssales
array
(JournalReportVatGroup)
REQUIRED

Sales grouped by vat values. See JournalReportVatGroup for fields.

productgroupssales
array
(JournalReportProductGroup)
REQUIRED

Sales grouped by product group. See JournalReportProductGroup for fields.

moneysalesnotdeliveredtotal
Money
REQUIRED

The total gross amount for sales not delivered.

moneysalesnotdeliveredtotalnet
Money
REQUIRED

The total net amount for sales not delivered.

numsalesnotdelivered
integer
REQUIRED

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

numsalesnotdelivereditems
integer
REQUIRED

The total number of items in sales not delivered.

vatgroupssalesnotdelivered
array
(JournalReportVatGroup)
REQUIRED

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

productgroupssalesnotdelivered
array
(JournalReportProductGroup)
REQUIRED

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

moneyrefundtotal
Money
REQUIRED

The total gross amount for refunds.

moneyrefundtotalnet
Money
REQUIRED

The total net amount for refunds.

numrefund
integer
REQUIRED

The total number of refunds.

numrefunditems
integer
REQUIRED

The total number of items in refunds.

vatgroupsrefund
array
(JournalReportVatGroup)
REQUIRED

Refunds grouped by vat values. See JournalReportVatGroup for fields.

productgroupsrefund
array
(JournalReportProductGroup)
REQUIRED

Refunds grouped by product group. See JournalReportProductGroup for fields.

moneyroundoff
Money
REQUIRED

The total amount for roundoff.

salestaxessales
array
(JournalReportSalesTax)
REQUIRED

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

salestaxesrefund
array
(JournalReportSalesTax)
REQUIRED

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

moneysalestaxinadvance
Money
REQUIRED

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

moneysummarysales
Money
REQUIRED

The total amount for sales.

moneysummaryrefund
Money
REQUIRED

The total amount for refunds.

moneysummarysubtotal
Money
REQUIRED

The sub total amount (moneysummarysales - moneysummaryrefund).

moneysummarysalestax
Money
REQUIRED

The sub total amount for sales tax.

moneysummaryroundoff
Money
REQUIRED

The total amount for roundoff.

moneysummarytotal
Money
REQUIRED

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

paymentssales
array
(JournalReportPayment)
REQUIRED

All payments for sales. See JournalReportPayment for fields.

paymentsrefund
array
(JournalReportPayment)
REQUIRED

All payments for refunds. See JournalReportPayment for fields.

discountssales
array
(JournalReportDiscount)
REQUIRED

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

discountssalesnotdelivered
array
(JournalReportDiscount)
REQUIRED

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

discountsrefund
array
(JournalReportDiscount)
REQUIRED

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

moneycash_in
Money
REQUIRED

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

moneycash_salesrefunds
Money
REQUIRED

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

moneycash_petty
Money
REQUIRED

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

moneycash_bank
Money
REQUIRED

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

moneycash_expected
Money
REQUIRED

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

moneycash_counted
Money
REQUIRED

The counted amount for cash in the register when closing.

moneycash_diff
Money
REQUIRED

The difference in amount for cash between expected and counted values.

moneycash_bankfinal
Money
REQUIRED

The amount of cash banked after cash had been counted.

moneycash_out
Money
REQUIRED

The amount for cash in the register after it was closed.

moneydiscount
Money
REQUIRED

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

cash_bankfinal_bag_id
string

The money bank bag ID for the counted cash.

numsalestypeproduct
integer
REQUIRED

The total number of items of type "product".

numsalestypeservice
integer
REQUIRED

The total number of items of type "service".

numsalestypegiftcard
integer
REQUIRED

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

numreceipts
integer
REQUIRED

The total number of receipts.

numopendrawer
integer
REQUIRED

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

numpractice
integer
REQUIRED

The total number of transactions made in practice mode.

moneypractice
Money
REQUIRED

The total amount of transactions made in practice mode.

currencyconversions
array
(JournalReportCurrencyConversion)

Contains details about foreign currencies. See JournalReportCurrencyConversion for fields.

moneygrandtotalsales
Money
REQUIRED

The total amount for sales since the start of the cash register.

moneygrandtotalrefund
Money
REQUIRED

The total amount for refunds since the start of the cash register.

moneygrandtotalnet
Money
REQUIRED

The summary total amount 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.

zreportid
integer
REQUIRED

ID for a Z-report (report number)

JournalReportCurrencyConversion
object

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

PROPERTIES
currency_code
string
REQUIRED

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

Pattern: ^[A-Z]{3}$
Example: ""EUR""
money_expected
Money
REQUIRED

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

money_counted
Money
REQUIRED

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

money_expected_base
Money
REQUIRED

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

money_counted_base
Money
REQUIRED

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

bag_id
string

The money bank bag ID for the counted cash in this currency.

JournalReportDiscount
object

Contains the discount details for a journal report.

PROPERTIES
vouchercode
string
REQUIRED

The vouchercode of the discount group.

moneytotal
Money
REQUIRED

The total gross amount for the discount group.

moneytotalnet
Money
REQUIRED

The total net amount for the discount group.

moneytotalvat
Money
REQUIRED

The total vat amount for the discount group.

JournalReportPayment
object

Contains the payment details for a journal report.

PROPERTIES
name
string
REQUIRED

The name of the payment.

moneytotal
Money
REQUIRED

The total amount of the payment.

moneycaptured
Money

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

moneyinadvance
Money

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

moneyreserved
Money

The reserved amount.

subpayments
array
(JournalReportSubPayment)
REQUIRED

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

JournalReportProductGroup
object

Contains the product group details for a journal report.

PROPERTIES
name
string
REQUIRED

The name of the product group.

vatvalue
number
(double)
REQUIRED

The vat value for the product group.

numtotal
integer
REQUIRED

The total number of items for the product group.

moneytotal
Money
REQUIRED

The total gross amount for the product group.

moneytotalnet
Money
REQUIRED

The total net amount for the product group.

moneytotalvat
Money
REQUIRED

The total vat amount for the product group.

JournalReportSalesTax
object

Contains the sales tax details for a journal report.

PROPERTIES
name
string
REQUIRED

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
REQUIRED

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

moneytax
Money
REQUIRED

The total net amount for this sales tax.

decimaltaxvalue
DecimalQuantity
REQUIRED

The tax value in percent.

JournalReportSubPayment
object

Contains the details for a sub payment of JournalReportPayment.

PROPERTIES
name
string
REQUIRED

The name of the sub payment.

moneysubtotal
Money
REQUIRED

The amount of the sub payment.

moneycaptured
Money

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

moneyinadvance
Money

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

moneyreserved
Money

The reserved amount.

JournalReportVatGroup
object

Contains the VAT details for a journal report.

PROPERTIES
vatvalue
number
(double)
REQUIRED

The vat value for the vat group.

moneytotal
Money
REQUIRED

The total gross amount for the vat group.

moneytotalnet
Money
REQUIRED

The total net amount for the vat group.

moneytotalvat
Money
REQUIRED

The total vat amount for the vat group.

JournalStaff
object

An object for identifiying a staff in the journal

PROPERTIES
staff
string
REQUIRED

The name of the staff that generated the entry.

staffuserid
string
REQUIRED

The user ID for the staff that generated the entry.

Money
string

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

PaymentMethod
integer

ID for the payment method used.

  • 100 Cash
  • 110 CreditNote
  • 200 PointAirPay
  • 210 VerifoneLPP
  • 220 Host2T
  • 300 ExtCard
  • 400 Custom5
  • 500 GiftCard
  • 510 GiftCardCreditNote
  • 600 Invoice
  • 610 CashOnDelivery
  • 700 Klarna
  • 705 KlarnaV3
  • 710 Swish
  • 711 SwishQR
  • 720 MobilePay
  • 730 Vipps
  • 1000 Custom1
  • 1100 Custom2
  • 1200 Custom3
  • 1300 Custom4
  • 1400 CustomInvoice
  • 2000 CustomApi
  • 2100 Adyen
  • 2110 AdyenAPI
  • 2200 Nets
  • 2300 Coiney
  • 2400 Zettle

PrintLine
object

A print format used primarily for printing extra lines on parts of a receipt.

PROPERTIES
type
integer
REQUIRED

The type of print formatting for this line.

  • 1 Text: Prints a line of text from value1.
  • 2 TextBold: Prints a line of text from value1 in bold font.
  • 3 TextDouble: Prints a line of text from value1 in bold font with double size, centered.
  • 4 Info2: Prints value1 with a colon before value2.
  • 5 Item2: Prints value1 in the first columna and value2 in the second (right aligned).
  • 7 SepSpace: Prints an empty line.
  • 8 SepDashed: Prints an separator line.
  • 9 Sign: Prints an signature line.
  • 10 Barcode128: Prints a barcode in Code 128 format. value1 is the barcode data and value2 is printed below the barcode.
  • 11 BarcodeQR: Prints a QR code. value1 is the QR data and value2 is printed below the QR code.
  • 12 TextCenter: Prints a line of text from value1 centered.
scope
integer

The scope for printing this line if applicable.

  • 1 Customer
  • 2 Store
value1
string

Value 1 for this line. (Used by Text, TextBold, TextDouble, TextCenter, Info2, Item2, Sign, Barcode128 and BarcodeQR)

value2
string

Value 2 for this line. (Used by Info2, Item2, Barcode128 and BarcodeQR)

SortOrder
string

Sort order.

  • asc Ascending
  • desc Descending

Default: asc

Copyright © 2024 Sitoo AB. All rights reserved.