Retrieve Pay Deductions By Code
    • 25 Sep 2024
    • 1 Minute to read
    • Dark
      Light

    Retrieve Pay Deductions By Code

    • Dark
      Light

    Article summary

    Get
    /hcm-rest-api/rest/1/ukgpaydeductions

    Query Standards

    Finder

    Following row finders are available for data filtering and optimizing request performance.

    • Select Deductions

    Select Deductions

    Recommended finder parameters. Refer to Query Parameters for example.

    ParameterDescriptionSample
    companyCodeCompany Code001
    payRunCodePay Run CodeWK
    employeeNumEmployee Number007
    payPeriodPay Period25
    payYearPay Year2022
    Security
    HTTP
    Type basic

    Basic authentication

    Query parameters
    finder
    string
    ExampleselectDeductions;companyCode=001, payRunCode=WK, employeeNum=007, payPeriod=25, payYear=2022
    limit
    integer
    Example500
    offset
    integer
    Example0
    totalResults
    boolean
    Exampletrue
    orderBy
    string
    ExampleEmpdedEmpNo:desc
    Responses
    200

    Successful response