getSales

Method returns sale list

Usage URL: https://magboss.pl/api/getSales.json?key=YOURAPIKEY

Query params

(put those in your URL, e.g. ?id=123)

id
integer or integer[]
Internal identifier of sale.
More than one value can be specified after comma (,) separator.
{"name":"id","propertyName":"id","type":{"format":null},"description":"Internal identifier of sale.\nMore than one value can be specified after comma (,) separator.","example":null,"required":false,"children":[]}
name
string
Order name of sale.
Example: 'Z23' will return all sales that contain Z23 in the `ordername` field.
{"name":"name","propertyName":"name","type":{"format":null},"description":"Order name of sale.","example":"'Z23' will return all sales that contain Z23<\/strong> in the `ordername` field.","required":false,"children":[]}
invoicename
string
Document (invoice/receipt/correction) name of sale.
Example: '03' will return all sales that contain 03 in the `invoicename` field.
{"name":"invoicename","propertyName":"invoiceName","type":{"format":null},"description":"Document (invoice\/receipt\/correction) name of sale.","example":"'03' will return all sales that contain 03<\/strong> in the `invoicename` field.","required":false,"children":[]}
type
integer or integer[]
Return all sales with type param.
More than one value can be specified after comma (,) separator.
{"name":"type","propertyName":"type","type":{"format":null},"description":"Return all sales with type<\/strong> param.\nMore than one value can be specified after comma (,) separator.","example":null,"required":false,"children":[]}
date
datetime (YYYY-MM-DD HH:MM:SS)
Return all sales created after the date param. That is highly recommended when you want to update your local database.
{"name":"date","propertyName":"date","type":{"format":"YYYY-MM-DD HH:MM:SS"},"description":"Return all sales created after the date<\/strong> param. That is highly recommended<\/strong> when you want to update your local database.","example":null,"required":false,"children":[]}
modified
datetime (YYYY-MM-DD HH:MM:SS)
Return all sales modified after the modified param. That is highly recommended when you want to update your local database.
{"name":"modified","propertyName":"modified","type":{"format":"YYYY-MM-DD HH:MM:SS"},"description":"Return all sales modified after the modified<\/strong> param. That is highly recommended<\/strong> when you want to update your local database.","example":null,"required":false,"children":[]}
productid
integer
Product ID.
Example: '51234' will return all sales which have product with ID 51234 inside.
{"name":"productid","propertyName":"productId","type":{"format":null},"description":"Product ID.","example":"'51234' will return all sales which have product with ID 51234<\/strong> inside.","required":false,"children":[]}
isattachable
boolean (1 = true, 0 = false)
Return only sales that can be attached to another sale or can be attached to (for example more products can be added).
Example: If set to true - only attachable sales will be returned, if set to false - only non-attachable sales will be returned.
{"name":"isattachable","propertyName":"isAttachable","type":{"format":"1 = true, 0 = false"},"description":"Return only sales that can be attached to another sale or can be attached to (for example more products can be added).","example":"If set to true<\/strong> - only attachable sales will be returned, if set to false<\/strong> - only non-attachable sales will be returned.","required":false,"children":[]}
lang
string
Language of result. ISO 2 Letter Language Codes ie
Example: en, pl, cs
{"name":"lang","propertyName":"lang","type":{"format":null},"description":"Language of result. ISO 2 Letter Language Codes ie","example":"en, pl, cs","required":false,"children":[]}

