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

Was this helpful?

  1. API Reference
  2. List of all endpoints for v4

Companies

PreviousTransport Operation CategoriesNextContacts

Last updated 1 year ago

Was this helpful?

📚

Read a company

get
Authorizations
Path parameters
pknumberRequired
remote_idstringOptional

If you choose to identify an object with its remote_id instead of its pk then

  • replace the pk value with the remote_id value in the URL

  • specify lookup_field=remote_id in the query parameters

Query parameters
lookup_fieldstringOptional

Used to specify what field is used in the URL to identify the object you're requesting, e.g. with the remote_id (see path parameters)

Responses
200
Get successful
application/json
get
GET /api/v4/companies/{pk}/ HTTP/1.1
Host: api.dashdoc.eu
Authentication: YOUR_API_KEY
Accept: */*
200

Get successful

{
  "pk": 928,
  "name": "Transport Bouvet",
  "addresses": [
    {
      "pk": 23498,
      "name": "Transport Bouvet",
      "address": "3 rue des champs",
      "city": "Nantes",
      "postcode": "44000",
      "country": "FR",
      "latitude": -52.5561625,
      "longitude": 92.896504,
      "radius": 500,
      "coords_validated": false,
      "is_demo": true,
      "is_carrier": true,
      "is_shipper": true,
      "is_origin": true,
      "is_destination": true,
      "created_by": {
        "pk": 25,
        "name": "Transport Bouvet"
      },
      "created_by_user": {
        "pk": 34,
        "display_name": "Jean Pierre Bouvet",
        "company": 25,
        "trucker_id": 95
      },
      "created": "2020-12-22T15:31:39.26167Z",
      "remote_id": "text"
    }
  ],
  "phone_number": "text",
  "email": "adele.bouvet@gmail.com",
  "siren": "text",
  "trade_number": "text",
  "vat_number": "text",
  "country": "FR",
  "has_loggable_managers": true,
  "contacts": [
    {
      "uid": "687cddac-dbd2-11ea-9024-0242ac130006",
      "created": "2020-12-22T15:31:39.26167Z",
      "company": {
        "pk": 928,
        "remote_id": "text",
        "created": "2020-07-30T21:10:06.445510Z",
        "updated": "2020-07-30T21:10:06.44551Z",
        "deleted": true,
        "invoicing_remote_id": "COMP_456",
        "name": "Transport Bouvet",
        "phone_number": "0601020304",
        "email": "i.love.dashdoc@gmail.com",
        "siren": "123456789",
        "trade_number": "text",
        "country": "FR",
        "comments": "text",
        "vat_number": "text",
        "is_verified": true,
        "settings_transport_order_observations": "text",
        "settings_constrain_reference_edition": true,
        "account_type": "text",
        "logo": "text",
        "subscription_access": {},
        "settings": {},
        "primary_address": {
          "pk": "text",
          "name": "Transport Bouvet",
          "address": "3 rue des champs",
          "city": "Nantes",
          "postcode": "44000",
          "country": "FR",
          "latitude": -52.5561625,
          "longitude": 92.896504,
          "radius": 500,
          "coords_validated": false,
          "is_demo": true,
          "is_carrier": true,
          "is_shipper": true,
          "is_origin": true,
          "is_destination": true,
          "created_by": 1,
          "created": "2020-07-30T21:10:06.44551Z",
          "instructions": "text",
          "remote_id": "text"
        },
        "managers": [
          {
            "pk": 928,
            "user": {
              "email": "adele.bouvet@gmail.com",
              "first_name": "Adèle",
              "last_name": "Bouvet"
            },
            "display_name": "text",
            "role": "text"
          }
        ],
        "has_loggable_managers": true
      },
      "first_name": "Adèle",
      "last_name": "Bouvet",
      "email": "adele.bouvet@gmail.com",
      "phone_number": "+33600000000",
      "fax_number": "text",
      "remote_id": "CONTACT_123",
      "is_manager": true,
      "has_pending_invite": true,
      "is_invitable": true,
      "invitation_link": "text"
    }
  ],
  "has_pending_invites": true,
  "primary_address": {
    "pk": 23498,
    "name": "Transport Bouvet",
    "address": "3 rue des champs",
    "city": "Nantes",
    "postcode": "44000",
    "country": "FR",
    "latitude": -52.5561625,
    "longitude": 92.896504,
    "radius": 500,
    "coords_validated": false,
    "is_demo": true,
    "is_carrier": true,
    "is_shipper": true,
    "is_origin": true,
    "is_destination": true,
    "created_by": {
      "pk": 25,
      "name": "Transport Bouvet"
    },
    "created_by_user": {
      "pk": 34,
      "display_name": "Jean Pierre Bouvet",
      "company": 25,
      "trucker_id": 95
    },
    "created": "2020-12-22T15:31:39.26167Z",
    "instructions": "text",
    "remote_id": "text",
    "company": {
      "pk": 928,
      "remote_id": "text",
      "created": "2020-07-30T21:10:06.445510Z",
      "updated": "2020-07-30T21:10:06.44551Z",
      "deleted": true,
      "invoicing_remote_id": "COMP_456",
      "name": "Transport Bouvet",
      "phone_number": "0601020304",
      "email": "i.love.dashdoc@gmail.com",
      "siren": "123456789",
      "trade_number": "text",
      "country": "FR",
      "comments": "text",
      "vat_number": "text",
      "is_verified": true,
      "settings_transport_order_observations": "text",
      "settings_constrain_reference_edition": true,
      "account_type": "text",
      "logo": "text",
      "subscription_access": {},
      "settings": {},
      "primary_address": {
        "pk": "text",
        "name": "Transport Bouvet",
        "address": "3 rue des champs",
        "city": "Nantes",
        "postcode": "44000",
        "country": "FR",
        "latitude": -52.5561625,
        "longitude": 92.896504,
        "radius": 500,
        "coords_validated": false,
        "is_demo": true,
        "is_carrier": true,
        "is_shipper": true,
        "is_origin": true,
        "is_destination": true,
        "created_by": 1,
        "created": "2020-07-30T21:10:06.44551Z",
        "instructions": "text",
        "remote_id": "text"
      },
      "managers": [
        {
          "pk": 928,
          "user": {
            "email": "adele.bouvet@gmail.com",
            "first_name": "Adèle",
            "last_name": "Bouvet"
          },
          "display_name": "text",
          "role": "text"
        }
      ],
      "has_loggable_managers": true
    }
  },
  "transports_in_last_month": 1,
  "is_verified": true,
  "can_invite_to": true,
  "remote_id": "text",
  "invoicing_remote_id": "COMP_456",
  "notes": "text",
  "tags": [
    {
      "pk": 23498,
      "name": "Remorque"
    }
  ]
}
  • GETCompanies list
  • POSTCreate a company
  • GETRead a company
  • PATCHPartially update a company

Companies list

get
Authorizations
Query parameters
pageintegerOptional

A page number within the paginated result set.

textstringOptional

Case insentive filter on company name

updated__gtestring · date-timeOptional

Filter companies updated after or at a certain date

updated__ltestring · date-timeOptional

Filter companies updated before or at a certain date

updated__gtstring · date-timeOptional

Filter companies updated after a certain date

updated__ltstring · date-timeOptional

Filter companies updated before a certain date

Responses
200
Get successful
application/json
get
GET /api/v4/companies/ HTTP/1.1
Host: api.dashdoc.eu
Authentication: YOUR_API_KEY
Accept: */*
200

