ATatlar
GL Classifications

Find classification

Changed on

Find a single GL classification by type, third party ID and vendor value ID. Use this to check whether a value from your ERP already exists before creating or updating it. Omit thirdPartyId to find a classification that was created without one.

post/accounting/v2beta/gl-classifications:find

Request

Request body

typestring required

Identifies the kind of ERP-specific classification. This is a free string, stored as the ERP reports it:

  • NetSuite built-in classifications are CLASS, DEPARTMENT and LOCATION.
  • NetSuite custom segments use the raw field key, for example cseg_region.
  • Business Central uses the dimension code.
thirdPartyIdstring

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

vendorValueIdstring required

ID of the classification value in the ERP.

Example request

{
  "type": "cseg_region",
  "thirdPartyId": "9a8b1372-5c80-44a5-81a9-553a34041eb7"
}

Response

A 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