ATatlar
GL Classifications

Update classification

Changed on

Update a GL classification using JSON Patch. The name, GL entities and inactive state can be changed. Retire a value that is no longer available in your ERP by setting inactive to true, as classifications cannot be deleted. Values that Atlar syncs from a connected ERP may be overwritten by that sync.

patch/accounting/v2beta/gl-classifications/{id}

Request

Path parameters

idstring required

Atlar resource ID.

Headers

If-Matchstring

ETag (version) of resource to be updated.

Request body

Response

The updated GL classification.

idstring required

Unique resource identifier.

organizationIdstring required

Unique resource identifier for an Organization.

thirdPartyIdstring

ID of the third party (ERP) the classification originates from. Omitted if the integration has no third party.

vendorValueIdstring required

ID of the classification value in the ERP.

namestring required

Human-readable name of the classification value, as shown in the ERP.

glEntityIdsstring[]

GL entity ids this value may be used with. Empty means all GL entities in the organization (restricted principals cannot create or widen to org-wide scope).

inactiveboolean required

Whether the value is inactive in the ERP. Inactive classifications remain addressable by id; retire obsolete values with inactive true instead of deleting.

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

{
  "id": "2ed9a3ee-60aa-4f9f-a858-2eed4eefbbc8",
  "organizationId": "0160f6ab-5741-49e1-af46-9138927e547e",
  "thirdPartyId": "9a8b1372-5c80-44a5-81a9-553a34041eb7",
  "type": {
    "type": "cseg_region",
    "name": "Class",
    "fieldKey": "cseg_region"
  },
  "name": "EMEA Sales",
  "version": 1,
  "etag": "version:3",
  "created": "2022-05-04T18:31:12.889104898Z",
  "updated": "2022-05-04T18:47:32.213842599Z"
}

Changes