Companies

Companies list

get
Authorizations
AuthenticationstringRequired

Authentication is token based. You can issue a token for your API request from the 'API' section of the settings menu. The token MUST be sent in a Authorization header with each request.

Example of authenticated request

$ curl -X GET -H "Authorization: Token <your token>" "https://api.dashdoc.eu/api/v4/"
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
/companies/
200

Get successful

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
AuthenticationstringRequired

Authentication is token based. You can issue a token for your API request from the 'API' section of the settings menu. The token MUST be sent in a Authorization header with each request.

Example of authenticated request

$ curl -X GET -H "Authorization: Token <your token>" "https://api.dashdoc.eu/api/v4/"
Body
namestringRequiredExample: Transport Bouvet
phone_numberstringOptional
emailstring · emailOptionalExample: [email protected]
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
post
/companies/
201

Create successful

Read a company

get
Authorizations
AuthenticationstringRequired

Authentication is token based. You can issue a token for your API request from the 'API' section of the settings menu. The token MUST be sent in a Authorization header with each request.

Example of authenticated request

$ curl -X GET -H "Authorization: Token <your token>" "https://api.dashdoc.eu/api/v4/"
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
/companies/{pk}/
200

Get successful

Partially update a company

patch
Authorizations
AuthenticationstringRequired

Authentication is token based. You can issue a token for your API request from the 'API' section of the settings menu. The token MUST be sent in a Authorization header with each request.

Example of authenticated request

$ curl -X GET -H "Authorization: Token <your token>" "https://api.dashdoc.eu/api/v4/"
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: [email protected]
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
/companies/{pk}/
200

Update successful

Last updated

Was this helpful?