Companies

Companies list

GEThttps://api.dashdoc.eu/api/v4/companies/

Query parameters

Response

Get successful

Body

countinteger

Example: 1

nextnullable string

previousnullable string

resultsarray of FullCompany (object)

Request

const response = await fetch('https://api.dashdoc.eu/api/v4/companies/', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "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,
          "coords_validated": false,
          "is_demo": false,
          "is_carrier": false,
          "is_shipper": false,
          "is_origin": false,
          "is_destination": false,
          "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": false,
      "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": false,
            "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": false,
            "settings_transport_order_observations": "text",
            "settings_constrain_reference_edition": false,
            "account_type": "text",
            "logo": "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,
              "coords_validated": false,
              "is_demo": false,
              "is_carrier": false,
              "is_shipper": false,
              "is_origin": false,
              "is_destination": false,
              "created_by": 0,
              "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": false
          },
          "first_name": "Adèle",
          "last_name": "Bouvet",
          "email": "adele.bouvet@gmail.com",
          "phone_number": "+33600000000",
          "fax_number": "text",
          "remote_id": "CONTACT_123",
          "is_manager": false,
          "has_pending_invite": false,
          "is_invitable": false,
          "invitation_link": "text"
        }
      ],
      "has_pending_invites": false,
      "primary_address": {
        "pk": 23498,
        "name": "Transport Bouvet",
        "address": "3 rue des champs",
        "city": "Nantes",
        "postcode": "44000",
        "country": "FR",
        "latitude": -52.5561625,
        "longitude": 92.896504,
        "coords_validated": false,
        "is_demo": false,
        "is_carrier": false,
        "is_shipper": false,
        "is_origin": false,
        "is_destination": false,
        "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": false,
          "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": false,
          "settings_transport_order_observations": "text",
          "settings_constrain_reference_edition": false,
          "account_type": "text",
          "logo": "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,
            "coords_validated": false,
            "is_demo": false,
            "is_carrier": false,
            "is_shipper": false,
            "is_origin": false,
            "is_destination": false,
            "created_by": 0,
            "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": false
        }
      },
      "is_verified": false,
      "can_invite_to": false,
      "remote_id": "text",
      "invoicing_remote_id": "COMP_456",
      "notes": "text"
    }
  ]
}

Create a company

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

POSThttps://api.dashdoc.eu/api/v4/companies/

Body

name*string

Example: "Transport Bouvet"

phone_numberstring

emailstring (email)

Example: "adele.bouvet@gmail.com"

sirenstring

trade_numberstring

vat_numberstring

country*country (string)

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

Example: "FR"

remote_idstring

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

invoicing_remote_idstring

The id of the company in your invoicing system.

Example: "COMP_456"

notesstring

Notes for this company, only visibile to your team members

primary_addressAddressForCompany (object)

Response

Create successful

Body

pknumber

Dashdoc's internal id.

Example: 928

namestring

Example: "Transport Bouvet"

addressesarray of AddressForCompany_1 (object)

phone_numberstring

emailstring (email)

Example: "adele.bouvet@gmail.com"

sirenstring

trade_numberstring

vat_numberstring

countrycountry (string)

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

Example: "FR"

has_loggable_managersboolean

Ignore. Dashdoc technical data.

contactsarray of Contact (object)

has_pending_invitesboolean

Ignore. Dashdoc technical data.

primary_addressAddress (object)

transports_in_last_monthinteger

Ignore. Dashdoc technical data.

is_verifiedboolean

Ignore. Dashdoc technical data.

can_invite_toboolean

Ignore. Dashdoc technical data.

remote_idstring

The id of the company in your system.

invoicing_remote_idstring

The id of the company in your invoicing system.

Example: "COMP_456"

notesstring

Notes for this company, only visibile to your team members

Request

const response = await fetch('https://api.dashdoc.eu/api/v4/companies/', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "country": "FR",
      "name": "Transport Bouvet"
    }),
});
const data = await response.json();

Response