Get successful

{
  "count": 1,
  "next": "text",
  "previous": "text",
  "results": [
    {
      "pk": 928,
      "name": "Transport Bouvet",
      "addresses": [
        {
          "pk": 23498,
          "name": "Transport Bouvet",
          "address": "3 rue des champs",
          "city": "Nantes",
          "postcode": "44000",
          "country": "FR",
          "latitude": -52.5561625,
          "longitude": 92.896504,
          "radius": 500,
          "coords_validated": false,
          "is_demo": true,
          "is_carrier": true,
          "is_shipper": true,
          "is_origin": true,
          "is_destination": true,
          "created_by": {
            "pk": 25,
            "name": "Transport Bouvet"
          },
          "created_by_user": {
            "pk": 34,
            "display_name": "Jean Pierre Bouvet",
            "company": 25,
            "trucker_id": 95
          },
          "created": "2020-12-22T15:31:39.26167Z",
          "remote_id": "text"
        }
      ],
      "phone_number": "text",
      "email": "adele.bouvet@gmail.com",
      "siren": "text",
      "trade_number": "text",
      "vat_number": "text",
      "country": "FR",
      "has_loggable_managers": true,
      "contacts": [
        {
          "uid": "687cddac-dbd2-11ea-9024-0242ac130006",
          "created": "2020-12-22T15:31:39.26167Z",
          "company": {
            "pk": 928,
            "remote_id": "text",
            "created": "2020-07-30T21:10:06.445510Z",
            "updated": "2020-07-30T21:10:06.44551Z",
            "deleted": true,
            "invoicing_remote_id": "COMP_456",
            "name": "Transport Bouvet",
            "phone_number": "0601020304",
            "email": "i.love.dashdoc@gmail.com",
            "siren": "123456789",
            "trade_number": "text",
            "country": "FR",
            "comments": "text",
            "vat_number": "text",
            "is_verified": true,
            "settings_transport_order_observations": "text",
            "settings_constrain_reference_edition": true,
            "account_type": "text",
            "logo": "text",
            "subscription_access": {},
            "settings": {},
            "primary_address": {
              "pk": "text",
              "name": "Transport Bouvet",
              "address": "3 rue des champs",
              "city": "Nantes",
              "postcode": "44000",
              "country": "FR",
              "latitude": -52.5561625,
              "longitude": 92.896504,
              "radius": 500,
              "coords_validated": false,
              "is_demo": true,
              "is_carrier": true,
              "is_shipper": true,
              "is_origin": true,
              "is_destination": true,
              "created_by": 1,
              "created": "2020-07-30T21:10:06.44551Z",
              "instructions": "text",
              "remote_id": "text"
            },
            "managers": [
              {
                "pk": 928,
                "user": {
                  "email": "adele.bouvet@gmail.com",
                  "first_name": "Adèle",
                  "last_name": "Bouvet"
                },
                "display_name": "text",
                "role": "text"
              }
            ],
            "has_loggable_managers": true
          },
          "first_name": "Adèle",
          "last_name": "Bouvet",
          "email": "adele.bouvet@gmail.com",
          "phone_number": "+33600000000",
          "fax_number": "text",
          "remote_id": "CONTACT_123",
          "is_manager": true,
          "has_pending_invite": true,
          "is_invitable": true,
          "invitation_link": "text"
        }
      ],
      "has_pending_invites": true,
      "primary_address": {
        "pk": 23498,
        "name": "Transport Bouvet",
        "address": "3 rue des champs",
        "city": "Nantes",
        "postcode": "44000",
        "country": "FR",
        "latitude": -52.5561625,
        "longitude": 92.896504,
        "radius": 500,
        "coords_validated": false,
        "is_demo": true,
        "is_carrier": true,
        "is_shipper": true,
        "is_origin": true,
        "is_destination": true,
        "created_by": {
          "pk": 25,
          "name": "Transport Bouvet"
        },
        "created_by_user": {
          "pk": 34,
          "display_name": "Jean Pierre Bouvet",
          "company": 25,
          "trucker_id": 95
        },
        "created": "2020-12-22T15:31:39.26167Z",
        "instructions": "text",
        "remote_id": "text",
        "company": {
          "pk": 928,
          "remote_id": "text",
          "created": "2020-07-30T21:10:06.445510Z",
          "updated": "2020-07-30T21:10:06.44551Z",
          "deleted": true,
          "invoicing_remote_id": "COMP_456",
          "name": "Transport Bouvet",
          "phone_number": "0601020304",
          "email": "i.love.dashdoc@gmail.com",
          "siren": "123456789",
          "trade_number": "text",
          "country": "FR",
          "comments": "text",
          "vat_number": "text",
          "is_verified": true,
          "settings_transport_order_observations": "text",
          "settings_constrain_reference_edition": true,
          "account_type": "text",
          "logo": "text",
          "subscription_access": {},
          "settings": {},
          "primary_address": {
            "pk": "text",
            "name": "Transport Bouvet",
            "address": "3 rue des champs",
            "city": "Nantes",
            "postcode": "44000",
            "country": "FR",
            "latitude": -52.5561625,
            "longitude": 92.896504,
            "radius": 500,
            "coords_validated": false,
            "is_demo": true,
            "is_carrier": true,
            "is_shipper": true,
            "is_origin": true,
            "is_destination": true,
            "created_by": 1,
            "created": "2020-07-30T21:10:06.44551Z",
            "instructions": "text",
            "remote_id": "text"
          },
          "managers": [
            {
              "pk": 928,
              "user": {
                "email": "adele.bouvet@gmail.com",
                "first_name": "Adèle",
                "last_name": "Bouvet"
              },
              "display_name": "text",
              "role": "text"
            }
          ],
          "has_loggable_managers": true
        }
      },
      "transports_in_last_month": 1,
      "is_verified": true,
      "can_invite_to": true,
      "remote_id": "text",
      "invoicing_remote_id": "COMP_456",
      "notes": "text",
      "tags": [
        {
          "pk": 23498,
          "name": "Remorque"
        }
      ]
    }
  ]
}

