Skip to content
Cashier balance/
Upload list of cashier ba...

Upload list of cashier balances

Request

POST https://api.zoined.com/cashierBalance?dryRun=false&separator=%3B&encoding=utf-8

Security
bearerAuth
Query
dryRunbooleanrequired

Only validate the request without storing the data

Example:dryRun=true
separatorstringrequired

Column separator used when loading CSV data

Example:separator=;
encodingstringrequired

Character encoding used in the CSV data (default is utf-8)

Example:encoding=utf-8
Body
Any of:
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"
source_systemstring

Identifier of the source system this data is from. Needed when mapping between source system identifiers and master identifiers are used.

Example:"ABCDEF"
curl -i -X POST \
  'https://zapi-api.zoined.com/_mock/cashierBalance?dryRun=true&separator=%3B&encoding=utf-8' \
  -H 'Authorization: Bearer <YOUR_token_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "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",
    "source_system": "ABCDEF"
  }'

Responses

Request has been processed successfully.

Headers

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

Status of the operation OK / Not OK

Example:"OK"
msgstringrequired

Message describing result of operation

Example:"1 entity added"
Response
{
  "status": "OK",
  "msg": "1 entity added"
}