Delivery Note
Endpoints here allow you to upload delivery notes and filter information about those that were successfully imported.
id
long
Delivery note ID
📶 EQUALS
,ENUM
currency
string(3)
Currency from xml element DEASDV.DOCUMENT.CURRENCYcreated
timestamp?
Created date and time from xml element DEASDV.DOCUMENT.CREATED
📶 EQUALS
,ENUM
,NUMBER
🔽 BOTH
deleted
boolean
Delivery note deleted
📶 EQUALS
,ENUM
🔽 BOTH
documentId
string(180)
Document ID from xml attribute DEASDV.DOCUMENT.id
📶 EQUALS
,ENUM
,STRING
documentNumber
string(18)
Document number from xml element DEASDV.DOCUMENT.DOCUMENT_NUMBERexpeditionDate
timestamp?
Expedition date and time from xml element DEASDV.DOCUMENT.EXPEDITION_DATE
📶 EQUALS
,ENUM
,NUMBER
🔽 BOTH
status
integer
Status
📶 EQUALS
,ENUM
supplierName
string(180)
Supplier name from xml element DEASDV.DOCUMENT.SUPPLIER.NAMEtext
string
Text from xml element DEASDV.DOCUMENT.TEXTurl
string(256)
Public URL that can be used to download the XML document. The file downloaded represents only the DOCUMENT section from the imported file so it cannot be re-uploaded as-is (uploaded files must have the DEASDV root element).versionDate
timestamp?
Last modification date and time
📶 EQUALS
,ENUM
,NUMBER
🔽 BOTH
// representation like string
DELIVERY_NOTE,
RETURN // i.e. remittance
[
{
"_branchId": <integer>,
"_cloudId": <integer>,
"created": <timestamp>,
"currency": <string>,
"deleted": <boolean>,
"documentId": <string>,
"documentNumber": <string>,
"expeditionDate": <timestamp>,
"id": <string>,
"status": <integer>,
"supplierName": <string>,
"text": <string>,
"type": <enum>,
"url": <string>,
"versionDate": <timestamp>
},
{
...
}
...
]
Below is a simplified structure only. For the complete definition of the document structure please see the attached XSD below.
<DEASDV>
<DOCUMENT id="Document UUID" >
<CREATED><!-- RFC 3339 --></CREATED>
<EXPEDITION_DATE><!-- RFC 3339 --></EXPEDITION_DATE>
<TEXT><!-- custom string --></TEXT>
<CURRENCY><!-- ISO 4217 CODE --></CURRENCY>
<DOCUMENT_NUMBER><!-- custom string --></DOCUMENT_NUMBER>
<SUPPLIER id="Supplier UUID">
...
</SUPPLIER>
<ITEM>
<SKU><!-- internal SKU to match product with --></SKU>
<PRODUCT_NAME lang="cs"><!-- product name --></PRODUCT_NAME>
<DESCRIPTION><!-- long product description --></DESCRIPTION>
<AMOUNT><!-- number --></AMOUNT>
<UNIT><!-- see below --></UNIT>
<PRICE_WITHOUT_VAT><!-- number --></PRICE_WITHOUT_VAT>
<PRICE_WITH_VAT><!-- number --></PRICE_WITH_VAT>
<VAT_RATE><!-- percent rate such as 15.0 --></VAT_RATE>
<SALE_INFO>
...
</SALE_INFO>
<BARCODES>
...
</BARCODES>
<IMGURL>
...
</IMGURL>
</ITEM>
<ITEM>
...
</ITEM>
...
</DOCUMENT>
<DOCUMENT>
... <!-- the next document -->
</DOCUMENT>
</DEASDV>
- Piece, Points
- Milligram, Gram, Decagram, Kilogram, Pound, Ounce, Quintal, Tone
- Millimeter, Centimeter, Meter, Kilometer, Inch, Mile
- SquareMeter, SquareFoot
- Milliliter, Centiliter, Deciliter, Liter, UsGallon, UkGallon, CubicFoot, Hectoliter, CubicMeter
- Second, Minute, Hour, Day, Week, Month, Year
The complete description of the XML file structure can be found in the attached file below:
DeliveryNote.xsd
9KB
Binary
Delivery Note XSD
post
https://api.dotykacka.cz
/v2/clouds/:cloudId/branches/:branchId/delivery-note-uploads
Upload delivery note

Postman
You can download a sample XML and modify it for your needs. The attached sample file contains two documents of types DELIVERY_NOTE and RETURN respectively.
SampleDeliveryNote-utf-8.xml
4KB
Text
SampleDeliveryNote-utf-8.xml
In case the XML file is not accepted, please make sure it is valid according to the XSD. You can use one of the free online validation tools like https://www.freeformatter.com/xml-validator-xsd.html
- Maximum size of the XML file is set to 60MB.
- The uploaded XML file must have s single
DEASDV
root element - Document
id
attribute must be a valid UUID in the form "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" - Document
TYPE
must be "DELIVERY_NOTE" (default when null) or "RETURN" (remittance) - Document
CURRENCY
must be in the ISO 4217 format - Item
UNIT
must be a valid unit name - see the Supported units (UNIT)
- Item
PRICE_WITHOUT_VAT
must not be null - Item
PRICE_WITH_VAT
must not be null - Item
VAT_RATE
must not be null
- Item
AMOUNT
cannot be positive - Item
PRICE_WITHOUT_VAT
must be null - Item
PRICE_WITH_VAT
must be null - Item
VAT_RATE
must be null
get
https://api.dotykacka.cz
/v2/clouds/:cloudId/delivery-notes
Get delivery notes
get
https://api.dotykacka.cz
/v2/clouds/:cloudId/delivery-notes/:deliveryNoteId
Get delivery note
options
https://api.dotykacka.cz
/v2/clouds/:cloudId/delivery-notes
Options delivery notes
options
https://api.dotykacka.cz
/v2/clouds/:cloudId/delivery-notes/:deliveryNoteId
Options delivery note
Last modified 1yr ago