Create a company

post

Creates a company in your address book.

Controls occur to prevent from creating distinct companies objects that would actually represent the same.

Unicity control is performed on attributes in this order to determine if it already exists:

  • remote_id

  • trade_number

  • name

Authorizations
Body
namestringRequiredExample: Transport Bouvet
phone_numberstringOptional
emailstring · emailOptionalExample: adele.bouvet@gmail.com
sirenstringOptional
trade_numberstringOptional
vat_numberstringOptional
countrystringRequired

Only the 2-character codification is accepted (ISO 3166-1 alpha-2)

Example: FR
remote_idstringOptional

The ID of the company in your system. It has to be unique among all your companies.

invoicing_remote_idstringOptional

The id of the company in your invoicing system.

Example: COMP_456
notesstringOptional

Notes for this company, only visibile to your team members

Responses
201
Create successful
application/json
post
POST /api/v4/companies/ HTTP/1.1
Host: api.dashdoc.eu
Authentication: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 666

{
  "name": "Transport Bouvet",
  "phone_number": "text",
  "email": "adele.bouvet@gmail.com",
  "siren": "text",
  "trade_number": "text",
  "vat_number": "text",
  "country": "FR",
  "remote_id": "text",
  "invoicing_remote_id": "COMP_456",
  "notes": "text",
  "primary_address": {
    "pk": "text",
    "name": "Transport Bouvet",
    "address": "3 rue des champs",
    "city": "Nantes",
    "postcode": "44000",
    "country": "FR",
    "latitude": -52.5561625,
    "longitude": 92.896504,
    "radius": 500,
    "coords_validated": false,
    "is_demo": true,
    "is_carrier": true,
    "is_shipper": true,
    "is_origin": true,
    "is_destination": true,
    "created_by": 1,
    "created": "2020-07-30T21:10:06.44551Z",
    "instructions": "text",
    "remote_id": "text"
  },
  "tags": [
    {
      "pk": 23498,
      "name": "Remorque"
    }
  ]
}
201

