Sign in
Payroll

Update Rule

Beta: this endpoint currently serves employers onboarded after March 4th and historical support will be added soon Update a rule for a pay statement item.

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

Headers

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

Request body

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

Response

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.

Changes