# Paychex

> Read Paychex Flex companies, workers, compensation, payroll periods and company configuration.

App · 20 actions. Web page: https://docs.lodol.com/docs/integrations/paychex

## Actions

### Get company

Get company.

**Inputs**

- Company (`company_id`, text, required): The ID of the company.

**Outputs**: Result.

- `data` (object): Complete service response.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation value for the next page.

**Example output**

```json
{
  "data": {
    "content": {
      "communications": [],
      "companyId": "",
      "displayId": "",
      "hasPermission": false,
      "legalId": {},
      "legalName": "",
      "lineage": {},
      "links": []
    },
    "links": []
  },
  "has_more": false,
  "next_cursor": null
}
```

### Get pay period

Get pay period.

**Inputs**

- Company (`company_id`, text, required): The id assigned to the company that is being requested for.
- Payperiod id (`payperiod_id`, text, required): The id assigned to the PayPeriod you are looking for.

**Outputs**: Result.

- `data` (object): Complete service response.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation value for the next page.

**Example output**

```json
{
  "data": {
    "content": {
      "checkCount": 0,
      "checkDate": "",
      "description": "",
      "endDate": "",
      "intervalCode": "ANNUAL",
      "links": [],
      "originalPayPeriodID": "",
      "payPeriodId": "",
      "startDate": "",
      "status": "COMPLETED",
      "submitByDate": ""
    },
    "links": []
  },
  "has_more": false,
  "next_cursor": null
}
```

### Get worker

Get worker.

**Inputs**

- Worker id (`worker_id`, text, required): ID associated with desired worker.

**Outputs**: Result.

- `data` (object): Complete service response.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation value for the next page.

**Example output**

```json
{
  "data": {
    "content": {
      "_links": {},
      "birthDate": "",
      "clockId": "",
      "communications": [],
      "currentStatus": {},
      "customEmploymentType": {},
      "employeeId": "",
      "employmentType": "FULL_TIME",
      "ethnicityCode": "",
      "exemptionType": "EXEMPT",
      "hireDate": "",
      "job": {},
      "jobId": "",
      "laborAssignmentId": "",
      "legalId": {},
      "locationId": "",
      "name": {},
      "organization": {},
      "profileImageURL": "",
      "seniorityDate": "",
      "sex": "MALE",
      "supervisor": {},
      "workState": "",
      "workerCorrelationId": "",
      "workerId": "",
      "workerType": ""
    },
    "links": []
  },
  "has_more": false,
  "next_cursor": null
}
```

### Get worker compensation

Get worker compensation.

**Inputs**

- Worker id (`worker_id`, text, required): ID associated with desired worker.

**Outputs**: Result.

- `data` (object): Complete service response.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation value for the next page.

**Example output**

```json
{
  "data": {
    "content": {
      "_links": {},
      "content": [],
      "errors": [],
      "message": "",
      "metadata": {}
    },
    "links": []
  },
  "has_more": false,
  "next_cursor": null
}
```

### List companies

List companies. Returns one page; use the continuation value for more records.

**Inputs**

- Offset (`offset`, number): Offset.
- Limit (`limit`, number): Limit. At least 1.

**Outputs**: Result.

- `data` (object): Complete service response.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation value for the next page.

**Example output**

```json
{
  "data": {
    "content": {
      "communications": [],
      "companyId": "",
      "displayId": "",
      "hasPermission": false,
      "legalId": {},
      "legalName": "",
      "lineage": {},
      "links": []
    },
    "links": [],
    "metadata": {
      "contentItemCount": 0,
      "pagination": {}
    }
  },
  "has_more": false,
  "next_cursor": null
}
```

### List job titles

List job titles.

**Inputs**

- Company (`company_id`, text, required): The ID of the company.

**Outputs**: Result.

- `data` (object): Complete service response.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation value for the next page.

**Example output**

```json
{
  "data": {
    "content": {
      "endDate": "",
      "jobTitleId": "",
      "links": [],
      "startDate": "",
      "title": ""
    },
    "links": [],
    "metadata": {
      "contentItemCount": 0,
      "pagination": {}
    }
  },
  "has_more": false,
  "next_cursor": null
}
```

### List jobs

List jobs.

**Inputs**

- Company (`company_id`, text, required): The ID of the company.

**Outputs**: Result.

- `data` (object): Complete service response.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation value for the next page.

**Example output**

```json
{
  "data": {
    "content": {
      "endDate": "",
      "jobCorrelationId": "",
      "jobId": "",
      "jobName": "",
      "jobNumber": {},
      "links": [],
      "startDate": ""
    },
    "links": [],
    "metadata": {
      "contentItemCount": 0,
      "pagination": {}
    }
  },
  "has_more": false,
  "next_cursor": null
}
```

