{ "openapi": "3.0.3", "info": { "title": "External API", "description": "\n\n# Developer Resources\n Refer\n[Developer Resources](/resources/overview/) for more details on API specification \n \n# Getting started \n \n[Click here to open the Getting Started page](/getting-started/overview)\n\t", "version": "1.0" }, "servers": [ { "url": "https://api.paychex.com" } ], "tags": [ { "name": "Authentication" }, { "name": "Company" }, { "name": "Payroll" }, { "name": "Worker" }, { "name": "Webhooks" }, { "name": "Management" } ], "paths": { "/auth/oauth/v2/token": { "post": { "tags": [ "Authentication" ], "summary": "Create Bearer token", "description": "Request a Bearer token that will be used as an access token when making calls to resources. The credentials need to be sent within the body of the request.", "requestBody": { "description": "user info to be filled", "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "required": [ "grant_type", "client_id", "client_secret" ], "properties": { "grant_type": { "type": "string", "description": "Send \"client_credentials\"." }, "client_id": { "type": "string", "description": "The applications API key." }, "client_secret": { "type": "string", "description": "The applications corresponding secret." } } } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Authentication" } } } } } } }, "/companies": { "get": { "tags": [ "Company" ], "summary": "Companies", "description": "Array of companies that your application has been granted with some level of access. Your Application (API Key) can be granted access to one or more companies (clients) accounts that are associated with one or more product lines within Paychex.", "operationId": "getCompanies_1", "parameters": [ { "name": "displayid", "in": "query", "description": "The client account number used for identification purposes. (no dash or spaces allowed, only the last 8 characters of the ID)", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/vnd.paychex.companies.v1+json": { "schema": { "$ref": "#/components/schemas/CompanyResource" }, "examples": { "Companies": { "$ref": "#/components/examples/JSONEXAMPLES/value/COMPANIES_GET" } } }, "application/json": { "schema": { "$ref": "#/components/schemas/CompanyResource" }, "examples": { "defaultResponse": { "$ref": "#/components/examples/JSONEXAMPLES/value/COMPANIES_GET" } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-102", "description": "The client could not be authenticated due to missing or invalid client credentials.", "resolution": "Make sure that you are using the correct API key/Secret and that your application is enabled." } ] } } } }, "403": { "description": "User doesn't have access to this endpoint (API-2)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-2", "description": "Your application is not authorized to access the resource.", "resolution": "Please have your company administrator give your application access to the resource." } ] } } } }, "404": { "description": "No companies found matching search criteria. (API-43)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-7", "description": "The resource or status is invalid. You may have an incorrect resource ID.", "resolution": "Send a valid resource in your request" } ] } } } }, "405": { "description": "Unsupported method type (API-59)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-59", "description": "The request method type is unsupported." } ] } } } }, "406": { "description": "Unsupported Accept header", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-75", "description": "Invalid vendor media type.", "resolution": "Please refer to our documentation and send the correct vendor media type" } ] } } } }, "500": { "description": "Internal Server Error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-1", "description": "Internal Server Error.", "resolution": "Please contact Paychex API Developer Center Support." } ] } } } } } } }, "/companies/{companyId}": { "get": { "tags": [ "Company" ], "summary": "A Company", "description": "Information about a single company that your application has access to.", "operationId": "getCompany_1", "parameters": [ { "name": "companyId", "in": "path", "description": "The ID of the company.", "required": true, "schema": { "type": "string" } }, { "name": "includelineage", "in": "query", "required": false, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/vnd.paychex.company.v1+json": { "schema": { "$ref": "#/components/schemas/CompanyResource" }, "examples": { "company": { "$ref": "#/components/examples/JSONEXAMPLES/value/COMPANY_GET" } } }, "application/json": { "schema": { "$ref": "#/components/schemas/CompanyResource" }, "examples": { "defaultResponse": { "$ref": "#/components/examples/JSONEXAMPLES/value/COMPANY_GET" } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-102", "description": "The client could not be authenticated due to missing or invalid client credentials.", "resolution": "Make sure that you are using the correct API key/Secret and that your application is enabled." } ] } } } }, "403": { "description": "User doesn't have access to this endpoint (API-2), Client has been end dated (API-68)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-2", "description": "Your application is not authorized to access the resource.", "resolution": "Please have your company administrator give your application access to the resource." } ] } } } }, "404": { "description": "Invalid resource ID (API-7)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-7", "description": "The resource or status is invalid. You may have an incorrect resource ID.", "resolution": "Send a valid resource in your request" } ] } } } }, "405": { "description": "Unsupported method type (API-59)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-59", "description": "The request method type is unsupported." } ] } } } }, "406": { "description": "Unsupported Accept header", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-75", "description": "Invalid vendor media type.", "resolution": "Please refer to our documentation and send the correct vendor media type" } ] } } } }, "409": { "description": "default response" }, "500": { "description": "Internal Server Error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-1", "description": "Internal Server Error.", "resolution": "Please contact Paychex API Developer Center Support." } ] } } } } } } }, "/companies/{companyId}/calculationbases": { "get": { "tags": [ "Company" ], "summary": "Company Calculation Bases", "description": "Array of calculation bases that are used with a worker pay components that are not FLAT_DOLLAR_AMOUNT allow you to determine what to apply the calculation against when determining the amount during the pay run.", "operationId": "getCompanyCalculationBases", "parameters": [ { "name": "companyId", "in": "path", "description": "The ID of the company.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/vnd.paychex.payroll.calculationbases.v1+json": { "schema": { "$ref": "#/components/schemas/CalculationBase" }, "examples": { "CompanyCalculationBases": { "$ref": "#/components/examples/JSONEXAMPLES/value/COMPANY_CALCBASE_GET" } } }, "application/json": { "schema": { "$ref": "#/components/schemas/CalculationBase" }, "examples": { "defaultResponse": { "$ref": "#/components/examples/JSONEXAMPLES/value/COMPANY_CALCBASE_GET" } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-102", "description": "The client could not be authenticated due to missing or invalid client credentials.", "resolution": "Make sure that you are using the correct API key/Secret and that your application is enabled." } ] } } } }, "403": { "description": "User doesn't have access to this endpoint (API-2), Client has been end dated (API-68)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-2", "description": "Your application is not authorized to access the resource.", "resolution": "Please have your company administrator give your application access to the resource." } ] } } } }, "404": { "description": "Invalid resource ID (API-7)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-7", "description": "The resource or status is invalid. You may have an incorrect resource ID.", "resolution": "Send a valid resource in your request" } ] } } } }, "405": { "description": "Unsupported method type (API-59)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-59", "description": "The request method type is unsupported." } ] } } } }, "406": { "description": "Unsupported Accept header", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-75", "description": "Invalid vendor media type.", "resolution": "Please refer to our documentation and send the correct vendor media type" } ] } } } }, "500": { "description": "Internal Server Error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-1", "description": "Internal Server Error.", "resolution": "Please contact Paychex API Developer Center Support." } ] } } } } } } }, "/companies/{companyId}/checks": { "get": { "tags": [ "Payroll" ], "summary": "Company Checks", "description": "Get check(s) that are for a specific company within a processed or unprocessed pay period.", "operationId": "getCompanyChecks", "parameters": [ { "name": "companyId", "in": "path", "description": "ID associated with desired company.", "required": true, "schema": { "type": "string" } }, { "name": "payperiodid", "in": "query", "description": "The id assigned to the pay period that the check will be within.", "required": true, "schema": { "type": "string" } }, { "name": "offset", "in": "query", "description": "The zero based offset of the next page of data to be presented.", "required": false, "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "limit", "in": "query", "description": "The maximum number of elements to be returned in a page transition.", "required": false, "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "filterbyuserid", "in": "query", "description": "Filter by User Id.", "required": false, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/vnd.paychex.payroll.checks.v1+json": { "schema": { "$ref": "#/components/schemas/CheckResource_Internal" }, "examples": { "unProcessed": { "$ref": "#/components/examples/JSONEXAMPLES/value/UN_PROCESSED_CHECK_GET" } } }, "application/json": { "schema": { "$ref": "#/components/schemas/CheckResource_Internal" }, "examples": { "defaultResponse": { "$ref": "#/components/examples/JSONEXAMPLES/value/UN_PROCESSED_CHECK_GET" } } }, "application/vnd.paychex.payroll.processedchecks.v1+json": { "schema": { "$ref": "#/components/schemas/CheckResource_Internal" }, "examples": { "processed": { "$ref": "#/components/examples/JSONEXAMPLES/value/PROCESSED_CHECK_GET" } } } } }, "400": { "description": "Missing query parameter (API-49), Invalid query parameter (API-40)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource_Internal" }, "example": { "errors": [ { "code": "API-40", "description": "The request isn't valid.", "resolution": "Please send the valid request" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource_Internal" }, "example": { "errors": [ { "code": "API-102", "description": "The client could not be authenticated due to missing or invalid client credentials.", "resolution": "Make sure that you are using the correct API key/Secret and that your application is enabled." } ] } } } }, "403": { "description": "User doesn't have access to this endpoint (API-2), Client has been end dated (API-68)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource_Internal" }, "example": { "errors": [ { "code": "API-2", "description": "Your application is not authorized to access the resource.", "resolution": "Please have your company administrator give your application access to the resource." } ] } } } }, "404": { "description": "Invalid resource ID (API-7)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource_Internal" }, "example": { "errors": [ { "code": "API-7", "description": "The resource or status is invalid. You may have an incorrect resource ID.", "resolution": "Send a valid resource in your request" } ] } } } }, "405": { "description": "Unsupported method type (API-59)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource_Internal" }, "example": { "errors": [ { "code": "API-59", "description": "The request method type is unsupported." } ] } } } }, "406": { "description": "Unsupported Accept header", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource_Internal" }, "example": { "errors": [ { "code": "API-75", "description": "Invalid vendor media type.", "resolution": "Please refer to our documentation and send the correct vendor media type" } ] } } } }, "500": { "description": "Internal Server Error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource_Internal" }, "example": { "errors": [ { "code": "API-1", "description": "Internal Server Error.", "resolution": "Please contact Paychex API Developer Center Support." } ] } } } } } }, "post": { "tags": [ "Payroll" ], "summary": "Company Checks", "description": "Add a check for one or more worker within a company for an available pay period.", "operationId": "createCompanyChecks", "parameters": [ { "name": "companyId", "in": "path", "description": "ID associated with desired company.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/vnd.paychex.payroll.checks.v1+json": { "schema": { "$ref": "#/components/schemas/CheckResource" }, "examples": { "CompanyChecks": { "$ref": "#/components/examples/JSONEXAMPLES/value/COMPANIES_CHECKS_POST_REQ" } } } }, "required": true }, "responses": { "201": { "description": "successful operation", "content": { "application/vnd.paychex.payroll.checks.v1+json": { "schema": { "$ref": "#/components/schemas/CheckResource" }, "examples": { "CompaniesChecks": { "$ref": "#/components/examples/JSONEXAMPLES/value/COMPANIES_CHECKS_POST_RES" } } }, "application/json": { "schema": { "$ref": "#/components/schemas/CheckResource" }, "examples": { "defaultResponse": { "$ref": "#/components/examples/JSONEXAMPLES/value/COMPANIES_CHECKS_POST_RES" } } } } }, "400": { "description": "Amount should be between 0.00-9999.99 (API-28), Invalid Org ID (API-40), Required field missing (API-46), Required field ambiguous (API-47), Required field invalid (API-48), Pay period is in a state that will not allow checks to be modified (API-51), Empty request (API-52), All checks must have the same pay period in the request (API-53), Missing required field for one or more request (API-54), At least one worker doesn't belong to this client (API-55), Duplicate correlation ID (API-56), The pay component doesn't support the corresponding worker type (API-57), The pay component can't be REDUCTION type (API-60), Product was not set up for this client as of the check date of the given pay period (API-65), The pay rate's start date is after the provided PayPeriod's date range (API-69), This worker does not have a default pay rate set (API-70) ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-40", "description": "The request isn't valid.", "resolution": "Please send the valid request" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-102", "description": "The client could not be authenticated due to missing or invalid client credentials.", "resolution": "Make sure that you are using the correct API key/Secret and that your application is enabled." } ] } } } }, "403": { "description": "User doesn't have access to this endpoint (API-2), Client has been end dated (API-68)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-2", "description": "Your application is not authorized to access the resource.", "resolution": "Please have your company administrator give your application access to the resource." } ] } } } }, "404": { "description": "Invalid resource ID (API-7)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-7", "description": "The resource or status is invalid. You may have an incorrect resource ID.", "resolution": "Send a valid resource in your request" } ] } } } }, "405": { "description": "Unsupported method type (API-59), Check is not allowed to be modified (API-51)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-59", "description": "The request method type is unsupported." } ] } } } }, "406": { "description": "Unsupported Accept header", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-75", "description": "Invalid vendor media type.", "resolution": "Please refer to our documentation and send the correct vendor media type" } ] } } } }, "413": { "description": "Post more than 100 checks per request (API-44)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": "{\"errors\" : [{\"code\": \"API-44\",\"description\": \"Request exceeded the max content size available for this request\": \"-\"}]}" } } }, "423": { "description": "Client locked (API-10)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-10", "description": "The client is locked because another user or process is updating it. Your changes cannot be saved while the client is locked.", "resolution": "Please try again later." } ] } } } }, "500": { "description": "Internal Server Error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-1", "description": "Internal Server Error.", "resolution": "Please contact Paychex API Developer Center Support." } ] } } } } } } }, "/companies/{companyId}/contacttypes": { "get": { "tags": [ "Company" ], "summary": "Company Contact Types", "description": "Information about contact types that your application has been granted access to.", "operationId": "getCompanyContactTypes", "parameters": [ { "name": "companyId", "in": "path", "description": "ID associated with desired company.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful operation.", "content": { "application/vnd.paychex.company.contacttypes.v1+json": { "schema": { "$ref": "#/components/schemas/ContactTypeResource" }, "examples": { "companyContactTypesResVMT": { "$ref": "#/components/examples/JSONEXAMPLES/value/COMPANY_CONTACT_TYPES_GET" } } }, "application/json": { "schema": { "$ref": "#/components/schemas/ContactTypeResource" }, "examples": { "companyContactTypesResDef": { "$ref": "#/components/examples/JSONEXAMPLES/value/COMPANY_CONTACT_TYPES_GET" } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-102", "description": "The client could not be authenticated due to missing or invalid client credentials.", "resolution": "Make sure that you are using the correct API key/Secret and that your application is enabled." } ] } } } }, "403": { "description": "User doesn't have access to this endpoint (API-2), Client has been end dated (API-68)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-2", "description": "Your application is not authorized to access the resource.", "resolution": "Please have your company administrator give your application access to the resource." } ] } } } }, "405": { "description": "Unsupported method type (API-59)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-59", "description": "The request method type is unsupported." } ] } } } }, "406": { "description": "Unsupported Accept header", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-75", "description": "Invalid vendor media type.", "resolution": "Please refer to our documentation and send the correct vendor media type" } ] } } } }, "500": { "description": "Internal Server Error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-1", "description": "Internal Server Error.", "resolution": "Please contact Paychex API Developer Center Support." } ] } } } } } } }, "/companies/{companyId}/customemploymenttypes": { "get": { "tags": [ "Company" ], "summary": "Company Custom Employment Types", "description": "Array of custom employment types thata worker could be assigned to.", "operationId": "getCompanyCustomEmploymentTypes", "parameters": [ { "name": "companyId", "in": "path", "description": "ID associated with desired company.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomEmploymentTypeResource" }, "examples": { "defaultResponse": { "$ref": "#/components/examples/JSONEXAMPLES/value/COMPANIES_CUSTOMEMPLOYMENTTYPES_GET" } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-102", "description": "The client could not be authenticated due to missing or invalid client credentials.", "resolution": "Make sure that you are using the correct API key/Secret and that your application is enabled." } ] } } } }, "403": { "description": "User doesn't have access to this endpoint (API-2), Client has been end dated (API-68)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-2", "description": "Your application is not authorized to access the resource.", "resolution": "Please have your company administrator give your application access to the resource." } ] } } } }, "405": { "description": "Unsupported method type (API-59)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-59", "description": "The request method type is unsupported." } ] } } } }, "406": { "description": "Unsupported Accept header", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-75", "description": "Invalid vendor media type.", "resolution": "Please refer to our documentation and send the correct vendor media type" } ] } } } }, "500": { "description": "Internal Server Error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-1", "description": "Internal Server Error.", "resolution": "Please contact Paychex API Developer Center Support." } ] } } } } } } }, "/companies/{companyId}/customfields": { "get": { "tags": [ "Company" ], "summary": "Custom Fields", "description": "Array of customFields Configured at the company level ", "operationId": "getCompanyCustomfields", "parameters": [ { "name": "companyId", "in": "path", "description": "ID associated with desired company.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/vnd.paychex.company.customfields.v1+json": { "schema": { "$ref": "#/components/schemas/CustomFieldsResource" }, "examples": { "CompaniesCustomfields": { "$ref": "#/components/examples/JSONEXAMPLES/value/COMPANIES_CUSTOMFIELDS_GET" } } }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomFieldsResource" }, "examples": { "defaultResponse": { "$ref": "#/components/examples/JSONEXAMPLES/value/COMPANIES_CUSTOMFIELDS_GET" } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-102", "description": "The client could not be authenticated due to missing or invalid client credentials.", "resolution": "Make sure that you are using the correct API key/Secret and that your application is enabled." } ] } } } }, "403": { "description": "User doesn't have access to this endpoint (API-2), Client has been end dated (API-68)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-2", "description": "Your application is not authorized to access the resource.", "resolution": "Please have your company administrator give your application access to the resource." } ] } } } }, "404": { "description": "Invalid resource ID (API-7)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-7", "description": "The resource or status is invalid. You may have an incorrect resource ID.", "resolution": "Send a valid resource in your request" } ] } } } }, "405": { "description": "Unsupported method type (API-59)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-59", "description": "The request method type is unsupported." } ] } } } }, "406": { "description": "Unsupported Accept header", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-75", "description": "Invalid vendor media type.", "resolution": "Please refer to our documentation and send the correct vendor media type" } ] } } } }, "500": { "description": "Internal Server Error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-1", "description": "Internal Server Error.", "resolution": "Please contact Paychex API Developer Center Support." } ] } } } } } }, "post": { "tags": [ "Company" ], "summary": "Custom Field", "description": "Create CustomFields at the company level which a company could be assigned.", "operationId": "createCompanyCustomFields", "parameters": [ { "name": "companyId", "in": "path", "description": "ID associated with desired company.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/vnd.paychex.company.customfields.v1+json": { "schema": { "$ref": "#/components/schemas/CustomFieldsResource" }, "examples": { "CompanyCusomFields": { "$ref": "#/components/examples/JSONEXAMPLES/value/C_CFIELDS_POST_REQ" } } }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomFieldsResource" }, "examples": { "CompCusomFieldsDef": { "$ref": "#/components/examples/JSONEXAMPLES/value/C_CFIELDS_POST_REQ" } } } }, "required": true }, "responses": { "201": { "description": "successful operation", "content": { "application/vnd.paychex.company.customfields.v1+json": { "schema": { "$ref": "#/components/schemas/CustomFieldsResource" }, "examples": { "CompaniesCustomFields": { "$ref": "#/components/examples/JSONEXAMPLES/value/C_CFIELDS_POST_RES" } } }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomFieldsResource" }, "examples": { "defaultResponse": { "$ref": "#/components/examples/JSONEXAMPLES/value/C_CFIELDS_POST_RES" } } } } }, "400": { "description": "The value for the one of the field is invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-40", "description": "The request isn't valid.", "resolution": "Please send the valid request" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-102", "description": "The client could not be authenticated due to missing or invalid client credentials.", "resolution": "Make sure that you are using the correct API key/Secret and that your application is enabled." } ] } } } }, "403": { "description": "User doesn't have access to this endpoint (API-2), Client has been end dated (API-68)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-2", "description": "Your application is not authorized to access the resource.", "resolution": "Please have your company administrator give your application access to the resource." } ] } } } }, "404": { "description": "Invalid resource ID (API-7)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-7", "description": "The resource or status is invalid. You may have an incorrect resource ID.", "resolution": "Send a valid resource in your request" } ] } } } }, "405": { "description": "Unsupported method type (API-59)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-59", "description": "The request method type is unsupported." } ] } } } }, "406": { "description": "Unsupported Accept header", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-75", "description": "Invalid vendor media type.", "resolution": "Please refer to our documentation and send the correct vendor media type" } ] } } } }, "500": { "description": "Internal Server Error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-1", "description": "Internal Server Error.", "resolution": "Please contact Paychex API Developer Center Support." } ] } } } } } } }, "/companies/{companyId}/customfields/{customFieldId}": { "get": { "tags": [ "Company" ], "summary": "Custom Field", "description": "Information about a single CustomField.", "operationId": "getCompanyCustomFieldById", "parameters": [ { "name": "companyId", "in": "path", "description": "ID associated with desired company.", "required": true, "schema": { "type": "string" } }, { "name": "customFieldId", "in": "path", "description": "ID associated with desired custom field.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/vnd.paychex.company.customfield.v1+json": { "schema": { "$ref": "#/components/schemas/CustomFieldsResource" }, "examples": { "CompaniesCustomfield": { "$ref": "#/components/examples/JSONEXAMPLES/value/COMPANIES_CUSTOMFIELD_GET" } } }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomFieldsResource" }, "examples": { "defaultResponse": { "$ref": "#/components/examples/JSONEXAMPLES/value/COMPANIES_CUSTOMFIELD_GET" } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-102", "description": "The client could not be authenticated due to missing or invalid client credentials.", "resolution": "Make sure that you are using the correct API key/Secret and that your application is enabled." } ] } } } }, "403": { "description": "User doesn't have access to this endpoint (API-2), Client has been end dated (API-68)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-2", "description": "Your application is not authorized to access the resource.", "resolution": "Please have your company administrator give your application access to the resource." } ] } } } }, "404": { "description": "Invalid resource ID (API-7)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-7", "description": "The resource or status is invalid. You may have an incorrect resource ID.", "resolution": "Send a valid resource in your request" } ] } } } }, "405": { "description": "Unsupported method type (API-59)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-59", "description": "The request method type is unsupported." } ] } } } }, "406": { "description": "Unsupported Accept header", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-75", "description": "Invalid vendor media type.", "resolution": "Please refer to our documentation and send the correct vendor media type" } ] } } } }, "500": { "description": "Internal Server Error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-1", "description": "Internal Server Error.", "resolution": "Please contact Paychex API Developer Center Support." } ] } } } } } } }, "/companies/{companyId}/customfields/{customfieldid}": { "delete": { "tags": [ "Company" ], "summary": "Custom Field", "description": "Delete CustomField at the company level.", "operationId": "deleteCompanyCustomField", "parameters": [ { "name": "companyId", "in": "path", "description": "ID associated with desired company.", "required": true, "schema": { "type": "string" } }, { "name": "customfieldid", "in": "path", "description": "ID associated with desired custom field.", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "successful operation" }, "400": { "description": "The value for the one of the field is invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-40", "description": "The request isn't valid.", "resolution": "Please send the valid request" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-102", "description": "The client could not be authenticated due to missing or invalid client credentials.", "resolution": "Make sure that you are using the correct API key/Secret and that your application is enabled." } ] } } } }, "403": { "description": "User doesn't have access to this endpoint (API-2), Client has been end dated (API-68)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-2", "description": "Your application is not authorized to access the resource.", "resolution": "Please have your company administrator give your application access to the resource." } ] } } } }, "404": { "description": "Invalid resource ID (API-7)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-7", "description": "The resource or status is invalid. You may have an incorrect resource ID.", "resolution": "Send a valid resource in your request" } ] } } } }, "405": { "description": "Unsupported method type (API-59)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-59", "description": "The request method type is unsupported." } ] } } } }, "406": { "description": "Unsupported Accept header", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-75", "description": "Invalid vendor media type.", "resolution": "Please refer to our documentation and send the correct vendor media type" } ] } } } }, "500": { "description": "Internal Server Error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-1", "description": "Internal Server Error.", "resolution": "Please contact Paychex API Developer Center Support." } ] } } } } } }, "patch": { "tags": [ "Company" ], "summary": "Custom Field", "description": "Update CustomFields at the company level which a company could be assigned.", "operationId": "updateCompanyCustomField", "parameters": [ { "name": "companyId", "in": "path", "description": "ID associated with desired company.", "required": true, "schema": { "type": "string" } }, { "name": "customfieldid", "in": "path", "description": "ID associated with desired custom field.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/vnd.paychex.company.customfield.v1+json": { "schema": { "$ref": "#/components/schemas/CustomFieldsResource" }, "examples": { "CompanyCusomFields": { "$ref": "#/components/examples/JSONEXAMPLES/value/C_CFIELDS_POST_REQ" } } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "application/vnd.paychex.company.customfield.v1+json": { "schema": { "$ref": "#/components/schemas/CustomFieldsResource" }, "examples": { "CompaniesCustomFields": { "$ref": "#/components/examples/JSONEXAMPLES/value/C_CFIELDS_POST_RES" } } }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomFieldsResource" }, "examples": { "defaultResponse": { "$ref": "#/components/examples/JSONEXAMPLES/value/C_CFIELDS_POST_RES" } } } } }, "400": { "description": "The value for the one of the field is invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-40", "description": "The request isn't valid.", "resolution": "Please send the valid request" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-102", "description": "The client could not be authenticated due to missing or invalid client credentials.", "resolution": "Make sure that you are using the correct API key/Secret and that your application is enabled." } ] } } } }, "403": { "description": "User doesn't have access to this endpoint (API-2), Client has been end dated (API-68)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-2", "description": "Your application is not authorized to access the resource.", "resolution": "Please have your company administrator give your application access to the resource." } ] } } } }, "404": { "description": "Invalid resource ID (API-7)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-7", "description": "The resource or status is invalid. You may have an incorrect resource ID.", "resolution": "Send a valid resource in your request" } ] } } } }, "405": { "description": "Unsupported method type (API-59)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-59", "description": "The request method type is unsupported." } ] } } } }, "406": { "description": "Unsupported Accept header", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-75", "description": "Invalid vendor media type.", "resolution": "Please refer to our documentation and send the correct vendor media type" } ] } } } }, "500": { "description": "Internal Server Error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-1", "description": "Internal Server Error.", "resolution": "Please contact Paychex API Developer Center Support." } ] } } } } } } }, "/companies/{companyId}/customfieldscategories": { "get": { "tags": [ "Company" ], "summary": "Custom Fields Categories", "description": "Array of CustomFieldsCategories Configured at the company level ", "operationId": "getCompanyCustomfieldscategories", "parameters": [ { "name": "companyId", "in": "path", "description": "ID associated with desired company.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/vnd.paychex.company.customfieldscategories.v1+json": { "schema": { "$ref": "#/components/schemas/CustomFieldsCategoryResource" }, "examples": { "CompaniesCustomfieldsCategories": { "$ref": "#/components/examples/JSONEXAMPLES/value/COMPANIES_CUSTOMCATEGORIES_GET" } } }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomFieldsCategoryResource" }, "examples": { "defaultResponse": { "$ref": "#/components/examples/JSONEXAMPLES/value/COMPANIES_CUSTOMCATEGORIES_GET" } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-102", "description": "The client could not be authenticated due to missing or invalid client credentials.", "resolution": "Make sure that you are using the correct API key/Secret and that your application is enabled." } ] } } } }, "403": { "description": "User doesn't have access to this endpoint (API-2), Client has been end dated (API-68)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-2", "description": "Your application is not authorized to access the resource.", "resolution": "Please have your company administrator give your application access to the resource." } ] } } } }, "404": { "description": "Invalid resource ID (API-7)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-7", "description": "The resource or status is invalid. You may have an incorrect resource ID.", "resolution": "Send a valid resource in your request" } ] } } } }, "405": { "description": "Unsupported method type (API-59)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-59", "description": "The request method type is unsupported." } ] } } } }, "406": { "description": "Unsupported Accept header", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-75", "description": "Invalid vendor media type.", "resolution": "Please refer to our documentation and send the correct vendor media type" } ] } } } }, "500": { "description": "Internal Server Error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-1", "description": "Internal Server Error.", "resolution": "Please contact Paychex API Developer Center Support." } ] } } } } } }, "post": { "tags": [ "Company" ], "summary": "Custom Fields Category", "description": "Create CustomFieldsCategory at the company level which a company could be assigned.", "operationId": "createCompanyCustomFieldsCategory", "parameters": [ { "name": "companyId", "in": "path", "description": "ID associated with desired company.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomFieldsCategoryResource" } }, "application/vnd.paychex.company.customfieldscategories.v1+json": { "schema": { "$ref": "#/components/schemas/CustomFieldsCategoryResource" } } }, "required": true }, "responses": { "201": { "description": "successful operation", "content": { "application/vnd.paychex.company.customfieldscategories.v1+json": { "schema": { "$ref": "#/components/schemas/CustomFieldsCategoryResource" }, "examples": { "PostCompaniesCustomfieldsCategory": { "$ref": "#/components/examples/JSONEXAMPLES/value/COMPANIES_CUSTOMCATEGORY_GET" } } }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomFieldsCategoryResource" }, "examples": { "defaultResponse": { "$ref": "#/components/examples/JSONEXAMPLES/value/COMPANIES_CUSTOMCATEGORY_GET" } } } } }, "400": { "description": "The value for the one of the field is invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-40", "description": "The request isn't valid.", "resolution": "Please send the valid request" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-102", "description": "The client could not be authenticated due to missing or invalid client credentials.", "resolution": "Make sure that you are using the correct API key/Secret and that your application is enabled." } ] } } } }, "403": { "description": "User doesn't have access to this endpoint (API-2), Client has been end dated (API-68)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-2", "description": "Your application is not authorized to access the resource.", "resolution": "Please have your company administrator give your application access to the resource." } ] } } } }, "404": { "description": "Invalid resource ID (API-7)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-7", "description": "The resource or status is invalid. You may have an incorrect resource ID.", "resolution": "Send a valid resource in your request" } ] } } } }, "405": { "description": "Unsupported method type (API-59)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-59", "description": "The request method type is unsupported." } ] } } } }, "406": { "description": "Unsupported Accept header", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-75", "description": "Invalid vendor media type.", "resolution": "Please refer to our documentation and send the correct vendor media type" } ] } } } }, "500": { "description": "Internal Server Error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-1", "description": "Internal Server Error.", "resolution": "Please contact Paychex API Developer Center Support." } ] } } } } } } }, "/companies/{companyId}/customfieldscategories/{categoryId}": { "get": { "tags": [ "Company" ], "summary": "Custom Fields Category", "description": "Information about a single CustomFieldsCategory.", "operationId": "getCompanyCustomfieldscategory", "parameters": [ { "name": "companyId", "in": "path", "description": "ID associated with desired company.", "required": true, "schema": { "type": "string" } }, { "name": "categoryId", "in": "path", "description": "ID associated with desired category.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/vnd.paychex.company.customfieldscategory.v1+json": { "schema": { "$ref": "#/components/schemas/CustomFieldsCategoryResource" }, "examples": { "CompaniesCustomfieldsCategory": { "$ref": "#/components/examples/JSONEXAMPLES/value/COMPANIES_CUSTOMCATEGORY_GET" } } }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomFieldsCategoryResource" }, "examples": { "defaultResponse": { "$ref": "#/components/examples/JSONEXAMPLES/value/COMPANIES_CUSTOMCATEGORY_GET" } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-102", "description": "The client could not be authenticated due to missing or invalid client credentials.", "resolution": "Make sure that you are using the correct API key/Secret and that your application is enabled." } ] } } } }, "403": { "description": "User doesn't have access to this endpoint (API-2), Client has been end dated (API-68)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-2", "description": "Your application is not authorized to access the resource.", "resolution": "Please have your company administrator give your application access to the resource." } ] } } } }, "404": { "description": "Invalid resource ID (API-7)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-7", "description": "The resource or status is invalid. You may have an incorrect resource ID.", "resolution": "Send a valid resource in your request" } ] } } } }, "405": { "description": "Unsupported method type (API-59)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-59", "description": "The request method type is unsupported." } ] } } } }, "406": { "description": "Unsupported Accept header", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-75", "description": "Invalid vendor media type.", "resolution": "Please refer to our documentation and send the correct vendor media type" } ] } } } }, "500": { "description": "Internal Server Error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-1", "description": "Internal Server Error.", "resolution": "Please contact Paychex API Developer Center Support." } ] } } } } } } }, "/companies/{companyId}/customfieldscategories/{categoryid}": { "delete": { "tags": [ "Company" ], "summary": "Custom Fields Category", "description": "Delete CustomFieldsCategory at the company level.", "operationId": "deleteCompanyCustomFieldsCategory", "parameters": [ { "name": "companyId", "in": "path", "description": "ID associated with desired company.", "required": true, "schema": { "type": "string" } }, { "name": "categoryid", "in": "path", "description": "ID associated with desired category.", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "successful operation" }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-102", "description": "The client could not be authenticated due to missing or invalid client credentials.", "resolution": "Make sure that you are using the correct API key/Secret and that your application is enabled." } ] } } } }, "403": { "description": "User doesn't have access to this endpoint (API-2), Client has been end dated (API-68)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-2", "description": "Your application is not authorized to access the resource.", "resolution": "Please have your company administrator give your application access to the resource." } ] } } } }, "404": { "description": "Invalid resource ID (API-7)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-7", "description": "The resource or status is invalid. You may have an incorrect resource ID.", "resolution": "Send a valid resource in your request" } ] } } } }, "405": { "description": "Unsupported method type (API-59)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-59", "description": "The request method type is unsupported." } ] } } } }, "406": { "description": "Unsupported Accept header", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-75", "description": "Invalid vendor media type.", "resolution": "Please refer to our documentation and send the correct vendor media type" } ] } } } }, "500": { "description": "Internal Server Error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-1", "description": "Internal Server Error.", "resolution": "Please contact Paychex API Developer Center Support." } ] } } } } } }, "patch": { "tags": [ "Company" ], "summary": "Custom Fields Category", "description": "Update CustomFieldsCategory at the company level.", "operationId": "updateCompanyCustomFieldsCategory", "parameters": [ { "name": "companyId", "in": "path", "description": "ID associated with desired company.", "required": true, "schema": { "type": "string" } }, { "name": "categoryid", "in": "path", "description": "ID associated with desired custom field.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomFieldsCategoryResource" } }, "application/vnd.paychex.company.customfieldscategory.v1+json": { "schema": { "$ref": "#/components/schemas/CustomFieldsCategoryResource" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "application/vnd.paychex.company.customfieldscategories.v1+json": { "schema": { "$ref": "#/components/schemas/CustomFieldsCategoryResource" }, "examples": { "UpdateCompaniesCustomfieldsCategory": { "$ref": "#/components/examples/JSONEXAMPLES/value/COMPANIES_CUSTOMCATEGORY_GET" } } }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomFieldsCategoryResource" }, "examples": { "defaultResponse": { "$ref": "#/components/examples/JSONEXAMPLES/value/COMPANIES_CUSTOMCATEGORY_GET" } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-102", "description": "The client could not be authenticated due to missing or invalid client credentials.", "resolution": "Make sure that you are using the correct API key/Secret and that your application is enabled." } ] } } } }, "403": { "description": "User doesn't have access to this endpoint (API-2), Client has been end dated (API-68)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-2", "description": "Your application is not authorized to access the resource.", "resolution": "Please have your company administrator give your application access to the resource." } ] } } } }, "404": { "description": "Invalid resource ID (API-7)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-7", "description": "The resource or status is invalid. You may have an incorrect resource ID.", "resolution": "Send a valid resource in your request" } ] } } } }, "405": { "description": "Unsupported method type (API-59)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-59", "description": "The request method type is unsupported." } ] } } } }, "406": { "description": "Unsupported Accept header", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-75", "description": "Invalid vendor media type.", "resolution": "Please refer to our documentation and send the correct vendor media type" } ] } } } }, "500": { "description": "Internal Server Error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-1", "description": "Internal Server Error.", "resolution": "Please contact Paychex API Developer Center Support." } ] } } } } } } }, "/companies/{companyId}/documentcategories": { "get": { "tags": [ "Company" ], "summary": "Company Document Categories", "description": "List of document categories that a company could use while creating / organizing documents.", "operationId": "getCompanyDocumentCategories", "parameters": [ { "name": "companyId", "in": "path", "description": "ID associated with desired company.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentCategoryResource" }, "examples": { "SuccessResponse": { "$ref": "#/components/examples/JSONEXAMPLES/value/COMPANIES_DOCUMENT_CATEGORIES_GET" } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-102", "description": "The client could not be authenticated due to missing or invalid client credentials.", "resolution": "Make sure that you are using the correct API key/Secret and that your application is enabled." } ] } } } }, "403": { "description": "User doesn't have access to this endpoint (API-2), Client has been end dated (API-68)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-2", "description": "Your application is not authorized to access the resource.", "resolution": "Please have your company administrator give your application access to the resource." } ] } } } }, "404": { "description": "Invalid resource ID (API-7)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-7", "description": "The resource or status is invalid. You may have an incorrect resource ID.", "resolution": "Send a valid resource in your request" } ] } } } }, "405": { "description": "Unsupported method type (API-59)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-59", "description": "The request method type is unsupported." } ] } } } }, "406": { "description": "Unsupported Accept header", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-75", "description": "Invalid vendor media type.", "resolution": "Please refer to our documentation and send the correct vendor media type" } ] } } } }, "500": { "description": "Internal Server Error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-1", "description": "Internal Server Error.", "resolution": "Please contact Paychex API Developer Center Support." } ] } } } } } } }, "/companies/{companyId}/jobs": { "get": { "tags": [ "Company" ], "summary": "Company Jobs", "description": "Array of jobs set at the company level.", "operationId": "getCompanyJobs", "parameters": [ { "name": "companyId", "in": "path", "description": "The ID of the company.", "required": true, "schema": { "type": "string" } }, { "name": "asof", "in": "query", "description": "Returns all jobs as of the date used in the request.", "required": false, "schema": { "type": "string" }, "example": "2020-01-04T00:00:00Z" } ], "responses": { "200": { "description": "successful operation", "content": { "application/vnd.paychex.company.jobs.v1+json": { "schema": { "$ref": "#/components/schemas/JobResource" }, "examples": { "CompaniesJobs": { "$ref": "#/components/examples/JSONEXAMPLES/value/COMPANIES_JOBS_GET" } } }, "application/json": { "schema": { "$ref": "#/components/schemas/JobResource" }, "examples": { "defaultResponse": { "$ref": "#/components/examples/JSONEXAMPLES/value/COMPANIES_JOBS_GET" } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-102", "description": "The client could not be authenticated due to missing or invalid client credentials.", "resolution": "Make sure that you are using the correct API key/Secret and that your application is enabled." } ] } } } }, "403": { "description": "User doesn't have access to this endpoint (API-2), Client has been end dated (API-68)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-2", "description": "Your application is not authorized to access the resource.", "resolution": "Please have your company administrator give your application access to the resource." } ] } } } }, "404": { "description": "Invalid resource ID (API-7)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-7", "description": "The resource or status is invalid. You may have an incorrect resource ID.", "resolution": "Send a valid resource in your request" } ] } } } }, "405": { "description": "Unsupported method type (API-59)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-59", "description": "The request method type is unsupported." } ] } } } }, "406": { "description": "Unsupported Accept header", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-75", "description": "Invalid vendor media type.", "resolution": "Please refer to our documentation and send the correct vendor media type" } ] } } } }, "500": { "description": "Internal Server Error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-1", "description": "Internal Server Error.", "resolution": "Please contact Paychex API Developer Center Support." } ] } } } } } }, "post": { "tags": [ "Company" ], "summary": "Company Job", "description": "Add a company level job. If a client has their job numbering structured in 2-3 separate 'segments', you may need to first do a GET on the jobsegements endpoint, so you can see how many segments and the character length of each segment, as well as the name of those segments, which you will need to have before you POST.", "operationId": "createCompanyJobs", "parameters": [ { "name": "companyId", "in": "path", "description": "The ID of the company.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/vnd.paychex.company.jobs.v1+json": { "schema": { "$ref": "#/components/schemas/JobResource" }, "examples": { "CompanyJobs": { "$ref": "#/components/examples/JSONEXAMPLES/value/COMPANIES_JOBS_POST_REQ" } } } }, "required": true }, "responses": { "201": { "description": "successful operation", "content": { "application/vnd.paychex.company.jobs.v1+json": { "schema": { "$ref": "#/components/schemas/JobResource" }, "examples": { "CompaniesJobs": { "$ref": "#/components/examples/JSONEXAMPLES/value/COMPANIES_JOBS_POST_RES" } } }, "application/json": { "schema": { "$ref": "#/components/schemas/JobResource" }, "examples": { "defaultResponse": { "$ref": "#/components/examples/JSONEXAMPLES/value/COMPANIES_JOBS_POST_RES" } } } } }, "400": { "description": "Invalid resource or field,The request cannot be performed since the worker is in a state which does not allow this action(API-19)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "examples": { "resorce Not Found": { "description": "resorce Not Found", "value": { "errors": [ { "code": "API-40", "description": "The request isn't valid.", "resolution": "Please send the valid request" } ] } } } } } }, "403": { "description": "User doesn't have access to this endpoint (API-2), Client has been end dated (API-68)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-2", "description": "Your application is not authorized to access the resource.", "resolution": "Please have your company administrator give your application access to the resource." } ] } } } }, "404": { "description": "Invalid resource ID (API-7)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-7", "description": "The resource or status is invalid. You may have an incorrect resource ID.", "resolution": "Send a valid resource in your request" } ] } } } }, "405": { "description": "Unsupported method type (API-59)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-59", "description": "The request method type is unsupported." } ] } } } }, "406": { "description": "Unsupported Accept header", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-75", "description": "Invalid vendor media type.", "resolution": "Please refer to our documentation and send the correct vendor media type" } ] } } } }, "500": { "description": "Internal Server Error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-1", "description": "Internal Server Error.", "resolution": "Please contact Paychex API Developer Center Support." } ] } } } } } } }, "/companies/{companyId}/jobs/{jobId}": { "get": { "tags": [ "Company" ], "summary": "Company Job", "description": "Information about a single Job.", "operationId": "getCompanyJob", "parameters": [ { "name": "companyId", "in": "path", "description": "The ID of the company.", "required": true, "schema": { "type": "string" } }, { "name": "jobId", "in": "path", "description": "The ID of the job.", "required": true, "schema": { "type": "string" } }, { "name": "asof", "in": "query", "description": "Returns job as of the date used in the request.", "required": false, "schema": { "type": "string" }, "example": "2020-01-04T00:00:00Z" } ], "responses": { "200": { "description": "successful operation", "content": { "application/vnd.paychex.company.job.v1+json": { "schema": { "$ref": "#/components/schemas/JobResource" }, "examples": { "CompaniesJob": { "$ref": "#/components/examples/JSONEXAMPLES/value/COMPANIES_JOB_GET" } } }, "application/json": { "schema": { "$ref": "#/components/schemas/JobResource" }, "examples": { "defaultResponse": { "$ref": "#/components/examples/JSONEXAMPLES/value/COMPANIES_JOB_GET" } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-102", "description": "The client could not be authenticated due to missing or invalid client credentials.", "resolution": "Make sure that you are using the correct API key/Secret and that your application is enabled." } ] } } } }, "403": { "description": "User doesn't have access to this endpoint (API-2), Client has been end dated (API-68)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-2", "description": "Your application is not authorized to access the resource.", "resolution": "Please have your company administrator give your application access to the resource." } ] } } } }, "404": { "description": "Invalid resource ID (API-7)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-7", "description": "The resource or status is invalid. You may have an incorrect resource ID.", "resolution": "Send a valid resource in your request" } ] } } } }, "405": { "description": "Unsupported method type (API-59)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-59", "description": "The request method type is unsupported." } ] } } } }, "406": { "description": "Unsupported Accept header", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-75", "description": "Invalid vendor media type.", "resolution": "Please refer to our documentation and send the correct vendor media type" } ] } } } }, "500": { "description": "Internal Server Error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-1", "description": "Internal Server Error.", "resolution": "Please contact Paychex API Developer Center Support." } ] } } } } } }, "patch": { "tags": [ "Company" ], "summary": "Company Job", "description": "Update a single Job.", "operationId": "updateCompanyJobs", "parameters": [ { "name": "companyId", "in": "path", "description": "The ID of the company.", "required": true, "schema": { "type": "string" } }, { "name": "jobId", "in": "path", "description": "The ID of the job.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobResourcePatch" } }, "application/vnd.paychex.company.jobs.v1+json": { "schema": { "$ref": "#/components/schemas/JobResourcePatch" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "application/vnd.paychex.company.jobs.v1+json": { "schema": { "$ref": "#/components/schemas/JobResource" }, "examples": { "UpdateCompaniesJobs": { "$ref": "#/components/examples/JSONEXAMPLES/value/COMPANIES_JOBS_POST_RES" } } }, "application/json": { "schema": { "$ref": "#/components/schemas/JobResource" }, "examples": { "defaultResponse": { "$ref": "#/components/examples/JSONEXAMPLES/value/COMPANIES_JOBS_POST_RES" } } } } }, "400": { "description": "Invalid resource ID or Date (API-34)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-40", "description": "The request isn't valid.", "resolution": "Please send the valid request" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-102", "description": "The client could not be authenticated due to missing or invalid client credentials.", "resolution": "Make sure that you are using the correct API key/Secret and that your application is enabled." } ] } } } }, "403": { "description": "User doesn't have access to this endpoint (API-2), Client has been end dated (API-68)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-2", "description": "Your application is not authorized to access the resource.", "resolution": "Please have your company administrator give your application access to the resource." } ] } } } }, "405": { "description": "Unsupported method type (API-59)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-59", "description": "The request method type is unsupported." } ] } } } }, "406": { "description": "Unsupported Accept header", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-75", "description": "Invalid vendor media type.", "resolution": "Please refer to our documentation and send the correct vendor media type" } ] } } } }, "500": { "description": "Internal Server Error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-1", "description": "Internal Server Error.", "resolution": "Please contact Paychex API Developer Center Support." } ] } } } } } } }, "/companies/{companyId}/jobsegments": { "get": { "tags": [ "Company" ], "summary": "Company Job Segments", "description": "Retrieve job segment structure setup for this client. This endpoint is only available if the client has their job numbering set up in '2-3 separate 'segments'. The response will give you back the exact character lengths and the segment names so you are able to POST.", "operationId": "getCompanyJobSegments", "parameters": [ { "name": "companyId", "in": "path", "description": "The ID of the company.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/vnd.paychex.company.jobsegments.v1+json": { "schema": { "$ref": "#/components/schemas/JobSegmentsConfigResource" }, "examples": { "CompaniesJobSegments": { "$ref": "#/components/examples/JSONEXAMPLES/value/C_JOBSEGMTS_GET" } } }, "application/json": { "schema": { "$ref": "#/components/schemas/JobSegmentsConfigResource" }, "examples": { "defaultResponse": { "$ref": "#/components/examples/JSONEXAMPLES/value/C_JOBSEGMTS_GET" } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-102", "description": "The client could not be authenticated due to missing or invalid client credentials.", "resolution": "Make sure that you are using the correct API key/Secret and that your application is enabled." } ] } } } }, "403": { "description": "User doesn't have access to this endpoint (API-2), Client has been end dated (API-68)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-2", "description": "Your application is not authorized to access the resource.", "resolution": "Please have your company administrator give your application access to the resource." } ] } } } }, "404": { "description": "Invalid resource ID (API-7)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-7", "description": "The resource or status is invalid. You may have an incorrect resource ID.", "resolution": "Send a valid resource in your request" } ] } } } }, "405": { "description": "Unsupported method type (API-59)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-59", "description": "The request method type is unsupported." } ] } } } }, "406": { "description": "Unsupported Accept header", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-75", "description": "Invalid vendor media type.", "resolution": "Please refer to our documentation and send the correct vendor media type" } ] } } } }, "500": { "description": "Internal Server Error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-1", "description": "Internal Server Error.", "resolution": "Please contact Paychex API Developer Center Support." } ] } } } } } } }, "/companies/{companyId}/jobtitles": { "get": { "tags": [ "Company" ], "summary": "Company Job Titles", "description": "Array of job titles set at the company level which a worker could be assigned.", "operationId": "getCompanyPositions", "parameters": [ { "name": "companyId", "in": "path", "description": "The ID of the company.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/vnd.paychex.company.jobtitles.v1+json": { "schema": { "$ref": "#/components/schemas/JobTitleResource" }, "examples": { "CompaniesJobTitles": { "$ref": "#/components/examples/JSONEXAMPLES/value/C_JOBTITLES_GET" } } }, "application/json": { "schema": { "$ref": "#/components/schemas/JobTitleResource" }, "examples": { "defaultResponse": { "$ref": "#/components/examples/JSONEXAMPLES/value/C_JOBTITLES_GET" } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-102", "description": "The client could not be authenticated due to missing or invalid client credentials.", "resolution": "Make sure that you are using the correct API key/Secret and that your application is enabled." } ] } } } }, "403": { "description": "User doesn't have access to this endpoint (API-2), Client has been end dated (API-68)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-2", "description": "Your application is not authorized to access the resource.", "resolution": "Please have your company administrator give your application access to the resource." } ] } } } }, "404": { "description": "Invalid resource ID (API-7)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-7", "description": "The resource or status is invalid. You may have an incorrect resource ID.", "resolution": "Send a valid resource in your request" } ] } } } }, "405": { "description": "Unsupported method type (API-59)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-59", "description": "The request method type is unsupported." } ] } } } }, "406": { "description": "Unsupported Accept header", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-75", "description": "Invalid vendor media type.", "resolution": "Please refer to our documentation and send the correct vendor media type" } ] } } } }, "500": { "description": "Internal Server Error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-1", "description": "Internal Server Error.", "resolution": "Please contact Paychex API Developer Center Support." } ] } } } } } } }, "/companies/{companyId}/jobtitles/{jobTitleId}": { "get": { "tags": [ "Company" ], "summary": "Job Title", "description": "Information about a single Job Title.", "operationId": "getCompanyPosition", "parameters": [ { "name": "companyId", "in": "path", "description": "The ID of the company.", "required": true, "schema": { "type": "string" } }, { "name": "jobTitleId", "in": "path", "description": "The ID of the worker job title.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/vnd.paychex.company.jobtitle.v1+json": { "schema": { "$ref": "#/components/schemas/JobTitleResource" }, "examples": { "CompaniesJobtile": { "$ref": "#/components/examples/JSONEXAMPLES/value/C_JOBTITLE_GET" } } }, "application/json": { "schema": { "$ref": "#/components/schemas/JobTitleResource" }, "examples": { "defaultResponse": { "$ref": "#/components/examples/JSONEXAMPLES/value/C_JOBTITLE_GET" } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-102", "description": "The client could not be authenticated due to missing or invalid client credentials.", "resolution": "Make sure that you are using the correct API key/Secret and that your application is enabled." } ] } } } }, "403": { "description": "User doesn't have access to this endpoint (API-2), Client has been end dated (API-68)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-2", "description": "Your application is not authorized to access the resource.", "resolution": "Please have your company administrator give your application access to the resource." } ] } } } }, "404": { "description": "Invalid resource ID (API-7)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-7", "description": "The resource or status is invalid. You may have an incorrect resource ID.", "resolution": "Send a valid resource in your request" } ] } } } }, "405": { "description": "Unsupported method type (API-59)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-59", "description": "The request method type is unsupported." } ] } } } }, "406": { "description": "Unsupported Accept header", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-75", "description": "Invalid vendor media type.", "resolution": "Please refer to our documentation and send the correct vendor media type" } ] } } } }, "500": { "description": "Internal Server Error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-1", "description": "Internal Server Error.", "resolution": "Please contact Paychex API Developer Center Support." } ] } } } } } } }, "/companies/{companyId}/laborassignments": { "get": { "tags": [ "Company" ], "summary": "Company Labor Assignments", "description": "Array of labor assignments set at the company level.", "operationId": "getCompanyLaborAssignments", "parameters": [ { "name": "companyId", "in": "path", "description": "The ID of the company.", "required": true, "schema": { "type": "string" } }, { "name": "asof", "in": "query", "description": "Returns all labor assignments as of the date used in the request.", "required": false, "schema": { "type": "string" }, "example": "2020-01-04T00:00:00Z" } ], "responses": { "200": { "description": "successful operation", "content": { "application/vnd.paychex.company.laborassignments.v1+json": { "schema": { "$ref": "#/components/schemas/LaborAssignmentResource" }, "examples": { "CompanyLaborAssignments": { "$ref": "#/components/examples/JSONEXAMPLES/value/COMPANY_LBRASSIGNMENTS_GET" } } }, "application/json": { "schema": { "$ref": "#/components/schemas/LaborAssignmentResource" }, "examples": { "defaultResponse": { "$ref": "#/components/examples/JSONEXAMPLES/value/COMPANY_LBRASSIGNMENTS_GET" } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-102", "description": "The client could not be authenticated due to missing or invalid client credentials.", "resolution": "Make sure that you are using the correct API key/Secret and that your application is enabled." } ] } } } }, "403": { "description": "User doesn't have access to this endpoint (API-2), Client has been end dated (API-68)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-2", "description": "Your application is not authorized to access the resource.", "resolution": "Please have your company administrator give your application access to the resource." } ] } } } }, "404": { "description": "Invalid resource ID (API-7)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-7", "description": "The resource or status is invalid. You may have an incorrect resource ID.", "resolution": "Send a valid resource in your request" } ] } } } }, "405": { "description": "Unsupported method type (API-59)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-59", "description": "The request method type is unsupported." } ] } } } }, "406": { "description": "Unsupported Accept header", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-75", "description": "Invalid vendor media type.", "resolution": "Please refer to our documentation and send the correct vendor media type" } ] } } } }, "500": { "description": "Internal Server Error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-1", "description": "Internal Server Error.", "resolution": "Please contact Paychex API Developer Center Support." } ] } } } } } } }, "/companies/{companyId}/laborassignments/{laborAssignmentId}": { "get": { "tags": [ "Company" ], "summary": "Company Labor Assignment", "description": "Information about a single Labor Assignment.", "operationId": "getCompanyLaborAssignment", "parameters": [ { "name": "companyId", "in": "path", "description": "The ID of the company.", "required": true, "schema": { "type": "string" } }, { "name": "laborAssignmentId", "in": "path", "description": "The ID of the labor assignment.", "required": true, "schema": { "type": "string" } }, { "name": "asof", "in": "query", "description": "Returns labor assignment as of the date used in the request.", "required": false, "schema": { "type": "string" }, "example": "2020-01-04T00:00:00Z" } ], "responses": { "200": { "description": "successful operation", "content": { "application/vnd.paychex.company.laborassignment.v1+json": { "schema": { "$ref": "#/components/schemas/LaborAssignmentResource" }, "examples": { "CompanyLaborAssignment": { "$ref": "#/components/examples/JSONEXAMPLES/value/COMPANY_LBRASSIGNMENT_GET" } } }, "application/json": { "schema": { "$ref": "#/components/schemas/LaborAssignmentResource" }, "examples": { "defaultResponse": { "$ref": "#/components/examples/JSONEXAMPLES/value/COMPANY_LBRASSIGNMENT_GET" } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-102", "description": "The client could not be authenticated due to missing or invalid client credentials.", "resolution": "Make sure that you are using the correct API key/Secret and that your application is enabled." } ] } } } }, "403": { "description": "User doesn't have access to this endpoint (API-2), Client has been end dated (API-68)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-2", "description": "Your application is not authorized to access the resource.", "resolution": "Please have your company administrator give your application access to the resource." } ] } } } }, "404": { "description": "Invalid resource ID (API-7)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-7", "description": "The resource or status is invalid. You may have an incorrect resource ID.", "resolution": "Send a valid resource in your request" } ] } } } }, "405": { "description": "Unsupported method type (API-59)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-59", "description": "The request method type is unsupported." } ] } } } }, "406": { "description": "Unsupported Accept header", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-75", "description": "Invalid vendor media type.", "resolution": "Please refer to our documentation and send the correct vendor media type" } ] } } } }, "500": { "description": "Internal Server Error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-1", "description": "Internal Server Error.", "resolution": "Please contact Paychex API Developer Center Support." } ] } } } } } } }, "/companies/{companyId}/locations": { "get": { "tags": [ "Company" ], "summary": "Company Locations", "description": "Array of locations set at the company level.", "operationId": "getCompanyLocations", "parameters": [ { "name": "companyId", "in": "path", "description": "The ID of the company.", "required": true, "schema": { "type": "string" } }, { "name": "asof", "in": "query", "description": "Returns all locations as of the date used in the request.", "required": false, "schema": { "type": "string" }, "example": "2020-01-04T00:00:00Z" } ], "responses": { "200": { "description": "successful operation", "content": { "application/vnd.paychex.company.locations.v1+json": { "schema": { "$ref": "#/components/schemas/LocationResource" }, "examples": { "CompanyLocations": { "$ref": "#/components/examples/JSONEXAMPLES/value/COMPANY_LOCATIONS_GET" } } }, "application/json": { "schema": { "$ref": "#/components/schemas/LocationResource" }, "examples": { "defaultResponse": { "$ref": "#/components/examples/JSONEXAMPLES/value/COMPANY_LOCATIONS_GET" } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-102", "description": "The client could not be authenticated due to missing or invalid client credentials.", "resolution": "Make sure that you are using the correct API key/Secret and that your application is enabled." } ] } } } }, "403": { "description": "User doesn't have access to this endpoint (API-2), Client has been end dated (API-68)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-2", "description": "Your application is not authorized to access the resource.", "resolution": "Please have your company administrator give your application access to the resource." } ] } } } }, "404": { "description": "Invalid resource ID (API-7)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-7", "description": "The resource or status is invalid. You may have an incorrect resource ID.", "resolution": "Send a valid resource in your request" } ] } } } }, "405": { "description": "Unsupported method type (API-59)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-59", "description": "The request method type is unsupported." } ] } } } }, "406": { "description": "Unsupported Accept header", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-75", "description": "Invalid vendor media type.", "resolution": "Please refer to our documentation and send the correct vendor media type" } ] } } } }, "500": { "description": "Internal Server Error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-1", "description": "Internal Server Error.", "resolution": "Please contact Paychex API Developer Center Support." } ] } } } } } } }, "/companies/{companyId}/locations/{locationId}": { "get": { "tags": [ "Company" ], "summary": "Company Location", "description": "Information about a single Location.", "operationId": "getCompanyLocation", "parameters": [ { "name": "companyId", "in": "path", "description": "ID associated with desired company.", "required": true, "schema": { "type": "string" } }, { "name": "locationId", "in": "path", "description": "The ID of the location.", "required": true, "schema": { "type": "string" } }, { "name": "asof", "in": "query", "description": "Returns location as of the date used in the request.", "required": false, "schema": { "type": "string" }, "example": "2020-01-04T00:00:00Z" } ], "responses": { "200": { "description": "successful operation", "content": { "application/vnd.paychex.company.location.v1+json": { "schema": { "$ref": "#/components/schemas/LocationResource" }, "examples": { "CompanyLocation": { "$ref": "#/components/examples/JSONEXAMPLES/value/COMPANY_LOCATION_GET" } } }, "application/json": { "schema": { "$ref": "#/components/schemas/LocationResource" }, "examples": { "defaultResponse": { "$ref": "#/components/examples/JSONEXAMPLES/value/COMPANY_LOCATION_GET" } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-102", "description": "The client could not be authenticated due to missing or invalid client credentials.", "resolution": "Make sure that you are using the correct API key/Secret and that your application is enabled." } ] } } } }, "403": { "description": "User doesn't have access to this endpoint (API-2), Client has been end dated (API-68)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-2", "description": "Your application is not authorized to access the resource.", "resolution": "Please have your company administrator give your application access to the resource." } ] } } } }, "404": { "description": "Invalid resource ID (API-7)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-7", "description": "The resource or status is invalid. You may have an incorrect resource ID.", "resolution": "Send a valid resource in your request" } ] } } } }, "405": { "description": "Unsupported method type (API-59)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-59", "description": "The request method type is unsupported." } ] } } } }, "406": { "description": "Unsupported Accept header", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-75", "description": "Invalid vendor media type.", "resolution": "Please refer to our documentation and send the correct vendor media type" } ] } } } }, "500": { "description": "Internal Server Error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-1", "description": "Internal Server Error.", "resolution": "Please contact Paychex API Developer Center Support." } ] } } } } } } }, "/companies/{companyId}/non-workers-users": { "get": { "tags": [ "Company" ], "summary": "Company Non Workers Users", "description": "Company users who are non workers", "operationId": "getCompanyNonWorkerUsers", "parameters": [ { "name": "companyId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Users who are non workers successfully returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CollectionResourceUserSearchResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CollectionResourceUserSearchResponse" } } } }, "403": { "description": "User doesn't have access to this endpoint (API-2), Client has been end dated (API-68)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CollectionResourceUserSearchResponse" } } } }, "404": { "description": "Invalid resource ID (API-7)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CollectionResourceUserSearchResponse" } } } }, "500": { "description": "Internal Server Error Exception", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CollectionResourceUserSearchResponse" } } } } } } }, "/companies/{companyId}/organizations": { "get": { "tags": [ "Company" ], "summary": "Company Organizations", "description": "Array of organizations set at the company level.", "operationId": "getCompanyOrganizations", "parameters": [ { "name": "companyId", "in": "path", "description": "The ID of the company.", "required": true, "schema": { "type": "string" } }, { "name": "asof", "in": "query", "description": "Returns all Organizations as of the date used in the request.", "required": false, "schema": { "type": "string" }, "example": "2020-01-04T00:00:00Z" } ], "responses": { "200": { "description": "successful operation", "content": { "application/vnd.paychex.company.organizations.v1+json": { "schema": { "$ref": "#/components/schemas/OrganizationResource" }, "examples": { "companyOrganizations": { "$ref": "#/components/examples/JSONEXAMPLES/value/COMPANIES_ORG_GET" } } }, "application/json": { "schema": { "$ref": "#/components/schemas/OrganizationResource" }, "examples": { "defaultResponse": { "$ref": "#/components/examples/JSONEXAMPLES/value/COMPANIES_ORG_GET" } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-102", "description": "The client could not be authenticated due to missing or invalid client credentials.", "resolution": "Make sure that you are using the correct API key/Secret and that your application is enabled." } ] } } } }, "403": { "description": "User doesn't have access to this endpoint (API-2), Client has been end dated (API-68)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-2", "description": "Your application is not authorized to access the resource.", "resolution": "Please have your company administrator give your application access to the resource." } ] } } } }, "404": { "description": "Invalid resource ID (API-7)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-7", "description": "The resource or status is invalid. You may have an incorrect resource ID.", "resolution": "Send a valid resource in your request" } ] } } } }, "405": { "description": "Unsupported method type (API-59)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-59", "description": "The request method type is unsupported." } ] } } } }, "406": { "description": "Unsupported Accept header", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-75", "description": "Invalid vendor media type.", "resolution": "Please refer to our documentation and send the correct vendor media type" } ] } } } }, "500": { "description": "Internal Server Error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-1", "description": "Internal Server Error.", "resolution": "Please contact Paychex API Developer Center Support." } ] } } } } } } }, "/companies/{companyId}/organizations/{organizationId}": { "get": { "tags": [ "Company" ], "summary": "Company Organization", "description": "Information about a single Organization.", "operationId": "getCompanyOrganizationsById", "parameters": [ { "name": "companyId", "in": "path", "description": "The ID of the company.", "required": true, "schema": { "type": "string" } }, { "name": "organizationId", "in": "path", "description": "The ID of the organization.", "required": true, "schema": { "type": "string" } }, { "name": "asof", "in": "query", "description": "Returns all Organizations as of the date used in the request.", "required": false, "schema": { "type": "string" }, "example": "2020-01-04T00:00:00Z" } ], "responses": { "200": { "description": "successful operation", "content": { "application/vnd.paychex.company.organization.v1+json": { "schema": { "$ref": "#/components/schemas/OrganizationResource" }, "examples": { "CompaniesOrg": { "$ref": "#/components/examples/JSONEXAMPLES/value/COMPANIES_ORGID_GET" } } }, "application/json": { "schema": { "$ref": "#/components/schemas/OrganizationResource" }, "examples": { "defaultResponse": { "$ref": "#/components/examples/JSONEXAMPLES/value/COMPANIES_ORGID_GET" } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-102", "description": "The client could not be authenticated due to missing or invalid client credentials.", "resolution": "Make sure that you are using the correct API key/Secret and that your application is enabled." } ] } } } }, "403": { "description": "User doesn't have access to this endpoint (API-2), Client has been end dated (API-68)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-2", "description": "Your application is not authorized to access the resource.", "resolution": "Please have your company administrator give your application access to the resource." } ] } } } }, "404": { "description": "Invalid resource ID (API-7)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-7", "description": "The resource or status is invalid. You may have an incorrect resource ID.", "resolution": "Send a valid resource in your request" } ] } } } }, "405": { "description": "Unsupported method type (API-59)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-59", "description": "The request method type is unsupported." } ] } } } }, "406": { "description": "Unsupported Accept header", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-75", "description": "Invalid vendor media type.", "resolution": "Please refer to our documentation and send the correct vendor media type" } ] } } } }, "500": { "description": "Internal Server Error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-1", "description": "Internal Server Error.", "resolution": "Please contact Paychex API Developer Center Support." } ] } } } } } } }, "/companies/{companyId}/paycomponents": { "get": { "tags": [ "Payroll" ], "summary": "Company Pay Components", "description": "Array of pay components that are configured for a company. Pay components are earnings and deductions which are used for payroll.", "operationId": "getCompanyPayComponents", "parameters": [ { "name": "companyId", "in": "path", "description": "The id assigned to the company that is being requested for.", "required": true, "schema": { "type": "string" } }, { "name": "effectonpay", "in": "query", "description": "The type of effect on pay that you are requested for.", "required": false, "schema": { "type": "string" } }, { "name": "asof", "in": "query", "description": "Returns all PayComponent's as of the date used in the request.", "required": false, "schema": { "type": "string" }, "example": "2020-01-04T00:00:00Z" }, { "name": "classificationtype", "in": "query", "description": "The category that this component falls into. (such as EARNINGS or SICK_PAY )", "required": false, "schema": { "type": "string" } }, { "name": "name", "in": "query", "description": "The name of a pay component that a company has.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/vnd.paychex.payroll.paycomponents.v1+json": { "schema": { "$ref": "#/components/schemas/PayComponentResource" }, "examples": { "CompanyPayComponents": { "$ref": "#/components/examples/JSONEXAMPLES/value/COMPANY_PAYCOMPONENTS_GET" } } }, "application/json": { "schema": { "$ref": "#/components/schemas/PayComponentResource" }, "examples": { "defaultResponse": { "$ref": "#/components/examples/JSONEXAMPLES/value/COMPANY_PAYCOMPONENTS_GET" } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-102", "description": "The client could not be authenticated due to missing or invalid client credentials.", "resolution": "Make sure that you are using the correct API key/Secret and that your application is enabled." } ] } } } }, "403": { "description": "User doesn't have access to this endpoint (API-2), Client has been end dated (API-68)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-2", "description": "Your application is not authorized to access the resource.", "resolution": "Please have your company administrator give your application access to the resource." } ] } } } }, "404": { "description": "Invalid resource ID (API-7)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-7", "description": "The resource or status is invalid. You may have an incorrect resource ID.", "resolution": "Send a valid resource in your request" } ] } } } }, "405": { "description": "Unsupported method type (API-59)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-59", "description": "The request method type is unsupported." } ] } } } }, "406": { "description": "Unsupported Accept header", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-75", "description": "Invalid vendor media type.", "resolution": "Please refer to our documentation and send the correct vendor media type" } ] } } } }, "500": { "description": "Internal Server Error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-1", "description": "Internal Server Error.", "resolution": "Please contact Paychex API Developer Center Support." } ] } } } } } } }, "/companies/{companyId}/paycomponents/{paycomponentId}": { "get": { "tags": [ "Payroll" ], "summary": "Company Pay Component", "description": "Pay component associated with the company.", "operationId": "getCompanyPayComponent", "parameters": [ { "name": "companyId", "in": "path", "description": "The id assigned to the company that is being requested for.", "required": true, "schema": { "type": "string" } }, { "name": "paycomponentId", "in": "path", "description": "The unique identifier used to identify a pay component.", "required": true, "schema": { "type": "string" } }, { "name": "asof", "in": "query", "description": "Returns PayComponent as of the date used in the request.", "required": false, "schema": { "type": "string" }, "example": "2020-01-04T00:00:00Z" } ], "responses": { "200": { "description": "successful operation", "content": { "application/vnd.paychex.payroll.paycomponent.v1+json": { "schema": { "$ref": "#/components/schemas/PayComponentResource" }, "examples": { "CompanyPayComponentVmt": { "$ref": "#/components/examples/JSONEXAMPLES/value/COMPANY_PAYCOMPONENT_GET" } } }, "application/json": { "schema": { "$ref": "#/components/schemas/PayComponentResource" }, "examples": { "defaultResponse": { "$ref": "#/components/examples/JSONEXAMPLES/value/COMPANY_PAYCOMPONENT_GET" } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-102", "description": "The client could not be authenticated due to missing or invalid client credentials.", "resolution": "Make sure that you are using the correct API key/Secret and that your application is enabled." } ] } } } }, "403": { "description": "User doesn't have access to this endpoint (API-2), Client has been end dated (API-68)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-2", "description": "Your application is not authorized to access the resource.", "resolution": "Please have your company administrator give your application access to the resource." } ] } } } }, "404": { "description": "Invalid resource ID (API-7)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-7", "description": "The resource or status is invalid. You may have an incorrect resource ID.", "resolution": "Send a valid resource in your request" } ] } } } }, "405": { "description": "Unsupported method type (API-59)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-59", "description": "The request method type is unsupported." } ] } } } }, "406": { "description": "Unsupported Accept header", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-75", "description": "Invalid vendor media type.", "resolution": "Please refer to our documentation and send the correct vendor media type" } ] } } } }, "500": { "description": "Internal Server Error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-1", "description": "Internal Server Error.", "resolution": "Please contact Paychex API Developer Center Support." } ] } } } } } } }, "/companies/{companyId}/payfrequencies": { "get": { "tags": [ "Company" ], "summary": "Company Pay Frequencies", "description": "Array of pay frequencies that workers maybe paid on. This is a generic array that is currently not specific to the companies pay frequency. This is to be used with the workers pay components to determine what the frequency, occurrence, and intervals are allowed.", "operationId": "getFrequencyCombinations", "parameters": [ { "name": "payfrequency", "in": "query", "description": "The frequency that you would like to search for.", "required": false, "schema": { "type": "string" } }, { "name": "companyId", "in": "path", "description": "The ID of the company.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/vnd.paychex.payroll.payfrequencies.v1+json": { "schema": { "$ref": "#/components/schemas/FrequencyCombinationUnitResource" }, "examples": { "CompanyPayFrequencies": { "$ref": "#/components/examples/JSONEXAMPLES/value/COMPANY_PAYFREQUENCIES_GET" } } }, "application/json": { "schema": { "$ref": "#/components/schemas/FrequencyCombinationUnitResource" }, "examples": { "defaultResponse": { "$ref": "#/components/examples/JSONEXAMPLES/value/COMPANY_PAYFREQUENCIES_GET" } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-102", "description": "The client could not be authenticated due to missing or invalid client credentials.", "resolution": "Make sure that you are using the correct API key/Secret and that your application is enabled." } ] } } } }, "403": { "description": "User doesn't have access to this endpoint (API-2), Client has been end dated (API-68)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-2", "description": "Your application is not authorized to access the resource.", "resolution": "Please have your company administrator give your application access to the resource." } ] } } } }, "405": { "description": "Unsupported method type (API-59)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-59", "description": "The request method type is unsupported." } ] } } } }, "406": { "description": "Unsupported Accept header", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-75", "description": "Invalid vendor media type.", "resolution": "Please refer to our documentation and send the correct vendor media type" } ] } } } }, "500": { "description": "Internal Server Error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-1", "description": "Internal Server Error.", "resolution": "Please contact Paychex API Developer Center Support." } ] } } } } } } }, "/companies/{companyId}/payperiods": { "get": { "tags": [ "Payroll" ], "summary": "Company Pay Periods", "description": "Array of pay periods associated with the company.", "operationId": "getCompanyPayPeriods_1", "parameters": [ { "name": "companyId", "in": "path", "description": "The id assigned to the company that is being requested for.", "required": true, "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "Get PayPeriods that are in List of specific status.", "required": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "from", "in": "query", "description": "The beginning of the search date range using the Payperiod start date.", "required": false, "schema": { "type": "string" } }, { "name": "to", "in": "query", "description": "The ending of the search date range using the Payperiod end date.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/vnd.paychex.payroll.periods.v1+json": { "schema": { "$ref": "#/components/schemas/PayPeriodResource" }, "examples": { "CmpyPayperiods": { "$ref": "#/components/examples/JSONEXAMPLES/value/COMPANY_PPRDS_GET" } } }, "application/json": { "schema": { "$ref": "#/components/schemas/PayPeriodResource" }, "examples": { "defaultResponse": { "$ref": "#/components/examples/JSONEXAMPLES/value/COMPANY_PPRDS_GET" } } } } }, "400": { "description": "The date range requires valid start and end dates (API-8), The status you have provided is invalid (API-40)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "examples": { "CompanyPayPeriodStatus": { "description": "The value for the status is invalid.", "value": { "errors": [ { "code": "API-40", "description": "The value for the status is invalid.", "resolution": "Please remove the invalid status: FINISHED" } ] } }, "CompanyDaterange": { "description": "The date range requires valid start and end dates", "value": { "errors": [ { "code": "API-8", "description": "The date you have provided is invalid.", "resolution": "The date range requires valid start and end dates." } ] } }, "CompanyPayperiodsMultipleStatuses": { "description": "Multiple status values are invalid.", "value": { "errors": [ { "code": "API-40", "description": "The value for the multiple status is invalid.", "resolution": "Please remove the invalid statuses: FINISHED,NEW " } ] } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-102", "description": "The client could not be authenticated due to missing or invalid client credentials.", "resolution": "Make sure that you are using the correct API key/Secret and that your application is enabled." } ] } } } }, "403": { "description": "User doesn't have access to this endpoint (API-2), Client has been end dated (API-68)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-2", "description": "Your application is not authorized to access the resource.", "resolution": "Please have your company administrator give your application access to the resource." } ] } } } }, "404": { "description": "Invalid resource ID (API-7)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-7", "description": "The resource or status is invalid. You may have an incorrect resource ID.", "resolution": "Send a valid resource in your request" } ] } } } }, "405": { "description": "Unsupported method type (API-59)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-59", "description": "The request method type is unsupported." } ] } } } }, "406": { "description": "Unsupported Accept header", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-75", "description": "Invalid vendor media type.", "resolution": "Please refer to our documentation and send the correct vendor media type" } ] } } } }, "500": { "description": "Internal Server Error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-1", "description": "Internal Server Error.", "resolution": "Please contact Paychex API Developer Center Support." } ] } } } } } } }, "/companies/{companyId}/payperiods/{payperiodId}": { "get": { "tags": [ "Payroll" ], "summary": "Company Pay Period", "description": "A single pay period.", "operationId": "getCompanyPayPeriodsByPayPeriodId", "parameters": [ { "name": "companyId", "in": "path", "description": "The id assigned to the company that is being requested for.", "required": true, "schema": { "type": "string" } }, { "name": "payperiodId", "in": "path", "description": "The id assigned to the PayPeriod you are looking for.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Pay Period successfully returned for given payPeriodId.", "content": { "application/vnd.paychex.payroll.period.v1+json": { "schema": { "$ref": "#/components/schemas/PayPeriodResource" }, "examples": { "CmpyPayperiod": { "$ref": "#/components/examples/JSONEXAMPLES/value/COMPANY_PPRD_GET" } } }, "application/json": { "schema": { "$ref": "#/components/schemas/PayPeriodResource" }, "examples": { "defaultResponse": { "$ref": "#/components/examples/JSONEXAMPLES/value/COMPANY_PPRD_GET" } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-102", "description": "The client could not be authenticated due to missing or invalid client credentials.", "resolution": "Make sure that you are using the correct API key/Secret and that your application is enabled." } ] } } } }, "403": { "description": "User doesn't have access to this endpoint (API-2)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-2", "description": "Your application is not authorized to access the resource.", "resolution": "Please have your company administrator give your application access to the resource." } ] } } } }, "404": { "description": "Invalid resource ID (API-7)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-7", "description": "The resource or status is invalid. You may have an incorrect resource ID.", "resolution": "Send a valid resource in your request" } ] } } } }, "405": { "description": "Unsupported method type (API-59)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-59", "description": "The request method type is unsupported." } ] } } } }, "406": { "description": "Unsupported Accept header", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-75", "description": "Invalid vendor media type.", "resolution": "Please refer to our documentation and send the correct vendor media type" } ] } } } }, "500": { "description": "Internal Server Error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-1", "description": "Internal Server Error.", "resolution": "Please contact Paychex API Developer Center Support." } ] } } } } } } }, "/companies/{companyId}/statetaxes": { "get": { "tags": [ "Company" ], "summary": "Company State Taxes", "description": "Information about states that the client has enabled for state income tax.", "operationId": "getCompanyStateTaxes", "parameters": [ { "name": "companyId", "in": "path", "description": "The id assigned to the company that is being requested for.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientStateTaxResource" }, "examples": { "Success": { "$ref": "#/components/examples/JSONEXAMPLES/value/COMPANY_STATE_TAXES" } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-102", "description": "The client could not be authenticated due to missing or invalid client credentials.", "resolution": "Make sure that you are using the correct API key/Secret and that your application is enabled." } ] } } } }, "403": { "description": "User doesn't have access to this endpoint (API-2), Client has been end dated (API-68)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-2", "description": "Your application is not authorized to access the resource.", "resolution": "Please have your company administrator give your application access to the resource." } ] } } } }, "404": { "description": "Invalid resource ID (API-7)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-7", "description": "The resource or status is invalid. You may have an incorrect resource ID.", "resolution": "Send a valid resource in your request" } ] } } } }, "405": { "description": "Unsupported method type (API-59)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-59", "description": "The request method type is unsupported." } ] } } } }, "500": { "description": "Internal Server Error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-1", "description": "Internal Server Error.", "resolution": "Please contact Paychex API Developer Center Support." } ] } } } } } } }, "/companies/{companyId}/workers": { "get": { "tags": [ "Company" ], "summary": "Company Workers", "description": "Array of workers (employee and contractor) for all of the companies who are associated with a specific company that your application has been granted access to. The combination of query parameters to be used with this endpoint are as follows: 1. givenname, familyname, legallastfour 2. from, to (start date, end date) 3. employeeid 4. locationid 5. offset, limit (paging). Note: Paging and filtering attributes cannot be applied together. ", "operationId": "getCompanyWorkers", "parameters": [ { "name": "companyId", "in": "path", "description": "The id assigned to the company that workers are being requested for.", "required": true, "schema": { "type": "string" } }, { "name": "givenname", "in": "query", "description": "The given or first name of the workers to search for.", "required": false, "schema": { "type": "string" } }, { "name": "familyname", "in": "query", "description": "The family or last name of the workers to search for.", "required": false, "schema": { "type": "string" } }, { "name": "legallastfour", "in": "query", "description": "The last 4 digits of the workers federal level taxpayer id number of the worker to search for.", "required": false, "schema": { "type": "string" } }, { "name": "employeeid", "in": "query", "description": "The assigned workers employee ID.", "required": false, "schema": { "type": "string" } }, { "name": "from", "in": "query", "description": "The beginning of the search date range using for when the worker was created.", "required": false, "schema": { "type": "string" } }, { "name": "to", "in": "query", "description": "The ending of the search date range using for then the worker was created.", "required": false, "schema": { "type": "string" } }, { "name": "locationid", "in": "query", "description": "The location id of the worker", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/vnd.paychex.workers.v1+json": { "schema": { "$ref": "#/components/schemas/WorkerResource" }, "examples": { "CompanyWorkers": { "$ref": "#/components/examples/JSONEXAMPLES/value/COMPANIES_WORKERS_GET" } } }, "application/json": { "schema": { "$ref": "#/components/schemas/WorkerResource" }, "examples": { "defaultResponse": { "$ref": "#/components/examples/JSONEXAMPLES/value/COMPANIES_WORKERS_GET" } } }, "application/vnd.paychex.workers_communications.v1+json": { "schema": { "$ref": "#/components/schemas/WorkerResource" }, "examples": { "CompanyWorkersCommunications": { "$ref": "#/components/examples/JSONEXAMPLES/value/COMPANIES_WORKERS_COMM_GET" } } }, "application/vnd.paychex.workers.nonpii_communications.v1+json": { "schema": { "$ref": "#/components/schemas/WorkerResource" }, "examples": { "CompanyWorkersCommunicationsNonPII": { "$ref": "#/components/examples/JSONEXAMPLES/value/COMPANIES_WORKERS_COMM_NONPII_GET" } } }, "application/vnd.paychex.workers.nonpii.v1+json": { "schema": { "$ref": "#/components/schemas/WorkerResource" }, "examples": { "CompanyWorkersNonPII": { "$ref": "#/components/examples/JSONEXAMPLES/value/COMPANIES_WORKERS_NONPII_GET" } } }, "application/vnd.paychex.workers.roster.v1+json": { "schema": { "$ref": "#/components/schemas/WorkerResource" }, "examples": { "CompanyWorkersRoster": { "$ref": "#/components/examples/JSONEXAMPLES/value/COMPANIES_WORKERS_ROSTER_GET" } } } } }, "400": { "description": "Missing query parameters (API-42), Missing query parameter (API-49), Invalid query parameter combination (API-40)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-40", "description": "The request isn't valid.", "resolution": "Please send the valid request" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-102", "description": "The client could not be authenticated due to missing or invalid client credentials.", "resolution": "Make sure that you are using the correct API key/Secret and that your application is enabled." } ] } } } }, "403": { "description": "User doesn't have access to this endpoint (API-2), Client has been end dated (API-68)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-2", "description": "Your application is not authorized to access the resource.", "resolution": "Please have your company administrator give your application access to the resource." } ] } } } }, "404": { "description": "Invalid resource ID (API-7), No existing worker found matching search criteria (API-43)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-7", "description": "The resource or status is invalid. You may have an incorrect resource ID.", "resolution": "Send a valid resource in your request" } ] } } } }, "405": { "description": "Unsupported method type (API-59)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-59", "description": "The request method type is unsupported." } ] } } } }, "406": { "description": "Unsupported Accept header", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-75", "description": "Invalid vendor media type.", "resolution": "Please refer to our documentation and send the correct vendor media type" } ] } } } }, "500": { "description": "Internal Server Error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-1", "description": "Internal Server Error.", "resolution": "Please contact Paychex API Developer Center Support." } ] } } } } } }, "post": { "tags": [ "Company" ], "summary": "In Progress Workers", "description": "Add one or more workers to a specific company that your application has been granted access to. These workers will be added with an IN_PROGRESS status assigned to them. In_Progress workers will pre-populated within Paychex Flex and will require someone to complete them to be fully available with the Flex platform. Paychex Flex UI will hold a majority of validation, rules, and enforced required fields based on the clients configuration. Required fields are givenName, familyName, & workerType (when adding multiple workers at a time you will need to also include a \"workerCorrelationId\" data element on each worker, that will be used as an identifier in our responses). Optionally you can include a worker's communications object within the worker. A worker's federal tax elections will be generated and defaulted automatically to withheld with 0 deductions/income and a filing status of single/married filing separately. Upon successfully posting a new in-progress worker, the response will generate a new workerId. This ID can then be used in subsequent calls to update existing worker properties or add more details to the worker's communications, direct deposit, compensation, and state taxes.", "operationId": "createInProgressWorkers", "parameters": [ { "name": "companyId", "in": "path", "description": "The id assigned to the company that workers are being requested for.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/vnd.paychex.workers.v1+json": { "schema": { "$ref": "#/components/schemas/WorkerResource" }, "examples": { "postWorkerReq": { "$ref": "#/components/examples/JSONEXAMPLES/value/C_IN_PROGRESS_WORKER_POST_REQ" } } } }, "required": true }, "responses": { "201": { "description": "successful operation", "content": { "application/vnd.paychex.workers.v1+json": { "schema": { "$ref": "#/components/schemas/WorkerResource" }, "examples": { "postWorkers": { "$ref": "#/components/examples/JSONEXAMPLES/value/C_IN_PROGRESS_WORKER_POST_RESP" } } }, "application/json": { "schema": { "$ref": "#/components/schemas/WorkerResource" }, "examples": { "postDefResponse": { "$ref": "#/components/examples/JSONEXAMPLES/value/C_IN_PROGRESS_WORKER_POST_RESP" } } } } }, "207": { "description": "Multi-status", "content": { "application/vnd.paychex.workers.v1+json": { "schema": { "$ref": "#/components/schemas/WorkerResource" }, "examples": { "postWorkersMulti": { "$ref": "#/components/examples/JSONEXAMPLES/value/C_IN_PROGRESS_WORKER_POST_RESP_MULTI" } } }, "application/json": { "schema": { "$ref": "#/components/schemas/WorkerResource" }, "examples": { "postResponseMulti": { "$ref": "#/components/examples/JSONEXAMPLES/value/C_IN_PROGRESS_WORKER_POST_RESP_MULTI" } } } } }, "400": { "description": "Required field invalid (API-48)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-40", "description": "The request isn't valid.", "resolution": "Please send the valid request" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-102", "description": "The client could not be authenticated due to missing or invalid client credentials.", "resolution": "Make sure that you are using the correct API key/Secret and that your application is enabled." } ] } } } }, "403": { "description": "User doesn't have access to this endpoint (API-2), Client has been end dated (API-68)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-2", "description": "Your application is not authorized to access the resource.", "resolution": "Please have your company administrator give your application access to the resource." } ] } } } }, "405": { "description": "Unsupported method type (API-59)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-59", "description": "The request method type is unsupported." } ] } } } }, "406": { "description": "Unsupported Accept header", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-75", "description": "Invalid vendor media type.", "resolution": "Please refer to our documentation and send the correct vendor media type" } ] } } } }, "500": { "description": "Internal Server Error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-1", "description": "Internal Server Error.", "resolution": "Please contact Paychex API Developer Center Support." } ] } } } } } } }, "/companies/{companyId}/workerstatuses": { "get": { "tags": [ "Company" ], "summary": "Company Worker Statuses", "description": "Array of statuses set at the company level which a worker could be assigned.", "operationId": "getCompanyStatusCodes", "parameters": [ { "name": "companyId", "in": "path", "description": "The ID of the company.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/vnd.paychex.company.workerstatuses.v1+json": { "schema": { "$ref": "#/components/schemas/WorkerStatus" }, "examples": { "CompaniesWkrStatuses": { "$ref": "#/components/examples/JSONEXAMPLES/value/C_WSTATUSES_GET" } } }, "application/json": { "schema": { "$ref": "#/components/schemas/WorkerStatus" }, "examples": { "defaultResponse": { "$ref": "#/components/examples/JSONEXAMPLES/value/C_WSTATUSES_GET" } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-102", "description": "The client could not be authenticated due to missing or invalid client credentials.", "resolution": "Make sure that you are using the correct API key/Secret and that your application is enabled." } ] } } } }, "403": { "description": "User doesn't have access to this endpoint (API-2), Client has been end dated (API-68)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-2", "description": "Your application is not authorized to access the resource.", "resolution": "Please have your company administrator give your application access to the resource." } ] } } } }, "404": { "description": "Invalid resource ID (API-7)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-7", "description": "The resource or status is invalid. You may have an incorrect resource ID.", "resolution": "Send a valid resource in your request" } ] } } } }, "405": { "description": "Unsupported method type (API-59)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-59", "description": "The request method type is unsupported." } ] } } } }, "406": { "description": "Unsupported Accept header", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-75", "description": "Invalid vendor media type.", "resolution": "Please refer to our documentation and send the correct vendor media type" } ] } } } }, "500": { "description": "Internal Server Error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-1", "description": "Internal Server Error.", "resolution": "Please contact Paychex API Developer Center Support." } ] } } } } } } }, "/companies/{companyId}/workerstatuses/{workerStatusId}": { "get": { "tags": [ "Company" ], "summary": "Company Worker Status", "description": "Information about a single status.", "operationId": "getCompanyStatusCode", "parameters": [ { "name": "companyId", "in": "path", "description": "The ID of the company.", "required": true, "schema": { "type": "string" } }, { "name": "workerStatusId", "in": "path", "description": "The ID of the worker status.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/vnd.paychex.company.workerstatus.v1+json": { "schema": { "$ref": "#/components/schemas/WorkerStatus" }, "examples": { "CompaniesWkrStatus": { "$ref": "#/components/examples/JSONEXAMPLES/value/C_WSTATUSID_GET" } } }, "application/json": { "schema": { "$ref": "#/components/schemas/WorkerStatus" }, "examples": { "defaultResponse": { "$ref": "#/components/examples/JSONEXAMPLES/value/C_WSTATUSID_GET" } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-102", "description": "The client could not be authenticated due to missing or invalid client credentials.", "resolution": "Make sure that you are using the correct API key/Secret and that your application is enabled." } ] } } } }, "403": { "description": "User doesn't have access to this endpoint (API-2), Client has been end dated (API-68)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-2", "description": "Your application is not authorized to access the resource.", "resolution": "Please have your company administrator give your application access to the resource." } ] } } } }, "404": { "description": "Invalid resource ID (API-7)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-7", "description": "The resource or status is invalid. You may have an incorrect resource ID.", "resolution": "Send a valid resource in your request" } ] } } } }, "405": { "description": "Unsupported method type (API-59)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-59", "description": "The request method type is unsupported." } ] } } } }, "406": { "description": "Unsupported Accept header", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-75", "description": "Invalid vendor media type.", "resolution": "Please refer to our documentation and send the correct vendor media type" } ] } } } }, "500": { "description": "Internal Server Error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-1", "description": "Internal Server Error.", "resolution": "Please contact Paychex API Developer Center Support." } ] } } } } } } }, "/workers/{workerId}": { "get": { "tags": [ "Worker" ], "summary": "Worker", "description": "Information about a unique worker (employee and contractor) that your application has been granted access to. Currently workers that exist within Paychex Flex payroll will be available, future enhancements will make workers from other Paychex systems available.", "operationId": "getWorkerUsersCommunicationsNonpii_1_1_1_1_1_1_1_1", "parameters": [ { "name": "workerId", "in": "path", "description": "ID associated with desired worker.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/vnd.paychex.worker.v1+json": { "schema": { "$ref": "#/components/schemas/WorkerResourceV2" }, "examples": { "Worker1": { "$ref": "#/components/examples/JSON_WORKER_EXAMPLES/value/WORKER_DEFAULT_GET" } } }, "application/vnd.paychex.worker_communications.v1+json": { "schema": { "$ref": "#/components/schemas/WorkerResourceV2" }, "examples": { "Worker2": { "$ref": "#/components/examples/JSON_WORKER_EXAMPLES/value/GET_WORKER_VMT_COMMUNICATION" } } }, "application/vnd.paychex.worker.nonpii.v1+json": { "schema": { "$ref": "#/components/schemas/WorkerResourceV2" }, "examples": { "Worker3": { "$ref": "#/components/examples/JSON_WORKER_EXAMPLES/value/WORKER_NONPII_VMT_GET" } } }, "application/json": { "schema": { "$ref": "#/components/schemas/WorkerResourceV2" }, "examples": { "Worker4": { "$ref": "#/components/examples/JSON_WORKER_EXAMPLES/value/WORKER_DEFAULT_GET" } } }, "application/vnd.paychex.worker.nonpii_communications.v1+json": { "schema": { "$ref": "#/components/schemas/WorkerResourceV2" }, "examples": { "Worker5": { "$ref": "#/components/examples/JSON_WORKER_EXAMPLES/value/WORKER_NONPII_VMT_COMMUNICATION" } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-102", "description": "The client could not be authenticated due to missing or invalid client credentials.", "resolution": "Make sure that you are using the correct API key/Secret and that your application is enabled." } ] } } } }, "403": { "description": "User doesn't have access to this endpoint (API-2), Client has been end dated (API-68)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-2", "description": "Your application is not authorized to access the resource.", "resolution": "Please have your company administrator give your application access to the resource." } ] } } } }, "404": { "description": "Invalid resource ID (API-7)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-7", "description": "The resource or status is invalid. You may have an incorrect resource ID.", "resolution": "Send a valid resource in your request" } ] } } } }, "405": { "description": "Unsupported method type (API-59)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-59", "description": "The request method type is unsupported." } ] } } } }, "406": { "description": "Unsupported Accept header", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-75", "description": "Invalid vendor media type.", "resolution": "Please refer to our documentation and send the correct vendor media type" } ] } } } }, "500": { "description": "Internal Server Error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-1", "description": "Internal Server Error.", "resolution": "Please contact Paychex API Developer Center Support." } ] } } } } } }, "delete": { "tags": [ "Worker" ], "summary": "Worker", "description": "Delete in progress Worker", "operationId": "deleteInProgressWorker", "parameters": [ { "name": "workerId", "in": "path", "description": "ID associated with desired worker.", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Inprogress Worker successfully deleted" }, "400": { "description": "The request cannot be performed since the worker is in a state which does not allow this action(API-19)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-40", "description": "The request isn't valid.", "resolution": "Please send the valid request" } ] } } } }, "404": { "description": "Worker not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-7", "description": "The resource or status is invalid. You may have an incorrect resource ID.", "resolution": "Send a valid resource in your request" } ] } } } }, "500": { "description": "Internal Server Error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-1", "description": "Internal Server Error.", "resolution": "Please contact Paychex API Developer Center Support." } ] } } } } } }, "patch": { "tags": [ "Worker" ], "summary": "Worker", "description": "Update a unique worker (employee and contractor) that your application has been granted access to modify.", "operationId": "updateWorker", "parameters": [ { "name": "workerId", "in": "path", "description": "ID associated with desired worker.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/vnd.paychex.worker.v1+json": { "schema": { "$ref": "#/components/schemas/WorkerResourceV2" }, "examples": { "updateWorkerReq1": { "$ref": "#/components/examples/JSON_WORKER_EXAMPLES/value/WORKER_PATCH" } } }, "application/json": { "schema": { "$ref": "#/components/schemas/WorkerResourceV2" }, "examples": { "updateWorkerReq2": { "$ref": "#/components/examples/JSON_WORKER_EXAMPLES/value/WORKER_PATCH" } } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "application/vnd.paychex.worker.v1+json": { "schema": { "$ref": "#/components/schemas/WorkerResourceV2" }, "examples": { "updateWorkerRes1": { "$ref": "#/components/examples/JSON_WORKER_EXAMPLES/value/WORKER_PATCH_RESPONSE" } } }, "application/json": { "schema": { "$ref": "#/components/schemas/WorkerResourceV2" }, "examples": { "updateWorkerRes2": { "$ref": "#/components/examples/JSON_WORKER_EXAMPLES/value/WORKER_PATCH_RESPONSE" } } } } }, "400": { "description": "The request is invalid (API-4), Invalid field (API-17), The request cannot be performed since the worker is in a state which does not allow this action(API-19),The current status cannot be past or future dated (API-20), Invalid value (API-24), The field cannot be removed (API-25), Attempting to terminate a worker that is a supervisor (API-67)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-40", "description": "The request isn't valid.", "resolution": "Please send the valid request" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-102", "description": "The client could not be authenticated due to missing or invalid client credentials.", "resolution": "Make sure that you are using the correct API key/Secret and that your application is enabled." } ] } } } }, "403": { "description": "User doesn't have access to this endpoint (API-2), Client has been end dated (API-68)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-2", "description": "Your application is not authorized to access the resource.", "resolution": "Please have your company administrator give your application access to the resource." } ] } } } }, "404": { "description": "Invalid resource ID (API-7)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-7", "description": "The resource or status is invalid. You may have an incorrect resource ID.", "resolution": "Send a valid resource in your request" } ] } } } }, "405": { "description": "Unsupported method type (API-59)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-59", "description": "The request method type is unsupported." } ] } } } }, "406": { "description": "Unsupported Accept header", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-75", "description": "Invalid vendor media type.", "resolution": "Please refer to our documentation and send the correct vendor media type" } ] } } } }, "423": { "description": "Client locked (API-10)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-10", "description": "The client is locked because another user or process is updating it. Your changes cannot be saved while the client is locked.", "resolution": "Please try again later." } ] } } } }, "500": { "description": "Internal Server Error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-1", "description": "Internal Server Error.", "resolution": "Please contact Paychex API Developer Center Support." } ] } } } } } } }, "/workers/{workerId}/assignmentdistributions": { "get": { "tags": [ "Worker" ], "summary": "Worker Assignments", "description": "Array of assignments that will be used for auto distribution assigned to the worker.", "operationId": "getWorkerAssignmentsDistributions", "parameters": [ { "name": "workerId", "in": "path", "description": "The ID of the worker.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/vnd.paychex.worker.assignmentdistributions.v1+json": { "schema": { "$ref": "#/components/schemas/WorkerAssignmentDistributionsResource" }, "examples": { "assignmentDistributionVMT": { "$ref": "#/components/examples/JSON_WORKER_EXAMPLES/value/WORKER_ASSIGNMENT_DISTRIBUTIONS_GET" } } }, "application/json": { "schema": { "$ref": "#/components/schemas/WorkerAssignmentDistributionsResource" }, "examples": { "assignmentDistributionDef": { "$ref": "#/components/examples/JSON_WORKER_EXAMPLES/value/WORKER_ASSIGNMENT_DISTRIBUTIONS_GET" } } } } }, "400": { "description": "Invalid resource or field, The request cannot be performed since the worker is in a state which does not allow this action(API-19)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-40", "description": "The request isn't valid.", "resolution": "Please send the valid request" } ] } } } }, "404": { "description": "Worker Assignments not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-7", "description": "The resource or status is invalid. You may have an incorrect resource ID.", "resolution": "Send a valid resource in your request" } ] } } } }, "500": { "description": "Internal Server Error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-1", "description": "Internal Server Error.", "resolution": "Please contact Paychex API Developer Center Support." } ] } } } } } } }, "/workers/{workerId}/checks": { "get": { "tags": [ "Payroll" ], "summary": "Worker Checks", "description": "Get check(s) that are for a specific worker within a processed or unprocessed pay period.", "operationId": "getWorkerChecks", "parameters": [ { "name": "workerId", "in": "path", "description": "ID associated with desired worker.", "required": true, "schema": { "type": "string" } }, { "name": "payperiodid", "in": "query", "description": "The id assigned to the pay period that the check will be within.", "required": true, "schema": { "type": "string" } }, { "name": "filterbyuserid", "in": "query", "description": "Filter by User Id.", "required": false, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/vnd.paychex.payroll.processedchecks.v1+json": { "schema": { "$ref": "#/components/schemas/CheckResource_Internal1" }, "examples": { "getWorkerChecks1": { "$ref": "#/components/examples/JSON_WORKER_EXAMPLES/value/WORKER_PROCESSED_CHECKS_GET" } } }, "application/vnd.paychex.payroll.checks.v1+json": { "schema": { "$ref": "#/components/schemas/CheckResource_Internal1" }, "examples": { "getWorkerChecks2": { "$ref": "#/components/examples/JSON_WORKER_EXAMPLES/value/WORKER_UN_PROCESSED_CHECKS_GET" } } }, "application/json": { "schema": { "$ref": "#/components/schemas/CheckResource_Internal1" }, "examples": { "getWorkerChecks3": { "$ref": "#/components/examples/JSON_WORKER_EXAMPLES/value/WORKER_UN_PROCESSED_CHECKS_GET" } } } } }, "400": { "description": "The request cannot be performed since the worker is in a state which does not allow this action(API-19),Invalid pay period ID (API-40)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource_Internal" }, "example": { "errors": [ { "code": "API-40", "description": "The request isn't valid.", "resolution": "Please send the valid request" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource_Internal" }, "example": { "errors": [ { "code": "API-102", "description": "The client could not be authenticated due to missing or invalid client credentials.", "resolution": "Make sure that you are using the correct API key/Secret and that your application is enabled." } ] } } } }, "403": { "description": "User doesn't have access to this endpoint (API-2), Client has been end dated (API-68)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource_Internal" }, "example": { "errors": [ { "code": "API-2", "description": "Your application is not authorized to access the resource.", "resolution": "Please have your company administrator give your application access to the resource." } ] } } } }, "404": { "description": "Invalid resource ID (API-7)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource_Internal" }, "example": { "errors": [ { "code": "API-7", "description": "The resource or status is invalid. You may have an incorrect resource ID.", "resolution": "Send a valid resource in your request" } ] } } } }, "405": { "description": "Unsupported method type (API-59)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource_Internal" }, "example": { "errors": [ { "code": "API-59", "description": "The request method type is unsupported." } ] } } } }, "406": { "description": "Unsupported Accept header", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource_Internal" }, "example": { "errors": [ { "code": "API-75", "description": "Invalid vendor media type.", "resolution": "Please refer to our documentation and send the correct vendor media type" } ] } } } }, "500": { "description": "Internal Server Error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource_Internal" }, "example": { "errors": [ { "code": "API-1", "description": "Internal Server Error.", "resolution": "Please contact Paychex API Developer Center Support." } ] } } } } } }, "post": { "tags": [ "Payroll" ], "summary": "Worker Check", "description": "Add a check to a worker for an unprocessed pay period.", "operationId": "createWorkerCheck", "parameters": [ { "name": "workerId", "in": "path", "description": "ID associated with desired worker.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/vnd.paychex.payroll.check.v1+json": { "schema": { "$ref": "#/components/schemas/CheckResource1" }, "examples": { "workerCheckReqVMT": { "$ref": "#/components/examples/JSON_WORKER_EXAMPLES/value/WORKER_CHECK_POST" } } }, "application/json": { "schema": { "$ref": "#/components/schemas/CheckResource1" }, "examples": { "workerCheckReqDef": { "$ref": "#/components/examples/JSON_WORKER_EXAMPLES/value/WORKER_CHECK_POST" } } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "application/vnd.paychex.payroll.check.v1+json": { "schema": { "$ref": "#/components/schemas/CheckResource1" }, "examples": { "workerCheckResVMT": { "$ref": "#/components/examples/JSON_WORKER_EXAMPLES/value/WORKER_UN_PROCESSED_CHECK_GET" } } }, "application/json": { "schema": { "$ref": "#/components/schemas/CheckResource1" }, "examples": { "workerCheckResDef": { "$ref": "#/components/examples/JSON_WORKER_EXAMPLES/value/WORKER_UN_PROCESSED_CHECK_GET" } } } } }, "400": { "description": "The request cannot be performed since the worker is in a state which does not allow this action(API-19),Amount should be between 0.00-9999.99 (API-28), Invalid Org ID (API-40), Required field missing (API-46), Required field ambiguous (API-47), Required field invalid (API-48), Pay period is in a state that will not allow checks to be modified (API-51), Empty request (API-52), All checks must have the same pay period in the request (API-53), Missing required field for one or more request (API-54), At least one worker doesn't belong to this client (API-55), Duplicate correlation ID (API-56), The pay component doesn't support the corresponding worker type (API-57), The pay component can't be REDUCTION type (API-60), Product was not set up for this client as of the check date of the given pay period (API-65), The pay rate's start date is after the provided PayPeriod's date range (API-69), This worker does not have a default pay rate set (API-70)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-40", "description": "The request isn't valid.", "resolution": "Please send the valid request" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-102", "description": "The client could not be authenticated due to missing or invalid client credentials.", "resolution": "Make sure that you are using the correct API key/Secret and that your application is enabled." } ] } } } }, "403": { "description": "User doesn't have access to this endpoint (API-2), Client has been end dated (API-68)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-2", "description": "Your application is not authorized to access the resource.", "resolution": "Please have your company administrator give your application access to the resource." } ] } } } }, "404": { "description": "Invalid resource ID (API-7)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-7", "description": "The resource or status is invalid. You may have an incorrect resource ID.", "resolution": "Send a valid resource in your request" } ] } } } }, "405": { "description": "Unsupported method type (API-59)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-59", "description": "The request method type is unsupported." } ] } } } }, "406": { "description": "Unsupported Accept header", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-75", "description": "Invalid vendor media type.", "resolution": "Please refer to our documentation and send the correct vendor media type" } ] } } } }, "423": { "description": "Client locked (API-10)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-10", "description": "The client is locked because another user or process is updating it. Your changes cannot be saved while the client is locked.", "resolution": "Please try again later." } ] } } } }, "500": { "description": "Internal Server Error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-1", "description": "Internal Server Error.", "resolution": "Please contact Paychex API Developer Center Support." } ] } } } }, "503": { "description": "Checks service unavailable (API-66)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-66", "description": "The service is temporarily unavailable.", "resolution": "Please try again later." } ] } } } } } } }, "/workers/{workerId}/checks/{externalCheckId}": { "get": { "tags": [ "Payroll" ], "summary": "Worker Check", "description": "Retrieve a specific unprocessed or processed check that a worker has.", "operationId": "getWorkerCheck", "parameters": [ { "name": "workerId", "in": "path", "description": "ID associated with desired worker.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/vnd.paychex.payroll.processedcheck.v1+json": { "schema": { "$ref": "#/components/schemas/CheckResource_Internal1" }, "examples": { "processedCheck1": { "$ref": "#/components/examples/JSON_WORKER_EXAMPLES/value/WORKER_PROCESSED_CHECK_GET" } } }, "application/vnd.paychex.payroll.check.v1+json": { "schema": { "$ref": "#/components/schemas/CheckResource_Internal1" }, "examples": { "unprocessedCheck1": { "$ref": "#/components/examples/JSON_WORKER_EXAMPLES/value/WORKER_UN_PROCESSED_CHECK_GET" } } }, "application/json": { "schema": { "$ref": "#/components/schemas/CheckResource_Internal1" }, "examples": { "checksdefault": { "$ref": "#/components/examples/JSON_WORKER_EXAMPLES/value/WORKER_UN_PROCESSED_CHECK_GET" } } } } }, "400": { "description": "The request cannot be performed since the worker is in a state which does not allow this action(API-19)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource_Internal" }, "example": { "errors": [ { "code": "API-40", "description": "The request isn't valid.", "resolution": "Please send the valid request" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource_Internal" }, "example": { "errors": [ { "code": "API-102", "description": "The client could not be authenticated due to missing or invalid client credentials.", "resolution": "Make sure that you are using the correct API key/Secret and that your application is enabled." } ] } } } }, "403": { "description": "User doesn't have access to this endpoint (API-2), Client has been end dated (API-68)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource_Internal" }, "example": { "errors": [ { "code": "API-2", "description": "Your application is not authorized to access the resource.", "resolution": "Please have your company administrator give your application access to the resource." } ] } } } }, "404": { "description": "Invalid resource ID (API-7)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource_Internal" }, "example": { "errors": [ { "code": "API-7", "description": "The resource or status is invalid. You may have an incorrect resource ID.", "resolution": "Send a valid resource in your request" } ] } } } }, "405": { "description": "Unsupported method type (API-59)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource_Internal" }, "example": { "errors": [ { "code": "API-59", "description": "The request method type is unsupported." } ] } } } }, "406": { "description": "Unsupported Accept header", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource_Internal" }, "example": { "errors": [ { "code": "API-75", "description": "Invalid vendor media type.", "resolution": "Please refer to our documentation and send the correct vendor media type" } ] } } } }, "500": { "description": "Internal Server Error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource_Internal" }, "example": { "errors": [ { "code": "API-1", "description": "Internal Server Error.", "resolution": "Please contact Paychex API Developer Center Support." } ] } } } }, "503": { "description": "Checks service unavailable (API-66)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource_Internal" }, "example": { "errors": [ { "code": "API-66", "description": "The service is temporarily unavailable.", "resolution": "Please try again later." } ] } } } } } }, "delete": { "tags": [ "Payroll" ], "summary": "Worker Check", "description": "Remove a specific unprocessed check that a worker has.", "operationId": "deleteWorkerCheck", "parameters": [ { "name": "workerId", "in": "path", "description": "ID associated with desired worker.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/vnd.paychex.payroll.check.v1+json": { "schema": { "$ref": "#/components/schemas/CheckResource1" }, "examples": { "deleteWorkercheckByid": { "$ref": "#/components/examples/JSON_WORKER_EXAMPLES/value/DELETE_EMPTY_RESPONSE" } } } } }, "400": { "description": "The request cannot be performed since the worker is in a state which does not allow this action(API-19)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-40", "description": "The request isn't valid.", "resolution": "Please send the valid request" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-102", "description": "The client could not be authenticated due to missing or invalid client credentials.", "resolution": "Make sure that you are using the correct API key/Secret and that your application is enabled." } ] } } } }, "403": { "description": "User doesn't have access to this endpoint (API-2), Client has been end dated (API-68)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-2", "description": "Your application is not authorized to access the resource.", "resolution": "Please have your company administrator give your application access to the resource." } ] } } } }, "404": { "description": "Invalid resource ID (API-7)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-7", "description": "The resource or status is invalid. You may have an incorrect resource ID.", "resolution": "Send a valid resource in your request" } ] } } } }, "405": { "description": "Unsupported method type (API-59)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-59", "description": "The request method type is unsupported." } ] } } } }, "406": { "description": "Unsupported Accept header", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-75", "description": "Invalid vendor media type.", "resolution": "Please refer to our documentation and send the correct vendor media type" } ] } } } }, "500": { "description": "Internal Server Error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-1", "description": "Internal Server Error.", "resolution": "Please contact Paychex API Developer Center Support." } ] } } } } } } }, "/workers/{workerId}/communications": { "get": { "tags": [ "Worker" ], "summary": "Worker Communications", "description": "Information about \"Active\" or \"In-progress\" workers communications.", "operationId": "getWorkerCommunications", "parameters": [ { "name": "workerId", "in": "path", "description": "The id assigned to the worker that workers are being requested for.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/vnd.paychex.worker.communications.v1+json": { "schema": { "$ref": "#/components/schemas/CommunicationResource1" }, "examples": { "communicationsVMT": { "$ref": "#/components/examples/JSON_WORKER_EXAMPLES/value/WORKER_COMMUNICATIONS_GET" } } }, "application/json": { "schema": { "$ref": "#/components/schemas/CommunicationResource1" }, "examples": { "communicationsDefault": { "$ref": "#/components/examples/JSON_WORKER_EXAMPLES/value/WORKER_COMMUNICATIONS_GET" } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-102", "description": "The client could not be authenticated due to missing or invalid client credentials.", "resolution": "Make sure that you are using the correct API key/Secret and that your application is enabled." } ] } } } }, "403": { "description": "User doesn't have access to this endpoint (API-2), Client has been end dated (API-68)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-2", "description": "Your application is not authorized to access the resource.", "resolution": "Please have your company administrator give your application access to the resource." } ] } } } }, "404": { "description": "Invalid resource ID (API-7)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-7", "description": "The resource or status is invalid. You may have an incorrect resource ID.", "resolution": "Send a valid resource in your request" } ] } } } }, "405": { "description": "Unsupported method type (API-59)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-59", "description": "The request method type is unsupported." } ] } } } }, "406": { "description": "Unsupported Accept header", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-75", "description": "Invalid vendor media type.", "resolution": "Please refer to our documentation and send the correct vendor media type" } ] } } } }, "500": { "description": "Internal Server Error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-1", "description": "Internal Server Error.", "resolution": "Please contact Paychex API Developer Center Support." } ] } } } } } }, "post": { "tags": [ "Worker" ], "summary": "Worker Communication", "description": "Add a single communication to the \"Active\" or \"In-progress\" worker.", "operationId": "createWorkerCommunication", "parameters": [ { "name": "workerId", "in": "path", "description": "The id assigned to the worker that workers are being requested for.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/vnd.paychex.worker.communication.v1+json": { "schema": { "$ref": "#/components/schemas/CommunicationResource1" }, "examples": { "communication4": { "$ref": "#/components/examples/JSON_WORKER_EXAMPLES/value/WORKER_COMMUNICATION_POST" } } }, "application/json": { "schema": { "$ref": "#/components/schemas/CommunicationResource1" }, "examples": { "communication5": { "$ref": "#/components/examples/JSON_WORKER_EXAMPLES/value/WORKER_COMMUNICATION_POST" } } } }, "required": true }, "responses": { "201": { "description": "successful operation", "content": { "application/vnd.paychex.worker.communication.v1+json": { "schema": { "$ref": "#/components/schemas/CommunicationResource1" }, "examples": { "communication3": { "$ref": "#/components/examples/JSON_WORKER_EXAMPLES/value/WORKER_COMMUNICATION_POST_RESPONSE" } } }, "application/json": { "schema": { "$ref": "#/components/schemas/CommunicationResource1" }, "examples": { "communication4": { "$ref": "#/components/examples/JSON_WORKER_EXAMPLES/value/WORKER_COMMUNICATION_POST_RESPONSE" } } } } }, "400": { "description": "Invalid request (API-4), Invalid phone number (API-14), Invalid street address (API-15), Invalid worker status date (API-20), Can not create duplicate entry (API-26),The request cannot be performed since the worker is in a state which does not allow this action (API-19)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-40", "description": "The request isn't valid.", "resolution": "Please send the valid request" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-102", "description": "The client could not be authenticated due to missing or invalid client credentials.", "resolution": "Make sure that you are using the correct API key/Secret and that your application is enabled." } ] } } } }, "403": { "description": "User doesn't have access to this endpoint (API-2), Client has been end dated (API-68)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-2", "description": "Your application is not authorized to access the resource.", "resolution": "Please have your company administrator give your application access to the resource." } ] } } } }, "404": { "description": "Invalid resource ID (API-7)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-7", "description": "The resource or status is invalid. You may have an incorrect resource ID.", "resolution": "Send a valid resource in your request" } ] } } } }, "405": { "description": "Unsupported method type (API-59)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-59", "description": "The request method type is unsupported." } ] } } } }, "406": { "description": "Unsupported Accept header", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-75", "description": "Invalid vendor media type.", "resolution": "Please refer to our documentation and send the correct vendor media type" } ] } } } }, "423": { "description": "Client locked (API-10)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-10", "description": "The client is locked because another user or process is updating it. Your changes cannot be saved while the client is locked.", "resolution": "Please try again later." } ] } } } }, "500": { "description": "Internal Server Error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-1", "description": "Internal Server Error.", "resolution": "Please contact Paychex API Developer Center Support." } ] } } } } } } }, "/workers/{workerId}/communications/{communicationId}": { "get": { "tags": [ "Worker" ], "summary": "Worker Communication", "description": "A \"Active\" or \"In-progress\" workers single communication item.", "operationId": "getWorkerCommunicationsById", "parameters": [ { "name": "workerId", "in": "path", "description": "The id assigned to the worker that workers are being requested for.", "required": true, "schema": { "type": "string" } }, { "name": "communicationId", "in": "path", "description": "The id of a single workers communication.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/vnd.paychex.worker.communication.v1+json": { "schema": { "$ref": "#/components/schemas/CommunicationResource1" }, "examples": { "communicationVMT": { "$ref": "#/components/examples/JSON_WORKER_EXAMPLES/value/WORKER_COMMUNICATION_GET" } } }, "application/json": { "schema": { "$ref": "#/components/schemas/CommunicationResource1" }, "examples": { "communicationDefault": { "$ref": "#/components/examples/JSON_WORKER_EXAMPLES/value/WORKER_COMMUNICATION_GET" } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-102", "description": "The client could not be authenticated due to missing or invalid client credentials.", "resolution": "Make sure that you are using the correct API key/Secret and that your application is enabled." } ] } } } }, "403": { "description": "User doesn't have access to this endpoint (API-2), Client has been end dated (API-68)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-2", "description": "Your application is not authorized to access the resource.", "resolution": "Please have your company administrator give your application access to the resource." } ] } } } }, "404": { "description": "Invalid resource ID (API-7)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-7", "description": "The resource or status is invalid. You may have an incorrect resource ID.", "resolution": "Send a valid resource in your request" } ] } } } }, "405": { "description": "Unsupported method type (API-59)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-59", "description": "The request method type is unsupported." } ] } } } }, "406": { "description": "Unsupported Accept header", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-75", "description": "Invalid vendor media type.", "resolution": "Please refer to our documentation and send the correct vendor media type" } ] } } } }, "500": { "description": "Internal Server Error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-1", "description": "Internal Server Error.", "resolution": "Please contact Paychex API Developer Center Support." } ] } } } } } }, "delete": { "tags": [ "Worker" ], "summary": "Worker Communication", "description": "Remove a communication item from an \"Active\" or \"In-Progress\" worker. A communication type of \"STREET_ADDRESS\" or \"PO_BOX_ADDRESS\" cannot be removed from the worker.", "operationId": "deleteWorkerCommunication", "parameters": [ { "name": "workerId", "in": "path", "description": "The id assigned to the worker that workers are being requested for.", "required": true, "schema": { "type": "string" } }, { "name": "communicationId", "in": "path", "description": "The id of a single workers communication.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/vnd.paychex.worker.communications.v1+json": { "schema": { "$ref": "#/components/schemas/CommunicationResource1" }, "examples": { "communication6": { "$ref": "#/components/examples/JSON_WORKER_EXAMPLES/value/WORKER_COMMUNICATION_GET" } } }, "application/json": { "schema": { "$ref": "#/components/schemas/CommunicationResource1" }, "examples": { "communication7": { "$ref": "#/components/examples/JSON_WORKER_EXAMPLES/value/WORKER_COMMUNICATION_GET" } } } } }, "400": { "description": "Invalid request (API-4), The communication can not be deleted (API-25),The request cannot be performed since the worker is in a state which does not allow this action(API-19)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-40", "description": "The request isn't valid.", "resolution": "Please send the valid request" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-102", "description": "The client could not be authenticated due to missing or invalid client credentials.", "resolution": "Make sure that you are using the correct API key/Secret and that your application is enabled." } ] } } } }, "403": { "description": "User doesn't have access to this endpoint (API-2), Client has been end dated (API-68)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-2", "description": "Your application is not authorized to access the resource.", "resolution": "Please have your company administrator give your application access to the resource." } ] } } } }, "404": { "description": "Invalid resource ID (API-7)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-7", "description": "The resource or status is invalid. You may have an incorrect resource ID.", "resolution": "Send a valid resource in your request" } ] } } } }, "405": { "description": "Unsupported method type (API-59)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-59", "description": "The request method type is unsupported." } ] } } } }, "406": { "description": "Unsupported Accept header", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-75", "description": "Invalid vendor media type.", "resolution": "Please refer to our documentation and send the correct vendor media type" } ] } } } }, "423": { "description": "Client locked (API-10)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-10", "description": "The client is locked because another user or process is updating it. Your changes cannot be saved while the client is locked.", "resolution": "Please try again later." } ] } } } }, "500": { "description": "Internal Server Error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-1", "description": "Internal Server Error.", "resolution": "Please contact Paychex API Developer Center Support." } ] } } } } } }, "patch": { "tags": [ "Worker" ], "summary": "Worker Communication", "description": "Update a \"Active\" or \"In-progress\" workers specific communication item.", "operationId": "updateWorkerCommunication", "parameters": [ { "name": "workerId", "in": "path", "description": "The id assigned to the worker that workers are being requested for.", "required": true, "schema": { "type": "string" } }, { "name": "communicationId", "in": "path", "description": "The id of a single workers communication.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/vnd.paychex.worker.communication.v1+json": { "schema": { "$ref": "#/components/schemas/CommunicationResource1" }, "examples": { "communication1": { "$ref": "#/components/examples/JSON_WORKER_EXAMPLES/value/WORKER_COMMUNICATION_PATCH" } } }, "application/json": { "schema": { "$ref": "#/components/schemas/CommunicationResource1" }, "examples": { "communication2": { "$ref": "#/components/examples/JSON_WORKER_EXAMPLES/value/WORKER_COMMUNICATION_PATCH" } } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "application/vnd.paychex.worker.communication.v1+json": { "schema": { "$ref": "#/components/schemas/CommunicationResource1" }, "examples": { "communicationRes": { "$ref": "#/components/examples/JSON_WORKER_EXAMPLES/value/WORKER_COMMUNICATION_PATCH_RESPONSE" } } }, "application/json": { "schema": { "$ref": "#/components/schemas/CommunicationResource1" }, "examples": { "communicationDefaultRes": { "$ref": "#/components/examples/JSON_WORKER_EXAMPLES/value/WORKER_COMMUNICATION_PATCH_RESPONSE" } } } } }, "400": { "description": "Invalid request (API-4), Invalid phone number (API-14), Invalid street address (API-15), Invalid worker status date (API-20),The request cannot be performed since the worker is in a state which does not allow this action(API-19)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-40", "description": "The request isn't valid.", "resolution": "Please send the valid request" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-102", "description": "The client could not be authenticated due to missing or invalid client credentials.", "resolution": "Make sure that you are using the correct API key/Secret and that your application is enabled." } ] } } } }, "403": { "description": "User doesn't have access to this endpoint (API-2), Client has been end dated (API-68)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-2", "description": "Your application is not authorized to access the resource.", "resolution": "Please have your company administrator give your application access to the resource." } ] } } } }, "404": { "description": "Invalid resource ID (API-7)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-7", "description": "The resource or status is invalid. You may have an incorrect resource ID.", "resolution": "Send a valid resource in your request" } ] } } } }, "405": { "description": "Unsupported method type (API-59)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-59", "description": "The request method type is unsupported." } ] } } } }, "406": { "description": "Unsupported Accept header", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-75", "description": "Invalid vendor media type.", "resolution": "Please refer to our documentation and send the correct vendor media type" } ] } } } }, "423": { "description": "Client locked (API-10)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-10", "description": "The client is locked because another user or process is updating it. Your changes cannot be saved while the client is locked.", "resolution": "Please try again later." } ] } } } }, "500": { "description": "Internal Server Error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-1", "description": "Internal Server Error.", "resolution": "Please contact Paychex API Developer Center Support." } ] } } } } } } }, "/workers/{workerId}/compensation": { "get": { "tags": [ "Worker" ], "summary": "Worker Compensation", "description": "Information about a workers compensation.", "operationId": "getWorkerCompensationStandardRates_1", "parameters": [ { "name": "workerId", "in": "path", "description": "ID associated with desired worker.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/vnd.paychex.payroll.compensation.v1+json": { "schema": { "$ref": "#/components/schemas/CollectionResource" }, "examples": { "COMPENSATIONSDEFAULT": { "$ref": "#/components/examples/JSON_WORKER_EXAMPLES/value/WORKER_COMPENSATIONS_DEFAULT_VMT_GET" } } }, "application/vnd.paychex.payroll.compensation.standards_rates.v1+json": { "schema": { "$ref": "#/components/schemas/PayRatesStandardResource" }, "examples": { "PayRatesStandard": { "$ref": "#/components/examples/JSON_WORKER_EXAMPLES/value/WORKER_COMPENSATIONS_STANDARD_RATES_VMT_GET" } } }, "application/json": { "schema": { "$ref": "#/components/schemas/CollectionResource" }, "examples": { "defaultVMT": { "$ref": "#/components/examples/JSON_WORKER_EXAMPLES/value/WORKER_COMPENSATIONS_DEFAULT_VMT_GET" } } } } }, "400": { "description": "The request cannot be performed since the worker is in a state which does not allow this action(API-19)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-40", "description": "The request isn't valid.", "resolution": "Please send the valid request" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-102", "description": "The client could not be authenticated due to missing or invalid client credentials.", "resolution": "Make sure that you are using the correct API key/Secret and that your application is enabled." } ] } } } }, "403": { "description": "User doesn't have access to this endpoint (API-2), Client has been end dated (API-68)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-2", "description": "Your application is not authorized to access the resource.", "resolution": "Please have your company administrator give your application access to the resource." } ] } } } }, "404": { "description": "Invalid resource ID (API-7)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-7", "description": "The resource or status is invalid. You may have an incorrect resource ID.", "resolution": "Send a valid resource in your request" } ] } } } }, "405": { "description": "Unsupported method type (API-59)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-59", "description": "The request method type is unsupported." } ] } } } }, "406": { "description": "Unsupported Accept header", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-75", "description": "Invalid vendor media type.", "resolution": "Please refer to our documentation and send the correct vendor media type" } ] } } } }, "500": { "description": "Internal Server Error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-1", "description": "Internal Server Error.", "resolution": "Please contact Paychex API Developer Center Support." } ] } } } } } } }, "/workers/{workerId}/compensation/payrates": { "get": { "tags": [ "Worker" ], "summary": "Worker Pay Rates", "description": "Information about a workers compensation rates. A worker can have up to 25 different rates.It’s not required for a worker to have a rate in the system.", "operationId": "getWorkerPayRates", "parameters": [ { "name": "workerId", "in": "path", "description": "ID associated with desired worker.", "required": true, "schema": { "type": "string" } }, { "name": "asof", "in": "query", "description": "Returns all pay rates as of the date used in the request", "required": false, "schema": { "type": "string" }, "example": "2020-01-04T00:00:00Z" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/vnd.paychex.payroll.compensation.payrates.v1+json": { "schema": { "$ref": "#/components/schemas/PayRateResource" }, "examples": { "payaratesVMT": { "$ref": "#/components/examples/JSON_WORKER_EXAMPLES/value/WORKER_COMPENSATION_PAYRATES_GET" } } }, "application/json": { "schema": { "$ref": "#/components/schemas/PayRateResource" }, "examples": { "payaratesDef": { "$ref": "#/components/examples/JSON_WORKER_EXAMPLES/value/WORKER_COMPENSATION_PAYRATES_GET" } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-102", "description": "The client could not be authenticated due to missing or invalid client credentials.", "resolution": "Make sure that you are using the correct API key/Secret and that your application is enabled." } ] } } } }, "403": { "description": "User doesn't have access to this endpoint (API-2), Client has been end dated (API-68)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-2", "description": "Your application is not authorized to access the resource.", "resolution": "Please have your company administrator give your application access to the resource." } ] } } } }, "404": { "description": "Invalid resource ID (API-7)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-7", "description": "The resource or status is invalid. You may have an incorrect resource ID.", "resolution": "Send a valid resource in your request" } ] } } } }, "405": { "description": "Unsupported method type (API-59)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-59", "description": "The request method type is unsupported." } ] } } } }, "406": { "description": "Unsupported Accept header", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-75", "description": "Invalid vendor media type.", "resolution": "Please refer to our documentation and send the correct vendor media type" } ] } } } }, "500": { "description": "Internal Server Error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-1", "description": "Internal Server Error.", "resolution": "Please contact Paychex API Developer Center Support." } ] } } } } } }, "post": { "tags": [ "Worker" ], "summary": "Worker Pay Rate", "description": "Add a single compensation rate to the \"Active\" or \"In-progress\" worker.", "operationId": "createWorkerPayRate", "parameters": [ { "name": "workerId", "in": "path", "description": "ID associated with desired worker.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/vnd.paychex.payroll.compensation.payrate.v1+json": { "schema": { "$ref": "#/components/schemas/PayRateResource" }, "examples": { "postPayarateResVMT": { "$ref": "#/components/examples/JSON_WORKER_EXAMPLES/value/WORKER_COMPENSATION_PAYRATE_POST_PATCH" } } }, "application/json": { "schema": { "$ref": "#/components/schemas/PayRateResource" }, "examples": { "postPayarateResDef": { "$ref": "#/components/examples/JSON_WORKER_EXAMPLES/value/WORKER_COMPENSATION_PAYRATE_POST_PATCH" } } } }, "required": true }, "responses": { "200": { "description": "Successful operation", "content": { "application/vnd.paychex.payroll.compensation.payrate.v1+json": { "schema": { "$ref": "#/components/schemas/PayRateResource" }, "examples": { "payarateReqDef": { "$ref": "#/components/examples/JSON_WORKER_EXAMPLES/value/WORKER_COMPENSATION_PAYRATE_GET" } } }, "application/json": { "schema": { "$ref": "#/components/schemas/PayRateResource" }, "examples": { "payarateReqDef": { "$ref": "#/components/examples/JSON_WORKER_EXAMPLES/value/WORKER_COMPENSATION_PAYRATE_GET" } } } } }, "400": { "description": "Invalid request (API-4), Field too long (API-6), Invalid field (API-17), The request cannot be performed since the worker is in a state which does not allow this action(API-19),Invalid value (API-24), Can not create duplicate entry (API-26), Invalid rate type (API-27), Required field missing (API-46), Invalid amount (API-28)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-40", "description": "The request isn't valid.", "resolution": "Please send the valid request" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-102", "description": "The client could not be authenticated due to missing or invalid client credentials.", "resolution": "Make sure that you are using the correct API key/Secret and that your application is enabled." } ] } } } }, "403": { "description": "User doesn't have access to this endpoint (API-2), Client has been end dated (API-68)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-2", "description": "Your application is not authorized to access the resource.", "resolution": "Please have your company administrator give your application access to the resource." } ] } } } }, "404": { "description": "Invalid resource ID (API-7)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-7", "description": "The resource or status is invalid. You may have an incorrect resource ID.", "resolution": "Send a valid resource in your request" } ] } } } }, "405": { "description": "Unsupported method type (API-59)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-59", "description": "The request method type is unsupported." } ] } } } }, "406": { "description": "Unsupported Accept header", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-75", "description": "Invalid vendor media type.", "resolution": "Please refer to our documentation and send the correct vendor media type" } ] } } } }, "415": { "description": "Missing value (API-22)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-22", "description": "Invalid required value", "resolution": "Please provide the valid value." } ] } } } }, "423": { "description": "Client locked (API-10)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-10", "description": "The client is locked because another user or process is updating it. Your changes cannot be saved while the client is locked.", "resolution": "Please try again later." } ] } } } }, "500": { "description": "Internal Server Error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-1", "description": "Internal Server Error.", "resolution": "Please contact Paychex API Developer Center Support." } ] } } } } } } }, "/workers/{workerId}/compensation/payrates/{rateId}": { "get": { "tags": [ "Worker" ], "summary": "Worker Pay Rate", "description": "A workers single compensation rate.", "operationId": "getWorkerPayRatesById", "parameters": [ { "name": "workerId", "in": "path", "description": "ID associated with desired worker.", "required": true, "schema": { "type": "string" } }, { "name": "rateId", "in": "path", "description": "The id of a single workers compensation rate.", "required": true, "schema": { "type": "string" } }, { "name": "asof", "in": "query", "description": "Returns compensation as of the date used in the request", "required": false, "schema": { "type": "string" }, "example": "2020-01-04T00:00:00Z" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/vnd.paychex.payroll.compensation.payrate.v1+json": { "schema": { "$ref": "#/components/schemas/PayRateResource" }, "examples": { "payarateVMT": { "$ref": "#/components/examples/JSON_WORKER_EXAMPLES/value/WORKER_COMPENSATION_PAYRATE_GET" } } }, "application/json": { "schema": { "$ref": "#/components/schemas/PayRateResource" }, "examples": { "payarateDef": { "$ref": "#/components/examples/JSON_WORKER_EXAMPLES/value/WORKER_COMPENSATION_PAYRATE_GET" } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-102", "description": "The client could not be authenticated due to missing or invalid client credentials.", "resolution": "Make sure that you are using the correct API key/Secret and that your application is enabled." } ] } } } }, "403": { "description": "User doesn't have access to this endpoint (API-2), Client has been end dated (API-68)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-2", "description": "Your application is not authorized to access the resource.", "resolution": "Please have your company administrator give your application access to the resource." } ] } } } }, "404": { "description": "Invalid resource ID (API-7)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-7", "description": "The resource or status is invalid. You may have an incorrect resource ID.", "resolution": "Send a valid resource in your request" } ] } } } }, "405": { "description": "Unsupported method type (API-59)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-59", "description": "The request method type is unsupported." } ] } } } }, "406": { "description": "Unsupported Accept header", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-75", "description": "Invalid vendor media type.", "resolution": "Please refer to our documentation and send the correct vendor media type" } ] } } } }, "500": { "description": "Internal Server Error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-1", "description": "Internal Server Error.", "resolution": "Please contact Paychex API Developer Center Support." } ] } } } } } }, "delete": { "tags": [ "Worker" ], "summary": "Worker Pay Rate", "description": "Remove a compensation rate from a worker.", "operationId": "deleteWorkerPayRate", "parameters": [ { "name": "workerId", "in": "path", "description": "ID associated with desired worker.", "required": true, "schema": { "type": "string" } }, { "name": "rateId", "in": "path", "description": "The id of a single workers compensation rate.", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "successfully deleted" }, "400": { "description": "The request cannot be performed since the worker is in a state which does not allow this action(API-19)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-40", "description": "The request isn't valid.", "resolution": "Please send the valid request" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-102", "description": "The client could not be authenticated due to missing or invalid client credentials.", "resolution": "Make sure that you are using the correct API key/Secret and that your application is enabled." } ] } } } }, "403": { "description": "User doesn't have access to this endpoint (API-2), Client has been end dated (API-68)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-2", "description": "Your application is not authorized to access the resource.", "resolution": "Please have your company administrator give your application access to the resource." } ] } } } }, "404": { "description": "Invalid resource ID (API-7)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-7", "description": "The resource or status is invalid. You may have an incorrect resource ID.", "resolution": "Send a valid resource in your request" } ] } } } }, "405": { "description": "Unsupported method type (API-59)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-59", "description": "The request method type is unsupported." } ] } } } }, "406": { "description": "Unsupported Accept header", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-75", "description": "Invalid vendor media type.", "resolution": "Please refer to our documentation and send the correct vendor media type" } ] } } } }, "423": { "description": "Client locked (API-10)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-10", "description": "The client is locked because another user or process is updating it. Your changes cannot be saved while the client is locked.", "resolution": "Please try again later." } ] } } } }, "500": { "description": "Internal Server Error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-1", "description": "Internal Server Error.", "resolution": "Please contact Paychex API Developer Center Support." } ] } } } } } }, "patch": { "tags": [ "Worker" ], "summary": "Worker Pay Rate", "description": "Update a workers specific compensation rate.", "operationId": "updateWorkerPayRate", "parameters": [ { "name": "workerId", "in": "path", "description": "ID associated with desired worker.", "required": true, "schema": { "type": "string" } }, { "name": "rateId", "in": "path", "description": "The id of a single workers compensation rate.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/vnd.paychex.payroll.compensation.payrate.v1+json": { "schema": { "$ref": "#/components/schemas/PayRateResource" }, "examples": { "updatePayarateReqVMT": { "$ref": "#/components/examples/JSON_WORKER_EXAMPLES/value/WORKER_COMPENSATION_PAYRATE_POST_PATCH" } } }, "application/json": { "schema": { "$ref": "#/components/schemas/PayRateResource" }, "examples": { "updatePayarateReqDef": { "$ref": "#/components/examples/JSON_WORKER_EXAMPLES/value/WORKER_COMPENSATION_PAYRATE_POST_PATCH" } } } }, "required": true }, "responses": { "200": { "description": "Successful operation", "content": { "application/vnd.paychex.payroll.compensation.payrate.v1+json": { "schema": { "$ref": "#/components/schemas/PayRateResource" }, "examples": { "updatePayarateVMT": { "$ref": "#/components/examples/JSON_WORKER_EXAMPLES/value/WORKER_COMPENSATION_PAYRATE_GET" } } }, "application/json": { "schema": { "$ref": "#/components/schemas/PayRateResource" }, "examples": { "updatePayarateDef": { "$ref": "#/components/examples/JSON_WORKER_EXAMPLES/value/WORKER_COMPENSATION_PAYRATE_GET" } } } } }, "400": { "description": "Invalid request (API-4), Field too long (API-6), Invalid field (API-17), Invalid value (API-24), Invalid rate type (API-27), Invalid amount (API-28),Required field missing (API-46), The request cannot be performed since the worker is in a state which does not allow this action (API-19)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-40", "description": "The request isn't valid.", "resolution": "Please send the valid request" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-102", "description": "The client could not be authenticated due to missing or invalid client credentials.", "resolution": "Make sure that you are using the correct API key/Secret and that your application is enabled." } ] } } } }, "403": { "description": "User doesn't have access to this endpoint (API-2), Client has been end dated (API-68)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-2", "description": "Your application is not authorized to access the resource.", "resolution": "Please have your company administrator give your application access to the resource." } ] } } } }, "404": { "description": "Invalid resource ID (API-7)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-7", "description": "The resource or status is invalid. You may have an incorrect resource ID.", "resolution": "Send a valid resource in your request" } ] } } } }, "405": { "description": "Unsupported method type (API-59)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-59", "description": "The request method type is unsupported." } ] } } } }, "406": { "description": "Unsupported Accept header", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-75", "description": "Invalid vendor media type.", "resolution": "Please refer to our documentation and send the correct vendor media type" } ] } } } }, "415": { "description": "Missing value (API-22)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-22", "description": "Invalid required value", "resolution": "Please provide the valid value." } ] } } } }, "423": { "description": "Client locked (API-10)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-10", "description": "The client is locked because another user or process is updating it. Your changes cannot be saved while the client is locked.", "resolution": "Please try again later." } ] } } } }, "500": { "description": "Internal Server Error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-1", "description": "Internal Server Error.", "resolution": "Please contact Paychex API Developer Center Support." } ] } } } } } } }, "/workers/{workerId}/compensation/paystandards": { "get": { "tags": [ "Worker" ], "summary": "Worker Pay Standards", "description": "Information about a workers compensation pay standards.", "operationId": "getWorkerPayStandards", "parameters": [ { "name": "workerId", "in": "path", "description": "ID associated with desired worker.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/vnd.paychex.payroll.compensation.paystandards.v1+json": { "schema": { "$ref": "#/components/schemas/PayStandardResource" }, "examples": { "payStandardsVMT": { "$ref": "#/components/examples/JSON_WORKER_EXAMPLES/value/WORKER_COMPENSATION_PAYSTANDARDS_GET" } } }, "application/json": { "schema": { "$ref": "#/components/schemas/PayStandardResource" }, "examples": { "payStandardsDef": { "$ref": "#/components/examples/JSON_WORKER_EXAMPLES/value/WORKER_COMPENSATION_PAYSTANDARDS_GET" } } } } }, "400": { "description": "The request cannot be performed since the worker is in a state which does not allow this action(API-19)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-40", "description": "The request isn't valid.", "resolution": "Please send the valid request" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-102", "description": "The client could not be authenticated due to missing or invalid client credentials.", "resolution": "Make sure that you are using the correct API key/Secret and that your application is enabled." } ] } } } }, "403": { "description": "User doesn't have access to this endpoint (API-2), Client has been end dated (API-68)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-2", "description": "Your application is not authorized to access the resource.", "resolution": "Please have your company administrator give your application access to the resource." } ] } } } }, "404": { "description": "Invalid resource ID (API-7)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-7", "description": "The resource or status is invalid. You may have an incorrect resource ID.", "resolution": "Send a valid resource in your request" } ] } } } }, "405": { "description": "Unsupported method type (API-59)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-59", "description": "The request method type is unsupported." } ] } } } }, "406": { "description": "Unsupported Accept header", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-75", "description": "Invalid vendor media type.", "resolution": "Please refer to our documentation and send the correct vendor media type" } ] } } } }, "500": { "description": "Internal Server Error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-1", "description": "Internal Server Error.", "resolution": "Please contact Paychex API Developer Center Support." } ] } } } } } } }, "/workers/{workerId}/contacts": { "get": { "tags": [ "Worker" ], "summary": "Worker Contacts", "description": "Get all contacts for the specified worker.", "operationId": "getWorkerContacts", "parameters": [ { "name": "workerId", "in": "path", "description": "ID associated with desired worker.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful operation.", "content": { "application/vnd.paychex.worker.contacts.v1+json": { "schema": { "$ref": "#/components/schemas/WorkerContactResource" }, "examples": { "workerContactsResVMT": { "$ref": "#/components/examples/JSON_WORKER_EXAMPLES/value/WORKER_CONTACTS_GET" } } }, "application/json": { "schema": { "$ref": "#/components/schemas/WorkerContactResource" }, "examples": { "workerContactsResDef": { "$ref": "#/components/examples/JSON_WORKER_EXAMPLES/value/WORKER_CONTACTS_GET" } } } } }, "400": { "description": "Invalid worker status (API-19)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-19", "description": "The request cannot be performed since the worker is in a state which does not allow this action.", "resolution": "Please see documentation." } ] } } } }, "401": { "description": "Unauthorized (API-102)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-102", "description": "The client could not be authenticated due to missing or invalid client credentials.", "resolution": "Make sure that you are using the correct API key/Secret and that your application is enabled." } ] } } } }, "403": { "description": "User doesn't have access to this endpoint (API-2), Client has been end dated (API-68)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-2", "description": "Your application is not authorized to access the resource.", "resolution": "Please have your company administrator give your application access to the resource." } ] } } } }, "404": { "description": "Invalid resource ID (API-7)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-7", "description": "The resource or status is invalid. You may have an incorrect resource ID.", "resolution": "Send a valid resource in your request" } ] } } } }, "405": { "description": "Unsupported method type (API-59)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-59", "description": "The request method type is unsupported." } ] } } } }, "406": { "description": "Unsupported Accept header", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-75", "description": "Invalid vendor media type.", "resolution": "Please refer to our documentation and send the correct vendor media type" } ] } } } }, "500": { "description": "Internal Server Error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-1", "description": "Internal Server Error.", "resolution": "Please contact Paychex API Developer Center Support." } ] } } } } } }, "post": { "tags": [ "Worker" ], "summary": "Worker Contacts", "description": "Add one or more contacts to a worker. A contact may represent a person or entity (organization) but not both. A contact must have at least one communication (telecom, postal, or email). Person contacts can have multiple communications for each communication type (telecom, postal, or email) to support BUSINESS and PERSONAL. Exactly one contact must be marked as primary for each contact type. If one or more contacts are posted for the same contact type, and there are currently no contacts of that type for the worker, the first contact in the list will be made primary unless another in the list is expressly marked as primary. When a new contact is made primary the previous primary contact will be marked as not primary. Use the GET /companies/{companyId}/contacttypes endpoint to get a full list of available contact types and relationship types (used for person contacts).", "operationId": "addWorkerContacts", "parameters": [ { "name": "workerId", "in": "path", "description": "ID associated with desired worker.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/vnd.paychex.worker.contacts.v1+json": { "schema": { "$ref": "#/components/schemas/WorkerContactResource" }, "examples": { "workerContactsResVMT": { "$ref": "#/components/examples/JSON_WORKER_EXAMPLES/value/WORKER_CONTACTS_POST_REQUEST" } } }, "application/json": { "schema": { "$ref": "#/components/schemas/WorkerContactResource" }, "examples": { "workerContactsResDef": { "$ref": "#/components/examples/JSON_WORKER_EXAMPLES/value/WORKER_CONTACTS_POST_REQUEST" } } } }, "required": true }, "responses": { "201": { "description": "Successful operation.", "content": { "application/vnd.paychex.worker.contacts.v1+json": { "schema": { "$ref": "#/components/schemas/WorkerContactResource" }, "examples": { "workerContactsResVMT": { "$ref": "#/components/examples/JSON_WORKER_EXAMPLES/value/WORKER_CONTACTS_POST_RESPONSE" } } }, "application/json": { "schema": { "$ref": "#/components/schemas/WorkerContactResource" }, "examples": { "workerContactsResDef": { "$ref": "#/components/examples/JSON_WORKER_EXAMPLES/value/WORKER_CONTACTS_POST_RESPONSE" } } } } }, "400": { "description": "The request is invalid (API-4), Invalid email address (API-13), Invalid phone number (API-14), Invalid street address (API-15), Invalid worker status (API-19), Duplicate entry (API-26), Required field missing (API-46), Required field invalid (API-48)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-40", "description": "The request isn't valid.", "resolution": "Please send the valid request" } ] } } } }, "401": { "description": "Unauthorized (API-102)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-102", "description": "The client could not be authenticated due to missing or invalid client credentials.", "resolution": "Make sure that you are using the correct API key/Secret and that your application is enabled." } ] } } } }, "403": { "description": "User doesn't have access to this endpoint (API-2), Client has been end dated (API-68)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-2", "description": "Your application is not authorized to access the resource.", "resolution": "Please have your company administrator give your application access to the resource." } ] } } } }, "404": { "description": "Invalid resource ID (API-7)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-7", "description": "The resource or status is invalid. You may have an incorrect resource ID.", "resolution": "Send a valid resource in your request" } ] } } } }, "405": { "description": "Unsupported method type (API-59)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-59", "description": "The request method type is unsupported." } ] } } } }, "406": { "description": "Unsupported Accept header", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-75", "description": "Invalid vendor media type.", "resolution": "Please refer to our documentation and send the correct vendor media type" } ] } } } }, "500": { "description": "Internal Server Error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-1", "description": "Internal Server Error.", "resolution": "Please contact Paychex API Developer Center Support." } ] } } } } } } }, "/workers/{workerId}/contacts/{contactId}": { "get": { "tags": [ "Worker" ], "summary": "Worker Contact", "description": "Get a worker contact by contactId.", "operationId": "getWorkerContactsByContactId", "parameters": [ { "name": "workerId", "in": "path", "description": "ID associated with desired worker.", "required": true, "schema": { "type": "string" } }, { "name": "contactId", "in": "path", "description": "The id of a single Contact.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful operation.", "content": { "application/vnd.paychex.worker.contact.v1+json": { "schema": { "$ref": "#/components/schemas/WorkerContactResource" }, "examples": { "workerContactsResVMT": { "$ref": "#/components/examples/JSON_WORKER_EXAMPLES/value/WORKER_CONTACT_GET" } } }, "application/json": { "schema": { "$ref": "#/components/schemas/WorkerContactResource" }, "examples": { "workerContactsResDef": { "$ref": "#/components/examples/JSON_WORKER_EXAMPLES/value/WORKER_CONTACT_GET" } } } } }, "400": { "description": "Invalid worker status (API-19)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-19", "description": "The request cannot be performed since the worker is in a state which does not allow this action.", "resolution": "Please see documentation." } ] } } } }, "401": { "description": "Unauthorized (API-102)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-102", "description": "The client could not be authenticated due to missing or invalid client credentials.", "resolution": "Make sure that you are using the correct API key/Secret and that your application is enabled." } ] } } } }, "403": { "description": "User doesn't have access to this endpoint (API-2), Client has been end dated (API-68)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-2", "description": "Your application is not authorized to access the resource.", "resolution": "Please have your company administrator give your application access to the resource." } ] } } } }, "404": { "description": "Invalid resource ID (API-7)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-7", "description": "The resource or status is invalid. You may have an incorrect resource ID.", "resolution": "Send a valid resource in your request" } ] } } } }, "405": { "description": "Unsupported method type (API-59)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-59", "description": "The request method type is unsupported." } ] } } } }, "406": { "description": "Unsupported Accept header", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-75", "description": "Invalid vendor media type.", "resolution": "Please refer to our documentation and send the correct vendor media type" } ] } } } }, "500": { "description": "Internal Server Error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-1", "description": "Internal Server Error.", "resolution": "Please contact Paychex API Developer Center Support." } ] } } } } } }, "delete": { "tags": [ "Worker" ], "summary": "Worker Contact", "description": "Delete a worker contact by contactId.", "operationId": "deleteWorkerContact", "parameters": [ { "name": "workerId", "in": "path", "description": "ID associated with desired worker.", "required": true, "schema": { "type": "string" } }, { "name": "contactId", "in": "path", "description": "ID associated with desired worker contact.", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Successful operation." }, "400": { "description": "The request cannot be performed since the worker is in a state which does not allow this action(API-19),Required field missing (API-46), Empty request entity (API-52), File type is not supported (API-62), The document name is invalid (API-63), Service unavailable (API-66)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-40", "description": "The request isn't valid.", "resolution": "Please send the valid request" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-102", "description": "The client could not be authenticated due to missing or invalid client credentials.", "resolution": "Make sure that you are using the correct API key/Secret and that your application is enabled." } ] } } } }, "403": { "description": "User doesn't have access to this endpoint (API-2), Client has been end dated (API-68)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-2", "description": "Your application is not authorized to access the resource.", "resolution": "Please have your company administrator give your application access to the resource." } ] } } } }, "404": { "description": "Invalid resource ID (API-7)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-7", "description": "The resource or status is invalid. You may have an incorrect resource ID.", "resolution": "Send a valid resource in your request" } ] } } } }, "405": { "description": "Unsupported method type (API-59)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-59", "description": "The request method type is unsupported." } ] } } } }, "406": { "description": "Unsupported Accept header", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-75", "description": "Invalid vendor media type.", "resolution": "Please refer to our documentation and send the correct vendor media type" } ] } } } }, "500": { "description": "Internal Server Error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-1", "description": "Internal Server Error.", "resolution": "Please contact Paychex API Developer Center Support." } ] } } } } } }, "patch": { "tags": [ "Worker" ], "summary": "Worker Contacts", "description": "Update a worker contact. A contact may represent a person or entity (organization) but not both. A contact must have at least one communication (telecom, postal, or email). Person contacts can have multiple communications for each communication type (telecom, postal, or email) to support BUSINESS and PERSONAL. Exactly one contact must be marked as primary for each contact type. When a new contact is made primary the previous primary contact will be marked as not primary. A postal contact can be switched from a street address to a PO box and vice versa. This is done by setting either streetLineOne or postOfficeBox (a postal communication may not have both). Use the GET /companies/{companyId}/contacttypes endpoint to get a full list of available contact types and relationship types (used for person contacts).", "operationId": "updateWorkerContact", "parameters": [ { "name": "workerId", "in": "path", "description": "ID associated with desired worker.", "required": true, "schema": { "type": "string" } }, { "name": "contactId", "in": "path", "description": "ID associated with desired worker contact.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/vnd.paychex.worker.contacts.v1+json": { "schema": { "$ref": "#/components/schemas/WorkerContactResource" }, "examples": { "workerContactPatchEntityNameVMT": { "$ref": "#/components/examples/JSON_WORKER_EXAMPLES/value/WORKER_CONTACTS_PATCH_ENTITY_NAME" }, "workerContactPatchEntityPhoneVMT": { "$ref": "#/components/examples/JSON_WORKER_EXAMPLES/value/WORKER_CONTACTS_PATCH_ENTITY_PHONE" }, "workerContactPatchEntityEmailVMT": { "$ref": "#/components/examples/JSON_WORKER_EXAMPLES/value/WORKER_CONTACTS_PATCH_ENTITY_EMAIL" }, "workerContactPatchEntityPostalVMT": { "$ref": "#/components/examples/JSON_WORKER_EXAMPLES/value/WORKER_CONTACTS_PATCH_ENTITY_POSTAL" }, "workerContactPatchPersonNameVMT": { "$ref": "#/components/examples/JSON_WORKER_EXAMPLES/value/WORKER_CONTACTS_PATCH_PERSON_NAME" }, "workerContactPatchPersonPhoneVMT": { "$ref": "#/components/examples/JSON_WORKER_EXAMPLES/value/WORKER_CONTACTS_PATCH_PERSON_PHONE" }, "workerContactPatchPersonEmailVMT": { "$ref": "#/components/examples/JSON_WORKER_EXAMPLES/value/WORKER_CONTACTS_PATCH_PERSON_EMAIL" }, "workerContactPatchPersonPostalVMT": { "$ref": "#/components/examples/JSON_WORKER_EXAMPLES/value/WORKER_CONTACTS_PATCH_PERSON_POSTAL" } } }, "application/json": { "schema": { "$ref": "#/components/schemas/WorkerContactResource" }, "examples": { "workerContactPatchEntityNameDef": { "$ref": "#/components/examples/JSON_WORKER_EXAMPLES/value/WORKER_CONTACTS_PATCH_ENTITY_NAME" }, "workerContactPatchEntityPhoneDef": { "$ref": "#/components/examples/JSON_WORKER_EXAMPLES/value/WORKER_CONTACTS_PATCH_ENTITY_PHONE" }, "workerContactPatchEntityEmailDef": { "$ref": "#/components/examples/JSON_WORKER_EXAMPLES/value/WORKER_CONTACTS_PATCH_ENTITY_EMAIL" }, "workerContactPatchEntityPostalDef": { "$ref": "#/components/examples/JSON_WORKER_EXAMPLES/value/WORKER_CONTACTS_PATCH_ENTITY_POSTAL" }, "workerContactPatchPersonNameDef": { "$ref": "#/components/examples/JSON_WORKER_EXAMPLES/value/WORKER_CONTACTS_PATCH_PERSON_NAME" }, "workerContactPatchPersonPhoneDef": { "$ref": "#/components/examples/JSON_WORKER_EXAMPLES/value/WORKER_CONTACTS_PATCH_PERSON_PHONE" }, "workerContactPatchPersonEmailDef": { "$ref": "#/components/examples/JSON_WORKER_EXAMPLES/value/WORKER_CONTACTS_PATCH_PERSON_EMAIL" }, "workerContactPatchPersonPostalDef": { "$ref": "#/components/examples/JSON_WORKER_EXAMPLES/value/WORKER_CONTACTS_PATCH_PERSON_POSTAL" } } } }, "required": true }, "responses": { "200": { "description": "Successful operation.", "content": { "application/vnd.paychex.worker.contacts.v1+json": { "schema": { "$ref": "#/components/schemas/WorkerContactResource" }, "examples": { "workerContactPatchEntityNameVMT": { "$ref": "#/components/examples/JSON_WORKER_EXAMPLES/value/WORKER_CONTACTS_PATCH_ENTITY_NAME" }, "workerContactPatchEntityPhoneVMT": { "$ref": "#/components/examples/JSON_WORKER_EXAMPLES/value/WORKER_CONTACTS_PATCH_ENTITY_PHONE" }, "workerContactPatchEntityEmailVMT": { "$ref": "#/components/examples/JSON_WORKER_EXAMPLES/value/WORKER_CONTACTS_PATCH_ENTITY_EMAIL" }, "workerContactPatchEntityPostalVMT": { "$ref": "#/components/examples/JSON_WORKER_EXAMPLES/value/WORKER_CONTACTS_PATCH_ENTITY_POSTAL" }, "workerContactPatchPersonNameVMT": { "$ref": "#/components/examples/JSON_WORKER_EXAMPLES/value/WORKER_CONTACTS_PATCH_PERSON_NAME" }, "workerContactPatchPersonPhoneVMT": { "$ref": "#/components/examples/JSON_WORKER_EXAMPLES/value/WORKER_CONTACTS_PATCH_PERSON_PHONE" }, "workerContactPatchPersonEmailVMT": { "$ref": "#/components/examples/JSON_WORKER_EXAMPLES/value/WORKER_CONTACTS_PATCH_PERSON_EMAIL" }, "workerContactPatchPersonPostalVMT": { "$ref": "#/components/examples/JSON_WORKER_EXAMPLES/value/WORKER_CONTACTS_PATCH_PERSON_POSTAL" } } }, "application/json": { "schema": { "$ref": "#/components/schemas/WorkerContactResource" }, "examples": { "workerContactPatchEntityNameDef": { "$ref": "#/components/examples/JSON_WORKER_EXAMPLES/value/WORKER_CONTACTS_PATCH_ENTITY_NAME" }, "workerContactPatchEntityPhoneDef": { "$ref": "#/components/examples/JSON_WORKER_EXAMPLES/value/WORKER_CONTACTS_PATCH_ENTITY_PHONE" }, "workerContactPatchEntityEmailDef": { "$ref": "#/components/examples/JSON_WORKER_EXAMPLES/value/WORKER_CONTACTS_PATCH_ENTITY_EMAIL" }, "workerContactPatchEntityPostalDef": { "$ref": "#/components/examples/JSON_WORKER_EXAMPLES/value/WORKER_CONTACTS_PATCH_ENTITY_POSTAL" }, "workerContactPatchPersonNameDef": { "$ref": "#/components/examples/JSON_WORKER_EXAMPLES/value/WORKER_CONTACTS_PATCH_PERSON_NAME" }, "workerContactPatchPersonPhoneDef": { "$ref": "#/components/examples/JSON_WORKER_EXAMPLES/value/WORKER_CONTACTS_PATCH_PERSON_PHONE" }, "workerContactPatchPersonEmailDef": { "$ref": "#/components/examples/JSON_WORKER_EXAMPLES/value/WORKER_CONTACTS_PATCH_PERSON_EMAIL" }, "workerContactPatchPersonPostalDef": { "$ref": "#/components/examples/JSON_WORKER_EXAMPLES/value/WORKER_CONTACTS_PATCH_PERSON_POSTAL" } } } } }, "400": { "description": "The request is invalid (API-4), Invalid resource ID (API-7), Invalid email address (API-13), Invalid phone number (API-14), Invalid street address (API-15), Invalid worker status (API-19), Invalid required value (API-22), Duplicate entry (API-26), Required field missing (API-46), Required field invalid (API-48)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-40", "description": "The request isn't valid.", "resolution": "Please send the valid request" } ] } } } }, "401": { "description": "Unauthorized (API-102)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-102", "description": "The client could not be authenticated due to missing or invalid client credentials.", "resolution": "Make sure that you are using the correct API key/Secret and that your application is enabled." } ] } } } }, "403": { "description": "User doesn't have access to this endpoint (API-2), Client has been end dated (API-68)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-2", "description": "Your application is not authorized to access the resource.", "resolution": "Please have your company administrator give your application access to the resource." } ] } } } }, "404": { "description": "Invalid resource ID (API-7)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-7", "description": "The resource or status is invalid. You may have an incorrect resource ID.", "resolution": "Send a valid resource in your request" } ] } } } }, "405": { "description": "Unsupported method type (API-59)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-59", "description": "The request method type is unsupported." } ] } } } }, "406": { "description": "Unsupported Accept header", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-75", "description": "Invalid vendor media type.", "resolution": "Please refer to our documentation and send the correct vendor media type" } ] } } } }, "500": { "description": "Internal Server Error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-1", "description": "Internal Server Error.", "resolution": "Please contact Paychex API Developer Center Support." } ] } } } } } } }, "/workers/{workerId}/customfields": { "get": { "tags": [ "Worker" ], "summary": "Worker Custom Fields", "description": "Get the worker's customFields", "operationId": "getWorkerCustomFields", "parameters": [ { "name": "workerId", "in": "path", "description": "ID associated with desired worker.", "required": true, "schema": { "type": "string" } }, { "name": "asof", "in": "query", "description": "Returns all custom fields as of the date used in the request", "required": false, "schema": { "type": "string" }, "example": "2020-01-04T00:00:00Z" } ], "responses": { "200": { "description": "Worker Custom fields successfully returned", "content": { "application/vnd.paychex.worker.customfields.v1+json": { "schema": { "$ref": "#/components/schemas/WorkerCustomFieldsResource" }, "examples": { "WorkerCustomFieldsVMT": { "$ref": "#/components/examples/JSON_WORKER_EXAMPLES/value/WORKER_CUSTOM_FIELDS_GET" } } }, "application/json": { "schema": { "$ref": "#/components/schemas/WorkerCustomFieldsResource" }, "examples": { "WorkerCustomFieldsDef": { "$ref": "#/components/examples/JSON_WORKER_EXAMPLES/value/WORKER_CUSTOM_FIELDS_GET" } } } } }, "400": { "description": "Invalid resource or field, The request cannot be performed since the worker is in a state which does not allow this action(API-19)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-40", "description": "The request isn't valid.", "resolution": "Please send the valid request" } ] } } } }, "404": { "description": "Worker Custom fields not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-7", "description": "The resource or status is invalid. You may have an incorrect resource ID.", "resolution": "Send a valid resource in your request" } ] } } } }, "500": { "description": "Internal Server Error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-1", "description": "Internal Server Error.", "resolution": "Please contact Paychex API Developer Center Support." } ] } } } } } }, "post": { "tags": [ "Worker" ], "summary": "Worker Custom Field", "description": "Create CustomField at the worker level", "operationId": "createWorkerCustomField", "parameters": [ { "name": "workerId", "in": "path", "description": "ID associated with desired worker.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/vnd.paychex.worker.customfields.v1+json": { "schema": { "$ref": "#/components/schemas/WorkerCustomFieldsResource" }, "examples": { "postWorkerCustomFieldReqVMT": { "$ref": "#/components/examples/JSON_WORKER_EXAMPLES/value/WORKER_CUSTOM_FIELD_POST_PATCH" } } }, "application/json": { "schema": { "$ref": "#/components/schemas/WorkerCustomFieldsResource" }, "examples": { "postWorkerCustomFieldReqDef": { "$ref": "#/components/examples/JSON_WORKER_EXAMPLES/value/WORKER_CUSTOM_FIELD_POST_PATCH" } } } }, "required": true }, "responses": { "200": { "description": "Worker Custom field successfully created", "content": { "application/vnd.paychex.worker.customfields.v1+json": { "schema": { "$ref": "#/components/schemas/WorkerCustomFieldsResource" }, "examples": { "postWorkerCustomFieldVMT": { "$ref": "#/components/examples/JSON_WORKER_EXAMPLES/value/WORKER_CUSTOM_FIELD_GET" } } }, "application/json": { "schema": { "$ref": "#/components/schemas/WorkerCustomFieldsResource" }, "examples": { "postWorkerCustomFieldDef": { "$ref": "#/components/examples/JSON_WORKER_EXAMPLES/value/WORKER_CUSTOM_FIELD_GET" } } } } }, "400": { "description": "The request cannot be performed since the worker is in a state which does not allow this action(API-19),Required field missing (API-46), Empty request entity (API-52), File type is not supported (API-62), The document name is invalid (API-63), Service unavailable (API-66)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-40", "description": "The request isn't valid.", "resolution": "Please send the valid request" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-102", "description": "The client could not be authenticated due to missing or invalid client credentials.", "resolution": "Make sure that you are using the correct API key/Secret and that your application is enabled." } ] } } } }, "403": { "description": "User doesn't have access to this endpoint (API-2), Client has been end dated (API-68)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-2", "description": "Your application is not authorized to access the resource.", "resolution": "Please have your company administrator give your application access to the resource." } ] } } } }, "404": { "description": "Invalid resource ID (API-7)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-7", "description": "The resource or status is invalid. You may have an incorrect resource ID.", "resolution": "Send a valid resource in your request" } ] } } } }, "405": { "description": "Unsupported method type (API-59)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-59", "description": "The request method type is unsupported." } ] } } } }, "406": { "description": "Unsupported Accept header", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-75", "description": "Invalid vendor media type.", "resolution": "Please refer to our documentation and send the correct vendor media type" } ] } } } }, "500": { "description": "Internal Server Error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-1", "description": "Internal Server Error.", "resolution": "Please contact Paychex API Developer Center Support." } ] } } } } } } }, "/workers/{workerId}/customfields/{workerCustomFieldId}": { "get": { "tags": [ "Worker" ], "summary": "Worker Custom Field", "description": "Get the worker's customFields by workerCustomFieldId", "operationId": "getWorkerCustomFieldsById", "parameters": [ { "name": "workerId", "in": "path", "description": "ID associated with desired worker.", "required": true, "schema": { "type": "string" } }, { "name": "workerCustomFieldId", "in": "path", "description": "ID associated with desired worker custom field.", "required": true, "schema": { "type": "string" } }, { "name": "asof", "in": "query", "description": "Returns custom field as of the date used in the request", "required": false, "schema": { "type": "string" }, "example": "2020-01-04T00:00:00Z" } ], "responses": { "200": { "description": "Worker Custom field successfully returned", "content": { "application/vnd.paychex.worker.customfield.v1+json": { "schema": { "$ref": "#/components/schemas/WorkerCustomFieldsResource" }, "examples": { "WorkerCustomFieldVMT": { "$ref": "#/components/examples/JSON_WORKER_EXAMPLES/value/WORKER_CUSTOM_FIELD_GET" } } }, "application/json": { "schema": { "$ref": "#/components/schemas/WorkerCustomFieldsResource" }, "examples": { "WorkerCustomFieldDef": { "$ref": "#/components/examples/JSON_WORKER_EXAMPLES/value/WORKER_CUSTOM_FIELD_GET" } } } } }, "400": { "description": "The value for the one of the field is invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-40", "description": "The request isn't valid.", "resolution": "Please send the valid request" } ] } } } }, "404": { "description": "Worker Custom fields not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-7", "description": "The resource or status is invalid. You may have an incorrect resource ID.", "resolution": "Send a valid resource in your request" } ] } } } }, "500": { "description": "Internal Server Error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-1", "description": "Internal Server Error.", "resolution": "Please contact Paychex API Developer Center Support." } ] } } } } } }, "delete": { "tags": [ "Worker" ], "summary": "Worker Custom Field", "description": "Delete CustomField at the worker level", "operationId": "deleteWorkerCustomField", "parameters": [ { "name": "workerId", "in": "path", "description": "ID associated with desired worker.", "required": true, "schema": { "type": "string" } }, { "name": "workerCustomFieldId", "in": "path", "description": "ID associated with desired worker custom field.", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "successful operation" }, "400": { "description": "The request cannot be performed since the worker is in a state which does not allow this action(API-19),Required field missing (API-46), Empty request entity (API-52), File type is not supported (API-62), The document name is invalid (API-63), Service unavailable (API-66)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-40", "description": "The request isn't valid.", "resolution": "Please send the valid request" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-102", "description": "The client could not be authenticated due to missing or invalid client credentials.", "resolution": "Make sure that you are using the correct API key/Secret and that your application is enabled." } ] } } } }, "403": { "description": "User doesn't have access to this endpoint (API-2), Client has been end dated (API-68)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-2", "description": "Your application is not authorized to access the resource.", "resolution": "Please have your company administrator give your application access to the resource." } ] } } } }, "404": { "description": "Invalid resource ID (API-7)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-7", "description": "The resource or status is invalid. You may have an incorrect resource ID.", "resolution": "Send a valid resource in your request" } ] } } } }, "405": { "description": "Unsupported method type (API-59)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-59", "description": "The request method type is unsupported." } ] } } } }, "406": { "description": "Unsupported Accept header", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-75", "description": "Invalid vendor media type.", "resolution": "Please refer to our documentation and send the correct vendor media type" } ] } } } }, "500": { "description": "Internal Server Error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-1", "description": "Internal Server Error.", "resolution": "Please contact Paychex API Developer Center Support." } ] } } } } } }, "patch": { "tags": [ "Worker" ], "summary": "Worker CustomField", "description": "Update CustomField at the worker level", "operationId": "updateWorkerCustomField", "parameters": [ { "name": "workerId", "in": "path", "description": "ID associated with desired worker.", "required": true, "schema": { "type": "string" } }, { "name": "workerCustomFieldId", "in": "path", "description": "ID associated with desired worker custom field.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/vnd.paychex.worker.customfield.v1+json": { "schema": { "$ref": "#/components/schemas/WorkerCustomFieldsResource" }, "examples": { "postWorkerCustomFieldResVMT": { "$ref": "#/components/examples/JSON_WORKER_EXAMPLES/value/WORKER_CUSTOM_FIELD_POST_PATCH" } } }, "application/json": { "schema": { "$ref": "#/components/schemas/WorkerCustomFieldsResource" }, "examples": { "postWorkerCustomFieldResDef": { "$ref": "#/components/examples/JSON_WORKER_EXAMPLES/value/WORKER_CUSTOM_FIELD_POST_PATCH" } } } }, "required": true }, "responses": { "200": { "description": "Worker Custom field successfully updated", "content": { "application/vnd.paychex.worker.customfield.v1+json": { "schema": { "$ref": "#/components/schemas/WorkerCustomFieldsResource" }, "examples": { "updateWorkerCustomFieldVMT": { "$ref": "#/components/examples/JSON_WORKER_EXAMPLES/value/WORKER_CUSTOM_FIELD_GET" } } }, "application/json": { "schema": { "$ref": "#/components/schemas/WorkerCustomFieldsResource" }, "examples": { "updateWorkerCustomFieldDef": { "$ref": "#/components/examples/JSON_WORKER_EXAMPLES/value/WORKER_CUSTOM_FIELD_GET" } } } } }, "400": { "description": "The request cannot be performed since the worker is in a state which does not allow this action(API-19),Required field missing (API-46), Empty request entity (API-52), File type is not supported (API-62), The document name is invalid (API-63), Service unavailable (API-66)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-40", "description": "The request isn't valid.", "resolution": "Please send the valid request" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-102", "description": "The client could not be authenticated due to missing or invalid client credentials.", "resolution": "Make sure that you are using the correct API key/Secret and that your application is enabled." } ] } } } }, "403": { "description": "User doesn't have access to this endpoint (API-2), Client has been end dated (API-68)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-2", "description": "Your application is not authorized to access the resource.", "resolution": "Please have your company administrator give your application access to the resource." } ] } } } }, "404": { "description": "Invalid resource ID (API-7)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-7", "description": "The resource or status is invalid. You may have an incorrect resource ID.", "resolution": "Send a valid resource in your request" } ] } } } }, "405": { "description": "Unsupported method type (API-59)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-59", "description": "The request method type is unsupported." } ] } } } }, "406": { "description": "Unsupported Accept header", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-75", "description": "Invalid vendor media type.", "resolution": "Please refer to our documentation and send the correct vendor media type" } ] } } } }, "500": { "description": "Internal Server Error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-1", "description": "Internal Server Error.", "resolution": "Please contact Paychex API Developer Center Support." } ] } } } } } } }, "/workers/{workerId}/directdeposits": { "get": { "tags": [ "Worker" ], "summary": "Worker Direct Deposits", "description": "Array of direct deposits for an \"Active\" or \"In-Progress\" worker.", "operationId": "getWorkerDirectDeposits", "parameters": [ { "name": "workerId", "in": "path", "description": "ID associated with desired worker.", "required": true, "schema": { "type": "string" } }, { "name": "effectivitydate", "in": "query", "description": "The effectivity date.", "required": false, "schema": { "type": "string" }, "example": "2020-01-04" }, { "name": "asof", "in": "query", "description": "Returns all direct deposits as of the date used in the request", "required": false, "schema": { "type": "string" }, "example": "2020-01-04T00:00:00Z" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/vnd.paychex.payroll.directdeposits.v1+json": { "schema": { "$ref": "#/components/schemas/DirectDepositResourceV2" }, "examples": { "directdepositsVMT": { "$ref": "#/components/examples/JSON_WORKER_EXAMPLES/value/WORKER_DIRECT_DEPOSITS_GET" } } }, "application/json": { "schema": { "$ref": "#/components/schemas/DirectDepositResourceV2" }, "examples": { "directdepositsDef": { "$ref": "#/components/examples/JSON_WORKER_EXAMPLES/value/WORKER_DIRECT_DEPOSITS_GET" } } } } }, "400": { "description": "The request cannot be performed since the worker is in a state which does not allow this action(API-19)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-40", "description": "The request isn't valid.", "resolution": "Please send the valid request" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-102", "description": "The client could not be authenticated due to missing or invalid client credentials.", "resolution": "Make sure that you are using the correct API key/Secret and that your application is enabled." } ] } } } }, "403": { "description": "User doesn't have access to this endpoint (API-2), Client has been end dated (API-68)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-2", "description": "Your application is not authorized to access the resource.", "resolution": "Please have your company administrator give your application access to the resource." } ] } } } }, "404": { "description": "Invalid resource ID (API-7)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-7", "description": "The resource or status is invalid. You may have an incorrect resource ID.", "resolution": "Send a valid resource in your request" } ] } } } }, "405": { "description": "Unsupported method type (API-59)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-59", "description": "The request method type is unsupported." } ] } } } }, "406": { "description": "Unsupported Accept header", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-75", "description": "Invalid vendor media type.", "resolution": "Please refer to our documentation and send the correct vendor media type" } ] } } } }, "500": { "description": "Internal Server Error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-1", "description": "Internal Server Error.", "resolution": "Please contact Paychex API Developer Center Support." } ] } } } } } }, "post": { "tags": [ "Worker" ], "summary": "Worker Direct Deposit", "description": "Add a direct deposit to an \"Active\" or \"In-Progress\" worker.", "operationId": "createWorkerDirectDeposit", "parameters": [ { "name": "workerId", "in": "path", "description": "ID associated with desired worker.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/vnd.paychex.payroll.directdeposit.v1+json": { "schema": { "$ref": "#/components/schemas/DirectDepositResourceV2" }, "examples": { "postdirectdepositVMT": { "$ref": "#/components/examples/JSON_WORKER_EXAMPLES/value/WORKER_DIRECT_DEPOSIT_POST" } } }, "application/json": { "schema": { "$ref": "#/components/schemas/DirectDepositResourceV2" }, "examples": { "postdirectdepositDef": { "$ref": "#/components/examples/JSON_WORKER_EXAMPLES/value/WORKER_DIRECT_DEPOSIT_POST" } } } }, "required": true }, "responses": { "201": { "description": "Successful operation", "content": { "application/vnd.paychex.payroll.directdeposit.v1+json": { "schema": { "$ref": "#/components/schemas/DirectDepositResourceV2" }, "examples": { "directdepositVMT": { "$ref": "#/components/examples/JSON_WORKER_EXAMPLES/value/WORKER_DIRECT_DEPOSIT_GET" } } }, "application/json": { "schema": { "$ref": "#/components/schemas/DirectDepositResourceV2" }, "examples": { "directdepositDef": { "$ref": "#/components/examples/JSON_WORKER_EXAMPLES/value/WORKER_DIRECT_DEPOSIT_GET" } } } } }, "400": { "description": "Invalid request (API-4), Uneditable field (API-5), Invalid field (API-17), The request cannot be performed since the worker is in a state which does not allow this action(API-19),Non parsable value (API-24), Invalid amount (API-28), Missing routing/account number (API-29), Invalid routing/account number (API-30), The routing number must have nine digits (API-31), Invalid dates (API-34), Value required (API-35), The Direct Deposit product has not been set up for this client (API-36), Invalid date range for creating DD (API-37), The calculation method Remainder can only be used once (API-38), Direct deposit doesn't match partner bank account record (API-39), Invalid payment type/account type (API-40), There are future direct deposits that are preventing this action from completing (API-41)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-40", "description": "The request isn't valid.", "resolution": "Please send the valid request" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-102", "description": "The client could not be authenticated due to missing or invalid client credentials.", "resolution": "Make sure that you are using the correct API key/Secret and that your application is enabled." } ] } } } }, "403": { "description": "User doesn't have access to this endpoint (API-2), Client has been end dated (API-68)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-2", "description": "Your application is not authorized to access the resource.", "resolution": "Please have your company administrator give your application access to the resource." } ] } } } }, "404": { "description": "Invalid resource ID (API-7)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-7", "description": "The resource or status is invalid. You may have an incorrect resource ID.", "resolution": "Send a valid resource in your request" } ] } } } }, "405": { "description": "Unsupported method type (API-59)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-59", "description": "The request method type is unsupported." } ] } } } }, "406": { "description": "Unsupported Accept header", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-75", "description": "Invalid vendor media type.", "resolution": "Please refer to our documentation and send the correct vendor media type" } ] } } } }, "423": { "description": "Client locked (API-10)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-10", "description": "The client is locked because another user or process is updating it. Your changes cannot be saved while the client is locked.", "resolution": "Please try again later." } ] } } } }, "500": { "description": "Internal Server Error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-1", "description": "Internal Server Error.", "resolution": "Please contact Paychex API Developer Center Support." } ] } } } } } }, "patch": { "tags": [ "Worker" ], "summary": "Worker Direct Deposits", "description": "Update multiple direct deposits for an \"Active\" or \"In-Progress\" worker at a time. \"In-Progress\" workers cannot be PATCHED using Content Type \"application/json-patch+json\"\n", "operationId": "updateWorkerDirectDeposits_1", "parameters": [ { "name": "workerId", "in": "path", "description": "ID associated with desired worker.", "required": true, "schema": { "type": "string" } }, { "name": "effectivitydate", "in": "query", "description": "The effectivity date. Cannot be used with Content Type \"application/json-patch+json\"", "required": false, "schema": { "type": "string" }, "example": "2020-01-31" } ], "requestBody": { "content": { "application/vnd.paychex.payroll.directdeposits.v1+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DirectDepositResourceV2" } }, "examples": { "postdirectdepositReqVMT": { "$ref": "#/components/examples/JSON_WORKER_EXAMPLES/value/WORKER_DIRECT_DEPOSITS_PATCH_BULK" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DirectDepositResourceV2" } }, "examples": { "postdirectdepositReqDef": { "$ref": "#/components/examples/JSON_WORKER_EXAMPLES/value/WORKER_DIRECT_DEPOSITS_PATCH_BULK" } } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/WorkerDirectDepositFieldsDescription" }, "examples": { "Add or Replace or Remove a worker's direct deposit data": { "$ref": "#/components/examples/JSON_WORKER_EXAMPLES/value/WORKER_DIRECT_DEPOSITS_BULK_JSONPATCH_REQUEST" } } } }, "required": true }, "responses": { "200": { "description": "This is successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DirectDepositResourceV2" }, "examples": { "DDExample2": { "$ref": "#/components/examples/JSON_WORKER_EXAMPLES/value/WORKER_DIRECT_DEPOSITS_GET" } } }, "application/vnd.paychex.payroll.directdeposits.v1+json": { "schema": { "$ref": "#/components/schemas/DirectDepositResourceV2" }, "examples": { "DDExample1": { "$ref": "#/components/examples/JSON_WORKER_EXAMPLES/value/WORKER_DIRECT_DEPOSITS_GET" } } } } }, "400": { "description": "The request cannot be performed since the worker is in a state which does not allow this action(API-19)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-40", "description": "The request isn't valid.", "resolution": "Please send the valid request" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-102", "description": "The client could not be authenticated due to missing or invalid client credentials.", "resolution": "Make sure that you are using the correct API key/Secret and that your application is enabled." } ] } } } }, "403": { "description": "User doesn't have access to this endpoint (API-2), Client has been end dated (API-68)", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-2", "description": "Your application is not authorized to access the resource.", "resolution": "Please have your company administrator give your application access to the resource." } ] } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } }, "404": { "description": "Invalid resource ID (API-7)", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-7", "description": "The resource or status is invalid. You may have an incorrect resource ID.", "resolution": "Send a valid resource in your request" } ] } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } }, "405": { "description": "Unsupported method type (API-59)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-59", "description": "The request method type is unsupported." } ] } } } }, "406": { "description": "Unsupported Accept header", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-75", "description": "Invalid vendor media type.", "resolution": "Please refer to our documentation and send the correct vendor media type" } ] } } } }, "500": { "description": "Internal Server Error.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-1", "description": "Internal Server Error.", "resolution": "Please contact Paychex API Developer Center Support." } ] } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } } }, "/workers/{workerId}/directdeposits/{directDepositId}": { "get": { "tags": [ "Worker" ], "summary": "Worker Direct Deposit", "description": "Single direct deposit for an \"Active\" or \"In-Progress\" worker.", "operationId": "getWorkerDirectDepositById", "parameters": [ { "name": "workerId", "in": "path", "description": "ID associated with desired worker.", "required": true, "schema": { "type": "string" } }, { "name": "directDepositId", "in": "path", "description": "The id assigned to the direct deposit for this worker.", "required": true, "schema": { "type": "string" } }, { "name": "effectivitydate", "in": "query", "description": "The effectivity date.", "required": false, "schema": { "type": "string" }, "example": "2020-01-04" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/vnd.paychex.payroll.directdeposit.v1+json": { "schema": { "$ref": "#/components/schemas/DirectDepositResourceV2" }, "examples": { "directdepositVMT": { "$ref": "#/components/examples/JSON_WORKER_EXAMPLES/value/WORKER_DIRECT_DEPOSIT_GET" } } }, "application/json": { "schema": { "$ref": "#/components/schemas/DirectDepositResourceV2" }, "examples": { "directdepositDef": { "$ref": "#/components/examples/JSON_WORKER_EXAMPLES/value/WORKER_DIRECT_DEPOSIT_GET" } } } } }, "400": { "description": "The request cannot be performed since the worker is in a state which does not allow this action(API-19)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-40", "description": "The request isn't valid.", "resolution": "Please send the valid request" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-102", "description": "The client could not be authenticated due to missing or invalid client credentials.", "resolution": "Make sure that you are using the correct API key/Secret and that your application is enabled." } ] } } } }, "403": { "description": "User doesn't have access to this endpoint (API-2), Client has been end dated (API-68)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-2", "description": "Your application is not authorized to access the resource.", "resolution": "Please have your company administrator give your application access to the resource." } ] } } } }, "404": { "description": "Invalid resource ID (API-7)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-7", "description": "The resource or status is invalid. You may have an incorrect resource ID.", "resolution": "Send a valid resource in your request" } ] } } } }, "405": { "description": "Unsupported method type (API-59)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-59", "description": "The request method type is unsupported." } ] } } } }, "406": { "description": "Unsupported Accept header", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-75", "description": "Invalid vendor media type.", "resolution": "Please refer to our documentation and send the correct vendor media type" } ] } } } }, "500": { "description": "Internal Server Error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-1", "description": "Internal Server Error.", "resolution": "Please contact Paychex API Developer Center Support." } ] } } } } } }, "delete": { "tags": [ "Worker" ], "summary": "Worker Direct Deposit", "description": "Remove a single direct deposit for an \"Active\" or \"In-Progress\" worker.", "operationId": "deleteWorkerDirectDeposit", "parameters": [ { "name": "workerId", "in": "path", "description": "ID associated with desired worker.", "required": true, "schema": { "type": "string" } }, { "name": "directDepositId", "in": "path", "description": "The id assigned to the direct deposit for this worker.", "required": true, "schema": { "type": "string" } }, { "name": "effectivitydate", "in": "query", "description": "The effectivity date.", "required": false, "schema": { "type": "string" }, "example": "2020-01-31" } ], "responses": { "204": { "description": "Direct Deposit successfully deleted" }, "400": { "description": "The request cannot be performed since the worker is in a state which does not allow this action(API-19)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-40", "description": "The request isn't valid.", "resolution": "Please send the valid request" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-102", "description": "The client could not be authenticated due to missing or invalid client credentials.", "resolution": "Make sure that you are using the correct API key/Secret and that your application is enabled." } ] } } } }, "403": { "description": "User doesn't have access to this endpoint (API-2), Client has been end dated (API-68)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-2", "description": "Your application is not authorized to access the resource.", "resolution": "Please have your company administrator give your application access to the resource." } ] } } } }, "404": { "description": "Invalid resource ID (API-7)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-7", "description": "The resource or status is invalid. You may have an incorrect resource ID.", "resolution": "Send a valid resource in your request" } ] } } } }, "405": { "description": "Unsupported method type (API-59)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-59", "description": "The request method type is unsupported." } ] } } } }, "406": { "description": "Unsupported Accept header", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-75", "description": "Invalid vendor media type.", "resolution": "Please refer to our documentation and send the correct vendor media type" } ] } } } }, "423": { "description": "Client locked (API-10)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-10", "description": "The client is locked because another user or process is updating it. Your changes cannot be saved while the client is locked.", "resolution": "Please try again later." } ] } } } }, "500": { "description": "Internal Server Error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-1", "description": "Internal Server Error.", "resolution": "Please contact Paychex API Developer Center Support." } ] } } } } } }, "patch": { "tags": [ "Worker" ], "summary": "Worker Direct Deposit", "description": "Update a single direct deposit for an \"Active\" or \"In-Progress\" worker. \"In-Progress\" workers cannot be PATCHED using Content Type \"application/json-patch+json\"\n", "operationId": "updateWorkerDirectDeposits_2", "parameters": [ { "name": "workerId", "in": "path", "description": "ID associated with desired worker.", "required": true, "schema": { "type": "string" } }, { "name": "directDepositId", "in": "path", "description": "The id assigned to the direct deposit for this worker.", "required": true, "schema": { "type": "string" } }, { "name": "effectivitydate", "in": "query", "description": "The effectivity date. Cannot be used with Content Type \"application/json-patch+json\"", "required": false, "schema": { "type": "string" }, "example": "2020-01-31" } ], "requestBody": { "content": { "application/vnd.paychex.payroll.directdeposit.v1+json": { "schema": { "$ref": "#/components/schemas/DirectDepositResourceV2" }, "examples": { "directdepositReqVMT": { "$ref": "#/components/examples/JSON_WORKER_EXAMPLES/value/WORKER_DIRECT_DEPOSIT_PATCH" } } }, "application/json": { "schema": { "$ref": "#/components/schemas/DirectDepositResourceV2" }, "examples": { "directdepositReqDef": { "$ref": "#/components/examples/JSON_WORKER_EXAMPLES/value/WORKER_DIRECT_DEPOSIT_PATCH" } } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/WorkerDirectDepositFieldsDescription" }, "examples": { "Replace multiple data fields for a worker's direct deposit ": { "$ref": "#/components/examples/JSON_WORKER_EXAMPLES/value/WORKER_DIRECT_DEPOSITS_BY_ID_JSONPATCH_REQUEST_1" }, "Replace a single data field for a worker's direct deposit": { "$ref": "#/components/examples/JSON_WORKER_EXAMPLES/value/WORKER_DIRECT_DEPOSITS_BY_ID_JSONPATCH_REQUEST_2" } } } }, "required": true }, "responses": { "200": { "description": "Successful operation", "content": { "application/vnd.paychex.payroll.directdeposit.v1+json": { "schema": { "$ref": "#/components/schemas/DirectDepositResourceV2" }, "examples": { "updateDirectdepositVMT": { "$ref": "#/components/examples/JSON_WORKER_EXAMPLES/value/WORKER_DIRECT_DEPOSIT_PATCH_RESPONSE" } } }, "application/json": { "schema": { "$ref": "#/components/schemas/DirectDepositResourceV2" }, "examples": { "updateDirectdepositDef": { "$ref": "#/components/examples/JSON_WORKER_EXAMPLES/value/WORKER_DIRECT_DEPOSIT_PATCH_RESPONSE" } } } } }, "400": { "description": "Invalid request (API-4), Uneditable field (API-5), Invalid field (API-17), The request cannot be performed since the worker is in a state which does not allow this action(API-19),Invalid payment type (API-22), Non parsable value (API-24), Unremovable attribute (API-25), Invalid amount (API-28), Missing routing/account number (API-29), Invalid routing/account number (API-30), The routing number must have nine digits (API-31), Invalid dates (API-34), Value required (API-35), The Direct Deposit product has not been set up for this client (API-36), Invalid date range for creating DD (API-37), The calculation method Remainder can only be used once (API-38), Direct deposit doesn't match partner bank account record (API-39), There are future direct deposits that are preventing this action from completing (API-41)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-40", "description": "The request isn't valid.", "resolution": "Please send the valid request" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-102", "description": "The client could not be authenticated due to missing or invalid client credentials.", "resolution": "Make sure that you are using the correct API key/Secret and that your application is enabled." } ] } } } }, "403": { "description": "User doesn't have access to this endpoint (API-2), Client has been end dated (API-68)", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-2", "description": "Your application is not authorized to access the resource.", "resolution": "Please have your company administrator give your application access to the resource." } ] } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } }, "404": { "description": "Invalid resource ID (API-7)", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-7", "description": "The resource or status is invalid. You may have an incorrect resource ID.", "resolution": "Send a valid resource in your request" } ] } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } }, "405": { "description": "Unsupported method type (API-59)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-59", "description": "The request method type is unsupported." } ] } } } }, "406": { "description": "Unsupported Accept header", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-75", "description": "Invalid vendor media type.", "resolution": "Please refer to our documentation and send the correct vendor media type" } ] } } } }, "423": { "description": "Client locked (API-10)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-10", "description": "The client is locked because another user or process is updating it. Your changes cannot be saved while the client is locked.", "resolution": "Please try again later." } ] } } } }, "500": { "description": "Internal Server Error.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-1", "description": "Internal Server Error.", "resolution": "Please contact Paychex API Developer Center Support." } ] } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } } }, "/workers/{workerId}/documents": { "get": { "tags": [ "Worker" ], "summary": "Worker Documents", "description": "Get document list for an \"Active\" or \"Terminated\" worker.", "operationId": "getDocumentList", "parameters": [ { "name": "workerId", "in": "path", "description": "ID associated with desired worker.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentManagementResource" }, "examples": { "documentListSuccessResponse": { "$ref": "#/components/examples/JSON_WORKER_EXAMPLES/value/WORKER_GET_DOCUMENT_LIST_RESPONSE" } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-102", "description": "The client could not be authenticated due to missing or invalid client credentials.", "resolution": "Make sure that you are using the correct API key/Secret and that your application is enabled." } ] } } } }, "403": { "description": "User doesn't have access to this endpoint (API-2), Client has been end dated (API-68)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-2", "description": "Your application is not authorized to access the resource.", "resolution": "Please have your company administrator give your application access to the resource." } ] } } } }, "404": { "description": "No documents found for this worker. (API-7)\n", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "examples": { "noDocumentsFoundErrorResponse": { "$ref": "#/components/examples/JSON_WORKER_EXAMPLES/value/WORKER_GET_DOCUMENT_LIST_NO_DOCS_ERROR_RESPONSE" } } } } }, "405": { "description": "Unsupported method type (API-59)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-59", "description": "The request method type is unsupported." } ] } } } }, "406": { "description": "Unsupported Accept header", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-75", "description": "Invalid vendor media type.", "resolution": "Please refer to our documentation and send the correct vendor media type" } ] } } } }, "423": { "description": "Client locked (API-10)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-10", "description": "The client is locked because another user or process is updating it. Your changes cannot be saved while the client is locked.", "resolution": "Please try again later." } ] } } } }, "500": { "description": "Internal Server Error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-1", "description": "Internal Server Error.", "resolution": "Please contact Paychex API Developer Center Support." } ] } } } } } }, "post": { "tags": [ "Worker" ], "summary": "Worker Document", "description": "Add a document to an \"Active\" or \"Terminated\" worker.", "operationId": "uploadDocument", "parameters": [ { "name": "workerId", "in": "path", "description": "ID associated with desired worker.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/FileResource" }, "examples": { "multipartSample": { "$ref": "#/components/examples/JSON_WORKER_EXAMPLES/value/WORKER_ADD_DOCUMENT_FILE_TYPE_REQUEST" }, "documentManagementResource": { "$ref": "#/components/examples/JSON_WORKER_EXAMPLES/value/WORKER_ADD_DOCUMENT_METADATA" }, "notificationResource": { "$ref": "#/components/examples/JSON_WORKER_EXAMPLES/value/WORKER_ADD_DOCUMENT_NOTIFICATION_REQUEST" } } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentManagementResource" }, "examples": { "documentAddSuccessResponse": { "$ref": "#/components/examples/JSON_WORKER_EXAMPLES/value/WORKER_ADD_DOCUMENT_RESPONSE" } } } } }, "400": { "description": "Uploaded document is not an acceptable file type. (API-62), Uploaded document exceeds maximum allowed size. (API-4)\n", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "examples": { "documentAddFileTypeErrorResponse": { "$ref": "#/components/examples/JSON_WORKER_EXAMPLES/value/WORKER_ADD_DOCUMENT_FILE_TYPE_ERROR_RESPONSE" } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-102", "description": "The client could not be authenticated due to missing or invalid client credentials.", "resolution": "Make sure that you are using the correct API key/Secret and that your application is enabled." } ] } } } }, "403": { "description": "User doesn't have access to this endpoint (API-2), Client has been end dated (API-68)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-2", "description": "Your application is not authorized to access the resource.", "resolution": "Please have your company administrator give your application access to the resource." } ] } } } }, "404": { "description": "Invalid resource ID (API-7)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-7", "description": "The resource or status is invalid. You may have an incorrect resource ID.", "resolution": "Send a valid resource in your request" } ] } } } }, "405": { "description": "Unsupported method type (API-59)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-59", "description": "The request method type is unsupported." } ] } } } }, "406": { "description": "Unsupported Accept header", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-75", "description": "Invalid vendor media type.", "resolution": "Please refer to our documentation and send the correct vendor media type" } ] } } } }, "423": { "description": "Client locked (API-10)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-10", "description": "The client is locked because another user or process is updating it. Your changes cannot be saved while the client is locked.", "resolution": "Please try again later." } ] } } } }, "500": { "description": "Internal Server Error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-1", "description": "Internal Server Error.", "resolution": "Please contact Paychex API Developer Center Support." } ] } } } } } } }, "/workers/{workerId}/documents/{documentId}": { "get": { "tags": [ "Worker" ], "summary": "Worker Document", "description": "Retrieve a document for a worker.", "operationId": "getDocument", "parameters": [ { "name": "workerId", "in": "path", "description": "ID associated with desired worker.", "required": true, "schema": { "type": "string" } }, { "name": "documentId", "in": "path", "description": "ID associated with the document.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Worker document successfully retrieved", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentManagementResource" }, "examples": { "SuccessResponse": { "$ref": "#/components/examples/JSON_WORKER_EXAMPLES/value/WORKER_GET_DOCUMENT_RESPONSE" } } } } }, "400": { "description": "The request cannot be performed since the worker is in a state which does not allow this action (API-19)\n", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-40", "description": "The request isn't valid.", "resolution": "Please send the valid request" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-102", "description": "The client could not be authenticated due to missing or invalid client credentials.", "resolution": "Make sure that you are using the correct API key/Secret and that your application is enabled." } ] } } } }, "403": { "description": "User doesn't have access to this endpoint (API-2), Client has been end dated (API-68)\n", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-2", "description": "Your application is not authorized to access the resource.", "resolution": "Please have your company administrator give your application access to the resource." } ] } } } }, "404": { "description": "Invalid resource ID (API-7)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-7", "description": "The resource or status is invalid. You may have an incorrect resource ID.", "resolution": "Send a valid resource in your request" } ] } } } }, "500": { "description": "Internal Server Error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-1", "description": "Internal Server Error.", "resolution": "Please contact Paychex API Developer Center Support." } ] } } } } } }, "delete": { "tags": [ "Worker" ], "summary": "Worker Document", "description": "Remove a document from an \"Active\" or \"Terminated\" worker.", "operationId": "deleteDocument", "parameters": [ { "name": "workerId", "in": "path", "description": "ID associated with desired worker.", "required": true, "schema": { "type": "string" } }, { "name": "documentId", "in": "path", "description": "ID associated with the document.", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Worker document successfully deleted" }, "400": { "description": "The request cannot be performed since the worker is in a state which does not allow this action(API-19)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-40", "description": "The request isn't valid.", "resolution": "Please send the valid request" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-102", "description": "The client could not be authenticated due to missing or invalid client credentials.", "resolution": "Make sure that you are using the correct API key/Secret and that your application is enabled." } ] } } } }, "403": { "description": "User doesn't have access to this endpoint (API-2), Client has been end dated (API-68)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-2", "description": "Your application is not authorized to access the resource.", "resolution": "Please have your company administrator give your application access to the resource." } ] } } } }, "404": { "description": "Invalid resource ID (API-7)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-7", "description": "The resource or status is invalid. You may have an incorrect resource ID.", "resolution": "Send a valid resource in your request" } ] } } } }, "500": { "description": "Internal Server Error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-1", "description": "Internal Server Error.", "resolution": "Please contact Paychex API Developer Center Support." } ] } } } } } } }, "/workers/{workerId}/federaltax": { "get": { "tags": [ "Worker" ], "summary": "Worker Federal Tax", "description": "Federal tax setup for an \"Active\" or \"In-progress\" worker.", "operationId": "getWorkerFederalTax", "parameters": [ { "name": "workerId", "in": "path", "description": "ID associated with desired worker.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Worker Federal Tax successfully returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkerFederalTaxResource" }, "examples": { "federalTaxDef": { "$ref": "#/components/examples/JSON_WORKER_EXAMPLES/value/WORKER_FEDERAL_TAX_RESPONSE" } } }, "application/vnd.paychex.worker.federaltax2020.v1+json": { "schema": { "$ref": "#/components/schemas/WorkerFederalTaxResource" }, "examples": { "federalTaxVmt": { "$ref": "#/components/examples/JSON_WORKER_EXAMPLES/value/WORKER_FEDERAL_TAX_RESPONSE" } } } } }, "400": { "description": "Invalid resource or field, The request cannot be performed since the worker is in a state which does not allow this action(API-19)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-40", "description": "The request isn't valid.", "resolution": "Please send the valid request" } ] } } } }, "404": { "description": "Worker Federal Tax not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-7", "description": "The resource or status is invalid. You may have an incorrect resource ID.", "resolution": "Send a valid resource in your request" } ] } } } }, "500": { "description": "Internal Server Error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-1", "description": "Internal Server Error.", "resolution": "Please contact Paychex API Developer Center Support." } ] } } } } } }, "post": { "tags": [ "Worker" ], "summary": "Worker Federal Tax", "description": "WARNING: This endpoint will be deprecated on 1/30/2026. Until this date, POST federal tax will behave both as a POST and PATCH call accordingly, depending on if the worker already has a federal tax setup. \nNOTE: In-progress workers are created with a federal tax setup automatically. See POST In-progress worker. If a worker does not have a federal tax set up, this endpoint will create one with the values given in the request.", "operationId": "addWorkerFederalTax", "parameters": [ { "name": "workerId", "in": "path", "description": "ID associated with desired worker.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkerFederalTaxResource" }, "examples": { "federalTaxDef": { "$ref": "#/components/examples/JSON_WORKER_EXAMPLES/value/WORKER_FEDERAL_TAX_REQUEST" } } }, "application/vnd.paychex.worker.federaltax2020.v1+json": { "schema": { "$ref": "#/components/schemas/WorkerFederalTaxResource" }, "examples": { "federalTaxVmt": { "$ref": "#/components/examples/JSON_WORKER_EXAMPLES/value/WORKER_FEDERAL_TAX_REQUEST" } } } }, "required": true }, "responses": { "201": { "description": "Worker Federal Tax successfully added", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkerFederalTaxResource" }, "examples": { "federalTaxDef": { "$ref": "#/components/examples/JSON_WORKER_EXAMPLES/value/WORKER_FEDERAL_TAX_RESPONSE" } } }, "application/vnd.paychex.worker.federaltax2020.v1+json": { "schema": { "$ref": "#/components/schemas/WorkerFederalTaxResource" }, "examples": { "federalTaxVmt": { "$ref": "#/components/examples/JSON_WORKER_EXAMPLES/value/WORKER_FEDERAL_TAX_RESPONSE" } } } } }, "400": { "description": "Invalid resource or field,The request cannot be performed since the worker is in a state which does not allow this action(API-19)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-40", "description": "The request isn't valid.", "resolution": "Please send the valid request" } ] } } } }, "404": { "description": "Worker not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-7", "description": "The resource or status is invalid. You may have an incorrect resource ID.", "resolution": "Send a valid resource in your request" } ] } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-1", "description": "Internal Server Error.", "resolution": "Please contact Paychex API Developer Center Support." } ] } } } } } }, "patch": { "tags": [ "Worker" ], "summary": "Worker Federal Tax", "description": "Update the federal tax setup for an \"Active\" or \"In-progress\" worker. The patching will allow you to change the combination that you have with the extra and overrides.", "operationId": "updateWorkerFederalTax", "parameters": [ { "name": "workerId", "in": "path", "description": "ID associated with desired worker.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkerFederalTaxResource" }, "examples": { "federalTaxDef": { "$ref": "#/components/examples/JSON_WORKER_EXAMPLES/value/WORKER_FEDERAL_TAX_REQUEST" } } }, "application/vnd.paychex.worker.federaltax2020.v1+json": { "schema": { "$ref": "#/components/schemas/WorkerFederalTaxResource" }, "examples": { "federalTaxVmt": { "$ref": "#/components/examples/JSON_WORKER_EXAMPLES/value/WORKER_FEDERAL_TAX_REQUEST" } } } }, "required": true }, "responses": { "200": { "description": "Worker Federal Tax successfully updated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkerFederalTaxResource" }, "examples": { "federalTaxDef": { "$ref": "#/components/examples/JSON_WORKER_EXAMPLES/value/WORKER_FEDERAL_TAX_RESPONSE" } } }, "application/vnd.paychex.worker.federaltax2020.v1+json": { "schema": { "$ref": "#/components/schemas/WorkerFederalTaxResource" }, "examples": { "federalTaxVmt": { "$ref": "#/components/examples/JSON_WORKER_EXAMPLES/value/WORKER_FEDERAL_TAX_RESPONSE" } } } } }, "400": { "description": "Invalid resource or field, The request cannot be performed since the worker is in a state which does not allow this action(API-19)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-40", "description": "The request isn't valid.", "resolution": "Please send the valid request" } ] } } } }, "404": { "description": "Worker Federal Tax not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-7", "description": "The resource or status is invalid. You may have an incorrect resource ID.", "resolution": "Send a valid resource in your request" } ] } } } }, "500": { "description": "Internal Server Error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-1", "description": "Internal Server Error.", "resolution": "Please contact Paychex API Developer Center Support." } ] } } } } } } }, "/workers/{workerId}/i-nine/status": { "get": { "tags": [ "Worker" ], "summary": "Worker I9 Status", "description": "I9 status of a worker (employee and contractor) that your application has been granted access to. ", "operationId": "getWorkerI9Status", "parameters": [ { "name": "workerId", "in": "path", "description": "ID associated with desired worker.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/I9StatusResource" }, "examples": { "WorkerI9": { "$ref": "#/components/examples/JSON_WORKER_EXAMPLES/value/WORKER_I9_STATUS_GET" } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-102", "description": "The client could not be authenticated due to missing or invalid client credentials.", "resolution": "Make sure that you are using the correct API key/Secret and that your application is enabled." } ] } } } }, "403": { "description": "User doesn't have access to this endpoint (API-2), Client has been end dated (API-68)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-2", "description": "Your application is not authorized to access the resource.", "resolution": "Please have your company administrator give your application access to the resource." } ] } } } }, "404": { "description": "Invalid resource ID (API-7)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-7", "description": "The resource or status is invalid. You may have an incorrect resource ID.", "resolution": "Send a valid resource in your request" } ] } } } }, "405": { "description": "Unsupported method type (API-59)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-59", "description": "The request method type is unsupported." } ] } } } }, "406": { "description": "Unsupported Accept header", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-75", "description": "Invalid vendor media type.", "resolution": "Please refer to our documentation and send the correct vendor media type" } ] } } } }, "500": { "description": "Internal Server Error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-1", "description": "Internal Server Error.", "resolution": "Please contact Paychex API Developer Center Support." } ] } } } } } } }, "/workers/{workerId}/paycomponents": { "get": { "tags": [ "Worker" ], "summary": "Worker Pay Components", "description": "Get all the the pay components for a specific \"Active\" worker.", "operationId": "getWorkerRecurrings", "parameters": [ { "name": "workerId", "in": "path", "description": "ID associated with desired worker.", "required": true, "schema": { "type": "string" } }, { "name": "effectonpay", "in": "query", "description": "What the effect on pay will be (REDUCTION OR ADDITION), currently only reductions are available.", "required": false, "schema": { "type": "string" } }, { "name": "asof", "in": "query", "description": "Returns all pay components as of the date used in the request", "required": false, "schema": { "type": "string" }, "example": "2020-01-04T00:00:00Z" }, { "name": "name", "in": "query", "description": "The name of a pay component that a workers has.", "required": false, "schema": { "type": "string" } }, { "name": "componentid", "in": "query", "description": "The unique identifier of the pay component.", "required": false, "schema": { "type": "string" } }, { "name": "classificationtype", "in": "query", "description": "The classification type of a pay component that a worker has. (such as \"DEDUCTION\", or \"REGULAR\",)", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RecurringResource" }, "examples": { "default": { "$ref": "#/components/examples/JSON_WORKER_EXAMPLES/value/WORKER_PAY_COMPONENTS_GET" } } }, "application/vnd.paychex.payroll.paycomponents.v1+json": { "schema": { "$ref": "#/components/schemas/RecurringResource" }, "examples": { "workerPayCompVMT": { "$ref": "#/components/examples/JSON_WORKER_EXAMPLES/value/WORKER_PAY_COMPONENTS_GET" } } } } }, "400": { "description": "The request cannot be performed since the worker is in a state which does not allow this action(API-19)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-40", "description": "The request isn't valid.", "resolution": "Please send the valid request" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-102", "description": "The client could not be authenticated due to missing or invalid client credentials.", "resolution": "Make sure that you are using the correct API key/Secret and that your application is enabled." } ] } } } }, "403": { "description": "User doesn't have access to this endpoint (API-2), Client has been end dated (API-68)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-2", "description": "Your application is not authorized to access the resource.", "resolution": "Please have your company administrator give your application access to the resource." } ] } } } }, "404": { "description": "Invalid resource ID (API-7)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-7", "description": "The resource or status is invalid. You may have an incorrect resource ID.", "resolution": "Send a valid resource in your request" } ] } } } }, "405": { "description": "Unsupported method type (API-59)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-59", "description": "The request method type is unsupported." } ] } } } }, "406": { "description": "Unsupported Accept header", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-75", "description": "Invalid vendor media type.", "resolution": "Please refer to our documentation and send the correct vendor media type" } ] } } } }, "500": { "description": "Internal Server Error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-1", "description": "Internal Server Error.", "resolution": "Please contact Paychex API Developer Center Support." } ] } } } } } }, "post": { "tags": [ "Worker" ], "summary": "Worker Pay Component", "description": "Add a single pay component to the \"Active\" worker. This pay component will be used for apply recurring pay components on a workers check based on the frequency specified. supports the ability to POST both Addition and Reduction type pay components.", "operationId": "createWorkerRecurring", "parameters": [ { "name": "workerId", "in": "path", "description": "ID associated with desired worker.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/vnd.paychex.payroll.paycomponents.v1+json": { "schema": { "$ref": "#/components/schemas/RecurringResource" }, "examples": { "workerPaycompVMT": { "$ref": "#/components/examples/JSON_WORKER_EXAMPLES/value/WORKER_PAY_COMPONENT_POST" } } }, "application/json": { "schema": { "$ref": "#/components/schemas/RecurringResource" }, "examples": { "workerPaycompDef": { "$ref": "#/components/examples/JSON_WORKER_EXAMPLES/value/WORKER_PAY_COMPONENT_POST" } } } }, "required": true }, "responses": { "201": { "description": "Successful operation", "content": { "application/vnd.paychex.payroll.paycomponents.v1+json": { "schema": { "$ref": "#/components/schemas/RecurringResource" }, "examples": { "workerPayCompSingleVMT": { "$ref": "#/components/examples/JSON_WORKER_EXAMPLES/value/WORKER_PAY_COMPONENT_GET" } } }, "application/json": { "schema": { "$ref": "#/components/schemas/RecurringResource" }, "examples": { "workerPayCompSingleDef": { "$ref": "#/components/examples/JSON_WORKER_EXAMPLES/value/WORKER_PAY_COMPONENT_GET" } } } } }, "400": { "description": "Invalid request (API-4), The request cannot be performed since the worker is in a state which does not allow this action(API-19),Invalid value (API-24), Invalid Amount (API-28), Invalid Dates Range for creating PayComponent (API-37), Required field missing (API-46), Required field invalid (API-48), Overlapping dates (API-71), Invalid calculationBase (API-72)Invalid PayPeriod (API-74)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-40", "description": "The request isn't valid.", "resolution": "Please send the valid request" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-102", "description": "The client could not be authenticated due to missing or invalid client credentials.", "resolution": "Make sure that you are using the correct API key/Secret and that your application is enabled." } ] } } } }, "403": { "description": "User doesn't have access to this endpoint (API-2), Client has been end dated (API-68)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-2", "description": "Your application is not authorized to access the resource.", "resolution": "Please have your company administrator give your application access to the resource." } ] } } } }, "404": { "description": "Invalid resource ID (API-7)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-7", "description": "The resource or status is invalid. You may have an incorrect resource ID.", "resolution": "Send a valid resource in your request" } ] } } } }, "405": { "description": "Unsupported method type (API-59)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-59", "description": "The request method type is unsupported." } ] } } } }, "406": { "description": "Unsupported Accept header", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-75", "description": "Invalid vendor media type.", "resolution": "Please refer to our documentation and send the correct vendor media type" } ] } } } }, "415": { "description": "Invalid required value (API-22)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-22", "description": "Invalid required value", "resolution": "Please provide the valid value." } ] } } } }, "423": { "description": "Client locked (API-10)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-10", "description": "The client is locked because another user or process is updating it. Your changes cannot be saved while the client is locked.", "resolution": "Please try again later." } ] } } } }, "500": { "description": "Internal Server Error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-1", "description": "Internal Server Error.", "resolution": "Please contact Paychex API Developer Center Support." } ] } } } } } }, "patch": { "tags": [ "Worker" ], "summary": "Worker Pay Components", "description": "Batch update pay components associated to the \"Active\" worker.", "operationId": "updateWorkerRecurrings", "parameters": [ { "name": "workerId", "in": "path", "description": "ID associated with desired worker.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/vnd.paychex.payroll.paycomponents.v1+json": { "schema": { "$ref": "#/components/schemas/RecurringResource" }, "examples": { "vmtBatchUpdateReq": { "$ref": "#/components/examples/JSON_WORKER_EXAMPLES/value/WORKER_PAY_COMPONENTS_BULK_PATCH" } } }, "application/json": { "schema": { "$ref": "#/components/schemas/RecurringResource" }, "examples": { "defaultBatchUpDateReq": { "$ref": "#/components/examples/JSON_WORKER_EXAMPLES/value/WORKER_PAY_COMPONENTS_BULK_PATCH" } } } }, "required": true }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RecurringResource" }, "examples": { "defaultBatchUpDate": { "$ref": "#/components/examples/JSON_WORKER_EXAMPLES/value/WORKER_PAY_COMPONENTS_GET" } } }, "application/vnd.paychex.payroll.paycomponents.v1+json": { "schema": { "$ref": "#/components/schemas/RecurringResource" }, "examples": { "vmtBatchUpdate": { "$ref": "#/components/examples/JSON_WORKER_EXAMPLES/value/WORKER_PAY_COMPONENTS_GET" } } } } }, "400": { "description": "Invalid request (API-4), The request cannot be performed since the worker is in a state which does not allow this action(API-19),Invalid value (API-24), Unremovable attribute (API-25), Invalid Amount (API-28), Invalid Dates Range for creating pay component (API-37), Required field missing (API-46), Required field invalid (API-48), Overlapping dates (API-71), Invalid calculationBase (API-72)Invalid PayPeriod (API-74)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-40", "description": "The request isn't valid.", "resolution": "Please send the valid request" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-102", "description": "The client could not be authenticated due to missing or invalid client credentials.", "resolution": "Make sure that you are using the correct API key/Secret and that your application is enabled." } ] } } } }, "403": { "description": "User doesn't have access to this endpoint (API-2), Client has been end dated (API-68)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-2", "description": "Your application is not authorized to access the resource.", "resolution": "Please have your company administrator give your application access to the resource." } ] } } } }, "404": { "description": "Invalid resource ID (API-7)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-7", "description": "The resource or status is invalid. You may have an incorrect resource ID.", "resolution": "Send a valid resource in your request" } ] } } } }, "405": { "description": "Unsupported method type (API-59)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-59", "description": "The request method type is unsupported." } ] } } } }, "406": { "description": "Unsupported Accept header", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-75", "description": "Invalid vendor media type.", "resolution": "Please refer to our documentation and send the correct vendor media type" } ] } } } }, "415": { "description": "Invalid required value (API-22)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-22", "description": "Invalid required value", "resolution": "Please provide the valid value." } ] } } } }, "423": { "description": "Client locked (API-10)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-10", "description": "The client is locked because another user or process is updating it. Your changes cannot be saved while the client is locked.", "resolution": "Please try again later." } ] } } } }, "500": { "description": "Internal Server Error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-1", "description": "Internal Server Error.", "resolution": "Please contact Paychex API Developer Center Support." } ] } } } } } } }, "/workers/{workerId}/paycomponents/{workerComponentId}": { "get": { "tags": [ "Worker" ], "summary": "Worker Pay Component", "description": "Retrieve a specific pay component that a \"Active\" worker has.", "operationId": "getWorkerRecurringById", "parameters": [ { "name": "workerId", "in": "path", "description": "ID associated with desired worker.", "required": true, "schema": { "type": "string" } }, { "name": "workerComponentId", "in": "path", "description": "The id of a single pay component that a \"Active\" worker has.", "required": true, "schema": { "type": "string" } }, { "name": "asof", "in": "query", "description": "Returns pay component as of the date used in the request", "required": false, "schema": { "type": "string" }, "example": "2020-01-04T00:00:00Z" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/vnd.paychex.payroll.paycomponent.v1+json": { "schema": { "$ref": "#/components/schemas/RecurringResource" }, "examples": { "workerPayCompSingleVMT": { "$ref": "#/components/examples/JSON_WORKER_EXAMPLES/value/WORKER_PAY_COMPONENT_GET" } } }, "application/json": { "schema": { "$ref": "#/components/schemas/RecurringResource" }, "examples": { "workerPayCompSingleDef": { "$ref": "#/components/examples/JSON_WORKER_EXAMPLES/value/WORKER_PAY_COMPONENT_GET" } } } } }, "400": { "description": "The request cannot be performed since the worker is in a state which does not allow this action(API-19)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-40", "description": "The request isn't valid.", "resolution": "Please send the valid request" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-102", "description": "The client could not be authenticated due to missing or invalid client credentials.", "resolution": "Make sure that you are using the correct API key/Secret and that your application is enabled." } ] } } } }, "403": { "description": "User doesn't have access to this endpoint (API-2), Client has been end dated (API-68)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-2", "description": "Your application is not authorized to access the resource.", "resolution": "Please have your company administrator give your application access to the resource." } ] } } } }, "404": { "description": "Invalid resource ID (API-7)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-7", "description": "The resource or status is invalid. You may have an incorrect resource ID.", "resolution": "Send a valid resource in your request" } ] } } } }, "405": { "description": "Unsupported method type (API-59)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-75", "description": "Invalid vendor media type.", "resolution": "Please refer to our documentation and send the correct vendor media type" } ] } } } }, "406": { "description": "Unsupported Accept header", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-59", "description": "The request method type is unsupported." } ] } } } }, "500": { "description": "Internal Server Error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-1", "description": "Internal Server Error.", "resolution": "Please contact Paychex API Developer Center Support." } ] } } } } } }, "delete": { "tags": [ "Worker" ], "summary": "Worker Pay Component", "description": "Remove a specific pay component that a \"Active\" worker has.", "operationId": "deleteWorkerRecurring", "parameters": [ { "name": "workerId", "in": "path", "description": "ID associated with desired worker.", "required": true, "schema": { "type": "string" } }, { "name": "workerComponentId", "in": "path", "description": "The id of a single pay component that a workers has.", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Successful operation" }, "400": { "description": "The request cannot be performed since the worker is in a state which does not allow this action(API-19)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-40", "description": "The request isn't valid.", "resolution": "Please send the valid request" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-102", "description": "The client could not be authenticated due to missing or invalid client credentials.", "resolution": "Make sure that you are using the correct API key/Secret and that your application is enabled." } ] } } } }, "403": { "description": "User doesn't have access to this endpoint (API-2), Client has been end dated (API-68), Cannot delete the worker pay component if you created it today, please try to delete it tomorrow (API-73)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-2", "description": "Your application is not authorized to access the resource.", "resolution": "Please have your company administrator give your application access to the resource." } ] } } } }, "404": { "description": "Invalid resource ID (API-7)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-7", "description": "The resource or status is invalid. You may have an incorrect resource ID.", "resolution": "Send a valid resource in your request" } ] } } } }, "405": { "description": "Unsupported method type (API-59)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-59", "description": "The request method type is unsupported." } ] } } } }, "406": { "description": "Unsupported Accept header", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-75", "description": "Invalid vendor media type.", "resolution": "Please refer to our documentation and send the correct vendor media type" } ] } } } }, "422": { "description": "Future pay component cannot be deleted (API-45)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-45", "description": "The resource can't be deleted.", "resolution": "The resource state will not allow to delete." } ] } } } }, "500": { "description": "Internal Server Error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-1", "description": "Internal Server Error.", "resolution": "Please contact Paychex API Developer Center Support." } ] } } } } } }, "patch": { "tags": [ "Worker" ], "summary": "Worker Pay Component", "description": " Update a single pay component associated to the \"Active\" worker.", "operationId": "updateWorkerRecurring", "parameters": [ { "name": "workerId", "in": "path", "description": "ID associated with desired worker.", "required": true, "schema": { "type": "string" } }, { "name": "workerComponentId", "in": "path", "description": "The id of a single pay component that a workers has.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/vnd.paychex.payroll.paycomponent.v1+json": { "schema": { "$ref": "#/components/schemas/RecurringResource" }, "examples": { "workerPayCompSingleReqVMT": { "$ref": "#/components/examples/JSON_WORKER_EXAMPLES/value/WORKER_PAY_COMPONENT_PATCH" } } }, "application/json": { "schema": { "$ref": "#/components/schemas/RecurringResource" }, "examples": { "workerPayCompSingleReqDef": { "$ref": "#/components/examples/JSON_WORKER_EXAMPLES/value/WORKER_PAY_COMPONENT_PATCH" } } } }, "required": true }, "responses": { "200": { "description": "Successful operation", "content": { "application/vnd.paychex.payroll.paycomponent.v1+json": { "schema": { "$ref": "#/components/schemas/RecurringResource" }, "examples": { "workerPayCompSingleVMT": { "$ref": "#/components/examples/JSON_WORKER_EXAMPLES/value/WORKER_PAY_COMPONENT_PATCH_RESPONSE" } } }, "application/json": { "schema": { "$ref": "#/components/schemas/RecurringResource" }, "examples": { "workerPayCompSingleDef": { "$ref": "#/components/examples/JSON_WORKER_EXAMPLES/value/WORKER_PAY_COMPONENT_PATCH_RESPONSE" } } } } }, "400": { "description": "Invalid request (API-4), The request cannot be performed since the worker is in a state which does not allow this action(API-19),Invalid value (API-24), Unremovable attribute (API-25), Invalid Amount (API-28), Invalid Dates Range for creating PayComponent (API-37), Required field missing (API-46), Required field invalid (API-48), Overlapping dates (API-71), Invalid calculationBase (API-72)Invalid PayPeriod (API-74)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-40", "description": "The request isn't valid.", "resolution": "Please send the valid request" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-102", "description": "The client could not be authenticated due to missing or invalid client credentials.", "resolution": "Make sure that you are using the correct API key/Secret and that your application is enabled." } ] } } } }, "403": { "description": "User doesn't have access to this endpoint (API-2), Client has been end dated (API-68)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-2", "description": "Your application is not authorized to access the resource.", "resolution": "Please have your company administrator give your application access to the resource." } ] } } } }, "404": { "description": "Invalid resource ID (API-7)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-7", "description": "The resource or status is invalid. You may have an incorrect resource ID.", "resolution": "Send a valid resource in your request" } ] } } } }, "405": { "description": "Unsupported method type (API-59)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-59", "description": "The request method type is unsupported." } ] } } } }, "406": { "description": "Unsupported Accept header", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-75", "description": "Invalid vendor media type.", "resolution": "Please refer to our documentation and send the correct vendor media type" } ] } } } }, "415": { "description": "Invalid required value (API-22)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-22", "description": "Invalid required value", "resolution": "Please provide the valid value." } ] } } } }, "423": { "description": "Client locked (API-10)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-10", "description": "The client is locked because another user or process is updating it. Your changes cannot be saved while the client is locked.", "resolution": "Please try again later." } ] } } } }, "500": { "description": "Internal Server Error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-1", "description": "Internal Server Error.", "resolution": "Please contact Paychex API Developer Center Support." } ] } } } } } } }, "/workers/{workerId}/profileimage": { "get": { "tags": [ "Worker" ], "summary": "Worker Profile Image", "description": "Retrieve profile image for an \"Active\" or \"In-Progress\" worker.", "operationId": "getProfileImage", "parameters": [ { "name": "workerId", "in": "path", "description": "ID associated with desired worker.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProfileImageEntity" }, "examples": { "base64AndSuccessResponse": { "$ref": "#/components/examples/JSON_WORKER_EXAMPLES/value/WORKER_PROFILE_IMAGE_GET" } } } } }, "400": { "description": "Profile image does not exist for the worker provided. (API-7)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "examples": { "getProfileImageDoesNotExistResponse": { "$ref": "#/components/examples/JSON_WORKER_EXAMPLES/value/WORKER_PROFILE_IMAGE_DOES_NOT_EXIST_RESPONSE" } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-102", "description": "The client could not be authenticated due to missing or invalid client credentials.", "resolution": "Make sure that you are using the correct API key/Secret and that your application is enabled." } ] } } } }, "403": { "description": "User doesn't have access to this endpoint (API-2), Client has been end dated (API-68)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-2", "description": "Your application is not authorized to access the resource.", "resolution": "Please have your company administrator give your application access to the resource." } ] } } } }, "404": { "description": "Invalid resource ID (API-7)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-7", "description": "The resource or status is invalid. You may have an incorrect resource ID.", "resolution": "Send a valid resource in your request" } ] } } } }, "405": { "description": "Unsupported method type (API-59)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-59", "description": "The request method type is unsupported." } ] } } } }, "406": { "description": "Unsupported Accept header", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-75", "description": "Invalid vendor media type.", "resolution": "Please refer to our documentation and send the correct vendor media type" } ] } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "examples": { "profileImageGetServerErrorResponse": { "$ref": "#/components/examples/JSON_WORKER_EXAMPLES/value/WORKER_PROFILE_IMAGE_GET_SERVER_ERROR_RESPONSE" } } } } } } }, "post": { "tags": [ "Worker" ], "summary": "Worker Profile Image", "description": "Add a profile image to an \"Active\" or \"In-Progress\" worker. Profile images may be JPG, PNG, or GIF files no larger than 5MB.\n", "operationId": "addProfileImage", "parameters": [ { "name": "workerId", "in": "path", "description": "ID associated with desired worker.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "required": [ "image" ], "type": "object", "properties": { "image": { "type": "string", "format": "binary" } } } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddProfileImageResource" }, "examples": { "imageAddSuccessResponse": { "$ref": "#/components/examples/JSON_WORKER_EXAMPLES/value/WORKER_ADD_PROFILE_IMAGE_RESPONSE" } } } } }, "400": { "description": "Uploaded profile image is not an acceptable file type. (API-62), Uploaded profile image exceeds maximum allowed size. (API-4)\n", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "examples": { "imageAddFileTypeErrorResponse": { "$ref": "#/components/examples/JSON_WORKER_EXAMPLES/value/WORKER_ADD_PROFILE_IMAGE_FILE_TYPE_ERROR_RESPONSE" } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-102", "description": "The client could not be authenticated due to missing or invalid client credentials.", "resolution": "Make sure that you are using the correct API key/Secret and that your application is enabled." } ] } } } }, "403": { "description": "User doesn't have access to this endpoint (API-2), Client has been end dated (API-68)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-2", "description": "Your application is not authorized to access the resource.", "resolution": "Please have your company administrator give your application access to the resource." } ] } } } }, "404": { "description": "Invalid resource ID (API-7)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-7", "description": "The resource or status is invalid. You may have an incorrect resource ID.", "resolution": "Send a valid resource in your request" } ] } } } }, "405": { "description": "Unsupported method type (API-59)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-59", "description": "The request method type is unsupported." } ] } } } }, "406": { "description": "Unsupported Accept header", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-75", "description": "Invalid vendor media type.", "resolution": "Please refer to our documentation and send the correct vendor media type" } ] } } } }, "423": { "description": "Client locked (API-10)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-10", "description": "The client is locked because another user or process is updating it. Your changes cannot be saved while the client is locked.", "resolution": "Please try again later." } ] } } } }, "500": { "description": "Internal Server Error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "examples": { "serverErrorResponse": { "$ref": "#/components/examples/JSON_WORKER_EXAMPLES/value/WORKER_ADD_PROFILE_IMAGE_SERVER_ERROR_RESPONSE" }, "deleteProfileImageBeforeAddingResponse": { "$ref": "#/components/examples/JSON_WORKER_EXAMPLES/value/WORKER_ADD_PROFILE_IMAGE_DELETE_FIRST_RESPONSE" } } } } } } }, "delete": { "tags": [ "Worker" ], "summary": "Worker Profile Image", "description": "Remove the profile image from an \"Active\" or \"In-Progress\" worker.", "operationId": "deleteProfileImage", "parameters": [ { "name": "workerId", "in": "path", "description": "ID associated with desired worker.", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Profile image successfully deleted" }, "400": { "description": "Profile image does not exist for the worker provided. (API-7), Server error occurred deleting profile image. (API-66)\n", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "examples": { "profileImageDeleteDoesNotExistResponse": { "$ref": "#/components/examples/JSON_WORKER_EXAMPLES/value/WORKER_PROFILE_IMAGE_DOES_NOT_EXIST_RESPONSE" } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-102", "description": "The client could not be authenticated due to missing or invalid client credentials.", "resolution": "Make sure that you are using the correct API key/Secret and that your application is enabled." } ] } } } }, "403": { "description": "User doesn't have access to this endpoint (API-2), Client has been end dated (API-68)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-2", "description": "Your application is not authorized to access the resource.", "resolution": "Please have your company administrator give your application access to the resource." } ] } } } }, "404": { "description": "Invalid resource ID (API-7)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-7", "description": "The resource or status is invalid. You may have an incorrect resource ID.", "resolution": "Send a valid resource in your request" } ] } } } }, "405": { "description": "Unsupported method type (API-59)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-59", "description": "The request method type is unsupported." } ] } } } }, "406": { "description": "Unsupported Accept header", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-75", "description": "Invalid vendor media type.", "resolution": "Please refer to our documentation and send the correct vendor media type" } ] } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "examples": { "profileImageDeleteServerErrorResponse": { "$ref": "#/components/examples/JSON_WORKER_EXAMPLES/value/WORKER_PROFILE_IMAGE_DELETE_SERVER_ERROR_RESPONSE" } } } } } } } }, "/workers/{workerId}/statetaxes": { "get": { "tags": [ "Worker" ], "summary": "Worker State Tax", "description": "Information about worker's state tax allocation.", "operationId": "getWorkerStateTaxes", "parameters": [ { "name": "workerId", "in": "path", "description": "ID associated with desired worker.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StateTaxResponse" }, "examples": { "Success": { "$ref": "#/components/examples/JSON_WORKER_EXAMPLES/value/WORKER_STATE_TAXES" } } } } }, "403": { "description": "User doesn't have access to this endpoint (API-2), Client has been end dated (API-68)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-2", "description": "Your application is not authorized to access the resource.", "resolution": "Please have your company administrator give your application access to the resource." } ] } } } }, "404": { "description": "Invalid resource ID (API-7)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-7", "description": "The resource or status is invalid. You may have an incorrect resource ID.", "resolution": "Send a valid resource in your request" } ] } } } }, "500": { "description": "Internal Server Error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-1", "description": "Internal Server Error.", "resolution": "Please contact Paychex API Developer Center Support." } ] } } } } } }, "patch": { "tags": [ "Worker" ], "summary": "Worker State Tax", "description": "

Add and Replace existing state tax data for a given worker

", "externalDocs": { "description": "Full state tax documentation", "url": "https://developer.paychex.com/resources/webhooks" }, "operationId": "patchWorkerStateTaxes", "parameters": [ { "name": "workerId", "in": "path", "description": "ID associated with desired worker.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/StateTaxFieldsDescription" }, "examples": { "Add a new state tax": { "$ref": "#/components/examples/JSON_WORKER_EXAMPLES/value/WORKER_STATE_TAX" } } } }, "required": true }, "responses": { "200": { "description": "Successful PATCH operation", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/StateTaxResponse" }, "examples": { "Success": { "$ref": "#/components/examples/JSON_WORKER_EXAMPLES/value/WORKER_STATE_TAXES" } } } } }, "403": { "description": "User doesn't have access to this endpoint (API-2), Client has been end dated (API-68)", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-2", "description": "Your application is not authorized to access the resource.", "resolution": "Please have your company administrator give your application access to the resource." } ] } } } }, "404": { "description": "Invalid resource ID (API-7)", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-7", "description": "The resource or status is invalid. You may have an incorrect resource ID.", "resolution": "Send a valid resource in your request" } ] } } } }, "500": { "description": "Internal Server Error.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-1", "description": "Internal Server Error.", "resolution": "Please contact Paychex API Developer Center Support." } ] } } } } } } }, "/workers/{workerId}/status": { "get": { "tags": [ "Worker" ], "summary": "Worker Statuses", "description": "Retrieve the full list of worker statuses (past, present, and future). For each status the workerStatusId is the value of the corresponding company worker status ID. If no company worker status with a matching type/reason exists then workerStatusId is omitted. If multiple statuses share an effective date the order field will indicate the order in which they were posted.", "operationId": "getWorkerStatusHistory", "parameters": [ { "name": "workerId", "in": "path", "description": "ID associated with desired worker.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/vnd.paychex.company.workerstatuses.v1+json": { "schema": { "$ref": "#/components/schemas/Status1" }, "examples": { "workerStatusesResVMT": { "$ref": "#/components/examples/JSON_WORKER_EXAMPLES/value/WORKER_STATUSES_GET" } } }, "application/json": { "schema": { "$ref": "#/components/schemas/Status1" }, "examples": { "workerStatusesResDef": { "$ref": "#/components/examples/JSON_WORKER_EXAMPLES/value/WORKER_STATUSES_GET" } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-102", "description": "The client could not be authenticated due to missing or invalid client credentials.", "resolution": "Make sure that you are using the correct API key/Secret and that your application is enabled." } ] } } } }, "403": { "description": "User doesn't have access to this endpoint (API-2), Client has been end dated (API-68)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-2", "description": "Your application is not authorized to access the resource.", "resolution": "Please have your company administrator give your application access to the resource." } ] } } } }, "404": { "description": "Invalid resource ID (API-7)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-7", "description": "The resource or status is invalid. You may have an incorrect resource ID.", "resolution": "Send a valid resource in your request" } ] } } } }, "405": { "description": "Unsupported method type (API-59)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-59", "description": "The request method type is unsupported." } ] } } } }, "406": { "description": "Unsupported Accept header", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-75", "description": "Invalid vendor media type.", "resolution": "Please refer to our documentation and send the correct vendor media type" } ] } } } }, "500": { "description": "Internal Server Error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-1", "description": "Internal Server Error.", "resolution": "Please contact Paychex API Developer Center Support." } ] } } } } } } }, "/workers/{workerId}/timeoff": { "get": { "tags": [ "Worker" ], "summary": "Worker Time Off", "description": "Array of time off balance(s) a worker has for each policy type of time off, for that worker. NOTE: This data is only available if the client has the Time Off Accrual product (This is not related to the Flex Time product which has it is own dev portal for those APIs).", "operationId": "getWorkerTimeOff", "parameters": [ { "name": "workerId", "in": "path", "description": "The ID of the worker.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/vnd.paychex.worker.timeoff.v1+json": { "schema": { "$ref": "#/components/schemas/TimeOffResource" }, "examples": { "timeoffVMT": { "$ref": "#/components/examples/JSON_WORKER_EXAMPLES/value/WORKER_TIMEOFF_GET" } } }, "application/json": { "schema": { "$ref": "#/components/schemas/TimeOffResource" }, "examples": { "timeofDef": { "$ref": "#/components/examples/JSON_WORKER_EXAMPLES/value/WORKER_TIMEOFF_GET" } } } } }, "400": { "description": "The value for the one of the field is invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-40", "description": "The request isn't valid.", "resolution": "Please send the valid request" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-102", "description": "The client could not be authenticated due to missing or invalid client credentials.", "resolution": "Make sure that you are using the correct API key/Secret and that your application is enabled." } ] } } } }, "403": { "description": "User doesn't have access to this endpoint (API-2), Client has been end dated (API-68)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-2", "description": "Your application is not authorized to access the resource.", "resolution": "Please have your company administrator give your application access to the resource." } ] } } } }, "404": { "description": "Invalid resource ID (API-7)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-7", "description": "The resource or status is invalid. You may have an incorrect resource ID.", "resolution": "Send a valid resource in your request" } ] } } } }, "405": { "description": "Unsupported method type (API-59)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-59", "description": "The request method type is unsupported." } ] } } } }, "406": { "description": "Unsupported Accept header", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-75", "description": "Invalid vendor media type.", "resolution": "Please refer to our documentation and send the correct vendor media type" } ] } } } }, "500": { "description": "Internal Server Error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-1", "description": "Internal Server Error.", "resolution": "Please contact Paychex API Developer Center Support." } ] } } } }, "503": { "description": "service unavailable (API-66)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-66", "description": "The service is temporarily unavailable.", "resolution": "Please try again later." } ] } } } } } } }, "/checks": { "delete": { "tags": [ "Payroll" ], "summary": "Checks by Pay Period and User", "description": "Delete checks by pay period Id and user Id.", "operationId": "deleteChecksByPayPeriodIdUserId", "parameters": [ { "name": "payperiodid", "in": "query", "description": "ID associated with desired pay period.", "required": true, "schema": { "type": "string" } }, { "name": "deletebyuserid", "in": "query", "description": "Value for deletebyuserid parameter should be \"true\" ", "required": true, "schema": { "type": "boolean" } } ], "responses": { "204": { "description": "Successful operation" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-40", "description": "The request isn't valid.", "resolution": "Please send the valid request" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-102", "description": "The client could not be authenticated due to missing or invalid client credentials.", "resolution": "Make sure that you are using the correct API key/Secret and that your application is enabled." } ] } } } }, "403": { "description": "User doesn't have access to this endpoint (API-2), Client has been end dated (API-68)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-2", "description": "Your application is not authorized to access the resource.", "resolution": "Please have your company administrator give your application access to the resource." } ] } } } }, "404": { "description": "Invalid resource ID (API-7)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-7", "description": "The resource or status is invalid. You may have an incorrect resource ID.", "resolution": "Send a valid resource in your request" } ] } } } }, "405": { "description": "Unsupported method type (API-59)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-59", "description": "The request method type is unsupported." } ] } } } }, "406": { "description": "Unsupported Accept header", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-75", "description": "Invalid vendor media type.", "resolution": "Please refer to our documentation and send the correct vendor media type" } ] } } } }, "500": { "description": "Invalid/Missing ssoguid (API-9), Internal server error unexplained (API-1)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-1", "description": "Internal Server Error.", "resolution": "Please contact Paychex API Developer Center Support." } ] } } } }, "503": { "description": "Checks service unavailable (API-66)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-66", "description": "The service is temporarily unavailable.", "resolution": "Please try again later." } ] } } } } } } }, "/checks/{checkId}/checkcomponents": { "post": { "tags": [ "Payroll" ], "summary": "Pay Component to a check.", "description": "Add a new pay component on an individual unprocessed check.", "operationId": "addPayComponentForCheck", "parameters": [ { "name": "checkId", "in": "path", "description": "ID associated with desired check.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/vnd.paychex.payroll.check.checkcomponent.v1+json": { "schema": { "$ref": "#/components/schemas/PayComponentResource2" }, "examples": { "PayComponentResource vmt": { "$ref": "#/components/examples/JSON_CHECK_EXAMPLES/value/ADD_EARNING_TO_CHECK_REQUEST" } } }, "application/json": { "schema": { "$ref": "#/components/schemas/PayComponentResource2" }, "examples": { "PayComponentResource def": { "$ref": "#/components/examples/JSON_CHECK_EXAMPLES/value/ADD_EARNING_TO_CHECK_REQUEST" } } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "application/vnd.paychex.payroll.check.checkcomponent.v1+json": { "schema": { "$ref": "#/components/schemas/CheckResource2" }, "examples": { "CheckResource vmt": { "$ref": "#/components/examples/JSON_CHECK_EXAMPLES/value/ADD_EARNING_TO_CHECK_RESPONSE" } } }, "application/json": { "schema": { "$ref": "#/components/schemas/CheckResource2" }, "examples": { "CheckResource def": { "$ref": "#/components/examples/JSON_CHECK_EXAMPLES/value/ADD_EARNING_TO_CHECK_RESPONSE" } } } } }, "400": { "description": "The request cannot be performed since the check is in a state which does not allow this action(API-19)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-40", "description": "The request isn't valid.", "resolution": "Please send the valid request" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-102", "description": "The client could not be authenticated due to missing or invalid client credentials.", "resolution": "Make sure that you are using the correct API key/Secret and that your application is enabled." } ] } } } }, "403": { "description": "User doesn't have access to this endpoint (API-2), Client has been end dated (API-68)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-2", "description": "Your application is not authorized to access the resource.", "resolution": "Please have your company administrator give your application access to the resource." } ] } } } }, "404": { "description": "Invalid resource ID (API-7)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-7", "description": "The resource or status is invalid. You may have an incorrect resource ID.", "resolution": "Send a valid resource in your request" } ] } } } }, "405": { "description": "Unsupported method type (API-59)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-59", "description": "The request method type is unsupported." } ] } } } }, "406": { "description": "Unsupported Accept header", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-75", "description": "Invalid vendor media type.", "resolution": "Please refer to our documentation and send the correct vendor media type" } ] } } } }, "500": { "description": "Invalid/Missing ssoguid (API-9), Internal server error unexplained (API-1)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-1", "description": "Internal Server Error.", "resolution": "Please contact Paychex API Developer Center Support." } ] } } } }, "503": { "description": "service unavailable (API-66)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-66", "description": "The service is temporarily unavailable.", "resolution": "Please try again later." } ] } } } } } } }, "/checks/{checkId}/checkcomponents/{checkComponentId}": { "delete": { "tags": [ "Payroll" ], "summary": "Pay Component of a check", "description": "Remove a single pay component on an individual unprocessed check.", "operationId": "deleteCheckEarningById", "parameters": [ { "name": "checkId", "in": "path", "description": "ID associated with desired check.", "required": true, "schema": { "type": "string" } }, { "name": "checkComponentId", "in": "path", "description": "ID associated with an Earning of this check", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "successful operation" }, "400": { "description": "The request cannot be performed since the check is in a state which does not allow this action(API-19)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-40", "description": "The request isn't valid.", "resolution": "Please send the valid request" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-102", "description": "The client could not be authenticated due to missing or invalid client credentials.", "resolution": "Make sure that you are using the correct API key/Secret and that your application is enabled." } ] } } } }, "403": { "description": "User doesn't have access to this endpoint (API-2), Client has been end dated (API-68)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-2", "description": "Your application is not authorized to access the resource.", "resolution": "Please have your company administrator give your application access to the resource." } ] } } } }, "404": { "description": "Invalid resource ID (API-7)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-7", "description": "The resource or status is invalid. You may have an incorrect resource ID.", "resolution": "Send a valid resource in your request" } ] } } } }, "405": { "description": "Unsupported method type (API-59)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-59", "description": "The request method type is unsupported." } ] } } } }, "406": { "description": "Unsupported Accept header", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-75", "description": "Invalid vendor media type.", "resolution": "Please refer to our documentation and send the correct vendor media type" } ] } } } }, "500": { "description": "Invalid/Missing ssoguid (API-9), Internal server error unexplained (API-1)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-1", "description": "Internal Server Error.", "resolution": "Please contact Paychex API Developer Center Support." } ] } } } } } }, "patch": { "tags": [ "Payroll" ], "summary": "Pay Component of a Check", "description": " Update a single pay component on an individual unprocessed check.", "operationId": "patchCheckComponentById", "parameters": [ { "name": "checkId", "in": "path", "description": "ID associated with desired check.", "required": true, "schema": { "type": "string" } }, { "name": "checkComponentId", "in": "path", "description": "ID associated with an Earning of this check", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/vnd.paychex.payroll.check.checkcomponent.v1+json": { "schema": { "$ref": "#/components/schemas/PayComponentResource2" }, "examples": { "PayComponent vmt": { "$ref": "#/components/examples/JSON_CHECK_EXAMPLES/value/UPDATE_EARNING_TO_CHECK_REQUEST" } } }, "application/json": { "schema": { "$ref": "#/components/schemas/PayComponentResource2" }, "examples": { "PayComponent def": { "$ref": "#/components/examples/JSON_CHECK_EXAMPLES/value/UPDATE_EARNING_TO_CHECK_REQUEST" } } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "application/vnd.paychex.payroll.check.checkcomponent.v1+json": { "schema": { "$ref": "#/components/schemas/PayComponentResource2" }, "examples": { "PayComponentVMT": { "$ref": "#/components/examples/JSON_CHECK_EXAMPLES/value/UPDATE_EARNING_TO_CHECK_RESPONSE" } } }, "application/json": { "schema": { "$ref": "#/components/schemas/PayComponentResource2" }, "examples": { "PayComponentDef": { "$ref": "#/components/examples/JSON_CHECK_EXAMPLES/value/UPDATE_EARNING_TO_CHECK_RESPONSE" } } } } }, "400": { "description": "The request cannot be performed since the worker is in a state which does not allow this action(API-19)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-40", "description": "The request isn't valid.", "resolution": "Please send the valid request" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-102", "description": "The client could not be authenticated due to missing or invalid client credentials.", "resolution": "Make sure that you are using the correct API key/Secret and that your application is enabled." } ] } } } }, "403": { "description": "User doesn't have access to this endpoint (API-2), Client has been end dated (API-68)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-2", "description": "Your application is not authorized to access the resource.", "resolution": "Please have your company administrator give your application access to the resource." } ] } } } }, "404": { "description": "Invalid resource ID (API-7)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-7", "description": "The resource or status is invalid. You may have an incorrect resource ID.", "resolution": "Send a valid resource in your request" } ] } } } }, "405": { "description": "Unsupported method type (API-59)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-59", "description": "The request method type is unsupported." } ] } } } }, "406": { "description": "Unsupported Accept header", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-75", "description": "Invalid vendor media type.", "resolution": "Please refer to our documentation and send the correct vendor media type" } ] } } } }, "500": { "description": "Invalid/Missing ssoguid (API-9), Internal server error unexplained (API-1)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-1", "description": "Internal Server Error.", "resolution": "Please contact Paychex API Developer Center Support." } ] } } } }, "503": { "description": "service unavailable (API-66)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-66", "description": "The service is temporarily unavailable.", "resolution": "Please try again later." } ] } } } } } } }, "/management/domains": { "get": { "tags": [ "Webhooks" ], "summary": "Get Webhook domains", "description": "Will return a list of available domains depending on application type.", "operationId": "domains", "responses": { "200": { "description": "Domains successfully returned.", "content": { "application/json": { "schema": { "type": "string" }, "examples": { "CLIENT_DOMAINS": { "$ref": "#/components/examples/WEBHOOK_JSONEXAMPLES/value/CLIENT_DOMAINS" }, "PARTNER_DOMAINS": { "$ref": "#/components/examples/WEBHOOK_JSONEXAMPLES/value/PARTNER_DOMAINS" } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-102", "description": "The client could not be authenticated due to missing or invalid client credentials.", "resolution": "Make sure that you are using the correct API key/Secret and that your application is enabled." } ] } } } }, "403": { "description": "User doesn't have access to this endpoint (API-2), ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-2", "description": "Your application is not authorized to access the resource.", "resolution": "Please have your company administrator give your application access to the resource." } ] } } } }, "405": { "description": "Unsupported method type (API-59)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-59", "description": "The request method type is unsupported." } ] } } } }, "406": { "description": "Unsupported Accept header", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-75", "description": "Invalid vendor media type.", "resolution": "Please refer to our documentation and send the correct vendor media type" } ] } } } }, "500": { "description": "Internal Server Error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-1", "description": "Internal Server Error.", "resolution": "Please contact Paychex API Developer Center Support." } ] } } } } } } }, "/management/hooks": { "get": { "tags": [ "Webhooks" ], "summary": "List Webhooks", "description": "List all the webhooks setup for the calling application", "operationId": "getAllHooks", "responses": { "200": { "description": "Webhooks successfully returned.", "content": { "application/json": { "examples": { "webhooks": { "$ref": "#/components/examples/WEBHOOK_JSONEXAMPLES/value/WEBHOOKS_GET" } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-102", "description": "The client could not be authenticated due to missing or invalid client credentials.", "resolution": "Make sure that you are using the correct API key/Secret and that your application is enabled." } ] } } } }, "403": { "description": "User does not have access to this resource (API-2)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-2", "description": "Your application is not authorized to access the resource.", "resolution": "Please have your company administrator give your application access to the resource." } ] } } } }, "404": { "description": "Invalid resource ID (API-7)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-7", "description": "The resource or status is invalid. You may have an incorrect resource ID.", "resolution": "Send a valid resource in your request" } ] } } } }, "405": { "description": "Unsupported method type (API-59)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-59", "description": "The request method type is unsupported." } ] } } } }, "500": { "description": "Internal Server Error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-1", "description": "Internal Server Error.", "resolution": "Please contact Paychex API Developer Center Support." } ] } } } } } }, "post": { "tags": [ "Webhooks" ], "summary": "Add Webhook", "description": "

Add a webhook for the calling application.

When registering a webhook, you will need to provide your own URI in the request body (see our full webhook documention here on how to configure your URI). The newly registered webhook will send notifications to this endpoint as JSON payloads which vary by domain. Please configure your endpoint to accept the relevant payloads. To see an example payload for each domain, please refer to the \"Callbacks\" tab.

", "externalDocs": { "description": "Full webhook documention", "url": "https://developer.paychex.com/resources/webhooks" }, "operationId": "addHook", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookRequest" }, "examples": { "NO_AUTH": { "$ref": "#/components/examples/WEBHOOK_JSONEXAMPLES/value/WEBHOOK_ADD_NO_AUTH" }, "BASIC_AUTH": { "$ref": "#/components/examples/WEBHOOK_JSONEXAMPLES/value/WEBHOOK_ADD_BASIC_AUTH" }, "APIKEY": { "$ref": "#/components/examples/WEBHOOK_JSONEXAMPLES/value/WEBHOOK_ADD_APIKEY" }, "OAUTH2_BASIC": { "$ref": "#/components/examples/WEBHOOK_JSONEXAMPLES/value/WEBHOOK_ADD_OAUTH2_BASIC" }, "OAUTH2": { "$ref": "#/components/examples/WEBHOOK_JSONEXAMPLES/value/WEBHOOK_ADD_OAUTH2" } } } }, "required": true }, "responses": { "201": { "description": "Webhook successfully created.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookResponse" }, "examples": { "webhook": { "$ref": "#/components/examples/WEBHOOK_JSONEXAMPLES/value/WEBHOOK_ADD_RESPONSE" } } } } }, "400": { "description": "Please add the required attribute. (API-46), Please provide a hookid without special characters. (API-22)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-22", "description": "Invalid required value", "resolution": "Please provide the valid value." } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-102", "description": "The client could not be authenticated due to missing or invalid client credentials.", "resolution": "Make sure that you are using the correct API key/Secret and that your application is enabled." } ] } } } }, "403": { "description": "User does not have access to this resource. (API-2)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-2", "description": "Your application is not authorized to access the resource.", "resolution": "Please have your company administrator give your application access to the resource." } ] } } } }, "404": { "description": "Invalid resource ID (API-7)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-7", "description": "The resource or status is invalid. You may have an incorrect resource ID.", "resolution": "Send a valid resource in your request" } ] } } } }, "405": { "description": "Unsupported method type (API-59)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-59", "description": "The request method type is unsupported." } ] } } } }, "500": { "description": "Internal Server Error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-1", "description": "Internal Server Error.", "resolution": "Please contact Paychex API Developer Center Support." } ] } } } } }, "callbacks": { "Example Notification Callback": { "https://789mw789x4.execute-api.us-east-2.amazonaws.com/messages": { "post": { "summary": "Example Notification Callback", "description": "To see an example JSON payload for any given domain, please select the domain from the \"Examples\" dropdown in the \"Responses\" section. Please ensure your endpoint can accept this JSON if you register a webhook with the selected domain.", "requestBody": { "description": "JSON payload for selected domain", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "WRKR_EMPL": { "$ref": "#/components/examples/WEBHOOK_JSONEXAMPLES/value/WEBHOOK_NOTIFICATION_WRKR_EMPL" }, "WRKR_TAX": { "$ref": "#/components/examples/WEBHOOK_JSONEXAMPLES/value/WEBHOOK_NOTIFICATION_WRKR_TAX" }, "WRKR_CMP": { "$ref": "#/components/examples/WEBHOOK_JSONEXAMPLES/value/WEBHOOK_NOTIFICATION_WRKR_CMP" }, "WRKR_ASGN": { "$ref": "#/components/examples/WEBHOOK_JSONEXAMPLES/value/WEBHOOK_NOTIFICATION_WRKR_ASGN" }, "WRKR_DEM": { "$ref": "#/components/examples/WEBHOOK_JSONEXAMPLES/value/WEBHOOK_NOTIFICATION_WRKR_DEM" }, "WRKR_ADD": { "$ref": "#/components/examples/WEBHOOK_JSONEXAMPLES/value/WEBHOOK_NOTIFICATION_WRKR_ADD" }, "CLT_PAY_COMP": { "$ref": "#/components/examples/WEBHOOK_JSONEXAMPLES/value/WEBHOOK_NOTIFICATION_CLT_PAY_COMP" }, "CLT_PYRN": { "$ref": "#/components/examples/WEBHOOK_JSONEXAMPLES/value/WEBHOOK_NOTIFICATION_CLT_PYRN" }, "CLT_DEM": { "$ref": "#/components/examples/WEBHOOK_JSONEXAMPLES/value/WEBHOOK_NOTIFICATION_CLT_DEM" }, "CLT_ORG": { "$ref": "#/components/examples/WEBHOOK_JSONEXAMPLES/value/WEBHOOK_NOTIFICATION_CLT_ORG" }, "CLT_ACCESS": { "$ref": "#/components/examples/WEBHOOK_JSONEXAMPLES/value/WEBHOOK_NOTIFICATION_CLT_ACCESS" }, "CLT_LINEAGE": { "$ref": "#/components/examples/WEBHOOK_JSONEXAMPLES/value/WEBHOOK_NOTIFICATION_CLT_LINEAGE" }, "PAY_PERIOD": { "$ref": "#/components/examples/WEBHOOK_JSONEXAMPLES/value/WEBHOOK_NOTIFICATION_PAY_PERIOD" }, "PAYX_ALERT": { "$ref": "#/components/examples/WEBHOOK_JSONEXAMPLES/value/WEBHOOK_NOTIFICATION_PAYX_ALERT" } } } } }, "responses": { "2XX": { "description": "Callback successfully processed and no retries will be performed" }, "4XX": { "description": "Callback processing failed and retries will be performed" }, "5XX": { "description": "Callback processing failed and retries will be performed" } } } } } } } }, "/management/hooks/{hookId}": { "get": { "tags": [ "Webhooks" ], "summary": "Webhook", "description": "Get a specific hook for the calling application by id", "operationId": "getHook", "parameters": [ { "name": "hookId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Webhook successfully returned.", "content": { "application/json": { "examples": { "webhook": { "$ref": "#/components/examples/WEBHOOK_JSONEXAMPLES/value/WEBHOOK_GET" } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-102", "description": "The client could not be authenticated due to missing or invalid client credentials.", "resolution": "Make sure that you are using the correct API key/Secret and that your application is enabled." } ] } } } }, "404": { "description": "Invalid resource ID (API-7)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-7", "description": "The resource or status is invalid. You may have an incorrect resource ID.", "resolution": "Send a valid resource in your request" } ] } } } }, "405": { "description": "Unsupported method type (API-59)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-59", "description": "The request method type is unsupported." } ] } } } }, "500": { "description": "Internal Server Error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-1", "description": "Internal Server Error.", "resolution": "Please contact Paychex API Developer Center Support." } ] } } } } } }, "delete": { "tags": [ "Webhooks" ], "summary": "Delete Webhook", "description": "Delete a specific hook for the calling application by id", "operationId": "deleteHook", "parameters": [ { "name": "hookId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Worker successfully deleted", "content": { "*/*": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-102", "description": "The client could not be authenticated due to missing or invalid client credentials.", "resolution": "Make sure that you are using the correct API key/Secret and that your application is enabled." } ] } } } }, "404": { "description": "Invalid resource ID (API-7)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-7", "description": "The resource or status is invalid. You may have an incorrect resource ID.", "resolution": "Send a valid resource in your request" } ] } } } }, "405": { "description": "Unsupported method type (API-59)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-59", "description": "The request method type is unsupported." } ] } } } }, "500": { "description": "Internal Server Error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-1", "description": "Internal Server Error.", "resolution": "Please contact Paychex API Developer Center Support." } ] } } } } } } }, "/management/requestclientaccess": { "post": { "tags": [ "Management" ], "summary": "Request Client Access", "description": "(For partnerships only) Link Paychex clients to a 3rd party partner application", "operationId": "requestAccess", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PartnerLinkRequestResource" } } }, "required": true }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeepUrlResponseResource" }, "examples": { "requestAccess": { "$ref": "#/components/examples/WEBHOOK_JSONEXAMPLES/value/REQUEST_ACCESS" } } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "type": "string" }, "examples": { "INVALID_DISPLAY_ID": { "description": "INVALID_DISPLAY_ID", "value": { "errors": [ { "code": "API-22", "description": "The value for the display id is invalid.", "resolution": "Please provide a valid value." } ] } }, "CONNECTION_ALREADY_EXISTS": { "$ref": "#/components/examples/WEBHOOK_JSONEXAMPLES/value/CONNECTION_ALREADY_EXISTS" } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-103", "description": "Bearer token is expired or invalid.", "resolution": "Use the authorization service to generate a new token." } ] } } } }, "405": { "description": "Unsupported method type", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-59", "description": "The request method type is unsupported." } ] } } } }, "500": { "description": "Internal Server Error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" }, "example": { "errors": [ { "code": "API-1", "description": "Internal Server Error.", "resolution": "Please contact Paychex API Developer Center Support." } ] } } } } } } } }, "components": { "schemas": { "Authentication": { "type": "object", "properties": { "access_token": { "type": "string", "description": "The token which will be used for making future calls.", "example": "99f9c30a-8134-4a30-a789-7c7665add41e" }, "expires_in": { "type": "string", "description": "Number of seconds remaining before the token expires.", "example": 600 }, "scope": { "type": "string", "description": "This will always return 'oob' (out of band) based on OAuth configuration.", "example": "oob" }, "token_type": { "type": "string", "description": "This will always return 'Bearer' based on OAuth configuration.", "example": "Bearer" } }, "description": "The Authentication Response" }, "CommunicationResource": { "type": "object", "properties": { "communicationId": { "type": "string", "description": "The unique ID associated with communication ", "example": "00Z5V9BTINBT97UMERCA" }, "type": { "type": "string", "description": "A set of communication types classifying an instruction that the customer, requester, or subject must comply with in order for the screening to go forward. NOTE: PHONE and EMAIL type supports BUSINESS and PERSONAL usage type only.MOBILE_PHONE, FAX and PAGER supports BUSINESS usage type only.This data field cannot be PATCHED.", "example": "STREET_ADDRESS", "enum": [ "STREET_ADDRESS", "PO_BOX_ADDRESS", "PHONE", "MOBILE_PHONE", "FAX", "EMAIL", "PAGER" ] }, "usageType": { "type": "string", "description": "A code classifying a designated use associated with a contact method. For example, whether a telephone or email address is one for business communications or one primarily for personal use.This data field cannot be PATCHED.", "example": "BUSINESS", "enum": [ "PERSONAL", "BUSINESS", "HOME", "WORK", "LOCATION_STREET_ADDRESS", "MAILING_ADDRESS" ] }, "dialCountry": { "type": "string", "description": "The country dialing code for a communication number." }, "dialArea": { "type": "string", "description": "The area dialing code for a communication number." }, "dialNumber": { "type": "string", "description": "The communication number, not including country dialing or area dialing codes." }, "dialExtension": { "type": "string", "description": "The extension of the associated communication number." }, "uri": { "type": "string", "description": "The mailto address as specified in RFC2368 ." }, "streetLineOne": { "type": "string", "description": "The street address line one", "example": "Mike St" }, "streetLineTwo": { "type": "string", "description": "The street address line two", "example": "Sulley Ln" }, "postOfficeBox": { "type": "string", "description": "The postal office box. This data field cannot be PATCHED." }, "city": { "type": "string", "description": "The city name", "example": "ANAHEIM" }, "postalCode": { "type": "string", "description": "The zip-code", "example": "92802" }, "postalCodeExtension": { "type": "string", "description": "The zip-code extension" }, "countrySubdivisionCode": { "type": "string", "description": "The state code (ISO 3166 subdivision code)", "example": "CA" }, "countryCode": { "type": "string", "description": "The country code (ISO 3166 alpha-2)", "example": "US" } }, "description": "Array of properties which specify communication information associated with an entity." }, "JobTitleResource": { "type": "object", "properties": { "jobTitleId": { "type": "string", "description": "The unique identifier associated with this job titles representation.", "example": "00DWS906IMW2JSH8AQJ8" }, "title": { "type": "string", "description": "The name of the title.", "example": "Archaeologist" }, "startDate": { "type": "string", "description": "Date when this job is available to be assigned to a worker.", "format": "date-time", "example": "2010-01-01T00:00:00Z" }, "endDate": { "type": "string", "description": "Date when this job is no longer available to be assigned to a worker.", "format": "date-time", "example": "2016-12-31T00:00:00Z" }, "links": { "type": "array", "items": { "$ref": "#/components/schemas/Link" } } }, "description": "The state representation of allowed worker job titles configured for the company." }, "LegalIdResource": { "type": "object", "properties": { "legalIdType": { "type": "string", "description": "A value that identifies the type of taxpayer identification number provided. SSN: Social Security Number - 9 digit number , FEIN: Federal Employer Identification Number (EIN)", "enum": [ "SSN", "FEIN" ] }, "legalIdValue": { "type": "string", "description": "The federal level taxpayer id number assigned to a business", "example": "995886885" } }, "description": "The workers legal tax identification information. This data field cannot be PATCHED for ACTIVE workers." }, "Link": { "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" } } }, "NameResource": { "type": "object", "properties": { "familyName": { "type": "string", "description": "The family or last name of a worker.", "example": "JONES" }, "middleName": { "type": "string", "description": "A subordinate given name, or initial representing that name, of a worker.
NOTE: More than one char is not allowed and returns an error.
A full middle name can be added directly via Paychex Flex only at this time.", "example": "H" }, "givenName": { "type": "string", "description": "The given or first name of a worker. For an independent contractor that is a company rather than an individual, the name of the company.", "example": "INDIANA" }, "preferredName": { "type": "string", "description": "The first name that the worker prefers to go by", "example": "Indi" }, "preferredLastName": { "type": "string", "description": "The last name that the worker prefers to go by", "example": "Jan" }, "pronoun": { "type": "string", "description": "The pronoun that the worker prefers to go by. This data field cannot be POSTED.", "example": "He/him/his" }, "qualificationAffixCode": { "type": "string", "description": "A qualifier to the name of a worker, indicating generation.", "example": "Jr" }, "titleAffixCode": { "type": "string", "description": "A personal title that comes before an individual's name in a formal address (such as Dr., Prof., Rev., Mr.). ", "example": "Dr." } }, "description": "Data elements of a workers name." }, "OrganizationResource": { "type": "object", "properties": { "organizationId": { "type": "string", "description": "The unique identifier associated with this organizations representation.", "example": "970000055981384" }, "name": { "type": "string", "description": "The name of the organization.", "example": "2 Division B" }, "number": { "type": "string", "description": "The number assigned to the organization.", "example": "2" }, "level": { "type": "string", "description": "The level number within the organizational structures hierarchy.", "example": "Level 2" }, "links": { "type": "array", "readOnly": true, "items": { "$ref": "#/components/schemas/Link" } } }, "description": "The state representation of Organizations within a company." }, "Status": { "type": "object", "properties": { "workerStatusId": { "type": "string", "description": "The unique identifier associated with this status representation.", "example": "00DWS906IMW2JSH8AQJ9" }, "statusType": { "type": "string", "description": "The workers current status.", "enum": [ "ACTIVE", "INACTIVE", "TERMINATED", "PENDING", "IN_PROGRESS" ] }, "statusReason": { "type": "string", "description": "The detailed reason of the workers current status.", "example": "HIRED" } }, "description": "The workers employment status information. This data field cannot be POSTED or PATCHED for an IN_PROGRESS worker." }, "SupervisorResource": { "type": "object", "properties": { "workerId": { "type": "string", "description": "The supervisor Id", "example": "00H2A1IUJ4IPERJ589YE" }, "name": { "$ref": "#/components/schemas/NameResource" } }, "description": "The workers supervisor information. Supervisor cannot be a TERMINATED or IN_PROGRESS worker." }, "WorkerResource": { "type": "object", "properties": { "workerId": { "type": "string", "description": "The unique identifier associated with this worker representation.", "example": "00Z5V9BTIHRQF2CF7BTH" }, "employeeId": { "type": "string", "description": "The workers employee identification information.", "example": "3052" }, "workerType": { "type": "string", "description": "The type of worker. This data field cannot be PATCHED.NOTE: An IN_PROGRESS worker cannot be POSTED with a value of CONTRACTOR.", "enum": [ "EMPLOYEE", "CONTRACTOR", "INDEPENDENT_CONTRACTOR" ] }, "employmentType": { "type": "string", "description": "The type of employment for the worker.", "example": "NON_EXEMPT", "enum": [ "FULL_TIME", "PART_TIME" ] }, "exemptionType": { "type": "string", "description": "The Overtime classification of the worker.This data field cannot be PATCHED for ACTIVE workers.", "enum": [ "EXEMPT", "NON_EXEMPT" ] }, "birthDate": { "type": "string", "description": "The workers date of birth. It cannot be greater than today's date.", "format": "date-time" }, "sex": { "type": "string", "example": "MALE", "enum": [ "MALE", "FEMALE", "NOT_SPECIFIED" ] }, "ethnicityCode": { "type": "string", "description": "Disclaimer:This parameter is not visible in Flex for the client. This data field cannot be PATCHED for ACTIVE workers.", "enum": [ "(blank)", "HISPANIC_OR_LATINO", "WHITE_NOT_OF_HISPANIC_ORIGIN", "BLACK_OR_AFRICAN_AMERICAN", "NATIVE_HAWAIIAN_OR_OTHER_PACIFIC_ISLAND", "ASIAN", "AMERICAN_INDIAN_OR_ALASKAN_NATIVE", "TWO_OR_MORE_RACES", "PREFER_NOT_TO_ANSWER" ] }, "hireDate": { "type": "string", "description": "The date which the worker was hired. It cannot be PATCHED for ACTIVE workers.", "format": "date-time", "example": "2015-06-15T00:00:00Z" }, "clockId": { "type": "string", "description": "The clock ID of the worker that can be an identification for other systems.", "example": "4321" }, "name": { "$ref": "#/components/schemas/NameResource" }, "seniorityDate": { "type": "string", "description": "The workers seniority date. This data field cannot be POSTED or PATCHED.", "format": "date-time", "example": "2020-05-20T00:00:00Z" }, "profileImageURL": { "type": "string", "description": "The workers profile image url. This data field cannot be POSTED or PATCHED.", "example": "https://cdn.url/flexworkerphotos/wrkr0ad1b60a-45cc-4bbb-b5gc-299a832ce111.jpg" }, "legalId": { "$ref": "#/components/schemas/LegalIdResource" }, "laborAssignmentId": { "type": "string", "description": "The workers home labor assignment.", "example": "970001557863345" }, "jobId": { "type": "string", "description": "The workers home job.", "example": "970001557916904" }, "locationId": { "type": "string", "description": "The workers location. When POSTING or PATCHING this field the organization must also be present.", "example": "970001701620675" }, "job": { "$ref": "#/components/schemas/JobTitleResource" }, "organization": { "$ref": "#/components/schemas/OrganizationResource" }, "supervisor": { "$ref": "#/components/schemas/SupervisorResource" }, "currentStatus": { "$ref": "#/components/schemas/Status" }, "communications": { "type": "array", "description": "Worker Communications. This data field cannot be updated for worker endpoint.", "items": { "$ref": "#/components/schemas/CommunicationResource" } }, "workerCorrelationId": { "type": "string", "description": "Id that you define which is used for error handling/responses.This data field is used while POSTING multiple IN_PROGRESS workers" } } }, "ErrorResource": { "type": "object", "properties": { "code": { "type": "string", "description": "Error code" }, "description": { "type": "string", "description": "Description of error" }, "resolution": { "type": "string", "description": "Resolution of error" } }, "description": "Representation of error" }, "PurchaseResource": { "type": "object", "properties": { "transactionId": { "type": "string" }, "type": { "type": "string" }, "count": { "type": "string" }, "price": { "type": "number" }, "links": { "type": "array", "items": { "$ref": "#/components/schemas/Link" } } } }, "PayComponentResource": { "type": "object", "properties": { "componentId": { "type": "string", "description": "The unique identifier used to identify a pay component.", "example": "970000076689381" }, "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.", "example": "1" }, "name": { "type": "string", "description": "Name given to the pay component.", "example": "Hourly" }, "classificationType": { "type": "string", "description": "The category that this component falls into.", "example": "Regular" }, "description": { "type": "string", "description": "The description of the Pay Component.", "example": "Use for regular pay." }, "effectOnPay": { "type": "string", "description": "The effect that the pay component will have on the check amount.", "example": "ADDITION", "enum": [ "ADDITION", "ADDITION_WITH_IN_OUT", "EMPLOYER_INFORMATIONAL", "REDUCTION" ] }, "startDate": { "type": "string", "description": "The date that the pay component is able to be applied on a check.", "format": "date-time", "example": "2016-01-01T00:00:00Z" }, "endDate": { "type": "string", "description": "The date that the pay component is not available to be applied on a check moving forward.", "format": "date-time" }, "appliesToWorkerTypes": { "type": "array", "description": "List of workerTypes that the component can be applied to.", "items": { "type": "string", "description": "The type of worker. This data field cannot be PATCHED.NOTE: An IN_PROGRESS worker cannot be POSTED with a value of CONTRACTOR.", "enum": [ "EMPLOYEE", "CONTRACTOR", "INDEPENDENT_CONTRACTOR" ] } }, "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.", "example": "SCHEDULED_AMOUNT" }, "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.", "example": "7.25" }, "payHours": { "type": "string", "description": "The number of hours that will be applied for this component. Used in conjunction with rate.", "example": "4" }, "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": { "$ref": "#/components/schemas/OrganizationResource" }, "lineDate": { "type": "string", "description": "This is used optionally for specifying a date that the pay component was generated on.", "format": "date-time" }, "memoed": { "type": "boolean", "description": "This is used optionally for memoing the payHours or payUnits so that they are informational when using a payAmount.", "example": false }, "links": { "type": "array", "items": { "$ref": "#/components/schemas/Link" } } }, "description": "The earnings to apply to the check. Each earning needs to define as one of the following allowed values" }, "CalcMethod": { "type": "object", "properties": { "ccmId": { "type": "integer", "format": "int64" }, "defaultTypeId": { "type": "integer", "format": "int64" }, "defaultType": { "type": "string" }, "calcTypeId": { "type": "integer", "format": "int64" }, "calculationType": { "type": "string" }, "calcType": { "type": "string" }, "calcAdjType": { "type": "string" }, "isIncludeMemoHours": { "type": "boolean" }, "isTieredByPct": { "type": "boolean" }, "isMatchCalcAsPct": { "type": "boolean" }, "calcAdjTypeId": { "type": "integer", "format": "int64" }, "payRateOvrdTypeId": { "type": "integer", "format": "int64" }, "payRateOvrdType": { "type": "string" } } }, "ClientPayComponentFrequency": { "type": "object", "properties": { "cfId": { "type": "integer", "format": "int64" }, "frequencyOptionId": { "type": "integer", "format": "int64" }, "freqTypeId": { "type": "integer", "format": "int64" }, "frequencyType": { "type": "string" }, "freqType": { "type": "string" }, "payFreqId": { "type": "integer", "format": "int64" }, "payFrequency": { "type": "string" }, "payFreq": { "type": "string" }, "firstPeriodOccurrenceId": { "type": "integer", "format": "int64" }, "firstPeriodOccurrenceType": { "type": "string" }, "firstFrequencyPeriod": { "type": "string" }, "firstPeriodOccurrence": { "type": "string" }, "secondPeriodOccurrenceId": { "type": "integer", "format": "int64" }, "secondPeriodOccurrenceType": { "type": "string" }, "secondFrequencyPeriod": { "type": "string" }, "secondPeriodOccurrence": { "type": "string" }, "intervalValue": { "type": "integer", "format": "int32" }, "firstCheckRuleId": { "type": "integer", "format": "int64" }, "firstCheckRuleType": { "type": "string" }, "firstCheckRule": { "type": "string" }, "firstCheckOnly": { "type": "boolean" } } }, "ClientPayComponentOptions": { "type": "object", "properties": { "optValueId": { "type": "integer", "format": "int64" }, "optValueName": { "type": "string" }, "optValueTypeId": { "type": "integer", "format": "int64" }, "optValue": { "type": "string" } } }, "ClientPayComponentResponse": { "type": "object", "properties": { "payComponent": { "$ref": "#/components/schemas/Pay Component" }, "frequencyData": { "$ref": "#/components/schemas/ClientPayComponentFrequency" }, "calcMethods": { "type": "array", "items": { "$ref": "#/components/schemas/CalcMethod" } }, "workerTypes": { "type": "array", "items": { "$ref": "#/components/schemas/ClientPayComponentWorkerTypes" } }, "options": { "type": "array", "items": { "$ref": "#/components/schemas/ClientPayComponentOptions" } } } }, "ClientPayComponentWorkerTypes": { "type": "object", "properties": { "emplTypeId": { "type": "integer", "format": "int64" }, "emplType": { "type": "string" } } }, "Pay Component": { "type": "object", "properties": { "cltpcId": { "type": "integer", "format": "int64" }, "offeringId": { "type": "string" }, "pcId": { "type": "integer", "format": "int64" }, "customName": { "type": "string" }, "reportCode": { "type": "string" }, "isPaychexAdministered": { "type": "boolean" }, "deductionPriority": { "type": "integer", "format": "int32" }, "refId": { "type": "integer", "format": "int64" }, "payCompName": { "type": "string" }, "payCpntTypeId": { "type": "integer", "format": "int64" }, "payCpntType": { "type": "string" }, "classTypeId": { "type": "integer", "format": "int64" }, "classType": { "type": "string" }, "payFreqId": { "type": "integer", "format": "int64" }, "payFreq": { "type": "string" }, "freqTypeId": { "type": "integer", "format": "int64" }, "freqType": { "type": "string" }, "firstCheckRuleId": { "type": "integer", "format": "int64" }, "firstCheckRule": { "type": "string" }, "isBankRequired": { "type": "boolean" }, "collectArrearsOnShortfall": { "type": "boolean" }, "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" } }, "description": "A pay component defined for a client" }, "JobResource": { "type": "object", "properties": { "jobId": { "type": "string", "description": "The unique identifier associated with this job.", "readOnly": true, "example": "970001557916902" }, "jobCorrelationId": { "type": "string", "description": "Id that you define which is used for error handling/responses." }, "jobName": { "type": "string", "description": "The name of the job.", "example": "My job A" }, "startDate": { "type": "string", "description": "The start date associated with this job.", "format": "date-time", "example": "2018-12-20T00:00:00Z" }, "endDate": { "type": "string", "description": "The end date associated with this job.", "format": "date-time", "example": "2025-12-20T00:00:00Z" }, "links": { "type": "array", "items": { "$ref": "#/components/schemas/Link" } }, "jobNumber": { "$ref": "#/components/schemas/JobSegmentsResource" } }, "description": "The state representation of Jobs within a company." }, "JobSegmentsResource": { "type": "object", "properties": { "segment1": { "type": "string", "description": "This is segment 1 or the number associated to the job when segmentation is not used.", "example": "A1" }, "segment2": { "type": "string", "description": "This is segment 2.", "example": "A2" }, "segment3": { "type": "string", "description": "This is segment 3.", "example": "A3" } }, "description": "Data elements of a Job Number to show the segments and number.For segmentation this can be up to 3 different segments." }, "CustomFieldsCategoryResource": { "type": "object", "properties": { "categoryId": { "type": "string", "description": "The unique identifier that is autogenerated when creating a category", "readOnly": true, "example": "970003868555304" }, "categoryName": { "type": "string", "description": "The name of the Category", "example": "Social" }, "links": { "type": "array", "items": { "$ref": "#/components/schemas/Link" } } } }, "CustomFieldsDropdownResource": { "type": "object", "properties": { "dropdownId": { "type": "string", "description": "The unique identifier that is autogenerated when dropdown list is created", "example": "1040014203453303" }, "dropdownValue": { "type": "string", "description": "The value for dropdown list", "example": "Basketball" }, "dropdownDefault": { "type": "boolean", "description": "The default value for dropdown list", "example": true } } }, "CustomFieldsResource": { "type": "object", "properties": { "customFieldId": { "type": "string", "description": "The unique identifier that is autogenerated when a custom field is created", "readOnly": true, "example": "1040014203417589" }, "customFieldName": { "type": "string", "description": "The name of the custom field", "example": "Hobbies" }, "categoryId": { "type": "string", "description": "The unique identifier that is autogenerated when creating a category", "example": "1040014179116276" }, "required": { "type": "boolean", "description": "Where to indicate if the custom field is required on the worker where true = required and false = not required", "example": false }, "checkStub": { "type": "boolean", "description": "Where to indicate if the custom field is required on the worker's pay stub, where true = required and false = not required", "example": false }, "employeeEditable": { "type": "boolean", "description": "Where to indicate if the custom field is able to be edited by the employee, where true = required and false = not required", "example": false }, "type": { "type": "string", "description": "The type of field the custom field is.", "example": "DROPDOWN", "enum": [ "DROPDOWN", "TEXT", "BOOLEAN", "DATE", "NUMERIC, NUMERIC__0_00_ OR NUMERIC__0_0000_" ] }, "booleanValue": { "type": "boolean", "description": "The value for BOOLEAN type (true / false)" }, "links": { "type": "array", "items": { "$ref": "#/components/schemas/Link" } }, "dateValue": { "type": "string", "description": "The value for DATE type , example : 2012-02-01T05:00:00Z", "format": "date-time" }, "textValue": { "type": "string", "description": "The value for TEXT type (any text, alphanumeric, special characters allowed)" }, "maxTextLength": { "type": "number", "description": "The maximum allowed value for textValue" }, "numericValue": { "type": "number", "description": "Numeric data type can have three formats namely - whole number, second decimal place and fourth decimal place, example: 12 , 12.34 or 12.3456" }, "dropdown": { "type": "array", "items": { "$ref": "#/components/schemas/CustomFieldsDropdownResource" } } } }, "CheckResource": { "type": "object", "properties": { "workerId": { "type": "string", "description": "The id assigned to the worker.", "example": "004UWBZQJ7GEB9TVWFR9" }, "paycheckId": { "type": "string", "description": "The id of a single check that a workers has.", "readOnly": true, "example": "1020026552555444" }, "payPeriodId": { "type": "string", "description": "The id for the unprocessed payperiod. ", "example": "1020026427391732" }, "checkCorrelationId": { "type": "string", "description": "Id that you define which is used for error handling/responses. This is not required when sending a single check." }, "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.", "example": false }, "earnings": { "type": "array", "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.\n2. payHours and payRate: Will allow you to define the monetary rate that the hours will be applied against.\n3. payHours and payRateId: Will allow you to define which workers predefined pay rate the hours will be applied against.\n4. payUnits: Will use the default hourly rate defined on the worker to apply the units against.\n5. payUnits and payRate: Will allow you to define the monetary rate that the units will be applied against.\n6. payUnits and payRateId: Will allow you to define which workers predefined pay rate the units will be applied against.\n7. payAmount: Will allow you to define straight monetary amount.", "items": { "$ref": "#/components/schemas/PayComponentResource" } }, "deductions": { "type": "array", "description": "Deduction pay components on the check.", "items": { "$ref": "#/components/schemas/PayComponentResource" } }, "checkDate": { "type": "string", "description": "The check date ", "example": "2019-05-12T20:00:00Z" }, "informational": { "type": "array", "description": "Informational pay components on the check.", "items": { "$ref": "#/components/schemas/PayComponentResource" } }, "taxes": { "type": "array", "description": "Tax pay components on the check.", "items": { "$ref": "#/components/schemas/PayComponentResource" } }, "links": { "type": "array", "items": { "$ref": "#/components/schemas/Link" } } }, "description": "The state representation of Labor Assignments within a company." }, "JobResourcePatch": { "type": "object", "properties": { "jobId": { "type": "string", "description": "The unique identifier associated with this job.", "readOnly": true, "example": "970001557916902" }, "jobCorrelationId": { "type": "string", "description": "Id that you define which is used for error handling/responses." }, "jobName": { "type": "string", "description": "The name of the job.", "example": "My job A" }, "startDate": { "type": "string", "description": "The start date associated with this job.", "format": "date-time", "example": "2018-12-20T00:00:00Z" }, "endDate": { "type": "string", "description": "The end date associated with this job.", "format": "date-time", "example": "2025-12-20T00:00:00Z" }, "effectiveDate": { "type": "string", "description": "Date which this pay component has started for the worker.", "format": "date-time" }, "links": { "type": "array", "items": { "$ref": "#/components/schemas/Link" } }, "jobNumber": { "$ref": "#/components/schemas/JobSegmentsResource" } }, "description": "The state representation of Jobs within a company." }, "CompanyResource": { "type": "object", "properties": { "companyId": { "type": "string", "description": "The unique identifier associated with this companies representation.", "example": "99Z5V9BTI8J2FCGESC05" }, "displayId": { "type": "string", "description": "The client account number used for identification purposes. (no dash or spaces allowed, only the last 8 characters of the ID)", "example": "09620579" }, "legalName": { "type": "string", "description": "The legal name of the company.", "example": "Monsters, Inc" }, "communications": { "type": "array", "items": { "$ref": "#/components/schemas/CommunicationResource" } }, "hasPermission": { "type": "boolean", "description": "Indicates whether the provisioned company has active payroll product codes. Companies without active payroll product codes will not be accessible via the API." }, "legalId": { "$ref": "#/components/schemas/LegalIdResource" }, "lineage": { "$ref": "#/components/schemas/LineageInfoResource" }, "links": { "type": "array", "items": { "$ref": "#/components/schemas/Link" } } }, "description": "The state representation of a company" }, "LineageInfoResource": { "type": "object", "properties": { "successors": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/SuccessorPredecessorResource" }, "description": "Successors lineage information of the company." }, "predecessors": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/SuccessorPredecessorResource" }, "description": "Predecessors lineage information of the company." } }, "description": "Client lineage information" }, "SuccessorPredecessorResource": { "type": "object", "properties": { "caid": { "type": "string", "description": "The client account identifier (CAID)", "example": "00HWYNTDLEEC8AQX0MI0" }, "reasonType": { "type": "string", "description": "The reason type for the lineage transition", "example": "CHANGE_ENTITY" }, "createdDate": { "type": "string", "description": "The date when the successor was created", "format": "date-time" }, "clientName": { "type": "string", "description": "The name of the successor client", "example": "Chris Frost" }, "taxPayerIdentification": { "$ref": "#/components/schemas/TaxPayerIdentificationResource" } }, "description": "The state representation of a successor and predecessor account in the lineage hierarchy" }, "TaxPayerIdentificationResource": { "type": "object", "properties": { "id": { "type": "string", "description": "The tax payer identification number", "example": "123456789" }, "type": { "type": "string", "description": "The type of tax payer identification", "example": "FEIN" } }, "description": "Tax payer identification information" }, "WorkerStatus": { "type": "object", "properties": { "workerStatusId": { "type": "string", "description": "The unique identifier associated with this status representation.", "example": "00DWS906IMW2JSH8AQJ9" }, "statusType": { "type": "string", "description": "The status category.", "example": "ACTIVE" }, "statusReason": { "type": "string", "description": "The reason of the status.", "example": "HIRED" }, "links": { "type": "array", "items": { "$ref": "#/components/schemas/Link" } } }, "description": "The state representation of allowed worker statuses configured for the company." }, "ClientStateTaxResource": { "type": "object", "properties": { "countrySubdivisionCodes": { "type": "array", "items": { "type": "string" } } } }, "PayPeriodResource": { "type": "object", "properties": { "payPeriodId": { "type": "string", "description": "The unique identifier used to identify a pay period.", "example": "850000414675408" }, "intervalCode": { "type": "string", "description": "Frequency of the payroll period.", "example": "BI_WEEKLY", "enum": [ "ANNUAL", "BI_WEEKLY", "MONTHLY", "QUARTERLY", "SEMI_ANNUAL", "SEMI_MONTHLY", "WEEKLY" ] }, "status": { "type": "string", "description": "The current state of the associated pay period.", "example": "INITIAL", "enum": [ "COMPLETED", "COMPLETED_BY_MEC", "ENTRY", "INITIAL", "PROCESSING", "REISSUED", "RELEASED", "REVERSED" ] }, "description": { "type": "string", "description": "The description of the Pay Period.", "example": "Bi-weekly Payroll (1)" }, "startDate": { "type": "string", "description": "The start date associated with this pay period.", "format": "date-time", "example": "2016-02-27T00:00:00Z" }, "endDate": { "type": "string", "description": "The end date associated with this pay period.", "format": "date-time", "example": "2016-03-11T00:00:00Z" }, "submitByDate": { "type": "string", "description": "The date by which information for the pay run must be submitted in order to be guaranteed the information is included.", "format": "date-time", "example": "2016-03-18T00:00:00Z" }, "checkDate": { "type": "string", "description": "The date on which the checks associated with this pay period can be cashed.", "format": "date-time", "example": "2016-03-18T00:00:00Z" }, "checkCount": { "type": "integer", "description": "Number of checks that are included within the pay period.", "format": "int32", "example": 1 }, "originalPayPeriodID": { "type": "string", "description": "If the payperiod was created from a reversed payperiod then this is a unique identifier for the original payperiod.", "example": "850000414358408" }, "links": { "type": "array", "items": { "$ref": "#/components/schemas/Link" } } }, "description": "The representational state of pay periods." }, "FrequencyCombinationUnitResource": { "type": "object", "properties": { "payFrequency": { "type": "string", "description": "Frequency which the pay component would be applied.", "example": "WEEKLY" }, "payComponentFrequency": { "$ref": "#/components/schemas/PayComponentFrequencyTypeResource" }, "links": { "type": "array", "items": { "$ref": "#/components/schemas/Link" } } }, "description": "The state representation of generic pay frequencies." }, "FrequencyIntervalsResource": { "type": "object", "properties": { "interval1": { "type": "string", "description": "Interval 1 ", "example": "1" }, "interval2": { "type": "string", "description": "Interval 2", "example": "4" } }, "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." }, "PayComponentFrequencyTypeResource": { "type": "object", "properties": { "applied": { "type": "string", "description": "Currently we only support a BY_PAY_PERIOD value for the API.", "example": "BY_PAY_PERIOD" }, "occurrence": { "type": "string", "description": "This is how often the to be applied on the pay run.", "example": "SEMI_MONTHLY" }, "occurrenceIntervals": { "$ref": "#/components/schemas/FrequencyIntervalsResource" } }, "description": "Pay Component Frequency" }, "CollectionResourceUserSearchResponse": { "type": "object", "properties": { "metadata": { "$ref": "#/components/schemas/MetadataResource" }, "content": { "type": "array", "items": { "$ref": "#/components/schemas/UserSearchResponse" } }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ErrorResource" } }, "message": { "type": "string" }, "links": { "type": "array", "items": { "$ref": "#/components/schemas/Link" } } } }, "MetadataResource": { "type": "object", "properties": { "contentItemCount": { "type": "integer", "format": "int32" }, "pagination": { "$ref": "#/components/schemas/PaginationMetadataResource" } } }, "PaginationMetadataResource": { "type": "object", "properties": { "offset": { "type": "integer", "format": "int32" }, "limit": { "type": "integer", "format": "int32" }, "itemCount": { "type": "integer", "format": "int32" }, "total": { "type": "integer", "format": "int32" } } }, "UserSearchResponse": { "type": "object", "properties": { "ueid": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "emailAddress": { "type": "string" } } }, "LocationResource": { "type": "object", "properties": { "locationId": { "type": "string", "description": "The unique identifier associated with this locations representation.", "example": "970000082973090" }, "name": { "type": "string", "description": "The name of the location.", "example": "Default Location" }, "address": { "$ref": "#/components/schemas/CommunicationResource" }, "links": { "type": "array", "items": { "$ref": "#/components/schemas/Link" } }, "movedIn": { "type": "string", "description": "The date which the location was moved into.", "format": "date-time" }, "movedOut": { "type": "string", "description": "The date which the location was moved out.", "format": "date-time" } }, "description": "The state representation of Locations within a company." }, "LaborAssignmentResource": { "type": "object", "properties": { "laborAssignmentId": { "type": "string", "description": "The unique identifier associated with this labor assignment representation.", "example": "970001701620720" }, "name": { "type": "string", "description": "The name of the labor assignment.", "example": "Assignment 3" }, "startDate": { "type": "string", "description": "The start date associated with this labor assignment.", "format": "date-time", "example": "2019-01-24T00:00:00Z" }, "endDate": { "type": "string", "description": "The end date associated with this labor assignment.", "format": "date-time", "example": "2029-12-24T00:00:00Z" }, "organizationId": { "type": "string", "description": "The organization associated with this labor assignment.", "example": "970001701620691" }, "positionId": { "type": "string", "description": "The position associated with this labor assignment.", "example": "970000180782611" }, "links": { "type": "array", "items": { "$ref": "#/components/schemas/Link" } }, "locationId": { "type": "string", "description": "The locations associated with this labor assignment.", "example": "970001701620683" }, "rate": { "type": "string", "description": "The wage rate code associated with this labor assignment.", "example": "RATE_2" } }, "description": "The state representation of Labor Assignments within a company." }, "JobSegmentsConfigResource": { "type": "object", "properties": { "segmentNumber": { "type": "integer", "description": "Segment Number", "format": "int32", "example": 1 }, "name": { "type": "string", "description": "Segment Name", "example": "Service Code" }, "segmentLength": { "type": "integer", "description": "Segment Length", "format": "int32", "example": 4 }, "links": { "type": "array", "items": { "$ref": "#/components/schemas/Link" } } } }, "DocumentCategoryResource": { "type": "object", "properties": { "categoryId": { "type": "string", "description": "The unique identifier associated with this document category.", "example": "11" }, "name": { "type": "string", "description": "The name of the category.", "example": "Certifications & Licenses" }, "customCategory": { "type": "boolean", "description": "A boolean indicating if the category is a custom specified one or not.", "example": false }, "links": { "type": "array", "items": { "$ref": "#/components/schemas/Link" } } }, "description": "The state representation of allowed document categories configured for the company." }, "CustomEmploymentTypeResource": { "type": "object", "properties": { "customEmploymentTypeId": { "type": "string", "description": "The unique identifier associated with this custom employment type.", "example": "123456" }, "customEmploymentTypeName": { "type": "string", "description": "The name associated with this custom employment type", "example": "Hybrid" }, "links": { "type": "array", "items": { "$ref": "#/components/schemas/Link" } } }, "description": "The state representation of allowed custom employment types configured for the company." }, "ContactTypeResource": { "type": "object", "properties": { "contactTypeId": { "type": "string" }, "contactTypeName": { "type": "string" }, "relationshipTypes": { "type": "array", "items": { "$ref": "#/components/schemas/RelationTypeResource" } }, "links": { "type": "array", "items": { "$ref": "#/components/schemas/Link" } } } }, "RelationTypeResource": { "type": "object", "properties": { "relationshipTypeId": { "type": "string" }, "relationshipTypeName": { "type": "string" } } }, "Client": { "type": "object", "properties": { "lockVersion": { "type": "integer", "format": "int64" }, "createdByApplicationName": { "type": "string" }, "createdByUserId": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "createdByApplicationSubProcessName": { "type": "string" }, "clientAccountRegistrations": { "type": "array", "items": { "$ref": "#/components/schemas/ClientAccountRegistration" } }, "clientAccountRelations": { "type": "array", "items": { "$ref": "#/components/schemas/ClientAccountRelation" } }, "clientAddresses": { "type": "array", "items": { "$ref": "#/components/schemas/ClientAddress" } }, "clientNames": { "type": "array", "items": { "$ref": "#/components/schemas/ClientName" } }, "clientVersions": { "type": "array", "items": { "$ref": "#/components/schemas/ClientVersion" } }, "ceid": { "type": "string" } } }, "ClientAccount": { "type": "object", "properties": { "externalCAID": { "type": "string" }, "externalId": { "type": "string" }, "lockVersion": { "type": "integer", "format": "int32" }, "applicationName": { "type": "string" }, "assignedName": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "createdByApplicationName": { "type": "string" }, "createdByUserId": { "type": "string" }, "routeAttributeName": { "type": "string" }, "createdByApplicationSubProcessName": { "type": "string" }, "routeAttributeValue": { "type": "string" }, "modifiedDate": { "type": "string", "format": "date-time" }, "modifiedByApplicationName": { "type": "string" }, "modifiedByApplicationSubProcessName": { "type": "string" }, "modifiedByUserId": { "type": "string" }, "parentIndicator": { "type": "boolean" }, "displayName": { "type": "string" }, "clientAccountRegistrations": { "type": "array", "items": { "$ref": "#/components/schemas/ClientAccountRegistration" } }, "successors": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/SuccessorPredecessorResource" } }, "predecessors": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/SuccessorPredecessorResource" } }, "caid": { "type": "string" } } }, "ClientAccountRegistration": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" }, "endReasonCode": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "createdByApplicationName": { "type": "string" }, "createdByUserId": { "type": "string" }, "createdByApplicationSubProcessName": { "type": "string" }, "modifiedDate": { "type": "string", "format": "date-time" }, "modifiedByApplicationName": { "type": "string" }, "modifiedByApplicationSubProcessName": { "type": "string" }, "modifiedByUserId": { "type": "string" }, "client": { "$ref": "#/components/schemas/Client" }, "clientAccount": { "$ref": "#/components/schemas/ClientAccount" } } }, "ClientAccountRelation": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "applicationName": { "type": "string" }, "assignedName": { "type": "string" }, "sibApplicationName": { "type": "string" }, "sibAssignedName": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" }, "createdByApplicationName": { "type": "string" }, "createdByUserId": { "type": "string" }, "createdByApplicationSubProcessName": { "type": "string" }, "modifiedDate": { "type": "string", "format": "date-time" }, "modifiedByApplicationName": { "type": "string" }, "modifiedByApplicationSubProcessName": { "type": "string" }, "caid": { "type": "string" }, "modifiedByUserId": { "type": "string" }, "client": { "$ref": "#/components/schemas/Client" } } }, "ClientAddress": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "addressUsageType": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "createdByApplicationName": { "type": "string" }, "createdByUserId": { "type": "string" }, "createdByApplicationSubProcessName": { "type": "string" }, "client": { "$ref": "#/components/schemas/Client" }, "clientAddressVersions": { "type": "array", "items": { "$ref": "#/components/schemas/ClientAddressVersion" } } } }, "ClientAddressVersion": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "city": { "type": "string" }, "valStateCode": { "type": "string" }, "verStateCode": { "type": "string" }, "beginEffectiveDate": { "type": "string", "format": "date-time" }, "endEffectiveDate": { "type": "string", "format": "date-time" }, "modifiedDate": { "type": "string", "format": "date-time" }, "stateProvince": { "type": "string" }, "stateProvinceF": { "type": "string" }, "portalCode": { "type": "string" }, "countryCode": { "type": "string" }, "buildingNumber": { "type": "string" }, "unitName": { "type": "string" }, "streetName": { "type": "string" }, "poBox": { "type": "string" }, "streetAddressOne": { "type": "string" }, "streetAddressTwo": { "type": "string" }, "modifedByApplicationName": { "type": "string" }, "modifiedByApplicationSubProcessName": { "type": "string" }, "modifiedByUserId": { "type": "string" }, "clientAddress": { "$ref": "#/components/schemas/ClientAddress" } } }, "ClientName": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "type": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "createdByApplicationName": { "type": "string" }, "createdByUserId": { "type": "string" }, "createdByApplicationSubProcessName": { "type": "string" }, "clients": { "$ref": "#/components/schemas/Client" }, "clientNameVersions": { "type": "array", "items": { "$ref": "#/components/schemas/ClientNameVersion" } } } }, "ClientNameVersion": { "type": "object", "properties": { "cnvId": { "type": "integer", "format": "int64" }, "cnvCltNm": { "type": "string" }, "cnvVerStatCd": { "type": "string" }, "cnvValStatCd": { "type": "string" }, "cnvBegnEffDt": { "type": "string", "format": "date-time" }, "cnvEndEffDt": { "type": "string", "format": "date-time" }, "cnvModDt": { "type": "string", "format": "date-time" }, "cnvModByAppNm": { "type": "string" }, "cnvModByAppUsrNm": { "type": "string" }, "cnvModByAppSubNm": { "type": "string" }, "cltNmByCnId": { "$ref": "#/components/schemas/ClientName" } } }, "ClientVersion": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "taxPayerIdentificationNumber": { "type": "string" }, "tinLastFour": { "type": "string" }, "tinType": { "type": "string" }, "tinValidStatusCode": { "type": "string" }, "normalizedName": { "type": "string" }, "normalizedCity": { "type": "string" }, "normalizedCountryCode": { "type": "string" }, "versionStatusCode": { "type": "string" }, "beginEffectiveDate": { "type": "string", "format": "date-time" }, "endEffectiveDate": { "type": "string", "format": "date-time" }, "normalizedBuildingNumber": { "type": "string" }, "normalizedSteetName": { "type": "string" }, "normalizedUnitName": { "type": "string" }, "normalizedPOBox": { "type": "string" }, "normalizedStateProvince": { "type": "string" }, "normalizedStateProvinceF": { "type": "string" }, "normalizedPostalCode": { "type": "string" }, "tinVersionStatusCode": { "type": "string" }, "status": { "type": "string" }, "statusDate": { "type": "string", "format": "date-time" }, "superceededBy": { "type": "string" }, "modifiedDate": { "type": "string", "format": "date-time" }, "modifiedByApplicationName": { "type": "string" }, "modifiedByApplicationSubProcessName": { "type": "string" }, "modifiedByUserId": { "type": "string" }, "modifiedReason": { "type": "string" }, "client": { "$ref": "#/components/schemas/Client" } } }, "CheckResource_Internal": { "type": "object", "properties": { "workerId": { "type": "string", "description": "The id assigned to the worker.", "example": "004UWBZQJ7GEB9TVWFR9" }, "paycheckId": { "type": "string", "description": "The id of a single check that a workers has.", "readOnly": true, "example": "1020026552555444" }, "payPeriodId": { "type": "string", "description": "The id for the unprocessed payperiod. ", "example": "1020026427391732" }, "checkCorrelationId": { "type": "string", "description": "Id that you define which is used for error handling/responses. This is not required when sending a single check." }, "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.", "example": false }, "earnings": { "type": "array", "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.\n2. payHours and payRate: Will allow you to define the monetary rate that the hours will be applied against.\n3. payHours and payRateId: Will allow you to define which workers predefined pay rate the hours will be applied against.\n4. payUnits: Will use the default hourly rate defined on the worker to apply the units against.\n5. payUnits and payRate: Will allow you to define the monetary rate that the units will be applied against.\n6. payUnits and payRateId: Will allow you to define which workers predefined pay rate the units will be applied against.\n7. payAmount: Will allow you to define straight monetary amount.", "items": { "$ref": "#/components/schemas/PayComponentResource_Internal" } }, "deductions": { "type": "array", "description": "Deduction pay components on the check.", "items": { "$ref": "#/components/schemas/PayComponentResource_Internal" } }, "checkDate": { "type": "string", "description": "The check date ", "example": "2019-05-12T20:00:00Z" }, "informational": { "type": "array", "description": "Informational pay components on the check.", "items": { "$ref": "#/components/schemas/PayComponentResource_Internal" } }, "taxes": { "type": "array", "description": "Tax pay components on the check.", "items": { "$ref": "#/components/schemas/PayComponentResource_Internal" } }, "links": { "type": "array", "items": { "$ref": "#/components/schemas/Link_Internal" } } }, "description": "The state representation of Labor Assignments within a company." }, "Link_Internal": { "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" } } }, "OrganizationResource_Internal": { "type": "object", "properties": { "organizationId": { "type": "string", "description": "The unique identifier associated with this organizations representation.", "example": "970000055981384" }, "name": { "type": "string", "description": "The name of the organization.", "example": "2 Division B" }, "number": { "type": "string", "description": "The number assigned to the organization.", "example": "2" }, "level": { "type": "string", "description": "The level number within the organizational structures hierarchy.", "example": "Level 2" } }, "description": "The state representation of Organizations within a company." }, "PayComponentResource_Internal": { "type": "object", "properties": { "componentId": { "type": "string", "description": "The unique identifier used to identify a pay component.", "example": "970000076689381" }, "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.", "example": "1" }, "name": { "type": "string", "description": "Name given to the pay component.", "example": "Hourly" }, "classificationType": { "type": "string", "description": "The category that this component falls into.", "example": "Regular" }, "description": { "type": "string", "description": "The description of the Pay Component.", "example": "Use for regular pay." }, "effectOnPay": { "type": "string", "description": "The effect that the pay component will have on the check amount.", "example": "ADDITION", "enum": [ "ADDITION", "ADDITION_WITH_IN_OUT", "EMPLOYER_INFORMATIONAL", "REDUCTION" ] }, "startDate": { "type": "string", "description": "The date that the pay component is able to be applied on a check.", "format": "date-time", "example": "2016-01-01T00:00:00Z" }, "endDate": { "type": "string", "description": "The date that the pay component is not available to be applied on a check moving forward.", "format": "date-time" }, "appliesToWorkerTypes": { "type": "array", "description": "List of workerTypes that the component can be applied to.", "items": { "type": "string", "description": "The type of worker. This data field cannot be PATCHED.NOTE: An IN_PROGRESS worker cannot be POSTED with a value of CONTRACTOR.", "enum": [ "EMPLOYEE", "CONTRACTOR", "INDEPENDENT_CONTRACTOR" ] } }, "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.", "example": "SCHEDULED_AMOUNT" }, "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.", "example": "7.25" }, "payHours": { "type": "string", "description": "The number of hours that will be applied for this component. Used in conjunction with rate.", "example": "4" }, "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": { "$ref": "#/components/schemas/OrganizationResource_Internal" }, "lineDate": { "type": "string", "description": "This is used optionally for specifying a date that the pay component was generated on.", "format": "date-time" }, "memoed": { "type": "boolean", "description": "This is used optionally for memoing the payHours or payUnits so that they are informational when using a payAmount.", "example": false }, "links": { "type": "array", "items": { "$ref": "#/components/schemas/Link_Internal" } } }, "description": "The earnings to apply to the check. Each earning needs to define as one of the following allowed values" }, "ErrorResource_Internal": { "type": "object", "properties": { "code": { "type": "string", "description": "Error code" }, "description": { "type": "string", "description": "Description of error" }, "resolution": { "type": "string", "description": "Resolution of error" } }, "description": "Representation of error" }, "CalculationBase": { "type": "object", "properties": { "calculationBaseId": { "type": "string", "description": "The unique ID associated with Calculation Base", "example": "00H2A1IUJE7MXV6TQ37Q" }, "calculationBaseName": { "type": "string", "description": "Name of CalculationBase", "example": "All earnings - employee cafeteria plan pre tax amounts" } }, "description": "The state representation of CalculationBase" }, "AddProfileImageResource": { "type": "object", "properties": { "profileImageURL": { "type": "string" } } }, "Links": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/Link1" } }, "WorkerPODBalanceResource": { "required": [ "availableBalanceAmount" ], "type": "object", "properties": { "availableBalanceAmount": { "minimum": 0, "type": "number", "format": "float" }, "outstandingBalance": { "type": "boolean" }, "workerId": { "type": "string" }, "_links": { "$ref": "#/components/schemas/Links" } }, "description": "Worker pod balance" }, "CheckLimitResource": { "type": "object", "properties": { "type": { "type": "string", "description": "This is used to determine what type of limitations to apply.", "enum": [ "NONE:This is the default when no check limits exist", "STOPS_AT:This is used to stop when a specific amount is reached", "STOPS_AT_NEW_AMOUNT:This is the latest amount that is used to stop when a specific amount is reached", "BASED_ON_YTD_CASH_WAGES:This is used to stop when a specific amount is reached within the year against cash wages", "AMOUNT_PER_CHECK:This is used to stop when a specific amount is reached on a 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" } } }, "FrequencyIntervalsResource1": { "type": "object", "properties": { "interval1": { "type": "string", "description": "First interval", "example": "2" }, "interval2": { "type": "string", "description": "Second interval", "example": "Last" } }, "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." }, "PayComponentFrequencyTypeResource1": { "type": "object", "properties": { "applied": { "type": "string", "description": "Currently we only support a BY_PAY_PERIOD value for the API.", "example": "BY_PAY_PERIOD" }, "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.", "example": "QUARTERLY" }, "occurrenceIntervals": { "$ref": "#/components/schemas/FrequencyIntervalsResource1" }, "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.", "example": "EVERY_CHECK" } }, "description": "Worker pay frequency" }, "RecurringResource": { "type": "object", "properties": { "workerComponentId": { "type": "string", "description": "The id of a single pay component that a workers has.", "readOnly": true, "example": "970000223656831" }, "componentId": { "type": "string", "description": "The unique identifier of the pay component. This data field cannot be PATCHED.", "example": "970000180599325" }, "name": { "type": "string", "description": "Name of the pay component. This data field will be populated automatically based on componentId.", "example": "Deduction - 1" }, "calculationType": { "type": "string", "description": "The type of calculation that will be applied for the pay component .", "enum": [ "FLAT_DOLLAR_AMOUNT:This is used for a specific dollar amount", "PERCENTAGE:This is used for when a Percentage will be used to calculate the amount and will need a calculationBaseId to specify what to apply against", "RATE_X_UNITS:This is used for apply the rate against units and will need a calculationBaseId to specify what to apply against", "RATE_X_HOURS:This is used for apply the rate against hours and will need a calculationBaseId to specify what to apply against." ] }, "calculationBaseId": { "type": "string", "description": "This is required if you are not using a FLAT_DOLLAR_AMOUNT Calculation Type.", "example": "00H2A1IUJE7MXV6TQ37U" }, "value": { "type": "number", "description": "This is used to specify the value that is used against the calculationType.", "example": 5 }, "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.", "format": "date-time", "example": "2018-03-01T00:00:00Z" }, "effectiveDate": { "type": "string", "description": "Date which this pay component has started for the worker.", "format": "date-time" }, "endDate": { "type": "string", "description": "Date which this pay component has ended for the worker.", "format": "date-time" }, "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", "example": "REDUCTION" }, "classificationType": { "type": "string", "description": "The category that this component falls into." }, "checkLimit": { "$ref": "#/components/schemas/CheckLimitResource" }, "frequency": { "$ref": "#/components/schemas/PayComponentFrequencyTypeResource1" }, "workerPayCompScheduledEntries": { "type": "array", "items": { "$ref": "#/components/schemas/Worker Pay Component Scheduled Entry Data" } }, "transactions": { "type": "array", "description": "Pay Component transaction details.", "items": { "$ref": "#/components/schemas/Worker Pay Component Transactions Details" } }, "_links": { "$ref": "#/components/schemas/Links" } }, "description": "Worker recurring deduction" }, "Worker Pay Component Scheduled Entry Data": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "workerCalcMethodId": { "type": "integer", "format": "int64" }, "clientPayrollId": { "type": "integer", "format": "int64" }, "checkDate": { "type": "string", "format": "date-time" }, "scheduledAmount": { "type": "number" }, "processedAmount": { "type": "number" }, "sequenceId": { "type": "integer", "format": "int64" }, "transactionDetails": { "$ref": "#/components/schemas/Worker Pay Component Scheduled Entry Transactions Data" } }, "description": "Setting Worker Pay Component Scheduled Entry Data." }, "Worker Pay Component Scheduled Entry Transactions Data": { "type": "object", "properties": { "scheduledEntryId": { "type": "integer", "format": "int64" }, "earliestTransactionDate": { "type": "string", "format": "date-time" }, "latestTransactionDate": { "type": "string", "format": "date-time" }, "transactions": { "type": "array", "items": { "$ref": "#/components/schemas/Worker Pay Component Transactions Details" } } }, "description": "Setting Worker Pay Component Scheduled Entry Transactions Data." }, "Worker Pay Component Transactions Details": { "type": "object", "properties": { "transactionId": { "type": "string" }, "date": { "type": "string", "format": "date-time" }, "amount": { "type": "number" } }, "description": "Pay Component transaction details." }, "DocumentManagementResource": { "required": [ "category" ], "type": "object", "properties": { "docId": { "type": "string", "description": "The document id associated with this document.", "example": "97155644" }, "name": { "type": "string", "description": "The name of the document.", "example": "sampledoc.pdf" }, "expirationReminderDays": { "type": "integer", "format": "int32" }, "expirationDate": { "type": "string", "description": "The expiration date of the document.", "format": "date-time", "example": "2025-09-11T00:00:00Z" }, "category": { "type": "string", "description": "The category id of the document.", "example": "15" }, "workerVisible": { "type": "boolean", "description": "Flag for if the document is visible to the worker.", "example": true }, "workerVisibleDate": { "type": "string", "description": "The date that the document is visible to the worker.", "format": "date-time", "example": "2025-09-11T00:00:00Z" }, "document": { "type": "string", "description": "The document data in base64. This field cannot be POSTED. The document should be POSTED in the 'file' field.", "example": "data:application/pdf;base64,PgpzdGFydHhyZWYKMTg4NTU4CiUlRU9GCg==" }, "_links": { "$ref": "#/components/schemas/Links" } } }, "FileResource": { "required": [ "file", "metadata" ], "type": "object", "properties": { "file": { "type": "string", "format": "binary" }, "metadata": { "$ref": "#/components/schemas/DocumentManagementResource" }, "notificationToggle": { "type": "boolean", "description": "The notification toggle for send notification." } } }, "WorkerCustomFieldsResource": { "type": "object", "properties": { "workerCustomFieldId": { "type": "string", "description": "The unique identifier that is autogenerated when a custom field is created" }, "customFieldId": { "type": "string", "description": "client Custom Field Id" }, "type": { "type": "string", "description": "The type of field the custom field is", "enum": [ "DROPDOWN", "TEXT", "BOOLEAN", "DATE", "NUMERIC, NUMERIC__0_00_ OR NUMERIC__0_0000_" ] }, "booleanValue": { "type": "boolean", "description": "The value for BOOLEAN type (true/false)" }, "textValue": { "type": "string", "description": "The value for TEXT type (any text, alphanumeric, special characters allowed)" }, "numericValue": { "type": "number", "description": "Numeric data type can have three formats namely - whole number, second decimal place and fourth decimal place, example: 12 , 12.34 or 12.3456" }, "dateValue": { "type": "string", "description": "The value for DATE type , example : 2012-02-01T05:00:00Z", "format": "date-time" }, "dropdownId": { "type": "string", "description": "The unique identifier that is autogenerated when dropdown list is created" }, "dropdownValue": { "type": "string", "description": "The value for dropdown list" }, "customFieldName": { "type": "string", "description": "The name of the custom field. Such as: \"Hobbies\"" }, "required": { "type": "boolean", "description": "Where to indicate if the custom field is required on the worker where true = required and false = not required" }, "checkStub": { "type": "boolean", "description": "Where to indicate if the custom field is required on the workers pay stub, where true = required and false = not required." }, "employeeEditable": { "type": "boolean", "description": "Where to indicate if the custom field is able to be edited by the employee, where true = required and false = not required." } } }, "ContactTypeResource1": { "type": "object", "properties": { "contactTypeId": { "type": "string", "description": "The ID for specific type of contact. Required for POST contacts." }, "contactTypeName": { "type": "string", "description": "Enum: \"EMERGENCY_CONTACT\"\n\nThe name for specific type of contact." } }, "description": "The type of this worker contact. Required for POST contacts." }, "EmailResource": { "type": "object", "properties": { "communicationId": { "type": "string", "description": "The ID for this email communication." }, "uri": { "type": "string", "description": "The mailto address as specified in RFC2368. Required for POST contacts." }, "usageType": { "type": "string", "description": "Enum: \"PERSONAL\", \"BUSINESS\"\n\nA code classifying a designated use associated with a contact method. For example, whether a telephone or email address is one for work communications or one primarily for personal use. This data field cannot be PATCHED. Required for POST contacts." } }, "description": "The email communications for this contact." }, "EntityCommunicationResource": { "type": "object", "properties": { "telecom": { "$ref": "#/components/schemas/TelecomResource" }, "postal": { "$ref": "#/components/schemas/PostalResource" }, "email": { "$ref": "#/components/schemas/EmailResource" } }, "description": "The set of communications for this contact. Required for POST contacts." }, "EntityResource": { "type": "object", "properties": { "entityId": { "type": "string", "description": "The ID for this contact." }, "entityName": { "type": "string", "description": "The entity name. Required for POST contacts." }, "communication": { "$ref": "#/components/schemas/EntityCommunicationResource" } }, "description": "The organization associated with this relationship. The relationship must have either a person or entity." }, "NameResource1": { "type": "object", "properties": { "familyName": { "type": "string", "description": "The family or last name of a worker.", "example": "JONES" }, "middleName": { "type": "string", "description": "A subordinate given name, or initial representing that name, of a worker.
NOTE: Please send in just a single character initial for middleName.
If sending in more than one character the name will be truncated the first letter of the middleName.
A full middle name can be entered directly in Paychex Flex only at this time.", "example": "H" }, "givenName": { "type": "string", "description": "The given or first name of a worker. For an independent contractor that is a company rather than an individual, the name of the company.", "example": "INDIANA" }, "preferredName": { "type": "string", "description": "The first name that the worker prefers to go by", "example": "Indi" }, "preferredLastName": { "type": "string", "description": "The last name that the worker prefers to go by", "example": "Jan" }, "pronoun": { "type": "string", "description": "The pronoun that the worker prefers to go by. This data field cannot be POSTED.", "example": "He/him/his" }, "qualificationAffixCode": { "type": "string", "description": "A qualifier to the name of a worker, indicating generation.", "example": "Jr" }, "titleAffixCode": { "type": "string", "description": "A personal title that comes before an individual's name in a formal address (such as Dr., Prof., Rev., Mr.). ", "example": "Dr" } }, "description": "Information about the workers name." }, "PersonCommunicationResource": { "type": "object", "properties": { "telecom": { "type": "array", "description": "The telecom communications for this contact.", "items": { "$ref": "#/components/schemas/TelecomResource" } }, "postal": { "type": "array", "description": "The postal communications for this contact.", "items": { "$ref": "#/components/schemas/PostalResource" } }, "email": { "type": "array", "description": "The email communications for this contact.", "items": { "$ref": "#/components/schemas/EmailResource" } } }, "description": "The set of communications for this contact. Required for POST contacts." }, "PersonResource": { "type": "object", "properties": { "name": { "$ref": "#/components/schemas/NameResource1" }, "communication": { "$ref": "#/components/schemas/PersonCommunicationResource" } }, "description": "The person associated with this relationship. The relationship must have either a person or entity." }, "PostalResource": { "type": "object", "properties": { "communicationId": { "type": "string", "description": "The ID for the workers relationship to contact." }, "streetLineOne": { "type": "string", "description": "The street address line one. Required for street address. Required for POST contacts." }, "streetLineTwo": { "type": "string", "description": "The street address line two." }, "postOfficeBox": { "type": "string", "description": "The postal office box. Required for PO Box with POST contacts." }, "city": { "type": "string", "description": "The city name. Required for POST contacts." }, "postalCode": { "type": "string", "description": "The zip-code. Required for POST contacts." }, "countrySubdivisionCode": { "type": "string", "description": "The state code (ISO 3166 subdivision code). Required for POST contacts." }, "countryCode": { "type": "string", "description": "The country code (ISO 3166 alpha-2). Required for POST contacts." } }, "description": "The postal communications for this contact." }, "RelationTypeResource1": { "type": "object", "properties": { "relationshipTypeId": { "type": "string", "description": "ID of worker specific type of relationship with the contact. Required for POST contacts." }, "relationshipTypeName": { "type": "string", "description": "The name of worker specific type of relationship with the contact.\n\nEnum: \"Spouse\", \"Parent\", \"Sibling\", \"Child\", \"Friend\", \"Domestic Partner\", \"Other\"" } }, "description": "The relationship type for this worker contact. Required for POST person contacts." }, "RelationshipResource": { "type": "object", "properties": { "relationshipId": { "type": "string", "description": "The ID for the workers relationship to contact." }, "relationWeid": { "type": "string", "description": "The ID for the workers specific relation." }, "relationshipType": { "$ref": "#/components/schemas/RelationTypeResource1" }, "primary": { "type": "boolean", "description": "Where to indicate if the contact is selected as Primary, where true = Primary contact and false = not Primary contact." }, "person": { "$ref": "#/components/schemas/PersonResource" }, "entity": { "$ref": "#/components/schemas/EntityResource" } }, "description": "The relationship for this worker contract. Required for POST contacts." }, "TelecomResource": { "type": "object", "properties": { "communicationId": { "type": "string", "description": "The ID for the workers relationship to contact." }, "dialCountry": { "type": "string", "description": "The country code. Required for POST contacts." }, "dialArea": { "type": "string", "description": "The area code. Required for POST contacts." }, "dialNumber": { "type": "string", "description": "The phone number. Required for POST contacts." }, "type": { "type": "string", "description": "Enum: \"PHONE\", \"MOBILE_PHONE\"\n\nIndicates whether or not the number is for a mobile device. Required for POST contacts." }, "usageType": { "type": "string", "description": "Enum: \"PERSONAL\", \"BUSINESS\"\n\nA code classifying a designated use associated with a contact method. For example, whether a telephone or email address is one for work communications or one primarily for personal use. This data field cannot be PATCHED. Required for POST contacts." }, "extension": { "type": "string", "description": "The phone extension." } }, "description": "The telecom communications for this contact." }, "WorkerContactResource": { "type": "object", "properties": { "contactId": { "type": "string", "description": "The ID for the workers specific contact." }, "contactType": { "$ref": "#/components/schemas/ContactTypeResource1" }, "relationship": { "$ref": "#/components/schemas/RelationshipResource" } } }, "CheckResource1": { "type": "object", "properties": { "workerId": { "type": "string", "description": "The id assigned to the worker", "example": "004UWBZQJ7GEB9TVWFR9" }, "paycheckId": { "type": "string", "description": "The id of a single check that a workers has.", "readOnly": true, "example": "1020026552555444" }, "payPeriodId": { "type": "string", "description": "The id for the unprocessed payperiod.", "example": "1020026427391732" }, "checkCorrelationId": { "type": "string", "description": "Id that you define which is used for error handling/responses. This is not required when sending a single check.", "example": "yourID_1" }, "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.", "example": false, "enum": [ true, false ] }, "earnings": { "type": "array", "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.\n2. payHours and payRate: Will allow you to define the monetary rate that the hours will be applied against.\n3. payHours and payRateId: Will allow you to define which workers predefined pay rate the hours will be applied against.\n4. payUnits: Will use the default hourly rate defined on the worker to apply the units against.\n5. payUnits and payRate: Will allow you to define the monetary rate that the units will be applied against.\n6. payUnits and payRateId: Will allow you to define which workers predefined pay rate the units will be applied against.\n7. payAmount: Will allow you to define straight monetary amount.", "items": { "$ref": "#/components/schemas/PayComponentResource1" } }, "deductions": { "type": "array", "description": "Deduction pay components on the check.", "items": { "$ref": "#/components/schemas/PayComponentResource1" } }, "informational": { "type": "array", "description": "Informational pay components on the check.", "items": { "$ref": "#/components/schemas/PayComponentResource1" } }, "taxes": { "type": "array", "description": "Tax pay components on the check.", "items": { "$ref": "#/components/schemas/PayComponentResource1" } } }, "description": "Check resource" }, "Link1": { "type": "object", "properties": { "href": { "type": "string" }, "hreflang": { "type": "string" }, "title": { "type": "string" }, "type": { "type": "string" }, "deprecation": { "type": "string" }, "profile": { "type": "string" }, "name": { "type": "string" }, "templated": { "type": "boolean" } } }, "OrganizationResource1": { "type": "object", "properties": { "organizationId": { "type": "string", "description": "The unique identifier associated with this organizations representation.", "example": "1020022951957523" }, "name": { "type": "string", "description": "The name of the organization.", "example": "2 Division B" }, "number": { "type": "string", "description": "The number assigned to the organization.", "example": "1" }, "level": { "type": "string", "description": "The level number within the organizational structures hierarchy." }, "_links": { "type": "array", "readOnly": true, "items": { "$ref": "#/components/schemas/Link1" } } }, "description": "The organization which the worker is part of." }, "PayComponentResource1": { "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.", "example": "1020026552555441" }, "name": { "type": "string", "description": "The name given to the pay component", "example": "Hourly" }, "classificationType": { "type": "string", "description": "The category that this component falls into.", "example": "REGULAR" }, "description": { "type": "string" }, "effectOnPay": { "type": "string", "description": "The effect that the pay component will have on the check amount.", "example": "ADDITION", "enum": [ "ADDITION", "ADDITION_WITH_IN_OUT", "EMPLOYER_INFORMATIONAL", "REDUCTION" ] }, "startDate": { "type": "string", "description": "The date that the pay component is able to be applied on a check.", "format": "date-time" }, "endDate": { "type": "string", "description": "The date that the pay component is not available to be applied on a check moving forward.", "format": "date-time" }, "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.", "example": "40.2" }, "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.", "example": "4" }, "payAmount": { "type": "string", "description": "The flat amount to be applied for this component. Not used with Rate, Hours, or Units." }, "organization": { "$ref": "#/components/schemas/OrganizationResource1" }, "lineDate": { "type": "string", "description": "This is used optionally for specifying a date that the earning was generated on.", "format": "date-time" }, "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." }, "CommunicationResource1": { "type": "object", "properties": { "communicationId": { "type": "string", "description": "The ID for the workers specific communication item." }, "type": { "type": "string", "description": "A set of communication types classifying an instruction that the customer, requester, or subject must comply with in order for the screening to go forward. NOTE: PHONE and EMAIL type supports BUSINESS and PERSONAL usage type only.MOBILE_PHONE, FAX and PAGER supports BUSINESS usage type only.This data field cannot be PATCHED.", "enum": [ "STREET_ADDRESS", "PO_BOX_ADDRESS", "PHONE", "MOBILE_PHONE", "FAX", "EMAIL", "PAGER" ] }, "usageType": { "type": "string", "description": "A code classifying a designated use associated with a contact method. For example, whether a telephone or email address is one for business communications or one primarily for personal use.This data field cannot be PATCHED.", "enum": [ "PERSONAL", "BUSINESS", "HOME", "WORK", "LOCATION_STREET_ADDRESS", "MAILING_ADDRESS" ] }, "dialCountry": { "type": "string", "description": "The country dialing code for a communication number" }, "dialArea": { "type": "string", "description": "The area dialing code for a communication number" }, "dialNumber": { "type": "string", "description": "The communication number, not including country dialing or area dialing codes" }, "dialExtension": { "type": "string", "description": "The extension of the associated communication number" }, "uri": { "type": "string", "description": "The mailto address as specified in RFC2368" }, "streetLineOne": { "type": "string", "description": "The street address line one" }, "streetLineTwo": { "type": "string", "description": "The street address line two" }, "postOfficeBox": { "type": "string", "description": "The postal office box. This data field cannot be PATCHED" }, "city": { "type": "string", "description": "The city name" }, "postalCode": { "type": "string", "description": "The zip-code" }, "postalCodeExtension": { "type": "string", "description": "The zip-code extension" }, "countrySubdivisionCode": { "type": "string", "description": "The state code (ISO 3166 subdivision code)" }, "countryCode": { "type": "string", "description": "The country code (ISO 3166 alpha-2)" }, "_links": { "$ref": "#/components/schemas/Links" } } }, "WorkerFederalTaxResource": { "type": "object", "properties": { "taxId": { "type": "string", "description": "The ID for the federal tax item.", "readOnly": true, "example": "3520000118851387" }, "filingStatus": { "type": "string", "description": "Filing status.", "example": "MARRIED_FILING_JOINTLY", "enum": [ "SINGLE_OR_MARRIED_FILING_SEPARATELY", "MARRIED_FILING_JOINTLY", "HEAD_OF_HOUSEHOLD" ] }, "multipleJobs": { "type": "string", "description": "See federal W-4 instructions.", "example": "false", "enum": [ "true", "false" ] }, "dependentsAmount": { "type": "string", "description": "See federal W-4 instructions.", "example": "123.45" }, "otherIncome": { "maximum": 999999999.99, "minimum": 0, "type": "string", "description": "See federal W-4 instructions.", "example": "23.45" }, "deductionsAmount": { "maximum": 999999999.99, "minimum": 0, "type": "string", "description": "See federal W-4 instructions.", "example": "2.45" }, "taxesWithheld": { "type": "string", "description": "Should federal taxes be withheld: \ntrue means federal taxes are withheld, \nfalse means federal taxes are NOT withheld. Earnings will still be reported to state and federal agencies.", "example": "true", "enum": [ "true", "false" ] }, "extraWithholdingAmount": { "maximum": 999999999.99, "minimum": 0, "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.", "example": "3.45" }, "overrideWithholdingAmount": { "maximum": 999999999.99, "minimum": 0, "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.", "example": "9.45" }, "extraWithholdingPercentage": { "maximum": 100, "minimum": 0, "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.", "example": "19.45" }, "overrideWithholdingPercentage": { "maximum": 100, "minimum": 0, "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.", "example": "31.95" } }, "description": "The representational state of the a worker's federal tax setup." }, "DirectDepositResourceV2": { "type": "object", "properties": { "directDepositId": { "type": "string", "description": "The ID for the direct deposit item.", "readOnly": true, "example": "1020026420675252" }, "startDate": { "type": "string", "description": "The date that this direct deposit will be applied to future pay periods. This data field cannot be PATCHED.", "format": "date-time", "example": "2017-09-11T00:00:00Z" }, "paymentType": { "type": "string", "description": "A type of payment for the direct deposit.", "example": "PERCENTAGE", "enum": [ "FLAT_DOLLAR_AMOUNT", "PERCENTAGE", "REMAINDER" ] }, "accountType": { "type": "string", "description": "Financial institutions account type. This data field cannot be PATCHED.", "example": "CHECKING", "enum": [ "CHECKING", "SAVINGS" ] }, "value": { "type": "number", "description": "The amount to be applied to this direct deposit.", "example": 75 }, "routingNumber": { "type": "string", "description": "The financial institutions routing number.This data field cannot be PATCHED.", "example": "222371863" }, "accountNumber": { "type": "string", "description": "The financial institutions account number.This data field cannot be PATCHED.", "example": "123456" }, "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.", "example": "1" }, "_links": { "$ref": "#/components/schemas/Links" } }, "description": "Worker direct deposit" }, "PayRateResource": { "type": "object", "properties": { "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**", "readOnly": true, "example": "970000054610137" }, "startDate": { "type": "string", "description": "The date when the pay rate is going to begin.", "format": "date-time" }, "rateNumber": { "type": "string", "description": "The number of the rate. A worker can have up to 25 different rates.", "example": "RATE_1" }, "rateType": { "type": "string", "description": "Type of rate.", "example": "RATE_1", "enum": [ "ANNUAL_SALARY", "PER_PAY_PERIOD_SALARY", "PIECEWORK_RATE", "DAILY_RATE", "HOURLY_RATE" ] }, "description": { "type": "string", "description": "Describes the rate for the worker. A maximum of 30 characters is allowed.", "example": "Security2" }, "amount": { "type": "string", "description": "The currency amount which this rate is applied.", "example": "40.2" }, "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.", "example": "25.25" }, "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.", "example": "3.25" }, "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.", "example": true }, "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)." }, "_links": { "$ref": "#/components/schemas/Links" } }, "description": "Worker Pay Rate" }, "StateTaxFieldsDescription": { "type": "object", "properties": { "countrySubdivisionCode": { "type": "string", "description": "The state abbreviation for a given state tax" }, "stateAllocationPercent": { "type": "string", "description": "The percentage of a worker's income to be applied to this state tax" }, "isResidentState": { "type": "string", "description": "Whether this worker is a resident in this state" }, "taxStatusType": { "type": "string", "description": "The withholding status for this state tax" }, "filingStatusType": { "type": "string", "description": "The filing status of the worker for this state tax" }, "additionalAmount": { "type": "number", "description": "See state tax documentation" }, "additionalPercent": { "type": "integer", "description": "See state tax documentation", "format": "int32" }, "flatDollarOverride": { "type": "number", "description": "See state tax documentation" }, "overridePercent": { "type": "number", "description": "See state tax documentation" } } }, "StateTaxResponse": { "type": "object", "properties": { "workerTaxId": { "type": "string" }, "countrySubdivisionCode": { "type": "string" }, "isResidentState": { "type": "boolean" }, "stateAllocationPercent": { "type": "integer", "format": "int32" }, "regulationType": { "type": "string" }, "taxStatusType": { "type": "string" }, "filingStatusType": { "type": "string" }, "additionalAmount": { "type": "number", "format": "double" }, "additionalPercent": { "type": "number", "format": "double" }, "overridePercent": { "type": "number", "format": "double" }, "flatDollarOverride": { "type": "number", "format": "double" }, "exemptionReasonDescription": { "type": "string" }, "workerTaxDeductions": { "type": "array", "items": { "$ref": "#/components/schemas/WorkerTaxDeductionResponse" } } } }, "WorkerTaxDeductionResponse": { "type": "object", "properties": { "workerTaxDeductionId": { "type": "object" }, "workerTaxDeductionName": { "type": "string" }, "amount": { "type": "integer", "format": "int32" }, "quantity": { "type": "number" } } }, "CustomEmploymentTypeResource1": { "type": "object", "properties": { "customEmploymentTypeId": { "type": "string", "description": "Unique ID for the custom employment type which the worker is assigned to. This data field cannot be PATCHED for IN_PROGRESS workers.", "example": "970008177269854" }, "customEmploymentTypeName": { "type": "string", "description": "The name of the custom employment type that the worker is assigned to.", "example": "Hybrid" } }, "description": "The workers custom employment type", "example": "FULL_TIME_CUSTOM_1" }, "JobTitleResource1": { "type": "object", "properties": { "jobTitleId": { "type": "string", "description": "Unique ID for that job within the company that the worker is assigned to.", "example": "00DWS906IMW2JSH8AQJ8" }, "title": { "type": "string", "description": "The name of the title that the worker is assigned to.", "example": "Archaeologist" } }, "description": "The workers current job/position information." }, "LegalIdResource1": { "type": "object", "properties": { "legalIdType": { "type": "string", "description": "A value that identifies the type of taxpayer identification number provided. SSN: Social Security Number - 9 digit number , FEIN: Federal Employer Identification Number (EIN)", "enum": [ "SSN", "FEIN" ] }, "legalIdValue": { "type": "string", "description": "The federal level taxpayer id number that the worker has provided", "example": "333221111" } }, "description": "The workers legal tax identification information. This data field cannot be PATCHED for ACTIVE workers." }, "Status1": { "type": "object", "properties": { "workerStatusId": { "type": "string", "description": "The unique identifier associated with this status representation.", "example": "00DWS906IMW2JSH8AQJ9" }, "statusType": { "type": "string", "description": "The workers current status.", "example": "ACTIVE", "enum": [ "ACTIVE", "INACTIVE", "TERMINATED", "PENDING", "IN_PROGRESS" ] }, "statusReason": { "type": "string", "description": "The detailed reason of the workers current status.", "example": "HIRED" }, "effectiveDate": { "type": "string", "description": "Date that this status has started for the worker.", "format": "date-time", "example": "2015-06-15T00:00:00Z" }, "order": { "type": "integer", "format": "int32" }, "_links": { "$ref": "#/components/schemas/Links" } }, "description": "The workers employment status information. This data field cannot be POSTED or PATCHED for an IN_PROGRESS worker.", "example": "ACTIVE" }, "SupervisorResource1": { "type": "object", "properties": { "workerId": { "type": "string", "description": "The supervisor's Id", "example": "00H2A1IUJ4IPERJ589YE" }, "name": { "$ref": "#/components/schemas/NameResource1" } }, "description": "The workers supervisor information.Supervisor cannot be a TERMINATED or IN_PROGRESS worker.Only individuals who are designated as 'workers' will be returned. This includes 'Supervisors', who must also possess the 'worker' designation to be included. Individuals designated solely as 'users' will not have their data returned by this API." }, "WorkerResourceV2": { "type": "object", "properties": { "workerId": { "type": "string", "description": "The unique identifier associated with this worker representation.", "example": "00Z5V9BTIHRQF2CF7BTH" }, "employeeId": { "type": "string", "description": "The workers employee identification information.", "example": "3052" }, "workerType": { "type": "string", "description": "The type of worker. This data field cannot be PATCHED.NOTE: An IN_PROGRESS worker cannot be POSTED with a value of CONTRACTOR.", "example": "EMPLOYEE", "enum": [ "EMPLOYEE", "CONTRACTOR", "INDEPENDENT_CONTRACTOR" ] }, "employmentType": { "type": "string", "description": "The type of employment for the worker.", "example": "FULL_TIME", "enum": [ "FULL_TIME", "PART_TIME" ] }, "customEmploymentType": { "$ref": "#/components/schemas/CustomEmploymentTypeResource1" }, "exemptionType": { "type": "string", "description": "The Overtime classification of the worker. This data field cannot be PATCHED for ACTIVE workers.", "example": "NON_EXEMPT", "enum": [ "EXEMPT", "NON_EXEMPT" ] }, "workState": { "type": "string", "description": "The state(s) in which the worker works in." }, "birthDate": { "type": "string", "description": "The workers date of birth. It cannot be greater than today's date.", "format": "date-time", "example": "1988-07-01T00:00:00Z" }, "sex": { "type": "string", "example": "MALE", "enum": [ "MALE", "FEMALE", "NOT_SPECIFIED" ] }, "ethnicityCode": { "type": "string", "description": "Disclaimer:This parameter is not visible in Flex for the client. This data field cannot be PATCHED for ACTIVE workers." }, "hireDate": { "type": "string", "description": "The date which the worker was hired. It cannot be PATCHED for ACTIVE workers.", "format": "date-time", "example": "2015-06-15T00:00:00Z" }, "clockId": { "type": "string", "description": "The clock ID of the worker that can be an identification for other systems.", "example": "4321" }, "name": { "$ref": "#/components/schemas/NameResource1" }, "seniorityDate": { "type": "string", "description": "The workers seniority date. This data field cannot be POSTED or PATCHED.", "format": "date-time", "example": "2015-06-15T00:00:00Z" }, "profileImageURL": { "type": "string", "description": "The workers profile image url. This data field cannot be POSTED or PATCHED.", "example": "https://cdn.url/flexworkerphotos/wrkr0ad1b60a-45cc-4bbb-b5gc-299a832ce111.jpg" }, "legalId": { "$ref": "#/components/schemas/LegalIdResource1" }, "laborAssignmentId": { "type": "string", "description": "The workers home labor assignment.", "example": "970001557863345" }, "locationId": { "type": "string", "description": "The workers location.", "example": "970001701620675" }, "jobId": { "type": "string", "description": "The workers home job", "example": "970001557916904" }, "job": { "$ref": "#/components/schemas/JobTitleResource1" }, "organization": { "$ref": "#/components/schemas/OrganizationResource1" }, "supervisor": { "$ref": "#/components/schemas/SupervisorResource1" }, "currentStatus": { "$ref": "#/components/schemas/Status1" }, "communications": { "type": "array", "description": "Worker Communications. This data field cannot be updated for worker endpoint.", "items": { "$ref": "#/components/schemas/CommunicationResource1" } }, "_links": { "$ref": "#/components/schemas/Links" }, "workerCorrelationId": { "type": "string", "description": "Id that you define which is used for error handling/responses.This data field is used while POSTING multiple IN_PROGRESS workers" } } }, "WorkerDirectDepositFieldsDescription": { "required": [ "accountNumber", "accountType", "paymentType", "routingNumber", "value" ], "type": "object", "properties": { "priority": { "type": "string", "description": "The priority of the direct deposit." }, "accountNumber": { "type": "string", "description": "The financial institution's account number. This data field cannot be PATCHED." }, "nickname": { "type": "string", "description": "A friendly name for the direct deposit." }, "routingNumber": { "type": "string", "description": "The financial institution's routing number. This data field cannot be PATCHED." }, "accountType": { "type": "string", "description": "The financial institution's account type. This data field cannot be PATCHED.", "example": "CHECKING", "enum": [ "CHECKING", "SAVINGS" ] }, "paymentType": { "type": "string", "description": "The type of payment for the direct deposit.", "example": "FLAT_DOLLAR_AMOUNT", "enum": [ "FLAT_DOLLAR_AMOUNT", "PERCENTAGE", "REMAINDER" ] }, "value": { "type": "number", "description": "The amount to be applied to this direct deposit." }, "startDate": { "type": "string", "description": "The date that this direct deposit will be applied.", "format": "date-time" }, "endDate": { "type": "string", "description": "The date that this direct deposit will not longer be applied.", "format": "date-time" } } }, "TimeOffResource": { "type": "object", "properties": { "policyId": { "type": "string", "description": "The unique ID assigned to the company policy.", "example": "970002308485816" }, "type": { "type": "string", "description": "The policy type the client has assigned at the company level", "example": "Vacation" }, "name": { "type": "string", "description": "The name of the policy the client has assigned at the company level.", "example": "Vacation" }, "balance": { "type": "string", "description": "The current balance for this worker, for the associated policy type.", "example": "40" }, "measure": { "type": "string", "description": "Type of measurement type to be applied to the balance.", "example": "HOURS", "enum": [ "HOURS", "UNITS" ] } }, "description": "The representational state of a workers time off." }, "WorkerShiftResource": { "type": "object", "properties": { "shiftId": { "type": "string" }, "workerId": { "type": "string" }, "regularMinutes": { "type": "number", "format": "float" }, "otMinutes": { "type": "number", "format": "float" }, "dates": { "type": "array", "items": { "type": "string", "format": "date-time" } } } }, "ProfileImageEntity": { "type": "object", "properties": { "fileName": { "type": "string" }, "base64Image": { "type": "string" } } }, "I9StatusResource": { "type": "object", "properties": { "status": { "type": "string", "description": "The I9 status of a worker.Possible Statuses: Not Started, Started, Section 1 Completed, Section 2 Completed" }, "isRemoteI9": { "type": "boolean", "description": "If the I9 verification is being done remotely" }, "remoteType": { "type": "string", "description": "Type of remote verification being done" }, "createdDate": { "type": "string", "description": "The date the I9 task was created for the Worker" }, "lastUpdated": { "type": "string", "description": "The date the I9 task was last updated for the Worker" }, "_links": { "$ref": "#/components/schemas/Links" } } }, "CollectionResource": { "type": "object", "properties": { "metadata": { "$ref": "#/components/schemas/MetadataResource" }, "content": { "type": "array", "items": { "type": "object" } }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ErrorResource" } }, "message": { "type": "string" }, "_links": { "$ref": "#/components/schemas/Links" } } }, "PayRatesStandardResource": { "type": "object", "properties": { "payStandards": { "$ref": "#/components/schemas/PayStandardResource" }, "payRates": { "type": "array", "items": { "$ref": "#/components/schemas/PayRateResource" } } }, "description": "Worker Pay Rate Standard" }, "PayStandardResource": { "type": "object", "properties": { "payFrequency": { "type": "string", "description": "How often a worker is paid.", "example": "MONTHLY", "enum": [ "WEEKLY", "BI_WEEKLY", "SEMI_MONTHLY", "MONTHLY" ] }, "overtimeFactor": { "type": "string", "description": "Default overtime factor that would be applied for overtime work completed.", "example": "1.5" }, "calculatedPayPeriod": { "type": "string", "description": "Calculated amount of compensation based on rate defaults.", "example": "1704.1" }, "calculatedAnnualSalary": { "type": "string", "description": "Calculated amount of compensation based on calculatedPayPeriod and payFrequency.", "example": "20449.2" }, "calculatedAnnualSalaryFromHistory": { "type": "string", "description": "Calculated Annual Salary based on historical actual check amounts.", "example": "2500.0" } }, "description": "Worker Pay Standard" }, "CheckResource_Internal1": { "type": "object", "properties": { "workerId": { "type": "string", "description": "The id assigned to the worker", "example": "004UWBZQJ7GEB9TVWFR9" }, "paycheckId": { "type": "string", "description": "The id of a single check that a workers has.", "readOnly": true, "example": "1020026552555444" }, "payPeriodId": { "type": "string", "description": "The id for the unprocessed payperiod.", "example": "1020026427391732" }, "checkCorrelationId": { "type": "string", "description": "Id that you define which is used for error handling/responses. This is not required when sending a single check.", "example": "yourID_1" }, "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.", "example": false, "enum": [ true, false ] }, "earnings": { "type": "array", "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.\n2. payHours and payRate: Will allow you to define the monetary rate that the hours will be applied against.\n3. payHours and payRateId: Will allow you to define which workers predefined pay rate the hours will be applied against.\n4. payUnits: Will use the default hourly rate defined on the worker to apply the units against.\n5. payUnits and payRate: Will allow you to define the monetary rate that the units will be applied against.\n6. payUnits and payRateId: Will allow you to define which workers predefined pay rate the units will be applied against.\n7. payAmount: Will allow you to define straight monetary amount.", "items": { "$ref": "#/components/schemas/PayComponentResource_Internal1" } }, "deductions": { "type": "array", "description": "Deduction pay components on the check.", "items": { "$ref": "#/components/schemas/PayComponentResource_Internal1" } }, "informational": { "type": "array", "description": "Informational pay components on the check.", "items": { "$ref": "#/components/schemas/PayComponentResource_Internal1" } }, "taxes": { "type": "array", "description": "Tax pay components on the check.", "items": { "$ref": "#/components/schemas/PayComponentResource_Internal1" } } }, "description": "Check resource" }, "OrganizationResource_Internal1": { "type": "object", "properties": { "organizationId": { "type": "string", "description": "The unique identifier associated with this organizations representation.", "example": "1020022951957523" }, "name": { "type": "string", "description": "The name of the organization.", "example": "2 Division B" }, "number": { "type": "string", "description": "The number assigned to the organization.", "example": "1" }, "level": { "type": "string", "description": "The level number within the organizational structures hierarchy." } }, "description": "The organization which the worker is part of." }, "PayComponentResource_Internal1": { "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.", "example": "1020026552555441" }, "name": { "type": "string", "description": "The name given to the pay component", "example": "Hourly" }, "classificationType": { "type": "string", "description": "The category that this component falls into.", "example": "REGULAR" }, "description": { "type": "string" }, "effectOnPay": { "type": "string", "description": "The effect that the pay component will have on the check amount.", "example": "ADDITION", "enum": [ "ADDITION", "ADDITION_WITH_IN_OUT", "EMPLOYER_INFORMATIONAL", "REDUCTION" ] }, "startDate": { "type": "string", "description": "The date that the pay component is able to be applied on a check.", "format": "date-time" }, "endDate": { "type": "string", "description": "The date that the pay component is not available to be applied on a check moving forward.", "format": "date-time" }, "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.", "example": "40.2" }, "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.", "example": "4" }, "payAmount": { "type": "string", "description": "The flat amount to be applied for this component. Not used with Rate, Hours, or Units." }, "organization": { "$ref": "#/components/schemas/OrganizationResource_Internal1" }, "lineDate": { "type": "string", "description": "This is used optionally for specifying a date that the earning was generated on.", "format": "date-time" }, "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." }, "WorkerAssignmentDistributionsResource": { "type": "object", "properties": { "jobId": { "type": "string", "description": "The job associated with this distribution", "readOnly": true, "example": "970001557916904" }, "laborAssignmentId": { "type": "string", "description": "The labor assignment associated with this distribution.", "example": "970001701620607" }, "value": { "type": "string", "description": "The allocation of the assignment distribution (percentage).", "example": "60" } }, "description": "Worker Assignment Distributions" }, "MarketingCommunicationResource": { "type": "object", "properties": { "type": { "type": "string" }, "usageType": { "type": "string" }, "uri": { "type": "string" } } }, "WorkerMarketingEmailResource": { "type": "object", "properties": { "workerId": { "type": "string" }, "name": { "$ref": "#/components/schemas/NameResource1" }, "communications": { "type": "array", "items": { "$ref": "#/components/schemas/MarketingCommunicationResource" } }, "currentStatus": { "$ref": "#/components/schemas/Status1" }, "_links": { "$ref": "#/components/schemas/Links" } } }, "CheckResource2": { "type": "object", "properties": { "workerId": { "type": "string", "description": "The worker Id", "example": "00Z5V9BTIJAH537DF8R0" }, "paycheckId": { "type": "string", "description": "The paycheck Id", "example": "970003547324810" }, "payPeriodId": { "type": "string", "description": "The id of payperiod. ", "example": "1020026427391732" }, "checkCorrelationId": { "type": "string", "description": "Id that you define which is used for error handling/responses. This is not required when sending a single check." }, "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.", "example": false, "enum": [ true, false ] }, "earnings": { "type": "array", "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.\n2. payHours and payRate: Will allow you to define the monetary rate that the hours will be applied against.\n3. payHours and payRateId: Will allow you to define which workers predefined pay rate the hours will be applied against.\n4. payUnits: Will use the default hourly rate defined on the worker to apply the units against.\n5. payUnits and payRate: Will allow you to define the monetary rate that the units will be applied against.\n6. payUnits and payRateId: Will allow you to define which workers predefined pay rate the units will be applied against.\n7. payAmount: Will allow you to define straight monetary amount.8. payRateId: For Salary workers only, the Salary Pay Rate Id can be used with payHours and memoed set to true, or without payHours.", "items": { "$ref": "#/components/schemas/PayComponentResource2" } }, "deductions": { "type": "array", "description": "Deduction pay components on the check.", "items": { "$ref": "#/components/schemas/PayComponentResource2" } }, "informational": { "type": "array", "description": "Informational pay components on the check.", "items": { "$ref": "#/components/schemas/PayComponentResource2" } }, "links": { "type": "array", "items": { "$ref": "#/components/schemas/Link" } } } }, "PayComponentResource2": { "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.", "readOnly": true, "example": "970000053577899" }, "checkComponentId": { "type": "string", "description": "The unique identifier associated for the pay component on this check.", "readOnly": true, "example": "1020026552555441" }, "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": "Description" }, "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" ] }, "startDate": { "type": "string", "description": "The date that the pay component is able to be applied on a check.", "format": "date-time" }, "endDate": { "type": "string", "description": "The date that the pay component is not available to be applied on a check moving forward.", "format": "date-time" }, "appliesToWorkerTypes": { "type": "array", "description": "Applies To WorkerTypes.", "items": { "type": "string", "description": "The type of worker. This data field cannot be PATCHED.NOTE: An IN_PROGRESS worker cannot be POSTED with a value of CONTRACTOR.", "enum": [ "EMPLOYEE", "CONTRACTOR", "INDEPENDENT_CONTRACTOR" ] } }, "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." }, "memoed": { "type": "boolean", "description": "This is used optionally for memoing the payHours or payUnits so that they are informational when using a payAmount." }, "lineDate": { "type": "string", "description": "This is used optionally for specifying a date that the pay component was generated on.", "format": "date-time" }, "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." } }, "description": "Informational pay components on the check." }, "OrganizationResource2": { "type": "object", "properties": { "organizationId": { "type": "string" }, "name": { "type": "string" }, "number": { "type": "string" }, "level": { "type": "string" }, "children": { "type": "array", "items": { "$ref": "#/components/schemas/OrganizationResource2" } } } }, "ProcessedCheckComponentResource": { "type": "object", "properties": { "componentId": { "type": "string" }, "checkComponentId": { "type": "string" }, "name": { "type": "string" }, "classificationType": { "type": "string" }, "effectOnPay": { "type": "string", "enum": [ "ADDITION", "ADDITION_WITH_IN_OUT", "EMPLOYER_INFORMATIONAL", "REDUCTION" ] }, "memoed": { "type": "boolean" }, "laborAssignmentId": { "type": "string" }, "organization": { "$ref": "#/components/schemas/OrganizationResource2" }, "jobName": { "type": "string" }, "jobId": { "type": "string" }, "paidBy": { "type": "string" }, "isBlocked": { "type": "boolean" }, "lineDate": { "type": "string", "format": "date-time" }, "amount": { "type": "string" }, "rate": { "type": "string" }, "hours": { "type": "string" }, "units": { "type": "string" }, "workerPayCompScheduledEntries": { "type": "array", "items": { "$ref": "#/components/schemas/WorkerPayCompScheduledEntryResource" } }, "blocked": { "type": "boolean", "writeOnly": true } } }, "ProcessedCheckResource": { "type": "object", "properties": { "payPeriodId": { "type": "string" }, "paycheckId": { "type": "string" }, "workerId": { "type": "string" }, "checkDate": { "type": "string", "format": "date-time" }, "netPay": { "type": "string" }, "checkType": { "type": "string" }, "checkNumber": { "type": "string" }, "earnings": { "type": "array", "items": { "$ref": "#/components/schemas/ProcessedCheckComponentResource" } }, "deductions": { "type": "array", "items": { "$ref": "#/components/schemas/ProcessedCheckComponentResource" } }, "informational": { "type": "array", "items": { "$ref": "#/components/schemas/ProcessedCheckComponentResource" } }, "taxes": { "type": "array", "items": { "$ref": "#/components/schemas/ProcessedCheckComponentResource" } }, "grossEarnings": { "type": "string" }, "links": { "type": "array", "items": { "$ref": "#/components/schemas/Link" } } } }, "TransactionDetailsResource": { "type": "object", "properties": { "earliestTransactionDate": { "type": "string", "format": "date-time" }, "latestTransactionDate": { "type": "string", "format": "date-time" }, "transactions": { "type": "array", "items": { "$ref": "#/components/schemas/TransactionResource" } } } }, "TransactionResource": { "type": "object", "properties": { "transactionId": { "type": "string" }, "date": { "type": "string", "format": "date-time" }, "amount": { "type": "number", "format": "double" } } }, "WorkerPayCompScheduledEntryResource": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "clientPayrollId": { "type": "integer", "format": "int64" }, "checkDate": { "type": "string", "format": "date-time" }, "scheduledAmount": { "type": "number", "format": "double" }, "processedAmount": { "type": "number", "format": "double" }, "sequenceId": { "type": "integer", "format": "int64" }, "transactionDetails": { "$ref": "#/components/schemas/TransactionDetailsResource" } } }, "CompanyIdResource": { "type": "object", "properties": { "companyId": { "type": "string" } } }, "CheckSummaryResource": { "type": "object", "properties": { "payPeriodId": { "type": "string" }, "checkDate": { "type": "string", "format": "date-time" }, "payRunDate": { "type": "string", "format": "date-time" }, "totalHrs": { "type": "string" }, "checkNumber": { "type": "string" }, "totalEarnings": { "type": "string" }, "totalWithholdings": { "type": "string" }, "totalDeductions": { "type": "string" }, "netPay": { "type": "string" }, "checkType": { "type": "string" }, "grossYTD": { "type": "string" }, "netYTD": { "type": "string" }, "links": { "type": "array", "items": { "$ref": "#/components/schemas/Link" } } } }, "Readiness": { "type": "object", "properties": { "busy": { "type": "boolean" }, "busyReason": { "type": "string" } } }, "Liveness": { "type": "object", "properties": { "health": { "type": "boolean" }, "healthReason": { "type": "string" } } }, "HealthMonitoring": { "type": "object", "properties": { "health": { "type": "boolean" }, "healthReason": { "type": "string" }, "busy": { "type": "boolean" }, "busyReason": { "type": "string" } } }, "PartnerLinkRequestResource": { "required": [ "displayId" ], "type": "object", "properties": { "displayId": { "type": "string", "description": "The client account number used for identification purposes. (no dash or spaces allowed, only the last 8 characters of the ID)" } } }, "DeepUrlResponseResource": { "type": "object", "properties": { "approvalLink": { "type": "string", "description": "The deeplink URL that redirects a Flex client Admin to the Flex integrated apps drawer for their approval or denial of the partner integration" } } }, "AcknowledgementResource": { "type": "object", "properties": { "status": { "type": "string" }, "description": { "type": "string" } } }, "Authentication1": { "required": [ "authType" ], "type": "object", "properties": { "authType": { "type": "string", "description": "The authorization method used to authorize callers to your webhook url.", "enum": [ "NO_AUTH", "BASIC_AUTH", "API_KEY", "OAUTH2", "OAUTH2_BASIC" ] }, "apiKey": { "type": "string", "description": "The API key required for API_KEY authorization." }, "username": { "type": "string", "description": "The username required for BASIC_AUTH authorization." }, "password": { "type": "string", "description": "The password required for BASIC_AUTH authorization." }, "tokenUrl": { "type": "string", "description": "The URL used to obtain an access token for OAUTH2 or OAUTH2_BASIC authorization." }, "clientId": { "type": "string", "description": "The client ID required by OAUTH2 and OAUTH2_BASIC authorization." }, "clientSecret": { "type": "string", "description": "The client secret required by OAUTH2 and OAUTH2_BASIC authorization." }, "grantType": { "type": "string", "description": "The grant type used to acquire an access token by OAUTH2 and OAUTH2_BASIC authorization." }, "contentType": { "type": "string", "description": "The content type to use in the token request for OAUTH2 and OAUTH2_BASIC authorization." } }, "description": "Required Authentication object is going to be different based on each authType.
* NO_AUTH doesn't have any other fields in authentication object
* BASIC_AUTH needs 2 fields: username and password
* APIKEY requires the field: apiKey
* OAUTH2 requires 5 fields: tokenUrl, clientId, clientSecret, grantType, contentType
* OAUTH2_BASIC requires 5 fields: tokenUrl, clientId, clientSecret, grantType, contentType" }, "WebhookRequest": { "required": [ "authentication", "domains", "uri" ], "type": "object", "properties": { "hookId": { "type": "string", "description": "The unique identifier associated with this webhook. Not required for Posting." }, "uri": { "type": "string", "description": "Enter a valid URL for the webhook to receive events." }, "companyId": { "type": "string", "description": "ID associated with desired company that will receive the webhook notifications. NOTE: If no Company ID is provided in the POST, then all companies linked to the app will receive notifications." }, "authentication": { "$ref": "#/components/schemas/Authentication1" }, "domains": { "type": "array", "description": "List of available domains to register to. Refer to webhook documentation https://developer.paychex.com/documentation#operation/domains.", "items": { "type": "string", "description": "List of available domains to register to. Refer to webhook documentation https://developer.paychex.com/documentation#operation/domains." } }, "links": { "type": "array", "items": { "$ref": "#/components/schemas/Link" } } }, "description": "This resource is for registering/unregistering webhooks." }, "WebhookResponse": { "type": "object", "properties": { "hookId": { "type": "string" }, "companyId": { "type": "string" }, "uri": { "type": "string" }, "authType": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "active": { "type": "boolean" }, "domains": { "type": "array", "items": { "type": "string" } } } }, "EmailResource1": { "type": "object", "properties": { "primaryEmail": { "type": "string" }, "secondaryEmail": { "type": "string" }, "connectionName": { "type": "string" }, "displayId": { "type": "string" }, "legalName": { "type": "string" }, "notificationType": { "type": "string", "enum": [ "CONNECTION_ERROR", "DATA_ERROR", "WORKER_CHECK_ERROR", "MULTI_ID_SPI_REJECT", "EMPLOYEE_OVERTIME_NOTIFICATION", "COMPANY_PAY_PERIOD_ERROR", "PAYROLL_CONFIRMATION", "COMPANY_JOBCODE", "OFFBOARDING_SURVEY", "OFFBOARDING_ERROR", "WORKER_PUNCH_OR_ADJUSTMENT_ERROR", "WORKER_SCHEDULE_ERROR", "MIP_INTEGRATION_ERRORS" ] }, "workerErrors": { "type": "array", "items": { "$ref": "#/components/schemas/WorkerErrorResource" } }, "payPeriod": { "type": "string" }, "partnerLocationId": { "type": "string" }, "state": { "type": "string" }, "sourceJobName": { "type": "string" }, "bcc": { "type": "string" }, "employeeFirstName": { "type": "string" }, "employeeLastName": { "type": "string" }, "linkToSurvey": { "type": "string" }, "links": { "type": "array", "items": { "$ref": "#/components/schemas/Link" } }, "attachment": { "type": "array", "items": { "type": "string", "format": "byte" } } } }, "ErrorMessageResource": { "type": "object", "properties": { "errorType": { "type": "string" }, "description": { "type": "string" }, "resolution": { "type": "string" } } }, "WorkerErrorResource": { "type": "object", "properties": { "employeeFirstName": { "type": "string" }, "employeeLastName": { "type": "string" }, "employeeNumber": { "type": "string" }, "ErrorMessage": { "type": "array", "items": { "$ref": "#/components/schemas/ErrorMessageResource" } }, "links": { "type": "array", "items": { "$ref": "#/components/schemas/Link" } } } }, "CompanyStatusResource": { "required": [ "companyId", "status" ], "type": "object", "properties": { "companyId": { "type": "string" }, "status": { "type": "string" } } } }, "examples": { "JSONEXAMPLES": { "value": { "PROCESSED_CHECK_GET": { "value": { "content": [ { "payPeriodId": "970002146440893", "paycheckId": "00H2A1IUJVF8Y2EPA6XD", "workerId": "00H2A1IUJKSLXZ07NHIA", "checkDate": "2019-05-12T20:00:00Z", "netPay": "506.65", "checkType": "Regular", "checkNumber": "1", "earnings": [ { "componentId": "970000076689381", "checkComponentId": "970002146440900", "name": "Hourly", "classificationType": "Regular", "effectOnPay": "ADDITION", "memoed": false, "laborAssignmentId": "970001557863345", "organization": { "organizationId": "970001701620695", "name": "2 Level 2" }, "jobName": "My job 1", "amount": "400.0", "rate": "20", "hours": "20.0" }, { "componentId": "970000076689381", "checkComponentId": "970002146440900", "name": "Hourly", "classificationType": "Regular", "effectOnPay": "ADDITION", "memoed": false, "laborAssignmentId": "970001701620607", "organization": { "organizationId": "970001701620695", "name": "2 Level 2" }, "jobName": "My job 2", "amount": "400.0", "rate": "20", "hours": "20.0" } ], "deductions": [ { "componentId": "970000191960058", "checkComponentId": "970002146440901", "name": "IRA EE", "classificationType": "IRA", "effectOnPay": "REDUCTION", "memoed": false, "laborAssignmentId": "970001557863345", "organization": { "organizationId": "970001701620695", "name": "2 Level 2" }, "jobName": "My job 1", "amount": "200.0" } ], "informational": [ { "componentId": "970000191960058", "checkComponentId": "970002146440999", "name": "Info", "classificationType": "INFORMATIONAL", "effectOnPay": "INFORMATIONAL", "amount": "50.0" } ], "taxes": [ { "name": "Employee Medicare Tax", "laborAssignmentId": "970001557863345", "jobId": "970001557916904", "paidBy": "EMPLOYEE_WITHHOLDING", "amount": "11.6" }, { "name": "Employee Social Security Tax", "laborAssignmentId": "970001557863345", "jobId": "970001557916904", "paidBy": "EMPLOYEE_WITHHOLDING", "amount": "49.6" }, { "name": "Employer Medicare Tax", "laborAssignmentId": "970001557863345", "jobId": "970001557916904", "paidBy": "EMPLOYER_LIABILITY", "amount": "11.6" }, { "name": "Employer Social Security Tax", "laborAssignmentId": "970001557863345", "jobId": "970001557916904", "paidBy": "EMPLOYER_LIABILITY", "amount": "49.6" }, { "name": "Federal Income Tax", "laborAssignmentId": "970001557863345", "jobId": "970001557916904", "paidBy": "EMPLOYEE_WITHHOLDING", "amount": "28.33" }, { "name": "Federal Unemployment Insurance", "laborAssignmentId": "970001557863345", "jobId": "970001557916904", "paidBy": "EMPLOYER_LIABILITY", "amount": "4.8" }, { "name": "New York Disability Insurance", "laborAssignmentId": "970001557863345", "jobId": "970001557916904", "paidBy": "EMPLOYEE_WITHHOLDING", "amount": "2.6" }, { "name": "New York Income Tax", "laborAssignmentId": "970001557863345", "jobId": "970001557916904", "paidBy": "EMPLOYEE_WITHHOLDING", "amount": "0.0" }, { "name": "New York Paid Family Leave Insurance", "laborAssignmentId": "970001557863345", "jobId": "970001557916904", "paidBy": "EMPLOYEE_WITHHOLDING", "amount": "1.22" }, { "name": "New York Unemployment Insurance", "laborAssignmentId": "970001557863345", "jobId": "970001557916904", "paidBy": "EMPLOYER_LIABILITY", "amount": "25.0" }, { "name": "Re-employment Service Fund", "laborAssignmentId": "970001557863345", "jobId": "970001557916904", "paidBy": "EMPLOYER_LIABILITY", "amount": "0.6" } ] } ] } }, "UN_PROCESSED_CHECK_GET": { "value": { "content": [ { "workerId": "004UWBZQJ7GEB9TVWFR9", "paycheckId": "1020026552555444", "payPeriodId": "1020026427391732", "earnings": [ { "componentId": "1020021373899133", "checkComponentId": "1020026552555441", "name": "Hourly", "classificationType": "REGULAR", "effectOnPay": "ADDITION", "payRate": "40.2000", "payHours": "4", "organization": { "organizationId": "1020022951957515", "name": " Branch A - East", "number": "1", "level": "Level 1" } }, { "componentId": "1020021373899133", "checkComponentId": "1020026552555445", "name": "Hourly", "classificationType": "REGULAR", "effectOnPay": "ADDITION", "payRate": "7.25", "payUnits": "8", "organization": { "organizationId": "1020022951957515", "name": " Branch A - East", "number": "1", "level": "Level 1" } }, { "componentId": "1020021373899318", "checkComponentId": "1020026552555447", "name": "Bonus", "classificationType": "SUPPLEMENTAL", "effectOnPay": "ADDITION", "payAmount": "300.60", "organization": { "organizationId": "1020022951957523", "name": " Branch B - West", "number": "2", "level": "Level 2" } } ], "links": [ { "rel": "self", "href": "https://api.paychex.com/workers/004UWBZQJ7GEB9TVWFR9/checks/1020026552555444" } ] }, { "workerId": "00Z1IQF9J0MIGR3K3VXO", "paycheckId": "1020026552555462", "payPeriodId": "1020026427391732", "blockAutoDistribution": true, "earnings": [ { "componentId": "1020021373899318", "checkComponentId": "1020026552555462", "name": "Bonus", "classificationType": "SUPPLEMENTAL", "effectOnPay": "ADDITION", "payAmount": "250.00", "organization": { "organizationId": "1020022951957523", "name": " Branch B - West", "number": "2", "level": "Level 2" } } ], "links": [ { "rel": "self", "href": "https://api.paychex.com/workers/00Z1IQF9J0MIGR3K3VXO/checks/1020026552555462" } ] } ] } }, "COMPANY_CALCBASE_GET": { "value": { "content": [ { "calculationBaseId": "00H2A1IUJE7MXV6TQ37Q", "calculationBaseName": "All earnings - employee cafeteria plan pre tax amounts" }, { "calculationBaseId": "00H2A1IUJE7MXV6TQ37S", "calculationBaseName": "All earnings - taxes" }, { "calculationBaseId": "00H2A1IUJE7MXV6TQ37U", "calculationBaseName": "All earnings" } ], "links": [ { "rel": "self", "href": "https://api.paychex.com/companies/00Z5V9BTIJOPZF9Y0NU3/calculationbases" } ] } }, "COMPANY_PAYCOMPONENTS_GET": { "value": { "content": [ { "componentId": "970000076689326", "name": "Old regular pay", "classificationType": "REGULAR", "description": "Use for regular pay.", "code": "1", "effectOnPay": "ADDITION", "startDate": "2017-01-01T00:00:00Z", "endDate": "2017-12-31T00:00:00Z", "appliesToWorkerTypes": [ "EMPLOYEE" ] }, { "componentId": "970000079956947", "name": "Deduction", "classificationType": "DEDUCTION", "description": "Use for any normal employee deduction.", "code": "12", "effectOnPay": "REDUCTION", "startDate": "2017-03-02T00:00:00Z", "appliesToWorkerTypes": [ "INDEPENDENT_CONTRACTOR", "EMPLOYEE" ] } ], "links": [ { "rel": "self", "href": "https://api.paychex.com/companies/99Z5V9BTI8J2FCGESC05/paycomponents" } ] } }, "COMPANY_PAYCOMPONENT_GET": { "value": { "content": [ { "componentId": "970000076689326", "name": "Old regular pay", "classificationType": "REGULAR", "description": "Use for regular pay.", "code": "1", "effectOnPay": "ADDITION", "startDate": "2017-01-01T00:00:00Z", "endDate": "2017-12-31T00:00:00Z", "appliesToWorkerTypes": [ "EMPLOYEE" ] } ], "links": [ { "rel": "self", "href": "https://api.paychex.com/companies/99Z5V9BTI8J2FCGESC05/paycomponents/970000076689326" } ] } }, "COMPANY_PAYCOMPONENT_POST_PATCH_REQ": { "value": { "startDate": "2023-01-01T00:00:00Z", "name": "Test CS Pay Comp" } }, "COMPANY_PAYCOMPONENT_POST_PATCH_RSPN": { "value": { "content": [ { "payComponent": { "cltpcId": 987654321098765, "pcId": 12345678901234, "customName": "Test Pay Comp", "reportCode": "12", "isPaychexAdministered": false, "deductionPriority": 1, "startDate": "2022-12-31", "endDate": "4712-12-31" }, "frequencyData": { "cfId": 970006303193804, "frequencyOptionId": 1006585, "freqTypeId": 1004547, "frequencyType": "BY_PAY_PERIOD", "freqType": "by pay period", "payFreqId": 1016653, "payFrequency": "EVERY_PAY_PERIOD", "payFreq": "Every Pay Period", "firstCheckRuleId": 1016864, "firstCheckRuleType": "EVERY_CHECK", "firstCheckRule": "every check", "firstCheckOnly": false }, "calcMethods": [ { "ccmId": 970006303193802, "defaultTypeId": 1004475, "defaultType": "Employee defaults", "calcTypeId": 1000170, "calculationType": "FLAT_DOLLAR_AMOUNT", "calcType": "Flat dollar amount" } ] } ], "links": [] } }, "COMPANY_PPRDS_GET": { "value": { "metadata": { "contentItemCount": 3 }, "content": [ { "payPeriodId": "850000414358408", "intervalCode": "BI_WEEKLY", "status": "INITIAL", "description": "Bi-weekly Payroll (1)", "startDate": "2016-02-27T00:00:00Z", "endDate": "2016-03-11T00:00:00Z", "submitByDate": "2016-03-18T00:00:00Z", "checkDate": "2016-03-18T00:00:00Z", "checkCount": 0 }, { "payPeriodId": "850000524255195", "intervalCode": "BI_WEEKLY", "status": "REVERSED", "description": "Bi-weekly Payroll (1)", "startDate": "2017-09-09T00:00:00Z", "endDate": "2017-09-22T00:00:00Z", "submitByDate": "2017-09-27T00:00:00Z", "checkDate": "2017-09-29T00:00:00Z", "checkCount": 1 }, { "payPeriodId": "970007831913645", "status": "COMPLETED", "description": "Reverse", "startDate": "2017-09-09T00:00:00Z", "endDate": "2017-09-22T00:00:00Z", "submitByDate": "2017-09-22T00:00:00Z", "checkDate": "2017-09-29T00:00:00Z", "checkCount": 1, "originalPayPeriodID": "850000524255195" } ], "links": [ { "rel": "self", "href": "https://api.paychex.com/companies/99Z5V9BTI8J2FCGESC05/payperiods" } ] } }, "COMPANY_V2_PPRDS_GET": { "value": { "metadata": { "contentItemCount": 3 }, "content": [ { "payPeriodId": "850000414358408", "intervalCode": "BI_WEEKLY", "status": "INITIAL", "description": "Bi-weekly Payroll (1)", "startDate": "2016-02-27T00:00:00Z", "endDate": "2016-03-11T00:00:00Z", "submitByDate": "2016-03-18T00:00:00Z", "checkDate": "2016-03-18T00:00:00Z", "checkCount": 0, "payrollId": "970009031710598" }, { "payPeriodId": "850000524255195", "intervalCode": "BI_WEEKLY", "status": "REVERSED", "description": "Bi-weekly Payroll (1)", "startDate": "2017-09-09T00:00:00Z", "endDate": "2017-09-22T00:00:00Z", "submitByDate": "2017-09-27T00:00:00Z", "checkDate": "2017-09-29T00:00:00Z", "checkCount": 1, "payrollId": "970009070857734" }, { "payPeriodId": "970007831913645", "status": "COMPLETED", "description": "Reverse", "startDate": "2017-09-09T00:00:00Z", "endDate": "2017-09-22T00:00:00Z", "submitByDate": "2017-09-22T00:00:00Z", "checkDate": "2017-09-29T00:00:00Z", "checkCount": 1, "originalPayPeriodID": "850000524255195", "payrollId": "970009031710583" } ], "links": [ { "rel": "self", "href": "https://api.paychex.com/companies/99Z5V9BTI8J2FCGESC05/payperiods" } ] } }, "COMPANY_PPRD_GET": { "value": { "metadata": { "contentItemCount": 1 }, "content": [ { "payPeriodId": "970003039332512", "intervalCode": "WEEKLY", "status": "COMPLETED", "description": "Weekly Payroll (1)", "startDate": "2020-02-05T00:00:00Z", "endDate": "2020-02-11T00:00:00Z", "submitByDate": "2020-02-14T00:00:00Z", "checkDate": "2020-02-14T00:00:00Z", "checkCount": 161, "originalPayPeriodID": "970007200172705" } ], "links": [ { "rel": "self", "href": "https://api.paychex.com/companies/00H2A1IUK695XL45NDO6/payperiods/970003039332512" } ] } }, "COMPANY_V2_PPRD_GET": { "value": { "metadata": { "contentItemCount": 1 }, "content": [ { "payPeriodId": "970003039332512", "intervalCode": "WEEKLY", "status": "COMPLETED", "description": "Weekly Payroll (1)", "startDate": "2020-02-05T00:00:00Z", "endDate": "2020-02-11T00:00:00Z", "submitByDate": "2020-02-14T00:00:00Z", "checkDate": "2020-02-14T00:00:00Z", "checkCount": 161, "originalPayPeriodID": "970007200172705", "payrollId": "970009031710583" } ], "links": [ { "rel": "self", "href": "https://api.paychex.com/companies/00H2A1IUK695XL45NDO6/payperiods/970003039332512" } ] } }, "COMPANY_PAYFREQUENCIES_GET": { "value": { "metadata": { "contentItemCount": 2 }, "content": [ { "payFrequency": "WEEKLY", "payComponentFrequency": { "applied": "BY_PAY_PERIOD", "occurrence": "SEMI_MONTHLY", "occurrenceIntervals": { "interval1": "1", "interval2": "4" } } }, { "payFrequency": "WEEKLY", "payComponentFrequency": { "applied": "BY_PAY_PERIOD", "occurrence": "SEMI_MONTHLY", "occurrenceIntervals": { "interval1": "1", "interval2": "Last" } } } ], "links": [ { "rel": "self", "href": "https://api.paychex.com/companies/00Z5V9BTIJOPZF9Y0NU3/payFrequencies" } ] } }, "COMPANY_LOCATIONS_GET": { "value": { "content": [ { "locationId": "970000106981852", "name": "Location1", "address": { "streetLineOne": "675 Basket Rd", "city": "Webster", "postalCode": "14580", "countrySubdivisionCode": "NY", "countryCode": "US" }, "movedIn": "2017-07-25T00:00:00Z" }, { "locationId": "970001451713467", "name": "Location 2", "address": { "streetLineOne": "1891 Ridge Rd", "city": "Webster", "postalCode": "14580", "countrySubdivisionCode": "NY", "countryCode": "US" }, "movedIn": "2017-07-25T00:00:00Z" } ] } }, "COMPANY_LOCATION_GET": { "value": { "content": [ { "locationId": "970004678670972", "name": "org location test", "address": { "streetLineOne": "Street 1", "streetLineTwo": "2nd Main", "city": "Elk Grove Township", "postalCode": "60007", "countrySubdivisionCode": "IL", "countryCode": "US" }, "movedIn": "2021-04-05T00:00:00Z" } ] } }, "COMPANY_LBRASSIGNMENTS_GET": { "value": { "content": [ { "laborAssignmentId": "970001701620720", "name": "Assignment 3", "startDate": "2019-01-24T00:00:00Z", "endDate": "2029-12-24T00:00:00Z", "organizationId": "970001701620691", "positionId": "970000180782611", "locationId": "970001701620683" }, { "laborAssignmentId": "970001701620607", "name": "Assignement2", "startDate": "2018-12-09T00:00:00Z", "locationId": "970001701620675" } ] } }, "COMPANY_LBRASSIGNMENT_GET": { "value": { "content": [ { "laborAssignmentId": "970003437117733", "name": "assignment 1", "startDate": "2020-04-20T00:00:00Z", "organizationId": "970003163104803" } ], "links": [] } }, "COMPANIES_GET": { "value": { "metadata": { "contentItemCount": 1 }, "content": [ { "companyId": "99Z5V9BTI8J2FCGESC05", "displayId": "09620579", "legalName": "Monsters, Inc", "hasPermission": true, "legalId": { "legalIdType": "FEIN", "legalIdValue": "995886885" }, "communications": [ { "type": "STREET_ADDRESS", "usageType": "BUSINESS", "streetLineOne": "Mike St", "streetLineTwo": "Sulley Ln", "city": "ANAHEIM", "countrySubdivisionCode": "CA", "postalCode": "92802", "postalCodeExtension": "7890", "countryCode": "US" } ], "links": [ { "rel": "self", "href": "https://api.paychex.com/companies/99Z5V9BTI8J2FCGESC05" }, { "rel": "workers", "href": "https://api.paychex.com/companies/99Z5V9BTI8J2FCGESC05/workers" } ] } ], "links": [ { "rel": "self", "href": "https://api.paychex.com/companies" } ] } }, "COMPANY_GET_IDS": { "value": { "content": [ { "companyId": "99Z5V9BTI8J2FCGESC05", "displayId": "09620579", "links": [ { "rel": "self", "href": "https://api.paychex.com/companies/99Z5V9BTI8J2FCGESC05" }, { "rel": "workers", "href": "https://api.paychex.com/companies/99Z5V9BTI8J2FCGESC05/workers" } ] } ] } }, "COMPANY_GET": { "value": { "content": [ { "companyId": "99Z5V9BTI8J2FCGESC05", "displayId": "09620579", "legalName": "Monsters, Inc", "hasPermission": true, "legalId": { "legalIdType": "FEIN", "legalIdValue": "995886885" }, "communications": [ { "type": "STREET_ADDRESS", "usageType": "BUSINESS", "streetLineOne": "Mike St", "streetLineTwo": "Sulley Ln", "city": "ANAHEIM", "countrySubdivisionCode": "CA", "postalCode": "92802", "postalCodeExtension": "7890", "countryCode": "US" } ], "lineage": { "successors": { "869f6544-a71f-4099-bebe-9177cf801edd": { "caid": "005BO0BGMIZYS5ET010P", "reasonType": "PC_CORE2PEO", "createdDate": "2025-12-10", "clientName": "BTD CORE SMALL 04-19-2024 0224", "taxPayerIdentification": { "id": "933340406", "type": "FEIN" } } }, "predecessors": { "2dcb142d-4c98-4853-ae47-995e047af6d8": { "caid": "008WQ28JLV6WUQ5P5RP2", "reasonType": "CHANGE_ENTITY", "createdDate": "2025-12-08", "clientName": "BTD CORE SMALL 04-19-2024 0224", "taxPayerIdentification": { "id": "933340406", "type": "FEIN" } } } }, "links": [ { "rel": "self", "href": "https://api.paychex.com/companies/99Z5V9BTI8J2FCGESC05" }, { "rel": "workers", "href": "https://api.paychex.com/companies/99Z5V9BTI8J2FCGESC05/workers" } ] } ] } }, "COMPANIES_ORG_GET": { "value": { "metadata": { "contentItemCount": 2 }, "content": [ { "organizationId": "850002407928081", "name": "1 Administration", "number": "1", "level": "Administration", "links": [ { "rel": "self", "href": "https://api.paychex.com/companies/00DCE1NVK0RYATB9JW57/organizations/850002407928081" }, { "rel": "parent", "href": "https://api.paychex.com/companies/00DCE1NVK0RYATB9JW57/organizations/850002407928079" } ] }, { "organizationId": "850002407928077", "name": "1 North Division", "number": "1", "level": "North Division", "links": [ { "rel": "self", "href": "https://api.paychex.com/companies/00DCE1NVK0RYATB9JW57/organizations/850002407928077" }, { "rel": "parent", "href": "https://api.paychex.com/companies/00DCE1NVK0RYATB9JW57/organizations/850001539951646" }, { "rel": "child", "href": "https://api.paychex.com/companies/00DCE1NVK0RYATB9JW57/organizations/850002407928079" } ] } ], "links": [ { "rel": "self", "href": "https://api.paychex.com/companies/00DCE1NVK0RYATB9JW57/organizations" } ] } }, "COMPANIES_ORGID_GET": { "value": { "content": [ { "organizationId": "850002407928077", "name": "1 North Division", "number": "1", "level": "North Division", "links": [ { "rel": "self", "href": "https://api.paychex.com/companies/00DCE1NVK0RYATB9JW57/organizations/850002407928077" }, { "rel": "parent", "href": "https://api.paychex.com/companies/00DCE1NVK0RYATB9JW57/organizations/850001539951646" }, { "rel": "child", "href": "https://api.paychex.com/companies/00DCE1NVK0RYATB9JW57/organizations/850002407928079" } ] } ] } }, "COMPANIES_WORKERS_GET": { "value": { "metadata": { "contentItemCount": 1 }, "content": [ { "workerId": "00H2A1IUKDU2H84400C9", "employeeId": "105", "workerType": "EMPLOYEE", "employmentType": "FULL_TIME", "exemptionType": "NON_EXEMPT", "workState": "IL", "birthDate": "1990-08-03T00:00:00Z", "sex": "NOT_SPECIFIED", "ethnicityCode": "WHITE_NOT_OF_HISPANIC_ORIGIN", "hireDate": "2019-09-03T00:00:00Z", "name": { "familyName": "Walker", "middleName": "L", "givenName": "Paul", "preferredName": "paul", "preferredLastName": "wilkins", "pronoun": "He/him/his" }, "seniorityDate": "2020-05-20T00:00:00Z", "profileImageURL": "https://cdn.url/demophotoid.jpg", "legalId": { "legalIdType": "SSN", "legalIdValue": "888889999" }, "laborAssignmentId": "970003437117733", "locationId": "970003436212414", "jobId": "970003585037029", "job": { "jobTitleId": "970003436212358", "title": "Developer" }, "organization": { "organizationId": "970003163104801", "name": "1 Branch 1 - north", "number": "1", "links": [] }, "supervisor": { "workerId": "00H2A1IUK6G2MM6ET8JT", "name": { "familyName": "H", "givenName": "Harshita", "qualificationAffixCode": "Sr", "titleAffixCode": "Rev" } }, "currentStatus": { "workerStatusId": "00DWS906IMW2JSH8AQJ9", "statusType": "ACTIVE", "statusReason": "HIRED", "effectiveDate": "2019-09-03T00:00:00Z" }, "links": [ { "rel": "self", "href": "https://api.paychex.com/workers/00H2A1IUKDU2H84400C9" }, { "rel": "communications", "href": "https://api.paychex.com/workers/00H2A1IUKDU2H84400C9/communications" }, { "rel": "supervisor", "href": "https://api.paychex.com/workers/00H2A1IUK6G2MM6ET8JT" } ] } ] } }, "COMPANIES_WORKERS_NONPII_GET": { "value": { "metadata": { "contentItemCount": 1 }, "content": [ { "workerId": "00H2A1IUKDU2H84400C9", "employeeId": "105", "workerType": "EMPLOYEE", "laborAssignmentId": "970003437117733", "employmentType": "FULL_TIME", "locationId": "970003436212414", "jobId": "970003585037029", "exemptionType": "NON_EXEMPT", "hireDate": "2019-09-03T00:00:00Z", "name": { "familyName": "Walker", "middleName": "L", "givenName": "Paul", "preferredName": "paul", "preferredLastName": "wilkins", "pronoun": "He/him/his" }, "seniorityDate": "2020-05-20T00:00:00Z", "profileImageURL": "https://cdn.url/demophotoid.jpg", "job": { "jobTitleId": "970003436212358", "title": "Developer" }, "organization": { "organizationId": "970003163104801", "name": "1 Branch 1 - north", "links": [] }, "currentStatus": { "workerStatusId": "00DWS906IMW2JSH8AQJ9", "statusType": "ACTIVE", "statusReason": "HIRED", "effectiveDate": "2019-09-03T00:00:00Z" }, "supervisor": { "workerId": "00H2A1IUK6G2MM6ET8JT", "name": { "familyName": "H", "givenName": "Harshita", "qualificationAffixCode": "Sr", "titleAffixCode": "Rev" } }, "links": [ { "rel": "self", "href": "https://api.paychex.com/workers/00H2A1IUKDU2H84400C9" }, { "rel": "communications", "href": "https://api.paychex.com/workers/00H2A1IUKDU2H84400C9/communications" }, { "rel": "supervisor", "href": "https://api.paychex.com/workers/00H2A1IUK6G2MM6ET8JT" } ] } ] } }, "COMPANIES_WORKERS_ROSTER_GET": { "value": { "metadata": { "contentItemCount": 1 }, "content": [ { "employeeId": "4449", "name": { "familyName": "Gibson", "givenName": "Vanessa", "pronoun": "He/him/his" }, "seniorityDate": "2020-05-20T00:00:00Z", "communications": [ { "type": "STREET_ADDRESS", "streetLineOne": "511 Brighton St", "city": "Rochester", "postalCode": "14604", "postalCodeExtension": "7890", "countrySubdivisionCode": "NY", "countryCode": "US" }, { "type": "PHONE", "usageType": "BUSINESS", "dialArea": "741", "dialNumber": "8529632" }, { "type": "EMAIL", "usageType": "PERSONAL", "uri": "testhome@gmail.com" } ] } ] } }, "COMPANIES_WORKERS_COMM_NONPII_GET": { "value": { "metadata": { "contentItemCount": 1 }, "content": [ { "workerId": "00Z5V9BTIJAH537CF8P7", "employeeId": "4449", "workerType": "EMPLOYEE", "employmentType": "PART_TIME", "locationId": "970001614528519", "exemptionType": "NON_EXEMPT", "hireDate": "2015-01-01T00:00:00Z", "name": { "familyName": "Gibson", "middleName": "W", "givenName": "Vanessa", "pronoun": "He/him/his" }, "seniorityDate": "2020-05-20T00:00:00Z", "organization": { "organizationId": "970000053577572", "name": "Company" }, "currentStatus": { "workerStatusId": "00DWS906IMW2JSH8AQJ9", "statusType": "ACTIVE", "statusReason": "HIRED", "effectiveDate": "2015-01-01T00:00:00Z" }, "communications": [ { "communicationId": "00Z5V9BTIXUGRBMM51EO", "type": "STREET_ADDRESS", "streetLineOne": "511 Brighton St", "city": "Rochester", "postalCode": "14604", "postalCodeExtension": "7890", "countrySubdivisionCode": "NY", "countryCode": "US", "links": [ { "rel": "self", "href": "https://api.paychex.com/workers/00Z5V9BTIJAH537CF8P7/communications/00Z5V9BTIXUGRBMM51EO" } ] } ], "links": [ { "rel": "self", "href": "https://api.paychex.com/workers/00Z5V9BTIJAH537CF8P7" }, { "rel": "communications", "href": "https://api.paychex.com/workers/00Z5V9BTIJAH537CF8P7/communications" } ] } ] } }, "COMPANIES_WORKERS_COMM_GET": { "value": { "metadata": { "contentItemCount": 1 }, "content": [ { "workerId": "00H2A1IUKDU2H84400C9", "employeeId": "105", "workerType": "EMPLOYEE", "employmentType": "FULL_TIME", "exemptionType": "NON_EXEMPT", "workState": "IL", "birthDate": "1990-08-03T00:00:00Z", "sex": "NOT_SPECIFIED", "ethnicityCode": "WHITE_NOT_OF_HISPANIC_ORIGIN", "hireDate": "2019-09-03T00:00:00Z", "name": { "familyName": "Walker", "middleName": "L", "givenName": "Paul", "preferredName": "paul", "preferredLastName": "wilkins", "pronoun": "He/him/his" }, "seniorityDate": "2020-05-20T00:00:00Z", "profileImageURL": "https://cdn.url/demophotoid.jpg", "legalId": { "legalIdType": "SSN", "legalIdValue": "888889999" }, "laborAssignmentId": "970003437117733", "locationId": "970003436212414", "jobId": "970003585037029", "job": { "jobTitleId": "970003436212358", "title": "Developer" }, "organization": { "organizationId": "970003163104801", "name": "1 Branch 1 - north", "number": "1", "links": [] }, "supervisor": { "workerId": "00H2A1IUK6G2MM6ET8JT", "name": { "familyName": "H", "givenName": "Harshita", "qualificationAffixCode": "Sr", "titleAffixCode": "Rev" } }, "currentStatus": { "workerStatusId": "00DWS906IMW2JSH8AQJ9", "statusType": "ACTIVE", "statusReason": "HIRED", "effectiveDate": "2019-09-03T00:00:00Z" }, "communications": [ { "communicationId": "00H2A1IUKDU2H84400CI", "type": "PHONE", "usageType": "BUSINESS", "dialArea": "741", "dialNumber": "8529632", "links": [ { "rel": "self", "href": "https://api.paychex.com/workers/00H2A1IUKDU2H84400C9/communications/00H2A1IUKDU2H84400CI" } ] }, { "communicationId": "00H2A1IUKDU2H84400CO", "type": "PAGER", "usageType": "BUSINESS", "dialArea": "456", "dialNumber": "9632147", "links": [ { "rel": "self", "href": "https://api.paychex.com/workers/00H2A1IUKDU2H84400C9/communications/00H2A1IUKDU2H84400CO" } ] }, { "communicationId": "00H2A1IUKDU2H84400CC", "type": "EMAIL", "usageType": "PERSONAL", "uri": "testhome@gmail.com", "links": [ { "rel": "self", "href": "https://api.paychex.com/workers/00H2A1IUKDU2H84400C9/communications/00H2A1IUKDU2H84400CC" } ] }, { "communicationId": "00H2A1IUKDU2H84400CE", "type": "STREET_ADDRESS", "streetLineOne": "201 walnut st", "streetLineTwo": "calton building", "city": "Chester", "postalCode": "29706", "postalCodeExtension": "7890", "countrySubdivisionCode": "SC", "countryCode": "US", "links": [ { "rel": "self", "href": "https://api.paychex.com/workers/00H2A1IUKDU2H84400C9/communications/00H2A1IUKDU2H84400CE" } ] }, { "communicationId": "00H2A1IUKDU2H84400CQ", "type": "MOBILE_PHONE", "usageType": "BUSINESS", "dialArea": "369", "dialNumber": "8521478", "links": [ { "rel": "self", "href": "https://api.paychex.com/workers/00H2A1IUKDU2H84400C9/communications/00H2A1IUKDU2H84400CQ" } ] }, { "communicationId": "00H2A1IUKDU2H84400CK", "type": "FAX", "usageType": "BUSINESS", "dialArea": "526", "dialNumber": "3987456", "links": [ { "rel": "self", "href": "https://api.paychex.com/workers/00H2A1IUKDU2H84400C9/communications/00H2A1IUKDU2H84400CK" } ] }, { "communicationId": "00H2A1IUKDU2H84400CM", "type": "EMAIL", "usageType": "BUSINESS", "uri": "testwork@gmail.com", "links": [ { "rel": "self", "href": "https://api.paychex.com/workers/00H2A1IUKDU2H84400C9/communications/00H2A1IUKDU2H84400CM" } ] }, { "communicationId": "00H2A1IUKDU2H84400CG", "type": "PHONE", "usageType": "PERSONAL", "dialArea": "741", "dialNumber": "5896321", "links": [ { "rel": "self", "href": "https://api.paychex.com/workers/00H2A1IUKDU2H84400C9/communications/00H2A1IUKDU2H84400CG" } ] } ], "links": [ { "rel": "self", "href": "https://api.paychex.com/workers/00H2A1IUKDU2H84400C9" }, { "rel": "communications", "href": "https://api.paychex.com/workers/00H2A1IUKDU2H84400C9/communications" }, { "rel": "supervisor", "href": "https://api.paychex.com/workers/00H2A1IUK6G2MM6ET8JT" } ] } ] } }, "COMPANIES_JOBS_GET": { "value": { "content": [ { "jobId": "970001557916902", "jobName": "My job A", "startDate": "2018-12-20T00:00:00Z", "endDate": "2025-12-20T00:00:00Z", "jobNumber": { "segment1": "A1", "segment2": "A2", "segment3": "A3" } }, { "jobId": "970001557916904", "jobName": "My job B", "startDate": "2018-12-20T00:00:00Z", "jobNumber": { "segment1": "B1" } } ] } }, "COMPANIES_JOB_GET": { "value": { "content": [ { "jobId": "970004615485933", "jobName": "78046704patched", "startDate": "2021-03-15T00:00:00Z", "jobNumber": { "segment1": "oodi5ZjUR3" } } ], "links": [] } }, "COMPANIES_JOBS_POST_REQ": { "value": { "jobName": "My job A", "jobNumber": { "segment1": "A-12345678" } } }, "COMPANIES_JOBS_POST_RES": { "value": { "jobId": "970004186163729", "jobName": "My job A", "startDate": "2020-04-20T00:00:00Z", "jobNumber": { "segment1": "A-12345678" } } }, "GET_COMPANIES_CONTACTS": { "value": { "name": { "familyName": "Dasharath", "givenName": "Lakshman", "preferredName": "Lucky", "qualificationAffixCode": "Jr" }, "products": [ { "productName": "Paychex Workers' Compensation Report Service", "responsibleFor": "EMPLOYER_SERVICES", "priority": "PRIMARY" }, { "productName": "Paychex Workers' Compensation Report Service", "responsibleFor": "EMPLOYER_SERVICES", "priority": "PRIMARY" }, { "productName": "Paychex Workers' Compensation Report Service", "responsibleFor": "EMPLOYER_SERVICES", "priority": "PRIMARY" }, { "productName": "Direct Deposit", "responsibleFor": "BANKING_SERVICES", "priority": "PRIMARY" }, { "productName": "Core Payroll", "responsibleFor": "PAYROLL_SERVICES", "priority": "PRIMARY" }, { "productName": "Core Payroll", "responsibleFor": "PAYROLL_SERVICES", "priority": "PRIMARY" }, { "productName": "Core Payroll", "responsibleFor": "PAYROLL_SERVICES", "priority": "PRIMARY" }, { "productName": "Core Payroll", "responsibleFor": "PAYROLL_SERVICES", "priority": "PRIMARY" }, { "productName": "Core Payroll", "responsibleFor": "PAYROLL_SERVICES", "priority": "PRIMARY" }, { "productName": "Paychex Learning Essentials", "responsibleFor": "EMPLOYER_SERVICES", "priority": "PRIMARY" }, { "productName": "Paychex Learning Essentials", "responsibleFor": "EMPLOYER_SERVICES", "priority": "PRIMARY" }, { "productName": "Paychex Learning Essentials", "responsibleFor": "EMPLOYER_SERVICES", "priority": "PRIMARY" }, { "productName": "Financial Wellness", "responsibleFor": "MISCELLANEOUS_EMPLOYEE_BENEFITS", "priority": "PRIMARY" }, { "productName": "Time Off Accrual", "responsibleFor": "EMPLOYER_SERVICES", "priority": "PRIMARY" }, { "productName": "Time Off Accrual", "responsibleFor": "EMPLOYER_SERVICES", "priority": "PRIMARY" }, { "productName": "Time Off Accrual", "responsibleFor": "EMPLOYER_SERVICES", "priority": "PRIMARY" }, { "productName": "Job Costing", "responsibleFor": "ACCOUNTING_SERVICES", "priority": "PRIMARY" }, { "productName": "Labor Distribution", "responsibleFor": "ACCOUNTING_SERVICES", "priority": "PRIMARY" } ], "communications": [ { "type": "PHONE", "usageType": "WORK", "dialArea": "786", "dialNumber": "7564534" }, { "type": "E_MAIL", "usageType": "WORK", "uri": "paychextestapi.mail.com" } ] } }, "COMPANIES_CHECKS_POST_REQ": { "value": [ { "payPeriodId": "850002407928035", "workerId": "00DCE1NVK4DFN01LEJE5", "checkCorrelationId": "1", "blockAutoDistribution": false, "earnings": [ { "componentId": "850001539952899", "payHours": "4" }, { "componentId": "850001539952899", "payHours": "5", "payRate": "22.50" }, { "componentId": "850001539952899", "payHours": "6", "payRateId": "850002318509797" }, { "componentId": "850001539952899", "payUnits": "7" }, { "componentId": "1020021373899133", "payAmount": "100", "jobId": "970001557916904" }, { "componentId": "1020021373899133", "payAmount": "150", "laborAssignmentId": "970001701620720" }, { "componentId": "850001539952899", "payUnits": "8", "payRate": "7.25" }, { "componentId": "850001539952899", "payUnits": "9", "payRateId": "850002378335313" }, { "componentId": "850001539952938", "payAmount": "300.60" } ] }, { "payPeriodId": "850002407928035", "workerId": "00DCE1NVK4DN3TC3ELLE", "checkCorrelationId": "2", "blockAutoDistribution": true, "earnings": [ { "componentId": "850001539952899", "payAmount": "250.00" }, { "componentId": "850001539952899", "payAmount": "80.00", "payHours": "2", "lineDate": "2020-09-20T00:00:00Z", "memoed": true }, { "componentId": "850001539952899", "payAmount": "100", "jobId": "850002378235915" }, { "componentId": "850001539952899", "payAmount": "150", "laborAssignmentId": "850001648338637" } ] } ] }, "COMPANIES_CHECKS_POST_RES": { "value": { "metadata": { "contentItemCount": 2 }, "content": [ { "workerId": "00DCE1NVK4DFN01LEJE5", "paycheckId": "00DCE1NVKFZGPJL79Y92", "payPeriodId": "850002407928035", "checkCorrelationId": "1", "earnings": [ { "componentId": "850001539952899", "checkComponentId": "850002407922783", "name": "Bonus", "classificationType": "SUPPLEMENTAL", "effectOnPay": "ADDITION", "jobId": "850002234866519", "laborAssignmentId": "850001648338637", "payRate": "40.0000", "payHours": "4", "memoed": false }, { "componentId": "850001539952899", "checkComponentId": "850002407922784", "name": "Bonus", "classificationType": "SUPPLEMENTAL", "effectOnPay": "ADDITION", "jobId": "850002234866519", "laborAssignmentId": "850001648338637", "payRate": "22.50", "payHours": "5", "memoed": false }, { "componentId": "850001539952899", "checkComponentId": "850002407922785", "name": "Bonus", "classificationType": "SUPPLEMENTAL", "effectOnPay": "ADDITION", "jobId": "850002234866519", "laborAssignmentId": "850001648338637", "payRate": "66", "payHours": "6", "memoed": false }, { "componentId": "850001539952899", "checkComponentId": "850002407922786", "name": "Bonus", "classificationType": "SUPPLEMENTAL", "effectOnPay": "ADDITION", "jobId": "850002234866519", "laborAssignmentId": "850001648338637", "payRate": "40.0000", "payUnits": "7", "memoed": false }, { "componentId": "850001539952899", "checkComponentId": "850002407922787", "name": "Bonus", "classificationType": "SUPPLEMENTAL", "effectOnPay": "ADDITION", "jobId": "850002234866519", "laborAssignmentId": "850001648338637", "payRate": "7.25", "payUnits": "8", "memoed": false }, { "componentId": "850001539952899", "checkComponentId": "850002407922788", "name": "Bonus", "classificationType": "SUPPLEMENTAL", "effectOnPay": "ADDITION", "jobId": "850002234866519", "laborAssignmentId": "850001648338637", "payRate": "100.0000", "payUnits": "9", "memoed": false }, { "componentId": "850001539952938", "checkComponentId": "850002407922789", "name": "Sick", "classificationType": "SICK_PAY", "effectOnPay": "ADDITION", "jobId": "850002234866519", "laborAssignmentId": "850001648338637", "payAmount": "300.60", "memoed": false }, { "componentId": "850001539952938", "checkComponentId": "850002407922790", "name": "Sick", "classificationType": "SICK_PAY", "effectOnPay": "ADDITION", "jobId": "850002234866519", "laborAssignmentId": "850001648338637", "payAmount": "50.00", "memoed": false }, { "componentId": "850001539952899", "checkComponentId": "850002407922791", "name": "Bonus", "classificationType": "SUPPLEMENTAL", "effectOnPay": "ADDITION", "jobId": "850002234866519", "laborAssignmentId": "850001648338637", "payAmount": "50.00", "memoed": false } ], "deductions": [ { "componentId": "850002318647599", "checkComponentId": "850002407922792", "name": "401k EE Post Tax", "classificationType": "_401K", "effectOnPay": "REDUCTION", "payAmount": "20.00", "memoed": false } ], "links": [ { "rel": "self", "href": "https://api.paychex.com/checks/00DCE1NVKFZGPJL79Y92" } ] }, { "workerId": "00DCE1NVK4DN3TC3ELLE", "paycheckId": "00DCE1NVKFZGPJL79Y94", "payPeriodId": "850002407928035", "checkCorrelationId": "2", "earnings": [ { "componentId": "850001539952899", "checkComponentId": "850002407922812", "name": "Bonus", "classificationType": "SUPPLEMENTAL", "effectOnPay": "ADDITION", "laborAssignmentId": "850001648338637", "payAmount": "250.00", "memoed": false }, { "componentId": "850001539952899", "checkComponentId": "850002407922813", "name": "Bonus", "classificationType": "SUPPLEMENTAL", "effectOnPay": "ADDITION", "laborAssignmentId": "850001648338637", "payHours": "2", "payAmount": "80.00", "memoed": true, "lineDate": "2020-09-20T00:00:00Z" }, { "componentId": "850001539952899", "checkComponentId": "850002407922814", "name": "Bonus", "classificationType": "SUPPLEMENTAL", "effectOnPay": "ADDITION", "jobId": "850002378235915", "laborAssignmentId": "850001648338637", "payAmount": "100.00", "memoed": false }, { "componentId": "850001539952899", "checkComponentId": "850002407922815", "name": "Bonus", "classificationType": "SUPPLEMENTAL", "effectOnPay": "ADDITION", "laborAssignmentId": "850001648338637", "payAmount": "150.00", "memoed": false } ], "links": [ { "rel": "self", "href": "https://api.paychex.com/checks/00DCE1NVKFZGPJL79Y94" } ] } ] } }, "COMPANIES_CUSTOMFIELD_GET": { "value": { "content": [ { "customFieldId": "1040014024315868", "customFieldName": "Allowance", "categoryId": "1040014023478466", "required": false, "checkStub": false, "employeeEditable": false, "type": "NUMERIC__0_0000_", "numericValue": 50 } ] } }, "COMPANIES_CUSTOMFIELDS_GET": { "value": { "metadata": { "contentItemCount": 5 }, "content": [ { "customFieldId": "1040014024315868", "customFieldName": "Allowance", "categoryId": "1040014023478466", "required": false, "checkStub": false, "employeeEditable": false, "type": "NUMERIC__0_0000_", "numericValue": 50 }, { "customFieldId": "1040014023804588", "customFieldName": "Sports", "categoryId": "1040014023478466", "required": false, "checkStub": true, "employeeEditable": true, "type": "DROPDOWN", "dropdown": [ { "dropdownId": "1040014023804589", "dropdownValue": "Football", "dropdownDefault": false }, { "dropdownId": "1040014023804591", "dropdownValue": "Basketball", "dropdownDefault": false }, { "dropdownId": "1040014023804592", "dropdownValue": "Baseball", "dropdownDefault": false } ] }, { "customFieldId": "1040014018565506", "customFieldName": "LinkedIn URL", "categoryId": "1040014018565504", "required": true, "checkStub": true, "employeeEditable": true, "type": "TEXT", "textValue": "www.linkedin.com/", "maxTextLength": 60 }, { "customFieldId": "1040014024315869", "customFieldName": "Birthday", "categoryId": "1040014023478466", "required": false, "checkStub": false, "employeeEditable": false, "type": "DATE", "dateValue": "1990-01-01T05:00:00Z" }, { "customFieldId": "1040014024315891", "customFieldName": "Vehicle", "categoryId": "1040014023478466", "required": false, "checkStub": false, "employeeEditable": false, "type": "BOOLEAN", "booleanValue": false } ] } }, "COMPANIES_CUSTOMCATEGORIES_GET": { "value": { "metadata": { "contentItemCount": 3 }, "content": [ { "categoryId": "1040014023478466", "categoryName": "Interests" }, { "categoryId": "1040014156203638", "categoryName": "Health" }, { "categoryId": "1040014018565504", "categoryName": "Social" } ] } }, "COMPANIES_CUSTOMCATEGORY_GET": { "value": { "content": [ { "categoryId": "970005446091167", "categoryName": "Social" } ], "links": [] } }, "C_JOBSEGMTS_GET": { "value": { "metadata": { "contentItemCount": 3 }, "content": [ { "segmentNumber": 1, "name": "Location Code", "segmentLength": 2 }, { "segmentNumber": 2, "name": "Service Code", "segmentLength": 4 }, { "segmentNumber": 3, "name": "Client Code", "segmentLength": 10 } ] } }, "C_JOBTITLES_GET": { "value": { "metadata": { "contentItemCount": 2 }, "content": [ { "jobTitleId": "850001637186920", "title": "Developer", "startDate": "2020-01-01T00:00:00Z", "links": [ { "rel": "self", "href": "https://api.paychex.com/companies/00DCE1NVK0RYATB9JW57/jobtitles/850001637186920" } ] }, { "jobTitleId": "850001648338651", "title": "Tester", "startDate": "2020-01-01T00:00:00Z", "links": [ { "rel": "self", "href": "https://api.paychex.com/companies/00DCE1NVK0RYATB9JW57/jobtitles/850001648338651" } ] } ], "links": [ { "rel": "self", "href": "https://api.paychex.com/companies/00DCE1NVK0RYATB9JW57/jobtitles" } ] } }, "C_JOBTITLE_GET": { "value": { "content": [ { "jobTitleId": "850001637186920", "title": "Developer", "startDate": "2020-01-01T00:00:00Z", "links": [ { "rel": "self", "href": "https://api.paychex.com/companies/00DCE1NVK0RYATB9JW57/jobtitles/850001637186920" } ] } ] } }, "C_CFIELDS_POST_REQ": { "value": { "customFieldName": "Allowance", "categoryId": "1040014179116276", "required": false, "checkStub": false, "employeeEditable": false, "type": "NUMERIC__0_00_", "numericValue": 50 } }, "C_CFIELDS_POST_RES": { "value": { "content": [ { "customFieldId": "1030013027288602", "customFieldName": "Allowance", "categoryId": "1030013027288601", "required": false, "checkStub": false, "employeeEditable": false, "type": "NUMERIC__0_00_", "numericValue": 50 } ] } }, "C_WSTATUSES_GET": { "value": { "metadata": { "contentItemCount": 2 }, "content": [ { "workerStatusId": "00DWS906IMW2JSH8AQJ9", "statusType": "ACTIVE", "statusReason": "HIRED", "links": [] }, { "workerStatusId": "00DWS906IMW2JSH8AQJA", "statusType": "ACTIVE", "statusReason": "RETURN_TO_WORK", "links": [] } ], "links": [ { "rel": "self", "href": "https://api.paychex.com/companies/00DCE1NVK0RYATB9JW57/workerstatuses" } ] } }, "C_WSTATUSID_GET": { "value": { "content": [ { "workerStatusId": "00DWS906IMW2JSH8AQJ9", "statusType": "ACTIVE", "statusReason": "HIRED", "links": [] } ] } }, "C_IN_PROGRESS_WORKER_POST_REQ": { "value": [ { "employmentType": "PART_TIME", "hireDate": "2020-12-12T00:00:00Z", "exemptionType": "NON_EXEMPT", "workerType": "EMPLOYEE", "sex": "MALE", "employeeId": "11012657", "ethnicityCode": "ASIAN_OR_PACIFIC_ISLANDER", "name": { "familyName": "Bliss", "middleName": "J", "givenName": "Pluto", "preferredName": "Pluto", "preferredLastName": "Bliss", "qualificationAffixCode": "Sr.", "titleAffixCode": "Dr." }, "profileImageURL": "https://cdn.url/demophotoid.jpg", "legalId": { "legalIdType": "SSN", "legalIdValue": "432066789" }, "job": { "jobTitleId": "970003436212358", "title": "Developer" }, "communications": [ { "type": "EMAIL", "usageType": "BUSINESS", "uri": "Pluto_Bliss@amz.com" }, { "type": "STREET_ADDRESS", "streetLineOne": "184 Cartwright St", "city": "Marniville", "postalCode": "14270", "postalCodeExtension": "7890", "countrySubdivisionCode": "HI", "countryCode": "JP" } ] } ] }, "C_IN_PROGRESS_WORKER_POST_RESP": { "value": { "content": [ { "workerId": "00DCE1NVKGAMZ3O7DQ67", "employeeId": "11012657", "workerType": "EMPLOYEE", "employmentType": "PART_TIME", "exemptionType": "NON_EXEMPT", "sex": "MALE", "ethnicityCode": "ASIAN_OR_PACIFIC_ISLANDER", "hireDate": "2020-12-12T00:00:00Z", "name": { "familyName": "Bliss", "middleName": "J", "givenName": "Pluto", "preferredName": "Pluto", "preferredLastName": "Bliss", "qualificationAffixCode": "Sr.", "titleAffixCode": "Dr." }, "profileImageURL": "https://cdn.url/demophotoid.jpg", "legalId": { "legalIdType": "SSN", "legalIdValue": "432066789" }, "job": { "jobTitleId": "970003436212358", "title": "Developer" }, "currentStatus": { "workerStatusId": "00ZAJSWSJ0DYTECE004S", "statusType": "IN_PROGRESS", "statusReason": "PENDING_HIRE", "effectiveDate": "2020-10-15T00:00:00Z" }, "communications": [ { "communicationId": "00DCE1NVKGAMZ3O7DQ6B", "type": "EMAIL", "usageType": "BUSINESS", "uri": "Pluto_Bliss@amz.com", "links": [ { "rel": "self", "href": "https://api.paychex.com/workers/00DCE1NVKGAMZ3O7DQ67/communications/00DCE1NVKGAMZ3O7DQ6B" } ] }, { "communicationId": "00DCE1NVKGAMZ3O7DQ69", "type": "STREET_ADDRESS", "streetLineOne": "184 Cartwright St", "city": "Marniville", "postalCode": "14270", "postalCodeExtension": "7890", "countrySubdivisionCode": "HI", "countryCode": "JP", "links": [ { "rel": "self", "href": "https://api.paychex.com/workers/00DCE1NVKGAMZ3O7DQ67/communications/00DCE1NVKGAMZ3O7DQ69" } ] } ], "links": [ { "rel": "self", "href": "https://api.paychex.com/workers/00DCE1NVKGAMZ3O7DQ67" }, { "rel": "communications", "href": "https://api.paychex.com/workers/00DCE1NVKGAMZ3O7DQ67/communications" } ] } ] } }, "C_IN_PROGRESS_WORKER_POST_RESP_MULTI": { "value": { "content": [ { "workerId": "00DCE1NVKGAMZ3O7DQ67", "employeeId": "11012657", "workerCorrelationId": "correlation-1", "workerType": "EMPLOYEE", "employmentType": "PART_TIME", "exemptionType": "NON_EXEMPT", "sex": "MALE", "ethnicityCode": "ASIAN_OR_PACIFIC_ISLANDER", "hireDate": "2020-12-12T00:00:00Z", "name": { "familyName": "Bliss", "middleName": "J", "givenName": "Pluto", "preferredName": "Pluto", "preferredLastName": "Bliss", "qualificationAffixCode": "Sr.", "titleAffixCode": "Dr." }, "profileImageURL": "https://cdn.url/demophotoid.jpg", "legalId": { "legalIdType": "SSN", "legalIdValue": "432066789" }, "job": { "jobTitleId": "970003436212358", "title": "Developer" }, "currentStatus": { "workerStatusId": "00ZAJSWSJ0DYTECE004S", "statusType": "IN_PROGRESS", "statusReason": "PENDING_HIRE", "effectiveDate": "2020-10-15T00:00:00Z" }, "communications": [ { "communicationId": "00DCE1NVKGAMZ3O7DQ6B", "type": "EMAIL", "usageType": "BUSINESS", "uri": "Pluto_Bliss@amz.com", "links": [ { "rel": "self", "href": "https://api.paychex.com/workers/00DCE1NVKGAMZ3O7DQ67/communications/00DCE1NVKGAMZ3O7DQ6B" } ] }, { "communicationId": "00DCE1NVKGAMZ3O7DQ69", "type": "STREET_ADDRESS", "streetLineOne": "184 Cartwright St", "city": "Marniville", "postalCode": "14270", "postalCodeExtension": "7890", "countrySubdivisionCode": "HI", "countryCode": "JP", "links": [ { "rel": "self", "href": "https://api.paychex.com/workers/00DCE1NVKGAMZ3O7DQ67/communications/00DCE1NVKGAMZ3O7DQ69" } ] } ] } ], "errors": [ { "code": "API-48", "description": "The 'Location' field is invalid. For resource with workerCorrelationId: correlation-1" } ], "links": [ { "rel": "self", "href": "https://api.paychex.com/workers/00DCE1NVKGAMZ3O7DQ67" }, { "rel": "communications", "href": "https://api.paychex.com/workers/00DCE1NVKGAMZ3O7DQ67/communications" } ] } }, "COMPANY_CONTACT_TYPES_GET": { "value": { "content": [ { "contactTypeId": "82450", "contactTypeName": "Emergency Contact", "relationshipTypes": [ { "relationshipTypeId": "458810", "relationshipTypeName": "Spouse" }, { "relationshipTypeId": "458820", "relationshipTypeName": "Parent" }, { "relationshipTypeId": "458830", "relationshipTypeName": "Sibling" }, { "relationshipTypeId": "458840", "relationshipTypeName": "Child" }, { "relationshipTypeId": "458740", "relationshipTypeName": "Friend" }, { "relationshipTypeId": "458725", "relationshipTypeName": "Domestic partner" }, { "relationshipTypeId": "458800", "relationshipTypeName": "Other" } ] } ], "links": [] } }, "COMPANY_STATE_TAXES": { "value": { "content": [ { "countrySubdivisionCodes": [ "MA", "MN", "OK" ] } ] } }, "COMPANIES_CUSTOMEMPLOYMENTTYPES_GET": { "value": { "metadata": { "contentItemCount": 3 }, "content": [ { "customEmploymentTypeId": "1040014023478466", "customEmploymentTypeName": "Hybrid", "links": [ { "rel": "self", "href": "https://api.paychex.com/companies/COMPANY_ID/customemploymenttypes" } ] }, { "customEmploymentTypeId": "1040014156203638", "customEmploymentTypeName": "Remote", "links": [ { "rel": "self", "href": "https://api.paychex.com/companies/COMPANY_ID/customemploymenttypes" } ] }, { "customEmploymentTypeId": "1040014018565504", "customEmploymentTypeName": "On-Site", "links": [ { "rel": "self", "href": "https://api.paychex.com/companies/COMPANY_ID/customemploymenttypes" } ] } ], "links": [ { "rel": "self", "href": "https://api.paychex.com/companies/COMPANY_ID/customemploymenttypes" } ] } }, "COMPANIES_DOCUMENT_CATEGORIES_GET": { "value": { "metadata": { "contentItemCount": 3 }, "content": [ { "categoryId": "21", "name": "Restricted", "customCategory": false }, { "categoryId": "17", "name": "Recruiting & Hiring", "customCategory": false }, { "categoryId": "11413", "name": "Test Custom category", "customCategory": true } ], "links": [ { "rel": "self", "href": "https://api.paychex.com/companies/COMPANY_ID/documentcategories" } ] } }, "COMPANY_PRODUCT_HOLDS_GET": { "value": { "metadata": { "contentItemCount": 2 }, "content": [ { "clientProductHoldId": "970009052670080", "clientProductHoldType": "COMPANY_TAXATION", "createDate": "2025-06-13T00:00:00Z" }, { "clientProductHoldId": "970009052670081", "clientProductHoldType": "MANAGEMENT_REVIEW", "createDate": "2025-06-13T00:00:00Z" } ], "links": [] } }, "COMPANY_PAY_PERIOD_HOLDS_GET": { "value": { "metadata": { "contentItemCount": 3 }, "content": [ { "payPeriodHoldId": "970009052670097", "active": true, "payPeriodHoldType": "COMPANY_TAXATION", "holdComment": "Dave broke it", "createDate": "2025-06-13T00:00:00Z" }, { "payPeriodHoldId": "970009052670098", "active": true, "payPeriodHoldType": "MANAGEMENT_REVIEW", "createDate": "2025-06-13T00:00:00Z" }, { "payPeriodHoldId": "970009052670099", "active": true, "payPeriodHoldType": "REVIEW", "createDate": "2025-06-13T00:00:00Z" } ], "links": [] } }, "COMPANY_PAYROLL_RISK_HOLDS_GET": { "value": { "metadata": { "contentItemCount": 1 }, "content": [ { "payrollHoldId": "970009122456788", "payrollHoldType": "PREFUNDING_LIMIT", "active": true, "primary": true, "responsiblePartyType": "CA", "createDate": "2025-07-08T00:00:00Z" } ], "links": [] } }, "COMPANY_AI_OPTIONS_GET": { "value": { "metadata": { "contentItemCount": 1 }, "content": [ { "clientAIOptionId": "2005550303023900", "clientAIOptionType": "AI_VOICE", "enabled": true } ], "links": [] } }, "GET_COMPANY_NOTES": { "value": { "metadata": { "contentItemCount": 3, "pagination": { "offset": 0, "limit": 50, "itemCount": 3, "total": 3 } }, "content": [ { "noteId": "970009070818776", "message": "Company Note Test 1", "startDate": "2025-06-19T00:00:00Z", "endDate": "4712-12-31T00:00:00Z", "createdDate": "2025-06-19T00:00:00Z", "priorityType": "NON_URGENT", "externallyViewable": true, "noteType": "PERSONAL_NOTES" }, { "noteId": "970009070828475", "message": "Company Note Test 2", "startDate": "2025-06-19T00:00:00Z", "endDate": "4712-12-31T00:00:00Z", "createdDate": "2025-06-19T00:00:00Z", "priorityType": "NON_URGENT", "externallyViewable": true, "noteType": "PERSONAL_NOTES" }, { "noteId": "970009070828539", "message": "Company Note Test 3", "startDate": "2025-06-19T00:00:00Z", "endDate": "4712-12-31T00:00:00Z", "createdDate": "2025-06-19T00:00:00Z", "priorityType": "NON_URGENT", "externallyViewable": true, "noteType": "PERSONAL_NOTES" } ], "links": [] } }, "COMPANY_PREPROCESSING_POST": { "value": { "metadata": { "contentItemCount": 1 }, "content": [ { "preprocessingGuid": "686574a8909a9e296d6d25db", "payrollId": "970008673624130", "checkDate": "2025-06-09T00:00:00Z", "payrollGuid": "466616ad02924ac58e4f4c6415bc435d" } ], "links": [ { "rel": "self", "href": "http://localhost:8090/companies/payrolls/preprocessings?companyId=00622SLMM70X8EFP7Y17&payrollId=970008673624130" } ] } }, "COMPANY_PREPROCESSING_GET": { "value": { "metadata": { "contentItemCount": 1 }, "content": [ { "preprocessingGuid": "12345", "clientAccountNbr": "CA:09001501", "payrollId": "999999", "userGuid": "CA:8366015", "checkDate": "2025-06-27T00:00:00Z", "payrollGuid": "111111", "status": "COMPLETED" } ], "links": [] } }, "COMPANY_PREPROCESSING_WORKER_CHECKS_GET": { "value": { "metadata": { "contentItemCount": 1 }, "content": [ { "id": "1234567890", "preprocessingGuid": "222", "payrollId": "999999", "checkDate": "2025-06-27T00:00:00Z", "workerCheckPayrollTotals": { "workerCount": "1", "workerCheckCount": "1", "totalNegotiableCheckAmount": "0", "totalDirectDeposit": "2807.25", "totalHours": "40.0", "totalEarnings": "4444.44", "totalOtherEarnings": "88.89", "totalDeductions": "133.33", "totalEmployerLiability": "548.89", "totalTaxLiability": "2052.75", "totalNetPay": "2807.25", "earnings": [ { "checkPayComponentId": "1", "amount": "4444.44", "hours": "40", "rate": "111.111", "payComponentName": "Regular", "payComponentType": "ADDITION" }, { "checkPayComponentId": "2", "amount": "88.89", "payComponentName": "401k ER", "payComponentType": "ADDITION WITH IN OUT" } ], "deductions": [ { "checkPayComponentId": "3", "amount": "133.33", "payComponentName": "401k EE Pretax", "payComponentType": "REDUCTION" } ], "withholdings": [ { "amount": "275.56", "withholdingName": "Social Security", "payerType": "Employee" }, { "amount": "64.44", "withholdingName": "Medicare", "payerType": "Employee" }, { "amount": "899.07", "withholdingName": "Fed Income Tax", "payerType": "Employee" }, { "amount": "264.19", "withholdingName": "NY Income Tax", "payerType": "Employee" }, { "amount": "0.6", "withholdingName": "NY Disability", "payerType": "Employee" }, { "amount": "275.56", "withholdingName": "Social Security", "payerType": "Employer" }, { "amount": "64.44", "withholdingName": "Medicare", "payerType": "Employer" }, { "amount": "26.67", "withholdingName": "Fed Unemploy", "payerType": "Employer" }, { "amount": "178.89", "withholdingName": "NY Unemploy", "payerType": "Employer" }, { "amount": "3.33", "withholdingName": "NY Re-empl Svc", "payerType": "Employer" } ] }, "workers": [ { "workerId": "1111111111", "workerWEID": "ABCDEFG12345", "workerRefNbr": "2", "workerNameFirst": "Lucy", "workerNameLast": "Lee", "checks": [ { "workerPeriodCheckId": "111", "netPay": "2807.25", "payComponents": [ { "checkPayComponentId": "1", "amount": "4444.44", "hours": "40", "rate": "111.111", "payComponentName": "Regular", "payComponentType": "ADDITION" }, { "checkPayComponentId": "2", "amount": "133.33", "payComponentName": "401k EE Pretax", "payComponentType": "REDUCTION" }, { "checkPayComponentId": "2", "amount": "88.89", "payComponentName": "401k ER", "payComponentType": "ADDITION WITH IN OUT" } ], "taxWithholdings": [ { "amount": "275.56", "withholdingName": "Social Security", "payerType": "Employee" }, { "amount": "64.44", "withholdingName": "Medicare", "payerType": "Employee" }, { "amount": "899.07", "withholdingName": "Fed Income Tax", "payerType": "Employee" }, { "amount": "264.19", "withholdingName": "NY Income Tax", "payerType": "Employee" }, { "amount": "0.6", "withholdingName": "NY Disability", "payerType": "Employee" } ], "payments": [ { "accountType": "Checking", "amount": "2807.25", "accountNumber": "Chkg 6789" } ] } ], "ic": false, "icCompany": false } ] } ], "links": [] } }, "COMPANY_PREPROCESSING_FINANCIALS_GET": { "value": { "metadata": { "contentItemCount": 1 }, "content": [ { "id": "0", "preprocessingGuid": "222", "payrollId": "999999", "checkDate": "2025-06-27T00:00:00Z", "totalNegotiableAndEFTAmount": "2807.25", "totalEFTAmount": "2807.25", "totalNegotiableCheckAmount": "0", "totalDeductionsWithholdingsLiabilitiesAmount": "2274.97", "totalCashRequired": "5082.22", "totalEmployeeWithholdings": "1503.86", "totalEmployerWithholdings": "548.89", "totalDeductions": "133.33", "totalOtherItems": "0", "electronicFundsTransfers": [ { "transactionDate": "2025-06-26T00:00:00Z", "bankName": "Bank of America", "accountNumber": "xxx5410", "accountType": "Checking", "productName": "Direct Deposit", "description": "Net Pay Allocations", "amount": "2807.25" } ], "withholdings": [ { "transactionDate": "2025-06-27T00:00:00Z", "productName": "Payroll", "description": "Social Security", "payerType": "EMPLOYEE", "amount": "275.56" }, { "transactionDate": "2025-06-27T00:00:00Z", "productName": "Payroll", "description": "Medicare", "payerType": "EMPLOYEE", "amount": "64.44" }, { "transactionDate": "2025-06-27T00:00:00Z", "productName": "Payroll", "description": "Fed Income Tax", "payerType": "EMPLOYEE", "amount": "899.07" }, { "transactionDate": "2025-06-27T00:00:00Z", "productName": "Payroll", "description": "NY Income Tax", "payerType": "EMPLOYEE", "amount": "264.19" }, { "transactionDate": "2025-06-27T00:00:00Z", "productName": "Payroll", "description": "NY Disability", "payerType": "EMPLOYEE", "amount": "0.6" }, { "transactionDate": "2025-06-27T00:00:00Z", "productName": "Payroll", "description": "Social Security", "payerType": "EMPLOYER", "amount": "275.56" }, { "transactionDate": "2025-06-27T00:00:00Z", "productName": "Payroll", "description": "Medicare", "payerType": "EMPLOYER", "amount": "64.44" }, { "transactionDate": "2025-06-27T00:00:00Z", "productName": "Payroll", "description": "Fed Unemploy", "payerType": "EMPLOYER", "amount": "26.67" }, { "transactionDate": "2025-06-27T00:00:00Z", "productName": "Payroll", "description": "NY Unemploy", "payerType": "EMPLOYER", "amount": "178.89" }, { "transactionDate": "2025-06-27T00:00:00Z", "productName": "Payroll", "description": "NY Re-empl Svc", "payerType": "EMPLOYER", "amount": "3.33" } ], "deductions": [ { "transactionDate": "2025-06-27T00:00:00Z", "productName": "Payroll", "description": "401k EE Pretax", "payerType": "EMPLOYEE", "amount": "133.33" } ], "otherItems": [ { "transactionDate": "2025-06-27T00:00:00Z", "productName": "Payroll", "description": "401k ER", "payerType": "EMPLOYEE", "amount": "88.89" } ], "taxDeposits": [ { "dueDate": "2025-06-03T00:00:00Z", "productName": "Payroll", "description": "NY IT PMT Group", "amount": "1344.74", "taxPayApprovalProcess": false, "replacement": false }, { "dueDate": "2025-06-11T00:00:00Z", "productName": "Payroll", "description": "NY IT PMT Group", "amount": "0", "taxPayApprovalProcess": false, "replacement": true }, { "dueDate": "2025-06-16T00:00:00Z", "productName": "Payroll", "description": "FED IT PMT Group", "amount": "10958.06", "taxPayApprovalProcess": false, "replacement": true }, { "dueDate": "2025-06-20T00:00:00Z", "productName": "Payroll", "description": "FED IT PMT Group", "amount": "229.26", "taxPayApprovalProcess": true, "replacement": true } ] } ], "links": [] } }, "COMPANY_PREPROCESSING_VENDOR_CHECKS_GET": { "value": { "content": [], "links": [] } }, "COMPANY_PREPROCESSING_AGENCY_CHECKS_GET": { "value": { "content": [], "links": [] } }, "COMPANY_PREPROCESSING_JOBS_GET": { "value": { "content": [], "links": [] } }, "COMPANY_PREPROCESSING_LABOR_ASSIGN_GET": { "value": { "content": [], "links": [] } }, "COMPANY_PREPROCESSING_REPORTS_GET": { "value": { "content": [], "links": [] } }, "COMPANY_CLIENT_SERVICE_ACTIVITY": { "value": { "metadata": { "contentItemCount": 1 }, "content": [ { "clientServiceActivityId": "970009245557370", "classType": "PAYROLL", "priorityType": "PRIORITY_1_WITHIN_4_HOURS", "statusType": "OPEN", "createDate": "2025-08-24T00:00:00Z", "description": "Client service activity description", "comments": [ { "commentText": "Comment 1 for a client service activity" }, { "commentText": "Comment 2 for a client service activity" } ] } ], "links": [] } } } }, "JSON_WORKER_EXAMPLES": { "value": { "WORKER_COMMUNICATION_GET": { "value": { "content": [ { "communicationId": "00Z5V9BTINBT97UMERCA", "type": "EMAIL", "usageType": "BUSINESS", "uri": "jd_work@noreplay.com", "links": [ { "rel": "self", "href": "https://api.paychex.com/workers/00Z5V9BTIHRQF2CF7BTH/communications/00Z5V9BTINBT97UMERCA" } ] } ] } }, "WORKER_PODBALANCE_POST_PATCH": { "value": { "availableBalanceAmount": 99.99, "outstandingBalance": false }, "links": [ { "rel": "self", "href": "https://api.paychex.com/workers/00Z5V9BTIHRQF2CF7BTH/podbalance" } ] }, "WORKER_PODBALANCES_POST_PATCH": { "value": [ { "workerId": "00Z5V9BTIHRQF2CF7BTH", "availableBalanceAmount": 99.99, "outstandingBalance": false }, { "workerId": "00Z5V9BTIHRQF2CHK2HB", "availableBalanceAmount": 99.99, "outstandingBalance": false } ], "links": [ { "rel": "self", "href": "https://api.paychex.com/companies/00Z5V9BTIHRQFKB8H7G/podbalances" } ] }, "WORKER_COMMUNICATION_POST_PATCH": { "value": { "type": "EMAIL", "usageType": "BUSINESS", "uri": "jd_work@noreplay.com" } }, "WORKER_COMMUNICATIONS_GET": { "value": { "content": [ { "communicationId": "00Z5V9BTINBT97UMERCA", "type": "EMAIL", "usageType": "BUSINESS", "uri": "jd_work@noreplay.com", "links": [ { "rel": "self", "href": "https://api.paychex.com/workers/00Z5V9BTIHRQF2CF7BTH/communications/00Z5V9BTINBT97UMERCA" } ] }, { "communicationId": "00Z5V9BTINBT97UMERCB", "type": "PHONE", "usageType": "BUSINESS", "dialCountry": "1", "dialArea": "999", "dialNumber": "8887777", "dialExtension": "6", "links": [ { "rel": "self", "href": "https://api.paychex.com/workers/00Z5V9BTIHRQF2CF7BTH/communications/00Z5V9BTINBT97UMERCB" } ] }, { "communicationId": "00Z5V9BTINBT97UMERCC", "type": "MOBILE_PHONE", "usageType": "BUSINESS", "dialCountry": "1", "dialArea": "777", "dialNumber": "6665555", "links": [ { "rel": "self", "href": "https://api.paychex.com/workers/00Z5V9BTIHRQF2CF7BTH/communications/00Z5V9BTINBT97UMERCC" } ] }, { "communicationId": "00Z5V9BTINBT97UMERCD", "type": "FAX", "usageType": "BUSINESS", "dialCountry": "1", "dialArea": "555", "dialNumber": "4443333", "links": [ { "rel": "self", "href": "https://api.paychex.com/workers/00Z5V9BTIHRQF2CF7BTH/communications/00Z5V9BTINBT97UMERCD" } ] }, { "communicationId": "00Z5V9BTINBT97UMERCE", "type": "PAGER", "usageType": "BUSINESS", "dialCountry": "1", "dialArea": "666", "dialNumber": "5554444", "links": [ { "rel": "self", "href": "https://api.paychex.com/workers/00Z5V9BTIHRQF2CF7BTH/communications/00Z5V9BTINBT97UMERCE" } ] }, { "communicationId": "00Z5V9BTINBT97UMERCF", "type": "STREET_ADDRESS", "streetLineOne": "1 Main Street", "streetLineTwo": "Office 3", "city": "Webster", "countrySubdivisionCode": "NY", "postalCode": "14580", "countryCode": "US", "links": [ { "rel": "self", "href": "https://api.paychex.com/workers/00Z5V9BTIHRQF2CF7BTH/communications/00Z5V9BTINBT97UMERCF" } ] } ], "links": [ { "rel": "self", "href": "https://api.paychex.com/workers/00Z5V9BTIHRQF2CF7BTH/communications" }, { "rel": "create", "href": "https://api.paychex.com/workers/00Z5V9BTIHRQF2CF7BTH/communications" } ] } }, "WORKER_PATCH": { "value": { "employeeId": "10", "employmentType": "PART_TIME", "birthDate": "1987-06-22T11:36:39Z", "sex": "MALE", "clockId": "2", "name": { "familyName": "john", "middleName": "A", "givenName": "Joe", "preferredName": "john", "preferredLastName": "joe", "qualificationAffixCode": "Dr", "titleAffixCode": "III", "pronoun": "He/him/his" }, "job": { "jobTitleId": "850002407928162", "title": "Archaeologist" }, "organization": { "organizationId": "850001539951646", "name": "Company" }, "currentStatus": { "workerStatusId": "00DWS906IMW2JSH8AQJA", "statusType": "ACTIVE", "statusReason": "RETURN_TO_WORK" } } }, "WORKER_DEFAULT_GET": { "value": { "content": [ { "workerId": "00H2A1IUKAESBXZN4PYS", "employeeId": "101", "workerType": "EMPLOYEE", "employmentType": "FULL_TIME", "exemptionType": "NON_EXEMPT", "workState": "IL", "birthDate": "1989-06-21T00:00:00Z", "sex": "FEMALE", "ethnicityCode": "ASIAN", "hireDate": "2020-05-20T00:00:00Z", "clockId": "1", "name": { "familyName": "JONES", "middleName": "K", "givenName": "INDIANA", "preferredName": "Indi", "preferredLastName": "Jan", "qualificationAffixCode": "II", "titleAffixCode": "Dr", "pronoun": "He/him/his" }, "seniorityDate": "2020-05-20T00:00:00Z", "profileImageURL": "https://cdn.url/demophotoid.jpg", "legalId": { "legalIdType": "SSN", "legalIdValue": "234567876" }, "laborAssignmentId": "970003437117733", "locationId": "970003436212414", "jobId": "970003585037029", "job": { "jobTitleId": "970003436212359", "title": "Archaeologist" }, "organization": { "organizationId": "970003163104799", "name": "1 North Division", "number": "1" }, "supervisor": { "workerId": "00H2A1IUK72UOFRV3FK1", "name": { "familyName": "Scott", "givenName": "Willie", "preferredName": "jen", "qualificationAffixCode": "III", "titleAffixCode": "Dr" } }, "currentStatus": { "workerStatusId": "00DWS906IMW2JSH8AQJ9", "statusType": "ACTIVE", "statusReason": "HIRED", "effectiveDate": "2020-05-20T00:00:00Z" }, "links": [ { "rel": "self", "href": "https://api.paychex.com/workers/00H2A1IUKAESBXZN4PYS" }, { "rel": "communications", "href": "https://api.paychex.com/workers/00H2A1IUKAESBXZN4PYS/communications" }, { "rel": "supervisor", "href": "https://api.paychex.com/workers/00H2A1IUK72UOFRV3FK1" } ] } ] } }, "GET_WORKER_VMT_COMMUNICATION": { "value": { "content": [ { "workerId": "00H2A1IUKAESBXZN4PYS", "employeeId": "101", "workerType": "EMPLOYEE", "employmentType": "FULL_TIME", "exemptionType": "NON_EXEMPT", "workState": "IL", "birthDate": "1989-06-21T00:00:00Z", "sex": "FEMALE", "ethnicityCode": "ASIAN", "hireDate": "2020-05-20T00:00:00Z", "clockId": "1", "name": { "familyName": "JONES", "middleName": "K", "givenName": "INDIANA", "preferredName": "Indi", "preferredLastName": "Jan", "qualificationAffixCode": "II", "titleAffixCode": "Dr", "pronoun": "He/him/his" }, "seniorityDate": "2020-05-20T00:00:00Z", "profileImageURL": "https://cdn.url/demophotoid.jpg", "legalId": { "legalIdType": "SSN", "legalIdValue": "234567876" }, "laborAssignmentId": "970003437117733", "locationId": "970003436212414", "jobId": "970003585037029", "job": { "jobTitleId": "970003436212359", "title": "Archaeologist" }, "organization": { "organizationId": "970003163104799", "name": "1 North Division", "number": "1" }, "supervisor": { "workerId": "00H2A1IUK72UOFRV3FK1", "name": { "familyName": "Scott", "givenName": "Willie", "preferredName": "jen", "qualificationAffixCode": "III", "titleAffixCode": "Dr" } }, "currentStatus": { "workerStatusId": "00DWS906IMW2JSH8AQJ9", "statusType": "ACTIVE", "statusReason": "HIRED", "effectiveDate": "2020-05-20T00:00:00Z" }, "communications": [ { "communicationId": "00H2A1IUKAEWLVUI4RA3", "type": "STREET_ADDRESS", "streetLineOne": "Main Street One", "streetLineTwo": "second cross", "city": "Anchorage", "postalCode": "99501", "countrySubdivisionCode": "AZ", "countryCode": "US", "links": [ { "rel": "self", "href": "https://api.paychex.com/workers/00H2A1IUKAESBXZN4PYS/communications/00H2A1IUKAEWLVUI4RA3" } ] }, { "communicationId": "00H2A1IUKDYFQDZI16BE", "type": "FAX", "usageType": "BUSINESS", "dialArea": "678", "dialNumber": "9000088", "links": [ { "rel": "self", "href": "https://api.paychex.com/workers/00H2A1IUKAESBXZN4PYS/communications/00H2A1IUKDYFQDZI16BE" } ] }, { "communicationId": "00H2A1IUKDYFQDZI16BG", "type": "PHONE", "usageType": "PERSONAL", "dialArea": "944", "dialNumber": "9276766", "links": [ { "rel": "self", "href": "https://api.paychex.com/workers/00H2A1IUKAESBXZN4PYS/communications/00H2A1IUKDYFQDZI16BG" } ] }, { "communicationId": "00H2A1IUKDYFQDZI16BK", "type": "PHONE", "usageType": "BUSINESS", "dialArea": "678", "dialNumber": "9764678", "dialExtension": "7777777", "links": [ { "rel": "self", "href": "https://api.paychex.com/workers/00H2A1IUKAESBXZN4PYS/communications/00H2A1IUKDYFQDZI16BK" } ] }, { "communicationId": "00H2A1IUKDYFQDZI16BM", "type": "PAGER", "usageType": "BUSINESS", "dialArea": "677", "dialNumber": "8988888", "links": [ { "rel": "self", "href": "https://api.paychex.com/workers/00H2A1IUKAESBXZN4PYS/communications/00H2A1IUKDYFQDZI16BM" } ] }, { "communicationId": "00H2A1IUKDYFQDZI16BI", "type": "EMAIL", "usageType": "BUSINESS", "uri": "jd_work@noreplay.com", "links": [ { "rel": "self", "href": "https://api.paychex.com/workers/00H2A1IUKAESBXZN4PYS/communications/00H2A1IUKDYFQDZI16BI" } ] }, { "communicationId": "00H2A1IUKAEWLVUI4RA1", "type": "EMAIL", "usageType": "PERSONAL", "uri": "jon@gmail.com", "links": [ { "rel": "self", "href": "https://api.paychex.com/workers/00H2A1IUKAESBXZN4PYS/communications/00H2A1IUKAEWLVUI4RA1" } ] }, { "communicationId": "00H2A1IUKDYFQDZI16BO", "type": "MOBILE_PHONE", "usageType": "BUSINESS", "dialArea": "876", "dialNumber": "4678976", "links": [ { "rel": "self", "href": "https://api.paychex.com/workers/00H2A1IUKAESBXZN4PYS/communications/00H2A1IUKDYFQDZI16BO" } ] } ], "links": [ { "rel": "self", "href": "https://api.paychex.com/workers/00H2A1IUKAESBXZN4PYS" }, { "rel": "communications", "href": "https://api.paychex.com/workers/00H2A1IUKAESBXZN4PYS/communications" }, { "rel": "supervisor", "href": "https://api.paychex.com/workers/00H2A1IUK72UOFRV3FK1" } ] } ] } }, "WORKER_NONPII_VMT_GET": { "value": { "content": [ { "workerId": "00H2A1IUKAESBXZN4PYS", "employeeId": "101", "clockId": "1", "workerType": "EMPLOYEE", "laborAssignmentId": "970003437117733", "employmentType": "FULL_TIME", "locationId": "970003436212414", "jobId": "970003585037029", "exemptionType": "NON_EXEMPT", "hireDate": "2020-05-20T00:00:00Z", "name": { "familyName": "JONES", "middleName": "K", "givenName": "INDIANA", "preferredName": "Indi", "preferredLastName": "Jan", "qualificationAffixCode": "II", "titleAffixCode": "Dr", "pronoun": "He/him/his" }, "seniorityDate": "2020-05-20T00:00:00Z", "profileImageURL": "https://cdn.url/demophotoid.jpg", "job": { "jobTitleId": "970003436212359", "title": "Archaeologist" }, "organization": { "organizationId": "970003163104799", "name": "1 North Division" }, "currentStatus": { "workerStatusId": "00DWS906IMW2JSH8AQJ9", "statusType": "ACTIVE", "statusReason": "HIRED", "effectiveDate": "2020-05-20T00:00:00Z" }, "supervisor": { "workerId": "00H2A1IUK72UOFRV3FK1", "name": { "familyName": "Scott", "givenName": "Willie", "preferredName": "jen", "qualificationAffixCode": "III", "titleAffixCode": "Dr" } }, "links": [ { "rel": "self", "href": "https://api.paychex.com/workers/00H2A1IUKAESBXZN4PYS" }, { "rel": "communications", "href": "https://api.paychex.com/workers/00H2A1IUKAESBXZN4PYS/communications" }, { "rel": "supervisor", "href": "https://api.paychex.com/workers/00H2A1IUK72UOFRV3FK1" } ] } ] } }, "WORKER_NONPII_VMT_COMMUNICATION": { "value": { "content": [ { "workerId": "00Z5V9BTIJAH5NK8FAZU", "employeeId": "3577", "workerType": "EMPLOYEE", "employmentType": "PART_TIME", "locationId": "970001614528519", "exemptionType": "NON_EXEMPT", "hireDate": "2015-01-01T00:00:00Z", "name": { "familyName": "Parr", "middleName": "A", "givenName": "Ryan", "pronoun": "He/him/his" }, "seniorityDate": "2020-05-20T00:00:00Z", "profileImageURL": "https://cdn.url/demophotoid.jpg", "organization": { "organizationId": "970000053577572", "name": "Company" }, "currentStatus": { "workerStatusId": "00DWS906IMW2JSH8AQJ9", "statusType": "ACTIVE", "statusReason": "HIRED", "effectiveDate": "2015-01-01T00:00:00Z" }, "communications": [ { "communicationId": "00Z5V9BTIXUG6YG84ZSV", "type": "STREET_ADDRESS", "streetLineOne": "511 Brighton St", "city": "Rochester", "postalCode": "14604", "countrySubdivisionCode": "NY", "countryCode": "US", "links": [ { "rel": "self", "href": "https://api.paychex.com/workers/00Z5V9BTIJAH5NK8FAZU/communications/00Z5V9BTIXUG6YG84ZSV" } ] } ], "links": [ { "rel": "self", "href": "https://api.paychex.com/workers/00Z5V9BTIJAH5NK8FAZU" }, { "rel": "communications", "href": "https://api.paychex.com/workers/00Z5V9BTIJAH5NK8FAZU/communications" } ] } ] } }, "WORKER_COMPENSATION_PAYRATES_GET": { "value": { "content": [ { "rateId": "970000054610137", "startDate": "2021-02-17T00:00:00Z", "rateNumber": "RATE_1", "rateType": "HOURLY_RATE", "description": "Security2", "amount": "40.20", "standardHours": "25.25", "standardOvertime": "3.25", "default": true, "links": [ { "rel": "self", "href": "https://api.paychex.com/workers/00Z5V9BTIHRQF2CF7BTH/compensation/payrates/970000054610137" } ] }, { "rateId": "970000054610138", "startDate": "2021-02-18T00:00:00Z", "rateNumber": "RATE_2", "rateType": "HOURLY_RATE", "description": "Update Rate", "amount": "43.22", "standardHours": "10.00", "standardOvertime": "5.00", "default": false, "links": [ { "rel": "self", "href": "https://api.paychex.com/workers/00Z5V9BTIHRQF2CF7BTH/compensation/payrates/970000054610138" } ] }, { "rateId": "970000054610139", "startDate": "2021-02-19T00:00:00Z", "rateNumber": "RATE_3", "rateType": "HOURLY_RATE", "amount": "30.15", "standardHours": "5.00", "standardOvertime": "1.00", "default": false, "links": [ { "rel": "self", "href": "https://api.paychex.com/workers/00Z5V9BTIHRQF2CF7BTH/compensation/payrates/970000054610139" } ] }, { "rateId": "970000054610140", "startDate": "2021-02-20T00:00:00Z", "rateNumber": "RATE_4", "rateType": "HOURLY_RATE", "description": "This is for dancing", "amount": "21.22", "standardHours": "5.00", "default": false, "links": [ { "rel": "self", "href": "https://api.paychex.com/workers/00Z5V9BTIHRQF2CF7BTH/compensation/payrates/970000054610140" } ] } ], "links": [ { "rel": "self", "href": "https://api.paychex.com/workers/00Z5V9BTIHRQF2CF7BTH/compensation/payrates" } ] } }, "WORKER_COMPENSATION_PAYRATE_GET": { "value": { "content": [ { "rateId": "970000054610137", "startDate": "2021-02-17T00:00:00Z", "rateNumber": "RATE_1", "rateType": "HOURLY_RATE", "amount": "40.20", "default": false, "links": [ { "rel": "self", "href": "https://api.paychex.com/workers/00Z5V9BTIHRQF2CF7BTH/compensation/payrates/970000054610137" } ] } ] } }, "WORKER_COMPENSATION_PAYRATE_POST_PATCH": { "value": { "rateNumber": "RATE_1", "rateType": "HOURLY_RATE", "amount": "40.20" } }, "WORKER_COMPENSATION_PAYSTANDARDS_GET": { "value": { "content": [ { "payFrequency": "MONTHLY", "overtimeFactor": "1.5", "calculatedPayPeriod": "1704.10", "calculatedAnnualSalary": "20449.20", "calculatedAnnualSalaryFromHistory": "2500.00" } ], "links": [ { "rel": "self", "href": "https://api.paychex.com/workers/00Z5V9BTIHRQF2CF7BTH/compensation/paystandards" } ] } }, "WORKER_COMPENSATIONS_STANDARD_RATES_VMT_GET": { "value": { "content": [ { "payStandards": { "payFrequency": "WEEKLY", "overtimeFactor": "1.5", "calculatedPayPeriod": "160.00", "calculatedAnnualSalary": "8320.00", "calculatedAnnualSalaryFromHistory": "2500.00" }, "payRates": [ { "rateId": "970003050254451", "startDate": "2020-02-07T00:00:00Z", "rateNumber": "RATE_1", "rateType": "HOURLY_RATE", "amount": "40.00", "standardHours": "4", "default": true, "links": [ { "rel": "self", "href": "https://api.paychex.com/workers/00H2A1IUK6BUYTCDQNX6/compensation/payrates/970003050254451" } ] } ] } ], "links": [ { "rel": "self", "href": "https://api.paychex.com/workers/00H2A1IUK6BUYTCDQNX6/compensation" }, { "rel": "payRates", "href": "https://api.paychex.com/workers/00H2A1IUK6BUYTCDQNX6/compensation/payrates" }, { "rel": "payStandards", "href": "https://api.paychex.com/workers/00H2A1IUK6BUYTCDQNX6/compensation/paystandards" } ] } }, "WORKER_COMPENSATIONS_DEFAULT_VMT_GET": { "value": { "content": [], "links": [ { "rel": "self", "href": "https://api.paychex.com/workers/00Z5V9BTIHRQF2CF7BTH/compensation" }, { "rel": "payRates", "href": "https://api.paychex.com/workers/00Z5V9BTIHRQF2CF7BTH/compensation/payrates" }, { "rel": "payStandards", "href": "https://api.paychex.com/workers/00Z5V9BTIHRQF2CF7BTH/compensation/paystandards" } ] } }, "WORKER_FEDERAL_TAX_RESPONSE": { "value": { "content": [ { "taxId": "3520000118851387", "filingStatus": "MARRIED_FILING_JOINTLY", "multipleJobs": "false", "dependentsAmount": "123.45", "otherIncome": "23.45", "deductionsAmount": "2.45", "taxesWithheld": "true", "extraWithholdingAmount": "3.45", "extraWithholdingPercentage": "19.45" } ] } }, "WORKER_FEDERAL_TAX_REQUEST": { "value": { "filingStatus": "MARRIED_FILING_JOINTLY", "multipleJobs": "false", "dependentsAmount": "123.45", "otherIncome": "23.45", "deductionsAmount": "2.45", "taxesWithheld": "true", "extraWithholdingAmount": "3.45", "extraWithholdingPercentage": "19.45" } }, "WORKER_DIRECT_DEPOSITS_GET": { "value": { "content": [ { "directDepositId": "1020026420675252", "startDate": "2020-08-11T00:00:00Z", "paymentType": "PERCENTAGE", "accountType": "CHECKING", "value": 75, "routingNumber": "222371863", "accountNumber": "123456", "priority": "1", "links": [ { "rel": "self", "href": "https://api.paychex.com/workers/004UWBZQJ7GEB9TVWFR9/directdeposits/1020026420675252" } ] }, { "directDepositId": "1020026420675254", "startDate": "2020-08-11T00:00:00Z", "paymentType": "REMAINDER", "accountType": "CHECKING", "routingNumber": "222371863", "accountNumber": "234567", "priority": "99", "links": [ { "rel": "self", "href": "https://api.paychex.com/workers/004UWBZQJ7GEB9TVWFR9/directdeposits/1020026420675254" } ] } ], "links": [ { "rel": "self", "href": "https://api.paychex.com/workers/004UWBZQJ7GEB9TVWFR9/directdeposits" } ] } }, "WORKER_DIRECT_DEPOSIT_GET": { "value": { "content": [ { "directDepositId": "1030013555117946", "startDate": "2021-04-23T00:00:00Z", "paymentType": "FLAT_DOLLAR_AMOUNT", "accountType": "CHECKING", "value": 100, "routingNumber": "122100024", "accountNumber": "1234567865", "priority": "1", "directDepositType": "Net Pay", "links": [ { "rel": "self", "href": "https://api.paychex.com/workers/00JWDGDYKBUE9KWXLXRP/directdeposits/1030013555117946" } ] } ] } }, "WORKER_DIRECT_DEPOSIT_POST": { "value": { "paymentType": "FLAT_DOLLAR_AMOUNT", "accountType": "CHECKING", "value": "100", "routingNumber": "122100024", "accountNumber": "1234567865", "priority": "1" } }, "WORKER_DIRECT_DEPOSIT_PATCH": { "value": { "paymentType": "PERCENTAGE", "accountType": "SAVINGS", "value": "50", "routingNumber": "122100024", "accountNumber": "1234567866", "priority": "1" } }, "WORKER_DIRECT_DEPOSIT_PATCH_RESPONSE": { "value": { "content": [ { "directDepositId": "1030013555117946", "startDate": "2021-04-23T00:00:00Z", "paymentType": "PERCENTAGE", "accountType": "CHECKING", "value": 50, "routingNumber": "122100024", "accountNumber": "1234567865", "priority": "1", "directDepositType": "Net Pay", "links": [ { "rel": "self", "href": "https://api.paychex.com/workers/00JWDGDYKBUE9KWXLXRP/directdeposits/1030013555117946" } ] } ] } }, "WORKER_DIRECT_DEPOSITS_PATCH_BULK": { "value": [ { "directDepositId": "1020026420675252", "value": 75, "paymentType": "PERCENTAGE", "accountType": "CHECKING" }, { "directDepositId": "1020026420675254", "startDate": "2020-08-11T00:00:00Z", "paymentType": "REMAINDER", "accountType": "CHECKING" } ] }, "WORKER_DIRECT_DEPOSITS_BULK_JSONPATCH_REQUEST": { "value": [ { "op": "add", "path": "/workerdeposits", "value": { "priority": 1, "accountNumber": "1234567865", "nickname": "friendly name", "routingNumber": "122100024", "accountType": "CHECKING", "paymentType": "PERCENTAGE", "value": 25.6, "startDate": "2025-08-29T00:00:00Z", "endDate": "2100-12-31T00:00:00Z" } }, { "op": "replace", "path": "/workerdeposits/1234567890987654321", "value": { "value": 5 } }, { "op": "replace", "path": "/workerdeposits/1234567890987654321/value", "value": 5 }, { "op": "remove", "path": "/workerdeposits/1234567890987654321" } ] }, "WORKER_DIRECT_DEPOSITS_BY_ID_JSONPATCH_REQUEST_1": { "value": { "op": "replace", "path": "/workerdeposits/1234567890987654321", "value": { "value": 5, "startDate": "2025-10-10T00:00:00Z" } } }, "WORKER_DIRECT_DEPOSITS_BY_ID_JSONPATCH_REQUEST_2": { "value": { "op": "replace", "path": "/workerdeposits/1234567890987654321/value", "value": 5 } }, "WORKER_DIRECT_DEPOSITS_JSONPATCH_RESPONSE": { "value": { "content": "SUCCESS", "links": [] } }, "WORKER_PAY_COMPONENTS_GET": { "value": { "content": [ { "workerComponentId": "970000223656831", "componentId": "970000180599325", "name": "Deduction - 1", "calculationType": "FLAT_DOLLAR_AMOUNT", "value": 250.75, "startDate": "2018-03-15T00:00:00Z", "effectOnPay": "REDUCTION", "checkLimit": { "type": "BASED_ON_YTD_CASH_WAGES", "startsAt": "500" }, "frequency": { "applied": "BY_PAY_PERIOD", "occurrence": "QUARTERLY", "occurrenceIntervals": { "interval1": "2", "interval2": "Last" }, "effectedChecks": "EVERY_CHECK" }, "links": [ { "rel": "self", "href": "https://api.paychex.com/workers/00H2A1IUJDOX2AAKG977/paycomponents/970000223656831" } ] }, { "workerComponentId": "970000224745559", "componentId": "970000079956947", "name": "Deduction - 2", "calculationType": "PERCENTAGE", "calculationBaseId": "00H2A1IUJE7MXV6TQ37U", "value": 5, "startDate": "2018-03-01T00:00:00Z", "effectOnPay": "REDUCTION", "checkLimit": { "type": "NONE" }, "frequency": { "applied": "BY_PAY_PERIOD", "occurrence": "QUARTERLY", "occurrenceIntervals": { "interval1": "1", "interval2": "Last" }, "effectedChecks": "FIRST_CHECK" }, "links": [ { "rel": "self", "href": "https://api.paychex.com/workers/00H2A1IUJDOX2AAKG977/paycomponents/970000224745559" } ] }, { "workerComponentId": "970000223656812", "componentId": "970000180598323", "name": "Deduction - 3", "calculationType": "RATE_X_UNITS", "calculationBaseId": "00H2A1IUJE7MXV6TQ37U", "value": 3, "startDate": "2018-03-15T00:00:00Z", "effectOnPay": "REDUCTION", "checkLimit": { "type": "NONE" }, "frequency": { "applied": "BY_PAY_PERIOD", "occurrence": "EVERY", "effectedChecks": "FIRST_CHECK" }, "links": [ { "rel": "self", "href": "https://api.paychex.com/workers/00H2A1IUJDOX2AAKG977/paycomponents/970000223656812" } ] } ], "links": [ { "rel": "self", "href": "https://api.paychex.com/workers/00H2A1IUJDOX2AAKG977/paycomponents" } ] } }, "WORKER_PAY_COMPONENT_GET": { "value": { "content": [ { "workerComponentId": "850002975988185", "componentId": "850001659458001", "name": "Union dues", "calculationType": "PERCENTAGE", "calculationBaseId": "00DCE1NVJEOMDPV36GDY", "value": 5, "startDate": "2021-09-23T00:00:00Z", "effectiveDate": "2021-08-24T00:00:00Z", "endDate": "2021-09-24T00:00:00Z", "effectOnPay": "REDUCTION", "classificationType": "UNION_DUES", "checkLimit": { "type": "BASED_ON_YTD_CASH_WAGES", "startsAt": "500" }, "frequency": { "applied": "BY_PAY_PERIOD", "occurrence": "QUARTERLY", "occurrenceIntervals": { "interval1": "1", "interval2": "1" }, "effectedChecks": "EVERY_CHECK" }, "links": [ { "rel": "self", "href": "https://api.paychex.com/workers/00DCE1NVK4DV16J4ENQJ/paycomponents/850002975988185" } ] } ] } }, "WORKER_PAY_COMPONENT_PATCH_RESPONSE": { "value": { "content": [ { "workerComponentId": "850002975988185", "componentId": "850001659458001", "name": "Union dues", "calculationType": "RATE_X_UNITS", "calculationBaseId": "00DCE1NVJEOMDPV36GCK", "value": 6, "startDate": "2021-10-23T00:00:00Z", "effectiveDate": "2021-09-24T00:00:00Z", "endDate": "2021-10-24T00:00:00Z", "effectOnPay": "REDUCTION", "classificationType": "UNION_DUES", "checkLimit": { "type": "BASED_ON_YTD_CASH_WAGES", "startsAt": "400" }, "frequency": { "applied": "BY_PAY_PERIOD", "occurrence": "QUARTERLY", "occurrenceIntervals": { "interval1": "2", "interval2": "2" }, "effectedChecks": "EVERY_CHECK" }, "links": [ { "rel": "self", "href": "https://api.paychex.com/workers/00DCE1NVK4DV16J4ENQJ/paycomponents/850002975988185" } ] } ] } }, "WORKER_PAY_COMPONENTS_BULK_PATCH": { "value": [ { "workerComponentId": "970000223656831", "componentId": "970000180599325", "value": 250.75 }, { "workerComponentId": "970000224745559", "componentId": "970000079956947", "value": 5 }, { "workerComponentId": "970000223656812", "componentId": "970000180598323", "value": 3 } ] }, "WORKER_PAY_COMPONENT_POST": { "value": { "componentId": "850001659458001", "calculationType": "PERCENTAGE", "calculationBaseId": "00DCE1NVJEOMDPV36GDY", "value": 5, "startDate": "2021-09-23T00:00:00Z", "endDate": "2021-09-24T00:00:00Z", "effectiveDate": "2021-8-24T00:00:00Z", "frequency": { "applied": "BY_PAY_PERIOD", "occurrence": "QUARTERLY", "occurrenceIntervals": { "interval1": "1", "interval2": "1" }, "effectedChecks": "EVERY_CHECK" }, "checkLimit": { "type": "BASED_ON_YTD_CASH_WAGES", "startsAt": 500 } } }, "WORKER_PAY_COMPONENT_PATCH": { "value": { "calculationType": "RATE_X_UNITS", "calculationBaseId": "00DCE1NVJEOMDPV36GCK", "value": 6, "startDate": "2021-10-23T00:00:00Z", "endDate": "2021-10-24T00:00:00Z", "effectiveDate": "2021-9-24T00:00:00Z", "checkLimit": { "type": "BASED_ON_YTD_CASH_WAGES", "startsAt": "400" }, "frequency": { "applied": "BY_PAY_PERIOD", "occurrence": "QUARTERLY", "occurrenceIntervals": { "interval1": "2", "interval2": "2" }, "effectedChecks": "EVERY_CHECK" } } }, "WORKER_ASSIGNMENT_DISTRIBUTIONS_GET": { "value": { "metadata": { "contentItemCount": 2 }, "content": [ { "jobId": "970001557916904", "laborAssignmentId": "970001701620607", "value": "60" }, { "jobId": "970001557916900", "laborAssignmentId": "970001557863345", "value": "40" } ] } }, "WORKER_CUSTOM_FIELDS_GET": { "value": { "metadata": { "contentItemCount": 2 }, "content": [ { "workerCustomFieldId": "970004186136627", "customFieldId": "970004186138361", "dropdownId": "970004186138363", "dropdownValue": "Football", "customFieldName": "Sports" }, { "workerCustomFieldId": "970004186138696", "customFieldId": "970004186162982", "textValue": "www.linkedin.com" } ], "links": [] } }, "WORKER_CUSTOM_FIELD_GET": { "value": { "content": [ { "workerCustomFieldId": "970004186136627", "customFieldId": "970004186138361", "dropdownId": "970004186138363", "dropdownValue": "Football", "customFieldName": "Sports" } ] } }, "WORKER_CUSTOM_FIELD_POST_PATCH": { "value": { "customFieldId": "970004186138361", "dropdownId": "970004186138363", "dropdownValue": "Football" } }, "WORKER_UN_PROCESSED_CHECKS_GET": { "value": { "content": [ { "workerId": "004UWBZQJ7GEB9TVWFR9", "paycheckId": "1020026552555444", "payPeriodId": "1020026427391732", "earnings": [ { "componentId": "1020021373899133", "checkComponentId": "1020026552555441", "name": "Hourly", "classificationType": "REGULAR", "effectOnPay": "ADDITION", "payRate": "40.2000", "payHours": "4", "organization": { "organizationId": "1020022951957515", "name": " Branch A - East", "number": "1", "level": "Level 1" } }, { "componentId": "1020021373899133", "checkComponentId": "1020026552555445", "name": "Hourly", "classificationType": "REGULAR", "effectOnPay": "ADDITION", "payRate": "7.25", "payUnits": "8", "organization": { "organizationId": "1020022951957515", "name": " Branch A - East", "number": "1", "level": "Level 1" } }, { "componentId": "1020021373899318", "checkComponentId": "1020026552555447", "name": "Bonus", "classificationType": "SUPPLEMENTAL", "effectOnPay": "ADDITION", "payAmount": "300.60", "organization": { "organizationId": "970001701620695", "name": "Branch B - West", "number": "2", "level": "Level 2" } } ], "links": [ { "rel": "self", "href": "https://api.paychex.com/workers/004UWBZQJ7GEB9TVWFR9/checks/1020026552555444" } ] }, { "workerId": "00Z1IQF9J0MIGR3K3VXO", "paycheckId": "1020026552555462", "payPeriodId": "1020026427391732", "blockAutoDistribution": true, "earnings": [ { "componentId": "1020021373899318", "checkComponentId": "1020026552555462", "name": "Bonus", "classificationType": "SUPPLEMENTAL", "effectOnPay": "ADDITION", "payAmount": "250.00", "organization": { "organizationId": "970001701620695", "name": "Branch B - West", "number": "2", "level": "Level 2" } } ], "links": [ { "rel": "self", "href": "https://api.paychex.com/workers/00Z1IQF9J0MIGR3K3VXO/checks/1020026552555462" } ] } ] } }, "WORKER_UN_PROCESSED_CHECK_GET": { "value": { "content": [ { "workerId": "00H2A1IUJYQNBYKUD6DS", "paycheckId": "00H2A1IUK7IDBDA179UJ", "payPeriodId": "970002369233004", "blockAutoDistribution": false, "earnings": [ { "componentId": "970002369232910", "checkComponentId": "970003240624468", "name": "Bonus", "classificationType": "SUPPLEMENTAL", "effectOnPay": "ADDITION", "payAmount": "889.00", "memoed": false } ], "links": [ { "rel": "self", "href": "https://api.paychex.com/checks/00H2A1IUK7IDBDA179UJ" } ] } ] } }, "WORKER_PROCESSED_CHECK_GET": { "value": { "content": [ { "payPeriodId": "970002146440893", "paycheckId": "00H2A1IUJVF8Y2EPA6XD", "workerId": "00H2A1IUJKSLXZ07NHIA", "checkDate": "2019-05-12T20:00:00Z", "netPay": "506.65", "checkType": "Regular", "checkNumber": "1", "earnings": [ { "componentId": "970000076689381", "checkComponentId": "970002146440900", "name": "Hourly", "classificationType": "Regular", "effectOnPay": "ADDITION", "memoed": false, "laborAssignmentId": "970001557863345", "organization": { "organizationId": "970001701620695", "name": "Branch B - West", "number": "2", "level": "Level 2" }, "jobName": "My job 1", "amount": "400.0", "rate": "20", "hours": "20.0" }, { "componentId": "970000076689381", "checkComponentId": "970002146440900", "name": "Hourly", "classificationType": "Regular", "effectOnPay": "ADDITION", "memoed": false, "laborAssignmentId": "970001701620607", "organization": { "organizationId": "970001701620695", "name": "Branch B - West", "number": "2", "level": "Level 2" }, "jobName": "My job 2", "amount": "400.0", "rate": "20", "hours": "20.0" } ], "deductions": [ { "componentId": "970000191960058", "checkComponentId": "970002146440901", "name": "IRA EE", "classificationType": "IRA", "effectOnPay": "REDUCTION", "memoed": false, "laborAssignmentId": "970001557863345", "organization": { "organizationId": "970001701620695", "name": "Branch B - West", "number": "2", "level": "Level 2" }, "jobName": "My job 1", "amount": "200.0" } ], "informational": [ { "componentId": "970000191960058", "checkComponentId": "970002146440999", "name": "Info", "classificationType": "INFORMATIONAL", "effectOnPay": "INFORMATIONAL", "amount": "50.0" } ], "taxes": [ { "name": "Employee Medicare Tax", "laborAssignmentId": "970001557863345", "jobId": "970001557916904", "paidBy": "EMPLOYEE_WITHHOLDING", "amount": "11.6" }, { "name": "Employee Social Security Tax", "laborAssignmentId": "970001557863345", "jobId": "970001557916904", "paidBy": "EMPLOYEE_WITHHOLDING", "amount": "49.6" }, { "name": "Employer Medicare Tax", "laborAssignmentId": "970001557863345", "jobId": "970001557916904", "paidBy": "EMPLOYER_LIABILITY", "amount": "11.6" }, { "name": "Employer Social Security Tax", "laborAssignmentId": "970001557863345", "jobId": "970001557916904", "paidBy": "EMPLOYER_LIABILITY", "amount": "49.6" }, { "name": "Federal Income Tax", "laborAssignmentId": "970001557863345", "jobId": "970001557916904", "paidBy": "EMPLOYEE_WITHHOLDING", "amount": "28.33" }, { "name": "Federal Unemployment Insurance", "laborAssignmentId": "970001557863345", "jobId": "970001557916904", "paidBy": "EMPLOYER_LIABILITY", "amount": "4.8" }, { "name": "New York Disability Insurance", "laborAssignmentId": "970001557863345", "jobId": "970001557916904", "paidBy": "EMPLOYEE_WITHHOLDING", "amount": "2.6" }, { "name": "New York Income Tax", "laborAssignmentId": "970001557863345", "jobId": "970001557916904", "paidBy": "EMPLOYEE_WITHHOLDING", "amount": "0.0" }, { "name": "New York Paid Family Leave Insurance", "laborAssignmentId": "970001557863345", "jobId": "970001557916904", "paidBy": "EMPLOYEE_WITHHOLDING", "amount": "1.22" }, { "name": "New York Unemployment Insurance", "laborAssignmentId": "970001557863345", "jobId": "970001557916904", "paidBy": "EMPLOYER_LIABILITY", "amount": "25.0" }, { "name": "Re-employment Service Fund", "laborAssignmentId": "970001557863345", "jobId": "970001557916904", "paidBy": "EMPLOYER_LIABILITY", "amount": "0.6" } ] } ] } }, "WORKER_PROCESSED_CHECKS_GET": { "value": { "metadata": { "contentItemCount": 1 }, "content": [ { "payPeriodId": "970002146440893", "paycheckId": "00H2A1IUJVF8Y2EPA6XD", "workerId": "00H2A1IUJKSLXZ07NHIA", "checkDate": "2019-05-12T20:00:00Z", "netPay": "506.65", "checkType": "Regular", "checkNumber": "1", "earnings": [ { "componentId": "970000076689381", "checkComponentId": "970002146440900", "name": "Hourly", "classificationType": "Regular", "effectOnPay": "ADDITION", "memoed": false, "laborAssignmentId": "970001557863345", "organization": { "organizationId": "970001701620695", "name": "Branch B - West", "number": "2", "level": "Level 2" }, "jobName": "My job 1", "amount": "400.0", "rate": "20", "hours": "20.0" }, { "componentId": "970000076689381", "checkComponentId": "970002146440900", "name": "Hourly", "classificationType": "Regular", "effectOnPay": "ADDITION", "memoed": false, "laborAssignmentId": "970001701620607", "organization": { "organizationId": "970001701620695", "name": "Branch B - West", "number": "2", "level": "Level 2" }, "jobName": "My job 2", "amount": "400.0", "rate": "20", "hours": "20.0" } ], "deductions": [ { "componentId": "970000191960058", "checkComponentId": "970002146440901", "name": "IRA EE", "classificationType": "IRA", "effectOnPay": "REDUCTION", "memoed": false, "laborAssignmentId": "970001557863345", "organization": { "organizationId": "970001701620695", "name": "Branch B - West", "number": "2", "level": "Level 2" }, "jobName": "My job 1", "amount": "200.0" } ], "informational": [ { "componentId": "970000191960058", "checkComponentId": "970002146440999", "name": "Info", "classificationType": "INFORMATIONAL", "effectOnPay": "INFORMATIONAL", "amount": "50.0" } ], "taxes": [ { "name": "Employee Medicare Tax", "laborAssignmentId": "970001557863345", "jobId": "970001557916904", "paidBy": "EMPLOYEE_WITHHOLDING", "amount": "11.6" }, { "name": "Employee Social Security Tax", "laborAssignmentId": "970001557863345", "jobId": "970001557916904", "paidBy": "EMPLOYEE_WITHHOLDING", "amount": "49.6" }, { "name": "Employer Medicare Tax", "laborAssignmentId": "970001557863345", "jobId": "970001557916904", "paidBy": "EMPLOYER_LIABILITY", "amount": "11.6" }, { "name": "Employer Social Security Tax", "laborAssignmentId": "970001557863345", "jobId": "970001557916904", "paidBy": "EMPLOYER_LIABILITY", "amount": "49.6" }, { "name": "Federal Income Tax", "laborAssignmentId": "970001557863345", "jobId": "970001557916904", "paidBy": "EMPLOYEE_WITHHOLDING", "amount": "28.33" }, { "name": "Federal Unemployment Insurance", "laborAssignmentId": "970001557863345", "jobId": "970001557916904", "paidBy": "EMPLOYER_LIABILITY", "amount": "4.8" }, { "name": "New York Disability Insurance", "laborAssignmentId": "970001557863345", "jobId": "970001557916904", "paidBy": "EMPLOYEE_WITHHOLDING", "amount": "2.6" }, { "name": "New York Income Tax", "laborAssignmentId": "970001557863345", "jobId": "970001557916904", "paidBy": "EMPLOYEE_WITHHOLDING", "amount": "0.0" }, { "name": "New York Paid Family Leave Insurance", "laborAssignmentId": "970001557863345", "jobId": "970001557916904", "paidBy": "EMPLOYEE_WITHHOLDING", "amount": "1.22" }, { "name": "New York Unemployment Insurance", "laborAssignmentId": "970001557863345", "jobId": "970001557916904", "paidBy": "EMPLOYER_LIABILITY", "amount": "25.0" }, { "name": "Re-employment Service Fund", "laborAssignmentId": "970001557863345", "jobId": "970001557916904", "paidBy": "EMPLOYER_LIABILITY", "amount": "0.6" } ] } ], "links": [ { "rel": "self", "href": "https://api.paychex.com/checks/?payperiodid=970002146440893&workerid=00H2A1IUJKSLXZ07NHIA" } ] } }, "WORKER_CHECK_POST": { "value": { "payPeriodId": "970002369233004", "earnings": [ { "componentId": "970002369232910", "effectOnPay": "ADDITION", "payAmount": "889.00" } ] } }, "WORKER_TIMEOFF_GET": { "value": { "metadata": { "contentItemCount": 2 }, "content": [ { "policyId": "970002308485816", "type": "Vacation", "name": "Vacation", "balance": "40", "measure": "HOURS" }, { "policyId": "85812308488791", "type": "PTO", "name": "PTO", "balance": "80", "measure": "HOURS" } ] } }, "DELETE_EMPTY_RESPONSE": { "value": { "content": [], "links": [] } }, "WORKER_PATCH_RESPONSE": { "value": { "content": [ { "workerId": "00DCE1NVK4DV16J4ENQJ", "employeeId": "10", "workerType": "EMPLOYEE", "employmentType": "PART_TIME", "exemptionType": "NON_EXEMPT", "workState": "IL", "birthDate": "1987-06-22T00:00:00Z", "sex": "MALE", "ethnicityCode": "AMERICAN_INDIAN_OR_ALASKAN_NATIVE", "hireDate": "2019-12-20T00:00:00Z", "clockId": "2", "name": { "familyName": "john", "middleName": "A", "givenName": "Joe", "preferredName": "john", "preferredLastName": "joe", "qualificationAffixCode": "Dr", "titleAffixCode": "III", "pronoun": "He/him/his" }, "legalId": { "legalIdType": "SSN", "legalIdValue": "098765432" }, "laborAssignmentId": "850001648338637", "locationId": "850001637190077", "job": { "jobTitleId": "850002407928162", "title": "Archaeologist" }, "organization": { "organizationId": "850001539951646", "name": "Company", "links": [] }, "supervisor": { "workerId": "00DCE1NVK0RSEULWJVHJ", "name": { "familyName": "Lisa", "givenName": "Pinto" } }, "currentStatus": { "workerStatusId": "00DWS906IMW2JSH8AQJA", "statusType": "ACTIVE", "statusReason": "RETURN_TO_WORK", "effectiveDate": "2021-04-23T00:00:00Z" }, "links": [ { "rel": "self", "href": "https://api.paychex.com/workers/00DCE1NVK4DV16J4ENQJ" }, { "rel": "communications", "href": "https://api.paychex.com/workers/00DCE1NVK4DV16J4ENQJ/communications" }, { "rel": "supervisor", "href": "https://api.paychex.com/workers/00DCE1NVK0RSEULWJVHJ" } ] } ], "links": [] } }, "WORKER_COMMUNICATION_POST": { "value": { "type": "STREET_ADDRESS", "usageType": "BUSINESS", "streetLineOne": "1232 SAFE RD", "streetLineTwo": "SPACE 1122", "city": "ROCHESTER", "postalCode": "14607", "countrySubdivisionCode": "NY", "countryCode": "US" } }, "WORKER_COMMUNICATION_POST_RESPONSE": { "value": { "content": [ { "communicationId": "00DCE1NVKNU4MB4A8P9V", "type": "STREET_ADDRESS", "usageType": "BUSINESS", "streetLineOne": "1232 SAFE RD", "streetLineTwo": "SPACE 1122", "city": "ROCHESTER", "postalCode": "14607", "countrySubdivisionCode": "NY", "countryCode": "US", "links": [ { "rel": "self", "href": "https://api.paychex.com/workers/00DCE1NVK2005LNRBRQ7/communications/00DCE1NVKNU4MB4A8P9V" } ] } ], "links": [] } }, "WORKER_COMMUNICATION_PATCH": { "value": { "streetLineOne": "ALCOA RD", "streetLineTwo": "SPACE 1122", "city": "ROCHESTER", "postalCode": "14607", "countryCode": "US" } }, "WORKER_COMMUNICATION_PATCH_RESPONSE": { "value": { "content": [ { "communicationId": "00DCE1NVKNU4MB4A8P9V", "type": "STREET_ADDRESS", "usageType": "BUSINESS", "streetLineOne": "ALCOA RD", "streetLineTwo": "SPACE 1122", "city": "ROCHESTER", "postalCode": "14607", "countrySubdivisionCode": "NY", "countryCode": "US", "links": [ { "rel": "self", "href": "https://api.paychex.com/workers/00DCE1NVK2005LNRBRQ7/communications/00DCE1NVKNU4MB4A8P9V" } ] } ], "links": [] } }, "WORKER_STATUSES_GET": { "value": { "metadata": { "contentItemCount": 4 }, "content": [ { "workerStatusId": "00DWS906IMW2JSH8AQJB", "statusType": "ACTIVE", "statusReason": "REHIRED", "effectiveDate": "2018-06-07T00:00:00Z", "order": 0 }, { "statusType": "TERMINATED", "statusReason": "CUSTOM_UNKNOWN", "effectiveDate": "2016-02-08T00:00:00Z", "order": 0 }, { "workerStatusId": "00DWS906IMW2JSH8AQJG", "statusType": "INACTIVE", "statusReason": "DISABILITY", "effectiveDate": "2016-02-01T00:00:00Z", "order": 0 }, { "workerStatusId": "00DWS906IMW2JSH8AQJ9", "statusType": "ACTIVE", "statusReason": "HIRED", "effectiveDate": "2015-01-01T00:00:00Z", "order": 1 } ], "links": [] } }, "WORKER_CONTACTS_GET": { "value": { "metadata": { "contentItemCount": 2 }, "content": [ { "contactId": "1460423a-9544-4c20-a27d-f438f427e722", "contactType": { "contactTypeId": "82450", "contactTypeName": "Emergency Contact" }, "relationship": { "relationshipId": "6e500758-714a-40e2-aa58-a60efc06361c", "relationWeid": "00H2A1IUJUK1PQ2S2LIY", "relationshipType": { "relationshipTypeId": "458810", "relationshipTypeName": "Spouse" }, "primary": true, "person": { "name": { "familyName": "Smith", "middleName": "Ray", "givenName": "Bob" }, "communication": { "telecom": [ { "communicationId": "98dca682-a918-453f-8314-8e4d34e2f622", "dialCountry": "1", "dialArea": "585", "dialNumber": "5552222", "type": "PHONE", "usageType": "BUSINESS" }, { "communicationId": "c09ffe6b-5914-4d73-8bea-3120ed767a23", "dialCountry": "1", "dialArea": "585", "dialNumber": "5553333", "type": "MOBILE_PHONE", "usageType": "PERSONAL" } ], "postal": [ { "communicationId": "0f58226e-0f71-45c8-bea2-e5f78603c039", "streetLineOne": "98 Railroad Ave", "city": "Rochester", "postalCode": "14612", "countrySubdivisionCode": "NY", "countryCode": "US" } ], "email": [ { "communicationId": "5a964c4b-0e2c-4e26-b876-5fe5386a03fd", "uri": "bob.smith@aweco.com", "usageType": "BUSINESS" }, { "communicationId": "ce7d7c6c-1f9d-40a2-b32e-2175f914e997", "uri": "brs123@gmail.com", "usageType": "PERSONAL" } ] } } } }, { "contactId": "ef9fc81b-0216-408a-bc99-3219fc993d34", "contactType": { "contactTypeId": "82450", "contactTypeName": "Emergency Contact" }, "relationship": { "relationWeid": "00H2A1IUJUK1PQ2S2LIY", "primary": false, "entity": { "entityId": "17a9142e-af73-4947-aab9-0e569c0ae54a", "entityName": "Awesome Co.", "communication": { "telecom": { "dialCountry": "1", "dialArea": "585", "dialNumber": "5551111", "type": "PHONE", "usageType": "BUSINESS" }, "postal": { "streetLineOne": "100 Main Street", "streetLineTwo": "Suite 6", "city": "Rochester", "postalCode": "14612", "countrySubdivisionCode": "NY", "countryCode": "US" }, "email": { "uri": "contact@aweco.com", "usageType": "BUSINESS" } } } } } ], "links": [] } }, "WORKER_CONTACTS_POST_REQUEST": { "value": [ { "contactType": { "contactTypeId": "82450" }, "relationship": { "relationshipType": { "relationshipTypeId": "458810" }, "primary": false, "person": { "name": { "familyName": "Attridge", "givenName": "Mike" }, "communication": { "telecom": [ { "dialCountry": "1", "dialArea": "585", "dialNumber": "5552222", "type": "PHONE", "usageType": "PERSONAL" } ], "postal": [ { "postOfficeBox": "123 Main St", "city": "Rochester", "postalCode": "123456", "countrySubdivisionCode": "NY", "countryCode": "US" } ], "email": [ { "uri": "fake@test.com", "usageType": "PERSONAL" } ] } } } } ] }, "WORKER_CONTACTS_POST_RESPONSE": { "value": { "metadata": { "contentItemCount": 1 }, "content": [ { "contactId": "314230af-0093-48eb-bd12-21fe14db6342", "contactType": { "contactTypeId": "82450", "contactTypeName": "Emergency Contact" }, "relationship": { "relationshipId": "60debe44-b78f-4b23-9a32-9a0f21ab496b", "relationWeid": "00H2A1IUK99W4GJ41D0J", "relationshipType": { "relationshipTypeId": "458810", "relationshipTypeName": "Spouse" }, "primary": false, "person": { "name": { "familyName": "Attridge", "givenName": "Mike" }, "communication": { "telecom": [ { "communicationId": "38e383da-e805-4da2-9d1a-2a40712daa39", "dialCountry": "1", "dialArea": "585", "dialNumber": "5552222", "type": "PHONE", "usageType": "PERSONAL" } ], "postal": [ { "communicationId": "26b0c9dd-db56-4a1a-8fda-5a0491e59eb1", "postOfficeBox": "123 Main St", "city": "Rochester", "postalCode": "123456", "countrySubdivisionCode": "NY", "countryCode": "US" } ], "email": [ { "communicationId": "284d4c76-c6fc-4c3a-bccc-0c0118c00f7e", "uri": "fake@test.com", "usageType": "PERSONAL" } ] } } } } ], "links": [] } }, "WORKER_CONTACT_GET": { "value": { "content": [ { "contactId": "ef9fc81b-0216-408a-bc99-3219fc993d34", "contactType": { "contactTypeId": "82450", "contactTypeName": "Emergency Contact" }, "relationship": { "relationWeid": "00H2A1IUJUK1PQ2S2LIY", "primary": false, "entity": { "entityId": "17a9142e-af73-4947-aab9-0e569c0ae54a", "entityName": "Awesome Co.", "communication": { "telecom": { "dialCountry": "1", "dialArea": "585", "dialNumber": "5551111", "type": "PHONE", "usageType": "BUSINESS" }, "postal": { "streetLineOne": "100 Main Street", "streetLineTwo": "Suite 6", "city": "Rochester", "postalCode": "14612", "countrySubdivisionCode": "NY", "countryCode": "US" }, "email": { "uri": "contact@aweco.com", "usageType": "BUSINESS" } } } } } ], "links": [] } }, "WORKER_CONTACTS_PATCH_ENTITY_NAME": { "value": { "relationship": { "entity": { "entityName": "Busy Inc." } } } }, "WORKER_CONTACTS_PATCH_ENTITY_PHONE": { "value": { "relationship": { "entity": { "communication": { "telecom": { "dialCountry": "3", "dialArea": "587", "dialNumber": "5551001" } } } } } }, "WORKER_CONTACTS_PATCH_ENTITY_EMAIL": { "value": { "relationship": { "entity": { "communication": { "email": { "uri": "contactus@busyinc.com" } } } } } }, "WORKER_CONTACTS_PATCH_ENTITY_POSTAL": { "value": { "relationship": { "entity": { "communication": { "postal": { "postOfficeBox": "PO Box 12345", "city": "Rochester", "countrySubdivisionCode": "NY", "countryCode": "US", "postalCode": "14612" } } } } } }, "WORKER_CONTACTS_PATCH_PERSON_NAME": { "value": { "relationship": { "person": { "name": { "givenName": "Robert", "middleName": "Raymond", "familyName": "Smitty" } } } } }, "WORKER_CONTACTS_PATCH_PERSON_PHONE": { "value": { "relationship": { "person": { "communication": { "telecom": { "dialCountry": "3", "dialArea": "587", "dialNumber": "5551001" } } } } } }, "WORKER_CONTACTS_PATCH_PERSON_EMAIL": { "value": { "relationship": { "person": { "communication": { "email": { "uri": "bobbysmitty@hotmail.com" } } } } } }, "WORKER_CONTACTS_PATCH_PERSON_POSTAL": { "value": { "relationship": { "person": { "communication": { "postal": { "streetLineOne": "252 West Bend Drive", "city": "Rochester", "countrySubdivisionCode": "NY", "countryCode": "US", "postalCode": "14612" } } } } } }, "WORKER_SHIFT_GET": { "value": { "content": [ { "shiftId": "3361 1111", "workerId": "00H2A1IUKYJF2U6Y7XDM", "regularMinutes": 5, "otMinutes": 2, "dates": [ "2024-02-12T23:00:00", "2024-02-13T10:00:00" ] } ], "links": [] } }, "WORKER_STATE_TAXES": { "value": { "metadata": { "contentItemCount": 4 }, "content": [ { "workerTaxId": "970008398734773", "countrySubdivisionCode": "OH", "isResidentState": false, "stateAllocationPercent": 30, "regulationType": "INCOME_TAX", "taxStatusType": "WITHHOLD", "flatDollarOverride": 88, "workerTaxDeductions": [ { "workerTaxDeductionId": 970008398734775, "workerTaxDeductionName": "Total Number of Allowances", "quantity": 0 } ] }, { "workerTaxId": "679952e145cb7f7e11917e18", "countrySubdivisionCode": "MI", "isResidentState": false, "stateAllocationPercent": 70, "regulationType": "INCOME_TAX", "taxStatusType": "EXEMPT", "exemptionReasonDescription": "reason", "workerTaxDeductions": [ { "workerTaxDeductionId": 970008398736844, "workerTaxDeductionName": "Personal and Dependency Exemptions", "quantity": 0 } ] }, { "workerTaxId": "970008395963115", "countrySubdivisionCode": "NJ", "isResidentState": false, "stateAllocationPercent": 0, "regulationType": "INCOME_TAX", "taxStatusType": "WITHHOLD", "filingStatusType": "SINGLE_MARRIED_CIVIL_UNION_SEP", "additionalAmount": 25, "additionalPercent": 20, "workerTaxDeductions": [ { "workerTaxDeductionId": 970008395963139, "workerTaxDeductionName": "Total Number of Allowances", "quantity": 0 } ] }, { "workerTaxId": "970008398724317", "countrySubdivisionCode": "UT", "isResidentState": false, "stateAllocationPercent": 0, "regulationType": "INCOME_TAX", "taxStatusType": "WITHHOLD", "filingStatusType": "HEAD_OF_HOUSEHOLD", "additionalAmount": 40, "overridePercent": 20 } ], "links": [] } }, "WORKER_STATE_TAX": { "value": [ { "op": "add", "path": "/workerTaxes/yourCorrelationID", "value": { "countrySubdivisionCode": "OH", "isResidentState": true, "stateAllocationPercent": 30, "regulationType": "INCOME_TAX", "taxStatusType": "WITHHOLD", "flatDollarOverride": 88 } }, { "op": "replace", "path": "/workerTaxes/679952e145cb7f7e11917e18/workerTaxDeductions/970008398736844/quantity", "value": 1 }, { "op": "replace", "path": "/workerTaxes/679952e145cb7f7e11917e18/isResidentState", "value": false }, { "op": "replace", "path": "/workerTaxes/679952e145cb7f7e11917e18/stateAllocationPercent", "value": 70 }, { "op": "replace", "path": "/workerTaxes/6799556f45cb7f7e11917e1c/stateAllocationPercent", "value": 0 }, { "op": "add", "path": "/workerTaxes/674e1fca9cf204727b185da3/additionalAmount", "value": 25 } ] }, "WORKER_I9_STATUS_GET": { "value": { "content": [ { "status": "Not Started", "isRemoteI9": false, "createdDate": "2024-02-26T00:00:00Z", "lastUpdated": "2024-02-28T00:00:00Z" } ], "links": [ { "rel": "self", "href": "https://api.paychex.com/workers/00Z5V9BTIHRQF2CF7BTH/i-nine/status" } ] } }, "WORKER_ADD_PROFILE_IMAGE_RESPONSE": { "value": { "profileImageURL": "https://cdn.url/demophotoid.jpg" } }, "WORKER_ADD_PROFILE_IMAGE_FILE_TYPE_ERROR_RESPONSE": { "value": { "content": [], "errors": [ { "code": "API-62", "description": "Uploaded profile image is not an acceptable file type.", "resolution": "Please upload an acceptable image file type." } ], "links": [] } }, "WORKER_ADD_PROFILE_IMAGE_SERVER_ERROR_RESPONSE": { "value": { "content": [], "errors": [ { "code": "API-66", "description": "Server error occurred adding profile image.", "resolution": "Please try again later." } ], "links": [] } }, "WORKER_ADD_PROFILE_IMAGE_DELETE_FIRST_RESPONSE": { "value": { "content": [], "errors": [ { "code": "API-66", "description": "Server error occurred adding profile image.", "resolution": "Please try calling delete profile image endpoint first." } ], "links": [] } }, "WORKER_PROFILE_IMAGE_DOES_NOT_EXIST_RESPONSE": { "value": { "content": [], "errors": [ { "code": "API-7", "description": "Profile image does not exist for the worker provided." } ], "links": [] } }, "WORKER_PROFILE_IMAGE_DELETE_SERVER_ERROR_RESPONSE": { "value": { "content": [], "errors": [ { "code": "API-66", "description": "Server error occurred deleting profile image.", "resolution": "Please try again later." } ], "links": [] } }, "WORKER_PROFILE_IMAGE_GET": { "value": "data:image/jpeg;base64,/9j/4AAQSkZJRgABAQAAAQABAAD/2wBDAAMCAgMCAgMDAwMEAwMEBQgFBQQEBQoHBwYIDAoMDAsKCwsNDh..." }, "WORKER_PROFILE_IMAGE_GET_SERVER_ERROR_RESPONSE": { "value": { "content": [], "errors": [ { "code": "API-66", "description": "Server error occurred while retrieving profile image.", "resolution": "Please try again later." } ], "links": [] } }, "WORKER_ADD_DOCUMENT_RESPONSE": { "value": { "content": [ { "docId": "97238619", "name": "sample.pdf", "category": "15", "workerVisible": true, "workerVisibleDate": "2025-05-15T22:27:50.247Z", "expirationDate": "2025-05-30T04:00:00.000Z", "expirationReminderDays": 21 } ] } }, "WORKER_ADD_DOCUMENT_FILE_TYPE_REQUEST": { "value": { "file": "(binary)" } }, "WORKER_ADD_DOCUMENT_NOTIFICATION_REQUEST": { "value": { "notificationToggle": false } }, "WORKER_ADD_DOCUMENT_METADATA": { "value": { "category": "15", "workerVisible": true, "workerVisibleDate": "2025-05-15T22:27:50.247Z", "expirationDate": "2025-05-30T04:00:00.000Z", "expirationReminderDays": 21 } }, "WORKER_ADD_DOCUMENT_FILE_TYPE_ERROR_RESPONSE": { "value": { "content": [], "errors": [ { "code": "API-62", "description": "Uploaded document is not an acceptable file type.", "resolution": "Please upload an acceptable document file type." } ], "links": [] } }, "WORKER_GET_DOCUMENT_RESPONSE": { "value": { "content": [ { "docId": "97155644", "name": "samplepdf.pdf", "expirationDate": "2025-05-30T00:00:00.000Z", "category": "15", "workerVisible": true, "workerVisibleDate": "2025-05-15T00:00:00.000Z", "document": "data:application/pdf;base64,PgpzdGFydHhyZWYKMTg4NTU4CiUlRU9GCg==" } ], "links": [ { "rel": "self", "href": "https://api.paychex.com/workers/008WQ28JLV6YPU9G5A8Q/documents/97155644" } ] } }, "WORKER_GET_DOCUMENT_LIST_RESPONSE": { "value": { "content": [ { "docId": "97238619", "name": "sample.pdf", "category": "15", "workerVisible": true, "workerVisibleDate": "2025-05-15T22:27:50.247Z", "expirationDate": "2025-05-30T04:00:00.000Z", "expirationReminderDays": 10 }, { "docId": "97238620", "name": "example.pdf", "category": "12", "workerVisible": true, "workerVisibleDate": "2025-05-14T22:27:50.247Z", "expirationDate": "2025-05-30T04:00:00.000Z", "expirationReminderDays": 21 } ] } }, "WORKER_GET_DOCUMENT_LIST_NO_DOCS_ERROR_RESPONSE": { "value": { "content": [], "errors": [ { "code": "API-7", "description": "No documents found for this worker." } ], "links": [] } }, "GET_WORKER_NOTES_RESPONSE": { "value": { "metadata": { "contentItemCount": 0, "pagination": { "offset": 0, "limit": 50, "itemCount": 3, "total": 3 } }, "content": [ { "noteId": "970009020586285", "message": "Test Worker Note 1", "startDate": "2025-06-02T00:00:00Z", "endDate": "4712-12-31T00:00:00Z", "createdDate": "2025-06-02T00:00:00Z", "priorityType": "NON_URGENT", "externallyViewable": true, "noteType": "WORKER_NOTE" }, { "noteId": "970009020586319", "message": "Test Worker Note 2", "startDate": "2025-06-02T00:00:00Z", "endDate": "4712-12-31T00:00:00Z", "createdDate": "2025-06-02T00:00:00Z", "priorityType": "NON_URGENT", "externallyViewable": true, "noteType": "WORKER_NOTE" }, { "noteId": "970009020649762", "message": "Test Worker Note 3", "startDate": "2025-06-02T00:00:00Z", "endDate": "4712-12-31T00:00:00Z", "createdDate": "2025-06-02T00:00:00Z", "priorityType": "NON_URGENT", "externallyViewable": true, "noteType": "WORKER_NOTE" } ], "links": [] } } } }, "JSON_CHECK_EXAMPLES": { "value": { "ADD_EARNING_TO_CHECK_REQUEST": { "value": { "componentId": "970002369232910", "lineDate": "2019-08-24T14:15:22Z", "name": "Bonus", "classificationType": "SUPPLEMENTAL", "effectOnPay": "ADDITION", "payAmount": "11.00", "memoed": false } }, "ADD_EARNING_TO_CHECK_RESPONSE": { "value": { "content": [ { "workerId": "00H2A1IUJYQNBYKUD6DS", "paycheckId": "00H2A1IUK7IDBDA179UJ", "payPeriodId": "970002369233004", "blockAutoDistribution": true, "earnings": [ { "componentId": "970002369232910", "checkComponentId": "970003240624468", "name": "Bonus", "classificationType": "SUPPLEMENTAL", "effectOnPay": "ADDITION", "payAmount": "11.00", "memoed": false, "lineDate": "2019-08-24T00:00:00Z" }, { "componentId": "970002369232910", "checkComponentId": "970004188298706", "name": "Bonus", "classificationType": "SUPPLEMENTAL", "effectOnPay": "ADDITION", "payAmount": "11.00", "memoed": false, "lineDate": "2019-08-24T00:00:00Z" } ], "links": [ { "rel": "self", "href": "https://api.paychex.com/checks/00H2A1IUK7IDBDA179UJ" } ] } ] } }, "UPDATE_EARNING_TO_CHECK_RESPONSE": { "value": { "content": [ { "componentId": "970002369232910", "checkComponentId": "970003240624468", "name": "Bonus", "classificationType": "SUPPLEMENTAL", "effectOnPay": "ADDITION", "payAmount": "11.00", "memoed": false, "lineDate": "2019-08-24T00:00:00Z" } ] } }, "UPDATE_EARNING_TO_CHECK_REQUEST": { "value": { "name": "Bonus", "classificationType": "SUPPLEMENTAL", "effectOnPay": "ADDITION", "payAmount": "11.00", "memoed": false, "lineDate": "2019-08-24T00:00:00Z" } }, "GET_CHECKSHELL_RESPONSE": { "metadata": { "contentItemCount": 1 }, "content": [ { "workerId": "970006718522263", "payPeriodId": "970009079255746", "checkCorrelationId": "ef5bb8f6c0a801d7474c185700000005", "earnings": [ { "componentId": "970006718521088", "name": "Overtime", "classificationType": "Supplemental", "effectOnPay": "ADDITION", "memoed": false, "recurring": "true" }, { "componentId": "970006718521127", "name": "Vacation", "classificationType": "Regular", "effectOnPay": "ADDITION", "memoed": false, "recurring": "true" }, { "componentId": "970006718521168", "name": "Holiday", "classificationType": "Regular", "effectOnPay": "ADDITION", "memoed": false, "recurring": "true" }, { "componentId": "970006718521047", "name": "Salary", "classificationType": "Regular", "effectOnPay": "ADDITION", "payRateId": "970006718522314", "payHours": "40", "memoed": true, "recurring": "false" }, { "componentId": "970009068175147", "name": "Vacation PCT", "classificationType": "Regular", "effectOnPay": "ADDITION", "memoed": false, "recurring": "false" }, { "componentId": "970006718521249", "name": "Sick", "classificationType": "Sick pay", "effectOnPay": "ADDITION", "memoed": false, "recurring": "false" }, { "componentId": "970009001697031", "name": "Meals-PCT", "classificationType": "Fringe Benefits", "effectOnPay": "ADDITION_WITH_IN_OUT", "memoed": false, "recurring": "false" }, { "componentId": "970009068175190", "name": "Meals", "classificationType": "Fringe Benefits", "effectOnPay": "ADDITION_WITH_IN_OUT", "memoed": false, "recurring": "false" } ] } ], "links": [] } } }, "WEBHOOK_JSONEXAMPLES": { "value": { "WEBHOOK_ADD_NO_AUTH": { "value": { "hookId": "webhook_NO_AUTH", "companyId": "99Z5V9BTI8J2FCGESC05", "uri": "https://789mw789x4.execute-api.us-east-2.amazonaws.com/messages", "authentication": { "authType": "NO_AUTH" }, "domains": [ "WRKR_DEM" ] } }, "WEBHOOK_ADD_BASIC_AUTH": { "value": { "hookId": "WEBHOOK_ADD_BASIC_AUTH", "uri": "https://789mw789x4.execute-api.us-east-2.amazonaws.com/messages", "companyId": "99Z5V9BTI8J2FCGESC05", "authentication": { "authType": "BASIC_AUTH", "username": "userHook", "password": "test@Web$2&" }, "domains": [ "CLT_DEM" ] } }, "WEBHOOK_ADD_APIKEY": { "value": { "hookId": "WEBHOOK_ADD_APIKEY", "uri": "https://789mw789x4.execute-api.us-east-2.amazonaws.com/messages", "companyId": "99Z5V9BTI8J2FCGESC05", "authentication": { "authType": "APIKEY", "apiKey": "l7xx7be0801fab947758ei6x1cf139df91e" }, "domains": [ "WRKR_CMP" ] } }, "WEBHOOK_ADD_OAUTH2": { "value": { "hookId": "WEBHOOK_ADD_OAUTH2", "uri": "https://789mw789x4.execute-api.us-east-2.amazonaws.com/messages", "companyId": "99Z5V9BTI8J2FCGESC05", "authentication": { "authType": "OAUTH2", "tokenUrl": "https://789mw789x4.execute-api.us-east-2.amazonaws.com/oauth/token", "clientId": "l7xx7be0801fab947758ei6x1cf139df91e", "clientSecret": "a4a904fa6bd94ia1916o3bc0by9aa2ce", "grantType": "client_credentials", "contentType": "application/x-www-form-urlencoded" }, "domains": [ "WRKR_DEM", "WRKR_TAX" ] } }, "WEBHOOK_ADD_OAUTH2_BASIC": { "value": { "hookId": "WEBHOOK_ADD_OAUTH2_BASIC", "uri": "https://789mw789x4.execute-api.us-east-1.amazonaws.com/messages", "companyId": "99Z5V9BTI8J2FCGESC05", "authentication": { "authType": "OAUTH2_BASIC", "tokenUrl": "https://789mw789x4.execute-api.us-east-1.amazonaws.com/oauth/token", "clientId": "l7xx7be0801fab947758ei6x1cf139df91e", "clientSecret": "a4a904fa6bd94ia1916o3bc0by9aa2ce", "grantType": "client_credentials", "contentType": "application/x-www-form-urlencoded" }, "domains": [ "WRKR_DEM", "WRKR_TAX" ] } }, "WEBHOOK_ADD_RESPONSE": { "value": { "hookId": "webhook_NO_AUTH", "companyId": "99Z5V9BTI8J2FCGESC05", "uri": "https://789mw789x4.execute-api.us-east-2.amazonaws.com/messages", "authType": "NO_AUTH", "createdDate": "2021-07-28T00:37:25.149Z", "domains": [ "WRKR_DEM" ] } }, "WEBHOOKS_GET": { "value": [ { "hookId": "webhook_NO_AUTH", "companyId": "99Z5V9BTI8J2FCGESC05", "uri": "https://789mw789x4.execute-api.us-east-2.amazonaws.com/messages", "authType": "NO_AUTH", "createdDate": "2021-07-28T00:37:25.149Z", "domains": [ "WRKR_DEM" ] } ] }, "WEBHOOK_GET": { "value": { "hookId": "OAUTH2_BASIC", "companyId": "99Z5V9BTI8J2FCGESC05", "uri": "https://789mw789x4.execute-api.us-east-2.amazonaws.com/messages", "authType": "OAUTH2_BASIC", "createdDate": "2021-07-28T00:37:25.149Z", "domains": [ "WRKR_DEM", "WRKR_TAX" ] } }, "WEBHOOK_NOTIFICATION_WRKR_EMPL": { "value": { "companyId": "00H2A1IUJXXCQWJ2GHGH", "workerId": "00H2A1IUJXXDIVTGGHGH", "asOfDate": "2022-06-07T10:10:24.000+00:00", "domains": [ "WRKR_EMPL" ], "action": "ADD", "notificationType": "WORKER_MESSAGE", "notificationId": "31a271e5-b970-49e6-ac8f-d46f73c061af" } }, "WEBHOOK_NOTIFICATION_WRKR_TAX": { "value": { "companyId": "00H2A1IUJXXCQWJ2GHGH", "workerId": "00H2A1IUJXXDIVTGGHGH", "asOfDate": "2022-06-07T10:10:24.000+00:00", "domains": [ "WRKR_TAX" ], "action": "ADD", "notificationType": "WORKER_MESSAGE", "notificationId": "31a271e5-b970-49e6-ac8f-d46f73c061af" } }, "WEBHOOK_NOTIFICATION_WRKR_ASGN": { "value": { "companyId": "00H2A1IUJXXCQWJ2GHGH", "workerId": "00H2A1IUJXXDIVTGGHGH", "asOfDate": "2022-06-07T10:10:24.000+00:00", "domains": [ "WRKR_ASGN" ], "action": "ADD", "notificationType": "WORKER_MESSAGE", "notificationId": "31a271e5-b970-49e6-ac8f-d46f73c061af" } }, "WEBHOOK_NOTIFICATION_WRKR_CMP": { "value": { "companyId": "00H2A1IUJXXCQWJ2GHGH", "workerId": "00H2A1IUJXXDIVTGGHGH", "asOfDate": "2022-06-07T10:10:24.000+00:00", "domains": [ "WRKR_CMP" ], "action": "ADD", "notificationType": "WORKER_MESSAGE", "notificationId": "31a271e5-b970-49e6-ac8f-d46f73c061af" } }, "WEBHOOK_NOTIFICATION_WRKR_DEM": { "value": { "companyId": "00H2A1IUJXXCQWJ2GHGH", "workerId": "00H2A1IUJXXDIVTGGHGH", "asOfDate": "2022-06-07T10:10:24.000+00:00", "domains": [ "WRKR_DEM" ], "action": "ADD", "notificationType": "WORKER_MESSAGE", "notificationId": "31a271e5-b970-49e6-ac8f-d46f73c061af" } }, "WEBHOOK_NOTIFICATION_WRKR_ADD": { "value": { "companyId": "00H2A1IUJXXCQWJ2GHGH", "workerId": "00H2A1IUJXXDIVTGGHGH", "asOfDate": "2022-06-07T10:10:24.000+00:00", "domains": [ "WRKR_ADD" ], "action": "ADD", "notificationType": "WORKER_MESSAGE", "notificationId": "31a271e5-b970-49e6-ac8f-d46f73c061af" } }, "WEBHOOK_NOTIFICATION_CLT_PAY_COMP": { "value": { "companyId": "00Z5V9BTIJ0FK88DGHGH", "asOfDate": "2022-01-08T00:06:00.000+00:00", "domains": [ "CLT_PAY_COMP" ], "action": "N-OP", "displayId": "09621789", "notificationType": "CLT_PAY_COMP_MESSAGE", "notificationId": "22e04d72-6c7a-45a6-855b-7bad2261c263" } }, "WEBHOOK_NOTIFICATION_CLT_PYRN": { "value": { "companyId": "00Z5V9BTIJ0FK88DGHGH", "asOfDate": "2022-01-08T00:06:00.000+00:00", "domains": [ "CLT_PYRN" ], "action": "PAYRUN_COMPLETED", "payperiodId": "970000204674443", "notificationType": "PAYRUN_MESSAGE", "notificationId": "22e04d72-6c7a-45a6-855b-7bad2261c263" } }, "WEBHOOK_NOTIFICATION_CLT_DEM": { "value": { "companyId": "00Z5V9BTIJ0FK88DGHGH", "asOfDate": "2022-01-08T00:06:00.000+00:00", "domains": [ "CLT_DEM" ], "action": "UPDATE", "notificationType": "CLT_DEMOGRAPHIC_MESSAGE", "notificationId": "22e04d72-6c7a-45a6-855b-7bad2261c263" } }, "WEBHOOK_NOTIFICATION_CLT_ORG": { "value": { "companyId": "00Z5V9BTIJ0FK88DGHGH", "asOfDate": "2022-01-08T00:06:00.000+00:00", "domains": [ "CLT_ORG" ], "action": "PAYRUN_COMPLETED", "notificationId": "22e04d72-6c7a-45a6-855b-7bad2261c263" } }, "WEBHOOK_NOTIFICATION_CLT_ACCESS": { "value": { "companyId": "00Z5V9BTIJ0FK88DGHGH", "asOfDate": "2022-01-08T00:06:00.000+00:00", "domains": [ "CLT_ACCESS" ], "action": "UPDATE", "notificationType": "CLT_ACCESS_MESSAGE", "notificationId": "22e04d72-6c7a-45a6-855b-7bad2261c263" } }, "WEBHOOK_NOTIFICATION_CLT_LINEAGE": { "value": { "companyId": "00Z5V9BTIJ0FK88DGHGH", "asOfDate": "2025-01-08T00:06:00.000+00:00", "domains": [ "CLT_LINEAGE" ], "action": "UPDATE", "notificationType": "CLT_LINEAGE_MESSAGE", "notificationId": "22e04d72-6c7a-45a6-855b-7bad2261c263" } }, "WEBHOOK_NOTIFICATION_PAY_PERIOD": { "value": { "companyId": "008WQ28JLIXRVG0U4SU5", "asOfDate": "Mon Aug 21 00:00:00 EDT 2023", "domains": [ "PAY_PERIOD" ], "action": "ADD", "notificationId": "ece76f7b-eb58-4d2c-a11f-771a74e6adf2" } }, "WEBHOOK_NOTIFICATION_PAYX_ALERT": { "value": { "asOfDate": "2025-11-23T17:23:07Z", "domains": [ "PAYX_ALERT" ], "alert": { "type": "breaking_change", "headline": "N0 test environment will be deprecated January 20th 2026!", "details": "Please update your test apps in N0 to use N1 before this date!", "uri": "https://devloper.paychex.com/news" }, "notificationType": "PAYX_ALERT_MESSAGE" } }, "PARTNER_DOMAINS": { "value": [ [ "WRKR_TAX", "WRKR_EMPL", "CLT_PYRN", "WRKR_ASGN", "WRKR_DEM", "WRKR_CMP", "WRKR_ADD", "CLT_DEM", "CLT_ACCESS", "PAY_PERIOD", "PAYX_ALERT" ] ] }, "CLIENT_DOMAINS": { "value": [ [ "WRKR_TAX", "CLT_ORG", "WRKR_EMPL", "CLT_PYRN", "WRKR_ASGN", "WRKR_DEM", "WRKR_CMP", "WRKR_ADD", "CLT_DEM", "PAY_PERIOD", "CLT_LINEAGE" ] ] }, "REQUEST_ACCESS": { "value": { "approvalLink": "https://myappsimp6.paychex.com&drawer=paychex.app.drawer.somePartnerAccessDrawer" } }, "CONNECTION_ALREADY_EXISTS": { "value": { "errors": [ { "code": "API-17", "description": "The requested company is already linked to this application", "resolution": "Please use another ClientID and try again" } ] } }, "COMPANY_STATUS": { "value": { "companyId": "008WQ28JLNUKNVIR3UZD", "status": "READY" } } } } } } }