MyApiPaySlipModel resource

Methods

  • get - Get Pay Slip Data by Employee ID

Resource

{
    "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"
}

Properties

Name Type Description
accruedLeave[] array
accruedLeave[].amount double Decimal
accruedLeave[].leaveCategory string String
accruedLeave[].notes string String
bankPayments[] array
bankPayments[].accountName string String
bankPayments[].accountNumber string String
bankPayments[].amount double Decimal
bankPayments[].bankCode string String
bankPayments[].branchCode string String
bankPayments[].lodgementReference string String
basePayRate string String
baseRate string String
benefitsInKindAdjustments[] array
benefitsInKindAdjustments[].amount double Decimal
benefitsInKindAdjustments[].benefitsInKindType string String
benefitsInKindAdjustments[].notes string String
businessAddress string String
businessName string String
contactName string String
deductions[] array
deductions[].amount double Decimal
deductions[].name string String
deductions[].notes string String
deductions[].taxStatus string String
earningsLines[] array
earningsLines[].grossEarnings double Decimal
earningsLines[].isFixed boolean Boolean
earningsLines[].isTaxExempt boolean Boolean
earningsLines[].locationName string String
earningsLines[].notes string String
earningsLines[].payCategoryName string String
earningsLines[].rate double Decimal
earningsLines[].taxableEarnings double Decimal
earningsLines[].units double Decimal
employeeBaseRate double Decimal
employeeBaseRateUnit string RateUnitEnum

Possible values are:

  • Hourly
  • Annually
  • Fixed
  • Daily
  • Monthly
employeeEpfNumber string String
employeeExpenses[] array
employeeExpenses[].amount double Decimal
employeeExpenses[].employeeExpenseCategoryName string String
employeeExpenses[].locationName string String
employeeExpenses[].notes string String
employeeExternalId string String
employeeFirstName string String
employeeId int32 Int32
employeeName string String
employeePostalAddressCountry string String
employeePostalAddressLine2 string String
employeePostalAddressLine3 string String
employeePostalAddressType string String
employeePostalBlockNumber string String
employeePostalLevelNumber string String
employeePostalStreetAddress string String
employeePostalStreetName string String
employeePostalSuburbName string String
employeePostalSuburbPostcode string String
employeePostalSuburbState string String
employeePostalUnitNumber string String
employeeSurname string String
grossEarnings double Decimal
grossYTD double Decimal
grossYTDDetails[] array
grossYTDDetails[].grossEarnings double Decimal
grossYTDDetails[].payCategoryName string String
hourlyRate double Decimal
id int32 Int32
isPublished boolean Boolean
leaveTaken[] array
leaveTaken[].amount double Decimal
leaveTaken[].leaveCategory string String
leaveTaken[].notes string String
message string String
netEarnings double Decimal
netYTD double Decimal
notation string String
otherAmounts[] array
otherAmounts[].amount double Nullable
otherAmounts[].category string PayslipCategory

Possible values are:

  • Earnings
  • TerminationEarnings
  • ETP
  • PreTaxDeductions
  • Taxes
  • PostTaxDeductions
  • Expenses
  • Liabilities
  • SuperContributions
  • Deductions
  • EmployerContributions
  • KiwiSaverContributions
  • StatutoryContributions
  • PayrolledBenefits
  • BenefitsInKindAdjustments
  • StatutoryDetails
otherAmounts[].name string String
otherAmounts[].ytdAmount double Nullable
payPeriodEnding string String
payPeriodStarting string String
postTaxDeductionAmount double Decimal
postTaxDeductionsYTD double Decimal
preTaxDeductionAmount double Decimal
preTaxDeductionsYTD double Decimal
startDate date-time Nullable
taxableEarnings double Decimal
terminationDate date-time Nullable
totalAccruedLeave[] array
totalAccruedLeave[].amount double Decimal
totalAccruedLeave[].leaveCategory string String
totalAccruedLeave[].notes string String
totalHours double Decimal
withholdingYTD double Decimal