id
integer
Internal identifier of sale.
{"name":"id","propertyName":"id","type":{"format":null},"description":"Internal identifier of sale.","example":null,"required":false,"children":[]}
type
integer
Type of sale:
-1 - Order,
0 - Invoice,
1 - Invoice correction,
2 - Receipt,
3 - Receipt correction,
5 - Advance invoice,
10 - Utilization,
100 - Invoice non-rating
{"name":"type","propertyName":"type","type":{"format":null},"description":"Type of sale:\r\n-1 - Order,\r\n0 - Invoice,\r\n1 - Invoice correction,\r\n2 - Receipt,\r\n3 - Receipt correction,\r\n5 - Advance invoice,\r\n10 - Utilization,\r\n100 - Invoice non-rating","example":null,"required":false,"children":[]}
created
datetime (YYYY-MM-DD HH:MM:SS)
When created
{"name":"created","propertyName":"created","type":{"format":"YYYY-MM-DD HH:MM:SS"},"description":"When created","example":null,"required":false,"children":[]}
modified
datetime (YYYY-MM-DD HH:MM:SS)
When last modified
{"name":"modified","propertyName":"modified","type":{"format":"YYYY-MM-DD HH:MM:SS"},"description":"When last modified","example":null,"required":false,"children":[]}
ordername
string
Name of order
{"name":"ordername","propertyName":"ordername","type":{"format":null},"description":"Name of order","example":null,"required":false,"children":[]}
invoicename
string
Name of assigned financial document
{"name":"invoicename","propertyName":"invoiceName","type":{"format":null},"description":"Name of assigned financial document","example":null,"required":false,"children":[]}
statusname
string
Current sale status
{"name":"statusname","propertyName":"statusName","type":{"format":null},"description":"Current sale status","example":null,"required":false,"children":[]}
fkcurrency
integer
Internal ID of currency
{"name":"fkcurrency","propertyName":"fkCurrency","type":{"format":null},"description":"Internal ID of currency","example":null,"required":false,"children":[]}
symbol
string
Sale's currency symbol
Example: Three letters format ie: PLN, EUR, USD.
{"name":"symbol","propertyName":"symbol","type":{"format":null},"description":"Sale's currency symbol","example":"Three letters format ie: PLN, EUR, USD.","required":false,"children":[]}
paid
float
Value paid
{"name":"paid","propertyName":"paid","type":{"format":null},"description":"Value paid","example":null,"required":false,"children":[]}
total
float
Total net price of sale
{"name":"total","propertyName":"total","type":{"format":null},"description":"Total net price of sale","example":null,"required":false,"children":[]}
totalgross
float
Total gross price of sale
{"name":"totalgross","propertyName":"totalGross","type":{"format":null},"description":"Total gross price of sale","example":null,"required":false,"children":[]}
isassembling
boolean (1 = true, 0 = false)
Points whether sale is marked as still assembling
{"name":"isassembling","propertyName":"isAssembling","type":{"format":"1 = true, 0 = false"},"description":"Points whether sale is marked as still assembling","example":null,"required":false,"children":[]}
assemblyend
datetime (YYYY-MM-DD HH:MM:SS)
Date when assembling has been finished
{"name":"assemblyend","propertyName":"assemblyEnd","type":{"format":"YYYY-MM-DD HH:MM:SS"},"description":"Date when assembling has been finished","example":null,"required":false,"children":[]}
paymentdeadline
datetime (YYYY-MM-DD HH:MM:SS)
Payment deadline
{"name":"paymentdeadline","propertyName":"paymentDeadline","type":{"format":"YYYY-MM-DD HH:MM:SS"},"description":"Payment deadline","example":null,"required":false,"children":[]}
paymenttag
string
Internal tag of payment type
{"name":"paymenttag","propertyName":"paymentTag","type":{"format":null},"description":"Internal tag of payment type","example":null,"required":false,"children":[]}
paymenttypeid
integer
Payment type internal identifier
{"name":"paymenttypeid","propertyName":"paymentTypeId","type":{"format":null},"description":"Payment type internal identifier","example":null,"required":false,"children":[]}
paymenttypename
string
Payment type name
{"name":"paymenttypename","propertyName":"paymentTypeName","type":{"format":null},"description":"Payment type name","example":null,"required":false,"children":[]}
isshipped
boolean (1 = true, 0 = false)
Points whether sale is shipped
{"name":"isshipped","propertyName":"isShipped","type":{"format":"1 = true, 0 = false"},"description":"Points whether sale is shipped","example":null,"required":false,"children":[]}
isattachable
boolean (1 = true, 0 = false)
Points whether sale can be attached to another sale or can be attached to (for example more products can be added)
{"name":"isattachable","propertyName":"isAttachable","type":{"format":"1 = true, 0 = false"},"description":"Points whether sale can be attached to another sale or can be attached to (for example more products can be added)","example":null,"required":false,"children":[]}
mergedids
string
Lists of sales IDs that were merged into this one, comma separated string
{"name":"mergedids","propertyName":"mergedIds","type":{"format":null},"description":"Lists of sales IDs that were merged into this one, comma separated string","example":null,"required":false,"children":[]}

Example URL: https://magboss.pl/api/getSales.json?key=YOURAPIKEY&lang=en&modified=2017-02-23

