The format of the following data types:
datetime must be ISO 8601, i.e., "YYYY-MM-DDThh:mm:ss.sssZ".
date must be ISO 8601 date-only, i.e., "YYYY-MM-DD" (no time component). This is the format used for transport dates (transportDate).
decimal must use a decimal point as the only valid decimal separator, for example, 1999.99 or 0.45
guid: Identifiers are UUID v4 (format xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx).
If not provided, the following default values are assumed for each data type:
| Type |
Value |
boolean |
false |
integer |
0 |
decimal |
0 |
string |
|
datetime |
0001-01-01T00:00:00+00:00 |
date |
0001-01-01 |
DeCA
Data from the electronic road-based administrative control document, used for:
| Property |
Data type |
Required |
Description |
contractualCharger |
ContractualCharger |
Yes |
Contractual consignor (Art. 6.a) |
actualCarrier |
ActualCarrier |
Yes |
Actual carrier (Art. 6.b) |
shipments |
List<Shipment> |
Yes |
Transport (Art. 6.c) and Goods (Art. 6.d) |
vehicle |
Vehicle |
Yes |
Vehicle (Art. 6.g) |
transportDate |
date |
Yes |
Date the transport was carried out (Art. 6.f) |
specialCirculationPermit |
string |
No |
Special circulation permit, if applicable (Art. 6.e) |
remarks |
string |
No |
Remarks, reservations, or any other useful information (Art. 6.h) |
logo |
string |
No |
Company logo to be displayed in the PDF and/or notification email. Base64 string containing the PNG/JPG/GIF/BMP file content |
ContractualCharger
| Property |
Data type |
Required |
Description |
businessName |
string |
Yes |
Business name or corporate name |
taxIdentificationNumber |
string |
Yes |
Valid Spanish NIF, NIE, or CIF |
address |
string |
Yes |
Tax or registered address |
ActualCarrier
| Property |
Data type |
Required |
Description |
businessName |
string |
Yes |
Business name or corporate name |
taxIdentificationNumber |
string |
Yes |
Valid Spanish NIF, NIE, or CIF, or a foreign tax identifier (VIES-style format: ISO 3166-1 alpha-2 country code other than ES + up to 12 alphanumeric characters with at least one digit). The actual carrier may be a foreign company carrying out domestic transport |
Shipment
| Property |
Data type |
Required |
Description |
origin |
string |
Yes |
Place of origin of the transport (Art. 6.c) |
destination |
string |
Yes |
Place of destination of the transport (Art. 6.c) |
goodsNature |
string |
Yes |
Nature of the transported goods (Art. 6.d) |
packageCount |
integer |
No |
Number of packages of transported goods (Art. 6.d) |
weightKg |
decimal |
Conditional |
Weight in kilograms (Art. 6.d). Mandatory if alternativeMagnitude is not specified |
alternativeMagnitude |
string |
Conditional |
Alternative magnitude when weight cannot be determined (Art. 6.d) |
Vehicle
| Property |
Data type |
Required |
Description |
licensePlate |
string |
Conditional |
Main vehicle license plate. Required unless both tractorLicensePlate and semitrailerLicensePlate are provided (complete articulated combination), in which case it is optional and not printed on the PDF |
tractorLicensePlate |
string |
Conditional |
Tractor license plate for articulated vehicle combinations. If specified, semitrailerLicensePlate must also be specified |
semitrailerLicensePlate |
string |
Conditional |
Semi-trailer or trailer license plate. If specified, tractorLicensePlate must also be specified |
vehicleChange |
string |
No |
Description of vehicle change during transport, if applicable |
Recipient
Data for notifying the Electronic Road Administrative Control Document, used for:
| Property |
Data type |
Required |
Description |
channel |
0 = Email, 1 = SMS, 2 = WhatsApp |
Yes |
Type of notification to send |
address |
string |
Yes |
Destination address based on the channel. If Email, the format must be an email address; otherwise, an E.164 phone number (e.g., +34666123456) |
name |
string |
No |
Recipient's name |