Get Payslip Data by Employee

Gets the pay slip data for an employee in a payrun.

Request

GET ../api/v1/client/payrun/{payrunId}/payslip/data/{identityCardNumber}

Path parameters

Parameter name	Value	Description	Additional
payrunId	int32		Required
identityCardNumber	int32		Required

Response

The following HTTP status codes may be returned, optionally with a response resource.

Status code	Description	Resource
200	Success	Refer Response Data

Response Data

{
    "accruedLeave": [
        {
            "amount": "double",
            "leaveCategory": "string",
            "notes": "string"
        }
    ],
    "bankPayments": [
        {
            "accountName": "string",
            "accountNumber": "string",
            "amount": "double",
            "bankCode": "string",
            "branchCode": "string",
            "lodgementReference": "string"
        }
    ],
    "basePayRate": "string",
    "baseRate": "string",
    "benefitsInKindAdjustments": [
        {
            "amount": "double",
            "benefitsInKindType": "string",
            "notes": "string"
        }
    ],
    "businessAddress": "string",
    "businessName": "string",
    "contactName": "string",
    "deductions": [
        {
            "amount": "double",
            "name": "string",
            "notes": "string",
            "taxStatus": "string"
        }
    ],
    "earningsLines": [
        {
            "grossEarnings": "double",
            "isFixed": "boolean",
            "isTaxExempt": "boolean",
            "locationName": "string",
            "notes": "string",
            "payCategoryName": "string",
            "rate": "double",
            "taxableEarnings": "double",
            "units": "double"
        }
    ],
    "employeeBaseRate": "double",
    "employeeBaseRateUnit": "string",
    "employeeEpfNumber": "string",
    "employeeExpenses": [
        {
            "amount": "double",
            "employeeExpenseCategoryName": "string",
            "locationName": "string",
            "notes": "string"
        }
    ],
    "employeeExternalId": "string",
    "employeeFirstName": "string",
    "employeeId": "int32",
    "employeeName": "string",
    "employeePostalAddressCountry": "string",
    "employeePostalAddressLine2": "string",
    "employeePostalAddressLine3": "string",
    "employeePostalAddressType": "string",
    "employeePostalBlockNumber": "string",
    "employeePostalLevelNumber": "string",
    "employeePostalStreetAddress": "string",
    "employeePostalStreetName": "string",
    "employeePostalSuburbName": "string",
    "employeePostalSuburbPostcode": "string",
    "employeePostalSuburbState": "string",
    "employeePostalUnitNumber": "string",
    "employeeSurname": "string",
    "grossEarnings": "double",
    "grossYTD": "double",
    "grossYTDDetails": [
        {
            "grossEarnings": "double",
            "payCategoryName": "string"
        }
    ],
    "hourlyRate": "double",
    "id": "int32",
    "isPublished": "boolean",
    "leaveTaken": [
        {
            "amount": "double",
            "leaveCategory": "string",
            "notes": "string"
        }
    ],
    "message": "string",
    "netEarnings": "double",
    "netYTD": "double",
    "notation": "string",
    "otherAmounts": [
        {
            "amount": "double",
            "category": "string",
            "name": "string",
            "ytdAmount": "double"
        }
    ],
    "payPeriodEnding": "string",
    "payPeriodStarting": "string",
    "postTaxDeductionAmount": "double",
    "postTaxDeductionsYTD": "double",
    "preTaxDeductionAmount": "double",
    "preTaxDeductionsYTD": "double",
    "startDate": "date-time",
    "taxableEarnings": "double",
    "terminationDate": "date-time",
    "totalAccruedLeave": [
        {
            "amount": "double",
            "leaveCategory": "string",
            "notes": "string"
        }
    ],
    "totalHours": "double",
    "withholdingYTD": "double"
}