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

• 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

• organizationEmployeeGroupId integer

  Organization employee group ID filter

Responses

• 200 application/json

  OK

  Hide response attribute Show response attribute object

  • items array[object]
    Hide items attributes Show items attributes object

    • errorCode object
      Hide errorCode attributes Show errorCode attributes object

      • errorCode string

        Values are NO_ERROR, NOT_IMPLEMENTED_YET, CONTACT_NOT_FOUND, FIELD_REQUIRED, VALIDATION_ERROR, DUPLICATION_ERROR, UNIQUE_CONSTRAINT_VIOLATION, WRONG_PASSWORD_FORMAT, WRONG_PASSWORD, ACTION_DENIED, NOT_FOUND, EXPECTED_ONE_FILE, UNIQUE_VIOLATION, CONTENT_EMPTY, INVALID_TYPE, CONVERSION_ERROR, FILE_PARSE_EXCEPTION, or IN_USE.

      • errorDetailValues array[object]
        Hide errorDetailValues attributes Show errorDetailValues attributes object

        • errorCode string
        • fieldName string
        • data string
        • isSevere boolean
    • freshData

      Refreshed domain data

    • freshRow

      Refreshed table row data

    • possibleWorkflows array[object]
      Hide possibleWorkflows attributes Show possibleWorkflows attributes object

      • id integer(int64)
      • name string
    • error boolean
    • severeError boolean
• 400

  400 Bad Request

• 401

  401 Unauthorized

• 403

  403 Access Denied

• 404

  404 Not Found

• 500

  500 Internal Server Error