Delivery Note
Endpoints here allow you to upload delivery notes and filter information about those that were successfully imported.
Last updated
Was this helpful?
Endpoints here allow you to upload delivery notes and filter information about those that were successfully imported.
Last updated
Was this helpful?
id long
Delivery note ID
📶 EQUALS,ENUM
_branchId integer
📶 EQUALS,ENUM
_cloudId integer
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
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
Below is a simplified structure only. For the complete definition of the document structure please see the attached XSD below.
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:
POST https://api.dotykacka.cz/v2/clouds/:cloudId/branches/:branchId/delivery-note-uploads
cloudId*
integer
branchId*
integer
Authorization*
string
Bearer accessToken
Content-Type*
string
multipart/form-data; boundary=:boundary (:boundary can be any value that won't appear in the HTTP data sent to the server, f.e. 12345678-abcd-1234-cdef-1234567890ab)
file*
object
Delivery note XML file. You must set file content type: application/xml; charset=:charset (:charset must be a valid charset used to encode the file, f.e. UTF-8, ISO-8859-2, etc.)
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.
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)
<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
<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
cloudId*
integer
page
integer
limit
integer
filter
string
sort
string
If-None-Match
string
ETag to return results only if changed.
Authorization*
string
Bearer accessToken
GET https://api.dotykacka.cz/v2/clouds/:cloudId/delivery-notes/:deliveryNoteId
deliveryNoteId*
integer
cloudId*
integer
Authorization*
string
Bearer accessToken
OPTIONS https://api.dotykacka.cz/v2/clouds/:cloudId/delivery-notes
cloudId*
integer
Authorization*
string
Bearer accessToken
OPTIONS https://api.dotykacka.cz/v2/clouds/:cloudId/delivery-notes/:deliveryNoteId
deliveryNoteId*
integer
cloudId*
integer
Authorization*
string
Upload the delivery note XML file to the server for verification and further processing. The file must be provided as a value for the key named "file" in a form-data body. For each XML element DEASDV.DOCUMENT a DeliveryNote entity is returned in a list in the response.
If TYPE in DEASDV.DOCUMENT is RETURN, then ITEM.AMOUNT must be a negative number or zero and ITEM.PRICE_WITHOUT_VAT, ITEM.PRICE_WITH_VAT and ITEM.VAT_RATE must be NULL (not present under the ITEM node). See the .
Below you can see how to correctly configure the request Body in .
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
