getSaleDocuments

Method returns links to sale documents.
Only 250 results can be fetched via request. Please use request filters to fetch other results.

Usage URL: https://magboss.pl/api/getSaleDocuments.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":[]}
date
datetime (YYYY-MM-DD HH:MM:SS)
Return all documents created after the modified date. 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 documents created after the modified<\/strong> date. That is highly recommended<\/strong> when you want to update your local database.","example":null,"required":false,"children":[]}
type
integer or integer[]
Return all documents assigned to sale with type param.
Check getSales for more information about sale types.
More than one value can be specified after comma (,) separator.
{"name":"type","propertyName":"type","type":{"format":null},"description":"Return all documents assigned to sale with type<\/strong> param. Check <a href='https:\/\/magboss.pl\/apidocs\/show\/getSales' target='_blank'>getSales<\/a> for more information about sale types.\nMore than one value can be specified after comma (,) separator.","example":null,"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 document.
{"name":"id","propertyName":"id","type":{"format":null},"description":"Internal identifier of document.","example":null,"required":false,"children":[]}
name
string
Document file name
{"name":"name","propertyName":"name","type":{"format":null},"description":"Document file name","example":null,"required":false,"children":[]}
langiso2
string
Document language iso
{"name":"langiso2","propertyName":"langIso2","type":{"format":null},"description":"Document language iso","example":null,"required":false,"children":[]}
ext
string
File extension
{"name":"ext","propertyName":"ext","type":{"format":null},"description":"File extension","example":null,"required":false,"children":[]}
size
integer
File size in bytes
{"name":"size","propertyName":"size","type":{"format":null},"description":"File size in bytes","example":null,"required":false,"children":[]}
mime
string
File mime type
{"name":"mime","propertyName":"mime","type":{"format":null},"description":"File mime type","example":null,"required":false,"children":[]}
saleid
integer
Internal identifier of sale
{"name":"saleid","propertyName":"saleId","type":{"format":null},"description":"Internal identifier of sale","example":null,"required":false,"children":[]}
saledate
datetime (YYYY-MM-DD HH:MM:SS)
When sale was created
{"name":"saledate","propertyName":"saleDate","type":{"format":"YYYY-MM-DD HH:MM:SS"},"description":"When sale was created","example":null,"required":false,"children":[]}
saletype
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,
101 - Temporary invoice
{"name":"saletype","propertyName":"saleType","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,\r\n101 - Temporary invoice","example":null,"required":false,"children":[]}
payload
string
File bytes

Example how to save such file (PHP):
```
$json = file_get_contents("USAGE_URL_HERE");

$obj = json_decode($json);

file_put_contents("{$obj[0]->name}.{$obj[0]->ext}", utf8_decode($obj[0]->payload));
```
{"name":"payload","propertyName":"payload","type":{"format":null},"description":"File bytes \r\nExample how to save such file (PHP):\r\n<pre>$json = file_get_contents(\"USAGE_URL_HERE\");\r\n$obj = json_decode($json);\r\nfile_put_contents(\"{$obj[0]->name}.{$obj[0]->ext}\", utf8_decode($obj[0]->payload));<\/pre>","example":null,"required":false,"children":[]}

Example URL: https://magboss.pl/api/getSaleDocuments.json?key=YOURAPIKEY&lang=en&id=112087

Example URL: https://magboss.pl/api/getSaleDocuments.xml?key=YOURAPIKEY&lang=en&id=112087