Skip to content

Sales summaries

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

Operations

Download sales summaries as JSON

Request

GET https://api.zoined.com/v2/download/salesSummaries.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/salesSummaries.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
sales_datestringrequired

Sales date (yyyy-mm-dd)

Example:"2016-01-01"
sales_timestring

Sales time (HH:mm:ss)

Example:"15:00:00"
organisation_idstringrequired

Organisation/Store ID

Example:"540"
department_idstring

Store department ID

Example:"5401"
salesperson_idstring

Sales person ID

Example:"15:00:00"
customer_idstring

Customer ID

Example:"1234"
supplier_idstring

Supplier ID

Example:"12"
campaign_idstring

Campaign ID

Example:"123"
rebate_code_idstring

Rebate Code ID

Example:"3313V"
sales_valuenumber

Total sales amount including tax

Example:2000
sales_value_wo_vatnumber

Total sales amount without tax

Example:1600
sales_currencystring

Sales currency as ISO 4217 currency code. Required if multiple currencies are used.

Example:"EUR"
rebatenumber

Amount of rebate given including tax

Example:0
rebate_wo_vatnumber

Amount of rebate given without tax

Example:0
purchase_pricenumber

Total purchase price including tax

Example:500
purchase_price_wo_vatnumber

Total purchase price without tax

Example:400
product_quantitynumber

Sold quantity

Example:4
number_of_transactionsnumber

Number of receipts

Example:2
custom_field_1string

User defined custom field 1

Example:"extra info"
custom_field_2string

User defined custom field 2

Example:"extra info"
custom_field_3string

User defined custom field 3

Example:"extra info"
custom_field_4string

User defined custom field 4

Example:"extra info"
custom_field_5string

User defined custom field 5

Example:"extra info"
custom_field_6string

User defined custom field 6

Example:"extra info"
custom_field_7string

User defined custom field 7

Example:"extra info"
custom_field_8string

User defined custom field 8

Example:"extra info"
custom_field_9string

User defined custom field 9

Example:"extra info"
custom_field_10string

User defined custom field 10

Example:"extra info"
custom_metric_1number

Custom metric 1

Example:1
custom_metric_2number

Custom metric 2

Example:100
custom_metric_3number

Custom metric 3

Example:2.2
custom_metric_4number

Custom metric 4

Example:1.05
custom_metric_5number

Custom metric 5

Example:10000
Response
{
  "sales_date": "2016-01-01",
  "sales_time": "15:00:00",
  "organisation_id": "540",
  "department_id": "5401",
  "salesperson_id": "15:00:00",
  "customer_id": "1234",
  "supplier_id": "12",
  "campaign_id": "123",
  "rebate_code_id": "3313V",
  "sales_value": 2000,
  "sales_value_wo_vat": 1600,
  "sales_currency": "EUR",
  "rebate": 0,
  "rebate_wo_vat": 0,
  "purchase_price": 500,
  "purchase_price_wo_vat": 400,
  "product_quantity": 4,
  "number_of_transactions": 2,
  "custom_field_1": "extra info",
  "custom_field_2": "extra info",
  "custom_field_3": "extra info",
  "custom_field_4": "extra info",
  "custom_field_5": "extra info",
  "custom_field_6": "extra info",
  "custom_field_7": "extra info",
  "custom_field_8": "extra info",
  "custom_field_9": "extra info",
  "custom_field_10": "extra info",
  "custom_metric_1": 1,
  "custom_metric_2": 100,
  "custom_metric_3": 2.2,
  "custom_metric_4": 1.05,
  "custom_metric_5": 10000
}