v1

latestOpenAPI 3.0.02026-07-2494288373.8 KB

Companies

Update a company

Updates the company with the given ID.

patch/v1/companies/{id}

Path parameters

idstring uuid required

Id of the company

Request body

namestring

Name for the company (at most 160 characters).

commercial_namestring nullable

Commercial name for the company (at most 160 characters).

registration_numberstring nullable

registration_datestring date nullable

Date in format ISO 8601(yyyy-MM-dd eg 2023-01-31)

status'live' | 'closed' | 'not_reported'

legal_formstring nullable

entity_legal_formstring nullable

ISO 20275 code (eg: 6CHY)

countrystring alpha-2 nullable

ISO 3166-1 alpha-2 country code (eg FR)

share_capitalstring nullable

tax_identification_numberstring nullable

website_urlstring nullable

employer_identification_numberstring nullable

custom_propertiesobject

Optional partial custom properties object in a format of key (string) / value (string | boolean | string[] | number | null) to update the company.

Archived custom properties are not accepted.

Example request

{
  "banking_information": {
    "iban": "FR7630006000011234567890189",
    "bic": "AGRIFRPPXXX"
  },
  "custom_properties": {
    "custom_text": "Custom properties text",
    "custom_boolean": true,
    "custom_date": "2012-12-12",
    "custom_countries": [
      "FR"
    ],
    "custom_choices": [
      "option1",
      "option2"
    ],
    "custom_numeric": 12.3,
    "custom_property": null
  }
}

Response

Returns information of the updated company

ℹ️ Click to see full payload

idstring uuid required

case_idstring uuid required

type'main' | 'affiliated' required

namestring required

is_relevantboolean required

commercial_namestring nullable required

countrystring alpha-2 nullable required

ISO 3166-1 alpha-2 country code (eg FR)

registration_numberstring nullable required

registration_datestring date nullable required

Date in format ISO 8601(yyyy-MM-dd eg 2023-01-31)

status'live' | 'closed' | 'not_reported' required

legal_formstring nullable required

entity_legal_formstring nullable required

ISO 20275 code (eg: 6CHY)

entity_legal_form_labelstring nullable required

Label in the origin country language of the ISO 20275 code.
May contains multiple labels separated with a comma , when the code is assigned to multiple label in different languages.

share_capitalstring nullable required

tax_identification_numberstring nullable required

website_urlstring nullable required

employer_identification_numberstring nullable required

custom_propertiesobject required

Custom properties object in a format of key (string) / value (string | boolean | string[] | number | null) to read the company.

Archived custom properties are omitted.

created_atstring date-time required

Creation date
Date time in format ISO 8601 (yyyy-MM-ddTHH:mm:ss.S+X eg 2023-01-31T13:30:00.000Z)

updated_atstring date-time required

Latest update date
Date time in format ISO 8601 (yyyy-MM-ddTHH:mm:ss.S+X eg 2023-01-31T13:30:00.000Z)

last_activity_atstring date-time required

Latest activity date
Date time in format ISO 8601 (yyyy-MM-ddTHH:mm:ss.S+X eg 2023-01-31T13:30:00.000Z)

property_originsobject

Property origin details keyed by property path, returned only when property_origin=true is provided.

Example response

{
  "banking_information": {
    "iban": "FR7630006000011234567890189",
    "bic": "AGRIFRPPXXX"
  },
  "custom_properties": {
    "custom_text": "Custom properties text",
    "custom_boolean": true,
    "custom_date": "2012-12-12",
    "custom_countries": [
      "FR"
    ],
    "custom_choices": [
      "option1",
      "option2"
    ],
    "custom_numeric": 12.3,
    "custom_property": null
  }
}