{
  "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,
      "coords_validated": false,
      "is_demo": false,
      "is_carrier": false,
      "is_shipper": false,
      "is_origin": false,
      "is_destination": false,
      "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": false,
  "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": false,
        "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": false,
        "settings_transport_order_observations": "text",
        "settings_constrain_reference_edition": false,
        "account_type": "text",
        "logo": "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,
          "coords_validated": false,
          "is_demo": false,
          "is_carrier": false,
          "is_shipper": false,
          "is_origin": false,
          "is_destination": false,
          "created_by": 0,
          "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": false
      },
      "first_name": "Adèle",
      "last_name": "Bouvet",
      "email": "adele.bouvet@gmail.com",
      "phone_number": "+33600000000",
      "fax_number": "text",
      "remote_id": "CONTACT_123",
      "is_manager": false,
      "has_pending_invite": false,
      "is_invitable": false,
      "invitation_link": "text"
    }
  ],
  "has_pending_invites": false,
  "primary_address": {
    "pk": 23498,
    "name": "Transport Bouvet",
    "address": "3 rue des champs",
    "city": "Nantes",
    "postcode": "44000",
    "country": "FR",
    "latitude": -52.5561625,
    "longitude": 92.896504,
    "coords_validated": false,
    "is_demo": false,
    "is_carrier": false,
    "is_shipper": false,
    "is_origin": false,
    "is_destination": false,
    "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": false,
      "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": false,
      "settings_transport_order_observations": "text",
      "settings_constrain_reference_edition": false,
      "account_type": "text",
      "logo": "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,
        "coords_validated": false,
        "is_demo": false,
        "is_carrier": false,
        "is_shipper": false,
        "is_origin": false,
        "is_destination": false,
        "created_by": 0,
        "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": false
    }
  },
  "is_verified": false,
  "can_invite_to": false,
  "remote_id": "text",
  "invoicing_remote_id": "COMP_456",
  "notes": "text"
}

Read a company

GEThttps://api.dashdoc.eu/api/v4/companies/{pk}/

Path parameters

pk*number

remote_idstring

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

Response

Get successful

Body

pknumber

Dashdoc's internal id.

Example: 928

namestring

Example: "Transport Bouvet"

addressesarray of AddressForCompany_1 (object)

phone_numberstring

emailstring (email)

Example: "adele.bouvet@gmail.com"

sirenstring

trade_numberstring

vat_numberstring

countrycountry (string)

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

Example: "FR"

has_loggable_managersboolean

Ignore. Dashdoc technical data.

contactsarray of Contact (object)

has_pending_invitesboolean

Ignore. Dashdoc technical data.

primary_addressAddress (object)

transports_in_last_monthinteger

Ignore. Dashdoc technical data.

is_verifiedboolean

Ignore. Dashdoc technical data.

can_invite_toboolean

Ignore. Dashdoc technical data.

remote_idstring

The id of the company in your system.

invoicing_remote_idstring

The id of the company in your invoicing system.

Example: "COMP_456"

notesstring

Notes for this company, only visibile to your team members

Request

const response = await fetch('https://api.dashdoc.eu/api/v4/companies/{pk}/', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "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,
      "coords_validated": false,
      "is_demo": false,
      "is_carrier": false,
      "is_shipper": false,
      "is_origin": false,
      "is_destination": false,
      "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": false,
  "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": false,
        "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": false,
        "settings_transport_order_observations": "text",
        "settings_constrain_reference_edition": false,
        "account_type": "text",
        "logo": "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,
          "coords_validated": false,
          "is_demo": false,
          "is_carrier": false,
          "is_shipper": false,
          "is_origin": false,
          "is_destination": false,
          "created_by": 0,
          "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": false
      },
      "first_name": "Adèle",
      "last_name": "Bouvet",
      "email": "adele.bouvet@gmail.com",
      "phone_number": "+33600000000",
      "fax_number": "text",
      "remote_id": "CONTACT_123",
      "is_manager": false,
      "has_pending_invite": false,
      "is_invitable": false,
      "invitation_link": "text"
    }
  ],
  "has_pending_invites": false,
  "primary_address": {
    "pk": 23498,
    "name": "Transport Bouvet",
    "address": "3 rue des champs",
    "city": "Nantes",
    "postcode": "44000",
    "country": "FR",
    "latitude": -52.5561625,
    "longitude": 92.896504,
    "coords_validated": false,
    "is_demo": false,
    "is_carrier": false,
    "is_shipper": false,
    "is_origin": false,
    "is_destination": false,
    "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": false,
      "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": false,
      "settings_transport_order_observations": "text",
      "settings_constrain_reference_edition": false,
      "account_type": "text",
      "logo": "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,
        "coords_validated": false,
        "is_demo": false,
        "is_carrier": false,
        "is_shipper": false,
        "is_origin": false,
        "is_destination": false,
        "created_by": 0,
        "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": false
    }
  },
  "is_verified": false,
  "can_invite_to": false,
  "remote_id": "text",
  "invoicing_remote_id": "COMP_456",
  "notes": "text"
}

