Skip to content

Sales payments

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

Operations

Download sales payments as JSON

Request

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

Transaction line identifier

Example:"1"
customer_idstring

Customer ID for identified customer

Example:"32"
delivery_customer_idstring

Delivery customer ID for identified customer

Example:"35"
organisation_idstring

Organisation unit ID

Example:"540"
department_idstring

Department unit ID

Example:"5400"
salesperson_idstring

Sales person ID

Example:"5402101"
register_idstring

Cash register ID

Example:"54022"
table_numberstring

Table number

Example:"54"
payment_methodstring

Payment method ID

Example:"Visa"
giftcard_payment_idstring

Id to link to possible giftcard used for this payment.

Example:"12345"
sales_datestringrequired

Sales date (yyyy-mm-dd)

Example:"2016-01-01"
sales_timestringrequired

Sales time (HH:mm:ss)

Example:"15:00:00"
product_quantitynumber

Sold quantity

Example:4
sales_valuenumberrequired

Total sales amount including tax

Example:20
sales_value_wo_vatnumber

Total sales amount without tax

Example:20
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
currencystring

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

Example:"EUR"
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
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",
  "organisation_id": "540",
  "department_id": "5400",
  "salesperson_id": "5402101",
  "register_id": "54022",
  "table_number": "54",
  "payment_method": "Visa",
  "giftcard_payment_id": "12345",
  "sales_date": "2016-01-01",
  "sales_time": "15:00:00",
  "product_quantity": 4,
  "sales_value": 20,
  "sales_value_wo_vat": 20,
  "rebate": 0,
  "rebate_wo_vat": 0,
  "purchase_price": 500,
  "purchase_price_wo_vat": 400,
  "currency": "EUR",
  "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,
  "custom_metric_6": 1,
  "custom_metric_7": 100,
  "custom_metric_8": 2.2,
  "custom_metric_9": 1.05,
  "custom_metric_10": 10000
}