Headers

• WEAL-TOKEN Required

  API token (can be retrieved from account settings)

• TARGET-ORGANIZATION-ID

  ID of organization, for which the operation must be performed

Query parameters

• pageNumber integer

  Page Number

  Default value is 1.

• sortingField string

  Field to sort by

• direction string

  Sorting direction

  Values are ASC or DESC. Default value is ASC.

• sizePerPage integer

  Size per page

  Default value is 60.

• id string

  Payroll ID filter.
  
  Multi-value supported. Example: value1;value2
  
  

• calendarYear integer(int32)

  Calendar year filter

• monthType string

  Payroll month filter

  Values are JANUARY, FEBRUARY, MARCH, APRIL, MAY, JUNE, JULY, AUGUST, SEPTEMBER, OCTOBER, NOVEMBER, or DECEMBER.

• paymentDate string

  Payment date filterSupports comparison operators:

  • Range ( .. )
  • Greater than ( > )
  • Greater than or equal ( >= )
  • Less than ( < )
  • Less than or equal ( <= )
  • Not equal ( <> )

  Examples:

  • 01/01/2026..31/12/2026
  • >=01/01/2026
  • <=01/01/2026
  • <>01/01/2026

  Use <>01/01/2026 to return only records where the selected date is not equal to the filter date.
  
  

• employeeId string

  Employee contact ID filter.
  
  Multi-value supported. Example: value1;value2
  
  

• currencyCode string

  Currency code filter

• grossSalary string

  Gross salary filterSupports comparison operators:

  • Range ( .. )
  • Greater than ( > )
  • Greater than or equal ( >= )
  • Less than ( < )
  • Less than or equal ( <= )
  • Not equal ( <> )

  Examples:

  • <=100.00
  • >=100.00
  • <>100.00
  • 100.00..200.00

  Use <>0 to return only records where the selected amount is not equal to zero.
  
  

• netSalary string

  Net salary filterSupports comparison operators:

  • Range ( .. )
  • Greater than ( > )
  • Greater than or equal ( >= )
  • Less than ( < )
  • Less than or equal ( <= )
  • Not equal ( <> )

  Examples:

  • <=100.00
  • >=100.00
  • <>100.00
  • 100.00..200.00

  Use <>0 to return only records where the selected amount is not equal to zero.
  
  

• payable string

  Payable amount filterSupports comparison operators:

  • Range ( .. )
  • Greater than ( > )
  • Greater than or equal ( >= )
  • Less than ( < )
  • Less than or equal ( <= )
  • Not equal ( <> )

  Examples:

  • <=100.00
  • >=100.00
  • <>100.00
  • 100.00..200.00

  Use <>0 to return only records where the selected amount is not equal to zero.
  
  

• status string

  Payroll status filter

  Values are UNPAID, PAID, PARTIALLY_PAID, or WIRED.

• employeeEmail string

  Employee email filter

• employeeECorrespondence boolean

  Whether the employee uses e-correspondence

• isDocSent boolean

  Whether the payroll document has been sent to the employee

• addressEmployeeName string

  Employee address name filter

• addressStreet string

  Employee address street filter

• addressStreetPoBox string

  Employee address P.O. box / street line 2 filter

• addressPostCode string

  Employee address postal code filter

• addressCity string

  Employee address city filter

• addressCountry string

  Employee address country filter

• addressRegion string

  Employee address region filter

• addressToTheAttentionOf string

  Employee address 'to the attention of' filter

• addressHouseNumber string

  Employee address house number filter

• payslipEmployerRate number

  Payslip line employer contribution rate filter

• payslipLineNumber string

  Payslip line number filter.
  
  Multi-value supported. Example: value1;value2
  
  

• payslipEmployeeAmount string

  Payslip line employee amount filterSupports comparison operators:

  • Range ( .. )
  • Greater than ( > )
  • Greater than or equal ( >= )
  • Less than ( < )
  • Less than or equal ( <= )
  • Not equal ( <> )

  Examples:

  • <=100.00
  • >=100.00
  • <>100.00
  • 100.00..200.00

  Use <>0 to return only records where the selected amount is not equal to zero.
  
  

• payslipBaseAmount string

  Payslip line base amount filterSupports comparison operators:

  • Range ( .. )
  • Greater than ( > )
  • Greater than or equal ( >= )
  • Less than ( < )
  • Less than or equal ( <= )
  • Not equal ( <> )

  Examples:

  • <=100.00
  • >=100.00
  • <>100.00
  • 100.00..200.00

  Use <>0 to return only records where the selected amount is not equal to zero.
  
  

• payslipDescription string

  Payslip line description filter

• payslipEmployeeRate number

  Payslip line employee contribution rate filter

