ATatlar
GL Classifications

List GL classifications

Changed on

Returns a list of GL classifications. For further details on Pagination, see the section above.

get/accounting/v2beta/gl-classifications

Request

Query parameters

typestring

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.
Example:cseg_region

Only include classifications of the specified type.

glEntityIdstring

Unique resource identifier.

Example:2ed9a3ee-60aa-4f9f-a858-2eed4eefbbc8

Filter to classifications applicable to the given GL entity (i.e. with no GL entities, or referencing this one).

namestring

Filter to classifications whose name contains the given substring (case-insensitive). Must be at least 3 characters.

inactiveboolean

Only include classifications with the given inactive state. Omit to include both.

limitinteger

Limit the number of items in resulting query response.

tokenstring

If a query response contains a non-empty nextToken, use that value as token query parameter to continue pagination.

Response

A list of GL classifications.

nextTokenstring required

Pagination token for next page. The value will be a non-empty string if there are more resources to be fetched. The value will be an empty string if there are no more resources to be fetched.

tokenstring required

The pagination token that was used for this request. The value will be an empty string if no token query parameter was provided with the request.

limitinteger required

The page limit that was used for this request.

Example response

{
  "items": [
    {
      "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"
    }
  ],
  "nextToken": "eyIxIjogIlRoaXMgaXMgYSBkdW1teSBwYWdpbmF0aW9uIHRva2VuLiJ9",
  "token": "eyIwIjogIlRoaXMgaXMgYSBkdW1teSBwYWdpbmF0aW9uIHRva2VuLiJ9",
  "limit": 100
}

Changes