Create successful

{
  "pk": 928,
  "name": "Transport Bouvet",
  "addresses": [
    {
      "pk": 23498,
      "name": "Transport Bouvet",
      "address": "3 rue des champs",
      "city": "Nantes",
      "postcode": "44000",
      "country": "FR",
      "latitude": -52.5561625,
      "longitude": 92.896504,
      "radius": 500,
      "coords_validated": false,
      "is_demo": true,
      "is_carrier": true,
      "is_shipper": true,
      "is_origin": true,
      "is_destination": true,
      "created_by": {
        "pk": 25,
        "name": "Transport Bouvet"
      },
      "created_by_user": {
        "pk": 34,
        "display_name": "Jean Pierre Bouvet",
        "company": 25,
        "trucker_id": 95
      },
      "created": "2020-12-22T15:31:39.26167Z",
      "remote_id": "text"
    }
  ],
  "phone_number": "text",
  "email": "adele.bouvet@gmail.com",
  "siren": "text",
  "trade_number": "text",
  "vat_number": "text",
  "country": "FR",
  "has_loggable_managers": true,
  "contacts": [
    {
      "uid": "687cddac-dbd2-11ea-9024-0242ac130006",
      "created": "2020-12-22T15:31:39.26167Z",
      "company": {
        "pk": 928,
        "remote_id": "text",
        "created": "2020-07-30T21:10:06.445510Z",
        "updated": "2020-07-30T21:10:06.44551Z",
        "deleted": true,
        "invoicing_remote_id": "COMP_456",
        "name": "Transport Bouvet",
        "phone_number": "0601020304",
        "email": "i.love.dashdoc@gmail.com",
        "siren": "123456789",
        "trade_number": "text",
        "country": "FR",
        "comments": "text",
        "vat_number": "text",
        "is_verified": true,
        "settings_transport_order_observations": "text",
        "settings_constrain_reference_edition": true,
        "account_type": "text",
        "logo": "text",
        "subscription_access": {},
        "settings": {},
        "primary_address": {
          "pk": "text",
          "name": "Transport Bouvet",
          "address": "3 rue des champs",
          "city": "Nantes",
          "postcode": "44000",
          "country": "FR",
          "latitude": -52.5561625,
          "longitude": 92.896504,
          "radius": 500,
          "coords_validated": false,
          "is_demo": true,
          "is_carrier": true,
          "is_shipper": true,
          "is_origin": true,
          "is_destination": true,
          "created_by": 1,
          "created": "2020-07-30T21:10:06.44551Z",
          "instructions": "text",
          "remote_id": "text"
        },
        "managers": [
          {
            "pk": 928,
            "user": {
              "email": "adele.bouvet@gmail.com",
              "first_name": "Adèle",
              "last_name": "Bouvet"
            },
            "display_name": "text",
            "role": "text"
          }
        ],
        "has_loggable_managers": true
      },
      "first_name": "Adèle",
      "last_name": "Bouvet",
      "email": "adele.bouvet@gmail.com",
      "phone_number": "+33600000000",
      "fax_number": "text",
      "remote_id": "CONTACT_123",
      "is_manager": true,
      "has_pending_invite": true,
      "is_invitable": true,
      "invitation_link": "text"
    }
  ],
  "has_pending_invites": true,
  "primary_address": {
    "pk": 23498,
    "name": "Transport Bouvet",
    "address": "3 rue des champs",
    "city": "Nantes",
    "postcode": "44000",
    "country": "FR",
    "latitude": -52.5561625,
    "longitude": 92.896504,
    "radius": 500,
    "coords_validated": false,
    "is_demo": true,
    "is_carrier": true,
    "is_shipper": true,
    "is_origin": true,
    "is_destination": true,
    "created_by": {
      "pk": 25,
      "name": "Transport Bouvet"
    },
    "created_by_user": {
      "pk": 34,
      "display_name": "Jean Pierre Bouvet",
      "company": 25,
      "trucker_id": 95
    },
    "created": "2020-12-22T15:31:39.26167Z",
    "instructions": "text",
    "remote_id": "text",
    "company": {
      "pk": 928,
      "remote_id": "text",
      "created": "2020-07-30T21:10:06.445510Z",
      "updated": "2020-07-30T21:10:06.44551Z",
      "deleted": true,
      "invoicing_remote_id": "COMP_456",
      "name": "Transport Bouvet",
      "phone_number": "0601020304",
      "email": "i.love.dashdoc@gmail.com",
      "siren": "123456789",
      "trade_number": "text",
      "country": "FR",
      "comments": "text",
      "vat_number": "text",
      "is_verified": true,
      "settings_transport_order_observations": "text",
      "settings_constrain_reference_edition": true,
      "account_type": "text",
      "logo": "text",
      "subscription_access": {},
      "settings": {},
      "primary_address": {
        "pk": "text",
        "name": "Transport Bouvet",
        "address": "3 rue des champs",
        "city": "Nantes",
        "postcode": "44000",
        "country": "FR",
        "latitude": -52.5561625,
        "longitude": 92.896504,
        "radius": 500,
        "coords_validated": false,
        "is_demo": true,
        "is_carrier": true,
        "is_shipper": true,
        "is_origin": true,
        "is_destination": true,
        "created_by": 1,
        "created": "2020-07-30T21:10:06.44551Z",
        "instructions": "text",
        "remote_id": "text"
      },
      "managers": [
        {
          "pk": 928,
          "user": {
            "email": "adele.bouvet@gmail.com",
            "first_name": "Adèle",
            "last_name": "Bouvet"
          },
          "display_name": "text",
          "role": "text"
        }
      ],
      "has_loggable_managers": true
    }
  },
  "transports_in_last_month": 1,
  "is_verified": true,
  "can_invite_to": true,
  "remote_id": "text",
  "invoicing_remote_id": "COMP_456",
  "notes": "text",
  "tags": [
    {
      "pk": 23498,
      "name": "Remorque"
    }
  ]
}

