STstuut
adjustments

Update

Update an Adjustment

Update an adjustment. System adjustments can be renamed and have ledger accounts configured, but cannot be deleted (only deactivated via is_active=false).

patch/v2/adjustments/{adjustment_id}

Request

  • Base URL
    https://api.stuut.ai (the document declares no server; this is the origin it was published from)
  • Auth
    HTTP bearer

Path parameters

adjustment_idstring required

Request body

namestring nullable
ledger_account_idstring nullable
is_activeboolean nullable
automatedboolean nullable
descriptionstring nullable

Response

Successful Response

created_atstring date-time required
modified_atstring date-time nullable required
idstring required
namestring required

The name of this adjustment type, e.g. 'Stripe Processing Fee'

is_activeboolean required

Whether this adjustment type is active and available for use

is_systemboolean required

Whether this adjustment was created by the system (e.g., during Stripe processing) vs manually by a user

automatedboolean required

Whether this adjustment is automatically applied during payment processing

descriptionstring nullable required

Optional description for this adjustment type

ledger_account_idstring nullable required

Optional ledger account for accounting integration. When set, this adjustment's allocations will be posted to this ledger account.

objectstring required

String representing the object's type. Objects of the same type share the same value.

can_deleteboolean required

Whether this adjustment can be deleted. System adjustments cannot be deleted, only deactivated.

Changes

No recorded changes to this operation across all 2 revisions of this API.