Create classification

post

https://api.atlar.com/accounting/v2beta/gl-classifications

Create a GL classification, typically for a value from your ERP. A classification is identified by its type,
thirdPartyId and vendorValueId. Creating an identical classification again returns the existing one with
status 200. Creating one with the same type, thirdPartyId and vendorValueId but a different payload
returns 409. Use :find and then update the existing classification instead.

Every id in glEntityIds must be an existing GL entity. An empty glEntityIds applies the classification to
the whole organization, which principals restricted to specific entities are not allowed to do.

Body Params

Call POST /v2beta/gl-classifications:find with the natural key before create. An identical payload returns 200
with the existing row; the same key with different fields returns 409 — patch the existing classification instead.

vendorValueId

string

required

length between 1 and 64

ID of the classification value in the ERP.

thirdPartyId

string

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

type

object

required

Full ERP type metadata (type, name, fieldKey). All three must match on idempotent create; they determine how values are posted on outgoing lines.

name

string

required

length between 1 and 255

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

glEntityIds

array of strings

GL entity ids this value may be used with. Empty means all GL entities (restricted principals cannot use an empty list on create).

glEntityIds

inactive

boolean

Whether the value is inactive in the ERP. Omit for false.

Responses

Language

Credentials

Basic

base64

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200An identical GL classification already existed and is returned.

201The created GL classification.

400Bad request.

409Conflict.