Get list of payrolls using advanced filters

GET /api-v1/payroll/advanced

Headers

TARGET-ORGANIZATION-ID integer(int32)

ID of organization, for which the operation must be performed
WEAL-TOKEN string Required

API token (can be retrieved from account settings)

Responses

200

OK
Hide response attributes Show response attributes object
- calendarYear integer(int32)
- currencyCode string
- employee string
- employeeECorrespondence boolean
- employeeEmail string
- employeeId integer
- grossSalary number
- id integer
- monthNumber integer(int32)
- monthType string
  
  Values are JANUARY, FEBRUARY, MARCH, APRIL, MAY, JUNE, JULY, AUGUST, SEPTEMBER, OCTOBER, NOVEMBER, or DECEMBER.
- netSalary number
- organizationEmployeeGroupId integer
- organizationEmployeeGroupName string
- organizationId integer
- payable number
- paymentDate string(date-time)
- status string
  
  Values are UNPAID, PAID, PARTIALLY_PAID, WIRED, or NOT_SENT.
- warnings string
400

400 Bad Request
401

401 Unauthorized
403

403 Access Denied
404

404 Not Found
500

500 Internal Server Error

GET /api-v1/payroll/advanced

curl \
 -X GET http://10.10.10.132/api-v1/payroll/advanced \
 -H "TARGET-ORGANIZATION-ID: 42" \
 -H "WEAL-TOKEN: string"

Response examples (200)

[
  {
    "calendarYear": 42,
    "currencyCode": "string",
    "employee": "string",
    "employeeECorrespondence": true,
    "employeeEmail": "string",
    "employeeId": 42,
    "grossSalary": 42.0,
    "id": 42,
    "monthNumber": 42,
    "monthType": "JANUARY",
    "netSalary": 42.0,
    "organizationEmployeeGroupId": 42,
    "organizationEmployeeGroupName": "string",
    "organizationId": 42,
    "payable": 42.0,
    "paymentDate": "2024-05-04T09:42:00+00:00",
    "status": "UNPAID",
    "warnings": "string"
  }
]