Companies
Last updated
Was this helpful?
Last updated
Was this helpful?
/companies/
A page number within the paginated result set.
Case insentive filter on company name
curl -L \
--url 'https://api.dashdoc.eu/api/v4/companies/' \
--header 'Authentication: YOUR_API_KEY'{
"count": 1,
"next": "text",
"previous": "text",
"results": [
{
"pk": 928,
"name": "Transport Bouvet",
"phone_number": "text",
"email": "adele.bouvet@gmail.com",
"siren": "text",
"trade_number": "text",
"vat_number": "text",
"country": "FR",
"has_loggable_managers": true,
"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"
},
"has_loggable_managers": true,
"managers": [
{
"pk": 928,
"user": {
"email": "adele.bouvet@gmail.com",
"first_name": "Adèle",
"last_name": "Bouvet"
},
"display_name": "text",
"role": "text"
}
]
}
},
"transports_in_last_month": 1,
"is_verified": true,
"can_invite_to": true,
"remote_id": "text",
"invoicing_remote_id": "COMP_456",
"notes": "text",
"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"
}
],
"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"
},
"has_loggable_managers": true,
"managers": [
{
"pk": 928,
"user": {
"email": "adele.bouvet@gmail.com",
"first_name": "Adèle",
"last_name": "Bouvet"
},
"display_name": "text",
"role": "text"
}
]
},
"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"
}
]
}
]
}Get successful
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
/companies/
Transport Bouvetadele.bouvet@gmail.comOnly the 2-character codification is accepted (ISO 3166-1 alpha-2)
FRThe ID of the company in your system. It has to be unique among all your companies.
The id of the company in your invoicing system.
COMP_456Notes for this company, only visibile to your team members
curl -L \
--request POST \
--url 'https://api.dashdoc.eu/api/v4/companies/' \
--header 'Authentication: YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data '{"name":"Transport Bouvet","email":"adele.bouvet@gmail.com","country":"FR","invoicing_remote_id":"COMP_456","primary_address":{"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,"created":"2020-07-30T21:10:06.44551Z"}}'{
"pk": 928,
"name": "Transport Bouvet",
"phone_number": "text",
"email": "adele.bouvet@gmail.com",
"siren": "text",
"trade_number": "text",
"vat_number": "text",
"country": "FR",
"has_loggable_managers": true,
"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"
},
"has_loggable_managers": true,
"managers": [
{
"pk": 928,
"user": {
"email": "adele.bouvet@gmail.com",
"first_name": "Adèle",
"last_name": "Bouvet"
},
"display_name": "text",
"role": "text"
}
]
}
},
"transports_in_last_month": 1,
"is_verified": true,
"can_invite_to": true,
"remote_id": "text",
"invoicing_remote_id": "COMP_456",
"notes": "text",
"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"
}
],
"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"
},
"has_loggable_managers": true,
"managers": [
{
"pk": 928,
"user": {
"email": "adele.bouvet@gmail.com",
"first_name": "Adèle",
"last_name": "Bouvet"
},
"display_name": "text",
"role": "text"
}
]
},
"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"
}
]
}Create successful
/companies/{pk}//
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
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)
curl -L \
--url 'https://api.dashdoc.eu/api/v4/companies/{pk}/' \
--header 'Authentication: YOUR_API_KEY'{
"pk": 928,
"name": "Transport Bouvet",
"phone_number": "text",
"email": "adele.bouvet@gmail.com",
"siren": "text",
"trade_number": "text",
"vat_number": "text",
"country": "FR",
"has_loggable_managers": true,
"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"
},
"has_loggable_managers": true,
"managers": [
{
"pk": 928,
"user": {
"email": "adele.bouvet@gmail.com",
"first_name": "Adèle",
"last_name": "Bouvet"
},
"display_name": "text",
"role": "text"
}
]
}
},
"transports_in_last_month": 1,
"is_verified": true,
"can_invite_to": true,
"remote_id": "text",
"invoicing_remote_id": "COMP_456",
"notes": "text",
"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"
}
],
"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"
},
"has_loggable_managers": true,
"managers": [
{
"pk": 928,
"user": {
"email": "adele.bouvet@gmail.com",
"first_name": "Adèle",
"last_name": "Bouvet"
},
"display_name": "text",
"role": "text"
}
]
},
"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"
}
]
}Get successful
/companies/{pk}//
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
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)
Only updatable by the creator of the company, and if the company hasn't subscribed to Dashdoc
Transport BouvetOnly updatable by the creator of the company, and if the company hasn't subscribed to Dashdoc
Only updatable by the creator of the company, and if the company hasn't subscribed to Dashdoc
adele.bouvet@gmail.comOnly updatable by the creator of the company, and if the company hasn't subscribed to Dashdoc
Only updatable by the creator of the company, and if the company hasn't subscribed to Dashdoc
Only updatable by the creator of the company, and if the company hasn't subscribed to Dashdoc
Only the 2-character codification is accepted (ISO 3166-1 alpha-2)
FRThe ID of the company in your system. It has to be unique among all your companies.
The id of the company in your invoicing system.
COMP_456Notes for this company, only visibile to your team members
curl -L \
--request PATCH \
--url 'https://api.dashdoc.eu/api/v4/companies/{pk}/' \
--header 'Authentication: YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data '{"name":"Transport Bouvet","email":"adele.bouvet@gmail.com","country":"FR","invoicing_remote_id":"COMP_456","primary_address":{"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,"created":"2020-07-30T21:10:06.44551Z"}}'{
"pk": 928,
"name": "Transport Bouvet",
"phone_number": "text",
"email": "adele.bouvet@gmail.com",
"siren": "text",
"trade_number": "text",
"vat_number": "text",
"country": "FR",
"has_loggable_managers": true,
"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"
},
"has_loggable_managers": true,
"managers": [
{
"pk": 928,
"user": {
"email": "adele.bouvet@gmail.com",
"first_name": "Adèle",
"last_name": "Bouvet"
},
"display_name": "text",
"role": "text"
}
]
}
},
"transports_in_last_month": 1,
"is_verified": true,
"can_invite_to": true,
"remote_id": "text",
"invoicing_remote_id": "COMP_456",
"notes": "text",
"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"
}
],
"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"
},
"has_loggable_managers": true,
"managers": [
{
"pk": 928,
"user": {
"email": "adele.bouvet@gmail.com",
"first_name": "Adèle",
"last_name": "Bouvet"
},
"display_name": "text",
"role": "text"
}
]
},
"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"
}
]
}Update successful