--- title: "Update a Pay Component of a Check" method: PATCH path: "/v2/checks/checkcomponents" tags: ["Payroll"] --- # Update a Pay Component of a Check `PATCH /v2/checks/checkcomponents` ## Request - Base URL: `https://api.paychex.com` - URL: `https://api.paychex.com/v2/checks/checkcomponents` - Auth: none declared - TypeScript: (a function with typed inputs; its response is checked against the schema) Update a single pay component on an individual unprocessed check. ## Query parameters - `checkid` string, required - `checkcomponentid` string, required ## Request body - PayComponentResourceV2 - `componentId` string: The identifier of the pay component to add to the check. An overtime pay component can't be placed on a worker that is OT exempt. - `checkComponentId` string: The unique identifier associated for the pay component on this check. - `name` string: The name given to the pay component - `classificationType` string: The category that this component falls into. - `description` string: Description - `effectOnPay` 'ADDITION' | 'ADDITION_WITH_IN_OUT' | 'EMPLOYER_INFORMATIONAL' | 'REDUCTION': The effect that the pay component will have on the check amount. - `startDate` string, date-time: The date that the pay component is able to be applied on a check. - `endDate` string, date-time: The date that the pay component is not available to be applied on a check moving forward. - `appliesToWorkerTypes` string[]: Applies To WorkerTypes. - `jobId` string: This is used optionally for overriding a job when it needs to be different then the workers default. This option is only available when the client has job costing. - `laborAssignmentId` string: This is used optionally for overriding a labor assignment when it needs to be different then the workers assignment distribution. This option is only available when the client has labor assignment. - `grossUpToInd` boolean, nullable: Whether or not this check Pay Component is used in net-to-gross pay calculations. - `payRateType` string, nullable: Pay rate type used in some pay component calculations. - `percent` string: The percent to be applied for this component. - `recurring` boolean: Whether or not this Check Pay Component is recurring or not. A recurring (true) means this is a representation of a Worker Pay Component on the check. A non-recurring (false) is the most common scenario and represents individual check pay components. - `isBlocked` boolean, nullable: Indicates whether a one-time block has been applied to this recurring pay component for this specific check. - `payRateId` string: The rate identifier for the workers compensation - `payRate` string: The rate amount that will be applied for this component. Used in conjunction with Hours or Units. - `payHours` string: The number of hours that will be applied for this component. Used in conjunction with rate. - `payUnits` string: The number of units that will be applied for this component. Used in conjunction with rate. - `payAmount` string: The flat amount to be applied for this component. Not used with Rate, Hours, or Units. - `memoed` boolean: This is used optionally for memoing the payHours or payUnits so that they are informational when using a payAmount. - `lineDate` string, date-time: This is used optionally for specifying a date that the pay component was generated on. ## Response `200` Successful operation - PayComponentResourceV2 - `componentId` string: The identifier of the pay component to add to the check. An overtime pay component can't be placed on a worker that is OT exempt. - `checkComponentId` string: The unique identifier associated for the pay component on this check. - `name` string: The name given to the pay component - `classificationType` string: The category that this component falls into. - `description` string: Description - `effectOnPay` 'ADDITION' | 'ADDITION_WITH_IN_OUT' | 'EMPLOYER_INFORMATIONAL' | 'REDUCTION': The effect that the pay component will have on the check amount. - `startDate` string, date-time: The date that the pay component is able to be applied on a check. - `endDate` string, date-time: The date that the pay component is not available to be applied on a check moving forward. - `appliesToWorkerTypes` string[]: Applies To WorkerTypes. - `jobId` string: This is used optionally for overriding a job when it needs to be different then the workers default. This option is only available when the client has job costing. - `laborAssignmentId` string: This is used optionally for overriding a labor assignment when it needs to be different then the workers assignment distribution. This option is only available when the client has labor assignment. - `grossUpToInd` boolean, nullable: Whether or not this check Pay Component is used in net-to-gross pay calculations. - `payRateType` string, nullable: Pay rate type used in some pay component calculations. - `percent` string: The percent to be applied for this component. - `recurring` boolean: Whether or not this Check Pay Component is recurring or not. A recurring (true) means this is a representation of a Worker Pay Component on the check. A non-recurring (false) is the most common scenario and represents individual check pay components. - `isBlocked` boolean, nullable: Indicates whether a one-time block has been applied to this recurring pay component for this specific check. - `payRateId` string: The rate identifier for the workers compensation - `payRate` string: The rate amount that will be applied for this component. Used in conjunction with Hours or Units. - `payHours` string: The number of hours that will be applied for this component. Used in conjunction with rate. - `payUnits` string: The number of units that will be applied for this component. Used in conjunction with rate. - `payAmount` string: The flat amount to be applied for this component. Not used with Rate, Hours, or Units. - `memoed` boolean: This is used optionally for memoing the payHours or payUnits so that they are informational when using a payAmount. - `lineDate` string, date-time: This is used optionally for specifying a date that the pay component was generated on. ## Other responses - `400`: The request cannot be performed since the worker is in a state which does not allow this action(API-19) - `401`: Unauthorized - `403`: User doesn't have access to this endpoint (API-2), Client has been end dated (API-68) - `404`: Invalid resource ID (API-7) - `405`: Unsupported method type (API-59) - `406`: Unsupported Accept header - `500`: Invalid/Missing ssoguid (API-9), Internal server error unexplained (API-1) - `503`: service unavailable (API-66) --- [API](https://skmtc.dev/paychex/apis/external-api.md) - [All operations](https://skmtc.dev/paychex/apis/external-api/llms.txt) - [OpenAPI document](https://skmtc.dev/paychex/apis/external-api/revisions/07161d3e073f?raw)