> For the complete documentation index, see [llms.txt](https://developer.dashdoc.com/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://developer.dashdoc.com/docs/api-reference/models.md).

# Models

## The Addresses object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"Addresses":{"properties":{"count":{"type":"integer"},"next":{"nullable":true,"type":"string"},"previous":{"nullable":true,"type":"string"},"results":{"items":{"$ref":"#/components/schemas/Address"},"type":"array"}},"type":"object"},"Address":{"properties":{"pk":{"description":"Dashdoc's internal id.","type":"number"},"name":{"type":"string"},"address":{"type":"string"},"city":{"type":"string"},"postcode":{"type":"string"},"country":{"$ref":"#/components/schemas/country"},"latitude":{"$ref":"#/components/schemas/latitude"},"longitude":{"$ref":"#/components/schemas/longitude"},"radius":{"default":500,"description":"Radius around the GPS coordinates within which the address is located (in meters)","type":"integer"},"coords_validated":{"default":false,"description":"if `true`, when this address is used as a loading or unloading site, the mobile app displays an itinerary button to start GPS app with guidance to these coordinates","type":"boolean"},"is_demo":{"$ref":"#/components/schemas/is_demo"},"is_carrier":{"type":"boolean"},"is_shipper":{"type":"boolean"},"is_origin":{"$ref":"#/components/schemas/address_is_origin_and_is_destination"},"is_destination":{"$ref":"#/components/schemas/address_is_origin_and_is_destination"},"created_by":{"$ref":"#/components/schemas/created-by"},"created_by_user":{"$ref":"#/components/schemas/created-by-user"},"created":{"$ref":"#/components/schemas/created"},"instructions":{"$ref":"#/components/schemas/site_instructions"},"remote_id":{"description":"The id of the address in your system.","type":"string"},"original":{"description":"Dashdoc's internal id of the original address.","nullable":true,"readOnly":true,"type":"number"},"company":{"$ref":"#/components/schemas/Company"}},"type":"object"},"country":{"description":"Only the 2-character codification is accepted (ISO 3166-1 alpha-2)","type":"string"},"latitude":{"description":"Latitude using the decimal GPS coordinates (WGS84). At 7 decimals, the position is accurate around the centimeter.","format":"float","nullable":true,"type":"number"},"longitude":{"description":"Longitude using the decimal GPS coordinates (WGS84). At 7 decimals, the position is accurate around the centimeter.","format":"float","nullable":true,"type":"number"},"is_demo":{"description":"Indicates that the address is a fake one created from demonstration. Everything linked to it will be deleted when using the 'Delete demo content' button in company parameters","type":"boolean"},"address_is_origin_and_is_destination":{"description":"Whether this address is a \"Logistic Points\" and will be usable as pickup/delivery point.\nThe distinction between origin/pickup and destination/delivery was merged as a single \"Logistic Point\" concept. `is_origin` implies `is_destination` and vice-versa.\n","type":"boolean"},"created-by":{"nullable":true,"properties":{"pk":{"description":"company id","type":"number"},"name":{"description":"name of the company","type":"string"}},"type":"object"},"created-by-user":{"nullable":true,"properties":{"pk":{"type":"number"},"display_name":{"type":"string"},"company":{"description":"The company id who created the address","type":"number"},"trucker_id":{"description":"The trucker id who created the address","type":"number"}},"type":"object"},"created":{"description":"Date of creation on our server","format":"date-time","type":"string"},"site_instructions":{"description":"Site instructions, visible to all parties (trucker, carrier, shipper, site). Displayed in the trucker mobile app. Not visible in the eCMR. If the field is not provided, the address's site instructions will be used.","maxLength":1000,"type":"string"},"Company":{"properties":{"pk":{"description":"Dashdoc's internal id.","type":"number"},"remote_id":{"type":"string"},"created":{"format":"date-time","type":"object"},"updated":{"format":"date-time","type":"string"},"deleted":{"type":"boolean"},"invoicing_remote_id":{"description":"The id of the company in your invoicing system.","type":"string"},"name":{"type":"string"},"phone_number":{"type":"string"},"email":{"type":"string"},"siren":{"type":"string"},"trade_number":{"type":"string"},"country":{"$ref":"#/components/schemas/country"},"comments":{"type":"string"},"vat_number":{"type":"string"},"is_verified":{"type":"boolean"},"settings_transport_order_observations":{"type":"string"},"settings_constrain_reference_edition":{"type":"boolean"},"account_type":{"description":"Ignore. Dashdoc technical data.","type":"string"},"logo":{"description":"The URL of your logo","nullable":true,"type":"string"},"subscription_access":{"type":"object"},"settings":{"type":"object"},"primary_address":{"$ref":"#/components/schemas/PrimaryAddress_1"},"managers":{"items":{"$ref":"#/components/schemas/Managers"},"type":"array"},"has_loggable_managers":{"description":"Ignore. Dashdoc technical data.","type":"boolean"}},"type":"object"},"PrimaryAddress_1":{"properties":{"pk":{"description":"Dashdoc's internal id.","type":"number"},"name":{"type":"string"},"address":{"type":"string"},"city":{"type":"string"},"postcode":{"type":"string"},"country":{"$ref":"#/components/schemas/country"},"latitude":{"$ref":"#/components/schemas/latitude"},"longitude":{"$ref":"#/components/schemas/longitude"},"radius":{"default":500,"description":"Radius around the GPS coordinates within which the address is located (in meters)","type":"integer"},"coords_validated":{"default":false,"description":"if `true`, when this address is used as a loading or unloading site, the mobile app displays an itinerary button to start GPS app with guidance to these coordinates","type":"boolean"},"is_demo":{"$ref":"#/components/schemas/is_demo"},"is_carrier":{"description":"Whether this company is considered a carrier","type":"boolean"},"is_shipper":{"description":"Whether this company is considered a shipper","type":"boolean"},"is_origin":{"description":"Legacy, not relevant for a company's primary address. Consider creating a separate address associated with this partner instead.\n","type":"boolean"},"is_destination":{"description":"Legacy, not relevant for a company's primary address. Consider creating a separate address associated with this partner instead.\n","type":"boolean"},"created_by":{"$ref":"#/components/schemas/created-by"},"created_by_user":{"$ref":"#/components/schemas/created-by-user"},"created":{"$ref":"#/components/schemas/created"},"remote_id":{"description":"The id of the address in your system.","type":"string"}},"type":"object"},"Managers":{"properties":{"pk":{"description":"Dashdoc's internal id.","type":"number"},"user":{"$ref":"#/components/schemas/Managers_user"},"display_name":{"type":"string"},"role":{"type":"string"}},"type":"object"},"Managers_user":{"properties":{"email":{"format":"email","type":"string"},"first_name":{"type":"string"},"last_name":{"type":"string"}},"type":"object"}}}}
```

## The NewAddress object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"NewAddress":{"properties":{"name":{"description":"Label for this address","maxLength":200,"type":"string"},"remote_id":{"description":"The id of the address in your system.","type":"string"},"address":{"description":"Address not mandatory but strongly advised to fill","maxLength":200,"type":"string"},"city":{"maxLength":100,"type":"string"},"postcode":{"maxLength":100,"type":"string"},"country":{"description":"Only the 2-character codification is accepted (ISO 3166-1 alpha-2). Country not mandatory but strongly advised to fill","type":"string"},"latitude":{"$ref":"#/components/schemas/latitude"},"longitude":{"$ref":"#/components/schemas/longitude"},"radius":{"default":500,"description":"Radius around the GPS coordinates within which the address is located (in meters)","type":"integer"},"coords_validated":{"default":false,"description":"if `true`, when this address is used as a loading or unloading site, the mobile app displays an itinerary button to start GPS app with guidance to these coordinates","type":"boolean"},"is_demo":{"$ref":"#/components/schemas/is_demo"},"is_carrier":{"$ref":"#/components/schemas/address_is_carrier_and_is_shipper_for_writes"},"is_shipper":{"$ref":"#/components/schemas/address_is_carrier_and_is_shipper_for_writes"},"is_origin":{"$ref":"#/components/schemas/address_is_origin_and_is_destination"},"is_destination":{"$ref":"#/components/schemas/address_is_origin_and_is_destination"},"company":{"$ref":"#/components/schemas/CompanyForNewAddress"}},"required":["city","company","postcode"],"type":"object"},"latitude":{"description":"Latitude using the decimal GPS coordinates (WGS84). At 7 decimals, the position is accurate around the centimeter.","format":"float","nullable":true,"type":"number"},"longitude":{"description":"Longitude using the decimal GPS coordinates (WGS84). At 7 decimals, the position is accurate around the centimeter.","format":"float","nullable":true,"type":"number"},"is_demo":{"description":"Indicates that the address is a fake one created from demonstration. Everything linked to it will be deleted when using the 'Delete demo content' button in company parameters","type":"boolean"},"address_is_carrier_and_is_shipper_for_writes":{"description":"Controls the associated company's role (see `company` in same payload). For new companies ONLY. The value is ignored for existing companies.\nIt is encouraged to use the company create/update endpoints directly instead.\n","type":"boolean"},"address_is_origin_and_is_destination":{"description":"Whether this address is a \"Logistic Points\" and will be usable as pickup/delivery point.\nThe distinction between origin/pickup and destination/delivery was merged as a single \"Logistic Point\" concept. `is_origin` implies `is_destination` and vice-versa.\n","type":"boolean"},"CompanyForNewAddress":{"description":"Identification of the company for which the address is created. You may simply use its `pk` or `remote_id` if the company already exists. Other possible identification method are its `trade_number` or `name`. If it doesn't exist, the company will be created with the information you send based on what's possible when creating a company via /companies/ web service. Minimum required information in this case is a name (e.g. for a logistic point).","properties":{"pk":{"description":"Dashdoc's internal id.Optional, not required if `remote_id` is sent.","type":"number"},"remote_id":{"description":"The id of the company in your system. Optional, ignored if `pk` is sent.","type":"string"},"trade_number":{"maxLength":100,"type":"string"},"name":{"maxLength":200,"type":"string"}},"type":"object"}}}}
```

## The Address object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"Address":{"properties":{"pk":{"description":"Dashdoc's internal id.","type":"number"},"name":{"type":"string"},"address":{"type":"string"},"city":{"type":"string"},"postcode":{"type":"string"},"country":{"$ref":"#/components/schemas/country"},"latitude":{"$ref":"#/components/schemas/latitude"},"longitude":{"$ref":"#/components/schemas/longitude"},"radius":{"default":500,"description":"Radius around the GPS coordinates within which the address is located (in meters)","type":"integer"},"coords_validated":{"default":false,"description":"if `true`, when this address is used as a loading or unloading site, the mobile app displays an itinerary button to start GPS app with guidance to these coordinates","type":"boolean"},"is_demo":{"$ref":"#/components/schemas/is_demo"},"is_carrier":{"type":"boolean"},"is_shipper":{"type":"boolean"},"is_origin":{"$ref":"#/components/schemas/address_is_origin_and_is_destination"},"is_destination":{"$ref":"#/components/schemas/address_is_origin_and_is_destination"},"created_by":{"$ref":"#/components/schemas/created-by"},"created_by_user":{"$ref":"#/components/schemas/created-by-user"},"created":{"$ref":"#/components/schemas/created"},"instructions":{"$ref":"#/components/schemas/site_instructions"},"remote_id":{"description":"The id of the address in your system.","type":"string"},"original":{"description":"Dashdoc's internal id of the original address.","nullable":true,"readOnly":true,"type":"number"},"company":{"$ref":"#/components/schemas/Company"}},"type":"object"},"country":{"description":"Only the 2-character codification is accepted (ISO 3166-1 alpha-2)","type":"string"},"latitude":{"description":"Latitude using the decimal GPS coordinates (WGS84). At 7 decimals, the position is accurate around the centimeter.","format":"float","nullable":true,"type":"number"},"longitude":{"description":"Longitude using the decimal GPS coordinates (WGS84). At 7 decimals, the position is accurate around the centimeter.","format":"float","nullable":true,"type":"number"},"is_demo":{"description":"Indicates that the address is a fake one created from demonstration. Everything linked to it will be deleted when using the 'Delete demo content' button in company parameters","type":"boolean"},"address_is_origin_and_is_destination":{"description":"Whether this address is a \"Logistic Points\" and will be usable as pickup/delivery point.\nThe distinction between origin/pickup and destination/delivery was merged as a single \"Logistic Point\" concept. `is_origin` implies `is_destination` and vice-versa.\n","type":"boolean"},"created-by":{"nullable":true,"properties":{"pk":{"description":"company id","type":"number"},"name":{"description":"name of the company","type":"string"}},"type":"object"},"created-by-user":{"nullable":true,"properties":{"pk":{"type":"number"},"display_name":{"type":"string"},"company":{"description":"The company id who created the address","type":"number"},"trucker_id":{"description":"The trucker id who created the address","type":"number"}},"type":"object"},"created":{"description":"Date of creation on our server","format":"date-time","type":"string"},"site_instructions":{"description":"Site instructions, visible to all parties (trucker, carrier, shipper, site). Displayed in the trucker mobile app. Not visible in the eCMR. If the field is not provided, the address's site instructions will be used.","maxLength":1000,"type":"string"},"Company":{"properties":{"pk":{"description":"Dashdoc's internal id.","type":"number"},"remote_id":{"type":"string"},"created":{"format":"date-time","type":"object"},"updated":{"format":"date-time","type":"string"},"deleted":{"type":"boolean"},"invoicing_remote_id":{"description":"The id of the company in your invoicing system.","type":"string"},"name":{"type":"string"},"phone_number":{"type":"string"},"email":{"type":"string"},"siren":{"type":"string"},"trade_number":{"type":"string"},"country":{"$ref":"#/components/schemas/country"},"comments":{"type":"string"},"vat_number":{"type":"string"},"is_verified":{"type":"boolean"},"settings_transport_order_observations":{"type":"string"},"settings_constrain_reference_edition":{"type":"boolean"},"account_type":{"description":"Ignore. Dashdoc technical data.","type":"string"},"logo":{"description":"The URL of your logo","nullable":true,"type":"string"},"subscription_access":{"type":"object"},"settings":{"type":"object"},"primary_address":{"$ref":"#/components/schemas/PrimaryAddress_1"},"managers":{"items":{"$ref":"#/components/schemas/Managers"},"type":"array"},"has_loggable_managers":{"description":"Ignore. Dashdoc technical data.","type":"boolean"}},"type":"object"},"PrimaryAddress_1":{"properties":{"pk":{"description":"Dashdoc's internal id.","type":"number"},"name":{"type":"string"},"address":{"type":"string"},"city":{"type":"string"},"postcode":{"type":"string"},"country":{"$ref":"#/components/schemas/country"},"latitude":{"$ref":"#/components/schemas/latitude"},"longitude":{"$ref":"#/components/schemas/longitude"},"radius":{"default":500,"description":"Radius around the GPS coordinates within which the address is located (in meters)","type":"integer"},"coords_validated":{"default":false,"description":"if `true`, when this address is used as a loading or unloading site, the mobile app displays an itinerary button to start GPS app with guidance to these coordinates","type":"boolean"},"is_demo":{"$ref":"#/components/schemas/is_demo"},"is_carrier":{"description":"Whether this company is considered a carrier","type":"boolean"},"is_shipper":{"description":"Whether this company is considered a shipper","type":"boolean"},"is_origin":{"description":"Legacy, not relevant for a company's primary address. Consider creating a separate address associated with this partner instead.\n","type":"boolean"},"is_destination":{"description":"Legacy, not relevant for a company's primary address. Consider creating a separate address associated with this partner instead.\n","type":"boolean"},"created_by":{"$ref":"#/components/schemas/created-by"},"created_by_user":{"$ref":"#/components/schemas/created-by-user"},"created":{"$ref":"#/components/schemas/created"},"remote_id":{"description":"The id of the address in your system.","type":"string"}},"type":"object"},"Managers":{"properties":{"pk":{"description":"Dashdoc's internal id.","type":"number"},"user":{"$ref":"#/components/schemas/Managers_user"},"display_name":{"type":"string"},"role":{"type":"string"}},"type":"object"},"Managers_user":{"properties":{"email":{"format":"email","type":"string"},"first_name":{"type":"string"},"last_name":{"type":"string"}},"type":"object"}}}}
```

## The UpdateAddress object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"UpdateAddress":{"properties":{"name":{"description":"Label for this address","maxLength":200,"type":"string"},"remote_id":{"description":"The id of the address in your system.","type":"string"},"address":{"maxLength":200,"type":"string"},"city":{"maxLength":100,"type":"string"},"postcode":{"maxLength":100,"type":"string"},"country":{"$ref":"#/components/schemas/country"},"latitude":{"$ref":"#/components/schemas/latitude"},"longitude":{"$ref":"#/components/schemas/longitude"},"radius":{"default":500,"description":"Radius around the GPS coordinates within which the address is located (in meters)","type":"integer"},"coords_validated":{"default":false,"description":"if `true`, when this address is used as a loading or unloading site, the mobile app displays an itinerary button to start GPS app with guidance to these coordinates","type":"boolean"},"is_demo":{"$ref":"#/components/schemas/is_demo"},"is_carrier":{"$ref":"#/components/schemas/address_is_carrier_and_is_shipper_for_writes"},"is_shipper":{"$ref":"#/components/schemas/address_is_carrier_and_is_shipper_for_writes"},"is_origin":{"$ref":"#/components/schemas/address_is_origin_and_is_destination"},"is_destination":{"$ref":"#/components/schemas/address_is_origin_and_is_destination"},"company":{"$ref":"#/components/schemas/CompanyForUpdateAddress"}},"type":"object"},"country":{"description":"Only the 2-character codification is accepted (ISO 3166-1 alpha-2)","type":"string"},"latitude":{"description":"Latitude using the decimal GPS coordinates (WGS84). At 7 decimals, the position is accurate around the centimeter.","format":"float","nullable":true,"type":"number"},"longitude":{"description":"Longitude using the decimal GPS coordinates (WGS84). At 7 decimals, the position is accurate around the centimeter.","format":"float","nullable":true,"type":"number"},"is_demo":{"description":"Indicates that the address is a fake one created from demonstration. Everything linked to it will be deleted when using the 'Delete demo content' button in company parameters","type":"boolean"},"address_is_carrier_and_is_shipper_for_writes":{"description":"Controls the associated company's role (see `company` in same payload). For new companies ONLY. The value is ignored for existing companies.\nIt is encouraged to use the company create/update endpoints directly instead.\n","type":"boolean"},"address_is_origin_and_is_destination":{"description":"Whether this address is a \"Logistic Points\" and will be usable as pickup/delivery point.\nThe distinction between origin/pickup and destination/delivery was merged as a single \"Logistic Point\" concept. `is_origin` implies `is_destination` and vice-versa.\n","type":"boolean"},"CompanyForUpdateAddress":{"description":"Identification of the company that the address belongs to. You may simply use its `pk` or `remote_id`, or just a name (e.g. for a logistic point that has no other company detail in your address book).","properties":{"pk":{"description":"Dashdoc's internal id.Optional, not required if `remote_id` is sent.","type":"number"},"remote_id":{"description":"The id of the company in your system. Optional, ignored if `pk` is sent.","type":"string"},"name":{"maxLength":200,"type":"string"}},"type":"object"}}}}
```

## The SecurityProtocol object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"SecurityProtocol":{"properties":{"pk":{"description":"Dashdoc's internal id. It will be automatically generated by Dashdoc.","type":"number"},"address":{"description":"Id of the address that the security protocol should be linked to.","type":"number"},"document":{"description":"URL of the stored document. You can download the document from this URL.","type":"string"},"document_title":{"description":"Filename","type":"string"},"updated":{"description":"Last updated time","format":"date-time","type":"string"},"has_been_seen_recently":{"description":"Check if you've seen the security protocol recently. Returns `null` if it hasn't been seen at all.","type":"boolean"}},"type":"object"}}}}
```

## The AdrUnCodes object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"AdrUnCodes":{"properties":{"count":{"type":"integer"},"next":{"nullable":true,"type":"string"},"previous":{"nullable":true,"type":"string"},"results":{"items":{"$ref":"#/components/schemas/AdrUnCode"},"type":"array"}},"type":"object"},"AdrUnCode":{"properties":{"id":{"description":"Dashdoc's internal id","type":"number"},"code":{"description":"UN code, column n°1 from ADR Table A","type":"number"},"category":{"description":"ADR class, column n°2 from ADR Table A","type":"string"},"description":{"$ref":"#/components/schemas/AdrUnCodeDescription"},"packaging_group":{"description":"Packaging group, column n°4 from ADR Table A","type":"string"},"tunnel_restriction":{"description":"Tunnel restriction code, column n°15 from ADR Table A","type":"string"}},"type":"object"},"AdrUnCodeDescription":{"description":"Name and description, column n°4 from ADR Table A. Translated in FR, EN, NL, DE","properties":{"fr":{"description":"French label","type":"string"},"en":{"description":"English label","type":"string"},"nl":{"description":"Dutch label","type":"string"},"de":{"description":"German label","type":"string"}},"type":"object"}}}}
```

## The TransportOperationCategories object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"TransportOperationCategories":{"properties":{"count":{"type":"integer"},"next":{"nullable":true,"type":"string"},"previous":{"nullable":true,"type":"string"},"results":{"items":{"$ref":"#/components/schemas/TransportOperationCategories_results"},"type":"array"}},"type":"object"},"TransportOperationCategories_results":{"properties":{"uid":{"format":"uuid","type":"string"},"name":{"type":"string"}},"type":"object"}}}}
```

## The Companies object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"Companies":{"properties":{"count":{"type":"integer"},"next":{"nullable":true,"type":"string"},"previous":{"nullable":true,"type":"string"},"results":{"items":{"$ref":"#/components/schemas/FullCompany"},"type":"array"}},"type":"object"},"FullCompany":{"properties":{"pk":{"description":"Dashdoc's internal id.","type":"number"},"name":{"type":"string"},"addresses":{"items":{"$ref":"#/components/schemas/AddressForCompany"},"type":"array"},"phone_number":{"type":"string"},"email":{"format":"email","type":"string"},"siren":{"type":"string"},"trade_number":{"type":"string"},"vat_number":{"type":"string"},"country":{"$ref":"#/components/schemas/country"},"has_loggable_managers":{"description":"Ignore. Dashdoc technical data.","type":"boolean"},"contacts":{"items":{"$ref":"#/components/schemas/Contact"},"type":"array"},"has_pending_invites":{"description":"Ignore. Dashdoc technical data.","type":"boolean"},"primary_address":{"$ref":"#/components/schemas/PrimaryAddress_1"},"transports_in_last_month":{"description":"Ignore. Dashdoc technical data.","type":"integer"},"is_verified":{"description":"Ignore. Dashdoc technical data.","type":"boolean"},"can_invite_to":{"description":"Ignore. Dashdoc technical data.","type":"boolean"},"remote_id":{"description":"The id of the company in your system.","type":"string"},"invoicing_remote_id":{"description":"The id of the company in your invoicing system.","type":"string"},"notes":{"description":"Notes for this company, only visibile to your team members","type":"string"},"account_code":{"description":"The accounting ledger code (\"compte de tiers\") used for this company when it is a customer/shipper.","type":"string"},"side_account_code":{"description":"The auxiliary accounting code used for this company when it is a customer/shipper.","type":"string"},"purchase_account_code":{"description":"The accounting ledger code (\"compte de tiers\") used for this company when it is a supplier/carrier.","type":"string"},"purchase_side_account_code":{"description":"The auxiliary accounting code used for this company when it is a supplier/carrier.","type":"string"},"tags":{"description":"List of tags applied to the company.","items":{"$ref":"#/components/schemas/Tag"},"type":"array"}},"type":"object"},"AddressForCompany":{"properties":{"pk":{"description":"Dashdoc's internal id.","type":"number"},"name":{"type":"string"},"address":{"type":"string"},"city":{"type":"string"},"postcode":{"type":"string"},"country":{"$ref":"#/components/schemas/country"},"latitude":{"$ref":"#/components/schemas/latitude"},"longitude":{"$ref":"#/components/schemas/longitude"},"radius":{"default":500,"description":"Radius around the GPS coordinates within which the address is located (in meters)","type":"integer"},"coords_validated":{"default":false,"description":"if `true`, when this address is used as a loading or unloading site, the mobile app displays an itinerary button to start GPS app with guidance to these coordinates","type":"boolean"},"is_demo":{"$ref":"#/components/schemas/is_demo"},"is_carrier":{"type":"boolean"},"is_shipper":{"type":"boolean"},"is_origin":{"$ref":"#/components/schemas/address_is_origin_and_is_destination"},"is_destination":{"$ref":"#/components/schemas/address_is_origin_and_is_destination"},"created_by":{"$ref":"#/components/schemas/created-by"},"created_by_user":{"$ref":"#/components/schemas/created-by-user"},"created":{"$ref":"#/components/schemas/created"},"remote_id":{"description":"The id of the address in your system.","type":"string"}},"type":"object"},"country":{"description":"Only the 2-character codification is accepted (ISO 3166-1 alpha-2)","type":"string"},"latitude":{"description":"Latitude using the decimal GPS coordinates (WGS84). At 7 decimals, the position is accurate around the centimeter.","format":"float","nullable":true,"type":"number"},"longitude":{"description":"Longitude using the decimal GPS coordinates (WGS84). At 7 decimals, the position is accurate around the centimeter.","format":"float","nullable":true,"type":"number"},"is_demo":{"description":"Indicates that the address is a fake one created from demonstration. Everything linked to it will be deleted when using the 'Delete demo content' button in company parameters","type":"boolean"},"address_is_origin_and_is_destination":{"description":"Whether this address is a \"Logistic Points\" and will be usable as pickup/delivery point.\nThe distinction between origin/pickup and destination/delivery was merged as a single \"Logistic Point\" concept. `is_origin` implies `is_destination` and vice-versa.\n","type":"boolean"},"created-by":{"nullable":true,"properties":{"pk":{"description":"company id","type":"number"},"name":{"description":"name of the company","type":"string"}},"type":"object"},"created-by-user":{"nullable":true,"properties":{"pk":{"type":"number"},"display_name":{"type":"string"},"company":{"description":"The company id who created the address","type":"number"},"trucker_id":{"description":"The trucker id who created the address","type":"number"}},"type":"object"},"created":{"description":"Date of creation on our server","format":"date-time","type":"string"},"Contact":{"properties":{"uid":{"format":"uuid","type":"string"},"created":{"$ref":"#/components/schemas/created"},"company":{"$ref":"#/components/schemas/Company"},"first_name":{"type":"string"},"last_name":{"type":"string"},"email":{"format":"email","type":"string"},"phone_number":{"type":"string"},"fax_number":{"type":"string"},"remote_id":{"description":"The id of the contact in your system","type":"string"},"is_manager":{"description":"Ignore. Dashdoc technical data.","type":"boolean"},"has_pending_invite":{"description":"Ignore. Dashdoc technical data.","type":"boolean"},"is_invitable":{"description":"Ignore. Dashdoc technical data.","type":"boolean"},"invitation_link":{"format":"url","nullable":true,"type":"string"}},"type":"object"},"Company":{"properties":{"pk":{"description":"Dashdoc's internal id.","type":"number"},"remote_id":{"type":"string"},"created":{"format":"date-time","type":"object"},"updated":{"format":"date-time","type":"string"},"deleted":{"type":"boolean"},"invoicing_remote_id":{"description":"The id of the company in your invoicing system.","type":"string"},"name":{"type":"string"},"phone_number":{"type":"string"},"email":{"type":"string"},"siren":{"type":"string"},"trade_number":{"type":"string"},"country":{"$ref":"#/components/schemas/country"},"comments":{"type":"string"},"vat_number":{"type":"string"},"is_verified":{"type":"boolean"},"settings_transport_order_observations":{"type":"string"},"settings_constrain_reference_edition":{"type":"boolean"},"account_type":{"description":"Ignore. Dashdoc technical data.","type":"string"},"logo":{"description":"The URL of your logo","nullable":true,"type":"string"},"subscription_access":{"type":"object"},"settings":{"type":"object"},"primary_address":{"$ref":"#/components/schemas/PrimaryAddress_1"},"managers":{"items":{"$ref":"#/components/schemas/Managers"},"type":"array"},"has_loggable_managers":{"description":"Ignore. Dashdoc technical data.","type":"boolean"}},"type":"object"},"PrimaryAddress_1":{"properties":{"pk":{"description":"Dashdoc's internal id.","type":"number"},"name":{"type":"string"},"address":{"type":"string"},"city":{"type":"string"},"postcode":{"type":"string"},"country":{"$ref":"#/components/schemas/country"},"latitude":{"$ref":"#/components/schemas/latitude"},"longitude":{"$ref":"#/components/schemas/longitude"},"radius":{"default":500,"description":"Radius around the GPS coordinates within which the address is located (in meters)","type":"integer"},"coords_validated":{"default":false,"description":"if `true`, when this address is used as a loading or unloading site, the mobile app displays an itinerary button to start GPS app with guidance to these coordinates","type":"boolean"},"is_demo":{"$ref":"#/components/schemas/is_demo"},"is_carrier":{"description":"Whether this company is considered a carrier","type":"boolean"},"is_shipper":{"description":"Whether this company is considered a shipper","type":"boolean"},"is_origin":{"description":"Legacy, not relevant for a company's primary address. Consider creating a separate address associated with this partner instead.\n","type":"boolean"},"is_destination":{"description":"Legacy, not relevant for a company's primary address. Consider creating a separate address associated with this partner instead.\n","type":"boolean"},"created_by":{"$ref":"#/components/schemas/created-by"},"created_by_user":{"$ref":"#/components/schemas/created-by-user"},"created":{"$ref":"#/components/schemas/created"},"remote_id":{"description":"The id of the address in your system.","type":"string"}},"type":"object"},"Managers":{"properties":{"pk":{"description":"Dashdoc's internal id.","type":"number"},"user":{"$ref":"#/components/schemas/Managers_user"},"display_name":{"type":"string"},"role":{"type":"string"}},"type":"object"},"Managers_user":{"properties":{"email":{"format":"email","type":"string"},"first_name":{"type":"string"},"last_name":{"type":"string"}},"type":"object"},"Tag":{"properties":{"pk":{"description":"The unique identifier of the tag","type":"integer"},"name":{"description":"The name of the tag","type":"string"},"color":{"description":"The color of the tag in hex format","type":"string"},"tag_group_id":{"description":"The ID of the tag group this tag belongs to, if any","nullable":true,"type":"integer"}},"required":["color","name","pk"],"type":"object"}}}}
```

## The NewCompany object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"NewCompany":{"properties":{"name":{"type":"string"},"phone_number":{"type":"string"},"email":{"format":"email","type":"string"},"siren":{"type":"string"},"trade_number":{"type":"string"},"vat_number":{"type":"string"},"country":{"$ref":"#/components/schemas/country"},"remote_id":{"description":"The ID of the company in your system. It has to be unique among all your companies.","type":"string"},"invoicing_remote_id":{"description":"The id of the company in your invoicing system.","type":"string"},"notes":{"description":"Notes for this company, only visibile to your team members","type":"string"},"account_code":{"description":"The accounting ledger code (\"compte de tiers\") used for this company when it is a customer/shipper.","type":"string"},"side_account_code":{"description":"The auxiliary accounting code used for this company when it is a customer/shipper.","type":"string"},"purchase_account_code":{"description":"The accounting ledger code (\"compte de tiers\") used for this company when it is a supplier/carrier.","type":"string"},"purchase_side_account_code":{"description":"The auxiliary accounting code used for this company when it is a supplier/carrier.","type":"string"},"primary_address":{"$ref":"#/components/schemas/PrimaryAddress"},"tags":{"description":"List of tags applied to the company.","items":{"$ref":"#/components/schemas/Tag"},"type":"array"}},"required":["country","name"],"type":"object"},"country":{"description":"Only the 2-character codification is accepted (ISO 3166-1 alpha-2)","type":"string"},"PrimaryAddress":{"properties":{"pk":{"type":"string"},"name":{"maxLength":200,"type":"string"},"address":{"maxLength":200,"type":"string"},"city":{"maxLength":100,"type":"string"},"postcode":{"maxLength":100,"type":"string"},"country":{"$ref":"#/components/schemas/country"},"latitude":{"$ref":"#/components/schemas/latitude"},"longitude":{"$ref":"#/components/schemas/longitude"},"radius":{"default":500,"description":"Radius around the GPS coordinates within which the address is located (in meters)","type":"integer"},"coords_validated":{"default":false,"description":"if `true`, when this address is used as a loading or unloading site, the mobile app displays an itinerary button to start GPS app with guidance to these coordinates","type":"boolean"},"is_demo":{"$ref":"#/components/schemas/is_demo"},"is_carrier":{"description":"Whether this company is considered a carrier.","type":"boolean"},"is_shipper":{"description":"Whether this company is considered a shipper.","type":"boolean"},"is_origin":{"description":"Legacy, not relevant for a company's primary address.","type":"boolean"},"is_destination":{"description":"Legacy, not relevant for a company's primary address.","type":"boolean"},"created_by":{"type":"number"},"created":{"description":"Date of creation on our server","format":"date-time","type":"string"},"instructions":{"type":"string"},"remote_id":{"description":"The id of the address in your system.","type":"string"}},"type":"object"},"latitude":{"description":"Latitude using the decimal GPS coordinates (WGS84). At 7 decimals, the position is accurate around the centimeter.","format":"float","nullable":true,"type":"number"},"longitude":{"description":"Longitude using the decimal GPS coordinates (WGS84). At 7 decimals, the position is accurate around the centimeter.","format":"float","nullable":true,"type":"number"},"is_demo":{"description":"Indicates that the address is a fake one created from demonstration. Everything linked to it will be deleted when using the 'Delete demo content' button in company parameters","type":"boolean"},"Tag":{"properties":{"pk":{"description":"The unique identifier of the tag","type":"integer"},"name":{"description":"The name of the tag","type":"string"},"color":{"description":"The color of the tag in hex format","type":"string"},"tag_group_id":{"description":"The ID of the tag group this tag belongs to, if any","nullable":true,"type":"integer"}},"required":["color","name","pk"],"type":"object"}}}}
```

## The FullCompany object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"FullCompany":{"properties":{"pk":{"description":"Dashdoc's internal id.","type":"number"},"name":{"type":"string"},"addresses":{"items":{"$ref":"#/components/schemas/AddressForCompany"},"type":"array"},"phone_number":{"type":"string"},"email":{"format":"email","type":"string"},"siren":{"type":"string"},"trade_number":{"type":"string"},"vat_number":{"type":"string"},"country":{"$ref":"#/components/schemas/country"},"has_loggable_managers":{"description":"Ignore. Dashdoc technical data.","type":"boolean"},"contacts":{"items":{"$ref":"#/components/schemas/Contact"},"type":"array"},"has_pending_invites":{"description":"Ignore. Dashdoc technical data.","type":"boolean"},"primary_address":{"$ref":"#/components/schemas/PrimaryAddress_1"},"transports_in_last_month":{"description":"Ignore. Dashdoc technical data.","type":"integer"},"is_verified":{"description":"Ignore. Dashdoc technical data.","type":"boolean"},"can_invite_to":{"description":"Ignore. Dashdoc technical data.","type":"boolean"},"remote_id":{"description":"The id of the company in your system.","type":"string"},"invoicing_remote_id":{"description":"The id of the company in your invoicing system.","type":"string"},"notes":{"description":"Notes for this company, only visibile to your team members","type":"string"},"account_code":{"description":"The accounting ledger code (\"compte de tiers\") used for this company when it is a customer/shipper.","type":"string"},"side_account_code":{"description":"The auxiliary accounting code used for this company when it is a customer/shipper.","type":"string"},"purchase_account_code":{"description":"The accounting ledger code (\"compte de tiers\") used for this company when it is a supplier/carrier.","type":"string"},"purchase_side_account_code":{"description":"The auxiliary accounting code used for this company when it is a supplier/carrier.","type":"string"},"tags":{"description":"List of tags applied to the company.","items":{"$ref":"#/components/schemas/Tag"},"type":"array"}},"type":"object"},"AddressForCompany":{"properties":{"pk":{"description":"Dashdoc's internal id.","type":"number"},"name":{"type":"string"},"address":{"type":"string"},"city":{"type":"string"},"postcode":{"type":"string"},"country":{"$ref":"#/components/schemas/country"},"latitude":{"$ref":"#/components/schemas/latitude"},"longitude":{"$ref":"#/components/schemas/longitude"},"radius":{"default":500,"description":"Radius around the GPS coordinates within which the address is located (in meters)","type":"integer"},"coords_validated":{"default":false,"description":"if `true`, when this address is used as a loading or unloading site, the mobile app displays an itinerary button to start GPS app with guidance to these coordinates","type":"boolean"},"is_demo":{"$ref":"#/components/schemas/is_demo"},"is_carrier":{"type":"boolean"},"is_shipper":{"type":"boolean"},"is_origin":{"$ref":"#/components/schemas/address_is_origin_and_is_destination"},"is_destination":{"$ref":"#/components/schemas/address_is_origin_and_is_destination"},"created_by":{"$ref":"#/components/schemas/created-by"},"created_by_user":{"$ref":"#/components/schemas/created-by-user"},"created":{"$ref":"#/components/schemas/created"},"remote_id":{"description":"The id of the address in your system.","type":"string"}},"type":"object"},"country":{"description":"Only the 2-character codification is accepted (ISO 3166-1 alpha-2)","type":"string"},"latitude":{"description":"Latitude using the decimal GPS coordinates (WGS84). At 7 decimals, the position is accurate around the centimeter.","format":"float","nullable":true,"type":"number"},"longitude":{"description":"Longitude using the decimal GPS coordinates (WGS84). At 7 decimals, the position is accurate around the centimeter.","format":"float","nullable":true,"type":"number"},"is_demo":{"description":"Indicates that the address is a fake one created from demonstration. Everything linked to it will be deleted when using the 'Delete demo content' button in company parameters","type":"boolean"},"address_is_origin_and_is_destination":{"description":"Whether this address is a \"Logistic Points\" and will be usable as pickup/delivery point.\nThe distinction between origin/pickup and destination/delivery was merged as a single \"Logistic Point\" concept. `is_origin` implies `is_destination` and vice-versa.\n","type":"boolean"},"created-by":{"nullable":true,"properties":{"pk":{"description":"company id","type":"number"},"name":{"description":"name of the company","type":"string"}},"type":"object"},"created-by-user":{"nullable":true,"properties":{"pk":{"type":"number"},"display_name":{"type":"string"},"company":{"description":"The company id who created the address","type":"number"},"trucker_id":{"description":"The trucker id who created the address","type":"number"}},"type":"object"},"created":{"description":"Date of creation on our server","format":"date-time","type":"string"},"Contact":{"properties":{"uid":{"format":"uuid","type":"string"},"created":{"$ref":"#/components/schemas/created"},"company":{"$ref":"#/components/schemas/Company"},"first_name":{"type":"string"},"last_name":{"type":"string"},"email":{"format":"email","type":"string"},"phone_number":{"type":"string"},"fax_number":{"type":"string"},"remote_id":{"description":"The id of the contact in your system","type":"string"},"is_manager":{"description":"Ignore. Dashdoc technical data.","type":"boolean"},"has_pending_invite":{"description":"Ignore. Dashdoc technical data.","type":"boolean"},"is_invitable":{"description":"Ignore. Dashdoc technical data.","type":"boolean"},"invitation_link":{"format":"url","nullable":true,"type":"string"}},"type":"object"},"Company":{"properties":{"pk":{"description":"Dashdoc's internal id.","type":"number"},"remote_id":{"type":"string"},"created":{"format":"date-time","type":"object"},"updated":{"format":"date-time","type":"string"},"deleted":{"type":"boolean"},"invoicing_remote_id":{"description":"The id of the company in your invoicing system.","type":"string"},"name":{"type":"string"},"phone_number":{"type":"string"},"email":{"type":"string"},"siren":{"type":"string"},"trade_number":{"type":"string"},"country":{"$ref":"#/components/schemas/country"},"comments":{"type":"string"},"vat_number":{"type":"string"},"is_verified":{"type":"boolean"},"settings_transport_order_observations":{"type":"string"},"settings_constrain_reference_edition":{"type":"boolean"},"account_type":{"description":"Ignore. Dashdoc technical data.","type":"string"},"logo":{"description":"The URL of your logo","nullable":true,"type":"string"},"subscription_access":{"type":"object"},"settings":{"type":"object"},"primary_address":{"$ref":"#/components/schemas/PrimaryAddress_1"},"managers":{"items":{"$ref":"#/components/schemas/Managers"},"type":"array"},"has_loggable_managers":{"description":"Ignore. Dashdoc technical data.","type":"boolean"}},"type":"object"},"PrimaryAddress_1":{"properties":{"pk":{"description":"Dashdoc's internal id.","type":"number"},"name":{"type":"string"},"address":{"type":"string"},"city":{"type":"string"},"postcode":{"type":"string"},"country":{"$ref":"#/components/schemas/country"},"latitude":{"$ref":"#/components/schemas/latitude"},"longitude":{"$ref":"#/components/schemas/longitude"},"radius":{"default":500,"description":"Radius around the GPS coordinates within which the address is located (in meters)","type":"integer"},"coords_validated":{"default":false,"description":"if `true`, when this address is used as a loading or unloading site, the mobile app displays an itinerary button to start GPS app with guidance to these coordinates","type":"boolean"},"is_demo":{"$ref":"#/components/schemas/is_demo"},"is_carrier":{"description":"Whether this company is considered a carrier","type":"boolean"},"is_shipper":{"description":"Whether this company is considered a shipper","type":"boolean"},"is_origin":{"description":"Legacy, not relevant for a company's primary address. Consider creating a separate address associated with this partner instead.\n","type":"boolean"},"is_destination":{"description":"Legacy, not relevant for a company's primary address. Consider creating a separate address associated with this partner instead.\n","type":"boolean"},"created_by":{"$ref":"#/components/schemas/created-by"},"created_by_user":{"$ref":"#/components/schemas/created-by-user"},"created":{"$ref":"#/components/schemas/created"},"remote_id":{"description":"The id of the address in your system.","type":"string"}},"type":"object"},"Managers":{"properties":{"pk":{"description":"Dashdoc's internal id.","type":"number"},"user":{"$ref":"#/components/schemas/Managers_user"},"display_name":{"type":"string"},"role":{"type":"string"}},"type":"object"},"Managers_user":{"properties":{"email":{"format":"email","type":"string"},"first_name":{"type":"string"},"last_name":{"type":"string"}},"type":"object"},"Tag":{"properties":{"pk":{"description":"The unique identifier of the tag","type":"integer"},"name":{"description":"The name of the tag","type":"string"},"color":{"description":"The color of the tag in hex format","type":"string"},"tag_group_id":{"description":"The ID of the tag group this tag belongs to, if any","nullable":true,"type":"integer"}},"required":["color","name","pk"],"type":"object"}}}}
```

## The UpdateCompany object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"UpdateCompany":{"properties":{"name":{"description":"Only updatable by the creator of the company, and if the company hasn't subscribed to Dashdoc","type":"string"},"phone_number":{"description":"Only updatable by the creator of the company, and if the company hasn't subscribed to Dashdoc","type":"string"},"email":{"description":"Only updatable by the creator of the company, and if the company hasn't subscribed to Dashdoc","format":"email","type":"string"},"siren":{"description":"Only updatable by the creator of the company, and if the company hasn't subscribed to Dashdoc","type":"string"},"trade_number":{"description":"Only updatable by the creator of the company, and if the company hasn't subscribed to Dashdoc","type":"string"},"vat_number":{"description":"Only updatable by the creator of the company, and if the company hasn't subscribed to Dashdoc","type":"string"},"country":{"$ref":"#/components/schemas/country"},"remote_id":{"description":"The ID of the company in your system. It has to be unique among all your companies.","type":"string"},"invoicing_remote_id":{"description":"The id of the company in your invoicing system.","type":"string"},"notes":{"description":"Notes for this company, only visibile to your team members","type":"string"},"account_code":{"description":"The accounting ledger code (\"compte de tiers\") used for this company when it is a customer/shipper. Send an empty string to clear it.","type":"string"},"side_account_code":{"description":"The auxiliary accounting code used for this company when it is a customer/shipper. Send an empty string to clear it.","type":"string"},"purchase_account_code":{"description":"The accounting ledger code (\"compte de tiers\") used for this company when it is a supplier/carrier. Send an empty string to clear it.","type":"string"},"purchase_side_account_code":{"description":"The auxiliary accounting code used for this company when it is a supplier/carrier. Send an empty string to clear it.","type":"string"},"primary_address":{"$ref":"#/components/schemas/PrimaryAddress"},"tags":{"description":"List of tags applied to the company.","items":{"$ref":"#/components/schemas/Tag"},"type":"array"}},"required":["country","name"],"type":"object"},"country":{"description":"Only the 2-character codification is accepted (ISO 3166-1 alpha-2)","type":"string"},"PrimaryAddress":{"properties":{"pk":{"type":"string"},"name":{"maxLength":200,"type":"string"},"address":{"maxLength":200,"type":"string"},"city":{"maxLength":100,"type":"string"},"postcode":{"maxLength":100,"type":"string"},"country":{"$ref":"#/components/schemas/country"},"latitude":{"$ref":"#/components/schemas/latitude"},"longitude":{"$ref":"#/components/schemas/longitude"},"radius":{"default":500,"description":"Radius around the GPS coordinates within which the address is located (in meters)","type":"integer"},"coords_validated":{"default":false,"description":"if `true`, when this address is used as a loading or unloading site, the mobile app displays an itinerary button to start GPS app with guidance to these coordinates","type":"boolean"},"is_demo":{"$ref":"#/components/schemas/is_demo"},"is_carrier":{"description":"Whether this company is considered a carrier.","type":"boolean"},"is_shipper":{"description":"Whether this company is considered a shipper.","type":"boolean"},"is_origin":{"description":"Legacy, not relevant for a company's primary address.","type":"boolean"},"is_destination":{"description":"Legacy, not relevant for a company's primary address.","type":"boolean"},"created_by":{"type":"number"},"created":{"description":"Date of creation on our server","format":"date-time","type":"string"},"instructions":{"type":"string"},"remote_id":{"description":"The id of the address in your system.","type":"string"}},"type":"object"},"latitude":{"description":"Latitude using the decimal GPS coordinates (WGS84). At 7 decimals, the position is accurate around the centimeter.","format":"float","nullable":true,"type":"number"},"longitude":{"description":"Longitude using the decimal GPS coordinates (WGS84). At 7 decimals, the position is accurate around the centimeter.","format":"float","nullable":true,"type":"number"},"is_demo":{"description":"Indicates that the address is a fake one created from demonstration. Everything linked to it will be deleted when using the 'Delete demo content' button in company parameters","type":"boolean"},"Tag":{"properties":{"pk":{"description":"The unique identifier of the tag","type":"integer"},"name":{"description":"The name of the tag","type":"string"},"color":{"description":"The color of the tag in hex format","type":"string"},"tag_group_id":{"description":"The ID of the tag group this tag belongs to, if any","nullable":true,"type":"integer"}},"required":["color","name","pk"],"type":"object"}}}}
```

## The Contacts object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"Contacts":{"properties":{"count":{"type":"integer"},"next":{"nullable":true,"type":"string"},"previous":{"nullable":true,"type":"string"},"results":{"items":{"$ref":"#/components/schemas/Contact"},"type":"array"}},"type":"object"},"Contact":{"properties":{"uid":{"format":"uuid","type":"string"},"created":{"$ref":"#/components/schemas/created"},"company":{"$ref":"#/components/schemas/Company"},"first_name":{"type":"string"},"last_name":{"type":"string"},"email":{"format":"email","type":"string"},"phone_number":{"type":"string"},"fax_number":{"type":"string"},"remote_id":{"description":"The id of the contact in your system","type":"string"},"is_manager":{"description":"Ignore. Dashdoc technical data.","type":"boolean"},"has_pending_invite":{"description":"Ignore. Dashdoc technical data.","type":"boolean"},"is_invitable":{"description":"Ignore. Dashdoc technical data.","type":"boolean"},"invitation_link":{"format":"url","nullable":true,"type":"string"}},"type":"object"},"created":{"description":"Date of creation on our server","format":"date-time","type":"string"},"Company":{"properties":{"pk":{"description":"Dashdoc's internal id.","type":"number"},"remote_id":{"type":"string"},"created":{"format":"date-time","type":"object"},"updated":{"format":"date-time","type":"string"},"deleted":{"type":"boolean"},"invoicing_remote_id":{"description":"The id of the company in your invoicing system.","type":"string"},"name":{"type":"string"},"phone_number":{"type":"string"},"email":{"type":"string"},"siren":{"type":"string"},"trade_number":{"type":"string"},"country":{"$ref":"#/components/schemas/country"},"comments":{"type":"string"},"vat_number":{"type":"string"},"is_verified":{"type":"boolean"},"settings_transport_order_observations":{"type":"string"},"settings_constrain_reference_edition":{"type":"boolean"},"account_type":{"description":"Ignore. Dashdoc technical data.","type":"string"},"logo":{"description":"The URL of your logo","nullable":true,"type":"string"},"subscription_access":{"type":"object"},"settings":{"type":"object"},"primary_address":{"$ref":"#/components/schemas/PrimaryAddress_1"},"managers":{"items":{"$ref":"#/components/schemas/Managers"},"type":"array"},"has_loggable_managers":{"description":"Ignore. Dashdoc technical data.","type":"boolean"}},"type":"object"},"country":{"description":"Only the 2-character codification is accepted (ISO 3166-1 alpha-2)","type":"string"},"PrimaryAddress_1":{"properties":{"pk":{"description":"Dashdoc's internal id.","type":"number"},"name":{"type":"string"},"address":{"type":"string"},"city":{"type":"string"},"postcode":{"type":"string"},"country":{"$ref":"#/components/schemas/country"},"latitude":{"$ref":"#/components/schemas/latitude"},"longitude":{"$ref":"#/components/schemas/longitude"},"radius":{"default":500,"description":"Radius around the GPS coordinates within which the address is located (in meters)","type":"integer"},"coords_validated":{"default":false,"description":"if `true`, when this address is used as a loading or unloading site, the mobile app displays an itinerary button to start GPS app with guidance to these coordinates","type":"boolean"},"is_demo":{"$ref":"#/components/schemas/is_demo"},"is_carrier":{"description":"Whether this company is considered a carrier","type":"boolean"},"is_shipper":{"description":"Whether this company is considered a shipper","type":"boolean"},"is_origin":{"description":"Legacy, not relevant for a company's primary address. Consider creating a separate address associated with this partner instead.\n","type":"boolean"},"is_destination":{"description":"Legacy, not relevant for a company's primary address. Consider creating a separate address associated with this partner instead.\n","type":"boolean"},"created_by":{"$ref":"#/components/schemas/created-by"},"created_by_user":{"$ref":"#/components/schemas/created-by-user"},"created":{"$ref":"#/components/schemas/created"},"remote_id":{"description":"The id of the address in your system.","type":"string"}},"type":"object"},"latitude":{"description":"Latitude using the decimal GPS coordinates (WGS84). At 7 decimals, the position is accurate around the centimeter.","format":"float","nullable":true,"type":"number"},"longitude":{"description":"Longitude using the decimal GPS coordinates (WGS84). At 7 decimals, the position is accurate around the centimeter.","format":"float","nullable":true,"type":"number"},"is_demo":{"description":"Indicates that the address is a fake one created from demonstration. Everything linked to it will be deleted when using the 'Delete demo content' button in company parameters","type":"boolean"},"created-by":{"nullable":true,"properties":{"pk":{"description":"company id","type":"number"},"name":{"description":"name of the company","type":"string"}},"type":"object"},"created-by-user":{"nullable":true,"properties":{"pk":{"type":"number"},"display_name":{"type":"string"},"company":{"description":"The company id who created the address","type":"number"},"trucker_id":{"description":"The trucker id who created the address","type":"number"}},"type":"object"},"Managers":{"properties":{"pk":{"description":"Dashdoc's internal id.","type":"number"},"user":{"$ref":"#/components/schemas/Managers_user"},"display_name":{"type":"string"},"role":{"type":"string"}},"type":"object"},"Managers_user":{"properties":{"email":{"format":"email","type":"string"},"first_name":{"type":"string"},"last_name":{"type":"string"}},"type":"object"}}}}
```

## The NewContact object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"NewContact":{"properties":{"uid":{"format":"uuid","type":"string"},"created":{"description":"Date of creation on our server","format":"date-time","readOnly":true,"type":"string"},"company":{"$ref":"#/components/schemas/CompanyIdentification"},"first_name":{"maxLength":200,"type":"string"},"last_name":{"maxLength":200,"type":"string"},"email":{"format":"email","type":"string"},"phone_number":{"maxLength":100,"type":"string"},"fax_number":{"maxLength":100,"type":"string"},"remote_id":{"description":"The id of the contact in your system","type":"string"}},"required":["company","last_name"],"type":"object"},"CompanyIdentification":{"description":"Identification of the company. The company must already exist in Dashdoc.","properties":{"pk":{"description":"Dashdoc's internal id. Optional, not required if `remote_id` is sent.","type":"integer"},"remote_id":{"description":"Your remote carrier id. Optional, ignored if `pk` is sent.","type":"string"},"name":{"type":"string"},"trade_number":{"type":"string"},"country":{"$ref":"#/components/schemas/country"},"settings_contract_html":{"description":"Ignore. Dashdoc technical data.","type":"string"},"settings_logo":{"description":"Ignore. Dashdoc technical data.","nullable":true,"type":"string"},"settings_stamp":{"description":"Ignore. Dashdoc technical data.","nullable":true,"type":"string"},"settings_print_mode":{"description":"Ignore. Dashdoc technical data.","type":"boolean"},"settings_special_agreements":{"description":"Ignore. Dashdoc technical data.","type":"string"},"settings_transport_order_observations":{"type":"string"},"settings_constrain_reference_edition":{"type":"boolean"},"vat_number":{"type":"string"},"is_verified":{"description":"Ignore. Dashdoc technical data.","type":"string"}},"type":"object"},"country":{"description":"Only the 2-character codification is accepted (ISO 3166-1 alpha-2)","type":"string"}}}}
```

## The Contact object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"Contact":{"properties":{"uid":{"format":"uuid","type":"string"},"created":{"$ref":"#/components/schemas/created"},"company":{"$ref":"#/components/schemas/Company"},"first_name":{"type":"string"},"last_name":{"type":"string"},"email":{"format":"email","type":"string"},"phone_number":{"type":"string"},"fax_number":{"type":"string"},"remote_id":{"description":"The id of the contact in your system","type":"string"},"is_manager":{"description":"Ignore. Dashdoc technical data.","type":"boolean"},"has_pending_invite":{"description":"Ignore. Dashdoc technical data.","type":"boolean"},"is_invitable":{"description":"Ignore. Dashdoc technical data.","type":"boolean"},"invitation_link":{"format":"url","nullable":true,"type":"string"}},"type":"object"},"created":{"description":"Date of creation on our server","format":"date-time","type":"string"},"Company":{"properties":{"pk":{"description":"Dashdoc's internal id.","type":"number"},"remote_id":{"type":"string"},"created":{"format":"date-time","type":"object"},"updated":{"format":"date-time","type":"string"},"deleted":{"type":"boolean"},"invoicing_remote_id":{"description":"The id of the company in your invoicing system.","type":"string"},"name":{"type":"string"},"phone_number":{"type":"string"},"email":{"type":"string"},"siren":{"type":"string"},"trade_number":{"type":"string"},"country":{"$ref":"#/components/schemas/country"},"comments":{"type":"string"},"vat_number":{"type":"string"},"is_verified":{"type":"boolean"},"settings_transport_order_observations":{"type":"string"},"settings_constrain_reference_edition":{"type":"boolean"},"account_type":{"description":"Ignore. Dashdoc technical data.","type":"string"},"logo":{"description":"The URL of your logo","nullable":true,"type":"string"},"subscription_access":{"type":"object"},"settings":{"type":"object"},"primary_address":{"$ref":"#/components/schemas/PrimaryAddress_1"},"managers":{"items":{"$ref":"#/components/schemas/Managers"},"type":"array"},"has_loggable_managers":{"description":"Ignore. Dashdoc technical data.","type":"boolean"}},"type":"object"},"country":{"description":"Only the 2-character codification is accepted (ISO 3166-1 alpha-2)","type":"string"},"PrimaryAddress_1":{"properties":{"pk":{"description":"Dashdoc's internal id.","type":"number"},"name":{"type":"string"},"address":{"type":"string"},"city":{"type":"string"},"postcode":{"type":"string"},"country":{"$ref":"#/components/schemas/country"},"latitude":{"$ref":"#/components/schemas/latitude"},"longitude":{"$ref":"#/components/schemas/longitude"},"radius":{"default":500,"description":"Radius around the GPS coordinates within which the address is located (in meters)","type":"integer"},"coords_validated":{"default":false,"description":"if `true`, when this address is used as a loading or unloading site, the mobile app displays an itinerary button to start GPS app with guidance to these coordinates","type":"boolean"},"is_demo":{"$ref":"#/components/schemas/is_demo"},"is_carrier":{"description":"Whether this company is considered a carrier","type":"boolean"},"is_shipper":{"description":"Whether this company is considered a shipper","type":"boolean"},"is_origin":{"description":"Legacy, not relevant for a company's primary address. Consider creating a separate address associated with this partner instead.\n","type":"boolean"},"is_destination":{"description":"Legacy, not relevant for a company's primary address. Consider creating a separate address associated with this partner instead.\n","type":"boolean"},"created_by":{"$ref":"#/components/schemas/created-by"},"created_by_user":{"$ref":"#/components/schemas/created-by-user"},"created":{"$ref":"#/components/schemas/created"},"remote_id":{"description":"The id of the address in your system.","type":"string"}},"type":"object"},"latitude":{"description":"Latitude using the decimal GPS coordinates (WGS84). At 7 decimals, the position is accurate around the centimeter.","format":"float","nullable":true,"type":"number"},"longitude":{"description":"Longitude using the decimal GPS coordinates (WGS84). At 7 decimals, the position is accurate around the centimeter.","format":"float","nullable":true,"type":"number"},"is_demo":{"description":"Indicates that the address is a fake one created from demonstration. Everything linked to it will be deleted when using the 'Delete demo content' button in company parameters","type":"boolean"},"created-by":{"nullable":true,"properties":{"pk":{"description":"company id","type":"number"},"name":{"description":"name of the company","type":"string"}},"type":"object"},"created-by-user":{"nullable":true,"properties":{"pk":{"type":"number"},"display_name":{"type":"string"},"company":{"description":"The company id who created the address","type":"number"},"trucker_id":{"description":"The trucker id who created the address","type":"number"}},"type":"object"},"Managers":{"properties":{"pk":{"description":"Dashdoc's internal id.","type":"number"},"user":{"$ref":"#/components/schemas/Managers_user"},"display_name":{"type":"string"},"role":{"type":"string"}},"type":"object"},"Managers_user":{"properties":{"email":{"format":"email","type":"string"},"first_name":{"type":"string"},"last_name":{"type":"string"}},"type":"object"}}}}
```

## The UpdateContact object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"UpdateContact":{"properties":{"company":{"$ref":"#/components/schemas/CompanyIdentification"},"first_name":{"maxLength":200,"type":"string"},"last_name":{"maxLength":200,"type":"string"},"email":{"format":"email","type":"string"},"phone_number":{"maxLength":100,"type":"string"},"fax_number":{"maxLength":100,"type":"string"}},"type":"object"},"CompanyIdentification":{"description":"Identification of the company. The company must already exist in Dashdoc.","properties":{"pk":{"description":"Dashdoc's internal id. Optional, not required if `remote_id` is sent.","type":"integer"},"remote_id":{"description":"Your remote carrier id. Optional, ignored if `pk` is sent.","type":"string"},"name":{"type":"string"},"trade_number":{"type":"string"},"country":{"$ref":"#/components/schemas/country"},"settings_contract_html":{"description":"Ignore. Dashdoc technical data.","type":"string"},"settings_logo":{"description":"Ignore. Dashdoc technical data.","nullable":true,"type":"string"},"settings_stamp":{"description":"Ignore. Dashdoc technical data.","nullable":true,"type":"string"},"settings_print_mode":{"description":"Ignore. Dashdoc technical data.","type":"boolean"},"settings_special_agreements":{"description":"Ignore. Dashdoc technical data.","type":"string"},"settings_transport_order_observations":{"type":"string"},"settings_constrain_reference_edition":{"type":"boolean"},"vat_number":{"type":"string"},"is_verified":{"description":"Ignore. Dashdoc technical data.","type":"string"}},"type":"object"},"country":{"description":"Only the 2-character codification is accepted (ISO 3166-1 alpha-2)","type":"string"}}}}
```

## The DashdocInvoiceItems object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"DashdocInvoiceItems":{"properties":{"count":{"description":"Total number of items matching the filters.","minimum":0,"type":"integer"},"next":{"description":"URL of the next page, or null on the last page.","format":"uri","nullable":true,"type":"string"},"previous":{"description":"URL of the previous page, or null on the first page.","format":"uri","nullable":true,"type":"string"},"results":{"items":{"$ref":"#/components/schemas/DashdocInvoiceItem"},"type":"array"}},"required":["count","next","previous","results"],"type":"object"},"DashdocInvoiceItem":{"properties":{"uid":{"format":"uuid","type":"string"},"description":{"description":"Name of the invoice item in the catalogue.","type":"string"},"line_description":{"description":"Default description when this item is used on a price or invoice line.","type":"string"},"account_code":{"description":"Accounting code associated with the invoice item.","type":"string"},"enabled":{"description":"Whether this catalogue item is enabled.","type":"boolean"},"tax_code":{"$ref":"#/components/schemas/DashdocInvoiceItem_tax_code"}},"required":["account_code","description","enabled","line_description","tax_code","uid"],"type":"object"},"DashdocInvoiceItem_tax_code":{"properties":{"dashdoc_id":{"description":"Dashdoc identifier of the tax code.","type":"string"},"tax_rate":{"description":"Tax rate as a percentage, encoded as a decimal string.","format":"decimal","type":"string"},"tax_type":{"description":"Type of tax, resolved for the authenticated company's country.","enum":["IGIC","IRPF","RETENTION","TPS","TVH","TVQ","VAT"],"type":"string"}},"required":["dashdoc_id","tax_rate","tax_type"],"type":"object"}}}}
```

## The Deliveries object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"Deliveries":{"properties":{"count":{"type":"integer"},"next":{"nullable":true,"type":"string"},"previous":{"nullable":true,"type":"string"},"results":{"items":{"$ref":"#/components/schemas/Delivery"},"type":"array"}},"type":"object"},"Delivery":{"properties":{"uid":{"description":"Dashdoc's internal id.","type":"string"},"sequential_id":{"description":"eCMR number","type":"number"},"remote_id":{"type":"string"},"tracking_id":{"description":"Deprecated","type":"string"},"origin":{"$ref":"#/components/schemas/CreateOrUpdateSite"},"destination":{"$ref":"#/components/schemas/CreateOrUpdateSite"},"shipper_address":{"$ref":"#/components/schemas/NewAddressReduced"},"planned_loads":{"description":"Loads as planned before the transport has been started","items":{"$ref":"#/components/schemas/DeliveryLoads"},"type":"array"},"loads":{"description":"Loads as they are most recently defined. This means it is: \n\n* equal to `planned_loads` before loading is actually done \n\n* equal to `origin_loads` after loading is done (with details validated by trucker), but unloading is not done yet \n\n* equal to `loads_loads` after unloading is actually done (with details validated by trucker)","items":{"$ref":"#/components/schemas/DeliveryLoads"},"type":"array"},"origin_loads":{"description":"Loads as validated by trucker right after loading is done","items":{"$ref":"#/components/schemas/DeliveryLoads"},"type":"array"},"destination_loads":{"description":"Loads as validated by trucker right after unloading is done","items":{"$ref":"#/components/schemas/DeliveryLoads"},"type":"array"},"tracking_contacts":{"description":"List of contacts that will automatically receive an email when delivery is done. ⚠️ If no tracking contacts are provided for a company and the setting `partner_email_fallback` is enabled, a tracking contact corresponding to the company's email will be added, at the creation of the transport. This only applies to the carrier and the shipper.","items":{"$ref":"#/components/schemas/Delivery_tracking_contacts"},"type":"array"},"shipper_reference":{"description":"Reference the client may use to match transport on his own system, e.g. an order number. The transport's creator can toggle a setting to only allow himself to set it.","type":"string"},"multiple_rounds":{"description":"If true, the trucker will be able to do a signature at loading, then add any amount of rounds for the transport (with weight/volume and weight ticket), and finish with a signature at unloading.","type":"boolean"}},"type":"object"},"CreateOrUpdateSite":{"properties":{"uid":{"format":"uuid","type":"string"},"remote_id":{"description":"The id of the site in your system","type":"string"},"address":{"allOf":[{"$ref":"#/components/schemas/SiteAddress"}],"nullable":true},"real_start":{"description":"date and time when trucker arrived on site","format":"date-time","readOnly":true,"type":"string"},"real_end":{"description":"date and time when trucker completed loading / unloading (depending whether site is origin or destination)","format":"date-time","readOnly":true,"type":"string"},"signature_process":{"type":"string"},"is_booking_needed":{"type":"boolean"},"instructions":{"$ref":"#/components/schemas/site_instructions"},"reference":{"type":"string"},"action":{"deprecated":true,"description":"Deprecated. Accepted for backward compatibility but ignored. Responses always return an empty string.","type":"string"},"eta":{"format":"date-time","nullable":true,"type":"string"},"eta_tracking":{"type":"boolean"},"punctuality_status":{"readOnly":true,"type":"string"},"supports_exchanges":{"$ref":"#/components/schemas/SupportsExchange"},"category":{"type":"string"},"slots":{"items":{"$ref":"#/components/schemas/Site_slots"},"type":"array"},"trucker_instructions":{"$ref":"#/components/schemas/trucker_instructions"},"trip":{"$ref":"#/components/schemas/Site_trip"}},"type":"object"},"SiteAddress":{"description":"Address of the site. Reference an existing address with its `pk` or `remote_id`, or send its details to have it matched or created.","properties":{"pk":{"description":"Dashdoc's internal id. Optional, set it to reference an existing address.","type":"integer"},"name":{"type":"string"},"address":{"type":"string"},"city":{"type":"string"},"postcode":{"type":"string"},"country":{"$ref":"#/components/schemas/country"},"latitude":{"$ref":"#/components/schemas/latitude"},"longitude":{"$ref":"#/components/schemas/longitude"},"radius":{"default":500,"description":"Radius around the GPS coordinates within which the address is located (in meters)","type":"integer"},"coords_validated":{"default":false,"description":"if `true`, when this address is used as a loading or unloading site, the mobile app displays an itinerary button to start GPS app with guidance to these coordinates","type":"boolean"},"is_demo":{"$ref":"#/components/schemas/is_demo"},"is_carrier":{"type":"boolean"},"is_shipper":{"type":"boolean"},"is_origin":{"$ref":"#/components/schemas/address_is_origin_and_is_destination"},"is_destination":{"$ref":"#/components/schemas/address_is_origin_and_is_destination"},"instructions":{"$ref":"#/components/schemas/site_instructions"},"remote_id":{"description":"The id of the address in your system.","type":"string"},"company":{"$ref":"#/components/schemas/CompanyForTransportAddress_1"}},"type":"object"},"country":{"description":"Only the 2-character codification is accepted (ISO 3166-1 alpha-2)","type":"string"},"latitude":{"description":"Latitude using the decimal GPS coordinates (WGS84). At 7 decimals, the position is accurate around the centimeter.","format":"float","nullable":true,"type":"number"},"longitude":{"description":"Longitude using the decimal GPS coordinates (WGS84). At 7 decimals, the position is accurate around the centimeter.","format":"float","nullable":true,"type":"number"},"is_demo":{"description":"Indicates that the address is a fake one created from demonstration. Everything linked to it will be deleted when using the 'Delete demo content' button in company parameters","type":"boolean"},"address_is_origin_and_is_destination":{"description":"Whether this address is a \"Logistic Points\" and will be usable as pickup/delivery point.\nThe distinction between origin/pickup and destination/delivery was merged as a single \"Logistic Point\" concept. `is_origin` implies `is_destination` and vice-versa.\n","type":"boolean"},"site_instructions":{"description":"Site instructions, visible to all parties (trucker, carrier, shipper, site). Displayed in the trucker mobile app. Not visible in the eCMR. If the field is not provided, the address's site instructions will be used.","maxLength":1000,"type":"string"},"CompanyForTransportAddress_1":{"description":"Identification of the company. You may simply use its `pk` or `remote_id` if the company already exists. Other possible identification method are its `trade_number` or `name`. If it doesn't exist, the company will be created with the information you send based on what's possible when creating a company via /companies/ web service. Minimum required information in this case is a name.","properties":{"pk":{"description":"Dashdoc's internal id.Optional, not required if `remote_id` is sent.","type":"integer"},"remote_id":{"description":"The id of the company in your system. Optional, ignored if `pk` is sent.","type":"string"},"trade_number":{"maxLength":100,"type":"string"},"name":{"maxLength":200,"type":"string"}},"type":"object"},"SupportsExchange":{"properties":{"uid":{"description":"uid of the support exchange","format":"uuid","type":"string"},"site":{"$ref":"#/components/schemas/SupportsExchange_site"},"support_type":{"$ref":"#/components/schemas/SupportType"},"expected_retrieved":{"description":"Expected number of supports that should be retrieved on the site","type":"number"},"actual_retrieved":{"description":"Actual number of supports that were retrieved on the site","type":"number"},"expected_delivered":{"description":"Expected number of supports that should be delivered on the site","type":"number"},"actual_delivered":{"description":"Actual number of supports that were delivered on the site","type":"number"},"observations":{"description":"Free text. Observations about this supports exchange. Can be filled on mobile app, web app or via API.","type":"string"},"remote_id":{"description":"The ID of the support in your system","type":"string"}},"type":"object"},"SupportsExchange_site":{"description":"site where supports exchange is expected","properties":{"uid":{"description":"uid of the site","format":"uuid","type":"string"},"remote_id":{"description":"remote_id of the site","type":"string"}},"type":"object"},"SupportType":{"description":"Type of the supports that are exchanged","properties":{"name":{"description":"Display name of the support type","type":"string"},"created":{"$ref":"#/components/schemas/created"},"uid":{"format":"uuid","type":"string"},"remote_id":{"description":"The id of the support type in your system.","type":"string"}},"type":"object"},"created":{"description":"Date of creation on our server","format":"date-time","type":"string"},"Site_slots":{"properties":{"start":{"format":"date-time","type":"string"},"end":{"format":"date-time","type":"string"}},"type":"object"},"trucker_instructions":{"description":"**This field is part of a beta feature.** Private instructions. **The carrier of the transport is the only one who can edit and read those instructions.** Note that those instructions are not visible in the consignment note and can be accessed by the trucker. The value is null if the caller doesn't have the right of access to the data.","maxLength":1000,"type":"string"},"Site_trip":{"description":"Trip linked to this site/activity.","nullable":true,"properties":{"uid":{"format":"uuid","type":"string"},"name":{"type":"string"},"is_prepared":{"type":"boolean"},"status":{"enum":["unstarted","ongoing","done"],"type":"string"}},"readOnly":true,"type":"object"},"NewAddressReduced":{"properties":{"pk":{"description":"Dashdoc's internal id. Optional, set it to reference an existing address.","type":"integer"},"name":{"type":"string"},"address":{"type":"string"},"city":{"type":"string"},"postcode":{"type":"string"},"country":{"$ref":"#/components/schemas/country"},"latitude":{"$ref":"#/components/schemas/latitude"},"longitude":{"$ref":"#/components/schemas/longitude"},"radius":{"default":500,"description":"Radius around the GPS coordinates within which the address is located (in meters)","type":"integer"},"coords_validated":{"default":false,"description":"if `true`, when this address is used as a loading or unloading site, the mobile app displays an itinerary button to start GPS app with guidance to these coordinates","type":"boolean"},"is_demo":{"$ref":"#/components/schemas/is_demo"},"is_carrier":{"type":"boolean"},"is_shipper":{"type":"boolean"},"is_origin":{"type":"boolean"},"is_destination":{"type":"boolean"},"created_by":{"description":"Ignore. Dashdoc technical data.","readOnly":true,"type":"number"},"created":{"description":"Date of creation on our server","format":"date-time","readOnly":true,"type":"string"},"instructions":{"type":"string"},"remote_id":{"description":"The id of the address in your system.","type":"string"},"company":{"$ref":"#/components/schemas/CompanyForTransportAddress"},"original":{"description":"Ignore. Dashdoc technical data.","nullable":true,"readOnly":true,"type":"number"}},"required":["address","city","company","country","postcode"],"type":"object"},"CompanyForTransportAddress":{"properties":{"pk":{"description":"Dashdoc's internal id.","type":"number"},"remote_id":{"description":"The id of the company in your system.","type":"string"},"name":{"type":"string"},"trade_number":{"type":"string"},"country":{"$ref":"#/components/schemas/country"},"settings_contract_html":{"description":"Ignore. Dashdoc technical data.","type":"string"},"settings_logo":{"description":"Ignore. Dashdoc technical data.","nullable":true,"type":"string"},"settings_stamp":{"description":"Ignore. Dashdoc technical data.","nullable":true,"type":"string"},"settings_print_mode":{"description":"Ignore. Dashdoc technical data.","type":"boolean"},"settings_special_agreements":{"description":"Ignore. Dashdoc technical data.","type":"string"},"settings_transport_order_observations":{"type":"string"},"settings_constrain_reference_edition":{"type":"boolean"},"vat_number":{"type":"string"},"is_verified":{"type":"boolean"}},"type":"object"},"DeliveryLoads":{"properties":{"uid":{"description":"Dashdoc's internal id.","type":"string"},"remote_id":{"description":"The ID of the load in your system. It has to be unique among all your transports.","type":"string"},"description":{"description":"Text description of the load","type":"string"},"reference":{"description":"Reference of the load","type":"string"},"round_id":{"description":"The ID of the round.","format":"integer","type":"number"},"weight":{"description":"In kilograms","format":"float","type":"number"},"volume":{"description":"Volume of load in m3","format":"float","type":"number"},"volume_display_unit":{"default":"m3","enum":["m3","L"],"type":"string"},"linear_meters":{"description":"Length of load in meters","format":"float","type":"number"},"quantity":{"description":"Only one decimal accepted (e.g 0.0)","format":"float","type":"number"},"pallet_equivalence":{"description":"Pallet equivalence (EPS/EQPAL): how many standard pallet spaces the load occupies. `null` when it was never set. Otherwise at least `0.01`, with two decimals kept.","format":"float","nullable":true,"type":"number"},"category":{"description":"Packaging of the load. The text is free but these specific values cause a custom flow on the mobile app: `pallets`, `containers`, `bulk`, `roundwood`, `powder_tank`, `bulk_qualimat`, `rental`.","type":"string"},"dangerous_goods_category":{"description":"ADR class","enum":["1","2","3","4.1","4.2","4.3","5.1","5.2","6.1","6.2","7","8","9"],"type":"string"},"is_dangerous":{"type":"boolean"},"adr_un_code":{"type":"string"},"legal_mentions":{"type":"string"},"complementary_information":{"description":"Any information about the load that doesn't fit to the description field","type":"string"},"container_number":{"type":"string"},"tare_weight":{"description":"In kilograms","format":"float","type":"number"},"container_seal_number":{"type":"string"},"refrigerated":{"description":"Indicates whether the load is refrigerated. If true, the trucker can fill in the temperature.","type":"boolean"},"temperature":{"type":"string"},"steres":{"format":"float","type":"number"},"idtf_number":{"description":"Must match an existing IDTF number","type":"string"},"use_identifiers":{"description":"if `true`, trucker is asked to scan barcode identifiers on load","type":"boolean"},"identifiers":{"description":"Only relevant if use_identifiers is set to `true`. List of expected barcode identifiers that the trucker should scan at loading and unloading. App controls that expected barcodes are actually scanned. If empty, the trucker will have to scan barcodes anyway, but there won't be any check. Feature has to be activated in your account by your Dashdoc projet manager.","items":{"type":"string"},"type":"array"},"identifiers_observations":{"description":"Observations explaining issues with identifier, such as missing or unexpected identifiers","type":"string"}},"type":"object"},"Delivery_tracking_contacts":{"properties":{"uid":{"description":"Dashdoc's internal id.","type":"string"},"contact":{"$ref":"#/components/schemas/NewContact"},"subscribed_to_status_updates":{"description":"If set to true, the contact will receive an email at every step of the delivery. Else, they will receive only one email once the delivery is done.","type":"boolean"},"role":{"description":"The role of the contact in the delivery. It can be `carrier`, `shipper`, or `site`.","type":"string"}},"required":["contact"],"type":"object"},"NewContact":{"properties":{"uid":{"format":"uuid","type":"string"},"created":{"description":"Date of creation on our server","format":"date-time","readOnly":true,"type":"string"},"company":{"$ref":"#/components/schemas/CompanyIdentification"},"first_name":{"maxLength":200,"type":"string"},"last_name":{"maxLength":200,"type":"string"},"email":{"format":"email","type":"string"},"phone_number":{"maxLength":100,"type":"string"},"fax_number":{"maxLength":100,"type":"string"},"remote_id":{"description":"The id of the contact in your system","type":"string"}},"required":["company","last_name"],"type":"object"},"CompanyIdentification":{"description":"Identification of the company. The company must already exist in Dashdoc.","properties":{"pk":{"description":"Dashdoc's internal id. Optional, not required if `remote_id` is sent.","type":"integer"},"remote_id":{"description":"Your remote carrier id. Optional, ignored if `pk` is sent.","type":"string"},"name":{"type":"string"},"trade_number":{"type":"string"},"country":{"$ref":"#/components/schemas/country"},"settings_contract_html":{"description":"Ignore. Dashdoc technical data.","type":"string"},"settings_logo":{"description":"Ignore. Dashdoc technical data.","nullable":true,"type":"string"},"settings_stamp":{"description":"Ignore. Dashdoc technical data.","nullable":true,"type":"string"},"settings_print_mode":{"description":"Ignore. Dashdoc technical data.","type":"boolean"},"settings_special_agreements":{"description":"Ignore. Dashdoc technical data.","type":"string"},"settings_transport_order_observations":{"type":"string"},"settings_constrain_reference_edition":{"type":"boolean"},"vat_number":{"type":"string"},"is_verified":{"description":"Ignore. Dashdoc technical data.","type":"string"}},"type":"object"}}}}
```

## The Delivery object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"Delivery":{"properties":{"uid":{"description":"Dashdoc's internal id.","type":"string"},"sequential_id":{"description":"eCMR number","type":"number"},"remote_id":{"type":"string"},"tracking_id":{"description":"Deprecated","type":"string"},"origin":{"$ref":"#/components/schemas/CreateOrUpdateSite"},"destination":{"$ref":"#/components/schemas/CreateOrUpdateSite"},"shipper_address":{"$ref":"#/components/schemas/NewAddressReduced"},"planned_loads":{"description":"Loads as planned before the transport has been started","items":{"$ref":"#/components/schemas/DeliveryLoads"},"type":"array"},"loads":{"description":"Loads as they are most recently defined. This means it is: \n\n* equal to `planned_loads` before loading is actually done \n\n* equal to `origin_loads` after loading is done (with details validated by trucker), but unloading is not done yet \n\n* equal to `loads_loads` after unloading is actually done (with details validated by trucker)","items":{"$ref":"#/components/schemas/DeliveryLoads"},"type":"array"},"origin_loads":{"description":"Loads as validated by trucker right after loading is done","items":{"$ref":"#/components/schemas/DeliveryLoads"},"type":"array"},"destination_loads":{"description":"Loads as validated by trucker right after unloading is done","items":{"$ref":"#/components/schemas/DeliveryLoads"},"type":"array"},"tracking_contacts":{"description":"List of contacts that will automatically receive an email when delivery is done. ⚠️ If no tracking contacts are provided for a company and the setting `partner_email_fallback` is enabled, a tracking contact corresponding to the company's email will be added, at the creation of the transport. This only applies to the carrier and the shipper.","items":{"$ref":"#/components/schemas/Delivery_tracking_contacts"},"type":"array"},"shipper_reference":{"description":"Reference the client may use to match transport on his own system, e.g. an order number. The transport's creator can toggle a setting to only allow himself to set it.","type":"string"},"multiple_rounds":{"description":"If true, the trucker will be able to do a signature at loading, then add any amount of rounds for the transport (with weight/volume and weight ticket), and finish with a signature at unloading.","type":"boolean"}},"type":"object"},"CreateOrUpdateSite":{"properties":{"uid":{"format":"uuid","type":"string"},"remote_id":{"description":"The id of the site in your system","type":"string"},"address":{"allOf":[{"$ref":"#/components/schemas/SiteAddress"}],"nullable":true},"real_start":{"description":"date and time when trucker arrived on site","format":"date-time","readOnly":true,"type":"string"},"real_end":{"description":"date and time when trucker completed loading / unloading (depending whether site is origin or destination)","format":"date-time","readOnly":true,"type":"string"},"signature_process":{"type":"string"},"is_booking_needed":{"type":"boolean"},"instructions":{"$ref":"#/components/schemas/site_instructions"},"reference":{"type":"string"},"action":{"deprecated":true,"description":"Deprecated. Accepted for backward compatibility but ignored. Responses always return an empty string.","type":"string"},"eta":{"format":"date-time","nullable":true,"type":"string"},"eta_tracking":{"type":"boolean"},"punctuality_status":{"readOnly":true,"type":"string"},"supports_exchanges":{"$ref":"#/components/schemas/SupportsExchange"},"category":{"type":"string"},"slots":{"items":{"$ref":"#/components/schemas/Site_slots"},"type":"array"},"trucker_instructions":{"$ref":"#/components/schemas/trucker_instructions"},"trip":{"$ref":"#/components/schemas/Site_trip"}},"type":"object"},"SiteAddress":{"description":"Address of the site. Reference an existing address with its `pk` or `remote_id`, or send its details to have it matched or created.","properties":{"pk":{"description":"Dashdoc's internal id. Optional, set it to reference an existing address.","type":"integer"},"name":{"type":"string"},"address":{"type":"string"},"city":{"type":"string"},"postcode":{"type":"string"},"country":{"$ref":"#/components/schemas/country"},"latitude":{"$ref":"#/components/schemas/latitude"},"longitude":{"$ref":"#/components/schemas/longitude"},"radius":{"default":500,"description":"Radius around the GPS coordinates within which the address is located (in meters)","type":"integer"},"coords_validated":{"default":false,"description":"if `true`, when this address is used as a loading or unloading site, the mobile app displays an itinerary button to start GPS app with guidance to these coordinates","type":"boolean"},"is_demo":{"$ref":"#/components/schemas/is_demo"},"is_carrier":{"type":"boolean"},"is_shipper":{"type":"boolean"},"is_origin":{"$ref":"#/components/schemas/address_is_origin_and_is_destination"},"is_destination":{"$ref":"#/components/schemas/address_is_origin_and_is_destination"},"instructions":{"$ref":"#/components/schemas/site_instructions"},"remote_id":{"description":"The id of the address in your system.","type":"string"},"company":{"$ref":"#/components/schemas/CompanyForTransportAddress_1"}},"type":"object"},"country":{"description":"Only the 2-character codification is accepted (ISO 3166-1 alpha-2)","type":"string"},"latitude":{"description":"Latitude using the decimal GPS coordinates (WGS84). At 7 decimals, the position is accurate around the centimeter.","format":"float","nullable":true,"type":"number"},"longitude":{"description":"Longitude using the decimal GPS coordinates (WGS84). At 7 decimals, the position is accurate around the centimeter.","format":"float","nullable":true,"type":"number"},"is_demo":{"description":"Indicates that the address is a fake one created from demonstration. Everything linked to it will be deleted when using the 'Delete demo content' button in company parameters","type":"boolean"},"address_is_origin_and_is_destination":{"description":"Whether this address is a \"Logistic Points\" and will be usable as pickup/delivery point.\nThe distinction between origin/pickup and destination/delivery was merged as a single \"Logistic Point\" concept. `is_origin` implies `is_destination` and vice-versa.\n","type":"boolean"},"site_instructions":{"description":"Site instructions, visible to all parties (trucker, carrier, shipper, site). Displayed in the trucker mobile app. Not visible in the eCMR. If the field is not provided, the address's site instructions will be used.","maxLength":1000,"type":"string"},"CompanyForTransportAddress_1":{"description":"Identification of the company. You may simply use its `pk` or `remote_id` if the company already exists. Other possible identification method are its `trade_number` or `name`. If it doesn't exist, the company will be created with the information you send based on what's possible when creating a company via /companies/ web service. Minimum required information in this case is a name.","properties":{"pk":{"description":"Dashdoc's internal id.Optional, not required if `remote_id` is sent.","type":"integer"},"remote_id":{"description":"The id of the company in your system. Optional, ignored if `pk` is sent.","type":"string"},"trade_number":{"maxLength":100,"type":"string"},"name":{"maxLength":200,"type":"string"}},"type":"object"},"SupportsExchange":{"properties":{"uid":{"description":"uid of the support exchange","format":"uuid","type":"string"},"site":{"$ref":"#/components/schemas/SupportsExchange_site"},"support_type":{"$ref":"#/components/schemas/SupportType"},"expected_retrieved":{"description":"Expected number of supports that should be retrieved on the site","type":"number"},"actual_retrieved":{"description":"Actual number of supports that were retrieved on the site","type":"number"},"expected_delivered":{"description":"Expected number of supports that should be delivered on the site","type":"number"},"actual_delivered":{"description":"Actual number of supports that were delivered on the site","type":"number"},"observations":{"description":"Free text. Observations about this supports exchange. Can be filled on mobile app, web app or via API.","type":"string"},"remote_id":{"description":"The ID of the support in your system","type":"string"}},"type":"object"},"SupportsExchange_site":{"description":"site where supports exchange is expected","properties":{"uid":{"description":"uid of the site","format":"uuid","type":"string"},"remote_id":{"description":"remote_id of the site","type":"string"}},"type":"object"},"SupportType":{"description":"Type of the supports that are exchanged","properties":{"name":{"description":"Display name of the support type","type":"string"},"created":{"$ref":"#/components/schemas/created"},"uid":{"format":"uuid","type":"string"},"remote_id":{"description":"The id of the support type in your system.","type":"string"}},"type":"object"},"created":{"description":"Date of creation on our server","format":"date-time","type":"string"},"Site_slots":{"properties":{"start":{"format":"date-time","type":"string"},"end":{"format":"date-time","type":"string"}},"type":"object"},"trucker_instructions":{"description":"**This field is part of a beta feature.** Private instructions. **The carrier of the transport is the only one who can edit and read those instructions.** Note that those instructions are not visible in the consignment note and can be accessed by the trucker. The value is null if the caller doesn't have the right of access to the data.","maxLength":1000,"type":"string"},"Site_trip":{"description":"Trip linked to this site/activity.","nullable":true,"properties":{"uid":{"format":"uuid","type":"string"},"name":{"type":"string"},"is_prepared":{"type":"boolean"},"status":{"enum":["unstarted","ongoing","done"],"type":"string"}},"readOnly":true,"type":"object"},"NewAddressReduced":{"properties":{"pk":{"description":"Dashdoc's internal id. Optional, set it to reference an existing address.","type":"integer"},"name":{"type":"string"},"address":{"type":"string"},"city":{"type":"string"},"postcode":{"type":"string"},"country":{"$ref":"#/components/schemas/country"},"latitude":{"$ref":"#/components/schemas/latitude"},"longitude":{"$ref":"#/components/schemas/longitude"},"radius":{"default":500,"description":"Radius around the GPS coordinates within which the address is located (in meters)","type":"integer"},"coords_validated":{"default":false,"description":"if `true`, when this address is used as a loading or unloading site, the mobile app displays an itinerary button to start GPS app with guidance to these coordinates","type":"boolean"},"is_demo":{"$ref":"#/components/schemas/is_demo"},"is_carrier":{"type":"boolean"},"is_shipper":{"type":"boolean"},"is_origin":{"type":"boolean"},"is_destination":{"type":"boolean"},"created_by":{"description":"Ignore. Dashdoc technical data.","readOnly":true,"type":"number"},"created":{"description":"Date of creation on our server","format":"date-time","readOnly":true,"type":"string"},"instructions":{"type":"string"},"remote_id":{"description":"The id of the address in your system.","type":"string"},"company":{"$ref":"#/components/schemas/CompanyForTransportAddress"},"original":{"description":"Ignore. Dashdoc technical data.","nullable":true,"readOnly":true,"type":"number"}},"required":["address","city","company","country","postcode"],"type":"object"},"CompanyForTransportAddress":{"properties":{"pk":{"description":"Dashdoc's internal id.","type":"number"},"remote_id":{"description":"The id of the company in your system.","type":"string"},"name":{"type":"string"},"trade_number":{"type":"string"},"country":{"$ref":"#/components/schemas/country"},"settings_contract_html":{"description":"Ignore. Dashdoc technical data.","type":"string"},"settings_logo":{"description":"Ignore. Dashdoc technical data.","nullable":true,"type":"string"},"settings_stamp":{"description":"Ignore. Dashdoc technical data.","nullable":true,"type":"string"},"settings_print_mode":{"description":"Ignore. Dashdoc technical data.","type":"boolean"},"settings_special_agreements":{"description":"Ignore. Dashdoc technical data.","type":"string"},"settings_transport_order_observations":{"type":"string"},"settings_constrain_reference_edition":{"type":"boolean"},"vat_number":{"type":"string"},"is_verified":{"type":"boolean"}},"type":"object"},"DeliveryLoads":{"properties":{"uid":{"description":"Dashdoc's internal id.","type":"string"},"remote_id":{"description":"The ID of the load in your system. It has to be unique among all your transports.","type":"string"},"description":{"description":"Text description of the load","type":"string"},"reference":{"description":"Reference of the load","type":"string"},"round_id":{"description":"The ID of the round.","format":"integer","type":"number"},"weight":{"description":"In kilograms","format":"float","type":"number"},"volume":{"description":"Volume of load in m3","format":"float","type":"number"},"volume_display_unit":{"default":"m3","enum":["m3","L"],"type":"string"},"linear_meters":{"description":"Length of load in meters","format":"float","type":"number"},"quantity":{"description":"Only one decimal accepted (e.g 0.0)","format":"float","type":"number"},"pallet_equivalence":{"description":"Pallet equivalence (EPS/EQPAL): how many standard pallet spaces the load occupies. `null` when it was never set. Otherwise at least `0.01`, with two decimals kept.","format":"float","nullable":true,"type":"number"},"category":{"description":"Packaging of the load. The text is free but these specific values cause a custom flow on the mobile app: `pallets`, `containers`, `bulk`, `roundwood`, `powder_tank`, `bulk_qualimat`, `rental`.","type":"string"},"dangerous_goods_category":{"description":"ADR class","enum":["1","2","3","4.1","4.2","4.3","5.1","5.2","6.1","6.2","7","8","9"],"type":"string"},"is_dangerous":{"type":"boolean"},"adr_un_code":{"type":"string"},"legal_mentions":{"type":"string"},"complementary_information":{"description":"Any information about the load that doesn't fit to the description field","type":"string"},"container_number":{"type":"string"},"tare_weight":{"description":"In kilograms","format":"float","type":"number"},"container_seal_number":{"type":"string"},"refrigerated":{"description":"Indicates whether the load is refrigerated. If true, the trucker can fill in the temperature.","type":"boolean"},"temperature":{"type":"string"},"steres":{"format":"float","type":"number"},"idtf_number":{"description":"Must match an existing IDTF number","type":"string"},"use_identifiers":{"description":"if `true`, trucker is asked to scan barcode identifiers on load","type":"boolean"},"identifiers":{"description":"Only relevant if use_identifiers is set to `true`. List of expected barcode identifiers that the trucker should scan at loading and unloading. App controls that expected barcodes are actually scanned. If empty, the trucker will have to scan barcodes anyway, but there won't be any check. Feature has to be activated in your account by your Dashdoc projet manager.","items":{"type":"string"},"type":"array"},"identifiers_observations":{"description":"Observations explaining issues with identifier, such as missing or unexpected identifiers","type":"string"}},"type":"object"},"Delivery_tracking_contacts":{"properties":{"uid":{"description":"Dashdoc's internal id.","type":"string"},"contact":{"$ref":"#/components/schemas/NewContact"},"subscribed_to_status_updates":{"description":"If set to true, the contact will receive an email at every step of the delivery. Else, they will receive only one email once the delivery is done.","type":"boolean"},"role":{"description":"The role of the contact in the delivery. It can be `carrier`, `shipper`, or `site`.","type":"string"}},"required":["contact"],"type":"object"},"NewContact":{"properties":{"uid":{"format":"uuid","type":"string"},"created":{"description":"Date of creation on our server","format":"date-time","readOnly":true,"type":"string"},"company":{"$ref":"#/components/schemas/CompanyIdentification"},"first_name":{"maxLength":200,"type":"string"},"last_name":{"maxLength":200,"type":"string"},"email":{"format":"email","type":"string"},"phone_number":{"maxLength":100,"type":"string"},"fax_number":{"maxLength":100,"type":"string"},"remote_id":{"description":"The id of the contact in your system","type":"string"}},"required":["company","last_name"],"type":"object"},"CompanyIdentification":{"description":"Identification of the company. The company must already exist in Dashdoc.","properties":{"pk":{"description":"Dashdoc's internal id. Optional, not required if `remote_id` is sent.","type":"integer"},"remote_id":{"description":"Your remote carrier id. Optional, ignored if `pk` is sent.","type":"string"},"name":{"type":"string"},"trade_number":{"type":"string"},"country":{"$ref":"#/components/schemas/country"},"settings_contract_html":{"description":"Ignore. Dashdoc technical data.","type":"string"},"settings_logo":{"description":"Ignore. Dashdoc technical data.","nullable":true,"type":"string"},"settings_stamp":{"description":"Ignore. Dashdoc technical data.","nullable":true,"type":"string"},"settings_print_mode":{"description":"Ignore. Dashdoc technical data.","type":"boolean"},"settings_special_agreements":{"description":"Ignore. Dashdoc technical data.","type":"string"},"settings_transport_order_observations":{"type":"string"},"settings_constrain_reference_edition":{"type":"boolean"},"vat_number":{"type":"string"},"is_verified":{"description":"Ignore. Dashdoc technical data.","type":"string"}},"type":"object"}}}}
```

## The CreateOrUpdateDelivery object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"CreateOrUpdateDelivery":{"properties":{"planned_loads":{"description":"Loads as planned before the transport has been started","items":{"$ref":"#/components/schemas/NewDeliveryLoads"},"type":"array"},"origin":{"$ref":"#/components/schemas/CreateOrUpdateSite"},"destination":{"$ref":"#/components/schemas/CreateOrUpdateSite"},"shipper_address":{"$ref":"#/components/schemas/NewAddressReduced"},"tracking_contacts":{"description":"List of contacts that will automatically receive an email when delivery is done.\nThe role of each contact will be determined by matching its company to a company\non the transport (carrier, shipper, pick-up, delivery).\n⚠️ If no tracking contacts are provided for a company and the setting `partner_email_fallback` is enabled,\na tracking contact corresponding to the company's email will be added, at the creation of the transport.\nThis only applies to the carrier and the shipper.\n","items":{"$ref":"#/components/schemas/CreateOrUpdateDelivery_tracking_contacts"},"type":"array"},"shipper_reference":{"description":"Reference the client may use to match transport on his own system, e.g. an order number.","type":"string"},"multiple_rounds":{"description":"If true, the trucker will be able to do a signature at loading, then add any amount of rounds for the transport (with weight/volume and weight ticket), and finish with a signature at unloading.","type":"boolean"}},"required":["destination","origin","shipper_address"],"type":"object"},"NewDeliveryLoads":{"properties":{"remote_id":{"description":"The ID of the load in your system. It has to be unique among all your transports.","type":"string"},"description":{"description":"Text description of the load. In the case of a dangerous load, the description has to respect the ADR law.","type":"string"},"reference":{"description":"Reference of the load.","type":"string"},"weight":{"description":"In kilograms","format":"float","type":"number"},"volume":{"description":"Volume of load in m3","format":"float","type":"number"},"linear_meters":{"description":"Length of load in meters","format":"float","type":"number"},"quantity":{"description":"Only one decimal accepted (e.g 0.0)","format":"float","type":"number"},"pallet_equivalence":{"description":"Pallet equivalence (EPS/EQPAL): how many standard pallet spaces the load occupies. Minimum `0.01`, and only two decimals are kept — omit it or send `null` rather than 0 when unknown. When a load is created from the Dashdoc interface this defaults to `quantity` × the handling unit's pallet equivalence, and stays freely overridable.","format":"float","nullable":true,"type":"number"},"category":{"description":"Packaging of the load. The text is free but these specific values cause a custom flow on the mobile app: `pallets`, `containers`, `bulk`, `roundwood`, `powder_tank`, `bulk_qualimat`, `rental`.","type":"string"},"handling_unit_uid":{"description":"Existing handling unit UID from the load type catalog.","format":"uuid","type":"string"},"good_uid":{"description":"Existing good UID from the goods catalog.","format":"uuid","type":"string"},"create_handling_unit":{"$ref":"#/components/schemas/NewDeliveryLoads_create_handling_unit"},"create_good":{"$ref":"#/components/schemas/NewDeliveryLoads_create_good"},"dangerous_goods_category":{"deprecated":true,"description":"ADR class","enum":["1","2","3","4.1","4.2","4.3","5.1","5.2","6.1","6.2","7","8","9"],"type":"string"},"is_dangerous":{"default":false,"description":"Indicates whether the load is dangerous. If true, the trucker has to confirm adr un code and legal mentions at unloading.","type":"boolean"},"adr_un_code":{"description":"Only for dangerous load, the official UN code from the ADR law.","type":"string"},"legal_mentions":{"description":"Only for dangerous load, all mandatory legal mentions printed on documents.","type":"string"},"complementary_information":{"description":"Any information about the load that doesn't fit to the description field.","type":"string"},"container_number":{"type":"string"},"tare_weight":{"description":"In kilograms","format":"float","type":"number"},"container_seal_number":{"type":"string"},"refrigerated":{"description":"Indicates whether the load is refrigerated. If true, the trucker can fill in the temperature.","type":"boolean"},"temperature":{"type":"string"},"steres":{"format":"float","type":"number"},"idtf_number":{"description":"Must match an existing IDTF number","type":"string"},"use_identifiers":{"description":"if `true`, trucker is asked to scan barcode identifiers on load","type":"boolean"},"identifiers":{"description":"Only relevant if use_identifiers is set to `true`. List of expected barcode identifiers that the trucker should scan at loading and unloading. App controls that expected barcodes are actually scanned. If empty, the trucker will have to scan barcodes anyway, but there won't be any check. Feature has to be activated in your account by your Dashdoc projet manager.","items":{"type":"string"},"type":"array"},"identifiers_observations":{"description":"Observations explaining issues with identifier, such as missing or unexpected identifiers","type":"string"}},"type":"object"},"NewDeliveryLoads_create_handling_unit":{"description":"Create a handling unit in the catalog and use its UID for this load. If provided, it silently overrides `handling_unit_uid`.","nullable":true,"properties":{"name":{"type":"string"},"dashdoc_load_category":{"type":"string"},"remote_id":{"type":"string"}},"type":"object"},"NewDeliveryLoads_create_good":{"description":"Create a good in the catalog and use its UID for this load. If provided, it silently overrides `good_uid`.","nullable":true,"properties":{"name":{"type":"string"},"additional_information":{"type":"string"},"remote_id":{"type":"string"}},"type":"object"},"CreateOrUpdateSite":{"properties":{"uid":{"format":"uuid","type":"string"},"remote_id":{"description":"The id of the site in your system","type":"string"},"address":{"allOf":[{"$ref":"#/components/schemas/SiteAddress"}],"nullable":true},"real_start":{"description":"date and time when trucker arrived on site","format":"date-time","readOnly":true,"type":"string"},"real_end":{"description":"date and time when trucker completed loading / unloading (depending whether site is origin or destination)","format":"date-time","readOnly":true,"type":"string"},"signature_process":{"type":"string"},"is_booking_needed":{"type":"boolean"},"instructions":{"$ref":"#/components/schemas/site_instructions"},"reference":{"type":"string"},"action":{"deprecated":true,"description":"Deprecated. Accepted for backward compatibility but ignored. Responses always return an empty string.","type":"string"},"eta":{"format":"date-time","nullable":true,"type":"string"},"eta_tracking":{"type":"boolean"},"punctuality_status":{"readOnly":true,"type":"string"},"supports_exchanges":{"$ref":"#/components/schemas/SupportsExchange"},"category":{"type":"string"},"slots":{"items":{"$ref":"#/components/schemas/Site_slots"},"type":"array"},"trucker_instructions":{"$ref":"#/components/schemas/trucker_instructions"},"trip":{"$ref":"#/components/schemas/Site_trip"}},"type":"object"},"SiteAddress":{"description":"Address of the site. Reference an existing address with its `pk` or `remote_id`, or send its details to have it matched or created.","properties":{"pk":{"description":"Dashdoc's internal id. Optional, set it to reference an existing address.","type":"integer"},"name":{"type":"string"},"address":{"type":"string"},"city":{"type":"string"},"postcode":{"type":"string"},"country":{"$ref":"#/components/schemas/country"},"latitude":{"$ref":"#/components/schemas/latitude"},"longitude":{"$ref":"#/components/schemas/longitude"},"radius":{"default":500,"description":"Radius around the GPS coordinates within which the address is located (in meters)","type":"integer"},"coords_validated":{"default":false,"description":"if `true`, when this address is used as a loading or unloading site, the mobile app displays an itinerary button to start GPS app with guidance to these coordinates","type":"boolean"},"is_demo":{"$ref":"#/components/schemas/is_demo"},"is_carrier":{"type":"boolean"},"is_shipper":{"type":"boolean"},"is_origin":{"$ref":"#/components/schemas/address_is_origin_and_is_destination"},"is_destination":{"$ref":"#/components/schemas/address_is_origin_and_is_destination"},"instructions":{"$ref":"#/components/schemas/site_instructions"},"remote_id":{"description":"The id of the address in your system.","type":"string"},"company":{"$ref":"#/components/schemas/CompanyForTransportAddress_1"}},"type":"object"},"country":{"description":"Only the 2-character codification is accepted (ISO 3166-1 alpha-2)","type":"string"},"latitude":{"description":"Latitude using the decimal GPS coordinates (WGS84). At 7 decimals, the position is accurate around the centimeter.","format":"float","nullable":true,"type":"number"},"longitude":{"description":"Longitude using the decimal GPS coordinates (WGS84). At 7 decimals, the position is accurate around the centimeter.","format":"float","nullable":true,"type":"number"},"is_demo":{"description":"Indicates that the address is a fake one created from demonstration. Everything linked to it will be deleted when using the 'Delete demo content' button in company parameters","type":"boolean"},"address_is_origin_and_is_destination":{"description":"Whether this address is a \"Logistic Points\" and will be usable as pickup/delivery point.\nThe distinction between origin/pickup and destination/delivery was merged as a single \"Logistic Point\" concept. `is_origin` implies `is_destination` and vice-versa.\n","type":"boolean"},"site_instructions":{"description":"Site instructions, visible to all parties (trucker, carrier, shipper, site). Displayed in the trucker mobile app. Not visible in the eCMR. If the field is not provided, the address's site instructions will be used.","maxLength":1000,"type":"string"},"CompanyForTransportAddress_1":{"description":"Identification of the company. You may simply use its `pk` or `remote_id` if the company already exists. Other possible identification method are its `trade_number` or `name`. If it doesn't exist, the company will be created with the information you send based on what's possible when creating a company via /companies/ web service. Minimum required information in this case is a name.","properties":{"pk":{"description":"Dashdoc's internal id.Optional, not required if `remote_id` is sent.","type":"integer"},"remote_id":{"description":"The id of the company in your system. Optional, ignored if `pk` is sent.","type":"string"},"trade_number":{"maxLength":100,"type":"string"},"name":{"maxLength":200,"type":"string"}},"type":"object"},"SupportsExchange":{"properties":{"uid":{"description":"uid of the support exchange","format":"uuid","type":"string"},"site":{"$ref":"#/components/schemas/SupportsExchange_site"},"support_type":{"$ref":"#/components/schemas/SupportType"},"expected_retrieved":{"description":"Expected number of supports that should be retrieved on the site","type":"number"},"actual_retrieved":{"description":"Actual number of supports that were retrieved on the site","type":"number"},"expected_delivered":{"description":"Expected number of supports that should be delivered on the site","type":"number"},"actual_delivered":{"description":"Actual number of supports that were delivered on the site","type":"number"},"observations":{"description":"Free text. Observations about this supports exchange. Can be filled on mobile app, web app or via API.","type":"string"},"remote_id":{"description":"The ID of the support in your system","type":"string"}},"type":"object"},"SupportsExchange_site":{"description":"site where supports exchange is expected","properties":{"uid":{"description":"uid of the site","format":"uuid","type":"string"},"remote_id":{"description":"remote_id of the site","type":"string"}},"type":"object"},"SupportType":{"description":"Type of the supports that are exchanged","properties":{"name":{"description":"Display name of the support type","type":"string"},"created":{"$ref":"#/components/schemas/created"},"uid":{"format":"uuid","type":"string"},"remote_id":{"description":"The id of the support type in your system.","type":"string"}},"type":"object"},"created":{"description":"Date of creation on our server","format":"date-time","type":"string"},"Site_slots":{"properties":{"start":{"format":"date-time","type":"string"},"end":{"format":"date-time","type":"string"}},"type":"object"},"trucker_instructions":{"description":"**This field is part of a beta feature.** Private instructions. **The carrier of the transport is the only one who can edit and read those instructions.** Note that those instructions are not visible in the consignment note and can be accessed by the trucker. The value is null if the caller doesn't have the right of access to the data.","maxLength":1000,"type":"string"},"Site_trip":{"description":"Trip linked to this site/activity.","nullable":true,"properties":{"uid":{"format":"uuid","type":"string"},"name":{"type":"string"},"is_prepared":{"type":"boolean"},"status":{"enum":["unstarted","ongoing","done"],"type":"string"}},"readOnly":true,"type":"object"},"NewAddressReduced":{"properties":{"pk":{"description":"Dashdoc's internal id. Optional, set it to reference an existing address.","type":"integer"},"name":{"type":"string"},"address":{"type":"string"},"city":{"type":"string"},"postcode":{"type":"string"},"country":{"$ref":"#/components/schemas/country"},"latitude":{"$ref":"#/components/schemas/latitude"},"longitude":{"$ref":"#/components/schemas/longitude"},"radius":{"default":500,"description":"Radius around the GPS coordinates within which the address is located (in meters)","type":"integer"},"coords_validated":{"default":false,"description":"if `true`, when this address is used as a loading or unloading site, the mobile app displays an itinerary button to start GPS app with guidance to these coordinates","type":"boolean"},"is_demo":{"$ref":"#/components/schemas/is_demo"},"is_carrier":{"type":"boolean"},"is_shipper":{"type":"boolean"},"is_origin":{"type":"boolean"},"is_destination":{"type":"boolean"},"created_by":{"description":"Ignore. Dashdoc technical data.","readOnly":true,"type":"number"},"created":{"description":"Date of creation on our server","format":"date-time","readOnly":true,"type":"string"},"instructions":{"type":"string"},"remote_id":{"description":"The id of the address in your system.","type":"string"},"company":{"$ref":"#/components/schemas/CompanyForTransportAddress"},"original":{"description":"Ignore. Dashdoc technical data.","nullable":true,"readOnly":true,"type":"number"}},"required":["address","city","company","country","postcode"],"type":"object"},"CompanyForTransportAddress":{"properties":{"pk":{"description":"Dashdoc's internal id.","type":"number"},"remote_id":{"description":"The id of the company in your system.","type":"string"},"name":{"type":"string"},"trade_number":{"type":"string"},"country":{"$ref":"#/components/schemas/country"},"settings_contract_html":{"description":"Ignore. Dashdoc technical data.","type":"string"},"settings_logo":{"description":"Ignore. Dashdoc technical data.","nullable":true,"type":"string"},"settings_stamp":{"description":"Ignore. Dashdoc technical data.","nullable":true,"type":"string"},"settings_print_mode":{"description":"Ignore. Dashdoc technical data.","type":"boolean"},"settings_special_agreements":{"description":"Ignore. Dashdoc technical data.","type":"string"},"settings_transport_order_observations":{"type":"string"},"settings_constrain_reference_edition":{"type":"boolean"},"vat_number":{"type":"string"},"is_verified":{"type":"boolean"}},"type":"object"},"CreateOrUpdateDelivery_tracking_contacts":{"properties":{"contact":{"$ref":"#/components/schemas/NewContact"},"subscribed_to_status_updates":{"description":"If set to true, the contact will receive an email at every step of the delivery. Else, they will receive only one email once the delivery is done.","type":"boolean"}},"required":["contact"],"type":"object"},"NewContact":{"properties":{"uid":{"format":"uuid","type":"string"},"created":{"description":"Date of creation on our server","format":"date-time","readOnly":true,"type":"string"},"company":{"$ref":"#/components/schemas/CompanyIdentification"},"first_name":{"maxLength":200,"type":"string"},"last_name":{"maxLength":200,"type":"string"},"email":{"format":"email","type":"string"},"phone_number":{"maxLength":100,"type":"string"},"fax_number":{"maxLength":100,"type":"string"},"remote_id":{"description":"The id of the contact in your system","type":"string"}},"required":["company","last_name"],"type":"object"},"CompanyIdentification":{"description":"Identification of the company. The company must already exist in Dashdoc.","properties":{"pk":{"description":"Dashdoc's internal id. Optional, not required if `remote_id` is sent.","type":"integer"},"remote_id":{"description":"Your remote carrier id. Optional, ignored if `pk` is sent.","type":"string"},"name":{"type":"string"},"trade_number":{"type":"string"},"country":{"$ref":"#/components/schemas/country"},"settings_contract_html":{"description":"Ignore. Dashdoc technical data.","type":"string"},"settings_logo":{"description":"Ignore. Dashdoc technical data.","nullable":true,"type":"string"},"settings_stamp":{"description":"Ignore. Dashdoc technical data.","nullable":true,"type":"string"},"settings_print_mode":{"description":"Ignore. Dashdoc technical data.","type":"boolean"},"settings_special_agreements":{"description":"Ignore. Dashdoc technical data.","type":"string"},"settings_transport_order_observations":{"type":"string"},"settings_constrain_reference_edition":{"type":"boolean"},"vat_number":{"type":"string"},"is_verified":{"description":"Ignore. Dashdoc technical data.","type":"string"}},"type":"object"}}}}
```

## The AddRoundDeliveries object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"AddRoundDeliveries":{"properties":{"loads":{"items":{"$ref":"#/components/schemas/NewDeliveryLoads"},"type":"array"}},"required":["loads"],"type":"object"},"NewDeliveryLoads":{"properties":{"remote_id":{"description":"The ID of the load in your system. It has to be unique among all your transports.","type":"string"},"description":{"description":"Text description of the load. In the case of a dangerous load, the description has to respect the ADR law.","type":"string"},"reference":{"description":"Reference of the load.","type":"string"},"weight":{"description":"In kilograms","format":"float","type":"number"},"volume":{"description":"Volume of load in m3","format":"float","type":"number"},"linear_meters":{"description":"Length of load in meters","format":"float","type":"number"},"quantity":{"description":"Only one decimal accepted (e.g 0.0)","format":"float","type":"number"},"pallet_equivalence":{"description":"Pallet equivalence (EPS/EQPAL): how many standard pallet spaces the load occupies. Minimum `0.01`, and only two decimals are kept — omit it or send `null` rather than 0 when unknown. When a load is created from the Dashdoc interface this defaults to `quantity` × the handling unit's pallet equivalence, and stays freely overridable.","format":"float","nullable":true,"type":"number"},"category":{"description":"Packaging of the load. The text is free but these specific values cause a custom flow on the mobile app: `pallets`, `containers`, `bulk`, `roundwood`, `powder_tank`, `bulk_qualimat`, `rental`.","type":"string"},"handling_unit_uid":{"description":"Existing handling unit UID from the load type catalog.","format":"uuid","type":"string"},"good_uid":{"description":"Existing good UID from the goods catalog.","format":"uuid","type":"string"},"create_handling_unit":{"$ref":"#/components/schemas/NewDeliveryLoads_create_handling_unit"},"create_good":{"$ref":"#/components/schemas/NewDeliveryLoads_create_good"},"dangerous_goods_category":{"deprecated":true,"description":"ADR class","enum":["1","2","3","4.1","4.2","4.3","5.1","5.2","6.1","6.2","7","8","9"],"type":"string"},"is_dangerous":{"default":false,"description":"Indicates whether the load is dangerous. If true, the trucker has to confirm adr un code and legal mentions at unloading.","type":"boolean"},"adr_un_code":{"description":"Only for dangerous load, the official UN code from the ADR law.","type":"string"},"legal_mentions":{"description":"Only for dangerous load, all mandatory legal mentions printed on documents.","type":"string"},"complementary_information":{"description":"Any information about the load that doesn't fit to the description field.","type":"string"},"container_number":{"type":"string"},"tare_weight":{"description":"In kilograms","format":"float","type":"number"},"container_seal_number":{"type":"string"},"refrigerated":{"description":"Indicates whether the load is refrigerated. If true, the trucker can fill in the temperature.","type":"boolean"},"temperature":{"type":"string"},"steres":{"format":"float","type":"number"},"idtf_number":{"description":"Must match an existing IDTF number","type":"string"},"use_identifiers":{"description":"if `true`, trucker is asked to scan barcode identifiers on load","type":"boolean"},"identifiers":{"description":"Only relevant if use_identifiers is set to `true`. List of expected barcode identifiers that the trucker should scan at loading and unloading. App controls that expected barcodes are actually scanned. If empty, the trucker will have to scan barcodes anyway, but there won't be any check. Feature has to be activated in your account by your Dashdoc projet manager.","items":{"type":"string"},"type":"array"},"identifiers_observations":{"description":"Observations explaining issues with identifier, such as missing or unexpected identifiers","type":"string"}},"type":"object"},"NewDeliveryLoads_create_handling_unit":{"description":"Create a handling unit in the catalog and use its UID for this load. If provided, it silently overrides `handling_unit_uid`.","nullable":true,"properties":{"name":{"type":"string"},"dashdoc_load_category":{"type":"string"},"remote_id":{"type":"string"}},"type":"object"},"NewDeliveryLoads_create_good":{"description":"Create a good in the catalog and use its UID for this load. If provided, it silently overrides `good_uid`.","nullable":true,"properties":{"name":{"type":"string"},"additional_information":{"type":"string"},"remote_id":{"type":"string"}},"type":"object"}}}}
```

## The Statuses object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"Statuses":{"enum":["created","updated","confirmed","declined","verified","invoiced","paid","cancelled","assigned","sent_to_trucker","acknowledged","truck_wash","on_loading_site","loading_complete","on_unloading_site","unloading_complete","bulking_break_started","bulking_break_complete","rounds_started","round_added","round_added_v2","round_edited","round_deleted","rounds_complete","event","checklist_filled","activity_complete","on_the_way","handling_started","done"],"type":"string"}}}}
```

## The CMRDocument object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"CMRDocument":{"properties":{"file":{"description":"URL of the stored cmr document. You can download the document from this URL.","type":"string"},"reference":{"description":"Free text. This reference is searchable in the transports dashboard. Filled by the trucker if the CMR / LV is added from the mobile app. Filled by the user, if the document is added from the web app, or filled by API request.","type":"string"}},"type":"object"}}}}
```

## The DockActivities object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"DockActivities":{"properties":{"count":{"type":"integer"},"next":{"nullable":true,"type":"string"},"previous":{"nullable":true,"type":"string"},"results":{"items":{"$ref":"#/components/schemas/DockActivity"},"type":"array"}},"type":"object"},"DockActivity":{"properties":{"uid":{"description":"uid of this Activity","format":"uuid","type":"string"},"transport_uid":{"description":"uid of the transport containing this Activity","format":"uuid","type":"string"},"transport_tags":{"items":{"type":"string"},"type":"array"},"dock_done_observations":{"description":"Observations set by dock when activity was done by dock","type":"string"},"dock_done_date":{"format":"date-time","type":"string"},"trucker":{"$ref":"#/components/schemas/DockActivity_trucker"},"carrier":{"$ref":"#/components/schemas/DockActivity_carrier"},"shipper":{"$ref":"#/components/schemas/DockActivity_shipper"},"shipper_reference":{"description":"Shipper reference on the activity's transport","type":"string"},"vehicle":{"$ref":"#/components/schemas/DockActivity_vehicle"},"trailer":{"type":"object"},"category":{"description":"Type of the activity. Possible values: loading, unloading, breaking, resuming","type":"string"},"loads":{"items":{"$ref":"#/components/schemas/DockActivity_loads"},"type":"array"}},"type":"object"},"DockActivity_trucker":{"properties":{"pk":{"description":"Id of the trucker","type":"number"},"display_name":{"description":"Full name of the trucker","type":"string"}},"type":"object"},"DockActivity_carrier":{"properties":{"pk":{"description":"Id of the carrier","type":"number"},"name":{"description":"Name of the carrier","type":"string"}},"type":"object"},"DockActivity_shipper":{"properties":{"pk":{"description":"Id of the shipping company","type":"number"},"name":{"description":"Name of the shipper","type":"string"}},"type":"object"},"DockActivity_vehicle":{"properties":{"pk":{"description":"Id of the vehicle","type":"number"},"license_plate":{"type":"string"}},"type":"object"},"DockActivity_loads":{"properties":{"uid":{"description":"Id of the load","format":"uuid","type":"string"},"description":{"description":"Description of the load","type":"string"},"loading_scheduled_date":{"description":"Date of scheduled loading","format":"date-time","type":"string"},"unloading_scheduled_date":{"description":"Date of scheduled unloading","format":"date-time","type":"string"},"loading_address":{"$ref":"#/components/schemas/DockActivity_loading_address"},"unloading_address":{"$ref":"#/components/schemas/DockActivity_loading_address"},"quantity":{"format":"float","type":"number"},"category":{"description":"Packaging of the load. The text is free but these specific values cause a custom flow on the mobile app: `pallets`, `containers`, `bulk`, `roundwood`, `powder_tank`, `bulk_qualimat`, `rental`.","type":"string"},"complementary_information":{"description":"Any information about the load that doesn't fit to the description field","type":"string"},"weight":{"description":"In kilograms","format":"float","type":"number"},"volume":{"description":"Volume of load in m3","format":"float","type":"number"},"volume_display_unit":{"default":"m3","enum":["m3","L"],"type":"string"},"linear_meters":{"description":"Length of load in meters","format":"float","type":"number"},"is_dangerous":{"type":"boolean"}},"type":"object"},"DockActivity_loading_address":{"properties":{"name":{"type":"string"},"address":{"type":"string"},"city":{"type":"string"},"postcode":{"type":"string"},"country":{"$ref":"#/components/schemas/country"}},"type":"object"},"country":{"description":"Only the 2-character codification is accepted (ISO 3166-1 alpha-2)","type":"string"}}}}
```

## The InvoiceItems object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"InvoiceItems":{"properties":{"count":{"type":"integer"},"next":{"nullable":true,"type":"string"},"previous":{"nullable":true,"type":"string"},"results":{"items":{"$ref":"#/components/schemas/InvoiceItem"},"type":"array"}},"type":"object"},"InvoiceItem":{"properties":{"uid":{"format":"uuid","type":"string"},"remote_id":{"description":"The id of the invoice item in your system","type":"string"},"description":{"description":"Default description when a user selects this invoice item for an invoice line","type":"string"}},"type":"object"}}}}
```

## The NewInvoiceItem object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"NewInvoiceItem":{"properties":{"remote_id":{"description":"The id of the invoice item in your system","type":"string"},"description":{"description":"Default description when a user selects this invoice item for an invoice line","type":"string"}},"type":"object"}}}}
```

## The InvoiceItem object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"InvoiceItem":{"properties":{"uid":{"format":"uuid","type":"string"},"remote_id":{"description":"The id of the invoice item in your system","type":"string"},"description":{"description":"Default description when a user selects this invoice item for an invoice line","type":"string"}},"type":"object"}}}}
```

## The UpdateInvoiceItem object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"UpdateInvoiceItem":{"properties":{"remote_id":{"description":"The id of the invoice item in your system","type":"string"},"description":{"description":"Default description when a user selects this invoice item for an invoice line","type":"string"}},"type":"object"}}}}
```

## The Invoices object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"Invoices":{"properties":{"count":{"type":"integer"},"next":{"nullable":true,"type":"string"},"previous":{"nullable":true,"type":"string"},"results":{"items":{"$ref":"#/components/schemas/Invoice"},"type":"array"}},"type":"object"},"Invoice":{"properties":{"uid":{"description":"uuid of this Invoice","format":"uuid","type":"string"},"created_by":{"$ref":"#/components/schemas/InvoiceCreatedBy"},"debtor":{"$ref":"#/components/schemas/InvoiceDebtor"},"description_template":{"description":"Ignore. Dashdoc technical data.","type":"object"},"document_number":{"description":"Invoice's number. It usually corresponds to the invoice's number defined in your invoicing tool.","type":"string"},"status":{"default":"draft","description":"Indicate the status of the invoice","enum":["draft","final","paid"],"type":"string"},"due_date":{"description":"Due date of the invoice","format":"date","nullable":true,"type":"string"},"line_groups":{"items":{"$ref":"#/components/schemas/InvoiceLineGroup"},"type":"array"},"lines":{"description":"List of lines of the invoice which do not correspond to a transport","items":{"$ref":"#/components/schemas/InvoiceLine"},"type":"array"},"created":{"$ref":"#/components/schemas/created"},"updated":{"description":"Last update on our server","format":"date-time","type":"string"},"period":{"$ref":"#/components/schemas/Invoice_period"},"transports_count":{"description":"Number of transports linked to this invoice","type":"integer"},"remote_id":{"description":"The id of the invoice in your system.","type":"string"},"invoicing_connector":{"description":"Ignore. Dashdoc technical data.","type":"object"},"file":{"description":"Invoice file path","format":"url","type":"string"},"invoicing_date":{"description":"Date of invoicing","format":"date","type":"string"},"finalized_at":{"description":"Date of invoice finalization.","format":"date-time","type":"string"},"debtor_reference":{"description":"Pre-billing reference","type":"string"},"buyer_reference":{"description":"Reference assigned by the buyer, carried as BT-10 on the electronic invoice","type":"string"},"project_reference":{"description":"Project reference, carried as BT-11 on the electronic invoice","type":"string"},"contract_reference":{"description":"Contract reference, carried as BT-12 on the electronic invoice","type":"string"},"purchase_order_reference":{"description":"Purchase order reference assigned by the customer, carried as BT-13 on the electronic invoice","type":"string"},"total_price":{"description":"Total price, excluding taxes","type":"string"},"total_tax_amount":{"description":"Total taxes amount","type":"string"}},"type":"object"},"InvoiceCreatedBy":{"properties":{"pk":{"description":"Dashdoc's internal id.","type":"number"},"name":{"type":"string"},"primary_address":{"$ref":"#/components/schemas/PrimaryAddress_1"},"country":{"$ref":"#/components/schemas/country"},"vat_number":{"type":"string"}},"type":"object"},"PrimaryAddress_1":{"properties":{"pk":{"description":"Dashdoc's internal id.","type":"number"},"name":{"type":"string"},"address":{"type":"string"},"city":{"type":"string"},"postcode":{"type":"string"},"country":{"$ref":"#/components/schemas/country"},"latitude":{"$ref":"#/components/schemas/latitude"},"longitude":{"$ref":"#/components/schemas/longitude"},"radius":{"default":500,"description":"Radius around the GPS coordinates within which the address is located (in meters)","type":"integer"},"coords_validated":{"default":false,"description":"if `true`, when this address is used as a loading or unloading site, the mobile app displays an itinerary button to start GPS app with guidance to these coordinates","type":"boolean"},"is_demo":{"$ref":"#/components/schemas/is_demo"},"is_carrier":{"description":"Whether this company is considered a carrier","type":"boolean"},"is_shipper":{"description":"Whether this company is considered a shipper","type":"boolean"},"is_origin":{"description":"Legacy, not relevant for a company's primary address. Consider creating a separate address associated with this partner instead.\n","type":"boolean"},"is_destination":{"description":"Legacy, not relevant for a company's primary address. Consider creating a separate address associated with this partner instead.\n","type":"boolean"},"created_by":{"$ref":"#/components/schemas/created-by"},"created_by_user":{"$ref":"#/components/schemas/created-by-user"},"created":{"$ref":"#/components/schemas/created"},"remote_id":{"description":"The id of the address in your system.","type":"string"}},"type":"object"},"country":{"description":"Only the 2-character codification is accepted (ISO 3166-1 alpha-2)","type":"string"},"latitude":{"description":"Latitude using the decimal GPS coordinates (WGS84). At 7 decimals, the position is accurate around the centimeter.","format":"float","nullable":true,"type":"number"},"longitude":{"description":"Longitude using the decimal GPS coordinates (WGS84). At 7 decimals, the position is accurate around the centimeter.","format":"float","nullable":true,"type":"number"},"is_demo":{"description":"Indicates that the address is a fake one created from demonstration. Everything linked to it will be deleted when using the 'Delete demo content' button in company parameters","type":"boolean"},"created-by":{"nullable":true,"properties":{"pk":{"description":"company id","type":"number"},"name":{"description":"name of the company","type":"string"}},"type":"object"},"created-by-user":{"nullable":true,"properties":{"pk":{"type":"number"},"display_name":{"type":"string"},"company":{"description":"The company id who created the address","type":"number"},"trucker_id":{"description":"The trucker id who created the address","type":"number"}},"type":"object"},"created":{"description":"Date of creation on our server","format":"date-time","type":"string"},"InvoiceDebtor":{"properties":{"pk":{"description":"Dashdoc's internal id.","type":"number"},"invoicing_remote_id":{"description":"The id of the company in your invoicing system.","type":"string"},"name":{"type":"string"},"primary_address":{"$ref":"#/components/schemas/PrimaryAddress_1"},"country":{"$ref":"#/components/schemas/country"},"vat_number":{"type":"string"}},"type":"object"},"InvoiceLineGroup":{"properties":{"transport":{"$ref":"#/components/schemas/InvoiceTransport"},"lines":{"description":"List of lines of the invoice for the transport associated with this line group.","items":{"$ref":"#/components/schemas/InvoiceLine"},"type":"array"},"description":{"description":"Description of the group of line of the invoice","type":"string"},"currency":{"type":"string"},"gas_index":{"nullable":true,"readOnly":true,"type":"string"},"gas_index_invoice_item":{"$ref":"#/components/schemas/InvoiceItem"}},"type":"object"},"InvoiceTransport":{"properties":{"uid":{"description":"uuid of the Transport","format":"uuid","type":"string"},"sequential_id":{"type":"number"},"deliveries":{"items":{"$ref":"#/components/schemas/InvoiceDelivery"},"type":"array"},"documents":{"description":"See https://developer.dashdoc.eu/docs/tutorials/retrieve-transport-tracking-data#get-documents-and-photos-with-their-type","items":{"$ref":"#/components/schemas/InvoiceDocument"},"type":"array"},"messages":{"description":"See https://developer.dashdoc.eu/docs/tutorials/retrieve-transport-tracking-data#get-documents-and-photos-with-their-type","items":{"$ref":"#/components/schemas/InvoiceMessage"},"type":"array"}},"type":"object"},"InvoiceDelivery":{"properties":{"uid":{"description":"uuid of the Delivery","format":"uuid","type":"string"},"origin":{"$ref":"#/components/schemas/InvoiceSite"},"destination":{"$ref":"#/components/schemas/InvoiceSite"}},"type":"object"},"InvoiceSite":{"properties":{"uid":{"type":"string"},"company_name":{"type":"string"},"city":{"type":"string"}},"type":"object"},"InvoiceDocument":{"properties":{"delivery":{"description":"uuid of the Delivery","format":"uuid","type":"string"},"file":{"description":"path of the document","format":"url","type":"string"},"reference":{"type":"string"},"category":{"description":"Type of document. Possible values are \"cmr\", \"cmr4\", \"ldv\", \"orc\", \"chc\", \"rental\" and \"loading_plan\"","type":"string"}},"type":"object"},"InvoiceMessage":{"properties":{"document":{"description":"path of the document","format":"url","type":"string"},"reference":{"type":"string"},"document_type":{"enum":["load_photo","cmr","washing_note","delivery_note","confirmation","weight_note","waste_manifest","holders_swap_note","invoice"],"maxLength":100,"type":"string"}},"type":"object"},"InvoiceLine":{"properties":{"description":{"description":"Description of the line of the invoice","type":"string"},"quantity":{"type":"number"},"unit_price":{"type":"number"},"currency":{"type":"string"},"total_price_without_tax":{"type":"number"},"invoice_item":{"$ref":"#/components/schemas/InvoiceItem"},"is_gas_indexed":{"description":"Whether this invoice line is subject to gas indexation","nullable":true,"readOnly":true,"type":"boolean"}},"type":"object"},"InvoiceItem":{"properties":{"uid":{"format":"uuid","type":"string"},"remote_id":{"description":"The id of the invoice item in your system","type":"string"},"description":{"description":"Default description when a user selects this invoice item for an invoice line","type":"string"}},"type":"object"},"Invoice_period":{"description":"The interval between the date of first loading and last unloading among all the transports of the invoice.","properties":{"first_loading_at":{"description":"Date of first loading among all the transports of the invoice.","format":"date-time","nullable":true,"type":"string"},"last_unloading_at":{"description":"Date of last unloading among all the transports of the invoice.","format":"date-time","nullable":true,"type":"string"}},"type":"object"}}}}
```

## The Invoice object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"Invoice":{"properties":{"uid":{"description":"uuid of this Invoice","format":"uuid","type":"string"},"created_by":{"$ref":"#/components/schemas/InvoiceCreatedBy"},"debtor":{"$ref":"#/components/schemas/InvoiceDebtor"},"description_template":{"description":"Ignore. Dashdoc technical data.","type":"object"},"document_number":{"description":"Invoice's number. It usually corresponds to the invoice's number defined in your invoicing tool.","type":"string"},"status":{"default":"draft","description":"Indicate the status of the invoice","enum":["draft","final","paid"],"type":"string"},"due_date":{"description":"Due date of the invoice","format":"date","nullable":true,"type":"string"},"line_groups":{"items":{"$ref":"#/components/schemas/InvoiceLineGroup"},"type":"array"},"lines":{"description":"List of lines of the invoice which do not correspond to a transport","items":{"$ref":"#/components/schemas/InvoiceLine"},"type":"array"},"created":{"$ref":"#/components/schemas/created"},"updated":{"description":"Last update on our server","format":"date-time","type":"string"},"period":{"$ref":"#/components/schemas/Invoice_period"},"transports_count":{"description":"Number of transports linked to this invoice","type":"integer"},"remote_id":{"description":"The id of the invoice in your system.","type":"string"},"invoicing_connector":{"description":"Ignore. Dashdoc technical data.","type":"object"},"file":{"description":"Invoice file path","format":"url","type":"string"},"invoicing_date":{"description":"Date of invoicing","format":"date","type":"string"},"finalized_at":{"description":"Date of invoice finalization.","format":"date-time","type":"string"},"debtor_reference":{"description":"Pre-billing reference","type":"string"},"buyer_reference":{"description":"Reference assigned by the buyer, carried as BT-10 on the electronic invoice","type":"string"},"project_reference":{"description":"Project reference, carried as BT-11 on the electronic invoice","type":"string"},"contract_reference":{"description":"Contract reference, carried as BT-12 on the electronic invoice","type":"string"},"purchase_order_reference":{"description":"Purchase order reference assigned by the customer, carried as BT-13 on the electronic invoice","type":"string"},"total_price":{"description":"Total price, excluding taxes","type":"string"},"total_tax_amount":{"description":"Total taxes amount","type":"string"}},"type":"object"},"InvoiceCreatedBy":{"properties":{"pk":{"description":"Dashdoc's internal id.","type":"number"},"name":{"type":"string"},"primary_address":{"$ref":"#/components/schemas/PrimaryAddress_1"},"country":{"$ref":"#/components/schemas/country"},"vat_number":{"type":"string"}},"type":"object"},"PrimaryAddress_1":{"properties":{"pk":{"description":"Dashdoc's internal id.","type":"number"},"name":{"type":"string"},"address":{"type":"string"},"city":{"type":"string"},"postcode":{"type":"string"},"country":{"$ref":"#/components/schemas/country"},"latitude":{"$ref":"#/components/schemas/latitude"},"longitude":{"$ref":"#/components/schemas/longitude"},"radius":{"default":500,"description":"Radius around the GPS coordinates within which the address is located (in meters)","type":"integer"},"coords_validated":{"default":false,"description":"if `true`, when this address is used as a loading or unloading site, the mobile app displays an itinerary button to start GPS app with guidance to these coordinates","type":"boolean"},"is_demo":{"$ref":"#/components/schemas/is_demo"},"is_carrier":{"description":"Whether this company is considered a carrier","type":"boolean"},"is_shipper":{"description":"Whether this company is considered a shipper","type":"boolean"},"is_origin":{"description":"Legacy, not relevant for a company's primary address. Consider creating a separate address associated with this partner instead.\n","type":"boolean"},"is_destination":{"description":"Legacy, not relevant for a company's primary address. Consider creating a separate address associated with this partner instead.\n","type":"boolean"},"created_by":{"$ref":"#/components/schemas/created-by"},"created_by_user":{"$ref":"#/components/schemas/created-by-user"},"created":{"$ref":"#/components/schemas/created"},"remote_id":{"description":"The id of the address in your system.","type":"string"}},"type":"object"},"country":{"description":"Only the 2-character codification is accepted (ISO 3166-1 alpha-2)","type":"string"},"latitude":{"description":"Latitude using the decimal GPS coordinates (WGS84). At 7 decimals, the position is accurate around the centimeter.","format":"float","nullable":true,"type":"number"},"longitude":{"description":"Longitude using the decimal GPS coordinates (WGS84). At 7 decimals, the position is accurate around the centimeter.","format":"float","nullable":true,"type":"number"},"is_demo":{"description":"Indicates that the address is a fake one created from demonstration. Everything linked to it will be deleted when using the 'Delete demo content' button in company parameters","type":"boolean"},"created-by":{"nullable":true,"properties":{"pk":{"description":"company id","type":"number"},"name":{"description":"name of the company","type":"string"}},"type":"object"},"created-by-user":{"nullable":true,"properties":{"pk":{"type":"number"},"display_name":{"type":"string"},"company":{"description":"The company id who created the address","type":"number"},"trucker_id":{"description":"The trucker id who created the address","type":"number"}},"type":"object"},"created":{"description":"Date of creation on our server","format":"date-time","type":"string"},"InvoiceDebtor":{"properties":{"pk":{"description":"Dashdoc's internal id.","type":"number"},"invoicing_remote_id":{"description":"The id of the company in your invoicing system.","type":"string"},"name":{"type":"string"},"primary_address":{"$ref":"#/components/schemas/PrimaryAddress_1"},"country":{"$ref":"#/components/schemas/country"},"vat_number":{"type":"string"}},"type":"object"},"InvoiceLineGroup":{"properties":{"transport":{"$ref":"#/components/schemas/InvoiceTransport"},"lines":{"description":"List of lines of the invoice for the transport associated with this line group.","items":{"$ref":"#/components/schemas/InvoiceLine"},"type":"array"},"description":{"description":"Description of the group of line of the invoice","type":"string"},"currency":{"type":"string"},"gas_index":{"nullable":true,"readOnly":true,"type":"string"},"gas_index_invoice_item":{"$ref":"#/components/schemas/InvoiceItem"}},"type":"object"},"InvoiceTransport":{"properties":{"uid":{"description":"uuid of the Transport","format":"uuid","type":"string"},"sequential_id":{"type":"number"},"deliveries":{"items":{"$ref":"#/components/schemas/InvoiceDelivery"},"type":"array"},"documents":{"description":"See https://developer.dashdoc.eu/docs/tutorials/retrieve-transport-tracking-data#get-documents-and-photos-with-their-type","items":{"$ref":"#/components/schemas/InvoiceDocument"},"type":"array"},"messages":{"description":"See https://developer.dashdoc.eu/docs/tutorials/retrieve-transport-tracking-data#get-documents-and-photos-with-their-type","items":{"$ref":"#/components/schemas/InvoiceMessage"},"type":"array"}},"type":"object"},"InvoiceDelivery":{"properties":{"uid":{"description":"uuid of the Delivery","format":"uuid","type":"string"},"origin":{"$ref":"#/components/schemas/InvoiceSite"},"destination":{"$ref":"#/components/schemas/InvoiceSite"}},"type":"object"},"InvoiceSite":{"properties":{"uid":{"type":"string"},"company_name":{"type":"string"},"city":{"type":"string"}},"type":"object"},"InvoiceDocument":{"properties":{"delivery":{"description":"uuid of the Delivery","format":"uuid","type":"string"},"file":{"description":"path of the document","format":"url","type":"string"},"reference":{"type":"string"},"category":{"description":"Type of document. Possible values are \"cmr\", \"cmr4\", \"ldv\", \"orc\", \"chc\", \"rental\" and \"loading_plan\"","type":"string"}},"type":"object"},"InvoiceMessage":{"properties":{"document":{"description":"path of the document","format":"url","type":"string"},"reference":{"type":"string"},"document_type":{"enum":["load_photo","cmr","washing_note","delivery_note","confirmation","weight_note","waste_manifest","holders_swap_note","invoice"],"maxLength":100,"type":"string"}},"type":"object"},"InvoiceLine":{"properties":{"description":{"description":"Description of the line of the invoice","type":"string"},"quantity":{"type":"number"},"unit_price":{"type":"number"},"currency":{"type":"string"},"total_price_without_tax":{"type":"number"},"invoice_item":{"$ref":"#/components/schemas/InvoiceItem"},"is_gas_indexed":{"description":"Whether this invoice line is subject to gas indexation","nullable":true,"readOnly":true,"type":"boolean"}},"type":"object"},"InvoiceItem":{"properties":{"uid":{"format":"uuid","type":"string"},"remote_id":{"description":"The id of the invoice item in your system","type":"string"},"description":{"description":"Default description when a user selects this invoice item for an invoice line","type":"string"}},"type":"object"},"Invoice_period":{"description":"The interval between the date of first loading and last unloading among all the transports of the invoice.","properties":{"first_loading_at":{"description":"Date of first loading among all the transports of the invoice.","format":"date-time","nullable":true,"type":"string"},"last_unloading_at":{"description":"Date of last unloading among all the transports of the invoice.","format":"date-time","nullable":true,"type":"string"}},"type":"object"}}}}
```

## The UpdateInvoice object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"UpdateInvoice":{"properties":{"file":{"description":"Invoice file content. **Use content-type with `multipart/form-data` value to the header of the request to send a document.**","format":"byte","type":"object"},"document_number":{"description":"The invoice number","maxLength":64,"type":"string"},"invoicing_date":{"description":"Date of invoicing.","format":"date","type":"string"},"debtor_reference":{"description":"Pre-billing reference. **Can only be set for a draft invoice**","type":"string"},"buyer_reference":{"description":"Reference assigned by the buyer, carried as BT-10 on the electronic invoice. **Can only be set for a draft invoice**","maxLength":50,"type":"string"},"project_reference":{"description":"Project reference, carried as BT-11 on the electronic invoice. **Can only be set for a draft invoice**","maxLength":50,"type":"string"},"contract_reference":{"description":"Contract reference, carried as BT-12 on the electronic invoice. **Can only be set for a draft invoice**","maxLength":50,"type":"string"},"purchase_order_reference":{"description":"Purchase order reference assigned by the customer, carried as BT-13 on the electronic invoice. **Can only be set for a draft invoice**","maxLength":50,"type":"string"}},"type":"object"}}}}
```

## The InviteManager object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"InviteManager":{"properties":{"first_name":{"type":"string"},"last_name":{"type":"string"},"email":{"format":"email","type":"string"},"role":{"description":"**Note:** Only 1 role is accepted as input for this endpoint.\n","enum":["admin","user","readonly"],"type":"string"}},"required":["email","first_name","last_name","role"],"type":"object"}}}}
```

## The Manager object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"Manager":{"properties":{"pk":{"description":"Dashdoc's internal id.","type":"number"},"display_name":{"type":"string"},"user":{"$ref":"#/components/schemas/User"},"role":{"description":"**Note:** If the manager has multiple roles, only 1 of them is returned.\n","enum":["admin","user","readonly"],"type":"string"},"remote_id":{"type":"string"},"phone_number":{"type":"string"},"personas":{"nullable":true,"type":"string"},"current_company":{"$ref":"#/components/schemas/Company"}},"required":["current_company","display_name","pk","role","shipment_columns","transport_columns"],"type":"object"},"User":{"properties":{"pk":{"description":"Dashdoc's internal id.","type":"number"},"username":{"description":"Ignore. Dashdoc technical data.","type":"string"},"display_name":{"description":"Display name generated by Dashdoc.","type":"string"},"email":{"format":"email","type":"string"},"date_joined":{"description":"Ignore. Dashdoc technical data.","format":"date-time","type":"string"},"last_login":{"description":"Ignore. Dashdoc technical data.","format":"date-time","type":"string"},"has_usable_password":{"description":"Ignore. Dashdoc technical data.","type":"boolean"},"first_name":{"type":"string"},"last_name":{"type":"string"}},"type":"object"},"Company":{"properties":{"pk":{"description":"Dashdoc's internal id.","type":"number"},"remote_id":{"type":"string"},"created":{"format":"date-time","type":"object"},"updated":{"format":"date-time","type":"string"},"deleted":{"type":"boolean"},"invoicing_remote_id":{"description":"The id of the company in your invoicing system.","type":"string"},"name":{"type":"string"},"phone_number":{"type":"string"},"email":{"type":"string"},"siren":{"type":"string"},"trade_number":{"type":"string"},"country":{"$ref":"#/components/schemas/country"},"comments":{"type":"string"},"vat_number":{"type":"string"},"is_verified":{"type":"boolean"},"settings_transport_order_observations":{"type":"string"},"settings_constrain_reference_edition":{"type":"boolean"},"account_type":{"description":"Ignore. Dashdoc technical data.","type":"string"},"logo":{"description":"The URL of your logo","nullable":true,"type":"string"},"subscription_access":{"type":"object"},"settings":{"type":"object"},"primary_address":{"$ref":"#/components/schemas/PrimaryAddress_1"},"managers":{"items":{"$ref":"#/components/schemas/Managers"},"type":"array"},"has_loggable_managers":{"description":"Ignore. Dashdoc technical data.","type":"boolean"}},"type":"object"},"country":{"description":"Only the 2-character codification is accepted (ISO 3166-1 alpha-2)","type":"string"},"PrimaryAddress_1":{"properties":{"pk":{"description":"Dashdoc's internal id.","type":"number"},"name":{"type":"string"},"address":{"type":"string"},"city":{"type":"string"},"postcode":{"type":"string"},"country":{"$ref":"#/components/schemas/country"},"latitude":{"$ref":"#/components/schemas/latitude"},"longitude":{"$ref":"#/components/schemas/longitude"},"radius":{"default":500,"description":"Radius around the GPS coordinates within which the address is located (in meters)","type":"integer"},"coords_validated":{"default":false,"description":"if `true`, when this address is used as a loading or unloading site, the mobile app displays an itinerary button to start GPS app with guidance to these coordinates","type":"boolean"},"is_demo":{"$ref":"#/components/schemas/is_demo"},"is_carrier":{"description":"Whether this company is considered a carrier","type":"boolean"},"is_shipper":{"description":"Whether this company is considered a shipper","type":"boolean"},"is_origin":{"description":"Legacy, not relevant for a company's primary address. Consider creating a separate address associated with this partner instead.\n","type":"boolean"},"is_destination":{"description":"Legacy, not relevant for a company's primary address. Consider creating a separate address associated with this partner instead.\n","type":"boolean"},"created_by":{"$ref":"#/components/schemas/created-by"},"created_by_user":{"$ref":"#/components/schemas/created-by-user"},"created":{"$ref":"#/components/schemas/created"},"remote_id":{"description":"The id of the address in your system.","type":"string"}},"type":"object"},"latitude":{"description":"Latitude using the decimal GPS coordinates (WGS84). At 7 decimals, the position is accurate around the centimeter.","format":"float","nullable":true,"type":"number"},"longitude":{"description":"Longitude using the decimal GPS coordinates (WGS84). At 7 decimals, the position is accurate around the centimeter.","format":"float","nullable":true,"type":"number"},"is_demo":{"description":"Indicates that the address is a fake one created from demonstration. Everything linked to it will be deleted when using the 'Delete demo content' button in company parameters","type":"boolean"},"created-by":{"nullable":true,"properties":{"pk":{"description":"company id","type":"number"},"name":{"description":"name of the company","type":"string"}},"type":"object"},"created-by-user":{"nullable":true,"properties":{"pk":{"type":"number"},"display_name":{"type":"string"},"company":{"description":"The company id who created the address","type":"number"},"trucker_id":{"description":"The trucker id who created the address","type":"number"}},"type":"object"},"created":{"description":"Date of creation on our server","format":"date-time","type":"string"},"Managers":{"properties":{"pk":{"description":"Dashdoc's internal id.","type":"number"},"user":{"$ref":"#/components/schemas/Managers_user"},"display_name":{"type":"string"},"role":{"type":"string"}},"type":"object"},"Managers_user":{"properties":{"email":{"format":"email","type":"string"},"first_name":{"type":"string"},"last_name":{"type":"string"}},"type":"object"}}}}
```

## The UpdateManager object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"UpdateManager":{"properties":{"role":{"enum":["admin","user","readonly"],"type":"string"},"user":{"$ref":"#/components/schemas/UpdateManager_user"}},"type":"object"},"UpdateManager_user":{"properties":{"pk":{"description":"Dashdoc's internal id.","type":"number"},"first_name":{"type":"string"},"last_name":{"type":"string"},"email":{"description":"Another manager's email can only be changed if they have access to no company other than yours (403 `cannot_update_email` otherwise).","format":"email","type":"string"}},"required":["pk"],"type":"object"}}}}
```

## The Truckers object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"Truckers":{"properties":{"count":{"type":"integer"},"next":{"nullable":true,"type":"string"},"previous":{"nullable":true,"type":"string"},"results":{"items":{"$ref":"#/components/schemas/Trucker"},"type":"array"}},"type":"object"},"Trucker":{"properties":{"pk":{"description":"Dashdoc's internal id.","type":"number"},"user":{"$ref":"#/components/schemas/User"},"phone_number":{"type":"string"},"invite_code":{"description":"Invite code trucker needs to connect to mobile app. The code is generated by Dashdoc.","type":"string"},"app_version":{"description":"Ignore. Dashdoc technical data.","type":"number"},"readable_app_version":{"description":"Ignore. Dashdoc technical data.","type":"string"},"platform":{"description":"Ignore. Dashdoc technical data.","type":"string"},"remote_id":{"description":"The ID of the trucker in your system. It has to be unique among all your truckers.","type":"string"},"carrier":{"$ref":"#/components/schemas/Company"},"is_rented":{"type":"boolean"},"phone_number_personal":{"type":"string"},"address":{"type":"string"},"postcode":{"type":"string"},"city":{"type":"string"},"country_code":{"$ref":"#/components/schemas/country"},"driving_license_number":{"type":"string"},"driving_license_deadline":{"format":"date-time","type":"string"},"adr_license_deadline":{"format":"date-time","type":"string"},"carrist_license_deadline":{"format":"date-time","type":"string"},"occupational_health_visit_deadline":{"format":"date-time","type":"string"},"new_app_update_available":{"description":"Ignore. Dashdoc technical data.","type":"boolean"},"unavailability":{"description":"List of unavailable period","items":{"$ref":"#/components/schemas/Unavailability"},"type":"array"},"events":{"description":"Ignore. Dashdoc technical data.","items":{"type":"object"},"type":"array"},"tags":{"description":"List of tags applied to the trucker.","items":{"$ref":"#/components/schemas/Tag"},"type":"array"}},"type":"object"},"User":{"properties":{"pk":{"description":"Dashdoc's internal id.","type":"number"},"username":{"description":"Ignore. Dashdoc technical data.","type":"string"},"display_name":{"description":"Display name generated by Dashdoc.","type":"string"},"email":{"format":"email","type":"string"},"date_joined":{"description":"Ignore. Dashdoc technical data.","format":"date-time","type":"string"},"last_login":{"description":"Ignore. Dashdoc technical data.","format":"date-time","type":"string"},"has_usable_password":{"description":"Ignore. Dashdoc technical data.","type":"boolean"},"first_name":{"type":"string"},"last_name":{"type":"string"}},"type":"object"},"Company":{"properties":{"pk":{"description":"Dashdoc's internal id.","type":"number"},"remote_id":{"type":"string"},"created":{"format":"date-time","type":"object"},"updated":{"format":"date-time","type":"string"},"deleted":{"type":"boolean"},"invoicing_remote_id":{"description":"The id of the company in your invoicing system.","type":"string"},"name":{"type":"string"},"phone_number":{"type":"string"},"email":{"type":"string"},"siren":{"type":"string"},"trade_number":{"type":"string"},"country":{"$ref":"#/components/schemas/country"},"comments":{"type":"string"},"vat_number":{"type":"string"},"is_verified":{"type":"boolean"},"settings_transport_order_observations":{"type":"string"},"settings_constrain_reference_edition":{"type":"boolean"},"account_type":{"description":"Ignore. Dashdoc technical data.","type":"string"},"logo":{"description":"The URL of your logo","nullable":true,"type":"string"},"subscription_access":{"type":"object"},"settings":{"type":"object"},"primary_address":{"$ref":"#/components/schemas/PrimaryAddress_1"},"managers":{"items":{"$ref":"#/components/schemas/Managers"},"type":"array"},"has_loggable_managers":{"description":"Ignore. Dashdoc technical data.","type":"boolean"}},"type":"object"},"country":{"description":"Only the 2-character codification is accepted (ISO 3166-1 alpha-2)","type":"string"},"PrimaryAddress_1":{"properties":{"pk":{"description":"Dashdoc's internal id.","type":"number"},"name":{"type":"string"},"address":{"type":"string"},"city":{"type":"string"},"postcode":{"type":"string"},"country":{"$ref":"#/components/schemas/country"},"latitude":{"$ref":"#/components/schemas/latitude"},"longitude":{"$ref":"#/components/schemas/longitude"},"radius":{"default":500,"description":"Radius around the GPS coordinates within which the address is located (in meters)","type":"integer"},"coords_validated":{"default":false,"description":"if `true`, when this address is used as a loading or unloading site, the mobile app displays an itinerary button to start GPS app with guidance to these coordinates","type":"boolean"},"is_demo":{"$ref":"#/components/schemas/is_demo"},"is_carrier":{"description":"Whether this company is considered a carrier","type":"boolean"},"is_shipper":{"description":"Whether this company is considered a shipper","type":"boolean"},"is_origin":{"description":"Legacy, not relevant for a company's primary address. Consider creating a separate address associated with this partner instead.\n","type":"boolean"},"is_destination":{"description":"Legacy, not relevant for a company's primary address. Consider creating a separate address associated with this partner instead.\n","type":"boolean"},"created_by":{"$ref":"#/components/schemas/created-by"},"created_by_user":{"$ref":"#/components/schemas/created-by-user"},"created":{"$ref":"#/components/schemas/created"},"remote_id":{"description":"The id of the address in your system.","type":"string"}},"type":"object"},"latitude":{"description":"Latitude using the decimal GPS coordinates (WGS84). At 7 decimals, the position is accurate around the centimeter.","format":"float","nullable":true,"type":"number"},"longitude":{"description":"Longitude using the decimal GPS coordinates (WGS84). At 7 decimals, the position is accurate around the centimeter.","format":"float","nullable":true,"type":"number"},"is_demo":{"description":"Indicates that the address is a fake one created from demonstration. Everything linked to it will be deleted when using the 'Delete demo content' button in company parameters","type":"boolean"},"created-by":{"nullable":true,"properties":{"pk":{"description":"company id","type":"number"},"name":{"description":"name of the company","type":"string"}},"type":"object"},"created-by-user":{"nullable":true,"properties":{"pk":{"type":"number"},"display_name":{"type":"string"},"company":{"description":"The company id who created the address","type":"number"},"trucker_id":{"description":"The trucker id who created the address","type":"number"}},"type":"object"},"created":{"description":"Date of creation on our server","format":"date-time","type":"string"},"Managers":{"properties":{"pk":{"description":"Dashdoc's internal id.","type":"number"},"user":{"$ref":"#/components/schemas/Managers_user"},"display_name":{"type":"string"},"role":{"type":"string"}},"type":"object"},"Managers_user":{"properties":{"email":{"format":"email","type":"string"},"first_name":{"type":"string"},"last_name":{"type":"string"}},"type":"object"},"Unavailability":{"properties":{"id":{"description":"Dashdoc's internal id","type":"number"},"remote_id":{"description":"The ID of the unavailability in your system","type":"string"},"created":{"description":"Date of creation on our server","format":"date-time","type":"string"},"start_date":{"description":"Start date of the unavailability","format":"date-time","type":"string"},"end_date":{"description":"End date of the unavailability","format":"date-time","type":"string"},"unavailability_type":{"description":"Type of unavailability","enum":["paid_vacation","day_off","sick_leave","training","vacation","maintenance","rental","other"],"type":"string"},"unavailability_note":{"description":"Notes about the unavailability","type":"string"}},"type":"object"},"Tag":{"properties":{"pk":{"description":"The unique identifier of the tag","type":"integer"},"name":{"description":"The name of the tag","type":"string"},"color":{"description":"The color of the tag in hex format","type":"string"},"tag_group_id":{"description":"The ID of the tag group this tag belongs to, if any","nullable":true,"type":"integer"}},"required":["color","name","pk"],"type":"object"}}}}
```

## The NewTrucker object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"NewTrucker":{"properties":{"user":{"$ref":"#/components/schemas/NewUser"},"phone_number":{"maxLength":100,"type":"string"},"remote_id":{"description":"The ID of the trucker in your system. It has to be unique among all your truckers.","type":"string"},"tags":{"description":"List of tags applied to the vehicle.","items":{"$ref":"#/components/schemas/Tag"},"type":"array"}},"required":["user"],"type":"object"},"NewUser":{"properties":{"email":{"format":"email","type":"string"},"first_name":{"maxLength":200,"type":"string"},"last_name":{"maxLength":200,"type":"string"}},"type":"object"},"Tag":{"properties":{"pk":{"description":"The unique identifier of the tag","type":"integer"},"name":{"description":"The name of the tag","type":"string"},"color":{"description":"The color of the tag in hex format","type":"string"},"tag_group_id":{"description":"The ID of the tag group this tag belongs to, if any","nullable":true,"type":"integer"}},"required":["color","name","pk"],"type":"object"}}}}
```

## The Trucker object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"Trucker":{"properties":{"pk":{"description":"Dashdoc's internal id.","type":"number"},"user":{"$ref":"#/components/schemas/User"},"phone_number":{"type":"string"},"invite_code":{"description":"Invite code trucker needs to connect to mobile app. The code is generated by Dashdoc.","type":"string"},"app_version":{"description":"Ignore. Dashdoc technical data.","type":"number"},"readable_app_version":{"description":"Ignore. Dashdoc technical data.","type":"string"},"platform":{"description":"Ignore. Dashdoc technical data.","type":"string"},"remote_id":{"description":"The ID of the trucker in your system. It has to be unique among all your truckers.","type":"string"},"carrier":{"$ref":"#/components/schemas/Company"},"is_rented":{"type":"boolean"},"phone_number_personal":{"type":"string"},"address":{"type":"string"},"postcode":{"type":"string"},"city":{"type":"string"},"country_code":{"$ref":"#/components/schemas/country"},"driving_license_number":{"type":"string"},"driving_license_deadline":{"format":"date-time","type":"string"},"adr_license_deadline":{"format":"date-time","type":"string"},"carrist_license_deadline":{"format":"date-time","type":"string"},"occupational_health_visit_deadline":{"format":"date-time","type":"string"},"new_app_update_available":{"description":"Ignore. Dashdoc technical data.","type":"boolean"},"unavailability":{"description":"List of unavailable period","items":{"$ref":"#/components/schemas/Unavailability"},"type":"array"},"events":{"description":"Ignore. Dashdoc technical data.","items":{"type":"object"},"type":"array"},"tags":{"description":"List of tags applied to the trucker.","items":{"$ref":"#/components/schemas/Tag"},"type":"array"}},"type":"object"},"User":{"properties":{"pk":{"description":"Dashdoc's internal id.","type":"number"},"username":{"description":"Ignore. Dashdoc technical data.","type":"string"},"display_name":{"description":"Display name generated by Dashdoc.","type":"string"},"email":{"format":"email","type":"string"},"date_joined":{"description":"Ignore. Dashdoc technical data.","format":"date-time","type":"string"},"last_login":{"description":"Ignore. Dashdoc technical data.","format":"date-time","type":"string"},"has_usable_password":{"description":"Ignore. Dashdoc technical data.","type":"boolean"},"first_name":{"type":"string"},"last_name":{"type":"string"}},"type":"object"},"Company":{"properties":{"pk":{"description":"Dashdoc's internal id.","type":"number"},"remote_id":{"type":"string"},"created":{"format":"date-time","type":"object"},"updated":{"format":"date-time","type":"string"},"deleted":{"type":"boolean"},"invoicing_remote_id":{"description":"The id of the company in your invoicing system.","type":"string"},"name":{"type":"string"},"phone_number":{"type":"string"},"email":{"type":"string"},"siren":{"type":"string"},"trade_number":{"type":"string"},"country":{"$ref":"#/components/schemas/country"},"comments":{"type":"string"},"vat_number":{"type":"string"},"is_verified":{"type":"boolean"},"settings_transport_order_observations":{"type":"string"},"settings_constrain_reference_edition":{"type":"boolean"},"account_type":{"description":"Ignore. Dashdoc technical data.","type":"string"},"logo":{"description":"The URL of your logo","nullable":true,"type":"string"},"subscription_access":{"type":"object"},"settings":{"type":"object"},"primary_address":{"$ref":"#/components/schemas/PrimaryAddress_1"},"managers":{"items":{"$ref":"#/components/schemas/Managers"},"type":"array"},"has_loggable_managers":{"description":"Ignore. Dashdoc technical data.","type":"boolean"}},"type":"object"},"country":{"description":"Only the 2-character codification is accepted (ISO 3166-1 alpha-2)","type":"string"},"PrimaryAddress_1":{"properties":{"pk":{"description":"Dashdoc's internal id.","type":"number"},"name":{"type":"string"},"address":{"type":"string"},"city":{"type":"string"},"postcode":{"type":"string"},"country":{"$ref":"#/components/schemas/country"},"latitude":{"$ref":"#/components/schemas/latitude"},"longitude":{"$ref":"#/components/schemas/longitude"},"radius":{"default":500,"description":"Radius around the GPS coordinates within which the address is located (in meters)","type":"integer"},"coords_validated":{"default":false,"description":"if `true`, when this address is used as a loading or unloading site, the mobile app displays an itinerary button to start GPS app with guidance to these coordinates","type":"boolean"},"is_demo":{"$ref":"#/components/schemas/is_demo"},"is_carrier":{"description":"Whether this company is considered a carrier","type":"boolean"},"is_shipper":{"description":"Whether this company is considered a shipper","type":"boolean"},"is_origin":{"description":"Legacy, not relevant for a company's primary address. Consider creating a separate address associated with this partner instead.\n","type":"boolean"},"is_destination":{"description":"Legacy, not relevant for a company's primary address. Consider creating a separate address associated with this partner instead.\n","type":"boolean"},"created_by":{"$ref":"#/components/schemas/created-by"},"created_by_user":{"$ref":"#/components/schemas/created-by-user"},"created":{"$ref":"#/components/schemas/created"},"remote_id":{"description":"The id of the address in your system.","type":"string"}},"type":"object"},"latitude":{"description":"Latitude using the decimal GPS coordinates (WGS84). At 7 decimals, the position is accurate around the centimeter.","format":"float","nullable":true,"type":"number"},"longitude":{"description":"Longitude using the decimal GPS coordinates (WGS84). At 7 decimals, the position is accurate around the centimeter.","format":"float","nullable":true,"type":"number"},"is_demo":{"description":"Indicates that the address is a fake one created from demonstration. Everything linked to it will be deleted when using the 'Delete demo content' button in company parameters","type":"boolean"},"created-by":{"nullable":true,"properties":{"pk":{"description":"company id","type":"number"},"name":{"description":"name of the company","type":"string"}},"type":"object"},"created-by-user":{"nullable":true,"properties":{"pk":{"type":"number"},"display_name":{"type":"string"},"company":{"description":"The company id who created the address","type":"number"},"trucker_id":{"description":"The trucker id who created the address","type":"number"}},"type":"object"},"created":{"description":"Date of creation on our server","format":"date-time","type":"string"},"Managers":{"properties":{"pk":{"description":"Dashdoc's internal id.","type":"number"},"user":{"$ref":"#/components/schemas/Managers_user"},"display_name":{"type":"string"},"role":{"type":"string"}},"type":"object"},"Managers_user":{"properties":{"email":{"format":"email","type":"string"},"first_name":{"type":"string"},"last_name":{"type":"string"}},"type":"object"},"Unavailability":{"properties":{"id":{"description":"Dashdoc's internal id","type":"number"},"remote_id":{"description":"The ID of the unavailability in your system","type":"string"},"created":{"description":"Date of creation on our server","format":"date-time","type":"string"},"start_date":{"description":"Start date of the unavailability","format":"date-time","type":"string"},"end_date":{"description":"End date of the unavailability","format":"date-time","type":"string"},"unavailability_type":{"description":"Type of unavailability","enum":["paid_vacation","day_off","sick_leave","training","vacation","maintenance","rental","other"],"type":"string"},"unavailability_note":{"description":"Notes about the unavailability","type":"string"}},"type":"object"},"Tag":{"properties":{"pk":{"description":"The unique identifier of the tag","type":"integer"},"name":{"description":"The name of the tag","type":"string"},"color":{"description":"The color of the tag in hex format","type":"string"},"tag_group_id":{"description":"The ID of the tag group this tag belongs to, if any","nullable":true,"type":"integer"}},"required":["color","name","pk"],"type":"object"}}}}
```

## The LeaseTrucker object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"LeaseTrucker":{"properties":{"tenant_carrier":{"$ref":"#/components/schemas/LeaseTrucker_tenant_carrier"}},"required":["tenant_carrier"],"type":"object"},"LeaseTrucker_tenant_carrier":{"description":"Carrier to whom you wish to lease the trucker. Identified either by its `pk` or `remote_id`.","properties":{"pk":{"description":"Dashdoc's internal id. Optional, not required if `remote_id` is sent.","type":"number"},"remote_id":{"description":"Your remote carrier id. Optional, ignored if pk is sent.","type":"string"}},"type":"object"}}}}
```

## The LeaseTruckerManagerNotFoundError object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"LeaseTruckerManagerNotFoundError":{"properties":{"non_field_errors":{"$ref":"#/components/schemas/LeaseTruckerManagerNotFoundError_non_field_errors"}},"type":"object"},"LeaseTruckerManagerNotFoundError_non_field_errors":{"properties":{"code":{"items":{"type":"string"},"type":"array"},"detail":{"items":{"type":"string"},"type":"array"}},"type":"object"}}}}
```

## The LeaseTruckerManagerNotLinkedError object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"LeaseTruckerManagerNotLinkedError":{"properties":{"non_field_errors":{"$ref":"#/components/schemas/LeaseTruckerManagerNotLinkedError_non_field_errors"}},"type":"object"},"LeaseTruckerManagerNotLinkedError_non_field_errors":{"properties":{"code":{"items":{"type":"string"},"type":"array"},"detail":{"items":{"type":"string"},"type":"array"}},"type":"object"}}}}
```

## The CreateUnavailability object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"CreateUnavailability":{"properties":{"remote_id":{"description":"The ID of the unavailability in your system","type":"string"},"created":{"description":"Date of creation on our server","format":"date-time","type":"string"},"start_date":{"description":"Start date of the unavailability","format":"date-time","type":"string"},"end_date":{"description":"End date of the unavailability","format":"date-time","type":"string"},"unavailability_type":{"description":"Type of unavailability","enum":["paid_vacation","day_off","sick_leave","training","vacation","maintenance","rental","other"],"type":"string"},"unavailability_note":{"description":"Notes about the unavailability","type":"string"}},"type":"object"}}}}
```

## The UpdateUnavailability object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"UpdateUnavailability":{"properties":{"remote_id":{"description":"The ID of the unavailability in your system","type":"string"},"created":{"description":"Date of creation on our server","format":"date-time","type":"string"},"start_date":{"description":"Start date of the unavailability","format":"date-time","type":"string"},"end_date":{"description":"End date of the unavailability","format":"date-time","type":"string"},"unavailability_type":{"description":"Type of unavailability","enum":["paid_vacation","day_off","sick_leave","training","vacation","maintenance","rental","other"],"type":"string"},"unavailability_note":{"description":"Notes about the unavailability","type":"string"}},"type":"object"}}}}
```

## The NewSecurityProtocols object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"NewSecurityProtocols":{"properties":{"address":{"description":"Id of the address the security protocol should be linked.","type":"number"},"document":{"description":"File content, as a PDF, PNG or JPEG file (`.pdf`, `.png`, `.jpg` or `.jpeg` file name), the formats drivers can open in the Dashdoc app. **Use content-type with `multipart/form-data` value to the header of the request to send a document.**","format":"byte","type":"string"},"document_title":{"description":"Filename","type":"string"}},"required":["address","document"],"type":"object"}}}}
```

## The UpdateSecurityProtocol object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"UpdateSecurityProtocol":{"properties":{"address":{"description":"Id of the address that the security protocol should be linked to.","type":"number"},"document":{"description":"File content, as a PDF, PNG or JPEG file (`.pdf`, `.png`, `.jpg` or `.jpeg` file name), the formats drivers can open in the Dashdoc app. **Use content-type with `multipart/form-data` value to the header of the request to send a document.**","format":"byte","type":"string"},"document_title":{"description":"Filename","type":"string"}},"type":"object"}}}}
```

## The UpdateSegment object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"UpdateSegment":{"properties":{"remote_id":{"description":"The id of the segment in your system.","type":"string"},"origin":{"$ref":"#/components/schemas/CreateOrUpdateSite_1"},"destination":{"$ref":"#/components/schemas/CreateOrUpdateSite_1"},"vehicle":{"$ref":"#/components/schemas/VehicleForSegment"},"trailers":{"items":{"$ref":"#/components/schemas/TrailerForSegment"},"type":"array"},"trucker_id":{"$ref":"#/components/schemas/UpdateSegment_trucker_id"},"scheduled_start_range":{"$ref":"#/components/schemas/UpdateSegment_scheduled_start_range"},"scheduled_end_range":{"$ref":"#/components/schemas/UpdateSegment_scheduled_end_range"},"scheduled_start":{"deprecated":true,"description":"The scheduled date and time of arrival at the origin (ISO 8601)","type":"string"},"scheduled_end":{"deprecated":true,"description":"The scheduled date and time of arrival at the destination (ISO 8601)","type":"string"}},"required":["origin"],"type":"object"},"CreateOrUpdateSite_1":{"properties":{"remote_id":{"description":"The id of the site in your system","type":"string"},"address":{"$ref":"#/components/schemas/AddressGetOrCreate"},"loading_instructions":{"$ref":"#/components/schemas/loading_instructions"},"unloading_instructions":{"$ref":"#/components/schemas/unloading_instructions"},"instructions":{"$ref":"#/components/schemas/site_instructions"},"reference":{"type":"string"},"action":{"deprecated":true,"description":"Deprecated. Accepted for backward compatibility but ignored.","type":"string"},"eta":{"nullable":true,"type":"string"},"supports_exchanges":{"$ref":"#/components/schemas/CreateOrUpdateSupportsExchangeForTransport"},"arrival_date":{"description":"expected arrival date (YYYY-MM-DD)","format":"date","type":"string"},"arrival_time_min":{"description":"expected arrival min time (HH:mm)","type":"string"},"arrival_time_max":{"description":"expected arrival max time (HH:mm)","type":"string"},"date_exact":{"description":"if `true`, `arrival_time_max` is considered as being on the following day from `arrival_date`","type":"boolean"},"trucker_instructions":{"$ref":"#/components/schemas/trucker_instructions"}},"type":"object"},"AddressGetOrCreate":{"description":"Identification of the address. You may simply use its `pk` or `remote_id` if the address already exists, or you can send address details as in /addresses/ web service. The address may be recognized with its details or if it doesn't exist, the address will be created with the information you send based on what's possible when creating an address via /addresses/ web service.","properties":{"pk":{"description":"Dashdoc's internal id.","type":"number"},"remote_id":{"description":"The id of the address in your system.","type":"string"}},"type":"object"},"loading_instructions":{"deprecated":true,"description":"**Prefer using the field `instructions`.** Loading instructions, visible to all parties (trucker, carrier, shipper, site). Displayed in the trucker mobile app. Not visible in the eCMR.","maxLength":1000,"type":"string"},"unloading_instructions":{"deprecated":true,"description":"**Prefer using the field `instructions`.** Unloading instructions, visible to all parties (trucker, carrier, shipper, site). Displayed in the trucker mobile app. Not visible in the eCMR.","maxLength":1000,"type":"string"},"site_instructions":{"description":"Site instructions, visible to all parties (trucker, carrier, shipper, site). Displayed in the trucker mobile app. Not visible in the eCMR. If the field is not provided, the address's site instructions will be used.","maxLength":1000,"type":"string"},"CreateOrUpdateSupportsExchangeForTransport":{"properties":{"support_type":{"$ref":"#/components/schemas/CreateOrUpdateSupportsExchangeForTransport_support_type"},"expected_retrieved":{"description":"Expected number of supports that should be retrieved on the site","type":"number"},"actual_retrieved":{"description":"Actual number of supports that were retrieved on the site","type":"number"},"expected_delivered":{"description":"Expected number of supports that should be delivered on the site","type":"number"},"actual_delivered":{"description":"Actual number of supports that were delivered on the site","type":"number"},"observations":{"description":"Free text. Observations about this supports exchange. Can be filled on mobile app, web app or via API.","type":"string"}},"required":["support_type"],"type":"object"},"CreateOrUpdateSupportsExchangeForTransport_support_type":{"description":"Type of the supports that are exchanged","properties":{"uid":{"format":"uuid","type":"string"},"remote_id":{"description":"The id of the support type in your system.","type":"string"}},"type":"object"},"trucker_instructions":{"description":"**This field is part of a beta feature.** Private instructions. **The carrier of the transport is the only one who can edit and read those instructions.** Note that those instructions are not visible in the consignment note and can be accessed by the trucker. The value is null if the caller doesn't have the right of access to the data.","maxLength":1000,"type":"string"},"VehicleForSegment":{"properties":{"license_plate":{"description":"License plate number. Creates a new vehicle if unknown.","maxLength":200,"type":"string"}},"type":"object"},"TrailerForSegment":{"properties":{"license_plate":{"description":"License plate number. Creates a new trailer if unknown.","maxLength":200,"type":"string"}},"type":"object"},"UpdateSegment_trucker_id":{"properties":{"pk":{"description":"Dashdoc's internal id. Optional, not required if `remote_id` is sent.","type":"number"},"remote_id":{"description":"The ID of the trucker in your system. Optional, ignored if pk is sent.","type":"string"}},"type":"object"},"UpdateSegment_scheduled_start_range":{"description":"The scheduled date and time range of arrival at the origin (ISO 8601)","properties":{"start":{"description":"Min scheduled date and time of arrival at the origin (ISO 8601)","type":"string"},"end":{"description":"Max scheduled date and time of arrival at the origin (ISO 8601)","type":"string"}},"type":"object"},"UpdateSegment_scheduled_end_range":{"description":"The scheduled date and time range of arrival at the destination (ISO 8601)","properties":{"start":{"description":"Min scheduled date and time of arrival at the destination (ISO 8601)","type":"string"},"end":{"description":"Max scheduled date and time of arrival at the destination (ISO 8601)","type":"string"}},"type":"object"}}}}
```

## The Segment object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"Segment":{"description":"","properties":{"uid":{"minLength":1,"type":"string"},"remote_id":{"minLength":1,"type":"string"},"origin":{"$ref":"#/components/schemas/Site"},"destination":{"$ref":"#/components/schemas/Site"},"trucker":{"$ref":"#/components/schemas/SegmentTrucker"},"vehicle":{"$ref":"#/components/schemas/Vehicle"},"trailers":{"items":{"$ref":"#/components/schemas/Trailer"},"type":"array"},"sort_order":{"description":"The index of the segment in the transport","minimum":0,"type":"number"},"scheduled_start_range":{"$ref":"#/components/schemas/Segment_scheduled_start_range"},"scheduled_end_range":{"$ref":"#/components/schemas/Segment_scheduled_end_range"},"scheduled_start":{"deprecated":true,"description":"The datetime at which the carrier scheduled the start of this segment\n","type":"string"},"scheduled_end":{"deprecated":true,"description":"The datetime at which the carrier scheduled the end of this segment","type":"string"},"child_transport":{"$ref":"#/components/schemas/Segment_child_transport"},"telematic_distance":{"description":"Automatically computed distance from telematic data (in kms).","type":"integer"},"distance":{"description":"Manually entered distance. If null, it takes the value of telematic_distance (in kms).","type":"integer"},"origin_mileage":{"description":"Mileage at transport origin site (in kms).","type":"integer"},"destination_mileage":{"description":"Mileage at transport destination site (in kms).","type":"integer"}},"type":"object"},"Site":{"properties":{"uid":{"format":"uuid","type":"string"},"remote_id":{"description":"The id of the site in your system","type":"string"},"address":{"$ref":"#/components/schemas/Address"},"real_start":{"description":"date and time when trucker arrived on site","format":"date-time","type":"string"},"real_end":{"description":"date and time when trucker completed loading / unloading (depending whether site is origin or destination)","format":"date-time","type":"string"},"signature_process":{"type":"string"},"instructions":{"$ref":"#/components/schemas/site_instructions"},"reference":{"type":"string"},"action":{"deprecated":true,"description":"Deprecated. Always returned as an empty string.","type":"string"},"eta":{"nullable":true,"type":"string"},"eta_tracking":{"$ref":"#/components/schemas/eta_tracking"},"punctuality_status":{"$ref":"#/components/schemas/punctuality_status"},"supports_exchanges":{"$ref":"#/components/schemas/SupportsExchange"},"category":{"enum":["loading","unloading"],"type":"string"},"slots":{"items":{"$ref":"#/components/schemas/Site_slots"},"type":"array"},"trucker_instructions":{"$ref":"#/components/schemas/trucker_instructions"},"trip":{"$ref":"#/components/schemas/Site_trip"}},"type":"object"},"Address":{"properties":{"pk":{"description":"Dashdoc's internal id.","type":"number"},"name":{"type":"string"},"address":{"type":"string"},"city":{"type":"string"},"postcode":{"type":"string"},"country":{"$ref":"#/components/schemas/country"},"latitude":{"$ref":"#/components/schemas/latitude"},"longitude":{"$ref":"#/components/schemas/longitude"},"radius":{"default":500,"description":"Radius around the GPS coordinates within which the address is located (in meters)","type":"integer"},"coords_validated":{"default":false,"description":"if `true`, when this address is used as a loading or unloading site, the mobile app displays an itinerary button to start GPS app with guidance to these coordinates","type":"boolean"},"is_demo":{"$ref":"#/components/schemas/is_demo"},"is_carrier":{"type":"boolean"},"is_shipper":{"type":"boolean"},"is_origin":{"$ref":"#/components/schemas/address_is_origin_and_is_destination"},"is_destination":{"$ref":"#/components/schemas/address_is_origin_and_is_destination"},"created_by":{"$ref":"#/components/schemas/created-by"},"created_by_user":{"$ref":"#/components/schemas/created-by-user"},"created":{"$ref":"#/components/schemas/created"},"instructions":{"$ref":"#/components/schemas/site_instructions"},"remote_id":{"description":"The id of the address in your system.","type":"string"},"original":{"description":"Dashdoc's internal id of the original address.","nullable":true,"readOnly":true,"type":"number"},"company":{"$ref":"#/components/schemas/Company"}},"type":"object"},"country":{"description":"Only the 2-character codification is accepted (ISO 3166-1 alpha-2)","type":"string"},"latitude":{"description":"Latitude using the decimal GPS coordinates (WGS84). At 7 decimals, the position is accurate around the centimeter.","format":"float","nullable":true,"type":"number"},"longitude":{"description":"Longitude using the decimal GPS coordinates (WGS84). At 7 decimals, the position is accurate around the centimeter.","format":"float","nullable":true,"type":"number"},"is_demo":{"description":"Indicates that the address is a fake one created from demonstration. Everything linked to it will be deleted when using the 'Delete demo content' button in company parameters","type":"boolean"},"address_is_origin_and_is_destination":{"description":"Whether this address is a \"Logistic Points\" and will be usable as pickup/delivery point.\nThe distinction between origin/pickup and destination/delivery was merged as a single \"Logistic Point\" concept. `is_origin` implies `is_destination` and vice-versa.\n","type":"boolean"},"created-by":{"nullable":true,"properties":{"pk":{"description":"company id","type":"number"},"name":{"description":"name of the company","type":"string"}},"type":"object"},"created-by-user":{"nullable":true,"properties":{"pk":{"type":"number"},"display_name":{"type":"string"},"company":{"description":"The company id who created the address","type":"number"},"trucker_id":{"description":"The trucker id who created the address","type":"number"}},"type":"object"},"created":{"description":"Date of creation on our server","format":"date-time","type":"string"},"site_instructions":{"description":"Site instructions, visible to all parties (trucker, carrier, shipper, site). Displayed in the trucker mobile app. Not visible in the eCMR. If the field is not provided, the address's site instructions will be used.","maxLength":1000,"type":"string"},"Company":{"properties":{"pk":{"description":"Dashdoc's internal id.","type":"number"},"remote_id":{"type":"string"},"created":{"format":"date-time","type":"object"},"updated":{"format":"date-time","type":"string"},"deleted":{"type":"boolean"},"invoicing_remote_id":{"description":"The id of the company in your invoicing system.","type":"string"},"name":{"type":"string"},"phone_number":{"type":"string"},"email":{"type":"string"},"siren":{"type":"string"},"trade_number":{"type":"string"},"country":{"$ref":"#/components/schemas/country"},"comments":{"type":"string"},"vat_number":{"type":"string"},"is_verified":{"type":"boolean"},"settings_transport_order_observations":{"type":"string"},"settings_constrain_reference_edition":{"type":"boolean"},"account_type":{"description":"Ignore. Dashdoc technical data.","type":"string"},"logo":{"description":"The URL of your logo","nullable":true,"type":"string"},"subscription_access":{"type":"object"},"settings":{"type":"object"},"primary_address":{"$ref":"#/components/schemas/PrimaryAddress_1"},"managers":{"items":{"$ref":"#/components/schemas/Managers"},"type":"array"},"has_loggable_managers":{"description":"Ignore. Dashdoc technical data.","type":"boolean"}},"type":"object"},"PrimaryAddress_1":{"properties":{"pk":{"description":"Dashdoc's internal id.","type":"number"},"name":{"type":"string"},"address":{"type":"string"},"city":{"type":"string"},"postcode":{"type":"string"},"country":{"$ref":"#/components/schemas/country"},"latitude":{"$ref":"#/components/schemas/latitude"},"longitude":{"$ref":"#/components/schemas/longitude"},"radius":{"default":500,"description":"Radius around the GPS coordinates within which the address is located (in meters)","type":"integer"},"coords_validated":{"default":false,"description":"if `true`, when this address is used as a loading or unloading site, the mobile app displays an itinerary button to start GPS app with guidance to these coordinates","type":"boolean"},"is_demo":{"$ref":"#/components/schemas/is_demo"},"is_carrier":{"description":"Whether this company is considered a carrier","type":"boolean"},"is_shipper":{"description":"Whether this company is considered a shipper","type":"boolean"},"is_origin":{"description":"Legacy, not relevant for a company's primary address. Consider creating a separate address associated with this partner instead.\n","type":"boolean"},"is_destination":{"description":"Legacy, not relevant for a company's primary address. Consider creating a separate address associated with this partner instead.\n","type":"boolean"},"created_by":{"$ref":"#/components/schemas/created-by"},"created_by_user":{"$ref":"#/components/schemas/created-by-user"},"created":{"$ref":"#/components/schemas/created"},"remote_id":{"description":"The id of the address in your system.","type":"string"}},"type":"object"},"Managers":{"properties":{"pk":{"description":"Dashdoc's internal id.","type":"number"},"user":{"$ref":"#/components/schemas/Managers_user"},"display_name":{"type":"string"},"role":{"type":"string"}},"type":"object"},"Managers_user":{"properties":{"email":{"format":"email","type":"string"},"first_name":{"type":"string"},"last_name":{"type":"string"}},"type":"object"},"eta_tracking":{"default":false,"description":"Ask for an ETA on this site. This is currently a beta feature, not activated by default.","type":"boolean"},"punctuality_status":{"default":"untracked","description":"Indicate the punctuality on this site.","enum":["untracked","probably_late","probably_on_time","late","on_time"],"type":"string"},"SupportsExchange":{"properties":{"uid":{"description":"uid of the support exchange","format":"uuid","type":"string"},"site":{"$ref":"#/components/schemas/SupportsExchange_site"},"support_type":{"$ref":"#/components/schemas/SupportType"},"expected_retrieved":{"description":"Expected number of supports that should be retrieved on the site","type":"number"},"actual_retrieved":{"description":"Actual number of supports that were retrieved on the site","type":"number"},"expected_delivered":{"description":"Expected number of supports that should be delivered on the site","type":"number"},"actual_delivered":{"description":"Actual number of supports that were delivered on the site","type":"number"},"observations":{"description":"Free text. Observations about this supports exchange. Can be filled on mobile app, web app or via API.","type":"string"},"remote_id":{"description":"The ID of the support in your system","type":"string"}},"type":"object"},"SupportsExchange_site":{"description":"site where supports exchange is expected","properties":{"uid":{"description":"uid of the site","format":"uuid","type":"string"},"remote_id":{"description":"remote_id of the site","type":"string"}},"type":"object"},"SupportType":{"description":"Type of the supports that are exchanged","properties":{"name":{"description":"Display name of the support type","type":"string"},"created":{"$ref":"#/components/schemas/created"},"uid":{"format":"uuid","type":"string"},"remote_id":{"description":"The id of the support type in your system.","type":"string"}},"type":"object"},"Site_slots":{"properties":{"start":{"format":"date-time","type":"string"},"end":{"format":"date-time","type":"string"}},"type":"object"},"trucker_instructions":{"description":"**This field is part of a beta feature.** Private instructions. **The carrier of the transport is the only one who can edit and read those instructions.** Note that those instructions are not visible in the consignment note and can be accessed by the trucker. The value is null if the caller doesn't have the right of access to the data.","maxLength":1000,"type":"string"},"Site_trip":{"description":"Trip linked to this site/activity.","nullable":true,"properties":{"uid":{"format":"uuid","type":"string"},"name":{"type":"string"},"is_prepared":{"type":"boolean"},"status":{"enum":["unstarted","ongoing","done"],"type":"string"}},"readOnly":true,"type":"object"},"SegmentTrucker":{"properties":{"pk":{"description":"Dashdoc's internal id.","type":"number"},"remote_id":{"description":"The ID of the trucker in your system. It has to be unique among all your truckers.","type":"string"},"display_name":{"type":"string"},"user":{"$ref":"#/components/schemas/SegmentTruckerUser"}},"type":"object"},"SegmentTruckerUser":{"properties":{"pk":{"description":"Dashdoc's internal id.","type":"number"},"first_name":{"type":"string"},"last_name":{"type":"string"},"username":{"description":"Ignore. Dashdoc technical data.","type":"string"},"email":{"format":"email","type":"string"},"display_name":{"description":"Display name generated by Dashdoc.","type":"string"},"date_joined":{"description":"Ignore. Dashdoc technical data.","format":"date-time","type":"string"},"is_staff":{"description":"Ignore. Dashdoc technical data.","type":"boolean"},"is_superuser":{"description":"Ignore. Dashdoc technical data.","type":"boolean"},"has_usable_password":{"description":"Ignore. Dashdoc technical data.","type":"boolean"}},"type":"object"},"Vehicle":{"properties":{"pk":{"description":"Dashdoc's internal id","type":"number"},"carrier":{"description":"Dashdoc's internal id of the carrier owning the vehicle","type":"number"},"category":{"description":"Vehicle category","type":"string"},"license_plate":{"description":"License plate number","type":"string"},"fleet_number":{"description":"Your vehicle fleet number","type":"string"},"remote_id":{"description":"The ID of the vehicle in your system","type":"string"},"created":{"description":"Date of creation on our server","format":"date-time","type":"string"},"used_for_qualimat_transports":{"description":"True if the vehicle can be used for Qualimat transport (only used for visual help and warnings)","type":"boolean"},"telematic_vehicle":{"description":"Ignore. Dashdoc technical data","type":"number"},"original":{"type":"number"},"tags":{"description":"List of tags applied to the vehicle.","items":{"$ref":"#/components/schemas/Tag"},"type":"array"},"technical_control_deadline":{"format":"date-time","type":"string"},"tachograph_deadline":{"format":"date-time","type":"string"},"speed_limiter_deadline":{"format":"date-time","type":"string"},"country":{"$ref":"#/components/schemas/country"},"unavailability":{"description":"List of unavailable period","items":{"$ref":"#/components/schemas/Unavailability"},"type":"array"},"events":{"description":"Ignore. Dashdoc technical data.","items":{"type":"object"},"type":"array"}},"type":"object"},"Tag":{"properties":{"pk":{"description":"The unique identifier of the tag","type":"integer"},"name":{"description":"The name of the tag","type":"string"},"color":{"description":"The color of the tag in hex format","type":"string"},"tag_group_id":{"description":"The ID of the tag group this tag belongs to, if any","nullable":true,"type":"integer"}},"required":["color","name","pk"],"type":"object"},"Unavailability":{"properties":{"id":{"description":"Dashdoc's internal id","type":"number"},"remote_id":{"description":"The ID of the unavailability in your system","type":"string"},"created":{"description":"Date of creation on our server","format":"date-time","type":"string"},"start_date":{"description":"Start date of the unavailability","format":"date-time","type":"string"},"end_date":{"description":"End date of the unavailability","format":"date-time","type":"string"},"unavailability_type":{"description":"Type of unavailability","enum":["paid_vacation","day_off","sick_leave","training","vacation","maintenance","rental","other"],"type":"string"},"unavailability_note":{"description":"Notes about the unavailability","type":"string"}},"type":"object"},"Trailer":{"properties":{"pk":{"description":"Dashdoc's internal id","type":"number"},"original":{"description":"Ignore. Dashdoc technical data","type":"number"},"carrier":{"description":"Dashdoc's internal id of the carrier owning the trailer","type":"number"},"license_plate":{"description":"License plate number","type":"string"},"fleet_number":{"description":"Your trailer fleet number","type":"string"},"remote_id":{"description":"The ID of the trailer in your system","type":"string"},"created":{"description":"Date of creation on our server","format":"date-time","type":"string"},"used_for_qualimat_transports":{"description":"True if the trailer can be used for Qualimat transport (only used for visual help and warnings)","type":"boolean"},"tags":{"description":"List of tags applied to the trailer.","items":{"$ref":"#/components/schemas/Tag"},"type":"array"},"technical_control_deadline":{"format":"date-time","type":"string"},"country":{"$ref":"#/components/schemas/country"},"unavailability":{"description":"List of unavailable period","items":{"$ref":"#/components/schemas/Unavailability"},"type":"array"},"events":{"description":"Ignore. Dashdoc technical data.","items":{"type":"object"},"type":"array"}},"type":"object"},"Segment_scheduled_start_range":{"description":"The datetime range at which the carrier scheduled the start of this segment","properties":{"start":{"description":"Min scheduled start date (ISO 8601)","type":"string"},"end":{"description":"Max scheduled start date (ISO 8601)","type":"string"}},"type":"object"},"Segment_scheduled_end_range":{"description":"The datetime range at which the carrier scheduled the end of this segment","properties":{"start":{"description":"Min scheduled end date (ISO 8601)","type":"string"},"end":{"description":"Max scheduled end date (ISO 8601)","type":"string"}},"type":"object"},"Segment_child_transport":{"description":"If the segment is chartered, will contain the child transport","properties":{"uid":{"format":"uuid","type":"string"},"sequential_id":{"type":"number"},"remote_id":{"type":"string"},"has_strong_link":{"type":"boolean"}},"type":"object"}}}}
```

## The AssignSegment object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"AssignSegment":{"properties":{"send_to_trucker":{"description":"if true, a notification is sent to the trucker on the mobile app","type":"boolean"},"trucker_id":{"$ref":"#/components/schemas/TruckerForSegment"},"vehicle":{"$ref":"#/components/schemas/VehicleForSegment"},"trailers":{"description":"trailers to assign to the segment","items":{"$ref":"#/components/schemas/TrailerForSegment"},"type":"array"}},"type":"object"},"TruckerForSegment":{"properties":{"pk":{"description":"Dashdoc's internal id. Optional, not required if `remote_id` is sent.","type":"number"},"remote_id":{"description":"The ID of the trucker in your system. Optional, ignored if pk is sent.","type":"string"}},"type":"object"},"VehicleForSegment":{"properties":{"license_plate":{"description":"License plate number. Creates a new vehicle if unknown.","maxLength":200,"type":"string"}},"type":"object"},"TrailerForSegment":{"properties":{"license_plate":{"description":"License plate number. Creates a new trailer if unknown.","maxLength":200,"type":"string"}},"type":"object"}}}}
```

## The Transport object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"Transport":{"properties":{"uid":{"description":"Dashdoc's internal id. It will be automatically generated by us.","format":"uuid","type":"string"},"sequential_id":{"type":"number"},"created":{"description":"Date of creation sent by the creator. Useful when the transport is created by mobile devices. If network connection is bad, the `created` date can be later than `created_device`","format":"date-time","type":"string"},"updated":{"format":"date-time","type":"string"},"deleted":{"nullable":true,"type":"string"},"remote_id":{"description":"Your transport id. It has to be unique among all your transports","type":"string"},"carrier_address":{"$ref":"#/components/schemas/AddressForTransport"},"created_by":{"$ref":"#/components/schemas/Company"},"created_device":{"format":"date-time","type":"string"},"creation_method":{"enum":["mobile_app","api","web_app"],"type":"string"},"archived_by":{"items":{"type":"object"},"type":"array"},"is_order":{"type":"boolean"},"carrier_assignation_status":{"allOf":[{"$ref":"#/components/schemas/CarrierAssignationStatus"}],"nullable":true},"invite_code":{"type":"string"},"deliveries":{"items":{"$ref":"#/components/schemas/Delivery"},"type":"array"},"segments":{"items":{"$ref":"#/components/schemas/Segment"},"type":"array"},"status":{"$ref":"#/components/schemas/Statuses"},"status_updates":{"items":{"$ref":"#/components/schemas/Status"},"type":"array"},"has_observations":{"type":"boolean"},"messages":{"items":{"$ref":"#/components/schemas/TransportMessage"},"type":"array"},"requested_vehicle":{"$ref":"#/components/schemas/requested_vehicle"},"documents":{"items":{"$ref":"#/components/schemas/Document"},"type":"array"},"carrier_reference":{"description":"Text that will help the carrier operators manage the transports, e.g. transport number in his TMS. It should only be set by the carrier of the transport and the transport's creator can toggle a company-wide setting to only allow the carrier to set it.","type":"string"},"price":{"$ref":"#/components/schemas/deprecated_price"},"requires_washing":{"description":"Flag to enable the truck washing flow in the mobile app","type":"boolean"},"business_privacy":{"description":"Flag to enable 'business privacy' mode: no eCMR will be generated, and the trucker won't be prompted to share the transport link.","type":"boolean"},"is_multiple_compartments":{"description":"Flag to enable 'multiple compartments' mode: truckers will have to select in which compartments loads were loaded. It also generates a specific delivery document : loading_plan.","type":"boolean"},"loading_plan":{"description":"Uid of the loading plan created by the trucker. Contact us if you need to retrieve data from it","type":"string"},"customer_to_invoice":{"$ref":"#/components/schemas/customer_to_invoice"},"parent_transport":{"$ref":"#/components/schemas/Transport_parent_transport"},"invoice_number":{"nullable":true,"type":"string"},"invoiced_price":{"$ref":"#/components/schemas/deprecated_invoiced_price"},"volume_display_unit":{"enum":["m3","L"],"type":"string"},"references":{"items":{"$ref":"#/components/schemas/Transport_references"},"type":"array"},"rental_deliveries":{"description":"Array of transports executed by the trucker during the rental order. Implies that the current transport is a rental order. Inner objects have the same transport data structure.","items":{"$ref":"#/components/schemas/Transport"},"type":"array"},"billing-metrics":{"deprecated":true,"description":"Retired feature, will always be null.","nullable":true,"type":"string"},"shape":{"type":"string"},"instructions":{"$ref":"#/components/schemas/global_instructions"},"carbon_footprint":{"description":"Carbon footprint of the transport in kgCO2","nullable":true,"readOnly":true,"type":"number"},"tags":{"description":"List of tags applied to the transport.","items":{"$ref":"#/components/schemas/Tag"},"type":"array"}},"required":["business_privacy","carrier_address","carrier_reference","created","created_by","created_device","creation_method","deliveries","documents","has_observations","invite_code","invoice_number","is_order","messages","price","references","remote_id","requested_vehicle","requires_washing","segments","sequential_id","status","status_updates","uid","updated"],"type":"object"},"AddressForTransport":{"properties":{"pk":{"description":"Dashdoc's internal id.","type":"number"},"name":{"type":"string"},"address":{"type":"string"},"city":{"type":"string"},"postcode":{"type":"string"},"country":{"$ref":"#/components/schemas/country"},"latitude":{"$ref":"#/components/schemas/latitude"},"longitude":{"$ref":"#/components/schemas/longitude"},"radius":{"default":500,"description":"Radius around the GPS coordinates within which the address is located (in meters)","type":"integer"},"coords_validated":{"default":false,"description":"if `true`, when this address is used as a loading or unloading site, the mobile app displays an itinerary button to start GPS app with guidance to these coordinates","type":"boolean"},"is_demo":{"$ref":"#/components/schemas/is_demo"},"is_carrier":{"type":"boolean"},"is_shipper":{"type":"boolean"},"is_origin":{"$ref":"#/components/schemas/address_is_origin_and_is_destination"},"is_destination":{"$ref":"#/components/schemas/address_is_origin_and_is_destination"},"created_by":{"type":"number"},"created":{"$ref":"#/components/schemas/created"},"remote_id":{"description":"The id of the address in your system.","type":"string"},"company":{"$ref":"#/components/schemas/CompanyForTransportAddress"},"original":{"type":"number"}},"type":"object"},"country":{"description":"Only the 2-character codification is accepted (ISO 3166-1 alpha-2)","type":"string"},"latitude":{"description":"Latitude using the decimal GPS coordinates (WGS84). At 7 decimals, the position is accurate around the centimeter.","format":"float","nullable":true,"type":"number"},"longitude":{"description":"Longitude using the decimal GPS coordinates (WGS84). At 7 decimals, the position is accurate around the centimeter.","format":"float","nullable":true,"type":"number"},"is_demo":{"description":"Indicates that the address is a fake one created from demonstration. Everything linked to it will be deleted when using the 'Delete demo content' button in company parameters","type":"boolean"},"address_is_origin_and_is_destination":{"description":"Whether this address is a \"Logistic Points\" and will be usable as pickup/delivery point.\nThe distinction between origin/pickup and destination/delivery was merged as a single \"Logistic Point\" concept. `is_origin` implies `is_destination` and vice-versa.\n","type":"boolean"},"created":{"description":"Date of creation on our server","format":"date-time","type":"string"},"CompanyForTransportAddress":{"properties":{"pk":{"description":"Dashdoc's internal id.","type":"number"},"remote_id":{"description":"The id of the company in your system.","type":"string"},"name":{"type":"string"},"trade_number":{"type":"string"},"country":{"$ref":"#/components/schemas/country"},"settings_contract_html":{"description":"Ignore. Dashdoc technical data.","type":"string"},"settings_logo":{"description":"Ignore. Dashdoc technical data.","nullable":true,"type":"string"},"settings_stamp":{"description":"Ignore. Dashdoc technical data.","nullable":true,"type":"string"},"settings_print_mode":{"description":"Ignore. Dashdoc technical data.","type":"boolean"},"settings_special_agreements":{"description":"Ignore. Dashdoc technical data.","type":"string"},"settings_transport_order_observations":{"type":"string"},"settings_constrain_reference_edition":{"type":"boolean"},"vat_number":{"type":"string"},"is_verified":{"type":"boolean"}},"type":"object"},"Company":{"properties":{"pk":{"description":"Dashdoc's internal id.","type":"number"},"remote_id":{"type":"string"},"created":{"format":"date-time","type":"object"},"updated":{"format":"date-time","type":"string"},"deleted":{"type":"boolean"},"invoicing_remote_id":{"description":"The id of the company in your invoicing system.","type":"string"},"name":{"type":"string"},"phone_number":{"type":"string"},"email":{"type":"string"},"siren":{"type":"string"},"trade_number":{"type":"string"},"country":{"$ref":"#/components/schemas/country"},"comments":{"type":"string"},"vat_number":{"type":"string"},"is_verified":{"type":"boolean"},"settings_transport_order_observations":{"type":"string"},"settings_constrain_reference_edition":{"type":"boolean"},"account_type":{"description":"Ignore. Dashdoc technical data.","type":"string"},"logo":{"description":"The URL of your logo","nullable":true,"type":"string"},"subscription_access":{"type":"object"},"settings":{"type":"object"},"primary_address":{"$ref":"#/components/schemas/PrimaryAddress_1"},"managers":{"items":{"$ref":"#/components/schemas/Managers"},"type":"array"},"has_loggable_managers":{"description":"Ignore. Dashdoc technical data.","type":"boolean"}},"type":"object"},"PrimaryAddress_1":{"properties":{"pk":{"description":"Dashdoc's internal id.","type":"number"},"name":{"type":"string"},"address":{"type":"string"},"city":{"type":"string"},"postcode":{"type":"string"},"country":{"$ref":"#/components/schemas/country"},"latitude":{"$ref":"#/components/schemas/latitude"},"longitude":{"$ref":"#/components/schemas/longitude"},"radius":{"default":500,"description":"Radius around the GPS coordinates within which the address is located (in meters)","type":"integer"},"coords_validated":{"default":false,"description":"if `true`, when this address is used as a loading or unloading site, the mobile app displays an itinerary button to start GPS app with guidance to these coordinates","type":"boolean"},"is_demo":{"$ref":"#/components/schemas/is_demo"},"is_carrier":{"description":"Whether this company is considered a carrier","type":"boolean"},"is_shipper":{"description":"Whether this company is considered a shipper","type":"boolean"},"is_origin":{"description":"Legacy, not relevant for a company's primary address. Consider creating a separate address associated with this partner instead.\n","type":"boolean"},"is_destination":{"description":"Legacy, not relevant for a company's primary address. Consider creating a separate address associated with this partner instead.\n","type":"boolean"},"created_by":{"$ref":"#/components/schemas/created-by"},"created_by_user":{"$ref":"#/components/schemas/created-by-user"},"created":{"$ref":"#/components/schemas/created"},"remote_id":{"description":"The id of the address in your system.","type":"string"}},"type":"object"},"created-by":{"nullable":true,"properties":{"pk":{"description":"company id","type":"number"},"name":{"description":"name of the company","type":"string"}},"type":"object"},"created-by-user":{"nullable":true,"properties":{"pk":{"type":"number"},"display_name":{"type":"string"},"company":{"description":"The company id who created the address","type":"number"},"trucker_id":{"description":"The trucker id who created the address","type":"number"}},"type":"object"},"Managers":{"properties":{"pk":{"description":"Dashdoc's internal id.","type":"number"},"user":{"$ref":"#/components/schemas/Managers_user"},"display_name":{"type":"string"},"role":{"type":"string"}},"type":"object"},"Managers_user":{"properties":{"email":{"format":"email","type":"string"},"first_name":{"type":"string"},"last_name":{"type":"string"}},"type":"object"},"CarrierAssignationStatus":{"description":"Carrier assignment state of an order (Only for chartered transport). Null values should be treated as unassigned.","enum":["unassigned","draft_assigned","assigned"],"type":"string"},"Delivery":{"properties":{"uid":{"description":"Dashdoc's internal id.","type":"string"},"sequential_id":{"description":"eCMR number","type":"number"},"remote_id":{"type":"string"},"tracking_id":{"description":"Deprecated","type":"string"},"origin":{"$ref":"#/components/schemas/CreateOrUpdateSite"},"destination":{"$ref":"#/components/schemas/CreateOrUpdateSite"},"shipper_address":{"$ref":"#/components/schemas/NewAddressReduced"},"planned_loads":{"description":"Loads as planned before the transport has been started","items":{"$ref":"#/components/schemas/DeliveryLoads"},"type":"array"},"loads":{"description":"Loads as they are most recently defined. This means it is: \n\n* equal to `planned_loads` before loading is actually done \n\n* equal to `origin_loads` after loading is done (with details validated by trucker), but unloading is not done yet \n\n* equal to `loads_loads` after unloading is actually done (with details validated by trucker)","items":{"$ref":"#/components/schemas/DeliveryLoads"},"type":"array"},"origin_loads":{"description":"Loads as validated by trucker right after loading is done","items":{"$ref":"#/components/schemas/DeliveryLoads"},"type":"array"},"destination_loads":{"description":"Loads as validated by trucker right after unloading is done","items":{"$ref":"#/components/schemas/DeliveryLoads"},"type":"array"},"tracking_contacts":{"description":"List of contacts that will automatically receive an email when delivery is done. ⚠️ If no tracking contacts are provided for a company and the setting `partner_email_fallback` is enabled, a tracking contact corresponding to the company's email will be added, at the creation of the transport. This only applies to the carrier and the shipper.","items":{"$ref":"#/components/schemas/Delivery_tracking_contacts"},"type":"array"},"shipper_reference":{"description":"Reference the client may use to match transport on his own system, e.g. an order number. The transport's creator can toggle a setting to only allow himself to set it.","type":"string"},"multiple_rounds":{"description":"If true, the trucker will be able to do a signature at loading, then add any amount of rounds for the transport (with weight/volume and weight ticket), and finish with a signature at unloading.","type":"boolean"}},"type":"object"},"CreateOrUpdateSite":{"properties":{"uid":{"format":"uuid","type":"string"},"remote_id":{"description":"The id of the site in your system","type":"string"},"address":{"allOf":[{"$ref":"#/components/schemas/SiteAddress"}],"nullable":true},"real_start":{"description":"date and time when trucker arrived on site","format":"date-time","readOnly":true,"type":"string"},"real_end":{"description":"date and time when trucker completed loading / unloading (depending whether site is origin or destination)","format":"date-time","readOnly":true,"type":"string"},"signature_process":{"type":"string"},"is_booking_needed":{"type":"boolean"},"instructions":{"$ref":"#/components/schemas/site_instructions"},"reference":{"type":"string"},"action":{"deprecated":true,"description":"Deprecated. Accepted for backward compatibility but ignored. Responses always return an empty string.","type":"string"},"eta":{"format":"date-time","nullable":true,"type":"string"},"eta_tracking":{"type":"boolean"},"punctuality_status":{"readOnly":true,"type":"string"},"supports_exchanges":{"$ref":"#/components/schemas/SupportsExchange"},"category":{"type":"string"},"slots":{"items":{"$ref":"#/components/schemas/Site_slots"},"type":"array"},"trucker_instructions":{"$ref":"#/components/schemas/trucker_instructions"},"trip":{"$ref":"#/components/schemas/Site_trip"}},"type":"object"},"SiteAddress":{"description":"Address of the site. Reference an existing address with its `pk` or `remote_id`, or send its details to have it matched or created.","properties":{"pk":{"description":"Dashdoc's internal id. Optional, set it to reference an existing address.","type":"integer"},"name":{"type":"string"},"address":{"type":"string"},"city":{"type":"string"},"postcode":{"type":"string"},"country":{"$ref":"#/components/schemas/country"},"latitude":{"$ref":"#/components/schemas/latitude"},"longitude":{"$ref":"#/components/schemas/longitude"},"radius":{"default":500,"description":"Radius around the GPS coordinates within which the address is located (in meters)","type":"integer"},"coords_validated":{"default":false,"description":"if `true`, when this address is used as a loading or unloading site, the mobile app displays an itinerary button to start GPS app with guidance to these coordinates","type":"boolean"},"is_demo":{"$ref":"#/components/schemas/is_demo"},"is_carrier":{"type":"boolean"},"is_shipper":{"type":"boolean"},"is_origin":{"$ref":"#/components/schemas/address_is_origin_and_is_destination"},"is_destination":{"$ref":"#/components/schemas/address_is_origin_and_is_destination"},"instructions":{"$ref":"#/components/schemas/site_instructions"},"remote_id":{"description":"The id of the address in your system.","type":"string"},"company":{"$ref":"#/components/schemas/CompanyForTransportAddress_1"}},"type":"object"},"site_instructions":{"description":"Site instructions, visible to all parties (trucker, carrier, shipper, site). Displayed in the trucker mobile app. Not visible in the eCMR. If the field is not provided, the address's site instructions will be used.","maxLength":1000,"type":"string"},"CompanyForTransportAddress_1":{"description":"Identification of the company. You may simply use its `pk` or `remote_id` if the company already exists. Other possible identification method are its `trade_number` or `name`. If it doesn't exist, the company will be created with the information you send based on what's possible when creating a company via /companies/ web service. Minimum required information in this case is a name.","properties":{"pk":{"description":"Dashdoc's internal id.Optional, not required if `remote_id` is sent.","type":"integer"},"remote_id":{"description":"The id of the company in your system. Optional, ignored if `pk` is sent.","type":"string"},"trade_number":{"maxLength":100,"type":"string"},"name":{"maxLength":200,"type":"string"}},"type":"object"},"SupportsExchange":{"properties":{"uid":{"description":"uid of the support exchange","format":"uuid","type":"string"},"site":{"$ref":"#/components/schemas/SupportsExchange_site"},"support_type":{"$ref":"#/components/schemas/SupportType"},"expected_retrieved":{"description":"Expected number of supports that should be retrieved on the site","type":"number"},"actual_retrieved":{"description":"Actual number of supports that were retrieved on the site","type":"number"},"expected_delivered":{"description":"Expected number of supports that should be delivered on the site","type":"number"},"actual_delivered":{"description":"Actual number of supports that were delivered on the site","type":"number"},"observations":{"description":"Free text. Observations about this supports exchange. Can be filled on mobile app, web app or via API.","type":"string"},"remote_id":{"description":"The ID of the support in your system","type":"string"}},"type":"object"},"SupportsExchange_site":{"description":"site where supports exchange is expected","properties":{"uid":{"description":"uid of the site","format":"uuid","type":"string"},"remote_id":{"description":"remote_id of the site","type":"string"}},"type":"object"},"SupportType":{"description":"Type of the supports that are exchanged","properties":{"name":{"description":"Display name of the support type","type":"string"},"created":{"$ref":"#/components/schemas/created"},"uid":{"format":"uuid","type":"string"},"remote_id":{"description":"The id of the support type in your system.","type":"string"}},"type":"object"},"Site_slots":{"properties":{"start":{"format":"date-time","type":"string"},"end":{"format":"date-time","type":"string"}},"type":"object"},"trucker_instructions":{"description":"**This field is part of a beta feature.** Private instructions. **The carrier of the transport is the only one who can edit and read those instructions.** Note that those instructions are not visible in the consignment note and can be accessed by the trucker. The value is null if the caller doesn't have the right of access to the data.","maxLength":1000,"type":"string"},"Site_trip":{"description":"Trip linked to this site/activity.","nullable":true,"properties":{"uid":{"format":"uuid","type":"string"},"name":{"type":"string"},"is_prepared":{"type":"boolean"},"status":{"enum":["unstarted","ongoing","done"],"type":"string"}},"readOnly":true,"type":"object"},"NewAddressReduced":{"properties":{"pk":{"description":"Dashdoc's internal id. Optional, set it to reference an existing address.","type":"integer"},"name":{"type":"string"},"address":{"type":"string"},"city":{"type":"string"},"postcode":{"type":"string"},"country":{"$ref":"#/components/schemas/country"},"latitude":{"$ref":"#/components/schemas/latitude"},"longitude":{"$ref":"#/components/schemas/longitude"},"radius":{"default":500,"description":"Radius around the GPS coordinates within which the address is located (in meters)","type":"integer"},"coords_validated":{"default":false,"description":"if `true`, when this address is used as a loading or unloading site, the mobile app displays an itinerary button to start GPS app with guidance to these coordinates","type":"boolean"},"is_demo":{"$ref":"#/components/schemas/is_demo"},"is_carrier":{"type":"boolean"},"is_shipper":{"type":"boolean"},"is_origin":{"type":"boolean"},"is_destination":{"type":"boolean"},"created_by":{"description":"Ignore. Dashdoc technical data.","readOnly":true,"type":"number"},"created":{"description":"Date of creation on our server","format":"date-time","readOnly":true,"type":"string"},"instructions":{"type":"string"},"remote_id":{"description":"The id of the address in your system.","type":"string"},"company":{"$ref":"#/components/schemas/CompanyForTransportAddress"},"original":{"description":"Ignore. Dashdoc technical data.","nullable":true,"readOnly":true,"type":"number"}},"required":["address","city","company","country","postcode"],"type":"object"},"DeliveryLoads":{"properties":{"uid":{"description":"Dashdoc's internal id.","type":"string"},"remote_id":{"description":"The ID of the load in your system. It has to be unique among all your transports.","type":"string"},"description":{"description":"Text description of the load","type":"string"},"reference":{"description":"Reference of the load","type":"string"},"round_id":{"description":"The ID of the round.","format":"integer","type":"number"},"weight":{"description":"In kilograms","format":"float","type":"number"},"volume":{"description":"Volume of load in m3","format":"float","type":"number"},"volume_display_unit":{"default":"m3","enum":["m3","L"],"type":"string"},"linear_meters":{"description":"Length of load in meters","format":"float","type":"number"},"quantity":{"description":"Only one decimal accepted (e.g 0.0)","format":"float","type":"number"},"pallet_equivalence":{"description":"Pallet equivalence (EPS/EQPAL): how many standard pallet spaces the load occupies. `null` when it was never set. Otherwise at least `0.01`, with two decimals kept.","format":"float","nullable":true,"type":"number"},"category":{"description":"Packaging of the load. The text is free but these specific values cause a custom flow on the mobile app: `pallets`, `containers`, `bulk`, `roundwood`, `powder_tank`, `bulk_qualimat`, `rental`.","type":"string"},"dangerous_goods_category":{"description":"ADR class","enum":["1","2","3","4.1","4.2","4.3","5.1","5.2","6.1","6.2","7","8","9"],"type":"string"},"is_dangerous":{"type":"boolean"},"adr_un_code":{"type":"string"},"legal_mentions":{"type":"string"},"complementary_information":{"description":"Any information about the load that doesn't fit to the description field","type":"string"},"container_number":{"type":"string"},"tare_weight":{"description":"In kilograms","format":"float","type":"number"},"container_seal_number":{"type":"string"},"refrigerated":{"description":"Indicates whether the load is refrigerated. If true, the trucker can fill in the temperature.","type":"boolean"},"temperature":{"type":"string"},"steres":{"format":"float","type":"number"},"idtf_number":{"description":"Must match an existing IDTF number","type":"string"},"use_identifiers":{"description":"if `true`, trucker is asked to scan barcode identifiers on load","type":"boolean"},"identifiers":{"description":"Only relevant if use_identifiers is set to `true`. List of expected barcode identifiers that the trucker should scan at loading and unloading. App controls that expected barcodes are actually scanned. If empty, the trucker will have to scan barcodes anyway, but there won't be any check. Feature has to be activated in your account by your Dashdoc projet manager.","items":{"type":"string"},"type":"array"},"identifiers_observations":{"description":"Observations explaining issues with identifier, such as missing or unexpected identifiers","type":"string"}},"type":"object"},"Delivery_tracking_contacts":{"properties":{"uid":{"description":"Dashdoc's internal id.","type":"string"},"contact":{"$ref":"#/components/schemas/NewContact"},"subscribed_to_status_updates":{"description":"If set to true, the contact will receive an email at every step of the delivery. Else, they will receive only one email once the delivery is done.","type":"boolean"},"role":{"description":"The role of the contact in the delivery. It can be `carrier`, `shipper`, or `site`.","type":"string"}},"required":["contact"],"type":"object"},"NewContact":{"properties":{"uid":{"format":"uuid","type":"string"},"created":{"description":"Date of creation on our server","format":"date-time","readOnly":true,"type":"string"},"company":{"$ref":"#/components/schemas/CompanyIdentification"},"first_name":{"maxLength":200,"type":"string"},"last_name":{"maxLength":200,"type":"string"},"email":{"format":"email","type":"string"},"phone_number":{"maxLength":100,"type":"string"},"fax_number":{"maxLength":100,"type":"string"},"remote_id":{"description":"The id of the contact in your system","type":"string"}},"required":["company","last_name"],"type":"object"},"CompanyIdentification":{"description":"Identification of the company. The company must already exist in Dashdoc.","properties":{"pk":{"description":"Dashdoc's internal id. Optional, not required if `remote_id` is sent.","type":"integer"},"remote_id":{"description":"Your remote carrier id. Optional, ignored if `pk` is sent.","type":"string"},"name":{"type":"string"},"trade_number":{"type":"string"},"country":{"$ref":"#/components/schemas/country"},"settings_contract_html":{"description":"Ignore. Dashdoc technical data.","type":"string"},"settings_logo":{"description":"Ignore. Dashdoc technical data.","nullable":true,"type":"string"},"settings_stamp":{"description":"Ignore. Dashdoc technical data.","nullable":true,"type":"string"},"settings_print_mode":{"description":"Ignore. Dashdoc technical data.","type":"boolean"},"settings_special_agreements":{"description":"Ignore. Dashdoc technical data.","type":"string"},"settings_transport_order_observations":{"type":"string"},"settings_constrain_reference_edition":{"type":"boolean"},"vat_number":{"type":"string"},"is_verified":{"description":"Ignore. Dashdoc technical data.","type":"string"}},"type":"object"},"Segment":{"description":"","properties":{"uid":{"minLength":1,"type":"string"},"remote_id":{"minLength":1,"type":"string"},"origin":{"$ref":"#/components/schemas/Site"},"destination":{"$ref":"#/components/schemas/Site"},"trucker":{"$ref":"#/components/schemas/SegmentTrucker"},"vehicle":{"$ref":"#/components/schemas/Vehicle"},"trailers":{"items":{"$ref":"#/components/schemas/Trailer"},"type":"array"},"sort_order":{"description":"The index of the segment in the transport","minimum":0,"type":"number"},"scheduled_start_range":{"$ref":"#/components/schemas/Segment_scheduled_start_range"},"scheduled_end_range":{"$ref":"#/components/schemas/Segment_scheduled_end_range"},"scheduled_start":{"deprecated":true,"description":"The datetime at which the carrier scheduled the start of this segment\n","type":"string"},"scheduled_end":{"deprecated":true,"description":"The datetime at which the carrier scheduled the end of this segment","type":"string"},"child_transport":{"$ref":"#/components/schemas/Segment_child_transport"},"telematic_distance":{"description":"Automatically computed distance from telematic data (in kms).","type":"integer"},"distance":{"description":"Manually entered distance. If null, it takes the value of telematic_distance (in kms).","type":"integer"},"origin_mileage":{"description":"Mileage at transport origin site (in kms).","type":"integer"},"destination_mileage":{"description":"Mileage at transport destination site (in kms).","type":"integer"}},"type":"object"},"Site":{"properties":{"uid":{"format":"uuid","type":"string"},"remote_id":{"description":"The id of the site in your system","type":"string"},"address":{"$ref":"#/components/schemas/Address"},"real_start":{"description":"date and time when trucker arrived on site","format":"date-time","type":"string"},"real_end":{"description":"date and time when trucker completed loading / unloading (depending whether site is origin or destination)","format":"date-time","type":"string"},"signature_process":{"type":"string"},"instructions":{"$ref":"#/components/schemas/site_instructions"},"reference":{"type":"string"},"action":{"deprecated":true,"description":"Deprecated. Always returned as an empty string.","type":"string"},"eta":{"nullable":true,"type":"string"},"eta_tracking":{"$ref":"#/components/schemas/eta_tracking"},"punctuality_status":{"$ref":"#/components/schemas/punctuality_status"},"supports_exchanges":{"$ref":"#/components/schemas/SupportsExchange"},"category":{"enum":["loading","unloading"],"type":"string"},"slots":{"items":{"$ref":"#/components/schemas/Site_slots"},"type":"array"},"trucker_instructions":{"$ref":"#/components/schemas/trucker_instructions"},"trip":{"$ref":"#/components/schemas/Site_trip"}},"type":"object"},"Address":{"properties":{"pk":{"description":"Dashdoc's internal id.","type":"number"},"name":{"type":"string"},"address":{"type":"string"},"city":{"type":"string"},"postcode":{"type":"string"},"country":{"$ref":"#/components/schemas/country"},"latitude":{"$ref":"#/components/schemas/latitude"},"longitude":{"$ref":"#/components/schemas/longitude"},"radius":{"default":500,"description":"Radius around the GPS coordinates within which the address is located (in meters)","type":"integer"},"coords_validated":{"default":false,"description":"if `true`, when this address is used as a loading or unloading site, the mobile app displays an itinerary button to start GPS app with guidance to these coordinates","type":"boolean"},"is_demo":{"$ref":"#/components/schemas/is_demo"},"is_carrier":{"type":"boolean"},"is_shipper":{"type":"boolean"},"is_origin":{"$ref":"#/components/schemas/address_is_origin_and_is_destination"},"is_destination":{"$ref":"#/components/schemas/address_is_origin_and_is_destination"},"created_by":{"$ref":"#/components/schemas/created-by"},"created_by_user":{"$ref":"#/components/schemas/created-by-user"},"created":{"$ref":"#/components/schemas/created"},"instructions":{"$ref":"#/components/schemas/site_instructions"},"remote_id":{"description":"The id of the address in your system.","type":"string"},"original":{"description":"Dashdoc's internal id of the original address.","nullable":true,"readOnly":true,"type":"number"},"company":{"$ref":"#/components/schemas/Company"}},"type":"object"},"eta_tracking":{"default":false,"description":"Ask for an ETA on this site. This is currently a beta feature, not activated by default.","type":"boolean"},"punctuality_status":{"default":"untracked","description":"Indicate the punctuality on this site.","enum":["untracked","probably_late","probably_on_time","late","on_time"],"type":"string"},"SegmentTrucker":{"properties":{"pk":{"description":"Dashdoc's internal id.","type":"number"},"remote_id":{"description":"The ID of the trucker in your system. It has to be unique among all your truckers.","type":"string"},"display_name":{"type":"string"},"user":{"$ref":"#/components/schemas/SegmentTruckerUser"}},"type":"object"},"SegmentTruckerUser":{"properties":{"pk":{"description":"Dashdoc's internal id.","type":"number"},"first_name":{"type":"string"},"last_name":{"type":"string"},"username":{"description":"Ignore. Dashdoc technical data.","type":"string"},"email":{"format":"email","type":"string"},"display_name":{"description":"Display name generated by Dashdoc.","type":"string"},"date_joined":{"description":"Ignore. Dashdoc technical data.","format":"date-time","type":"string"},"is_staff":{"description":"Ignore. Dashdoc technical data.","type":"boolean"},"is_superuser":{"description":"Ignore. Dashdoc technical data.","type":"boolean"},"has_usable_password":{"description":"Ignore. Dashdoc technical data.","type":"boolean"}},"type":"object"},"Vehicle":{"properties":{"pk":{"description":"Dashdoc's internal id","type":"number"},"carrier":{"description":"Dashdoc's internal id of the carrier owning the vehicle","type":"number"},"category":{"description":"Vehicle category","type":"string"},"license_plate":{"description":"License plate number","type":"string"},"fleet_number":{"description":"Your vehicle fleet number","type":"string"},"remote_id":{"description":"The ID of the vehicle in your system","type":"string"},"created":{"description":"Date of creation on our server","format":"date-time","type":"string"},"used_for_qualimat_transports":{"description":"True if the vehicle can be used for Qualimat transport (only used for visual help and warnings)","type":"boolean"},"telematic_vehicle":{"description":"Ignore. Dashdoc technical data","type":"number"},"original":{"type":"number"},"tags":{"description":"List of tags applied to the vehicle.","items":{"$ref":"#/components/schemas/Tag"},"type":"array"},"technical_control_deadline":{"format":"date-time","type":"string"},"tachograph_deadline":{"format":"date-time","type":"string"},"speed_limiter_deadline":{"format":"date-time","type":"string"},"country":{"$ref":"#/components/schemas/country"},"unavailability":{"description":"List of unavailable period","items":{"$ref":"#/components/schemas/Unavailability"},"type":"array"},"events":{"description":"Ignore. Dashdoc technical data.","items":{"type":"object"},"type":"array"}},"type":"object"},"Tag":{"properties":{"pk":{"description":"The unique identifier of the tag","type":"integer"},"name":{"description":"The name of the tag","type":"string"},"color":{"description":"The color of the tag in hex format","type":"string"},"tag_group_id":{"description":"The ID of the tag group this tag belongs to, if any","nullable":true,"type":"integer"}},"required":["color","name","pk"],"type":"object"},"Unavailability":{"properties":{"id":{"description":"Dashdoc's internal id","type":"number"},"remote_id":{"description":"The ID of the unavailability in your system","type":"string"},"created":{"description":"Date of creation on our server","format":"date-time","type":"string"},"start_date":{"description":"Start date of the unavailability","format":"date-time","type":"string"},"end_date":{"description":"End date of the unavailability","format":"date-time","type":"string"},"unavailability_type":{"description":"Type of unavailability","enum":["paid_vacation","day_off","sick_leave","training","vacation","maintenance","rental","other"],"type":"string"},"unavailability_note":{"description":"Notes about the unavailability","type":"string"}},"type":"object"},"Trailer":{"properties":{"pk":{"description":"Dashdoc's internal id","type":"number"},"original":{"description":"Ignore. Dashdoc technical data","type":"number"},"carrier":{"description":"Dashdoc's internal id of the carrier owning the trailer","type":"number"},"license_plate":{"description":"License plate number","type":"string"},"fleet_number":{"description":"Your trailer fleet number","type":"string"},"remote_id":{"description":"The ID of the trailer in your system","type":"string"},"created":{"description":"Date of creation on our server","format":"date-time","type":"string"},"used_for_qualimat_transports":{"description":"True if the trailer can be used for Qualimat transport (only used for visual help and warnings)","type":"boolean"},"tags":{"description":"List of tags applied to the trailer.","items":{"$ref":"#/components/schemas/Tag"},"type":"array"},"technical_control_deadline":{"format":"date-time","type":"string"},"country":{"$ref":"#/components/schemas/country"},"unavailability":{"description":"List of unavailable period","items":{"$ref":"#/components/schemas/Unavailability"},"type":"array"},"events":{"description":"Ignore. Dashdoc technical data.","items":{"type":"object"},"type":"array"}},"type":"object"},"Segment_scheduled_start_range":{"description":"The datetime range at which the carrier scheduled the start of this segment","properties":{"start":{"description":"Min scheduled start date (ISO 8601)","type":"string"},"end":{"description":"Max scheduled start date (ISO 8601)","type":"string"}},"type":"object"},"Segment_scheduled_end_range":{"description":"The datetime range at which the carrier scheduled the end of this segment","properties":{"start":{"description":"Min scheduled end date (ISO 8601)","type":"string"},"end":{"description":"Max scheduled end date (ISO 8601)","type":"string"}},"type":"object"},"Segment_child_transport":{"description":"If the segment is chartered, will contain the child transport","properties":{"uid":{"format":"uuid","type":"string"},"sequential_id":{"type":"number"},"remote_id":{"type":"string"},"has_strong_link":{"type":"boolean"}},"type":"object"},"Statuses":{"enum":["created","updated","confirmed","declined","verified","invoiced","paid","cancelled","assigned","sent_to_trucker","acknowledged","truck_wash","on_loading_site","loading_complete","on_unloading_site","unloading_complete","bulking_break_started","bulking_break_complete","rounds_started","round_added","round_added_v2","round_edited","round_deleted","rounds_complete","event","checklist_filled","activity_complete","on_the_way","handling_started","done"],"type":"string"},"Status":{"properties":{"uid":{"format":"uuid","type":"string"},"created":{"description":"Date of creation on the server. Useful when the transport is created by mobile devices. If network connection is bad, the `created` date can be later than `created_device`","format":"date-time","type":"string"},"created_device":{"description":"If created from a mobile device, date of creation on the device.","format":"date-time","type":"string"},"creation_method":{"type":"string"},"category":{"description":"event that occured on the transport","type":"string"},"author":{"description":"details about author of the update. Contact Dashdoc if more details is needed.","type":"object"},"content":{"description":"Contact Dashdoc if more details is needed.","type":"object"},"content_signatory":{"description":"Contact Dashdoc if more details is needed.","type":"object"},"target":{"description":"Contact Dashdoc if more details is needed.","type":"object"},"site":{"description":"Contact Dashdoc if more details is needed.","type":"object"},"site_id":{"description":"Contact Dashdoc if more details is needed.","format":"uuid","type":"string"},"delivery":{"description":"Contact Dashdoc if more details is needed.","format":"uuid","type":"string"},"segment":{"description":"Contact Dashdoc if more details is needed.","format":"uuid","type":"string"},"transport":{"description":"Contact Dashdoc if more details is needed.","format":"uuid","type":"string"},"signature":{"description":"Contact Dashdoc if more details is needed.","type":"object"},"latitude":{"description":"Contact Dashdoc if more details is needed.","format":"float","type":"number"},"longitude":{"description":"Contact Dashdoc if more details is needed.","format":"float","type":"number"},"update_details":{"description":"Contact Dashdoc if more details is needed.","type":"object"},"author_company":{"type":"number"}},"required":["uid"],"type":"object"},"TransportMessage":{"properties":{"uid":{"format":"uuid","type":"string"},"created":{"$ref":"#/components/schemas/created"},"created_device":{"format":"date-time","type":"string"},"creation_method":{"type":"string"},"author":{"$ref":"#/components/schemas/NewTransportMessage_author"},"type":{"enum":["note","load_verification","share","document","photo"],"maxLength":100,"type":"string"},"document_title":{"description":"Filename or if uploaded by a trucker from the mobile app, the document title is generic, for instance `photo`.","maxLength":100,"type":"string"},"document_type":{"enum":["load_photo","cmr","washing_note","delivery_note","confirmation","weight_note","waste_manifest","holders_swap_note","invoice"],"maxLength":100,"type":"string"},"document":{"description":"URL of the stored document. You can download the document from this URL.","type":"string"},"is_attached_to_cmr":{"type":"boolean"},"transport":{"format":"uuid","type":"string"},"site":{"description":"This field is used for the default values of the field readable_by_company_ids; if null, companies from all Sites of the transport are listed in readable_by_company_ids, otherwise only the company of this Site. Site must exist in this transport. This field is part of a beta feature.","format":"uuid","nullable":true,"type":"string"},"site_remote_id":{"type":"string"},"readable_by_company_ids":{"description":"A list containing the pk of each company allowed to access the document, every company must be part of the transport. If no values are sent, it will be computed with default values; Carrier, Shipper, Invoiced Customer and Site's pk (see Site field). Once values have been sent, the behavior adding default companies is deactivated. The author company is always added. Only pks of companies from the transport will be added, others will be ignored. This field is part of a beta feature.","items":{"type":"integer"},"type":"array"},"message":{"description":"message displayed in the activity thread of a transport in the web app and in the mobile app","type":"string"},"latitude":{"$ref":"#/components/schemas/latitude"},"longitude":{"$ref":"#/components/schemas/longitude"},"reference":{"description":"Free text. This reference is searchable in the transports dashboard. Filled by trucker if document is added from mobile app, by user if document is added from web app, or filled by API request.","maxLength":140,"type":"string"},"visible_by_everyone":{"$ref":"#/components/schemas/visible_by_everyone"},"readable_by_trucker":{"$ref":"#/components/schemas/readable_by_trucker"},"extracted_reference":{"description":"Reference extracted by AI from the document. AI runs only on weight notes, so it will be null for other documents. \"\" if no reference has been found by the AI.","type":"string"}},"type":"object"},"NewTransportMessage_author":{"properties":{"display_name":{"type":"string"},"company":{"type":"number"},"pk":{"description":"Dashdoc's internal id.","type":"number"}},"type":"object"},"visible_by_everyone":{"description":"This field is used to make the transport message public, which makes it visible by all parties of the transport.","type":"boolean"},"readable_by_trucker":{"description":"This field is used to allow truckers to see the transport message. **Only available for carriers.**","type":"boolean"},"requested_vehicle":{"description":"Only useful when the transport is created by the shipper. Free text except punction and special characters.","maxLength":40,"type":"string"},"Document":{"properties":{"pk":{"type":"integer"},"file_updated_date":{"description":"Date was updated on the server.","format":"date-time","type":"string"},"delivery":{"description":"Contact Dashdoc if more details are needed.","format":"uuid","type":"string"},"delivery_sequential_id":{"description":"eCMR number (for category \"cmr\" and \"ldv\")","type":"integer"},"reference":{"type":"integer"},"category":{"description":"Type of document. Possible values are \"cmr\", \"cmr4\", \"ldv\", \"orc\", \"chc\", \"rental\" and \"loading_plan\"","type":"string"},"languages":{"description":"Languages displayed in the document (CMR only), formatted as an 2-letter ISO 639-1 language code","items":{"type":"string"},"type":"array"},"name":{"description":"generic name of the document","type":"string"},"file":{"description":"path to the document","format":"url","type":"string"},"business_privacy_scope":{"description":"Ignore. Dashdoc technical data.","type":"boolean"},"cancelled":{"description":"Date of cancellation of the the document","format":"date-time","type":"string"}},"type":"object"},"deprecated_price":{"deprecated":true,"description":"Full price for the transport","format":"float","nullable":true,"type":"number"},"customer_to_invoice":{"properties":{"pk":{"description":"Dashdoc's internal id.","type":"number"},"name":{"type":"string"},"invoicing_address":{"$ref":"#/components/schemas/customer_to_invoice_invoicing_address"}},"type":"object"},"customer_to_invoice_invoicing_address":{"properties":{"address":{"type":"string"},"city":{"type":"string"},"postcode":{"type":"string"},"country":{"$ref":"#/components/schemas/country"}},"type":"object"},"Transport_parent_transport":{"description":"if this is a chartered transport, this will contains the parent transport it is chartered from","properties":{"uid":{"format":"uuid","type":"string"},"sequential_id":{"type":"number"},"remote_id":{"type":"string"},"has_strong_link":{"type":"boolean"}},"type":"object"},"deprecated_invoiced_price":{"deprecated":true,"description":"Invoiced price for the transport. Deprecated in favour of pricing field","format":"float","nullable":true,"type":"number"},"Transport_references":{"properties":{"role":{"type":"string"},"company":{"$ref":"#/components/schemas/Transport_company"},"reference":{"type":"string"}},"type":"object"},"Transport_company":{"properties":{"name":{"type":"string"}},"type":"object"},"global_instructions":{"description":"Operating instructions. The carrier, the shipper and the creator of the transport have access to those instructions. However, the creator is the only who has the right to edit.","maxLength":1000,"type":"string"}}}}
```

## The BreakSegment object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"BreakSegment":{"properties":{"site":{"$ref":"#/components/schemas/CreateOrUpdateSite_2"},"trucker_id":{"$ref":"#/components/schemas/TruckerForSegment"},"vehicle":{"$ref":"#/components/schemas/VehicleForSegment"},"trailers":{"description":"trailers for the post break segment","items":{"$ref":"#/components/schemas/TrailerForSegment"},"type":"array"}},"required":["site"],"type":"object"},"CreateOrUpdateSite_2":{"properties":{"remote_id":{"description":"The id of the site in your system","type":"string"},"address":{"$ref":"#/components/schemas/AddressGetOrCreate"},"loading_instructions":{"$ref":"#/components/schemas/loading_instructions"},"unloading_instructions":{"$ref":"#/components/schemas/unloading_instructions"},"instructions":{"$ref":"#/components/schemas/site_instructions"},"reference":{"type":"string"},"action":{"deprecated":true,"description":"Deprecated. Accepted for backward compatibility but ignored.","type":"string"},"eta":{"nullable":true,"type":"string"},"supports_exchanges":{"$ref":"#/components/schemas/CreateOrUpdateSupportsExchangeForTransport"},"arrival_date":{"description":"expected arrival date (YYYY-MM-DD)","format":"date","type":"string"},"arrival_time_min":{"description":"expected arrival min time (HH:mm)","type":"string"},"arrival_time_max":{"description":"expected arrival max time (HH:mm)","type":"string"},"date_exact":{"description":"if `true`, `arrival_time_max` is considered as being on the following day from `arrival_date`","type":"boolean"},"trucker_instructions":{"$ref":"#/components/schemas/trucker_instructions"}},"type":"object"},"AddressGetOrCreate":{"description":"Identification of the address. You may simply use its `pk` or `remote_id` if the address already exists, or you can send address details as in /addresses/ web service. The address may be recognized with its details or if it doesn't exist, the address will be created with the information you send based on what's possible when creating an address via /addresses/ web service.","properties":{"pk":{"description":"Dashdoc's internal id.","type":"number"},"remote_id":{"description":"The id of the address in your system.","type":"string"}},"type":"object"},"loading_instructions":{"deprecated":true,"description":"**Prefer using the field `instructions`.** Loading instructions, visible to all parties (trucker, carrier, shipper, site). Displayed in the trucker mobile app. Not visible in the eCMR.","maxLength":1000,"type":"string"},"unloading_instructions":{"deprecated":true,"description":"**Prefer using the field `instructions`.** Unloading instructions, visible to all parties (trucker, carrier, shipper, site). Displayed in the trucker mobile app. Not visible in the eCMR.","maxLength":1000,"type":"string"},"site_instructions":{"description":"Site instructions, visible to all parties (trucker, carrier, shipper, site). Displayed in the trucker mobile app. Not visible in the eCMR. If the field is not provided, the address's site instructions will be used.","maxLength":1000,"type":"string"},"CreateOrUpdateSupportsExchangeForTransport":{"properties":{"support_type":{"$ref":"#/components/schemas/CreateOrUpdateSupportsExchangeForTransport_support_type"},"expected_retrieved":{"description":"Expected number of supports that should be retrieved on the site","type":"number"},"actual_retrieved":{"description":"Actual number of supports that were retrieved on the site","type":"number"},"expected_delivered":{"description":"Expected number of supports that should be delivered on the site","type":"number"},"actual_delivered":{"description":"Actual number of supports that were delivered on the site","type":"number"},"observations":{"description":"Free text. Observations about this supports exchange. Can be filled on mobile app, web app or via API.","type":"string"}},"required":["support_type"],"type":"object"},"CreateOrUpdateSupportsExchangeForTransport_support_type":{"description":"Type of the supports that are exchanged","properties":{"uid":{"format":"uuid","type":"string"},"remote_id":{"description":"The id of the support type in your system.","type":"string"}},"type":"object"},"trucker_instructions":{"description":"**This field is part of a beta feature.** Private instructions. **The carrier of the transport is the only one who can edit and read those instructions.** Note that those instructions are not visible in the consignment note and can be accessed by the trucker. The value is null if the caller doesn't have the right of access to the data.","maxLength":1000,"type":"string"},"TruckerForSegment":{"properties":{"pk":{"description":"Dashdoc's internal id. Optional, not required if `remote_id` is sent.","type":"number"},"remote_id":{"description":"The ID of the trucker in your system. Optional, ignored if pk is sent.","type":"string"}},"type":"object"},"VehicleForSegment":{"properties":{"license_plate":{"description":"License plate number. Creates a new vehicle if unknown.","maxLength":200,"type":"string"}},"type":"object"},"TrailerForSegment":{"properties":{"license_plate":{"description":"License plate number. Creates a new trailer if unknown.","maxLength":200,"type":"string"}},"type":"object"}}}}
```

## The CharterTransport object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"CharterTransport":{"properties":{"carrier":{"$ref":"#/components/schemas/CharterTransport_carrier"},"instructions":{"$ref":"#/components/schemas/global_instructions"},"price":{"$ref":"#/components/schemas/deprecated_price"}},"required":["carrier"],"type":"object"},"CharterTransport_carrier":{"description":"Carrier to whom you wish to charter the transport. Identified either by its `pk` or `remote_id`.","properties":{"pk":{"description":"Dashdoc's internal id. Optional, not required if `remote_id` is sent.","type":"number"},"remote_id":{"description":"Your remote carrier id. Optional, ignored if `pk` is sent.","type":"string"},"carrier_contacts":{"description":"A list containing the uids of each contact in the carrier's company to link to this transport.","items":{"type":"string"},"type":"array"}},"type":"object"},"global_instructions":{"description":"Operating instructions. The carrier, the shipper and the creator of the transport have access to those instructions. However, the creator is the only who has the right to edit.","maxLength":1000,"type":"string"},"deprecated_price":{"deprecated":true,"description":"Full price for the transport","format":"float","nullable":true,"type":"number"}}}}
```

## The CharterSegmentsFiltersError object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"CharterSegmentsFiltersError":{"properties":{"non_field_errors":{"$ref":"#/components/schemas/CharterSegmentsFiltersError_non_field_errors"}},"type":"object"},"CharterSegmentsFiltersError_non_field_errors":{"properties":{"code":{"items":{"type":"string"},"type":"array"},"detail":{"items":{"type":"string"},"type":"array"}},"type":"object"}}}}
```

## The TrackingFiles object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"TrackingFiles":{"properties":{"count":{"type":"integer"},"next":{"nullable":true,"type":"string"},"previous":{"nullable":true,"type":"string"},"results":{"items":{"$ref":"#/components/schemas/TrackingFile"},"type":"array"}},"type":"object"},"TrackingFile":{"properties":{"uid":{"description":"Unique identifier of the tracking file","type":"string"},"status":{"description":"Status of the tracking file","enum":["open","closed"],"type":"string"},"created":{"description":"Creation date of the tracking file","format":"date-time","type":"string"},"name":{"description":"Name of the tracking file","type":"string"},"shipper_id":{"description":"Primary key of the shipper","type":"integer"},"quantity_per_transport":{"description":"Quantity per transport","format":"float","type":"number"},"start_date":{"description":"Start date of the tracking file","format":"date-time","type":"string"},"end_date":{"description":"End date of the tracking file","format":"date-time","type":"string"},"unit":{"description":"Unit of measurement","enum":["liter","cubic_meter","kilogram","stere","linear_meter","quantity"],"type":"string"},"template_uid":{"description":"Unique identifier of the template linked to the tracking file","type":"string"},"loading_address":{"$ref":"#/components/schemas/Address"},"unloading_address":{"$ref":"#/components/schemas/Address"},"total_load":{"$ref":"#/components/schemas/PlannedLoads"},"requires_washing":{"description":"Indicates if washing is required by default for transports that will be created in this tracking file","type":"boolean"},"is_multiple_compartments":{"description":"Indicates if there are multiple compartments by default for transports that will be created in this tracking file","type":"boolean"}},"type":"object"},"Address":{"properties":{"pk":{"description":"Dashdoc's internal id.","type":"number"},"name":{"type":"string"},"address":{"type":"string"},"city":{"type":"string"},"postcode":{"type":"string"},"country":{"$ref":"#/components/schemas/country"},"latitude":{"$ref":"#/components/schemas/latitude"},"longitude":{"$ref":"#/components/schemas/longitude"},"radius":{"default":500,"description":"Radius around the GPS coordinates within which the address is located (in meters)","type":"integer"},"coords_validated":{"default":false,"description":"if `true`, when this address is used as a loading or unloading site, the mobile app displays an itinerary button to start GPS app with guidance to these coordinates","type":"boolean"},"is_demo":{"$ref":"#/components/schemas/is_demo"},"is_carrier":{"type":"boolean"},"is_shipper":{"type":"boolean"},"is_origin":{"$ref":"#/components/schemas/address_is_origin_and_is_destination"},"is_destination":{"$ref":"#/components/schemas/address_is_origin_and_is_destination"},"created_by":{"$ref":"#/components/schemas/created-by"},"created_by_user":{"$ref":"#/components/schemas/created-by-user"},"created":{"$ref":"#/components/schemas/created"},"instructions":{"$ref":"#/components/schemas/site_instructions"},"remote_id":{"description":"The id of the address in your system.","type":"string"},"original":{"description":"Dashdoc's internal id of the original address.","nullable":true,"readOnly":true,"type":"number"},"company":{"$ref":"#/components/schemas/Company"}},"type":"object"},"country":{"description":"Only the 2-character codification is accepted (ISO 3166-1 alpha-2)","type":"string"},"latitude":{"description":"Latitude using the decimal GPS coordinates (WGS84). At 7 decimals, the position is accurate around the centimeter.","format":"float","nullable":true,"type":"number"},"longitude":{"description":"Longitude using the decimal GPS coordinates (WGS84). At 7 decimals, the position is accurate around the centimeter.","format":"float","nullable":true,"type":"number"},"is_demo":{"description":"Indicates that the address is a fake one created from demonstration. Everything linked to it will be deleted when using the 'Delete demo content' button in company parameters","type":"boolean"},"address_is_origin_and_is_destination":{"description":"Whether this address is a \"Logistic Points\" and will be usable as pickup/delivery point.\nThe distinction between origin/pickup and destination/delivery was merged as a single \"Logistic Point\" concept. `is_origin` implies `is_destination` and vice-versa.\n","type":"boolean"},"created-by":{"nullable":true,"properties":{"pk":{"description":"company id","type":"number"},"name":{"description":"name of the company","type":"string"}},"type":"object"},"created-by-user":{"nullable":true,"properties":{"pk":{"type":"number"},"display_name":{"type":"string"},"company":{"description":"The company id who created the address","type":"number"},"trucker_id":{"description":"The trucker id who created the address","type":"number"}},"type":"object"},"created":{"description":"Date of creation on our server","format":"date-time","type":"string"},"site_instructions":{"description":"Site instructions, visible to all parties (trucker, carrier, shipper, site). Displayed in the trucker mobile app. Not visible in the eCMR. If the field is not provided, the address's site instructions will be used.","maxLength":1000,"type":"string"},"Company":{"properties":{"pk":{"description":"Dashdoc's internal id.","type":"number"},"remote_id":{"type":"string"},"created":{"format":"date-time","type":"object"},"updated":{"format":"date-time","type":"string"},"deleted":{"type":"boolean"},"invoicing_remote_id":{"description":"The id of the company in your invoicing system.","type":"string"},"name":{"type":"string"},"phone_number":{"type":"string"},"email":{"type":"string"},"siren":{"type":"string"},"trade_number":{"type":"string"},"country":{"$ref":"#/components/schemas/country"},"comments":{"type":"string"},"vat_number":{"type":"string"},"is_verified":{"type":"boolean"},"settings_transport_order_observations":{"type":"string"},"settings_constrain_reference_edition":{"type":"boolean"},"account_type":{"description":"Ignore. Dashdoc technical data.","type":"string"},"logo":{"description":"The URL of your logo","nullable":true,"type":"string"},"subscription_access":{"type":"object"},"settings":{"type":"object"},"primary_address":{"$ref":"#/components/schemas/PrimaryAddress_1"},"managers":{"items":{"$ref":"#/components/schemas/Managers"},"type":"array"},"has_loggable_managers":{"description":"Ignore. Dashdoc technical data.","type":"boolean"}},"type":"object"},"PrimaryAddress_1":{"properties":{"pk":{"description":"Dashdoc's internal id.","type":"number"},"name":{"type":"string"},"address":{"type":"string"},"city":{"type":"string"},"postcode":{"type":"string"},"country":{"$ref":"#/components/schemas/country"},"latitude":{"$ref":"#/components/schemas/latitude"},"longitude":{"$ref":"#/components/schemas/longitude"},"radius":{"default":500,"description":"Radius around the GPS coordinates within which the address is located (in meters)","type":"integer"},"coords_validated":{"default":false,"description":"if `true`, when this address is used as a loading or unloading site, the mobile app displays an itinerary button to start GPS app with guidance to these coordinates","type":"boolean"},"is_demo":{"$ref":"#/components/schemas/is_demo"},"is_carrier":{"description":"Whether this company is considered a carrier","type":"boolean"},"is_shipper":{"description":"Whether this company is considered a shipper","type":"boolean"},"is_origin":{"description":"Legacy, not relevant for a company's primary address. Consider creating a separate address associated with this partner instead.\n","type":"boolean"},"is_destination":{"description":"Legacy, not relevant for a company's primary address. Consider creating a separate address associated with this partner instead.\n","type":"boolean"},"created_by":{"$ref":"#/components/schemas/created-by"},"created_by_user":{"$ref":"#/components/schemas/created-by-user"},"created":{"$ref":"#/components/schemas/created"},"remote_id":{"description":"The id of the address in your system.","type":"string"}},"type":"object"},"Managers":{"properties":{"pk":{"description":"Dashdoc's internal id.","type":"number"},"user":{"$ref":"#/components/schemas/Managers_user"},"display_name":{"type":"string"},"role":{"type":"string"}},"type":"object"},"Managers_user":{"properties":{"email":{"format":"email","type":"string"},"first_name":{"type":"string"},"last_name":{"type":"string"}},"type":"object"},"PlannedLoads":{"properties":{"uid":{"description":"Dashdoc's internal id.","type":"string"},"remote_id":{"description":"The ID of the load in your system. It has to be unique among all your transports.","type":"string"},"description":{"description":"Text description of the load","type":"string"},"reference":{"description":"Reference of the load","type":"string"},"weight":{"description":"In kilograms","format":"float","type":"number"},"volume":{"description":"Volume of load in m3","format":"float","type":"number"},"volume_display_unit":{"default":"m3","enum":["m3","L"],"type":"string"},"linear_meters":{"description":"Length of load in meters","format":"float","type":"number"},"quantity":{"description":"Only one decimal accepted (e.g 0.0)","format":"float","type":"number"},"pallet_equivalence":{"description":"Pallet equivalence (EPS/EQPAL): how many standard pallet spaces the load occupies. `null` when it was never set. Otherwise at least `0.01`, with two decimals kept.","format":"float","nullable":true,"type":"number"},"category":{"description":"Packaging of the load. The text is free but these specific values cause a custom flow on the mobile app: `pallets`, `containers`, `bulk`, `roundwood`, `powder_tank`, `bulk_qualimat`, `rental`.","type":"string"},"dangerous_goods_category":{"description":"ADR class","enum":["1","2","3","4.1","4.2","4.3","5.1","5.2","6.1","6.2","7","8","9"],"type":"string"},"is_dangerous":{"type":"boolean"},"adr_un_code":{"type":"string"},"legal_mentions":{"type":"string"},"complementary_information":{"description":"Any information about the load that doesn't fit to the description field","type":"string"},"container_number":{"type":"string"},"tare_weight":{"description":"In kilograms","format":"float","type":"number"},"container_seal_number":{"type":"string"},"refrigerated":{"description":"Indicates whether the load is refrigerated. If true, the trucker can fill in the temperature.","type":"boolean"},"temperature":{"type":"string"},"steres":{"format":"float","type":"number"},"idtf_number":{"description":"Must match an existing IDTF number","type":"string"},"use_identifiers":{"description":"if `true`, trucker is asked to scan barcode identifiers on load","type":"boolean"},"identifiers":{"description":"Only relevant if use_identifiers is set to `true`. List of expected barcode identifiers that the trucker should scan at loading and unloading. App controls that expected barcodes are actually scanned. If empty, the trucker will have to scan barcodes anyway, but there won't be any check. Feature has to be activated in your account by your Dashdoc projet manager.","type":"string"},"identifiers_observations":{"description":"Observations explaining issues with identifier, such as missing or unexpected identifiers","type":"string"}},"type":"object"}}}}
```

## The TrackingFileInputValidator object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"TrackingFileInputValidator":{"properties":{"name":{"description":"Name of the tracking file","type":"string"},"shipper_id":{"description":"ID of the shipper","nullable":true,"type":"integer"},"start_date":{"description":"Start date of the tracking file","format":"date-time","nullable":true,"type":"string"},"end_date":{"description":"End date of the tracking file","format":"date-time","nullable":true,"type":"string"},"loading_address_id":{"description":"ID of the loading address.","nullable":true,"type":"integer"},"unloading_address_id":{"description":"ID of the unloading address","nullable":true,"type":"integer"},"quantity_per_transport":{"description":"Quantity per transport","format":"float","nullable":true,"type":"number"},"unit":{"description":"Unit of measurement","enum":["liter","cubic_meter","kilogram","stere","linear_meter","quantity"],"nullable":true,"type":"string"},"total_load":{"$ref":"#/components/schemas/NewDeliveryLoads"},"requires_washing":{"default":false,"description":"Indicates if washing is required by default for transports that will be created in this tracking file","type":"boolean"},"is_multiple_compartments":{"default":false,"description":"Indicates if there are multiple compartments by default for transports that will be created in this tracking file","type":"boolean"}},"required":["name","shipper_id"],"type":"object"},"NewDeliveryLoads":{"properties":{"remote_id":{"description":"The ID of the load in your system. It has to be unique among all your transports.","type":"string"},"description":{"description":"Text description of the load. In the case of a dangerous load, the description has to respect the ADR law.","type":"string"},"reference":{"description":"Reference of the load.","type":"string"},"weight":{"description":"In kilograms","format":"float","type":"number"},"volume":{"description":"Volume of load in m3","format":"float","type":"number"},"linear_meters":{"description":"Length of load in meters","format":"float","type":"number"},"quantity":{"description":"Only one decimal accepted (e.g 0.0)","format":"float","type":"number"},"pallet_equivalence":{"description":"Pallet equivalence (EPS/EQPAL): how many standard pallet spaces the load occupies. Minimum `0.01`, and only two decimals are kept — omit it or send `null` rather than 0 when unknown. When a load is created from the Dashdoc interface this defaults to `quantity` × the handling unit's pallet equivalence, and stays freely overridable.","format":"float","nullable":true,"type":"number"},"category":{"description":"Packaging of the load. The text is free but these specific values cause a custom flow on the mobile app: `pallets`, `containers`, `bulk`, `roundwood`, `powder_tank`, `bulk_qualimat`, `rental`.","type":"string"},"handling_unit_uid":{"description":"Existing handling unit UID from the load type catalog.","format":"uuid","type":"string"},"good_uid":{"description":"Existing good UID from the goods catalog.","format":"uuid","type":"string"},"create_handling_unit":{"$ref":"#/components/schemas/NewDeliveryLoads_create_handling_unit"},"create_good":{"$ref":"#/components/schemas/NewDeliveryLoads_create_good"},"dangerous_goods_category":{"deprecated":true,"description":"ADR class","enum":["1","2","3","4.1","4.2","4.3","5.1","5.2","6.1","6.2","7","8","9"],"type":"string"},"is_dangerous":{"default":false,"description":"Indicates whether the load is dangerous. If true, the trucker has to confirm adr un code and legal mentions at unloading.","type":"boolean"},"adr_un_code":{"description":"Only for dangerous load, the official UN code from the ADR law.","type":"string"},"legal_mentions":{"description":"Only for dangerous load, all mandatory legal mentions printed on documents.","type":"string"},"complementary_information":{"description":"Any information about the load that doesn't fit to the description field.","type":"string"},"container_number":{"type":"string"},"tare_weight":{"description":"In kilograms","format":"float","type":"number"},"container_seal_number":{"type":"string"},"refrigerated":{"description":"Indicates whether the load is refrigerated. If true, the trucker can fill in the temperature.","type":"boolean"},"temperature":{"type":"string"},"steres":{"format":"float","type":"number"},"idtf_number":{"description":"Must match an existing IDTF number","type":"string"},"use_identifiers":{"description":"if `true`, trucker is asked to scan barcode identifiers on load","type":"boolean"},"identifiers":{"description":"Only relevant if use_identifiers is set to `true`. List of expected barcode identifiers that the trucker should scan at loading and unloading. App controls that expected barcodes are actually scanned. If empty, the trucker will have to scan barcodes anyway, but there won't be any check. Feature has to be activated in your account by your Dashdoc projet manager.","items":{"type":"string"},"type":"array"},"identifiers_observations":{"description":"Observations explaining issues with identifier, such as missing or unexpected identifiers","type":"string"}},"type":"object"},"NewDeliveryLoads_create_handling_unit":{"description":"Create a handling unit in the catalog and use its UID for this load. If provided, it silently overrides `handling_unit_uid`.","nullable":true,"properties":{"name":{"type":"string"},"dashdoc_load_category":{"type":"string"},"remote_id":{"type":"string"}},"type":"object"},"NewDeliveryLoads_create_good":{"description":"Create a good in the catalog and use its UID for this load. If provided, it silently overrides `good_uid`.","nullable":true,"properties":{"name":{"type":"string"},"additional_information":{"type":"string"},"remote_id":{"type":"string"}},"type":"object"}}}}
```

## The TrackingFile object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"TrackingFile":{"properties":{"uid":{"description":"Unique identifier of the tracking file","type":"string"},"status":{"description":"Status of the tracking file","enum":["open","closed"],"type":"string"},"created":{"description":"Creation date of the tracking file","format":"date-time","type":"string"},"name":{"description":"Name of the tracking file","type":"string"},"shipper_id":{"description":"Primary key of the shipper","type":"integer"},"quantity_per_transport":{"description":"Quantity per transport","format":"float","type":"number"},"start_date":{"description":"Start date of the tracking file","format":"date-time","type":"string"},"end_date":{"description":"End date of the tracking file","format":"date-time","type":"string"},"unit":{"description":"Unit of measurement","enum":["liter","cubic_meter","kilogram","stere","linear_meter","quantity"],"type":"string"},"template_uid":{"description":"Unique identifier of the template linked to the tracking file","type":"string"},"loading_address":{"$ref":"#/components/schemas/Address"},"unloading_address":{"$ref":"#/components/schemas/Address"},"total_load":{"$ref":"#/components/schemas/PlannedLoads"},"requires_washing":{"description":"Indicates if washing is required by default for transports that will be created in this tracking file","type":"boolean"},"is_multiple_compartments":{"description":"Indicates if there are multiple compartments by default for transports that will be created in this tracking file","type":"boolean"}},"type":"object"},"Address":{"properties":{"pk":{"description":"Dashdoc's internal id.","type":"number"},"name":{"type":"string"},"address":{"type":"string"},"city":{"type":"string"},"postcode":{"type":"string"},"country":{"$ref":"#/components/schemas/country"},"latitude":{"$ref":"#/components/schemas/latitude"},"longitude":{"$ref":"#/components/schemas/longitude"},"radius":{"default":500,"description":"Radius around the GPS coordinates within which the address is located (in meters)","type":"integer"},"coords_validated":{"default":false,"description":"if `true`, when this address is used as a loading or unloading site, the mobile app displays an itinerary button to start GPS app with guidance to these coordinates","type":"boolean"},"is_demo":{"$ref":"#/components/schemas/is_demo"},"is_carrier":{"type":"boolean"},"is_shipper":{"type":"boolean"},"is_origin":{"$ref":"#/components/schemas/address_is_origin_and_is_destination"},"is_destination":{"$ref":"#/components/schemas/address_is_origin_and_is_destination"},"created_by":{"$ref":"#/components/schemas/created-by"},"created_by_user":{"$ref":"#/components/schemas/created-by-user"},"created":{"$ref":"#/components/schemas/created"},"instructions":{"$ref":"#/components/schemas/site_instructions"},"remote_id":{"description":"The id of the address in your system.","type":"string"},"original":{"description":"Dashdoc's internal id of the original address.","nullable":true,"readOnly":true,"type":"number"},"company":{"$ref":"#/components/schemas/Company"}},"type":"object"},"country":{"description":"Only the 2-character codification is accepted (ISO 3166-1 alpha-2)","type":"string"},"latitude":{"description":"Latitude using the decimal GPS coordinates (WGS84). At 7 decimals, the position is accurate around the centimeter.","format":"float","nullable":true,"type":"number"},"longitude":{"description":"Longitude using the decimal GPS coordinates (WGS84). At 7 decimals, the position is accurate around the centimeter.","format":"float","nullable":true,"type":"number"},"is_demo":{"description":"Indicates that the address is a fake one created from demonstration. Everything linked to it will be deleted when using the 'Delete demo content' button in company parameters","type":"boolean"},"address_is_origin_and_is_destination":{"description":"Whether this address is a \"Logistic Points\" and will be usable as pickup/delivery point.\nThe distinction between origin/pickup and destination/delivery was merged as a single \"Logistic Point\" concept. `is_origin` implies `is_destination` and vice-versa.\n","type":"boolean"},"created-by":{"nullable":true,"properties":{"pk":{"description":"company id","type":"number"},"name":{"description":"name of the company","type":"string"}},"type":"object"},"created-by-user":{"nullable":true,"properties":{"pk":{"type":"number"},"display_name":{"type":"string"},"company":{"description":"The company id who created the address","type":"number"},"trucker_id":{"description":"The trucker id who created the address","type":"number"}},"type":"object"},"created":{"description":"Date of creation on our server","format":"date-time","type":"string"},"site_instructions":{"description":"Site instructions, visible to all parties (trucker, carrier, shipper, site). Displayed in the trucker mobile app. Not visible in the eCMR. If the field is not provided, the address's site instructions will be used.","maxLength":1000,"type":"string"},"Company":{"properties":{"pk":{"description":"Dashdoc's internal id.","type":"number"},"remote_id":{"type":"string"},"created":{"format":"date-time","type":"object"},"updated":{"format":"date-time","type":"string"},"deleted":{"type":"boolean"},"invoicing_remote_id":{"description":"The id of the company in your invoicing system.","type":"string"},"name":{"type":"string"},"phone_number":{"type":"string"},"email":{"type":"string"},"siren":{"type":"string"},"trade_number":{"type":"string"},"country":{"$ref":"#/components/schemas/country"},"comments":{"type":"string"},"vat_number":{"type":"string"},"is_verified":{"type":"boolean"},"settings_transport_order_observations":{"type":"string"},"settings_constrain_reference_edition":{"type":"boolean"},"account_type":{"description":"Ignore. Dashdoc technical data.","type":"string"},"logo":{"description":"The URL of your logo","nullable":true,"type":"string"},"subscription_access":{"type":"object"},"settings":{"type":"object"},"primary_address":{"$ref":"#/components/schemas/PrimaryAddress_1"},"managers":{"items":{"$ref":"#/components/schemas/Managers"},"type":"array"},"has_loggable_managers":{"description":"Ignore. Dashdoc technical data.","type":"boolean"}},"type":"object"},"PrimaryAddress_1":{"properties":{"pk":{"description":"Dashdoc's internal id.","type":"number"},"name":{"type":"string"},"address":{"type":"string"},"city":{"type":"string"},"postcode":{"type":"string"},"country":{"$ref":"#/components/schemas/country"},"latitude":{"$ref":"#/components/schemas/latitude"},"longitude":{"$ref":"#/components/schemas/longitude"},"radius":{"default":500,"description":"Radius around the GPS coordinates within which the address is located (in meters)","type":"integer"},"coords_validated":{"default":false,"description":"if `true`, when this address is used as a loading or unloading site, the mobile app displays an itinerary button to start GPS app with guidance to these coordinates","type":"boolean"},"is_demo":{"$ref":"#/components/schemas/is_demo"},"is_carrier":{"description":"Whether this company is considered a carrier","type":"boolean"},"is_shipper":{"description":"Whether this company is considered a shipper","type":"boolean"},"is_origin":{"description":"Legacy, not relevant for a company's primary address. Consider creating a separate address associated with this partner instead.\n","type":"boolean"},"is_destination":{"description":"Legacy, not relevant for a company's primary address. Consider creating a separate address associated with this partner instead.\n","type":"boolean"},"created_by":{"$ref":"#/components/schemas/created-by"},"created_by_user":{"$ref":"#/components/schemas/created-by-user"},"created":{"$ref":"#/components/schemas/created"},"remote_id":{"description":"The id of the address in your system.","type":"string"}},"type":"object"},"Managers":{"properties":{"pk":{"description":"Dashdoc's internal id.","type":"number"},"user":{"$ref":"#/components/schemas/Managers_user"},"display_name":{"type":"string"},"role":{"type":"string"}},"type":"object"},"Managers_user":{"properties":{"email":{"format":"email","type":"string"},"first_name":{"type":"string"},"last_name":{"type":"string"}},"type":"object"},"PlannedLoads":{"properties":{"uid":{"description":"Dashdoc's internal id.","type":"string"},"remote_id":{"description":"The ID of the load in your system. It has to be unique among all your transports.","type":"string"},"description":{"description":"Text description of the load","type":"string"},"reference":{"description":"Reference of the load","type":"string"},"weight":{"description":"In kilograms","format":"float","type":"number"},"volume":{"description":"Volume of load in m3","format":"float","type":"number"},"volume_display_unit":{"default":"m3","enum":["m3","L"],"type":"string"},"linear_meters":{"description":"Length of load in meters","format":"float","type":"number"},"quantity":{"description":"Only one decimal accepted (e.g 0.0)","format":"float","type":"number"},"pallet_equivalence":{"description":"Pallet equivalence (EPS/EQPAL): how many standard pallet spaces the load occupies. `null` when it was never set. Otherwise at least `0.01`, with two decimals kept.","format":"float","nullable":true,"type":"number"},"category":{"description":"Packaging of the load. The text is free but these specific values cause a custom flow on the mobile app: `pallets`, `containers`, `bulk`, `roundwood`, `powder_tank`, `bulk_qualimat`, `rental`.","type":"string"},"dangerous_goods_category":{"description":"ADR class","enum":["1","2","3","4.1","4.2","4.3","5.1","5.2","6.1","6.2","7","8","9"],"type":"string"},"is_dangerous":{"type":"boolean"},"adr_un_code":{"type":"string"},"legal_mentions":{"type":"string"},"complementary_information":{"description":"Any information about the load that doesn't fit to the description field","type":"string"},"container_number":{"type":"string"},"tare_weight":{"description":"In kilograms","format":"float","type":"number"},"container_seal_number":{"type":"string"},"refrigerated":{"description":"Indicates whether the load is refrigerated. If true, the trucker can fill in the temperature.","type":"boolean"},"temperature":{"type":"string"},"steres":{"format":"float","type":"number"},"idtf_number":{"description":"Must match an existing IDTF number","type":"string"},"use_identifiers":{"description":"if `true`, trucker is asked to scan barcode identifiers on load","type":"boolean"},"identifiers":{"description":"Only relevant if use_identifiers is set to `true`. List of expected barcode identifiers that the trucker should scan at loading and unloading. App controls that expected barcodes are actually scanned. If empty, the trucker will have to scan barcodes anyway, but there won't be any check. Feature has to be activated in your account by your Dashdoc projet manager.","type":"string"},"identifiers_observations":{"description":"Observations explaining issues with identifier, such as missing or unexpected identifiers","type":"string"}},"type":"object"}}}}
```

## The AddTransportsToTrackingFile object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"AddTransportsToTrackingFile":{"properties":{"transport_uids":{"description":"Unique identifiers of the transports to add to the tracking file","items":{"type":"string"},"maxItems":100,"minItems":1,"type":"array"}},"required":["transport_uids"],"type":"object"}}}}
```

## The AddedTransports object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"AddedTransports":{"properties":{"transport_uids":{"description":"Unique identifiers of the transports that were added, in the order of the request. Unknown or unreadable transports are not listed.","items":{"type":"string"},"type":"array"}},"type":"object"}}}}
```

## The RemoveTransportsFromTrackingFile object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"RemoveTransportsFromTrackingFile":{"properties":{"transport_uids":{"description":"Unique identifiers of the transports to remove from the tracking file","items":{"type":"string"},"maxItems":100,"minItems":1,"type":"array"}},"required":["transport_uids"],"type":"object"}}}}
```

## The RemovedTransports object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"RemovedTransports":{"properties":{"transport_uids":{"description":"Unique identifiers of the transports that were removed, in the order of the request. Unknown or unreadable transports are not listed.","items":{"type":"string"},"type":"array"}},"type":"object"}}}}
```

## The Site object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"Site":{"properties":{"uid":{"format":"uuid","type":"string"},"remote_id":{"description":"The id of the site in your system","type":"string"},"address":{"$ref":"#/components/schemas/Address"},"real_start":{"description":"date and time when trucker arrived on site","format":"date-time","type":"string"},"real_end":{"description":"date and time when trucker completed loading / unloading (depending whether site is origin or destination)","format":"date-time","type":"string"},"signature_process":{"type":"string"},"instructions":{"$ref":"#/components/schemas/site_instructions"},"reference":{"type":"string"},"action":{"deprecated":true,"description":"Deprecated. Always returned as an empty string.","type":"string"},"eta":{"nullable":true,"type":"string"},"eta_tracking":{"$ref":"#/components/schemas/eta_tracking"},"punctuality_status":{"$ref":"#/components/schemas/punctuality_status"},"supports_exchanges":{"$ref":"#/components/schemas/SupportsExchange"},"category":{"enum":["loading","unloading"],"type":"string"},"slots":{"items":{"$ref":"#/components/schemas/Site_slots"},"type":"array"},"trucker_instructions":{"$ref":"#/components/schemas/trucker_instructions"},"trip":{"$ref":"#/components/schemas/Site_trip"}},"type":"object"},"Address":{"properties":{"pk":{"description":"Dashdoc's internal id.","type":"number"},"name":{"type":"string"},"address":{"type":"string"},"city":{"type":"string"},"postcode":{"type":"string"},"country":{"$ref":"#/components/schemas/country"},"latitude":{"$ref":"#/components/schemas/latitude"},"longitude":{"$ref":"#/components/schemas/longitude"},"radius":{"default":500,"description":"Radius around the GPS coordinates within which the address is located (in meters)","type":"integer"},"coords_validated":{"default":false,"description":"if `true`, when this address is used as a loading or unloading site, the mobile app displays an itinerary button to start GPS app with guidance to these coordinates","type":"boolean"},"is_demo":{"$ref":"#/components/schemas/is_demo"},"is_carrier":{"type":"boolean"},"is_shipper":{"type":"boolean"},"is_origin":{"$ref":"#/components/schemas/address_is_origin_and_is_destination"},"is_destination":{"$ref":"#/components/schemas/address_is_origin_and_is_destination"},"created_by":{"$ref":"#/components/schemas/created-by"},"created_by_user":{"$ref":"#/components/schemas/created-by-user"},"created":{"$ref":"#/components/schemas/created"},"instructions":{"$ref":"#/components/schemas/site_instructions"},"remote_id":{"description":"The id of the address in your system.","type":"string"},"original":{"description":"Dashdoc's internal id of the original address.","nullable":true,"readOnly":true,"type":"number"},"company":{"$ref":"#/components/schemas/Company"}},"type":"object"},"country":{"description":"Only the 2-character codification is accepted (ISO 3166-1 alpha-2)","type":"string"},"latitude":{"description":"Latitude using the decimal GPS coordinates (WGS84). At 7 decimals, the position is accurate around the centimeter.","format":"float","nullable":true,"type":"number"},"longitude":{"description":"Longitude using the decimal GPS coordinates (WGS84). At 7 decimals, the position is accurate around the centimeter.","format":"float","nullable":true,"type":"number"},"is_demo":{"description":"Indicates that the address is a fake one created from demonstration. Everything linked to it will be deleted when using the 'Delete demo content' button in company parameters","type":"boolean"},"address_is_origin_and_is_destination":{"description":"Whether this address is a \"Logistic Points\" and will be usable as pickup/delivery point.\nThe distinction between origin/pickup and destination/delivery was merged as a single \"Logistic Point\" concept. `is_origin` implies `is_destination` and vice-versa.\n","type":"boolean"},"created-by":{"nullable":true,"properties":{"pk":{"description":"company id","type":"number"},"name":{"description":"name of the company","type":"string"}},"type":"object"},"created-by-user":{"nullable":true,"properties":{"pk":{"type":"number"},"display_name":{"type":"string"},"company":{"description":"The company id who created the address","type":"number"},"trucker_id":{"description":"The trucker id who created the address","type":"number"}},"type":"object"},"created":{"description":"Date of creation on our server","format":"date-time","type":"string"},"site_instructions":{"description":"Site instructions, visible to all parties (trucker, carrier, shipper, site). Displayed in the trucker mobile app. Not visible in the eCMR. If the field is not provided, the address's site instructions will be used.","maxLength":1000,"type":"string"},"Company":{"properties":{"pk":{"description":"Dashdoc's internal id.","type":"number"},"remote_id":{"type":"string"},"created":{"format":"date-time","type":"object"},"updated":{"format":"date-time","type":"string"},"deleted":{"type":"boolean"},"invoicing_remote_id":{"description":"The id of the company in your invoicing system.","type":"string"},"name":{"type":"string"},"phone_number":{"type":"string"},"email":{"type":"string"},"siren":{"type":"string"},"trade_number":{"type":"string"},"country":{"$ref":"#/components/schemas/country"},"comments":{"type":"string"},"vat_number":{"type":"string"},"is_verified":{"type":"boolean"},"settings_transport_order_observations":{"type":"string"},"settings_constrain_reference_edition":{"type":"boolean"},"account_type":{"description":"Ignore. Dashdoc technical data.","type":"string"},"logo":{"description":"The URL of your logo","nullable":true,"type":"string"},"subscription_access":{"type":"object"},"settings":{"type":"object"},"primary_address":{"$ref":"#/components/schemas/PrimaryAddress_1"},"managers":{"items":{"$ref":"#/components/schemas/Managers"},"type":"array"},"has_loggable_managers":{"description":"Ignore. Dashdoc technical data.","type":"boolean"}},"type":"object"},"PrimaryAddress_1":{"properties":{"pk":{"description":"Dashdoc's internal id.","type":"number"},"name":{"type":"string"},"address":{"type":"string"},"city":{"type":"string"},"postcode":{"type":"string"},"country":{"$ref":"#/components/schemas/country"},"latitude":{"$ref":"#/components/schemas/latitude"},"longitude":{"$ref":"#/components/schemas/longitude"},"radius":{"default":500,"description":"Radius around the GPS coordinates within which the address is located (in meters)","type":"integer"},"coords_validated":{"default":false,"description":"if `true`, when this address is used as a loading or unloading site, the mobile app displays an itinerary button to start GPS app with guidance to these coordinates","type":"boolean"},"is_demo":{"$ref":"#/components/schemas/is_demo"},"is_carrier":{"description":"Whether this company is considered a carrier","type":"boolean"},"is_shipper":{"description":"Whether this company is considered a shipper","type":"boolean"},"is_origin":{"description":"Legacy, not relevant for a company's primary address. Consider creating a separate address associated with this partner instead.\n","type":"boolean"},"is_destination":{"description":"Legacy, not relevant for a company's primary address. Consider creating a separate address associated with this partner instead.\n","type":"boolean"},"created_by":{"$ref":"#/components/schemas/created-by"},"created_by_user":{"$ref":"#/components/schemas/created-by-user"},"created":{"$ref":"#/components/schemas/created"},"remote_id":{"description":"The id of the address in your system.","type":"string"}},"type":"object"},"Managers":{"properties":{"pk":{"description":"Dashdoc's internal id.","type":"number"},"user":{"$ref":"#/components/schemas/Managers_user"},"display_name":{"type":"string"},"role":{"type":"string"}},"type":"object"},"Managers_user":{"properties":{"email":{"format":"email","type":"string"},"first_name":{"type":"string"},"last_name":{"type":"string"}},"type":"object"},"eta_tracking":{"default":false,"description":"Ask for an ETA on this site. This is currently a beta feature, not activated by default.","type":"boolean"},"punctuality_status":{"default":"untracked","description":"Indicate the punctuality on this site.","enum":["untracked","probably_late","probably_on_time","late","on_time"],"type":"string"},"SupportsExchange":{"properties":{"uid":{"description":"uid of the support exchange","format":"uuid","type":"string"},"site":{"$ref":"#/components/schemas/SupportsExchange_site"},"support_type":{"$ref":"#/components/schemas/SupportType"},"expected_retrieved":{"description":"Expected number of supports that should be retrieved on the site","type":"number"},"actual_retrieved":{"description":"Actual number of supports that were retrieved on the site","type":"number"},"expected_delivered":{"description":"Expected number of supports that should be delivered on the site","type":"number"},"actual_delivered":{"description":"Actual number of supports that were delivered on the site","type":"number"},"observations":{"description":"Free text. Observations about this supports exchange. Can be filled on mobile app, web app or via API.","type":"string"},"remote_id":{"description":"The ID of the support in your system","type":"string"}},"type":"object"},"SupportsExchange_site":{"description":"site where supports exchange is expected","properties":{"uid":{"description":"uid of the site","format":"uuid","type":"string"},"remote_id":{"description":"remote_id of the site","type":"string"}},"type":"object"},"SupportType":{"description":"Type of the supports that are exchanged","properties":{"name":{"description":"Display name of the support type","type":"string"},"created":{"$ref":"#/components/schemas/created"},"uid":{"format":"uuid","type":"string"},"remote_id":{"description":"The id of the support type in your system.","type":"string"}},"type":"object"},"Site_slots":{"properties":{"start":{"format":"date-time","type":"string"},"end":{"format":"date-time","type":"string"}},"type":"object"},"trucker_instructions":{"description":"**This field is part of a beta feature.** Private instructions. **The carrier of the transport is the only one who can edit and read those instructions.** Note that those instructions are not visible in the consignment note and can be accessed by the trucker. The value is null if the caller doesn't have the right of access to the data.","maxLength":1000,"type":"string"},"Site_trip":{"description":"Trip linked to this site/activity.","nullable":true,"properties":{"uid":{"format":"uuid","type":"string"},"name":{"type":"string"},"is_prepared":{"type":"boolean"},"status":{"enum":["unstarted","ongoing","done"],"type":"string"}},"readOnly":true,"type":"object"}}}}
```

## The CreateOrUpdateSite object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"CreateOrUpdateSite":{"properties":{"uid":{"format":"uuid","type":"string"},"remote_id":{"description":"The id of the site in your system","type":"string"},"address":{"allOf":[{"$ref":"#/components/schemas/SiteAddress"}],"nullable":true},"real_start":{"description":"date and time when trucker arrived on site","format":"date-time","readOnly":true,"type":"string"},"real_end":{"description":"date and time when trucker completed loading / unloading (depending whether site is origin or destination)","format":"date-time","readOnly":true,"type":"string"},"signature_process":{"type":"string"},"is_booking_needed":{"type":"boolean"},"instructions":{"$ref":"#/components/schemas/site_instructions"},"reference":{"type":"string"},"action":{"deprecated":true,"description":"Deprecated. Accepted for backward compatibility but ignored. Responses always return an empty string.","type":"string"},"eta":{"format":"date-time","nullable":true,"type":"string"},"eta_tracking":{"type":"boolean"},"punctuality_status":{"readOnly":true,"type":"string"},"supports_exchanges":{"$ref":"#/components/schemas/SupportsExchange"},"category":{"type":"string"},"slots":{"items":{"$ref":"#/components/schemas/Site_slots"},"type":"array"},"trucker_instructions":{"$ref":"#/components/schemas/trucker_instructions"},"trip":{"$ref":"#/components/schemas/Site_trip"}},"type":"object"},"SiteAddress":{"description":"Address of the site. Reference an existing address with its `pk` or `remote_id`, or send its details to have it matched or created.","properties":{"pk":{"description":"Dashdoc's internal id. Optional, set it to reference an existing address.","type":"integer"},"name":{"type":"string"},"address":{"type":"string"},"city":{"type":"string"},"postcode":{"type":"string"},"country":{"$ref":"#/components/schemas/country"},"latitude":{"$ref":"#/components/schemas/latitude"},"longitude":{"$ref":"#/components/schemas/longitude"},"radius":{"default":500,"description":"Radius around the GPS coordinates within which the address is located (in meters)","type":"integer"},"coords_validated":{"default":false,"description":"if `true`, when this address is used as a loading or unloading site, the mobile app displays an itinerary button to start GPS app with guidance to these coordinates","type":"boolean"},"is_demo":{"$ref":"#/components/schemas/is_demo"},"is_carrier":{"type":"boolean"},"is_shipper":{"type":"boolean"},"is_origin":{"$ref":"#/components/schemas/address_is_origin_and_is_destination"},"is_destination":{"$ref":"#/components/schemas/address_is_origin_and_is_destination"},"instructions":{"$ref":"#/components/schemas/site_instructions"},"remote_id":{"description":"The id of the address in your system.","type":"string"},"company":{"$ref":"#/components/schemas/CompanyForTransportAddress_1"}},"type":"object"},"country":{"description":"Only the 2-character codification is accepted (ISO 3166-1 alpha-2)","type":"string"},"latitude":{"description":"Latitude using the decimal GPS coordinates (WGS84). At 7 decimals, the position is accurate around the centimeter.","format":"float","nullable":true,"type":"number"},"longitude":{"description":"Longitude using the decimal GPS coordinates (WGS84). At 7 decimals, the position is accurate around the centimeter.","format":"float","nullable":true,"type":"number"},"is_demo":{"description":"Indicates that the address is a fake one created from demonstration. Everything linked to it will be deleted when using the 'Delete demo content' button in company parameters","type":"boolean"},"address_is_origin_and_is_destination":{"description":"Whether this address is a \"Logistic Points\" and will be usable as pickup/delivery point.\nThe distinction between origin/pickup and destination/delivery was merged as a single \"Logistic Point\" concept. `is_origin` implies `is_destination` and vice-versa.\n","type":"boolean"},"site_instructions":{"description":"Site instructions, visible to all parties (trucker, carrier, shipper, site). Displayed in the trucker mobile app. Not visible in the eCMR. If the field is not provided, the address's site instructions will be used.","maxLength":1000,"type":"string"},"CompanyForTransportAddress_1":{"description":"Identification of the company. You may simply use its `pk` or `remote_id` if the company already exists. Other possible identification method are its `trade_number` or `name`. If it doesn't exist, the company will be created with the information you send based on what's possible when creating a company via /companies/ web service. Minimum required information in this case is a name.","properties":{"pk":{"description":"Dashdoc's internal id.Optional, not required if `remote_id` is sent.","type":"integer"},"remote_id":{"description":"The id of the company in your system. Optional, ignored if `pk` is sent.","type":"string"},"trade_number":{"maxLength":100,"type":"string"},"name":{"maxLength":200,"type":"string"}},"type":"object"},"SupportsExchange":{"properties":{"uid":{"description":"uid of the support exchange","format":"uuid","type":"string"},"site":{"$ref":"#/components/schemas/SupportsExchange_site"},"support_type":{"$ref":"#/components/schemas/SupportType"},"expected_retrieved":{"description":"Expected number of supports that should be retrieved on the site","type":"number"},"actual_retrieved":{"description":"Actual number of supports that were retrieved on the site","type":"number"},"expected_delivered":{"description":"Expected number of supports that should be delivered on the site","type":"number"},"actual_delivered":{"description":"Actual number of supports that were delivered on the site","type":"number"},"observations":{"description":"Free text. Observations about this supports exchange. Can be filled on mobile app, web app or via API.","type":"string"},"remote_id":{"description":"The ID of the support in your system","type":"string"}},"type":"object"},"SupportsExchange_site":{"description":"site where supports exchange is expected","properties":{"uid":{"description":"uid of the site","format":"uuid","type":"string"},"remote_id":{"description":"remote_id of the site","type":"string"}},"type":"object"},"SupportType":{"description":"Type of the supports that are exchanged","properties":{"name":{"description":"Display name of the support type","type":"string"},"created":{"$ref":"#/components/schemas/created"},"uid":{"format":"uuid","type":"string"},"remote_id":{"description":"The id of the support type in your system.","type":"string"}},"type":"object"},"created":{"description":"Date of creation on our server","format":"date-time","type":"string"},"Site_slots":{"properties":{"start":{"format":"date-time","type":"string"},"end":{"format":"date-time","type":"string"}},"type":"object"},"trucker_instructions":{"description":"**This field is part of a beta feature.** Private instructions. **The carrier of the transport is the only one who can edit and read those instructions.** Note that those instructions are not visible in the consignment note and can be accessed by the trucker. The value is null if the caller doesn't have the right of access to the data.","maxLength":1000,"type":"string"},"Site_trip":{"description":"Trip linked to this site/activity.","nullable":true,"properties":{"uid":{"format":"uuid","type":"string"},"name":{"type":"string"},"is_prepared":{"type":"boolean"},"status":{"enum":["unstarted","ongoing","done"],"type":"string"}},"readOnly":true,"type":"object"}}}}
```

## The MarkDoneSite object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"MarkDoneSite":{"properties":{"category":{"enum":["loading","unloading","bulking_break_started","bulking_break_complete"],"type":"string"},"on_site_date":{"format":"date-time","type":"string"},"complete_date":{"format":"date-time","type":"string"}},"required":["category","complete_date","on_site_date"],"type":"object"}}}}
```

## The EnableEtaCoordinatesError object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"EnableEtaCoordinatesError":{"properties":{"non_field_errors":{"$ref":"#/components/schemas/EnableEtaCoordinatesError_non_field_errors"}},"type":"object"},"EnableEtaCoordinatesError_non_field_errors":{"properties":{"code":{"items":{"type":"string"},"type":"array"},"detail":{"items":{"type":"string"},"type":"array"}},"type":"object"}}}}
```

## The FlowCompanyRequest object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"FlowCompanyRequest":{"properties":{"remote_id":{"description":"The ID of the company in your system","type":"string"},"name":{"description":"Company name","type":"string"},"address":{"$ref":"#/components/schemas/FlowCompanyRequest_address"}},"required":["address","name","remote_id"],"type":"object"},"FlowCompanyRequest_address":{"properties":{"address":{"description":"Address","type":"string"},"postcode":{"description":"Postal code","type":"string"},"city":{"description":"City name","type":"string"},"country":{"description":"Country code","type":"string"}},"required":["city","country","postcode"],"type":"object"}}}}
```

## The FlowCompany object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"FlowCompany":{"properties":{"uid":{"description":"Unique identifier for the company","format":"uuid","type":"string"},"remote_id":{"description":"The ID of the company in your system","type":"string"},"name":{"description":"Company name","type":"string"},"address":{"$ref":"#/components/schemas/FlowCompanyRequest_address"}},"type":"object"},"FlowCompanyRequest_address":{"properties":{"address":{"description":"Address","type":"string"},"postcode":{"description":"Postal code","type":"string"},"city":{"description":"City name","type":"string"},"country":{"description":"Country code","type":"string"}},"required":["city","country","postcode"],"type":"object"}}}}
```

## The SlotsResponse object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"SlotsResponse":{"properties":{"count":{"description":"Total number of slots","type":"integer"},"next":{"description":"URL for the next page of results","nullable":true,"type":"string"},"previous":{"description":"URL for the previous page of results","nullable":true,"type":"string"},"results":{"description":"Array of slot objects","items":{"$ref":"#/components/schemas/Slot"},"type":"array"}},"required":["count","results"],"type":"object"},"Slot":{"properties":{"uid":{"description":"Unique identifier for the slot","type":"string"},"zone":{"$ref":"#/components/schemas/Slot_zone"},"company":{"$ref":"#/components/schemas/Slot_company"},"start_time":{"description":"Start time of the slot in ISO 8601 format","format":"date-time","type":"string"},"end_time":{"description":"End time of the slot in ISO 8601 format","format":"date-time","type":"string"},"state":{"description":"Current state of the slot","enum":["draft","planned","arrived","handled","completed","departed","cancelled"],"type":"string"},"note":{"description":"Optional note for the slot","type":"string"},"fields":{"$ref":"#/components/schemas/SlotFields"}},"required":["company","end_time","start_time","state","uid","zone"],"type":"object"},"Slot_zone":{"properties":{"uid":{"description":"Zone unique identifier","type":"string"},"name":{"description":"Zone name","type":"string"}},"required":["name","uid"],"type":"object"},"Slot_company":{"properties":{"pk":{"description":"Company primary key","type":"integer"},"remote_id":{"description":"Company remote identifier","type":"string"},"name":{"description":"Company name","type":"string"}},"required":["name","pk"],"type":"object"},"SlotFields":{"description":"Custom fields for the slot","properties":{"references":{"description":"List of reference strings for the slot","items":{"maxLength":128,"type":"string"},"nullable":true,"type":"array"},"custom_field_1":{"description":"Value for the first custom field (if defined in the zone)","type":"string"},"custom_field_2":{"description":"Value for the second custom field (if defined in the zone)","type":"string"}},"type":"object"}}}}
```

## The SlotDraftRequest object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"SlotDraftRequest":{"properties":{"company":{"description":"Company information. Either 'remote_id' or 'pk' must be provided, but not both.","oneOf":[{"required":["remote_id"],"type":"object"},{"required":["pk"],"type":"object"}],"properties":{"remote_id":{"description":"Company remote identifier (external ID)","type":"string"},"pk":{"description":"Company primary key (internal ID)","type":"integer"}},"type":"object"},"note":{"description":"Optional note for the slot (can be blank or null)","nullable":true,"type":"string"},"fields":{"additionalProperties":{"description":"Custom field values (any type will be converted to string). Note that custom fields cannot be validated against zone specifications since draft slots don't have a zone assigned yet.","type":"string"},"description":"Optional fields containing references and/or custom fields. Custom fields are provided as key-value pairs where keys are field labels (strings) and values will be converted to strings.","properties":{"references":{"description":"List of reference strings for the slot","items":{"maxLength":128,"type":"string"},"type":"array"}},"type":"object"}},"required":["company"],"type":"object"}}}}
```

## The DraftSlot object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"DraftSlot":{"properties":{"uid":{"description":"Unique identifier for the slot","type":"string"},"zone":{"$ref":"#/components/schemas/DraftSlot_zone"},"company":{"$ref":"#/components/schemas/DraftSlot_company"},"start_time":{"description":"Start time of the slot in ISO 8601 format (null for draft slots until scheduled)","format":"date-time","nullable":true,"type":"string"},"end_time":{"description":"End time of the slot in ISO 8601 format (null for draft slots until scheduled)","format":"date-time","nullable":true,"type":"string"},"state":{"description":"State of the slot (always \"draft\" for draft slots)","enum":["draft"],"type":"string"},"note":{"description":"Optional note for the slot","nullable":true,"type":"string"},"fields":{"additionalProperties":{"description":"Custom field values returned as key-value pairs","type":"string"},"description":"Custom fields for the slot including references and any custom field labels","properties":{"references":{"description":"List of reference strings for the slot","items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"required":["state","uid"],"type":"object"},"DraftSlot_zone":{"description":"Zone information (null for draft slots as they are not assigned to a zone yet)","nullable":true,"properties":{"uid":{"description":"Zone unique identifier","type":"string"},"name":{"description":"Zone name","type":"string"}},"required":["name","uid"],"type":"object"},"DraftSlot_company":{"description":"Company associated with the slot","properties":{"pk":{"description":"Company primary key","type":"integer"},"remote_id":{"description":"Company remote identifier (external ID)","type":"string"},"name":{"description":"Company name","type":"string"}},"required":["name","pk"],"type":"object"}}}}
```

## The SlotPlannedRequest object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"SlotPlannedRequest":{"properties":{"zone":{"$ref":"#/components/schemas/SlotPlannedRequest_zone"},"company":{"description":"Company identification. Either remote_id or pk must be provided, but not both.","oneOf":[{"required":["remote_id"],"type":"object"},{"required":["pk"],"type":"object"}],"properties":{"remote_id":{"description":"Company remote identifier","type":"string"},"pk":{"description":"Company primary key","type":"integer"}},"type":"object"},"start_time":{"description":"Start time of the slot in ISO 8601 format","format":"date-time","type":"string"},"end_time":{"description":"End time of the slot in ISO 8601 format","format":"date-time","type":"string"},"note":{"description":"Optional note for the slot","type":"string"},"fields":{"$ref":"#/components/schemas/SlotFields"}},"required":["company","end_time","start_time","zone"],"type":"object"},"SlotPlannedRequest_zone":{"properties":{"uid":{"description":"Zone unique identifier","type":"string"}},"required":["uid"],"type":"object"},"SlotFields":{"description":"Custom fields for the slot","properties":{"references":{"description":"List of reference strings for the slot","items":{"maxLength":128,"type":"string"},"nullable":true,"type":"array"},"custom_field_1":{"description":"Value for the first custom field (if defined in the zone)","type":"string"},"custom_field_2":{"description":"Value for the second custom field (if defined in the zone)","type":"string"}},"type":"object"}}}}
```

## The Slot object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"Slot":{"properties":{"uid":{"description":"Unique identifier for the slot","type":"string"},"zone":{"$ref":"#/components/schemas/Slot_zone"},"company":{"$ref":"#/components/schemas/Slot_company"},"start_time":{"description":"Start time of the slot in ISO 8601 format","format":"date-time","type":"string"},"end_time":{"description":"End time of the slot in ISO 8601 format","format":"date-time","type":"string"},"state":{"description":"Current state of the slot","enum":["draft","planned","arrived","handled","completed","departed","cancelled"],"type":"string"},"note":{"description":"Optional note for the slot","type":"string"},"fields":{"$ref":"#/components/schemas/SlotFields"}},"required":["company","end_time","start_time","state","uid","zone"],"type":"object"},"Slot_zone":{"properties":{"uid":{"description":"Zone unique identifier","type":"string"},"name":{"description":"Zone name","type":"string"}},"required":["name","uid"],"type":"object"},"Slot_company":{"properties":{"pk":{"description":"Company primary key","type":"integer"},"remote_id":{"description":"Company remote identifier","type":"string"},"name":{"description":"Company name","type":"string"}},"required":["name","pk"],"type":"object"},"SlotFields":{"description":"Custom fields for the slot","properties":{"references":{"description":"List of reference strings for the slot","items":{"maxLength":128,"type":"string"},"nullable":true,"type":"array"},"custom_field_1":{"description":"Value for the first custom field (if defined in the zone)","type":"string"},"custom_field_2":{"description":"Value for the second custom field (if defined in the zone)","type":"string"}},"type":"object"}}}}
```

## The SlotUpdateReferencesRequest object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"SlotUpdateReferencesRequest":{"properties":{"references":{"description":"List of reference strings for the slot","items":{"maxLength":128,"type":"string"},"nullable":true,"type":"array"},"custom_field_1":{"description":"Value for the first custom field (if defined in the zone)","type":"string"},"custom_field_2":{"description":"Value for the second custom field (if defined in the zone)","type":"string"}},"required":["references"],"type":"object"}}}}
```

## The SlotReassignRequest object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"SlotReassignRequest":{"properties":{"company":{"description":"Company identification. Either remote_id or pk must be provided, but not both.","oneOf":[{"required":["remote_id"],"type":"object"},{"required":["pk"],"type":"object"}],"properties":{"remote_id":{"description":"Company remote identifier","type":"string"},"pk":{"description":"Company primary key","type":"integer"}},"type":"object"}},"required":["company"],"type":"object"}}}}
```

## The SlotDocument object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"SlotDocument":{"properties":{"uid":{"description":"Unique identifier for the document","type":"string"},"slot_uid":{"description":"Unique identifier of the slot the document is attached to","type":"string"},"name":{"description":"Display name of the document","type":"string"},"file":{"description":"URL of the uploaded file","format":"uri","type":"string"},"file_size":{"description":"File size in bytes","type":"integer"},"created":{"description":"Upload timestamp in ISO 8601 format","format":"date-time","type":"string"},"created_by_user":{"$ref":"#/components/schemas/SlotDocument_created_by_user"}},"required":["created","file","file_size","name","slot_uid","uid"],"type":"object"},"SlotDocument_created_by_user":{"description":"User who uploaded the document. Null if the user has been deleted.","nullable":true,"properties":{"email":{"type":"string"},"first_name":{"type":"string"},"last_name":{"type":"string"}},"type":"object"}}}}
```

## The SupportTypes object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"SupportTypes":{"properties":{"count":{"type":"integer"},"next":{"nullable":true,"type":"string"},"previous":{"nullable":true,"type":"string"},"results":{"items":{"$ref":"#/components/schemas/SupportType"},"type":"array"}},"type":"object"},"SupportType":{"description":"Type of the supports that are exchanged","properties":{"name":{"description":"Display name of the support type","type":"string"},"created":{"$ref":"#/components/schemas/created"},"uid":{"format":"uuid","type":"string"},"remote_id":{"description":"The id of the support type in your system.","type":"string"}},"type":"object"},"created":{"description":"Date of creation on our server","format":"date-time","type":"string"}}}}
```

## The NewSupportType object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"NewSupportType":{"properties":{"name":{"description":"Display name of the support type","type":"string"},"remote_id":{"description":"The id of the support type in your system. It has to be unique.","type":"string"}},"required":["name"],"type":"object"}}}}
```

## The SupportType object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"SupportType":{"description":"Type of the supports that are exchanged","properties":{"name":{"description":"Display name of the support type","type":"string"},"created":{"$ref":"#/components/schemas/created"},"uid":{"format":"uuid","type":"string"},"remote_id":{"description":"The id of the support type in your system.","type":"string"}},"type":"object"},"created":{"description":"Date of creation on our server","format":"date-time","type":"string"}}}}
```

## The Tags object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"Tags":{"properties":{"count":{"description":"Total number of tags","type":"integer"},"next":{"description":"URL to the next page of results","nullable":true,"type":"string"},"previous":{"description":"URL to the previous page of results","nullable":true,"type":"string"},"results":{"items":{"$ref":"#/components/schemas/Tag"},"type":"array"}},"type":"object"},"Tag":{"properties":{"pk":{"description":"The unique identifier of the tag","type":"integer"},"name":{"description":"The name of the tag","type":"string"},"color":{"description":"The color of the tag in hex format","type":"string"},"tag_group_id":{"description":"The ID of the tag group this tag belongs to, if any","nullable":true,"type":"integer"}},"required":["color","name","pk"],"type":"object"}}}}
```

## The NewSupportsExchange object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"NewSupportsExchange":{"properties":{"site":{"$ref":"#/components/schemas/NewSupportsExchange_site"},"support_type":{"$ref":"#/components/schemas/NewSupportsExchange_support_type"},"expected_retrieved":{"description":"Expected number of supports that should be retrieved on the site","type":"number"},"actual_retrieved":{"description":"Actual number of supports that were retrieved on the site","type":"number"},"expected_delivered":{"description":"Expected number of supports that should be delivered on the site","type":"number"},"actual_delivered":{"description":"Actual number of supports that were delivered on the site","type":"number"},"observations":{"description":"Free text. Observations about this supports exchange. Can be filled on mobile app, web app or via API.","type":"string"}},"required":["site","support_type"],"type":"object"},"NewSupportsExchange_site":{"description":"uid of the site where supports exchange is expected","properties":{"uid":{"description":"uid of the site","format":"uuid","type":"string"},"remote_id":{"description":"remote_id of the site","type":"string"}},"type":"object"},"NewSupportsExchange_support_type":{"description":"Type of the supports that are exchanged","properties":{"uid":{"format":"uuid","type":"string"},"remote_id":{"description":"your id of the support type","type":"string"}},"type":"object"}}}}
```

## The SupportsExchange object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"SupportsExchange":{"properties":{"uid":{"description":"uid of the support exchange","format":"uuid","type":"string"},"site":{"$ref":"#/components/schemas/SupportsExchange_site"},"support_type":{"$ref":"#/components/schemas/SupportType"},"expected_retrieved":{"description":"Expected number of supports that should be retrieved on the site","type":"number"},"actual_retrieved":{"description":"Actual number of supports that were retrieved on the site","type":"number"},"expected_delivered":{"description":"Expected number of supports that should be delivered on the site","type":"number"},"actual_delivered":{"description":"Actual number of supports that were delivered on the site","type":"number"},"observations":{"description":"Free text. Observations about this supports exchange. Can be filled on mobile app, web app or via API.","type":"string"},"remote_id":{"description":"The ID of the support in your system","type":"string"}},"type":"object"},"SupportsExchange_site":{"description":"site where supports exchange is expected","properties":{"uid":{"description":"uid of the site","format":"uuid","type":"string"},"remote_id":{"description":"remote_id of the site","type":"string"}},"type":"object"},"SupportType":{"description":"Type of the supports that are exchanged","properties":{"name":{"description":"Display name of the support type","type":"string"},"created":{"$ref":"#/components/schemas/created"},"uid":{"format":"uuid","type":"string"},"remote_id":{"description":"The id of the support type in your system.","type":"string"}},"type":"object"},"created":{"description":"Date of creation on our server","format":"date-time","type":"string"}}}}
```

## The UpdateSupportsExchange object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"UpdateSupportsExchange":{"properties":{"site":{"$ref":"#/components/schemas/NewSupportsExchange_site"},"support_type":{"$ref":"#/components/schemas/NewSupportsExchange_support_type"},"expected_retrieved":{"description":"Expected number of supports that should be retrieved on the site","type":"number"},"actual_retrieved":{"description":"Actual number of supports that were retrieved on the site","type":"number"},"expected_delivered":{"description":"Expected number of supports that should be delivered on the site","type":"number"},"actual_delivered":{"description":"Actual number of supports that were delivered on the site","type":"number"},"observations":{"description":"Free text. Observations about this supports exchange. Can be filled on mobile app, web app or via API.","type":"string"}},"required":["site","support_type"],"type":"object"},"NewSupportsExchange_site":{"description":"uid of the site where supports exchange is expected","properties":{"uid":{"description":"uid of the site","format":"uuid","type":"string"},"remote_id":{"description":"remote_id of the site","type":"string"}},"type":"object"},"NewSupportsExchange_support_type":{"description":"Type of the supports that are exchanged","properties":{"uid":{"format":"uuid","type":"string"},"remote_id":{"description":"your id of the support type","type":"string"}},"type":"object"}}}}
```

## The CreateTelematicsVehicle object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"CreateTelematicsVehicle":{"properties":{"telematics":{"enum":["trimble"],"type":"string"},"license_plate":{"type":"string"},"telematics_id":{"description":"ID of the vehicle in the telematics system","type":"string"}},"required":["license_plate","telematics","telematics_id"],"type":"object"}}}}
```

## The TelematicsVehicle object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"TelematicsVehicle":{"properties":{"telematics":{"enum":["trimble"],"type":"string"},"license_plate":{"type":"string"},"telematics_id":{"description":"ID of the vehicle in the telematics system","type":"string"}},"type":"object"}}}}
```

## The CreateTrace object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"CreateTrace":{"properties":{"license_plate":{"description":"License plate number","maxLength":200,"type":"string"},"country":{"description":"Country code of the license plate","type":"string"},"time":{"description":"Timestamp at which the trace was generated. ISO-8601 format.","type":"string"},"mileage":{"description":"Mileage expressed in kilometers","type":"integer"},"latitude":{"description":"Latitude of the position of the vehicle","type":"number"},"longitude":{"description":"Longitude of the position of the vehicle","type":"number"}},"required":["license_plate"],"type":"object"}}}}
```

## The Trace object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"Trace":{"properties":{"pk":{"description":"Dashdoc's internal id","type":"number"},"license_plate":{"description":"License plate number","maxLength":200,"type":"string"},"country":{"description":"Country code of the license plate","type":"string"},"time":{"description":"Timestamp at which the trace was generated. ISO-8601 format.","type":"string"},"mileage":{"description":"Mileage expressed in kilometers","type":"integer"},"latitude":{"description":"Latitude of the position of the vehicle","type":"number"},"longitude":{"description":"Longitude of the position of the vehicle","type":"number"}},"type":"object"}}}}
```

## The Trailers object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"Trailers":{"properties":{"count":{"type":"integer"},"next":{"nullable":true,"type":"string"},"previous":{"nullable":true,"type":"string"},"results":{"items":{"$ref":"#/components/schemas/Trailer"},"type":"array"}},"type":"object"},"Trailer":{"properties":{"pk":{"description":"Dashdoc's internal id","type":"number"},"original":{"description":"Ignore. Dashdoc technical data","type":"number"},"carrier":{"description":"Dashdoc's internal id of the carrier owning the trailer","type":"number"},"license_plate":{"description":"License plate number","type":"string"},"fleet_number":{"description":"Your trailer fleet number","type":"string"},"remote_id":{"description":"The ID of the trailer in your system","type":"string"},"created":{"description":"Date of creation on our server","format":"date-time","type":"string"},"used_for_qualimat_transports":{"description":"True if the trailer can be used for Qualimat transport (only used for visual help and warnings)","type":"boolean"},"tags":{"description":"List of tags applied to the trailer.","items":{"$ref":"#/components/schemas/Tag"},"type":"array"},"technical_control_deadline":{"format":"date-time","type":"string"},"country":{"$ref":"#/components/schemas/country"},"unavailability":{"description":"List of unavailable period","items":{"$ref":"#/components/schemas/Unavailability"},"type":"array"},"events":{"description":"Ignore. Dashdoc technical data.","items":{"type":"object"},"type":"array"}},"type":"object"},"Tag":{"properties":{"pk":{"description":"The unique identifier of the tag","type":"integer"},"name":{"description":"The name of the tag","type":"string"},"color":{"description":"The color of the tag in hex format","type":"string"},"tag_group_id":{"description":"The ID of the tag group this tag belongs to, if any","nullable":true,"type":"integer"}},"required":["color","name","pk"],"type":"object"},"country":{"description":"Only the 2-character codification is accepted (ISO 3166-1 alpha-2)","type":"string"},"Unavailability":{"properties":{"id":{"description":"Dashdoc's internal id","type":"number"},"remote_id":{"description":"The ID of the unavailability in your system","type":"string"},"created":{"description":"Date of creation on our server","format":"date-time","type":"string"},"start_date":{"description":"Start date of the unavailability","format":"date-time","type":"string"},"end_date":{"description":"End date of the unavailability","format":"date-time","type":"string"},"unavailability_type":{"description":"Type of unavailability","enum":["paid_vacation","day_off","sick_leave","training","vacation","maintenance","rental","other"],"type":"string"},"unavailability_note":{"description":"Notes about the unavailability","type":"string"}},"type":"object"}}}}
```

## The NewTrailer object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"NewTrailer":{"properties":{"remote_id":{"description":"The ID of the trailer in your system.","type":"string"},"fleet_number":{"description":"Your trailer fleet number. It has to be unique among all your trailers. When filled, fleet number will be displayed in the web and mobile app next to license plate number. It can also be used for searches.","maxLength":10,"type":"string"},"license_plate":{"description":"License plate number (has to be unique)","maxLength":200,"type":"string"},"used_for_qualimat_transports":{"description":"True if the trailer can be used for Qualimat transport. This value is used to add a Qualimat logo next to the trailer in forms, in order to help the user selecting the trailer when creating a transport. The is no control on the value. You can create a Qualimat transport with a trailer that is not flagged for Qualimat. In this case a warning is displayed in the transport detail.","type":"boolean"},"tags":{"description":"List of tags applied to the trailer.","items":{"$ref":"#/components/schemas/Tag"},"type":"array"}},"type":"object"},"Tag":{"properties":{"pk":{"description":"The unique identifier of the tag","type":"integer"},"name":{"description":"The name of the tag","type":"string"},"color":{"description":"The color of the tag in hex format","type":"string"},"tag_group_id":{"description":"The ID of the tag group this tag belongs to, if any","nullable":true,"type":"integer"}},"required":["color","name","pk"],"type":"object"}}}}
```

## The Trailer object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"Trailer":{"properties":{"pk":{"description":"Dashdoc's internal id","type":"number"},"original":{"description":"Ignore. Dashdoc technical data","type":"number"},"carrier":{"description":"Dashdoc's internal id of the carrier owning the trailer","type":"number"},"license_plate":{"description":"License plate number","type":"string"},"fleet_number":{"description":"Your trailer fleet number","type":"string"},"remote_id":{"description":"The ID of the trailer in your system","type":"string"},"created":{"description":"Date of creation on our server","format":"date-time","type":"string"},"used_for_qualimat_transports":{"description":"True if the trailer can be used for Qualimat transport (only used for visual help and warnings)","type":"boolean"},"tags":{"description":"List of tags applied to the trailer.","items":{"$ref":"#/components/schemas/Tag"},"type":"array"},"technical_control_deadline":{"format":"date-time","type":"string"},"country":{"$ref":"#/components/schemas/country"},"unavailability":{"description":"List of unavailable period","items":{"$ref":"#/components/schemas/Unavailability"},"type":"array"},"events":{"description":"Ignore. Dashdoc technical data.","items":{"type":"object"},"type":"array"}},"type":"object"},"Tag":{"properties":{"pk":{"description":"The unique identifier of the tag","type":"integer"},"name":{"description":"The name of the tag","type":"string"},"color":{"description":"The color of the tag in hex format","type":"string"},"tag_group_id":{"description":"The ID of the tag group this tag belongs to, if any","nullable":true,"type":"integer"}},"required":["color","name","pk"],"type":"object"},"country":{"description":"Only the 2-character codification is accepted (ISO 3166-1 alpha-2)","type":"string"},"Unavailability":{"properties":{"id":{"description":"Dashdoc's internal id","type":"number"},"remote_id":{"description":"The ID of the unavailability in your system","type":"string"},"created":{"description":"Date of creation on our server","format":"date-time","type":"string"},"start_date":{"description":"Start date of the unavailability","format":"date-time","type":"string"},"end_date":{"description":"End date of the unavailability","format":"date-time","type":"string"},"unavailability_type":{"description":"Type of unavailability","enum":["paid_vacation","day_off","sick_leave","training","vacation","maintenance","rental","other"],"type":"string"},"unavailability_note":{"description":"Notes about the unavailability","type":"string"}},"type":"object"}}}}
```

## The UpdateTrailer object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"UpdateTrailer":{"properties":{"remote_id":{"description":"The ID of the trailer in your system.","type":"string"},"fleet_number":{"description":"Your trailer fleet number. It has to be unique among all your trailers. When filled, fleet number will be displayed in the web and mobile app next to license plate number. It can also be used for searches.","maxLength":10,"type":"string"},"license_plate":{"description":"License plate number","maxLength":200,"type":"string"},"used_for_qualimat_transports":{"description":"True if the trailer can be used for Qualimat transport. This value is used to add a Qualimat logo next to the trailer in forms, in order to help the user selecting the trailer when creating a transport. The is no control on the value. You can create a Qualimat transport with a trailer that is not flagged for Qualimat. In this case a warning is displayed in the transport detail.","type":"boolean"},"tags":{"description":"List of tags applied to the trailer.","items":{"$ref":"#/components/schemas/Tag"},"type":"array"}},"type":"object"},"Tag":{"properties":{"pk":{"description":"The unique identifier of the tag","type":"integer"},"name":{"description":"The name of the tag","type":"string"},"color":{"description":"The color of the tag in hex format","type":"string"},"tag_group_id":{"description":"The ID of the tag group this tag belongs to, if any","nullable":true,"type":"integer"}},"required":["color","name","pk"],"type":"object"}}}}
```

## The TrackDechetsWasteNotes object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"TrackDechetsWasteNotes":{"properties":{"count":{"type":"integer"},"next":{"nullable":true,"type":"string"},"previous":{"nullable":true,"type":"string"},"results":{"items":{"$ref":"#/components/schemas/TrackDechetsWasteNote"},"type":"array"}},"type":"object"},"TrackDechetsWasteNote":{"properties":{"uid":{"description":"Dashdoc uid link between the transport and the TrackDéchets waste note","format":"uuid","type":"string"},"readable_id":{"description":"Waste note readable id from TrackDéchets","type":"string"},"opaque_id":{"description":"Waste note opaque id from TrackDéchets, differs from `readable_id` for BSD type of waste note only","type":"string"},"status":{"description":"TrackDéchets status of the waste note","type":"string"},"type":{"description":"Waste note type, based on its `readable_id`","type":"string"},"transport":{"$ref":"#/components/schemas/TrackDechetsWasteNote_transport"},"created":{"description":"creation date and time","format":"date-time","type":"string"},"updated":{"description":"last update date and time","format":"date-time","type":"string"}},"type":"object"},"TrackDechetsWasteNote_transport":{"description":"Transport","properties":{"uid":{"description":"uuid of the transport","format":"uuid","type":"string"},"remote_id":{"description":"your remote transport id","type":"string"}},"type":"object"}}}}
```

## The LinkTrackDechetsWasteNote object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"LinkTrackDechetsWasteNote":{"properties":{"readable_id":{"description":"Waste note readable id from TrackDéchets","type":"string"},"transport":{"$ref":"#/components/schemas/LinkTrackDechetsWasteNote_transport"}},"required":["readable_id"],"type":"object"},"LinkTrackDechetsWasteNote_transport":{"description":"Transport, identified either by its `uid` or `remote_id`","properties":{"uid":{"description":"uuid of the transport. Optional, not required if `remote_id` is sent.","format":"uuid","type":"string"},"remote_id":{"description":"your remote transport id. Optional, ignored if `uid` is sent.","type":"string"}},"type":"object"}}}}
```

## The TrackDechetsWasteNote object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"TrackDechetsWasteNote":{"properties":{"uid":{"description":"Dashdoc uid link between the transport and the TrackDéchets waste note","format":"uuid","type":"string"},"readable_id":{"description":"Waste note readable id from TrackDéchets","type":"string"},"opaque_id":{"description":"Waste note opaque id from TrackDéchets, differs from `readable_id` for BSD type of waste note only","type":"string"},"status":{"description":"TrackDéchets status of the waste note","type":"string"},"type":{"description":"Waste note type, based on its `readable_id`","type":"string"},"transport":{"$ref":"#/components/schemas/TrackDechetsWasteNote_transport"},"created":{"description":"creation date and time","format":"date-time","type":"string"},"updated":{"description":"last update date and time","format":"date-time","type":"string"}},"type":"object"},"TrackDechetsWasteNote_transport":{"description":"Transport","properties":{"uid":{"description":"uuid of the transport","format":"uuid","type":"string"},"remote_id":{"description":"your remote transport id","type":"string"}},"type":"object"}}}}
```

## The TransportLoadingPlan object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"TransportLoadingPlan":{"properties":{"uid":{"format":"uuid","type":"string"},"created":{"$ref":"#/components/schemas/created"},"created_device":{"$ref":"#/components/schemas/created_device"},"transport":{"format":"uuid","type":"string"},"compartments":{"items":{"$ref":"#/components/schemas/Compartment"},"type":"array"}},"type":"object"},"created":{"description":"Date of creation on our server","format":"date-time","type":"string"},"created_device":{"description":"Date of creation on device (ISO 8601)","format":"date-time","type":"string"},"Compartment":{"properties":{"compartment_number":{"type":"number"},"load":{"$ref":"#/components/schemas/DeliveryLoads"},"weight":{"description":"In kilograms","format":"float","type":"number"},"volume":{"description":"Volume of load in m3","format":"float","type":"number"},"volume_display_unit":{"default":"m3","enum":["m3","L"],"type":"string"},"unloading_status":{"enum":["","fully_unloaded","partially_unloaded","not_unloaded"],"type":"string"}},"type":"object"},"DeliveryLoads":{"properties":{"uid":{"description":"Dashdoc's internal id.","type":"string"},"remote_id":{"description":"The ID of the load in your system. It has to be unique among all your transports.","type":"string"},"description":{"description":"Text description of the load","type":"string"},"reference":{"description":"Reference of the load","type":"string"},"round_id":{"description":"The ID of the round.","format":"integer","type":"number"},"weight":{"description":"In kilograms","format":"float","type":"number"},"volume":{"description":"Volume of load in m3","format":"float","type":"number"},"volume_display_unit":{"default":"m3","enum":["m3","L"],"type":"string"},"linear_meters":{"description":"Length of load in meters","format":"float","type":"number"},"quantity":{"description":"Only one decimal accepted (e.g 0.0)","format":"float","type":"number"},"pallet_equivalence":{"description":"Pallet equivalence (EPS/EQPAL): how many standard pallet spaces the load occupies. `null` when it was never set. Otherwise at least `0.01`, with two decimals kept.","format":"float","nullable":true,"type":"number"},"category":{"description":"Packaging of the load. The text is free but these specific values cause a custom flow on the mobile app: `pallets`, `containers`, `bulk`, `roundwood`, `powder_tank`, `bulk_qualimat`, `rental`.","type":"string"},"dangerous_goods_category":{"description":"ADR class","enum":["1","2","3","4.1","4.2","4.3","5.1","5.2","6.1","6.2","7","8","9"],"type":"string"},"is_dangerous":{"type":"boolean"},"adr_un_code":{"type":"string"},"legal_mentions":{"type":"string"},"complementary_information":{"description":"Any information about the load that doesn't fit to the description field","type":"string"},"container_number":{"type":"string"},"tare_weight":{"description":"In kilograms","format":"float","type":"number"},"container_seal_number":{"type":"string"},"refrigerated":{"description":"Indicates whether the load is refrigerated. If true, the trucker can fill in the temperature.","type":"boolean"},"temperature":{"type":"string"},"steres":{"format":"float","type":"number"},"idtf_number":{"description":"Must match an existing IDTF number","type":"string"},"use_identifiers":{"description":"if `true`, trucker is asked to scan barcode identifiers on load","type":"boolean"},"identifiers":{"description":"Only relevant if use_identifiers is set to `true`. List of expected barcode identifiers that the trucker should scan at loading and unloading. App controls that expected barcodes are actually scanned. If empty, the trucker will have to scan barcodes anyway, but there won't be any check. Feature has to be activated in your account by your Dashdoc projet manager.","items":{"type":"string"},"type":"array"},"identifiers_observations":{"description":"Observations explaining issues with identifier, such as missing or unexpected identifiers","type":"string"}},"type":"object"}}}}
```

## The NewTransportMessage object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"NewTransportMessage":{"properties":{"uid":{"format":"uuid","type":"string"},"created":{"$ref":"#/components/schemas/created"},"created_device":{"format":"date-time","type":"string"},"creation_method":{"type":"string"},"author":{"$ref":"#/components/schemas/NewTransportMessage_author"},"type":{"enum":["note","load_verification","share","document","photo"],"maxLength":100,"type":"string"},"document_title":{"description":"Filename or if uploaded by a trucker from the mobile app, the document title is generic, for instance `photo`.","maxLength":100,"type":"string"},"document_type":{"enum":["load_photo","cmr","washing_note","delivery_note","confirmation","weight_note","waste_manifest","holders_swap_note","invoice"],"maxLength":100,"type":"string"},"document":{"description":"File content. **Use content-type with `multipart/form-data` value to the header of the request to send a document.**","format":"byte","type":"string"},"is_attached_to_cmr":{"type":"boolean"},"transport":{"format":"uuid","type":"string"},"site":{"description":"This field is used for the default values of the field readable_by_company_ids; if null, companies from all Sites of the transport are listed in readable_by_company_ids, otherwise only the company of this Site. Site must exist in this transport. This field is part of a beta feature.","format":"uuid","nullable":true,"type":"string"},"readable_by_company_ids":{"description":"A list containing the pk of each company allowed to access the document, every company must be part of the transport. If no values are sent, it will be computed with default values; Carrier, Shipper, Invoiced Customer and Site's pk (see Site field). Once values have been sent, the behavior adding default companies is deactivated. The author company is always added. Only pks of companies from the transport will be added, others will be ignored. This field is part of a beta feature.","items":{"type":"integer"},"type":"array"},"message":{"description":"message displayed in the activity thread of a transport in the web app and in the mobile app","type":"string"},"latitude":{"$ref":"#/components/schemas/latitude"},"longitude":{"$ref":"#/components/schemas/longitude"},"reference":{"description":"Free text. This reference is searchable in the transports dashboard.","maxLength":140,"type":"string"},"visible_by_everyone":{"$ref":"#/components/schemas/visible_by_everyone"},"readable_by_trucker":{"$ref":"#/components/schemas/readable_by_trucker"}},"required":["transport","type"],"type":"object"},"created":{"description":"Date of creation on our server","format":"date-time","type":"string"},"NewTransportMessage_author":{"properties":{"display_name":{"type":"string"},"company":{"type":"number"},"pk":{"description":"Dashdoc's internal id.","type":"number"}},"type":"object"},"latitude":{"description":"Latitude using the decimal GPS coordinates (WGS84). At 7 decimals, the position is accurate around the centimeter.","format":"float","nullable":true,"type":"number"},"longitude":{"description":"Longitude using the decimal GPS coordinates (WGS84). At 7 decimals, the position is accurate around the centimeter.","format":"float","nullable":true,"type":"number"},"visible_by_everyone":{"description":"This field is used to make the transport message public, which makes it visible by all parties of the transport.","type":"boolean"},"readable_by_trucker":{"description":"This field is used to allow truckers to see the transport message. **Only available for carriers.**","type":"boolean"}}}}
```

## The CreateTransportMessage object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"CreateTransportMessage":{"properties":{"uid":{"format":"uuid","type":"string"},"created":{"$ref":"#/components/schemas/created"},"created_device":{"format":"date-time","type":"string"},"creation_method":{"type":"string"},"author":{"$ref":"#/components/schemas/NewTransportMessage_author"},"type":{"enum":["note","load_verification","share","document","photo"],"maxLength":100,"type":"string"},"document_title":{"description":"Filename or if uploaded by a trucker from the mobile app, the document title is generic, for instance `photo`.","maxLength":100,"type":"string"},"document_type":{"enum":["load_photo","cmr","washing_note","delivery_note","confirmation","weight_note","waste_manifest","holders_swap_note","invoice"],"maxLength":100,"type":"string"},"document":{"description":"URL of the stored document. You can download the document from this URL.","type":"string"},"is_attached_to_cmr":{"type":"boolean"},"transport":{"format":"uuid","type":"string"},"site":{"description":"This field is used for the default values of the field readable_by_company_ids; if null, companies from all Sites of the transport are listed in readable_by_company_ids, otherwise only the company of this Site. Site must exist in this transport. This field is part of a beta feature.","format":"uuid","nullable":true,"type":"string"},"site_remote_id":{"type":"string"},"readable_by_company_ids":{"description":"A list containing the pk of each company allowed to access the document, every company must be part of the transport. If no values are sent, it will be computed with default values; Carrier, Shipper, Invoiced Customer and Site's pk (see Site field). Once values have been sent, the behavior adding default companies is deactivated. The author company is always added. Only pks of companies from the transport will be added, others will be ignored. This field is part of a beta feature.","items":{"type":"integer"},"type":"array"},"message":{"description":"message displayed in the activity thread of a transport in the web app and in the mobile app","type":"string"},"latitude":{"$ref":"#/components/schemas/latitude"},"longitude":{"$ref":"#/components/schemas/longitude"},"reference":{"description":"Free text. This reference is searchable in the transports dashboard. Filled by trucker if document is added from mobile app, by user if document is added from web app, or filled by API request.","maxLength":140,"type":"string"},"visible_by_everyone":{"$ref":"#/components/schemas/visible_by_everyone"},"readable_by_trucker":{"$ref":"#/components/schemas/readable_by_trucker"}},"type":"object"},"created":{"description":"Date of creation on our server","format":"date-time","type":"string"},"NewTransportMessage_author":{"properties":{"display_name":{"type":"string"},"company":{"type":"number"},"pk":{"description":"Dashdoc's internal id.","type":"number"}},"type":"object"},"latitude":{"description":"Latitude using the decimal GPS coordinates (WGS84). At 7 decimals, the position is accurate around the centimeter.","format":"float","nullable":true,"type":"number"},"longitude":{"description":"Longitude using the decimal GPS coordinates (WGS84). At 7 decimals, the position is accurate around the centimeter.","format":"float","nullable":true,"type":"number"},"visible_by_everyone":{"description":"This field is used to make the transport message public, which makes it visible by all parties of the transport.","type":"boolean"},"readable_by_trucker":{"description":"This field is used to allow truckers to see the transport message. **Only available for carriers.**","type":"boolean"}}}}
```

## The TransportMessage object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"TransportMessage":{"properties":{"uid":{"format":"uuid","type":"string"},"created":{"$ref":"#/components/schemas/created"},"created_device":{"format":"date-time","type":"string"},"creation_method":{"type":"string"},"author":{"$ref":"#/components/schemas/NewTransportMessage_author"},"type":{"enum":["note","load_verification","share","document","photo"],"maxLength":100,"type":"string"},"document_title":{"description":"Filename or if uploaded by a trucker from the mobile app, the document title is generic, for instance `photo`.","maxLength":100,"type":"string"},"document_type":{"enum":["load_photo","cmr","washing_note","delivery_note","confirmation","weight_note","waste_manifest","holders_swap_note","invoice"],"maxLength":100,"type":"string"},"document":{"description":"URL of the stored document. You can download the document from this URL.","type":"string"},"is_attached_to_cmr":{"type":"boolean"},"transport":{"format":"uuid","type":"string"},"site":{"description":"This field is used for the default values of the field readable_by_company_ids; if null, companies from all Sites of the transport are listed in readable_by_company_ids, otherwise only the company of this Site. Site must exist in this transport. This field is part of a beta feature.","format":"uuid","nullable":true,"type":"string"},"site_remote_id":{"type":"string"},"readable_by_company_ids":{"description":"A list containing the pk of each company allowed to access the document, every company must be part of the transport. If no values are sent, it will be computed with default values; Carrier, Shipper, Invoiced Customer and Site's pk (see Site field). Once values have been sent, the behavior adding default companies is deactivated. The author company is always added. Only pks of companies from the transport will be added, others will be ignored. This field is part of a beta feature.","items":{"type":"integer"},"type":"array"},"message":{"description":"message displayed in the activity thread of a transport in the web app and in the mobile app","type":"string"},"latitude":{"$ref":"#/components/schemas/latitude"},"longitude":{"$ref":"#/components/schemas/longitude"},"reference":{"description":"Free text. This reference is searchable in the transports dashboard. Filled by trucker if document is added from mobile app, by user if document is added from web app, or filled by API request.","maxLength":140,"type":"string"},"visible_by_everyone":{"$ref":"#/components/schemas/visible_by_everyone"},"readable_by_trucker":{"$ref":"#/components/schemas/readable_by_trucker"},"extracted_reference":{"description":"Reference extracted by AI from the document. AI runs only on weight notes, so it will be null for other documents. \"\" if no reference has been found by the AI.","type":"string"}},"type":"object"},"created":{"description":"Date of creation on our server","format":"date-time","type":"string"},"NewTransportMessage_author":{"properties":{"display_name":{"type":"string"},"company":{"type":"number"},"pk":{"description":"Dashdoc's internal id.","type":"number"}},"type":"object"},"latitude":{"description":"Latitude using the decimal GPS coordinates (WGS84). At 7 decimals, the position is accurate around the centimeter.","format":"float","nullable":true,"type":"number"},"longitude":{"description":"Longitude using the decimal GPS coordinates (WGS84). At 7 decimals, the position is accurate around the centimeter.","format":"float","nullable":true,"type":"number"},"visible_by_everyone":{"description":"This field is used to make the transport message public, which makes it visible by all parties of the transport.","type":"boolean"},"readable_by_trucker":{"description":"This field is used to allow truckers to see the transport message. **Only available for carriers.**","type":"boolean"}}}}
```

## The UpdateTransportMessage object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"UpdateTransportMessage":{"properties":{"uid":{"format":"uuid","type":"string"},"created":{"$ref":"#/components/schemas/created"},"created_device":{"format":"date-time","type":"string"},"creation_method":{"type":"string"},"author":{"$ref":"#/components/schemas/NewTransportMessage_author"},"type":{"enum":["note","load_verification","share","document","photo"],"maxLength":100,"type":"string"},"document_title":{"description":"Filename or if uploaded by a trucker from the mobile app, the document title is generic, for instance `photo`.","maxLength":100,"type":"string"},"document_type":{"enum":["load_photo","cmr","washing_note","delivery_note","confirmation","weight_note","waste_manifest","holders_swap_note","invoice"],"maxLength":100,"type":"string"},"document":{"$ref":"#/components/schemas/UpdateTransportMessage_document"},"is_attached_to_cmr":{"type":"boolean"},"transport":{"format":"uuid","type":"string"},"site":{"description":"This field is used for the default values of the field readable_by_company_ids; if null, companies from all Sites of the transport are listed in readable_by_company_ids, otherwise only the company of this Site. Site must exist in this transport. This field is part of a beta feature.","format":"uuid","nullable":true,"type":"string"},"readable_by_company_ids":{"description":"A list containing the pk of each company allowed to access the document, every company must be part of the transport. If no values are sent, it will be computed with default values; Carrier, Shipper, Invoiced Customer and Site's pk (see Site field). Once values have been sent, the behavior adding default companies is deactivated. The author company is always added. Only pks of companies from the transport will be added, others will be ignored. This field is part of a beta feature.","items":{"type":"integer"},"type":"array"},"message":{"description":"message displayed in the activity thread of a transport in the web app and in the mobile app","type":"string"},"latitude":{"$ref":"#/components/schemas/latitude"},"longitude":{"$ref":"#/components/schemas/longitude"},"reference":{"description":"Free text. This reference is searchable in the transports dashboard. Filled by trucker if document is added from mobile app, by user if document is added from web app, or filled by API request.","maxLength":140,"type":"string"},"visible_by_everyone":{"$ref":"#/components/schemas/visible_by_everyone"},"readable_by_trucker":{"$ref":"#/components/schemas/readable_by_trucker"}},"type":"object"},"created":{"description":"Date of creation on our server","format":"date-time","type":"string"},"NewTransportMessage_author":{"properties":{"display_name":{"type":"string"},"company":{"type":"number"},"pk":{"description":"Dashdoc's internal id.","type":"number"}},"type":"object"},"UpdateTransportMessage_document":{"properties":{"value":{"description":"file content","type":"string"},"options":{"$ref":"#/components/schemas/UpdateTransportMessage_document_options"}},"type":"object"},"UpdateTransportMessage_document_options":{"properties":{"filename":{"description":"filename","type":"string"}},"type":"object"},"latitude":{"description":"Latitude using the decimal GPS coordinates (WGS84). At 7 decimals, the position is accurate around the centimeter.","format":"float","nullable":true,"type":"number"},"longitude":{"description":"Longitude using the decimal GPS coordinates (WGS84). At 7 decimals, the position is accurate around the centimeter.","format":"float","nullable":true,"type":"number"},"visible_by_everyone":{"description":"This field is used to make the transport message public, which makes it visible by all parties of the transport.","type":"boolean"},"readable_by_trucker":{"description":"This field is used to allow truckers to see the transport message. **Only available for carriers.**","type":"boolean"}}}}
```

## The UpdateTransportMessage\_1 object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"UpdateTransportMessage_1":{"properties":{"uid":{"format":"uuid","type":"string"},"created":{"$ref":"#/components/schemas/created"},"created_device":{"format":"date-time","type":"string"},"creation_method":{"type":"string"},"author":{"$ref":"#/components/schemas/NewTransportMessage_author"},"type":{"enum":["note","load_verification","share","document","photo"],"maxLength":100,"type":"string"},"document_title":{"description":"Filename or if uploaded by a trucker from the mobile app, the document title is generic, for instance `photo`.","maxLength":100,"type":"string"},"document_type":{"enum":["load_photo","cmr","washing_note","delivery_note","confirmation","weight_note","waste_manifest","holders_swap_note","invoice"],"maxLength":100,"type":"string"},"document":{"description":"URL of the stored document. You can download the document from this URL.","type":"string"},"is_attached_to_cmr":{"type":"boolean"},"transport":{"format":"uuid","type":"string"},"site":{"description":"This field is used for the default values of the field readable_by_company_ids; if null, companies from all Sites of the transport are listed in readable_by_company_ids, otherwise only the company of this Site. Site must exist in this transport. This field is part of a beta feature.","format":"uuid","nullable":true,"type":"string"},"readable_by_company_ids":{"description":"A list containing the pk of each company allowed to access the document, every company must be part of the transport. If no values are sent, it will be computed with default values; Carrier, Shipper, Invoiced Customer and Site's pk (see Site field). Once values have been sent, the behavior adding default companies is deactivated. The author company is always added. Only pks of companies from the transport will be added, others will be ignored. This field is part of a beta feature.","items":{"type":"integer"},"type":"array"},"message":{"description":"message displayed in the activity thread of a transport in the web app and in the mobile app","type":"string"},"latitude":{"$ref":"#/components/schemas/latitude"},"longitude":{"$ref":"#/components/schemas/longitude"},"reference":{"description":"Free text. This reference is searchable in the transports dashboard. Filled by trucker if document is added from mobile app, by user if document is added from web app, or filled by API request.","maxLength":140,"type":"string"},"visible_by_everyone":{"$ref":"#/components/schemas/visible_by_everyone"},"readable_by_trucker":{"$ref":"#/components/schemas/readable_by_trucker"},"extracted_reference":{"description":"Reference extracted by AI from the document. AI runs only on weight notes, so it will be null for other documents. \"\" if no reference has been found by the AI.","type":"string"}},"type":"object"},"created":{"description":"Date of creation on our server","format":"date-time","type":"string"},"NewTransportMessage_author":{"properties":{"display_name":{"type":"string"},"company":{"type":"number"},"pk":{"description":"Dashdoc's internal id.","type":"number"}},"type":"object"},"latitude":{"description":"Latitude using the decimal GPS coordinates (WGS84). At 7 decimals, the position is accurate around the centimeter.","format":"float","nullable":true,"type":"number"},"longitude":{"description":"Longitude using the decimal GPS coordinates (WGS84). At 7 decimals, the position is accurate around the centimeter.","format":"float","nullable":true,"type":"number"},"visible_by_everyone":{"description":"This field is used to make the transport message public, which makes it visible by all parties of the transport.","type":"boolean"},"readable_by_trucker":{"description":"This field is used to allow truckers to see the transport message. **Only available for carriers.**","type":"boolean"}}}}
```

## The Transports object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"Transports":{"properties":{"count":{"type":"integer"},"next":{"nullable":true,"type":"string"},"previous":{"nullable":true,"type":"string"},"results":{"items":{"$ref":"#/components/schemas/TransportsListItem"},"type":"array"}},"type":"object"},"TransportsListItem":{"allOf":[{"$ref":"#/components/schemas/Transport"},{"$ref":"#/components/schemas/RetrievedTransport_allOf"}],"type":"object"},"Transport":{"properties":{"uid":{"description":"Dashdoc's internal id. It will be automatically generated by us.","format":"uuid","type":"string"},"sequential_id":{"type":"number"},"created":{"description":"Date of creation sent by the creator. Useful when the transport is created by mobile devices. If network connection is bad, the `created` date can be later than `created_device`","format":"date-time","type":"string"},"updated":{"format":"date-time","type":"string"},"deleted":{"nullable":true,"type":"string"},"remote_id":{"description":"Your transport id. It has to be unique among all your transports","type":"string"},"carrier_address":{"$ref":"#/components/schemas/AddressForTransport"},"created_by":{"$ref":"#/components/schemas/Company"},"created_device":{"format":"date-time","type":"string"},"creation_method":{"enum":["mobile_app","api","web_app"],"type":"string"},"archived_by":{"items":{"type":"object"},"type":"array"},"is_order":{"type":"boolean"},"carrier_assignation_status":{"allOf":[{"$ref":"#/components/schemas/CarrierAssignationStatus"}],"nullable":true},"invite_code":{"type":"string"},"deliveries":{"items":{"$ref":"#/components/schemas/Delivery"},"type":"array"},"segments":{"items":{"$ref":"#/components/schemas/Segment"},"type":"array"},"status":{"$ref":"#/components/schemas/Statuses"},"status_updates":{"items":{"$ref":"#/components/schemas/Status"},"type":"array"},"has_observations":{"type":"boolean"},"messages":{"items":{"$ref":"#/components/schemas/TransportMessage"},"type":"array"},"requested_vehicle":{"$ref":"#/components/schemas/requested_vehicle"},"documents":{"items":{"$ref":"#/components/schemas/Document"},"type":"array"},"carrier_reference":{"description":"Text that will help the carrier operators manage the transports, e.g. transport number in his TMS. It should only be set by the carrier of the transport and the transport's creator can toggle a company-wide setting to only allow the carrier to set it.","type":"string"},"price":{"$ref":"#/components/schemas/deprecated_price"},"requires_washing":{"description":"Flag to enable the truck washing flow in the mobile app","type":"boolean"},"business_privacy":{"description":"Flag to enable 'business privacy' mode: no eCMR will be generated, and the trucker won't be prompted to share the transport link.","type":"boolean"},"is_multiple_compartments":{"description":"Flag to enable 'multiple compartments' mode: truckers will have to select in which compartments loads were loaded. It also generates a specific delivery document : loading_plan.","type":"boolean"},"loading_plan":{"description":"Uid of the loading plan created by the trucker. Contact us if you need to retrieve data from it","type":"string"},"customer_to_invoice":{"$ref":"#/components/schemas/customer_to_invoice"},"parent_transport":{"$ref":"#/components/schemas/Transport_parent_transport"},"invoice_number":{"nullable":true,"type":"string"},"invoiced_price":{"$ref":"#/components/schemas/deprecated_invoiced_price"},"volume_display_unit":{"enum":["m3","L"],"type":"string"},"references":{"items":{"$ref":"#/components/schemas/Transport_references"},"type":"array"},"rental_deliveries":{"description":"Array of transports executed by the trucker during the rental order. Implies that the current transport is a rental order. Inner objects have the same transport data structure.","items":{"$ref":"#/components/schemas/Transport"},"type":"array"},"billing-metrics":{"deprecated":true,"description":"Retired feature, will always be null.","nullable":true,"type":"string"},"shape":{"type":"string"},"instructions":{"$ref":"#/components/schemas/global_instructions"},"carbon_footprint":{"description":"Carbon footprint of the transport in kgCO2","nullable":true,"readOnly":true,"type":"number"},"tags":{"description":"List of tags applied to the transport.","items":{"$ref":"#/components/schemas/Tag"},"type":"array"}},"required":["business_privacy","carrier_address","carrier_reference","created","created_by","created_device","creation_method","deliveries","documents","has_observations","invite_code","invoice_number","is_order","messages","price","references","remote_id","requested_vehicle","requires_washing","segments","sequential_id","status","status_updates","uid","updated"],"type":"object"},"AddressForTransport":{"properties":{"pk":{"description":"Dashdoc's internal id.","type":"number"},"name":{"type":"string"},"address":{"type":"string"},"city":{"type":"string"},"postcode":{"type":"string"},"country":{"$ref":"#/components/schemas/country"},"latitude":{"$ref":"#/components/schemas/latitude"},"longitude":{"$ref":"#/components/schemas/longitude"},"radius":{"default":500,"description":"Radius around the GPS coordinates within which the address is located (in meters)","type":"integer"},"coords_validated":{"default":false,"description":"if `true`, when this address is used as a loading or unloading site, the mobile app displays an itinerary button to start GPS app with guidance to these coordinates","type":"boolean"},"is_demo":{"$ref":"#/components/schemas/is_demo"},"is_carrier":{"type":"boolean"},"is_shipper":{"type":"boolean"},"is_origin":{"$ref":"#/components/schemas/address_is_origin_and_is_destination"},"is_destination":{"$ref":"#/components/schemas/address_is_origin_and_is_destination"},"created_by":{"type":"number"},"created":{"$ref":"#/components/schemas/created"},"remote_id":{"description":"The id of the address in your system.","type":"string"},"company":{"$ref":"#/components/schemas/CompanyForTransportAddress"},"original":{"type":"number"}},"type":"object"},"country":{"description":"Only the 2-character codification is accepted (ISO 3166-1 alpha-2)","type":"string"},"latitude":{"description":"Latitude using the decimal GPS coordinates (WGS84). At 7 decimals, the position is accurate around the centimeter.","format":"float","nullable":true,"type":"number"},"longitude":{"description":"Longitude using the decimal GPS coordinates (WGS84). At 7 decimals, the position is accurate around the centimeter.","format":"float","nullable":true,"type":"number"},"is_demo":{"description":"Indicates that the address is a fake one created from demonstration. Everything linked to it will be deleted when using the 'Delete demo content' button in company parameters","type":"boolean"},"address_is_origin_and_is_destination":{"description":"Whether this address is a \"Logistic Points\" and will be usable as pickup/delivery point.\nThe distinction between origin/pickup and destination/delivery was merged as a single \"Logistic Point\" concept. `is_origin` implies `is_destination` and vice-versa.\n","type":"boolean"},"created":{"description":"Date of creation on our server","format":"date-time","type":"string"},"CompanyForTransportAddress":{"properties":{"pk":{"description":"Dashdoc's internal id.","type":"number"},"remote_id":{"description":"The id of the company in your system.","type":"string"},"name":{"type":"string"},"trade_number":{"type":"string"},"country":{"$ref":"#/components/schemas/country"},"settings_contract_html":{"description":"Ignore. Dashdoc technical data.","type":"string"},"settings_logo":{"description":"Ignore. Dashdoc technical data.","nullable":true,"type":"string"},"settings_stamp":{"description":"Ignore. Dashdoc technical data.","nullable":true,"type":"string"},"settings_print_mode":{"description":"Ignore. Dashdoc technical data.","type":"boolean"},"settings_special_agreements":{"description":"Ignore. Dashdoc technical data.","type":"string"},"settings_transport_order_observations":{"type":"string"},"settings_constrain_reference_edition":{"type":"boolean"},"vat_number":{"type":"string"},"is_verified":{"type":"boolean"}},"type":"object"},"Company":{"properties":{"pk":{"description":"Dashdoc's internal id.","type":"number"},"remote_id":{"type":"string"},"created":{"format":"date-time","type":"object"},"updated":{"format":"date-time","type":"string"},"deleted":{"type":"boolean"},"invoicing_remote_id":{"description":"The id of the company in your invoicing system.","type":"string"},"name":{"type":"string"},"phone_number":{"type":"string"},"email":{"type":"string"},"siren":{"type":"string"},"trade_number":{"type":"string"},"country":{"$ref":"#/components/schemas/country"},"comments":{"type":"string"},"vat_number":{"type":"string"},"is_verified":{"type":"boolean"},"settings_transport_order_observations":{"type":"string"},"settings_constrain_reference_edition":{"type":"boolean"},"account_type":{"description":"Ignore. Dashdoc technical data.","type":"string"},"logo":{"description":"The URL of your logo","nullable":true,"type":"string"},"subscription_access":{"type":"object"},"settings":{"type":"object"},"primary_address":{"$ref":"#/components/schemas/PrimaryAddress_1"},"managers":{"items":{"$ref":"#/components/schemas/Managers"},"type":"array"},"has_loggable_managers":{"description":"Ignore. Dashdoc technical data.","type":"boolean"}},"type":"object"},"PrimaryAddress_1":{"properties":{"pk":{"description":"Dashdoc's internal id.","type":"number"},"name":{"type":"string"},"address":{"type":"string"},"city":{"type":"string"},"postcode":{"type":"string"},"country":{"$ref":"#/components/schemas/country"},"latitude":{"$ref":"#/components/schemas/latitude"},"longitude":{"$ref":"#/components/schemas/longitude"},"radius":{"default":500,"description":"Radius around the GPS coordinates within which the address is located (in meters)","type":"integer"},"coords_validated":{"default":false,"description":"if `true`, when this address is used as a loading or unloading site, the mobile app displays an itinerary button to start GPS app with guidance to these coordinates","type":"boolean"},"is_demo":{"$ref":"#/components/schemas/is_demo"},"is_carrier":{"description":"Whether this company is considered a carrier","type":"boolean"},"is_shipper":{"description":"Whether this company is considered a shipper","type":"boolean"},"is_origin":{"description":"Legacy, not relevant for a company's primary address. Consider creating a separate address associated with this partner instead.\n","type":"boolean"},"is_destination":{"description":"Legacy, not relevant for a company's primary address. Consider creating a separate address associated with this partner instead.\n","type":"boolean"},"created_by":{"$ref":"#/components/schemas/created-by"},"created_by_user":{"$ref":"#/components/schemas/created-by-user"},"created":{"$ref":"#/components/schemas/created"},"remote_id":{"description":"The id of the address in your system.","type":"string"}},"type":"object"},"created-by":{"nullable":true,"properties":{"pk":{"description":"company id","type":"number"},"name":{"description":"name of the company","type":"string"}},"type":"object"},"created-by-user":{"nullable":true,"properties":{"pk":{"type":"number"},"display_name":{"type":"string"},"company":{"description":"The company id who created the address","type":"number"},"trucker_id":{"description":"The trucker id who created the address","type":"number"}},"type":"object"},"Managers":{"properties":{"pk":{"description":"Dashdoc's internal id.","type":"number"},"user":{"$ref":"#/components/schemas/Managers_user"},"display_name":{"type":"string"},"role":{"type":"string"}},"type":"object"},"Managers_user":{"properties":{"email":{"format":"email","type":"string"},"first_name":{"type":"string"},"last_name":{"type":"string"}},"type":"object"},"CarrierAssignationStatus":{"description":"Carrier assignment state of an order (Only for chartered transport). Null values should be treated as unassigned.","enum":["unassigned","draft_assigned","assigned"],"type":"string"},"Delivery":{"properties":{"uid":{"description":"Dashdoc's internal id.","type":"string"},"sequential_id":{"description":"eCMR number","type":"number"},"remote_id":{"type":"string"},"tracking_id":{"description":"Deprecated","type":"string"},"origin":{"$ref":"#/components/schemas/CreateOrUpdateSite"},"destination":{"$ref":"#/components/schemas/CreateOrUpdateSite"},"shipper_address":{"$ref":"#/components/schemas/NewAddressReduced"},"planned_loads":{"description":"Loads as planned before the transport has been started","items":{"$ref":"#/components/schemas/DeliveryLoads"},"type":"array"},"loads":{"description":"Loads as they are most recently defined. This means it is: \n\n* equal to `planned_loads` before loading is actually done \n\n* equal to `origin_loads` after loading is done (with details validated by trucker), but unloading is not done yet \n\n* equal to `loads_loads` after unloading is actually done (with details validated by trucker)","items":{"$ref":"#/components/schemas/DeliveryLoads"},"type":"array"},"origin_loads":{"description":"Loads as validated by trucker right after loading is done","items":{"$ref":"#/components/schemas/DeliveryLoads"},"type":"array"},"destination_loads":{"description":"Loads as validated by trucker right after unloading is done","items":{"$ref":"#/components/schemas/DeliveryLoads"},"type":"array"},"tracking_contacts":{"description":"List of contacts that will automatically receive an email when delivery is done. ⚠️ If no tracking contacts are provided for a company and the setting `partner_email_fallback` is enabled, a tracking contact corresponding to the company's email will be added, at the creation of the transport. This only applies to the carrier and the shipper.","items":{"$ref":"#/components/schemas/Delivery_tracking_contacts"},"type":"array"},"shipper_reference":{"description":"Reference the client may use to match transport on his own system, e.g. an order number. The transport's creator can toggle a setting to only allow himself to set it.","type":"string"},"multiple_rounds":{"description":"If true, the trucker will be able to do a signature at loading, then add any amount of rounds for the transport (with weight/volume and weight ticket), and finish with a signature at unloading.","type":"boolean"}},"type":"object"},"CreateOrUpdateSite":{"properties":{"uid":{"format":"uuid","type":"string"},"remote_id":{"description":"The id of the site in your system","type":"string"},"address":{"allOf":[{"$ref":"#/components/schemas/SiteAddress"}],"nullable":true},"real_start":{"description":"date and time when trucker arrived on site","format":"date-time","readOnly":true,"type":"string"},"real_end":{"description":"date and time when trucker completed loading / unloading (depending whether site is origin or destination)","format":"date-time","readOnly":true,"type":"string"},"signature_process":{"type":"string"},"is_booking_needed":{"type":"boolean"},"instructions":{"$ref":"#/components/schemas/site_instructions"},"reference":{"type":"string"},"action":{"deprecated":true,"description":"Deprecated. Accepted for backward compatibility but ignored. Responses always return an empty string.","type":"string"},"eta":{"format":"date-time","nullable":true,"type":"string"},"eta_tracking":{"type":"boolean"},"punctuality_status":{"readOnly":true,"type":"string"},"supports_exchanges":{"$ref":"#/components/schemas/SupportsExchange"},"category":{"type":"string"},"slots":{"items":{"$ref":"#/components/schemas/Site_slots"},"type":"array"},"trucker_instructions":{"$ref":"#/components/schemas/trucker_instructions"},"trip":{"$ref":"#/components/schemas/Site_trip"}},"type":"object"},"SiteAddress":{"description":"Address of the site. Reference an existing address with its `pk` or `remote_id`, or send its details to have it matched or created.","properties":{"pk":{"description":"Dashdoc's internal id. Optional, set it to reference an existing address.","type":"integer"},"name":{"type":"string"},"address":{"type":"string"},"city":{"type":"string"},"postcode":{"type":"string"},"country":{"$ref":"#/components/schemas/country"},"latitude":{"$ref":"#/components/schemas/latitude"},"longitude":{"$ref":"#/components/schemas/longitude"},"radius":{"default":500,"description":"Radius around the GPS coordinates within which the address is located (in meters)","type":"integer"},"coords_validated":{"default":false,"description":"if `true`, when this address is used as a loading or unloading site, the mobile app displays an itinerary button to start GPS app with guidance to these coordinates","type":"boolean"},"is_demo":{"$ref":"#/components/schemas/is_demo"},"is_carrier":{"type":"boolean"},"is_shipper":{"type":"boolean"},"is_origin":{"$ref":"#/components/schemas/address_is_origin_and_is_destination"},"is_destination":{"$ref":"#/components/schemas/address_is_origin_and_is_destination"},"instructions":{"$ref":"#/components/schemas/site_instructions"},"remote_id":{"description":"The id of the address in your system.","type":"string"},"company":{"$ref":"#/components/schemas/CompanyForTransportAddress_1"}},"type":"object"},"site_instructions":{"description":"Site instructions, visible to all parties (trucker, carrier, shipper, site). Displayed in the trucker mobile app. Not visible in the eCMR. If the field is not provided, the address's site instructions will be used.","maxLength":1000,"type":"string"},"CompanyForTransportAddress_1":{"description":"Identification of the company. You may simply use its `pk` or `remote_id` if the company already exists. Other possible identification method are its `trade_number` or `name`. If it doesn't exist, the company will be created with the information you send based on what's possible when creating a company via /companies/ web service. Minimum required information in this case is a name.","properties":{"pk":{"description":"Dashdoc's internal id.Optional, not required if `remote_id` is sent.","type":"integer"},"remote_id":{"description":"The id of the company in your system. Optional, ignored if `pk` is sent.","type":"string"},"trade_number":{"maxLength":100,"type":"string"},"name":{"maxLength":200,"type":"string"}},"type":"object"},"SupportsExchange":{"properties":{"uid":{"description":"uid of the support exchange","format":"uuid","type":"string"},"site":{"$ref":"#/components/schemas/SupportsExchange_site"},"support_type":{"$ref":"#/components/schemas/SupportType"},"expected_retrieved":{"description":"Expected number of supports that should be retrieved on the site","type":"number"},"actual_retrieved":{"description":"Actual number of supports that were retrieved on the site","type":"number"},"expected_delivered":{"description":"Expected number of supports that should be delivered on the site","type":"number"},"actual_delivered":{"description":"Actual number of supports that were delivered on the site","type":"number"},"observations":{"description":"Free text. Observations about this supports exchange. Can be filled on mobile app, web app or via API.","type":"string"},"remote_id":{"description":"The ID of the support in your system","type":"string"}},"type":"object"},"SupportsExchange_site":{"description":"site where supports exchange is expected","properties":{"uid":{"description":"uid of the site","format":"uuid","type":"string"},"remote_id":{"description":"remote_id of the site","type":"string"}},"type":"object"},"SupportType":{"description":"Type of the supports that are exchanged","properties":{"name":{"description":"Display name of the support type","type":"string"},"created":{"$ref":"#/components/schemas/created"},"uid":{"format":"uuid","type":"string"},"remote_id":{"description":"The id of the support type in your system.","type":"string"}},"type":"object"},"Site_slots":{"properties":{"start":{"format":"date-time","type":"string"},"end":{"format":"date-time","type":"string"}},"type":"object"},"trucker_instructions":{"description":"**This field is part of a beta feature.** Private instructions. **The carrier of the transport is the only one who can edit and read those instructions.** Note that those instructions are not visible in the consignment note and can be accessed by the trucker. The value is null if the caller doesn't have the right of access to the data.","maxLength":1000,"type":"string"},"Site_trip":{"description":"Trip linked to this site/activity.","nullable":true,"properties":{"uid":{"format":"uuid","type":"string"},"name":{"type":"string"},"is_prepared":{"type":"boolean"},"status":{"enum":["unstarted","ongoing","done"],"type":"string"}},"readOnly":true,"type":"object"},"NewAddressReduced":{"properties":{"pk":{"description":"Dashdoc's internal id. Optional, set it to reference an existing address.","type":"integer"},"name":{"type":"string"},"address":{"type":"string"},"city":{"type":"string"},"postcode":{"type":"string"},"country":{"$ref":"#/components/schemas/country"},"latitude":{"$ref":"#/components/schemas/latitude"},"longitude":{"$ref":"#/components/schemas/longitude"},"radius":{"default":500,"description":"Radius around the GPS coordinates within which the address is located (in meters)","type":"integer"},"coords_validated":{"default":false,"description":"if `true`, when this address is used as a loading or unloading site, the mobile app displays an itinerary button to start GPS app with guidance to these coordinates","type":"boolean"},"is_demo":{"$ref":"#/components/schemas/is_demo"},"is_carrier":{"type":"boolean"},"is_shipper":{"type":"boolean"},"is_origin":{"type":"boolean"},"is_destination":{"type":"boolean"},"created_by":{"description":"Ignore. Dashdoc technical data.","readOnly":true,"type":"number"},"created":{"description":"Date of creation on our server","format":"date-time","readOnly":true,"type":"string"},"instructions":{"type":"string"},"remote_id":{"description":"The id of the address in your system.","type":"string"},"company":{"$ref":"#/components/schemas/CompanyForTransportAddress"},"original":{"description":"Ignore. Dashdoc technical data.","nullable":true,"readOnly":true,"type":"number"}},"required":["address","city","company","country","postcode"],"type":"object"},"DeliveryLoads":{"properties":{"uid":{"description":"Dashdoc's internal id.","type":"string"},"remote_id":{"description":"The ID of the load in your system. It has to be unique among all your transports.","type":"string"},"description":{"description":"Text description of the load","type":"string"},"reference":{"description":"Reference of the load","type":"string"},"round_id":{"description":"The ID of the round.","format":"integer","type":"number"},"weight":{"description":"In kilograms","format":"float","type":"number"},"volume":{"description":"Volume of load in m3","format":"float","type":"number"},"volume_display_unit":{"default":"m3","enum":["m3","L"],"type":"string"},"linear_meters":{"description":"Length of load in meters","format":"float","type":"number"},"quantity":{"description":"Only one decimal accepted (e.g 0.0)","format":"float","type":"number"},"pallet_equivalence":{"description":"Pallet equivalence (EPS/EQPAL): how many standard pallet spaces the load occupies. `null` when it was never set. Otherwise at least `0.01`, with two decimals kept.","format":"float","nullable":true,"type":"number"},"category":{"description":"Packaging of the load. The text is free but these specific values cause a custom flow on the mobile app: `pallets`, `containers`, `bulk`, `roundwood`, `powder_tank`, `bulk_qualimat`, `rental`.","type":"string"},"dangerous_goods_category":{"description":"ADR class","enum":["1","2","3","4.1","4.2","4.3","5.1","5.2","6.1","6.2","7","8","9"],"type":"string"},"is_dangerous":{"type":"boolean"},"adr_un_code":{"type":"string"},"legal_mentions":{"type":"string"},"complementary_information":{"description":"Any information about the load that doesn't fit to the description field","type":"string"},"container_number":{"type":"string"},"tare_weight":{"description":"In kilograms","format":"float","type":"number"},"container_seal_number":{"type":"string"},"refrigerated":{"description":"Indicates whether the load is refrigerated. If true, the trucker can fill in the temperature.","type":"boolean"},"temperature":{"type":"string"},"steres":{"format":"float","type":"number"},"idtf_number":{"description":"Must match an existing IDTF number","type":"string"},"use_identifiers":{"description":"if `true`, trucker is asked to scan barcode identifiers on load","type":"boolean"},"identifiers":{"description":"Only relevant if use_identifiers is set to `true`. List of expected barcode identifiers that the trucker should scan at loading and unloading. App controls that expected barcodes are actually scanned. If empty, the trucker will have to scan barcodes anyway, but there won't be any check. Feature has to be activated in your account by your Dashdoc projet manager.","items":{"type":"string"},"type":"array"},"identifiers_observations":{"description":"Observations explaining issues with identifier, such as missing or unexpected identifiers","type":"string"}},"type":"object"},"Delivery_tracking_contacts":{"properties":{"uid":{"description":"Dashdoc's internal id.","type":"string"},"contact":{"$ref":"#/components/schemas/NewContact"},"subscribed_to_status_updates":{"description":"If set to true, the contact will receive an email at every step of the delivery. Else, they will receive only one email once the delivery is done.","type":"boolean"},"role":{"description":"The role of the contact in the delivery. It can be `carrier`, `shipper`, or `site`.","type":"string"}},"required":["contact"],"type":"object"},"NewContact":{"properties":{"uid":{"format":"uuid","type":"string"},"created":{"description":"Date of creation on our server","format":"date-time","readOnly":true,"type":"string"},"company":{"$ref":"#/components/schemas/CompanyIdentification"},"first_name":{"maxLength":200,"type":"string"},"last_name":{"maxLength":200,"type":"string"},"email":{"format":"email","type":"string"},"phone_number":{"maxLength":100,"type":"string"},"fax_number":{"maxLength":100,"type":"string"},"remote_id":{"description":"The id of the contact in your system","type":"string"}},"required":["company","last_name"],"type":"object"},"CompanyIdentification":{"description":"Identification of the company. The company must already exist in Dashdoc.","properties":{"pk":{"description":"Dashdoc's internal id. Optional, not required if `remote_id` is sent.","type":"integer"},"remote_id":{"description":"Your remote carrier id. Optional, ignored if `pk` is sent.","type":"string"},"name":{"type":"string"},"trade_number":{"type":"string"},"country":{"$ref":"#/components/schemas/country"},"settings_contract_html":{"description":"Ignore. Dashdoc technical data.","type":"string"},"settings_logo":{"description":"Ignore. Dashdoc technical data.","nullable":true,"type":"string"},"settings_stamp":{"description":"Ignore. Dashdoc technical data.","nullable":true,"type":"string"},"settings_print_mode":{"description":"Ignore. Dashdoc technical data.","type":"boolean"},"settings_special_agreements":{"description":"Ignore. Dashdoc technical data.","type":"string"},"settings_transport_order_observations":{"type":"string"},"settings_constrain_reference_edition":{"type":"boolean"},"vat_number":{"type":"string"},"is_verified":{"description":"Ignore. Dashdoc technical data.","type":"string"}},"type":"object"},"Segment":{"description":"","properties":{"uid":{"minLength":1,"type":"string"},"remote_id":{"minLength":1,"type":"string"},"origin":{"$ref":"#/components/schemas/Site"},"destination":{"$ref":"#/components/schemas/Site"},"trucker":{"$ref":"#/components/schemas/SegmentTrucker"},"vehicle":{"$ref":"#/components/schemas/Vehicle"},"trailers":{"items":{"$ref":"#/components/schemas/Trailer"},"type":"array"},"sort_order":{"description":"The index of the segment in the transport","minimum":0,"type":"number"},"scheduled_start_range":{"$ref":"#/components/schemas/Segment_scheduled_start_range"},"scheduled_end_range":{"$ref":"#/components/schemas/Segment_scheduled_end_range"},"scheduled_start":{"deprecated":true,"description":"The datetime at which the carrier scheduled the start of this segment\n","type":"string"},"scheduled_end":{"deprecated":true,"description":"The datetime at which the carrier scheduled the end of this segment","type":"string"},"child_transport":{"$ref":"#/components/schemas/Segment_child_transport"},"telematic_distance":{"description":"Automatically computed distance from telematic data (in kms).","type":"integer"},"distance":{"description":"Manually entered distance. If null, it takes the value of telematic_distance (in kms).","type":"integer"},"origin_mileage":{"description":"Mileage at transport origin site (in kms).","type":"integer"},"destination_mileage":{"description":"Mileage at transport destination site (in kms).","type":"integer"}},"type":"object"},"Site":{"properties":{"uid":{"format":"uuid","type":"string"},"remote_id":{"description":"The id of the site in your system","type":"string"},"address":{"$ref":"#/components/schemas/Address"},"real_start":{"description":"date and time when trucker arrived on site","format":"date-time","type":"string"},"real_end":{"description":"date and time when trucker completed loading / unloading (depending whether site is origin or destination)","format":"date-time","type":"string"},"signature_process":{"type":"string"},"instructions":{"$ref":"#/components/schemas/site_instructions"},"reference":{"type":"string"},"action":{"deprecated":true,"description":"Deprecated. Always returned as an empty string.","type":"string"},"eta":{"nullable":true,"type":"string"},"eta_tracking":{"$ref":"#/components/schemas/eta_tracking"},"punctuality_status":{"$ref":"#/components/schemas/punctuality_status"},"supports_exchanges":{"$ref":"#/components/schemas/SupportsExchange"},"category":{"enum":["loading","unloading"],"type":"string"},"slots":{"items":{"$ref":"#/components/schemas/Site_slots"},"type":"array"},"trucker_instructions":{"$ref":"#/components/schemas/trucker_instructions"},"trip":{"$ref":"#/components/schemas/Site_trip"}},"type":"object"},"Address":{"properties":{"pk":{"description":"Dashdoc's internal id.","type":"number"},"name":{"type":"string"},"address":{"type":"string"},"city":{"type":"string"},"postcode":{"type":"string"},"country":{"$ref":"#/components/schemas/country"},"latitude":{"$ref":"#/components/schemas/latitude"},"longitude":{"$ref":"#/components/schemas/longitude"},"radius":{"default":500,"description":"Radius around the GPS coordinates within which the address is located (in meters)","type":"integer"},"coords_validated":{"default":false,"description":"if `true`, when this address is used as a loading or unloading site, the mobile app displays an itinerary button to start GPS app with guidance to these coordinates","type":"boolean"},"is_demo":{"$ref":"#/components/schemas/is_demo"},"is_carrier":{"type":"boolean"},"is_shipper":{"type":"boolean"},"is_origin":{"$ref":"#/components/schemas/address_is_origin_and_is_destination"},"is_destination":{"$ref":"#/components/schemas/address_is_origin_and_is_destination"},"created_by":{"$ref":"#/components/schemas/created-by"},"created_by_user":{"$ref":"#/components/schemas/created-by-user"},"created":{"$ref":"#/components/schemas/created"},"instructions":{"$ref":"#/components/schemas/site_instructions"},"remote_id":{"description":"The id of the address in your system.","type":"string"},"original":{"description":"Dashdoc's internal id of the original address.","nullable":true,"readOnly":true,"type":"number"},"company":{"$ref":"#/components/schemas/Company"}},"type":"object"},"eta_tracking":{"default":false,"description":"Ask for an ETA on this site. This is currently a beta feature, not activated by default.","type":"boolean"},"punctuality_status":{"default":"untracked","description":"Indicate the punctuality on this site.","enum":["untracked","probably_late","probably_on_time","late","on_time"],"type":"string"},"SegmentTrucker":{"properties":{"pk":{"description":"Dashdoc's internal id.","type":"number"},"remote_id":{"description":"The ID of the trucker in your system. It has to be unique among all your truckers.","type":"string"},"display_name":{"type":"string"},"user":{"$ref":"#/components/schemas/SegmentTruckerUser"}},"type":"object"},"SegmentTruckerUser":{"properties":{"pk":{"description":"Dashdoc's internal id.","type":"number"},"first_name":{"type":"string"},"last_name":{"type":"string"},"username":{"description":"Ignore. Dashdoc technical data.","type":"string"},"email":{"format":"email","type":"string"},"display_name":{"description":"Display name generated by Dashdoc.","type":"string"},"date_joined":{"description":"Ignore. Dashdoc technical data.","format":"date-time","type":"string"},"is_staff":{"description":"Ignore. Dashdoc technical data.","type":"boolean"},"is_superuser":{"description":"Ignore. Dashdoc technical data.","type":"boolean"},"has_usable_password":{"description":"Ignore. Dashdoc technical data.","type":"boolean"}},"type":"object"},"Vehicle":{"properties":{"pk":{"description":"Dashdoc's internal id","type":"number"},"carrier":{"description":"Dashdoc's internal id of the carrier owning the vehicle","type":"number"},"category":{"description":"Vehicle category","type":"string"},"license_plate":{"description":"License plate number","type":"string"},"fleet_number":{"description":"Your vehicle fleet number","type":"string"},"remote_id":{"description":"The ID of the vehicle in your system","type":"string"},"created":{"description":"Date of creation on our server","format":"date-time","type":"string"},"used_for_qualimat_transports":{"description":"True if the vehicle can be used for Qualimat transport (only used for visual help and warnings)","type":"boolean"},"telematic_vehicle":{"description":"Ignore. Dashdoc technical data","type":"number"},"original":{"type":"number"},"tags":{"description":"List of tags applied to the vehicle.","items":{"$ref":"#/components/schemas/Tag"},"type":"array"},"technical_control_deadline":{"format":"date-time","type":"string"},"tachograph_deadline":{"format":"date-time","type":"string"},"speed_limiter_deadline":{"format":"date-time","type":"string"},"country":{"$ref":"#/components/schemas/country"},"unavailability":{"description":"List of unavailable period","items":{"$ref":"#/components/schemas/Unavailability"},"type":"array"},"events":{"description":"Ignore. Dashdoc technical data.","items":{"type":"object"},"type":"array"}},"type":"object"},"Tag":{"properties":{"pk":{"description":"The unique identifier of the tag","type":"integer"},"name":{"description":"The name of the tag","type":"string"},"color":{"description":"The color of the tag in hex format","type":"string"},"tag_group_id":{"description":"The ID of the tag group this tag belongs to, if any","nullable":true,"type":"integer"}},"required":["color","name","pk"],"type":"object"},"Unavailability":{"properties":{"id":{"description":"Dashdoc's internal id","type":"number"},"remote_id":{"description":"The ID of the unavailability in your system","type":"string"},"created":{"description":"Date of creation on our server","format":"date-time","type":"string"},"start_date":{"description":"Start date of the unavailability","format":"date-time","type":"string"},"end_date":{"description":"End date of the unavailability","format":"date-time","type":"string"},"unavailability_type":{"description":"Type of unavailability","enum":["paid_vacation","day_off","sick_leave","training","vacation","maintenance","rental","other"],"type":"string"},"unavailability_note":{"description":"Notes about the unavailability","type":"string"}},"type":"object"},"Trailer":{"properties":{"pk":{"description":"Dashdoc's internal id","type":"number"},"original":{"description":"Ignore. Dashdoc technical data","type":"number"},"carrier":{"description":"Dashdoc's internal id of the carrier owning the trailer","type":"number"},"license_plate":{"description":"License plate number","type":"string"},"fleet_number":{"description":"Your trailer fleet number","type":"string"},"remote_id":{"description":"The ID of the trailer in your system","type":"string"},"created":{"description":"Date of creation on our server","format":"date-time","type":"string"},"used_for_qualimat_transports":{"description":"True if the trailer can be used for Qualimat transport (only used for visual help and warnings)","type":"boolean"},"tags":{"description":"List of tags applied to the trailer.","items":{"$ref":"#/components/schemas/Tag"},"type":"array"},"technical_control_deadline":{"format":"date-time","type":"string"},"country":{"$ref":"#/components/schemas/country"},"unavailability":{"description":"List of unavailable period","items":{"$ref":"#/components/schemas/Unavailability"},"type":"array"},"events":{"description":"Ignore. Dashdoc technical data.","items":{"type":"object"},"type":"array"}},"type":"object"},"Segment_scheduled_start_range":{"description":"The datetime range at which the carrier scheduled the start of this segment","properties":{"start":{"description":"Min scheduled start date (ISO 8601)","type":"string"},"end":{"description":"Max scheduled start date (ISO 8601)","type":"string"}},"type":"object"},"Segment_scheduled_end_range":{"description":"The datetime range at which the carrier scheduled the end of this segment","properties":{"start":{"description":"Min scheduled end date (ISO 8601)","type":"string"},"end":{"description":"Max scheduled end date (ISO 8601)","type":"string"}},"type":"object"},"Segment_child_transport":{"description":"If the segment is chartered, will contain the child transport","properties":{"uid":{"format":"uuid","type":"string"},"sequential_id":{"type":"number"},"remote_id":{"type":"string"},"has_strong_link":{"type":"boolean"}},"type":"object"},"Statuses":{"enum":["created","updated","confirmed","declined","verified","invoiced","paid","cancelled","assigned","sent_to_trucker","acknowledged","truck_wash","on_loading_site","loading_complete","on_unloading_site","unloading_complete","bulking_break_started","bulking_break_complete","rounds_started","round_added","round_added_v2","round_edited","round_deleted","rounds_complete","event","checklist_filled","activity_complete","on_the_way","handling_started","done"],"type":"string"},"Status":{"properties":{"uid":{"format":"uuid","type":"string"},"created":{"description":"Date of creation on the server. Useful when the transport is created by mobile devices. If network connection is bad, the `created` date can be later than `created_device`","format":"date-time","type":"string"},"created_device":{"description":"If created from a mobile device, date of creation on the device.","format":"date-time","type":"string"},"creation_method":{"type":"string"},"category":{"description":"event that occured on the transport","type":"string"},"author":{"description":"details about author of the update. Contact Dashdoc if more details is needed.","type":"object"},"content":{"description":"Contact Dashdoc if more details is needed.","type":"object"},"content_signatory":{"description":"Contact Dashdoc if more details is needed.","type":"object"},"target":{"description":"Contact Dashdoc if more details is needed.","type":"object"},"site":{"description":"Contact Dashdoc if more details is needed.","type":"object"},"site_id":{"description":"Contact Dashdoc if more details is needed.","format":"uuid","type":"string"},"delivery":{"description":"Contact Dashdoc if more details is needed.","format":"uuid","type":"string"},"segment":{"description":"Contact Dashdoc if more details is needed.","format":"uuid","type":"string"},"transport":{"description":"Contact Dashdoc if more details is needed.","format":"uuid","type":"string"},"signature":{"description":"Contact Dashdoc if more details is needed.","type":"object"},"latitude":{"description":"Contact Dashdoc if more details is needed.","format":"float","type":"number"},"longitude":{"description":"Contact Dashdoc if more details is needed.","format":"float","type":"number"},"update_details":{"description":"Contact Dashdoc if more details is needed.","type":"object"},"author_company":{"type":"number"}},"required":["uid"],"type":"object"},"TransportMessage":{"properties":{"uid":{"format":"uuid","type":"string"},"created":{"$ref":"#/components/schemas/created"},"created_device":{"format":"date-time","type":"string"},"creation_method":{"type":"string"},"author":{"$ref":"#/components/schemas/NewTransportMessage_author"},"type":{"enum":["note","load_verification","share","document","photo"],"maxLength":100,"type":"string"},"document_title":{"description":"Filename or if uploaded by a trucker from the mobile app, the document title is generic, for instance `photo`.","maxLength":100,"type":"string"},"document_type":{"enum":["load_photo","cmr","washing_note","delivery_note","confirmation","weight_note","waste_manifest","holders_swap_note","invoice"],"maxLength":100,"type":"string"},"document":{"description":"URL of the stored document. You can download the document from this URL.","type":"string"},"is_attached_to_cmr":{"type":"boolean"},"transport":{"format":"uuid","type":"string"},"site":{"description":"This field is used for the default values of the field readable_by_company_ids; if null, companies from all Sites of the transport are listed in readable_by_company_ids, otherwise only the company of this Site. Site must exist in this transport. This field is part of a beta feature.","format":"uuid","nullable":true,"type":"string"},"site_remote_id":{"type":"string"},"readable_by_company_ids":{"description":"A list containing the pk of each company allowed to access the document, every company must be part of the transport. If no values are sent, it will be computed with default values; Carrier, Shipper, Invoiced Customer and Site's pk (see Site field). Once values have been sent, the behavior adding default companies is deactivated. The author company is always added. Only pks of companies from the transport will be added, others will be ignored. This field is part of a beta feature.","items":{"type":"integer"},"type":"array"},"message":{"description":"message displayed in the activity thread of a transport in the web app and in the mobile app","type":"string"},"latitude":{"$ref":"#/components/schemas/latitude"},"longitude":{"$ref":"#/components/schemas/longitude"},"reference":{"description":"Free text. This reference is searchable in the transports dashboard. Filled by trucker if document is added from mobile app, by user if document is added from web app, or filled by API request.","maxLength":140,"type":"string"},"visible_by_everyone":{"$ref":"#/components/schemas/visible_by_everyone"},"readable_by_trucker":{"$ref":"#/components/schemas/readable_by_trucker"},"extracted_reference":{"description":"Reference extracted by AI from the document. AI runs only on weight notes, so it will be null for other documents. \"\" if no reference has been found by the AI.","type":"string"}},"type":"object"},"NewTransportMessage_author":{"properties":{"display_name":{"type":"string"},"company":{"type":"number"},"pk":{"description":"Dashdoc's internal id.","type":"number"}},"type":"object"},"visible_by_everyone":{"description":"This field is used to make the transport message public, which makes it visible by all parties of the transport.","type":"boolean"},"readable_by_trucker":{"description":"This field is used to allow truckers to see the transport message. **Only available for carriers.**","type":"boolean"},"requested_vehicle":{"description":"Only useful when the transport is created by the shipper. Free text except punction and special characters.","maxLength":40,"type":"string"},"Document":{"properties":{"pk":{"type":"integer"},"file_updated_date":{"description":"Date was updated on the server.","format":"date-time","type":"string"},"delivery":{"description":"Contact Dashdoc if more details are needed.","format":"uuid","type":"string"},"delivery_sequential_id":{"description":"eCMR number (for category \"cmr\" and \"ldv\")","type":"integer"},"reference":{"type":"integer"},"category":{"description":"Type of document. Possible values are \"cmr\", \"cmr4\", \"ldv\", \"orc\", \"chc\", \"rental\" and \"loading_plan\"","type":"string"},"languages":{"description":"Languages displayed in the document (CMR only), formatted as an 2-letter ISO 639-1 language code","items":{"type":"string"},"type":"array"},"name":{"description":"generic name of the document","type":"string"},"file":{"description":"path to the document","format":"url","type":"string"},"business_privacy_scope":{"description":"Ignore. Dashdoc technical data.","type":"boolean"},"cancelled":{"description":"Date of cancellation of the the document","format":"date-time","type":"string"}},"type":"object"},"deprecated_price":{"deprecated":true,"description":"Full price for the transport","format":"float","nullable":true,"type":"number"},"customer_to_invoice":{"properties":{"pk":{"description":"Dashdoc's internal id.","type":"number"},"name":{"type":"string"},"invoicing_address":{"$ref":"#/components/schemas/customer_to_invoice_invoicing_address"}},"type":"object"},"customer_to_invoice_invoicing_address":{"properties":{"address":{"type":"string"},"city":{"type":"string"},"postcode":{"type":"string"},"country":{"$ref":"#/components/schemas/country"}},"type":"object"},"Transport_parent_transport":{"description":"if this is a chartered transport, this will contains the parent transport it is chartered from","properties":{"uid":{"format":"uuid","type":"string"},"sequential_id":{"type":"number"},"remote_id":{"type":"string"},"has_strong_link":{"type":"boolean"}},"type":"object"},"deprecated_invoiced_price":{"deprecated":true,"description":"Invoiced price for the transport. Deprecated in favour of pricing field","format":"float","nullable":true,"type":"number"},"Transport_references":{"properties":{"role":{"type":"string"},"company":{"$ref":"#/components/schemas/Transport_company"},"reference":{"type":"string"}},"type":"object"},"Transport_company":{"properties":{"name":{"type":"string"}},"type":"object"},"global_instructions":{"description":"Operating instructions. The carrier, the shipper and the creator of the transport have access to those instructions. However, the creator is the only who has the right to edit.","maxLength":1000,"type":"string"},"RetrievedTransport_allOf":{"properties":{"agreed_price_total":{"description":"The total of the agreed price (including fuel surcharge, excluding taxes) if readable, otherwise null.","nullable":true,"type":"string"},"invoiced_price_total":{"description":"The total of the invoiced price (including fuel surcharge, excluding taxes) if readable, otherwise null.","nullable":true,"type":"string"},"shipper_final_price_total":{"description":"The total of the shipper final price (including fuel surcharge, excluding taxes) if readable, otherwise null.","nullable":true,"type":"string"},"effective_price_total":{"description":"The total of the effective price (including fuel surcharge, excluding taxes) if readable, otherwise null.","nullable":true,"type":"string"},"purchase_cost_total":{"description":"The total of the purchase costs if readable, otherwise null.","nullable":true,"type":"string"},"segments":{"items":{"$ref":"#/components/schemas/SegmentWithLegTags"},"type":"array"}},"type":"object"},"SegmentWithLegTags":{"allOf":[{"$ref":"#/components/schemas/Segment"},{"$ref":"#/components/schemas/SegmentWithLegTags_allOf"}],"type":"object"},"SegmentWithLegTags_allOf":{"properties":{"tags":{"description":"Tags of the leg this segment belongs to. Segments of the same leg share its tags.","items":{"$ref":"#/components/schemas/Tag"},"type":"array"}},"type":"object"}}}}
```

## The CreateOrUpdateTransport object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"CreateOrUpdateTransport":{"properties":{"remote_id":{"description":"Your transport id. It has to be unique among all your transports","type":"string"},"carrier_address":{"allOf":[{"$ref":"#/components/schemas/NewAddressReduced"},{"description":"Please note : specifying an address alone is not enough to have the carrier receive emails.\nFor that please add a tracking contact on the first delivery. See\n`deliveries > tracking_contacts`. The company of the contact must match the company\nof the `carrier_address` for the contact to be registered as the **carrier tracking contact**.\n","type":"object"}]},"deliveries":{"items":{"$ref":"#/components/schemas/CreateOrUpdateDelivery"},"type":"array"},"segments":{"items":{"$ref":"#/components/schemas/CreateOrUpdateSegment"},"type":"array"},"requested_vehicle":{"$ref":"#/components/schemas/requested_vehicle"},"carrier_reference":{"description":"Text that will help the carrier operators manage the transports, e.g. transport number in his TMS","type":"string"},"price":{"$ref":"#/components/schemas/deprecated_price"},"requires_washing":{"description":"Flag to enable the truck washing flow in the mobile app","type":"boolean"},"business_privacy":{"description":"Flag to enable 'business privacy' mode: no eCMR will be generated, and the trucker won't be prompted to share the transport link.","type":"boolean"},"is_multiple_compartments":{"description":"Flag to enable 'multiple compartments' mode: truckers will have to select in which compartments loads were loaded. It also generated a specific delivery document : loading_plan.","type":"boolean"},"customer_to_invoice":{"$ref":"#/components/schemas/NullableCompanyPkOrRemoteId"},"instructions":{"$ref":"#/components/schemas/global_instructions"},"tags":{"description":"List of tags applied to the transport.","items":{"$ref":"#/components/schemas/TagInput"},"type":"array"},"quotation":{"$ref":"#/components/schemas/CreateOrUpdateTransport_quotation"},"volume_display_unit":{"default":"m3","enum":["m3","L"],"type":"string"},"transport_operation_category_uid":{"description":"UID of the transport operation category","format":"uuid","nullable":true,"type":"string"},"send_to_trucker":{"default":true,"description":"Flag to send the missions to the assigned truckers. It has no effect on already sent missions.","type":"boolean"}},"required":["deliveries","segments"],"type":"object"},"NewAddressReduced":{"properties":{"pk":{"description":"Dashdoc's internal id. Optional, set it to reference an existing address.","type":"integer"},"name":{"type":"string"},"address":{"type":"string"},"city":{"type":"string"},"postcode":{"type":"string"},"country":{"$ref":"#/components/schemas/country"},"latitude":{"$ref":"#/components/schemas/latitude"},"longitude":{"$ref":"#/components/schemas/longitude"},"radius":{"default":500,"description":"Radius around the GPS coordinates within which the address is located (in meters)","type":"integer"},"coords_validated":{"default":false,"description":"if `true`, when this address is used as a loading or unloading site, the mobile app displays an itinerary button to start GPS app with guidance to these coordinates","type":"boolean"},"is_demo":{"$ref":"#/components/schemas/is_demo"},"is_carrier":{"type":"boolean"},"is_shipper":{"type":"boolean"},"is_origin":{"type":"boolean"},"is_destination":{"type":"boolean"},"created_by":{"description":"Ignore. Dashdoc technical data.","readOnly":true,"type":"number"},"created":{"description":"Date of creation on our server","format":"date-time","readOnly":true,"type":"string"},"instructions":{"type":"string"},"remote_id":{"description":"The id of the address in your system.","type":"string"},"company":{"$ref":"#/components/schemas/CompanyForTransportAddress"},"original":{"description":"Ignore. Dashdoc technical data.","nullable":true,"readOnly":true,"type":"number"}},"required":["address","city","company","country","postcode"],"type":"object"},"country":{"description":"Only the 2-character codification is accepted (ISO 3166-1 alpha-2)","type":"string"},"latitude":{"description":"Latitude using the decimal GPS coordinates (WGS84). At 7 decimals, the position is accurate around the centimeter.","format":"float","nullable":true,"type":"number"},"longitude":{"description":"Longitude using the decimal GPS coordinates (WGS84). At 7 decimals, the position is accurate around the centimeter.","format":"float","nullable":true,"type":"number"},"is_demo":{"description":"Indicates that the address is a fake one created from demonstration. Everything linked to it will be deleted when using the 'Delete demo content' button in company parameters","type":"boolean"},"CompanyForTransportAddress":{"properties":{"pk":{"description":"Dashdoc's internal id.","type":"number"},"remote_id":{"description":"The id of the company in your system.","type":"string"},"name":{"type":"string"},"trade_number":{"type":"string"},"country":{"$ref":"#/components/schemas/country"},"settings_contract_html":{"description":"Ignore. Dashdoc technical data.","type":"string"},"settings_logo":{"description":"Ignore. Dashdoc technical data.","nullable":true,"type":"string"},"settings_stamp":{"description":"Ignore. Dashdoc technical data.","nullable":true,"type":"string"},"settings_print_mode":{"description":"Ignore. Dashdoc technical data.","type":"boolean"},"settings_special_agreements":{"description":"Ignore. Dashdoc technical data.","type":"string"},"settings_transport_order_observations":{"type":"string"},"settings_constrain_reference_edition":{"type":"boolean"},"vat_number":{"type":"string"},"is_verified":{"type":"boolean"}},"type":"object"},"CreateOrUpdateDelivery":{"properties":{"planned_loads":{"description":"Loads as planned before the transport has been started","items":{"$ref":"#/components/schemas/NewDeliveryLoads"},"type":"array"},"origin":{"$ref":"#/components/schemas/CreateOrUpdateSite"},"destination":{"$ref":"#/components/schemas/CreateOrUpdateSite"},"shipper_address":{"$ref":"#/components/schemas/NewAddressReduced"},"tracking_contacts":{"description":"List of contacts that will automatically receive an email when delivery is done.\nThe role of each contact will be determined by matching its company to a company\non the transport (carrier, shipper, pick-up, delivery).\n⚠️ If no tracking contacts are provided for a company and the setting `partner_email_fallback` is enabled,\na tracking contact corresponding to the company's email will be added, at the creation of the transport.\nThis only applies to the carrier and the shipper.\n","items":{"$ref":"#/components/schemas/CreateOrUpdateDelivery_tracking_contacts"},"type":"array"},"shipper_reference":{"description":"Reference the client may use to match transport on his own system, e.g. an order number.","type":"string"},"multiple_rounds":{"description":"If true, the trucker will be able to do a signature at loading, then add any amount of rounds for the transport (with weight/volume and weight ticket), and finish with a signature at unloading.","type":"boolean"}},"required":["destination","origin","shipper_address"],"type":"object"},"NewDeliveryLoads":{"properties":{"remote_id":{"description":"The ID of the load in your system. It has to be unique among all your transports.","type":"string"},"description":{"description":"Text description of the load. In the case of a dangerous load, the description has to respect the ADR law.","type":"string"},"reference":{"description":"Reference of the load.","type":"string"},"weight":{"description":"In kilograms","format":"float","type":"number"},"volume":{"description":"Volume of load in m3","format":"float","type":"number"},"linear_meters":{"description":"Length of load in meters","format":"float","type":"number"},"quantity":{"description":"Only one decimal accepted (e.g 0.0)","format":"float","type":"number"},"pallet_equivalence":{"description":"Pallet equivalence (EPS/EQPAL): how many standard pallet spaces the load occupies. Minimum `0.01`, and only two decimals are kept — omit it or send `null` rather than 0 when unknown. When a load is created from the Dashdoc interface this defaults to `quantity` × the handling unit's pallet equivalence, and stays freely overridable.","format":"float","nullable":true,"type":"number"},"category":{"description":"Packaging of the load. The text is free but these specific values cause a custom flow on the mobile app: `pallets`, `containers`, `bulk`, `roundwood`, `powder_tank`, `bulk_qualimat`, `rental`.","type":"string"},"handling_unit_uid":{"description":"Existing handling unit UID from the load type catalog.","format":"uuid","type":"string"},"good_uid":{"description":"Existing good UID from the goods catalog.","format":"uuid","type":"string"},"create_handling_unit":{"$ref":"#/components/schemas/NewDeliveryLoads_create_handling_unit"},"create_good":{"$ref":"#/components/schemas/NewDeliveryLoads_create_good"},"dangerous_goods_category":{"deprecated":true,"description":"ADR class","enum":["1","2","3","4.1","4.2","4.3","5.1","5.2","6.1","6.2","7","8","9"],"type":"string"},"is_dangerous":{"default":false,"description":"Indicates whether the load is dangerous. If true, the trucker has to confirm adr un code and legal mentions at unloading.","type":"boolean"},"adr_un_code":{"description":"Only for dangerous load, the official UN code from the ADR law.","type":"string"},"legal_mentions":{"description":"Only for dangerous load, all mandatory legal mentions printed on documents.","type":"string"},"complementary_information":{"description":"Any information about the load that doesn't fit to the description field.","type":"string"},"container_number":{"type":"string"},"tare_weight":{"description":"In kilograms","format":"float","type":"number"},"container_seal_number":{"type":"string"},"refrigerated":{"description":"Indicates whether the load is refrigerated. If true, the trucker can fill in the temperature.","type":"boolean"},"temperature":{"type":"string"},"steres":{"format":"float","type":"number"},"idtf_number":{"description":"Must match an existing IDTF number","type":"string"},"use_identifiers":{"description":"if `true`, trucker is asked to scan barcode identifiers on load","type":"boolean"},"identifiers":{"description":"Only relevant if use_identifiers is set to `true`. List of expected barcode identifiers that the trucker should scan at loading and unloading. App controls that expected barcodes are actually scanned. If empty, the trucker will have to scan barcodes anyway, but there won't be any check. Feature has to be activated in your account by your Dashdoc projet manager.","items":{"type":"string"},"type":"array"},"identifiers_observations":{"description":"Observations explaining issues with identifier, such as missing or unexpected identifiers","type":"string"}},"type":"object"},"NewDeliveryLoads_create_handling_unit":{"description":"Create a handling unit in the catalog and use its UID for this load. If provided, it silently overrides `handling_unit_uid`.","nullable":true,"properties":{"name":{"type":"string"},"dashdoc_load_category":{"type":"string"},"remote_id":{"type":"string"}},"type":"object"},"NewDeliveryLoads_create_good":{"description":"Create a good in the catalog and use its UID for this load. If provided, it silently overrides `good_uid`.","nullable":true,"properties":{"name":{"type":"string"},"additional_information":{"type":"string"},"remote_id":{"type":"string"}},"type":"object"},"CreateOrUpdateSite":{"properties":{"uid":{"format":"uuid","type":"string"},"remote_id":{"description":"The id of the site in your system","type":"string"},"address":{"allOf":[{"$ref":"#/components/schemas/SiteAddress"}],"nullable":true},"real_start":{"description":"date and time when trucker arrived on site","format":"date-time","readOnly":true,"type":"string"},"real_end":{"description":"date and time when trucker completed loading / unloading (depending whether site is origin or destination)","format":"date-time","readOnly":true,"type":"string"},"signature_process":{"type":"string"},"is_booking_needed":{"type":"boolean"},"instructions":{"$ref":"#/components/schemas/site_instructions"},"reference":{"type":"string"},"action":{"deprecated":true,"description":"Deprecated. Accepted for backward compatibility but ignored. Responses always return an empty string.","type":"string"},"eta":{"format":"date-time","nullable":true,"type":"string"},"eta_tracking":{"type":"boolean"},"punctuality_status":{"readOnly":true,"type":"string"},"supports_exchanges":{"$ref":"#/components/schemas/SupportsExchange"},"category":{"type":"string"},"slots":{"items":{"$ref":"#/components/schemas/Site_slots"},"type":"array"},"trucker_instructions":{"$ref":"#/components/schemas/trucker_instructions"},"trip":{"$ref":"#/components/schemas/Site_trip"}},"type":"object"},"SiteAddress":{"description":"Address of the site. Reference an existing address with its `pk` or `remote_id`, or send its details to have it matched or created.","properties":{"pk":{"description":"Dashdoc's internal id. Optional, set it to reference an existing address.","type":"integer"},"name":{"type":"string"},"address":{"type":"string"},"city":{"type":"string"},"postcode":{"type":"string"},"country":{"$ref":"#/components/schemas/country"},"latitude":{"$ref":"#/components/schemas/latitude"},"longitude":{"$ref":"#/components/schemas/longitude"},"radius":{"default":500,"description":"Radius around the GPS coordinates within which the address is located (in meters)","type":"integer"},"coords_validated":{"default":false,"description":"if `true`, when this address is used as a loading or unloading site, the mobile app displays an itinerary button to start GPS app with guidance to these coordinates","type":"boolean"},"is_demo":{"$ref":"#/components/schemas/is_demo"},"is_carrier":{"type":"boolean"},"is_shipper":{"type":"boolean"},"is_origin":{"$ref":"#/components/schemas/address_is_origin_and_is_destination"},"is_destination":{"$ref":"#/components/schemas/address_is_origin_and_is_destination"},"instructions":{"$ref":"#/components/schemas/site_instructions"},"remote_id":{"description":"The id of the address in your system.","type":"string"},"company":{"$ref":"#/components/schemas/CompanyForTransportAddress_1"}},"type":"object"},"address_is_origin_and_is_destination":{"description":"Whether this address is a \"Logistic Points\" and will be usable as pickup/delivery point.\nThe distinction between origin/pickup and destination/delivery was merged as a single \"Logistic Point\" concept. `is_origin` implies `is_destination` and vice-versa.\n","type":"boolean"},"site_instructions":{"description":"Site instructions, visible to all parties (trucker, carrier, shipper, site). Displayed in the trucker mobile app. Not visible in the eCMR. If the field is not provided, the address's site instructions will be used.","maxLength":1000,"type":"string"},"CompanyForTransportAddress_1":{"description":"Identification of the company. You may simply use its `pk` or `remote_id` if the company already exists. Other possible identification method are its `trade_number` or `name`. If it doesn't exist, the company will be created with the information you send based on what's possible when creating a company via /companies/ web service. Minimum required information in this case is a name.","properties":{"pk":{"description":"Dashdoc's internal id.Optional, not required if `remote_id` is sent.","type":"integer"},"remote_id":{"description":"The id of the company in your system. Optional, ignored if `pk` is sent.","type":"string"},"trade_number":{"maxLength":100,"type":"string"},"name":{"maxLength":200,"type":"string"}},"type":"object"},"SupportsExchange":{"properties":{"uid":{"description":"uid of the support exchange","format":"uuid","type":"string"},"site":{"$ref":"#/components/schemas/SupportsExchange_site"},"support_type":{"$ref":"#/components/schemas/SupportType"},"expected_retrieved":{"description":"Expected number of supports that should be retrieved on the site","type":"number"},"actual_retrieved":{"description":"Actual number of supports that were retrieved on the site","type":"number"},"expected_delivered":{"description":"Expected number of supports that should be delivered on the site","type":"number"},"actual_delivered":{"description":"Actual number of supports that were delivered on the site","type":"number"},"observations":{"description":"Free text. Observations about this supports exchange. Can be filled on mobile app, web app or via API.","type":"string"},"remote_id":{"description":"The ID of the support in your system","type":"string"}},"type":"object"},"SupportsExchange_site":{"description":"site where supports exchange is expected","properties":{"uid":{"description":"uid of the site","format":"uuid","type":"string"},"remote_id":{"description":"remote_id of the site","type":"string"}},"type":"object"},"SupportType":{"description":"Type of the supports that are exchanged","properties":{"name":{"description":"Display name of the support type","type":"string"},"created":{"$ref":"#/components/schemas/created"},"uid":{"format":"uuid","type":"string"},"remote_id":{"description":"The id of the support type in your system.","type":"string"}},"type":"object"},"created":{"description":"Date of creation on our server","format":"date-time","type":"string"},"Site_slots":{"properties":{"start":{"format":"date-time","type":"string"},"end":{"format":"date-time","type":"string"}},"type":"object"},"trucker_instructions":{"description":"**This field is part of a beta feature.** Private instructions. **The carrier of the transport is the only one who can edit and read those instructions.** Note that those instructions are not visible in the consignment note and can be accessed by the trucker. The value is null if the caller doesn't have the right of access to the data.","maxLength":1000,"type":"string"},"Site_trip":{"description":"Trip linked to this site/activity.","nullable":true,"properties":{"uid":{"format":"uuid","type":"string"},"name":{"type":"string"},"is_prepared":{"type":"boolean"},"status":{"enum":["unstarted","ongoing","done"],"type":"string"}},"readOnly":true,"type":"object"},"CreateOrUpdateDelivery_tracking_contacts":{"properties":{"contact":{"$ref":"#/components/schemas/NewContact"},"subscribed_to_status_updates":{"description":"If set to true, the contact will receive an email at every step of the delivery. Else, they will receive only one email once the delivery is done.","type":"boolean"}},"required":["contact"],"type":"object"},"NewContact":{"properties":{"uid":{"format":"uuid","type":"string"},"created":{"description":"Date of creation on our server","format":"date-time","readOnly":true,"type":"string"},"company":{"$ref":"#/components/schemas/CompanyIdentification"},"first_name":{"maxLength":200,"type":"string"},"last_name":{"maxLength":200,"type":"string"},"email":{"format":"email","type":"string"},"phone_number":{"maxLength":100,"type":"string"},"fax_number":{"maxLength":100,"type":"string"},"remote_id":{"description":"The id of the contact in your system","type":"string"}},"required":["company","last_name"],"type":"object"},"CompanyIdentification":{"description":"Identification of the company. The company must already exist in Dashdoc.","properties":{"pk":{"description":"Dashdoc's internal id. Optional, not required if `remote_id` is sent.","type":"integer"},"remote_id":{"description":"Your remote carrier id. Optional, ignored if `pk` is sent.","type":"string"},"name":{"type":"string"},"trade_number":{"type":"string"},"country":{"$ref":"#/components/schemas/country"},"settings_contract_html":{"description":"Ignore. Dashdoc technical data.","type":"string"},"settings_logo":{"description":"Ignore. Dashdoc technical data.","nullable":true,"type":"string"},"settings_stamp":{"description":"Ignore. Dashdoc technical data.","nullable":true,"type":"string"},"settings_print_mode":{"description":"Ignore. Dashdoc technical data.","type":"boolean"},"settings_special_agreements":{"description":"Ignore. Dashdoc technical data.","type":"string"},"settings_transport_order_observations":{"type":"string"},"settings_constrain_reference_edition":{"type":"boolean"},"vat_number":{"type":"string"},"is_verified":{"description":"Ignore. Dashdoc technical data.","type":"string"}},"type":"object"},"CreateOrUpdateSegment":{"properties":{"remote_id":{"description":"The id of the segment in your system. Optional.","type":"string"},"origin":{"$ref":"#/components/schemas/CreateOrUpdateSite"},"destination":{"$ref":"#/components/schemas/CreateOrUpdateSite"},"trucker_id":{"$ref":"#/components/schemas/UpdateSegment_trucker_id"},"vehicle":{"$ref":"#/components/schemas/NewVehicle"},"trailers":{"items":{"$ref":"#/components/schemas/NewTrailer"},"type":"array"}},"required":["destination","origin"],"type":"object"},"UpdateSegment_trucker_id":{"properties":{"pk":{"description":"Dashdoc's internal id. Optional, not required if `remote_id` is sent.","type":"number"},"remote_id":{"description":"The ID of the trucker in your system. Optional, ignored if pk is sent.","type":"string"}},"type":"object"},"NewVehicle":{"properties":{"remote_id":{"description":"The ID of the vehicle in your system.","type":"string"},"fleet_number":{"description":"Your vehicle fleet number. It has to be unique among all your vehicles. When filled, fleet number will be displayed in the web and mobile app next to license plate number. It can also be used for searches.","maxLength":10,"type":"string"},"license_plate":{"description":"License plate number (has to be unique)","maxLength":200,"type":"string"},"category":{"$ref":"#/components/schemas/vehicle_category"},"used_for_qualimat_transports":{"description":"True if the vehicle can be used for Qualimat transport (only used for vehicle that can handle a load without trailer). This value is used to add a Qualimat logo next to the vehicle in forms, in order to help the user selecting the vehicle when creating a transport. The is no control on the value. You can create a Qualimat transport with a vehicle that is not flagged for Qualimat. In this case a warning is displayed in the transport detail.","type":"boolean"},"tags":{"description":"List of tags applied to the vehicle.","items":{"$ref":"#/components/schemas/Tag"},"type":"array"},"telematic_data_source":{"description":"The telematic where the vehicle is refered","enum":["alertgasoil","astrata","addsecure","dashdoc","eliott","fleetboard","geodynamics","geotracer","geotab","koovea","mappingcontrol","mapandtruck","masternaut","qeos","quartix","rio","scania","sudtelematique","transics","trimble","truckonline","vehizen","volvo","webfleet","strada","verizon","mapon","bump","samsara","samsara_mapandtruck","webeye","pass_tracabilite","bizztrack","aktkc_etransportas_mapandtruck","anima_mapandtruck","arvento_mapandtruck","as24_mapandtruck","axxess_mapandtruck","bornemann_infleet_mapandtruck","bpw_mapandtruck","cartrack_mapandtruck","commander_services_mapandtruck","dkv_mapandtruck","easytrack_mapandtruck","ecofleet_mapandtruck","edrive_mapandtruck","effitrailer_mapandtruck","ekolis_mapandtruck","fleetgo_mapandtruck","fleethand_mapandtruck","fleetmaster_mapandtruck","framelogic_mapandtruck","frotcom_mapandtruck","geotab_mapandtruck","gestracking_mapandtruck","globaltrack_mapandtruck","goodyear_france_mapandtruck","gps_mobile_mapandtruck","icell_mapandtruck","ims_telematics_mapandtruck","inelo_mapandtruck","infis_mapandtruck","jaltest_mapandtruck","k2gps_mapandtruck","keeptrace_mapandtruck","konsalnet_mapandtruck","krone_telematic_mapandtruck","legal_telematics_mapandtruck","linqo_mapandtruck","localizare_mapandtruck","locationsolutions_mapandtruck","loctracker_mapandtruck","mecomo_mapandtruck","microlise_mapandtruck","mix_telematics_mapandtruck","movertis_mapandtruck","movildata_mapandtruck","mtrack_mapandtruck","n2mobil_mapandtruck","naocom_mapandtruck","navifleet_mapandtruck","nexus_mapandtruck","ocean_mapandtruck","optifleet_mapandtruck","optimo_gps_mapandtruck","orbcomm_mapandtruck","orbcomm_africa_mapandtruck","pulsit_electronics_mapandtruck","quake_tracking_mapandtruck","riverlong_mapandtruck","sas_fleet_mapandtruck","satko_mapandtruck","schmitz_cargobull_mapandtruck","seyir_mobil_mapandtruck","skywatch_mapandtruck","solustop_mapandtruck","spedion_mapandtruck","speedtelematics_mapandtruck","starcom_mapandtruck","telepass_mapandtruck","terramar_networks_mapandtruck","tracker_mapandtruck","trackit_mapandtruck","tracknamic_mapandtruck","trendfire_mapandtruck","v3_smart_technologies_mapandtruck","vektor_teknoloji_mapandtruck","viafleet_mapandtruck","viasat_mapandtruck","visirun_mapandtruck","waynet_mapandtruck","wayzz_mapandtruck","webdispecink_mapandtruck"],"type":"string"},"vendor_id":{"description":"ID of the vehicle in the telematics system","type":"string"}},"type":"object"},"vehicle_category":{"description":"Vehicle category","enum":["unknown","light","straight","straight_tipper","tipper","tipper_cereal","tipper_construction","refrigerated","isotherm","platform","curtainsider","box_body","trailer_truck","flatbed","low_flatbed","log","coil","container","vehicle","heavy_equipment","solid_tanker","petrol_tanker","chemical_tanker","food_tanker","livestock","special_convoy"],"maxLength":200,"type":"string"},"Tag":{"properties":{"pk":{"description":"The unique identifier of the tag","type":"integer"},"name":{"description":"The name of the tag","type":"string"},"color":{"description":"The color of the tag in hex format","type":"string"},"tag_group_id":{"description":"The ID of the tag group this tag belongs to, if any","nullable":true,"type":"integer"}},"required":["color","name","pk"],"type":"object"},"NewTrailer":{"properties":{"remote_id":{"description":"The ID of the trailer in your system.","type":"string"},"fleet_number":{"description":"Your trailer fleet number. It has to be unique among all your trailers. When filled, fleet number will be displayed in the web and mobile app next to license plate number. It can also be used for searches.","maxLength":10,"type":"string"},"license_plate":{"description":"License plate number (has to be unique)","maxLength":200,"type":"string"},"used_for_qualimat_transports":{"description":"True if the trailer can be used for Qualimat transport. This value is used to add a Qualimat logo next to the trailer in forms, in order to help the user selecting the trailer when creating a transport. The is no control on the value. You can create a Qualimat transport with a trailer that is not flagged for Qualimat. In this case a warning is displayed in the transport detail.","type":"boolean"},"tags":{"description":"List of tags applied to the trailer.","items":{"$ref":"#/components/schemas/Tag"},"type":"array"}},"type":"object"},"requested_vehicle":{"description":"Only useful when the transport is created by the shipper. Free text except punction and special characters.","maxLength":40,"type":"string"},"deprecated_price":{"deprecated":true,"description":"Full price for the transport","format":"float","nullable":true,"type":"number"},"NullableCompanyPkOrRemoteId":{"description":"Identification of the company. The company must already exist in Dashdoc.","nullable":true,"properties":{"pk":{"description":"Dashdoc's internal id. Optional, should not be sent if `remote_id` is sent.","type":"number"},"remote_id":{"description":"The ID of the company in your system. Optional, should not be sent if `pk` is sent.","type":"string"}},"type":"object"},"global_instructions":{"description":"Operating instructions. The carrier, the shipper and the creator of the transport have access to those instructions. However, the creator is the only who has the right to edit.","maxLength":1000,"type":"string"},"TagInput":{"properties":{"name":{"description":"The name of the tag. A tag is matched by its name, and created if it does not exist yet.","maxLength":40,"minLength":1,"type":"string"},"color":{"description":"The color of the tag in hex format. Only used when creating a new tag.","type":"string"}},"required":["name"],"type":"object"},"CreateOrUpdateTransport_quotation":{"description":"Pricing information for the transport","properties":{"lines":{"items":{"$ref":"#/components/schemas/NewPriceLine"},"type":"array"}},"type":"object"},"NewPriceLine":{"properties":{"description":{"description":"Description of the line","type":"string"},"quantity":{"type":"number"},"unit_price":{"type":"number"},"is_gas_indexed":{"description":"Whether the price is indexed on gas price using fuel surcharge","type":"boolean"},"metric":{"description":"Metric of the price line","enum":["FLAT","DISTANCE_IN_KM","DURATION_IN_MINUTE","DURATION_IN_HOUR","LOADED_WEIGHT_IN_KG","LOADED_WEIGHT_IN_TONNE","LOADED_VOLUME_IN_LITRE","LOADED_VOLUME_IN_M3","LOADED_QUANTITY","LOADED_LINEAR_METERS","UNLOADED_WEIGHT_IN_KG","UNLOADED_WEIGHT_IN_TONNE","UNLOADED_VOLUME_IN_LITRE","UNLOADED_VOLUME_IN_M3","UNLOADED_QUANTITY","UNLOADED_LINEAR_METERS","NB_DELIVERIES","NB_ROUNDS"],"type":"string"}},"type":"object"}}}}
```

## The RetrievedTransport object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"RetrievedTransport":{"allOf":[{"$ref":"#/components/schemas/Transport"},{"$ref":"#/components/schemas/RetrievedTransport_allOf"}],"type":"object"},"Transport":{"properties":{"uid":{"description":"Dashdoc's internal id. It will be automatically generated by us.","format":"uuid","type":"string"},"sequential_id":{"type":"number"},"created":{"description":"Date of creation sent by the creator. Useful when the transport is created by mobile devices. If network connection is bad, the `created` date can be later than `created_device`","format":"date-time","type":"string"},"updated":{"format":"date-time","type":"string"},"deleted":{"nullable":true,"type":"string"},"remote_id":{"description":"Your transport id. It has to be unique among all your transports","type":"string"},"carrier_address":{"$ref":"#/components/schemas/AddressForTransport"},"created_by":{"$ref":"#/components/schemas/Company"},"created_device":{"format":"date-time","type":"string"},"creation_method":{"enum":["mobile_app","api","web_app"],"type":"string"},"archived_by":{"items":{"type":"object"},"type":"array"},"is_order":{"type":"boolean"},"carrier_assignation_status":{"allOf":[{"$ref":"#/components/schemas/CarrierAssignationStatus"}],"nullable":true},"invite_code":{"type":"string"},"deliveries":{"items":{"$ref":"#/components/schemas/Delivery"},"type":"array"},"segments":{"items":{"$ref":"#/components/schemas/Segment"},"type":"array"},"status":{"$ref":"#/components/schemas/Statuses"},"status_updates":{"items":{"$ref":"#/components/schemas/Status"},"type":"array"},"has_observations":{"type":"boolean"},"messages":{"items":{"$ref":"#/components/schemas/TransportMessage"},"type":"array"},"requested_vehicle":{"$ref":"#/components/schemas/requested_vehicle"},"documents":{"items":{"$ref":"#/components/schemas/Document"},"type":"array"},"carrier_reference":{"description":"Text that will help the carrier operators manage the transports, e.g. transport number in his TMS. It should only be set by the carrier of the transport and the transport's creator can toggle a company-wide setting to only allow the carrier to set it.","type":"string"},"price":{"$ref":"#/components/schemas/deprecated_price"},"requires_washing":{"description":"Flag to enable the truck washing flow in the mobile app","type":"boolean"},"business_privacy":{"description":"Flag to enable 'business privacy' mode: no eCMR will be generated, and the trucker won't be prompted to share the transport link.","type":"boolean"},"is_multiple_compartments":{"description":"Flag to enable 'multiple compartments' mode: truckers will have to select in which compartments loads were loaded. It also generates a specific delivery document : loading_plan.","type":"boolean"},"loading_plan":{"description":"Uid of the loading plan created by the trucker. Contact us if you need to retrieve data from it","type":"string"},"customer_to_invoice":{"$ref":"#/components/schemas/customer_to_invoice"},"parent_transport":{"$ref":"#/components/schemas/Transport_parent_transport"},"invoice_number":{"nullable":true,"type":"string"},"invoiced_price":{"$ref":"#/components/schemas/deprecated_invoiced_price"},"volume_display_unit":{"enum":["m3","L"],"type":"string"},"references":{"items":{"$ref":"#/components/schemas/Transport_references"},"type":"array"},"rental_deliveries":{"description":"Array of transports executed by the trucker during the rental order. Implies that the current transport is a rental order. Inner objects have the same transport data structure.","items":{"$ref":"#/components/schemas/Transport"},"type":"array"},"billing-metrics":{"deprecated":true,"description":"Retired feature, will always be null.","nullable":true,"type":"string"},"shape":{"type":"string"},"instructions":{"$ref":"#/components/schemas/global_instructions"},"carbon_footprint":{"description":"Carbon footprint of the transport in kgCO2","nullable":true,"readOnly":true,"type":"number"},"tags":{"description":"List of tags applied to the transport.","items":{"$ref":"#/components/schemas/Tag"},"type":"array"}},"required":["business_privacy","carrier_address","carrier_reference","created","created_by","created_device","creation_method","deliveries","documents","has_observations","invite_code","invoice_number","is_order","messages","price","references","remote_id","requested_vehicle","requires_washing","segments","sequential_id","status","status_updates","uid","updated"],"type":"object"},"AddressForTransport":{"properties":{"pk":{"description":"Dashdoc's internal id.","type":"number"},"name":{"type":"string"},"address":{"type":"string"},"city":{"type":"string"},"postcode":{"type":"string"},"country":{"$ref":"#/components/schemas/country"},"latitude":{"$ref":"#/components/schemas/latitude"},"longitude":{"$ref":"#/components/schemas/longitude"},"radius":{"default":500,"description":"Radius around the GPS coordinates within which the address is located (in meters)","type":"integer"},"coords_validated":{"default":false,"description":"if `true`, when this address is used as a loading or unloading site, the mobile app displays an itinerary button to start GPS app with guidance to these coordinates","type":"boolean"},"is_demo":{"$ref":"#/components/schemas/is_demo"},"is_carrier":{"type":"boolean"},"is_shipper":{"type":"boolean"},"is_origin":{"$ref":"#/components/schemas/address_is_origin_and_is_destination"},"is_destination":{"$ref":"#/components/schemas/address_is_origin_and_is_destination"},"created_by":{"type":"number"},"created":{"$ref":"#/components/schemas/created"},"remote_id":{"description":"The id of the address in your system.","type":"string"},"company":{"$ref":"#/components/schemas/CompanyForTransportAddress"},"original":{"type":"number"}},"type":"object"},"country":{"description":"Only the 2-character codification is accepted (ISO 3166-1 alpha-2)","type":"string"},"latitude":{"description":"Latitude using the decimal GPS coordinates (WGS84). At 7 decimals, the position is accurate around the centimeter.","format":"float","nullable":true,"type":"number"},"longitude":{"description":"Longitude using the decimal GPS coordinates (WGS84). At 7 decimals, the position is accurate around the centimeter.","format":"float","nullable":true,"type":"number"},"is_demo":{"description":"Indicates that the address is a fake one created from demonstration. Everything linked to it will be deleted when using the 'Delete demo content' button in company parameters","type":"boolean"},"address_is_origin_and_is_destination":{"description":"Whether this address is a \"Logistic Points\" and will be usable as pickup/delivery point.\nThe distinction between origin/pickup and destination/delivery was merged as a single \"Logistic Point\" concept. `is_origin` implies `is_destination` and vice-versa.\n","type":"boolean"},"created":{"description":"Date of creation on our server","format":"date-time","type":"string"},"CompanyForTransportAddress":{"properties":{"pk":{"description":"Dashdoc's internal id.","type":"number"},"remote_id":{"description":"The id of the company in your system.","type":"string"},"name":{"type":"string"},"trade_number":{"type":"string"},"country":{"$ref":"#/components/schemas/country"},"settings_contract_html":{"description":"Ignore. Dashdoc technical data.","type":"string"},"settings_logo":{"description":"Ignore. Dashdoc technical data.","nullable":true,"type":"string"},"settings_stamp":{"description":"Ignore. Dashdoc technical data.","nullable":true,"type":"string"},"settings_print_mode":{"description":"Ignore. Dashdoc technical data.","type":"boolean"},"settings_special_agreements":{"description":"Ignore. Dashdoc technical data.","type":"string"},"settings_transport_order_observations":{"type":"string"},"settings_constrain_reference_edition":{"type":"boolean"},"vat_number":{"type":"string"},"is_verified":{"type":"boolean"}},"type":"object"},"Company":{"properties":{"pk":{"description":"Dashdoc's internal id.","type":"number"},"remote_id":{"type":"string"},"created":{"format":"date-time","type":"object"},"updated":{"format":"date-time","type":"string"},"deleted":{"type":"boolean"},"invoicing_remote_id":{"description":"The id of the company in your invoicing system.","type":"string"},"name":{"type":"string"},"phone_number":{"type":"string"},"email":{"type":"string"},"siren":{"type":"string"},"trade_number":{"type":"string"},"country":{"$ref":"#/components/schemas/country"},"comments":{"type":"string"},"vat_number":{"type":"string"},"is_verified":{"type":"boolean"},"settings_transport_order_observations":{"type":"string"},"settings_constrain_reference_edition":{"type":"boolean"},"account_type":{"description":"Ignore. Dashdoc technical data.","type":"string"},"logo":{"description":"The URL of your logo","nullable":true,"type":"string"},"subscription_access":{"type":"object"},"settings":{"type":"object"},"primary_address":{"$ref":"#/components/schemas/PrimaryAddress_1"},"managers":{"items":{"$ref":"#/components/schemas/Managers"},"type":"array"},"has_loggable_managers":{"description":"Ignore. Dashdoc technical data.","type":"boolean"}},"type":"object"},"PrimaryAddress_1":{"properties":{"pk":{"description":"Dashdoc's internal id.","type":"number"},"name":{"type":"string"},"address":{"type":"string"},"city":{"type":"string"},"postcode":{"type":"string"},"country":{"$ref":"#/components/schemas/country"},"latitude":{"$ref":"#/components/schemas/latitude"},"longitude":{"$ref":"#/components/schemas/longitude"},"radius":{"default":500,"description":"Radius around the GPS coordinates within which the address is located (in meters)","type":"integer"},"coords_validated":{"default":false,"description":"if `true`, when this address is used as a loading or unloading site, the mobile app displays an itinerary button to start GPS app with guidance to these coordinates","type":"boolean"},"is_demo":{"$ref":"#/components/schemas/is_demo"},"is_carrier":{"description":"Whether this company is considered a carrier","type":"boolean"},"is_shipper":{"description":"Whether this company is considered a shipper","type":"boolean"},"is_origin":{"description":"Legacy, not relevant for a company's primary address. Consider creating a separate address associated with this partner instead.\n","type":"boolean"},"is_destination":{"description":"Legacy, not relevant for a company's primary address. Consider creating a separate address associated with this partner instead.\n","type":"boolean"},"created_by":{"$ref":"#/components/schemas/created-by"},"created_by_user":{"$ref":"#/components/schemas/created-by-user"},"created":{"$ref":"#/components/schemas/created"},"remote_id":{"description":"The id of the address in your system.","type":"string"}},"type":"object"},"created-by":{"nullable":true,"properties":{"pk":{"description":"company id","type":"number"},"name":{"description":"name of the company","type":"string"}},"type":"object"},"created-by-user":{"nullable":true,"properties":{"pk":{"type":"number"},"display_name":{"type":"string"},"company":{"description":"The company id who created the address","type":"number"},"trucker_id":{"description":"The trucker id who created the address","type":"number"}},"type":"object"},"Managers":{"properties":{"pk":{"description":"Dashdoc's internal id.","type":"number"},"user":{"$ref":"#/components/schemas/Managers_user"},"display_name":{"type":"string"},"role":{"type":"string"}},"type":"object"},"Managers_user":{"properties":{"email":{"format":"email","type":"string"},"first_name":{"type":"string"},"last_name":{"type":"string"}},"type":"object"},"CarrierAssignationStatus":{"description":"Carrier assignment state of an order (Only for chartered transport). Null values should be treated as unassigned.","enum":["unassigned","draft_assigned","assigned"],"type":"string"},"Delivery":{"properties":{"uid":{"description":"Dashdoc's internal id.","type":"string"},"sequential_id":{"description":"eCMR number","type":"number"},"remote_id":{"type":"string"},"tracking_id":{"description":"Deprecated","type":"string"},"origin":{"$ref":"#/components/schemas/CreateOrUpdateSite"},"destination":{"$ref":"#/components/schemas/CreateOrUpdateSite"},"shipper_address":{"$ref":"#/components/schemas/NewAddressReduced"},"planned_loads":{"description":"Loads as planned before the transport has been started","items":{"$ref":"#/components/schemas/DeliveryLoads"},"type":"array"},"loads":{"description":"Loads as they are most recently defined. This means it is: \n\n* equal to `planned_loads` before loading is actually done \n\n* equal to `origin_loads` after loading is done (with details validated by trucker), but unloading is not done yet \n\n* equal to `loads_loads` after unloading is actually done (with details validated by trucker)","items":{"$ref":"#/components/schemas/DeliveryLoads"},"type":"array"},"origin_loads":{"description":"Loads as validated by trucker right after loading is done","items":{"$ref":"#/components/schemas/DeliveryLoads"},"type":"array"},"destination_loads":{"description":"Loads as validated by trucker right after unloading is done","items":{"$ref":"#/components/schemas/DeliveryLoads"},"type":"array"},"tracking_contacts":{"description":"List of contacts that will automatically receive an email when delivery is done. ⚠️ If no tracking contacts are provided for a company and the setting `partner_email_fallback` is enabled, a tracking contact corresponding to the company's email will be added, at the creation of the transport. This only applies to the carrier and the shipper.","items":{"$ref":"#/components/schemas/Delivery_tracking_contacts"},"type":"array"},"shipper_reference":{"description":"Reference the client may use to match transport on his own system, e.g. an order number. The transport's creator can toggle a setting to only allow himself to set it.","type":"string"},"multiple_rounds":{"description":"If true, the trucker will be able to do a signature at loading, then add any amount of rounds for the transport (with weight/volume and weight ticket), and finish with a signature at unloading.","type":"boolean"}},"type":"object"},"CreateOrUpdateSite":{"properties":{"uid":{"format":"uuid","type":"string"},"remote_id":{"description":"The id of the site in your system","type":"string"},"address":{"allOf":[{"$ref":"#/components/schemas/SiteAddress"}],"nullable":true},"real_start":{"description":"date and time when trucker arrived on site","format":"date-time","readOnly":true,"type":"string"},"real_end":{"description":"date and time when trucker completed loading / unloading (depending whether site is origin or destination)","format":"date-time","readOnly":true,"type":"string"},"signature_process":{"type":"string"},"is_booking_needed":{"type":"boolean"},"instructions":{"$ref":"#/components/schemas/site_instructions"},"reference":{"type":"string"},"action":{"deprecated":true,"description":"Deprecated. Accepted for backward compatibility but ignored. Responses always return an empty string.","type":"string"},"eta":{"format":"date-time","nullable":true,"type":"string"},"eta_tracking":{"type":"boolean"},"punctuality_status":{"readOnly":true,"type":"string"},"supports_exchanges":{"$ref":"#/components/schemas/SupportsExchange"},"category":{"type":"string"},"slots":{"items":{"$ref":"#/components/schemas/Site_slots"},"type":"array"},"trucker_instructions":{"$ref":"#/components/schemas/trucker_instructions"},"trip":{"$ref":"#/components/schemas/Site_trip"}},"type":"object"},"SiteAddress":{"description":"Address of the site. Reference an existing address with its `pk` or `remote_id`, or send its details to have it matched or created.","properties":{"pk":{"description":"Dashdoc's internal id. Optional, set it to reference an existing address.","type":"integer"},"name":{"type":"string"},"address":{"type":"string"},"city":{"type":"string"},"postcode":{"type":"string"},"country":{"$ref":"#/components/schemas/country"},"latitude":{"$ref":"#/components/schemas/latitude"},"longitude":{"$ref":"#/components/schemas/longitude"},"radius":{"default":500,"description":"Radius around the GPS coordinates within which the address is located (in meters)","type":"integer"},"coords_validated":{"default":false,"description":"if `true`, when this address is used as a loading or unloading site, the mobile app displays an itinerary button to start GPS app with guidance to these coordinates","type":"boolean"},"is_demo":{"$ref":"#/components/schemas/is_demo"},"is_carrier":{"type":"boolean"},"is_shipper":{"type":"boolean"},"is_origin":{"$ref":"#/components/schemas/address_is_origin_and_is_destination"},"is_destination":{"$ref":"#/components/schemas/address_is_origin_and_is_destination"},"instructions":{"$ref":"#/components/schemas/site_instructions"},"remote_id":{"description":"The id of the address in your system.","type":"string"},"company":{"$ref":"#/components/schemas/CompanyForTransportAddress_1"}},"type":"object"},"site_instructions":{"description":"Site instructions, visible to all parties (trucker, carrier, shipper, site). Displayed in the trucker mobile app. Not visible in the eCMR. If the field is not provided, the address's site instructions will be used.","maxLength":1000,"type":"string"},"CompanyForTransportAddress_1":{"description":"Identification of the company. You may simply use its `pk` or `remote_id` if the company already exists. Other possible identification method are its `trade_number` or `name`. If it doesn't exist, the company will be created with the information you send based on what's possible when creating a company via /companies/ web service. Minimum required information in this case is a name.","properties":{"pk":{"description":"Dashdoc's internal id.Optional, not required if `remote_id` is sent.","type":"integer"},"remote_id":{"description":"The id of the company in your system. Optional, ignored if `pk` is sent.","type":"string"},"trade_number":{"maxLength":100,"type":"string"},"name":{"maxLength":200,"type":"string"}},"type":"object"},"SupportsExchange":{"properties":{"uid":{"description":"uid of the support exchange","format":"uuid","type":"string"},"site":{"$ref":"#/components/schemas/SupportsExchange_site"},"support_type":{"$ref":"#/components/schemas/SupportType"},"expected_retrieved":{"description":"Expected number of supports that should be retrieved on the site","type":"number"},"actual_retrieved":{"description":"Actual number of supports that were retrieved on the site","type":"number"},"expected_delivered":{"description":"Expected number of supports that should be delivered on the site","type":"number"},"actual_delivered":{"description":"Actual number of supports that were delivered on the site","type":"number"},"observations":{"description":"Free text. Observations about this supports exchange. Can be filled on mobile app, web app or via API.","type":"string"},"remote_id":{"description":"The ID of the support in your system","type":"string"}},"type":"object"},"SupportsExchange_site":{"description":"site where supports exchange is expected","properties":{"uid":{"description":"uid of the site","format":"uuid","type":"string"},"remote_id":{"description":"remote_id of the site","type":"string"}},"type":"object"},"SupportType":{"description":"Type of the supports that are exchanged","properties":{"name":{"description":"Display name of the support type","type":"string"},"created":{"$ref":"#/components/schemas/created"},"uid":{"format":"uuid","type":"string"},"remote_id":{"description":"The id of the support type in your system.","type":"string"}},"type":"object"},"Site_slots":{"properties":{"start":{"format":"date-time","type":"string"},"end":{"format":"date-time","type":"string"}},"type":"object"},"trucker_instructions":{"description":"**This field is part of a beta feature.** Private instructions. **The carrier of the transport is the only one who can edit and read those instructions.** Note that those instructions are not visible in the consignment note and can be accessed by the trucker. The value is null if the caller doesn't have the right of access to the data.","maxLength":1000,"type":"string"},"Site_trip":{"description":"Trip linked to this site/activity.","nullable":true,"properties":{"uid":{"format":"uuid","type":"string"},"name":{"type":"string"},"is_prepared":{"type":"boolean"},"status":{"enum":["unstarted","ongoing","done"],"type":"string"}},"readOnly":true,"type":"object"},"NewAddressReduced":{"properties":{"pk":{"description":"Dashdoc's internal id. Optional, set it to reference an existing address.","type":"integer"},"name":{"type":"string"},"address":{"type":"string"},"city":{"type":"string"},"postcode":{"type":"string"},"country":{"$ref":"#/components/schemas/country"},"latitude":{"$ref":"#/components/schemas/latitude"},"longitude":{"$ref":"#/components/schemas/longitude"},"radius":{"default":500,"description":"Radius around the GPS coordinates within which the address is located (in meters)","type":"integer"},"coords_validated":{"default":false,"description":"if `true`, when this address is used as a loading or unloading site, the mobile app displays an itinerary button to start GPS app with guidance to these coordinates","type":"boolean"},"is_demo":{"$ref":"#/components/schemas/is_demo"},"is_carrier":{"type":"boolean"},"is_shipper":{"type":"boolean"},"is_origin":{"type":"boolean"},"is_destination":{"type":"boolean"},"created_by":{"description":"Ignore. Dashdoc technical data.","readOnly":true,"type":"number"},"created":{"description":"Date of creation on our server","format":"date-time","readOnly":true,"type":"string"},"instructions":{"type":"string"},"remote_id":{"description":"The id of the address in your system.","type":"string"},"company":{"$ref":"#/components/schemas/CompanyForTransportAddress"},"original":{"description":"Ignore. Dashdoc technical data.","nullable":true,"readOnly":true,"type":"number"}},"required":["address","city","company","country","postcode"],"type":"object"},"DeliveryLoads":{"properties":{"uid":{"description":"Dashdoc's internal id.","type":"string"},"remote_id":{"description":"The ID of the load in your system. It has to be unique among all your transports.","type":"string"},"description":{"description":"Text description of the load","type":"string"},"reference":{"description":"Reference of the load","type":"string"},"round_id":{"description":"The ID of the round.","format":"integer","type":"number"},"weight":{"description":"In kilograms","format":"float","type":"number"},"volume":{"description":"Volume of load in m3","format":"float","type":"number"},"volume_display_unit":{"default":"m3","enum":["m3","L"],"type":"string"},"linear_meters":{"description":"Length of load in meters","format":"float","type":"number"},"quantity":{"description":"Only one decimal accepted (e.g 0.0)","format":"float","type":"number"},"pallet_equivalence":{"description":"Pallet equivalence (EPS/EQPAL): how many standard pallet spaces the load occupies. `null` when it was never set. Otherwise at least `0.01`, with two decimals kept.","format":"float","nullable":true,"type":"number"},"category":{"description":"Packaging of the load. The text is free but these specific values cause a custom flow on the mobile app: `pallets`, `containers`, `bulk`, `roundwood`, `powder_tank`, `bulk_qualimat`, `rental`.","type":"string"},"dangerous_goods_category":{"description":"ADR class","enum":["1","2","3","4.1","4.2","4.3","5.1","5.2","6.1","6.2","7","8","9"],"type":"string"},"is_dangerous":{"type":"boolean"},"adr_un_code":{"type":"string"},"legal_mentions":{"type":"string"},"complementary_information":{"description":"Any information about the load that doesn't fit to the description field","type":"string"},"container_number":{"type":"string"},"tare_weight":{"description":"In kilograms","format":"float","type":"number"},"container_seal_number":{"type":"string"},"refrigerated":{"description":"Indicates whether the load is refrigerated. If true, the trucker can fill in the temperature.","type":"boolean"},"temperature":{"type":"string"},"steres":{"format":"float","type":"number"},"idtf_number":{"description":"Must match an existing IDTF number","type":"string"},"use_identifiers":{"description":"if `true`, trucker is asked to scan barcode identifiers on load","type":"boolean"},"identifiers":{"description":"Only relevant if use_identifiers is set to `true`. List of expected barcode identifiers that the trucker should scan at loading and unloading. App controls that expected barcodes are actually scanned. If empty, the trucker will have to scan barcodes anyway, but there won't be any check. Feature has to be activated in your account by your Dashdoc projet manager.","items":{"type":"string"},"type":"array"},"identifiers_observations":{"description":"Observations explaining issues with identifier, such as missing or unexpected identifiers","type":"string"}},"type":"object"},"Delivery_tracking_contacts":{"properties":{"uid":{"description":"Dashdoc's internal id.","type":"string"},"contact":{"$ref":"#/components/schemas/NewContact"},"subscribed_to_status_updates":{"description":"If set to true, the contact will receive an email at every step of the delivery. Else, they will receive only one email once the delivery is done.","type":"boolean"},"role":{"description":"The role of the contact in the delivery. It can be `carrier`, `shipper`, or `site`.","type":"string"}},"required":["contact"],"type":"object"},"NewContact":{"properties":{"uid":{"format":"uuid","type":"string"},"created":{"description":"Date of creation on our server","format":"date-time","readOnly":true,"type":"string"},"company":{"$ref":"#/components/schemas/CompanyIdentification"},"first_name":{"maxLength":200,"type":"string"},"last_name":{"maxLength":200,"type":"string"},"email":{"format":"email","type":"string"},"phone_number":{"maxLength":100,"type":"string"},"fax_number":{"maxLength":100,"type":"string"},"remote_id":{"description":"The id of the contact in your system","type":"string"}},"required":["company","last_name"],"type":"object"},"CompanyIdentification":{"description":"Identification of the company. The company must already exist in Dashdoc.","properties":{"pk":{"description":"Dashdoc's internal id. Optional, not required if `remote_id` is sent.","type":"integer"},"remote_id":{"description":"Your remote carrier id. Optional, ignored if `pk` is sent.","type":"string"},"name":{"type":"string"},"trade_number":{"type":"string"},"country":{"$ref":"#/components/schemas/country"},"settings_contract_html":{"description":"Ignore. Dashdoc technical data.","type":"string"},"settings_logo":{"description":"Ignore. Dashdoc technical data.","nullable":true,"type":"string"},"settings_stamp":{"description":"Ignore. Dashdoc technical data.","nullable":true,"type":"string"},"settings_print_mode":{"description":"Ignore. Dashdoc technical data.","type":"boolean"},"settings_special_agreements":{"description":"Ignore. Dashdoc technical data.","type":"string"},"settings_transport_order_observations":{"type":"string"},"settings_constrain_reference_edition":{"type":"boolean"},"vat_number":{"type":"string"},"is_verified":{"description":"Ignore. Dashdoc technical data.","type":"string"}},"type":"object"},"Segment":{"description":"","properties":{"uid":{"minLength":1,"type":"string"},"remote_id":{"minLength":1,"type":"string"},"origin":{"$ref":"#/components/schemas/Site"},"destination":{"$ref":"#/components/schemas/Site"},"trucker":{"$ref":"#/components/schemas/SegmentTrucker"},"vehicle":{"$ref":"#/components/schemas/Vehicle"},"trailers":{"items":{"$ref":"#/components/schemas/Trailer"},"type":"array"},"sort_order":{"description":"The index of the segment in the transport","minimum":0,"type":"number"},"scheduled_start_range":{"$ref":"#/components/schemas/Segment_scheduled_start_range"},"scheduled_end_range":{"$ref":"#/components/schemas/Segment_scheduled_end_range"},"scheduled_start":{"deprecated":true,"description":"The datetime at which the carrier scheduled the start of this segment\n","type":"string"},"scheduled_end":{"deprecated":true,"description":"The datetime at which the carrier scheduled the end of this segment","type":"string"},"child_transport":{"$ref":"#/components/schemas/Segment_child_transport"},"telematic_distance":{"description":"Automatically computed distance from telematic data (in kms).","type":"integer"},"distance":{"description":"Manually entered distance. If null, it takes the value of telematic_distance (in kms).","type":"integer"},"origin_mileage":{"description":"Mileage at transport origin site (in kms).","type":"integer"},"destination_mileage":{"description":"Mileage at transport destination site (in kms).","type":"integer"}},"type":"object"},"Site":{"properties":{"uid":{"format":"uuid","type":"string"},"remote_id":{"description":"The id of the site in your system","type":"string"},"address":{"$ref":"#/components/schemas/Address"},"real_start":{"description":"date and time when trucker arrived on site","format":"date-time","type":"string"},"real_end":{"description":"date and time when trucker completed loading / unloading (depending whether site is origin or destination)","format":"date-time","type":"string"},"signature_process":{"type":"string"},"instructions":{"$ref":"#/components/schemas/site_instructions"},"reference":{"type":"string"},"action":{"deprecated":true,"description":"Deprecated. Always returned as an empty string.","type":"string"},"eta":{"nullable":true,"type":"string"},"eta_tracking":{"$ref":"#/components/schemas/eta_tracking"},"punctuality_status":{"$ref":"#/components/schemas/punctuality_status"},"supports_exchanges":{"$ref":"#/components/schemas/SupportsExchange"},"category":{"enum":["loading","unloading"],"type":"string"},"slots":{"items":{"$ref":"#/components/schemas/Site_slots"},"type":"array"},"trucker_instructions":{"$ref":"#/components/schemas/trucker_instructions"},"trip":{"$ref":"#/components/schemas/Site_trip"}},"type":"object"},"Address":{"properties":{"pk":{"description":"Dashdoc's internal id.","type":"number"},"name":{"type":"string"},"address":{"type":"string"},"city":{"type":"string"},"postcode":{"type":"string"},"country":{"$ref":"#/components/schemas/country"},"latitude":{"$ref":"#/components/schemas/latitude"},"longitude":{"$ref":"#/components/schemas/longitude"},"radius":{"default":500,"description":"Radius around the GPS coordinates within which the address is located (in meters)","type":"integer"},"coords_validated":{"default":false,"description":"if `true`, when this address is used as a loading or unloading site, the mobile app displays an itinerary button to start GPS app with guidance to these coordinates","type":"boolean"},"is_demo":{"$ref":"#/components/schemas/is_demo"},"is_carrier":{"type":"boolean"},"is_shipper":{"type":"boolean"},"is_origin":{"$ref":"#/components/schemas/address_is_origin_and_is_destination"},"is_destination":{"$ref":"#/components/schemas/address_is_origin_and_is_destination"},"created_by":{"$ref":"#/components/schemas/created-by"},"created_by_user":{"$ref":"#/components/schemas/created-by-user"},"created":{"$ref":"#/components/schemas/created"},"instructions":{"$ref":"#/components/schemas/site_instructions"},"remote_id":{"description":"The id of the address in your system.","type":"string"},"original":{"description":"Dashdoc's internal id of the original address.","nullable":true,"readOnly":true,"type":"number"},"company":{"$ref":"#/components/schemas/Company"}},"type":"object"},"eta_tracking":{"default":false,"description":"Ask for an ETA on this site. This is currently a beta feature, not activated by default.","type":"boolean"},"punctuality_status":{"default":"untracked","description":"Indicate the punctuality on this site.","enum":["untracked","probably_late","probably_on_time","late","on_time"],"type":"string"},"SegmentTrucker":{"properties":{"pk":{"description":"Dashdoc's internal id.","type":"number"},"remote_id":{"description":"The ID of the trucker in your system. It has to be unique among all your truckers.","type":"string"},"display_name":{"type":"string"},"user":{"$ref":"#/components/schemas/SegmentTruckerUser"}},"type":"object"},"SegmentTruckerUser":{"properties":{"pk":{"description":"Dashdoc's internal id.","type":"number"},"first_name":{"type":"string"},"last_name":{"type":"string"},"username":{"description":"Ignore. Dashdoc technical data.","type":"string"},"email":{"format":"email","type":"string"},"display_name":{"description":"Display name generated by Dashdoc.","type":"string"},"date_joined":{"description":"Ignore. Dashdoc technical data.","format":"date-time","type":"string"},"is_staff":{"description":"Ignore. Dashdoc technical data.","type":"boolean"},"is_superuser":{"description":"Ignore. Dashdoc technical data.","type":"boolean"},"has_usable_password":{"description":"Ignore. Dashdoc technical data.","type":"boolean"}},"type":"object"},"Vehicle":{"properties":{"pk":{"description":"Dashdoc's internal id","type":"number"},"carrier":{"description":"Dashdoc's internal id of the carrier owning the vehicle","type":"number"},"category":{"description":"Vehicle category","type":"string"},"license_plate":{"description":"License plate number","type":"string"},"fleet_number":{"description":"Your vehicle fleet number","type":"string"},"remote_id":{"description":"The ID of the vehicle in your system","type":"string"},"created":{"description":"Date of creation on our server","format":"date-time","type":"string"},"used_for_qualimat_transports":{"description":"True if the vehicle can be used for Qualimat transport (only used for visual help and warnings)","type":"boolean"},"telematic_vehicle":{"description":"Ignore. Dashdoc technical data","type":"number"},"original":{"type":"number"},"tags":{"description":"List of tags applied to the vehicle.","items":{"$ref":"#/components/schemas/Tag"},"type":"array"},"technical_control_deadline":{"format":"date-time","type":"string"},"tachograph_deadline":{"format":"date-time","type":"string"},"speed_limiter_deadline":{"format":"date-time","type":"string"},"country":{"$ref":"#/components/schemas/country"},"unavailability":{"description":"List of unavailable period","items":{"$ref":"#/components/schemas/Unavailability"},"type":"array"},"events":{"description":"Ignore. Dashdoc technical data.","items":{"type":"object"},"type":"array"}},"type":"object"},"Tag":{"properties":{"pk":{"description":"The unique identifier of the tag","type":"integer"},"name":{"description":"The name of the tag","type":"string"},"color":{"description":"The color of the tag in hex format","type":"string"},"tag_group_id":{"description":"The ID of the tag group this tag belongs to, if any","nullable":true,"type":"integer"}},"required":["color","name","pk"],"type":"object"},"Unavailability":{"properties":{"id":{"description":"Dashdoc's internal id","type":"number"},"remote_id":{"description":"The ID of the unavailability in your system","type":"string"},"created":{"description":"Date of creation on our server","format":"date-time","type":"string"},"start_date":{"description":"Start date of the unavailability","format":"date-time","type":"string"},"end_date":{"description":"End date of the unavailability","format":"date-time","type":"string"},"unavailability_type":{"description":"Type of unavailability","enum":["paid_vacation","day_off","sick_leave","training","vacation","maintenance","rental","other"],"type":"string"},"unavailability_note":{"description":"Notes about the unavailability","type":"string"}},"type":"object"},"Trailer":{"properties":{"pk":{"description":"Dashdoc's internal id","type":"number"},"original":{"description":"Ignore. Dashdoc technical data","type":"number"},"carrier":{"description":"Dashdoc's internal id of the carrier owning the trailer","type":"number"},"license_plate":{"description":"License plate number","type":"string"},"fleet_number":{"description":"Your trailer fleet number","type":"string"},"remote_id":{"description":"The ID of the trailer in your system","type":"string"},"created":{"description":"Date of creation on our server","format":"date-time","type":"string"},"used_for_qualimat_transports":{"description":"True if the trailer can be used for Qualimat transport (only used for visual help and warnings)","type":"boolean"},"tags":{"description":"List of tags applied to the trailer.","items":{"$ref":"#/components/schemas/Tag"},"type":"array"},"technical_control_deadline":{"format":"date-time","type":"string"},"country":{"$ref":"#/components/schemas/country"},"unavailability":{"description":"List of unavailable period","items":{"$ref":"#/components/schemas/Unavailability"},"type":"array"},"events":{"description":"Ignore. Dashdoc technical data.","items":{"type":"object"},"type":"array"}},"type":"object"},"Segment_scheduled_start_range":{"description":"The datetime range at which the carrier scheduled the start of this segment","properties":{"start":{"description":"Min scheduled start date (ISO 8601)","type":"string"},"end":{"description":"Max scheduled start date (ISO 8601)","type":"string"}},"type":"object"},"Segment_scheduled_end_range":{"description":"The datetime range at which the carrier scheduled the end of this segment","properties":{"start":{"description":"Min scheduled end date (ISO 8601)","type":"string"},"end":{"description":"Max scheduled end date (ISO 8601)","type":"string"}},"type":"object"},"Segment_child_transport":{"description":"If the segment is chartered, will contain the child transport","properties":{"uid":{"format":"uuid","type":"string"},"sequential_id":{"type":"number"},"remote_id":{"type":"string"},"has_strong_link":{"type":"boolean"}},"type":"object"},"Statuses":{"enum":["created","updated","confirmed","declined","verified","invoiced","paid","cancelled","assigned","sent_to_trucker","acknowledged","truck_wash","on_loading_site","loading_complete","on_unloading_site","unloading_complete","bulking_break_started","bulking_break_complete","rounds_started","round_added","round_added_v2","round_edited","round_deleted","rounds_complete","event","checklist_filled","activity_complete","on_the_way","handling_started","done"],"type":"string"},"Status":{"properties":{"uid":{"format":"uuid","type":"string"},"created":{"description":"Date of creation on the server. Useful when the transport is created by mobile devices. If network connection is bad, the `created` date can be later than `created_device`","format":"date-time","type":"string"},"created_device":{"description":"If created from a mobile device, date of creation on the device.","format":"date-time","type":"string"},"creation_method":{"type":"string"},"category":{"description":"event that occured on the transport","type":"string"},"author":{"description":"details about author of the update. Contact Dashdoc if more details is needed.","type":"object"},"content":{"description":"Contact Dashdoc if more details is needed.","type":"object"},"content_signatory":{"description":"Contact Dashdoc if more details is needed.","type":"object"},"target":{"description":"Contact Dashdoc if more details is needed.","type":"object"},"site":{"description":"Contact Dashdoc if more details is needed.","type":"object"},"site_id":{"description":"Contact Dashdoc if more details is needed.","format":"uuid","type":"string"},"delivery":{"description":"Contact Dashdoc if more details is needed.","format":"uuid","type":"string"},"segment":{"description":"Contact Dashdoc if more details is needed.","format":"uuid","type":"string"},"transport":{"description":"Contact Dashdoc if more details is needed.","format":"uuid","type":"string"},"signature":{"description":"Contact Dashdoc if more details is needed.","type":"object"},"latitude":{"description":"Contact Dashdoc if more details is needed.","format":"float","type":"number"},"longitude":{"description":"Contact Dashdoc if more details is needed.","format":"float","type":"number"},"update_details":{"description":"Contact Dashdoc if more details is needed.","type":"object"},"author_company":{"type":"number"}},"required":["uid"],"type":"object"},"TransportMessage":{"properties":{"uid":{"format":"uuid","type":"string"},"created":{"$ref":"#/components/schemas/created"},"created_device":{"format":"date-time","type":"string"},"creation_method":{"type":"string"},"author":{"$ref":"#/components/schemas/NewTransportMessage_author"},"type":{"enum":["note","load_verification","share","document","photo"],"maxLength":100,"type":"string"},"document_title":{"description":"Filename or if uploaded by a trucker from the mobile app, the document title is generic, for instance `photo`.","maxLength":100,"type":"string"},"document_type":{"enum":["load_photo","cmr","washing_note","delivery_note","confirmation","weight_note","waste_manifest","holders_swap_note","invoice"],"maxLength":100,"type":"string"},"document":{"description":"URL of the stored document. You can download the document from this URL.","type":"string"},"is_attached_to_cmr":{"type":"boolean"},"transport":{"format":"uuid","type":"string"},"site":{"description":"This field is used for the default values of the field readable_by_company_ids; if null, companies from all Sites of the transport are listed in readable_by_company_ids, otherwise only the company of this Site. Site must exist in this transport. This field is part of a beta feature.","format":"uuid","nullable":true,"type":"string"},"site_remote_id":{"type":"string"},"readable_by_company_ids":{"description":"A list containing the pk of each company allowed to access the document, every company must be part of the transport. If no values are sent, it will be computed with default values; Carrier, Shipper, Invoiced Customer and Site's pk (see Site field). Once values have been sent, the behavior adding default companies is deactivated. The author company is always added. Only pks of companies from the transport will be added, others will be ignored. This field is part of a beta feature.","items":{"type":"integer"},"type":"array"},"message":{"description":"message displayed in the activity thread of a transport in the web app and in the mobile app","type":"string"},"latitude":{"$ref":"#/components/schemas/latitude"},"longitude":{"$ref":"#/components/schemas/longitude"},"reference":{"description":"Free text. This reference is searchable in the transports dashboard. Filled by trucker if document is added from mobile app, by user if document is added from web app, or filled by API request.","maxLength":140,"type":"string"},"visible_by_everyone":{"$ref":"#/components/schemas/visible_by_everyone"},"readable_by_trucker":{"$ref":"#/components/schemas/readable_by_trucker"},"extracted_reference":{"description":"Reference extracted by AI from the document. AI runs only on weight notes, so it will be null for other documents. \"\" if no reference has been found by the AI.","type":"string"}},"type":"object"},"NewTransportMessage_author":{"properties":{"display_name":{"type":"string"},"company":{"type":"number"},"pk":{"description":"Dashdoc's internal id.","type":"number"}},"type":"object"},"visible_by_everyone":{"description":"This field is used to make the transport message public, which makes it visible by all parties of the transport.","type":"boolean"},"readable_by_trucker":{"description":"This field is used to allow truckers to see the transport message. **Only available for carriers.**","type":"boolean"},"requested_vehicle":{"description":"Only useful when the transport is created by the shipper. Free text except punction and special characters.","maxLength":40,"type":"string"},"Document":{"properties":{"pk":{"type":"integer"},"file_updated_date":{"description":"Date was updated on the server.","format":"date-time","type":"string"},"delivery":{"description":"Contact Dashdoc if more details are needed.","format":"uuid","type":"string"},"delivery_sequential_id":{"description":"eCMR number (for category \"cmr\" and \"ldv\")","type":"integer"},"reference":{"type":"integer"},"category":{"description":"Type of document. Possible values are \"cmr\", \"cmr4\", \"ldv\", \"orc\", \"chc\", \"rental\" and \"loading_plan\"","type":"string"},"languages":{"description":"Languages displayed in the document (CMR only), formatted as an 2-letter ISO 639-1 language code","items":{"type":"string"},"type":"array"},"name":{"description":"generic name of the document","type":"string"},"file":{"description":"path to the document","format":"url","type":"string"},"business_privacy_scope":{"description":"Ignore. Dashdoc technical data.","type":"boolean"},"cancelled":{"description":"Date of cancellation of the the document","format":"date-time","type":"string"}},"type":"object"},"deprecated_price":{"deprecated":true,"description":"Full price for the transport","format":"float","nullable":true,"type":"number"},"customer_to_invoice":{"properties":{"pk":{"description":"Dashdoc's internal id.","type":"number"},"name":{"type":"string"},"invoicing_address":{"$ref":"#/components/schemas/customer_to_invoice_invoicing_address"}},"type":"object"},"customer_to_invoice_invoicing_address":{"properties":{"address":{"type":"string"},"city":{"type":"string"},"postcode":{"type":"string"},"country":{"$ref":"#/components/schemas/country"}},"type":"object"},"Transport_parent_transport":{"description":"if this is a chartered transport, this will contains the parent transport it is chartered from","properties":{"uid":{"format":"uuid","type":"string"},"sequential_id":{"type":"number"},"remote_id":{"type":"string"},"has_strong_link":{"type":"boolean"}},"type":"object"},"deprecated_invoiced_price":{"deprecated":true,"description":"Invoiced price for the transport. Deprecated in favour of pricing field","format":"float","nullable":true,"type":"number"},"Transport_references":{"properties":{"role":{"type":"string"},"company":{"$ref":"#/components/schemas/Transport_company"},"reference":{"type":"string"}},"type":"object"},"Transport_company":{"properties":{"name":{"type":"string"}},"type":"object"},"global_instructions":{"description":"Operating instructions. The carrier, the shipper and the creator of the transport have access to those instructions. However, the creator is the only who has the right to edit.","maxLength":1000,"type":"string"},"RetrievedTransport_allOf":{"properties":{"agreed_price_total":{"description":"The total of the agreed price (including fuel surcharge, excluding taxes) if readable, otherwise null.","nullable":true,"type":"string"},"invoiced_price_total":{"description":"The total of the invoiced price (including fuel surcharge, excluding taxes) if readable, otherwise null.","nullable":true,"type":"string"},"shipper_final_price_total":{"description":"The total of the shipper final price (including fuel surcharge, excluding taxes) if readable, otherwise null.","nullable":true,"type":"string"},"effective_price_total":{"description":"The total of the effective price (including fuel surcharge, excluding taxes) if readable, otherwise null.","nullable":true,"type":"string"},"purchase_cost_total":{"description":"The total of the purchase costs if readable, otherwise null.","nullable":true,"type":"string"},"segments":{"items":{"$ref":"#/components/schemas/SegmentWithLegTags"},"type":"array"}},"type":"object"},"SegmentWithLegTags":{"allOf":[{"$ref":"#/components/schemas/Segment"},{"$ref":"#/components/schemas/SegmentWithLegTags_allOf"}],"type":"object"},"SegmentWithLegTags_allOf":{"properties":{"tags":{"description":"Tags of the leg this segment belongs to. Segments of the same leg share its tags.","items":{"$ref":"#/components/schemas/Tag"},"type":"array"}},"type":"object"}}}}
```

## The AssignTransport object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"AssignTransport":{"properties":{"trucker_id":{"$ref":"#/components/schemas/AssignTransport_trucker_id"},"vehicle":{"$ref":"#/components/schemas/NewVehicle"},"trailers":{"items":{"$ref":"#/components/schemas/NewTrailer"},"type":"array"}},"type":"object"},"AssignTransport_trucker_id":{"properties":{"pk":{"description":"Dashdoc's internal id. Optional, not required if `remote_id` is sent.","type":"number"},"remote_id":{"description":"The ID of the trucker in your system. Optional, ignored if pk is sent.","type":"string"}},"required":["pk"],"type":"object"},"NewVehicle":{"properties":{"remote_id":{"description":"The ID of the vehicle in your system.","type":"string"},"fleet_number":{"description":"Your vehicle fleet number. It has to be unique among all your vehicles. When filled, fleet number will be displayed in the web and mobile app next to license plate number. It can also be used for searches.","maxLength":10,"type":"string"},"license_plate":{"description":"License plate number (has to be unique)","maxLength":200,"type":"string"},"category":{"$ref":"#/components/schemas/vehicle_category"},"used_for_qualimat_transports":{"description":"True if the vehicle can be used for Qualimat transport (only used for vehicle that can handle a load without trailer). This value is used to add a Qualimat logo next to the vehicle in forms, in order to help the user selecting the vehicle when creating a transport. The is no control on the value. You can create a Qualimat transport with a vehicle that is not flagged for Qualimat. In this case a warning is displayed in the transport detail.","type":"boolean"},"tags":{"description":"List of tags applied to the vehicle.","items":{"$ref":"#/components/schemas/Tag"},"type":"array"},"telematic_data_source":{"description":"The telematic where the vehicle is refered","enum":["alertgasoil","astrata","addsecure","dashdoc","eliott","fleetboard","geodynamics","geotracer","geotab","koovea","mappingcontrol","mapandtruck","masternaut","qeos","quartix","rio","scania","sudtelematique","transics","trimble","truckonline","vehizen","volvo","webfleet","strada","verizon","mapon","bump","samsara","samsara_mapandtruck","webeye","pass_tracabilite","bizztrack","aktkc_etransportas_mapandtruck","anima_mapandtruck","arvento_mapandtruck","as24_mapandtruck","axxess_mapandtruck","bornemann_infleet_mapandtruck","bpw_mapandtruck","cartrack_mapandtruck","commander_services_mapandtruck","dkv_mapandtruck","easytrack_mapandtruck","ecofleet_mapandtruck","edrive_mapandtruck","effitrailer_mapandtruck","ekolis_mapandtruck","fleetgo_mapandtruck","fleethand_mapandtruck","fleetmaster_mapandtruck","framelogic_mapandtruck","frotcom_mapandtruck","geotab_mapandtruck","gestracking_mapandtruck","globaltrack_mapandtruck","goodyear_france_mapandtruck","gps_mobile_mapandtruck","icell_mapandtruck","ims_telematics_mapandtruck","inelo_mapandtruck","infis_mapandtruck","jaltest_mapandtruck","k2gps_mapandtruck","keeptrace_mapandtruck","konsalnet_mapandtruck","krone_telematic_mapandtruck","legal_telematics_mapandtruck","linqo_mapandtruck","localizare_mapandtruck","locationsolutions_mapandtruck","loctracker_mapandtruck","mecomo_mapandtruck","microlise_mapandtruck","mix_telematics_mapandtruck","movertis_mapandtruck","movildata_mapandtruck","mtrack_mapandtruck","n2mobil_mapandtruck","naocom_mapandtruck","navifleet_mapandtruck","nexus_mapandtruck","ocean_mapandtruck","optifleet_mapandtruck","optimo_gps_mapandtruck","orbcomm_mapandtruck","orbcomm_africa_mapandtruck","pulsit_electronics_mapandtruck","quake_tracking_mapandtruck","riverlong_mapandtruck","sas_fleet_mapandtruck","satko_mapandtruck","schmitz_cargobull_mapandtruck","seyir_mobil_mapandtruck","skywatch_mapandtruck","solustop_mapandtruck","spedion_mapandtruck","speedtelematics_mapandtruck","starcom_mapandtruck","telepass_mapandtruck","terramar_networks_mapandtruck","tracker_mapandtruck","trackit_mapandtruck","tracknamic_mapandtruck","trendfire_mapandtruck","v3_smart_technologies_mapandtruck","vektor_teknoloji_mapandtruck","viafleet_mapandtruck","viasat_mapandtruck","visirun_mapandtruck","waynet_mapandtruck","wayzz_mapandtruck","webdispecink_mapandtruck"],"type":"string"},"vendor_id":{"description":"ID of the vehicle in the telematics system","type":"string"}},"type":"object"},"vehicle_category":{"description":"Vehicle category","enum":["unknown","light","straight","straight_tipper","tipper","tipper_cereal","tipper_construction","refrigerated","isotherm","platform","curtainsider","box_body","trailer_truck","flatbed","low_flatbed","log","coil","container","vehicle","heavy_equipment","solid_tanker","petrol_tanker","chemical_tanker","food_tanker","livestock","special_convoy"],"maxLength":200,"type":"string"},"Tag":{"properties":{"pk":{"description":"The unique identifier of the tag","type":"integer"},"name":{"description":"The name of the tag","type":"string"},"color":{"description":"The color of the tag in hex format","type":"string"},"tag_group_id":{"description":"The ID of the tag group this tag belongs to, if any","nullable":true,"type":"integer"}},"required":["color","name","pk"],"type":"object"},"NewTrailer":{"properties":{"remote_id":{"description":"The ID of the trailer in your system.","type":"string"},"fleet_number":{"description":"Your trailer fleet number. It has to be unique among all your trailers. When filled, fleet number will be displayed in the web and mobile app next to license plate number. It can also be used for searches.","maxLength":10,"type":"string"},"license_plate":{"description":"License plate number (has to be unique)","maxLength":200,"type":"string"},"used_for_qualimat_transports":{"description":"True if the trailer can be used for Qualimat transport. This value is used to add a Qualimat logo next to the trailer in forms, in order to help the user selecting the trailer when creating a transport. The is no control on the value. You can create a Qualimat transport with a trailer that is not flagged for Qualimat. In this case a warning is displayed in the transport detail.","type":"boolean"},"tags":{"description":"List of tags applied to the trailer.","items":{"$ref":"#/components/schemas/Tag"},"type":"array"}},"type":"object"}}}}
```

## The tripResponse object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"tripResponse":{"properties":{"uid":{"description":"The trip identifier.","format":"uuid","type":"string"},"name":{"description":"The trip name.","type":"string"}},"type":"object"}}}}
```

## The deprecated\_invoiced\_price object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"deprecated_invoiced_price":{"deprecated":true,"description":"Invoiced price for the transport. Deprecated in favour of pricing field","format":"float","nullable":true,"type":"number"}}}}
```

## The CompanyPkOrRemoteId object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"CompanyPkOrRemoteId":{"description":"Identification of the company. The company must already exist in Dashdoc.","properties":{"pk":{"description":"Dashdoc's internal id. Optional, should not be sent if `remote_id` is sent.","type":"number"},"remote_id":{"description":"The ID of the company in your system. Optional, should not be sent if `pk` is sent.","type":"string"}},"type":"object"}}}}
```

## The CancelTransport object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"CancelTransport":{"properties":{"cancel_reason":{"type":"string"}},"type":"object"}}}}
```

## The TransportRevenueSplit object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"TransportRevenueSplit":{"properties":{"activity_to_split_revenue":{"additionalProperties":{"$ref":"#/components/schemas/TransportRevenueSplit_activity_to_split_revenue"},"description":"Mapping where the key is the uid of the first activity included in this split, and the value is the split's detail.","type":"object"}},"type":"object"},"TransportRevenueSplit_activity_to_split_revenue":{"properties":{"transport_repartition":{"description":"The share of the revenue of this split relative to the total revenue of the transport","type":"string"},"transport_revenue_share":{"description":"The revenue of this split","type":"string"},"subcontracting_repartition":{"description":"The cost of this split from out of the subcontracting cost","nullable":true,"type":"string"},"subcontracting_cost_share":{"description":"The share of the cost of this split relative to the total cost of the subcontracting cost","nullable":true,"type":"string"},"child_transport_uid":{"description":"The uid of the child transport, if this split is for a subcontracted transport","nullable":true,"type":"string"}},"type":"object"}}}}
```

## The UpdateTransportStatus object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"UpdateTransportStatus":{"properties":{"site":{"description":"Site uid","type":"string"},"category":{"description":"Activity performed","enum":["on_loading_site","loading_complete","on_unloading_site","unloading_complete","bulking_break_started","bulking_break_complete"],"type":"string"},"transport":{"description":"Transport uid","type":"string"},"created_device":{"$ref":"#/components/schemas/created_device"},"update_details":{"$ref":"#/components/schemas/UpdateTransportStatus_update_details"}},"required":["category","site","transport"],"type":"object"},"created_device":{"description":"Date of creation on device (ISO 8601)","format":"date-time","type":"string"},"UpdateTransportStatus_update_details":{"properties":{"loads":{"$ref":"#/components/schemas/UpdateTransportStatus_update_details_loads"}},"type":"object"},"UpdateTransportStatus_update_details_loads":{"description":"The delivery concerned","properties":{"replace_with_delivery_uid":{"description":"Replace the name of this attribut with the righ delivery uid","items":{"$ref":"#/components/schemas/NewDeliveryLoads"},"type":"array"}},"type":"object"},"NewDeliveryLoads":{"properties":{"remote_id":{"description":"The ID of the load in your system. It has to be unique among all your transports.","type":"string"},"description":{"description":"Text description of the load. In the case of a dangerous load, the description has to respect the ADR law.","type":"string"},"reference":{"description":"Reference of the load.","type":"string"},"weight":{"description":"In kilograms","format":"float","type":"number"},"volume":{"description":"Volume of load in m3","format":"float","type":"number"},"linear_meters":{"description":"Length of load in meters","format":"float","type":"number"},"quantity":{"description":"Only one decimal accepted (e.g 0.0)","format":"float","type":"number"},"pallet_equivalence":{"description":"Pallet equivalence (EPS/EQPAL): how many standard pallet spaces the load occupies. Minimum `0.01`, and only two decimals are kept — omit it or send `null` rather than 0 when unknown. When a load is created from the Dashdoc interface this defaults to `quantity` × the handling unit's pallet equivalence, and stays freely overridable.","format":"float","nullable":true,"type":"number"},"category":{"description":"Packaging of the load. The text is free but these specific values cause a custom flow on the mobile app: `pallets`, `containers`, `bulk`, `roundwood`, `powder_tank`, `bulk_qualimat`, `rental`.","type":"string"},"handling_unit_uid":{"description":"Existing handling unit UID from the load type catalog.","format":"uuid","type":"string"},"good_uid":{"description":"Existing good UID from the goods catalog.","format":"uuid","type":"string"},"create_handling_unit":{"$ref":"#/components/schemas/NewDeliveryLoads_create_handling_unit"},"create_good":{"$ref":"#/components/schemas/NewDeliveryLoads_create_good"},"dangerous_goods_category":{"deprecated":true,"description":"ADR class","enum":["1","2","3","4.1","4.2","4.3","5.1","5.2","6.1","6.2","7","8","9"],"type":"string"},"is_dangerous":{"default":false,"description":"Indicates whether the load is dangerous. If true, the trucker has to confirm adr un code and legal mentions at unloading.","type":"boolean"},"adr_un_code":{"description":"Only for dangerous load, the official UN code from the ADR law.","type":"string"},"legal_mentions":{"description":"Only for dangerous load, all mandatory legal mentions printed on documents.","type":"string"},"complementary_information":{"description":"Any information about the load that doesn't fit to the description field.","type":"string"},"container_number":{"type":"string"},"tare_weight":{"description":"In kilograms","format":"float","type":"number"},"container_seal_number":{"type":"string"},"refrigerated":{"description":"Indicates whether the load is refrigerated. If true, the trucker can fill in the temperature.","type":"boolean"},"temperature":{"type":"string"},"steres":{"format":"float","type":"number"},"idtf_number":{"description":"Must match an existing IDTF number","type":"string"},"use_identifiers":{"description":"if `true`, trucker is asked to scan barcode identifiers on load","type":"boolean"},"identifiers":{"description":"Only relevant if use_identifiers is set to `true`. List of expected barcode identifiers that the trucker should scan at loading and unloading. App controls that expected barcodes are actually scanned. If empty, the trucker will have to scan barcodes anyway, but there won't be any check. Feature has to be activated in your account by your Dashdoc projet manager.","items":{"type":"string"},"type":"array"},"identifiers_observations":{"description":"Observations explaining issues with identifier, such as missing or unexpected identifiers","type":"string"}},"type":"object"},"NewDeliveryLoads_create_handling_unit":{"description":"Create a handling unit in the catalog and use its UID for this load. If provided, it silently overrides `handling_unit_uid`.","nullable":true,"properties":{"name":{"type":"string"},"dashdoc_load_category":{"type":"string"},"remote_id":{"type":"string"}},"type":"object"},"NewDeliveryLoads_create_good":{"description":"Create a good in the catalog and use its UID for this load. If provided, it silently overrides `good_uid`.","nullable":true,"properties":{"name":{"type":"string"},"additional_information":{"type":"string"},"remote_id":{"type":"string"}},"type":"object"}}}}
```

## The Transport\_1 object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"Transport_1":{"properties":{"uid":{"description":"Dashdoc's internal id. It will be automatically generated by Dashdoc.","format":"uuid","type":"string"},"sequential_id":{"type":"number"},"created":{"description":"Date of creation on the server. Useful when the transport is created by mobile devices. If network connection is bad, the `created` date can be later than `created_device`","format":"date-time","type":"string"},"updated":{"description":"last update time","format":"date-time","type":"string"},"deleted":{"nullable":true,"type":"string"},"remote_id":{"description":"The ID of the transport in your system. It has to be unique among all your transports.","type":"string"},"carrier_address":{"$ref":"#/components/schemas/AddressForTransport"},"created_by":{"$ref":"#/components/schemas/Company"},"created_device":{"description":"If created from a mobile device, date of creation on the device.","format":"date-time","type":"string"},"creation_method":{"enum":["mobile_app","api","web_app"],"type":"string"},"is_order":{"type":"boolean"},"archived_by":{"items":{"type":"object"},"type":"array"},"invite_code":{"type":"string"},"deliveries":{"items":{"$ref":"#/components/schemas/DeliveryForTransport"},"type":"array"},"segments":{"items":{"$ref":"#/components/schemas/SegmentForTransport"},"type":"array"},"status":{"$ref":"#/components/schemas/Statuses"},"status_updates":{"description":"See https://developer.dashdoc.eu/docs/tutorials/retrieve-transport-tracking-data#get-status-updates-with-date-and-time. Some of the above fields may not be filled or returned depending on the update itself","items":{"$ref":"#/components/schemas/StatusUpdates"},"type":"array"},"has_observations":{"type":"boolean"},"messages":{"description":"See https://developer.dashdoc.eu/docs/tutorials/retrieve-transport-tracking-data#get-documents-and-photos-with-their-type","items":{"$ref":"#/components/schemas/TransportMessage_1"},"type":"array"},"requested_vehicle":{"$ref":"#/components/schemas/requested_vehicle"},"documents":{"description":"See https://developer.dashdoc.eu/docs/tutorials/retrieve-transport-tracking-data#get-documents-and-photos-with-their-type","items":{"$ref":"#/components/schemas/Document"},"type":"array"},"carrier_reference":{"description":"Text that will help the carrier operators manage the transports, e.g. transport number in his TMS. It should only be set by the carrier of the transport and the transport's creator can toggle a company-wide setting to only allow the carrier to set it.","type":"string"},"price":{"$ref":"#/components/schemas/deprecated_price"},"requires_washing":{"description":"Flag to enable the truck washing flow in the mobile app","type":"boolean"},"business_privacy":{"description":"Flag to enable 'business privacy' mode: no eCMR will be generated, and the trucker won't be prompted to share the transport link.","type":"boolean"},"is_multiple_compartments":{"description":"Flag to enable 'multiple compartments' mode: truckers will have to select in which compartments loads were loaded. It also generates a specific delivery document : loading_plan.","type":"boolean"},"loading_plan":{"description":"Uid of the loading plan created by the trucker. Contact us if you need to retrieve data from it","type":"string"},"customer_to_invoice":{"$ref":"#/components/schemas/customer_to_invoice"},"parent_transport":{"$ref":"#/components/schemas/Transport_parent_transport"},"invoice_number":{"nullable":true,"type":"string"},"invoiced_price":{"$ref":"#/components/schemas/deprecated_invoiced_price"},"volume_display_unit":{"enum":["m3","L"],"type":"string"},"rental_deliveries":{"description":"Array of transports executed by the trucker during the rental order. Implies that the current transport is a rental order. Inner objects have the same transport data structure.","items":{"$ref":"#/components/schemas/Transport_1"},"type":"array"},"billing-metrics":{"deprecated":true,"description":"Retired feature, will always be null.","nullable":true,"type":"string"},"shape":{"type":"string"},"instructions":{"$ref":"#/components/schemas/global_instructions"},"tags":{"description":"List of tags applied to the transport.","items":{"$ref":"#/components/schemas/Tag"},"type":"array"}},"type":"object"},"AddressForTransport":{"properties":{"pk":{"description":"Dashdoc's internal id.","type":"number"},"name":{"type":"string"},"address":{"type":"string"},"city":{"type":"string"},"postcode":{"type":"string"},"country":{"$ref":"#/components/schemas/country"},"latitude":{"$ref":"#/components/schemas/latitude"},"longitude":{"$ref":"#/components/schemas/longitude"},"radius":{"default":500,"description":"Radius around the GPS coordinates within which the address is located (in meters)","type":"integer"},"coords_validated":{"default":false,"description":"if `true`, when this address is used as a loading or unloading site, the mobile app displays an itinerary button to start GPS app with guidance to these coordinates","type":"boolean"},"is_demo":{"$ref":"#/components/schemas/is_demo"},"is_carrier":{"type":"boolean"},"is_shipper":{"type":"boolean"},"is_origin":{"$ref":"#/components/schemas/address_is_origin_and_is_destination"},"is_destination":{"$ref":"#/components/schemas/address_is_origin_and_is_destination"},"created_by":{"type":"number"},"created":{"$ref":"#/components/schemas/created"},"remote_id":{"description":"The id of the address in your system.","type":"string"},"company":{"$ref":"#/components/schemas/CompanyForTransportAddress"},"original":{"type":"number"}},"type":"object"},"country":{"description":"Only the 2-character codification is accepted (ISO 3166-1 alpha-2)","type":"string"},"latitude":{"description":"Latitude using the decimal GPS coordinates (WGS84). At 7 decimals, the position is accurate around the centimeter.","format":"float","nullable":true,"type":"number"},"longitude":{"description":"Longitude using the decimal GPS coordinates (WGS84). At 7 decimals, the position is accurate around the centimeter.","format":"float","nullable":true,"type":"number"},"is_demo":{"description":"Indicates that the address is a fake one created from demonstration. Everything linked to it will be deleted when using the 'Delete demo content' button in company parameters","type":"boolean"},"address_is_origin_and_is_destination":{"description":"Whether this address is a \"Logistic Points\" and will be usable as pickup/delivery point.\nThe distinction between origin/pickup and destination/delivery was merged as a single \"Logistic Point\" concept. `is_origin` implies `is_destination` and vice-versa.\n","type":"boolean"},"created":{"description":"Date of creation on our server","format":"date-time","type":"string"},"CompanyForTransportAddress":{"properties":{"pk":{"description":"Dashdoc's internal id.","type":"number"},"remote_id":{"description":"The id of the company in your system.","type":"string"},"name":{"type":"string"},"trade_number":{"type":"string"},"country":{"$ref":"#/components/schemas/country"},"settings_contract_html":{"description":"Ignore. Dashdoc technical data.","type":"string"},"settings_logo":{"description":"Ignore. Dashdoc technical data.","nullable":true,"type":"string"},"settings_stamp":{"description":"Ignore. Dashdoc technical data.","nullable":true,"type":"string"},"settings_print_mode":{"description":"Ignore. Dashdoc technical data.","type":"boolean"},"settings_special_agreements":{"description":"Ignore. Dashdoc technical data.","type":"string"},"settings_transport_order_observations":{"type":"string"},"settings_constrain_reference_edition":{"type":"boolean"},"vat_number":{"type":"string"},"is_verified":{"type":"boolean"}},"type":"object"},"Company":{"properties":{"pk":{"description":"Dashdoc's internal id.","type":"number"},"remote_id":{"type":"string"},"created":{"format":"date-time","type":"object"},"updated":{"format":"date-time","type":"string"},"deleted":{"type":"boolean"},"invoicing_remote_id":{"description":"The id of the company in your invoicing system.","type":"string"},"name":{"type":"string"},"phone_number":{"type":"string"},"email":{"type":"string"},"siren":{"type":"string"},"trade_number":{"type":"string"},"country":{"$ref":"#/components/schemas/country"},"comments":{"type":"string"},"vat_number":{"type":"string"},"is_verified":{"type":"boolean"},"settings_transport_order_observations":{"type":"string"},"settings_constrain_reference_edition":{"type":"boolean"},"account_type":{"description":"Ignore. Dashdoc technical data.","type":"string"},"logo":{"description":"The URL of your logo","nullable":true,"type":"string"},"subscription_access":{"type":"object"},"settings":{"type":"object"},"primary_address":{"$ref":"#/components/schemas/PrimaryAddress_1"},"managers":{"items":{"$ref":"#/components/schemas/Managers"},"type":"array"},"has_loggable_managers":{"description":"Ignore. Dashdoc technical data.","type":"boolean"}},"type":"object"},"PrimaryAddress_1":{"properties":{"pk":{"description":"Dashdoc's internal id.","type":"number"},"name":{"type":"string"},"address":{"type":"string"},"city":{"type":"string"},"postcode":{"type":"string"},"country":{"$ref":"#/components/schemas/country"},"latitude":{"$ref":"#/components/schemas/latitude"},"longitude":{"$ref":"#/components/schemas/longitude"},"radius":{"default":500,"description":"Radius around the GPS coordinates within which the address is located (in meters)","type":"integer"},"coords_validated":{"default":false,"description":"if `true`, when this address is used as a loading or unloading site, the mobile app displays an itinerary button to start GPS app with guidance to these coordinates","type":"boolean"},"is_demo":{"$ref":"#/components/schemas/is_demo"},"is_carrier":{"description":"Whether this company is considered a carrier","type":"boolean"},"is_shipper":{"description":"Whether this company is considered a shipper","type":"boolean"},"is_origin":{"description":"Legacy, not relevant for a company's primary address. Consider creating a separate address associated with this partner instead.\n","type":"boolean"},"is_destination":{"description":"Legacy, not relevant for a company's primary address. Consider creating a separate address associated with this partner instead.\n","type":"boolean"},"created_by":{"$ref":"#/components/schemas/created-by"},"created_by_user":{"$ref":"#/components/schemas/created-by-user"},"created":{"$ref":"#/components/schemas/created"},"remote_id":{"description":"The id of the address in your system.","type":"string"}},"type":"object"},"created-by":{"nullable":true,"properties":{"pk":{"description":"company id","type":"number"},"name":{"description":"name of the company","type":"string"}},"type":"object"},"created-by-user":{"nullable":true,"properties":{"pk":{"type":"number"},"display_name":{"type":"string"},"company":{"description":"The company id who created the address","type":"number"},"trucker_id":{"description":"The trucker id who created the address","type":"number"}},"type":"object"},"Managers":{"properties":{"pk":{"description":"Dashdoc's internal id.","type":"number"},"user":{"$ref":"#/components/schemas/Managers_user"},"display_name":{"type":"string"},"role":{"type":"string"}},"type":"object"},"Managers_user":{"properties":{"email":{"format":"email","type":"string"},"first_name":{"type":"string"},"last_name":{"type":"string"}},"type":"object"},"DeliveryForTransport":{"properties":{"uid":{"description":"Dashdoc's internal id.","type":"string"},"sequential_id":{"description":"eCMR number","type":"number"},"remote_id":{"description":"The id of the delivery in your system","type":"string"},"tracking_id":{"description":"Deprecated","type":"string"},"origin":{"$ref":"#/components/schemas/Site_1"},"destination":{"$ref":"#/components/schemas/Site_1"},"shipper_address":{"$ref":"#/components/schemas/AddressForDelivery"},"loads":{"description":"Loads as they are most recently defined. This means it is: \n\n* equal to `planned_loads` before loading is actually done \n\n* equal to `origin_loads` after loading is done (with details validated by trucker), but unloading is not done yet \n\n* equal to `destination_loads` after unloading is actually done (with details validated by trucker) \n\nSome fields may not be returned depending on how loads were created initially and updated during the transport.","items":{"$ref":"#/components/schemas/DeliveryLoads"},"type":"array"},"planned_loads":{"description":"Loads as planned before the transport has been started","items":{"$ref":"#/components/schemas/PlannedLoads"},"type":"array"},"origin_loads":{"description":"Loads as validated by trucker right after loading is done. \n\nSome fields may not be returned depending on how loads were created initially and updated during the transport.","items":{"$ref":"#/components/schemas/DeliveryLoads"},"type":"array"},"destination_loads":{"description":"Loads as validated by trucker right after unloading is done. \n\nSome fields may not be returned depending on how loads were created initially and updated during the transport.","items":{"$ref":"#/components/schemas/DeliveryLoads"},"type":"array"},"tracking_contacts":{"description":"List of contacts that will automatically receive email notifications during the transport.","items":{"$ref":"#/components/schemas/DeliveryForTransport_tracking_contacts"},"type":"array"},"shipper_reference":{"description":"Reference the client may use to match transport on his own system, e.g. an order number.","type":"string"},"multiple_rounds":{"description":"If `true`, the trucker will be able to do a signature at loading, then add any amount of rounds for the transport (with weight/volume and weight ticket), and finish with a signature at unloading.","type":"boolean"}},"type":"object"},"Site_1":{"properties":{"uid":{"description":"Dashdoc's internal id.","format":"uuid","type":"string"},"remote_id":{"description":"The id of the site in your system","type":"string"},"address":{"$ref":"#/components/schemas/AddressForDelivery"},"loading_instructions":{"$ref":"#/components/schemas/loading_instructions"},"unloading_instructions":{"$ref":"#/components/schemas/unloading_instructions"},"real_start":{"description":"date and time when trucker arrived on site","format":"date-time","type":"string"},"real_end":{"description":"date and time when trucker completed loading / unloading (depending whether site is origin or destination)","format":"date-time","type":"string"},"signature_process":{"description":"signature process that was chosen to sign loads on site","type":"string"},"instructions":{"$ref":"#/components/schemas/site_instructions"},"reference":{"type":"string"},"action":{"deprecated":true,"description":"Deprecated. Always returned as an empty string.","type":"string"},"eta":{"nullable":true,"type":"string"},"eta_tracking":{"$ref":"#/components/schemas/eta_tracking"},"punctuality_status":{"$ref":"#/components/schemas/punctuality_status"},"supports_exchanges":{"$ref":"#/components/schemas/SupportsExchange"},"category":{"type":"string"},"arrival_date":{"description":"expected arrival date","format":"date","type":"string"},"arrival_time_min":{"description":"expected arrival min time","type":"string"},"arrival_time_max":{"description":"expected arrival max time","type":"string"},"date_exact":{"description":"if `true`, `arrival_time_max` is considered as being on the following day from `arrival_date`","type":"boolean"},"trucker_instructions":{"$ref":"#/components/schemas/trucker_instructions"}},"type":"object"},"AddressForDelivery":{"properties":{"pk":{"description":"Dashdoc's internal id.","type":"number"},"name":{"type":"string"},"address":{"type":"string"},"city":{"type":"string"},"postcode":{"type":"string"},"country":{"$ref":"#/components/schemas/country"},"latitude":{"$ref":"#/components/schemas/latitude"},"longitude":{"$ref":"#/components/schemas/longitude"},"radius":{"default":500,"description":"Radius around the GPS coordinates within which the address is located (in meters)","type":"integer"},"coords_validated":{"default":false,"description":"if `true`, when this address is used as a loading or unloading site, the mobile app displays an itinerary button to start GPS app with guidance to these coordinates","type":"boolean"},"is_demo":{"$ref":"#/components/schemas/is_demo"},"is_carrier":{"type":"boolean"},"is_shipper":{"type":"boolean"},"is_origin":{"$ref":"#/components/schemas/address_is_origin_and_is_destination"},"is_destination":{"$ref":"#/components/schemas/address_is_origin_and_is_destination"},"created_by":{"description":"Ignore. Dashdoc technical data.","type":"number"},"created":{"$ref":"#/components/schemas/created"},"instructions":{"$ref":"#/components/schemas/site_instructions"},"remote_id":{"description":"The id of the address in your system.","type":"string"},"company":{"$ref":"#/components/schemas/Company"},"original":{"description":"Ignore. Dashdoc technical data.","type":"number"}},"type":"object"},"site_instructions":{"description":"Site instructions, visible to all parties (trucker, carrier, shipper, site). Displayed in the trucker mobile app. Not visible in the eCMR. If the field is not provided, the address's site instructions will be used.","maxLength":1000,"type":"string"},"loading_instructions":{"deprecated":true,"description":"**Prefer using the field `instructions`.** Loading instructions, visible to all parties (trucker, carrier, shipper, site). Displayed in the trucker mobile app. Not visible in the eCMR.","maxLength":1000,"type":"string"},"unloading_instructions":{"deprecated":true,"description":"**Prefer using the field `instructions`.** Unloading instructions, visible to all parties (trucker, carrier, shipper, site). Displayed in the trucker mobile app. Not visible in the eCMR.","maxLength":1000,"type":"string"},"eta_tracking":{"default":false,"description":"Ask for an ETA on this site. This is currently a beta feature, not activated by default.","type":"boolean"},"punctuality_status":{"default":"untracked","description":"Indicate the punctuality on this site.","enum":["untracked","probably_late","probably_on_time","late","on_time"],"type":"string"},"SupportsExchange":{"properties":{"uid":{"description":"uid of the support exchange","format":"uuid","type":"string"},"site":{"$ref":"#/components/schemas/SupportsExchange_site"},"support_type":{"$ref":"#/components/schemas/SupportType"},"expected_retrieved":{"description":"Expected number of supports that should be retrieved on the site","type":"number"},"actual_retrieved":{"description":"Actual number of supports that were retrieved on the site","type":"number"},"expected_delivered":{"description":"Expected number of supports that should be delivered on the site","type":"number"},"actual_delivered":{"description":"Actual number of supports that were delivered on the site","type":"number"},"observations":{"description":"Free text. Observations about this supports exchange. Can be filled on mobile app, web app or via API.","type":"string"},"remote_id":{"description":"The ID of the support in your system","type":"string"}},"type":"object"},"SupportsExchange_site":{"description":"site where supports exchange is expected","properties":{"uid":{"description":"uid of the site","format":"uuid","type":"string"},"remote_id":{"description":"remote_id of the site","type":"string"}},"type":"object"},"SupportType":{"description":"Type of the supports that are exchanged","properties":{"name":{"description":"Display name of the support type","type":"string"},"created":{"$ref":"#/components/schemas/created"},"uid":{"format":"uuid","type":"string"},"remote_id":{"description":"The id of the support type in your system.","type":"string"}},"type":"object"},"trucker_instructions":{"description":"**This field is part of a beta feature.** Private instructions. **The carrier of the transport is the only one who can edit and read those instructions.** Note that those instructions are not visible in the consignment note and can be accessed by the trucker. The value is null if the caller doesn't have the right of access to the data.","maxLength":1000,"type":"string"},"DeliveryLoads":{"properties":{"uid":{"description":"Dashdoc's internal id.","type":"string"},"remote_id":{"description":"The ID of the load in your system. It has to be unique among all your transports.","type":"string"},"description":{"description":"Text description of the load","type":"string"},"reference":{"description":"Reference of the load","type":"string"},"round_id":{"description":"The ID of the round.","format":"integer","type":"number"},"weight":{"description":"In kilograms","format":"float","type":"number"},"volume":{"description":"Volume of load in m3","format":"float","type":"number"},"volume_display_unit":{"default":"m3","enum":["m3","L"],"type":"string"},"linear_meters":{"description":"Length of load in meters","format":"float","type":"number"},"quantity":{"description":"Only one decimal accepted (e.g 0.0)","format":"float","type":"number"},"pallet_equivalence":{"description":"Pallet equivalence (EPS/EQPAL): how many standard pallet spaces the load occupies. `null` when it was never set. Otherwise at least `0.01`, with two decimals kept.","format":"float","nullable":true,"type":"number"},"category":{"description":"Packaging of the load. The text is free but these specific values cause a custom flow on the mobile app: `pallets`, `containers`, `bulk`, `roundwood`, `powder_tank`, `bulk_qualimat`, `rental`.","type":"string"},"dangerous_goods_category":{"description":"ADR class","enum":["1","2","3","4.1","4.2","4.3","5.1","5.2","6.1","6.2","7","8","9"],"type":"string"},"is_dangerous":{"type":"boolean"},"adr_un_code":{"type":"string"},"legal_mentions":{"type":"string"},"complementary_information":{"description":"Any information about the load that doesn't fit to the description field","type":"string"},"container_number":{"type":"string"},"tare_weight":{"description":"In kilograms","format":"float","type":"number"},"container_seal_number":{"type":"string"},"refrigerated":{"description":"Indicates whether the load is refrigerated. If true, the trucker can fill in the temperature.","type":"boolean"},"temperature":{"type":"string"},"steres":{"format":"float","type":"number"},"idtf_number":{"description":"Must match an existing IDTF number","type":"string"},"use_identifiers":{"description":"if `true`, trucker is asked to scan barcode identifiers on load","type":"boolean"},"identifiers":{"description":"Only relevant if use_identifiers is set to `true`. List of expected barcode identifiers that the trucker should scan at loading and unloading. App controls that expected barcodes are actually scanned. If empty, the trucker will have to scan barcodes anyway, but there won't be any check. Feature has to be activated in your account by your Dashdoc projet manager.","items":{"type":"string"},"type":"array"},"identifiers_observations":{"description":"Observations explaining issues with identifier, such as missing or unexpected identifiers","type":"string"}},"type":"object"},"PlannedLoads":{"properties":{"uid":{"description":"Dashdoc's internal id.","type":"string"},"remote_id":{"description":"The ID of the load in your system. It has to be unique among all your transports.","type":"string"},"description":{"description":"Text description of the load","type":"string"},"reference":{"description":"Reference of the load","type":"string"},"weight":{"description":"In kilograms","format":"float","type":"number"},"volume":{"description":"Volume of load in m3","format":"float","type":"number"},"volume_display_unit":{"default":"m3","enum":["m3","L"],"type":"string"},"linear_meters":{"description":"Length of load in meters","format":"float","type":"number"},"quantity":{"description":"Only one decimal accepted (e.g 0.0)","format":"float","type":"number"},"pallet_equivalence":{"description":"Pallet equivalence (EPS/EQPAL): how many standard pallet spaces the load occupies. `null` when it was never set. Otherwise at least `0.01`, with two decimals kept.","format":"float","nullable":true,"type":"number"},"category":{"description":"Packaging of the load. The text is free but these specific values cause a custom flow on the mobile app: `pallets`, `containers`, `bulk`, `roundwood`, `powder_tank`, `bulk_qualimat`, `rental`.","type":"string"},"dangerous_goods_category":{"description":"ADR class","enum":["1","2","3","4.1","4.2","4.3","5.1","5.2","6.1","6.2","7","8","9"],"type":"string"},"is_dangerous":{"type":"boolean"},"adr_un_code":{"type":"string"},"legal_mentions":{"type":"string"},"complementary_information":{"description":"Any information about the load that doesn't fit to the description field","type":"string"},"container_number":{"type":"string"},"tare_weight":{"description":"In kilograms","format":"float","type":"number"},"container_seal_number":{"type":"string"},"refrigerated":{"description":"Indicates whether the load is refrigerated. If true, the trucker can fill in the temperature.","type":"boolean"},"temperature":{"type":"string"},"steres":{"format":"float","type":"number"},"idtf_number":{"description":"Must match an existing IDTF number","type":"string"},"use_identifiers":{"description":"if `true`, trucker is asked to scan barcode identifiers on load","type":"boolean"},"identifiers":{"description":"Only relevant if use_identifiers is set to `true`. List of expected barcode identifiers that the trucker should scan at loading and unloading. App controls that expected barcodes are actually scanned. If empty, the trucker will have to scan barcodes anyway, but there won't be any check. Feature has to be activated in your account by your Dashdoc projet manager.","type":"string"},"identifiers_observations":{"description":"Observations explaining issues with identifier, such as missing or unexpected identifiers","type":"string"}},"type":"object"},"DeliveryForTransport_tracking_contacts":{"properties":{"uid":{"description":"Dashdoc's internal id.","type":"string"},"contact":{"$ref":"#/components/schemas/TrackingContact"},"subscribed_to_status_updates":{"description":"If set to `true`, the contact will receive an email at every step of the delivery. Else, they will receive only one email once the delivery is done.","type":"boolean"}},"type":"object"},"TrackingContact":{"properties":{"uid":{"format":"uuid","type":"string"},"created":{"$ref":"#/components/schemas/created"},"company":{"$ref":"#/components/schemas/Company"},"first_name":{"type":"string"},"last_name":{"type":"string"},"email":{"format":"email","type":"string"},"phone_number":{"type":"string"},"fax_number":{"type":"string"},"remote_id":{"description":"The id of the contact in your system","type":"string"}},"type":"object"},"SegmentForTransport":{"description":"","properties":{"uid":{"minLength":1,"type":"string"},"remote_id":{"minLength":1,"type":"string"},"trucker":{"$ref":"#/components/schemas/SegmentTrucker"},"origin":{"$ref":"#/components/schemas/Site_1"},"destination":{"$ref":"#/components/schemas/Site_1"},"vehicle":{"$ref":"#/components/schemas/Vehicle"},"trailers":{"items":{"$ref":"#/components/schemas/Trailer"},"type":"array"},"sort_order":{"description":"The index of the segment in the transport","minimum":0,"type":"number"},"scheduled_start":{"description":"The datetime at which the carrier scheduled the start of this segment\n","type":"string"},"scheduled_end":{"description":"The datetime at which the carrier scheduled the end of this segment","type":"string"},"child_transport":{"$ref":"#/components/schemas/Segment_child_transport"},"distance":{"description":"Manually entered distance. If null, it takes the value of telematic_distance (in kms).","type":"integer"},"telematic_distance":{"description":"Automatically computed distance from telematic data (in kms).","type":"integer"},"origin_mileage":{"description":"Mileage at transport origin site (in kms).","type":"integer"},"destination_mileage":{"description":"Mileage at transport destination site (in kms).","type":"integer"}},"type":"object"},"SegmentTrucker":{"properties":{"pk":{"description":"Dashdoc's internal id.","type":"number"},"remote_id":{"description":"The ID of the trucker in your system. It has to be unique among all your truckers.","type":"string"},"display_name":{"type":"string"},"user":{"$ref":"#/components/schemas/SegmentTruckerUser"}},"type":"object"},"SegmentTruckerUser":{"properties":{"pk":{"description":"Dashdoc's internal id.","type":"number"},"first_name":{"type":"string"},"last_name":{"type":"string"},"username":{"description":"Ignore. Dashdoc technical data.","type":"string"},"email":{"format":"email","type":"string"},"display_name":{"description":"Display name generated by Dashdoc.","type":"string"},"date_joined":{"description":"Ignore. Dashdoc technical data.","format":"date-time","type":"string"},"is_staff":{"description":"Ignore. Dashdoc technical data.","type":"boolean"},"is_superuser":{"description":"Ignore. Dashdoc technical data.","type":"boolean"},"has_usable_password":{"description":"Ignore. Dashdoc technical data.","type":"boolean"}},"type":"object"},"Vehicle":{"properties":{"pk":{"description":"Dashdoc's internal id","type":"number"},"carrier":{"description":"Dashdoc's internal id of the carrier owning the vehicle","type":"number"},"category":{"description":"Vehicle category","type":"string"},"license_plate":{"description":"License plate number","type":"string"},"fleet_number":{"description":"Your vehicle fleet number","type":"string"},"remote_id":{"description":"The ID of the vehicle in your system","type":"string"},"created":{"description":"Date of creation on our server","format":"date-time","type":"string"},"used_for_qualimat_transports":{"description":"True if the vehicle can be used for Qualimat transport (only used for visual help and warnings)","type":"boolean"},"telematic_vehicle":{"description":"Ignore. Dashdoc technical data","type":"number"},"original":{"type":"number"},"tags":{"description":"List of tags applied to the vehicle.","items":{"$ref":"#/components/schemas/Tag"},"type":"array"},"technical_control_deadline":{"format":"date-time","type":"string"},"tachograph_deadline":{"format":"date-time","type":"string"},"speed_limiter_deadline":{"format":"date-time","type":"string"},"country":{"$ref":"#/components/schemas/country"},"unavailability":{"description":"List of unavailable period","items":{"$ref":"#/components/schemas/Unavailability"},"type":"array"},"events":{"description":"Ignore. Dashdoc technical data.","items":{"type":"object"},"type":"array"}},"type":"object"},"Tag":{"properties":{"pk":{"description":"The unique identifier of the tag","type":"integer"},"name":{"description":"The name of the tag","type":"string"},"color":{"description":"The color of the tag in hex format","type":"string"},"tag_group_id":{"description":"The ID of the tag group this tag belongs to, if any","nullable":true,"type":"integer"}},"required":["color","name","pk"],"type":"object"},"Unavailability":{"properties":{"id":{"description":"Dashdoc's internal id","type":"number"},"remote_id":{"description":"The ID of the unavailability in your system","type":"string"},"created":{"description":"Date of creation on our server","format":"date-time","type":"string"},"start_date":{"description":"Start date of the unavailability","format":"date-time","type":"string"},"end_date":{"description":"End date of the unavailability","format":"date-time","type":"string"},"unavailability_type":{"description":"Type of unavailability","enum":["paid_vacation","day_off","sick_leave","training","vacation","maintenance","rental","other"],"type":"string"},"unavailability_note":{"description":"Notes about the unavailability","type":"string"}},"type":"object"},"Trailer":{"properties":{"pk":{"description":"Dashdoc's internal id","type":"number"},"original":{"description":"Ignore. Dashdoc technical data","type":"number"},"carrier":{"description":"Dashdoc's internal id of the carrier owning the trailer","type":"number"},"license_plate":{"description":"License plate number","type":"string"},"fleet_number":{"description":"Your trailer fleet number","type":"string"},"remote_id":{"description":"The ID of the trailer in your system","type":"string"},"created":{"description":"Date of creation on our server","format":"date-time","type":"string"},"used_for_qualimat_transports":{"description":"True if the trailer can be used for Qualimat transport (only used for visual help and warnings)","type":"boolean"},"tags":{"description":"List of tags applied to the trailer.","items":{"$ref":"#/components/schemas/Tag"},"type":"array"},"technical_control_deadline":{"format":"date-time","type":"string"},"country":{"$ref":"#/components/schemas/country"},"unavailability":{"description":"List of unavailable period","items":{"$ref":"#/components/schemas/Unavailability"},"type":"array"},"events":{"description":"Ignore. Dashdoc technical data.","items":{"type":"object"},"type":"array"}},"type":"object"},"Segment_child_transport":{"description":"If the segment is chartered, will contain the child transport","properties":{"uid":{"format":"uuid","type":"string"},"sequential_id":{"type":"number"},"remote_id":{"type":"string"},"has_strong_link":{"type":"boolean"}},"type":"object"},"Statuses":{"enum":["created","updated","confirmed","declined","verified","invoiced","paid","cancelled","assigned","sent_to_trucker","acknowledged","truck_wash","on_loading_site","loading_complete","on_unloading_site","unloading_complete","bulking_break_started","bulking_break_complete","rounds_started","round_added","round_added_v2","round_edited","round_deleted","rounds_complete","event","checklist_filled","activity_complete","on_the_way","handling_started","done"],"type":"string"},"StatusUpdates":{"properties":{"uid":{"format":"uuid","type":"string"},"created":{"description":"Date of creation on the server. Useful when the transport is created by mobile devices. If network connection is bad, the `created` date can be later than `created_device`","format":"date-time","type":"string"},"created_device":{"description":"If created from a mobile device, date of creation on the device.","format":"date-time","type":"string"},"creation_method":{"type":"string"},"category":{"description":"event that occured on the transport","type":"string"},"author":{"description":"details about author of the update. Contact Dashdoc if more details is needed.","type":"object"},"content":{"description":"Contact Dashdoc if more details is needed.","type":"object"},"content_signatory":{"description":"Contact Dashdoc if more details is needed.","type":"object"},"target":{"description":"Contact Dashdoc if more details is needed.","type":"object"},"site":{"description":"Contact Dashdoc if more details is needed.","type":"object"},"site_id":{"description":"Contact Dashdoc if more details is needed.","format":"uuid","type":"string"},"delivery":{"description":"Contact Dashdoc if more details is needed.","format":"uuid","type":"string"},"segment":{"description":"Contact Dashdoc if more details is needed.","format":"uuid","type":"string"},"transport":{"description":"Contact Dashdoc if more details is needed.","format":"uuid","type":"string"},"holder_exchanges":{"description":"Contact Dashdoc if more details is needed.","type":"object"},"signature":{"description":"Contact Dashdoc if more details is needed.","type":"object"},"latitude":{"description":"Contact Dashdoc if more details is needed.","format":"float","type":"number"},"longitude":{"description":"Contact Dashdoc if more details is needed.","format":"float","type":"number"},"update_details":{"description":"Contact Dashdoc if more details is needed.","type":"object"}},"type":"object"},"TransportMessage_1":{"properties":{"uid":{"format":"uuid","type":"string"},"created":{"$ref":"#/components/schemas/created"},"created_device":{"format":"date-time","type":"string"},"creation_method":{"type":"string"},"author":{"$ref":"#/components/schemas/NewTransportMessage_author"},"type":{"enum":["note","load_verification","share","document","photo"],"maxLength":100,"type":"string"},"document_title":{"description":"Filename or if uploaded by a trucker from the mobile app, the document title is generic, for instance `photo`.","maxLength":100,"type":"string"},"document_type":{"enum":["load_photo","cmr","washing_note","delivery_note","confirmation","weight_note","waste_manifest","holders_swap_note","invoice"],"maxLength":100,"type":"string"},"document":{"description":"URL of the stored document. You can download the document from this URL.","type":"string"},"is_attached_to_cmr":{"type":"boolean"},"transport":{"format":"uuid","type":"string"},"site":{"description":"This field is used for the default values of the field readable_by_company_ids; if null, companies from all Sites of the transport are listed in readable_by_company_ids, otherwise only the company of this Site. Site must exist in this transport. This field is part of a beta feature.","format":"uuid","nullable":true,"type":"string"},"site_remote_id":{"type":"string"},"readable_by_company_ids":{"description":"A list containing the pk of each company allowed to access the document, every company must be part of the transport. If no values are sent, it will be computed with default values; Carrier, Shipper, Invoiced Customer and Site's pk (see Site field). Once values have been sent, the behavior adding default companies is deactivated. The author company is always added. Only pks of companies from the transport will be added, others will be ignored. This field is part of a beta feature.","items":{"type":"integer"},"type":"array"},"message":{"description":"message displayed in the activity thread of a transport in the web app and in the mobile app","type":"string"},"latitude":{"$ref":"#/components/schemas/latitude"},"longitude":{"$ref":"#/components/schemas/longitude"},"reference":{"description":"Free text. This reference is searchable in the transports dashboard. Filled by trucker if document is added from mobile app, by user if document is added from web app, or filled by API request.","maxLength":140,"type":"string"},"visible_by_everyone":{"$ref":"#/components/schemas/visible_by_everyone"},"readable_by_trucker":{"$ref":"#/components/schemas/readable_by_trucker"},"delivery":{"type":"string"},"extracted_reference":{"description":"Reference extracted by AI from the document. AI runs only on weight notes, so it will be null for other documents. \"\" if no reference has been found by the AI.","type":"string"}},"type":"object"},"NewTransportMessage_author":{"properties":{"display_name":{"type":"string"},"company":{"type":"number"},"pk":{"description":"Dashdoc's internal id.","type":"number"}},"type":"object"},"visible_by_everyone":{"description":"This field is used to make the transport message public, which makes it visible by all parties of the transport.","type":"boolean"},"readable_by_trucker":{"description":"This field is used to allow truckers to see the transport message. **Only available for carriers.**","type":"boolean"},"requested_vehicle":{"description":"Only useful when the transport is created by the shipper. Free text except punction and special characters.","maxLength":40,"type":"string"},"Document":{"properties":{"pk":{"type":"integer"},"file_updated_date":{"description":"Date was updated on the server.","format":"date-time","type":"string"},"delivery":{"description":"Contact Dashdoc if more details are needed.","format":"uuid","type":"string"},"delivery_sequential_id":{"description":"eCMR number (for category \"cmr\" and \"ldv\")","type":"integer"},"reference":{"type":"integer"},"category":{"description":"Type of document. Possible values are \"cmr\", \"cmr4\", \"ldv\", \"orc\", \"chc\", \"rental\" and \"loading_plan\"","type":"string"},"languages":{"description":"Languages displayed in the document (CMR only), formatted as an 2-letter ISO 639-1 language code","items":{"type":"string"},"type":"array"},"name":{"description":"generic name of the document","type":"string"},"file":{"description":"path to the document","format":"url","type":"string"},"business_privacy_scope":{"description":"Ignore. Dashdoc technical data.","type":"boolean"},"cancelled":{"description":"Date of cancellation of the the document","format":"date-time","type":"string"}},"type":"object"},"deprecated_price":{"deprecated":true,"description":"Full price for the transport","format":"float","nullable":true,"type":"number"},"customer_to_invoice":{"properties":{"pk":{"description":"Dashdoc's internal id.","type":"number"},"name":{"type":"string"},"invoicing_address":{"$ref":"#/components/schemas/customer_to_invoice_invoicing_address"}},"type":"object"},"customer_to_invoice_invoicing_address":{"properties":{"address":{"type":"string"},"city":{"type":"string"},"postcode":{"type":"string"},"country":{"$ref":"#/components/schemas/country"}},"type":"object"},"Transport_parent_transport":{"description":"if this is a chartered transport, this will contains the parent transport it is chartered from","properties":{"uid":{"format":"uuid","type":"string"},"sequential_id":{"type":"number"},"remote_id":{"type":"string"},"has_strong_link":{"type":"boolean"}},"type":"object"},"deprecated_invoiced_price":{"deprecated":true,"description":"Invoiced price for the transport. Deprecated in favour of pricing field","format":"float","nullable":true,"type":"number"},"global_instructions":{"description":"Operating instructions. The carrier, the shipper and the creator of the transport have access to those instructions. However, the creator is the only who has the right to edit.","maxLength":1000,"type":"string"}}}}
```

## The PriceLine object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"PriceLine":{"properties":{"description":{"description":"Description of the line","type":"string"},"quantity":{"type":"number"},"unit_price":{"type":"number"},"price":{"type":"number"},"currency":{"type":"string"},"invoice_item":{"$ref":"#/components/schemas/InvoiceItem"},"metric":{"description":"Metric of the price line","enum":["FLAT","DISTANCE_IN_KM","DURATION_IN_MINUTE","DURATION_IN_HOUR","LOADED_WEIGHT_IN_KG","LOADED_WEIGHT_IN_TONNE","LOADED_VOLUME_IN_LITRE","LOADED_VOLUME_IN_M3","LOADED_QUANTITY","LOADED_LINEAR_METERS","UNLOADED_WEIGHT_IN_KG","UNLOADED_WEIGHT_IN_TONNE","UNLOADED_VOLUME_IN_LITRE","UNLOADED_VOLUME_IN_M3","UNLOADED_QUANTITY","UNLOADED_LINEAR_METERS","NB_DELIVERIES","NB_ROUNDS"],"type":"string"}},"type":"object"},"InvoiceItem":{"properties":{"uid":{"format":"uuid","type":"string"},"remote_id":{"description":"The id of the invoice item in your system","type":"string"},"description":{"description":"Default description when a user selects this invoice item for an invoice line","type":"string"}},"type":"object"}}}}
```

## The AddLoadsConstraints object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"AddLoadsConstraints":{"properties":{"metrics":{"items":{"description":"Metric you want the trucker to be forced to enter.","enum":["loaded_weight","unloaded_weight","loaded_volume","unloaded_volume","loaded_quantity","unloaded_quantity","loaded_linear_meters","unloaded_linear_meters"],"type":"string"},"type":"array"}},"type":"object"}}}}
```

## The TransportLoadsConstraints object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"TransportLoadsConstraints":{"properties":{"metrics":{"description":"Metrics the trucker will be forced to enter.","items":{"enum":["loaded_weight","unloaded_weight","loaded_volume","unloaded_volume","loaded_quantity","unloaded_quantity","loaded_linear_meters","unloaded_linear_meters"],"type":"string"},"type":"array"}},"type":"object"}}}}
```

## The AddTagsToTransport object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"AddTagsToTransport":{"description":"List of tags to add to the transport. Each item references a tag either by its `pk` (an existing tag) or by its `name`. When a tag is referenced by `name` and no tag with that name exists yet, it is created on the fly (get-or-create). The optional `color`, `tag_group_id` and `tag_group_name` fields are only used when creating a new tag; they are ignored when the tag is matched by `pk` or by an already existing `name`.\n","items":{"anyOf":[{"required":["pk"],"type":"object"},{"required":["name"],"type":"object"}],"properties":{"pk":{"description":"The primary key of an existing tag to add. Takes precedence over `name` when both are provided.\n","type":"integer"},"name":{"description":"The name of the tag to add. If no tag with this name exists, it is created (get-or-create).\n","type":"string"},"color":{"description":"Color of the tag in hex format. Only used when creating a new tag; ignored if the tag already exists.\n","type":"string"},"tag_group_id":{"description":"ID of the tag group the new tag should belong to. Only used when creating a new tag; ignored if the tag already exists.\n","nullable":true,"type":"integer"},"tag_group_name":{"description":"Name of the tag group. Only used when adding a tag by `name`: the group is created if it does not exist yet and the tag is assigned to it. If a tag with this name already exists in another group, it is moved to this group.\n","type":"string"}},"type":"object"},"type":"array"}}}}
```

## The Tag object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"Tag":{"properties":{"pk":{"description":"The unique identifier of the tag","type":"integer"},"name":{"description":"The name of the tag","type":"string"},"color":{"description":"The color of the tag in hex format","type":"string"},"tag_group_id":{"description":"The ID of the tag group this tag belongs to, if any","nullable":true,"type":"integer"}},"required":["color","name","pk"],"type":"object"}}}}
```

## The TransportTemplates object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"TransportTemplates":{"properties":{"count":{"type":"integer"},"next":{"nullable":true,"type":"string"},"previous":{"nullable":true,"type":"string"},"results":{"items":{"$ref":"#/components/schemas/TransportTemplate"},"type":"array"}},"type":"object"},"TransportTemplate":{"allOf":[{"$ref":"#/components/schemas/Transport"},{"$ref":"#/components/schemas/TransportTemplate_allOf"}]},"Transport":{"properties":{"uid":{"description":"Dashdoc's internal id. It will be automatically generated by us.","format":"uuid","type":"string"},"sequential_id":{"type":"number"},"created":{"description":"Date of creation sent by the creator. Useful when the transport is created by mobile devices. If network connection is bad, the `created` date can be later than `created_device`","format":"date-time","type":"string"},"updated":{"format":"date-time","type":"string"},"deleted":{"nullable":true,"type":"string"},"remote_id":{"description":"Your transport id. It has to be unique among all your transports","type":"string"},"carrier_address":{"$ref":"#/components/schemas/AddressForTransport"},"created_by":{"$ref":"#/components/schemas/Company"},"created_device":{"format":"date-time","type":"string"},"creation_method":{"enum":["mobile_app","api","web_app"],"type":"string"},"archived_by":{"items":{"type":"object"},"type":"array"},"is_order":{"type":"boolean"},"carrier_assignation_status":{"allOf":[{"$ref":"#/components/schemas/CarrierAssignationStatus"}],"nullable":true},"invite_code":{"type":"string"},"deliveries":{"items":{"$ref":"#/components/schemas/Delivery"},"type":"array"},"segments":{"items":{"$ref":"#/components/schemas/Segment"},"type":"array"},"status":{"$ref":"#/components/schemas/Statuses"},"status_updates":{"items":{"$ref":"#/components/schemas/Status"},"type":"array"},"has_observations":{"type":"boolean"},"messages":{"items":{"$ref":"#/components/schemas/TransportMessage"},"type":"array"},"requested_vehicle":{"$ref":"#/components/schemas/requested_vehicle"},"documents":{"items":{"$ref":"#/components/schemas/Document"},"type":"array"},"carrier_reference":{"description":"Text that will help the carrier operators manage the transports, e.g. transport number in his TMS. It should only be set by the carrier of the transport and the transport's creator can toggle a company-wide setting to only allow the carrier to set it.","type":"string"},"price":{"$ref":"#/components/schemas/deprecated_price"},"requires_washing":{"description":"Flag to enable the truck washing flow in the mobile app","type":"boolean"},"business_privacy":{"description":"Flag to enable 'business privacy' mode: no eCMR will be generated, and the trucker won't be prompted to share the transport link.","type":"boolean"},"is_multiple_compartments":{"description":"Flag to enable 'multiple compartments' mode: truckers will have to select in which compartments loads were loaded. It also generates a specific delivery document : loading_plan.","type":"boolean"},"loading_plan":{"description":"Uid of the loading plan created by the trucker. Contact us if you need to retrieve data from it","type":"string"},"customer_to_invoice":{"$ref":"#/components/schemas/customer_to_invoice"},"parent_transport":{"$ref":"#/components/schemas/Transport_parent_transport"},"invoice_number":{"nullable":true,"type":"string"},"invoiced_price":{"$ref":"#/components/schemas/deprecated_invoiced_price"},"volume_display_unit":{"enum":["m3","L"],"type":"string"},"references":{"items":{"$ref":"#/components/schemas/Transport_references"},"type":"array"},"rental_deliveries":{"description":"Array of transports executed by the trucker during the rental order. Implies that the current transport is a rental order. Inner objects have the same transport data structure.","items":{"$ref":"#/components/schemas/Transport"},"type":"array"},"billing-metrics":{"deprecated":true,"description":"Retired feature, will always be null.","nullable":true,"type":"string"},"shape":{"type":"string"},"instructions":{"$ref":"#/components/schemas/global_instructions"},"carbon_footprint":{"description":"Carbon footprint of the transport in kgCO2","nullable":true,"readOnly":true,"type":"number"},"tags":{"description":"List of tags applied to the transport.","items":{"$ref":"#/components/schemas/Tag"},"type":"array"}},"required":["business_privacy","carrier_address","carrier_reference","created","created_by","created_device","creation_method","deliveries","documents","has_observations","invite_code","invoice_number","is_order","messages","price","references","remote_id","requested_vehicle","requires_washing","segments","sequential_id","status","status_updates","uid","updated"],"type":"object"},"AddressForTransport":{"properties":{"pk":{"description":"Dashdoc's internal id.","type":"number"},"name":{"type":"string"},"address":{"type":"string"},"city":{"type":"string"},"postcode":{"type":"string"},"country":{"$ref":"#/components/schemas/country"},"latitude":{"$ref":"#/components/schemas/latitude"},"longitude":{"$ref":"#/components/schemas/longitude"},"radius":{"default":500,"description":"Radius around the GPS coordinates within which the address is located (in meters)","type":"integer"},"coords_validated":{"default":false,"description":"if `true`, when this address is used as a loading or unloading site, the mobile app displays an itinerary button to start GPS app with guidance to these coordinates","type":"boolean"},"is_demo":{"$ref":"#/components/schemas/is_demo"},"is_carrier":{"type":"boolean"},"is_shipper":{"type":"boolean"},"is_origin":{"$ref":"#/components/schemas/address_is_origin_and_is_destination"},"is_destination":{"$ref":"#/components/schemas/address_is_origin_and_is_destination"},"created_by":{"type":"number"},"created":{"$ref":"#/components/schemas/created"},"remote_id":{"description":"The id of the address in your system.","type":"string"},"company":{"$ref":"#/components/schemas/CompanyForTransportAddress"},"original":{"type":"number"}},"type":"object"},"country":{"description":"Only the 2-character codification is accepted (ISO 3166-1 alpha-2)","type":"string"},"latitude":{"description":"Latitude using the decimal GPS coordinates (WGS84). At 7 decimals, the position is accurate around the centimeter.","format":"float","nullable":true,"type":"number"},"longitude":{"description":"Longitude using the decimal GPS coordinates (WGS84). At 7 decimals, the position is accurate around the centimeter.","format":"float","nullable":true,"type":"number"},"is_demo":{"description":"Indicates that the address is a fake one created from demonstration. Everything linked to it will be deleted when using the 'Delete demo content' button in company parameters","type":"boolean"},"address_is_origin_and_is_destination":{"description":"Whether this address is a \"Logistic Points\" and will be usable as pickup/delivery point.\nThe distinction between origin/pickup and destination/delivery was merged as a single \"Logistic Point\" concept. `is_origin` implies `is_destination` and vice-versa.\n","type":"boolean"},"created":{"description":"Date of creation on our server","format":"date-time","type":"string"},"CompanyForTransportAddress":{"properties":{"pk":{"description":"Dashdoc's internal id.","type":"number"},"remote_id":{"description":"The id of the company in your system.","type":"string"},"name":{"type":"string"},"trade_number":{"type":"string"},"country":{"$ref":"#/components/schemas/country"},"settings_contract_html":{"description":"Ignore. Dashdoc technical data.","type":"string"},"settings_logo":{"description":"Ignore. Dashdoc technical data.","nullable":true,"type":"string"},"settings_stamp":{"description":"Ignore. Dashdoc technical data.","nullable":true,"type":"string"},"settings_print_mode":{"description":"Ignore. Dashdoc technical data.","type":"boolean"},"settings_special_agreements":{"description":"Ignore. Dashdoc technical data.","type":"string"},"settings_transport_order_observations":{"type":"string"},"settings_constrain_reference_edition":{"type":"boolean"},"vat_number":{"type":"string"},"is_verified":{"type":"boolean"}},"type":"object"},"Company":{"properties":{"pk":{"description":"Dashdoc's internal id.","type":"number"},"remote_id":{"type":"string"},"created":{"format":"date-time","type":"object"},"updated":{"format":"date-time","type":"string"},"deleted":{"type":"boolean"},"invoicing_remote_id":{"description":"The id of the company in your invoicing system.","type":"string"},"name":{"type":"string"},"phone_number":{"type":"string"},"email":{"type":"string"},"siren":{"type":"string"},"trade_number":{"type":"string"},"country":{"$ref":"#/components/schemas/country"},"comments":{"type":"string"},"vat_number":{"type":"string"},"is_verified":{"type":"boolean"},"settings_transport_order_observations":{"type":"string"},"settings_constrain_reference_edition":{"type":"boolean"},"account_type":{"description":"Ignore. Dashdoc technical data.","type":"string"},"logo":{"description":"The URL of your logo","nullable":true,"type":"string"},"subscription_access":{"type":"object"},"settings":{"type":"object"},"primary_address":{"$ref":"#/components/schemas/PrimaryAddress_1"},"managers":{"items":{"$ref":"#/components/schemas/Managers"},"type":"array"},"has_loggable_managers":{"description":"Ignore. Dashdoc technical data.","type":"boolean"}},"type":"object"},"PrimaryAddress_1":{"properties":{"pk":{"description":"Dashdoc's internal id.","type":"number"},"name":{"type":"string"},"address":{"type":"string"},"city":{"type":"string"},"postcode":{"type":"string"},"country":{"$ref":"#/components/schemas/country"},"latitude":{"$ref":"#/components/schemas/latitude"},"longitude":{"$ref":"#/components/schemas/longitude"},"radius":{"default":500,"description":"Radius around the GPS coordinates within which the address is located (in meters)","type":"integer"},"coords_validated":{"default":false,"description":"if `true`, when this address is used as a loading or unloading site, the mobile app displays an itinerary button to start GPS app with guidance to these coordinates","type":"boolean"},"is_demo":{"$ref":"#/components/schemas/is_demo"},"is_carrier":{"description":"Whether this company is considered a carrier","type":"boolean"},"is_shipper":{"description":"Whether this company is considered a shipper","type":"boolean"},"is_origin":{"description":"Legacy, not relevant for a company's primary address. Consider creating a separate address associated with this partner instead.\n","type":"boolean"},"is_destination":{"description":"Legacy, not relevant for a company's primary address. Consider creating a separate address associated with this partner instead.\n","type":"boolean"},"created_by":{"$ref":"#/components/schemas/created-by"},"created_by_user":{"$ref":"#/components/schemas/created-by-user"},"created":{"$ref":"#/components/schemas/created"},"remote_id":{"description":"The id of the address in your system.","type":"string"}},"type":"object"},"created-by":{"nullable":true,"properties":{"pk":{"description":"company id","type":"number"},"name":{"description":"name of the company","type":"string"}},"type":"object"},"created-by-user":{"nullable":true,"properties":{"pk":{"type":"number"},"display_name":{"type":"string"},"company":{"description":"The company id who created the address","type":"number"},"trucker_id":{"description":"The trucker id who created the address","type":"number"}},"type":"object"},"Managers":{"properties":{"pk":{"description":"Dashdoc's internal id.","type":"number"},"user":{"$ref":"#/components/schemas/Managers_user"},"display_name":{"type":"string"},"role":{"type":"string"}},"type":"object"},"Managers_user":{"properties":{"email":{"format":"email","type":"string"},"first_name":{"type":"string"},"last_name":{"type":"string"}},"type":"object"},"CarrierAssignationStatus":{"description":"Carrier assignment state of an order (Only for chartered transport). Null values should be treated as unassigned.","enum":["unassigned","draft_assigned","assigned"],"type":"string"},"Delivery":{"properties":{"uid":{"description":"Dashdoc's internal id.","type":"string"},"sequential_id":{"description":"eCMR number","type":"number"},"remote_id":{"type":"string"},"tracking_id":{"description":"Deprecated","type":"string"},"origin":{"$ref":"#/components/schemas/CreateOrUpdateSite"},"destination":{"$ref":"#/components/schemas/CreateOrUpdateSite"},"shipper_address":{"$ref":"#/components/schemas/NewAddressReduced"},"planned_loads":{"description":"Loads as planned before the transport has been started","items":{"$ref":"#/components/schemas/DeliveryLoads"},"type":"array"},"loads":{"description":"Loads as they are most recently defined. This means it is: \n\n* equal to `planned_loads` before loading is actually done \n\n* equal to `origin_loads` after loading is done (with details validated by trucker), but unloading is not done yet \n\n* equal to `loads_loads` after unloading is actually done (with details validated by trucker)","items":{"$ref":"#/components/schemas/DeliveryLoads"},"type":"array"},"origin_loads":{"description":"Loads as validated by trucker right after loading is done","items":{"$ref":"#/components/schemas/DeliveryLoads"},"type":"array"},"destination_loads":{"description":"Loads as validated by trucker right after unloading is done","items":{"$ref":"#/components/schemas/DeliveryLoads"},"type":"array"},"tracking_contacts":{"description":"List of contacts that will automatically receive an email when delivery is done. ⚠️ If no tracking contacts are provided for a company and the setting `partner_email_fallback` is enabled, a tracking contact corresponding to the company's email will be added, at the creation of the transport. This only applies to the carrier and the shipper.","items":{"$ref":"#/components/schemas/Delivery_tracking_contacts"},"type":"array"},"shipper_reference":{"description":"Reference the client may use to match transport on his own system, e.g. an order number. The transport's creator can toggle a setting to only allow himself to set it.","type":"string"},"multiple_rounds":{"description":"If true, the trucker will be able to do a signature at loading, then add any amount of rounds for the transport (with weight/volume and weight ticket), and finish with a signature at unloading.","type":"boolean"}},"type":"object"},"CreateOrUpdateSite":{"properties":{"uid":{"format":"uuid","type":"string"},"remote_id":{"description":"The id of the site in your system","type":"string"},"address":{"allOf":[{"$ref":"#/components/schemas/SiteAddress"}],"nullable":true},"real_start":{"description":"date and time when trucker arrived on site","format":"date-time","readOnly":true,"type":"string"},"real_end":{"description":"date and time when trucker completed loading / unloading (depending whether site is origin or destination)","format":"date-time","readOnly":true,"type":"string"},"signature_process":{"type":"string"},"is_booking_needed":{"type":"boolean"},"instructions":{"$ref":"#/components/schemas/site_instructions"},"reference":{"type":"string"},"action":{"deprecated":true,"description":"Deprecated. Accepted for backward compatibility but ignored. Responses always return an empty string.","type":"string"},"eta":{"format":"date-time","nullable":true,"type":"string"},"eta_tracking":{"type":"boolean"},"punctuality_status":{"readOnly":true,"type":"string"},"supports_exchanges":{"$ref":"#/components/schemas/SupportsExchange"},"category":{"type":"string"},"slots":{"items":{"$ref":"#/components/schemas/Site_slots"},"type":"array"},"trucker_instructions":{"$ref":"#/components/schemas/trucker_instructions"},"trip":{"$ref":"#/components/schemas/Site_trip"}},"type":"object"},"SiteAddress":{"description":"Address of the site. Reference an existing address with its `pk` or `remote_id`, or send its details to have it matched or created.","properties":{"pk":{"description":"Dashdoc's internal id. Optional, set it to reference an existing address.","type":"integer"},"name":{"type":"string"},"address":{"type":"string"},"city":{"type":"string"},"postcode":{"type":"string"},"country":{"$ref":"#/components/schemas/country"},"latitude":{"$ref":"#/components/schemas/latitude"},"longitude":{"$ref":"#/components/schemas/longitude"},"radius":{"default":500,"description":"Radius around the GPS coordinates within which the address is located (in meters)","type":"integer"},"coords_validated":{"default":false,"description":"if `true`, when this address is used as a loading or unloading site, the mobile app displays an itinerary button to start GPS app with guidance to these coordinates","type":"boolean"},"is_demo":{"$ref":"#/components/schemas/is_demo"},"is_carrier":{"type":"boolean"},"is_shipper":{"type":"boolean"},"is_origin":{"$ref":"#/components/schemas/address_is_origin_and_is_destination"},"is_destination":{"$ref":"#/components/schemas/address_is_origin_and_is_destination"},"instructions":{"$ref":"#/components/schemas/site_instructions"},"remote_id":{"description":"The id of the address in your system.","type":"string"},"company":{"$ref":"#/components/schemas/CompanyForTransportAddress_1"}},"type":"object"},"site_instructions":{"description":"Site instructions, visible to all parties (trucker, carrier, shipper, site). Displayed in the trucker mobile app. Not visible in the eCMR. If the field is not provided, the address's site instructions will be used.","maxLength":1000,"type":"string"},"CompanyForTransportAddress_1":{"description":"Identification of the company. You may simply use its `pk` or `remote_id` if the company already exists. Other possible identification method are its `trade_number` or `name`. If it doesn't exist, the company will be created with the information you send based on what's possible when creating a company via /companies/ web service. Minimum required information in this case is a name.","properties":{"pk":{"description":"Dashdoc's internal id.Optional, not required if `remote_id` is sent.","type":"integer"},"remote_id":{"description":"The id of the company in your system. Optional, ignored if `pk` is sent.","type":"string"},"trade_number":{"maxLength":100,"type":"string"},"name":{"maxLength":200,"type":"string"}},"type":"object"},"SupportsExchange":{"properties":{"uid":{"description":"uid of the support exchange","format":"uuid","type":"string"},"site":{"$ref":"#/components/schemas/SupportsExchange_site"},"support_type":{"$ref":"#/components/schemas/SupportType"},"expected_retrieved":{"description":"Expected number of supports that should be retrieved on the site","type":"number"},"actual_retrieved":{"description":"Actual number of supports that were retrieved on the site","type":"number"},"expected_delivered":{"description":"Expected number of supports that should be delivered on the site","type":"number"},"actual_delivered":{"description":"Actual number of supports that were delivered on the site","type":"number"},"observations":{"description":"Free text. Observations about this supports exchange. Can be filled on mobile app, web app or via API.","type":"string"},"remote_id":{"description":"The ID of the support in your system","type":"string"}},"type":"object"},"SupportsExchange_site":{"description":"site where supports exchange is expected","properties":{"uid":{"description":"uid of the site","format":"uuid","type":"string"},"remote_id":{"description":"remote_id of the site","type":"string"}},"type":"object"},"SupportType":{"description":"Type of the supports that are exchanged","properties":{"name":{"description":"Display name of the support type","type":"string"},"created":{"$ref":"#/components/schemas/created"},"uid":{"format":"uuid","type":"string"},"remote_id":{"description":"The id of the support type in your system.","type":"string"}},"type":"object"},"Site_slots":{"properties":{"start":{"format":"date-time","type":"string"},"end":{"format":"date-time","type":"string"}},"type":"object"},"trucker_instructions":{"description":"**This field is part of a beta feature.** Private instructions. **The carrier of the transport is the only one who can edit and read those instructions.** Note that those instructions are not visible in the consignment note and can be accessed by the trucker. The value is null if the caller doesn't have the right of access to the data.","maxLength":1000,"type":"string"},"Site_trip":{"description":"Trip linked to this site/activity.","nullable":true,"properties":{"uid":{"format":"uuid","type":"string"},"name":{"type":"string"},"is_prepared":{"type":"boolean"},"status":{"enum":["unstarted","ongoing","done"],"type":"string"}},"readOnly":true,"type":"object"},"NewAddressReduced":{"properties":{"pk":{"description":"Dashdoc's internal id. Optional, set it to reference an existing address.","type":"integer"},"name":{"type":"string"},"address":{"type":"string"},"city":{"type":"string"},"postcode":{"type":"string"},"country":{"$ref":"#/components/schemas/country"},"latitude":{"$ref":"#/components/schemas/latitude"},"longitude":{"$ref":"#/components/schemas/longitude"},"radius":{"default":500,"description":"Radius around the GPS coordinates within which the address is located (in meters)","type":"integer"},"coords_validated":{"default":false,"description":"if `true`, when this address is used as a loading or unloading site, the mobile app displays an itinerary button to start GPS app with guidance to these coordinates","type":"boolean"},"is_demo":{"$ref":"#/components/schemas/is_demo"},"is_carrier":{"type":"boolean"},"is_shipper":{"type":"boolean"},"is_origin":{"type":"boolean"},"is_destination":{"type":"boolean"},"created_by":{"description":"Ignore. Dashdoc technical data.","readOnly":true,"type":"number"},"created":{"description":"Date of creation on our server","format":"date-time","readOnly":true,"type":"string"},"instructions":{"type":"string"},"remote_id":{"description":"The id of the address in your system.","type":"string"},"company":{"$ref":"#/components/schemas/CompanyForTransportAddress"},"original":{"description":"Ignore. Dashdoc technical data.","nullable":true,"readOnly":true,"type":"number"}},"required":["address","city","company","country","postcode"],"type":"object"},"DeliveryLoads":{"properties":{"uid":{"description":"Dashdoc's internal id.","type":"string"},"remote_id":{"description":"The ID of the load in your system. It has to be unique among all your transports.","type":"string"},"description":{"description":"Text description of the load","type":"string"},"reference":{"description":"Reference of the load","type":"string"},"round_id":{"description":"The ID of the round.","format":"integer","type":"number"},"weight":{"description":"In kilograms","format":"float","type":"number"},"volume":{"description":"Volume of load in m3","format":"float","type":"number"},"volume_display_unit":{"default":"m3","enum":["m3","L"],"type":"string"},"linear_meters":{"description":"Length of load in meters","format":"float","type":"number"},"quantity":{"description":"Only one decimal accepted (e.g 0.0)","format":"float","type":"number"},"pallet_equivalence":{"description":"Pallet equivalence (EPS/EQPAL): how many standard pallet spaces the load occupies. `null` when it was never set. Otherwise at least `0.01`, with two decimals kept.","format":"float","nullable":true,"type":"number"},"category":{"description":"Packaging of the load. The text is free but these specific values cause a custom flow on the mobile app: `pallets`, `containers`, `bulk`, `roundwood`, `powder_tank`, `bulk_qualimat`, `rental`.","type":"string"},"dangerous_goods_category":{"description":"ADR class","enum":["1","2","3","4.1","4.2","4.3","5.1","5.2","6.1","6.2","7","8","9"],"type":"string"},"is_dangerous":{"type":"boolean"},"adr_un_code":{"type":"string"},"legal_mentions":{"type":"string"},"complementary_information":{"description":"Any information about the load that doesn't fit to the description field","type":"string"},"container_number":{"type":"string"},"tare_weight":{"description":"In kilograms","format":"float","type":"number"},"container_seal_number":{"type":"string"},"refrigerated":{"description":"Indicates whether the load is refrigerated. If true, the trucker can fill in the temperature.","type":"boolean"},"temperature":{"type":"string"},"steres":{"format":"float","type":"number"},"idtf_number":{"description":"Must match an existing IDTF number","type":"string"},"use_identifiers":{"description":"if `true`, trucker is asked to scan barcode identifiers on load","type":"boolean"},"identifiers":{"description":"Only relevant if use_identifiers is set to `true`. List of expected barcode identifiers that the trucker should scan at loading and unloading. App controls that expected barcodes are actually scanned. If empty, the trucker will have to scan barcodes anyway, but there won't be any check. Feature has to be activated in your account by your Dashdoc projet manager.","items":{"type":"string"},"type":"array"},"identifiers_observations":{"description":"Observations explaining issues with identifier, such as missing or unexpected identifiers","type":"string"}},"type":"object"},"Delivery_tracking_contacts":{"properties":{"uid":{"description":"Dashdoc's internal id.","type":"string"},"contact":{"$ref":"#/components/schemas/NewContact"},"subscribed_to_status_updates":{"description":"If set to true, the contact will receive an email at every step of the delivery. Else, they will receive only one email once the delivery is done.","type":"boolean"},"role":{"description":"The role of the contact in the delivery. It can be `carrier`, `shipper`, or `site`.","type":"string"}},"required":["contact"],"type":"object"},"NewContact":{"properties":{"uid":{"format":"uuid","type":"string"},"created":{"description":"Date of creation on our server","format":"date-time","readOnly":true,"type":"string"},"company":{"$ref":"#/components/schemas/CompanyIdentification"},"first_name":{"maxLength":200,"type":"string"},"last_name":{"maxLength":200,"type":"string"},"email":{"format":"email","type":"string"},"phone_number":{"maxLength":100,"type":"string"},"fax_number":{"maxLength":100,"type":"string"},"remote_id":{"description":"The id of the contact in your system","type":"string"}},"required":["company","last_name"],"type":"object"},"CompanyIdentification":{"description":"Identification of the company. The company must already exist in Dashdoc.","properties":{"pk":{"description":"Dashdoc's internal id. Optional, not required if `remote_id` is sent.","type":"integer"},"remote_id":{"description":"Your remote carrier id. Optional, ignored if `pk` is sent.","type":"string"},"name":{"type":"string"},"trade_number":{"type":"string"},"country":{"$ref":"#/components/schemas/country"},"settings_contract_html":{"description":"Ignore. Dashdoc technical data.","type":"string"},"settings_logo":{"description":"Ignore. Dashdoc technical data.","nullable":true,"type":"string"},"settings_stamp":{"description":"Ignore. Dashdoc technical data.","nullable":true,"type":"string"},"settings_print_mode":{"description":"Ignore. Dashdoc technical data.","type":"boolean"},"settings_special_agreements":{"description":"Ignore. Dashdoc technical data.","type":"string"},"settings_transport_order_observations":{"type":"string"},"settings_constrain_reference_edition":{"type":"boolean"},"vat_number":{"type":"string"},"is_verified":{"description":"Ignore. Dashdoc technical data.","type":"string"}},"type":"object"},"Segment":{"description":"","properties":{"uid":{"minLength":1,"type":"string"},"remote_id":{"minLength":1,"type":"string"},"origin":{"$ref":"#/components/schemas/Site"},"destination":{"$ref":"#/components/schemas/Site"},"trucker":{"$ref":"#/components/schemas/SegmentTrucker"},"vehicle":{"$ref":"#/components/schemas/Vehicle"},"trailers":{"items":{"$ref":"#/components/schemas/Trailer"},"type":"array"},"sort_order":{"description":"The index of the segment in the transport","minimum":0,"type":"number"},"scheduled_start_range":{"$ref":"#/components/schemas/Segment_scheduled_start_range"},"scheduled_end_range":{"$ref":"#/components/schemas/Segment_scheduled_end_range"},"scheduled_start":{"deprecated":true,"description":"The datetime at which the carrier scheduled the start of this segment\n","type":"string"},"scheduled_end":{"deprecated":true,"description":"The datetime at which the carrier scheduled the end of this segment","type":"string"},"child_transport":{"$ref":"#/components/schemas/Segment_child_transport"},"telematic_distance":{"description":"Automatically computed distance from telematic data (in kms).","type":"integer"},"distance":{"description":"Manually entered distance. If null, it takes the value of telematic_distance (in kms).","type":"integer"},"origin_mileage":{"description":"Mileage at transport origin site (in kms).","type":"integer"},"destination_mileage":{"description":"Mileage at transport destination site (in kms).","type":"integer"}},"type":"object"},"Site":{"properties":{"uid":{"format":"uuid","type":"string"},"remote_id":{"description":"The id of the site in your system","type":"string"},"address":{"$ref":"#/components/schemas/Address"},"real_start":{"description":"date and time when trucker arrived on site","format":"date-time","type":"string"},"real_end":{"description":"date and time when trucker completed loading / unloading (depending whether site is origin or destination)","format":"date-time","type":"string"},"signature_process":{"type":"string"},"instructions":{"$ref":"#/components/schemas/site_instructions"},"reference":{"type":"string"},"action":{"deprecated":true,"description":"Deprecated. Always returned as an empty string.","type":"string"},"eta":{"nullable":true,"type":"string"},"eta_tracking":{"$ref":"#/components/schemas/eta_tracking"},"punctuality_status":{"$ref":"#/components/schemas/punctuality_status"},"supports_exchanges":{"$ref":"#/components/schemas/SupportsExchange"},"category":{"enum":["loading","unloading"],"type":"string"},"slots":{"items":{"$ref":"#/components/schemas/Site_slots"},"type":"array"},"trucker_instructions":{"$ref":"#/components/schemas/trucker_instructions"},"trip":{"$ref":"#/components/schemas/Site_trip"}},"type":"object"},"Address":{"properties":{"pk":{"description":"Dashdoc's internal id.","type":"number"},"name":{"type":"string"},"address":{"type":"string"},"city":{"type":"string"},"postcode":{"type":"string"},"country":{"$ref":"#/components/schemas/country"},"latitude":{"$ref":"#/components/schemas/latitude"},"longitude":{"$ref":"#/components/schemas/longitude"},"radius":{"default":500,"description":"Radius around the GPS coordinates within which the address is located (in meters)","type":"integer"},"coords_validated":{"default":false,"description":"if `true`, when this address is used as a loading or unloading site, the mobile app displays an itinerary button to start GPS app with guidance to these coordinates","type":"boolean"},"is_demo":{"$ref":"#/components/schemas/is_demo"},"is_carrier":{"type":"boolean"},"is_shipper":{"type":"boolean"},"is_origin":{"$ref":"#/components/schemas/address_is_origin_and_is_destination"},"is_destination":{"$ref":"#/components/schemas/address_is_origin_and_is_destination"},"created_by":{"$ref":"#/components/schemas/created-by"},"created_by_user":{"$ref":"#/components/schemas/created-by-user"},"created":{"$ref":"#/components/schemas/created"},"instructions":{"$ref":"#/components/schemas/site_instructions"},"remote_id":{"description":"The id of the address in your system.","type":"string"},"original":{"description":"Dashdoc's internal id of the original address.","nullable":true,"readOnly":true,"type":"number"},"company":{"$ref":"#/components/schemas/Company"}},"type":"object"},"eta_tracking":{"default":false,"description":"Ask for an ETA on this site. This is currently a beta feature, not activated by default.","type":"boolean"},"punctuality_status":{"default":"untracked","description":"Indicate the punctuality on this site.","enum":["untracked","probably_late","probably_on_time","late","on_time"],"type":"string"},"SegmentTrucker":{"properties":{"pk":{"description":"Dashdoc's internal id.","type":"number"},"remote_id":{"description":"The ID of the trucker in your system. It has to be unique among all your truckers.","type":"string"},"display_name":{"type":"string"},"user":{"$ref":"#/components/schemas/SegmentTruckerUser"}},"type":"object"},"SegmentTruckerUser":{"properties":{"pk":{"description":"Dashdoc's internal id.","type":"number"},"first_name":{"type":"string"},"last_name":{"type":"string"},"username":{"description":"Ignore. Dashdoc technical data.","type":"string"},"email":{"format":"email","type":"string"},"display_name":{"description":"Display name generated by Dashdoc.","type":"string"},"date_joined":{"description":"Ignore. Dashdoc technical data.","format":"date-time","type":"string"},"is_staff":{"description":"Ignore. Dashdoc technical data.","type":"boolean"},"is_superuser":{"description":"Ignore. Dashdoc technical data.","type":"boolean"},"has_usable_password":{"description":"Ignore. Dashdoc technical data.","type":"boolean"}},"type":"object"},"Vehicle":{"properties":{"pk":{"description":"Dashdoc's internal id","type":"number"},"carrier":{"description":"Dashdoc's internal id of the carrier owning the vehicle","type":"number"},"category":{"description":"Vehicle category","type":"string"},"license_plate":{"description":"License plate number","type":"string"},"fleet_number":{"description":"Your vehicle fleet number","type":"string"},"remote_id":{"description":"The ID of the vehicle in your system","type":"string"},"created":{"description":"Date of creation on our server","format":"date-time","type":"string"},"used_for_qualimat_transports":{"description":"True if the vehicle can be used for Qualimat transport (only used for visual help and warnings)","type":"boolean"},"telematic_vehicle":{"description":"Ignore. Dashdoc technical data","type":"number"},"original":{"type":"number"},"tags":{"description":"List of tags applied to the vehicle.","items":{"$ref":"#/components/schemas/Tag"},"type":"array"},"technical_control_deadline":{"format":"date-time","type":"string"},"tachograph_deadline":{"format":"date-time","type":"string"},"speed_limiter_deadline":{"format":"date-time","type":"string"},"country":{"$ref":"#/components/schemas/country"},"unavailability":{"description":"List of unavailable period","items":{"$ref":"#/components/schemas/Unavailability"},"type":"array"},"events":{"description":"Ignore. Dashdoc technical data.","items":{"type":"object"},"type":"array"}},"type":"object"},"Tag":{"properties":{"pk":{"description":"The unique identifier of the tag","type":"integer"},"name":{"description":"The name of the tag","type":"string"},"color":{"description":"The color of the tag in hex format","type":"string"},"tag_group_id":{"description":"The ID of the tag group this tag belongs to, if any","nullable":true,"type":"integer"}},"required":["color","name","pk"],"type":"object"},"Unavailability":{"properties":{"id":{"description":"Dashdoc's internal id","type":"number"},"remote_id":{"description":"The ID of the unavailability in your system","type":"string"},"created":{"description":"Date of creation on our server","format":"date-time","type":"string"},"start_date":{"description":"Start date of the unavailability","format":"date-time","type":"string"},"end_date":{"description":"End date of the unavailability","format":"date-time","type":"string"},"unavailability_type":{"description":"Type of unavailability","enum":["paid_vacation","day_off","sick_leave","training","vacation","maintenance","rental","other"],"type":"string"},"unavailability_note":{"description":"Notes about the unavailability","type":"string"}},"type":"object"},"Trailer":{"properties":{"pk":{"description":"Dashdoc's internal id","type":"number"},"original":{"description":"Ignore. Dashdoc technical data","type":"number"},"carrier":{"description":"Dashdoc's internal id of the carrier owning the trailer","type":"number"},"license_plate":{"description":"License plate number","type":"string"},"fleet_number":{"description":"Your trailer fleet number","type":"string"},"remote_id":{"description":"The ID of the trailer in your system","type":"string"},"created":{"description":"Date of creation on our server","format":"date-time","type":"string"},"used_for_qualimat_transports":{"description":"True if the trailer can be used for Qualimat transport (only used for visual help and warnings)","type":"boolean"},"tags":{"description":"List of tags applied to the trailer.","items":{"$ref":"#/components/schemas/Tag"},"type":"array"},"technical_control_deadline":{"format":"date-time","type":"string"},"country":{"$ref":"#/components/schemas/country"},"unavailability":{"description":"List of unavailable period","items":{"$ref":"#/components/schemas/Unavailability"},"type":"array"},"events":{"description":"Ignore. Dashdoc technical data.","items":{"type":"object"},"type":"array"}},"type":"object"},"Segment_scheduled_start_range":{"description":"The datetime range at which the carrier scheduled the start of this segment","properties":{"start":{"description":"Min scheduled start date (ISO 8601)","type":"string"},"end":{"description":"Max scheduled start date (ISO 8601)","type":"string"}},"type":"object"},"Segment_scheduled_end_range":{"description":"The datetime range at which the carrier scheduled the end of this segment","properties":{"start":{"description":"Min scheduled end date (ISO 8601)","type":"string"},"end":{"description":"Max scheduled end date (ISO 8601)","type":"string"}},"type":"object"},"Segment_child_transport":{"description":"If the segment is chartered, will contain the child transport","properties":{"uid":{"format":"uuid","type":"string"},"sequential_id":{"type":"number"},"remote_id":{"type":"string"},"has_strong_link":{"type":"boolean"}},"type":"object"},"Statuses":{"enum":["created","updated","confirmed","declined","verified","invoiced","paid","cancelled","assigned","sent_to_trucker","acknowledged","truck_wash","on_loading_site","loading_complete","on_unloading_site","unloading_complete","bulking_break_started","bulking_break_complete","rounds_started","round_added","round_added_v2","round_edited","round_deleted","rounds_complete","event","checklist_filled","activity_complete","on_the_way","handling_started","done"],"type":"string"},"Status":{"properties":{"uid":{"format":"uuid","type":"string"},"created":{"description":"Date of creation on the server. Useful when the transport is created by mobile devices. If network connection is bad, the `created` date can be later than `created_device`","format":"date-time","type":"string"},"created_device":{"description":"If created from a mobile device, date of creation on the device.","format":"date-time","type":"string"},"creation_method":{"type":"string"},"category":{"description":"event that occured on the transport","type":"string"},"author":{"description":"details about author of the update. Contact Dashdoc if more details is needed.","type":"object"},"content":{"description":"Contact Dashdoc if more details is needed.","type":"object"},"content_signatory":{"description":"Contact Dashdoc if more details is needed.","type":"object"},"target":{"description":"Contact Dashdoc if more details is needed.","type":"object"},"site":{"description":"Contact Dashdoc if more details is needed.","type":"object"},"site_id":{"description":"Contact Dashdoc if more details is needed.","format":"uuid","type":"string"},"delivery":{"description":"Contact Dashdoc if more details is needed.","format":"uuid","type":"string"},"segment":{"description":"Contact Dashdoc if more details is needed.","format":"uuid","type":"string"},"transport":{"description":"Contact Dashdoc if more details is needed.","format":"uuid","type":"string"},"signature":{"description":"Contact Dashdoc if more details is needed.","type":"object"},"latitude":{"description":"Contact Dashdoc if more details is needed.","format":"float","type":"number"},"longitude":{"description":"Contact Dashdoc if more details is needed.","format":"float","type":"number"},"update_details":{"description":"Contact Dashdoc if more details is needed.","type":"object"},"author_company":{"type":"number"}},"required":["uid"],"type":"object"},"TransportMessage":{"properties":{"uid":{"format":"uuid","type":"string"},"created":{"$ref":"#/components/schemas/created"},"created_device":{"format":"date-time","type":"string"},"creation_method":{"type":"string"},"author":{"$ref":"#/components/schemas/NewTransportMessage_author"},"type":{"enum":["note","load_verification","share","document","photo"],"maxLength":100,"type":"string"},"document_title":{"description":"Filename or if uploaded by a trucker from the mobile app, the document title is generic, for instance `photo`.","maxLength":100,"type":"string"},"document_type":{"enum":["load_photo","cmr","washing_note","delivery_note","confirmation","weight_note","waste_manifest","holders_swap_note","invoice"],"maxLength":100,"type":"string"},"document":{"description":"URL of the stored document. You can download the document from this URL.","type":"string"},"is_attached_to_cmr":{"type":"boolean"},"transport":{"format":"uuid","type":"string"},"site":{"description":"This field is used for the default values of the field readable_by_company_ids; if null, companies from all Sites of the transport are listed in readable_by_company_ids, otherwise only the company of this Site. Site must exist in this transport. This field is part of a beta feature.","format":"uuid","nullable":true,"type":"string"},"site_remote_id":{"type":"string"},"readable_by_company_ids":{"description":"A list containing the pk of each company allowed to access the document, every company must be part of the transport. If no values are sent, it will be computed with default values; Carrier, Shipper, Invoiced Customer and Site's pk (see Site field). Once values have been sent, the behavior adding default companies is deactivated. The author company is always added. Only pks of companies from the transport will be added, others will be ignored. This field is part of a beta feature.","items":{"type":"integer"},"type":"array"},"message":{"description":"message displayed in the activity thread of a transport in the web app and in the mobile app","type":"string"},"latitude":{"$ref":"#/components/schemas/latitude"},"longitude":{"$ref":"#/components/schemas/longitude"},"reference":{"description":"Free text. This reference is searchable in the transports dashboard. Filled by trucker if document is added from mobile app, by user if document is added from web app, or filled by API request.","maxLength":140,"type":"string"},"visible_by_everyone":{"$ref":"#/components/schemas/visible_by_everyone"},"readable_by_trucker":{"$ref":"#/components/schemas/readable_by_trucker"},"extracted_reference":{"description":"Reference extracted by AI from the document. AI runs only on weight notes, so it will be null for other documents. \"\" if no reference has been found by the AI.","type":"string"}},"type":"object"},"NewTransportMessage_author":{"properties":{"display_name":{"type":"string"},"company":{"type":"number"},"pk":{"description":"Dashdoc's internal id.","type":"number"}},"type":"object"},"visible_by_everyone":{"description":"This field is used to make the transport message public, which makes it visible by all parties of the transport.","type":"boolean"},"readable_by_trucker":{"description":"This field is used to allow truckers to see the transport message. **Only available for carriers.**","type":"boolean"},"requested_vehicle":{"description":"Only useful when the transport is created by the shipper. Free text except punction and special characters.","maxLength":40,"type":"string"},"Document":{"properties":{"pk":{"type":"integer"},"file_updated_date":{"description":"Date was updated on the server.","format":"date-time","type":"string"},"delivery":{"description":"Contact Dashdoc if more details are needed.","format":"uuid","type":"string"},"delivery_sequential_id":{"description":"eCMR number (for category \"cmr\" and \"ldv\")","type":"integer"},"reference":{"type":"integer"},"category":{"description":"Type of document. Possible values are \"cmr\", \"cmr4\", \"ldv\", \"orc\", \"chc\", \"rental\" and \"loading_plan\"","type":"string"},"languages":{"description":"Languages displayed in the document (CMR only), formatted as an 2-letter ISO 639-1 language code","items":{"type":"string"},"type":"array"},"name":{"description":"generic name of the document","type":"string"},"file":{"description":"path to the document","format":"url","type":"string"},"business_privacy_scope":{"description":"Ignore. Dashdoc technical data.","type":"boolean"},"cancelled":{"description":"Date of cancellation of the the document","format":"date-time","type":"string"}},"type":"object"},"deprecated_price":{"deprecated":true,"description":"Full price for the transport","format":"float","nullable":true,"type":"number"},"customer_to_invoice":{"properties":{"pk":{"description":"Dashdoc's internal id.","type":"number"},"name":{"type":"string"},"invoicing_address":{"$ref":"#/components/schemas/customer_to_invoice_invoicing_address"}},"type":"object"},"customer_to_invoice_invoicing_address":{"properties":{"address":{"type":"string"},"city":{"type":"string"},"postcode":{"type":"string"},"country":{"$ref":"#/components/schemas/country"}},"type":"object"},"Transport_parent_transport":{"description":"if this is a chartered transport, this will contains the parent transport it is chartered from","properties":{"uid":{"format":"uuid","type":"string"},"sequential_id":{"type":"number"},"remote_id":{"type":"string"},"has_strong_link":{"type":"boolean"}},"type":"object"},"deprecated_invoiced_price":{"deprecated":true,"description":"Invoiced price for the transport. Deprecated in favour of pricing field","format":"float","nullable":true,"type":"number"},"Transport_references":{"properties":{"role":{"type":"string"},"company":{"$ref":"#/components/schemas/Transport_company"},"reference":{"type":"string"}},"type":"object"},"Transport_company":{"properties":{"name":{"type":"string"}},"type":"object"},"global_instructions":{"description":"Operating instructions. The carrier, the shipper and the creator of the transport have access to those instructions. However, the creator is the only who has the right to edit.","maxLength":1000,"type":"string"},"TransportTemplate_allOf":{"properties":{"template_name":{"description":"Name given to the template","type":"string"}},"type":"object"}}}}
```

## The setNameTripBody object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"setNameTripBody":{"properties":{"name":{"type":"string"}},"required":["name"],"type":"object"}}}}
```

## The Vehicles object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"Vehicles":{"properties":{"count":{"type":"integer"},"next":{"nullable":true,"type":"string"},"previous":{"nullable":true,"type":"string"},"results":{"items":{"$ref":"#/components/schemas/Vehicle"},"type":"array"}},"type":"object"},"Vehicle":{"properties":{"pk":{"description":"Dashdoc's internal id","type":"number"},"carrier":{"description":"Dashdoc's internal id of the carrier owning the vehicle","type":"number"},"category":{"description":"Vehicle category","type":"string"},"license_plate":{"description":"License plate number","type":"string"},"fleet_number":{"description":"Your vehicle fleet number","type":"string"},"remote_id":{"description":"The ID of the vehicle in your system","type":"string"},"created":{"description":"Date of creation on our server","format":"date-time","type":"string"},"used_for_qualimat_transports":{"description":"True if the vehicle can be used for Qualimat transport (only used for visual help and warnings)","type":"boolean"},"telematic_vehicle":{"description":"Ignore. Dashdoc technical data","type":"number"},"original":{"type":"number"},"tags":{"description":"List of tags applied to the vehicle.","items":{"$ref":"#/components/schemas/Tag"},"type":"array"},"technical_control_deadline":{"format":"date-time","type":"string"},"tachograph_deadline":{"format":"date-time","type":"string"},"speed_limiter_deadline":{"format":"date-time","type":"string"},"country":{"$ref":"#/components/schemas/country"},"unavailability":{"description":"List of unavailable period","items":{"$ref":"#/components/schemas/Unavailability"},"type":"array"},"events":{"description":"Ignore. Dashdoc technical data.","items":{"type":"object"},"type":"array"}},"type":"object"},"Tag":{"properties":{"pk":{"description":"The unique identifier of the tag","type":"integer"},"name":{"description":"The name of the tag","type":"string"},"color":{"description":"The color of the tag in hex format","type":"string"},"tag_group_id":{"description":"The ID of the tag group this tag belongs to, if any","nullable":true,"type":"integer"}},"required":["color","name","pk"],"type":"object"},"country":{"description":"Only the 2-character codification is accepted (ISO 3166-1 alpha-2)","type":"string"},"Unavailability":{"properties":{"id":{"description":"Dashdoc's internal id","type":"number"},"remote_id":{"description":"The ID of the unavailability in your system","type":"string"},"created":{"description":"Date of creation on our server","format":"date-time","type":"string"},"start_date":{"description":"Start date of the unavailability","format":"date-time","type":"string"},"end_date":{"description":"End date of the unavailability","format":"date-time","type":"string"},"unavailability_type":{"description":"Type of unavailability","enum":["paid_vacation","day_off","sick_leave","training","vacation","maintenance","rental","other"],"type":"string"},"unavailability_note":{"description":"Notes about the unavailability","type":"string"}},"type":"object"}}}}
```

## The NewVehicle object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"NewVehicle":{"properties":{"remote_id":{"description":"The ID of the vehicle in your system.","type":"string"},"fleet_number":{"description":"Your vehicle fleet number. It has to be unique among all your vehicles. When filled, fleet number will be displayed in the web and mobile app next to license plate number. It can also be used for searches.","maxLength":10,"type":"string"},"license_plate":{"description":"License plate number (has to be unique)","maxLength":200,"type":"string"},"category":{"$ref":"#/components/schemas/vehicle_category"},"used_for_qualimat_transports":{"description":"True if the vehicle can be used for Qualimat transport (only used for vehicle that can handle a load without trailer). This value is used to add a Qualimat logo next to the vehicle in forms, in order to help the user selecting the vehicle when creating a transport. The is no control on the value. You can create a Qualimat transport with a vehicle that is not flagged for Qualimat. In this case a warning is displayed in the transport detail.","type":"boolean"},"tags":{"description":"List of tags applied to the vehicle.","items":{"$ref":"#/components/schemas/Tag"},"type":"array"},"telematic_data_source":{"description":"The telematic where the vehicle is refered","enum":["alertgasoil","astrata","addsecure","dashdoc","eliott","fleetboard","geodynamics","geotracer","geotab","koovea","mappingcontrol","mapandtruck","masternaut","qeos","quartix","rio","scania","sudtelematique","transics","trimble","truckonline","vehizen","volvo","webfleet","strada","verizon","mapon","bump","samsara","samsara_mapandtruck","webeye","pass_tracabilite","bizztrack","aktkc_etransportas_mapandtruck","anima_mapandtruck","arvento_mapandtruck","as24_mapandtruck","axxess_mapandtruck","bornemann_infleet_mapandtruck","bpw_mapandtruck","cartrack_mapandtruck","commander_services_mapandtruck","dkv_mapandtruck","easytrack_mapandtruck","ecofleet_mapandtruck","edrive_mapandtruck","effitrailer_mapandtruck","ekolis_mapandtruck","fleetgo_mapandtruck","fleethand_mapandtruck","fleetmaster_mapandtruck","framelogic_mapandtruck","frotcom_mapandtruck","geotab_mapandtruck","gestracking_mapandtruck","globaltrack_mapandtruck","goodyear_france_mapandtruck","gps_mobile_mapandtruck","icell_mapandtruck","ims_telematics_mapandtruck","inelo_mapandtruck","infis_mapandtruck","jaltest_mapandtruck","k2gps_mapandtruck","keeptrace_mapandtruck","konsalnet_mapandtruck","krone_telematic_mapandtruck","legal_telematics_mapandtruck","linqo_mapandtruck","localizare_mapandtruck","locationsolutions_mapandtruck","loctracker_mapandtruck","mecomo_mapandtruck","microlise_mapandtruck","mix_telematics_mapandtruck","movertis_mapandtruck","movildata_mapandtruck","mtrack_mapandtruck","n2mobil_mapandtruck","naocom_mapandtruck","navifleet_mapandtruck","nexus_mapandtruck","ocean_mapandtruck","optifleet_mapandtruck","optimo_gps_mapandtruck","orbcomm_mapandtruck","orbcomm_africa_mapandtruck","pulsit_electronics_mapandtruck","quake_tracking_mapandtruck","riverlong_mapandtruck","sas_fleet_mapandtruck","satko_mapandtruck","schmitz_cargobull_mapandtruck","seyir_mobil_mapandtruck","skywatch_mapandtruck","solustop_mapandtruck","spedion_mapandtruck","speedtelematics_mapandtruck","starcom_mapandtruck","telepass_mapandtruck","terramar_networks_mapandtruck","tracker_mapandtruck","trackit_mapandtruck","tracknamic_mapandtruck","trendfire_mapandtruck","v3_smart_technologies_mapandtruck","vektor_teknoloji_mapandtruck","viafleet_mapandtruck","viasat_mapandtruck","visirun_mapandtruck","waynet_mapandtruck","wayzz_mapandtruck","webdispecink_mapandtruck"],"type":"string"},"vendor_id":{"description":"ID of the vehicle in the telematics system","type":"string"}},"type":"object"},"vehicle_category":{"description":"Vehicle category","enum":["unknown","light","straight","straight_tipper","tipper","tipper_cereal","tipper_construction","refrigerated","isotherm","platform","curtainsider","box_body","trailer_truck","flatbed","low_flatbed","log","coil","container","vehicle","heavy_equipment","solid_tanker","petrol_tanker","chemical_tanker","food_tanker","livestock","special_convoy"],"maxLength":200,"type":"string"},"Tag":{"properties":{"pk":{"description":"The unique identifier of the tag","type":"integer"},"name":{"description":"The name of the tag","type":"string"},"color":{"description":"The color of the tag in hex format","type":"string"},"tag_group_id":{"description":"The ID of the tag group this tag belongs to, if any","nullable":true,"type":"integer"}},"required":["color","name","pk"],"type":"object"}}}}
```

## The Vehicle object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"Vehicle":{"properties":{"pk":{"description":"Dashdoc's internal id","type":"number"},"carrier":{"description":"Dashdoc's internal id of the carrier owning the vehicle","type":"number"},"category":{"description":"Vehicle category","type":"string"},"license_plate":{"description":"License plate number","type":"string"},"fleet_number":{"description":"Your vehicle fleet number","type":"string"},"remote_id":{"description":"The ID of the vehicle in your system","type":"string"},"created":{"description":"Date of creation on our server","format":"date-time","type":"string"},"used_for_qualimat_transports":{"description":"True if the vehicle can be used for Qualimat transport (only used for visual help and warnings)","type":"boolean"},"telematic_vehicle":{"description":"Ignore. Dashdoc technical data","type":"number"},"original":{"type":"number"},"tags":{"description":"List of tags applied to the vehicle.","items":{"$ref":"#/components/schemas/Tag"},"type":"array"},"technical_control_deadline":{"format":"date-time","type":"string"},"tachograph_deadline":{"format":"date-time","type":"string"},"speed_limiter_deadline":{"format":"date-time","type":"string"},"country":{"$ref":"#/components/schemas/country"},"unavailability":{"description":"List of unavailable period","items":{"$ref":"#/components/schemas/Unavailability"},"type":"array"},"events":{"description":"Ignore. Dashdoc technical data.","items":{"type":"object"},"type":"array"}},"type":"object"},"Tag":{"properties":{"pk":{"description":"The unique identifier of the tag","type":"integer"},"name":{"description":"The name of the tag","type":"string"},"color":{"description":"The color of the tag in hex format","type":"string"},"tag_group_id":{"description":"The ID of the tag group this tag belongs to, if any","nullable":true,"type":"integer"}},"required":["color","name","pk"],"type":"object"},"country":{"description":"Only the 2-character codification is accepted (ISO 3166-1 alpha-2)","type":"string"},"Unavailability":{"properties":{"id":{"description":"Dashdoc's internal id","type":"number"},"remote_id":{"description":"The ID of the unavailability in your system","type":"string"},"created":{"description":"Date of creation on our server","format":"date-time","type":"string"},"start_date":{"description":"Start date of the unavailability","format":"date-time","type":"string"},"end_date":{"description":"End date of the unavailability","format":"date-time","type":"string"},"unavailability_type":{"description":"Type of unavailability","enum":["paid_vacation","day_off","sick_leave","training","vacation","maintenance","rental","other"],"type":"string"},"unavailability_note":{"description":"Notes about the unavailability","type":"string"}},"type":"object"}}}}
```

## The UpdateVehicle object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"UpdateVehicle":{"properties":{"remote_id":{"description":"The ID of the vehicle in your system.","type":"string"},"fleet_number":{"description":"Your vehicle fleet number. It has to be unique among all your vehicles. When filled, fleet number will be displayed in the web and mobile app next to license plate number. It can also be used for searches.","maxLength":10,"type":"string"},"license_plate":{"description":"License plate number","maxLength":200,"type":"string"},"category":{"$ref":"#/components/schemas/vehicle_category"},"used_for_qualimat_transports":{"description":"True if the vehicle can be used for Qualimat transport (only used for vehicle that can handle a load without trailer). This value is used to add a Qualimat logo next to the vehicle in forms, in order to help the user selecting the vehicle when creating a transport. The is no control on the value. You can create a Qualimat transport with a vehicle that is not flagged for Qualimat. In this case a warning is displayed in the transport detail.","type":"boolean"},"tags":{"description":"List of tags applied to the vehicle.","items":{"$ref":"#/components/schemas/Tag"},"type":"array"}},"type":"object"},"vehicle_category":{"description":"Vehicle category","enum":["unknown","light","straight","straight_tipper","tipper","tipper_cereal","tipper_construction","refrigerated","isotherm","platform","curtainsider","box_body","trailer_truck","flatbed","low_flatbed","log","coil","container","vehicle","heavy_equipment","solid_tanker","petrol_tanker","chemical_tanker","food_tanker","livestock","special_convoy"],"maxLength":200,"type":"string"},"Tag":{"properties":{"pk":{"description":"The unique identifier of the tag","type":"integer"},"name":{"description":"The name of the tag","type":"string"},"color":{"description":"The color of the tag in hex format","type":"string"},"tag_group_id":{"description":"The ID of the tag group this tag belongs to, if any","nullable":true,"type":"integer"}},"required":["color","name","pk"],"type":"object"}}}}
```

## The waste\_contact\_role object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"waste_contact_role":{"enum":["trucker","notification","signatory"],"type":"string"}}}}
```

## The Contacts\_1 object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"Contacts_1":{"properties":{"count":{"type":"integer"},"next":{"nullable":true,"type":"string"},"previous":{"nullable":true,"type":"string"},"results":{"items":{"$ref":"#/components/schemas/Contact_1"},"type":"array"}},"type":"object"},"Contact_1":{"allOf":[{"$ref":"#/components/schemas/Contact_1_allOf"},{"$ref":"#/components/schemas/PublicWasteContactInputValidator"}]},"Contact_1_allOf":{"properties":{"uid":{"description":"Unique identifier of the contact","format":"uuid","type":"string"}},"type":"object"},"PublicWasteContactInputValidator":{"properties":{"company_id":{"description":"ID of the company of the contact","type":"integer"},"roles":{"description":"Roles of the contact","items":{"$ref":"#/components/schemas/waste_contact_role"},"type":"array"},"email":{"description":"Email of the contact","format":"email","type":"string"},"full_name":{"description":"Full name of the contact","type":"string"}},"type":"object"},"waste_contact_role":{"enum":["trucker","notification","signatory"],"type":"string"}}}}
```

## The PublicWasteContactInputValidator object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"PublicWasteContactInputValidator":{"properties":{"company_id":{"description":"ID of the company of the contact","type":"integer"},"roles":{"description":"Roles of the contact","items":{"$ref":"#/components/schemas/waste_contact_role"},"type":"array"},"email":{"description":"Email of the contact","format":"email","type":"string"},"full_name":{"description":"Full name of the contact","type":"string"}},"type":"object"},"waste_contact_role":{"enum":["trucker","notification","signatory"],"type":"string"}}}}
```

## The Contact\_1 object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"Contact_1":{"allOf":[{"$ref":"#/components/schemas/Contact_1_allOf"},{"$ref":"#/components/schemas/PublicWasteContactInputValidator"}]},"Contact_1_allOf":{"properties":{"uid":{"description":"Unique identifier of the contact","format":"uuid","type":"string"}},"type":"object"},"PublicWasteContactInputValidator":{"properties":{"company_id":{"description":"ID of the company of the contact","type":"integer"},"roles":{"description":"Roles of the contact","items":{"$ref":"#/components/schemas/waste_contact_role"},"type":"array"},"email":{"description":"Email of the contact","format":"email","type":"string"},"full_name":{"description":"Full name of the contact","type":"string"}},"type":"object"},"waste_contact_role":{"enum":["trucker","notification","signatory"],"type":"string"}}}}
```

## The waste\_shipment\_status object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"waste_shipment_status":{"description":"The status of the waste shipment","enum":["draft","signed","cancelled","inTransit","discontinued","arrived","completed"],"type":"string"}}}}
```

## The Forms object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"Forms":{"properties":{"count":{"type":"integer"},"next":{"nullable":true,"type":"string"},"previous":{"nullable":true,"type":"string"},"results":{"items":{"$ref":"#/components/schemas/Form"},"type":"array"}},"type":"object"},"Form":{"allOf":[{"$ref":"#/components/schemas/Form_allOf"},{"$ref":"#/components/schemas/PublicWasteShipmentInputValidator"}]},"Form_allOf":{"properties":{"uid":{"description":"Unique identifier of the waste form","format":"uuid","type":"string"},"name":{"description":"Human readable name of the waste form. Identifier for OVAM.","type":"string"},"created":{"description":"Date and time of creation","format":"date-time","type":"string"},"updated":{"description":"Date and time of last update","format":"date-time","type":"string"},"status":{"$ref":"#/components/schemas/waste_shipment_status"},"pdf":{"$ref":"#/components/schemas/Form_allOf_pdf"},"discontinued_reason":{"description":"Reason for the discontinuation of the waste shipment, the waste was in transit but never arrived at destination","nullable":true,"type":"string"},"transport_uid":{"description":"Unique identifier of the transport linked to the waste form in the TMS if any","format":"uuid","type":"string"}},"type":"object"},"waste_shipment_status":{"description":"The status of the waste shipment","enum":["draft","signed","cancelled","inTransit","discontinued","arrived","completed"],"type":"string"},"Form_allOf_pdf":{"nullable":true,"properties":{"url":{"description":"URL to fetch the PDF version of the waste form","type":"string"},"updated_date":{"description":"Date and time of PDF last update","format":"date-time","type":"string"}},"type":"object"},"PublicWasteShipmentInputValidator":{"properties":{"producer_id":{"description":"The ID of the producer company. You need to have the company created first with the /v4/companies/ endpoint. Make sure you also set the specific details that are mandatory for waste activity with the endpoint /v4/wam/companies/{id}/details/.","nullable":true,"type":"integer"},"processor_id":{"description":"The ID of the processor company. You need to have the company created first with the /v4/companies/ endpoint. Make sure you also set the specific details that are mandatory for waste activity with the endpoint /v4/wam/companies/{id}/details/.","nullable":true,"type":"integer"},"carrier_id":{"description":"The ID of the carrier company. You need to have the company created first with the /v4/companies/ endpoint. Make sure you also set the specific details that are mandatory for waste activity with the endpoint /v4/wam/companies/{id}/details/.","nullable":true,"type":"integer"},"organizer_id":{"description":"The ID of the organizer company. You need to have the company created first with the /v4/companies/ endpoint. Make sure you also set the specific details that are mandatory for waste activity with the endpoint /v4/wam/companies/{id}/details/.","nullable":true,"type":"integer"},"origin_id":{"description":"The ID of the origin address. If it does not exist, create it first with the /v4/addresses/ endpoint.","nullable":true,"type":"integer"},"destination_id":{"deprecated":true,"description":"The ID of the destination address. If it does not exist, create it first with the /v4/addresses/ endpoint. Deprecated because it is no longer used. We now use the processor address as destination.","nullable":true,"type":"integer"},"instructions":{"nullable":true,"type":"string"},"sea_ship_name":{"description":"Name of the sea ship","nullable":true,"type":"string"},"sea_ship_imo_number":{"description":"IMO number of the sea ship","nullable":true,"type":"string"},"sea_ship_mmsi_number":{"description":"MMSI number of the sea ship","nullable":true,"type":"string"},"sea_ship_eni_number":{"description":"ENI number of the sea ship","nullable":true,"type":"string"},"transport_date":{"format":"date-time","nullable":true,"type":"string"},"carrier_contact_uid":{"description":"The UID of the carrier contact. If it does not exist, create it first with the /v4/wam/contacts/ endpoint.","format":"uuid","nullable":true,"type":"string"},"organizer_signatory_uid":{"description":"The UID of the organizer signatory. If it does not exist, create it first with the /v4/wam/contacts/ endpoint.","format":"uuid","nullable":true,"type":"string"},"producer_contact_uid":{"description":"The UID of the producer contact. If it does not exist, create it first with the /v4/wam/contacts/ endpoint.","format":"uuid","nullable":true,"type":"string"},"processor_contact_uid":{"description":"The UID of the processor contact. If it does not exist, create it first with the /v4/wam/contacts/ endpoint.","format":"uuid","nullable":true,"type":"string"},"processor_signatory_uid":{"description":"The UID of the processor signatory. If it does not exist, create it first with the /v4/wam/contacts/ endpoint.","format":"uuid","nullable":true,"type":"string"}},"type":"object"}}}}
```

## The PublicWasteShipmentInputValidator object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"PublicWasteShipmentInputValidator":{"properties":{"producer_id":{"description":"The ID of the producer company. You need to have the company created first with the /v4/companies/ endpoint. Make sure you also set the specific details that are mandatory for waste activity with the endpoint /v4/wam/companies/{id}/details/.","nullable":true,"type":"integer"},"processor_id":{"description":"The ID of the processor company. You need to have the company created first with the /v4/companies/ endpoint. Make sure you also set the specific details that are mandatory for waste activity with the endpoint /v4/wam/companies/{id}/details/.","nullable":true,"type":"integer"},"carrier_id":{"description":"The ID of the carrier company. You need to have the company created first with the /v4/companies/ endpoint. Make sure you also set the specific details that are mandatory for waste activity with the endpoint /v4/wam/companies/{id}/details/.","nullable":true,"type":"integer"},"organizer_id":{"description":"The ID of the organizer company. You need to have the company created first with the /v4/companies/ endpoint. Make sure you also set the specific details that are mandatory for waste activity with the endpoint /v4/wam/companies/{id}/details/.","nullable":true,"type":"integer"},"origin_id":{"description":"The ID of the origin address. If it does not exist, create it first with the /v4/addresses/ endpoint.","nullable":true,"type":"integer"},"destination_id":{"deprecated":true,"description":"The ID of the destination address. If it does not exist, create it first with the /v4/addresses/ endpoint. Deprecated because it is no longer used. We now use the processor address as destination.","nullable":true,"type":"integer"},"instructions":{"nullable":true,"type":"string"},"sea_ship_name":{"description":"Name of the sea ship","nullable":true,"type":"string"},"sea_ship_imo_number":{"description":"IMO number of the sea ship","nullable":true,"type":"string"},"sea_ship_mmsi_number":{"description":"MMSI number of the sea ship","nullable":true,"type":"string"},"sea_ship_eni_number":{"description":"ENI number of the sea ship","nullable":true,"type":"string"},"transport_date":{"format":"date-time","nullable":true,"type":"string"},"carrier_contact_uid":{"description":"The UID of the carrier contact. If it does not exist, create it first with the /v4/wam/contacts/ endpoint.","format":"uuid","nullable":true,"type":"string"},"organizer_signatory_uid":{"description":"The UID of the organizer signatory. If it does not exist, create it first with the /v4/wam/contacts/ endpoint.","format":"uuid","nullable":true,"type":"string"},"producer_contact_uid":{"description":"The UID of the producer contact. If it does not exist, create it first with the /v4/wam/contacts/ endpoint.","format":"uuid","nullable":true,"type":"string"},"processor_contact_uid":{"description":"The UID of the processor contact. If it does not exist, create it first with the /v4/wam/contacts/ endpoint.","format":"uuid","nullable":true,"type":"string"},"processor_signatory_uid":{"description":"The UID of the processor signatory. If it does not exist, create it first with the /v4/wam/contacts/ endpoint.","format":"uuid","nullable":true,"type":"string"}},"type":"object"}}}}
```

## The PublicWasteLoadInputValidator object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"PublicWasteLoadInputValidator":{"properties":{"description":{"description":"Description of the waste load. Text longer than 255 characters is cut at 255 characters.","type":"string"},"weight":{"description":"Weight of the waste in kilograms. Rounded half up to the gram (3 decimals).","format":"float","minimum":0,"type":"number"},"quantity":{"description":"Number of packages, as a whole number. This is required for hazardous waste.","minimum":0,"type":"integer"},"eural_code":{"description":"The Eural code of the waste, as `02 01 01` or `020101`. It must exist in the European waste catalogue. Dashdoc reads from the catalogue whether the waste is hazardous: the `*` suffix is optional and ignored.\n","type":"string"},"physical_properties":{"description":"Physical properties of the waste load. This is required for hazardous waste. Text longer than 255 characters is cut at 255 characters.","type":"string"},"chemical_composition":{"description":"Chemical composition of the waste load. This is required for hazardous waste. Text longer than 255 characters is cut at 255 characters.","type":"string"},"packaging_type":{"description":"Packaging type of the waste load. This is required for hazardous waste. Text longer than 255 characters is cut at 255 characters.","type":"string"},"treatment_type":{"description":"Treatment type of the waste load. This is required for hazardous waste. Text longer than 255 characters is cut at 255 characters.","type":"string"},"treatment_codes":{"description":"Treatment codes of the waste load. Case, spaces and leading zeros are ignored (`r01` is read as `R1`), and duplicates are removed.\n","items":{"$ref":"#/components/schemas/treatment_code"},"type":"array"}},"type":"object"},"treatment_code":{"enum":["R1","R2","R3","R4","R5","R6","R7","R8","R9","R10","R11","R12","R13","D1","D2","D3","D4","D5","D6","D7","D8","D9","D10","D11","D12","D13","D14","D15"],"type":"string"}}}}
```

## The Form object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"Form":{"allOf":[{"$ref":"#/components/schemas/Form_allOf"},{"$ref":"#/components/schemas/PublicWasteShipmentInputValidator"}]},"Form_allOf":{"properties":{"uid":{"description":"Unique identifier of the waste form","format":"uuid","type":"string"},"name":{"description":"Human readable name of the waste form. Identifier for OVAM.","type":"string"},"created":{"description":"Date and time of creation","format":"date-time","type":"string"},"updated":{"description":"Date and time of last update","format":"date-time","type":"string"},"status":{"$ref":"#/components/schemas/waste_shipment_status"},"pdf":{"$ref":"#/components/schemas/Form_allOf_pdf"},"discontinued_reason":{"description":"Reason for the discontinuation of the waste shipment, the waste was in transit but never arrived at destination","nullable":true,"type":"string"},"transport_uid":{"description":"Unique identifier of the transport linked to the waste form in the TMS if any","format":"uuid","type":"string"}},"type":"object"},"waste_shipment_status":{"description":"The status of the waste shipment","enum":["draft","signed","cancelled","inTransit","discontinued","arrived","completed"],"type":"string"},"Form_allOf_pdf":{"nullable":true,"properties":{"url":{"description":"URL to fetch the PDF version of the waste form","type":"string"},"updated_date":{"description":"Date and time of PDF last update","format":"date-time","type":"string"}},"type":"object"},"PublicWasteShipmentInputValidator":{"properties":{"producer_id":{"description":"The ID of the producer company. You need to have the company created first with the /v4/companies/ endpoint. Make sure you also set the specific details that are mandatory for waste activity with the endpoint /v4/wam/companies/{id}/details/.","nullable":true,"type":"integer"},"processor_id":{"description":"The ID of the processor company. You need to have the company created first with the /v4/companies/ endpoint. Make sure you also set the specific details that are mandatory for waste activity with the endpoint /v4/wam/companies/{id}/details/.","nullable":true,"type":"integer"},"carrier_id":{"description":"The ID of the carrier company. You need to have the company created first with the /v4/companies/ endpoint. Make sure you also set the specific details that are mandatory for waste activity with the endpoint /v4/wam/companies/{id}/details/.","nullable":true,"type":"integer"},"organizer_id":{"description":"The ID of the organizer company. You need to have the company created first with the /v4/companies/ endpoint. Make sure you also set the specific details that are mandatory for waste activity with the endpoint /v4/wam/companies/{id}/details/.","nullable":true,"type":"integer"},"origin_id":{"description":"The ID of the origin address. If it does not exist, create it first with the /v4/addresses/ endpoint.","nullable":true,"type":"integer"},"destination_id":{"deprecated":true,"description":"The ID of the destination address. If it does not exist, create it first with the /v4/addresses/ endpoint. Deprecated because it is no longer used. We now use the processor address as destination.","nullable":true,"type":"integer"},"instructions":{"nullable":true,"type":"string"},"sea_ship_name":{"description":"Name of the sea ship","nullable":true,"type":"string"},"sea_ship_imo_number":{"description":"IMO number of the sea ship","nullable":true,"type":"string"},"sea_ship_mmsi_number":{"description":"MMSI number of the sea ship","nullable":true,"type":"string"},"sea_ship_eni_number":{"description":"ENI number of the sea ship","nullable":true,"type":"string"},"transport_date":{"format":"date-time","nullable":true,"type":"string"},"carrier_contact_uid":{"description":"The UID of the carrier contact. If it does not exist, create it first with the /v4/wam/contacts/ endpoint.","format":"uuid","nullable":true,"type":"string"},"organizer_signatory_uid":{"description":"The UID of the organizer signatory. If it does not exist, create it first with the /v4/wam/contacts/ endpoint.","format":"uuid","nullable":true,"type":"string"},"producer_contact_uid":{"description":"The UID of the producer contact. If it does not exist, create it first with the /v4/wam/contacts/ endpoint.","format":"uuid","nullable":true,"type":"string"},"processor_contact_uid":{"description":"The UID of the processor contact. If it does not exist, create it first with the /v4/wam/contacts/ endpoint.","format":"uuid","nullable":true,"type":"string"},"processor_signatory_uid":{"description":"The UID of the processor signatory. If it does not exist, create it first with the /v4/wam/contacts/ endpoint.","format":"uuid","nullable":true,"type":"string"}},"type":"object"}}}}
```

## The Load object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"Load":{"properties":{"uid":{"description":"Unique identifier of the waste load","type":"string"},"description":{"description":"Description of the waste load","type":"string"},"weight":{"description":"Weight of the waste in kilograms","format":"float","type":"number"},"quantity":{"description":"Quantity of packages","format":"double","type":"number"},"eural_code":{"description":"The Eural code of the waste, suffixed with a * when the European waste catalogue marks it as hazardous.","type":"string"},"physical_properties":{"description":"Physical properties of the waste load","type":"string"},"chemical_composition":{"description":"Chemical composition of the waste load","type":"string"},"packaging_type":{"description":"Packaging type of the waste load","type":"string"},"treatment_type":{"description":"Treatment type of the waste load","type":"string"},"treatment_codes":{"description":"Treatment codes of the waste load","items":{"$ref":"#/components/schemas/treatment_code"},"type":"array"}},"type":"object"},"treatment_code":{"enum":["R1","R2","R3","R4","R5","R6","R7","R8","R9","R10","R11","R12","R13","D1","D2","D3","D4","D5","D6","D7","D8","D9","D10","D11","D12","D13","D14","D15"],"type":"string"}}}}
```

## The Loads object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"Loads":{"properties":{"count":{"type":"integer"},"next":{"nullable":true,"type":"string"},"previous":{"nullable":true,"type":"string"},"results":{"items":{"$ref":"#/components/schemas/Load"},"type":"array"}},"type":"object"},"Load":{"properties":{"uid":{"description":"Unique identifier of the waste load","type":"string"},"description":{"description":"Description of the waste load","type":"string"},"weight":{"description":"Weight of the waste in kilograms","format":"float","type":"number"},"quantity":{"description":"Quantity of packages","format":"double","type":"number"},"eural_code":{"description":"The Eural code of the waste, suffixed with a * when the European waste catalogue marks it as hazardous.","type":"string"},"physical_properties":{"description":"Physical properties of the waste load","type":"string"},"chemical_composition":{"description":"Chemical composition of the waste load","type":"string"},"packaging_type":{"description":"Packaging type of the waste load","type":"string"},"treatment_type":{"description":"Treatment type of the waste load","type":"string"},"treatment_codes":{"description":"Treatment codes of the waste load","items":{"$ref":"#/components/schemas/treatment_code"},"type":"array"}},"type":"object"},"treatment_code":{"enum":["R1","R2","R3","R4","R5","R6","R7","R8","R9","R10","R11","R12","R13","D1","D2","D3","D4","D5","D6","D7","D8","D9","D10","D11","D12","D13","D14","D15"],"type":"string"}}}}
```

## The LoadValidationError object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"LoadValidationError":{"additionalProperties":{"properties":{"code":{"description":"Machine-readable error codes.","items":{"type":"string"},"type":"array"},"detail":{"description":"Human-readable error messages.","items":{"type":"string"},"type":"array"}},"type":"object"},"description":"Errors keyed by the name of the invalid field.","type":"object"}}}}
```

## The CompanyDetails object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"CompanyDetails":{"properties":{"is_organizer":{"description":"True if the company is a waste shipment organizer","type":"boolean"},"is_producer":{"description":"True if the company is a waste producer","type":"boolean"},"is_processor":{"description":"True if the company is a waste processor","type":"boolean"},"is_carrier":{"description":"True if the company is a carrier","type":"boolean"},"is_citizen":{"description":"True if the waste producer is a citizen and not a company","type":"boolean"},"enterprise_number":{"description":"Enterprise number of the company","type":"string"},"producer_establishment_unit_number":{"description":"Producer establishment unit number of the company","pattern":"^([2-8][0-9]{9})$","type":"string"},"processor_establishment_unit_number":{"description":"Processor establishment unit number of the company","pattern":"^([2-8][0-9]{9})$","type":"string"},"vat_number":{"description":"VAT number of the company","type":"string"}},"type":"object"}}}}
```

## The latitude object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"latitude":{"description":"Latitude using the decimal GPS coordinates (WGS84). At 7 decimals, the position is accurate around the centimeter.","format":"float","nullable":true,"type":"number"}}}}
```

## The longitude object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"longitude":{"description":"Longitude using the decimal GPS coordinates (WGS84). At 7 decimals, the position is accurate around the centimeter.","format":"float","nullable":true,"type":"number"}}}}
```

## The is\_demo object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"is_demo":{"description":"Indicates that the address is a fake one created from demonstration. Everything linked to it will be deleted when using the 'Delete demo content' button in company parameters","type":"boolean"}}}}
```

## The address\_is\_carrier\_and\_is\_shipper\_for\_writes object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"address_is_carrier_and_is_shipper_for_writes":{"description":"Controls the associated company's role (see `company` in same payload). For new companies ONLY. The value is ignored for existing companies.\nIt is encouraged to use the company create/update endpoints directly instead.\n","type":"boolean"}}}}
```

## The address\_is\_origin\_and\_is\_destination object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"address_is_origin_and_is_destination":{"description":"Whether this address is a \"Logistic Points\" and will be usable as pickup/delivery point.\nThe distinction between origin/pickup and destination/delivery was merged as a single \"Logistic Point\" concept. `is_origin` implies `is_destination` and vice-versa.\n","type":"boolean"}}}}
```

## The CompanyForNewAddress object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"CompanyForNewAddress":{"description":"Identification of the company for which the address is created. You may simply use its `pk` or `remote_id` if the company already exists. Other possible identification method are its `trade_number` or `name`. If it doesn't exist, the company will be created with the information you send based on what's possible when creating a company via /companies/ web service. Minimum required information in this case is a name (e.g. for a logistic point).","properties":{"pk":{"description":"Dashdoc's internal id.Optional, not required if `remote_id` is sent.","type":"number"},"remote_id":{"description":"The id of the company in your system. Optional, ignored if `pk` is sent.","type":"string"},"trade_number":{"maxLength":100,"type":"string"},"name":{"maxLength":200,"type":"string"}},"type":"object"}}}}
```

## The country object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"country":{"description":"Only the 2-character codification is accepted (ISO 3166-1 alpha-2)","type":"string"}}}}
```

## The created-by object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"created-by":{"nullable":true,"properties":{"pk":{"description":"company id","type":"number"},"name":{"description":"name of the company","type":"string"}},"type":"object"}}}}
```

## The created-by-user object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"created-by-user":{"nullable":true,"properties":{"pk":{"type":"number"},"display_name":{"type":"string"},"company":{"description":"The company id who created the address","type":"number"},"trucker_id":{"description":"The trucker id who created the address","type":"number"}},"type":"object"}}}}
```

## The created object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"created":{"description":"Date of creation on our server","format":"date-time","type":"string"}}}}
```

## The site\_instructions object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"site_instructions":{"description":"Site instructions, visible to all parties (trucker, carrier, shipper, site). Displayed in the trucker mobile app. Not visible in the eCMR. If the field is not provided, the address's site instructions will be used.","maxLength":1000,"type":"string"}}}}
```

## The Company object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"Company":{"properties":{"pk":{"description":"Dashdoc's internal id.","type":"number"},"remote_id":{"type":"string"},"created":{"format":"date-time","type":"object"},"updated":{"format":"date-time","type":"string"},"deleted":{"type":"boolean"},"invoicing_remote_id":{"description":"The id of the company in your invoicing system.","type":"string"},"name":{"type":"string"},"phone_number":{"type":"string"},"email":{"type":"string"},"siren":{"type":"string"},"trade_number":{"type":"string"},"country":{"$ref":"#/components/schemas/country"},"comments":{"type":"string"},"vat_number":{"type":"string"},"is_verified":{"type":"boolean"},"settings_transport_order_observations":{"type":"string"},"settings_constrain_reference_edition":{"type":"boolean"},"account_type":{"description":"Ignore. Dashdoc technical data.","type":"string"},"logo":{"description":"The URL of your logo","nullable":true,"type":"string"},"subscription_access":{"type":"object"},"settings":{"type":"object"},"primary_address":{"$ref":"#/components/schemas/PrimaryAddress_1"},"managers":{"items":{"$ref":"#/components/schemas/Managers"},"type":"array"},"has_loggable_managers":{"description":"Ignore. Dashdoc technical data.","type":"boolean"}},"type":"object"},"country":{"description":"Only the 2-character codification is accepted (ISO 3166-1 alpha-2)","type":"string"},"PrimaryAddress_1":{"properties":{"pk":{"description":"Dashdoc's internal id.","type":"number"},"name":{"type":"string"},"address":{"type":"string"},"city":{"type":"string"},"postcode":{"type":"string"},"country":{"$ref":"#/components/schemas/country"},"latitude":{"$ref":"#/components/schemas/latitude"},"longitude":{"$ref":"#/components/schemas/longitude"},"radius":{"default":500,"description":"Radius around the GPS coordinates within which the address is located (in meters)","type":"integer"},"coords_validated":{"default":false,"description":"if `true`, when this address is used as a loading or unloading site, the mobile app displays an itinerary button to start GPS app with guidance to these coordinates","type":"boolean"},"is_demo":{"$ref":"#/components/schemas/is_demo"},"is_carrier":{"description":"Whether this company is considered a carrier","type":"boolean"},"is_shipper":{"description":"Whether this company is considered a shipper","type":"boolean"},"is_origin":{"description":"Legacy, not relevant for a company's primary address. Consider creating a separate address associated with this partner instead.\n","type":"boolean"},"is_destination":{"description":"Legacy, not relevant for a company's primary address. Consider creating a separate address associated with this partner instead.\n","type":"boolean"},"created_by":{"$ref":"#/components/schemas/created-by"},"created_by_user":{"$ref":"#/components/schemas/created-by-user"},"created":{"$ref":"#/components/schemas/created"},"remote_id":{"description":"The id of the address in your system.","type":"string"}},"type":"object"},"latitude":{"description":"Latitude using the decimal GPS coordinates (WGS84). At 7 decimals, the position is accurate around the centimeter.","format":"float","nullable":true,"type":"number"},"longitude":{"description":"Longitude using the decimal GPS coordinates (WGS84). At 7 decimals, the position is accurate around the centimeter.","format":"float","nullable":true,"type":"number"},"is_demo":{"description":"Indicates that the address is a fake one created from demonstration. Everything linked to it will be deleted when using the 'Delete demo content' button in company parameters","type":"boolean"},"created-by":{"nullable":true,"properties":{"pk":{"description":"company id","type":"number"},"name":{"description":"name of the company","type":"string"}},"type":"object"},"created-by-user":{"nullable":true,"properties":{"pk":{"type":"number"},"display_name":{"type":"string"},"company":{"description":"The company id who created the address","type":"number"},"trucker_id":{"description":"The trucker id who created the address","type":"number"}},"type":"object"},"created":{"description":"Date of creation on our server","format":"date-time","type":"string"},"Managers":{"properties":{"pk":{"description":"Dashdoc's internal id.","type":"number"},"user":{"$ref":"#/components/schemas/Managers_user"},"display_name":{"type":"string"},"role":{"type":"string"}},"type":"object"},"Managers_user":{"properties":{"email":{"format":"email","type":"string"},"first_name":{"type":"string"},"last_name":{"type":"string"}},"type":"object"}}}}
```

## The CompanyForUpdateAddress object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"CompanyForUpdateAddress":{"description":"Identification of the company that the address belongs to. You may simply use its `pk` or `remote_id`, or just a name (e.g. for a logistic point that has no other company detail in your address book).","properties":{"pk":{"description":"Dashdoc's internal id.Optional, not required if `remote_id` is sent.","type":"number"},"remote_id":{"description":"The id of the company in your system. Optional, ignored if `pk` is sent.","type":"string"},"name":{"maxLength":200,"type":"string"}},"type":"object"}}}}
```

## The AdrUnCode object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"AdrUnCode":{"properties":{"id":{"description":"Dashdoc's internal id","type":"number"},"code":{"description":"UN code, column n°1 from ADR Table A","type":"number"},"category":{"description":"ADR class, column n°2 from ADR Table A","type":"string"},"description":{"$ref":"#/components/schemas/AdrUnCodeDescription"},"packaging_group":{"description":"Packaging group, column n°4 from ADR Table A","type":"string"},"tunnel_restriction":{"description":"Tunnel restriction code, column n°15 from ADR Table A","type":"string"}},"type":"object"},"AdrUnCodeDescription":{"description":"Name and description, column n°4 from ADR Table A. Translated in FR, EN, NL, DE","properties":{"fr":{"description":"French label","type":"string"},"en":{"description":"English label","type":"string"},"nl":{"description":"Dutch label","type":"string"},"de":{"description":"German label","type":"string"}},"type":"object"}}}}
```

## The PrimaryAddress object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"PrimaryAddress":{"properties":{"pk":{"type":"string"},"name":{"maxLength":200,"type":"string"},"address":{"maxLength":200,"type":"string"},"city":{"maxLength":100,"type":"string"},"postcode":{"maxLength":100,"type":"string"},"country":{"$ref":"#/components/schemas/country"},"latitude":{"$ref":"#/components/schemas/latitude"},"longitude":{"$ref":"#/components/schemas/longitude"},"radius":{"default":500,"description":"Radius around the GPS coordinates within which the address is located (in meters)","type":"integer"},"coords_validated":{"default":false,"description":"if `true`, when this address is used as a loading or unloading site, the mobile app displays an itinerary button to start GPS app with guidance to these coordinates","type":"boolean"},"is_demo":{"$ref":"#/components/schemas/is_demo"},"is_carrier":{"description":"Whether this company is considered a carrier.","type":"boolean"},"is_shipper":{"description":"Whether this company is considered a shipper.","type":"boolean"},"is_origin":{"description":"Legacy, not relevant for a company's primary address.","type":"boolean"},"is_destination":{"description":"Legacy, not relevant for a company's primary address.","type":"boolean"},"created_by":{"type":"number"},"created":{"description":"Date of creation on our server","format":"date-time","type":"string"},"instructions":{"type":"string"},"remote_id":{"description":"The id of the address in your system.","type":"string"}},"type":"object"},"country":{"description":"Only the 2-character codification is accepted (ISO 3166-1 alpha-2)","type":"string"},"latitude":{"description":"Latitude using the decimal GPS coordinates (WGS84). At 7 decimals, the position is accurate around the centimeter.","format":"float","nullable":true,"type":"number"},"longitude":{"description":"Longitude using the decimal GPS coordinates (WGS84). At 7 decimals, the position is accurate around the centimeter.","format":"float","nullable":true,"type":"number"},"is_demo":{"description":"Indicates that the address is a fake one created from demonstration. Everything linked to it will be deleted when using the 'Delete demo content' button in company parameters","type":"boolean"}}}}
```

## The AddressForCompany object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"AddressForCompany":{"properties":{"pk":{"description":"Dashdoc's internal id.","type":"number"},"name":{"type":"string"},"address":{"type":"string"},"city":{"type":"string"},"postcode":{"type":"string"},"country":{"$ref":"#/components/schemas/country"},"latitude":{"$ref":"#/components/schemas/latitude"},"longitude":{"$ref":"#/components/schemas/longitude"},"radius":{"default":500,"description":"Radius around the GPS coordinates within which the address is located (in meters)","type":"integer"},"coords_validated":{"default":false,"description":"if `true`, when this address is used as a loading or unloading site, the mobile app displays an itinerary button to start GPS app with guidance to these coordinates","type":"boolean"},"is_demo":{"$ref":"#/components/schemas/is_demo"},"is_carrier":{"type":"boolean"},"is_shipper":{"type":"boolean"},"is_origin":{"$ref":"#/components/schemas/address_is_origin_and_is_destination"},"is_destination":{"$ref":"#/components/schemas/address_is_origin_and_is_destination"},"created_by":{"$ref":"#/components/schemas/created-by"},"created_by_user":{"$ref":"#/components/schemas/created-by-user"},"created":{"$ref":"#/components/schemas/created"},"remote_id":{"description":"The id of the address in your system.","type":"string"}},"type":"object"},"country":{"description":"Only the 2-character codification is accepted (ISO 3166-1 alpha-2)","type":"string"},"latitude":{"description":"Latitude using the decimal GPS coordinates (WGS84). At 7 decimals, the position is accurate around the centimeter.","format":"float","nullable":true,"type":"number"},"longitude":{"description":"Longitude using the decimal GPS coordinates (WGS84). At 7 decimals, the position is accurate around the centimeter.","format":"float","nullable":true,"type":"number"},"is_demo":{"description":"Indicates that the address is a fake one created from demonstration. Everything linked to it will be deleted when using the 'Delete demo content' button in company parameters","type":"boolean"},"address_is_origin_and_is_destination":{"description":"Whether this address is a \"Logistic Points\" and will be usable as pickup/delivery point.\nThe distinction between origin/pickup and destination/delivery was merged as a single \"Logistic Point\" concept. `is_origin` implies `is_destination` and vice-versa.\n","type":"boolean"},"created-by":{"nullable":true,"properties":{"pk":{"description":"company id","type":"number"},"name":{"description":"name of the company","type":"string"}},"type":"object"},"created-by-user":{"nullable":true,"properties":{"pk":{"type":"number"},"display_name":{"type":"string"},"company":{"description":"The company id who created the address","type":"number"},"trucker_id":{"description":"The trucker id who created the address","type":"number"}},"type":"object"},"created":{"description":"Date of creation on our server","format":"date-time","type":"string"}}}}
```

## The PrimaryAddress\_1 object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"PrimaryAddress_1":{"properties":{"pk":{"description":"Dashdoc's internal id.","type":"number"},"name":{"type":"string"},"address":{"type":"string"},"city":{"type":"string"},"postcode":{"type":"string"},"country":{"$ref":"#/components/schemas/country"},"latitude":{"$ref":"#/components/schemas/latitude"},"longitude":{"$ref":"#/components/schemas/longitude"},"radius":{"default":500,"description":"Radius around the GPS coordinates within which the address is located (in meters)","type":"integer"},"coords_validated":{"default":false,"description":"if `true`, when this address is used as a loading or unloading site, the mobile app displays an itinerary button to start GPS app with guidance to these coordinates","type":"boolean"},"is_demo":{"$ref":"#/components/schemas/is_demo"},"is_carrier":{"description":"Whether this company is considered a carrier","type":"boolean"},"is_shipper":{"description":"Whether this company is considered a shipper","type":"boolean"},"is_origin":{"description":"Legacy, not relevant for a company's primary address. Consider creating a separate address associated with this partner instead.\n","type":"boolean"},"is_destination":{"description":"Legacy, not relevant for a company's primary address. Consider creating a separate address associated with this partner instead.\n","type":"boolean"},"created_by":{"$ref":"#/components/schemas/created-by"},"created_by_user":{"$ref":"#/components/schemas/created-by-user"},"created":{"$ref":"#/components/schemas/created"},"remote_id":{"description":"The id of the address in your system.","type":"string"}},"type":"object"},"country":{"description":"Only the 2-character codification is accepted (ISO 3166-1 alpha-2)","type":"string"},"latitude":{"description":"Latitude using the decimal GPS coordinates (WGS84). At 7 decimals, the position is accurate around the centimeter.","format":"float","nullable":true,"type":"number"},"longitude":{"description":"Longitude using the decimal GPS coordinates (WGS84). At 7 decimals, the position is accurate around the centimeter.","format":"float","nullable":true,"type":"number"},"is_demo":{"description":"Indicates that the address is a fake one created from demonstration. Everything linked to it will be deleted when using the 'Delete demo content' button in company parameters","type":"boolean"},"created-by":{"nullable":true,"properties":{"pk":{"description":"company id","type":"number"},"name":{"description":"name of the company","type":"string"}},"type":"object"},"created-by-user":{"nullable":true,"properties":{"pk":{"type":"number"},"display_name":{"type":"string"},"company":{"description":"The company id who created the address","type":"number"},"trucker_id":{"description":"The trucker id who created the address","type":"number"}},"type":"object"},"created":{"description":"Date of creation on our server","format":"date-time","type":"string"}}}}
```

## The CompanyIdentification object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"CompanyIdentification":{"description":"Identification of the company. The company must already exist in Dashdoc.","properties":{"pk":{"description":"Dashdoc's internal id. Optional, not required if `remote_id` is sent.","type":"integer"},"remote_id":{"description":"Your remote carrier id. Optional, ignored if `pk` is sent.","type":"string"},"name":{"type":"string"},"trade_number":{"type":"string"},"country":{"$ref":"#/components/schemas/country"},"settings_contract_html":{"description":"Ignore. Dashdoc technical data.","type":"string"},"settings_logo":{"description":"Ignore. Dashdoc technical data.","nullable":true,"type":"string"},"settings_stamp":{"description":"Ignore. Dashdoc technical data.","nullable":true,"type":"string"},"settings_print_mode":{"description":"Ignore. Dashdoc technical data.","type":"boolean"},"settings_special_agreements":{"description":"Ignore. Dashdoc technical data.","type":"string"},"settings_transport_order_observations":{"type":"string"},"settings_constrain_reference_edition":{"type":"boolean"},"vat_number":{"type":"string"},"is_verified":{"description":"Ignore. Dashdoc technical data.","type":"string"}},"type":"object"},"country":{"description":"Only the 2-character codification is accepted (ISO 3166-1 alpha-2)","type":"string"}}}}
```

## The DashdocInvoiceItem object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"DashdocInvoiceItem":{"properties":{"uid":{"format":"uuid","type":"string"},"description":{"description":"Name of the invoice item in the catalogue.","type":"string"},"line_description":{"description":"Default description when this item is used on a price or invoice line.","type":"string"},"account_code":{"description":"Accounting code associated with the invoice item.","type":"string"},"enabled":{"description":"Whether this catalogue item is enabled.","type":"boolean"},"tax_code":{"$ref":"#/components/schemas/DashdocInvoiceItem_tax_code"}},"required":["account_code","description","enabled","line_description","tax_code","uid"],"type":"object"},"DashdocInvoiceItem_tax_code":{"properties":{"dashdoc_id":{"description":"Dashdoc identifier of the tax code.","type":"string"},"tax_rate":{"description":"Tax rate as a percentage, encoded as a decimal string.","format":"decimal","type":"string"},"tax_type":{"description":"Type of tax, resolved for the authenticated company's country.","enum":["IGIC","IRPF","RETENTION","TPS","TVH","TVQ","VAT"],"type":"string"}},"required":["dashdoc_id","tax_rate","tax_type"],"type":"object"}}}}
```

## The NewAddressReduced object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"NewAddressReduced":{"properties":{"pk":{"description":"Dashdoc's internal id. Optional, set it to reference an existing address.","type":"integer"},"name":{"type":"string"},"address":{"type":"string"},"city":{"type":"string"},"postcode":{"type":"string"},"country":{"$ref":"#/components/schemas/country"},"latitude":{"$ref":"#/components/schemas/latitude"},"longitude":{"$ref":"#/components/schemas/longitude"},"radius":{"default":500,"description":"Radius around the GPS coordinates within which the address is located (in meters)","type":"integer"},"coords_validated":{"default":false,"description":"if `true`, when this address is used as a loading or unloading site, the mobile app displays an itinerary button to start GPS app with guidance to these coordinates","type":"boolean"},"is_demo":{"$ref":"#/components/schemas/is_demo"},"is_carrier":{"type":"boolean"},"is_shipper":{"type":"boolean"},"is_origin":{"type":"boolean"},"is_destination":{"type":"boolean"},"created_by":{"description":"Ignore. Dashdoc technical data.","readOnly":true,"type":"number"},"created":{"description":"Date of creation on our server","format":"date-time","readOnly":true,"type":"string"},"instructions":{"type":"string"},"remote_id":{"description":"The id of the address in your system.","type":"string"},"company":{"$ref":"#/components/schemas/CompanyForTransportAddress"},"original":{"description":"Ignore. Dashdoc technical data.","nullable":true,"readOnly":true,"type":"number"}},"required":["address","city","company","country","postcode"],"type":"object"},"country":{"description":"Only the 2-character codification is accepted (ISO 3166-1 alpha-2)","type":"string"},"latitude":{"description":"Latitude using the decimal GPS coordinates (WGS84). At 7 decimals, the position is accurate around the centimeter.","format":"float","nullable":true,"type":"number"},"longitude":{"description":"Longitude using the decimal GPS coordinates (WGS84). At 7 decimals, the position is accurate around the centimeter.","format":"float","nullable":true,"type":"number"},"is_demo":{"description":"Indicates that the address is a fake one created from demonstration. Everything linked to it will be deleted when using the 'Delete demo content' button in company parameters","type":"boolean"},"CompanyForTransportAddress":{"properties":{"pk":{"description":"Dashdoc's internal id.","type":"number"},"remote_id":{"description":"The id of the company in your system.","type":"string"},"name":{"type":"string"},"trade_number":{"type":"string"},"country":{"$ref":"#/components/schemas/country"},"settings_contract_html":{"description":"Ignore. Dashdoc technical data.","type":"string"},"settings_logo":{"description":"Ignore. Dashdoc technical data.","nullable":true,"type":"string"},"settings_stamp":{"description":"Ignore. Dashdoc technical data.","nullable":true,"type":"string"},"settings_print_mode":{"description":"Ignore. Dashdoc technical data.","type":"boolean"},"settings_special_agreements":{"description":"Ignore. Dashdoc technical data.","type":"string"},"settings_transport_order_observations":{"type":"string"},"settings_constrain_reference_edition":{"type":"boolean"},"vat_number":{"type":"string"},"is_verified":{"type":"boolean"}},"type":"object"}}}}
```

## The DeliveryLoads object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"DeliveryLoads":{"properties":{"uid":{"description":"Dashdoc's internal id.","type":"string"},"remote_id":{"description":"The ID of the load in your system. It has to be unique among all your transports.","type":"string"},"description":{"description":"Text description of the load","type":"string"},"reference":{"description":"Reference of the load","type":"string"},"round_id":{"description":"The ID of the round.","format":"integer","type":"number"},"weight":{"description":"In kilograms","format":"float","type":"number"},"volume":{"description":"Volume of load in m3","format":"float","type":"number"},"volume_display_unit":{"default":"m3","enum":["m3","L"],"type":"string"},"linear_meters":{"description":"Length of load in meters","format":"float","type":"number"},"quantity":{"description":"Only one decimal accepted (e.g 0.0)","format":"float","type":"number"},"pallet_equivalence":{"description":"Pallet equivalence (EPS/EQPAL): how many standard pallet spaces the load occupies. `null` when it was never set. Otherwise at least `0.01`, with two decimals kept.","format":"float","nullable":true,"type":"number"},"category":{"description":"Packaging of the load. The text is free but these specific values cause a custom flow on the mobile app: `pallets`, `containers`, `bulk`, `roundwood`, `powder_tank`, `bulk_qualimat`, `rental`.","type":"string"},"dangerous_goods_category":{"description":"ADR class","enum":["1","2","3","4.1","4.2","4.3","5.1","5.2","6.1","6.2","7","8","9"],"type":"string"},"is_dangerous":{"type":"boolean"},"adr_un_code":{"type":"string"},"legal_mentions":{"type":"string"},"complementary_information":{"description":"Any information about the load that doesn't fit to the description field","type":"string"},"container_number":{"type":"string"},"tare_weight":{"description":"In kilograms","format":"float","type":"number"},"container_seal_number":{"type":"string"},"refrigerated":{"description":"Indicates whether the load is refrigerated. If true, the trucker can fill in the temperature.","type":"boolean"},"temperature":{"type":"string"},"steres":{"format":"float","type":"number"},"idtf_number":{"description":"Must match an existing IDTF number","type":"string"},"use_identifiers":{"description":"if `true`, trucker is asked to scan barcode identifiers on load","type":"boolean"},"identifiers":{"description":"Only relevant if use_identifiers is set to `true`. List of expected barcode identifiers that the trucker should scan at loading and unloading. App controls that expected barcodes are actually scanned. If empty, the trucker will have to scan barcodes anyway, but there won't be any check. Feature has to be activated in your account by your Dashdoc projet manager.","items":{"type":"string"},"type":"array"},"identifiers_observations":{"description":"Observations explaining issues with identifier, such as missing or unexpected identifiers","type":"string"}},"type":"object"}}}}
```

## The NewDeliveryLoads object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"NewDeliveryLoads":{"properties":{"remote_id":{"description":"The ID of the load in your system. It has to be unique among all your transports.","type":"string"},"description":{"description":"Text description of the load. In the case of a dangerous load, the description has to respect the ADR law.","type":"string"},"reference":{"description":"Reference of the load.","type":"string"},"weight":{"description":"In kilograms","format":"float","type":"number"},"volume":{"description":"Volume of load in m3","format":"float","type":"number"},"linear_meters":{"description":"Length of load in meters","format":"float","type":"number"},"quantity":{"description":"Only one decimal accepted (e.g 0.0)","format":"float","type":"number"},"pallet_equivalence":{"description":"Pallet equivalence (EPS/EQPAL): how many standard pallet spaces the load occupies. Minimum `0.01`, and only two decimals are kept — omit it or send `null` rather than 0 when unknown. When a load is created from the Dashdoc interface this defaults to `quantity` × the handling unit's pallet equivalence, and stays freely overridable.","format":"float","nullable":true,"type":"number"},"category":{"description":"Packaging of the load. The text is free but these specific values cause a custom flow on the mobile app: `pallets`, `containers`, `bulk`, `roundwood`, `powder_tank`, `bulk_qualimat`, `rental`.","type":"string"},"handling_unit_uid":{"description":"Existing handling unit UID from the load type catalog.","format":"uuid","type":"string"},"good_uid":{"description":"Existing good UID from the goods catalog.","format":"uuid","type":"string"},"create_handling_unit":{"$ref":"#/components/schemas/NewDeliveryLoads_create_handling_unit"},"create_good":{"$ref":"#/components/schemas/NewDeliveryLoads_create_good"},"dangerous_goods_category":{"deprecated":true,"description":"ADR class","enum":["1","2","3","4.1","4.2","4.3","5.1","5.2","6.1","6.2","7","8","9"],"type":"string"},"is_dangerous":{"default":false,"description":"Indicates whether the load is dangerous. If true, the trucker has to confirm adr un code and legal mentions at unloading.","type":"boolean"},"adr_un_code":{"description":"Only for dangerous load, the official UN code from the ADR law.","type":"string"},"legal_mentions":{"description":"Only for dangerous load, all mandatory legal mentions printed on documents.","type":"string"},"complementary_information":{"description":"Any information about the load that doesn't fit to the description field.","type":"string"},"container_number":{"type":"string"},"tare_weight":{"description":"In kilograms","format":"float","type":"number"},"container_seal_number":{"type":"string"},"refrigerated":{"description":"Indicates whether the load is refrigerated. If true, the trucker can fill in the temperature.","type":"boolean"},"temperature":{"type":"string"},"steres":{"format":"float","type":"number"},"idtf_number":{"description":"Must match an existing IDTF number","type":"string"},"use_identifiers":{"description":"if `true`, trucker is asked to scan barcode identifiers on load","type":"boolean"},"identifiers":{"description":"Only relevant if use_identifiers is set to `true`. List of expected barcode identifiers that the trucker should scan at loading and unloading. App controls that expected barcodes are actually scanned. If empty, the trucker will have to scan barcodes anyway, but there won't be any check. Feature has to be activated in your account by your Dashdoc projet manager.","items":{"type":"string"},"type":"array"},"identifiers_observations":{"description":"Observations explaining issues with identifier, such as missing or unexpected identifiers","type":"string"}},"type":"object"},"NewDeliveryLoads_create_handling_unit":{"description":"Create a handling unit in the catalog and use its UID for this load. If provided, it silently overrides `handling_unit_uid`.","nullable":true,"properties":{"name":{"type":"string"},"dashdoc_load_category":{"type":"string"},"remote_id":{"type":"string"}},"type":"object"},"NewDeliveryLoads_create_good":{"description":"Create a good in the catalog and use its UID for this load. If provided, it silently overrides `good_uid`.","nullable":true,"properties":{"name":{"type":"string"},"additional_information":{"type":"string"},"remote_id":{"type":"string"}},"type":"object"}}}}
```

## The DockActivity object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"DockActivity":{"properties":{"uid":{"description":"uid of this Activity","format":"uuid","type":"string"},"transport_uid":{"description":"uid of the transport containing this Activity","format":"uuid","type":"string"},"transport_tags":{"items":{"type":"string"},"type":"array"},"dock_done_observations":{"description":"Observations set by dock when activity was done by dock","type":"string"},"dock_done_date":{"format":"date-time","type":"string"},"trucker":{"$ref":"#/components/schemas/DockActivity_trucker"},"carrier":{"$ref":"#/components/schemas/DockActivity_carrier"},"shipper":{"$ref":"#/components/schemas/DockActivity_shipper"},"shipper_reference":{"description":"Shipper reference on the activity's transport","type":"string"},"vehicle":{"$ref":"#/components/schemas/DockActivity_vehicle"},"trailer":{"type":"object"},"category":{"description":"Type of the activity. Possible values: loading, unloading, breaking, resuming","type":"string"},"loads":{"items":{"$ref":"#/components/schemas/DockActivity_loads"},"type":"array"}},"type":"object"},"DockActivity_trucker":{"properties":{"pk":{"description":"Id of the trucker","type":"number"},"display_name":{"description":"Full name of the trucker","type":"string"}},"type":"object"},"DockActivity_carrier":{"properties":{"pk":{"description":"Id of the carrier","type":"number"},"name":{"description":"Name of the carrier","type":"string"}},"type":"object"},"DockActivity_shipper":{"properties":{"pk":{"description":"Id of the shipping company","type":"number"},"name":{"description":"Name of the shipper","type":"string"}},"type":"object"},"DockActivity_vehicle":{"properties":{"pk":{"description":"Id of the vehicle","type":"number"},"license_plate":{"type":"string"}},"type":"object"},"DockActivity_loads":{"properties":{"uid":{"description":"Id of the load","format":"uuid","type":"string"},"description":{"description":"Description of the load","type":"string"},"loading_scheduled_date":{"description":"Date of scheduled loading","format":"date-time","type":"string"},"unloading_scheduled_date":{"description":"Date of scheduled unloading","format":"date-time","type":"string"},"loading_address":{"$ref":"#/components/schemas/DockActivity_loading_address"},"unloading_address":{"$ref":"#/components/schemas/DockActivity_loading_address"},"quantity":{"format":"float","type":"number"},"category":{"description":"Packaging of the load. The text is free but these specific values cause a custom flow on the mobile app: `pallets`, `containers`, `bulk`, `roundwood`, `powder_tank`, `bulk_qualimat`, `rental`.","type":"string"},"complementary_information":{"description":"Any information about the load that doesn't fit to the description field","type":"string"},"weight":{"description":"In kilograms","format":"float","type":"number"},"volume":{"description":"Volume of load in m3","format":"float","type":"number"},"volume_display_unit":{"default":"m3","enum":["m3","L"],"type":"string"},"linear_meters":{"description":"Length of load in meters","format":"float","type":"number"},"is_dangerous":{"type":"boolean"}},"type":"object"},"DockActivity_loading_address":{"properties":{"name":{"type":"string"},"address":{"type":"string"},"city":{"type":"string"},"postcode":{"type":"string"},"country":{"$ref":"#/components/schemas/country"}},"type":"object"},"country":{"description":"Only the 2-character codification is accepted (ISO 3166-1 alpha-2)","type":"string"}}}}
```

## The InvoiceCreatedBy object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"InvoiceCreatedBy":{"properties":{"pk":{"description":"Dashdoc's internal id.","type":"number"},"name":{"type":"string"},"primary_address":{"$ref":"#/components/schemas/PrimaryAddress_1"},"country":{"$ref":"#/components/schemas/country"},"vat_number":{"type":"string"}},"type":"object"},"PrimaryAddress_1":{"properties":{"pk":{"description":"Dashdoc's internal id.","type":"number"},"name":{"type":"string"},"address":{"type":"string"},"city":{"type":"string"},"postcode":{"type":"string"},"country":{"$ref":"#/components/schemas/country"},"latitude":{"$ref":"#/components/schemas/latitude"},"longitude":{"$ref":"#/components/schemas/longitude"},"radius":{"default":500,"description":"Radius around the GPS coordinates within which the address is located (in meters)","type":"integer"},"coords_validated":{"default":false,"description":"if `true`, when this address is used as a loading or unloading site, the mobile app displays an itinerary button to start GPS app with guidance to these coordinates","type":"boolean"},"is_demo":{"$ref":"#/components/schemas/is_demo"},"is_carrier":{"description":"Whether this company is considered a carrier","type":"boolean"},"is_shipper":{"description":"Whether this company is considered a shipper","type":"boolean"},"is_origin":{"description":"Legacy, not relevant for a company's primary address. Consider creating a separate address associated with this partner instead.\n","type":"boolean"},"is_destination":{"description":"Legacy, not relevant for a company's primary address. Consider creating a separate address associated with this partner instead.\n","type":"boolean"},"created_by":{"$ref":"#/components/schemas/created-by"},"created_by_user":{"$ref":"#/components/schemas/created-by-user"},"created":{"$ref":"#/components/schemas/created"},"remote_id":{"description":"The id of the address in your system.","type":"string"}},"type":"object"},"country":{"description":"Only the 2-character codification is accepted (ISO 3166-1 alpha-2)","type":"string"},"latitude":{"description":"Latitude using the decimal GPS coordinates (WGS84). At 7 decimals, the position is accurate around the centimeter.","format":"float","nullable":true,"type":"number"},"longitude":{"description":"Longitude using the decimal GPS coordinates (WGS84). At 7 decimals, the position is accurate around the centimeter.","format":"float","nullable":true,"type":"number"},"is_demo":{"description":"Indicates that the address is a fake one created from demonstration. Everything linked to it will be deleted when using the 'Delete demo content' button in company parameters","type":"boolean"},"created-by":{"nullable":true,"properties":{"pk":{"description":"company id","type":"number"},"name":{"description":"name of the company","type":"string"}},"type":"object"},"created-by-user":{"nullable":true,"properties":{"pk":{"type":"number"},"display_name":{"type":"string"},"company":{"description":"The company id who created the address","type":"number"},"trucker_id":{"description":"The trucker id who created the address","type":"number"}},"type":"object"},"created":{"description":"Date of creation on our server","format":"date-time","type":"string"}}}}
```

## The InvoiceDebtor object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"InvoiceDebtor":{"properties":{"pk":{"description":"Dashdoc's internal id.","type":"number"},"invoicing_remote_id":{"description":"The id of the company in your invoicing system.","type":"string"},"name":{"type":"string"},"primary_address":{"$ref":"#/components/schemas/PrimaryAddress_1"},"country":{"$ref":"#/components/schemas/country"},"vat_number":{"type":"string"}},"type":"object"},"PrimaryAddress_1":{"properties":{"pk":{"description":"Dashdoc's internal id.","type":"number"},"name":{"type":"string"},"address":{"type":"string"},"city":{"type":"string"},"postcode":{"type":"string"},"country":{"$ref":"#/components/schemas/country"},"latitude":{"$ref":"#/components/schemas/latitude"},"longitude":{"$ref":"#/components/schemas/longitude"},"radius":{"default":500,"description":"Radius around the GPS coordinates within which the address is located (in meters)","type":"integer"},"coords_validated":{"default":false,"description":"if `true`, when this address is used as a loading or unloading site, the mobile app displays an itinerary button to start GPS app with guidance to these coordinates","type":"boolean"},"is_demo":{"$ref":"#/components/schemas/is_demo"},"is_carrier":{"description":"Whether this company is considered a carrier","type":"boolean"},"is_shipper":{"description":"Whether this company is considered a shipper","type":"boolean"},"is_origin":{"description":"Legacy, not relevant for a company's primary address. Consider creating a separate address associated with this partner instead.\n","type":"boolean"},"is_destination":{"description":"Legacy, not relevant for a company's primary address. Consider creating a separate address associated with this partner instead.\n","type":"boolean"},"created_by":{"$ref":"#/components/schemas/created-by"},"created_by_user":{"$ref":"#/components/schemas/created-by-user"},"created":{"$ref":"#/components/schemas/created"},"remote_id":{"description":"The id of the address in your system.","type":"string"}},"type":"object"},"country":{"description":"Only the 2-character codification is accepted (ISO 3166-1 alpha-2)","type":"string"},"latitude":{"description":"Latitude using the decimal GPS coordinates (WGS84). At 7 decimals, the position is accurate around the centimeter.","format":"float","nullable":true,"type":"number"},"longitude":{"description":"Longitude using the decimal GPS coordinates (WGS84). At 7 decimals, the position is accurate around the centimeter.","format":"float","nullable":true,"type":"number"},"is_demo":{"description":"Indicates that the address is a fake one created from demonstration. Everything linked to it will be deleted when using the 'Delete demo content' button in company parameters","type":"boolean"},"created-by":{"nullable":true,"properties":{"pk":{"description":"company id","type":"number"},"name":{"description":"name of the company","type":"string"}},"type":"object"},"created-by-user":{"nullable":true,"properties":{"pk":{"type":"number"},"display_name":{"type":"string"},"company":{"description":"The company id who created the address","type":"number"},"trucker_id":{"description":"The trucker id who created the address","type":"number"}},"type":"object"},"created":{"description":"Date of creation on our server","format":"date-time","type":"string"}}}}
```

## The InvoiceLineGroup object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"InvoiceLineGroup":{"properties":{"transport":{"$ref":"#/components/schemas/InvoiceTransport"},"lines":{"description":"List of lines of the invoice for the transport associated with this line group.","items":{"$ref":"#/components/schemas/InvoiceLine"},"type":"array"},"description":{"description":"Description of the group of line of the invoice","type":"string"},"currency":{"type":"string"},"gas_index":{"nullable":true,"readOnly":true,"type":"string"},"gas_index_invoice_item":{"$ref":"#/components/schemas/InvoiceItem"}},"type":"object"},"InvoiceTransport":{"properties":{"uid":{"description":"uuid of the Transport","format":"uuid","type":"string"},"sequential_id":{"type":"number"},"deliveries":{"items":{"$ref":"#/components/schemas/InvoiceDelivery"},"type":"array"},"documents":{"description":"See https://developer.dashdoc.eu/docs/tutorials/retrieve-transport-tracking-data#get-documents-and-photos-with-their-type","items":{"$ref":"#/components/schemas/InvoiceDocument"},"type":"array"},"messages":{"description":"See https://developer.dashdoc.eu/docs/tutorials/retrieve-transport-tracking-data#get-documents-and-photos-with-their-type","items":{"$ref":"#/components/schemas/InvoiceMessage"},"type":"array"}},"type":"object"},"InvoiceDelivery":{"properties":{"uid":{"description":"uuid of the Delivery","format":"uuid","type":"string"},"origin":{"$ref":"#/components/schemas/InvoiceSite"},"destination":{"$ref":"#/components/schemas/InvoiceSite"}},"type":"object"},"InvoiceSite":{"properties":{"uid":{"type":"string"},"company_name":{"type":"string"},"city":{"type":"string"}},"type":"object"},"InvoiceDocument":{"properties":{"delivery":{"description":"uuid of the Delivery","format":"uuid","type":"string"},"file":{"description":"path of the document","format":"url","type":"string"},"reference":{"type":"string"},"category":{"description":"Type of document. Possible values are \"cmr\", \"cmr4\", \"ldv\", \"orc\", \"chc\", \"rental\" and \"loading_plan\"","type":"string"}},"type":"object"},"InvoiceMessage":{"properties":{"document":{"description":"path of the document","format":"url","type":"string"},"reference":{"type":"string"},"document_type":{"enum":["load_photo","cmr","washing_note","delivery_note","confirmation","weight_note","waste_manifest","holders_swap_note","invoice"],"maxLength":100,"type":"string"}},"type":"object"},"InvoiceLine":{"properties":{"description":{"description":"Description of the line of the invoice","type":"string"},"quantity":{"type":"number"},"unit_price":{"type":"number"},"currency":{"type":"string"},"total_price_without_tax":{"type":"number"},"invoice_item":{"$ref":"#/components/schemas/InvoiceItem"},"is_gas_indexed":{"description":"Whether this invoice line is subject to gas indexation","nullable":true,"readOnly":true,"type":"boolean"}},"type":"object"},"InvoiceItem":{"properties":{"uid":{"format":"uuid","type":"string"},"remote_id":{"description":"The id of the invoice item in your system","type":"string"},"description":{"description":"Default description when a user selects this invoice item for an invoice line","type":"string"}},"type":"object"}}}}
```

## The InvoiceLine object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"InvoiceLine":{"properties":{"description":{"description":"Description of the line of the invoice","type":"string"},"quantity":{"type":"number"},"unit_price":{"type":"number"},"currency":{"type":"string"},"total_price_without_tax":{"type":"number"},"invoice_item":{"$ref":"#/components/schemas/InvoiceItem"},"is_gas_indexed":{"description":"Whether this invoice line is subject to gas indexation","nullable":true,"readOnly":true,"type":"boolean"}},"type":"object"},"InvoiceItem":{"properties":{"uid":{"format":"uuid","type":"string"},"remote_id":{"description":"The id of the invoice item in your system","type":"string"},"description":{"description":"Default description when a user selects this invoice item for an invoice line","type":"string"}},"type":"object"}}}}
```

## The User object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"User":{"properties":{"pk":{"description":"Dashdoc's internal id.","type":"number"},"username":{"description":"Ignore. Dashdoc technical data.","type":"string"},"display_name":{"description":"Display name generated by Dashdoc.","type":"string"},"email":{"format":"email","type":"string"},"date_joined":{"description":"Ignore. Dashdoc technical data.","format":"date-time","type":"string"},"last_login":{"description":"Ignore. Dashdoc technical data.","format":"date-time","type":"string"},"has_usable_password":{"description":"Ignore. Dashdoc technical data.","type":"boolean"},"first_name":{"type":"string"},"last_name":{"type":"string"}},"type":"object"}}}}
```

## The NewUser object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"NewUser":{"properties":{"email":{"format":"email","type":"string"},"first_name":{"maxLength":200,"type":"string"},"last_name":{"maxLength":200,"type":"string"}},"type":"object"}}}}
```

## The Unavailability object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"Unavailability":{"properties":{"id":{"description":"Dashdoc's internal id","type":"number"},"remote_id":{"description":"The ID of the unavailability in your system","type":"string"},"created":{"description":"Date of creation on our server","format":"date-time","type":"string"},"start_date":{"description":"Start date of the unavailability","format":"date-time","type":"string"},"end_date":{"description":"End date of the unavailability","format":"date-time","type":"string"},"unavailability_type":{"description":"Type of unavailability","enum":["paid_vacation","day_off","sick_leave","training","vacation","maintenance","rental","other"],"type":"string"},"unavailability_note":{"description":"Notes about the unavailability","type":"string"}},"type":"object"}}}}
```

## The CreateOrUpdateSite\_1 object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"CreateOrUpdateSite_1":{"properties":{"remote_id":{"description":"The id of the site in your system","type":"string"},"address":{"$ref":"#/components/schemas/AddressGetOrCreate"},"loading_instructions":{"$ref":"#/components/schemas/loading_instructions"},"unloading_instructions":{"$ref":"#/components/schemas/unloading_instructions"},"instructions":{"$ref":"#/components/schemas/site_instructions"},"reference":{"type":"string"},"action":{"deprecated":true,"description":"Deprecated. Accepted for backward compatibility but ignored.","type":"string"},"eta":{"nullable":true,"type":"string"},"supports_exchanges":{"$ref":"#/components/schemas/CreateOrUpdateSupportsExchangeForTransport"},"arrival_date":{"description":"expected arrival date (YYYY-MM-DD)","format":"date","type":"string"},"arrival_time_min":{"description":"expected arrival min time (HH:mm)","type":"string"},"arrival_time_max":{"description":"expected arrival max time (HH:mm)","type":"string"},"date_exact":{"description":"if `true`, `arrival_time_max` is considered as being on the following day from `arrival_date`","type":"boolean"},"trucker_instructions":{"$ref":"#/components/schemas/trucker_instructions"}},"type":"object"},"AddressGetOrCreate":{"description":"Identification of the address. You may simply use its `pk` or `remote_id` if the address already exists, or you can send address details as in /addresses/ web service. The address may be recognized with its details or if it doesn't exist, the address will be created with the information you send based on what's possible when creating an address via /addresses/ web service.","properties":{"pk":{"description":"Dashdoc's internal id.","type":"number"},"remote_id":{"description":"The id of the address in your system.","type":"string"}},"type":"object"},"loading_instructions":{"deprecated":true,"description":"**Prefer using the field `instructions`.** Loading instructions, visible to all parties (trucker, carrier, shipper, site). Displayed in the trucker mobile app. Not visible in the eCMR.","maxLength":1000,"type":"string"},"unloading_instructions":{"deprecated":true,"description":"**Prefer using the field `instructions`.** Unloading instructions, visible to all parties (trucker, carrier, shipper, site). Displayed in the trucker mobile app. Not visible in the eCMR.","maxLength":1000,"type":"string"},"site_instructions":{"description":"Site instructions, visible to all parties (trucker, carrier, shipper, site). Displayed in the trucker mobile app. Not visible in the eCMR. If the field is not provided, the address's site instructions will be used.","maxLength":1000,"type":"string"},"CreateOrUpdateSupportsExchangeForTransport":{"properties":{"support_type":{"$ref":"#/components/schemas/CreateOrUpdateSupportsExchangeForTransport_support_type"},"expected_retrieved":{"description":"Expected number of supports that should be retrieved on the site","type":"number"},"actual_retrieved":{"description":"Actual number of supports that were retrieved on the site","type":"number"},"expected_delivered":{"description":"Expected number of supports that should be delivered on the site","type":"number"},"actual_delivered":{"description":"Actual number of supports that were delivered on the site","type":"number"},"observations":{"description":"Free text. Observations about this supports exchange. Can be filled on mobile app, web app or via API.","type":"string"}},"required":["support_type"],"type":"object"},"CreateOrUpdateSupportsExchangeForTransport_support_type":{"description":"Type of the supports that are exchanged","properties":{"uid":{"format":"uuid","type":"string"},"remote_id":{"description":"The id of the support type in your system.","type":"string"}},"type":"object"},"trucker_instructions":{"description":"**This field is part of a beta feature.** Private instructions. **The carrier of the transport is the only one who can edit and read those instructions.** Note that those instructions are not visible in the consignment note and can be accessed by the trucker. The value is null if the caller doesn't have the right of access to the data.","maxLength":1000,"type":"string"}}}}
```

## The VehicleForSegment object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"VehicleForSegment":{"properties":{"license_plate":{"description":"License plate number. Creates a new vehicle if unknown.","maxLength":200,"type":"string"}},"type":"object"}}}}
```

## The TrailerForSegment object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"TrailerForSegment":{"properties":{"license_plate":{"description":"License plate number. Creates a new trailer if unknown.","maxLength":200,"type":"string"}},"type":"object"}}}}
```

## The SegmentTrucker object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"SegmentTrucker":{"properties":{"pk":{"description":"Dashdoc's internal id.","type":"number"},"remote_id":{"description":"The ID of the trucker in your system. It has to be unique among all your truckers.","type":"string"},"display_name":{"type":"string"},"user":{"$ref":"#/components/schemas/SegmentTruckerUser"}},"type":"object"},"SegmentTruckerUser":{"properties":{"pk":{"description":"Dashdoc's internal id.","type":"number"},"first_name":{"type":"string"},"last_name":{"type":"string"},"username":{"description":"Ignore. Dashdoc technical data.","type":"string"},"email":{"format":"email","type":"string"},"display_name":{"description":"Display name generated by Dashdoc.","type":"string"},"date_joined":{"description":"Ignore. Dashdoc technical data.","format":"date-time","type":"string"},"is_staff":{"description":"Ignore. Dashdoc technical data.","type":"boolean"},"is_superuser":{"description":"Ignore. Dashdoc technical data.","type":"boolean"},"has_usable_password":{"description":"Ignore. Dashdoc technical data.","type":"boolean"}},"type":"object"}}}}
```

## The TruckerForSegment object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"TruckerForSegment":{"properties":{"pk":{"description":"Dashdoc's internal id. Optional, not required if `remote_id` is sent.","type":"number"},"remote_id":{"description":"The ID of the trucker in your system. Optional, ignored if pk is sent.","type":"string"}},"type":"object"}}}}
```

## The AddressForTransport object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"AddressForTransport":{"properties":{"pk":{"description":"Dashdoc's internal id.","type":"number"},"name":{"type":"string"},"address":{"type":"string"},"city":{"type":"string"},"postcode":{"type":"string"},"country":{"$ref":"#/components/schemas/country"},"latitude":{"$ref":"#/components/schemas/latitude"},"longitude":{"$ref":"#/components/schemas/longitude"},"radius":{"default":500,"description":"Radius around the GPS coordinates within which the address is located (in meters)","type":"integer"},"coords_validated":{"default":false,"description":"if `true`, when this address is used as a loading or unloading site, the mobile app displays an itinerary button to start GPS app with guidance to these coordinates","type":"boolean"},"is_demo":{"$ref":"#/components/schemas/is_demo"},"is_carrier":{"type":"boolean"},"is_shipper":{"type":"boolean"},"is_origin":{"$ref":"#/components/schemas/address_is_origin_and_is_destination"},"is_destination":{"$ref":"#/components/schemas/address_is_origin_and_is_destination"},"created_by":{"type":"number"},"created":{"$ref":"#/components/schemas/created"},"remote_id":{"description":"The id of the address in your system.","type":"string"},"company":{"$ref":"#/components/schemas/CompanyForTransportAddress"},"original":{"type":"number"}},"type":"object"},"country":{"description":"Only the 2-character codification is accepted (ISO 3166-1 alpha-2)","type":"string"},"latitude":{"description":"Latitude using the decimal GPS coordinates (WGS84). At 7 decimals, the position is accurate around the centimeter.","format":"float","nullable":true,"type":"number"},"longitude":{"description":"Longitude using the decimal GPS coordinates (WGS84). At 7 decimals, the position is accurate around the centimeter.","format":"float","nullable":true,"type":"number"},"is_demo":{"description":"Indicates that the address is a fake one created from demonstration. Everything linked to it will be deleted when using the 'Delete demo content' button in company parameters","type":"boolean"},"address_is_origin_and_is_destination":{"description":"Whether this address is a \"Logistic Points\" and will be usable as pickup/delivery point.\nThe distinction between origin/pickup and destination/delivery was merged as a single \"Logistic Point\" concept. `is_origin` implies `is_destination` and vice-versa.\n","type":"boolean"},"created":{"description":"Date of creation on our server","format":"date-time","type":"string"},"CompanyForTransportAddress":{"properties":{"pk":{"description":"Dashdoc's internal id.","type":"number"},"remote_id":{"description":"The id of the company in your system.","type":"string"},"name":{"type":"string"},"trade_number":{"type":"string"},"country":{"$ref":"#/components/schemas/country"},"settings_contract_html":{"description":"Ignore. Dashdoc technical data.","type":"string"},"settings_logo":{"description":"Ignore. Dashdoc technical data.","nullable":true,"type":"string"},"settings_stamp":{"description":"Ignore. Dashdoc technical data.","nullable":true,"type":"string"},"settings_print_mode":{"description":"Ignore. Dashdoc technical data.","type":"boolean"},"settings_special_agreements":{"description":"Ignore. Dashdoc technical data.","type":"string"},"settings_transport_order_observations":{"type":"string"},"settings_constrain_reference_edition":{"type":"boolean"},"vat_number":{"type":"string"},"is_verified":{"type":"boolean"}},"type":"object"}}}}
```

## The CarrierAssignationStatus object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"CarrierAssignationStatus":{"description":"Carrier assignment state of an order (Only for chartered transport). Null values should be treated as unassigned.","enum":["unassigned","draft_assigned","assigned"],"type":"string"}}}}
```

## The Status object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"Status":{"properties":{"uid":{"format":"uuid","type":"string"},"created":{"description":"Date of creation on the server. Useful when the transport is created by mobile devices. If network connection is bad, the `created` date can be later than `created_device`","format":"date-time","type":"string"},"created_device":{"description":"If created from a mobile device, date of creation on the device.","format":"date-time","type":"string"},"creation_method":{"type":"string"},"category":{"description":"event that occured on the transport","type":"string"},"author":{"description":"details about author of the update. Contact Dashdoc if more details is needed.","type":"object"},"content":{"description":"Contact Dashdoc if more details is needed.","type":"object"},"content_signatory":{"description":"Contact Dashdoc if more details is needed.","type":"object"},"target":{"description":"Contact Dashdoc if more details is needed.","type":"object"},"site":{"description":"Contact Dashdoc if more details is needed.","type":"object"},"site_id":{"description":"Contact Dashdoc if more details is needed.","format":"uuid","type":"string"},"delivery":{"description":"Contact Dashdoc if more details is needed.","format":"uuid","type":"string"},"segment":{"description":"Contact Dashdoc if more details is needed.","format":"uuid","type":"string"},"transport":{"description":"Contact Dashdoc if more details is needed.","format":"uuid","type":"string"},"signature":{"description":"Contact Dashdoc if more details is needed.","type":"object"},"latitude":{"description":"Contact Dashdoc if more details is needed.","format":"float","type":"number"},"longitude":{"description":"Contact Dashdoc if more details is needed.","format":"float","type":"number"},"update_details":{"description":"Contact Dashdoc if more details is needed.","type":"object"},"author_company":{"type":"number"}},"required":["uid"],"type":"object"}}}}
```

## The requested\_vehicle object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"requested_vehicle":{"description":"Only useful when the transport is created by the shipper. Free text except punction and special characters.","maxLength":40,"type":"string"}}}}
```

## The Document object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"Document":{"properties":{"pk":{"type":"integer"},"file_updated_date":{"description":"Date was updated on the server.","format":"date-time","type":"string"},"delivery":{"description":"Contact Dashdoc if more details are needed.","format":"uuid","type":"string"},"delivery_sequential_id":{"description":"eCMR number (for category \"cmr\" and \"ldv\")","type":"integer"},"reference":{"type":"integer"},"category":{"description":"Type of document. Possible values are \"cmr\", \"cmr4\", \"ldv\", \"orc\", \"chc\", \"rental\" and \"loading_plan\"","type":"string"},"languages":{"description":"Languages displayed in the document (CMR only), formatted as an 2-letter ISO 639-1 language code","items":{"type":"string"},"type":"array"},"name":{"description":"generic name of the document","type":"string"},"file":{"description":"path to the document","format":"url","type":"string"},"business_privacy_scope":{"description":"Ignore. Dashdoc technical data.","type":"boolean"},"cancelled":{"description":"Date of cancellation of the the document","format":"date-time","type":"string"}},"type":"object"}}}}
```

## The deprecated\_price object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"deprecated_price":{"deprecated":true,"description":"Full price for the transport","format":"float","nullable":true,"type":"number"}}}}
```

## The customer\_to\_invoice object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"customer_to_invoice":{"properties":{"pk":{"description":"Dashdoc's internal id.","type":"number"},"name":{"type":"string"},"invoicing_address":{"$ref":"#/components/schemas/customer_to_invoice_invoicing_address"}},"type":"object"},"customer_to_invoice_invoicing_address":{"properties":{"address":{"type":"string"},"city":{"type":"string"},"postcode":{"type":"string"},"country":{"$ref":"#/components/schemas/country"}},"type":"object"},"country":{"description":"Only the 2-character codification is accepted (ISO 3166-1 alpha-2)","type":"string"}}}}
```

## The global\_instructions object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"global_instructions":{"description":"Operating instructions. The carrier, the shipper and the creator of the transport have access to those instructions. However, the creator is the only who has the right to edit.","maxLength":1000,"type":"string"}}}}
```

## The CreateOrUpdateSite\_2 object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"CreateOrUpdateSite_2":{"properties":{"remote_id":{"description":"The id of the site in your system","type":"string"},"address":{"$ref":"#/components/schemas/AddressGetOrCreate"},"loading_instructions":{"$ref":"#/components/schemas/loading_instructions"},"unloading_instructions":{"$ref":"#/components/schemas/unloading_instructions"},"instructions":{"$ref":"#/components/schemas/site_instructions"},"reference":{"type":"string"},"action":{"deprecated":true,"description":"Deprecated. Accepted for backward compatibility but ignored.","type":"string"},"eta":{"nullable":true,"type":"string"},"supports_exchanges":{"$ref":"#/components/schemas/CreateOrUpdateSupportsExchangeForTransport"},"arrival_date":{"description":"expected arrival date (YYYY-MM-DD)","format":"date","type":"string"},"arrival_time_min":{"description":"expected arrival min time (HH:mm)","type":"string"},"arrival_time_max":{"description":"expected arrival max time (HH:mm)","type":"string"},"date_exact":{"description":"if `true`, `arrival_time_max` is considered as being on the following day from `arrival_date`","type":"boolean"},"trucker_instructions":{"$ref":"#/components/schemas/trucker_instructions"}},"type":"object"},"AddressGetOrCreate":{"description":"Identification of the address. You may simply use its `pk` or `remote_id` if the address already exists, or you can send address details as in /addresses/ web service. The address may be recognized with its details or if it doesn't exist, the address will be created with the information you send based on what's possible when creating an address via /addresses/ web service.","properties":{"pk":{"description":"Dashdoc's internal id.","type":"number"},"remote_id":{"description":"The id of the address in your system.","type":"string"}},"type":"object"},"loading_instructions":{"deprecated":true,"description":"**Prefer using the field `instructions`.** Loading instructions, visible to all parties (trucker, carrier, shipper, site). Displayed in the trucker mobile app. Not visible in the eCMR.","maxLength":1000,"type":"string"},"unloading_instructions":{"deprecated":true,"description":"**Prefer using the field `instructions`.** Unloading instructions, visible to all parties (trucker, carrier, shipper, site). Displayed in the trucker mobile app. Not visible in the eCMR.","maxLength":1000,"type":"string"},"site_instructions":{"description":"Site instructions, visible to all parties (trucker, carrier, shipper, site). Displayed in the trucker mobile app. Not visible in the eCMR. If the field is not provided, the address's site instructions will be used.","maxLength":1000,"type":"string"},"CreateOrUpdateSupportsExchangeForTransport":{"properties":{"support_type":{"$ref":"#/components/schemas/CreateOrUpdateSupportsExchangeForTransport_support_type"},"expected_retrieved":{"description":"Expected number of supports that should be retrieved on the site","type":"number"},"actual_retrieved":{"description":"Actual number of supports that were retrieved on the site","type":"number"},"expected_delivered":{"description":"Expected number of supports that should be delivered on the site","type":"number"},"actual_delivered":{"description":"Actual number of supports that were delivered on the site","type":"number"},"observations":{"description":"Free text. Observations about this supports exchange. Can be filled on mobile app, web app or via API.","type":"string"}},"required":["support_type"],"type":"object"},"CreateOrUpdateSupportsExchangeForTransport_support_type":{"description":"Type of the supports that are exchanged","properties":{"uid":{"format":"uuid","type":"string"},"remote_id":{"description":"The id of the support type in your system.","type":"string"}},"type":"object"},"trucker_instructions":{"description":"**This field is part of a beta feature.** Private instructions. **The carrier of the transport is the only one who can edit and read those instructions.** Note that those instructions are not visible in the consignment note and can be accessed by the trucker. The value is null if the caller doesn't have the right of access to the data.","maxLength":1000,"type":"string"}}}}
```

## The PlannedLoads object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"PlannedLoads":{"properties":{"uid":{"description":"Dashdoc's internal id.","type":"string"},"remote_id":{"description":"The ID of the load in your system. It has to be unique among all your transports.","type":"string"},"description":{"description":"Text description of the load","type":"string"},"reference":{"description":"Reference of the load","type":"string"},"weight":{"description":"In kilograms","format":"float","type":"number"},"volume":{"description":"Volume of load in m3","format":"float","type":"number"},"volume_display_unit":{"default":"m3","enum":["m3","L"],"type":"string"},"linear_meters":{"description":"Length of load in meters","format":"float","type":"number"},"quantity":{"description":"Only one decimal accepted (e.g 0.0)","format":"float","type":"number"},"pallet_equivalence":{"description":"Pallet equivalence (EPS/EQPAL): how many standard pallet spaces the load occupies. `null` when it was never set. Otherwise at least `0.01`, with two decimals kept.","format":"float","nullable":true,"type":"number"},"category":{"description":"Packaging of the load. The text is free but these specific values cause a custom flow on the mobile app: `pallets`, `containers`, `bulk`, `roundwood`, `powder_tank`, `bulk_qualimat`, `rental`.","type":"string"},"dangerous_goods_category":{"description":"ADR class","enum":["1","2","3","4.1","4.2","4.3","5.1","5.2","6.1","6.2","7","8","9"],"type":"string"},"is_dangerous":{"type":"boolean"},"adr_un_code":{"type":"string"},"legal_mentions":{"type":"string"},"complementary_information":{"description":"Any information about the load that doesn't fit to the description field","type":"string"},"container_number":{"type":"string"},"tare_weight":{"description":"In kilograms","format":"float","type":"number"},"container_seal_number":{"type":"string"},"refrigerated":{"description":"Indicates whether the load is refrigerated. If true, the trucker can fill in the temperature.","type":"boolean"},"temperature":{"type":"string"},"steres":{"format":"float","type":"number"},"idtf_number":{"description":"Must match an existing IDTF number","type":"string"},"use_identifiers":{"description":"if `true`, trucker is asked to scan barcode identifiers on load","type":"boolean"},"identifiers":{"description":"Only relevant if use_identifiers is set to `true`. List of expected barcode identifiers that the trucker should scan at loading and unloading. App controls that expected barcodes are actually scanned. If empty, the trucker will have to scan barcodes anyway, but there won't be any check. Feature has to be activated in your account by your Dashdoc projet manager.","type":"string"},"identifiers_observations":{"description":"Observations explaining issues with identifier, such as missing or unexpected identifiers","type":"string"}},"type":"object"}}}}
```

## The eta\_tracking object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"eta_tracking":{"default":false,"description":"Ask for an ETA on this site. This is currently a beta feature, not activated by default.","type":"boolean"}}}}
```

## The punctuality\_status object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"punctuality_status":{"default":"untracked","description":"Indicate the punctuality on this site.","enum":["untracked","probably_late","probably_on_time","late","on_time"],"type":"string"}}}}
```

## The trucker\_instructions object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"trucker_instructions":{"description":"**This field is part of a beta feature.** Private instructions. **The carrier of the transport is the only one who can edit and read those instructions.** Note that those instructions are not visible in the consignment note and can be accessed by the trucker. The value is null if the caller doesn't have the right of access to the data.","maxLength":1000,"type":"string"}}}}
```

## The SiteAddress object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"SiteAddress":{"description":"Address of the site. Reference an existing address with its `pk` or `remote_id`, or send its details to have it matched or created.","properties":{"pk":{"description":"Dashdoc's internal id. Optional, set it to reference an existing address.","type":"integer"},"name":{"type":"string"},"address":{"type":"string"},"city":{"type":"string"},"postcode":{"type":"string"},"country":{"$ref":"#/components/schemas/country"},"latitude":{"$ref":"#/components/schemas/latitude"},"longitude":{"$ref":"#/components/schemas/longitude"},"radius":{"default":500,"description":"Radius around the GPS coordinates within which the address is located (in meters)","type":"integer"},"coords_validated":{"default":false,"description":"if `true`, when this address is used as a loading or unloading site, the mobile app displays an itinerary button to start GPS app with guidance to these coordinates","type":"boolean"},"is_demo":{"$ref":"#/components/schemas/is_demo"},"is_carrier":{"type":"boolean"},"is_shipper":{"type":"boolean"},"is_origin":{"$ref":"#/components/schemas/address_is_origin_and_is_destination"},"is_destination":{"$ref":"#/components/schemas/address_is_origin_and_is_destination"},"instructions":{"$ref":"#/components/schemas/site_instructions"},"remote_id":{"description":"The id of the address in your system.","type":"string"},"company":{"$ref":"#/components/schemas/CompanyForTransportAddress_1"}},"type":"object"},"country":{"description":"Only the 2-character codification is accepted (ISO 3166-1 alpha-2)","type":"string"},"latitude":{"description":"Latitude using the decimal GPS coordinates (WGS84). At 7 decimals, the position is accurate around the centimeter.","format":"float","nullable":true,"type":"number"},"longitude":{"description":"Longitude using the decimal GPS coordinates (WGS84). At 7 decimals, the position is accurate around the centimeter.","format":"float","nullable":true,"type":"number"},"is_demo":{"description":"Indicates that the address is a fake one created from demonstration. Everything linked to it will be deleted when using the 'Delete demo content' button in company parameters","type":"boolean"},"address_is_origin_and_is_destination":{"description":"Whether this address is a \"Logistic Points\" and will be usable as pickup/delivery point.\nThe distinction between origin/pickup and destination/delivery was merged as a single \"Logistic Point\" concept. `is_origin` implies `is_destination` and vice-versa.\n","type":"boolean"},"site_instructions":{"description":"Site instructions, visible to all parties (trucker, carrier, shipper, site). Displayed in the trucker mobile app. Not visible in the eCMR. If the field is not provided, the address's site instructions will be used.","maxLength":1000,"type":"string"},"CompanyForTransportAddress_1":{"description":"Identification of the company. You may simply use its `pk` or `remote_id` if the company already exists. Other possible identification method are its `trade_number` or `name`. If it doesn't exist, the company will be created with the information you send based on what's possible when creating a company via /companies/ web service. Minimum required information in this case is a name.","properties":{"pk":{"description":"Dashdoc's internal id.Optional, not required if `remote_id` is sent.","type":"integer"},"remote_id":{"description":"The id of the company in your system. Optional, ignored if `pk` is sent.","type":"string"},"trade_number":{"maxLength":100,"type":"string"},"name":{"maxLength":200,"type":"string"}},"type":"object"}}}}
```

## The SlotFields object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"SlotFields":{"description":"Custom fields for the slot","properties":{"references":{"description":"List of reference strings for the slot","items":{"maxLength":128,"type":"string"},"nullable":true,"type":"array"},"custom_field_1":{"description":"Value for the first custom field (if defined in the zone)","type":"string"},"custom_field_2":{"description":"Value for the second custom field (if defined in the zone)","type":"string"}},"type":"object"}}}}
```

## The created\_device object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"created_device":{"description":"Date of creation on device (ISO 8601)","format":"date-time","type":"string"}}}}
```

## The Compartment object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"Compartment":{"properties":{"compartment_number":{"type":"number"},"load":{"$ref":"#/components/schemas/DeliveryLoads"},"weight":{"description":"In kilograms","format":"float","type":"number"},"volume":{"description":"Volume of load in m3","format":"float","type":"number"},"volume_display_unit":{"default":"m3","enum":["m3","L"],"type":"string"},"unloading_status":{"enum":["","fully_unloaded","partially_unloaded","not_unloaded"],"type":"string"}},"type":"object"},"DeliveryLoads":{"properties":{"uid":{"description":"Dashdoc's internal id.","type":"string"},"remote_id":{"description":"The ID of the load in your system. It has to be unique among all your transports.","type":"string"},"description":{"description":"Text description of the load","type":"string"},"reference":{"description":"Reference of the load","type":"string"},"round_id":{"description":"The ID of the round.","format":"integer","type":"number"},"weight":{"description":"In kilograms","format":"float","type":"number"},"volume":{"description":"Volume of load in m3","format":"float","type":"number"},"volume_display_unit":{"default":"m3","enum":["m3","L"],"type":"string"},"linear_meters":{"description":"Length of load in meters","format":"float","type":"number"},"quantity":{"description":"Only one decimal accepted (e.g 0.0)","format":"float","type":"number"},"pallet_equivalence":{"description":"Pallet equivalence (EPS/EQPAL): how many standard pallet spaces the load occupies. `null` when it was never set. Otherwise at least `0.01`, with two decimals kept.","format":"float","nullable":true,"type":"number"},"category":{"description":"Packaging of the load. The text is free but these specific values cause a custom flow on the mobile app: `pallets`, `containers`, `bulk`, `roundwood`, `powder_tank`, `bulk_qualimat`, `rental`.","type":"string"},"dangerous_goods_category":{"description":"ADR class","enum":["1","2","3","4.1","4.2","4.3","5.1","5.2","6.1","6.2","7","8","9"],"type":"string"},"is_dangerous":{"type":"boolean"},"adr_un_code":{"type":"string"},"legal_mentions":{"type":"string"},"complementary_information":{"description":"Any information about the load that doesn't fit to the description field","type":"string"},"container_number":{"type":"string"},"tare_weight":{"description":"In kilograms","format":"float","type":"number"},"container_seal_number":{"type":"string"},"refrigerated":{"description":"Indicates whether the load is refrigerated. If true, the trucker can fill in the temperature.","type":"boolean"},"temperature":{"type":"string"},"steres":{"format":"float","type":"number"},"idtf_number":{"description":"Must match an existing IDTF number","type":"string"},"use_identifiers":{"description":"if `true`, trucker is asked to scan barcode identifiers on load","type":"boolean"},"identifiers":{"description":"Only relevant if use_identifiers is set to `true`. List of expected barcode identifiers that the trucker should scan at loading and unloading. App controls that expected barcodes are actually scanned. If empty, the trucker will have to scan barcodes anyway, but there won't be any check. Feature has to be activated in your account by your Dashdoc projet manager.","items":{"type":"string"},"type":"array"},"identifiers_observations":{"description":"Observations explaining issues with identifier, such as missing or unexpected identifiers","type":"string"}},"type":"object"}}}}
```

## The visible\_by\_everyone object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"visible_by_everyone":{"description":"This field is used to make the transport message public, which makes it visible by all parties of the transport.","type":"boolean"}}}}
```

## The readable\_by\_trucker object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"readable_by_trucker":{"description":"This field is used to allow truckers to see the transport message. **Only available for carriers.**","type":"boolean"}}}}
```

## The TransportsListItem object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"TransportsListItem":{"allOf":[{"$ref":"#/components/schemas/Transport"},{"$ref":"#/components/schemas/RetrievedTransport_allOf"}],"type":"object"},"Transport":{"properties":{"uid":{"description":"Dashdoc's internal id. It will be automatically generated by us.","format":"uuid","type":"string"},"sequential_id":{"type":"number"},"created":{"description":"Date of creation sent by the creator. Useful when the transport is created by mobile devices. If network connection is bad, the `created` date can be later than `created_device`","format":"date-time","type":"string"},"updated":{"format":"date-time","type":"string"},"deleted":{"nullable":true,"type":"string"},"remote_id":{"description":"Your transport id. It has to be unique among all your transports","type":"string"},"carrier_address":{"$ref":"#/components/schemas/AddressForTransport"},"created_by":{"$ref":"#/components/schemas/Company"},"created_device":{"format":"date-time","type":"string"},"creation_method":{"enum":["mobile_app","api","web_app"],"type":"string"},"archived_by":{"items":{"type":"object"},"type":"array"},"is_order":{"type":"boolean"},"carrier_assignation_status":{"allOf":[{"$ref":"#/components/schemas/CarrierAssignationStatus"}],"nullable":true},"invite_code":{"type":"string"},"deliveries":{"items":{"$ref":"#/components/schemas/Delivery"},"type":"array"},"segments":{"items":{"$ref":"#/components/schemas/Segment"},"type":"array"},"status":{"$ref":"#/components/schemas/Statuses"},"status_updates":{"items":{"$ref":"#/components/schemas/Status"},"type":"array"},"has_observations":{"type":"boolean"},"messages":{"items":{"$ref":"#/components/schemas/TransportMessage"},"type":"array"},"requested_vehicle":{"$ref":"#/components/schemas/requested_vehicle"},"documents":{"items":{"$ref":"#/components/schemas/Document"},"type":"array"},"carrier_reference":{"description":"Text that will help the carrier operators manage the transports, e.g. transport number in his TMS. It should only be set by the carrier of the transport and the transport's creator can toggle a company-wide setting to only allow the carrier to set it.","type":"string"},"price":{"$ref":"#/components/schemas/deprecated_price"},"requires_washing":{"description":"Flag to enable the truck washing flow in the mobile app","type":"boolean"},"business_privacy":{"description":"Flag to enable 'business privacy' mode: no eCMR will be generated, and the trucker won't be prompted to share the transport link.","type":"boolean"},"is_multiple_compartments":{"description":"Flag to enable 'multiple compartments' mode: truckers will have to select in which compartments loads were loaded. It also generates a specific delivery document : loading_plan.","type":"boolean"},"loading_plan":{"description":"Uid of the loading plan created by the trucker. Contact us if you need to retrieve data from it","type":"string"},"customer_to_invoice":{"$ref":"#/components/schemas/customer_to_invoice"},"parent_transport":{"$ref":"#/components/schemas/Transport_parent_transport"},"invoice_number":{"nullable":true,"type":"string"},"invoiced_price":{"$ref":"#/components/schemas/deprecated_invoiced_price"},"volume_display_unit":{"enum":["m3","L"],"type":"string"},"references":{"items":{"$ref":"#/components/schemas/Transport_references"},"type":"array"},"rental_deliveries":{"description":"Array of transports executed by the trucker during the rental order. Implies that the current transport is a rental order. Inner objects have the same transport data structure.","items":{"$ref":"#/components/schemas/Transport"},"type":"array"},"billing-metrics":{"deprecated":true,"description":"Retired feature, will always be null.","nullable":true,"type":"string"},"shape":{"type":"string"},"instructions":{"$ref":"#/components/schemas/global_instructions"},"carbon_footprint":{"description":"Carbon footprint of the transport in kgCO2","nullable":true,"readOnly":true,"type":"number"},"tags":{"description":"List of tags applied to the transport.","items":{"$ref":"#/components/schemas/Tag"},"type":"array"}},"required":["business_privacy","carrier_address","carrier_reference","created","created_by","created_device","creation_method","deliveries","documents","has_observations","invite_code","invoice_number","is_order","messages","price","references","remote_id","requested_vehicle","requires_washing","segments","sequential_id","status","status_updates","uid","updated"],"type":"object"},"AddressForTransport":{"properties":{"pk":{"description":"Dashdoc's internal id.","type":"number"},"name":{"type":"string"},"address":{"type":"string"},"city":{"type":"string"},"postcode":{"type":"string"},"country":{"$ref":"#/components/schemas/country"},"latitude":{"$ref":"#/components/schemas/latitude"},"longitude":{"$ref":"#/components/schemas/longitude"},"radius":{"default":500,"description":"Radius around the GPS coordinates within which the address is located (in meters)","type":"integer"},"coords_validated":{"default":false,"description":"if `true`, when this address is used as a loading or unloading site, the mobile app displays an itinerary button to start GPS app with guidance to these coordinates","type":"boolean"},"is_demo":{"$ref":"#/components/schemas/is_demo"},"is_carrier":{"type":"boolean"},"is_shipper":{"type":"boolean"},"is_origin":{"$ref":"#/components/schemas/address_is_origin_and_is_destination"},"is_destination":{"$ref":"#/components/schemas/address_is_origin_and_is_destination"},"created_by":{"type":"number"},"created":{"$ref":"#/components/schemas/created"},"remote_id":{"description":"The id of the address in your system.","type":"string"},"company":{"$ref":"#/components/schemas/CompanyForTransportAddress"},"original":{"type":"number"}},"type":"object"},"country":{"description":"Only the 2-character codification is accepted (ISO 3166-1 alpha-2)","type":"string"},"latitude":{"description":"Latitude using the decimal GPS coordinates (WGS84). At 7 decimals, the position is accurate around the centimeter.","format":"float","nullable":true,"type":"number"},"longitude":{"description":"Longitude using the decimal GPS coordinates (WGS84). At 7 decimals, the position is accurate around the centimeter.","format":"float","nullable":true,"type":"number"},"is_demo":{"description":"Indicates that the address is a fake one created from demonstration. Everything linked to it will be deleted when using the 'Delete demo content' button in company parameters","type":"boolean"},"address_is_origin_and_is_destination":{"description":"Whether this address is a \"Logistic Points\" and will be usable as pickup/delivery point.\nThe distinction between origin/pickup and destination/delivery was merged as a single \"Logistic Point\" concept. `is_origin` implies `is_destination` and vice-versa.\n","type":"boolean"},"created":{"description":"Date of creation on our server","format":"date-time","type":"string"},"CompanyForTransportAddress":{"properties":{"pk":{"description":"Dashdoc's internal id.","type":"number"},"remote_id":{"description":"The id of the company in your system.","type":"string"},"name":{"type":"string"},"trade_number":{"type":"string"},"country":{"$ref":"#/components/schemas/country"},"settings_contract_html":{"description":"Ignore. Dashdoc technical data.","type":"string"},"settings_logo":{"description":"Ignore. Dashdoc technical data.","nullable":true,"type":"string"},"settings_stamp":{"description":"Ignore. Dashdoc technical data.","nullable":true,"type":"string"},"settings_print_mode":{"description":"Ignore. Dashdoc technical data.","type":"boolean"},"settings_special_agreements":{"description":"Ignore. Dashdoc technical data.","type":"string"},"settings_transport_order_observations":{"type":"string"},"settings_constrain_reference_edition":{"type":"boolean"},"vat_number":{"type":"string"},"is_verified":{"type":"boolean"}},"type":"object"},"Company":{"properties":{"pk":{"description":"Dashdoc's internal id.","type":"number"},"remote_id":{"type":"string"},"created":{"format":"date-time","type":"object"},"updated":{"format":"date-time","type":"string"},"deleted":{"type":"boolean"},"invoicing_remote_id":{"description":"The id of the company in your invoicing system.","type":"string"},"name":{"type":"string"},"phone_number":{"type":"string"},"email":{"type":"string"},"siren":{"type":"string"},"trade_number":{"type":"string"},"country":{"$ref":"#/components/schemas/country"},"comments":{"type":"string"},"vat_number":{"type":"string"},"is_verified":{"type":"boolean"},"settings_transport_order_observations":{"type":"string"},"settings_constrain_reference_edition":{"type":"boolean"},"account_type":{"description":"Ignore. Dashdoc technical data.","type":"string"},"logo":{"description":"The URL of your logo","nullable":true,"type":"string"},"subscription_access":{"type":"object"},"settings":{"type":"object"},"primary_address":{"$ref":"#/components/schemas/PrimaryAddress_1"},"managers":{"items":{"$ref":"#/components/schemas/Managers"},"type":"array"},"has_loggable_managers":{"description":"Ignore. Dashdoc technical data.","type":"boolean"}},"type":"object"},"PrimaryAddress_1":{"properties":{"pk":{"description":"Dashdoc's internal id.","type":"number"},"name":{"type":"string"},"address":{"type":"string"},"city":{"type":"string"},"postcode":{"type":"string"},"country":{"$ref":"#/components/schemas/country"},"latitude":{"$ref":"#/components/schemas/latitude"},"longitude":{"$ref":"#/components/schemas/longitude"},"radius":{"default":500,"description":"Radius around the GPS coordinates within which the address is located (in meters)","type":"integer"},"coords_validated":{"default":false,"description":"if `true`, when this address is used as a loading or unloading site, the mobile app displays an itinerary button to start GPS app with guidance to these coordinates","type":"boolean"},"is_demo":{"$ref":"#/components/schemas/is_demo"},"is_carrier":{"description":"Whether this company is considered a carrier","type":"boolean"},"is_shipper":{"description":"Whether this company is considered a shipper","type":"boolean"},"is_origin":{"description":"Legacy, not relevant for a company's primary address. Consider creating a separate address associated with this partner instead.\n","type":"boolean"},"is_destination":{"description":"Legacy, not relevant for a company's primary address. Consider creating a separate address associated with this partner instead.\n","type":"boolean"},"created_by":{"$ref":"#/components/schemas/created-by"},"created_by_user":{"$ref":"#/components/schemas/created-by-user"},"created":{"$ref":"#/components/schemas/created"},"remote_id":{"description":"The id of the address in your system.","type":"string"}},"type":"object"},"created-by":{"nullable":true,"properties":{"pk":{"description":"company id","type":"number"},"name":{"description":"name of the company","type":"string"}},"type":"object"},"created-by-user":{"nullable":true,"properties":{"pk":{"type":"number"},"display_name":{"type":"string"},"company":{"description":"The company id who created the address","type":"number"},"trucker_id":{"description":"The trucker id who created the address","type":"number"}},"type":"object"},"Managers":{"properties":{"pk":{"description":"Dashdoc's internal id.","type":"number"},"user":{"$ref":"#/components/schemas/Managers_user"},"display_name":{"type":"string"},"role":{"type":"string"}},"type":"object"},"Managers_user":{"properties":{"email":{"format":"email","type":"string"},"first_name":{"type":"string"},"last_name":{"type":"string"}},"type":"object"},"CarrierAssignationStatus":{"description":"Carrier assignment state of an order (Only for chartered transport). Null values should be treated as unassigned.","enum":["unassigned","draft_assigned","assigned"],"type":"string"},"Delivery":{"properties":{"uid":{"description":"Dashdoc's internal id.","type":"string"},"sequential_id":{"description":"eCMR number","type":"number"},"remote_id":{"type":"string"},"tracking_id":{"description":"Deprecated","type":"string"},"origin":{"$ref":"#/components/schemas/CreateOrUpdateSite"},"destination":{"$ref":"#/components/schemas/CreateOrUpdateSite"},"shipper_address":{"$ref":"#/components/schemas/NewAddressReduced"},"planned_loads":{"description":"Loads as planned before the transport has been started","items":{"$ref":"#/components/schemas/DeliveryLoads"},"type":"array"},"loads":{"description":"Loads as they are most recently defined. This means it is: \n\n* equal to `planned_loads` before loading is actually done \n\n* equal to `origin_loads` after loading is done (with details validated by trucker), but unloading is not done yet \n\n* equal to `loads_loads` after unloading is actually done (with details validated by trucker)","items":{"$ref":"#/components/schemas/DeliveryLoads"},"type":"array"},"origin_loads":{"description":"Loads as validated by trucker right after loading is done","items":{"$ref":"#/components/schemas/DeliveryLoads"},"type":"array"},"destination_loads":{"description":"Loads as validated by trucker right after unloading is done","items":{"$ref":"#/components/schemas/DeliveryLoads"},"type":"array"},"tracking_contacts":{"description":"List of contacts that will automatically receive an email when delivery is done. ⚠️ If no tracking contacts are provided for a company and the setting `partner_email_fallback` is enabled, a tracking contact corresponding to the company's email will be added, at the creation of the transport. This only applies to the carrier and the shipper.","items":{"$ref":"#/components/schemas/Delivery_tracking_contacts"},"type":"array"},"shipper_reference":{"description":"Reference the client may use to match transport on his own system, e.g. an order number. The transport's creator can toggle a setting to only allow himself to set it.","type":"string"},"multiple_rounds":{"description":"If true, the trucker will be able to do a signature at loading, then add any amount of rounds for the transport (with weight/volume and weight ticket), and finish with a signature at unloading.","type":"boolean"}},"type":"object"},"CreateOrUpdateSite":{"properties":{"uid":{"format":"uuid","type":"string"},"remote_id":{"description":"The id of the site in your system","type":"string"},"address":{"allOf":[{"$ref":"#/components/schemas/SiteAddress"}],"nullable":true},"real_start":{"description":"date and time when trucker arrived on site","format":"date-time","readOnly":true,"type":"string"},"real_end":{"description":"date and time when trucker completed loading / unloading (depending whether site is origin or destination)","format":"date-time","readOnly":true,"type":"string"},"signature_process":{"type":"string"},"is_booking_needed":{"type":"boolean"},"instructions":{"$ref":"#/components/schemas/site_instructions"},"reference":{"type":"string"},"action":{"deprecated":true,"description":"Deprecated. Accepted for backward compatibility but ignored. Responses always return an empty string.","type":"string"},"eta":{"format":"date-time","nullable":true,"type":"string"},"eta_tracking":{"type":"boolean"},"punctuality_status":{"readOnly":true,"type":"string"},"supports_exchanges":{"$ref":"#/components/schemas/SupportsExchange"},"category":{"type":"string"},"slots":{"items":{"$ref":"#/components/schemas/Site_slots"},"type":"array"},"trucker_instructions":{"$ref":"#/components/schemas/trucker_instructions"},"trip":{"$ref":"#/components/schemas/Site_trip"}},"type":"object"},"SiteAddress":{"description":"Address of the site. Reference an existing address with its `pk` or `remote_id`, or send its details to have it matched or created.","properties":{"pk":{"description":"Dashdoc's internal id. Optional, set it to reference an existing address.","type":"integer"},"name":{"type":"string"},"address":{"type":"string"},"city":{"type":"string"},"postcode":{"type":"string"},"country":{"$ref":"#/components/schemas/country"},"latitude":{"$ref":"#/components/schemas/latitude"},"longitude":{"$ref":"#/components/schemas/longitude"},"radius":{"default":500,"description":"Radius around the GPS coordinates within which the address is located (in meters)","type":"integer"},"coords_validated":{"default":false,"description":"if `true`, when this address is used as a loading or unloading site, the mobile app displays an itinerary button to start GPS app with guidance to these coordinates","type":"boolean"},"is_demo":{"$ref":"#/components/schemas/is_demo"},"is_carrier":{"type":"boolean"},"is_shipper":{"type":"boolean"},"is_origin":{"$ref":"#/components/schemas/address_is_origin_and_is_destination"},"is_destination":{"$ref":"#/components/schemas/address_is_origin_and_is_destination"},"instructions":{"$ref":"#/components/schemas/site_instructions"},"remote_id":{"description":"The id of the address in your system.","type":"string"},"company":{"$ref":"#/components/schemas/CompanyForTransportAddress_1"}},"type":"object"},"site_instructions":{"description":"Site instructions, visible to all parties (trucker, carrier, shipper, site). Displayed in the trucker mobile app. Not visible in the eCMR. If the field is not provided, the address's site instructions will be used.","maxLength":1000,"type":"string"},"CompanyForTransportAddress_1":{"description":"Identification of the company. You may simply use its `pk` or `remote_id` if the company already exists. Other possible identification method are its `trade_number` or `name`. If it doesn't exist, the company will be created with the information you send based on what's possible when creating a company via /companies/ web service. Minimum required information in this case is a name.","properties":{"pk":{"description":"Dashdoc's internal id.Optional, not required if `remote_id` is sent.","type":"integer"},"remote_id":{"description":"The id of the company in your system. Optional, ignored if `pk` is sent.","type":"string"},"trade_number":{"maxLength":100,"type":"string"},"name":{"maxLength":200,"type":"string"}},"type":"object"},"SupportsExchange":{"properties":{"uid":{"description":"uid of the support exchange","format":"uuid","type":"string"},"site":{"$ref":"#/components/schemas/SupportsExchange_site"},"support_type":{"$ref":"#/components/schemas/SupportType"},"expected_retrieved":{"description":"Expected number of supports that should be retrieved on the site","type":"number"},"actual_retrieved":{"description":"Actual number of supports that were retrieved on the site","type":"number"},"expected_delivered":{"description":"Expected number of supports that should be delivered on the site","type":"number"},"actual_delivered":{"description":"Actual number of supports that were delivered on the site","type":"number"},"observations":{"description":"Free text. Observations about this supports exchange. Can be filled on mobile app, web app or via API.","type":"string"},"remote_id":{"description":"The ID of the support in your system","type":"string"}},"type":"object"},"SupportsExchange_site":{"description":"site where supports exchange is expected","properties":{"uid":{"description":"uid of the site","format":"uuid","type":"string"},"remote_id":{"description":"remote_id of the site","type":"string"}},"type":"object"},"SupportType":{"description":"Type of the supports that are exchanged","properties":{"name":{"description":"Display name of the support type","type":"string"},"created":{"$ref":"#/components/schemas/created"},"uid":{"format":"uuid","type":"string"},"remote_id":{"description":"The id of the support type in your system.","type":"string"}},"type":"object"},"Site_slots":{"properties":{"start":{"format":"date-time","type":"string"},"end":{"format":"date-time","type":"string"}},"type":"object"},"trucker_instructions":{"description":"**This field is part of a beta feature.** Private instructions. **The carrier of the transport is the only one who can edit and read those instructions.** Note that those instructions are not visible in the consignment note and can be accessed by the trucker. The value is null if the caller doesn't have the right of access to the data.","maxLength":1000,"type":"string"},"Site_trip":{"description":"Trip linked to this site/activity.","nullable":true,"properties":{"uid":{"format":"uuid","type":"string"},"name":{"type":"string"},"is_prepared":{"type":"boolean"},"status":{"enum":["unstarted","ongoing","done"],"type":"string"}},"readOnly":true,"type":"object"},"NewAddressReduced":{"properties":{"pk":{"description":"Dashdoc's internal id. Optional, set it to reference an existing address.","type":"integer"},"name":{"type":"string"},"address":{"type":"string"},"city":{"type":"string"},"postcode":{"type":"string"},"country":{"$ref":"#/components/schemas/country"},"latitude":{"$ref":"#/components/schemas/latitude"},"longitude":{"$ref":"#/components/schemas/longitude"},"radius":{"default":500,"description":"Radius around the GPS coordinates within which the address is located (in meters)","type":"integer"},"coords_validated":{"default":false,"description":"if `true`, when this address is used as a loading or unloading site, the mobile app displays an itinerary button to start GPS app with guidance to these coordinates","type":"boolean"},"is_demo":{"$ref":"#/components/schemas/is_demo"},"is_carrier":{"type":"boolean"},"is_shipper":{"type":"boolean"},"is_origin":{"type":"boolean"},"is_destination":{"type":"boolean"},"created_by":{"description":"Ignore. Dashdoc technical data.","readOnly":true,"type":"number"},"created":{"description":"Date of creation on our server","format":"date-time","readOnly":true,"type":"string"},"instructions":{"type":"string"},"remote_id":{"description":"The id of the address in your system.","type":"string"},"company":{"$ref":"#/components/schemas/CompanyForTransportAddress"},"original":{"description":"Ignore. Dashdoc technical data.","nullable":true,"readOnly":true,"type":"number"}},"required":["address","city","company","country","postcode"],"type":"object"},"DeliveryLoads":{"properties":{"uid":{"description":"Dashdoc's internal id.","type":"string"},"remote_id":{"description":"The ID of the load in your system. It has to be unique among all your transports.","type":"string"},"description":{"description":"Text description of the load","type":"string"},"reference":{"description":"Reference of the load","type":"string"},"round_id":{"description":"The ID of the round.","format":"integer","type":"number"},"weight":{"description":"In kilograms","format":"float","type":"number"},"volume":{"description":"Volume of load in m3","format":"float","type":"number"},"volume_display_unit":{"default":"m3","enum":["m3","L"],"type":"string"},"linear_meters":{"description":"Length of load in meters","format":"float","type":"number"},"quantity":{"description":"Only one decimal accepted (e.g 0.0)","format":"float","type":"number"},"pallet_equivalence":{"description":"Pallet equivalence (EPS/EQPAL): how many standard pallet spaces the load occupies. `null` when it was never set. Otherwise at least `0.01`, with two decimals kept.","format":"float","nullable":true,"type":"number"},"category":{"description":"Packaging of the load. The text is free but these specific values cause a custom flow on the mobile app: `pallets`, `containers`, `bulk`, `roundwood`, `powder_tank`, `bulk_qualimat`, `rental`.","type":"string"},"dangerous_goods_category":{"description":"ADR class","enum":["1","2","3","4.1","4.2","4.3","5.1","5.2","6.1","6.2","7","8","9"],"type":"string"},"is_dangerous":{"type":"boolean"},"adr_un_code":{"type":"string"},"legal_mentions":{"type":"string"},"complementary_information":{"description":"Any information about the load that doesn't fit to the description field","type":"string"},"container_number":{"type":"string"},"tare_weight":{"description":"In kilograms","format":"float","type":"number"},"container_seal_number":{"type":"string"},"refrigerated":{"description":"Indicates whether the load is refrigerated. If true, the trucker can fill in the temperature.","type":"boolean"},"temperature":{"type":"string"},"steres":{"format":"float","type":"number"},"idtf_number":{"description":"Must match an existing IDTF number","type":"string"},"use_identifiers":{"description":"if `true`, trucker is asked to scan barcode identifiers on load","type":"boolean"},"identifiers":{"description":"Only relevant if use_identifiers is set to `true`. List of expected barcode identifiers that the trucker should scan at loading and unloading. App controls that expected barcodes are actually scanned. If empty, the trucker will have to scan barcodes anyway, but there won't be any check. Feature has to be activated in your account by your Dashdoc projet manager.","items":{"type":"string"},"type":"array"},"identifiers_observations":{"description":"Observations explaining issues with identifier, such as missing or unexpected identifiers","type":"string"}},"type":"object"},"Delivery_tracking_contacts":{"properties":{"uid":{"description":"Dashdoc's internal id.","type":"string"},"contact":{"$ref":"#/components/schemas/NewContact"},"subscribed_to_status_updates":{"description":"If set to true, the contact will receive an email at every step of the delivery. Else, they will receive only one email once the delivery is done.","type":"boolean"},"role":{"description":"The role of the contact in the delivery. It can be `carrier`, `shipper`, or `site`.","type":"string"}},"required":["contact"],"type":"object"},"NewContact":{"properties":{"uid":{"format":"uuid","type":"string"},"created":{"description":"Date of creation on our server","format":"date-time","readOnly":true,"type":"string"},"company":{"$ref":"#/components/schemas/CompanyIdentification"},"first_name":{"maxLength":200,"type":"string"},"last_name":{"maxLength":200,"type":"string"},"email":{"format":"email","type":"string"},"phone_number":{"maxLength":100,"type":"string"},"fax_number":{"maxLength":100,"type":"string"},"remote_id":{"description":"The id of the contact in your system","type":"string"}},"required":["company","last_name"],"type":"object"},"CompanyIdentification":{"description":"Identification of the company. The company must already exist in Dashdoc.","properties":{"pk":{"description":"Dashdoc's internal id. Optional, not required if `remote_id` is sent.","type":"integer"},"remote_id":{"description":"Your remote carrier id. Optional, ignored if `pk` is sent.","type":"string"},"name":{"type":"string"},"trade_number":{"type":"string"},"country":{"$ref":"#/components/schemas/country"},"settings_contract_html":{"description":"Ignore. Dashdoc technical data.","type":"string"},"settings_logo":{"description":"Ignore. Dashdoc technical data.","nullable":true,"type":"string"},"settings_stamp":{"description":"Ignore. Dashdoc technical data.","nullable":true,"type":"string"},"settings_print_mode":{"description":"Ignore. Dashdoc technical data.","type":"boolean"},"settings_special_agreements":{"description":"Ignore. Dashdoc technical data.","type":"string"},"settings_transport_order_observations":{"type":"string"},"settings_constrain_reference_edition":{"type":"boolean"},"vat_number":{"type":"string"},"is_verified":{"description":"Ignore. Dashdoc technical data.","type":"string"}},"type":"object"},"Segment":{"description":"","properties":{"uid":{"minLength":1,"type":"string"},"remote_id":{"minLength":1,"type":"string"},"origin":{"$ref":"#/components/schemas/Site"},"destination":{"$ref":"#/components/schemas/Site"},"trucker":{"$ref":"#/components/schemas/SegmentTrucker"},"vehicle":{"$ref":"#/components/schemas/Vehicle"},"trailers":{"items":{"$ref":"#/components/schemas/Trailer"},"type":"array"},"sort_order":{"description":"The index of the segment in the transport","minimum":0,"type":"number"},"scheduled_start_range":{"$ref":"#/components/schemas/Segment_scheduled_start_range"},"scheduled_end_range":{"$ref":"#/components/schemas/Segment_scheduled_end_range"},"scheduled_start":{"deprecated":true,"description":"The datetime at which the carrier scheduled the start of this segment\n","type":"string"},"scheduled_end":{"deprecated":true,"description":"The datetime at which the carrier scheduled the end of this segment","type":"string"},"child_transport":{"$ref":"#/components/schemas/Segment_child_transport"},"telematic_distance":{"description":"Automatically computed distance from telematic data (in kms).","type":"integer"},"distance":{"description":"Manually entered distance. If null, it takes the value of telematic_distance (in kms).","type":"integer"},"origin_mileage":{"description":"Mileage at transport origin site (in kms).","type":"integer"},"destination_mileage":{"description":"Mileage at transport destination site (in kms).","type":"integer"}},"type":"object"},"Site":{"properties":{"uid":{"format":"uuid","type":"string"},"remote_id":{"description":"The id of the site in your system","type":"string"},"address":{"$ref":"#/components/schemas/Address"},"real_start":{"description":"date and time when trucker arrived on site","format":"date-time","type":"string"},"real_end":{"description":"date and time when trucker completed loading / unloading (depending whether site is origin or destination)","format":"date-time","type":"string"},"signature_process":{"type":"string"},"instructions":{"$ref":"#/components/schemas/site_instructions"},"reference":{"type":"string"},"action":{"deprecated":true,"description":"Deprecated. Always returned as an empty string.","type":"string"},"eta":{"nullable":true,"type":"string"},"eta_tracking":{"$ref":"#/components/schemas/eta_tracking"},"punctuality_status":{"$ref":"#/components/schemas/punctuality_status"},"supports_exchanges":{"$ref":"#/components/schemas/SupportsExchange"},"category":{"enum":["loading","unloading"],"type":"string"},"slots":{"items":{"$ref":"#/components/schemas/Site_slots"},"type":"array"},"trucker_instructions":{"$ref":"#/components/schemas/trucker_instructions"},"trip":{"$ref":"#/components/schemas/Site_trip"}},"type":"object"},"Address":{"properties":{"pk":{"description":"Dashdoc's internal id.","type":"number"},"name":{"type":"string"},"address":{"type":"string"},"city":{"type":"string"},"postcode":{"type":"string"},"country":{"$ref":"#/components/schemas/country"},"latitude":{"$ref":"#/components/schemas/latitude"},"longitude":{"$ref":"#/components/schemas/longitude"},"radius":{"default":500,"description":"Radius around the GPS coordinates within which the address is located (in meters)","type":"integer"},"coords_validated":{"default":false,"description":"if `true`, when this address is used as a loading or unloading site, the mobile app displays an itinerary button to start GPS app with guidance to these coordinates","type":"boolean"},"is_demo":{"$ref":"#/components/schemas/is_demo"},"is_carrier":{"type":"boolean"},"is_shipper":{"type":"boolean"},"is_origin":{"$ref":"#/components/schemas/address_is_origin_and_is_destination"},"is_destination":{"$ref":"#/components/schemas/address_is_origin_and_is_destination"},"created_by":{"$ref":"#/components/schemas/created-by"},"created_by_user":{"$ref":"#/components/schemas/created-by-user"},"created":{"$ref":"#/components/schemas/created"},"instructions":{"$ref":"#/components/schemas/site_instructions"},"remote_id":{"description":"The id of the address in your system.","type":"string"},"original":{"description":"Dashdoc's internal id of the original address.","nullable":true,"readOnly":true,"type":"number"},"company":{"$ref":"#/components/schemas/Company"}},"type":"object"},"eta_tracking":{"default":false,"description":"Ask for an ETA on this site. This is currently a beta feature, not activated by default.","type":"boolean"},"punctuality_status":{"default":"untracked","description":"Indicate the punctuality on this site.","enum":["untracked","probably_late","probably_on_time","late","on_time"],"type":"string"},"SegmentTrucker":{"properties":{"pk":{"description":"Dashdoc's internal id.","type":"number"},"remote_id":{"description":"The ID of the trucker in your system. It has to be unique among all your truckers.","type":"string"},"display_name":{"type":"string"},"user":{"$ref":"#/components/schemas/SegmentTruckerUser"}},"type":"object"},"SegmentTruckerUser":{"properties":{"pk":{"description":"Dashdoc's internal id.","type":"number"},"first_name":{"type":"string"},"last_name":{"type":"string"},"username":{"description":"Ignore. Dashdoc technical data.","type":"string"},"email":{"format":"email","type":"string"},"display_name":{"description":"Display name generated by Dashdoc.","type":"string"},"date_joined":{"description":"Ignore. Dashdoc technical data.","format":"date-time","type":"string"},"is_staff":{"description":"Ignore. Dashdoc technical data.","type":"boolean"},"is_superuser":{"description":"Ignore. Dashdoc technical data.","type":"boolean"},"has_usable_password":{"description":"Ignore. Dashdoc technical data.","type":"boolean"}},"type":"object"},"Vehicle":{"properties":{"pk":{"description":"Dashdoc's internal id","type":"number"},"carrier":{"description":"Dashdoc's internal id of the carrier owning the vehicle","type":"number"},"category":{"description":"Vehicle category","type":"string"},"license_plate":{"description":"License plate number","type":"string"},"fleet_number":{"description":"Your vehicle fleet number","type":"string"},"remote_id":{"description":"The ID of the vehicle in your system","type":"string"},"created":{"description":"Date of creation on our server","format":"date-time","type":"string"},"used_for_qualimat_transports":{"description":"True if the vehicle can be used for Qualimat transport (only used for visual help and warnings)","type":"boolean"},"telematic_vehicle":{"description":"Ignore. Dashdoc technical data","type":"number"},"original":{"type":"number"},"tags":{"description":"List of tags applied to the vehicle.","items":{"$ref":"#/components/schemas/Tag"},"type":"array"},"technical_control_deadline":{"format":"date-time","type":"string"},"tachograph_deadline":{"format":"date-time","type":"string"},"speed_limiter_deadline":{"format":"date-time","type":"string"},"country":{"$ref":"#/components/schemas/country"},"unavailability":{"description":"List of unavailable period","items":{"$ref":"#/components/schemas/Unavailability"},"type":"array"},"events":{"description":"Ignore. Dashdoc technical data.","items":{"type":"object"},"type":"array"}},"type":"object"},"Tag":{"properties":{"pk":{"description":"The unique identifier of the tag","type":"integer"},"name":{"description":"The name of the tag","type":"string"},"color":{"description":"The color of the tag in hex format","type":"string"},"tag_group_id":{"description":"The ID of the tag group this tag belongs to, if any","nullable":true,"type":"integer"}},"required":["color","name","pk"],"type":"object"},"Unavailability":{"properties":{"id":{"description":"Dashdoc's internal id","type":"number"},"remote_id":{"description":"The ID of the unavailability in your system","type":"string"},"created":{"description":"Date of creation on our server","format":"date-time","type":"string"},"start_date":{"description":"Start date of the unavailability","format":"date-time","type":"string"},"end_date":{"description":"End date of the unavailability","format":"date-time","type":"string"},"unavailability_type":{"description":"Type of unavailability","enum":["paid_vacation","day_off","sick_leave","training","vacation","maintenance","rental","other"],"type":"string"},"unavailability_note":{"description":"Notes about the unavailability","type":"string"}},"type":"object"},"Trailer":{"properties":{"pk":{"description":"Dashdoc's internal id","type":"number"},"original":{"description":"Ignore. Dashdoc technical data","type":"number"},"carrier":{"description":"Dashdoc's internal id of the carrier owning the trailer","type":"number"},"license_plate":{"description":"License plate number","type":"string"},"fleet_number":{"description":"Your trailer fleet number","type":"string"},"remote_id":{"description":"The ID of the trailer in your system","type":"string"},"created":{"description":"Date of creation on our server","format":"date-time","type":"string"},"used_for_qualimat_transports":{"description":"True if the trailer can be used for Qualimat transport (only used for visual help and warnings)","type":"boolean"},"tags":{"description":"List of tags applied to the trailer.","items":{"$ref":"#/components/schemas/Tag"},"type":"array"},"technical_control_deadline":{"format":"date-time","type":"string"},"country":{"$ref":"#/components/schemas/country"},"unavailability":{"description":"List of unavailable period","items":{"$ref":"#/components/schemas/Unavailability"},"type":"array"},"events":{"description":"Ignore. Dashdoc technical data.","items":{"type":"object"},"type":"array"}},"type":"object"},"Segment_scheduled_start_range":{"description":"The datetime range at which the carrier scheduled the start of this segment","properties":{"start":{"description":"Min scheduled start date (ISO 8601)","type":"string"},"end":{"description":"Max scheduled start date (ISO 8601)","type":"string"}},"type":"object"},"Segment_scheduled_end_range":{"description":"The datetime range at which the carrier scheduled the end of this segment","properties":{"start":{"description":"Min scheduled end date (ISO 8601)","type":"string"},"end":{"description":"Max scheduled end date (ISO 8601)","type":"string"}},"type":"object"},"Segment_child_transport":{"description":"If the segment is chartered, will contain the child transport","properties":{"uid":{"format":"uuid","type":"string"},"sequential_id":{"type":"number"},"remote_id":{"type":"string"},"has_strong_link":{"type":"boolean"}},"type":"object"},"Statuses":{"enum":["created","updated","confirmed","declined","verified","invoiced","paid","cancelled","assigned","sent_to_trucker","acknowledged","truck_wash","on_loading_site","loading_complete","on_unloading_site","unloading_complete","bulking_break_started","bulking_break_complete","rounds_started","round_added","round_added_v2","round_edited","round_deleted","rounds_complete","event","checklist_filled","activity_complete","on_the_way","handling_started","done"],"type":"string"},"Status":{"properties":{"uid":{"format":"uuid","type":"string"},"created":{"description":"Date of creation on the server. Useful when the transport is created by mobile devices. If network connection is bad, the `created` date can be later than `created_device`","format":"date-time","type":"string"},"created_device":{"description":"If created from a mobile device, date of creation on the device.","format":"date-time","type":"string"},"creation_method":{"type":"string"},"category":{"description":"event that occured on the transport","type":"string"},"author":{"description":"details about author of the update. Contact Dashdoc if more details is needed.","type":"object"},"content":{"description":"Contact Dashdoc if more details is needed.","type":"object"},"content_signatory":{"description":"Contact Dashdoc if more details is needed.","type":"object"},"target":{"description":"Contact Dashdoc if more details is needed.","type":"object"},"site":{"description":"Contact Dashdoc if more details is needed.","type":"object"},"site_id":{"description":"Contact Dashdoc if more details is needed.","format":"uuid","type":"string"},"delivery":{"description":"Contact Dashdoc if more details is needed.","format":"uuid","type":"string"},"segment":{"description":"Contact Dashdoc if more details is needed.","format":"uuid","type":"string"},"transport":{"description":"Contact Dashdoc if more details is needed.","format":"uuid","type":"string"},"signature":{"description":"Contact Dashdoc if more details is needed.","type":"object"},"latitude":{"description":"Contact Dashdoc if more details is needed.","format":"float","type":"number"},"longitude":{"description":"Contact Dashdoc if more details is needed.","format":"float","type":"number"},"update_details":{"description":"Contact Dashdoc if more details is needed.","type":"object"},"author_company":{"type":"number"}},"required":["uid"],"type":"object"},"TransportMessage":{"properties":{"uid":{"format":"uuid","type":"string"},"created":{"$ref":"#/components/schemas/created"},"created_device":{"format":"date-time","type":"string"},"creation_method":{"type":"string"},"author":{"$ref":"#/components/schemas/NewTransportMessage_author"},"type":{"enum":["note","load_verification","share","document","photo"],"maxLength":100,"type":"string"},"document_title":{"description":"Filename or if uploaded by a trucker from the mobile app, the document title is generic, for instance `photo`.","maxLength":100,"type":"string"},"document_type":{"enum":["load_photo","cmr","washing_note","delivery_note","confirmation","weight_note","waste_manifest","holders_swap_note","invoice"],"maxLength":100,"type":"string"},"document":{"description":"URL of the stored document. You can download the document from this URL.","type":"string"},"is_attached_to_cmr":{"type":"boolean"},"transport":{"format":"uuid","type":"string"},"site":{"description":"This field is used for the default values of the field readable_by_company_ids; if null, companies from all Sites of the transport are listed in readable_by_company_ids, otherwise only the company of this Site. Site must exist in this transport. This field is part of a beta feature.","format":"uuid","nullable":true,"type":"string"},"site_remote_id":{"type":"string"},"readable_by_company_ids":{"description":"A list containing the pk of each company allowed to access the document, every company must be part of the transport. If no values are sent, it will be computed with default values; Carrier, Shipper, Invoiced Customer and Site's pk (see Site field). Once values have been sent, the behavior adding default companies is deactivated. The author company is always added. Only pks of companies from the transport will be added, others will be ignored. This field is part of a beta feature.","items":{"type":"integer"},"type":"array"},"message":{"description":"message displayed in the activity thread of a transport in the web app and in the mobile app","type":"string"},"latitude":{"$ref":"#/components/schemas/latitude"},"longitude":{"$ref":"#/components/schemas/longitude"},"reference":{"description":"Free text. This reference is searchable in the transports dashboard. Filled by trucker if document is added from mobile app, by user if document is added from web app, or filled by API request.","maxLength":140,"type":"string"},"visible_by_everyone":{"$ref":"#/components/schemas/visible_by_everyone"},"readable_by_trucker":{"$ref":"#/components/schemas/readable_by_trucker"},"extracted_reference":{"description":"Reference extracted by AI from the document. AI runs only on weight notes, so it will be null for other documents. \"\" if no reference has been found by the AI.","type":"string"}},"type":"object"},"NewTransportMessage_author":{"properties":{"display_name":{"type":"string"},"company":{"type":"number"},"pk":{"description":"Dashdoc's internal id.","type":"number"}},"type":"object"},"visible_by_everyone":{"description":"This field is used to make the transport message public, which makes it visible by all parties of the transport.","type":"boolean"},"readable_by_trucker":{"description":"This field is used to allow truckers to see the transport message. **Only available for carriers.**","type":"boolean"},"requested_vehicle":{"description":"Only useful when the transport is created by the shipper. Free text except punction and special characters.","maxLength":40,"type":"string"},"Document":{"properties":{"pk":{"type":"integer"},"file_updated_date":{"description":"Date was updated on the server.","format":"date-time","type":"string"},"delivery":{"description":"Contact Dashdoc if more details are needed.","format":"uuid","type":"string"},"delivery_sequential_id":{"description":"eCMR number (for category \"cmr\" and \"ldv\")","type":"integer"},"reference":{"type":"integer"},"category":{"description":"Type of document. Possible values are \"cmr\", \"cmr4\", \"ldv\", \"orc\", \"chc\", \"rental\" and \"loading_plan\"","type":"string"},"languages":{"description":"Languages displayed in the document (CMR only), formatted as an 2-letter ISO 639-1 language code","items":{"type":"string"},"type":"array"},"name":{"description":"generic name of the document","type":"string"},"file":{"description":"path to the document","format":"url","type":"string"},"business_privacy_scope":{"description":"Ignore. Dashdoc technical data.","type":"boolean"},"cancelled":{"description":"Date of cancellation of the the document","format":"date-time","type":"string"}},"type":"object"},"deprecated_price":{"deprecated":true,"description":"Full price for the transport","format":"float","nullable":true,"type":"number"},"customer_to_invoice":{"properties":{"pk":{"description":"Dashdoc's internal id.","type":"number"},"name":{"type":"string"},"invoicing_address":{"$ref":"#/components/schemas/customer_to_invoice_invoicing_address"}},"type":"object"},"customer_to_invoice_invoicing_address":{"properties":{"address":{"type":"string"},"city":{"type":"string"},"postcode":{"type":"string"},"country":{"$ref":"#/components/schemas/country"}},"type":"object"},"Transport_parent_transport":{"description":"if this is a chartered transport, this will contains the parent transport it is chartered from","properties":{"uid":{"format":"uuid","type":"string"},"sequential_id":{"type":"number"},"remote_id":{"type":"string"},"has_strong_link":{"type":"boolean"}},"type":"object"},"deprecated_invoiced_price":{"deprecated":true,"description":"Invoiced price for the transport. Deprecated in favour of pricing field","format":"float","nullable":true,"type":"number"},"Transport_references":{"properties":{"role":{"type":"string"},"company":{"$ref":"#/components/schemas/Transport_company"},"reference":{"type":"string"}},"type":"object"},"Transport_company":{"properties":{"name":{"type":"string"}},"type":"object"},"global_instructions":{"description":"Operating instructions. The carrier, the shipper and the creator of the transport have access to those instructions. However, the creator is the only who has the right to edit.","maxLength":1000,"type":"string"},"RetrievedTransport_allOf":{"properties":{"agreed_price_total":{"description":"The total of the agreed price (including fuel surcharge, excluding taxes) if readable, otherwise null.","nullable":true,"type":"string"},"invoiced_price_total":{"description":"The total of the invoiced price (including fuel surcharge, excluding taxes) if readable, otherwise null.","nullable":true,"type":"string"},"shipper_final_price_total":{"description":"The total of the shipper final price (including fuel surcharge, excluding taxes) if readable, otherwise null.","nullable":true,"type":"string"},"effective_price_total":{"description":"The total of the effective price (including fuel surcharge, excluding taxes) if readable, otherwise null.","nullable":true,"type":"string"},"purchase_cost_total":{"description":"The total of the purchase costs if readable, otherwise null.","nullable":true,"type":"string"},"segments":{"items":{"$ref":"#/components/schemas/SegmentWithLegTags"},"type":"array"}},"type":"object"},"SegmentWithLegTags":{"allOf":[{"$ref":"#/components/schemas/Segment"},{"$ref":"#/components/schemas/SegmentWithLegTags_allOf"}],"type":"object"},"SegmentWithLegTags_allOf":{"properties":{"tags":{"description":"Tags of the leg this segment belongs to. Segments of the same leg share its tags.","items":{"$ref":"#/components/schemas/Tag"},"type":"array"}},"type":"object"}}}}
```

## The CreateOrUpdateSegment object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"CreateOrUpdateSegment":{"properties":{"remote_id":{"description":"The id of the segment in your system. Optional.","type":"string"},"origin":{"$ref":"#/components/schemas/CreateOrUpdateSite"},"destination":{"$ref":"#/components/schemas/CreateOrUpdateSite"},"trucker_id":{"$ref":"#/components/schemas/UpdateSegment_trucker_id"},"vehicle":{"$ref":"#/components/schemas/NewVehicle"},"trailers":{"items":{"$ref":"#/components/schemas/NewTrailer"},"type":"array"}},"required":["destination","origin"],"type":"object"},"CreateOrUpdateSite":{"properties":{"uid":{"format":"uuid","type":"string"},"remote_id":{"description":"The id of the site in your system","type":"string"},"address":{"allOf":[{"$ref":"#/components/schemas/SiteAddress"}],"nullable":true},"real_start":{"description":"date and time when trucker arrived on site","format":"date-time","readOnly":true,"type":"string"},"real_end":{"description":"date and time when trucker completed loading / unloading (depending whether site is origin or destination)","format":"date-time","readOnly":true,"type":"string"},"signature_process":{"type":"string"},"is_booking_needed":{"type":"boolean"},"instructions":{"$ref":"#/components/schemas/site_instructions"},"reference":{"type":"string"},"action":{"deprecated":true,"description":"Deprecated. Accepted for backward compatibility but ignored. Responses always return an empty string.","type":"string"},"eta":{"format":"date-time","nullable":true,"type":"string"},"eta_tracking":{"type":"boolean"},"punctuality_status":{"readOnly":true,"type":"string"},"supports_exchanges":{"$ref":"#/components/schemas/SupportsExchange"},"category":{"type":"string"},"slots":{"items":{"$ref":"#/components/schemas/Site_slots"},"type":"array"},"trucker_instructions":{"$ref":"#/components/schemas/trucker_instructions"},"trip":{"$ref":"#/components/schemas/Site_trip"}},"type":"object"},"SiteAddress":{"description":"Address of the site. Reference an existing address with its `pk` or `remote_id`, or send its details to have it matched or created.","properties":{"pk":{"description":"Dashdoc's internal id. Optional, set it to reference an existing address.","type":"integer"},"name":{"type":"string"},"address":{"type":"string"},"city":{"type":"string"},"postcode":{"type":"string"},"country":{"$ref":"#/components/schemas/country"},"latitude":{"$ref":"#/components/schemas/latitude"},"longitude":{"$ref":"#/components/schemas/longitude"},"radius":{"default":500,"description":"Radius around the GPS coordinates within which the address is located (in meters)","type":"integer"},"coords_validated":{"default":false,"description":"if `true`, when this address is used as a loading or unloading site, the mobile app displays an itinerary button to start GPS app with guidance to these coordinates","type":"boolean"},"is_demo":{"$ref":"#/components/schemas/is_demo"},"is_carrier":{"type":"boolean"},"is_shipper":{"type":"boolean"},"is_origin":{"$ref":"#/components/schemas/address_is_origin_and_is_destination"},"is_destination":{"$ref":"#/components/schemas/address_is_origin_and_is_destination"},"instructions":{"$ref":"#/components/schemas/site_instructions"},"remote_id":{"description":"The id of the address in your system.","type":"string"},"company":{"$ref":"#/components/schemas/CompanyForTransportAddress_1"}},"type":"object"},"country":{"description":"Only the 2-character codification is accepted (ISO 3166-1 alpha-2)","type":"string"},"latitude":{"description":"Latitude using the decimal GPS coordinates (WGS84). At 7 decimals, the position is accurate around the centimeter.","format":"float","nullable":true,"type":"number"},"longitude":{"description":"Longitude using the decimal GPS coordinates (WGS84). At 7 decimals, the position is accurate around the centimeter.","format":"float","nullable":true,"type":"number"},"is_demo":{"description":"Indicates that the address is a fake one created from demonstration. Everything linked to it will be deleted when using the 'Delete demo content' button in company parameters","type":"boolean"},"address_is_origin_and_is_destination":{"description":"Whether this address is a \"Logistic Points\" and will be usable as pickup/delivery point.\nThe distinction between origin/pickup and destination/delivery was merged as a single \"Logistic Point\" concept. `is_origin` implies `is_destination` and vice-versa.\n","type":"boolean"},"site_instructions":{"description":"Site instructions, visible to all parties (trucker, carrier, shipper, site). Displayed in the trucker mobile app. Not visible in the eCMR. If the field is not provided, the address's site instructions will be used.","maxLength":1000,"type":"string"},"CompanyForTransportAddress_1":{"description":"Identification of the company. You may simply use its `pk` or `remote_id` if the company already exists. Other possible identification method are its `trade_number` or `name`. If it doesn't exist, the company will be created with the information you send based on what's possible when creating a company via /companies/ web service. Minimum required information in this case is a name.","properties":{"pk":{"description":"Dashdoc's internal id.Optional, not required if `remote_id` is sent.","type":"integer"},"remote_id":{"description":"The id of the company in your system. Optional, ignored if `pk` is sent.","type":"string"},"trade_number":{"maxLength":100,"type":"string"},"name":{"maxLength":200,"type":"string"}},"type":"object"},"SupportsExchange":{"properties":{"uid":{"description":"uid of the support exchange","format":"uuid","type":"string"},"site":{"$ref":"#/components/schemas/SupportsExchange_site"},"support_type":{"$ref":"#/components/schemas/SupportType"},"expected_retrieved":{"description":"Expected number of supports that should be retrieved on the site","type":"number"},"actual_retrieved":{"description":"Actual number of supports that were retrieved on the site","type":"number"},"expected_delivered":{"description":"Expected number of supports that should be delivered on the site","type":"number"},"actual_delivered":{"description":"Actual number of supports that were delivered on the site","type":"number"},"observations":{"description":"Free text. Observations about this supports exchange. Can be filled on mobile app, web app or via API.","type":"string"},"remote_id":{"description":"The ID of the support in your system","type":"string"}},"type":"object"},"SupportsExchange_site":{"description":"site where supports exchange is expected","properties":{"uid":{"description":"uid of the site","format":"uuid","type":"string"},"remote_id":{"description":"remote_id of the site","type":"string"}},"type":"object"},"SupportType":{"description":"Type of the supports that are exchanged","properties":{"name":{"description":"Display name of the support type","type":"string"},"created":{"$ref":"#/components/schemas/created"},"uid":{"format":"uuid","type":"string"},"remote_id":{"description":"The id of the support type in your system.","type":"string"}},"type":"object"},"created":{"description":"Date of creation on our server","format":"date-time","type":"string"},"Site_slots":{"properties":{"start":{"format":"date-time","type":"string"},"end":{"format":"date-time","type":"string"}},"type":"object"},"trucker_instructions":{"description":"**This field is part of a beta feature.** Private instructions. **The carrier of the transport is the only one who can edit and read those instructions.** Note that those instructions are not visible in the consignment note and can be accessed by the trucker. The value is null if the caller doesn't have the right of access to the data.","maxLength":1000,"type":"string"},"Site_trip":{"description":"Trip linked to this site/activity.","nullable":true,"properties":{"uid":{"format":"uuid","type":"string"},"name":{"type":"string"},"is_prepared":{"type":"boolean"},"status":{"enum":["unstarted","ongoing","done"],"type":"string"}},"readOnly":true,"type":"object"},"UpdateSegment_trucker_id":{"properties":{"pk":{"description":"Dashdoc's internal id. Optional, not required if `remote_id` is sent.","type":"number"},"remote_id":{"description":"The ID of the trucker in your system. Optional, ignored if pk is sent.","type":"string"}},"type":"object"},"NewVehicle":{"properties":{"remote_id":{"description":"The ID of the vehicle in your system.","type":"string"},"fleet_number":{"description":"Your vehicle fleet number. It has to be unique among all your vehicles. When filled, fleet number will be displayed in the web and mobile app next to license plate number. It can also be used for searches.","maxLength":10,"type":"string"},"license_plate":{"description":"License plate number (has to be unique)","maxLength":200,"type":"string"},"category":{"$ref":"#/components/schemas/vehicle_category"},"used_for_qualimat_transports":{"description":"True if the vehicle can be used for Qualimat transport (only used for vehicle that can handle a load without trailer). This value is used to add a Qualimat logo next to the vehicle in forms, in order to help the user selecting the vehicle when creating a transport. The is no control on the value. You can create a Qualimat transport with a vehicle that is not flagged for Qualimat. In this case a warning is displayed in the transport detail.","type":"boolean"},"tags":{"description":"List of tags applied to the vehicle.","items":{"$ref":"#/components/schemas/Tag"},"type":"array"},"telematic_data_source":{"description":"The telematic where the vehicle is refered","enum":["alertgasoil","astrata","addsecure","dashdoc","eliott","fleetboard","geodynamics","geotracer","geotab","koovea","mappingcontrol","mapandtruck","masternaut","qeos","quartix","rio","scania","sudtelematique","transics","trimble","truckonline","vehizen","volvo","webfleet","strada","verizon","mapon","bump","samsara","samsara_mapandtruck","webeye","pass_tracabilite","bizztrack","aktkc_etransportas_mapandtruck","anima_mapandtruck","arvento_mapandtruck","as24_mapandtruck","axxess_mapandtruck","bornemann_infleet_mapandtruck","bpw_mapandtruck","cartrack_mapandtruck","commander_services_mapandtruck","dkv_mapandtruck","easytrack_mapandtruck","ecofleet_mapandtruck","edrive_mapandtruck","effitrailer_mapandtruck","ekolis_mapandtruck","fleetgo_mapandtruck","fleethand_mapandtruck","fleetmaster_mapandtruck","framelogic_mapandtruck","frotcom_mapandtruck","geotab_mapandtruck","gestracking_mapandtruck","globaltrack_mapandtruck","goodyear_france_mapandtruck","gps_mobile_mapandtruck","icell_mapandtruck","ims_telematics_mapandtruck","inelo_mapandtruck","infis_mapandtruck","jaltest_mapandtruck","k2gps_mapandtruck","keeptrace_mapandtruck","konsalnet_mapandtruck","krone_telematic_mapandtruck","legal_telematics_mapandtruck","linqo_mapandtruck","localizare_mapandtruck","locationsolutions_mapandtruck","loctracker_mapandtruck","mecomo_mapandtruck","microlise_mapandtruck","mix_telematics_mapandtruck","movertis_mapandtruck","movildata_mapandtruck","mtrack_mapandtruck","n2mobil_mapandtruck","naocom_mapandtruck","navifleet_mapandtruck","nexus_mapandtruck","ocean_mapandtruck","optifleet_mapandtruck","optimo_gps_mapandtruck","orbcomm_mapandtruck","orbcomm_africa_mapandtruck","pulsit_electronics_mapandtruck","quake_tracking_mapandtruck","riverlong_mapandtruck","sas_fleet_mapandtruck","satko_mapandtruck","schmitz_cargobull_mapandtruck","seyir_mobil_mapandtruck","skywatch_mapandtruck","solustop_mapandtruck","spedion_mapandtruck","speedtelematics_mapandtruck","starcom_mapandtruck","telepass_mapandtruck","terramar_networks_mapandtruck","tracker_mapandtruck","trackit_mapandtruck","tracknamic_mapandtruck","trendfire_mapandtruck","v3_smart_technologies_mapandtruck","vektor_teknoloji_mapandtruck","viafleet_mapandtruck","viasat_mapandtruck","visirun_mapandtruck","waynet_mapandtruck","wayzz_mapandtruck","webdispecink_mapandtruck"],"type":"string"},"vendor_id":{"description":"ID of the vehicle in the telematics system","type":"string"}},"type":"object"},"vehicle_category":{"description":"Vehicle category","enum":["unknown","light","straight","straight_tipper","tipper","tipper_cereal","tipper_construction","refrigerated","isotherm","platform","curtainsider","box_body","trailer_truck","flatbed","low_flatbed","log","coil","container","vehicle","heavy_equipment","solid_tanker","petrol_tanker","chemical_tanker","food_tanker","livestock","special_convoy"],"maxLength":200,"type":"string"},"Tag":{"properties":{"pk":{"description":"The unique identifier of the tag","type":"integer"},"name":{"description":"The name of the tag","type":"string"},"color":{"description":"The color of the tag in hex format","type":"string"},"tag_group_id":{"description":"The ID of the tag group this tag belongs to, if any","nullable":true,"type":"integer"}},"required":["color","name","pk"],"type":"object"},"NewTrailer":{"properties":{"remote_id":{"description":"The ID of the trailer in your system.","type":"string"},"fleet_number":{"description":"Your trailer fleet number. It has to be unique among all your trailers. When filled, fleet number will be displayed in the web and mobile app next to license plate number. It can also be used for searches.","maxLength":10,"type":"string"},"license_plate":{"description":"License plate number (has to be unique)","maxLength":200,"type":"string"},"used_for_qualimat_transports":{"description":"True if the trailer can be used for Qualimat transport. This value is used to add a Qualimat logo next to the trailer in forms, in order to help the user selecting the trailer when creating a transport. The is no control on the value. You can create a Qualimat transport with a trailer that is not flagged for Qualimat. In this case a warning is displayed in the transport detail.","type":"boolean"},"tags":{"description":"List of tags applied to the trailer.","items":{"$ref":"#/components/schemas/Tag"},"type":"array"}},"type":"object"}}}}
```

## The NullableCompanyPkOrRemoteId object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"NullableCompanyPkOrRemoteId":{"description":"Identification of the company. The company must already exist in Dashdoc.","nullable":true,"properties":{"pk":{"description":"Dashdoc's internal id. Optional, should not be sent if `remote_id` is sent.","type":"number"},"remote_id":{"description":"The ID of the company in your system. Optional, should not be sent if `pk` is sent.","type":"string"}},"type":"object"}}}}
```

## The TagInput object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"TagInput":{"properties":{"name":{"description":"The name of the tag. A tag is matched by its name, and created if it does not exist yet.","maxLength":40,"minLength":1,"type":"string"},"color":{"description":"The color of the tag in hex format. Only used when creating a new tag.","type":"string"}},"required":["name"],"type":"object"}}}}
```

## The NewPriceLine object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"NewPriceLine":{"properties":{"description":{"description":"Description of the line","type":"string"},"quantity":{"type":"number"},"unit_price":{"type":"number"},"is_gas_indexed":{"description":"Whether the price is indexed on gas price using fuel surcharge","type":"boolean"},"metric":{"description":"Metric of the price line","enum":["FLAT","DISTANCE_IN_KM","DURATION_IN_MINUTE","DURATION_IN_HOUR","LOADED_WEIGHT_IN_KG","LOADED_WEIGHT_IN_TONNE","LOADED_VOLUME_IN_LITRE","LOADED_VOLUME_IN_M3","LOADED_QUANTITY","LOADED_LINEAR_METERS","UNLOADED_WEIGHT_IN_KG","UNLOADED_WEIGHT_IN_TONNE","UNLOADED_VOLUME_IN_LITRE","UNLOADED_VOLUME_IN_M3","UNLOADED_QUANTITY","UNLOADED_LINEAR_METERS","NB_DELIVERIES","NB_ROUNDS"],"type":"string"}},"type":"object"}}}}
```

## The SegmentWithLegTags object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"SegmentWithLegTags":{"allOf":[{"$ref":"#/components/schemas/Segment"},{"$ref":"#/components/schemas/SegmentWithLegTags_allOf"}],"type":"object"},"Segment":{"description":"","properties":{"uid":{"minLength":1,"type":"string"},"remote_id":{"minLength":1,"type":"string"},"origin":{"$ref":"#/components/schemas/Site"},"destination":{"$ref":"#/components/schemas/Site"},"trucker":{"$ref":"#/components/schemas/SegmentTrucker"},"vehicle":{"$ref":"#/components/schemas/Vehicle"},"trailers":{"items":{"$ref":"#/components/schemas/Trailer"},"type":"array"},"sort_order":{"description":"The index of the segment in the transport","minimum":0,"type":"number"},"scheduled_start_range":{"$ref":"#/components/schemas/Segment_scheduled_start_range"},"scheduled_end_range":{"$ref":"#/components/schemas/Segment_scheduled_end_range"},"scheduled_start":{"deprecated":true,"description":"The datetime at which the carrier scheduled the start of this segment\n","type":"string"},"scheduled_end":{"deprecated":true,"description":"The datetime at which the carrier scheduled the end of this segment","type":"string"},"child_transport":{"$ref":"#/components/schemas/Segment_child_transport"},"telematic_distance":{"description":"Automatically computed distance from telematic data (in kms).","type":"integer"},"distance":{"description":"Manually entered distance. If null, it takes the value of telematic_distance (in kms).","type":"integer"},"origin_mileage":{"description":"Mileage at transport origin site (in kms).","type":"integer"},"destination_mileage":{"description":"Mileage at transport destination site (in kms).","type":"integer"}},"type":"object"},"Site":{"properties":{"uid":{"format":"uuid","type":"string"},"remote_id":{"description":"The id of the site in your system","type":"string"},"address":{"$ref":"#/components/schemas/Address"},"real_start":{"description":"date and time when trucker arrived on site","format":"date-time","type":"string"},"real_end":{"description":"date and time when trucker completed loading / unloading (depending whether site is origin or destination)","format":"date-time","type":"string"},"signature_process":{"type":"string"},"instructions":{"$ref":"#/components/schemas/site_instructions"},"reference":{"type":"string"},"action":{"deprecated":true,"description":"Deprecated. Always returned as an empty string.","type":"string"},"eta":{"nullable":true,"type":"string"},"eta_tracking":{"$ref":"#/components/schemas/eta_tracking"},"punctuality_status":{"$ref":"#/components/schemas/punctuality_status"},"supports_exchanges":{"$ref":"#/components/schemas/SupportsExchange"},"category":{"enum":["loading","unloading"],"type":"string"},"slots":{"items":{"$ref":"#/components/schemas/Site_slots"},"type":"array"},"trucker_instructions":{"$ref":"#/components/schemas/trucker_instructions"},"trip":{"$ref":"#/components/schemas/Site_trip"}},"type":"object"},"Address":{"properties":{"pk":{"description":"Dashdoc's internal id.","type":"number"},"name":{"type":"string"},"address":{"type":"string"},"city":{"type":"string"},"postcode":{"type":"string"},"country":{"$ref":"#/components/schemas/country"},"latitude":{"$ref":"#/components/schemas/latitude"},"longitude":{"$ref":"#/components/schemas/longitude"},"radius":{"default":500,"description":"Radius around the GPS coordinates within which the address is located (in meters)","type":"integer"},"coords_validated":{"default":false,"description":"if `true`, when this address is used as a loading or unloading site, the mobile app displays an itinerary button to start GPS app with guidance to these coordinates","type":"boolean"},"is_demo":{"$ref":"#/components/schemas/is_demo"},"is_carrier":{"type":"boolean"},"is_shipper":{"type":"boolean"},"is_origin":{"$ref":"#/components/schemas/address_is_origin_and_is_destination"},"is_destination":{"$ref":"#/components/schemas/address_is_origin_and_is_destination"},"created_by":{"$ref":"#/components/schemas/created-by"},"created_by_user":{"$ref":"#/components/schemas/created-by-user"},"created":{"$ref":"#/components/schemas/created"},"instructions":{"$ref":"#/components/schemas/site_instructions"},"remote_id":{"description":"The id of the address in your system.","type":"string"},"original":{"description":"Dashdoc's internal id of the original address.","nullable":true,"readOnly":true,"type":"number"},"company":{"$ref":"#/components/schemas/Company"}},"type":"object"},"country":{"description":"Only the 2-character codification is accepted (ISO 3166-1 alpha-2)","type":"string"},"latitude":{"description":"Latitude using the decimal GPS coordinates (WGS84). At 7 decimals, the position is accurate around the centimeter.","format":"float","nullable":true,"type":"number"},"longitude":{"description":"Longitude using the decimal GPS coordinates (WGS84). At 7 decimals, the position is accurate around the centimeter.","format":"float","nullable":true,"type":"number"},"is_demo":{"description":"Indicates that the address is a fake one created from demonstration. Everything linked to it will be deleted when using the 'Delete demo content' button in company parameters","type":"boolean"},"address_is_origin_and_is_destination":{"description":"Whether this address is a \"Logistic Points\" and will be usable as pickup/delivery point.\nThe distinction between origin/pickup and destination/delivery was merged as a single \"Logistic Point\" concept. `is_origin` implies `is_destination` and vice-versa.\n","type":"boolean"},"created-by":{"nullable":true,"properties":{"pk":{"description":"company id","type":"number"},"name":{"description":"name of the company","type":"string"}},"type":"object"},"created-by-user":{"nullable":true,"properties":{"pk":{"type":"number"},"display_name":{"type":"string"},"company":{"description":"The company id who created the address","type":"number"},"trucker_id":{"description":"The trucker id who created the address","type":"number"}},"type":"object"},"created":{"description":"Date of creation on our server","format":"date-time","type":"string"},"site_instructions":{"description":"Site instructions, visible to all parties (trucker, carrier, shipper, site). Displayed in the trucker mobile app. Not visible in the eCMR. If the field is not provided, the address's site instructions will be used.","maxLength":1000,"type":"string"},"Company":{"properties":{"pk":{"description":"Dashdoc's internal id.","type":"number"},"remote_id":{"type":"string"},"created":{"format":"date-time","type":"object"},"updated":{"format":"date-time","type":"string"},"deleted":{"type":"boolean"},"invoicing_remote_id":{"description":"The id of the company in your invoicing system.","type":"string"},"name":{"type":"string"},"phone_number":{"type":"string"},"email":{"type":"string"},"siren":{"type":"string"},"trade_number":{"type":"string"},"country":{"$ref":"#/components/schemas/country"},"comments":{"type":"string"},"vat_number":{"type":"string"},"is_verified":{"type":"boolean"},"settings_transport_order_observations":{"type":"string"},"settings_constrain_reference_edition":{"type":"boolean"},"account_type":{"description":"Ignore. Dashdoc technical data.","type":"string"},"logo":{"description":"The URL of your logo","nullable":true,"type":"string"},"subscription_access":{"type":"object"},"settings":{"type":"object"},"primary_address":{"$ref":"#/components/schemas/PrimaryAddress_1"},"managers":{"items":{"$ref":"#/components/schemas/Managers"},"type":"array"},"has_loggable_managers":{"description":"Ignore. Dashdoc technical data.","type":"boolean"}},"type":"object"},"PrimaryAddress_1":{"properties":{"pk":{"description":"Dashdoc's internal id.","type":"number"},"name":{"type":"string"},"address":{"type":"string"},"city":{"type":"string"},"postcode":{"type":"string"},"country":{"$ref":"#/components/schemas/country"},"latitude":{"$ref":"#/components/schemas/latitude"},"longitude":{"$ref":"#/components/schemas/longitude"},"radius":{"default":500,"description":"Radius around the GPS coordinates within which the address is located (in meters)","type":"integer"},"coords_validated":{"default":false,"description":"if `true`, when this address is used as a loading or unloading site, the mobile app displays an itinerary button to start GPS app with guidance to these coordinates","type":"boolean"},"is_demo":{"$ref":"#/components/schemas/is_demo"},"is_carrier":{"description":"Whether this company is considered a carrier","type":"boolean"},"is_shipper":{"description":"Whether this company is considered a shipper","type":"boolean"},"is_origin":{"description":"Legacy, not relevant for a company's primary address. Consider creating a separate address associated with this partner instead.\n","type":"boolean"},"is_destination":{"description":"Legacy, not relevant for a company's primary address. Consider creating a separate address associated with this partner instead.\n","type":"boolean"},"created_by":{"$ref":"#/components/schemas/created-by"},"created_by_user":{"$ref":"#/components/schemas/created-by-user"},"created":{"$ref":"#/components/schemas/created"},"remote_id":{"description":"The id of the address in your system.","type":"string"}},"type":"object"},"Managers":{"properties":{"pk":{"description":"Dashdoc's internal id.","type":"number"},"user":{"$ref":"#/components/schemas/Managers_user"},"display_name":{"type":"string"},"role":{"type":"string"}},"type":"object"},"Managers_user":{"properties":{"email":{"format":"email","type":"string"},"first_name":{"type":"string"},"last_name":{"type":"string"}},"type":"object"},"eta_tracking":{"default":false,"description":"Ask for an ETA on this site. This is currently a beta feature, not activated by default.","type":"boolean"},"punctuality_status":{"default":"untracked","description":"Indicate the punctuality on this site.","enum":["untracked","probably_late","probably_on_time","late","on_time"],"type":"string"},"SupportsExchange":{"properties":{"uid":{"description":"uid of the support exchange","format":"uuid","type":"string"},"site":{"$ref":"#/components/schemas/SupportsExchange_site"},"support_type":{"$ref":"#/components/schemas/SupportType"},"expected_retrieved":{"description":"Expected number of supports that should be retrieved on the site","type":"number"},"actual_retrieved":{"description":"Actual number of supports that were retrieved on the site","type":"number"},"expected_delivered":{"description":"Expected number of supports that should be delivered on the site","type":"number"},"actual_delivered":{"description":"Actual number of supports that were delivered on the site","type":"number"},"observations":{"description":"Free text. Observations about this supports exchange. Can be filled on mobile app, web app or via API.","type":"string"},"remote_id":{"description":"The ID of the support in your system","type":"string"}},"type":"object"},"SupportsExchange_site":{"description":"site where supports exchange is expected","properties":{"uid":{"description":"uid of the site","format":"uuid","type":"string"},"remote_id":{"description":"remote_id of the site","type":"string"}},"type":"object"},"SupportType":{"description":"Type of the supports that are exchanged","properties":{"name":{"description":"Display name of the support type","type":"string"},"created":{"$ref":"#/components/schemas/created"},"uid":{"format":"uuid","type":"string"},"remote_id":{"description":"The id of the support type in your system.","type":"string"}},"type":"object"},"Site_slots":{"properties":{"start":{"format":"date-time","type":"string"},"end":{"format":"date-time","type":"string"}},"type":"object"},"trucker_instructions":{"description":"**This field is part of a beta feature.** Private instructions. **The carrier of the transport is the only one who can edit and read those instructions.** Note that those instructions are not visible in the consignment note and can be accessed by the trucker. The value is null if the caller doesn't have the right of access to the data.","maxLength":1000,"type":"string"},"Site_trip":{"description":"Trip linked to this site/activity.","nullable":true,"properties":{"uid":{"format":"uuid","type":"string"},"name":{"type":"string"},"is_prepared":{"type":"boolean"},"status":{"enum":["unstarted","ongoing","done"],"type":"string"}},"readOnly":true,"type":"object"},"SegmentTrucker":{"properties":{"pk":{"description":"Dashdoc's internal id.","type":"number"},"remote_id":{"description":"The ID of the trucker in your system. It has to be unique among all your truckers.","type":"string"},"display_name":{"type":"string"},"user":{"$ref":"#/components/schemas/SegmentTruckerUser"}},"type":"object"},"SegmentTruckerUser":{"properties":{"pk":{"description":"Dashdoc's internal id.","type":"number"},"first_name":{"type":"string"},"last_name":{"type":"string"},"username":{"description":"Ignore. Dashdoc technical data.","type":"string"},"email":{"format":"email","type":"string"},"display_name":{"description":"Display name generated by Dashdoc.","type":"string"},"date_joined":{"description":"Ignore. Dashdoc technical data.","format":"date-time","type":"string"},"is_staff":{"description":"Ignore. Dashdoc technical data.","type":"boolean"},"is_superuser":{"description":"Ignore. Dashdoc technical data.","type":"boolean"},"has_usable_password":{"description":"Ignore. Dashdoc technical data.","type":"boolean"}},"type":"object"},"Vehicle":{"properties":{"pk":{"description":"Dashdoc's internal id","type":"number"},"carrier":{"description":"Dashdoc's internal id of the carrier owning the vehicle","type":"number"},"category":{"description":"Vehicle category","type":"string"},"license_plate":{"description":"License plate number","type":"string"},"fleet_number":{"description":"Your vehicle fleet number","type":"string"},"remote_id":{"description":"The ID of the vehicle in your system","type":"string"},"created":{"description":"Date of creation on our server","format":"date-time","type":"string"},"used_for_qualimat_transports":{"description":"True if the vehicle can be used for Qualimat transport (only used for visual help and warnings)","type":"boolean"},"telematic_vehicle":{"description":"Ignore. Dashdoc technical data","type":"number"},"original":{"type":"number"},"tags":{"description":"List of tags applied to the vehicle.","items":{"$ref":"#/components/schemas/Tag"},"type":"array"},"technical_control_deadline":{"format":"date-time","type":"string"},"tachograph_deadline":{"format":"date-time","type":"string"},"speed_limiter_deadline":{"format":"date-time","type":"string"},"country":{"$ref":"#/components/schemas/country"},"unavailability":{"description":"List of unavailable period","items":{"$ref":"#/components/schemas/Unavailability"},"type":"array"},"events":{"description":"Ignore. Dashdoc technical data.","items":{"type":"object"},"type":"array"}},"type":"object"},"Tag":{"properties":{"pk":{"description":"The unique identifier of the tag","type":"integer"},"name":{"description":"The name of the tag","type":"string"},"color":{"description":"The color of the tag in hex format","type":"string"},"tag_group_id":{"description":"The ID of the tag group this tag belongs to, if any","nullable":true,"type":"integer"}},"required":["color","name","pk"],"type":"object"},"Unavailability":{"properties":{"id":{"description":"Dashdoc's internal id","type":"number"},"remote_id":{"description":"The ID of the unavailability in your system","type":"string"},"created":{"description":"Date of creation on our server","format":"date-time","type":"string"},"start_date":{"description":"Start date of the unavailability","format":"date-time","type":"string"},"end_date":{"description":"End date of the unavailability","format":"date-time","type":"string"},"unavailability_type":{"description":"Type of unavailability","enum":["paid_vacation","day_off","sick_leave","training","vacation","maintenance","rental","other"],"type":"string"},"unavailability_note":{"description":"Notes about the unavailability","type":"string"}},"type":"object"},"Trailer":{"properties":{"pk":{"description":"Dashdoc's internal id","type":"number"},"original":{"description":"Ignore. Dashdoc technical data","type":"number"},"carrier":{"description":"Dashdoc's internal id of the carrier owning the trailer","type":"number"},"license_plate":{"description":"License plate number","type":"string"},"fleet_number":{"description":"Your trailer fleet number","type":"string"},"remote_id":{"description":"The ID of the trailer in your system","type":"string"},"created":{"description":"Date of creation on our server","format":"date-time","type":"string"},"used_for_qualimat_transports":{"description":"True if the trailer can be used for Qualimat transport (only used for visual help and warnings)","type":"boolean"},"tags":{"description":"List of tags applied to the trailer.","items":{"$ref":"#/components/schemas/Tag"},"type":"array"},"technical_control_deadline":{"format":"date-time","type":"string"},"country":{"$ref":"#/components/schemas/country"},"unavailability":{"description":"List of unavailable period","items":{"$ref":"#/components/schemas/Unavailability"},"type":"array"},"events":{"description":"Ignore. Dashdoc technical data.","items":{"type":"object"},"type":"array"}},"type":"object"},"Segment_scheduled_start_range":{"description":"The datetime range at which the carrier scheduled the start of this segment","properties":{"start":{"description":"Min scheduled start date (ISO 8601)","type":"string"},"end":{"description":"Max scheduled start date (ISO 8601)","type":"string"}},"type":"object"},"Segment_scheduled_end_range":{"description":"The datetime range at which the carrier scheduled the end of this segment","properties":{"start":{"description":"Min scheduled end date (ISO 8601)","type":"string"},"end":{"description":"Max scheduled end date (ISO 8601)","type":"string"}},"type":"object"},"Segment_child_transport":{"description":"If the segment is chartered, will contain the child transport","properties":{"uid":{"format":"uuid","type":"string"},"sequential_id":{"type":"number"},"remote_id":{"type":"string"},"has_strong_link":{"type":"boolean"}},"type":"object"},"SegmentWithLegTags_allOf":{"properties":{"tags":{"description":"Tags of the leg this segment belongs to. Segments of the same leg share its tags.","items":{"$ref":"#/components/schemas/Tag"},"type":"array"}},"type":"object"}}}}
```

## The DeliveryForTransport object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"DeliveryForTransport":{"properties":{"uid":{"description":"Dashdoc's internal id.","type":"string"},"sequential_id":{"description":"eCMR number","type":"number"},"remote_id":{"description":"The id of the delivery in your system","type":"string"},"tracking_id":{"description":"Deprecated","type":"string"},"origin":{"$ref":"#/components/schemas/Site_1"},"destination":{"$ref":"#/components/schemas/Site_1"},"shipper_address":{"$ref":"#/components/schemas/AddressForDelivery"},"loads":{"description":"Loads as they are most recently defined. This means it is: \n\n* equal to `planned_loads` before loading is actually done \n\n* equal to `origin_loads` after loading is done (with details validated by trucker), but unloading is not done yet \n\n* equal to `destination_loads` after unloading is actually done (with details validated by trucker) \n\nSome fields may not be returned depending on how loads were created initially and updated during the transport.","items":{"$ref":"#/components/schemas/DeliveryLoads"},"type":"array"},"planned_loads":{"description":"Loads as planned before the transport has been started","items":{"$ref":"#/components/schemas/PlannedLoads"},"type":"array"},"origin_loads":{"description":"Loads as validated by trucker right after loading is done. \n\nSome fields may not be returned depending on how loads were created initially and updated during the transport.","items":{"$ref":"#/components/schemas/DeliveryLoads"},"type":"array"},"destination_loads":{"description":"Loads as validated by trucker right after unloading is done. \n\nSome fields may not be returned depending on how loads were created initially and updated during the transport.","items":{"$ref":"#/components/schemas/DeliveryLoads"},"type":"array"},"tracking_contacts":{"description":"List of contacts that will automatically receive email notifications during the transport.","items":{"$ref":"#/components/schemas/DeliveryForTransport_tracking_contacts"},"type":"array"},"shipper_reference":{"description":"Reference the client may use to match transport on his own system, e.g. an order number.","type":"string"},"multiple_rounds":{"description":"If `true`, the trucker will be able to do a signature at loading, then add any amount of rounds for the transport (with weight/volume and weight ticket), and finish with a signature at unloading.","type":"boolean"}},"type":"object"},"Site_1":{"properties":{"uid":{"description":"Dashdoc's internal id.","format":"uuid","type":"string"},"remote_id":{"description":"The id of the site in your system","type":"string"},"address":{"$ref":"#/components/schemas/AddressForDelivery"},"loading_instructions":{"$ref":"#/components/schemas/loading_instructions"},"unloading_instructions":{"$ref":"#/components/schemas/unloading_instructions"},"real_start":{"description":"date and time when trucker arrived on site","format":"date-time","type":"string"},"real_end":{"description":"date and time when trucker completed loading / unloading (depending whether site is origin or destination)","format":"date-time","type":"string"},"signature_process":{"description":"signature process that was chosen to sign loads on site","type":"string"},"instructions":{"$ref":"#/components/schemas/site_instructions"},"reference":{"type":"string"},"action":{"deprecated":true,"description":"Deprecated. Always returned as an empty string.","type":"string"},"eta":{"nullable":true,"type":"string"},"eta_tracking":{"$ref":"#/components/schemas/eta_tracking"},"punctuality_status":{"$ref":"#/components/schemas/punctuality_status"},"supports_exchanges":{"$ref":"#/components/schemas/SupportsExchange"},"category":{"type":"string"},"arrival_date":{"description":"expected arrival date","format":"date","type":"string"},"arrival_time_min":{"description":"expected arrival min time","type":"string"},"arrival_time_max":{"description":"expected arrival max time","type":"string"},"date_exact":{"description":"if `true`, `arrival_time_max` is considered as being on the following day from `arrival_date`","type":"boolean"},"trucker_instructions":{"$ref":"#/components/schemas/trucker_instructions"}},"type":"object"},"AddressForDelivery":{"properties":{"pk":{"description":"Dashdoc's internal id.","type":"number"},"name":{"type":"string"},"address":{"type":"string"},"city":{"type":"string"},"postcode":{"type":"string"},"country":{"$ref":"#/components/schemas/country"},"latitude":{"$ref":"#/components/schemas/latitude"},"longitude":{"$ref":"#/components/schemas/longitude"},"radius":{"default":500,"description":"Radius around the GPS coordinates within which the address is located (in meters)","type":"integer"},"coords_validated":{"default":false,"description":"if `true`, when this address is used as a loading or unloading site, the mobile app displays an itinerary button to start GPS app with guidance to these coordinates","type":"boolean"},"is_demo":{"$ref":"#/components/schemas/is_demo"},"is_carrier":{"type":"boolean"},"is_shipper":{"type":"boolean"},"is_origin":{"$ref":"#/components/schemas/address_is_origin_and_is_destination"},"is_destination":{"$ref":"#/components/schemas/address_is_origin_and_is_destination"},"created_by":{"description":"Ignore. Dashdoc technical data.","type":"number"},"created":{"$ref":"#/components/schemas/created"},"instructions":{"$ref":"#/components/schemas/site_instructions"},"remote_id":{"description":"The id of the address in your system.","type":"string"},"company":{"$ref":"#/components/schemas/Company"},"original":{"description":"Ignore. Dashdoc technical data.","type":"number"}},"type":"object"},"country":{"description":"Only the 2-character codification is accepted (ISO 3166-1 alpha-2)","type":"string"},"latitude":{"description":"Latitude using the decimal GPS coordinates (WGS84). At 7 decimals, the position is accurate around the centimeter.","format":"float","nullable":true,"type":"number"},"longitude":{"description":"Longitude using the decimal GPS coordinates (WGS84). At 7 decimals, the position is accurate around the centimeter.","format":"float","nullable":true,"type":"number"},"is_demo":{"description":"Indicates that the address is a fake one created from demonstration. Everything linked to it will be deleted when using the 'Delete demo content' button in company parameters","type":"boolean"},"address_is_origin_and_is_destination":{"description":"Whether this address is a \"Logistic Points\" and will be usable as pickup/delivery point.\nThe distinction between origin/pickup and destination/delivery was merged as a single \"Logistic Point\" concept. `is_origin` implies `is_destination` and vice-versa.\n","type":"boolean"},"created":{"description":"Date of creation on our server","format":"date-time","type":"string"},"site_instructions":{"description":"Site instructions, visible to all parties (trucker, carrier, shipper, site). Displayed in the trucker mobile app. Not visible in the eCMR. If the field is not provided, the address's site instructions will be used.","maxLength":1000,"type":"string"},"Company":{"properties":{"pk":{"description":"Dashdoc's internal id.","type":"number"},"remote_id":{"type":"string"},"created":{"format":"date-time","type":"object"},"updated":{"format":"date-time","type":"string"},"deleted":{"type":"boolean"},"invoicing_remote_id":{"description":"The id of the company in your invoicing system.","type":"string"},"name":{"type":"string"},"phone_number":{"type":"string"},"email":{"type":"string"},"siren":{"type":"string"},"trade_number":{"type":"string"},"country":{"$ref":"#/components/schemas/country"},"comments":{"type":"string"},"vat_number":{"type":"string"},"is_verified":{"type":"boolean"},"settings_transport_order_observations":{"type":"string"},"settings_constrain_reference_edition":{"type":"boolean"},"account_type":{"description":"Ignore. Dashdoc technical data.","type":"string"},"logo":{"description":"The URL of your logo","nullable":true,"type":"string"},"subscription_access":{"type":"object"},"settings":{"type":"object"},"primary_address":{"$ref":"#/components/schemas/PrimaryAddress_1"},"managers":{"items":{"$ref":"#/components/schemas/Managers"},"type":"array"},"has_loggable_managers":{"description":"Ignore. Dashdoc technical data.","type":"boolean"}},"type":"object"},"PrimaryAddress_1":{"properties":{"pk":{"description":"Dashdoc's internal id.","type":"number"},"name":{"type":"string"},"address":{"type":"string"},"city":{"type":"string"},"postcode":{"type":"string"},"country":{"$ref":"#/components/schemas/country"},"latitude":{"$ref":"#/components/schemas/latitude"},"longitude":{"$ref":"#/components/schemas/longitude"},"radius":{"default":500,"description":"Radius around the GPS coordinates within which the address is located (in meters)","type":"integer"},"coords_validated":{"default":false,"description":"if `true`, when this address is used as a loading or unloading site, the mobile app displays an itinerary button to start GPS app with guidance to these coordinates","type":"boolean"},"is_demo":{"$ref":"#/components/schemas/is_demo"},"is_carrier":{"description":"Whether this company is considered a carrier","type":"boolean"},"is_shipper":{"description":"Whether this company is considered a shipper","type":"boolean"},"is_origin":{"description":"Legacy, not relevant for a company's primary address. Consider creating a separate address associated with this partner instead.\n","type":"boolean"},"is_destination":{"description":"Legacy, not relevant for a company's primary address. Consider creating a separate address associated with this partner instead.\n","type":"boolean"},"created_by":{"$ref":"#/components/schemas/created-by"},"created_by_user":{"$ref":"#/components/schemas/created-by-user"},"created":{"$ref":"#/components/schemas/created"},"remote_id":{"description":"The id of the address in your system.","type":"string"}},"type":"object"},"created-by":{"nullable":true,"properties":{"pk":{"description":"company id","type":"number"},"name":{"description":"name of the company","type":"string"}},"type":"object"},"created-by-user":{"nullable":true,"properties":{"pk":{"type":"number"},"display_name":{"type":"string"},"company":{"description":"The company id who created the address","type":"number"},"trucker_id":{"description":"The trucker id who created the address","type":"number"}},"type":"object"},"Managers":{"properties":{"pk":{"description":"Dashdoc's internal id.","type":"number"},"user":{"$ref":"#/components/schemas/Managers_user"},"display_name":{"type":"string"},"role":{"type":"string"}},"type":"object"},"Managers_user":{"properties":{"email":{"format":"email","type":"string"},"first_name":{"type":"string"},"last_name":{"type":"string"}},"type":"object"},"loading_instructions":{"deprecated":true,"description":"**Prefer using the field `instructions`.** Loading instructions, visible to all parties (trucker, carrier, shipper, site). Displayed in the trucker mobile app. Not visible in the eCMR.","maxLength":1000,"type":"string"},"unloading_instructions":{"deprecated":true,"description":"**Prefer using the field `instructions`.** Unloading instructions, visible to all parties (trucker, carrier, shipper, site). Displayed in the trucker mobile app. Not visible in the eCMR.","maxLength":1000,"type":"string"},"eta_tracking":{"default":false,"description":"Ask for an ETA on this site. This is currently a beta feature, not activated by default.","type":"boolean"},"punctuality_status":{"default":"untracked","description":"Indicate the punctuality on this site.","enum":["untracked","probably_late","probably_on_time","late","on_time"],"type":"string"},"SupportsExchange":{"properties":{"uid":{"description":"uid of the support exchange","format":"uuid","type":"string"},"site":{"$ref":"#/components/schemas/SupportsExchange_site"},"support_type":{"$ref":"#/components/schemas/SupportType"},"expected_retrieved":{"description":"Expected number of supports that should be retrieved on the site","type":"number"},"actual_retrieved":{"description":"Actual number of supports that were retrieved on the site","type":"number"},"expected_delivered":{"description":"Expected number of supports that should be delivered on the site","type":"number"},"actual_delivered":{"description":"Actual number of supports that were delivered on the site","type":"number"},"observations":{"description":"Free text. Observations about this supports exchange. Can be filled on mobile app, web app or via API.","type":"string"},"remote_id":{"description":"The ID of the support in your system","type":"string"}},"type":"object"},"SupportsExchange_site":{"description":"site where supports exchange is expected","properties":{"uid":{"description":"uid of the site","format":"uuid","type":"string"},"remote_id":{"description":"remote_id of the site","type":"string"}},"type":"object"},"SupportType":{"description":"Type of the supports that are exchanged","properties":{"name":{"description":"Display name of the support type","type":"string"},"created":{"$ref":"#/components/schemas/created"},"uid":{"format":"uuid","type":"string"},"remote_id":{"description":"The id of the support type in your system.","type":"string"}},"type":"object"},"trucker_instructions":{"description":"**This field is part of a beta feature.** Private instructions. **The carrier of the transport is the only one who can edit and read those instructions.** Note that those instructions are not visible in the consignment note and can be accessed by the trucker. The value is null if the caller doesn't have the right of access to the data.","maxLength":1000,"type":"string"},"DeliveryLoads":{"properties":{"uid":{"description":"Dashdoc's internal id.","type":"string"},"remote_id":{"description":"The ID of the load in your system. It has to be unique among all your transports.","type":"string"},"description":{"description":"Text description of the load","type":"string"},"reference":{"description":"Reference of the load","type":"string"},"round_id":{"description":"The ID of the round.","format":"integer","type":"number"},"weight":{"description":"In kilograms","format":"float","type":"number"},"volume":{"description":"Volume of load in m3","format":"float","type":"number"},"volume_display_unit":{"default":"m3","enum":["m3","L"],"type":"string"},"linear_meters":{"description":"Length of load in meters","format":"float","type":"number"},"quantity":{"description":"Only one decimal accepted (e.g 0.0)","format":"float","type":"number"},"pallet_equivalence":{"description":"Pallet equivalence (EPS/EQPAL): how many standard pallet spaces the load occupies. `null` when it was never set. Otherwise at least `0.01`, with two decimals kept.","format":"float","nullable":true,"type":"number"},"category":{"description":"Packaging of the load. The text is free but these specific values cause a custom flow on the mobile app: `pallets`, `containers`, `bulk`, `roundwood`, `powder_tank`, `bulk_qualimat`, `rental`.","type":"string"},"dangerous_goods_category":{"description":"ADR class","enum":["1","2","3","4.1","4.2","4.3","5.1","5.2","6.1","6.2","7","8","9"],"type":"string"},"is_dangerous":{"type":"boolean"},"adr_un_code":{"type":"string"},"legal_mentions":{"type":"string"},"complementary_information":{"description":"Any information about the load that doesn't fit to the description field","type":"string"},"container_number":{"type":"string"},"tare_weight":{"description":"In kilograms","format":"float","type":"number"},"container_seal_number":{"type":"string"},"refrigerated":{"description":"Indicates whether the load is refrigerated. If true, the trucker can fill in the temperature.","type":"boolean"},"temperature":{"type":"string"},"steres":{"format":"float","type":"number"},"idtf_number":{"description":"Must match an existing IDTF number","type":"string"},"use_identifiers":{"description":"if `true`, trucker is asked to scan barcode identifiers on load","type":"boolean"},"identifiers":{"description":"Only relevant if use_identifiers is set to `true`. List of expected barcode identifiers that the trucker should scan at loading and unloading. App controls that expected barcodes are actually scanned. If empty, the trucker will have to scan barcodes anyway, but there won't be any check. Feature has to be activated in your account by your Dashdoc projet manager.","items":{"type":"string"},"type":"array"},"identifiers_observations":{"description":"Observations explaining issues with identifier, such as missing or unexpected identifiers","type":"string"}},"type":"object"},"PlannedLoads":{"properties":{"uid":{"description":"Dashdoc's internal id.","type":"string"},"remote_id":{"description":"The ID of the load in your system. It has to be unique among all your transports.","type":"string"},"description":{"description":"Text description of the load","type":"string"},"reference":{"description":"Reference of the load","type":"string"},"weight":{"description":"In kilograms","format":"float","type":"number"},"volume":{"description":"Volume of load in m3","format":"float","type":"number"},"volume_display_unit":{"default":"m3","enum":["m3","L"],"type":"string"},"linear_meters":{"description":"Length of load in meters","format":"float","type":"number"},"quantity":{"description":"Only one decimal accepted (e.g 0.0)","format":"float","type":"number"},"pallet_equivalence":{"description":"Pallet equivalence (EPS/EQPAL): how many standard pallet spaces the load occupies. `null` when it was never set. Otherwise at least `0.01`, with two decimals kept.","format":"float","nullable":true,"type":"number"},"category":{"description":"Packaging of the load. The text is free but these specific values cause a custom flow on the mobile app: `pallets`, `containers`, `bulk`, `roundwood`, `powder_tank`, `bulk_qualimat`, `rental`.","type":"string"},"dangerous_goods_category":{"description":"ADR class","enum":["1","2","3","4.1","4.2","4.3","5.1","5.2","6.1","6.2","7","8","9"],"type":"string"},"is_dangerous":{"type":"boolean"},"adr_un_code":{"type":"string"},"legal_mentions":{"type":"string"},"complementary_information":{"description":"Any information about the load that doesn't fit to the description field","type":"string"},"container_number":{"type":"string"},"tare_weight":{"description":"In kilograms","format":"float","type":"number"},"container_seal_number":{"type":"string"},"refrigerated":{"description":"Indicates whether the load is refrigerated. If true, the trucker can fill in the temperature.","type":"boolean"},"temperature":{"type":"string"},"steres":{"format":"float","type":"number"},"idtf_number":{"description":"Must match an existing IDTF number","type":"string"},"use_identifiers":{"description":"if `true`, trucker is asked to scan barcode identifiers on load","type":"boolean"},"identifiers":{"description":"Only relevant if use_identifiers is set to `true`. List of expected barcode identifiers that the trucker should scan at loading and unloading. App controls that expected barcodes are actually scanned. If empty, the trucker will have to scan barcodes anyway, but there won't be any check. Feature has to be activated in your account by your Dashdoc projet manager.","type":"string"},"identifiers_observations":{"description":"Observations explaining issues with identifier, such as missing or unexpected identifiers","type":"string"}},"type":"object"},"DeliveryForTransport_tracking_contacts":{"properties":{"uid":{"description":"Dashdoc's internal id.","type":"string"},"contact":{"$ref":"#/components/schemas/TrackingContact"},"subscribed_to_status_updates":{"description":"If set to `true`, the contact will receive an email at every step of the delivery. Else, they will receive only one email once the delivery is done.","type":"boolean"}},"type":"object"},"TrackingContact":{"properties":{"uid":{"format":"uuid","type":"string"},"created":{"$ref":"#/components/schemas/created"},"company":{"$ref":"#/components/schemas/Company"},"first_name":{"type":"string"},"last_name":{"type":"string"},"email":{"format":"email","type":"string"},"phone_number":{"type":"string"},"fax_number":{"type":"string"},"remote_id":{"description":"The id of the contact in your system","type":"string"}},"type":"object"}}}}
```

## The SegmentForTransport object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"SegmentForTransport":{"description":"","properties":{"uid":{"minLength":1,"type":"string"},"remote_id":{"minLength":1,"type":"string"},"trucker":{"$ref":"#/components/schemas/SegmentTrucker"},"origin":{"$ref":"#/components/schemas/Site_1"},"destination":{"$ref":"#/components/schemas/Site_1"},"vehicle":{"$ref":"#/components/schemas/Vehicle"},"trailers":{"items":{"$ref":"#/components/schemas/Trailer"},"type":"array"},"sort_order":{"description":"The index of the segment in the transport","minimum":0,"type":"number"},"scheduled_start":{"description":"The datetime at which the carrier scheduled the start of this segment\n","type":"string"},"scheduled_end":{"description":"The datetime at which the carrier scheduled the end of this segment","type":"string"},"child_transport":{"$ref":"#/components/schemas/Segment_child_transport"},"distance":{"description":"Manually entered distance. If null, it takes the value of telematic_distance (in kms).","type":"integer"},"telematic_distance":{"description":"Automatically computed distance from telematic data (in kms).","type":"integer"},"origin_mileage":{"description":"Mileage at transport origin site (in kms).","type":"integer"},"destination_mileage":{"description":"Mileage at transport destination site (in kms).","type":"integer"}},"type":"object"},"SegmentTrucker":{"properties":{"pk":{"description":"Dashdoc's internal id.","type":"number"},"remote_id":{"description":"The ID of the trucker in your system. It has to be unique among all your truckers.","type":"string"},"display_name":{"type":"string"},"user":{"$ref":"#/components/schemas/SegmentTruckerUser"}},"type":"object"},"SegmentTruckerUser":{"properties":{"pk":{"description":"Dashdoc's internal id.","type":"number"},"first_name":{"type":"string"},"last_name":{"type":"string"},"username":{"description":"Ignore. Dashdoc technical data.","type":"string"},"email":{"format":"email","type":"string"},"display_name":{"description":"Display name generated by Dashdoc.","type":"string"},"date_joined":{"description":"Ignore. Dashdoc technical data.","format":"date-time","type":"string"},"is_staff":{"description":"Ignore. Dashdoc technical data.","type":"boolean"},"is_superuser":{"description":"Ignore. Dashdoc technical data.","type":"boolean"},"has_usable_password":{"description":"Ignore. Dashdoc technical data.","type":"boolean"}},"type":"object"},"Site_1":{"properties":{"uid":{"description":"Dashdoc's internal id.","format":"uuid","type":"string"},"remote_id":{"description":"The id of the site in your system","type":"string"},"address":{"$ref":"#/components/schemas/AddressForDelivery"},"loading_instructions":{"$ref":"#/components/schemas/loading_instructions"},"unloading_instructions":{"$ref":"#/components/schemas/unloading_instructions"},"real_start":{"description":"date and time when trucker arrived on site","format":"date-time","type":"string"},"real_end":{"description":"date and time when trucker completed loading / unloading (depending whether site is origin or destination)","format":"date-time","type":"string"},"signature_process":{"description":"signature process that was chosen to sign loads on site","type":"string"},"instructions":{"$ref":"#/components/schemas/site_instructions"},"reference":{"type":"string"},"action":{"deprecated":true,"description":"Deprecated. Always returned as an empty string.","type":"string"},"eta":{"nullable":true,"type":"string"},"eta_tracking":{"$ref":"#/components/schemas/eta_tracking"},"punctuality_status":{"$ref":"#/components/schemas/punctuality_status"},"supports_exchanges":{"$ref":"#/components/schemas/SupportsExchange"},"category":{"type":"string"},"arrival_date":{"description":"expected arrival date","format":"date","type":"string"},"arrival_time_min":{"description":"expected arrival min time","type":"string"},"arrival_time_max":{"description":"expected arrival max time","type":"string"},"date_exact":{"description":"if `true`, `arrival_time_max` is considered as being on the following day from `arrival_date`","type":"boolean"},"trucker_instructions":{"$ref":"#/components/schemas/trucker_instructions"}},"type":"object"},"AddressForDelivery":{"properties":{"pk":{"description":"Dashdoc's internal id.","type":"number"},"name":{"type":"string"},"address":{"type":"string"},"city":{"type":"string"},"postcode":{"type":"string"},"country":{"$ref":"#/components/schemas/country"},"latitude":{"$ref":"#/components/schemas/latitude"},"longitude":{"$ref":"#/components/schemas/longitude"},"radius":{"default":500,"description":"Radius around the GPS coordinates within which the address is located (in meters)","type":"integer"},"coords_validated":{"default":false,"description":"if `true`, when this address is used as a loading or unloading site, the mobile app displays an itinerary button to start GPS app with guidance to these coordinates","type":"boolean"},"is_demo":{"$ref":"#/components/schemas/is_demo"},"is_carrier":{"type":"boolean"},"is_shipper":{"type":"boolean"},"is_origin":{"$ref":"#/components/schemas/address_is_origin_and_is_destination"},"is_destination":{"$ref":"#/components/schemas/address_is_origin_and_is_destination"},"created_by":{"description":"Ignore. Dashdoc technical data.","type":"number"},"created":{"$ref":"#/components/schemas/created"},"instructions":{"$ref":"#/components/schemas/site_instructions"},"remote_id":{"description":"The id of the address in your system.","type":"string"},"company":{"$ref":"#/components/schemas/Company"},"original":{"description":"Ignore. Dashdoc technical data.","type":"number"}},"type":"object"},"country":{"description":"Only the 2-character codification is accepted (ISO 3166-1 alpha-2)","type":"string"},"latitude":{"description":"Latitude using the decimal GPS coordinates (WGS84). At 7 decimals, the position is accurate around the centimeter.","format":"float","nullable":true,"type":"number"},"longitude":{"description":"Longitude using the decimal GPS coordinates (WGS84). At 7 decimals, the position is accurate around the centimeter.","format":"float","nullable":true,"type":"number"},"is_demo":{"description":"Indicates that the address is a fake one created from demonstration. Everything linked to it will be deleted when using the 'Delete demo content' button in company parameters","type":"boolean"},"address_is_origin_and_is_destination":{"description":"Whether this address is a \"Logistic Points\" and will be usable as pickup/delivery point.\nThe distinction between origin/pickup and destination/delivery was merged as a single \"Logistic Point\" concept. `is_origin` implies `is_destination` and vice-versa.\n","type":"boolean"},"created":{"description":"Date of creation on our server","format":"date-time","type":"string"},"site_instructions":{"description":"Site instructions, visible to all parties (trucker, carrier, shipper, site). Displayed in the trucker mobile app. Not visible in the eCMR. If the field is not provided, the address's site instructions will be used.","maxLength":1000,"type":"string"},"Company":{"properties":{"pk":{"description":"Dashdoc's internal id.","type":"number"},"remote_id":{"type":"string"},"created":{"format":"date-time","type":"object"},"updated":{"format":"date-time","type":"string"},"deleted":{"type":"boolean"},"invoicing_remote_id":{"description":"The id of the company in your invoicing system.","type":"string"},"name":{"type":"string"},"phone_number":{"type":"string"},"email":{"type":"string"},"siren":{"type":"string"},"trade_number":{"type":"string"},"country":{"$ref":"#/components/schemas/country"},"comments":{"type":"string"},"vat_number":{"type":"string"},"is_verified":{"type":"boolean"},"settings_transport_order_observations":{"type":"string"},"settings_constrain_reference_edition":{"type":"boolean"},"account_type":{"description":"Ignore. Dashdoc technical data.","type":"string"},"logo":{"description":"The URL of your logo","nullable":true,"type":"string"},"subscription_access":{"type":"object"},"settings":{"type":"object"},"primary_address":{"$ref":"#/components/schemas/PrimaryAddress_1"},"managers":{"items":{"$ref":"#/components/schemas/Managers"},"type":"array"},"has_loggable_managers":{"description":"Ignore. Dashdoc technical data.","type":"boolean"}},"type":"object"},"PrimaryAddress_1":{"properties":{"pk":{"description":"Dashdoc's internal id.","type":"number"},"name":{"type":"string"},"address":{"type":"string"},"city":{"type":"string"},"postcode":{"type":"string"},"country":{"$ref":"#/components/schemas/country"},"latitude":{"$ref":"#/components/schemas/latitude"},"longitude":{"$ref":"#/components/schemas/longitude"},"radius":{"default":500,"description":"Radius around the GPS coordinates within which the address is located (in meters)","type":"integer"},"coords_validated":{"default":false,"description":"if `true`, when this address is used as a loading or unloading site, the mobile app displays an itinerary button to start GPS app with guidance to these coordinates","type":"boolean"},"is_demo":{"$ref":"#/components/schemas/is_demo"},"is_carrier":{"description":"Whether this company is considered a carrier","type":"boolean"},"is_shipper":{"description":"Whether this company is considered a shipper","type":"boolean"},"is_origin":{"description":"Legacy, not relevant for a company's primary address. Consider creating a separate address associated with this partner instead.\n","type":"boolean"},"is_destination":{"description":"Legacy, not relevant for a company's primary address. Consider creating a separate address associated with this partner instead.\n","type":"boolean"},"created_by":{"$ref":"#/components/schemas/created-by"},"created_by_user":{"$ref":"#/components/schemas/created-by-user"},"created":{"$ref":"#/components/schemas/created"},"remote_id":{"description":"The id of the address in your system.","type":"string"}},"type":"object"},"created-by":{"nullable":true,"properties":{"pk":{"description":"company id","type":"number"},"name":{"description":"name of the company","type":"string"}},"type":"object"},"created-by-user":{"nullable":true,"properties":{"pk":{"type":"number"},"display_name":{"type":"string"},"company":{"description":"The company id who created the address","type":"number"},"trucker_id":{"description":"The trucker id who created the address","type":"number"}},"type":"object"},"Managers":{"properties":{"pk":{"description":"Dashdoc's internal id.","type":"number"},"user":{"$ref":"#/components/schemas/Managers_user"},"display_name":{"type":"string"},"role":{"type":"string"}},"type":"object"},"Managers_user":{"properties":{"email":{"format":"email","type":"string"},"first_name":{"type":"string"},"last_name":{"type":"string"}},"type":"object"},"loading_instructions":{"deprecated":true,"description":"**Prefer using the field `instructions`.** Loading instructions, visible to all parties (trucker, carrier, shipper, site). Displayed in the trucker mobile app. Not visible in the eCMR.","maxLength":1000,"type":"string"},"unloading_instructions":{"deprecated":true,"description":"**Prefer using the field `instructions`.** Unloading instructions, visible to all parties (trucker, carrier, shipper, site). Displayed in the trucker mobile app. Not visible in the eCMR.","maxLength":1000,"type":"string"},"eta_tracking":{"default":false,"description":"Ask for an ETA on this site. This is currently a beta feature, not activated by default.","type":"boolean"},"punctuality_status":{"default":"untracked","description":"Indicate the punctuality on this site.","enum":["untracked","probably_late","probably_on_time","late","on_time"],"type":"string"},"SupportsExchange":{"properties":{"uid":{"description":"uid of the support exchange","format":"uuid","type":"string"},"site":{"$ref":"#/components/schemas/SupportsExchange_site"},"support_type":{"$ref":"#/components/schemas/SupportType"},"expected_retrieved":{"description":"Expected number of supports that should be retrieved on the site","type":"number"},"actual_retrieved":{"description":"Actual number of supports that were retrieved on the site","type":"number"},"expected_delivered":{"description":"Expected number of supports that should be delivered on the site","type":"number"},"actual_delivered":{"description":"Actual number of supports that were delivered on the site","type":"number"},"observations":{"description":"Free text. Observations about this supports exchange. Can be filled on mobile app, web app or via API.","type":"string"},"remote_id":{"description":"The ID of the support in your system","type":"string"}},"type":"object"},"SupportsExchange_site":{"description":"site where supports exchange is expected","properties":{"uid":{"description":"uid of the site","format":"uuid","type":"string"},"remote_id":{"description":"remote_id of the site","type":"string"}},"type":"object"},"SupportType":{"description":"Type of the supports that are exchanged","properties":{"name":{"description":"Display name of the support type","type":"string"},"created":{"$ref":"#/components/schemas/created"},"uid":{"format":"uuid","type":"string"},"remote_id":{"description":"The id of the support type in your system.","type":"string"}},"type":"object"},"trucker_instructions":{"description":"**This field is part of a beta feature.** Private instructions. **The carrier of the transport is the only one who can edit and read those instructions.** Note that those instructions are not visible in the consignment note and can be accessed by the trucker. The value is null if the caller doesn't have the right of access to the data.","maxLength":1000,"type":"string"},"Vehicle":{"properties":{"pk":{"description":"Dashdoc's internal id","type":"number"},"carrier":{"description":"Dashdoc's internal id of the carrier owning the vehicle","type":"number"},"category":{"description":"Vehicle category","type":"string"},"license_plate":{"description":"License plate number","type":"string"},"fleet_number":{"description":"Your vehicle fleet number","type":"string"},"remote_id":{"description":"The ID of the vehicle in your system","type":"string"},"created":{"description":"Date of creation on our server","format":"date-time","type":"string"},"used_for_qualimat_transports":{"description":"True if the vehicle can be used for Qualimat transport (only used for visual help and warnings)","type":"boolean"},"telematic_vehicle":{"description":"Ignore. Dashdoc technical data","type":"number"},"original":{"type":"number"},"tags":{"description":"List of tags applied to the vehicle.","items":{"$ref":"#/components/schemas/Tag"},"type":"array"},"technical_control_deadline":{"format":"date-time","type":"string"},"tachograph_deadline":{"format":"date-time","type":"string"},"speed_limiter_deadline":{"format":"date-time","type":"string"},"country":{"$ref":"#/components/schemas/country"},"unavailability":{"description":"List of unavailable period","items":{"$ref":"#/components/schemas/Unavailability"},"type":"array"},"events":{"description":"Ignore. Dashdoc technical data.","items":{"type":"object"},"type":"array"}},"type":"object"},"Tag":{"properties":{"pk":{"description":"The unique identifier of the tag","type":"integer"},"name":{"description":"The name of the tag","type":"string"},"color":{"description":"The color of the tag in hex format","type":"string"},"tag_group_id":{"description":"The ID of the tag group this tag belongs to, if any","nullable":true,"type":"integer"}},"required":["color","name","pk"],"type":"object"},"Unavailability":{"properties":{"id":{"description":"Dashdoc's internal id","type":"number"},"remote_id":{"description":"The ID of the unavailability in your system","type":"string"},"created":{"description":"Date of creation on our server","format":"date-time","type":"string"},"start_date":{"description":"Start date of the unavailability","format":"date-time","type":"string"},"end_date":{"description":"End date of the unavailability","format":"date-time","type":"string"},"unavailability_type":{"description":"Type of unavailability","enum":["paid_vacation","day_off","sick_leave","training","vacation","maintenance","rental","other"],"type":"string"},"unavailability_note":{"description":"Notes about the unavailability","type":"string"}},"type":"object"},"Trailer":{"properties":{"pk":{"description":"Dashdoc's internal id","type":"number"},"original":{"description":"Ignore. Dashdoc technical data","type":"number"},"carrier":{"description":"Dashdoc's internal id of the carrier owning the trailer","type":"number"},"license_plate":{"description":"License plate number","type":"string"},"fleet_number":{"description":"Your trailer fleet number","type":"string"},"remote_id":{"description":"The ID of the trailer in your system","type":"string"},"created":{"description":"Date of creation on our server","format":"date-time","type":"string"},"used_for_qualimat_transports":{"description":"True if the trailer can be used for Qualimat transport (only used for visual help and warnings)","type":"boolean"},"tags":{"description":"List of tags applied to the trailer.","items":{"$ref":"#/components/schemas/Tag"},"type":"array"},"technical_control_deadline":{"format":"date-time","type":"string"},"country":{"$ref":"#/components/schemas/country"},"unavailability":{"description":"List of unavailable period","items":{"$ref":"#/components/schemas/Unavailability"},"type":"array"},"events":{"description":"Ignore. Dashdoc technical data.","items":{"type":"object"},"type":"array"}},"type":"object"},"Segment_child_transport":{"description":"If the segment is chartered, will contain the child transport","properties":{"uid":{"format":"uuid","type":"string"},"sequential_id":{"type":"number"},"remote_id":{"type":"string"},"has_strong_link":{"type":"boolean"}},"type":"object"}}}}
```

## The StatusUpdates object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"StatusUpdates":{"properties":{"uid":{"format":"uuid","type":"string"},"created":{"description":"Date of creation on the server. Useful when the transport is created by mobile devices. If network connection is bad, the `created` date can be later than `created_device`","format":"date-time","type":"string"},"created_device":{"description":"If created from a mobile device, date of creation on the device.","format":"date-time","type":"string"},"creation_method":{"type":"string"},"category":{"description":"event that occured on the transport","type":"string"},"author":{"description":"details about author of the update. Contact Dashdoc if more details is needed.","type":"object"},"content":{"description":"Contact Dashdoc if more details is needed.","type":"object"},"content_signatory":{"description":"Contact Dashdoc if more details is needed.","type":"object"},"target":{"description":"Contact Dashdoc if more details is needed.","type":"object"},"site":{"description":"Contact Dashdoc if more details is needed.","type":"object"},"site_id":{"description":"Contact Dashdoc if more details is needed.","format":"uuid","type":"string"},"delivery":{"description":"Contact Dashdoc if more details is needed.","format":"uuid","type":"string"},"segment":{"description":"Contact Dashdoc if more details is needed.","format":"uuid","type":"string"},"transport":{"description":"Contact Dashdoc if more details is needed.","format":"uuid","type":"string"},"holder_exchanges":{"description":"Contact Dashdoc if more details is needed.","type":"object"},"signature":{"description":"Contact Dashdoc if more details is needed.","type":"object"},"latitude":{"description":"Contact Dashdoc if more details is needed.","format":"float","type":"number"},"longitude":{"description":"Contact Dashdoc if more details is needed.","format":"float","type":"number"},"update_details":{"description":"Contact Dashdoc if more details is needed.","type":"object"}},"type":"object"}}}}
```

## The TransportMessage\_1 object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"TransportMessage_1":{"properties":{"uid":{"format":"uuid","type":"string"},"created":{"$ref":"#/components/schemas/created"},"created_device":{"format":"date-time","type":"string"},"creation_method":{"type":"string"},"author":{"$ref":"#/components/schemas/NewTransportMessage_author"},"type":{"enum":["note","load_verification","share","document","photo"],"maxLength":100,"type":"string"},"document_title":{"description":"Filename or if uploaded by a trucker from the mobile app, the document title is generic, for instance `photo`.","maxLength":100,"type":"string"},"document_type":{"enum":["load_photo","cmr","washing_note","delivery_note","confirmation","weight_note","waste_manifest","holders_swap_note","invoice"],"maxLength":100,"type":"string"},"document":{"description":"URL of the stored document. You can download the document from this URL.","type":"string"},"is_attached_to_cmr":{"type":"boolean"},"transport":{"format":"uuid","type":"string"},"site":{"description":"This field is used for the default values of the field readable_by_company_ids; if null, companies from all Sites of the transport are listed in readable_by_company_ids, otherwise only the company of this Site. Site must exist in this transport. This field is part of a beta feature.","format":"uuid","nullable":true,"type":"string"},"site_remote_id":{"type":"string"},"readable_by_company_ids":{"description":"A list containing the pk of each company allowed to access the document, every company must be part of the transport. If no values are sent, it will be computed with default values; Carrier, Shipper, Invoiced Customer and Site's pk (see Site field). Once values have been sent, the behavior adding default companies is deactivated. The author company is always added. Only pks of companies from the transport will be added, others will be ignored. This field is part of a beta feature.","items":{"type":"integer"},"type":"array"},"message":{"description":"message displayed in the activity thread of a transport in the web app and in the mobile app","type":"string"},"latitude":{"$ref":"#/components/schemas/latitude"},"longitude":{"$ref":"#/components/schemas/longitude"},"reference":{"description":"Free text. This reference is searchable in the transports dashboard. Filled by trucker if document is added from mobile app, by user if document is added from web app, or filled by API request.","maxLength":140,"type":"string"},"visible_by_everyone":{"$ref":"#/components/schemas/visible_by_everyone"},"readable_by_trucker":{"$ref":"#/components/schemas/readable_by_trucker"},"delivery":{"type":"string"},"extracted_reference":{"description":"Reference extracted by AI from the document. AI runs only on weight notes, so it will be null for other documents. \"\" if no reference has been found by the AI.","type":"string"}},"type":"object"},"created":{"description":"Date of creation on our server","format":"date-time","type":"string"},"NewTransportMessage_author":{"properties":{"display_name":{"type":"string"},"company":{"type":"number"},"pk":{"description":"Dashdoc's internal id.","type":"number"}},"type":"object"},"latitude":{"description":"Latitude using the decimal GPS coordinates (WGS84). At 7 decimals, the position is accurate around the centimeter.","format":"float","nullable":true,"type":"number"},"longitude":{"description":"Longitude using the decimal GPS coordinates (WGS84). At 7 decimals, the position is accurate around the centimeter.","format":"float","nullable":true,"type":"number"},"visible_by_everyone":{"description":"This field is used to make the transport message public, which makes it visible by all parties of the transport.","type":"boolean"},"readable_by_trucker":{"description":"This field is used to allow truckers to see the transport message. **Only available for carriers.**","type":"boolean"}}}}
```

## The TransportTemplate object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"TransportTemplate":{"allOf":[{"$ref":"#/components/schemas/Transport"},{"$ref":"#/components/schemas/TransportTemplate_allOf"}]},"Transport":{"properties":{"uid":{"description":"Dashdoc's internal id. It will be automatically generated by us.","format":"uuid","type":"string"},"sequential_id":{"type":"number"},"created":{"description":"Date of creation sent by the creator. Useful when the transport is created by mobile devices. If network connection is bad, the `created` date can be later than `created_device`","format":"date-time","type":"string"},"updated":{"format":"date-time","type":"string"},"deleted":{"nullable":true,"type":"string"},"remote_id":{"description":"Your transport id. It has to be unique among all your transports","type":"string"},"carrier_address":{"$ref":"#/components/schemas/AddressForTransport"},"created_by":{"$ref":"#/components/schemas/Company"},"created_device":{"format":"date-time","type":"string"},"creation_method":{"enum":["mobile_app","api","web_app"],"type":"string"},"archived_by":{"items":{"type":"object"},"type":"array"},"is_order":{"type":"boolean"},"carrier_assignation_status":{"allOf":[{"$ref":"#/components/schemas/CarrierAssignationStatus"}],"nullable":true},"invite_code":{"type":"string"},"deliveries":{"items":{"$ref":"#/components/schemas/Delivery"},"type":"array"},"segments":{"items":{"$ref":"#/components/schemas/Segment"},"type":"array"},"status":{"$ref":"#/components/schemas/Statuses"},"status_updates":{"items":{"$ref":"#/components/schemas/Status"},"type":"array"},"has_observations":{"type":"boolean"},"messages":{"items":{"$ref":"#/components/schemas/TransportMessage"},"type":"array"},"requested_vehicle":{"$ref":"#/components/schemas/requested_vehicle"},"documents":{"items":{"$ref":"#/components/schemas/Document"},"type":"array"},"carrier_reference":{"description":"Text that will help the carrier operators manage the transports, e.g. transport number in his TMS. It should only be set by the carrier of the transport and the transport's creator can toggle a company-wide setting to only allow the carrier to set it.","type":"string"},"price":{"$ref":"#/components/schemas/deprecated_price"},"requires_washing":{"description":"Flag to enable the truck washing flow in the mobile app","type":"boolean"},"business_privacy":{"description":"Flag to enable 'business privacy' mode: no eCMR will be generated, and the trucker won't be prompted to share the transport link.","type":"boolean"},"is_multiple_compartments":{"description":"Flag to enable 'multiple compartments' mode: truckers will have to select in which compartments loads were loaded. It also generates a specific delivery document : loading_plan.","type":"boolean"},"loading_plan":{"description":"Uid of the loading plan created by the trucker. Contact us if you need to retrieve data from it","type":"string"},"customer_to_invoice":{"$ref":"#/components/schemas/customer_to_invoice"},"parent_transport":{"$ref":"#/components/schemas/Transport_parent_transport"},"invoice_number":{"nullable":true,"type":"string"},"invoiced_price":{"$ref":"#/components/schemas/deprecated_invoiced_price"},"volume_display_unit":{"enum":["m3","L"],"type":"string"},"references":{"items":{"$ref":"#/components/schemas/Transport_references"},"type":"array"},"rental_deliveries":{"description":"Array of transports executed by the trucker during the rental order. Implies that the current transport is a rental order. Inner objects have the same transport data structure.","items":{"$ref":"#/components/schemas/Transport"},"type":"array"},"billing-metrics":{"deprecated":true,"description":"Retired feature, will always be null.","nullable":true,"type":"string"},"shape":{"type":"string"},"instructions":{"$ref":"#/components/schemas/global_instructions"},"carbon_footprint":{"description":"Carbon footprint of the transport in kgCO2","nullable":true,"readOnly":true,"type":"number"},"tags":{"description":"List of tags applied to the transport.","items":{"$ref":"#/components/schemas/Tag"},"type":"array"}},"required":["business_privacy","carrier_address","carrier_reference","created","created_by","created_device","creation_method","deliveries","documents","has_observations","invite_code","invoice_number","is_order","messages","price","references","remote_id","requested_vehicle","requires_washing","segments","sequential_id","status","status_updates","uid","updated"],"type":"object"},"AddressForTransport":{"properties":{"pk":{"description":"Dashdoc's internal id.","type":"number"},"name":{"type":"string"},"address":{"type":"string"},"city":{"type":"string"},"postcode":{"type":"string"},"country":{"$ref":"#/components/schemas/country"},"latitude":{"$ref":"#/components/schemas/latitude"},"longitude":{"$ref":"#/components/schemas/longitude"},"radius":{"default":500,"description":"Radius around the GPS coordinates within which the address is located (in meters)","type":"integer"},"coords_validated":{"default":false,"description":"if `true`, when this address is used as a loading or unloading site, the mobile app displays an itinerary button to start GPS app with guidance to these coordinates","type":"boolean"},"is_demo":{"$ref":"#/components/schemas/is_demo"},"is_carrier":{"type":"boolean"},"is_shipper":{"type":"boolean"},"is_origin":{"$ref":"#/components/schemas/address_is_origin_and_is_destination"},"is_destination":{"$ref":"#/components/schemas/address_is_origin_and_is_destination"},"created_by":{"type":"number"},"created":{"$ref":"#/components/schemas/created"},"remote_id":{"description":"The id of the address in your system.","type":"string"},"company":{"$ref":"#/components/schemas/CompanyForTransportAddress"},"original":{"type":"number"}},"type":"object"},"country":{"description":"Only the 2-character codification is accepted (ISO 3166-1 alpha-2)","type":"string"},"latitude":{"description":"Latitude using the decimal GPS coordinates (WGS84). At 7 decimals, the position is accurate around the centimeter.","format":"float","nullable":true,"type":"number"},"longitude":{"description":"Longitude using the decimal GPS coordinates (WGS84). At 7 decimals, the position is accurate around the centimeter.","format":"float","nullable":true,"type":"number"},"is_demo":{"description":"Indicates that the address is a fake one created from demonstration. Everything linked to it will be deleted when using the 'Delete demo content' button in company parameters","type":"boolean"},"address_is_origin_and_is_destination":{"description":"Whether this address is a \"Logistic Points\" and will be usable as pickup/delivery point.\nThe distinction between origin/pickup and destination/delivery was merged as a single \"Logistic Point\" concept. `is_origin` implies `is_destination` and vice-versa.\n","type":"boolean"},"created":{"description":"Date of creation on our server","format":"date-time","type":"string"},"CompanyForTransportAddress":{"properties":{"pk":{"description":"Dashdoc's internal id.","type":"number"},"remote_id":{"description":"The id of the company in your system.","type":"string"},"name":{"type":"string"},"trade_number":{"type":"string"},"country":{"$ref":"#/components/schemas/country"},"settings_contract_html":{"description":"Ignore. Dashdoc technical data.","type":"string"},"settings_logo":{"description":"Ignore. Dashdoc technical data.","nullable":true,"type":"string"},"settings_stamp":{"description":"Ignore. Dashdoc technical data.","nullable":true,"type":"string"},"settings_print_mode":{"description":"Ignore. Dashdoc technical data.","type":"boolean"},"settings_special_agreements":{"description":"Ignore. Dashdoc technical data.","type":"string"},"settings_transport_order_observations":{"type":"string"},"settings_constrain_reference_edition":{"type":"boolean"},"vat_number":{"type":"string"},"is_verified":{"type":"boolean"}},"type":"object"},"Company":{"properties":{"pk":{"description":"Dashdoc's internal id.","type":"number"},"remote_id":{"type":"string"},"created":{"format":"date-time","type":"object"},"updated":{"format":"date-time","type":"string"},"deleted":{"type":"boolean"},"invoicing_remote_id":{"description":"The id of the company in your invoicing system.","type":"string"},"name":{"type":"string"},"phone_number":{"type":"string"},"email":{"type":"string"},"siren":{"type":"string"},"trade_number":{"type":"string"},"country":{"$ref":"#/components/schemas/country"},"comments":{"type":"string"},"vat_number":{"type":"string"},"is_verified":{"type":"boolean"},"settings_transport_order_observations":{"type":"string"},"settings_constrain_reference_edition":{"type":"boolean"},"account_type":{"description":"Ignore. Dashdoc technical data.","type":"string"},"logo":{"description":"The URL of your logo","nullable":true,"type":"string"},"subscription_access":{"type":"object"},"settings":{"type":"object"},"primary_address":{"$ref":"#/components/schemas/PrimaryAddress_1"},"managers":{"items":{"$ref":"#/components/schemas/Managers"},"type":"array"},"has_loggable_managers":{"description":"Ignore. Dashdoc technical data.","type":"boolean"}},"type":"object"},"PrimaryAddress_1":{"properties":{"pk":{"description":"Dashdoc's internal id.","type":"number"},"name":{"type":"string"},"address":{"type":"string"},"city":{"type":"string"},"postcode":{"type":"string"},"country":{"$ref":"#/components/schemas/country"},"latitude":{"$ref":"#/components/schemas/latitude"},"longitude":{"$ref":"#/components/schemas/longitude"},"radius":{"default":500,"description":"Radius around the GPS coordinates within which the address is located (in meters)","type":"integer"},"coords_validated":{"default":false,"description":"if `true`, when this address is used as a loading or unloading site, the mobile app displays an itinerary button to start GPS app with guidance to these coordinates","type":"boolean"},"is_demo":{"$ref":"#/components/schemas/is_demo"},"is_carrier":{"description":"Whether this company is considered a carrier","type":"boolean"},"is_shipper":{"description":"Whether this company is considered a shipper","type":"boolean"},"is_origin":{"description":"Legacy, not relevant for a company's primary address. Consider creating a separate address associated with this partner instead.\n","type":"boolean"},"is_destination":{"description":"Legacy, not relevant for a company's primary address. Consider creating a separate address associated with this partner instead.\n","type":"boolean"},"created_by":{"$ref":"#/components/schemas/created-by"},"created_by_user":{"$ref":"#/components/schemas/created-by-user"},"created":{"$ref":"#/components/schemas/created"},"remote_id":{"description":"The id of the address in your system.","type":"string"}},"type":"object"},"created-by":{"nullable":true,"properties":{"pk":{"description":"company id","type":"number"},"name":{"description":"name of the company","type":"string"}},"type":"object"},"created-by-user":{"nullable":true,"properties":{"pk":{"type":"number"},"display_name":{"type":"string"},"company":{"description":"The company id who created the address","type":"number"},"trucker_id":{"description":"The trucker id who created the address","type":"number"}},"type":"object"},"Managers":{"properties":{"pk":{"description":"Dashdoc's internal id.","type":"number"},"user":{"$ref":"#/components/schemas/Managers_user"},"display_name":{"type":"string"},"role":{"type":"string"}},"type":"object"},"Managers_user":{"properties":{"email":{"format":"email","type":"string"},"first_name":{"type":"string"},"last_name":{"type":"string"}},"type":"object"},"CarrierAssignationStatus":{"description":"Carrier assignment state of an order (Only for chartered transport). Null values should be treated as unassigned.","enum":["unassigned","draft_assigned","assigned"],"type":"string"},"Delivery":{"properties":{"uid":{"description":"Dashdoc's internal id.","type":"string"},"sequential_id":{"description":"eCMR number","type":"number"},"remote_id":{"type":"string"},"tracking_id":{"description":"Deprecated","type":"string"},"origin":{"$ref":"#/components/schemas/CreateOrUpdateSite"},"destination":{"$ref":"#/components/schemas/CreateOrUpdateSite"},"shipper_address":{"$ref":"#/components/schemas/NewAddressReduced"},"planned_loads":{"description":"Loads as planned before the transport has been started","items":{"$ref":"#/components/schemas/DeliveryLoads"},"type":"array"},"loads":{"description":"Loads as they are most recently defined. This means it is: \n\n* equal to `planned_loads` before loading is actually done \n\n* equal to `origin_loads` after loading is done (with details validated by trucker), but unloading is not done yet \n\n* equal to `loads_loads` after unloading is actually done (with details validated by trucker)","items":{"$ref":"#/components/schemas/DeliveryLoads"},"type":"array"},"origin_loads":{"description":"Loads as validated by trucker right after loading is done","items":{"$ref":"#/components/schemas/DeliveryLoads"},"type":"array"},"destination_loads":{"description":"Loads as validated by trucker right after unloading is done","items":{"$ref":"#/components/schemas/DeliveryLoads"},"type":"array"},"tracking_contacts":{"description":"List of contacts that will automatically receive an email when delivery is done. ⚠️ If no tracking contacts are provided for a company and the setting `partner_email_fallback` is enabled, a tracking contact corresponding to the company's email will be added, at the creation of the transport. This only applies to the carrier and the shipper.","items":{"$ref":"#/components/schemas/Delivery_tracking_contacts"},"type":"array"},"shipper_reference":{"description":"Reference the client may use to match transport on his own system, e.g. an order number. The transport's creator can toggle a setting to only allow himself to set it.","type":"string"},"multiple_rounds":{"description":"If true, the trucker will be able to do a signature at loading, then add any amount of rounds for the transport (with weight/volume and weight ticket), and finish with a signature at unloading.","type":"boolean"}},"type":"object"},"CreateOrUpdateSite":{"properties":{"uid":{"format":"uuid","type":"string"},"remote_id":{"description":"The id of the site in your system","type":"string"},"address":{"allOf":[{"$ref":"#/components/schemas/SiteAddress"}],"nullable":true},"real_start":{"description":"date and time when trucker arrived on site","format":"date-time","readOnly":true,"type":"string"},"real_end":{"description":"date and time when trucker completed loading / unloading (depending whether site is origin or destination)","format":"date-time","readOnly":true,"type":"string"},"signature_process":{"type":"string"},"is_booking_needed":{"type":"boolean"},"instructions":{"$ref":"#/components/schemas/site_instructions"},"reference":{"type":"string"},"action":{"deprecated":true,"description":"Deprecated. Accepted for backward compatibility but ignored. Responses always return an empty string.","type":"string"},"eta":{"format":"date-time","nullable":true,"type":"string"},"eta_tracking":{"type":"boolean"},"punctuality_status":{"readOnly":true,"type":"string"},"supports_exchanges":{"$ref":"#/components/schemas/SupportsExchange"},"category":{"type":"string"},"slots":{"items":{"$ref":"#/components/schemas/Site_slots"},"type":"array"},"trucker_instructions":{"$ref":"#/components/schemas/trucker_instructions"},"trip":{"$ref":"#/components/schemas/Site_trip"}},"type":"object"},"SiteAddress":{"description":"Address of the site. Reference an existing address with its `pk` or `remote_id`, or send its details to have it matched or created.","properties":{"pk":{"description":"Dashdoc's internal id. Optional, set it to reference an existing address.","type":"integer"},"name":{"type":"string"},"address":{"type":"string"},"city":{"type":"string"},"postcode":{"type":"string"},"country":{"$ref":"#/components/schemas/country"},"latitude":{"$ref":"#/components/schemas/latitude"},"longitude":{"$ref":"#/components/schemas/longitude"},"radius":{"default":500,"description":"Radius around the GPS coordinates within which the address is located (in meters)","type":"integer"},"coords_validated":{"default":false,"description":"if `true`, when this address is used as a loading or unloading site, the mobile app displays an itinerary button to start GPS app with guidance to these coordinates","type":"boolean"},"is_demo":{"$ref":"#/components/schemas/is_demo"},"is_carrier":{"type":"boolean"},"is_shipper":{"type":"boolean"},"is_origin":{"$ref":"#/components/schemas/address_is_origin_and_is_destination"},"is_destination":{"$ref":"#/components/schemas/address_is_origin_and_is_destination"},"instructions":{"$ref":"#/components/schemas/site_instructions"},"remote_id":{"description":"The id of the address in your system.","type":"string"},"company":{"$ref":"#/components/schemas/CompanyForTransportAddress_1"}},"type":"object"},"site_instructions":{"description":"Site instructions, visible to all parties (trucker, carrier, shipper, site). Displayed in the trucker mobile app. Not visible in the eCMR. If the field is not provided, the address's site instructions will be used.","maxLength":1000,"type":"string"},"CompanyForTransportAddress_1":{"description":"Identification of the company. You may simply use its `pk` or `remote_id` if the company already exists. Other possible identification method are its `trade_number` or `name`. If it doesn't exist, the company will be created with the information you send based on what's possible when creating a company via /companies/ web service. Minimum required information in this case is a name.","properties":{"pk":{"description":"Dashdoc's internal id.Optional, not required if `remote_id` is sent.","type":"integer"},"remote_id":{"description":"The id of the company in your system. Optional, ignored if `pk` is sent.","type":"string"},"trade_number":{"maxLength":100,"type":"string"},"name":{"maxLength":200,"type":"string"}},"type":"object"},"SupportsExchange":{"properties":{"uid":{"description":"uid of the support exchange","format":"uuid","type":"string"},"site":{"$ref":"#/components/schemas/SupportsExchange_site"},"support_type":{"$ref":"#/components/schemas/SupportType"},"expected_retrieved":{"description":"Expected number of supports that should be retrieved on the site","type":"number"},"actual_retrieved":{"description":"Actual number of supports that were retrieved on the site","type":"number"},"expected_delivered":{"description":"Expected number of supports that should be delivered on the site","type":"number"},"actual_delivered":{"description":"Actual number of supports that were delivered on the site","type":"number"},"observations":{"description":"Free text. Observations about this supports exchange. Can be filled on mobile app, web app or via API.","type":"string"},"remote_id":{"description":"The ID of the support in your system","type":"string"}},"type":"object"},"SupportsExchange_site":{"description":"site where supports exchange is expected","properties":{"uid":{"description":"uid of the site","format":"uuid","type":"string"},"remote_id":{"description":"remote_id of the site","type":"string"}},"type":"object"},"SupportType":{"description":"Type of the supports that are exchanged","properties":{"name":{"description":"Display name of the support type","type":"string"},"created":{"$ref":"#/components/schemas/created"},"uid":{"format":"uuid","type":"string"},"remote_id":{"description":"The id of the support type in your system.","type":"string"}},"type":"object"},"Site_slots":{"properties":{"start":{"format":"date-time","type":"string"},"end":{"format":"date-time","type":"string"}},"type":"object"},"trucker_instructions":{"description":"**This field is part of a beta feature.** Private instructions. **The carrier of the transport is the only one who can edit and read those instructions.** Note that those instructions are not visible in the consignment note and can be accessed by the trucker. The value is null if the caller doesn't have the right of access to the data.","maxLength":1000,"type":"string"},"Site_trip":{"description":"Trip linked to this site/activity.","nullable":true,"properties":{"uid":{"format":"uuid","type":"string"},"name":{"type":"string"},"is_prepared":{"type":"boolean"},"status":{"enum":["unstarted","ongoing","done"],"type":"string"}},"readOnly":true,"type":"object"},"NewAddressReduced":{"properties":{"pk":{"description":"Dashdoc's internal id. Optional, set it to reference an existing address.","type":"integer"},"name":{"type":"string"},"address":{"type":"string"},"city":{"type":"string"},"postcode":{"type":"string"},"country":{"$ref":"#/components/schemas/country"},"latitude":{"$ref":"#/components/schemas/latitude"},"longitude":{"$ref":"#/components/schemas/longitude"},"radius":{"default":500,"description":"Radius around the GPS coordinates within which the address is located (in meters)","type":"integer"},"coords_validated":{"default":false,"description":"if `true`, when this address is used as a loading or unloading site, the mobile app displays an itinerary button to start GPS app with guidance to these coordinates","type":"boolean"},"is_demo":{"$ref":"#/components/schemas/is_demo"},"is_carrier":{"type":"boolean"},"is_shipper":{"type":"boolean"},"is_origin":{"type":"boolean"},"is_destination":{"type":"boolean"},"created_by":{"description":"Ignore. Dashdoc technical data.","readOnly":true,"type":"number"},"created":{"description":"Date of creation on our server","format":"date-time","readOnly":true,"type":"string"},"instructions":{"type":"string"},"remote_id":{"description":"The id of the address in your system.","type":"string"},"company":{"$ref":"#/components/schemas/CompanyForTransportAddress"},"original":{"description":"Ignore. Dashdoc technical data.","nullable":true,"readOnly":true,"type":"number"}},"required":["address","city","company","country","postcode"],"type":"object"},"DeliveryLoads":{"properties":{"uid":{"description":"Dashdoc's internal id.","type":"string"},"remote_id":{"description":"The ID of the load in your system. It has to be unique among all your transports.","type":"string"},"description":{"description":"Text description of the load","type":"string"},"reference":{"description":"Reference of the load","type":"string"},"round_id":{"description":"The ID of the round.","format":"integer","type":"number"},"weight":{"description":"In kilograms","format":"float","type":"number"},"volume":{"description":"Volume of load in m3","format":"float","type":"number"},"volume_display_unit":{"default":"m3","enum":["m3","L"],"type":"string"},"linear_meters":{"description":"Length of load in meters","format":"float","type":"number"},"quantity":{"description":"Only one decimal accepted (e.g 0.0)","format":"float","type":"number"},"pallet_equivalence":{"description":"Pallet equivalence (EPS/EQPAL): how many standard pallet spaces the load occupies. `null` when it was never set. Otherwise at least `0.01`, with two decimals kept.","format":"float","nullable":true,"type":"number"},"category":{"description":"Packaging of the load. The text is free but these specific values cause a custom flow on the mobile app: `pallets`, `containers`, `bulk`, `roundwood`, `powder_tank`, `bulk_qualimat`, `rental`.","type":"string"},"dangerous_goods_category":{"description":"ADR class","enum":["1","2","3","4.1","4.2","4.3","5.1","5.2","6.1","6.2","7","8","9"],"type":"string"},"is_dangerous":{"type":"boolean"},"adr_un_code":{"type":"string"},"legal_mentions":{"type":"string"},"complementary_information":{"description":"Any information about the load that doesn't fit to the description field","type":"string"},"container_number":{"type":"string"},"tare_weight":{"description":"In kilograms","format":"float","type":"number"},"container_seal_number":{"type":"string"},"refrigerated":{"description":"Indicates whether the load is refrigerated. If true, the trucker can fill in the temperature.","type":"boolean"},"temperature":{"type":"string"},"steres":{"format":"float","type":"number"},"idtf_number":{"description":"Must match an existing IDTF number","type":"string"},"use_identifiers":{"description":"if `true`, trucker is asked to scan barcode identifiers on load","type":"boolean"},"identifiers":{"description":"Only relevant if use_identifiers is set to `true`. List of expected barcode identifiers that the trucker should scan at loading and unloading. App controls that expected barcodes are actually scanned. If empty, the trucker will have to scan barcodes anyway, but there won't be any check. Feature has to be activated in your account by your Dashdoc projet manager.","items":{"type":"string"},"type":"array"},"identifiers_observations":{"description":"Observations explaining issues with identifier, such as missing or unexpected identifiers","type":"string"}},"type":"object"},"Delivery_tracking_contacts":{"properties":{"uid":{"description":"Dashdoc's internal id.","type":"string"},"contact":{"$ref":"#/components/schemas/NewContact"},"subscribed_to_status_updates":{"description":"If set to true, the contact will receive an email at every step of the delivery. Else, they will receive only one email once the delivery is done.","type":"boolean"},"role":{"description":"The role of the contact in the delivery. It can be `carrier`, `shipper`, or `site`.","type":"string"}},"required":["contact"],"type":"object"},"NewContact":{"properties":{"uid":{"format":"uuid","type":"string"},"created":{"description":"Date of creation on our server","format":"date-time","readOnly":true,"type":"string"},"company":{"$ref":"#/components/schemas/CompanyIdentification"},"first_name":{"maxLength":200,"type":"string"},"last_name":{"maxLength":200,"type":"string"},"email":{"format":"email","type":"string"},"phone_number":{"maxLength":100,"type":"string"},"fax_number":{"maxLength":100,"type":"string"},"remote_id":{"description":"The id of the contact in your system","type":"string"}},"required":["company","last_name"],"type":"object"},"CompanyIdentification":{"description":"Identification of the company. The company must already exist in Dashdoc.","properties":{"pk":{"description":"Dashdoc's internal id. Optional, not required if `remote_id` is sent.","type":"integer"},"remote_id":{"description":"Your remote carrier id. Optional, ignored if `pk` is sent.","type":"string"},"name":{"type":"string"},"trade_number":{"type":"string"},"country":{"$ref":"#/components/schemas/country"},"settings_contract_html":{"description":"Ignore. Dashdoc technical data.","type":"string"},"settings_logo":{"description":"Ignore. Dashdoc technical data.","nullable":true,"type":"string"},"settings_stamp":{"description":"Ignore. Dashdoc technical data.","nullable":true,"type":"string"},"settings_print_mode":{"description":"Ignore. Dashdoc technical data.","type":"boolean"},"settings_special_agreements":{"description":"Ignore. Dashdoc technical data.","type":"string"},"settings_transport_order_observations":{"type":"string"},"settings_constrain_reference_edition":{"type":"boolean"},"vat_number":{"type":"string"},"is_verified":{"description":"Ignore. Dashdoc technical data.","type":"string"}},"type":"object"},"Segment":{"description":"","properties":{"uid":{"minLength":1,"type":"string"},"remote_id":{"minLength":1,"type":"string"},"origin":{"$ref":"#/components/schemas/Site"},"destination":{"$ref":"#/components/schemas/Site"},"trucker":{"$ref":"#/components/schemas/SegmentTrucker"},"vehicle":{"$ref":"#/components/schemas/Vehicle"},"trailers":{"items":{"$ref":"#/components/schemas/Trailer"},"type":"array"},"sort_order":{"description":"The index of the segment in the transport","minimum":0,"type":"number"},"scheduled_start_range":{"$ref":"#/components/schemas/Segment_scheduled_start_range"},"scheduled_end_range":{"$ref":"#/components/schemas/Segment_scheduled_end_range"},"scheduled_start":{"deprecated":true,"description":"The datetime at which the carrier scheduled the start of this segment\n","type":"string"},"scheduled_end":{"deprecated":true,"description":"The datetime at which the carrier scheduled the end of this segment","type":"string"},"child_transport":{"$ref":"#/components/schemas/Segment_child_transport"},"telematic_distance":{"description":"Automatically computed distance from telematic data (in kms).","type":"integer"},"distance":{"description":"Manually entered distance. If null, it takes the value of telematic_distance (in kms).","type":"integer"},"origin_mileage":{"description":"Mileage at transport origin site (in kms).","type":"integer"},"destination_mileage":{"description":"Mileage at transport destination site (in kms).","type":"integer"}},"type":"object"},"Site":{"properties":{"uid":{"format":"uuid","type":"string"},"remote_id":{"description":"The id of the site in your system","type":"string"},"address":{"$ref":"#/components/schemas/Address"},"real_start":{"description":"date and time when trucker arrived on site","format":"date-time","type":"string"},"real_end":{"description":"date and time when trucker completed loading / unloading (depending whether site is origin or destination)","format":"date-time","type":"string"},"signature_process":{"type":"string"},"instructions":{"$ref":"#/components/schemas/site_instructions"},"reference":{"type":"string"},"action":{"deprecated":true,"description":"Deprecated. Always returned as an empty string.","type":"string"},"eta":{"nullable":true,"type":"string"},"eta_tracking":{"$ref":"#/components/schemas/eta_tracking"},"punctuality_status":{"$ref":"#/components/schemas/punctuality_status"},"supports_exchanges":{"$ref":"#/components/schemas/SupportsExchange"},"category":{"enum":["loading","unloading"],"type":"string"},"slots":{"items":{"$ref":"#/components/schemas/Site_slots"},"type":"array"},"trucker_instructions":{"$ref":"#/components/schemas/trucker_instructions"},"trip":{"$ref":"#/components/schemas/Site_trip"}},"type":"object"},"Address":{"properties":{"pk":{"description":"Dashdoc's internal id.","type":"number"},"name":{"type":"string"},"address":{"type":"string"},"city":{"type":"string"},"postcode":{"type":"string"},"country":{"$ref":"#/components/schemas/country"},"latitude":{"$ref":"#/components/schemas/latitude"},"longitude":{"$ref":"#/components/schemas/longitude"},"radius":{"default":500,"description":"Radius around the GPS coordinates within which the address is located (in meters)","type":"integer"},"coords_validated":{"default":false,"description":"if `true`, when this address is used as a loading or unloading site, the mobile app displays an itinerary button to start GPS app with guidance to these coordinates","type":"boolean"},"is_demo":{"$ref":"#/components/schemas/is_demo"},"is_carrier":{"type":"boolean"},"is_shipper":{"type":"boolean"},"is_origin":{"$ref":"#/components/schemas/address_is_origin_and_is_destination"},"is_destination":{"$ref":"#/components/schemas/address_is_origin_and_is_destination"},"created_by":{"$ref":"#/components/schemas/created-by"},"created_by_user":{"$ref":"#/components/schemas/created-by-user"},"created":{"$ref":"#/components/schemas/created"},"instructions":{"$ref":"#/components/schemas/site_instructions"},"remote_id":{"description":"The id of the address in your system.","type":"string"},"original":{"description":"Dashdoc's internal id of the original address.","nullable":true,"readOnly":true,"type":"number"},"company":{"$ref":"#/components/schemas/Company"}},"type":"object"},"eta_tracking":{"default":false,"description":"Ask for an ETA on this site. This is currently a beta feature, not activated by default.","type":"boolean"},"punctuality_status":{"default":"untracked","description":"Indicate the punctuality on this site.","enum":["untracked","probably_late","probably_on_time","late","on_time"],"type":"string"},"SegmentTrucker":{"properties":{"pk":{"description":"Dashdoc's internal id.","type":"number"},"remote_id":{"description":"The ID of the trucker in your system. It has to be unique among all your truckers.","type":"string"},"display_name":{"type":"string"},"user":{"$ref":"#/components/schemas/SegmentTruckerUser"}},"type":"object"},"SegmentTruckerUser":{"properties":{"pk":{"description":"Dashdoc's internal id.","type":"number"},"first_name":{"type":"string"},"last_name":{"type":"string"},"username":{"description":"Ignore. Dashdoc technical data.","type":"string"},"email":{"format":"email","type":"string"},"display_name":{"description":"Display name generated by Dashdoc.","type":"string"},"date_joined":{"description":"Ignore. Dashdoc technical data.","format":"date-time","type":"string"},"is_staff":{"description":"Ignore. Dashdoc technical data.","type":"boolean"},"is_superuser":{"description":"Ignore. Dashdoc technical data.","type":"boolean"},"has_usable_password":{"description":"Ignore. Dashdoc technical data.","type":"boolean"}},"type":"object"},"Vehicle":{"properties":{"pk":{"description":"Dashdoc's internal id","type":"number"},"carrier":{"description":"Dashdoc's internal id of the carrier owning the vehicle","type":"number"},"category":{"description":"Vehicle category","type":"string"},"license_plate":{"description":"License plate number","type":"string"},"fleet_number":{"description":"Your vehicle fleet number","type":"string"},"remote_id":{"description":"The ID of the vehicle in your system","type":"string"},"created":{"description":"Date of creation on our server","format":"date-time","type":"string"},"used_for_qualimat_transports":{"description":"True if the vehicle can be used for Qualimat transport (only used for visual help and warnings)","type":"boolean"},"telematic_vehicle":{"description":"Ignore. Dashdoc technical data","type":"number"},"original":{"type":"number"},"tags":{"description":"List of tags applied to the vehicle.","items":{"$ref":"#/components/schemas/Tag"},"type":"array"},"technical_control_deadline":{"format":"date-time","type":"string"},"tachograph_deadline":{"format":"date-time","type":"string"},"speed_limiter_deadline":{"format":"date-time","type":"string"},"country":{"$ref":"#/components/schemas/country"},"unavailability":{"description":"List of unavailable period","items":{"$ref":"#/components/schemas/Unavailability"},"type":"array"},"events":{"description":"Ignore. Dashdoc technical data.","items":{"type":"object"},"type":"array"}},"type":"object"},"Tag":{"properties":{"pk":{"description":"The unique identifier of the tag","type":"integer"},"name":{"description":"The name of the tag","type":"string"},"color":{"description":"The color of the tag in hex format","type":"string"},"tag_group_id":{"description":"The ID of the tag group this tag belongs to, if any","nullable":true,"type":"integer"}},"required":["color","name","pk"],"type":"object"},"Unavailability":{"properties":{"id":{"description":"Dashdoc's internal id","type":"number"},"remote_id":{"description":"The ID of the unavailability in your system","type":"string"},"created":{"description":"Date of creation on our server","format":"date-time","type":"string"},"start_date":{"description":"Start date of the unavailability","format":"date-time","type":"string"},"end_date":{"description":"End date of the unavailability","format":"date-time","type":"string"},"unavailability_type":{"description":"Type of unavailability","enum":["paid_vacation","day_off","sick_leave","training","vacation","maintenance","rental","other"],"type":"string"},"unavailability_note":{"description":"Notes about the unavailability","type":"string"}},"type":"object"},"Trailer":{"properties":{"pk":{"description":"Dashdoc's internal id","type":"number"},"original":{"description":"Ignore. Dashdoc technical data","type":"number"},"carrier":{"description":"Dashdoc's internal id of the carrier owning the trailer","type":"number"},"license_plate":{"description":"License plate number","type":"string"},"fleet_number":{"description":"Your trailer fleet number","type":"string"},"remote_id":{"description":"The ID of the trailer in your system","type":"string"},"created":{"description":"Date of creation on our server","format":"date-time","type":"string"},"used_for_qualimat_transports":{"description":"True if the trailer can be used for Qualimat transport (only used for visual help and warnings)","type":"boolean"},"tags":{"description":"List of tags applied to the trailer.","items":{"$ref":"#/components/schemas/Tag"},"type":"array"},"technical_control_deadline":{"format":"date-time","type":"string"},"country":{"$ref":"#/components/schemas/country"},"unavailability":{"description":"List of unavailable period","items":{"$ref":"#/components/schemas/Unavailability"},"type":"array"},"events":{"description":"Ignore. Dashdoc technical data.","items":{"type":"object"},"type":"array"}},"type":"object"},"Segment_scheduled_start_range":{"description":"The datetime range at which the carrier scheduled the start of this segment","properties":{"start":{"description":"Min scheduled start date (ISO 8601)","type":"string"},"end":{"description":"Max scheduled start date (ISO 8601)","type":"string"}},"type":"object"},"Segment_scheduled_end_range":{"description":"The datetime range at which the carrier scheduled the end of this segment","properties":{"start":{"description":"Min scheduled end date (ISO 8601)","type":"string"},"end":{"description":"Max scheduled end date (ISO 8601)","type":"string"}},"type":"object"},"Segment_child_transport":{"description":"If the segment is chartered, will contain the child transport","properties":{"uid":{"format":"uuid","type":"string"},"sequential_id":{"type":"number"},"remote_id":{"type":"string"},"has_strong_link":{"type":"boolean"}},"type":"object"},"Statuses":{"enum":["created","updated","confirmed","declined","verified","invoiced","paid","cancelled","assigned","sent_to_trucker","acknowledged","truck_wash","on_loading_site","loading_complete","on_unloading_site","unloading_complete","bulking_break_started","bulking_break_complete","rounds_started","round_added","round_added_v2","round_edited","round_deleted","rounds_complete","event","checklist_filled","activity_complete","on_the_way","handling_started","done"],"type":"string"},"Status":{"properties":{"uid":{"format":"uuid","type":"string"},"created":{"description":"Date of creation on the server. Useful when the transport is created by mobile devices. If network connection is bad, the `created` date can be later than `created_device`","format":"date-time","type":"string"},"created_device":{"description":"If created from a mobile device, date of creation on the device.","format":"date-time","type":"string"},"creation_method":{"type":"string"},"category":{"description":"event that occured on the transport","type":"string"},"author":{"description":"details about author of the update. Contact Dashdoc if more details is needed.","type":"object"},"content":{"description":"Contact Dashdoc if more details is needed.","type":"object"},"content_signatory":{"description":"Contact Dashdoc if more details is needed.","type":"object"},"target":{"description":"Contact Dashdoc if more details is needed.","type":"object"},"site":{"description":"Contact Dashdoc if more details is needed.","type":"object"},"site_id":{"description":"Contact Dashdoc if more details is needed.","format":"uuid","type":"string"},"delivery":{"description":"Contact Dashdoc if more details is needed.","format":"uuid","type":"string"},"segment":{"description":"Contact Dashdoc if more details is needed.","format":"uuid","type":"string"},"transport":{"description":"Contact Dashdoc if more details is needed.","format":"uuid","type":"string"},"signature":{"description":"Contact Dashdoc if more details is needed.","type":"object"},"latitude":{"description":"Contact Dashdoc if more details is needed.","format":"float","type":"number"},"longitude":{"description":"Contact Dashdoc if more details is needed.","format":"float","type":"number"},"update_details":{"description":"Contact Dashdoc if more details is needed.","type":"object"},"author_company":{"type":"number"}},"required":["uid"],"type":"object"},"TransportMessage":{"properties":{"uid":{"format":"uuid","type":"string"},"created":{"$ref":"#/components/schemas/created"},"created_device":{"format":"date-time","type":"string"},"creation_method":{"type":"string"},"author":{"$ref":"#/components/schemas/NewTransportMessage_author"},"type":{"enum":["note","load_verification","share","document","photo"],"maxLength":100,"type":"string"},"document_title":{"description":"Filename or if uploaded by a trucker from the mobile app, the document title is generic, for instance `photo`.","maxLength":100,"type":"string"},"document_type":{"enum":["load_photo","cmr","washing_note","delivery_note","confirmation","weight_note","waste_manifest","holders_swap_note","invoice"],"maxLength":100,"type":"string"},"document":{"description":"URL of the stored document. You can download the document from this URL.","type":"string"},"is_attached_to_cmr":{"type":"boolean"},"transport":{"format":"uuid","type":"string"},"site":{"description":"This field is used for the default values of the field readable_by_company_ids; if null, companies from all Sites of the transport are listed in readable_by_company_ids, otherwise only the company of this Site. Site must exist in this transport. This field is part of a beta feature.","format":"uuid","nullable":true,"type":"string"},"site_remote_id":{"type":"string"},"readable_by_company_ids":{"description":"A list containing the pk of each company allowed to access the document, every company must be part of the transport. If no values are sent, it will be computed with default values; Carrier, Shipper, Invoiced Customer and Site's pk (see Site field). Once values have been sent, the behavior adding default companies is deactivated. The author company is always added. Only pks of companies from the transport will be added, others will be ignored. This field is part of a beta feature.","items":{"type":"integer"},"type":"array"},"message":{"description":"message displayed in the activity thread of a transport in the web app and in the mobile app","type":"string"},"latitude":{"$ref":"#/components/schemas/latitude"},"longitude":{"$ref":"#/components/schemas/longitude"},"reference":{"description":"Free text. This reference is searchable in the transports dashboard. Filled by trucker if document is added from mobile app, by user if document is added from web app, or filled by API request.","maxLength":140,"type":"string"},"visible_by_everyone":{"$ref":"#/components/schemas/visible_by_everyone"},"readable_by_trucker":{"$ref":"#/components/schemas/readable_by_trucker"},"extracted_reference":{"description":"Reference extracted by AI from the document. AI runs only on weight notes, so it will be null for other documents. \"\" if no reference has been found by the AI.","type":"string"}},"type":"object"},"NewTransportMessage_author":{"properties":{"display_name":{"type":"string"},"company":{"type":"number"},"pk":{"description":"Dashdoc's internal id.","type":"number"}},"type":"object"},"visible_by_everyone":{"description":"This field is used to make the transport message public, which makes it visible by all parties of the transport.","type":"boolean"},"readable_by_trucker":{"description":"This field is used to allow truckers to see the transport message. **Only available for carriers.**","type":"boolean"},"requested_vehicle":{"description":"Only useful when the transport is created by the shipper. Free text except punction and special characters.","maxLength":40,"type":"string"},"Document":{"properties":{"pk":{"type":"integer"},"file_updated_date":{"description":"Date was updated on the server.","format":"date-time","type":"string"},"delivery":{"description":"Contact Dashdoc if more details are needed.","format":"uuid","type":"string"},"delivery_sequential_id":{"description":"eCMR number (for category \"cmr\" and \"ldv\")","type":"integer"},"reference":{"type":"integer"},"category":{"description":"Type of document. Possible values are \"cmr\", \"cmr4\", \"ldv\", \"orc\", \"chc\", \"rental\" and \"loading_plan\"","type":"string"},"languages":{"description":"Languages displayed in the document (CMR only), formatted as an 2-letter ISO 639-1 language code","items":{"type":"string"},"type":"array"},"name":{"description":"generic name of the document","type":"string"},"file":{"description":"path to the document","format":"url","type":"string"},"business_privacy_scope":{"description":"Ignore. Dashdoc technical data.","type":"boolean"},"cancelled":{"description":"Date of cancellation of the the document","format":"date-time","type":"string"}},"type":"object"},"deprecated_price":{"deprecated":true,"description":"Full price for the transport","format":"float","nullable":true,"type":"number"},"customer_to_invoice":{"properties":{"pk":{"description":"Dashdoc's internal id.","type":"number"},"name":{"type":"string"},"invoicing_address":{"$ref":"#/components/schemas/customer_to_invoice_invoicing_address"}},"type":"object"},"customer_to_invoice_invoicing_address":{"properties":{"address":{"type":"string"},"city":{"type":"string"},"postcode":{"type":"string"},"country":{"$ref":"#/components/schemas/country"}},"type":"object"},"Transport_parent_transport":{"description":"if this is a chartered transport, this will contains the parent transport it is chartered from","properties":{"uid":{"format":"uuid","type":"string"},"sequential_id":{"type":"number"},"remote_id":{"type":"string"},"has_strong_link":{"type":"boolean"}},"type":"object"},"deprecated_invoiced_price":{"deprecated":true,"description":"Invoiced price for the transport. Deprecated in favour of pricing field","format":"float","nullable":true,"type":"number"},"Transport_references":{"properties":{"role":{"type":"string"},"company":{"$ref":"#/components/schemas/Transport_company"},"reference":{"type":"string"}},"type":"object"},"Transport_company":{"properties":{"name":{"type":"string"}},"type":"object"},"global_instructions":{"description":"Operating instructions. The carrier, the shipper and the creator of the transport have access to those instructions. However, the creator is the only who has the right to edit.","maxLength":1000,"type":"string"},"TransportTemplate_allOf":{"properties":{"template_name":{"description":"Name given to the template","type":"string"}},"type":"object"}}}}
```

## The vehicle\_category object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"vehicle_category":{"description":"Vehicle category","enum":["unknown","light","straight","straight_tipper","tipper","tipper_cereal","tipper_construction","refrigerated","isotherm","platform","curtainsider","box_body","trailer_truck","flatbed","low_flatbed","log","coil","container","vehicle","heavy_equipment","solid_tanker","petrol_tanker","chemical_tanker","food_tanker","livestock","special_convoy"],"maxLength":200,"type":"string"}}}}
```

## The treatment\_code object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"treatment_code":{"enum":["R1","R2","R3","R4","R5","R6","R7","R8","R9","R10","R11","R12","R13","D1","D2","D3","D4","D5","D6","D7","D8","D9","D10","D11","D12","D13","D14","D15"],"type":"string"}}}}
```

## The Managers object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"Managers":{"properties":{"pk":{"description":"Dashdoc's internal id.","type":"number"},"user":{"$ref":"#/components/schemas/Managers_user"},"display_name":{"type":"string"},"role":{"type":"string"}},"type":"object"},"Managers_user":{"properties":{"email":{"format":"email","type":"string"},"first_name":{"type":"string"},"last_name":{"type":"string"}},"type":"object"}}}}
```

## The AdrUnCodeDescription object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"AdrUnCodeDescription":{"description":"Name and description, column n°4 from ADR Table A. Translated in FR, EN, NL, DE","properties":{"fr":{"description":"French label","type":"string"},"en":{"description":"English label","type":"string"},"nl":{"description":"Dutch label","type":"string"},"de":{"description":"German label","type":"string"}},"type":"object"}}}}
```

## The CompanyForTransportAddress object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"CompanyForTransportAddress":{"properties":{"pk":{"description":"Dashdoc's internal id.","type":"number"},"remote_id":{"description":"The id of the company in your system.","type":"string"},"name":{"type":"string"},"trade_number":{"type":"string"},"country":{"$ref":"#/components/schemas/country"},"settings_contract_html":{"description":"Ignore. Dashdoc technical data.","type":"string"},"settings_logo":{"description":"Ignore. Dashdoc technical data.","nullable":true,"type":"string"},"settings_stamp":{"description":"Ignore. Dashdoc technical data.","nullable":true,"type":"string"},"settings_print_mode":{"description":"Ignore. Dashdoc technical data.","type":"boolean"},"settings_special_agreements":{"description":"Ignore. Dashdoc technical data.","type":"string"},"settings_transport_order_observations":{"type":"string"},"settings_constrain_reference_edition":{"type":"boolean"},"vat_number":{"type":"string"},"is_verified":{"type":"boolean"}},"type":"object"},"country":{"description":"Only the 2-character codification is accepted (ISO 3166-1 alpha-2)","type":"string"}}}}
```

## The InvoiceTransport object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"InvoiceTransport":{"properties":{"uid":{"description":"uuid of the Transport","format":"uuid","type":"string"},"sequential_id":{"type":"number"},"deliveries":{"items":{"$ref":"#/components/schemas/InvoiceDelivery"},"type":"array"},"documents":{"description":"See https://developer.dashdoc.eu/docs/tutorials/retrieve-transport-tracking-data#get-documents-and-photos-with-their-type","items":{"$ref":"#/components/schemas/InvoiceDocument"},"type":"array"},"messages":{"description":"See https://developer.dashdoc.eu/docs/tutorials/retrieve-transport-tracking-data#get-documents-and-photos-with-their-type","items":{"$ref":"#/components/schemas/InvoiceMessage"},"type":"array"}},"type":"object"},"InvoiceDelivery":{"properties":{"uid":{"description":"uuid of the Delivery","format":"uuid","type":"string"},"origin":{"$ref":"#/components/schemas/InvoiceSite"},"destination":{"$ref":"#/components/schemas/InvoiceSite"}},"type":"object"},"InvoiceSite":{"properties":{"uid":{"type":"string"},"company_name":{"type":"string"},"city":{"type":"string"}},"type":"object"},"InvoiceDocument":{"properties":{"delivery":{"description":"uuid of the Delivery","format":"uuid","type":"string"},"file":{"description":"path of the document","format":"url","type":"string"},"reference":{"type":"string"},"category":{"description":"Type of document. Possible values are \"cmr\", \"cmr4\", \"ldv\", \"orc\", \"chc\", \"rental\" and \"loading_plan\"","type":"string"}},"type":"object"},"InvoiceMessage":{"properties":{"document":{"description":"path of the document","format":"url","type":"string"},"reference":{"type":"string"},"document_type":{"enum":["load_photo","cmr","washing_note","delivery_note","confirmation","weight_note","waste_manifest","holders_swap_note","invoice"],"maxLength":100,"type":"string"}},"type":"object"}}}}
```

## The AddressGetOrCreate object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"AddressGetOrCreate":{"description":"Identification of the address. You may simply use its `pk` or `remote_id` if the address already exists, or you can send address details as in /addresses/ web service. The address may be recognized with its details or if it doesn't exist, the address will be created with the information you send based on what's possible when creating an address via /addresses/ web service.","properties":{"pk":{"description":"Dashdoc's internal id.","type":"number"},"remote_id":{"description":"The id of the address in your system.","type":"string"}},"type":"object"}}}}
```

## The loading\_instructions object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"loading_instructions":{"deprecated":true,"description":"**Prefer using the field `instructions`.** Loading instructions, visible to all parties (trucker, carrier, shipper, site). Displayed in the trucker mobile app. Not visible in the eCMR.","maxLength":1000,"type":"string"}}}}
```

## The unloading\_instructions object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"unloading_instructions":{"deprecated":true,"description":"**Prefer using the field `instructions`.** Unloading instructions, visible to all parties (trucker, carrier, shipper, site). Displayed in the trucker mobile app. Not visible in the eCMR.","maxLength":1000,"type":"string"}}}}
```

## The CreateOrUpdateSupportsExchangeForTransport object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"CreateOrUpdateSupportsExchangeForTransport":{"properties":{"support_type":{"$ref":"#/components/schemas/CreateOrUpdateSupportsExchangeForTransport_support_type"},"expected_retrieved":{"description":"Expected number of supports that should be retrieved on the site","type":"number"},"actual_retrieved":{"description":"Actual number of supports that were retrieved on the site","type":"number"},"expected_delivered":{"description":"Expected number of supports that should be delivered on the site","type":"number"},"actual_delivered":{"description":"Actual number of supports that were delivered on the site","type":"number"},"observations":{"description":"Free text. Observations about this supports exchange. Can be filled on mobile app, web app or via API.","type":"string"}},"required":["support_type"],"type":"object"},"CreateOrUpdateSupportsExchangeForTransport_support_type":{"description":"Type of the supports that are exchanged","properties":{"uid":{"format":"uuid","type":"string"},"remote_id":{"description":"The id of the support type in your system.","type":"string"}},"type":"object"}}}}
```

## The SegmentTruckerUser object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"SegmentTruckerUser":{"properties":{"pk":{"description":"Dashdoc's internal id.","type":"number"},"first_name":{"type":"string"},"last_name":{"type":"string"},"username":{"description":"Ignore. Dashdoc technical data.","type":"string"},"email":{"format":"email","type":"string"},"display_name":{"description":"Display name generated by Dashdoc.","type":"string"},"date_joined":{"description":"Ignore. Dashdoc technical data.","format":"date-time","type":"string"},"is_staff":{"description":"Ignore. Dashdoc technical data.","type":"boolean"},"is_superuser":{"description":"Ignore. Dashdoc technical data.","type":"boolean"},"has_usable_password":{"description":"Ignore. Dashdoc technical data.","type":"boolean"}},"type":"object"}}}}
```

## The CompanyForTransportAddress\_1 object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"CompanyForTransportAddress_1":{"description":"Identification of the company. You may simply use its `pk` or `remote_id` if the company already exists. Other possible identification method are its `trade_number` or `name`. If it doesn't exist, the company will be created with the information you send based on what's possible when creating a company via /companies/ web service. Minimum required information in this case is a name.","properties":{"pk":{"description":"Dashdoc's internal id.Optional, not required if `remote_id` is sent.","type":"integer"},"remote_id":{"description":"The id of the company in your system. Optional, ignored if `pk` is sent.","type":"string"},"trade_number":{"maxLength":100,"type":"string"},"name":{"maxLength":200,"type":"string"}},"type":"object"}}}}
```

## The Site\_1 object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"Site_1":{"properties":{"uid":{"description":"Dashdoc's internal id.","format":"uuid","type":"string"},"remote_id":{"description":"The id of the site in your system","type":"string"},"address":{"$ref":"#/components/schemas/AddressForDelivery"},"loading_instructions":{"$ref":"#/components/schemas/loading_instructions"},"unloading_instructions":{"$ref":"#/components/schemas/unloading_instructions"},"real_start":{"description":"date and time when trucker arrived on site","format":"date-time","type":"string"},"real_end":{"description":"date and time when trucker completed loading / unloading (depending whether site is origin or destination)","format":"date-time","type":"string"},"signature_process":{"description":"signature process that was chosen to sign loads on site","type":"string"},"instructions":{"$ref":"#/components/schemas/site_instructions"},"reference":{"type":"string"},"action":{"deprecated":true,"description":"Deprecated. Always returned as an empty string.","type":"string"},"eta":{"nullable":true,"type":"string"},"eta_tracking":{"$ref":"#/components/schemas/eta_tracking"},"punctuality_status":{"$ref":"#/components/schemas/punctuality_status"},"supports_exchanges":{"$ref":"#/components/schemas/SupportsExchange"},"category":{"type":"string"},"arrival_date":{"description":"expected arrival date","format":"date","type":"string"},"arrival_time_min":{"description":"expected arrival min time","type":"string"},"arrival_time_max":{"description":"expected arrival max time","type":"string"},"date_exact":{"description":"if `true`, `arrival_time_max` is considered as being on the following day from `arrival_date`","type":"boolean"},"trucker_instructions":{"$ref":"#/components/schemas/trucker_instructions"}},"type":"object"},"AddressForDelivery":{"properties":{"pk":{"description":"Dashdoc's internal id.","type":"number"},"name":{"type":"string"},"address":{"type":"string"},"city":{"type":"string"},"postcode":{"type":"string"},"country":{"$ref":"#/components/schemas/country"},"latitude":{"$ref":"#/components/schemas/latitude"},"longitude":{"$ref":"#/components/schemas/longitude"},"radius":{"default":500,"description":"Radius around the GPS coordinates within which the address is located (in meters)","type":"integer"},"coords_validated":{"default":false,"description":"if `true`, when this address is used as a loading or unloading site, the mobile app displays an itinerary button to start GPS app with guidance to these coordinates","type":"boolean"},"is_demo":{"$ref":"#/components/schemas/is_demo"},"is_carrier":{"type":"boolean"},"is_shipper":{"type":"boolean"},"is_origin":{"$ref":"#/components/schemas/address_is_origin_and_is_destination"},"is_destination":{"$ref":"#/components/schemas/address_is_origin_and_is_destination"},"created_by":{"description":"Ignore. Dashdoc technical data.","type":"number"},"created":{"$ref":"#/components/schemas/created"},"instructions":{"$ref":"#/components/schemas/site_instructions"},"remote_id":{"description":"The id of the address in your system.","type":"string"},"company":{"$ref":"#/components/schemas/Company"},"original":{"description":"Ignore. Dashdoc technical data.","type":"number"}},"type":"object"},"country":{"description":"Only the 2-character codification is accepted (ISO 3166-1 alpha-2)","type":"string"},"latitude":{"description":"Latitude using the decimal GPS coordinates (WGS84). At 7 decimals, the position is accurate around the centimeter.","format":"float","nullable":true,"type":"number"},"longitude":{"description":"Longitude using the decimal GPS coordinates (WGS84). At 7 decimals, the position is accurate around the centimeter.","format":"float","nullable":true,"type":"number"},"is_demo":{"description":"Indicates that the address is a fake one created from demonstration. Everything linked to it will be deleted when using the 'Delete demo content' button in company parameters","type":"boolean"},"address_is_origin_and_is_destination":{"description":"Whether this address is a \"Logistic Points\" and will be usable as pickup/delivery point.\nThe distinction between origin/pickup and destination/delivery was merged as a single \"Logistic Point\" concept. `is_origin` implies `is_destination` and vice-versa.\n","type":"boolean"},"created":{"description":"Date of creation on our server","format":"date-time","type":"string"},"site_instructions":{"description":"Site instructions, visible to all parties (trucker, carrier, shipper, site). Displayed in the trucker mobile app. Not visible in the eCMR. If the field is not provided, the address's site instructions will be used.","maxLength":1000,"type":"string"},"Company":{"properties":{"pk":{"description":"Dashdoc's internal id.","type":"number"},"remote_id":{"type":"string"},"created":{"format":"date-time","type":"object"},"updated":{"format":"date-time","type":"string"},"deleted":{"type":"boolean"},"invoicing_remote_id":{"description":"The id of the company in your invoicing system.","type":"string"},"name":{"type":"string"},"phone_number":{"type":"string"},"email":{"type":"string"},"siren":{"type":"string"},"trade_number":{"type":"string"},"country":{"$ref":"#/components/schemas/country"},"comments":{"type":"string"},"vat_number":{"type":"string"},"is_verified":{"type":"boolean"},"settings_transport_order_observations":{"type":"string"},"settings_constrain_reference_edition":{"type":"boolean"},"account_type":{"description":"Ignore. Dashdoc technical data.","type":"string"},"logo":{"description":"The URL of your logo","nullable":true,"type":"string"},"subscription_access":{"type":"object"},"settings":{"type":"object"},"primary_address":{"$ref":"#/components/schemas/PrimaryAddress_1"},"managers":{"items":{"$ref":"#/components/schemas/Managers"},"type":"array"},"has_loggable_managers":{"description":"Ignore. Dashdoc technical data.","type":"boolean"}},"type":"object"},"PrimaryAddress_1":{"properties":{"pk":{"description":"Dashdoc's internal id.","type":"number"},"name":{"type":"string"},"address":{"type":"string"},"city":{"type":"string"},"postcode":{"type":"string"},"country":{"$ref":"#/components/schemas/country"},"latitude":{"$ref":"#/components/schemas/latitude"},"longitude":{"$ref":"#/components/schemas/longitude"},"radius":{"default":500,"description":"Radius around the GPS coordinates within which the address is located (in meters)","type":"integer"},"coords_validated":{"default":false,"description":"if `true`, when this address is used as a loading or unloading site, the mobile app displays an itinerary button to start GPS app with guidance to these coordinates","type":"boolean"},"is_demo":{"$ref":"#/components/schemas/is_demo"},"is_carrier":{"description":"Whether this company is considered a carrier","type":"boolean"},"is_shipper":{"description":"Whether this company is considered a shipper","type":"boolean"},"is_origin":{"description":"Legacy, not relevant for a company's primary address. Consider creating a separate address associated with this partner instead.\n","type":"boolean"},"is_destination":{"description":"Legacy, not relevant for a company's primary address. Consider creating a separate address associated with this partner instead.\n","type":"boolean"},"created_by":{"$ref":"#/components/schemas/created-by"},"created_by_user":{"$ref":"#/components/schemas/created-by-user"},"created":{"$ref":"#/components/schemas/created"},"remote_id":{"description":"The id of the address in your system.","type":"string"}},"type":"object"},"created-by":{"nullable":true,"properties":{"pk":{"description":"company id","type":"number"},"name":{"description":"name of the company","type":"string"}},"type":"object"},"created-by-user":{"nullable":true,"properties":{"pk":{"type":"number"},"display_name":{"type":"string"},"company":{"description":"The company id who created the address","type":"number"},"trucker_id":{"description":"The trucker id who created the address","type":"number"}},"type":"object"},"Managers":{"properties":{"pk":{"description":"Dashdoc's internal id.","type":"number"},"user":{"$ref":"#/components/schemas/Managers_user"},"display_name":{"type":"string"},"role":{"type":"string"}},"type":"object"},"Managers_user":{"properties":{"email":{"format":"email","type":"string"},"first_name":{"type":"string"},"last_name":{"type":"string"}},"type":"object"},"loading_instructions":{"deprecated":true,"description":"**Prefer using the field `instructions`.** Loading instructions, visible to all parties (trucker, carrier, shipper, site). Displayed in the trucker mobile app. Not visible in the eCMR.","maxLength":1000,"type":"string"},"unloading_instructions":{"deprecated":true,"description":"**Prefer using the field `instructions`.** Unloading instructions, visible to all parties (trucker, carrier, shipper, site). Displayed in the trucker mobile app. Not visible in the eCMR.","maxLength":1000,"type":"string"},"eta_tracking":{"default":false,"description":"Ask for an ETA on this site. This is currently a beta feature, not activated by default.","type":"boolean"},"punctuality_status":{"default":"untracked","description":"Indicate the punctuality on this site.","enum":["untracked","probably_late","probably_on_time","late","on_time"],"type":"string"},"SupportsExchange":{"properties":{"uid":{"description":"uid of the support exchange","format":"uuid","type":"string"},"site":{"$ref":"#/components/schemas/SupportsExchange_site"},"support_type":{"$ref":"#/components/schemas/SupportType"},"expected_retrieved":{"description":"Expected number of supports that should be retrieved on the site","type":"number"},"actual_retrieved":{"description":"Actual number of supports that were retrieved on the site","type":"number"},"expected_delivered":{"description":"Expected number of supports that should be delivered on the site","type":"number"},"actual_delivered":{"description":"Actual number of supports that were delivered on the site","type":"number"},"observations":{"description":"Free text. Observations about this supports exchange. Can be filled on mobile app, web app or via API.","type":"string"},"remote_id":{"description":"The ID of the support in your system","type":"string"}},"type":"object"},"SupportsExchange_site":{"description":"site where supports exchange is expected","properties":{"uid":{"description":"uid of the site","format":"uuid","type":"string"},"remote_id":{"description":"remote_id of the site","type":"string"}},"type":"object"},"SupportType":{"description":"Type of the supports that are exchanged","properties":{"name":{"description":"Display name of the support type","type":"string"},"created":{"$ref":"#/components/schemas/created"},"uid":{"format":"uuid","type":"string"},"remote_id":{"description":"The id of the support type in your system.","type":"string"}},"type":"object"},"trucker_instructions":{"description":"**This field is part of a beta feature.** Private instructions. **The carrier of the transport is the only one who can edit and read those instructions.** Note that those instructions are not visible in the consignment note and can be accessed by the trucker. The value is null if the caller doesn't have the right of access to the data.","maxLength":1000,"type":"string"}}}}
```

## The AddressForDelivery object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"AddressForDelivery":{"properties":{"pk":{"description":"Dashdoc's internal id.","type":"number"},"name":{"type":"string"},"address":{"type":"string"},"city":{"type":"string"},"postcode":{"type":"string"},"country":{"$ref":"#/components/schemas/country"},"latitude":{"$ref":"#/components/schemas/latitude"},"longitude":{"$ref":"#/components/schemas/longitude"},"radius":{"default":500,"description":"Radius around the GPS coordinates within which the address is located (in meters)","type":"integer"},"coords_validated":{"default":false,"description":"if `true`, when this address is used as a loading or unloading site, the mobile app displays an itinerary button to start GPS app with guidance to these coordinates","type":"boolean"},"is_demo":{"$ref":"#/components/schemas/is_demo"},"is_carrier":{"type":"boolean"},"is_shipper":{"type":"boolean"},"is_origin":{"$ref":"#/components/schemas/address_is_origin_and_is_destination"},"is_destination":{"$ref":"#/components/schemas/address_is_origin_and_is_destination"},"created_by":{"description":"Ignore. Dashdoc technical data.","type":"number"},"created":{"$ref":"#/components/schemas/created"},"instructions":{"$ref":"#/components/schemas/site_instructions"},"remote_id":{"description":"The id of the address in your system.","type":"string"},"company":{"$ref":"#/components/schemas/Company"},"original":{"description":"Ignore. Dashdoc technical data.","type":"number"}},"type":"object"},"country":{"description":"Only the 2-character codification is accepted (ISO 3166-1 alpha-2)","type":"string"},"latitude":{"description":"Latitude using the decimal GPS coordinates (WGS84). At 7 decimals, the position is accurate around the centimeter.","format":"float","nullable":true,"type":"number"},"longitude":{"description":"Longitude using the decimal GPS coordinates (WGS84). At 7 decimals, the position is accurate around the centimeter.","format":"float","nullable":true,"type":"number"},"is_demo":{"description":"Indicates that the address is a fake one created from demonstration. Everything linked to it will be deleted when using the 'Delete demo content' button in company parameters","type":"boolean"},"address_is_origin_and_is_destination":{"description":"Whether this address is a \"Logistic Points\" and will be usable as pickup/delivery point.\nThe distinction between origin/pickup and destination/delivery was merged as a single \"Logistic Point\" concept. `is_origin` implies `is_destination` and vice-versa.\n","type":"boolean"},"created":{"description":"Date of creation on our server","format":"date-time","type":"string"},"site_instructions":{"description":"Site instructions, visible to all parties (trucker, carrier, shipper, site). Displayed in the trucker mobile app. Not visible in the eCMR. If the field is not provided, the address's site instructions will be used.","maxLength":1000,"type":"string"},"Company":{"properties":{"pk":{"description":"Dashdoc's internal id.","type":"number"},"remote_id":{"type":"string"},"created":{"format":"date-time","type":"object"},"updated":{"format":"date-time","type":"string"},"deleted":{"type":"boolean"},"invoicing_remote_id":{"description":"The id of the company in your invoicing system.","type":"string"},"name":{"type":"string"},"phone_number":{"type":"string"},"email":{"type":"string"},"siren":{"type":"string"},"trade_number":{"type":"string"},"country":{"$ref":"#/components/schemas/country"},"comments":{"type":"string"},"vat_number":{"type":"string"},"is_verified":{"type":"boolean"},"settings_transport_order_observations":{"type":"string"},"settings_constrain_reference_edition":{"type":"boolean"},"account_type":{"description":"Ignore. Dashdoc technical data.","type":"string"},"logo":{"description":"The URL of your logo","nullable":true,"type":"string"},"subscription_access":{"type":"object"},"settings":{"type":"object"},"primary_address":{"$ref":"#/components/schemas/PrimaryAddress_1"},"managers":{"items":{"$ref":"#/components/schemas/Managers"},"type":"array"},"has_loggable_managers":{"description":"Ignore. Dashdoc technical data.","type":"boolean"}},"type":"object"},"PrimaryAddress_1":{"properties":{"pk":{"description":"Dashdoc's internal id.","type":"number"},"name":{"type":"string"},"address":{"type":"string"},"city":{"type":"string"},"postcode":{"type":"string"},"country":{"$ref":"#/components/schemas/country"},"latitude":{"$ref":"#/components/schemas/latitude"},"longitude":{"$ref":"#/components/schemas/longitude"},"radius":{"default":500,"description":"Radius around the GPS coordinates within which the address is located (in meters)","type":"integer"},"coords_validated":{"default":false,"description":"if `true`, when this address is used as a loading or unloading site, the mobile app displays an itinerary button to start GPS app with guidance to these coordinates","type":"boolean"},"is_demo":{"$ref":"#/components/schemas/is_demo"},"is_carrier":{"description":"Whether this company is considered a carrier","type":"boolean"},"is_shipper":{"description":"Whether this company is considered a shipper","type":"boolean"},"is_origin":{"description":"Legacy, not relevant for a company's primary address. Consider creating a separate address associated with this partner instead.\n","type":"boolean"},"is_destination":{"description":"Legacy, not relevant for a company's primary address. Consider creating a separate address associated with this partner instead.\n","type":"boolean"},"created_by":{"$ref":"#/components/schemas/created-by"},"created_by_user":{"$ref":"#/components/schemas/created-by-user"},"created":{"$ref":"#/components/schemas/created"},"remote_id":{"description":"The id of the address in your system.","type":"string"}},"type":"object"},"created-by":{"nullable":true,"properties":{"pk":{"description":"company id","type":"number"},"name":{"description":"name of the company","type":"string"}},"type":"object"},"created-by-user":{"nullable":true,"properties":{"pk":{"type":"number"},"display_name":{"type":"string"},"company":{"description":"The company id who created the address","type":"number"},"trucker_id":{"description":"The trucker id who created the address","type":"number"}},"type":"object"},"Managers":{"properties":{"pk":{"description":"Dashdoc's internal id.","type":"number"},"user":{"$ref":"#/components/schemas/Managers_user"},"display_name":{"type":"string"},"role":{"type":"string"}},"type":"object"},"Managers_user":{"properties":{"email":{"format":"email","type":"string"},"first_name":{"type":"string"},"last_name":{"type":"string"}},"type":"object"}}}}
```

## The TrackingContact object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"TrackingContact":{"properties":{"uid":{"format":"uuid","type":"string"},"created":{"$ref":"#/components/schemas/created"},"company":{"$ref":"#/components/schemas/Company"},"first_name":{"type":"string"},"last_name":{"type":"string"},"email":{"format":"email","type":"string"},"phone_number":{"type":"string"},"fax_number":{"type":"string"},"remote_id":{"description":"The id of the contact in your system","type":"string"}},"type":"object"},"created":{"description":"Date of creation on our server","format":"date-time","type":"string"},"Company":{"properties":{"pk":{"description":"Dashdoc's internal id.","type":"number"},"remote_id":{"type":"string"},"created":{"format":"date-time","type":"object"},"updated":{"format":"date-time","type":"string"},"deleted":{"type":"boolean"},"invoicing_remote_id":{"description":"The id of the company in your invoicing system.","type":"string"},"name":{"type":"string"},"phone_number":{"type":"string"},"email":{"type":"string"},"siren":{"type":"string"},"trade_number":{"type":"string"},"country":{"$ref":"#/components/schemas/country"},"comments":{"type":"string"},"vat_number":{"type":"string"},"is_verified":{"type":"boolean"},"settings_transport_order_observations":{"type":"string"},"settings_constrain_reference_edition":{"type":"boolean"},"account_type":{"description":"Ignore. Dashdoc technical data.","type":"string"},"logo":{"description":"The URL of your logo","nullable":true,"type":"string"},"subscription_access":{"type":"object"},"settings":{"type":"object"},"primary_address":{"$ref":"#/components/schemas/PrimaryAddress_1"},"managers":{"items":{"$ref":"#/components/schemas/Managers"},"type":"array"},"has_loggable_managers":{"description":"Ignore. Dashdoc technical data.","type":"boolean"}},"type":"object"},"country":{"description":"Only the 2-character codification is accepted (ISO 3166-1 alpha-2)","type":"string"},"PrimaryAddress_1":{"properties":{"pk":{"description":"Dashdoc's internal id.","type":"number"},"name":{"type":"string"},"address":{"type":"string"},"city":{"type":"string"},"postcode":{"type":"string"},"country":{"$ref":"#/components/schemas/country"},"latitude":{"$ref":"#/components/schemas/latitude"},"longitude":{"$ref":"#/components/schemas/longitude"},"radius":{"default":500,"description":"Radius around the GPS coordinates within which the address is located (in meters)","type":"integer"},"coords_validated":{"default":false,"description":"if `true`, when this address is used as a loading or unloading site, the mobile app displays an itinerary button to start GPS app with guidance to these coordinates","type":"boolean"},"is_demo":{"$ref":"#/components/schemas/is_demo"},"is_carrier":{"description":"Whether this company is considered a carrier","type":"boolean"},"is_shipper":{"description":"Whether this company is considered a shipper","type":"boolean"},"is_origin":{"description":"Legacy, not relevant for a company's primary address. Consider creating a separate address associated with this partner instead.\n","type":"boolean"},"is_destination":{"description":"Legacy, not relevant for a company's primary address. Consider creating a separate address associated with this partner instead.\n","type":"boolean"},"created_by":{"$ref":"#/components/schemas/created-by"},"created_by_user":{"$ref":"#/components/schemas/created-by-user"},"created":{"$ref":"#/components/schemas/created"},"remote_id":{"description":"The id of the address in your system.","type":"string"}},"type":"object"},"latitude":{"description":"Latitude using the decimal GPS coordinates (WGS84). At 7 decimals, the position is accurate around the centimeter.","format":"float","nullable":true,"type":"number"},"longitude":{"description":"Longitude using the decimal GPS coordinates (WGS84). At 7 decimals, the position is accurate around the centimeter.","format":"float","nullable":true,"type":"number"},"is_demo":{"description":"Indicates that the address is a fake one created from demonstration. Everything linked to it will be deleted when using the 'Delete demo content' button in company parameters","type":"boolean"},"created-by":{"nullable":true,"properties":{"pk":{"description":"company id","type":"number"},"name":{"description":"name of the company","type":"string"}},"type":"object"},"created-by-user":{"nullable":true,"properties":{"pk":{"type":"number"},"display_name":{"type":"string"},"company":{"description":"The company id who created the address","type":"number"},"trucker_id":{"description":"The trucker id who created the address","type":"number"}},"type":"object"},"Managers":{"properties":{"pk":{"description":"Dashdoc's internal id.","type":"number"},"user":{"$ref":"#/components/schemas/Managers_user"},"display_name":{"type":"string"},"role":{"type":"string"}},"type":"object"},"Managers_user":{"properties":{"email":{"format":"email","type":"string"},"first_name":{"type":"string"},"last_name":{"type":"string"}},"type":"object"}}}}
```

## The InvoiceDelivery object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"InvoiceDelivery":{"properties":{"uid":{"description":"uuid of the Delivery","format":"uuid","type":"string"},"origin":{"$ref":"#/components/schemas/InvoiceSite"},"destination":{"$ref":"#/components/schemas/InvoiceSite"}},"type":"object"},"InvoiceSite":{"properties":{"uid":{"type":"string"},"company_name":{"type":"string"},"city":{"type":"string"}},"type":"object"}}}}
```

## The InvoiceDocument object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"InvoiceDocument":{"properties":{"delivery":{"description":"uuid of the Delivery","format":"uuid","type":"string"},"file":{"description":"path of the document","format":"url","type":"string"},"reference":{"type":"string"},"category":{"description":"Type of document. Possible values are \"cmr\", \"cmr4\", \"ldv\", \"orc\", \"chc\", \"rental\" and \"loading_plan\"","type":"string"}},"type":"object"}}}}
```

## The InvoiceMessage object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"InvoiceMessage":{"properties":{"document":{"description":"path of the document","format":"url","type":"string"},"reference":{"type":"string"},"document_type":{"enum":["load_photo","cmr","washing_note","delivery_note","confirmation","weight_note","waste_manifest","holders_swap_note","invoice"],"maxLength":100,"type":"string"}},"type":"object"}}}}
```

## The InvoiceSite object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"InvoiceSite":{"properties":{"uid":{"type":"string"},"company_name":{"type":"string"},"city":{"type":"string"}},"type":"object"}}}}
```

## The inline\_response\_200 object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"inline_response_200":{"properties":{"status":{"$ref":"#/components/schemas/Statuses"}},"type":"object"},"Statuses":{"enum":["created","updated","confirmed","declined","verified","invoiced","paid","cancelled","assigned","sent_to_trucker","acknowledged","truck_wash","on_loading_site","loading_complete","on_unloading_site","unloading_complete","bulking_break_started","bulking_break_complete","rounds_started","round_added","round_added_v2","round_edited","round_deleted","rounds_complete","event","checklist_filled","activity_complete","on_the_way","handling_started","done"],"type":"string"}}}}
```

## The inline\_response\_404 object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"inline_response_404":{"properties":{"detail":{"type":"string"}},"type":"object"}}}}
```

## The inline\_object object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"inline_object":{"properties":{"observations":{"description":"Observations by the dock during the loading operation","type":"string"}},"type":"object"}}}}
```

## The inline\_object\_1 object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"inline_object_1":{"properties":{"observations":{"description":"Observations by the dock during the unloading operation","type":"string"}},"type":"object"}}}}
```

## The inline\_object\_2 object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"inline_object_2":{"properties":{"customer_to_invoice_id":{"description":"Identifier of the invoiceable customer to invoice.","type":"integer"},"currency":{"description":"Currency of the created invoice. Defaults to EUR.","enum":["EUR","USD","GBP","PLN","HUF","RON","CZK","CAD"],"type":"string"}},"required":["customer_to_invoice_id"],"type":"object"}}}}
```

## The inline\_response\_201 object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"inline_response_201":{"properties":{"uid":{"format":"uuid","type":"string"}},"type":"object"}}}}
```

## The inline\_object\_3 object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"inline_object_3":{"properties":{"description":{"description":"Description of the invoice line.","type":"string"},"quantity":{"description":"Quantity (up to 3 decimal places).","format":"decimal","type":"string"},"unit_price":{"description":"Unit price (up to 4 decimal places).","format":"decimal","type":"string"},"invoice_item_uid":{"description":"UID of the invoice item to associate with this line. Required when the invoicing method mandates invoice items.","format":"uuid","nullable":true,"type":"string"}},"required":["quantity","unit_price"],"type":"object"}}}}
```

## The inline\_object\_4 object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"inline_object_4":{"properties":{"company":{"type":"number"}},"required":["company"],"type":"object"}}}}
```

## The inline\_response\_200\_1 object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"inline_response_200_1":{"properties":{"success":{"type":"boolean"}},"type":"object"}}}}
```

## The inline\_response\_404\_1 object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"inline_response_404_1":{"properties":{"success":{"type":"boolean"}},"type":"object"}}}}
```

## The inline\_response\_404\_2 object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"inline_response_404_2":{"properties":{"detail":{"type":"string"}},"type":"object"}}}}
```

## The inline\_response\_201\_1 object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"inline_response_201_1":{"properties":{"child_transport":{"description":"uid of the chartered transport that has been created","type":"string"}},"type":"object"}}}}
```

## The inline\_response\_400\_non\_field\_errors object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"inline_response_400_non_field_errors":{"properties":{"code":{"items":{"type":"string"},"type":"array"},"detail":{"items":{"type":"string"},"type":"array"}},"type":"object"}}}}
```

## The inline\_response\_400 object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"inline_response_400":{"properties":{"non_field_errors":{"$ref":"#/components/schemas/inline_response_400_non_field_errors"}},"type":"object"},"inline_response_400_non_field_errors":{"properties":{"code":{"items":{"type":"string"},"type":"array"},"detail":{"items":{"type":"string"},"type":"array"}},"type":"object"}}}}
```

## The inline\_response\_400\_1\_non\_field\_errors object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"inline_response_400_1_non_field_errors":{"properties":{"code":{"items":{"type":"string"},"type":"array"},"detail":{"items":{"type":"string"},"type":"array"}},"type":"object"}}}}
```

## The inline\_response\_400\_1 object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"inline_response_400_1":{"properties":{"non_field_errors":{"$ref":"#/components/schemas/inline_response_400_1_non_field_errors"}},"type":"object"},"inline_response_400_1_non_field_errors":{"properties":{"code":{"items":{"type":"string"},"type":"array"},"detail":{"items":{"type":"string"},"type":"array"}},"type":"object"}}}}
```

## The inline\_response\_400\_2\_non\_field\_errors object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"inline_response_400_2_non_field_errors":{"properties":{"code":{"items":{"type":"string"},"type":"array"},"detail":{"items":{"type":"string"},"type":"array"}},"type":"object"}}}}
```

## The inline\_response\_400\_2 object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"inline_response_400_2":{"properties":{"non_field_errors":{"$ref":"#/components/schemas/inline_response_400_2_non_field_errors"}},"type":"object"},"inline_response_400_2_non_field_errors":{"properties":{"code":{"items":{"type":"string"},"type":"array"},"detail":{"items":{"type":"string"},"type":"array"}},"type":"object"}}}}
```

## The inline\_response\_404\_3 object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"inline_response_404_3":{"properties":{"error":{"type":"string"}},"type":"object"}}}}
```

## The inline\_response\_400\_3\_non\_field\_errors object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"inline_response_400_3_non_field_errors":{"properties":{"code":{"items":{"type":"string"},"type":"array"},"detail":{"items":{"type":"string"},"type":"array"}},"type":"object"}}}}
```

## The inline\_response\_400\_3 object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"inline_response_400_3":{"properties":{"non_field_errors":{"$ref":"#/components/schemas/inline_response_400_3_non_field_errors"}},"type":"object"},"inline_response_400_3_non_field_errors":{"properties":{"code":{"items":{"type":"string"},"type":"array"},"detail":{"items":{"type":"string"},"type":"array"}},"type":"object"}}}}
```

## The inline\_response\_400\_4\_non\_field\_errors object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"inline_response_400_4_non_field_errors":{"properties":{"code":{"items":{"type":"string"},"type":"array"},"detail":{"items":{"type":"string"},"type":"array"}},"type":"object"}}}}
```

## The inline\_response\_400\_4 object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"inline_response_400_4":{"properties":{"non_field_errors":{"$ref":"#/components/schemas/inline_response_400_4_non_field_errors"}},"type":"object"},"inline_response_400_4_non_field_errors":{"properties":{"code":{"items":{"type":"string"},"type":"array"},"detail":{"items":{"type":"string"},"type":"array"}},"type":"object"}}}}
```

## The inline\_response\_404\_4\_non\_field\_errors object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"inline_response_404_4_non_field_errors":{"properties":{"code":{"items":{"type":"string"},"type":"array"},"detail":{"items":{"type":"string"},"type":"array"}},"type":"object"}}}}
```

## The inline\_response\_404\_4 object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"inline_response_404_4":{"properties":{"non_field_errors":{"$ref":"#/components/schemas/inline_response_404_4_non_field_errors"}},"type":"object"},"inline_response_404_4_non_field_errors":{"properties":{"code":{"items":{"type":"string"},"type":"array"},"detail":{"items":{"type":"string"},"type":"array"}},"type":"object"}}}}
```

## The inline\_object\_5 object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"inline_object_5":{"properties":{"reason":{"description":"The reason for cancelling the slot","type":"string"}},"required":["reason"],"type":"object"}}}}
```

## The inline\_response\_400\_5\_non\_field\_errors object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"inline_response_400_5_non_field_errors":{"properties":{"code":{"items":{"type":"string"},"type":"array"},"detail":{"items":{"type":"string"},"type":"array"}},"type":"object"}}}}
```

## The inline\_response\_400\_5 object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"inline_response_400_5":{"properties":{"non_field_errors":{"$ref":"#/components/schemas/inline_response_400_5_non_field_errors"}},"type":"object"},"inline_response_400_5_non_field_errors":{"properties":{"code":{"items":{"type":"string"},"type":"array"},"detail":{"items":{"type":"string"},"type":"array"}},"type":"object"}}}}
```

## The inline\_object\_6 object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"inline_object_6":{"properties":{"file":{"description":"The document file (PDF, JPEG or PNG, max 10 MB)","format":"binary","type":"string"},"name":{"description":"Optional display name. Defaults to the uploaded file name.","type":"string"}},"required":["file"],"type":"object"}}}}
```

## The inline\_object\_7 object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"inline_object_7":{"properties":{"name":{"description":"The new display name (1 to 255 characters, trimmed).","maxLength":255,"type":"string"}},"required":["name"],"type":"object"}}}}
```

## The inline\_object\_8 object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"inline_object_8":{"properties":{"invoice_number":{"description":"Invoice number for the transport","maxLength":100,"nullable":true,"type":"string"},"invoiced_price":{"$ref":"#/components/schemas/deprecated_invoiced_price"},"customer_to_invoice":{"$ref":"#/components/schemas/CompanyPkOrRemoteId"}},"type":"object"},"deprecated_invoiced_price":{"deprecated":true,"description":"Invoiced price for the transport. Deprecated in favour of pricing field","format":"float","nullable":true,"type":"number"},"CompanyPkOrRemoteId":{"description":"Identification of the company. The company must already exist in Dashdoc.","properties":{"pk":{"description":"Dashdoc's internal id. Optional, should not be sent if `remote_id` is sent.","type":"number"},"remote_id":{"description":"The ID of the company in your system. Optional, should not be sent if `pk` is sent.","type":"string"}},"type":"object"}}}}
```

## The inline\_response\_400\_6 object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"inline_response_400_6":{"properties":{"error":{"description":"A human-readable error message.","type":"string"},"error_code":{"description":"A machine-readable error code.","type":"string"}},"type":"object"}}}}
```

## The inline\_object\_9 object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"inline_object_9":{"properties":{"send_to_carrier":{"description":"Whether to send the document to the carrier. If not provided, document will be sent to carrier only if the organizer is the carrier.","nullable":true,"type":"boolean"}},"type":"object"}}}}
```

## The TransportOperationCategories\_results object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"TransportOperationCategories_results":{"properties":{"uid":{"format":"uuid","type":"string"},"name":{"type":"string"}},"type":"object"}}}}
```

## The Delivery\_tracking\_contacts object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"Delivery_tracking_contacts":{"properties":{"uid":{"description":"Dashdoc's internal id.","type":"string"},"contact":{"$ref":"#/components/schemas/NewContact"},"subscribed_to_status_updates":{"description":"If set to true, the contact will receive an email at every step of the delivery. Else, they will receive only one email once the delivery is done.","type":"boolean"},"role":{"description":"The role of the contact in the delivery. It can be `carrier`, `shipper`, or `site`.","type":"string"}},"required":["contact"],"type":"object"},"NewContact":{"properties":{"uid":{"format":"uuid","type":"string"},"created":{"description":"Date of creation on our server","format":"date-time","readOnly":true,"type":"string"},"company":{"$ref":"#/components/schemas/CompanyIdentification"},"first_name":{"maxLength":200,"type":"string"},"last_name":{"maxLength":200,"type":"string"},"email":{"format":"email","type":"string"},"phone_number":{"maxLength":100,"type":"string"},"fax_number":{"maxLength":100,"type":"string"},"remote_id":{"description":"The id of the contact in your system","type":"string"}},"required":["company","last_name"],"type":"object"},"CompanyIdentification":{"description":"Identification of the company. The company must already exist in Dashdoc.","properties":{"pk":{"description":"Dashdoc's internal id. Optional, not required if `remote_id` is sent.","type":"integer"},"remote_id":{"description":"Your remote carrier id. Optional, ignored if `pk` is sent.","type":"string"},"name":{"type":"string"},"trade_number":{"type":"string"},"country":{"$ref":"#/components/schemas/country"},"settings_contract_html":{"description":"Ignore. Dashdoc technical data.","type":"string"},"settings_logo":{"description":"Ignore. Dashdoc technical data.","nullable":true,"type":"string"},"settings_stamp":{"description":"Ignore. Dashdoc technical data.","nullable":true,"type":"string"},"settings_print_mode":{"description":"Ignore. Dashdoc technical data.","type":"boolean"},"settings_special_agreements":{"description":"Ignore. Dashdoc technical data.","type":"string"},"settings_transport_order_observations":{"type":"string"},"settings_constrain_reference_edition":{"type":"boolean"},"vat_number":{"type":"string"},"is_verified":{"description":"Ignore. Dashdoc technical data.","type":"string"}},"type":"object"},"country":{"description":"Only the 2-character codification is accepted (ISO 3166-1 alpha-2)","type":"string"}}}}
```

## The CreateOrUpdateDelivery\_tracking\_contacts object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"CreateOrUpdateDelivery_tracking_contacts":{"properties":{"contact":{"$ref":"#/components/schemas/NewContact"},"subscribed_to_status_updates":{"description":"If set to true, the contact will receive an email at every step of the delivery. Else, they will receive only one email once the delivery is done.","type":"boolean"}},"required":["contact"],"type":"object"},"NewContact":{"properties":{"uid":{"format":"uuid","type":"string"},"created":{"description":"Date of creation on our server","format":"date-time","readOnly":true,"type":"string"},"company":{"$ref":"#/components/schemas/CompanyIdentification"},"first_name":{"maxLength":200,"type":"string"},"last_name":{"maxLength":200,"type":"string"},"email":{"format":"email","type":"string"},"phone_number":{"maxLength":100,"type":"string"},"fax_number":{"maxLength":100,"type":"string"},"remote_id":{"description":"The id of the contact in your system","type":"string"}},"required":["company","last_name"],"type":"object"},"CompanyIdentification":{"description":"Identification of the company. The company must already exist in Dashdoc.","properties":{"pk":{"description":"Dashdoc's internal id. Optional, not required if `remote_id` is sent.","type":"integer"},"remote_id":{"description":"Your remote carrier id. Optional, ignored if `pk` is sent.","type":"string"},"name":{"type":"string"},"trade_number":{"type":"string"},"country":{"$ref":"#/components/schemas/country"},"settings_contract_html":{"description":"Ignore. Dashdoc technical data.","type":"string"},"settings_logo":{"description":"Ignore. Dashdoc technical data.","nullable":true,"type":"string"},"settings_stamp":{"description":"Ignore. Dashdoc technical data.","nullable":true,"type":"string"},"settings_print_mode":{"description":"Ignore. Dashdoc technical data.","type":"boolean"},"settings_special_agreements":{"description":"Ignore. Dashdoc technical data.","type":"string"},"settings_transport_order_observations":{"type":"string"},"settings_constrain_reference_edition":{"type":"boolean"},"vat_number":{"type":"string"},"is_verified":{"description":"Ignore. Dashdoc technical data.","type":"string"}},"type":"object"},"country":{"description":"Only the 2-character codification is accepted (ISO 3166-1 alpha-2)","type":"string"}}}}
```

## The Invoice\_period object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"Invoice_period":{"description":"The interval between the date of first loading and last unloading among all the transports of the invoice.","properties":{"first_loading_at":{"description":"Date of first loading among all the transports of the invoice.","format":"date-time","nullable":true,"type":"string"},"last_unloading_at":{"description":"Date of last unloading among all the transports of the invoice.","format":"date-time","nullable":true,"type":"string"}},"type":"object"}}}}
```

## The UpdateManager\_user object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"UpdateManager_user":{"properties":{"pk":{"description":"Dashdoc's internal id.","type":"number"},"first_name":{"type":"string"},"last_name":{"type":"string"},"email":{"description":"Another manager's email can only be changed if they have access to no company other than yours (403 `cannot_update_email` otherwise).","format":"email","type":"string"}},"required":["pk"],"type":"object"}}}}
```

## The LeaseTrucker\_tenant\_carrier object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"LeaseTrucker_tenant_carrier":{"description":"Carrier to whom you wish to lease the trucker. Identified either by its `pk` or `remote_id`.","properties":{"pk":{"description":"Dashdoc's internal id. Optional, not required if `remote_id` is sent.","type":"number"},"remote_id":{"description":"Your remote carrier id. Optional, ignored if pk is sent.","type":"string"}},"type":"object"}}}}
```

## The LeaseTruckerManagerNotFoundError\_non\_field\_errors object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"LeaseTruckerManagerNotFoundError_non_field_errors":{"properties":{"code":{"items":{"type":"string"},"type":"array"},"detail":{"items":{"type":"string"},"type":"array"}},"type":"object"}}}}
```

## The LeaseTruckerManagerNotLinkedError\_non\_field\_errors object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"LeaseTruckerManagerNotLinkedError_non_field_errors":{"properties":{"code":{"items":{"type":"string"},"type":"array"},"detail":{"items":{"type":"string"},"type":"array"}},"type":"object"}}}}
```

## The UpdateSegment\_trucker\_id object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"UpdateSegment_trucker_id":{"properties":{"pk":{"description":"Dashdoc's internal id. Optional, not required if `remote_id` is sent.","type":"number"},"remote_id":{"description":"The ID of the trucker in your system. Optional, ignored if pk is sent.","type":"string"}},"type":"object"}}}}
```

## The UpdateSegment\_scheduled\_start\_range object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"UpdateSegment_scheduled_start_range":{"description":"The scheduled date and time range of arrival at the origin (ISO 8601)","properties":{"start":{"description":"Min scheduled date and time of arrival at the origin (ISO 8601)","type":"string"},"end":{"description":"Max scheduled date and time of arrival at the origin (ISO 8601)","type":"string"}},"type":"object"}}}}
```

## The UpdateSegment\_scheduled\_end\_range object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"UpdateSegment_scheduled_end_range":{"description":"The scheduled date and time range of arrival at the destination (ISO 8601)","properties":{"start":{"description":"Min scheduled date and time of arrival at the destination (ISO 8601)","type":"string"},"end":{"description":"Max scheduled date and time of arrival at the destination (ISO 8601)","type":"string"}},"type":"object"}}}}
```

## The Segment\_scheduled\_start\_range object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"Segment_scheduled_start_range":{"description":"The datetime range at which the carrier scheduled the start of this segment","properties":{"start":{"description":"Min scheduled start date (ISO 8601)","type":"string"},"end":{"description":"Max scheduled start date (ISO 8601)","type":"string"}},"type":"object"}}}}
```

## The Segment\_scheduled\_end\_range object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"Segment_scheduled_end_range":{"description":"The datetime range at which the carrier scheduled the end of this segment","properties":{"start":{"description":"Min scheduled end date (ISO 8601)","type":"string"},"end":{"description":"Max scheduled end date (ISO 8601)","type":"string"}},"type":"object"}}}}
```

## The Segment\_child\_transport object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"Segment_child_transport":{"description":"If the segment is chartered, will contain the child transport","properties":{"uid":{"format":"uuid","type":"string"},"sequential_id":{"type":"number"},"remote_id":{"type":"string"},"has_strong_link":{"type":"boolean"}},"type":"object"}}}}
```

## The Transport\_parent\_transport object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"Transport_parent_transport":{"description":"if this is a chartered transport, this will contains the parent transport it is chartered from","properties":{"uid":{"format":"uuid","type":"string"},"sequential_id":{"type":"number"},"remote_id":{"type":"string"},"has_strong_link":{"type":"boolean"}},"type":"object"}}}}
```

## The Transport\_company object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"Transport_company":{"properties":{"name":{"type":"string"}},"type":"object"}}}}
```

## The Transport\_references object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"Transport_references":{"properties":{"role":{"type":"string"},"company":{"$ref":"#/components/schemas/Transport_company"},"reference":{"type":"string"}},"type":"object"},"Transport_company":{"properties":{"name":{"type":"string"}},"type":"object"}}}}
```

## The CharterTransport\_carrier object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"CharterTransport_carrier":{"description":"Carrier to whom you wish to charter the transport. Identified either by its `pk` or `remote_id`.","properties":{"pk":{"description":"Dashdoc's internal id. Optional, not required if `remote_id` is sent.","type":"number"},"remote_id":{"description":"Your remote carrier id. Optional, ignored if `pk` is sent.","type":"string"},"carrier_contacts":{"description":"A list containing the uids of each contact in the carrier's company to link to this transport.","items":{"type":"string"},"type":"array"}},"type":"object"}}}}
```

## The CharterSegmentsFiltersError\_non\_field\_errors object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"CharterSegmentsFiltersError_non_field_errors":{"properties":{"code":{"items":{"type":"string"},"type":"array"},"detail":{"items":{"type":"string"},"type":"array"}},"type":"object"}}}}
```

## The Site\_slots object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"Site_slots":{"properties":{"start":{"format":"date-time","type":"string"},"end":{"format":"date-time","type":"string"}},"type":"object"}}}}
```

## The Site\_trip object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"Site_trip":{"description":"Trip linked to this site/activity.","nullable":true,"properties":{"uid":{"format":"uuid","type":"string"},"name":{"type":"string"},"is_prepared":{"type":"boolean"},"status":{"enum":["unstarted","ongoing","done"],"type":"string"}},"readOnly":true,"type":"object"}}}}
```

## The EnableEtaCoordinatesError\_non\_field\_errors object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"EnableEtaCoordinatesError_non_field_errors":{"properties":{"code":{"items":{"type":"string"},"type":"array"},"detail":{"items":{"type":"string"},"type":"array"}},"type":"object"}}}}
```

## The FlowCompanyRequest\_address object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"FlowCompanyRequest_address":{"properties":{"address":{"description":"Address","type":"string"},"postcode":{"description":"Postal code","type":"string"},"city":{"description":"City name","type":"string"},"country":{"description":"Country code","type":"string"}},"required":["city","country","postcode"],"type":"object"}}}}
```

## The DraftSlot\_zone object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"DraftSlot_zone":{"description":"Zone information (null for draft slots as they are not assigned to a zone yet)","nullable":true,"properties":{"uid":{"description":"Zone unique identifier","type":"string"},"name":{"description":"Zone name","type":"string"}},"required":["name","uid"],"type":"object"}}}}
```

## The DraftSlot\_company object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"DraftSlot_company":{"description":"Company associated with the slot","properties":{"pk":{"description":"Company primary key","type":"integer"},"remote_id":{"description":"Company remote identifier (external ID)","type":"string"},"name":{"description":"Company name","type":"string"}},"required":["name","pk"],"type":"object"}}}}
```

## The SlotPlannedRequest\_zone object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"SlotPlannedRequest_zone":{"properties":{"uid":{"description":"Zone unique identifier","type":"string"}},"required":["uid"],"type":"object"}}}}
```

## The Slot\_zone object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"Slot_zone":{"properties":{"uid":{"description":"Zone unique identifier","type":"string"},"name":{"description":"Zone name","type":"string"}},"required":["name","uid"],"type":"object"}}}}
```

## The Slot\_company object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"Slot_company":{"properties":{"pk":{"description":"Company primary key","type":"integer"},"remote_id":{"description":"Company remote identifier","type":"string"},"name":{"description":"Company name","type":"string"}},"required":["name","pk"],"type":"object"}}}}
```

## The SlotDocument\_created\_by\_user object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"SlotDocument_created_by_user":{"description":"User who uploaded the document. Null if the user has been deleted.","nullable":true,"properties":{"email":{"type":"string"},"first_name":{"type":"string"},"last_name":{"type":"string"}},"type":"object"}}}}
```

## The NewSupportsExchange\_site object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"NewSupportsExchange_site":{"description":"uid of the site where supports exchange is expected","properties":{"uid":{"description":"uid of the site","format":"uuid","type":"string"},"remote_id":{"description":"remote_id of the site","type":"string"}},"type":"object"}}}}
```

## The NewSupportsExchange\_support\_type object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"NewSupportsExchange_support_type":{"description":"Type of the supports that are exchanged","properties":{"uid":{"format":"uuid","type":"string"},"remote_id":{"description":"your id of the support type","type":"string"}},"type":"object"}}}}
```

## The SupportsExchange\_site object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"SupportsExchange_site":{"description":"site where supports exchange is expected","properties":{"uid":{"description":"uid of the site","format":"uuid","type":"string"},"remote_id":{"description":"remote_id of the site","type":"string"}},"type":"object"}}}}
```

## The LinkTrackDechetsWasteNote\_transport object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"LinkTrackDechetsWasteNote_transport":{"description":"Transport, identified either by its `uid` or `remote_id`","properties":{"uid":{"description":"uuid of the transport. Optional, not required if `remote_id` is sent.","format":"uuid","type":"string"},"remote_id":{"description":"your remote transport id. Optional, ignored if `uid` is sent.","type":"string"}},"type":"object"}}}}
```

## The TrackDechetsWasteNote\_transport object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"TrackDechetsWasteNote_transport":{"description":"Transport","properties":{"uid":{"description":"uuid of the transport","format":"uuid","type":"string"},"remote_id":{"description":"your remote transport id","type":"string"}},"type":"object"}}}}
```

## The NewTransportMessage\_author object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"NewTransportMessage_author":{"properties":{"display_name":{"type":"string"},"company":{"type":"number"},"pk":{"description":"Dashdoc's internal id.","type":"number"}},"type":"object"}}}}
```

## The UpdateTransportMessage\_document\_options object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"UpdateTransportMessage_document_options":{"properties":{"filename":{"description":"filename","type":"string"}},"type":"object"}}}}
```

## The UpdateTransportMessage\_document object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"UpdateTransportMessage_document":{"properties":{"value":{"description":"file content","type":"string"},"options":{"$ref":"#/components/schemas/UpdateTransportMessage_document_options"}},"type":"object"},"UpdateTransportMessage_document_options":{"properties":{"filename":{"description":"filename","type":"string"}},"type":"object"}}}}
```

## The CreateOrUpdateTransport\_quotation object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"CreateOrUpdateTransport_quotation":{"description":"Pricing information for the transport","properties":{"lines":{"items":{"$ref":"#/components/schemas/NewPriceLine"},"type":"array"}},"type":"object"},"NewPriceLine":{"properties":{"description":{"description":"Description of the line","type":"string"},"quantity":{"type":"number"},"unit_price":{"type":"number"},"is_gas_indexed":{"description":"Whether the price is indexed on gas price using fuel surcharge","type":"boolean"},"metric":{"description":"Metric of the price line","enum":["FLAT","DISTANCE_IN_KM","DURATION_IN_MINUTE","DURATION_IN_HOUR","LOADED_WEIGHT_IN_KG","LOADED_WEIGHT_IN_TONNE","LOADED_VOLUME_IN_LITRE","LOADED_VOLUME_IN_M3","LOADED_QUANTITY","LOADED_LINEAR_METERS","UNLOADED_WEIGHT_IN_KG","UNLOADED_WEIGHT_IN_TONNE","UNLOADED_VOLUME_IN_LITRE","UNLOADED_VOLUME_IN_M3","UNLOADED_QUANTITY","UNLOADED_LINEAR_METERS","NB_DELIVERIES","NB_ROUNDS"],"type":"string"}},"type":"object"}}}}
```

## The RetrievedTransport\_allOf object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"RetrievedTransport_allOf":{"properties":{"agreed_price_total":{"description":"The total of the agreed price (including fuel surcharge, excluding taxes) if readable, otherwise null.","nullable":true,"type":"string"},"invoiced_price_total":{"description":"The total of the invoiced price (including fuel surcharge, excluding taxes) if readable, otherwise null.","nullable":true,"type":"string"},"shipper_final_price_total":{"description":"The total of the shipper final price (including fuel surcharge, excluding taxes) if readable, otherwise null.","nullable":true,"type":"string"},"effective_price_total":{"description":"The total of the effective price (including fuel surcharge, excluding taxes) if readable, otherwise null.","nullable":true,"type":"string"},"purchase_cost_total":{"description":"The total of the purchase costs if readable, otherwise null.","nullable":true,"type":"string"},"segments":{"items":{"$ref":"#/components/schemas/SegmentWithLegTags"},"type":"array"}},"type":"object"},"SegmentWithLegTags":{"allOf":[{"$ref":"#/components/schemas/Segment"},{"$ref":"#/components/schemas/SegmentWithLegTags_allOf"}],"type":"object"},"Segment":{"description":"","properties":{"uid":{"minLength":1,"type":"string"},"remote_id":{"minLength":1,"type":"string"},"origin":{"$ref":"#/components/schemas/Site"},"destination":{"$ref":"#/components/schemas/Site"},"trucker":{"$ref":"#/components/schemas/SegmentTrucker"},"vehicle":{"$ref":"#/components/schemas/Vehicle"},"trailers":{"items":{"$ref":"#/components/schemas/Trailer"},"type":"array"},"sort_order":{"description":"The index of the segment in the transport","minimum":0,"type":"number"},"scheduled_start_range":{"$ref":"#/components/schemas/Segment_scheduled_start_range"},"scheduled_end_range":{"$ref":"#/components/schemas/Segment_scheduled_end_range"},"scheduled_start":{"deprecated":true,"description":"The datetime at which the carrier scheduled the start of this segment\n","type":"string"},"scheduled_end":{"deprecated":true,"description":"The datetime at which the carrier scheduled the end of this segment","type":"string"},"child_transport":{"$ref":"#/components/schemas/Segment_child_transport"},"telematic_distance":{"description":"Automatically computed distance from telematic data (in kms).","type":"integer"},"distance":{"description":"Manually entered distance. If null, it takes the value of telematic_distance (in kms).","type":"integer"},"origin_mileage":{"description":"Mileage at transport origin site (in kms).","type":"integer"},"destination_mileage":{"description":"Mileage at transport destination site (in kms).","type":"integer"}},"type":"object"},"Site":{"properties":{"uid":{"format":"uuid","type":"string"},"remote_id":{"description":"The id of the site in your system","type":"string"},"address":{"$ref":"#/components/schemas/Address"},"real_start":{"description":"date and time when trucker arrived on site","format":"date-time","type":"string"},"real_end":{"description":"date and time when trucker completed loading / unloading (depending whether site is origin or destination)","format":"date-time","type":"string"},"signature_process":{"type":"string"},"instructions":{"$ref":"#/components/schemas/site_instructions"},"reference":{"type":"string"},"action":{"deprecated":true,"description":"Deprecated. Always returned as an empty string.","type":"string"},"eta":{"nullable":true,"type":"string"},"eta_tracking":{"$ref":"#/components/schemas/eta_tracking"},"punctuality_status":{"$ref":"#/components/schemas/punctuality_status"},"supports_exchanges":{"$ref":"#/components/schemas/SupportsExchange"},"category":{"enum":["loading","unloading"],"type":"string"},"slots":{"items":{"$ref":"#/components/schemas/Site_slots"},"type":"array"},"trucker_instructions":{"$ref":"#/components/schemas/trucker_instructions"},"trip":{"$ref":"#/components/schemas/Site_trip"}},"type":"object"},"Address":{"properties":{"pk":{"description":"Dashdoc's internal id.","type":"number"},"name":{"type":"string"},"address":{"type":"string"},"city":{"type":"string"},"postcode":{"type":"string"},"country":{"$ref":"#/components/schemas/country"},"latitude":{"$ref":"#/components/schemas/latitude"},"longitude":{"$ref":"#/components/schemas/longitude"},"radius":{"default":500,"description":"Radius around the GPS coordinates within which the address is located (in meters)","type":"integer"},"coords_validated":{"default":false,"description":"if `true`, when this address is used as a loading or unloading site, the mobile app displays an itinerary button to start GPS app with guidance to these coordinates","type":"boolean"},"is_demo":{"$ref":"#/components/schemas/is_demo"},"is_carrier":{"type":"boolean"},"is_shipper":{"type":"boolean"},"is_origin":{"$ref":"#/components/schemas/address_is_origin_and_is_destination"},"is_destination":{"$ref":"#/components/schemas/address_is_origin_and_is_destination"},"created_by":{"$ref":"#/components/schemas/created-by"},"created_by_user":{"$ref":"#/components/schemas/created-by-user"},"created":{"$ref":"#/components/schemas/created"},"instructions":{"$ref":"#/components/schemas/site_instructions"},"remote_id":{"description":"The id of the address in your system.","type":"string"},"original":{"description":"Dashdoc's internal id of the original address.","nullable":true,"readOnly":true,"type":"number"},"company":{"$ref":"#/components/schemas/Company"}},"type":"object"},"country":{"description":"Only the 2-character codification is accepted (ISO 3166-1 alpha-2)","type":"string"},"latitude":{"description":"Latitude using the decimal GPS coordinates (WGS84). At 7 decimals, the position is accurate around the centimeter.","format":"float","nullable":true,"type":"number"},"longitude":{"description":"Longitude using the decimal GPS coordinates (WGS84). At 7 decimals, the position is accurate around the centimeter.","format":"float","nullable":true,"type":"number"},"is_demo":{"description":"Indicates that the address is a fake one created from demonstration. Everything linked to it will be deleted when using the 'Delete demo content' button in company parameters","type":"boolean"},"address_is_origin_and_is_destination":{"description":"Whether this address is a \"Logistic Points\" and will be usable as pickup/delivery point.\nThe distinction between origin/pickup and destination/delivery was merged as a single \"Logistic Point\" concept. `is_origin` implies `is_destination` and vice-versa.\n","type":"boolean"},"created-by":{"nullable":true,"properties":{"pk":{"description":"company id","type":"number"},"name":{"description":"name of the company","type":"string"}},"type":"object"},"created-by-user":{"nullable":true,"properties":{"pk":{"type":"number"},"display_name":{"type":"string"},"company":{"description":"The company id who created the address","type":"number"},"trucker_id":{"description":"The trucker id who created the address","type":"number"}},"type":"object"},"created":{"description":"Date of creation on our server","format":"date-time","type":"string"},"site_instructions":{"description":"Site instructions, visible to all parties (trucker, carrier, shipper, site). Displayed in the trucker mobile app. Not visible in the eCMR. If the field is not provided, the address's site instructions will be used.","maxLength":1000,"type":"string"},"Company":{"properties":{"pk":{"description":"Dashdoc's internal id.","type":"number"},"remote_id":{"type":"string"},"created":{"format":"date-time","type":"object"},"updated":{"format":"date-time","type":"string"},"deleted":{"type":"boolean"},"invoicing_remote_id":{"description":"The id of the company in your invoicing system.","type":"string"},"name":{"type":"string"},"phone_number":{"type":"string"},"email":{"type":"string"},"siren":{"type":"string"},"trade_number":{"type":"string"},"country":{"$ref":"#/components/schemas/country"},"comments":{"type":"string"},"vat_number":{"type":"string"},"is_verified":{"type":"boolean"},"settings_transport_order_observations":{"type":"string"},"settings_constrain_reference_edition":{"type":"boolean"},"account_type":{"description":"Ignore. Dashdoc technical data.","type":"string"},"logo":{"description":"The URL of your logo","nullable":true,"type":"string"},"subscription_access":{"type":"object"},"settings":{"type":"object"},"primary_address":{"$ref":"#/components/schemas/PrimaryAddress_1"},"managers":{"items":{"$ref":"#/components/schemas/Managers"},"type":"array"},"has_loggable_managers":{"description":"Ignore. Dashdoc technical data.","type":"boolean"}},"type":"object"},"PrimaryAddress_1":{"properties":{"pk":{"description":"Dashdoc's internal id.","type":"number"},"name":{"type":"string"},"address":{"type":"string"},"city":{"type":"string"},"postcode":{"type":"string"},"country":{"$ref":"#/components/schemas/country"},"latitude":{"$ref":"#/components/schemas/latitude"},"longitude":{"$ref":"#/components/schemas/longitude"},"radius":{"default":500,"description":"Radius around the GPS coordinates within which the address is located (in meters)","type":"integer"},"coords_validated":{"default":false,"description":"if `true`, when this address is used as a loading or unloading site, the mobile app displays an itinerary button to start GPS app with guidance to these coordinates","type":"boolean"},"is_demo":{"$ref":"#/components/schemas/is_demo"},"is_carrier":{"description":"Whether this company is considered a carrier","type":"boolean"},"is_shipper":{"description":"Whether this company is considered a shipper","type":"boolean"},"is_origin":{"description":"Legacy, not relevant for a company's primary address. Consider creating a separate address associated with this partner instead.\n","type":"boolean"},"is_destination":{"description":"Legacy, not relevant for a company's primary address. Consider creating a separate address associated with this partner instead.\n","type":"boolean"},"created_by":{"$ref":"#/components/schemas/created-by"},"created_by_user":{"$ref":"#/components/schemas/created-by-user"},"created":{"$ref":"#/components/schemas/created"},"remote_id":{"description":"The id of the address in your system.","type":"string"}},"type":"object"},"Managers":{"properties":{"pk":{"description":"Dashdoc's internal id.","type":"number"},"user":{"$ref":"#/components/schemas/Managers_user"},"display_name":{"type":"string"},"role":{"type":"string"}},"type":"object"},"Managers_user":{"properties":{"email":{"format":"email","type":"string"},"first_name":{"type":"string"},"last_name":{"type":"string"}},"type":"object"},"eta_tracking":{"default":false,"description":"Ask for an ETA on this site. This is currently a beta feature, not activated by default.","type":"boolean"},"punctuality_status":{"default":"untracked","description":"Indicate the punctuality on this site.","enum":["untracked","probably_late","probably_on_time","late","on_time"],"type":"string"},"SupportsExchange":{"properties":{"uid":{"description":"uid of the support exchange","format":"uuid","type":"string"},"site":{"$ref":"#/components/schemas/SupportsExchange_site"},"support_type":{"$ref":"#/components/schemas/SupportType"},"expected_retrieved":{"description":"Expected number of supports that should be retrieved on the site","type":"number"},"actual_retrieved":{"description":"Actual number of supports that were retrieved on the site","type":"number"},"expected_delivered":{"description":"Expected number of supports that should be delivered on the site","type":"number"},"actual_delivered":{"description":"Actual number of supports that were delivered on the site","type":"number"},"observations":{"description":"Free text. Observations about this supports exchange. Can be filled on mobile app, web app or via API.","type":"string"},"remote_id":{"description":"The ID of the support in your system","type":"string"}},"type":"object"},"SupportsExchange_site":{"description":"site where supports exchange is expected","properties":{"uid":{"description":"uid of the site","format":"uuid","type":"string"},"remote_id":{"description":"remote_id of the site","type":"string"}},"type":"object"},"SupportType":{"description":"Type of the supports that are exchanged","properties":{"name":{"description":"Display name of the support type","type":"string"},"created":{"$ref":"#/components/schemas/created"},"uid":{"format":"uuid","type":"string"},"remote_id":{"description":"The id of the support type in your system.","type":"string"}},"type":"object"},"Site_slots":{"properties":{"start":{"format":"date-time","type":"string"},"end":{"format":"date-time","type":"string"}},"type":"object"},"trucker_instructions":{"description":"**This field is part of a beta feature.** Private instructions. **The carrier of the transport is the only one who can edit and read those instructions.** Note that those instructions are not visible in the consignment note and can be accessed by the trucker. The value is null if the caller doesn't have the right of access to the data.","maxLength":1000,"type":"string"},"Site_trip":{"description":"Trip linked to this site/activity.","nullable":true,"properties":{"uid":{"format":"uuid","type":"string"},"name":{"type":"string"},"is_prepared":{"type":"boolean"},"status":{"enum":["unstarted","ongoing","done"],"type":"string"}},"readOnly":true,"type":"object"},"SegmentTrucker":{"properties":{"pk":{"description":"Dashdoc's internal id.","type":"number"},"remote_id":{"description":"The ID of the trucker in your system. It has to be unique among all your truckers.","type":"string"},"display_name":{"type":"string"},"user":{"$ref":"#/components/schemas/SegmentTruckerUser"}},"type":"object"},"SegmentTruckerUser":{"properties":{"pk":{"description":"Dashdoc's internal id.","type":"number"},"first_name":{"type":"string"},"last_name":{"type":"string"},"username":{"description":"Ignore. Dashdoc technical data.","type":"string"},"email":{"format":"email","type":"string"},"display_name":{"description":"Display name generated by Dashdoc.","type":"string"},"date_joined":{"description":"Ignore. Dashdoc technical data.","format":"date-time","type":"string"},"is_staff":{"description":"Ignore. Dashdoc technical data.","type":"boolean"},"is_superuser":{"description":"Ignore. Dashdoc technical data.","type":"boolean"},"has_usable_password":{"description":"Ignore. Dashdoc technical data.","type":"boolean"}},"type":"object"},"Vehicle":{"properties":{"pk":{"description":"Dashdoc's internal id","type":"number"},"carrier":{"description":"Dashdoc's internal id of the carrier owning the vehicle","type":"number"},"category":{"description":"Vehicle category","type":"string"},"license_plate":{"description":"License plate number","type":"string"},"fleet_number":{"description":"Your vehicle fleet number","type":"string"},"remote_id":{"description":"The ID of the vehicle in your system","type":"string"},"created":{"description":"Date of creation on our server","format":"date-time","type":"string"},"used_for_qualimat_transports":{"description":"True if the vehicle can be used for Qualimat transport (only used for visual help and warnings)","type":"boolean"},"telematic_vehicle":{"description":"Ignore. Dashdoc technical data","type":"number"},"original":{"type":"number"},"tags":{"description":"List of tags applied to the vehicle.","items":{"$ref":"#/components/schemas/Tag"},"type":"array"},"technical_control_deadline":{"format":"date-time","type":"string"},"tachograph_deadline":{"format":"date-time","type":"string"},"speed_limiter_deadline":{"format":"date-time","type":"string"},"country":{"$ref":"#/components/schemas/country"},"unavailability":{"description":"List of unavailable period","items":{"$ref":"#/components/schemas/Unavailability"},"type":"array"},"events":{"description":"Ignore. Dashdoc technical data.","items":{"type":"object"},"type":"array"}},"type":"object"},"Tag":{"properties":{"pk":{"description":"The unique identifier of the tag","type":"integer"},"name":{"description":"The name of the tag","type":"string"},"color":{"description":"The color of the tag in hex format","type":"string"},"tag_group_id":{"description":"The ID of the tag group this tag belongs to, if any","nullable":true,"type":"integer"}},"required":["color","name","pk"],"type":"object"},"Unavailability":{"properties":{"id":{"description":"Dashdoc's internal id","type":"number"},"remote_id":{"description":"The ID of the unavailability in your system","type":"string"},"created":{"description":"Date of creation on our server","format":"date-time","type":"string"},"start_date":{"description":"Start date of the unavailability","format":"date-time","type":"string"},"end_date":{"description":"End date of the unavailability","format":"date-time","type":"string"},"unavailability_type":{"description":"Type of unavailability","enum":["paid_vacation","day_off","sick_leave","training","vacation","maintenance","rental","other"],"type":"string"},"unavailability_note":{"description":"Notes about the unavailability","type":"string"}},"type":"object"},"Trailer":{"properties":{"pk":{"description":"Dashdoc's internal id","type":"number"},"original":{"description":"Ignore. Dashdoc technical data","type":"number"},"carrier":{"description":"Dashdoc's internal id of the carrier owning the trailer","type":"number"},"license_plate":{"description":"License plate number","type":"string"},"fleet_number":{"description":"Your trailer fleet number","type":"string"},"remote_id":{"description":"The ID of the trailer in your system","type":"string"},"created":{"description":"Date of creation on our server","format":"date-time","type":"string"},"used_for_qualimat_transports":{"description":"True if the trailer can be used for Qualimat transport (only used for visual help and warnings)","type":"boolean"},"tags":{"description":"List of tags applied to the trailer.","items":{"$ref":"#/components/schemas/Tag"},"type":"array"},"technical_control_deadline":{"format":"date-time","type":"string"},"country":{"$ref":"#/components/schemas/country"},"unavailability":{"description":"List of unavailable period","items":{"$ref":"#/components/schemas/Unavailability"},"type":"array"},"events":{"description":"Ignore. Dashdoc technical data.","items":{"type":"object"},"type":"array"}},"type":"object"},"Segment_scheduled_start_range":{"description":"The datetime range at which the carrier scheduled the start of this segment","properties":{"start":{"description":"Min scheduled start date (ISO 8601)","type":"string"},"end":{"description":"Max scheduled start date (ISO 8601)","type":"string"}},"type":"object"},"Segment_scheduled_end_range":{"description":"The datetime range at which the carrier scheduled the end of this segment","properties":{"start":{"description":"Min scheduled end date (ISO 8601)","type":"string"},"end":{"description":"Max scheduled end date (ISO 8601)","type":"string"}},"type":"object"},"Segment_child_transport":{"description":"If the segment is chartered, will contain the child transport","properties":{"uid":{"format":"uuid","type":"string"},"sequential_id":{"type":"number"},"remote_id":{"type":"string"},"has_strong_link":{"type":"boolean"}},"type":"object"},"SegmentWithLegTags_allOf":{"properties":{"tags":{"description":"Tags of the leg this segment belongs to. Segments of the same leg share its tags.","items":{"$ref":"#/components/schemas/Tag"},"type":"array"}},"type":"object"}}}}
```

## The AssignTransport\_trucker\_id object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"AssignTransport_trucker_id":{"properties":{"pk":{"description":"Dashdoc's internal id. Optional, not required if `remote_id` is sent.","type":"number"},"remote_id":{"description":"The ID of the trucker in your system. Optional, ignored if pk is sent.","type":"string"}},"required":["pk"],"type":"object"}}}}
```

## The TransportRevenueSplit\_activity\_to\_split\_revenue object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"TransportRevenueSplit_activity_to_split_revenue":{"properties":{"transport_repartition":{"description":"The share of the revenue of this split relative to the total revenue of the transport","type":"string"},"transport_revenue_share":{"description":"The revenue of this split","type":"string"},"subcontracting_repartition":{"description":"The cost of this split from out of the subcontracting cost","nullable":true,"type":"string"},"subcontracting_cost_share":{"description":"The share of the cost of this split relative to the total cost of the subcontracting cost","nullable":true,"type":"string"},"child_transport_uid":{"description":"The uid of the child transport, if this split is for a subcontracted transport","nullable":true,"type":"string"}},"type":"object"}}}}
```

## The UpdateTransportStatus\_update\_details\_loads object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"UpdateTransportStatus_update_details_loads":{"description":"The delivery concerned","properties":{"replace_with_delivery_uid":{"description":"Replace the name of this attribut with the righ delivery uid","items":{"$ref":"#/components/schemas/NewDeliveryLoads"},"type":"array"}},"type":"object"},"NewDeliveryLoads":{"properties":{"remote_id":{"description":"The ID of the load in your system. It has to be unique among all your transports.","type":"string"},"description":{"description":"Text description of the load. In the case of a dangerous load, the description has to respect the ADR law.","type":"string"},"reference":{"description":"Reference of the load.","type":"string"},"weight":{"description":"In kilograms","format":"float","type":"number"},"volume":{"description":"Volume of load in m3","format":"float","type":"number"},"linear_meters":{"description":"Length of load in meters","format":"float","type":"number"},"quantity":{"description":"Only one decimal accepted (e.g 0.0)","format":"float","type":"number"},"pallet_equivalence":{"description":"Pallet equivalence (EPS/EQPAL): how many standard pallet spaces the load occupies. Minimum `0.01`, and only two decimals are kept — omit it or send `null` rather than 0 when unknown. When a load is created from the Dashdoc interface this defaults to `quantity` × the handling unit's pallet equivalence, and stays freely overridable.","format":"float","nullable":true,"type":"number"},"category":{"description":"Packaging of the load. The text is free but these specific values cause a custom flow on the mobile app: `pallets`, `containers`, `bulk`, `roundwood`, `powder_tank`, `bulk_qualimat`, `rental`.","type":"string"},"handling_unit_uid":{"description":"Existing handling unit UID from the load type catalog.","format":"uuid","type":"string"},"good_uid":{"description":"Existing good UID from the goods catalog.","format":"uuid","type":"string"},"create_handling_unit":{"$ref":"#/components/schemas/NewDeliveryLoads_create_handling_unit"},"create_good":{"$ref":"#/components/schemas/NewDeliveryLoads_create_good"},"dangerous_goods_category":{"deprecated":true,"description":"ADR class","enum":["1","2","3","4.1","4.2","4.3","5.1","5.2","6.1","6.2","7","8","9"],"type":"string"},"is_dangerous":{"default":false,"description":"Indicates whether the load is dangerous. If true, the trucker has to confirm adr un code and legal mentions at unloading.","type":"boolean"},"adr_un_code":{"description":"Only for dangerous load, the official UN code from the ADR law.","type":"string"},"legal_mentions":{"description":"Only for dangerous load, all mandatory legal mentions printed on documents.","type":"string"},"complementary_information":{"description":"Any information about the load that doesn't fit to the description field.","type":"string"},"container_number":{"type":"string"},"tare_weight":{"description":"In kilograms","format":"float","type":"number"},"container_seal_number":{"type":"string"},"refrigerated":{"description":"Indicates whether the load is refrigerated. If true, the trucker can fill in the temperature.","type":"boolean"},"temperature":{"type":"string"},"steres":{"format":"float","type":"number"},"idtf_number":{"description":"Must match an existing IDTF number","type":"string"},"use_identifiers":{"description":"if `true`, trucker is asked to scan barcode identifiers on load","type":"boolean"},"identifiers":{"description":"Only relevant if use_identifiers is set to `true`. List of expected barcode identifiers that the trucker should scan at loading and unloading. App controls that expected barcodes are actually scanned. If empty, the trucker will have to scan barcodes anyway, but there won't be any check. Feature has to be activated in your account by your Dashdoc projet manager.","items":{"type":"string"},"type":"array"},"identifiers_observations":{"description":"Observations explaining issues with identifier, such as missing or unexpected identifiers","type":"string"}},"type":"object"},"NewDeliveryLoads_create_handling_unit":{"description":"Create a handling unit in the catalog and use its UID for this load. If provided, it silently overrides `handling_unit_uid`.","nullable":true,"properties":{"name":{"type":"string"},"dashdoc_load_category":{"type":"string"},"remote_id":{"type":"string"}},"type":"object"},"NewDeliveryLoads_create_good":{"description":"Create a good in the catalog and use its UID for this load. If provided, it silently overrides `good_uid`.","nullable":true,"properties":{"name":{"type":"string"},"additional_information":{"type":"string"},"remote_id":{"type":"string"}},"type":"object"}}}}
```

## The UpdateTransportStatus\_update\_details object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"UpdateTransportStatus_update_details":{"properties":{"loads":{"$ref":"#/components/schemas/UpdateTransportStatus_update_details_loads"}},"type":"object"},"UpdateTransportStatus_update_details_loads":{"description":"The delivery concerned","properties":{"replace_with_delivery_uid":{"description":"Replace the name of this attribut with the righ delivery uid","items":{"$ref":"#/components/schemas/NewDeliveryLoads"},"type":"array"}},"type":"object"},"NewDeliveryLoads":{"properties":{"remote_id":{"description":"The ID of the load in your system. It has to be unique among all your transports.","type":"string"},"description":{"description":"Text description of the load. In the case of a dangerous load, the description has to respect the ADR law.","type":"string"},"reference":{"description":"Reference of the load.","type":"string"},"weight":{"description":"In kilograms","format":"float","type":"number"},"volume":{"description":"Volume of load in m3","format":"float","type":"number"},"linear_meters":{"description":"Length of load in meters","format":"float","type":"number"},"quantity":{"description":"Only one decimal accepted (e.g 0.0)","format":"float","type":"number"},"pallet_equivalence":{"description":"Pallet equivalence (EPS/EQPAL): how many standard pallet spaces the load occupies. Minimum `0.01`, and only two decimals are kept — omit it or send `null` rather than 0 when unknown. When a load is created from the Dashdoc interface this defaults to `quantity` × the handling unit's pallet equivalence, and stays freely overridable.","format":"float","nullable":true,"type":"number"},"category":{"description":"Packaging of the load. The text is free but these specific values cause a custom flow on the mobile app: `pallets`, `containers`, `bulk`, `roundwood`, `powder_tank`, `bulk_qualimat`, `rental`.","type":"string"},"handling_unit_uid":{"description":"Existing handling unit UID from the load type catalog.","format":"uuid","type":"string"},"good_uid":{"description":"Existing good UID from the goods catalog.","format":"uuid","type":"string"},"create_handling_unit":{"$ref":"#/components/schemas/NewDeliveryLoads_create_handling_unit"},"create_good":{"$ref":"#/components/schemas/NewDeliveryLoads_create_good"},"dangerous_goods_category":{"deprecated":true,"description":"ADR class","enum":["1","2","3","4.1","4.2","4.3","5.1","5.2","6.1","6.2","7","8","9"],"type":"string"},"is_dangerous":{"default":false,"description":"Indicates whether the load is dangerous. If true, the trucker has to confirm adr un code and legal mentions at unloading.","type":"boolean"},"adr_un_code":{"description":"Only for dangerous load, the official UN code from the ADR law.","type":"string"},"legal_mentions":{"description":"Only for dangerous load, all mandatory legal mentions printed on documents.","type":"string"},"complementary_information":{"description":"Any information about the load that doesn't fit to the description field.","type":"string"},"container_number":{"type":"string"},"tare_weight":{"description":"In kilograms","format":"float","type":"number"},"container_seal_number":{"type":"string"},"refrigerated":{"description":"Indicates whether the load is refrigerated. If true, the trucker can fill in the temperature.","type":"boolean"},"temperature":{"type":"string"},"steres":{"format":"float","type":"number"},"idtf_number":{"description":"Must match an existing IDTF number","type":"string"},"use_identifiers":{"description":"if `true`, trucker is asked to scan barcode identifiers on load","type":"boolean"},"identifiers":{"description":"Only relevant if use_identifiers is set to `true`. List of expected barcode identifiers that the trucker should scan at loading and unloading. App controls that expected barcodes are actually scanned. If empty, the trucker will have to scan barcodes anyway, but there won't be any check. Feature has to be activated in your account by your Dashdoc projet manager.","items":{"type":"string"},"type":"array"},"identifiers_observations":{"description":"Observations explaining issues with identifier, such as missing or unexpected identifiers","type":"string"}},"type":"object"},"NewDeliveryLoads_create_handling_unit":{"description":"Create a handling unit in the catalog and use its UID for this load. If provided, it silently overrides `handling_unit_uid`.","nullable":true,"properties":{"name":{"type":"string"},"dashdoc_load_category":{"type":"string"},"remote_id":{"type":"string"}},"type":"object"},"NewDeliveryLoads_create_good":{"description":"Create a good in the catalog and use its UID for this load. If provided, it silently overrides `good_uid`.","nullable":true,"properties":{"name":{"type":"string"},"additional_information":{"type":"string"},"remote_id":{"type":"string"}},"type":"object"}}}}
```

## The Contact\_1\_allOf object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"Contact_1_allOf":{"properties":{"uid":{"description":"Unique identifier of the contact","format":"uuid","type":"string"}},"type":"object"}}}}
```

## The Form\_allOf\_pdf object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"Form_allOf_pdf":{"nullable":true,"properties":{"url":{"description":"URL to fetch the PDF version of the waste form","type":"string"},"updated_date":{"description":"Date and time of PDF last update","format":"date-time","type":"string"}},"type":"object"}}}}
```

## The Form\_allOf object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"Form_allOf":{"properties":{"uid":{"description":"Unique identifier of the waste form","format":"uuid","type":"string"},"name":{"description":"Human readable name of the waste form. Identifier for OVAM.","type":"string"},"created":{"description":"Date and time of creation","format":"date-time","type":"string"},"updated":{"description":"Date and time of last update","format":"date-time","type":"string"},"status":{"$ref":"#/components/schemas/waste_shipment_status"},"pdf":{"$ref":"#/components/schemas/Form_allOf_pdf"},"discontinued_reason":{"description":"Reason for the discontinuation of the waste shipment, the waste was in transit but never arrived at destination","nullable":true,"type":"string"},"transport_uid":{"description":"Unique identifier of the transport linked to the waste form in the TMS if any","format":"uuid","type":"string"}},"type":"object"},"waste_shipment_status":{"description":"The status of the waste shipment","enum":["draft","signed","cancelled","inTransit","discontinued","arrived","completed"],"type":"string"},"Form_allOf_pdf":{"nullable":true,"properties":{"url":{"description":"URL to fetch the PDF version of the waste form","type":"string"},"updated_date":{"description":"Date and time of PDF last update","format":"date-time","type":"string"}},"type":"object"}}}}
```

## The DashdocInvoiceItem\_tax\_code object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"DashdocInvoiceItem_tax_code":{"properties":{"dashdoc_id":{"description":"Dashdoc identifier of the tax code.","type":"string"},"tax_rate":{"description":"Tax rate as a percentage, encoded as a decimal string.","format":"decimal","type":"string"},"tax_type":{"description":"Type of tax, resolved for the authenticated company's country.","enum":["IGIC","IRPF","RETENTION","TPS","TVH","TVQ","VAT"],"type":"string"}},"required":["dashdoc_id","tax_rate","tax_type"],"type":"object"}}}}
```

## The NewDeliveryLoads\_create\_handling\_unit object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"NewDeliveryLoads_create_handling_unit":{"description":"Create a handling unit in the catalog and use its UID for this load. If provided, it silently overrides `handling_unit_uid`.","nullable":true,"properties":{"name":{"type":"string"},"dashdoc_load_category":{"type":"string"},"remote_id":{"type":"string"}},"type":"object"}}}}
```

## The NewDeliveryLoads\_create\_good object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"NewDeliveryLoads_create_good":{"description":"Create a good in the catalog and use its UID for this load. If provided, it silently overrides `good_uid`.","nullable":true,"properties":{"name":{"type":"string"},"additional_information":{"type":"string"},"remote_id":{"type":"string"}},"type":"object"}}}}
```

## The DockActivity\_trucker object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"DockActivity_trucker":{"properties":{"pk":{"description":"Id of the trucker","type":"number"},"display_name":{"description":"Full name of the trucker","type":"string"}},"type":"object"}}}}
```

## The DockActivity\_carrier object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"DockActivity_carrier":{"properties":{"pk":{"description":"Id of the carrier","type":"number"},"name":{"description":"Name of the carrier","type":"string"}},"type":"object"}}}}
```

## The DockActivity\_shipper object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"DockActivity_shipper":{"properties":{"pk":{"description":"Id of the shipping company","type":"number"},"name":{"description":"Name of the shipper","type":"string"}},"type":"object"}}}}
```

## The DockActivity\_vehicle object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"DockActivity_vehicle":{"properties":{"pk":{"description":"Id of the vehicle","type":"number"},"license_plate":{"type":"string"}},"type":"object"}}}}
```

## The DockActivity\_loading\_address object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"DockActivity_loading_address":{"properties":{"name":{"type":"string"},"address":{"type":"string"},"city":{"type":"string"},"postcode":{"type":"string"},"country":{"$ref":"#/components/schemas/country"}},"type":"object"},"country":{"description":"Only the 2-character codification is accepted (ISO 3166-1 alpha-2)","type":"string"}}}}
```

## The DockActivity\_loads object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"DockActivity_loads":{"properties":{"uid":{"description":"Id of the load","format":"uuid","type":"string"},"description":{"description":"Description of the load","type":"string"},"loading_scheduled_date":{"description":"Date of scheduled loading","format":"date-time","type":"string"},"unloading_scheduled_date":{"description":"Date of scheduled unloading","format":"date-time","type":"string"},"loading_address":{"$ref":"#/components/schemas/DockActivity_loading_address"},"unloading_address":{"$ref":"#/components/schemas/DockActivity_loading_address"},"quantity":{"format":"float","type":"number"},"category":{"description":"Packaging of the load. The text is free but these specific values cause a custom flow on the mobile app: `pallets`, `containers`, `bulk`, `roundwood`, `powder_tank`, `bulk_qualimat`, `rental`.","type":"string"},"complementary_information":{"description":"Any information about the load that doesn't fit to the description field","type":"string"},"weight":{"description":"In kilograms","format":"float","type":"number"},"volume":{"description":"Volume of load in m3","format":"float","type":"number"},"volume_display_unit":{"default":"m3","enum":["m3","L"],"type":"string"},"linear_meters":{"description":"Length of load in meters","format":"float","type":"number"},"is_dangerous":{"type":"boolean"}},"type":"object"},"DockActivity_loading_address":{"properties":{"name":{"type":"string"},"address":{"type":"string"},"city":{"type":"string"},"postcode":{"type":"string"},"country":{"$ref":"#/components/schemas/country"}},"type":"object"},"country":{"description":"Only the 2-character codification is accepted (ISO 3166-1 alpha-2)","type":"string"}}}}
```

## The customer\_to\_invoice\_invoicing\_address object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"customer_to_invoice_invoicing_address":{"properties":{"address":{"type":"string"},"city":{"type":"string"},"postcode":{"type":"string"},"country":{"$ref":"#/components/schemas/country"}},"type":"object"},"country":{"description":"Only the 2-character codification is accepted (ISO 3166-1 alpha-2)","type":"string"}}}}
```

## The SegmentWithLegTags\_allOf object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"SegmentWithLegTags_allOf":{"properties":{"tags":{"description":"Tags of the leg this segment belongs to. Segments of the same leg share its tags.","items":{"$ref":"#/components/schemas/Tag"},"type":"array"}},"type":"object"},"Tag":{"properties":{"pk":{"description":"The unique identifier of the tag","type":"integer"},"name":{"description":"The name of the tag","type":"string"},"color":{"description":"The color of the tag in hex format","type":"string"},"tag_group_id":{"description":"The ID of the tag group this tag belongs to, if any","nullable":true,"type":"integer"}},"required":["color","name","pk"],"type":"object"}}}}
```

## The DeliveryForTransport\_tracking\_contacts object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"DeliveryForTransport_tracking_contacts":{"properties":{"uid":{"description":"Dashdoc's internal id.","type":"string"},"contact":{"$ref":"#/components/schemas/TrackingContact"},"subscribed_to_status_updates":{"description":"If set to `true`, the contact will receive an email at every step of the delivery. Else, they will receive only one email once the delivery is done.","type":"boolean"}},"type":"object"},"TrackingContact":{"properties":{"uid":{"format":"uuid","type":"string"},"created":{"$ref":"#/components/schemas/created"},"company":{"$ref":"#/components/schemas/Company"},"first_name":{"type":"string"},"last_name":{"type":"string"},"email":{"format":"email","type":"string"},"phone_number":{"type":"string"},"fax_number":{"type":"string"},"remote_id":{"description":"The id of the contact in your system","type":"string"}},"type":"object"},"created":{"description":"Date of creation on our server","format":"date-time","type":"string"},"Company":{"properties":{"pk":{"description":"Dashdoc's internal id.","type":"number"},"remote_id":{"type":"string"},"created":{"format":"date-time","type":"object"},"updated":{"format":"date-time","type":"string"},"deleted":{"type":"boolean"},"invoicing_remote_id":{"description":"The id of the company in your invoicing system.","type":"string"},"name":{"type":"string"},"phone_number":{"type":"string"},"email":{"type":"string"},"siren":{"type":"string"},"trade_number":{"type":"string"},"country":{"$ref":"#/components/schemas/country"},"comments":{"type":"string"},"vat_number":{"type":"string"},"is_verified":{"type":"boolean"},"settings_transport_order_observations":{"type":"string"},"settings_constrain_reference_edition":{"type":"boolean"},"account_type":{"description":"Ignore. Dashdoc technical data.","type":"string"},"logo":{"description":"The URL of your logo","nullable":true,"type":"string"},"subscription_access":{"type":"object"},"settings":{"type":"object"},"primary_address":{"$ref":"#/components/schemas/PrimaryAddress_1"},"managers":{"items":{"$ref":"#/components/schemas/Managers"},"type":"array"},"has_loggable_managers":{"description":"Ignore. Dashdoc technical data.","type":"boolean"}},"type":"object"},"country":{"description":"Only the 2-character codification is accepted (ISO 3166-1 alpha-2)","type":"string"},"PrimaryAddress_1":{"properties":{"pk":{"description":"Dashdoc's internal id.","type":"number"},"name":{"type":"string"},"address":{"type":"string"},"city":{"type":"string"},"postcode":{"type":"string"},"country":{"$ref":"#/components/schemas/country"},"latitude":{"$ref":"#/components/schemas/latitude"},"longitude":{"$ref":"#/components/schemas/longitude"},"radius":{"default":500,"description":"Radius around the GPS coordinates within which the address is located (in meters)","type":"integer"},"coords_validated":{"default":false,"description":"if `true`, when this address is used as a loading or unloading site, the mobile app displays an itinerary button to start GPS app with guidance to these coordinates","type":"boolean"},"is_demo":{"$ref":"#/components/schemas/is_demo"},"is_carrier":{"description":"Whether this company is considered a carrier","type":"boolean"},"is_shipper":{"description":"Whether this company is considered a shipper","type":"boolean"},"is_origin":{"description":"Legacy, not relevant for a company's primary address. Consider creating a separate address associated with this partner instead.\n","type":"boolean"},"is_destination":{"description":"Legacy, not relevant for a company's primary address. Consider creating a separate address associated with this partner instead.\n","type":"boolean"},"created_by":{"$ref":"#/components/schemas/created-by"},"created_by_user":{"$ref":"#/components/schemas/created-by-user"},"created":{"$ref":"#/components/schemas/created"},"remote_id":{"description":"The id of the address in your system.","type":"string"}},"type":"object"},"latitude":{"description":"Latitude using the decimal GPS coordinates (WGS84). At 7 decimals, the position is accurate around the centimeter.","format":"float","nullable":true,"type":"number"},"longitude":{"description":"Longitude using the decimal GPS coordinates (WGS84). At 7 decimals, the position is accurate around the centimeter.","format":"float","nullable":true,"type":"number"},"is_demo":{"description":"Indicates that the address is a fake one created from demonstration. Everything linked to it will be deleted when using the 'Delete demo content' button in company parameters","type":"boolean"},"created-by":{"nullable":true,"properties":{"pk":{"description":"company id","type":"number"},"name":{"description":"name of the company","type":"string"}},"type":"object"},"created-by-user":{"nullable":true,"properties":{"pk":{"type":"number"},"display_name":{"type":"string"},"company":{"description":"The company id who created the address","type":"number"},"trucker_id":{"description":"The trucker id who created the address","type":"number"}},"type":"object"},"Managers":{"properties":{"pk":{"description":"Dashdoc's internal id.","type":"number"},"user":{"$ref":"#/components/schemas/Managers_user"},"display_name":{"type":"string"},"role":{"type":"string"}},"type":"object"},"Managers_user":{"properties":{"email":{"format":"email","type":"string"},"first_name":{"type":"string"},"last_name":{"type":"string"}},"type":"object"}}}}
```

## The TransportTemplate\_allOf object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"TransportTemplate_allOf":{"properties":{"template_name":{"description":"Name given to the template","type":"string"}},"type":"object"}}}}
```

## The Managers\_user object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"Managers_user":{"properties":{"email":{"format":"email","type":"string"},"first_name":{"type":"string"},"last_name":{"type":"string"}},"type":"object"}}}}
```

## The CreateOrUpdateSupportsExchangeForTransport\_support\_type object

```json
{"openapi":"3.0.0","info":{"title":"Dashdoc public API","version":"4.0"},"components":{"schemas":{"CreateOrUpdateSupportsExchangeForTransport_support_type":{"description":"Type of the supports that are exchanged","properties":{"uid":{"format":"uuid","type":"string"},"remote_id":{"description":"The id of the support type in your system.","type":"string"}},"type":"object"}}}}
```
