GrossPayItems_GetList
Retrieve a list of gross pay items for employees or technicians by specifying filters such as date range, payroll ID, or employee type using a structured API request.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| dateOnOrAfter | No | Format - date-time (as date-time in RFC3339). Return items having date after certain date/time (in UTC) | |
| dateOnOrBefore | No | Format - date-time (as date-time in RFC3339). Return items having date before certain date/time (in UTC) | |
| employeeId | No | Format - int64. The Employee ID | |
| employeeType | No | The type of employee Values: [Technician, Employee] | |
| includeTotal | No | Whether total count should be returned | |
| page | No | Format - int32. The logical number of page to return, starting from 1 | |
| pageSize | No | Format - int32. How many records to return (50 by default) | |
| payrollIds | No | The payroll ID | |
| tenant | Yes | Format - int64. Tenant ID |
Input Schema (JSON Schema)
{
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"dateOnOrAfter": {
"description": "Format - date-time (as date-time in RFC3339). Return items having date after certain date/time (in UTC)",
"type": "string"
},
"dateOnOrBefore": {
"description": "Format - date-time (as date-time in RFC3339). Return items having date before certain date/time (in UTC)",
"type": "string"
},
"employeeId": {
"description": "Format - int64. The Employee ID",
"type": "integer"
},
"employeeType": {
"description": "The type of employee\nValues: [Technician, Employee]",
"type": "string"
},
"includeTotal": {
"description": "Whether total count should be returned",
"type": "boolean"
},
"page": {
"description": "Format - int32. The logical number of page to return, starting from 1",
"type": "integer"
},
"pageSize": {
"description": "Format - int32. How many records to return (50 by default)",
"type": "integer"
},
"payrollIds": {
"description": "The payroll ID",
"type": "string"
},
"tenant": {
"description": "Format - int64. Tenant ID",
"type": "integer"
}
},
"required": [
"tenant"
],
"type": "object"
}