Partially update a company

patch
Authorizations
Path parameters
pknumberRequired
remote_idstringOptional

If you choose to identify an object with its remote_id instead of its pk then

  • replace the pk value with the remote_id value in the URL

  • specify lookup_field=remote_id in the query parameters

Query parameters
lookup_fieldstringOptional

Used to specify what field is used in the URL to identify the object you're requesting, e.g. with the remote_id (see path parameters)

Body
namestringRequired

Only updatable by the creator of the company, and if the company hasn't subscribed to Dashdoc

Example: Transport Bouvet
phone_numberstringOptional

Only updatable by the creator of the company, and if the company hasn't subscribed to Dashdoc

emailstring · emailOptional

Only updatable by the creator of the company, and if the company hasn't subscribed to Dashdoc

Example: adele.bouvet@gmail.com
sirenstringOptional

Only updatable by the creator of the company, and if the company hasn't subscribed to Dashdoc

trade_numberstringOptional

Only updatable by the creator of the company, and if the company hasn't subscribed to Dashdoc

vat_numberstringOptional

Only updatable by the creator of the company, and if the company hasn't subscribed to Dashdoc

countrystringRequired

Only the 2-character codification is accepted (ISO 3166-1 alpha-2)

Example: FR
remote_idstringOptional

The ID of the company in your system. It has to be unique among all your companies.