### List labor assignments

List labor assignments.

**Inputs**

- Company (`company_id`, text, required): The ID of the company.

**Outputs**: Result.

- `data` (object): Complete service response.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation value for the next page.

**Example output**

```json
{
  "data": {
    "content": {
      "endDate": "",
      "laborAssignmentId": "",
      "links": [],
      "locationId": "",
      "name": "",
      "organizationId": "",
      "positionId": "",
      "rate": "",
      "startDate": ""
    },
    "links": [],
    "metadata": {
      "contentItemCount": 0,
      "pagination": {}
    }
  },
  "has_more": false,
  "next_cursor": null
}
```

### List locations

List locations.

**Inputs**

- Company (`company_id`, text, required): The ID of the company.

**Outputs**: Result.

- `data` (object): Complete service response.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation value for the next page.

**Example output**

```json
{
  "data": {
    "content": {
      "address": {},
      "links": [],
      "locationId": "",
      "movedIn": "",
      "movedOut": "",
      "name": ""
    },
    "links": [],
    "metadata": {
      "contentItemCount": 0,
      "pagination": {}
    }
  },
  "has_more": false,
  "next_cursor": null
}
```

### List organizations

List organizations.

**Inputs**

- Company (`company_id`, text, required): The ID of the company.

**Outputs**: Result.

- `data` (object): Complete service response.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation value for the next page.

**Example output**

```json
{
  "data": {
    "content": {
      "level": "",
      "links": [],
      "name": "",
      "number": "",
      "organizationId": ""
    },
    "links": [],
    "metadata": {
      "contentItemCount": 0,
      "pagination": {}
    }
  },
  "has_more": false,
  "next_cursor": null
}
```

### List pay components

List pay components.

**Inputs**

- Company (`company_id`, text, required): The id assigned to the company that is being requested for.

**Outputs**: Result.

- `data` (object): Complete service response.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation value for the next page.

**Example output**

```json
{
  "data": {
    "content": {
      "appliesToWorkerTypes": [],
      "calculationType": "",
      "checkComponentId": "",
      "classificationType": "",
      "code": "",
      "componentId": "",
      "description": "",
      "effectOnPay": "ADDITION",
      "endDate": "",
      "jobId": "",
      "laborAssignmentId": "",
      "lineDate": "",
      "links": [],
      "memoed": false,
      "name": "",
      "organization": {},
      "payAmount": "",
      "payHours": "",
      "payRate": "",
      "payRateId": "",
      "payUnits": "",
      "startDate": ""
    },
    "links": [],
    "metadata": {
      "contentItemCount": 0,
      "pagination": {}
    }
  },
  "has_more": false,
  "next_cursor": null
}
```

### List pay frequencies

List pay frequencies.

**Inputs**

- Company (`company_id`, text, required): The ID of the company.

**Outputs**: Result.

- `data` (object): Complete service response.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation value for the next page.

**Example output**

```json
{
  "data": {
    "content": {
      "links": [],
      "payComponentFrequency": {},
      "payFrequency": ""
    },
    "links": [],
    "metadata": {
      "contentItemCount": 0,
      "pagination": {}
    }
  },
  "has_more": false,
  "next_cursor": null
}
```

### List pay periods

List pay periods.

**Inputs**

- Company (`company_id`, text, required): The id assigned to the company that is being requested for.
- Status (`status`, list): Get PayPeriods that are in List of specific status.
- From (`from_value`, text): The beginning of the search date range using the Payperiod start date.
- To (`to`, text): The ending of the search date range using the Payperiod end date.

**Outputs**: Result.

- `data` (object): Complete service response.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation value for the next page.

**Example output**

```json
{
  "data": {
    "content": {
      "checkCount": 0,
      "checkDate": "",
      "description": "",
      "endDate": "",
      "intervalCode": "ANNUAL",
      "links": [],
      "originalPayPeriodID": "",
      "payPeriodId": "",
      "startDate": "",
      "status": "COMPLETED",
      "submitByDate": ""
    },
    "links": [],
    "metadata": {
      "contentItemCount": 0,
      "pagination": {}
    }
  },
  "has_more": false,
  "next_cursor": null
}
```

### List webhook domains

List webhook domains.

**Inputs**: None.

**Outputs**: Result.

- `data` (text): Complete service response.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation value for the next page.

**Example output**

```json
{
  "data": "",
  "has_more": false,
  "next_cursor": null
}
```

### List worker communications

