FpsEmployee

Name / Description Type / Format Example
employeeUniqueId string uuid "string"
item Item {Item}
employeeDetails FpsEmployeeDetails {FpsEmployeeDetails}
employment FpsEmployment {FpsEmployment}
validationMsg string "string"
{
  "employeeUniqueId": "string",
  "item": {
    "id": "string",
    "name": "string",
    "metadata": {},
    "url": "string"
  },
  "employeeDetails": {
    "nino": "string",
    "name": {
      "ttl": "string",
      "fore": [
        "string"
      ],
      "initials": "string",
      "sur": "string"
    },
    "address": {
      "line": [
        "string"
      ],
      "postcode": "string",
      "postCode": "string",
      "ukPostcode": "string",
      "country": "string"
    },
    "birthDate": "string",
    "gender": "string",
    "passportNumber": "string",
    "partnerDetails": {
      "nino": "string",
      "name": {
        "ttl": "string",
        "fore": [
          "string"
        ],
        "initials": "string",
        "sur": "string"
      }
    }
  },
  "employment": {
    "employeeCurrentNiLetter": "string",
    "occPenInd": "string",
    "directorsNIC": "string",
    "taxWkOfApptOfDirector": "string",
    "starter": {
      "startDate": "string",
      "startDec": "string",
      "studentLoan": "string",
      "postgradLoan": "string"
    },
    "payId": "string",
    "payIdChgd": {
      "payrollIdChangedIndicator": "string",
      "oldPayrollId": "string"
    },
    "paymentToANonIndividual": "string",
    "irrEmp": "string",
    "leavingDate": "string",
    "figuresToDate": {
      "taxablePay": "string",
      "totalTax": "string",
      "studentLoansTD": "string",
      "postgradLoansTD": "string",
      "benefitsTaxedViaPayrollYTD": "string",
      "empeePenContribnsPaidYTD": "string",
      "empeePenContribnsNotPaidYTD": "string",
      "smpytd": "string",
      "sppytd": "string",
      "sapytd": "string",
      "shppytd": "string",
      "spbpytd": "string",
      "gross": "string",
      "netPay": "string",
      "takeHomePay": "string",
      "adjustments": "string",
      "mapsMiles": "string"
    },
    "payment": {
      "bacsHashCode": "string",
      "payFreq": "string",
      "pmtDate": "string",
      "lateReason": "string",
      "weekNo": "string",
      "monthNo": "string",
      "periodsCovered": 0,
      "aggregatedEarnings": "string",
      "pmtAfterLeaving": "string",
      "hoursWorked": "string",
      "taxCode": {
        "basisNonCumulative": "string",
        "taxRegime": "string",
        "taxCode": "string"
      },
      "taxablePay": "string",
      "nonTaxOrNICPmt": "string",
      "dednsFromNetPay": "string",
      "payAfterStatDedns": "string",
      "benefitsTaxedViaPayroll": "string",
      "benefits": {
        "car": [
          {
            "make": "string",
            "firstRegd": "string",
            "cO2": "string",
            "zeroEmissionsMileage": "string",
            "fuel": "string",
            "id": "string",
            "amendment": "string",
            "price": "string",
            "availFrom": "string",
            "cashEquiv": "string",
            "availTo": "string",
            "freeFuel": {
              "provided": "string",
              "cashEquiv": "string",
              "withdrawn": "string"
            }
          }
        ]
      },
      "empeePenContribnsPaid": "string",
      "itemsSubjectToClass1NIC": "string",
      "empeePenContribnsNotPaid": "string",
      "studentLoanRecovered": {
        "planType": "string",
        "value": "string"
      },
      "postgradLoanRecovered": "string",
      "taxDeductedOrRefunded": "string",
      "onStrike": "string",
      "unpaidAbsence": "string",
      "smpytd": "string",
      "sppytd": "string",
      "sapytd": "string",
      "shPPYTD": "string",
      "spbpytd": "string",
      "trivialCommutationPayment": [
        {
          "type": "string",
          "value": "string"
        }
      ],
      "flexibleDrawdown": {
        "flexiblyAccessingPensionRights": "string",
        "pensionDeathBenefit": "string",
        "taxablePayment": "string",
        "nontaxablePayment": "string"
      }
    },
    "nIlettersAndValues": [
      {
        "nIletter": "string",
        "grossEarningsForNICsInPd": "string",
        "grossEarningsForNICsYTD": "string",
        "atLELYTD": "string",
        "leLtoPTYTD": "string",
        "pTtoUELYTD": "string",
        "totalEmpNICInPd": "string",
        "totalEmpNICYTD": "string",
        "empeeContribnsInPd": "string",
        "empeeContribnsYTD": "string"
      }
    ]
  },
  "validationMsg": "string"
}
Contained in Models
FullPaymentSubmission
Consumed by Operations

- none -

Returned by Operations

- none -