/paychex-payroll | Type: Application | PCID required: Yes
Tools
paychex_payroll_add_pay_component_for_check
Pay Component to a check. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
checkId | string | Yes | — | ID associated with desired check. |
appliesToWorkerTypes | string[] | No | — | Applies To WorkerTypes. |
checkComponentId | string | No | — | The unique identifier associated for the pay component on this check. |
classificationType | string | No | — | The category that this component falls into. |
componentId | string | No | — | 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. |
description | string | No | — | The description value |
effectOnPay | string | No | — | The effect that the pay component will have on the check amount. |
endDate | string | No | — | The date that the pay component is not available to be applied on a check moving forward. |
jobId | string | No | — | 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 | No | — | 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. |
lineDate | string | No | — | This is used optionally for specifying a date that the pay component was generated on. |
memoed | boolean | No | — | This is used optionally for memoing the payHours or payUnits so that they are informational when using a payAmount. |
name | string | No | — | The name given to the pay component |
payAmount | string | No | — | The flat amount to be applied for this component. Not used with Rate, Hours, or Units. |
payHours | string | No | — | The number of hours that will be applied for this component. Used in conjunction with rate. |
payRate | string | No | — | The rate amount that will be applied for this component. Used in conjunction with Hours or Units. |
payRateId | string | No | — | The rate identifier for the workers compensation |
payUnits | string | No | — | The number of units that will be applied for this component. Used in conjunction with rate. |
recurring | boolean | No | — | 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. |
startDate | string | No | — | The date that the pay component is able to be applied on a check. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"checkId": {
"type": "string",
"description": "ID associated with desired check."
},
"appliesToWorkerTypes": {
"type": "array",
"items": {
"type": "string",
"enum": [
"EMPLOYEE",
"CONTRACTOR",
"INDEPENDENT_CONTRACTOR"
]
},
"description": "Applies To WorkerTypes."
},
"checkComponentId": {
"type": "string",
"description": "The unique identifier associated for the pay component on this check."
},
"classificationType": {
"type": "string",
"description": "The category that this component falls into."
},
"componentId": {
"type": "string",
"description": "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."
},
"description": {
"type": "string",
"description": "The description value"
},
"effectOnPay": {
"type": "string",
"description": "The effect that the pay component will have on the check amount.",
"enum": [
"ADDITION",
"ADDITION_WITH_IN_OUT",
"EMPLOYER_INFORMATIONAL",
"REDUCTION"
]
},
"endDate": {
"type": "string",
"description": "The date that the pay component is not available to be applied on a check moving forward."
},
"jobId": {
"type": "string",
"description": "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": {
"type": "string",
"description": "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."
},
"lineDate": {
"type": "string",
"description": "This is used optionally for specifying a date that the pay component was generated on."
},
"memoed": {
"type": "boolean",
"description": "This is used optionally for memoing the payHours or payUnits so that they are informational when using a payAmount."
},
"name": {
"type": "string",
"description": "The name given to the pay component"
},
"payAmount": {
"type": "string",
"description": "The flat amount to be applied for this component. Not used with Rate, Hours, or Units."
},
"payHours": {
"type": "string",
"description": "The number of hours that will be applied for this component. Used in conjunction with rate."
},
"payRate": {
"type": "string",
"description": "The rate amount that will be applied for this component. Used in conjunction with Hours or Units."
},
"payRateId": {
"type": "string",
"description": "The rate identifier for the workers compensation"
},
"payUnits": {
"type": "string",
"description": "The number of units that will be applied for this component. Used in conjunction with rate."
},
"recurring": {
"type": "boolean",
"description": "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."
},
"startDate": {
"type": "string",
"description": "The date that the pay component is able to be applied on a check."
}
},
"required": [
"PCID",
"checkId"
]
}
paychex_payroll_add_worker_federal_tax
Worker Federal Tax Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
workerId | string | Yes | — | ID associated with desired worker. |
deductionsAmount | string | No | — | See federal W-4 instructions. |
dependentsAmount | string | No | — | See federal W-4 instructions. |
extraWithholdingAmount | string | No | — | See federal W-4 instructions. Can be used with extraWithholdingPercentage or overrideWithholdingPercentage. Cannot be used with overrideWithholdingAmount. If extraWithholdingAmount is entered, existing overrideWithholdingAmount data will be removed. |
extraWithholdingPercentage | string | No | — | See federal W-4 instructions. Can be used with extraWithholdingAmount. Cannot be used with overrideWithholdingAmount or overrideWithholdingPercentage. If entered, existing overrideWithholdingAmount and overrideWithholdingPercentage data will be removed. |
filingStatus | string | No | — | Filing status. |
multipleJobs | string | No | — | See federal W-4 instructions. |
otherIncome | string | No | — | See federal W-4 instructions. |
overrideWithholdingAmount | string | No | — | See federal W-4 instructions. Cannot be used with extraWithholdingAmount, extraWithholdingPercentage, or overrideWithholdingPercentage. If entered, existing extraWithholdingAmount, extraWithholdingPercentage, and overrideWithholdingPercentage data will be removed. |
overrideWithholdingPercentage | string | No | — | See federal W-4 instructions. Can be used with extraWithholdingAmount. Cannot be used with overrideWithholdingAmount or extraWithholdingPercentage. If entered, existing overrideWithholdingAmount and extraWithholdingPercentage data will be removed. |
taxesWithheld | string | No | — | Should federal taxes be withheld: true means federal taxes are withheld, false means federal taxes are NOT withheld. Earnings will still be reported to state and federal agencies. |
taxId | string | No | — | The ID for the federal tax item. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"workerId": {
"type": "string",
"description": "ID associated with desired worker."
},
"deductionsAmount": {
"type": "string",
"description": "See federal W-4 instructions."
},
"dependentsAmount": {
"type": "string",
"description": "See federal W-4 instructions."
},
"extraWithholdingAmount": {
"type": "string",
"description": "See federal W-4 instructions. Can be used with extraWithholdingPercentage or overrideWithholdingPercentage. Cannot be used with overrideWithholdingAmount. If extraWithholdingAmount is entered, existing overrideWithholdingAmount data will be removed."
},
"extraWithholdingPercentage": {
"type": "string",
"description": "See federal W-4 instructions. Can be used with extraWithholdingAmount. Cannot be used with overrideWithholdingAmount or overrideWithholdingPercentage. If entered, existing overrideWithholdingAmount and overrideWithholdingPercentage data will be removed."
},
"filingStatus": {
"type": "string",
"description": "Filing status.",
"enum": [
"SINGLE_OR_MARRIED_FILING_SEPARATELY",
"MARRIED_FILING_JOINTLY",
"HEAD_OF_HOUSEHOLD"
]
},
"multipleJobs": {
"type": "string",
"description": "See federal W-4 instructions.",
"enum": [
"true",
"false"
]
},
"otherIncome": {
"type": "string",
"description": "See federal W-4 instructions."
},
"overrideWithholdingAmount": {
"type": "string",
"description": "See federal W-4 instructions. Cannot be used with extraWithholdingAmount, extraWithholdingPercentage, or overrideWithholdingPercentage. If entered, existing extraWithholdingAmount, extraWithholdingPercentage, and overrideWithholdingPercentage data will be removed."
},
"overrideWithholdingPercentage": {
"type": "string",
"description": "See federal W-4 instructions. Can be used with extraWithholdingAmount. Cannot be used with overrideWithholdingAmount or extraWithholdingPercentage. If entered, existing overrideWithholdingAmount and extraWithholdingPercentage data will be removed."
},
"taxesWithheld": {
"type": "string",
"description": "Should federal taxes be withheld: true means federal taxes are withheld, false means federal taxes are NOT withheld. Earnings will still be reported to state and federal agencies.",
"enum": [
"true",
"false"
]
},
"taxId": {
"type": "string",
"description": "The ID for the federal tax item."
}
},
"required": [
"PCID",
"workerId"
]
}
paychex_payroll_create_company_checks
Company Checks Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
companyId | string | Yes | — | ID associated with desired company. |
blockAutoDistribution | boolean | No | — | This is used optionally for blocking the auto distribution of the earnings on the workers if they are setup for auto distribution. |
checkCorrelationId | string | No | — | Id that you define which is used for error handling/responses. This is not required when sending a single check. |
checkDate | string | No | — | The check date |
deductions | object[] | No | — | Deduction pay components on the check. |
earnings | object[] | No | — | The earnings to apply to the check.Each earning needs to define as one of the following:1 .payHours: Will use the default hourly rate defined on the worker to apply the hours against. 2. payHours and payRate: Will allow you to define the monetary rate that the hours will be applied against. 3. payHours and payRateId: Will allow you to define which workers predefined pay rate the hours will be applied against. 4. payUnits: Will use the default hourly rate defined on the worker to apply the units against. 5. payUnits and payRate: Will allow you to define the monetary rate that the units will be applied against. 6. payUnits and payRateId: Will allow you to define which workers predefined pay rate the units will be applied against. 7. payAmount: Will allow you to define straight monetary amount. |
informational | object[] | No | — | Informational pay components on the check. |
links | object[] | No | — | The links value |
paycheckId | string | No | — | The id of a single check that a workers has. |
payPeriodId | string | No | — | The id for the unprocessed payperiod. |
taxes | object[] | No | — | Tax pay components on the check. |
workerId | string | No | — | The id assigned to the worker. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"companyId": {
"type": "string",
"description": "ID associated with desired company."
},
"blockAutoDistribution": {
"type": "boolean",
"description": "This is used optionally for blocking the auto distribution of the earnings on the workers if they are setup for auto distribution."
},
"checkCorrelationId": {
"type": "string",
"description": "Id that you define which is used for error handling/responses. This is not required when sending a single check."
},
"checkDate": {
"type": "string",
"description": "The check date"
},
"deductions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"componentId": {
"type": "string",
"description": "The unique identifier used to identify a pay component."
},
"checkComponentId": {
"type": "string",
"description": "The unique identifier associated for the pay component on this check."
},
"code": {
"type": "string",
"description": "The Paychex standard code number for the Pay Component, can be two digit."
},
"name": {
"type": "string",
"description": "Name given to the pay component."
},
"classificationType": {
"type": "string",
"description": "The category that this component falls into."
},
"description": {
"type": "string",
"description": "The description of the Pay Component."
},
"effectOnPay": {
"type": "string",
"enum": [
"ADDITION",
"ADDITION_WITH_IN_OUT",
"EMPLOYER_INFORMATIONAL",
"REDUCTION"
],
"description": "The effect that the pay component will have on the check amount."
},
"startDate": {
"type": "string",
"format": "date-time",
"description": "The date that the pay component is able to be applied on a check."
},
"endDate": {
"type": "string",
"format": "date-time",
"description": "The date that the pay component is not available to be applied on a check moving forward."
},
"appliesToWorkerTypes": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of workerTypes that the component can be applied to."
},
"jobId": {
"type": "string",
"description": "This is used optionally for overriding a job when it needs to be different than the workers default. This option is only available when the client has job costing."
},
"laborAssignmentId": {
"type": "string",
"description": "This is used optionally for overriding a labor assignment when it needs to be different than the workers assignment distribution. This option is only available when the client has labor assignment."
},
"calculationType": {
"type": "string",
"description": "Calculation type used by the pay component."
},
"payRateId": {
"type": "string",
"description": "Unique identifier for this workers pay rate **This ID will change if this is created for an IN_PROGRESS worker that is later completed within Flex**"
},
"payRate": {
"type": "string",
"description": "The rate amount that will be applied for this component. Used in conjunction with Hours or Units."
},
"payHours": {
"type": "string",
"description": "The number of hours that will be applied for this component. Used in conjunction with rate."
},
"payUnits": {
"type": "string",
"description": "The number of units that will be applied for this component. Used in conjunction with rate."
},
"payAmount": {
"type": "string",
"description": "The flat amount to be applied for this component. Not used with Rate, Hours, or Units."
},
"organization": {
"type": "object",
"description": "The state representation of Organizations within a company."
},
"lineDate": {
"type": "string",
"format": "date-time",
"description": "This is used optionally for specifying a date that the pay component was generated on."
},
"memoed": {
"type": "boolean",
"description": "This is used optionally for memoing the payHours or payUnits so that they are informational when using a payAmount."
},
"links": {
"type": "array",
"items": {
"type": "object",
"properties": {
"rel": {
"type": "string"
},
"href": {
"type": "string"
},
"hreflang": {
"type": "string"
},
"media": {
"type": "string"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
},
"deprecation": {
"type": "string"
},
"profile": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"description": "The links value"
}
}
},
"description": "Deduction pay components on the check."
},
"earnings": {
"type": "array",
"items": {
"type": "object",
"properties": {
"componentId": {
"type": "string",
"description": "The unique identifier used to identify a pay component."
},
"checkComponentId": {
"type": "string",
"description": "The unique identifier associated for the pay component on this check."
},
"code": {
"type": "string",
"description": "The Paychex standard code number for the Pay Component, can be two digit."
},
"name": {
"type": "string",
"description": "Name given to the pay component."
},
"classificationType": {
"type": "string",
"description": "The category that this component falls into."
},
"description": {
"type": "string",
"description": "The description of the Pay Component."
},
"effectOnPay": {
"type": "string",
"enum": [
"ADDITION",
"ADDITION_WITH_IN_OUT",
"EMPLOYER_INFORMATIONAL",
"REDUCTION"
],
"description": "The effect that the pay component will have on the check amount."
},
"startDate": {
"type": "string",
"format": "date-time",
"description": "The date that the pay component is able to be applied on a check."
},
"endDate": {
"type": "string",
"format": "date-time",
"description": "The date that the pay component is not available to be applied on a check moving forward."
},
"appliesToWorkerTypes": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of workerTypes that the component can be applied to."
},
"jobId": {
"type": "string",
"description": "This is used optionally for overriding a job when it needs to be different than the workers default. This option is only available when the client has job costing."
},
"laborAssignmentId": {
"type": "string",
"description": "This is used optionally for overriding a labor assignment when it needs to be different than the workers assignment distribution. This option is only available when the client has labor assignment."
},
"calculationType": {
"type": "string",
"description": "Calculation type used by the pay component."
},
"payRateId": {
"type": "string",
"description": "Unique identifier for this workers pay rate **This ID will change if this is created for an IN_PROGRESS worker that is later completed within Flex**"
},
"payRate": {
"type": "string",
"description": "The rate amount that will be applied for this component. Used in conjunction with Hours or Units."
},
"payHours": {
"type": "string",
"description": "The number of hours that will be applied for this component. Used in conjunction with rate."
},
"payUnits": {
"type": "string",
"description": "The number of units that will be applied for this component. Used in conjunction with rate."
},
"payAmount": {
"type": "string",
"description": "The flat amount to be applied for this component. Not used with Rate, Hours, or Units."
},
"organization": {
"type": "object",
"description": "The state representation of Organizations within a company."
},
"lineDate": {
"type": "string",
"format": "date-time",
"description": "This is used optionally for specifying a date that the pay component was generated on."
},
"memoed": {
"type": "boolean",
"description": "This is used optionally for memoing the payHours or payUnits so that they are informational when using a payAmount."
},
"links": {
"type": "array",
"items": {
"type": "object",
"properties": {
"rel": {
"type": "string"
},
"href": {
"type": "string"
},
"hreflang": {
"type": "string"
},
"media": {
"type": "string"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
},
"deprecation": {
"type": "string"
},
"profile": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"description": "The links value"
}
}
},
"description": "The earnings to apply to the check.Each earning needs to define as one of the following:1 .payHours: Will use the default hourly rate defined on the worker to apply the hours against. 2. payHours and payRate: Will allow you to define the monetary rate that the hours will be applied against. 3. payHours and payRateId: Will allow you to define which workers predefined pay rate the hours will be applied against. 4. payUnits: Will use the default hourly rate defined on the worker to apply the units against. 5. payUnits and payRate: Will allow you to define the monetary rate that the units will be applied against. 6. payUnits and payRateId: Will allow you to define which workers predefined pay rate the units will be applied against. 7. payAmount: Will allow you to define straight monetary amount."
},
"informational": {
"type": "array",
"items": {
"type": "object",
"properties": {
"componentId": {
"type": "string",
"description": "The unique identifier used to identify a pay component."
},
"checkComponentId": {
"type": "string",
"description": "The unique identifier associated for the pay component on this check."
},
"code": {
"type": "string",
"description": "The Paychex standard code number for the Pay Component, can be two digit."
},
"name": {
"type": "string",
"description": "Name given to the pay component."
},
"classificationType": {
"type": "string",
"description": "The category that this component falls into."
},
"description": {
"type": "string",
"description": "The description of the Pay Component."
},
"effectOnPay": {
"type": "string",
"enum": [
"ADDITION",
"ADDITION_WITH_IN_OUT",
"EMPLOYER_INFORMATIONAL",
"REDUCTION"
],
"description": "The effect that the pay component will have on the check amount."
},
"startDate": {
"type": "string",
"format": "date-time",
"description": "The date that the pay component is able to be applied on a check."
},
"endDate": {
"type": "string",
"format": "date-time",
"description": "The date that the pay component is not available to be applied on a check moving forward."
},
"appliesToWorkerTypes": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of workerTypes that the component can be applied to."
},
"jobId": {
"type": "string",
"description": "This is used optionally for overriding a job when it needs to be different than the workers default. This option is only available when the client has job costing."
},
"laborAssignmentId": {
"type": "string",
"description": "This is used optionally for overriding a labor assignment when it needs to be different than the workers assignment distribution. This option is only available when the client has labor assignment."
},
"calculationType": {
"type": "string",
"description": "Calculation type used by the pay component."
},
"payRateId": {
"type": "string",
"description": "Unique identifier for this workers pay rate **This ID will change if this is created for an IN_PROGRESS worker that is later completed within Flex**"
},
"payRate": {
"type": "string",
"description": "The rate amount that will be applied for this component. Used in conjunction with Hours or Units."
},
"payHours": {
"type": "string",
"description": "The number of hours that will be applied for this component. Used in conjunction with rate."
},
"payUnits": {
"type": "string",
"description": "The number of units that will be applied for this component. Used in conjunction with rate."
},
"payAmount": {
"type": "string",
"description": "The flat amount to be applied for this component. Not used with Rate, Hours, or Units."
},
"organization": {
"type": "object",
"description": "The state representation of Organizations within a company."
},
"lineDate": {
"type": "string",
"format": "date-time",
"description": "This is used optionally for specifying a date that the pay component was generated on."
},
"memoed": {
"type": "boolean",
"description": "This is used optionally for memoing the payHours or payUnits so that they are informational when using a payAmount."
},
"links": {
"type": "array",
"items": {
"type": "object",
"properties": {
"rel": {
"type": "string"
},
"href": {
"type": "string"
},
"hreflang": {
"type": "string"
},
"media": {
"type": "string"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
},
"deprecation": {
"type": "string"
},
"profile": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"description": "The links value"
}
}
},
"description": "Informational pay components on the check."
},
"links": {
"type": "array",
"items": {
"type": "object",
"properties": {
"rel": {
"type": "string",
"description": "The rel value"
},
"href": {
"type": "string",
"description": "The href value"
},
"hreflang": {
"type": "string",
"description": "The hreflang value"
},
"media": {
"type": "string",
"description": "The media value"
},
"title": {
"type": "string",
"description": "The title value"
},
"type": {
"type": "string",
"description": "The type value"
},
"deprecation": {
"type": "string",
"description": "The deprecation value"
},
"profile": {
"type": "string",
"description": "The profile value"
},
"name": {
"type": "string",
"description": "The name value"
}
}
},
"description": "The links value"
},
"paycheckId": {
"type": "string",
"description": "The id of a single check that a workers has."
},
"payPeriodId": {
"type": "string",
"description": "The id for the unprocessed payperiod."
},
"taxes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"componentId": {
"type": "string",
"description": "The unique identifier used to identify a pay component."
},
"checkComponentId": {
"type": "string",
"description": "The unique identifier associated for the pay component on this check."
},
"code": {
"type": "string",
"description": "The Paychex standard code number for the Pay Component, can be two digit."
},
"name": {
"type": "string",
"description": "Name given to the pay component."
},
"classificationType": {
"type": "string",
"description": "The category that this component falls into."
},
"description": {
"type": "string",
"description": "The description of the Pay Component."
},
"effectOnPay": {
"type": "string",
"enum": [
"ADDITION",
"ADDITION_WITH_IN_OUT",
"EMPLOYER_INFORMATIONAL",
"REDUCTION"
],
"description": "The effect that the pay component will have on the check amount."
},
"startDate": {
"type": "string",
"format": "date-time",
"description": "The date that the pay component is able to be applied on a check."
},
"endDate": {
"type": "string",
"format": "date-time",
"description": "The date that the pay component is not available to be applied on a check moving forward."
},
"appliesToWorkerTypes": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of workerTypes that the component can be applied to."
},
"jobId": {
"type": "string",
"description": "This is used optionally for overriding a job when it needs to be different than the workers default. This option is only available when the client has job costing."
},
"laborAssignmentId": {
"type": "string",
"description": "This is used optionally for overriding a labor assignment when it needs to be different than the workers assignment distribution. This option is only available when the client has labor assignment."
},
"calculationType": {
"type": "string",
"description": "Calculation type used by the pay component."
},
"payRateId": {
"type": "string",
"description": "Unique identifier for this workers pay rate **This ID will change if this is created for an IN_PROGRESS worker that is later completed within Flex**"
},
"payRate": {
"type": "string",
"description": "The rate amount that will be applied for this component. Used in conjunction with Hours or Units."
},
"payHours": {
"type": "string",
"description": "The number of hours that will be applied for this component. Used in conjunction with rate."
},
"payUnits": {
"type": "string",
"description": "The number of units that will be applied for this component. Used in conjunction with rate."
},
"payAmount": {
"type": "string",
"description": "The flat amount to be applied for this component. Not used with Rate, Hours, or Units."
},
"organization": {
"type": "object",
"description": "The state representation of Organizations within a company."
},
"lineDate": {
"type": "string",
"format": "date-time",
"description": "This is used optionally for specifying a date that the pay component was generated on."
},
"memoed": {
"type": "boolean",
"description": "This is used optionally for memoing the payHours or payUnits so that they are informational when using a payAmount."
},
"links": {
"type": "array",
"items": {
"type": "object",
"properties": {
"rel": {
"type": "string"
},
"href": {
"type": "string"
},
"hreflang": {
"type": "string"
},
"media": {
"type": "string"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
},
"deprecation": {
"type": "string"
},
"profile": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"description": "The links value"
}
}
},
"description": "Tax pay components on the check."
},
"workerId": {
"type": "string",
"description": "The id assigned to the worker."
}
},
"required": [
"PCID",
"companyId"
]
}
paychex_payroll_create_worker_check
Worker Check Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
workerId | string | Yes | — | ID associated with desired worker. |
blockAutoDistribution | boolean | No | — | This is used optionally for blocking the auto distribution of the earnings on the workers if they are setup for auto distribution. |
checkCorrelationId | string | No | — | Id that you define which is used for error handling/responses. This is not required when sending a single check. |
deductions | object[] | No | — | Deduction pay components on the check. |
earnings | object[] | No | — | The earnings to apply to the check.Each earning needs to define as one of the following:1 .payHours: Will use the default hourly rate defined on the worker to apply the hours against. 2. payHours and payRate: Will allow you to define the monetary rate that the hours will be applied against. 3. payHours and payRateId: Will allow you to define which workers predefined pay rate the hours will be applied against. 4. payUnits: Will use the default hourly rate defined on the worker to apply the units against. 5. payUnits and payRate: Will allow you to define the monetary rate that the units will be applied against. 6. payUnits and payRateId: Will allow you to define which workers predefined pay rate the units will be applied against. 7. payAmount: Will allow you to define straight monetary amount. |
informational | object[] | No | — | Informational pay components on the check. |
paycheckId | string | No | — | The id of a single check that a workers has. |
payPeriodId | string | No | — | The id for the unprocessed payperiod. |
taxes | object[] | No | — | Tax pay components on the check. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"workerId": {
"type": "string",
"description": "ID associated with desired worker."
},
"blockAutoDistribution": {
"type": "boolean",
"description": "This is used optionally for blocking the auto distribution of the earnings on the workers if they are setup for auto distribution.",
"enum": [
true,
false
]
},
"checkCorrelationId": {
"type": "string",
"description": "Id that you define which is used for error handling/responses. This is not required when sending a single check."
},
"deductions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"componentId": {
"type": "string",
"description": "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": {
"type": "string",
"description": "The unique identifier associated for the pay component on this check."
},
"name": {
"type": "string",
"description": "The name given to the pay component"
},
"classificationType": {
"type": "string",
"description": "The category that this component falls into."
},
"description": {
"type": "string",
"description": "The description value"
},
"effectOnPay": {
"type": "string",
"enum": [
"ADDITION",
"ADDITION_WITH_IN_OUT",
"EMPLOYER_INFORMATIONAL",
"REDUCTION"
],
"description": "The effect that the pay component will have on the check amount."
},
"startDate": {
"type": "string",
"format": "date-time",
"description": "The date that the pay component is able to be applied on a check."
},
"endDate": {
"type": "string",
"format": "date-time",
"description": "The date that the pay component is not available to be applied on a check moving forward."
},
"jobId": {
"type": "string",
"description": "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": {
"type": "string",
"description": "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."
},
"payRateId": {
"type": "string",
"description": "The rate identifier for the workers compensation"
},
"payRate": {
"type": "string",
"description": "The rate amount that will be applied for this component. Used in conjunction with Hours or Units."
},
"payHours": {
"type": "string",
"description": "The number of hours that will be applied for this component. Used in conjunction with rate"
},
"payUnits": {
"type": "string",
"description": "The number of units that will be applied for this component. Used in conjunction with rate."
},
"payAmount": {
"type": "string",
"description": "The flat amount to be applied for this component. Not used with Rate, Hours, or Units."
},
"organization": {
"type": "object",
"description": "The organization which the worker is part of."
},
"lineDate": {
"type": "string",
"format": "date-time",
"description": "This is used optionally for specifying a date that the earning was generated on."
},
"memoed": {
"type": "boolean",
"description": "This is used optionally for memoing the payHours or payUnits so that they are informational when using a payAmount."
}
}
},
"description": "Deduction pay components on the check."
},
"earnings": {
"type": "array",
"items": {
"type": "object",
"properties": {
"componentId": {
"type": "string",
"description": "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": {
"type": "string",
"description": "The unique identifier associated for the pay component on this check."
},
"name": {
"type": "string",
"description": "The name given to the pay component"
},
"classificationType": {
"type": "string",
"description": "The category that this component falls into."
},
"description": {
"type": "string",
"description": "The description value"
},
"effectOnPay": {
"type": "string",
"enum": [
"ADDITION",
"ADDITION_WITH_IN_OUT",
"EMPLOYER_INFORMATIONAL",
"REDUCTION"
],
"description": "The effect that the pay component will have on the check amount."
},
"startDate": {
"type": "string",
"format": "date-time",
"description": "The date that the pay component is able to be applied on a check."
},
"endDate": {
"type": "string",
"format": "date-time",
"description": "The date that the pay component is not available to be applied on a check moving forward."
},
"jobId": {
"type": "string",
"description": "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": {
"type": "string",
"description": "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."
},
"payRateId": {
"type": "string",
"description": "The rate identifier for the workers compensation"
},
"payRate": {
"type": "string",
"description": "The rate amount that will be applied for this component. Used in conjunction with Hours or Units."
},
"payHours": {
"type": "string",
"description": "The number of hours that will be applied for this component. Used in conjunction with rate"
},
"payUnits": {
"type": "string",
"description": "The number of units that will be applied for this component. Used in conjunction with rate."
},
"payAmount": {
"type": "string",
"description": "The flat amount to be applied for this component. Not used with Rate, Hours, or Units."
},
"organization": {
"type": "object",
"description": "The organization which the worker is part of."
},
"lineDate": {
"type": "string",
"format": "date-time",
"description": "This is used optionally for specifying a date that the earning was generated on."
},
"memoed": {
"type": "boolean",
"description": "This is used optionally for memoing the payHours or payUnits so that they are informational when using a payAmount."
}
}
},
"description": "The earnings to apply to the check.Each earning needs to define as one of the following:1 .payHours: Will use the default hourly rate defined on the worker to apply the hours against. 2. payHours and payRate: Will allow you to define the monetary rate that the hours will be applied against. 3. payHours and payRateId: Will allow you to define which workers predefined pay rate the hours will be applied against. 4. payUnits: Will use the default hourly rate defined on the worker to apply the units against. 5. payUnits and payRate: Will allow you to define the monetary rate that the units will be applied against. 6. payUnits and payRateId: Will allow you to define which workers predefined pay rate the units will be applied against. 7. payAmount: Will allow you to define straight monetary amount."
},
"informational": {
"type": "array",
"items": {
"type": "object",
"properties": {
"componentId": {
"type": "string",
"description": "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": {
"type": "string",
"description": "The unique identifier associated for the pay component on this check."
},
"name": {
"type": "string",
"description": "The name given to the pay component"
},
"classificationType": {
"type": "string",
"description": "The category that this component falls into."
},
"description": {
"type": "string",
"description": "The description value"
},
"effectOnPay": {
"type": "string",
"enum": [
"ADDITION",
"ADDITION_WITH_IN_OUT",
"EMPLOYER_INFORMATIONAL",
"REDUCTION"
],
"description": "The effect that the pay component will have on the check amount."
},
"startDate": {
"type": "string",
"format": "date-time",
"description": "The date that the pay component is able to be applied on a check."
},
"endDate": {
"type": "string",
"format": "date-time",
"description": "The date that the pay component is not available to be applied on a check moving forward."
},
"jobId": {
"type": "string",
"description": "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": {
"type": "string",
"description": "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."
},
"payRateId": {
"type": "string",
"description": "The rate identifier for the workers compensation"
},
"payRate": {
"type": "string",
"description": "The rate amount that will be applied for this component. Used in conjunction with Hours or Units."
},
"payHours": {
"type": "string",
"description": "The number of hours that will be applied for this component. Used in conjunction with rate"
},
"payUnits": {
"type": "string",
"description": "The number of units that will be applied for this component. Used in conjunction with rate."
},
"payAmount": {
"type": "string",
"description": "The flat amount to be applied for this component. Not used with Rate, Hours, or Units."
},
"organization": {
"type": "object",
"description": "The organization which the worker is part of."
},
"lineDate": {
"type": "string",
"format": "date-time",
"description": "This is used optionally for specifying a date that the earning was generated on."
},
"memoed": {
"type": "boolean",
"description": "This is used optionally for memoing the payHours or payUnits so that they are informational when using a payAmount."
}
}
},
"description": "Informational pay components on the check."
},
"paycheckId": {
"type": "string",
"description": "The id of a single check that a workers has."
},
"payPeriodId": {
"type": "string",
"description": "The id for the unprocessed payperiod."
},
"taxes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"componentId": {
"type": "string",
"description": "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": {
"type": "string",
"description": "The unique identifier associated for the pay component on this check."
},
"name": {
"type": "string",
"description": "The name given to the pay component"
},
"classificationType": {
"type": "string",
"description": "The category that this component falls into."
},
"description": {
"type": "string",
"description": "The description value"
},
"effectOnPay": {
"type": "string",
"enum": [
"ADDITION",
"ADDITION_WITH_IN_OUT",
"EMPLOYER_INFORMATIONAL",
"REDUCTION"
],
"description": "The effect that the pay component will have on the check amount."
},
"startDate": {
"type": "string",
"format": "date-time",
"description": "The date that the pay component is able to be applied on a check."
},
"endDate": {
"type": "string",
"format": "date-time",
"description": "The date that the pay component is not available to be applied on a check moving forward."
},
"jobId": {
"type": "string",
"description": "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": {
"type": "string",
"description": "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."
},
"payRateId": {
"type": "string",
"description": "The rate identifier for the workers compensation"
},
"payRate": {
"type": "string",
"description": "The rate amount that will be applied for this component. Used in conjunction with Hours or Units."
},
"payHours": {
"type": "string",
"description": "The number of hours that will be applied for this component. Used in conjunction with rate"
},
"payUnits": {
"type": "string",
"description": "The number of units that will be applied for this component. Used in conjunction with rate."
},
"payAmount": {
"type": "string",
"description": "The flat amount to be applied for this component. Not used with Rate, Hours, or Units."
},
"organization": {
"type": "object",
"description": "The organization which the worker is part of."
},
"lineDate": {
"type": "string",
"format": "date-time",
"description": "This is used optionally for specifying a date that the earning was generated on."
},
"memoed": {
"type": "boolean",
"description": "This is used optionally for memoing the payHours or payUnits so that they are informational when using a payAmount."
}
}
},
"description": "Tax pay components on the check."
}
},
"required": [
"PCID",
"workerId"
]
}
paychex_payroll_create_worker_direct_deposit
Worker Direct Deposit Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
workerId | string | Yes | — | ID associated with desired worker. |
_links | object | No | — | The links value |
accountNumber | string | No | — | The financial institutions account number.This data field cannot be PATCHED. |
accountType | string | No | — | Financial institutions account type. This data field cannot be PATCHED. |
directDepositId | string | No | — | The ID for the direct deposit item. |
paymentType | string | No | — | A type of payment for the direct deposit. |
priority | string | No | — | The priority order for which the direct deposits will be performed in. When a new direct deposit is added the priority will be assigned. The priority can be modified only by swapping with a different direct deposit using the bulk PATCH. A paymentType of REMAINDER will show a priority of 99 and can’t be modified.This data field cannot be PATCHED. |
routingNumber | string | No | — | The financial institutions routing number.This data field cannot be PATCHED. |
startDate | string | No | — | The date that this direct deposit will be applied to future pay periods. This data field cannot be PATCHED. |
value | number | No | — | The amount to be applied to this direct deposit. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"workerId": {
"type": "string",
"description": "ID associated with desired worker."
},
"_links": {
"type": "object",
"description": "The links value"
},
"accountNumber": {
"type": "string",
"description": "The financial institutions account number.This data field cannot be PATCHED."
},
"accountType": {
"type": "string",
"description": "Financial institutions account type. This data field cannot be PATCHED.",
"enum": [
"CHECKING",
"SAVINGS"
]
},
"directDepositId": {
"type": "string",
"description": "The ID for the direct deposit item."
},
"paymentType": {
"type": "string",
"description": "A type of payment for the direct deposit.",
"enum": [
"FLAT_DOLLAR_AMOUNT",
"PERCENTAGE",
"REMAINDER"
]
},
"priority": {
"type": "string",
"description": "The priority order for which the direct deposits will be performed in. When a new direct deposit is added the priority will be assigned. The priority can be modified only by swapping with a different direct deposit using the bulk PATCH. A paymentType of REMAINDER will show a priority of 99 and can't be modified.This data field cannot be PATCHED."
},
"routingNumber": {
"type": "string",
"description": "The financial institutions routing number.This data field cannot be PATCHED."
},
"startDate": {
"type": "string",
"description": "The date that this direct deposit will be applied to future pay periods. This data field cannot be PATCHED."
},
"value": {
"type": "number",
"description": "The amount to be applied to this direct deposit."
}
},
"required": [
"PCID",
"workerId"
]
}
paychex_payroll_create_worker_pay_rate
Worker Pay Rate Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
workerId | string | Yes | — | ID associated with desired worker. |
_links | object | No | — | The links value |
amount | string | No | — | The currency amount which this rate is applied. |
default | boolean | No | — | If this rate is the default one to apply on the worker. This data field is not available for an IN_PROGRESS worker and is considered RATE_1. |
description | string | No | — | Describes the rate for the worker. A maximum of 30 characters is allowed. |
effectiveDate | string | No | — | The date when the pay rate becomes effective for the worker (can be used only in POST/PATCH for an active worker). |
rateId | string | No | — | Unique identifier for this workers pay rate. This ID will change if this is created for an IN_PROGRESS worker that is later completed within Flex |
rateNumber | string | No | — | The number of the rate. A worker can have up to 25 different rates. |
rateType | string | No | — | Type of rate. |
standardHours | string | No | — | Default standard hours that this rate is used with a pay frequency. This data field is not available for an IN_PROGRESS worker. |
standardOvertime | string | No | — | Default over time hours that this rate is used with a pay frequency. This data field is not available for an IN_PROGRESS worker. |
startDate | string | No | — | The date when the pay rate is going to begin. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"workerId": {
"type": "string",
"description": "ID associated with desired worker."
},
"_links": {
"type": "object",
"description": "The links value"
},
"amount": {
"type": "string",
"description": "The currency amount which this rate is applied."
},
"default": {
"type": "boolean",
"description": "If this rate is the default one to apply on the worker. This data field is not available for an IN_PROGRESS worker and is considered RATE_1."
},
"description": {
"type": "string",
"description": "Describes the rate for the worker. A maximum of 30 characters is allowed."
},
"effectiveDate": {
"type": "string",
"description": "The date when the pay rate becomes effective for the worker (can be used only in POST/PATCH for an active worker)."
},
"rateId": {
"type": "string",
"description": "Unique identifier for this workers pay rate. **This ID will change if this is created for an IN_PROGRESS worker that is later completed within Flex**"
},
"rateNumber": {
"type": "string",
"description": "The number of the rate. A worker can have up to 25 different rates."
},
"rateType": {
"type": "string",
"description": "Type of rate.",
"enum": [
"ANNUAL_SALARY",
"PER_PAY_PERIOD_SALARY",
"PIECEWORK_RATE",
"DAILY_RATE",
"HOURLY_RATE"
]
},
"standardHours": {
"type": "string",
"description": "Default standard hours that this rate is used with a pay frequency. This data field is not available for an IN_PROGRESS worker."
},
"standardOvertime": {
"type": "string",
"description": "Default over time hours that this rate is used with a pay frequency. This data field is not available for an IN_PROGRESS worker."
},
"startDate": {
"type": "string",
"description": "The date when the pay rate is going to begin."
}
},
"required": [
"PCID",
"workerId"
]
}
paychex_payroll_create_worker_recurring
Worker Pay Component Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
workerId | string | Yes | — | ID associated with desired worker. |
_links | object | No | — | The links value |
calculationBaseId | string | No | — | This is required if you are not using a FLAT_DOLLAR_AMOUNT Calculation Type. |
calculationType | string | No | — | The type of calculation that will be applied for the pay component . |
checkLimit | object | No | — | Check Limit |
classificationType | string | No | — | The category that this component falls into. |
componentId | string | No | — | The unique identifier of the pay component. This data field cannot be PATCHED. |
effectiveDate | string | No | — | Date which this pay component has started for the worker. |
effectOnPay | string | No | — | What the effect on pay will be (REDUCTION OR ADDITION), currently only reductions are available. This data field will be populated automatically based on componentId. This data field cannot be PATCHED |
endDate | string | No | — | Date which this pay component has ended for the worker. |
frequency | object | No | — | Worker pay frequency |
name | string | No | — | Name of the pay component. This data field will be populated automatically based on componentId. |
startDate | string | No | — | Date which this pay component will start to be applied during the payruns. This is an optional field that default to current datetime if not provided. This cannot be backdated but can be added to start in the future. |
transactions | object[] | No | — | Pay Component transaction details. |
value | number | No | — | This is used to specify the value that is used against the calculationType. |
workerComponentId | string | No | — | The id of a single pay component that a workers has. |
workerPayCompScheduledEntries | object[] | No | — | Worker Pay Comp Scheduled Entries |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"workerId": {
"type": "string",
"description": "ID associated with desired worker."
},
"_links": {
"type": "object",
"description": "The links value"
},
"calculationBaseId": {
"type": "string",
"description": "This is required if you are not using a FLAT_DOLLAR_AMOUNT Calculation Type."
},
"calculationType": {
"type": "string",
"description": "The type of calculation that will be applied for the pay component .",
"enum": [
"FLAT_DOLLAR_AMOUNT",
"PERCENTAGE",
"RATE_X_UNITS",
"RATE_X_HOURS"
]
},
"checkLimit": {
"type": "object",
"description": "Check Limit",
"properties": {
"type": {
"type": "string",
"description": "This is used to determine what type of limitations to apply.",
"enum": [
"NONE",
"STOPS_AT",
"STOPS_AT_NEW_AMOUNT",
"BASED_ON_YTD_CASH_WAGES",
"AMOUNT_PER_CHECK"
]
},
"startsAt": {
"type": "string",
"description": "This is the the amount that the calculation will begin with."
},
"stopsAt": {
"type": "string",
"description": "This is the upper limit of the amount that can be applied."
},
"amount": {
"type": "string",
"description": "This is the amount that will be taken from each check"
}
}
},
"classificationType": {
"type": "string",
"description": "The category that this component falls into."
},
"componentId": {
"type": "string",
"description": "The unique identifier of the pay component. This data field cannot be PATCHED."
},
"effectiveDate": {
"type": "string",
"description": "Date which this pay component has started for the worker."
},
"effectOnPay": {
"type": "string",
"description": "What the effect on pay will be (REDUCTION OR ADDITION), currently only reductions are available. This data field will be populated automatically based on componentId. This data field cannot be PATCHED"
},
"endDate": {
"type": "string",
"description": "Date which this pay component has ended for the worker."
},
"frequency": {
"type": "object",
"description": "Worker pay frequency",
"properties": {
"applied": {
"type": "string",
"description": "Currently we only support a BY_PAY_PERIOD value for the API."
},
"occurrence": {
"type": "string",
"description": "This is how often the pay component will be applied on the pay run. The available values for this will depend on the payFrequency that a worker is paid which can be found on the worker compensations pay standards."
},
"occurrenceIntervals": {
"type": "object",
"description": "These are sub intervals that are used for occurrences that are larger in duration that allow you to define when to apply the pay component. You can reference the payFrequency and occurance to determine what intervals and values applicable."
},
"effectedChecks": {
"type": "string",
"description": "Which check(s) within the payrun that the paycomponent will be applied to.FIRST_CHECK: The Pay Component will be applied to the first check for the worker within the pay run. This is used for a pay component that only should be applied once like a health insurance deduction.EVERY_CHECK: The Pay Component will be applied to all of the checks for the worker within the pay run. This is used for a pay component that is applied on all check like a retirement deduction."
}
}
},
"name": {
"type": "string",
"description": "Name of the pay component. This data field will be populated automatically based on componentId."
},
"startDate": {
"type": "string",
"description": "Date which this pay component will start to be applied during the payruns. This is an optional field that default to current datetime if not provided. This cannot be backdated but can be added to start in the future."
},
"transactions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"transactionId": {
"type": "string",
"description": "Transaction Id"
},
"date": {
"type": "string",
"format": "date-time",
"description": "The date value"
},
"amount": {
"type": "number",
"description": "The amount value"
}
}
},
"description": "Pay Component transaction details."
},
"value": {
"type": "number",
"description": "This is used to specify the value that is used against the calculationType."
},
"workerComponentId": {
"type": "string",
"description": "The id of a single pay component that a workers has."
},
"workerPayCompScheduledEntries": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"description": "The id value"
},
"workerCalcMethodId": {
"type": "integer",
"format": "int64",
"description": "Worker Calc Method Id"
},
"clientPayrollId": {
"type": "integer",
"format": "int64",
"description": "Client Payroll Id"
},
"checkDate": {
"type": "string",
"format": "date-time",
"description": "Check Date"
},
"scheduledAmount": {
"type": "number",
"description": "Scheduled Amount"
},
"processedAmount": {
"type": "number",
"description": "Processed Amount"
},
"sequenceId": {
"type": "integer",
"format": "int64",
"description": "Sequence Id"
},
"transactionDetails": {
"type": "object",
"description": "Setting Worker Pay Component Scheduled Entry Transactions Data."
}
}
},
"description": "Worker Pay Comp Scheduled Entries"
}
},
"required": [
"PCID",
"workerId"
]
}
paychex_payroll_delete_check_earning_by_id
Pay Component of a check Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
checkId | string | Yes | — | ID associated with desired check. |
checkComponentId | string | Yes | — | ID associated with an Earning of this check |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"checkId": {
"type": "string",
"description": "ID associated with desired check."
},
"checkComponentId": {
"type": "string",
"description": "ID associated with an Earning of this check"
}
},
"required": [
"PCID",
"checkId",
"checkComponentId"
]
}
paychex_payroll_delete_checks_by_pay_period_id_user_id
Checks by Pay Period and User Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
payperiodid | string | Yes | — | ID associated with desired pay period. |
deletebyuserid | boolean | Yes | — | Value for deletebyuserid parameter should be “true” |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"payperiodid": {
"type": "string",
"description": "ID associated with desired pay period."
},
"deletebyuserid": {
"type": "boolean",
"description": "Value for deletebyuserid parameter should be \"true\""
}
},
"required": [
"PCID",
"payperiodid",
"deletebyuserid"
]
}
paychex_payroll_delete_worker_check
Worker Check Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
workerId | string | Yes | — | ID associated with desired worker. |
externalCheckId | string | Yes | — | The external check ID. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"workerId": {
"type": "string",
"description": "ID associated with desired worker."
},
"externalCheckId": {
"type": "string",
"description": "The external check ID."
}
},
"required": [
"PCID",
"workerId",
"externalCheckId"
]
}
paychex_payroll_delete_worker_direct_deposit
Worker Direct Deposit Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
workerId | string | Yes | — | ID associated with desired worker. |
directDepositId | string | Yes | — | The id assigned to the direct deposit for this worker. |
effectivitydate | string | No | — | The effectivity date. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"workerId": {
"type": "string",
"description": "ID associated with desired worker."
},
"directDepositId": {
"type": "string",
"description": "The id assigned to the direct deposit for this worker."
},
"effectivitydate": {
"type": "string",
"description": "The effectivity date."
}
},
"required": [
"PCID",
"workerId",
"directDepositId"
]
}
paychex_payroll_delete_worker_pay_rate
Worker Pay Rate Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
workerId | string | Yes | — | ID associated with desired worker. |
rateId | string | Yes | — | The id of a single workers compensation rate. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"workerId": {
"type": "string",
"description": "ID associated with desired worker."
},
"rateId": {
"type": "string",
"description": "The id of a single workers compensation rate."
}
},
"required": [
"PCID",
"workerId",
"rateId"
]
}
paychex_payroll_delete_worker_recurring
Worker Pay Component Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
workerId | string | Yes | — | ID associated with desired worker. |
workerComponentId | string | Yes | — | The id of a single pay component that a workers has. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"workerId": {
"type": "string",
"description": "ID associated with desired worker."
},
"workerComponentId": {
"type": "string",
"description": "The id of a single pay component that a workers has."
}
},
"required": [
"PCID",
"workerId",
"workerComponentId"
]
}
paychex_payroll_get_company_checks
Company Checks Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
companyId | string | Yes | — | ID associated with desired company. |
payperiodid | string | Yes | — | The id assigned to the pay period that the check will be within. |
offset | integer | No | — | The zero based offset of the next page of data to be presented. |
limit | integer | No | — | The maximum number of elements to be returned in a page transition. |
filterbyuserid | boolean | No | — | Filter by User Id. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"companyId": {
"type": "string",
"description": "ID associated with desired company."
},
"payperiodid": {
"type": "string",
"description": "The id assigned to the pay period that the check will be within."
},
"offset": {
"type": "integer",
"description": "The zero based offset of the next page of data to be presented."
},
"limit": {
"type": "integer",
"description": "The maximum number of elements to be returned in a page transition."
},
"filterbyuserid": {
"type": "boolean",
"description": "Filter by User Id."
}
},
"required": [
"PCID",
"companyId",
"payperiodid"
]
}
paychex_payroll_get_worker_check
Worker Check Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
workerId | string | Yes | — | ID associated with desired worker. |
externalCheckId | string | Yes | — | The external check ID. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"workerId": {
"type": "string",
"description": "ID associated with desired worker."
},
"externalCheckId": {
"type": "string",
"description": "The external check ID."
}
},
"required": [
"PCID",
"workerId",
"externalCheckId"
]
}
paychex_payroll_get_worker_checks
Worker Checks Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
workerId | string | Yes | — | ID associated with desired worker. |
payperiodid | string | Yes | — | The id assigned to the pay period that the check will be within. |
filterbyuserid | boolean | No | — | Filter by User Id. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"workerId": {
"type": "string",
"description": "ID associated with desired worker."
},
"payperiodid": {
"type": "string",
"description": "The id assigned to the pay period that the check will be within."
},
"filterbyuserid": {
"type": "boolean",
"description": "Filter by User Id."
}
},
"required": [
"PCID",
"workerId",
"payperiodid"
]
}
paychex_payroll_get_worker_compensation_standard_rates_1
Worker Compensation Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
workerId | string | Yes | — | ID associated with desired worker. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"workerId": {
"type": "string",
"description": "ID associated with desired worker."
}
},
"required": [
"PCID",
"workerId"
]
}
paychex_payroll_get_worker_direct_deposit_by_id
Worker Direct Deposit Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
workerId | string | Yes | — | ID associated with desired worker. |
directDepositId | string | Yes | — | The id assigned to the direct deposit for this worker. |
effectivitydate | string | No | — | The effectivity date. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"workerId": {
"type": "string",
"description": "ID associated with desired worker."
},
"directDepositId": {
"type": "string",
"description": "The id assigned to the direct deposit for this worker."
},
"effectivitydate": {
"type": "string",
"description": "The effectivity date."
}
},
"required": [
"PCID",
"workerId",
"directDepositId"
]
}
paychex_payroll_get_worker_direct_deposits
Worker Direct Deposits Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
workerId | string | Yes | — | ID associated with desired worker. |
effectivitydate | string | No | — | The effectivity date. |
asof | string | No | — | Returns all direct deposits as of the date used in the request |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"workerId": {
"type": "string",
"description": "ID associated with desired worker."
},
"effectivitydate": {
"type": "string",
"description": "The effectivity date."
},
"asof": {
"type": "string",
"description": "Returns all direct deposits as of the date used in the request"
}
},
"required": [
"PCID",
"workerId"
]
}
paychex_payroll_get_worker_federal_tax
Worker Federal Tax Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
workerId | string | Yes | — | ID associated with desired worker. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"workerId": {
"type": "string",
"description": "ID associated with desired worker."
}
},
"required": [
"PCID",
"workerId"
]
}
paychex_payroll_get_worker_pay_rates
Worker Pay Rates Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
workerId | string | Yes | — | ID associated with desired worker. |
asof | string | No | — | Returns all pay rates as of the date used in the request |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"workerId": {
"type": "string",
"description": "ID associated with desired worker."
},
"asof": {
"type": "string",
"description": "Returns all pay rates as of the date used in the request"
}
},
"required": [
"PCID",
"workerId"
]
}
paychex_payroll_get_worker_pay_rates_by_id
Worker Pay Rate Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
workerId | string | Yes | — | ID associated with desired worker. |
rateId | string | Yes | — | The id of a single workers compensation rate. |
asof | string | No | — | Returns compensation as of the date used in the request |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"workerId": {
"type": "string",
"description": "ID associated with desired worker."
},
"rateId": {
"type": "string",
"description": "The id of a single workers compensation rate."
},
"asof": {
"type": "string",
"description": "Returns compensation as of the date used in the request"
}
},
"required": [
"PCID",
"workerId",
"rateId"
]
}
paychex_payroll_get_worker_pay_standards
Worker Pay Standards Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
workerId | string | Yes | — | ID associated with desired worker. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"workerId": {
"type": "string",
"description": "ID associated with desired worker."
}
},
"required": [
"PCID",
"workerId"
]
}
paychex_payroll_get_worker_recurring_by_id
Worker Pay Component Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
workerId | string | Yes | — | ID associated with desired worker. |
workerComponentId | string | Yes | — | The id of a single pay component that a “Active” worker has. |
asof | string | No | — | Returns pay component as of the date used in the request |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"workerId": {
"type": "string",
"description": "ID associated with desired worker."
},
"workerComponentId": {
"type": "string",
"description": "The id of a single pay component that a \"Active\" worker has."
},
"asof": {
"type": "string",
"description": "Returns pay component as of the date used in the request"
}
},
"required": [
"PCID",
"workerId",
"workerComponentId"
]
}
paychex_payroll_get_worker_recurrings
Worker Pay Components Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
workerId | string | Yes | — | ID associated with desired worker. |
effectonpay | string | No | — | What the effect on pay will be (REDUCTION OR ADDITION), currently only reductions are available. |
asof | string | No | — | Returns all pay components as of the date used in the request |
name | string | No | — | The name of a pay component that a workers has. |
componentid | string | No | — | The unique identifier of the pay component. |
classificationtype | string | No | — | The classification type of a pay component that a worker has. (such as “DEDUCTION”, or “REGULAR”,) |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"workerId": {
"type": "string",
"description": "ID associated with desired worker."
},
"effectonpay": {
"type": "string",
"description": "What the effect on pay will be (REDUCTION OR ADDITION), currently only reductions are available."
},
"asof": {
"type": "string",
"description": "Returns all pay components as of the date used in the request"
},
"name": {
"type": "string",
"description": "The name of a pay component that a workers has."
},
"componentid": {
"type": "string",
"description": "The unique identifier of the pay component."
},
"classificationtype": {
"type": "string",
"description": "The classification type of a pay component that a worker has. (such as \"DEDUCTION\", or \"REGULAR\",)"
}
},
"required": [
"PCID",
"workerId"
]
}
paychex_payroll_get_worker_state_taxes
Worker State Tax Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
workerId | string | Yes | — | ID associated with desired worker. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"workerId": {
"type": "string",
"description": "ID associated with desired worker."
}
},
"required": [
"PCID",
"workerId"
]
}
paychex_payroll_get_worker_time_off
Worker Time Off Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
workerId | string | Yes | — | The ID of the worker. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"workerId": {
"type": "string",
"description": "The ID of the worker."
}
},
"required": [
"PCID",
"workerId"
]
}
paychex_payroll_patch_check_component_by_id
Pay Component of a Check Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
checkId | string | Yes | — | ID associated with desired check. |
checkComponentId | string | Yes | — | ID associated with an Earning of this check |
appliesToWorkerTypes | string[] | No | — | Applies To WorkerTypes. |
classificationType | string | No | — | The category that this component falls into. |
componentId | string | No | — | 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. |
description | string | No | — | The description value |
effectOnPay | string | No | — | The effect that the pay component will have on the check amount. |
endDate | string | No | — | The date that the pay component is not available to be applied on a check moving forward. |
jobId | string | No | — | 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 | No | — | 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. |
lineDate | string | No | — | This is used optionally for specifying a date that the pay component was generated on. |
memoed | boolean | No | — | This is used optionally for memoing the payHours or payUnits so that they are informational when using a payAmount. |
name | string | No | — | The name given to the pay component |
payAmount | string | No | — | The flat amount to be applied for this component. Not used with Rate, Hours, or Units. |
payHours | string | No | — | The number of hours that will be applied for this component. Used in conjunction with rate. |
payRate | string | No | — | The rate amount that will be applied for this component. Used in conjunction with Hours or Units. |
payRateId | string | No | — | The rate identifier for the workers compensation |
payUnits | string | No | — | The number of units that will be applied for this component. Used in conjunction with rate. |
recurring | boolean | No | — | 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. |
startDate | string | No | — | The date that the pay component is able to be applied on a check. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"checkId": {
"type": "string",
"description": "ID associated with desired check."
},
"checkComponentId": {
"type": "string",
"description": "ID associated with an Earning of this check"
},
"appliesToWorkerTypes": {
"type": "array",
"items": {
"type": "string",
"enum": [
"EMPLOYEE",
"CONTRACTOR",
"INDEPENDENT_CONTRACTOR"
]
},
"description": "Applies To WorkerTypes."
},
"classificationType": {
"type": "string",
"description": "The category that this component falls into."
},
"componentId": {
"type": "string",
"description": "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."
},
"description": {
"type": "string",
"description": "The description value"
},
"effectOnPay": {
"type": "string",
"description": "The effect that the pay component will have on the check amount.",
"enum": [
"ADDITION",
"ADDITION_WITH_IN_OUT",
"EMPLOYER_INFORMATIONAL",
"REDUCTION"
]
},
"endDate": {
"type": "string",
"description": "The date that the pay component is not available to be applied on a check moving forward."
},
"jobId": {
"type": "string",
"description": "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": {
"type": "string",
"description": "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."
},
"lineDate": {
"type": "string",
"description": "This is used optionally for specifying a date that the pay component was generated on."
},
"memoed": {
"type": "boolean",
"description": "This is used optionally for memoing the payHours or payUnits so that they are informational when using a payAmount."
},
"name": {
"type": "string",
"description": "The name given to the pay component"
},
"payAmount": {
"type": "string",
"description": "The flat amount to be applied for this component. Not used with Rate, Hours, or Units."
},
"payHours": {
"type": "string",
"description": "The number of hours that will be applied for this component. Used in conjunction with rate."
},
"payRate": {
"type": "string",
"description": "The rate amount that will be applied for this component. Used in conjunction with Hours or Units."
},
"payRateId": {
"type": "string",
"description": "The rate identifier for the workers compensation"
},
"payUnits": {
"type": "string",
"description": "The number of units that will be applied for this component. Used in conjunction with rate."
},
"recurring": {
"type": "boolean",
"description": "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."
},
"startDate": {
"type": "string",
"description": "The date that the pay component is able to be applied on a check."
}
},
"required": [
"PCID",
"checkId",
"checkComponentId"
]
}
paychex_payroll_patch_worker_state_taxes
Worker State Tax Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
workerId | string | Yes | — | ID associated with desired worker. |
additionalAmount | number | No | — | See state tax documentation |
additionalPercent | integer | No | — | See state tax documentation |
countrySubdivisionCode | string | No | — | The state abbreviation for a given state tax |
filingStatusType | string | No | — | The filing status of the worker for this state tax |
flatDollarOverride | number | No | — | See state tax documentation |
isResidentState | string | No | — | Whether this worker is a resident in this state |
overridePercent | number | No | — | See state tax documentation |
stateAllocationPercent | string | No | — | The percentage of a worker’s income to be applied to this state tax |
taxStatusType | string | No | — | The withholding status for this state tax |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"workerId": {
"type": "string",
"description": "ID associated with desired worker."
},
"additionalAmount": {
"type": "number",
"description": "See state tax documentation"
},
"additionalPercent": {
"type": "integer",
"description": "See state tax documentation"
},
"countrySubdivisionCode": {
"type": "string",
"description": "The state abbreviation for a given state tax"
},
"filingStatusType": {
"type": "string",
"description": "The filing status of the worker for this state tax"
},
"flatDollarOverride": {
"type": "number",
"description": "See state tax documentation"
},
"isResidentState": {
"type": "string",
"description": "Whether this worker is a resident in this state"
},
"overridePercent": {
"type": "number",
"description": "See state tax documentation"
},
"stateAllocationPercent": {
"type": "string",
"description": "The percentage of a worker's income to be applied to this state tax"
},
"taxStatusType": {
"type": "string",
"description": "The withholding status for this state tax"
}
},
"required": [
"PCID",
"workerId"
]
}
paychex_payroll_update_worker_direct_deposits_1
Worker Direct Deposits Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
workerId | string | Yes | — | ID associated with desired worker. |
effectivitydate | string | No | — | The effectivity date. Cannot be used with Content Type “application/json-patch+json” |
body | object[] | Yes | — | Request body |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"workerId": {
"type": "string",
"description": "ID associated with desired worker."
},
"effectivitydate": {
"type": "string",
"description": "The effectivity date. Cannot be used with Content Type \"application/json-patch+json\""
},
"body": {
"type": "array",
"items": {
"type": "object",
"properties": {
"directDepositId": {
"type": "string",
"description": "The ID for the direct deposit item."
},
"startDate": {
"type": "string",
"format": "date-time",
"description": "The date that this direct deposit will be applied to future pay periods. This data field cannot be PATCHED."
},
"paymentType": {
"type": "string",
"enum": [
"FLAT_DOLLAR_AMOUNT",
"PERCENTAGE",
"REMAINDER"
],
"description": "A type of payment for the direct deposit."
},
"accountType": {
"type": "string",
"enum": [
"CHECKING",
"SAVINGS"
],
"description": "Financial institutions account type. This data field cannot be PATCHED."
},
"value": {
"type": "number",
"description": "The amount to be applied to this direct deposit."
},
"routingNumber": {
"type": "string",
"description": "The financial institutions routing number.This data field cannot be PATCHED."
},
"accountNumber": {
"type": "string",
"description": "The financial institutions account number.This data field cannot be PATCHED."
},
"priority": {
"type": "string",
"description": "The priority order for which the direct deposits will be performed in. When a new direct deposit is added the priority will be assigned. The priority can be modified only by swapping with a different direct deposit using the bulk PATCH. A paymentType of REMAINDER will show a priority of 99 and can't be modified.This data field cannot be PATCHED."
},
"_links": {
"type": "object",
"description": "The links value"
}
}
},
"description": "Request body"
}
},
"required": [
"PCID",
"workerId",
"body"
]
}
paychex_payroll_update_worker_direct_deposits_2
Worker Direct Deposit Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
workerId | string | Yes | — | ID associated with desired worker. |
directDepositId | string | Yes | — | The id assigned to the direct deposit for this worker. |
effectivitydate | string | No | — | The effectivity date. Cannot be used with Content Type “application/json-patch+json” |
_links | object | No | — | The links value |
accountNumber | string | No | — | The financial institutions account number.This data field cannot be PATCHED. |
accountType | string | No | — | Financial institutions account type. This data field cannot be PATCHED. |
paymentType | string | No | — | A type of payment for the direct deposit. |
priority | string | No | — | The priority order for which the direct deposits will be performed in. When a new direct deposit is added the priority will be assigned. The priority can be modified only by swapping with a different direct deposit using the bulk PATCH. A paymentType of REMAINDER will show a priority of 99 and can’t be modified.This data field cannot be PATCHED. |
routingNumber | string | No | — | The financial institutions routing number.This data field cannot be PATCHED. |
startDate | string | No | — | The date that this direct deposit will be applied to future pay periods. This data field cannot be PATCHED. |
value | number | No | — | The amount to be applied to this direct deposit. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"workerId": {
"type": "string",
"description": "ID associated with desired worker."
},
"directDepositId": {
"type": "string",
"description": "The id assigned to the direct deposit for this worker."
},
"effectivitydate": {
"type": "string",
"description": "The effectivity date. Cannot be used with Content Type \"application/json-patch+json\""
},
"_links": {
"type": "object",
"description": "The links value"
},
"accountNumber": {
"type": "string",
"description": "The financial institutions account number.This data field cannot be PATCHED."
},
"accountType": {
"type": "string",
"description": "Financial institutions account type. This data field cannot be PATCHED.",
"enum": [
"CHECKING",
"SAVINGS"
]
},
"paymentType": {
"type": "string",
"description": "A type of payment for the direct deposit.",
"enum": [
"FLAT_DOLLAR_AMOUNT",
"PERCENTAGE",
"REMAINDER"
]
},
"priority": {
"type": "string",
"description": "The priority order for which the direct deposits will be performed in. When a new direct deposit is added the priority will be assigned. The priority can be modified only by swapping with a different direct deposit using the bulk PATCH. A paymentType of REMAINDER will show a priority of 99 and can't be modified.This data field cannot be PATCHED."
},
"routingNumber": {
"type": "string",
"description": "The financial institutions routing number.This data field cannot be PATCHED."
},
"startDate": {
"type": "string",
"description": "The date that this direct deposit will be applied to future pay periods. This data field cannot be PATCHED."
},
"value": {
"type": "number",
"description": "The amount to be applied to this direct deposit."
}
},
"required": [
"PCID",
"workerId",
"directDepositId"
]
}
paychex_payroll_update_worker_federal_tax
Worker Federal Tax Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
workerId | string | Yes | — | ID associated with desired worker. |
deductionsAmount | string | No | — | See federal W-4 instructions. |
dependentsAmount | string | No | — | See federal W-4 instructions. |
extraWithholdingAmount | string | No | — | See federal W-4 instructions. Can be used with extraWithholdingPercentage or overrideWithholdingPercentage. Cannot be used with overrideWithholdingAmount. If extraWithholdingAmount is entered, existing overrideWithholdingAmount data will be removed. |
extraWithholdingPercentage | string | No | — | See federal W-4 instructions. Can be used with extraWithholdingAmount. Cannot be used with overrideWithholdingAmount or overrideWithholdingPercentage. If entered, existing overrideWithholdingAmount and overrideWithholdingPercentage data will be removed. |
filingStatus | string | No | — | Filing status. |
multipleJobs | string | No | — | See federal W-4 instructions. |
otherIncome | string | No | — | See federal W-4 instructions. |
overrideWithholdingAmount | string | No | — | See federal W-4 instructions. Cannot be used with extraWithholdingAmount, extraWithholdingPercentage, or overrideWithholdingPercentage. If entered, existing extraWithholdingAmount, extraWithholdingPercentage, and overrideWithholdingPercentage data will be removed. |
overrideWithholdingPercentage | string | No | — | See federal W-4 instructions. Can be used with extraWithholdingAmount. Cannot be used with overrideWithholdingAmount or extraWithholdingPercentage. If entered, existing overrideWithholdingAmount and extraWithholdingPercentage data will be removed. |
taxesWithheld | string | No | — | Should federal taxes be withheld: true means federal taxes are withheld, false means federal taxes are NOT withheld. Earnings will still be reported to state and federal agencies. |
taxId | string | No | — | The ID for the federal tax item. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"workerId": {
"type": "string",
"description": "ID associated with desired worker."
},
"deductionsAmount": {
"type": "string",
"description": "See federal W-4 instructions."
},
"dependentsAmount": {
"type": "string",
"description": "See federal W-4 instructions."
},
"extraWithholdingAmount": {
"type": "string",
"description": "See federal W-4 instructions. Can be used with extraWithholdingPercentage or overrideWithholdingPercentage. Cannot be used with overrideWithholdingAmount. If extraWithholdingAmount is entered, existing overrideWithholdingAmount data will be removed."
},
"extraWithholdingPercentage": {
"type": "string",
"description": "See federal W-4 instructions. Can be used with extraWithholdingAmount. Cannot be used with overrideWithholdingAmount or overrideWithholdingPercentage. If entered, existing overrideWithholdingAmount and overrideWithholdingPercentage data will be removed."
},
"filingStatus": {
"type": "string",
"description": "Filing status.",
"enum": [
"SINGLE_OR_MARRIED_FILING_SEPARATELY",
"MARRIED_FILING_JOINTLY",
"HEAD_OF_HOUSEHOLD"
]
},
"multipleJobs": {
"type": "string",
"description": "See federal W-4 instructions.",
"enum": [
"true",
"false"
]
},
"otherIncome": {
"type": "string",
"description": "See federal W-4 instructions."
},
"overrideWithholdingAmount": {
"type": "string",
"description": "See federal W-4 instructions. Cannot be used with extraWithholdingAmount, extraWithholdingPercentage, or overrideWithholdingPercentage. If entered, existing extraWithholdingAmount, extraWithholdingPercentage, and overrideWithholdingPercentage data will be removed."
},
"overrideWithholdingPercentage": {
"type": "string",
"description": "See federal W-4 instructions. Can be used with extraWithholdingAmount. Cannot be used with overrideWithholdingAmount or extraWithholdingPercentage. If entered, existing overrideWithholdingAmount and extraWithholdingPercentage data will be removed."
},
"taxesWithheld": {
"type": "string",
"description": "Should federal taxes be withheld: true means federal taxes are withheld, false means federal taxes are NOT withheld. Earnings will still be reported to state and federal agencies.",
"enum": [
"true",
"false"
]
},
"taxId": {
"type": "string",
"description": "The ID for the federal tax item."
}
},
"required": [
"PCID",
"workerId"
]
}
paychex_payroll_update_worker_pay_rate
Worker Pay Rate Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
workerId | string | Yes | — | ID associated with desired worker. |
rateId | string | Yes | — | The id of a single workers compensation rate. |
_links | object | No | — | The links value |
amount | string | No | — | The currency amount which this rate is applied. |
default | boolean | No | — | If this rate is the default one to apply on the worker. This data field is not available for an IN_PROGRESS worker and is considered RATE_1. |
description | string | No | — | Describes the rate for the worker. A maximum of 30 characters is allowed. |
effectiveDate | string | No | — | The date when the pay rate becomes effective for the worker (can be used only in POST/PATCH for an active worker). |
rateNumber | string | No | — | The number of the rate. A worker can have up to 25 different rates. |
rateType | string | No | — | Type of rate. |
standardHours | string | No | — | Default standard hours that this rate is used with a pay frequency. This data field is not available for an IN_PROGRESS worker. |
standardOvertime | string | No | — | Default over time hours that this rate is used with a pay frequency. This data field is not available for an IN_PROGRESS worker. |
startDate | string | No | — | The date when the pay rate is going to begin. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"workerId": {
"type": "string",
"description": "ID associated with desired worker."
},
"rateId": {
"type": "string",
"description": "The id of a single workers compensation rate."
},
"_links": {
"type": "object",
"description": "The links value"
},
"amount": {
"type": "string",
"description": "The currency amount which this rate is applied."
},
"default": {
"type": "boolean",
"description": "If this rate is the default one to apply on the worker. This data field is not available for an IN_PROGRESS worker and is considered RATE_1."
},
"description": {
"type": "string",
"description": "Describes the rate for the worker. A maximum of 30 characters is allowed."
},
"effectiveDate": {
"type": "string",
"description": "The date when the pay rate becomes effective for the worker (can be used only in POST/PATCH for an active worker)."
},
"rateNumber": {
"type": "string",
"description": "The number of the rate. A worker can have up to 25 different rates."
},
"rateType": {
"type": "string",
"description": "Type of rate.",
"enum": [
"ANNUAL_SALARY",
"PER_PAY_PERIOD_SALARY",
"PIECEWORK_RATE",
"DAILY_RATE",
"HOURLY_RATE"
]
},
"standardHours": {
"type": "string",
"description": "Default standard hours that this rate is used with a pay frequency. This data field is not available for an IN_PROGRESS worker."
},
"standardOvertime": {
"type": "string",
"description": "Default over time hours that this rate is used with a pay frequency. This data field is not available for an IN_PROGRESS worker."
},
"startDate": {
"type": "string",
"description": "The date when the pay rate is going to begin."
}
},
"required": [
"PCID",
"workerId",
"rateId"
]
}
paychex_payroll_update_worker_recurring
Worker Pay Component Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
workerId | string | Yes | — | ID associated with desired worker. |
workerComponentId | string | Yes | — | The id of a single pay component that a workers has. |
_links | object | No | — | The links value |
calculationBaseId | string | No | — | This is required if you are not using a FLAT_DOLLAR_AMOUNT Calculation Type. |
calculationType | string | No | — | The type of calculation that will be applied for the pay component . |
checkLimit | object | No | — | Check Limit |
classificationType | string | No | — | The category that this component falls into. |
componentId | string | No | — | The unique identifier of the pay component. This data field cannot be PATCHED. |
effectiveDate | string | No | — | Date which this pay component has started for the worker. |
effectOnPay | string | No | — | What the effect on pay will be (REDUCTION OR ADDITION), currently only reductions are available. This data field will be populated automatically based on componentId. This data field cannot be PATCHED |
endDate | string | No | — | Date which this pay component has ended for the worker. |
frequency | object | No | — | Worker pay frequency |
name | string | No | — | Name of the pay component. This data field will be populated automatically based on componentId. |
startDate | string | No | — | Date which this pay component will start to be applied during the payruns. This is an optional field that default to current datetime if not provided. This cannot be backdated but can be added to start in the future. |
transactions | object[] | No | — | Pay Component transaction details. |
value | number | No | — | This is used to specify the value that is used against the calculationType. |
workerPayCompScheduledEntries | object[] | No | — | Worker Pay Comp Scheduled Entries |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"workerId": {
"type": "string",
"description": "ID associated with desired worker."
},
"workerComponentId": {
"type": "string",
"description": "The id of a single pay component that a workers has."
},
"_links": {
"type": "object",
"description": "The links value"
},
"calculationBaseId": {
"type": "string",
"description": "This is required if you are not using a FLAT_DOLLAR_AMOUNT Calculation Type."
},
"calculationType": {
"type": "string",
"description": "The type of calculation that will be applied for the pay component .",
"enum": [
"FLAT_DOLLAR_AMOUNT",
"PERCENTAGE",
"RATE_X_UNITS",
"RATE_X_HOURS"
]
},
"checkLimit": {
"type": "object",
"description": "Check Limit",
"properties": {
"type": {
"type": "string",
"description": "This is used to determine what type of limitations to apply.",
"enum": [
"NONE",
"STOPS_AT",
"STOPS_AT_NEW_AMOUNT",
"BASED_ON_YTD_CASH_WAGES",
"AMOUNT_PER_CHECK"
]
},
"startsAt": {
"type": "string",
"description": "This is the the amount that the calculation will begin with."
},
"stopsAt": {
"type": "string",
"description": "This is the upper limit of the amount that can be applied."
},
"amount": {
"type": "string",
"description": "This is the amount that will be taken from each check"
}
}
},
"classificationType": {
"type": "string",
"description": "The category that this component falls into."
},
"componentId": {
"type": "string",
"description": "The unique identifier of the pay component. This data field cannot be PATCHED."
},
"effectiveDate": {
"type": "string",
"description": "Date which this pay component has started for the worker."
},
"effectOnPay": {
"type": "string",
"description": "What the effect on pay will be (REDUCTION OR ADDITION), currently only reductions are available. This data field will be populated automatically based on componentId. This data field cannot be PATCHED"
},
"endDate": {
"type": "string",
"description": "Date which this pay component has ended for the worker."
},
"frequency": {
"type": "object",
"description": "Worker pay frequency",
"properties": {
"applied": {
"type": "string",
"description": "Currently we only support a BY_PAY_PERIOD value for the API."
},
"occurrence": {
"type": "string",
"description": "This is how often the pay component will be applied on the pay run. The available values for this will depend on the payFrequency that a worker is paid which can be found on the worker compensations pay standards."
},
"occurrenceIntervals": {
"type": "object",
"description": "These are sub intervals that are used for occurrences that are larger in duration that allow you to define when to apply the pay component. You can reference the payFrequency and occurance to determine what intervals and values applicable."
},
"effectedChecks": {
"type": "string",
"description": "Which check(s) within the payrun that the paycomponent will be applied to.FIRST_CHECK: The Pay Component will be applied to the first check for the worker within the pay run. This is used for a pay component that only should be applied once like a health insurance deduction.EVERY_CHECK: The Pay Component will be applied to all of the checks for the worker within the pay run. This is used for a pay component that is applied on all check like a retirement deduction."
}
}
},
"name": {
"type": "string",
"description": "Name of the pay component. This data field will be populated automatically based on componentId."
},
"startDate": {
"type": "string",
"description": "Date which this pay component will start to be applied during the payruns. This is an optional field that default to current datetime if not provided. This cannot be backdated but can be added to start in the future."
},
"transactions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"transactionId": {
"type": "string",
"description": "Transaction Id"
},
"date": {
"type": "string",
"format": "date-time",
"description": "The date value"
},
"amount": {
"type": "number",
"description": "The amount value"
}
}
},
"description": "Pay Component transaction details."
},
"value": {
"type": "number",
"description": "This is used to specify the value that is used against the calculationType."
},
"workerPayCompScheduledEntries": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"description": "The id value"
},
"workerCalcMethodId": {
"type": "integer",
"format": "int64",
"description": "Worker Calc Method Id"
},
"clientPayrollId": {
"type": "integer",
"format": "int64",
"description": "Client Payroll Id"
},
"checkDate": {
"type": "string",
"format": "date-time",
"description": "Check Date"
},
"scheduledAmount": {
"type": "number",
"description": "Scheduled Amount"
},
"processedAmount": {
"type": "number",
"description": "Processed Amount"
},
"sequenceId": {
"type": "integer",
"format": "int64",
"description": "Sequence Id"
},
"transactionDetails": {
"type": "object",
"description": "Setting Worker Pay Component Scheduled Entry Transactions Data."
}
}
},
"description": "Worker Pay Comp Scheduled Entries"
}
},
"required": [
"PCID",
"workerId",
"workerComponentId"
]
}
paychex_payroll_update_worker_recurrings
Worker Pay Components Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
workerId | string | Yes | — | ID associated with desired worker. |
_links | object | No | — | The links value |
calculationBaseId | string | No | — | This is required if you are not using a FLAT_DOLLAR_AMOUNT Calculation Type. |
calculationType | string | No | — | The type of calculation that will be applied for the pay component . |
checkLimit | object | No | — | Check Limit |
classificationType | string | No | — | The category that this component falls into. |
componentId | string | No | — | The unique identifier of the pay component. This data field cannot be PATCHED. |
effectiveDate | string | No | — | Date which this pay component has started for the worker. |
effectOnPay | string | No | — | What the effect on pay will be (REDUCTION OR ADDITION), currently only reductions are available. This data field will be populated automatically based on componentId. This data field cannot be PATCHED |
endDate | string | No | — | Date which this pay component has ended for the worker. |
frequency | object | No | — | Worker pay frequency |
name | string | No | — | Name of the pay component. This data field will be populated automatically based on componentId. |
startDate | string | No | — | Date which this pay component will start to be applied during the payruns. This is an optional field that default to current datetime if not provided. This cannot be backdated but can be added to start in the future. |
transactions | object[] | No | — | Pay Component transaction details. |
value | number | No | — | This is used to specify the value that is used against the calculationType. |
workerComponentId | string | No | — | The id of a single pay component that a workers has. |
workerPayCompScheduledEntries | object[] | No | — | Worker Pay Comp Scheduled Entries |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"workerId": {
"type": "string",
"description": "ID associated with desired worker."
},
"_links": {
"type": "object",
"description": "The links value"
},
"calculationBaseId": {
"type": "string",
"description": "This is required if you are not using a FLAT_DOLLAR_AMOUNT Calculation Type."
},
"calculationType": {
"type": "string",
"description": "The type of calculation that will be applied for the pay component .",
"enum": [
"FLAT_DOLLAR_AMOUNT",
"PERCENTAGE",
"RATE_X_UNITS",
"RATE_X_HOURS"
]
},
"checkLimit": {
"type": "object",
"description": "Check Limit",
"properties": {
"type": {
"type": "string",
"description": "This is used to determine what type of limitations to apply.",
"enum": [
"NONE",
"STOPS_AT",
"STOPS_AT_NEW_AMOUNT",
"BASED_ON_YTD_CASH_WAGES",
"AMOUNT_PER_CHECK"
]
},
"startsAt": {
"type": "string",
"description": "This is the the amount that the calculation will begin with."
},
"stopsAt": {
"type": "string",
"description": "This is the upper limit of the amount that can be applied."
},
"amount": {
"type": "string",
"description": "This is the amount that will be taken from each check"
}
}
},
"classificationType": {
"type": "string",
"description": "The category that this component falls into."
},
"componentId": {
"type": "string",
"description": "The unique identifier of the pay component. This data field cannot be PATCHED."
},
"effectiveDate": {
"type": "string",
"description": "Date which this pay component has started for the worker."
},
"effectOnPay": {
"type": "string",
"description": "What the effect on pay will be (REDUCTION OR ADDITION), currently only reductions are available. This data field will be populated automatically based on componentId. This data field cannot be PATCHED"
},
"endDate": {
"type": "string",
"description": "Date which this pay component has ended for the worker."
},
"frequency": {
"type": "object",
"description": "Worker pay frequency",
"properties": {
"applied": {
"type": "string",
"description": "Currently we only support a BY_PAY_PERIOD value for the API."
},
"occurrence": {
"type": "string",
"description": "This is how often the pay component will be applied on the pay run. The available values for this will depend on the payFrequency that a worker is paid which can be found on the worker compensations pay standards."
},
"occurrenceIntervals": {
"type": "object",
"description": "These are sub intervals that are used for occurrences that are larger in duration that allow you to define when to apply the pay component. You can reference the payFrequency and occurance to determine what intervals and values applicable."
},
"effectedChecks": {
"type": "string",
"description": "Which check(s) within the payrun that the paycomponent will be applied to.FIRST_CHECK: The Pay Component will be applied to the first check for the worker within the pay run. This is used for a pay component that only should be applied once like a health insurance deduction.EVERY_CHECK: The Pay Component will be applied to all of the checks for the worker within the pay run. This is used for a pay component that is applied on all check like a retirement deduction."
}
}
},
"name": {
"type": "string",
"description": "Name of the pay component. This data field will be populated automatically based on componentId."
},
"startDate": {
"type": "string",
"description": "Date which this pay component will start to be applied during the payruns. This is an optional field that default to current datetime if not provided. This cannot be backdated but can be added to start in the future."
},
"transactions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"transactionId": {
"type": "string",
"description": "Transaction Id"
},
"date": {
"type": "string",
"format": "date-time",
"description": "The date value"
},
"amount": {
"type": "number",
"description": "The amount value"
}
}
},
"description": "Pay Component transaction details."
},
"value": {
"type": "number",
"description": "This is used to specify the value that is used against the calculationType."
},
"workerComponentId": {
"type": "string",
"description": "The id of a single pay component that a workers has."
},
"workerPayCompScheduledEntries": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"description": "The id value"
},
"workerCalcMethodId": {
"type": "integer",
"format": "int64",
"description": "Worker Calc Method Id"
},
"clientPayrollId": {
"type": "integer",
"format": "int64",
"description": "Client Payroll Id"
},
"checkDate": {
"type": "string",
"format": "date-time",
"description": "Check Date"
},
"scheduledAmount": {
"type": "number",
"description": "Scheduled Amount"
},
"processedAmount": {
"type": "number",
"description": "Processed Amount"
},
"sequenceId": {
"type": "integer",
"format": "int64",
"description": "Sequence Id"
},
"transactionDetails": {
"type": "object",
"description": "Setting Worker Pay Component Scheduled Entry Transactions Data."
}
}
},
"description": "Worker Pay Comp Scheduled Entries"
}
},
"required": [
"PCID",
"workerId"
]
}