Payroll

Update a Pay Component of a Check

Update a single pay component on an individual unprocessed check.

patch/v2/checks/checkcomponents

Request

Base URL
https://api.paychex.com
Auth
none declared
TypeScript
https://skmtc.dev/paychex/apis/external-api/docs/v2/checks/checkcomponents/patch.ts
A function with typed inputs. Its response is checked against the schema.

Query parameters

checkidstring required

ID associated with desired check.

checkcomponentidstring required

ID associated with an Earning or deduction of this check

Request body

componentIdstring

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.

checkComponentIdstring

The unique identifier associated for the pay component on this check.

namestring

The name given to the pay component

classificationTypestring

The category that this component falls into.

descriptionstring

Description

effectOnPay'ADDITION' | 'ADDITION_WITH_IN_OUT' | 'EMPLOYER_INFORMATIONAL' | 'REDUCTION'

The effect that the pay component will have on the check amount.

startDatestring date-time

The date that the pay component is able to be applied on a check.

endDatestring date-time

The date that the pay component is not available to be applied on a check moving forward.

appliesToWorkerTypesstring[]

Applies To WorkerTypes.

jobIdstring

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.

laborAssignmentIdstring

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.

grossUpToIndboolean nullable

Whether or not this check Pay Component is used in net-to-gross pay calculations.

payRateTypestring nullable

Pay rate type used in some pay component calculations.

percentstring

The percent to be applied for this component.

recurringboolean

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.

isBlockedboolean nullable

Indicates whether a one-time block has been applied to this recurring pay component for this specific check.

payRateIdstring

The rate identifier for the workers compensation

payRatestring

The rate amount that will be applied for this component. Used in conjunction with Hours or Units.

payHoursstring

The number of hours that will be applied for this component. Used in conjunction with rate.

payUnitsstring

The number of units that will be applied for this component. Used in conjunction with rate.

payAmountstring

The flat amount to be applied for this component. Not used with Rate, Hours, or Units.

memoedboolean

This is used optionally for memoing the payHours or payUnits so that they are informational when using a payAmount.

lineDatestring date-time

This is used optionally for specifying a date that the pay component was generated on.

Example request

{
  "componentId": "970000053577899",
  "checkComponentId": "1020026552555441"
}

Response

Successful operation