---
updatedAt: 2025-10-12T20:28:37.000Z
agentTools:
projectIndex: https://docs.checkhq.com/llms.txt
---
# Update a payroll item
Updates the specified payroll item.
# OpenAPI definition
```json
{
"openapi": "3.1.0",
"info": {
"title": "check-api",
"version": "2025-01-01"
},
"servers": [
{
"url": "https://sandbox.checkhq.com"
}
],
"components": {
"securitySchemes": {
"sec0": {
"type": "apiKey",
"in": "header",
"name": "Authorization",
"x-bearer-format": "bearer",
"x-default": "YOUR_API_KEY"
}
}
},
"security": [
{
"sec0": []
}
],
"paths": {
"/payroll_items/{payroll_item}": {
"patch": {
"summary": "Update a payroll item",
"description": "Updates the specified payroll item.",
"operationId": "update-a-payroll-item",
"parameters": [
{
"name": "payroll_item",
"in": "path",
"schema": {
"type": "string"
},
"required": true
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"payroll": {
"type": "string",
"description": "The payroll ID associated with the payroll item."
},
"payment_method": {
"type": "string",
"description": "May be `manual`, or `direct_deposit` if the employee has a linked bank account."
},
"earnings": {
"type": "array",
"description": "The set of earnings objects associated with the payroll item.",
"items": {
"properties": {
"type": {
"type": "string",
"description": "Type of earning. Can be one of the following earning types in Types of earnings"
},
"workplace": {
"type": "string",
"description": "ID of the workplace where work for this earning was performed"
},
"earning_code": {
"type": "string",
"description": "The earning code id which will be used to aggregate earnings on the paystub"
},
"description": {
"type": "string",
"description": "Readable description of the earning code that will show up on the paystub"
},
"earning_rate": {
"type": "string",
"description": "The earning rate id which will be used to calculate the gross wage. Required if type is “piece”"
},
"amount": {
"type": "string",
"description": "Amount earned for this earning
May be negative, for example to reverse or correct a previously reported earning"
},
"hours": {
"type": "number",
"description": "Number of hours worked for this earning",
"format": "float"
},
"piece_units": {
"type": "number",
"description": "Number of units of work produced. Required if type is “piece”",
"format": "float"
},
"metadata": {
"type": "string",
"description": "Additional loosely structured information to associate with the earning",
"format": "json"
}
},
"required": [
"workplace",
"type",
"amount"
],
"type": "object"
}
},
"reimbursements": {
"type": "array",
"description": "The set of non-taxable reimbursements objects associated with the payroll item.",
"items": {
"properties": {
"amount": {
"type": "string",
"description": "Amount of reimbursement
Must be greater than or equal to 0 on regular payrolls. Negative values are accepted on external payrolls"
},
"description": {
"type": "string",
"description": "Description for the reimbursement that will show up on the paystub"
},
"code": {
"type": "string",
"description": "Unique code to identify the reimbursement that will be used to aggregate reimbursements on the paystub. Recommended to always be included to have explicit groupings on the paystub."
},
"metadata": {
"type": "string",
"description": "Additional loosely structured information to associate with the reimbursement",
"format": "json"
}
},
"required": [
"amount"
],
"type": "object"
}
},
"benefit_overrides": {
"type": "array",
"description": "The set of benefit override objects associated with this payroll item.",
"items": {
"properties": {
"benefit": {
"type": "string",
"description": "ID of the employee benefit that is being overridden for the payroll item"
},
"employee_contribution_amount": {
"type": "string",
"description": "Updated employee contribution amount to use for this payroll only"
},
"company_contribution_amount": {
"type": "string",
"description": "Updated company contribution amount to use for this payroll only"
}
},
"required": [
"benefit"
],
"type": "object"
}
},
"post_tax_deduction_overrides": {
"type": "array",
"description": "The set of benefit override objects associated with this payroll item.",
"items": {
"properties": {
"post_tax_deduction": {
"type": "string",
"description": "ID of the miscellaneous post-tax deduction that is being overridden."
},
"amount": {
"type": "string",
"description": "Updated deduction amount to use for this payroll only"
}
},
"required": [
"post_tax_deduction",
"amount"
],
"type": "object"
}
},
"tax_overrides": {
"type": "array",
"description": "The set of tax override objects associated with this payroll item.",
"items": {
"properties": {
"tax": {
"type": "string",
"description": "ID of the tax being overridden. Only Federal Income Tax and State Income Taxes are eligible."
},
"amount": {
"type": "string",
"description": "Updated withholding amount to use for this payroll only."
}
},
"required": [
"tax",
"amount"
],
"type": "object"
}
},
"pto_balance_hours": {
"type": "number",
"description": "The employee's remaining PTO hour balance, for display on the paystub. Can be updated even after the associated payroll has been approved.",
"default": null,
"format": "float"
},
"sick_balance_hours": {
"type": "number",
"description": "The employee's remaining sick hour balance, for display on the paystub. Can be updated even after the associated payroll has been approved.",
"default": null,
"format": "float"
},
"state_covid_sick_balance_hours": {
"type": "number",
"description": "The employee's remaining sick hour balance from state COVID relief bills, for display on the paystub",
"default": null,
"format": "float"
},
"supplemental_tax_calc_method": {
"type": "string",
"description": "Controls the method used by Check to calculate tax on supplemental earnings. May be `flat` or `aggregate`"
},
"paper_check_number": {
"type": "string",
"description": "For accounting. The check number associated with any printed checks. Can be updated even after the associated payroll has been approved. See [Get a paper check](https://docs.checkhq.com/reference/get-a-paper-check) for more details."
},
"paystub_info": {
"type": "string",
"description": "Loosely structured information that will be returned on paystubs generated for this payroll item. Limited to 15 keys, and 500 total characters (combined length of keys and values).",
"format": "json"
},
"metadata": {
"type": "string",
"description": "Additional loosely structured information to associate with the payroll item",
"format": "json"
}
}
}
}
}
},
"responses": {
"200": {
"description": "200",
"content": {
"application/json": {
"examples": {
"Result": {
"value": ""
}
}
}
}
}
},
"deprecated": false
}
}
},
"x-readme": {
"headers": [],
"explorer-enabled": true,
"proxy-enabled": true
},
"x-readme-fauxas": true
}
```