Dashdoc API Documentation
  • 👋GET STARTED
    • Introduction
    • Core API concepts
      • Authentication
      • External identifiers
      • Date and time formats
      • Requests and filters
      • Pagination
      • HTTP status codes
      • Rate limiting
      • Send documents
    • Understand the data model
      • Transport - Segment - Delivery
      • Origin/Destination sites
      • Company - Address
      • Trucker
  • 🔁INTEGRATE YOUR SOFTWARE
    • How to integrate your software with Dashdoc
    • Setup
      • Create a sandbox account
      • Get the API token
      • Make an authenticated request
  • 🎓USE CASES AND TUTORIALS
    • Shippers (ERP, WMS) 🔀
      • Create a simple transport as a shipper
      • Manage the address book
    • Carriers 🚛
      • Create a simple transport as a carrier
      • Create a multi-deliveries transport as a carrier
      • Create a break in a transport (segment)
      • Charter whole or part of a transport - Affrètement
      • Manage truckers
      • Create and follow rental orders
      • Handle Qualimat transports
    • Retrieve transport data 🏁
      • Get last updated transports (Poll vs. webhooks)
      • Get status updates with dates and times
      • Get load information (quantity, weight...)
      • Get mileage from transport
      • Get documents and photos with their type
      • Get observations from trucker / signatory
      • Get information about washings
      • Filter transports created by your truckers and partners
    • Invoicing 💰
    • Dashdoc Wam ♻️
      • Create a Waste Form
      • Sign a Waste Form as Organizer
      • Create a Transport for a Waste Form
      • Find the transport linked to a waste form
  • ☁️WEBHOOKS
    • Webhooks
  • 📱MOBILE APP
    • Use the mobile app to simulate transports
  • 💡UPGRADES
    • Upgrading API from v3 to v4
  • 📚API Reference
    • API v4 Reference
    • List of all endpoints for v4
      • Addresses
        • Security Protocol
      • Adr Un Codes
      • Carbon Footprint
        • Transport Operation Categories
      • Companies
      • Contacts
        • Invite
      • Deliveries
        • Add Round
        • Cmrs
      • Dock Activities
        • Mark Loaded By Dock
        • Mark Unloaded By Dock
      • Invoices
        • Items
        • Mark Paid
        • Mark Not Paid
      • Managers
        • Invite
        • Me
        • Set Company
      • Manager Truckers
        • Lease
        • Generate Invite Code
        • Unavailability
      • Security Protocols
      • Segments
        • Assign
        • Break
        • Charter
      • Tracking Files
      • Sites
        • Mark Done
        • Enable Eta
      • Support Types
      • Supports Exchanges
      • Telematics
        • Vehicles
        • Traces
      • Trailers
        • Unavailability
      • Track Dechets
      • Transport Loading Plans
      • Transport Messages
      • Transports
        • Charter
        • Assign
        • Archive
        • Merge To Trip
        • Mark Done
        • Mark Invoiced
        • Mark Paid
        • Cancel
        • Confirm
        • Decline
        • Revenue Split
        • Cmrs
        • Effective Price Lines
        • Loads Constraints
      • Transport Status
      • Transport Templates
      • Scheduler
        • Trips
          • Set Name
      • Vehicles
        • Unavailability
      • Wam
        • Contacts
        • Forms
          • Sign As Organizer
          • Create Transport
          • Loads
        • Companies
          • Details
Powered by GitBook
On this page
  • Introduction
  • Activation
  • Rental transports details
  • Create rental order transport
  • Retrieve rental order data
  • User guide for rental order

Was this helpful?

  1. USE CASES AND TUTORIALS
  2. Carriers 🚛

Create and follow rental orders

This page explains how to create rental order transports that will generate specific rental documents, and how to retrieve related information.

Introduction

Rental transports provide a way for truckers to generate and sign a rental order with the following informations:

  • the company that asked for rental

  • the list of transports executed for this company (where, what, when, LV number)

  • the date

  • the trucker and associated plates

  • the worked hours (excluding breaks)

  • signature of trucker and third party

Activation

The rental orders feature must be enabled by the Dashdoc team on your account.

Rental transports details

Documents

A rental transport does not have a digital consignment note or CMR.

A rental transport has a rental order (see below).

A rental transport can have all sorts of documents attached to it, including paper consignment notes. They can be used for invoicing.

Statuses

The status of a rental transport are limited to:

  • loading_complete → start of a working period, the first one is the "start of the day"

  • unloading_complete → end of a working period, the last one is the "end of the day"

Breaks

status_updates with category = break_timeare used to represent unworking hours of the trucker . They are be used to compute the actual working hours displayed on the document (worked hours are not persisted).

Create rental order transport

Specific screens will be displayed to truckers when executing a rental order transport. Also, specific information will be stored in the transport detail.

In order do to so, transport data must contain a unique planned_loads object with "category" = "rental".

Retrieve rental order data

Rental deliveries

Information about transports executed by the trucker during the rental is stored in a rental_deliveries object at the root of the transport's JSON.

Here is an exemple of rental_deliveries detail for a transport. The inner data structure is a list of transports :

Legal document

As mentionned above, there is no eCMR generated by Dashdoc for those transports. Instead another document is created and stored also in the documents part of the transport's JSON. Its category differs and has the value rental.

Exemple:

"documents": [
    {
        "pk": 2836097,
        "file_updated_date": "2021-04-23T07:19:13.115643Z",
        "delivery": "6de64936-2602-4538-b1b1-c8c4d9f83d4d",
        "delivery_sequential_id": 2708600,
        "reference": 2708600,
        "category": "rental",
        "name": "Rental order",
        "file": "https://www.dashdoc.eu/api/delivery-documents/c28e57ec-c073-495c-87d9-c2d48758e418",
        "business_privacy_scope": null
    }
]

Global exemple of rental order transport:

User guide for rental order

The following pages provide user documentation about how to create and use rental order in the web app and mobile app:

PreviousManage truckersNextHandle Qualimat transports

Last updated 1 year ago

Was this helpful?

🎓
Comment lancer un transport en location avec Dashdoc ?
Le bon de régie sur Dashdoc
Logo
Logo
21KB
exemple_content_rental_deliveries.json
rental_deliveries exemple
54KB
exemple_transport_rental_order.json
JSON of a rental order transport