Partially update a company

PATCHhttps://api.dashdoc.eu/api/v4/companies/{pk}/

Path parameters

pk*number

remote_idstring

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

Body

name*string

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

Example: "Transport Bouvet"

phone_numberstring

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

emailstring (email)

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

Example: "adele.bouvet@gmail.com"

sirenstring

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

trade_numberstring

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

vat_numberstring

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

country*country (string)

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

Example: "FR"

remote_idstring

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

invoicing_remote_idstring

The id of the company in your invoicing system.

Example: "COMP_456"

notesstring

Notes for this company, only visibile to your team members

primary_addressAddressForCompany (object)

Response

Update successful

Body

pknumber

Dashdoc's internal id.

Example: 928

namestring

Example: "Transport Bouvet"

addressesarray of AddressForCompany_1 (object)

phone_numberstring

emailstring (email)

Example: "adele.bouvet@gmail.com"

sirenstring

trade_numberstring

vat_numberstring

countrycountry (string)

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

Example: "FR"

has_loggable_managersboolean

Ignore. Dashdoc technical data.

contactsarray of Contact (object)

has_pending_invitesboolean

Ignore. Dashdoc technical data.

primary_addressAddress (object)

transports_in_last_monthinteger

Ignore. Dashdoc technical data.

is_verifiedboolean

Ignore. Dashdoc technical data.

can_invite_toboolean

Ignore. Dashdoc technical data.

remote_idstring

The id of the company in your system.

invoicing_remote_idstring

The id of the company in your invoicing system.

Example: "COMP_456"

notesstring

Notes for this company, only visibile to your team members

Request

const response = await fetch('https://api.dashdoc.eu/api/v4/companies/{pk}/', {
    method: 'PATCH',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "country": "FR",
      "name": "Transport Bouvet"
    }),
});
const data = await response.json();

Response

{
  "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,
      "coords_validated": false,
      "is_demo": false,
      "is_carrier": false,
      "is_shipper": false,
      "is_origin": false,
      "is_destination": false,
      "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": false,
  "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": false,
        "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": false,
        "settings_transport_order_observations": "text",
        "settings_constrain_reference_edition": false,
        "account_type": "text",
        "logo": "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,
          "coords_validated": false,
          "is_demo": false,
          "is_carrier": false,
          "is_shipper": false,
          "is_origin": false,
          "is_destination": false,
          "created_by": 0,
          "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": false
      },
      "first_name": "Adèle",
      "last_name": "Bouvet",
      "email": "adele.bouvet@gmail.com",
      "phone_number": "+33600000000",
      "fax_number": "text",
      "remote_id": "CONTACT_123",
      "is_manager": false,
      "has_pending_invite": false,
      "is_invitable": false,
      "invitation_link": "text"
    }
  ],
  "has_pending_invites": false,
  "primary_address": {
    "pk": 23498,
    "name": "Transport Bouvet",
    "address": "3 rue des champs",
    "city": "Nantes",
    "postcode": "44000",
    "country": "FR",
    "latitude": -52.5561625,
    "longitude": 92.896504,
    "coords_validated": false,
    "is_demo": false,
    "is_carrier": false,
    "is_shipper": false,
    "is_origin": false,
    "is_destination": false,
    "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": false,
      "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": false,
      "settings_transport_order_observations": "text",
      "settings_constrain_reference_edition": false,
      "account_type": "text",
      "logo": "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,
        "coords_validated": false,
        "is_demo": false,
        "is_carrier": false,
        "is_shipper": false,
        "is_origin": false,
        "is_destination": false,
        "created_by": 0,
        "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": false
    }
  },
  "is_verified": false,
  "can_invite_to": false,
  "remote_id": "text",
  "invoicing_remote_id": "COMP_456",
  "notes": "text"
}

