v4

latestOpenAPI 3.1.02026-08-032294621.7 MB
Classifications

Update classification (partial)

Update specific fields on a classification. Send only the fields you want to change — anything you don't send stays as it is. Use null on parent_id to remove a parent.

Example — rename and deactivate a classification:

{"name": "Department (legacy)", "is_active": false}

Selections (classification lines)

Omitting selections preserves the existing lines. Sending the field applies it as-is: lines whose id you include are kept (and updated with whatever values you send), and lines whose id you omit are deleted. Sending [] removes every line. Adding a new line means sending it without an id:

{"selections": [
  {"id": 42, "name": "Engineering", "is_active": true, "parent_id": null},
  {"name": "Operations", "is_active": true, "parent_id": null}
]}

Required-for-records

Omitting required_for_records preserves existing associations. Sending the field replaces the full set; sending [] removes them all:

{"required_for_records": ["invoice", "bill"]}

Lines that are in use elsewhere can't be deleted; you'll get a 422 back listing which ones.

patch/public/v2/classifications/{classification_id}/

Path parameters

classification_idinteger required

Request body

namestring nullable
is_activeboolean nullable
required_for_recordsPublicClassifiableRecords[] nullable
parent_idinteger nullable

Response

OK

idinteger required
required_for_recordsPublicClassifiableRecords[] required
parent_idinteger nullable required
parent_namestring nullable required
namestring required
is_activeboolean