| Field | Description |
|---|---|
| id | String, Yordex generated UUID that is unique for this document |
| type | String, mandatory The table below specifies all document types and their upload restrictions |
| orderId | String, mandatory The id of the order that this document is uploaded to |
| eventId | String, optional The id of the event that this document is uploaded to. Only required if the type of the document is EVENT |
| documentDate | String, optional The date of this document, e.g. the invoice date, using the ISO-8601 standard. |
| customerDocumentId | String, optional The reference of this document, e.g. the invoice reference |
| fileName | String, mandatory The filename of the document that is uploaded |
| name | String, optional The name under which this document is known in Yordex. When the type of the document is EVENT, this field is used for matching the document to one of the fields in the documentsRequired array of the event |
| base64EncodedContent | String, mandatory The base64 encoded document |
| location | String, Yordex provided The location where the document is stored. This is an API end-point so the document cannot be downloaded directly from the browser. It has to be downloaded from a server |
| Document type | Description |
|---|---|
| INVOICE | An invoice. The invoice has to be attached to an event. Only one invoice can be provided per event. If a new invoice is provided, the old one will be overwritten |
| ORDER | A document attached to an order. Every order can have up to 5 documents attached to it. The "name" field is not used for this type of documents. |
| EVENT | A document attached to an event. Every event can have up to 5 documents attached to it. The "name" field should correspond to one of the fields in the "documentsRequired" array of the event |