Sales transactions

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

Operations

Download sales transactions as JSON

Request

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

transaction_idstringrequired

Unique ID for the transaction

Example:"242224"

line_item_idstringrequired

Secondary transaction identifier

Example:"1"

customer_idstring

Customer ID for identified customer

Example:"32"

delivery_customer_idstring

Delivery customer ID for identified customer

Example:"35"

sales_datestringrequired

Sales date (yyyy-mm-dd)

Example:"2016-01-01"

sales_timestringrequired

Sales time (HH:mm:ss)

Example:"15:00:00"

product_idstringrequired

Product ID

Example:"XYZ"

product_quantitynumberrequired

Sold quantity

Example:2

product_unit_pricenumberrequired

Unit price for single product

Example:10

sales_valuenumberrequired

Total sales amount including tax

Example:20

sales_value_wo_vatnumber

Total sales amount without tax

Example:20

compensation_amountnumber

Optional compensation paid for this sale

Example:3

rebatenumber

Amount of rebate given including tax

Example:0

rebate_wo_vatnumber

Amount of rebate given without tax

Example:0

currencystring

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

Example:"EUR"

payment_methodstring

Payment method

Example:"Visa"

supplier_idstring

Supplier ID

Example:"13"

parent_product_idstring

Parent Product ID

Example:"123"

purchase_pricenumber

Total purchase price including tax

Example:5

purchase_price_wo_vatnumber

Total purchase price without tax

Example:5

organisation_idstring

Organisation unit ID

Example:"540"

deparment_idstring

Department unit ID

Example:"5400"

salesperson_idstring

Sales person / cashier ID

Example:"5402101"

sales_representative_idstring

Responsible sales person ID

Example:"5402100"

campaign_idstring

Campaign ID

Example:"6344"

delivery_datestring

Delivery date (yyyy-mm-dd)

Example:"2016-01-01"

delivery_timestring

Delivery time (HH:mm:ss)

Example:"15:00:00"

invoice_datestring

Invoice date (yyyy-mm-dd)

Example:"2016-01-01"

invoice_timestring

Invoice time (HH:mm:ss)

Example:"15:00:00"

register_idstring

Cash register ID

Example:"54022"

table_numberstring

Table number

Example:"54"

rebate_code_idstring

Rebate Code ID

Example:"3313V"

booking_idstring

12 (string, optional) - Optional reference to booking that generated this sale.

Example:"B1224"

booking_line_idstring

Optional booking line that corresponds to this sale.

Example:"1"

event_idstring

Event ID

Example:"221"

sales_order_idstring

56 (string, optional) - Optional sales order that generated this sale.

Example:"SO1234"

sales_order_line_idstring

Optional sales order line that corresponds to this sale.

Example:"1"

parent_line_idstring

Line item id for parent line item in this sales transaction that this line is child to.

Example:"1"

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_field_11string

User defined custom field 11

Example:"extra info"

custom_field_12string

User defined custom field 12

Example:"extra info"

custom_field_13string

User defined custom field 13

Example:"extra info"

custom_field_14string

User defined custom field 14

Example:"extra info"

custom_field_15string

User defined custom field 15

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

custom_metric_6number

Custom metric 6

Example:1

custom_metric_7number

Custom metric 7

Example:100

custom_metric_8number

Custom metric 8

Example:2.2

custom_metric_9number

Custom metric 9

Example:1.05

custom_metric_10number

Custom metric 10

Example:10000

Response

{
  "transaction_id": "242224",
  "line_item_id": "1",
  "customer_id": "32",
  "delivery_customer_id": "35",
  "sales_date": "2016-01-01",
  "sales_time": "15:00:00",
  "product_id": "XYZ",
  "product_quantity": 2,
  "product_unit_price": 10,
  "sales_value": 20,
  "sales_value_wo_vat": 20,
  "compensation_amount": 3,
  "rebate": 0,
  "rebate_wo_vat": 0,
  "currency": "EUR",
  "payment_method": "Visa",
  "supplier_id": "13",
  "parent_product_id": "123",
  "purchase_price": 5,
  "purchase_price_wo_vat": 5,
  "organisation_id": "540",
  "deparment_id": "5400",
  "salesperson_id": "5402101",
  "sales_representative_id": "5402100",
  "campaign_id": "6344",
  "delivery_date": "2016-01-01",
  "delivery_time": "15:00:00",
  "invoice_date": "2016-01-01",
  "invoice_time": "15:00:00",
  "register_id": "54022",
  "table_number": "54",
  "rebate_code_id": "3313V",
  "booking_id": "B1224",
  "booking_line_id": "1",
  "event_id": "221",
  "sales_order_id": "SO1234",
  "sales_order_line_id": "1",
  "parent_line_id": "1",
  "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_field_11": "extra info",
  "custom_field_12": "extra info",
  "custom_field_13": "extra info",
  "custom_field_14": "extra info",
  "custom_field_15": "extra info",
  "custom_metric_1": 1,
  "custom_metric_2": 100,
  "custom_metric_3": 2.2,
  "custom_metric_4": 1.05,
  "custom_metric_5": 10000,
  "custom_metric_6": 1,
  "custom_metric_7": 100,
  "custom_metric_8": 2.2,
  "custom_metric_9": 1.05,
  "custom_metric_10": 10000
}