Classifications

Update classification (partial)

Changed on

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.

To rename and deactivate a classification, send:

{"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.

Side effects

  • If a selection you create or change matches an approval workflow, DualEntry can change that selection's is_active.
patch/public/v1/classifications/{classification_id}/

Request

  • Base URL: https://api.dualentry.com
  • URL: https://api.dualentry.com/public/v1/classifications/{classification_id}/
  • Auth: none declared

Path parameters

classification_idinteger required

Headers

Idempotency-Keystring

Optional. A unique value (a UUID works well) identifying this operation. If the request is repeated with the same key, the original response is replayed instead of the operation running again, so a retry cannot create a duplicate record. Results are replayable for 48 hours. Reusing a key with a different request body returns 422.

Request body

namestring nullable
is_activeboolean nullable
required_for_recordsPublicClassifiableRecords[] nullable
parent_idinteger nullable

Response

OK

created_atstring date-time required

Date and time the record was created

updated_atstring date-time required

Date and time the record was last updated

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

Changes

  • 6a577e8a2e32Revision changes
    • warning

      added the new customer_payment enum value to the / response property for the response status

    • warning

      added the new item enum value to the / response property for the response status

    • info

      added the new customer_payment enum value to the request property /

    • info

      added the new item enum value to the request property /

  • cd2bd4d748dfRevision changes
    • warning

      added the new customer enum value to the / response property for the response status

    • warning

      added the new vendor enum value to the / response property for the response status

    • info

      added the new customer enum value to the request property /

    • info

      added the new vendor enum value to the request property /

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status