Skip to content

Sales offers

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

Operations

Download sales offers as JSON

Request

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

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
offer_statusnumber

Return data with given offer status only

Example:offer_status=3
curl -i -X GET \
  'https://zapi-api.zoined.com/_mock/v2/download/salesOffers.json?limit=1000&offset=0&start=2017-01-01&end=2017-01-31&offer_status=3' \
  -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:"er/232/f31"
line_item_idstringrequired

Secondary transaction identifier

Example:"1"
customer_idstring

Customer ID for identified customer

Example:"32"
product_idstringrequired

Product ID

Example:"XYZ"
supplier_idstring

Supplier ID

Example:"221"
parent_product_idstring

Parent Product ID

Example:"123"
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
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:5
purchase_price_wo_vatnumber

Total purchase price without tax

Example:5
currencystring

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

Example:"EUR"
organisation_idstring

Organisation unit ID

Example:"540"
salesperson_idstring

Sales person ID

Example:"5402101"
offer_datestring

Order date (yyyy-mm-dd)

Example:"2016-01-01"
offer_timestring

Order time (HH:mm:ss)

Example:"15:00:00"
valid_datestring

Invoice date (yyyy-mm-dd)

Example:"2016-01-01"
valid_timestring

Invoice time (HH:mm:ss)

Example:"15:00:00"
offer_statusnumber

Offer status. 1=Open, 2=Reserved, 3=Invoiced, 4=Cancelled

Example:1
offer_typestring

Offer type

Example:"internal"
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
{
  "transaction_id": "er/232/f31",
  "line_item_id": "1",
  "customer_id": "32",
  "product_id": "XYZ",
  "supplier_id": "221",
  "parent_product_id": "123",
  "product_quantity": 2,
  "product_unit_price": 10,
  "sales_value": 20,
  "sales_value_wo_vat": 20,
  "rebate": 0,
  "rebate_wo_vat": 0,
  "purchase_price": 5,
  "purchase_price_wo_vat": 5,
  "currency": "EUR",
  "organisation_id": "540",
  "salesperson_id": "5402101",
  "offer_date": "2016-01-01",
  "offer_time": "15:00:00",
  "valid_date": "2016-01-01",
  "valid_time": "15:00:00",
  "offer_status": 1,
  "offer_type": "internal",
  "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
}