Methods

  • get - List Pay Slip Data

Resource

{
    "<key>": {
        "accruedLeave": [
            {
                "amount": "double",
                "leaveCategory": "string",
                "notes": "string"
            }
        ],
        "bankPayments": [
            {
                "accountName": "string",
                "accountNumber": "string",
                "amount": "double",
                "lodgementReference": "string",
                "sortCode": "string"
            }
        ],
        "basePayRate": "string",
        "baseRate": "string",
        "businessAddress": "string",
        "businessName": "string",
        "contactName": "string",
        "crn": "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",
                "superContribution": "double",
                "taxableEarnings": "double",
                "units": "double"
            }
        ],
        "employeeBaseRate": "double",
        "employeeBaseRateUnit": "string",
        "employeeExpenses": [
            {
                "amount": "double",
                "employeeExpenseCategoryName": "string",
                "locationName": "string",
                "notes": "string"
            }
        ],
        "employeeExternalId": "string",
        "employeeFirstName": "string",
        "employeeId": "int32",
        "employeeName": "string",
        "employeeNationalInsuranceYTD": "double",
        "employeePensionYTD": "double",
        "employeePostalAddressCity": "string",
        "employeePostalAddressCountry": "string",
        "employeePostalAddressCounty": "string",
        "employeePostalAddressLine2": "string",
        "employeePostalAddressPostcode": "string",
        "employeePostalStreetAddress": "string",
        "employeeSurname": "string",
        "employerNationalInsuranceYTD": "double",
        "employerPensionYTD": "double",
        "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",
        "payPeriodEnding": "string",
        "payPeriodStarting": "string",
        "payeAdjustments": [
            {
                "amount": "double",
                "notes": "string"
            }
        ],
        "payeWithholdingAmount": "double",
        "payeYTD": "double",
        "postTaxDeductionAmount": "double",
        "postTaxDeductionsYTD": "double",
        "preTaxDeductionAmount": "double",
        "preTaxDeductionsYTD": "double",
        "taxableEarnings": "double",
        "totalAccruedLeave": [
            {
                "amount": "double",
                "leaveCategory": "string",
                "notes": "string"
            }
        ],
        "totalHours": "double",
        "withholdingYTD": "double"
    }
}

Properties

Name Type Description
<key> map of object UkApiPaySlipModel
<key>.accruedLeave[] array
<key>.accruedLeave[].amount double Decimal
<key>.accruedLeave[].leaveCategory string String
<key>.accruedLeave[].notes string String
<key>.bankPayments[] array
<key>.bankPayments[].accountName string String
<key>.bankPayments[].accountNumber string String
<key>.bankPayments[].amount double Decimal
<key>.bankPayments[].lodgementReference string String
<key>.bankPayments[].sortCode string String
<key>.basePayRate string String
<key>.baseRate string String
<key>.businessAddress string String
<key>.businessName string String
<key>.contactName string String
<key>.crn string String
<key>.deductions[] array
<key>.deductions[].amount double Decimal
<key>.deductions[].name string String
<key>.deductions[].notes string String
<key>.deductions[].taxStatus string String
<key>.earningsLines[] array
<key>.earningsLines[].grossEarnings double Decimal
<key>.earningsLines[].isFixed boolean Boolean
<key>.earningsLines[].isTaxExempt boolean Boolean
<key>.earningsLines[].locationName string String
<key>.earningsLines[].notes string String
<key>.earningsLines[].payCategoryName string String
<key>.earningsLines[].rate double Decimal
<key>.earningsLines[].superContribution double Decimal
<key>.earningsLines[].taxableEarnings double Decimal
<key>.earningsLines[].units double Decimal
<key>.employeeBaseRate double Decimal
<key>.employeeBaseRateUnit string RateUnitEnum

Possible values are:

  • Hourly
  • Annually
  • Fixed
  • Daily
  • Monthly
<key>.employeeExpenses[] array
<key>.employeeExpenses[].amount double Decimal
<key>.employeeExpenses[].employeeExpenseCategoryName string String
<key>.employeeExpenses[].locationName string String
<key>.employeeExpenses[].notes string String
<key>.employeeExternalId string String
<key>.employeeFirstName string String
<key>.employeeId int32 Int32
<key>.employeeName string String
<key>.employeeNationalInsuranceYTD double Decimal
<key>.employeePensionYTD double Decimal
<key>.employeePostalAddressCity string String
<key>.employeePostalAddressCountry string String
<key>.employeePostalAddressCounty string String
<key>.employeePostalAddressLine2 string String
<key>.employeePostalAddressPostcode string String
<key>.employeePostalStreetAddress string String
<key>.employeeSurname string String
<key>.employerNationalInsuranceYTD double Decimal
<key>.employerPensionYTD double Decimal
<key>.grossEarnings double Decimal
<key>.grossYTD double Decimal
<key>.grossYTDDetails[] array
<key>.grossYTDDetails[].grossEarnings double Decimal
<key>.grossYTDDetails[].payCategoryName string String
<key>.hourlyRate double Decimal
<key>.id int32 Int32
<key>.isPublished boolean Boolean
<key>.leaveTaken[] array
<key>.leaveTaken[].amount double Decimal
<key>.leaveTaken[].leaveCategory string String
<key>.leaveTaken[].notes string String
<key>.message string String
<key>.netEarnings double Decimal
<key>.netYTD double Decimal
<key>.notation string String
<key>.payPeriodEnding string String
<key>.payPeriodStarting string String
<key>.payeAdjustments[] array
<key>.payeAdjustments[].amount double Decimal
<key>.payeAdjustments[].notes string String
<key>.payeWithholdingAmount double Decimal
<key>.payeYTD double Decimal
<key>.postTaxDeductionAmount double Decimal
<key>.postTaxDeductionsYTD double Decimal
<key>.preTaxDeductionAmount double Decimal
<key>.preTaxDeductionsYTD double Decimal
<key>.taxableEarnings double Decimal
<key>.totalAccruedLeave[] array
<key>.totalAccruedLeave[].amount double Decimal
<key>.totalAccruedLeave[].leaveCategory string String
<key>.totalAccruedLeave[].notes string String
<key>.totalHours double Decimal
<key>.withholdingYTD double Decimal