invoicing_remote_idstringOptional

The id of the company in your invoicing system.

Example: COMP_456
notesstringOptional

Notes for this company, only visibile to your team members

Responses
200
Update successful
application/json
patch
PATCH /api/v4/companies/{pk}/ HTTP/1.1
Host: api.dashdoc.eu
Authentication: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 666

{
  "name": "Transport Bouvet",
  "phone_number": "text",
  "email": "adele.bouvet@gmail.com",
  "siren": "text",
  "trade_number": "text",
  "vat_number": "text",
  "country": "FR",
  "remote_id": "text",
  "invoicing_remote_id": "COMP_456",
  "notes": "text",
  "primary_address": {
    "pk": "text",
    "name": "Transport Bouvet",
    "address": "3 rue des champs",
    "city": "Nantes",
    "postcode": "44000",
    "country": "FR",
    "latitude": -52.5561625,
    "longitude": 92.896504,
    "radius": 500,
    "coords_validated": false,
    "is_demo": true,
    "is_carrier": true,
    "is_shipper": true,
    "is_origin": true,
    "is_destination": true,
    "created_by": 1,
    "created": "2020-07-30T21:10:06.44551Z",
    "instructions": "text",
    "remote_id": "text"
  },
  "tags": [
    {
      "pk": 23498,
      "name": "Remorque"
    }
  ]
}
200

Update successful

