v1

latestOpenAPI 3.0.12026-07-144840447.2 KB

Companies

Show company

This endpoint returns the details of a company related to the firm.

ℹ️ This endpoint requires the following scope: companies:readonly

get/api/external/firm/v1/companies/{id}

Path parameters

idstring required

Existing company identifier (id)

Response

A company

idinteger required

Company's unique identifier

namestring required

Company's legal name.

billing_company_namestring required

Company's trade name.

sirenstring required

Company's SIREN

addressstring required

The number and street address of the company.

citystring required

The city the company is in.

postal_codestring required

The postal/zip code of the company.

activity_nomenclaturestring required

The activity nomenclature code, e.g. "code NAF" in France.

activity_codestring required

The activity code.

external_idstring required

The external identifier of the company.

client_codestring required

Client code of the company

Example response

{
  "id": 22938,
  "name": "Koss Inc.",
  "billing_company_name": "Koss",
  "siren": "362521879",
  "address": "35508 Mary Plain",
  "city": "Jefferson City",
  "postal_code": "77379",
  "activity_nomenclature": "NAFRev2",
  "activity_code": "1234A",
  "external_id": "G6YYYLPXIZ",
  "client_code": "DOSSIER_ABC"
}