Skip to content

Cashier balance

Returns list of cashier balances in the system. Returned data can be limited with start and end query parameters.

Operations

Download cashier balances as JSON

Request

GET https://api.zoined.com/v2/download/cashierBalance.json?limit=1000&offset=0&start=2017-01-01&end=2017-01-31

Security
bearerAuth
Query
limitnumber

How many entries to return

Example:limit=1000
offsetnumber

Which offset to return data from

Example:offset=0
startstring

Return data starting from given date

Example:start=2017-01-01
endstring

Return data ending to given date

Example:end=2017-01-31
curl -i -X GET \
  'https://zapi-api.zoined.com/_mock/v2/download/cashierBalance.json?limit=1000&offset=0&start=2017-01-01&end=2017-01-31' \
  -H 'Authorization: Bearer <YOUR_token_HERE>'

Responses

Request has been processed successfully.

Headers

  • Content-Type: application/json
Bodyapplication/json
organisation_idstringrequired

Identifier of store for this balance

Example:"ORG1"
department_idstring

Optional identifier of department for this balance

Example:"DEP1"
register_idstring

Optional cash register identifier for this balance

Example:"123"
batch_idstring

Optional batch or shift identifier for this balance row

Example:"1"
payment_methodstringrequired

Payment method of this balance row

Example:"Cash"
sales_datestringrequired

Date of balance (yyyy-mm-dd)

Example:"2018-01-01"
sales_timestring

Optional time of balance (hh:mm:ss)

Example:"15:00:00"
batch_statusstring

Optional status of this batch ID

Example:"OK"
transaction_countnumberrequired

Number of transactions for this shift and payment method

Example:9
shift_amountnumberrequired

Total amount of payments for this shift and payment method

Example:1000
over_shortnumber

Difference in money between sales and shift amounts

Example:100
cash_droppednumber

How much cash was dropped from register during this shift

Example:0
cash_paid_outnumber

How much cash was paid out from register during this shift

Example:50
currencystring

Shift currency as ISO 4217 currency code. Required if multiple currencies are used by the customer.

Example:"EUR"
Response
{
  "organisation_id": "ORG1",
  "department_id": "DEP1",
  "register_id": "123",
  "batch_id": "1",
  "payment_method": "Cash",
  "sales_date": "2018-01-01",
  "sales_time": "15:00:00",
  "batch_status": "OK",
  "transaction_count": 9,
  "shift_amount": 1000,
  "over_short": 100,
  "cash_dropped": 0,
  "cash_paid_out": 50,
  "currency": "EUR"
}