{
  "pk": 928,
  "name": "Transport Bouvet",
  "addresses": [
    {
      "pk": 23498,
      "name": "Transport Bouvet",
      "address": "3 rue des champs",
      "city": "Nantes",
      "postcode": "44000",
      "country": "FR",
      "latitude": -52.5561625,
      "longitude": 92.896504,
      "radius": 500,
      "coords_validated": false,
      "is_demo": true,
      "is_carrier": true,
      "is_shipper": true,
      "is_origin": true,
      "is_destination": true,
      "created_by": {
        "pk": 25,
        "name": "Transport Bouvet"
      },
      "created_by_user": {
        "pk": 34,
        "display_name": "Jean Pierre Bouvet",
        "company": 25,
        "trucker_id": 95
      },
      "created": "2020-12-22T15:31:39.26167Z",
      "remote_id": "text"
    }
  ],
  "phone_number": "text",
  "email": "adele.bouvet@gmail.com",
  "siren": "text",
  "trade_number": "text",
  "vat_number": "text",
  "country": "FR",
  "has_loggable_managers": true,
  "contacts": [
    {
      "uid": "687cddac-dbd2-11ea-9024-0242ac130006",
      "created": "2020-12-22T15:31:39.26167Z",
      "company": {
        "pk": 928,
        "remote_id": "text",
        "created": "2020-07-30T21:10:06.445510Z",
        "updated": "2020-07-30T21:10:06.44551Z",
        "deleted": true,
        "invoicing_remote_id": "COMP_456",
        "name": "Transport Bouvet",
        "phone_number": "0601020304",
        "email": "i.love.dashdoc@gmail.com",
        "siren": "123456789",
        "trade_number": "text",
        "country": "FR",
        "comments": "text",
        "vat_number": "text",
        "is_verified": true,
        "settings_transport_order_observations": "text",
        "settings_constrain_reference_edition": true,
        "account_type": "text",
        "logo": "text",
        "subscription_access": {},
        "settings": {},
        "primary_address": {
          "pk": "text",
          "name": "Transport Bouvet",
          "address": "3 rue des champs",
          "city": "Nantes",
          "postcode": "44000",
          "country": "FR",
          "latitude": -52.5561625,
          "longitude": 92.896504,
          "radius": 500,
          "coords_validated": false,
          "is_demo": true,
          "is_carrier": true,
          "is_shipper": true,
          "is_origin": true,
          "is_destination": true,
          "created_by": 1,
          "created": "2020-07-30T21:10:06.44551Z",
          "instructions": "text",
          "remote_id": "text"
        },
        "managers": [
          {
            "pk": 928,
            "user": {
              "email": "adele.bouvet@gmail.com",
              "first_name": "Adèle",
              "last_name": "Bouvet"
            },
            "display_name": "text",
            "role": "text"
          }
        ],
        "has_loggable_managers": true
      },
      "first_name": "Adèle",
      "last_name": "Bouvet",
      "email": "adele.bouvet@gmail.com",
      "phone_number": "+33600000000",
      "fax_number": "text",
      "remote_id": "CONTACT_123",
      "is_manager": true,
      "has_pending_invite": true,
      "is_invitable": true,
      "invitation_link": "text"
    }
  ],
  "has_pending_invites": true,
  "primary_address": {
    "pk": 23498,
    "name": "Transport Bouvet",
    "address": "3 rue des champs",
    "city": "Nantes",
    "postcode": "44000",
    "country": "FR",
    "latitude": -52.5561625,
    "longitude": 92.896504,
    "radius": 500,
    "coords_validated": false,
    "is_demo": true,
    "is_carrier": true,
    "is_shipper": true,
    "is_origin": true,
    "is_destination": true,
    "created_by": {
      "pk": 25,
      "name": "Transport Bouvet"
    },
    "created_by_user": {
      "pk": 34,
      "display_name": "Jean Pierre Bouvet",
      "company": 25,
      "trucker_id": 95
    },
    "created": "2020-12-22T15:31:39.26167Z",
    "instructions": "text",
    "remote_id": "text",
    "company": {
      "pk": 928,
      "remote_id": "text",
      "created": "2020-07-30T21:10:06.445510Z",
      "updated": "2020-07-30T21:10:06.44551Z",
      "deleted": true,
      "invoicing_remote_id": "COMP_456",
      "name": "Transport Bouvet",
      "phone_number": "0601020304",
      "email": "i.love.dashdoc@gmail.com",
      "siren": "123456789",
      "trade_number": "text",
      "country": "FR",
      "comments": "text",
      "vat_number": "text",
      "is_verified": true,
      "settings_transport_order_observations": "text",
      "settings_constrain_reference_edition": true,
      "account_type": "text",
      "logo": "text",
      "subscription_access": {},
      "settings": {},
      "primary_address": {
        "pk": "text",
        "name": "Transport Bouvet",
        "address": "3 rue des champs",
        "city": "Nantes",
        "postcode": "44000",
        "country": "FR",
        "latitude": -52.5561625,
        "longitude": 92.896504,
        "radius": 500,
        "coords_validated": false,
        "is_demo": true,
        "is_carrier": true,
        "is_shipper": true,
        "is_origin": true,
        "is_destination": true,
        "created_by": 1,
        "created": "2020-07-30T21:10:06.44551Z",
        "instructions": "text",
        "remote_id": "text"
      },
      "managers": [
        {
          "pk": 928,
          "user": {
            "email": "adele.bouvet@gmail.com",
            "first_name": "Adèle",
            "last_name": "Bouvet"
          },
          "display_name": "text",
          "role": "text"
        }
      ],
      "has_loggable_managers": true
    }
  },
  "transports_in_last_month": 1,
  "is_verified": true,
  "can_invite_to": true,
  "remote_id": "text",
  "invoicing_remote_id": "COMP_456",
  "notes": "text",
  "tags": [
    {
      "pk": 23498,
      "name": "Remorque"
    }
  ]
}