[
    {
        "id": 205430,
        "type": -1,
        "created": "2018-09-28 13:47:28",
        "modified": "2018-09-28 13:47:36",
        "invoicename": "--",
        "ordername": "Z18\/33482",
        "fkcurrency": 1,
        "statusname": "Pending",
        "symbol": "PLN",
        "paid": 0,
        "total": 273.21,
        "totalgross": 336.05,
        "isassembling": 0,
        "assemblyend": null,
        "paymentdeadline": "2018-10-08 13:47:28",
        "paymenttag": "paypal",
        "ispaid": 0,
        "ispacked": 0,
        "isshipped": 0,
        "mergedids": null
    },
    {
        "id": 205431,
        "type": 2,
        "created": "2018-09-28 00:00:00",
        "modified": "2018-09-28 14:24:10",
        "invoicename": "ssss",
        "ordername": "Z18\/33483",
        "fkcurrency": 1,
        "statusname": "Pending",
        "symbol": "PLN",
        "paid": 0,
        "total": 10854.91,
        "totalgross": 13351.54,
        "isassembling": 0,
        "assemblyend": null,
        "paymentdeadline": "2018-10-08 00:00:00",
        "paymenttag": "paypal",
        "ispaid": 0,
        "ispacked": 0,
        "isshipped": 0,
        "mergedids": null
    },
    {
        "id": 205432,
        "type": -1,
        "created": "2018-09-28 13:47:34",
        "modified": "2018-09-28 13:47:36",
        "invoicename": "--",
        "ordername": "Z18\/33484",
        "fkcurrency": 1,
        "statusname": "Pending",
        "symbol": "PLN",
        "paid": 0,
        "total": 54.12,
        "totalgross": 66.57,
        "isassembling": 0,
        "assemblyend": null,
        "paymentdeadline": "2018-10-08 13:47:34",
        "paymenttag": "paypal",
        "ispaid": 0,
        "ispacked": 0,
        "isshipped": 0,
        "mergedids": null
    }
]

Example URL: https://magboss.pl/api/getSales.xml?key=YOURAPIKEY&lang=en&modified=2017-02-23

<?xml version="1.0" encoding="utf-8"?>
<root>
	<item>
		<id>205430</id>
		<type>-1</type>
		<created>2018-09-28 13:47:28</created>
		<modified>2018-09-28 13:47:36</modified>
		<invoicename>--</invoicename>
		<ordername>Z18/33482</ordername>
		<fkcurrency>1</fkcurrency>
		<statusname>Pending</statusname>
		<symbol>PLN</symbol>
		<paid>0</paid>
		<total>273.21</total>
		<totalgross>336.05</totalgross>
		<isassembling>0</isassembling>
		<assemblyend></assemblyend>
		<paymentdeadline>2018-10-08 13:47:28</paymentdeadline>
		<paymenttag>paypal</paymenttag>
		<ispaid>0</ispaid>
		<ispacked>0</ispacked>
		<isshipped>0</isshipped>
		<mergedids></mergedids>
	</item>
	<item>
		<id>205431</id>
		<type>2</type>
		<created>2018-09-28 00:00:00</created>
		<modified>2018-09-28 14:24:10</modified>
		<invoicename>ssss</invoicename>
		<ordername>Z18/33483</ordername>
		<fkcurrency>1</fkcurrency>
		<statusname>Pending</statusname>
		<symbol>PLN</symbol>
		<paid>0</paid>
		<total>10854.91</total>
		<totalgross>13351.54</totalgross>
		<isassembling>0</isassembling>
		<assemblyend></assemblyend>
		<paymentdeadline>2018-10-08 00:00:00</paymentdeadline>
		<paymenttag>paypal</paymenttag>
		<ispaid>0</ispaid>
		<ispacked>0</ispacked>
		<isshipped>0</isshipped>
		<mergedids></mergedids>
	</item>
	<item>
		<id>205432</id>
		<type>-1</type>
		<created>2018-09-28 13:47:34</created>
		<modified>2018-09-28 13:47:36</modified>
		<invoicename>--</invoicename>
		<ordername>Z18/33484</ordername>
		<fkcurrency>1</fkcurrency>
		<statusname>Pending</statusname>
		<symbol>PLN</symbol>
		<paid>0</paid>
		<total>54.12</total>
		<totalgross>66.57</totalgross>
		<isassembling>0</isassembling>
		<assemblyend></assemblyend>
		<paymentdeadline>2018-10-08 13:47:34</paymentdeadline>
		<paymenttag>paypal</paymenttag>
		<ispaid>0</ispaid>
		<ispacked>0</ispacked>
		<isshipped>0</isshipped>
		<mergedids></mergedids>
	</item>
</root>