v50

latestOpenAPI 3.1.0raw.githubusercontent.com2026-07-2148120293.6 KB

Payroll

Update Rule

Update a rule for a pay statement item.

put/employer/pay-statement-item/rule/{rule_id}

entity_idsstring[]

The entity IDs to update the rule for. Provide exactly one entity ID per request; a maximum of one is accepted.

[
  "550e8400-e29b-41d4-a716-446655440000"
]

Finch-API-Versionstring date required

Header used to specify the version for a given API request. Current version is 2020-09-17.

Content-Typestring required

Used to indicate the original media type of the resource

{"stackTrail":"components:schemas:UpdateRuleRequest:properties:optionalProperty","oasType":"schema","type":"unknown"}

Successfully Updated

idstring uuid

Finch id (uuidv4) for the rule.

priorityinteger

The priority of the rule.

created_atstring date-time

The datetime when the rule was created.

updated_atstring date-time

The datetime when the rule was last updated.

effective_start_datestring nullable

effective_end_datestring nullable

entity_type'pay_statement_item'

The entity type to which the rule is applied.