v1

latestOpenAPI 3.1.0Apache 2.02026-07-2498321298.8 KB

Entities

Update entity

Update an entity.

patch/financial-data/v2/entities/{id}

Path parameters

idstring required

Atlar resource ID.

Headers

If-Matchstring

ETag (version) of resource to be updated.

Response

The updated entity.

idstring required

Unique resource identifier.

organizationIdstring required

Unique resource identifier for an Organization.

parentIdstring

This optional field identifies a parent entity, indicating this entity is a subsidiary or branch to the parent. A missing Parent Entity ID implies the entity is without parent company.

legalNamestring required

Legal name of the entity. E.g. your company's legal business name.

createdstring date-time required

Time at which the resource was created.

updatedstring date-time required

Time at which the resource was last updated.

versioninteger required

Resource version. Starts at value 1 when the resource is created and increases by one for each successive update.

Example response

{
  "id": "ce474c91-c09f-4200-81f8-0be97e1cda47",
  "organizationId": "6ee651dd-8982-4359-a9a7-7cd6bd1d8c41",
  "legalName": "Example Company GmbH",
  "created": "2023-04-14T12:31:12.889104898Z",
  "updated": "2023-04-14T12:31:12.889104898Z",
  "version": 1
}