Delivery Note

Search…

Delivery Note

Endpoints here allow you to upload delivery notes and filter information about those that were successfully imported.

Delivery Note schema
id long
Delivery note ID
📶 EQUALS,ENUM 
_branchId integer
Branch ID
📶 EQUALS,ENUM 
_cloudId integer
Cloud ID​
currency string(3)
Currency from xml element DEASDV.DOCUMENT.CURRENCY
created 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_NUMBER
expeditionDate 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.NAME
text string
Text from xml element DEASDV.DOCUMENT.TEXT
type enum
Type from xml element DEASDV.DOCUMENT.TYPE
url 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
DeliveryNote type
1
// representation like string
2
DELIVERY_NOTE,
3
RETURN // i.e. remittance
Copied!
DeliveryNote response
1
[
2
    {
3
        "_branchId": <integer>,
4
        "_cloudId": <integer>,
5
        "created": <timestamp>,
6
        "currency": <string>,
7
        "deleted": <boolean>,
8
        "documentId": <string>,
9
        "documentNumber": <string>,
10
        "expeditionDate": <timestamp>,
11
        "id": <string>,
12
        "status": <integer>,
13
        "supplierName": <string>,
14
        "text": <string>,
15
        "type": <enum>,
16
        "url": <string>,
17
        "versionDate": <timestamp>
18
    },
19
    {
20
        ...
21
    }
22
    ...
23
]
Copied!
Delivery note XML file structure
Below is a simplified structure only. For the complete definition of the document structure please see the attached XSD below.
1
<DEASDV>
2
    <DOCUMENT id="Document UUID" >
3
        <CREATED><!-- RFC 3339 --></CREATED>
4
        <EXPEDITION_DATE><!-- RFC 3339 --></EXPEDITION_DATE>
5
        <TEXT><!-- custom string --></TEXT>
6
        <CURRENCY><!-- ISO 4217 CODE --></CURRENCY>
7
        <DOCUMENT_NUMBER><!-- custom string --></DOCUMENT_NUMBER>
8
​
9
        <SUPPLIER id="Supplier UUID">
10
            ...
11
        </SUPPLIER>
12
        
13
        <ITEM>
14
            <SKU><!-- internal SKU to match product with --></SKU>
15
            <PRODUCT_NAME lang="cs"><!-- product name --></PRODUCT_NAME>
16
            <DESCRIPTION><!-- long product description --></DESCRIPTION>
17
            <AMOUNT><!-- number --></AMOUNT>
18
            <UNIT><!-- see below --></UNIT>
19
            <PRICE_WITHOUT_VAT><!-- number --></PRICE_WITHOUT_VAT>
20
            <PRICE_WITH_VAT><!-- number --></PRICE_WITH_VAT>
21
            <VAT_RATE><!-- percent rate such as 15.0 --></VAT_RATE>
22
            <SALE_INFO>
23
                ...
24
            </SALE_INFO>
25
            <BARCODES>
26
                ...
27
            </BARCODES>
28
            <IMGURL>
29
                ...
30
            </IMGURL>
31
        </ITEM>
32
        <ITEM>
33
            ...
34
        </ITEM>
35
        ...
36
    </DOCUMENT>
37
    <DOCUMENT>
38
        ... <!-- the next document -->
39
    </DOCUMENT>
40
</DEASDV>
Copied!
Supported units (UNIT)
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
Delivery note XSD file
 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
Below you can see how to correctly configure the request Body in Postman.
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
Validations
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)
Delivery notes (<TYPE>DELIVERY_NOTE</TYPE>)
Item PRICE_WITHOUT_VAT must not be null
Item PRICE_WITH_VAT must not be null
Item VAT_RATE must not be null
Remittances (<TYPE>RETURN</TYPE>)
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