Sign in

v1

latestOpenAPI 3.1.0Apache 2.02026-07-2498321298.8 KB
GL Entities

Create entity

Create a new GL entity.

post/accounting/v2beta/gl-entities

Request body

currencystring

Three-letter ISO 4217 currency code.

externalIdstring required

External ID is optional to use, but if used, the Atlar platform will persist it, index it, as well as require it to be unique across all resources. It is possible to retrieve a resource using the external ID using the prefix external:.

namestring required

The name of the GL entity.

thirdPartyIdstring

ID of the associated third-party, e.g. the ERP in which the account is held.

Example request

{
  "currency": "EUR",
  "externalId": "walVNuin6X5Mvte4xhg1ibTAVSACfN4Q9hl",
  "name": "Acme Inc.",
  "thirdPartyId": "9a8b1372-5c80-44a5-81a9-553a34041eb7"
}

Response

The created GL entity.

currencystring

Three-letter ISO 4217 currency code.

idstring required

Unique resource identifier.

externalIdstring required

External ID is optional to use, but if used, the Atlar platform will persist it, index it, as well as require it to be unique across all resources. It is possible to retrieve a resource using the external ID using the prefix external:.

organizationIdstring required

Unique resource identifier for an Organization.

entityIdstring

Unique resource identifier.

thirdPartyIdstring

ID of the associated third-party, e.g. the ERP in which the entity is held.

namestring required

The name of the GL entity.

versioninteger required

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

etagstring required

ETag based on the resource version. This can be passed along in If-Match HTTP header when updating a resource to perform a conditional update.

createdstring date-time required

Time at which the resource was created.

updatedstring date-time required

Time at which the resource was last updated.

Example response

{
  "currency": "EUR",
  "id": "2ed9a3ee-60aa-4f9f-a858-2eed4eefbbc8",
  "externalId": "walVNuin6X5Mvte4xhg1ibTAVSACfN4Q9hl",
  "organizationId": "0160f6ab-5741-49e1-af46-9138927e547e",
  "entityId": "2ed9a3ee-60aa-4f9f-a858-2eed4eefbbc8",
  "thirdPartyId": "9a8b1372-5c80-44a5-81a9-553a34041eb7",
  "name": "Acme Corporation",
  "version": 1,
  "etag": "version:3",
  "created": "2022-05-04T18:31:12.889104898Z",
  "updated": "2022-05-04T18:47:32.213842599Z"
}