• payslipEmployerAmount string

  Payslip line employer amount filterSupports comparison operators:

  • Range ( .. )
  • Greater than ( > )
  • Greater than or equal ( >= )
  • Less than ( < )
  • Less than or equal ( <= )
  • Not equal ( <> )

  Examples:

  • <=100.00
  • >=100.00
  • <>100.00
  • 100.00..200.00

  Use <>0 to return only records where the selected amount is not equal to zero.
  
  

• paidAmount string

  Payment paid amount filterSupports comparison operators:

  • Range ( .. )
  • Greater than ( > )
  • Greater than or equal ( >= )
  • Less than ( < )
  • Less than or equal ( <= )
  • Not equal ( <> )

  Examples:

  • <=100.00
  • >=100.00
  • <>100.00
  • 100.00..200.00

  Use <>0 to return only records where the selected amount is not equal to zero.
  
  

• bankCharges string

  Payment bank charges filterSupports comparison operators:

  • Range ( .. )
  • Greater than ( > )
  • Greater than or equal ( >= )
  • Less than ( < )
  • Less than or equal ( <= )
  • Not equal ( <> )

  Examples:

  • <=100.00
  • >=100.00
  • <>100.00
  • 100.00..200.00

  Use <>0 to return only records where the selected amount is not equal to zero.
  
  

• payableByCurrencyCode string

  Payable-by currency code filter

• salarySlipCurrencyCode string

  Salary slip currency code filter

• requestedAmount string

  Payment requested amount filterSupports comparison operators:

  • Range ( .. )
  • Greater than ( > )
  • Greater than or equal ( >= )
  • Less than ( < )
  • Less than or equal ( <= )
  • Not equal ( <> )

  Examples:

  • <=100.00
  • >=100.00
  • <>100.00
  • 100.00..200.00

  Use <>0 to return only records where the selected amount is not equal to zero.
  
  

• requestedDate string

  Payment requested date filterSupports comparison operators:

  • Range ( .. )
  • Greater than ( > )
  • Greater than or equal ( >= )
  • Less than ( < )
  • Less than or equal ( <= )
  • Not equal ( <> )

  Examples:

  • 01/01/2026..31/12/2026
  • >=01/01/2026
  • <=01/01/2026
  • <>01/01/2026

  Use <>01/01/2026 to return only records where the selected date is not equal to the filter date.
  
  

• plannedDate string

  Payment planned date filterSupports comparison operators:

  • Range ( .. )
  • Greater than ( > )
  • Greater than or equal ( >= )
  • Less than ( < )
  • Less than or equal ( <= )
  • Not equal ( <> )

  Examples:

  • 01/01/2026..31/12/2026
  • >=01/01/2026
  • <=01/01/2026
  • <>01/01/2026

  Use <>01/01/2026 to return only records where the selected date is not equal to the filter date.
  
  

• sentDate string

  Payment sent date filterSupports comparison operators:

  • Range ( .. )
  • Greater than ( > )
  • Greater than or equal ( >= )
  • Less than ( < )
  • Less than or equal ( <= )
  • Not equal ( <> )

  Examples:

  • 01/01/2026..31/12/2026
  • >=01/01/2026
  • <=01/01/2026
  • <>01/01/2026

  Use <>01/01/2026 to return only records where the selected date is not equal to the filter date.
  
  

• valueDate string

  Payment value date filterSupports comparison operators:

  • Range ( .. )
  • Greater than ( > )
  • Greater than or equal ( >= )
  • Less than ( < )
  • Less than or equal ( <= )
  • Not equal ( <> )

  Examples:

  • 01/01/2026..31/12/2026
  • >=01/01/2026
  • <=01/01/2026
  • <>01/01/2026

  Use <>01/01/2026 to return only records where the selected date is not equal to the filter date.
  
  

• orgEmployeeGroupId integer(int64)

  Organization employee group ID filter.
  
  Multi-value supported. Example: value1;value2
  
  

Responses

• 200 application/json

  OK

  Hide response attributes Show response attributes object

  • id integer(int64)
  • organizationId integer(int64)
  • calendarYear integer(int32)
  • monthNumber integer(int32)
  • monthType string

    Values are JANUARY, FEBRUARY, MARCH, APRIL, MAY, JUNE, JULY, AUGUST, SEPTEMBER, OCTOBER, NOVEMBER, or DECEMBER.

  • paymentDate string(date-time)
  • employee string
  • employeeId integer(int64)
  • currencyCode string
  • grossSalary number
  • netSalary number
  • payable number
  • status string

    Values are UNPAID, PAID, PARTIALLY_PAID, or WIRED.

  • warnings string
  • employeeEmail string
  • employeeECorrespondence boolean
  • organizationEmployeeGroupName string
  • organizationEmployeeGroupIds array[integer(int64)]
  • isDocSent boolean
• 400

  400 Bad Request

• 401

  401 Unauthorized

• 403

  403 Access Denied

• 404

  404 Not Found

• 500

  500 Internal Server Error