Update a Pay Item

Updates a pay item. Editing a pay item archives the existing one and creates a new one with a new id — use the response's replaced_ids to reconcile with the id you had stored. Only the fields provided are changed.
Cannot update pay items linked to a payroll adjustment, salary pay items, pay items automatically created from an external source, or pay items whose payroll run is no longer in preparation.

Scopes

CategoryRead only ScopeWrite only Scope (read access implicit)
Manage payroll runs (payroll)-Manage pay items (pay_item:write)
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
uuid
required

Pay item ID

Body Params

Pay Item

Partial update — only the fields provided are changed. Editing amount or effective_date archives the existing pay item and creates a new one with a new id; use the response's replaced_ids to reconcile. Editing provider_data alone updates the pay item in place and keeps the same id.

integer

Value of the pay item. See PayItemParams.amount for unit details. Must be non-zero; negative values are allowed for corrections.

date

Working day date (YYYY-MM-DD)

provider_data
object
Responses

Callback
Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json