List worker communications.

**Inputs**

- Worker id (`worker_id`, text, required): The id assigned to the worker that workers are being requested for.

**Outputs**: Result.

- `data` (object): Complete service response.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation value for the next page.

**Example output**

```json
{
  "data": {
    "content": {
      "_links": {},
      "city": "",
      "communicationId": "",
      "countryCode": "",
      "countrySubdivisionCode": "",
      "dialArea": "",
      "dialCountry": "",
      "dialExtension": "",
      "dialNumber": "",
      "postOfficeBox": "",
      "postalCode": "",
      "postalCodeExtension": "",
      "streetLineOne": "",
      "streetLineTwo": "",
      "type": "STREET_ADDRESS",
      "uri": "",
      "usageType": "PERSONAL"
    },
    "links": [],
    "metadata": {
      "contentItemCount": 0,
      "pagination": {}
    }
  },
  "has_more": false,
  "next_cursor": null
}
```

### List worker contacts

List worker contacts.

**Inputs**

- Worker id (`worker_id`, text, required): ID associated with desired worker.

**Outputs**: Result.

- `data` (object): Complete service response.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation value for the next page.

**Example output**

```json
{
  "data": {
    "content": {
      "contactId": "",
      "contactType": {},
      "notifyIfArrestedOrDetained": false,
      "relationship": {}
    },
    "links": [],
    "metadata": {
      "contentItemCount": 0,
      "pagination": {}
    }
  },
  "has_more": false,
  "next_cursor": null
}
```

### List worker pay rates

List worker pay rates.

**Inputs**

- Worker id (`worker_id`, text, required): ID associated with desired worker.

**Outputs**: Result.

- `data` (object): Complete service response.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation value for the next page.

**Example output**

```json
{
  "data": {
    "content": {
      "_links": {},
      "amount": "",
      "default": false,
      "description": "",
      "effectiveDate": "",
      "rateId": "",
      "rateNumber": "",
      "rateType": "ANNUAL_SALARY",
      "standardHours": "",
      "standardOvertime": "",
      "startDate": ""
    },
    "links": []
  },
  "has_more": false,
  "next_cursor": null
}
```

### List worker statuses

List worker statuses.

**Inputs**

- Company (`company_id`, text, required): The ID of the company.

**Outputs**: Result.

- `data` (object): Complete service response.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation value for the next page.

**Example output**

```json
{
  "data": {
    "content": {
      "links": [],
      "statusReason": "",
      "statusType": "",
      "workerStatusId": ""
    },
    "links": [],
    "metadata": {
      "contentItemCount": 0,
      "pagination": {}
    }
  },
  "has_more": false,
  "next_cursor": null
}
```

### List worker time off

List worker time off.

**Inputs**

- Worker id (`worker_id`, text, required): The ID of the worker.

**Outputs**: Result.

- `data` (object): Complete service response.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation value for the next page.

**Example output**

```json
{
  "data": {
    "content": {
      "balance": "",
      "measure": "HOURS",
      "name": "",
      "policyId": "",
      "type": ""
    },
    "links": [],
    "metadata": {
      "contentItemCount": 0,
      "pagination": {}
    }
  },
  "has_more": false,
  "next_cursor": null
}
```

### List workers

List workers. Returns one page; use the continuation value for more records.

**Inputs**

- Company (`company_id`, text, required): The id assigned to the company that workers are being requested for.
- From (`from_value`, text): The beginning of the search date range using for when the worker was created.
- To (`to`, text): The ending of the search date range using for then the worker was created.
- Status (`status`, text): The status of the worker
- Offset (`offset`, number): Offset.
- Limit (`limit`, number): Limit. At least 1.

**Outputs**: Result.

- `data` (object): Complete service response.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation value for the next page.

**Example output**

```json
{
  "data": {
    "content": {
      "birthDate": "",
      "clockId": "",
      "communications": [],
      "currentStatus": {},
      "employeeId": "",
      "employmentType": "FULL_TIME",
      "ethnicityCode": "(blank)",
      "exemptionType": "EXEMPT",
      "hireDate": "",
      "job": {},
      "jobId": "",
      "laborAssignmentId": "",
      "legalId": {},
      "locationId": "",
      "name": {},
      "organization": {},
      "profileImageURL": "",
      "seniorityDate": "",
      "sex": "MALE",
      "supervisor": {},
      "workerCorrelationId": "",
      "workerId": "",
      "workerType": ""
    },
    "links": [],
    "metadata": {
      "contentItemCount": 0,
      "pagination": {}
    }
  },
  "has_more": false,
  "next_cursor": null
}
```