PreviousTransport Operation Categories NextContacts

Last updated 1 year ago

Create a company

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

POSThttps://api.dashdoc.eu/api/v4/companies/

const response = await fetch('https://api.dashdoc.eu/api/v4/companies/', { method: 'POST', headers: { "Content-Type": "application/json" }, body: JSON.stringify({ "country": "FR", "name": "Transport Bouvet" }), }); const data = await response.json();

{ "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, "coords_validated": false, "is_demo": false, "is_carrier": false, "is_shipper": false, "is_origin": false, "is_destination": false, "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": false, "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": false, "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": false, "settings_transport_order_observations": "text", "settings_constrain_reference_edition": false, "account_type": "text", "logo": "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, "coords_validated": false, "is_demo": false, "is_carrier": false, "is_shipper": false, "is_origin": false, "is_destination": false, "created_by": 0, "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": false }, "first_name": "Adèle", "last_name": "Bouvet", "email": "adele.bouvet@gmail.com", "phone_number": "+33600000000", "fax_number": "text", "remote_id": "CONTACT_123", "is_manager": false, "has_pending_invite": false, "is_invitable": false, "invitation_link": "text" } ], "has_pending_invites": false, "primary_address": { "pk": 23498, "name": "Transport Bouvet", "address": "3 rue des champs", "city": "Nantes", "postcode": "44000", "country": "FR", "latitude": -52.5561625, "longitude": 92.896504, "coords_validated": false, "is_demo": false, "is_carrier": false, "is_shipper": false, "is_origin": false, "is_destination": false, "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": false, "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": false, "settings_transport_order_observations": "text", "settings_constrain_reference_edition": false, "account_type": "text", "logo": "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, "coords_validated": false, "is_demo": false, "is_carrier": false, "is_shipper": false, "is_origin": false, "is_destination": false, "created_by": 0, "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": false } }, "is_verified": false, "can_invite_to": false, "remote_id": "text", "invoicing_remote_id": "COMP_456", "notes": "text" }

{ "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, "coords_validated": false, "is_demo": false, "is_carrier": false, "is_shipper": false, "is_origin": false, "is_destination": false, "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": false, "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": false, "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": false, "settings_transport_order_observations": "text", "settings_constrain_reference_edition": false, "account_type": "text", "logo": "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, "coords_validated": false, "is_demo": false, "is_carrier": false, "is_shipper": false, "is_origin": false, "is_destination": false, "created_by": 0, "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": false }, "first_name": "Adèle", "last_name": "Bouvet", "email": "adele.bouvet@gmail.com", "phone_number": "+33600000000", "fax_number": "text", "remote_id": "CONTACT_123", "is_manager": false, "has_pending_invite": false, "is_invitable": false, "invitation_link": "text" } ], "has_pending_invites": false, "primary_address": { "pk": 23498, "name": "Transport Bouvet", "address": "3 rue des champs", "city": "Nantes", "postcode": "44000", "country": "FR", "latitude": -52.5561625, "longitude": 92.896504, "coords_validated": false, "is_demo": false, "is_carrier": false, "is_shipper": false, "is_origin": false, "is_destination": false, "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": false, "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": false, "settings_transport_order_observations": "text", "settings_constrain_reference_edition": false, "account_type": "text", "logo": "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, "coords_validated": false, "is_demo": false, "is_carrier": false, "is_shipper": false, "is_origin": false, "is_destination": false, "created_by": 0, "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": false } }, "is_verified": false, "can_invite_to": false, "remote_id": "text", "invoicing_remote_id": "COMP_456", "notes": "text" } ] }

const response = await fetch('https://api.dashdoc.eu/api/v4/companies/{pk}/', { method: 'PATCH', headers: { "Content-Type": "application/json" }, body: JSON.stringify({ "country": "FR", "name": "Transport Bouvet" }), }); const data = await response.json();