List an employee's recurring components or loans
payspace_list_recurring_componentsList the recurring payroll components (EmployeeComponent) or loans (EmployeeLoan) of ONE employee for a payroll frequency and run. Personal data (pay). Get frequency from payspace_list_payroll_frequencies and period from payspace_list_payroll_runs. GET /odata/v2.0/{company}/{entity}?frequency=&period=&$filter=EmployeeNumber eq '...'.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| top | No | Page size ($top, default and maximum 100). | |
| skip | No | Records to skip ($skip), for paging: page 2 of size 100 is skip=100. | |
| count | No | Include the total number of matching records as @odata.count. | |
| entity | Yes | EmployeeComponent (recurring components) or EmployeeLoan (loans). | |
| period | Yes | Payroll run (period), required by PaySpace. A value from payspace_list_payroll_runs (the CompanyRun lookup) for the chosen frequency. | |
| orderby | No | OData $orderby, for example `LastName asc`. | |
| frequency | Yes | Payroll frequency, required by PaySpace. A value from payspace_list_payroll_frequencies (the CompanyFrequency lookup). | |
| company_id | No | PaySpace company id or company code. Optional when the credentials give access to exactly one company; call payspace_list_companies to see them. | |
| employee_number | Yes | Employee number (the EmployeeNumber field of payspace_list_employees). PaySpace requires this filter for recurring components. |