Fps

Name / Description Type / Format Example
lateReason string "NoneGiven" "NotionalExpat" "NotionalErs" "NotionalOther" "Class1" "MicroEmployer" "NoRequirement" "ReasonableExcuse" "Correction"
paymentDate string date-time "2019-11-12T04:22:36"
employeeCount integer int32 0
fullPaymentSubmission FullPaymentSubmission {FullPaymentSubmission}
iRmark string "string"
xml string "string"
taxYear string "Year2017" "Year2018" "Year2019" "Year2020"
employerReferences EmpRefs {EmpRefs}
govTalkSubmission GovTalkSubmission {GovTalkSubmission}
id
The unique id of the object
string uuid "string"
{
  "lateReason": "NoneGiven",
  "paymentDate": "2019-11-12T04:22:36",
  "employeeCount": 0,
  "fullPaymentSubmission": {
    "employee": [
      {
        "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"
      }
    ],
    "relatedTaxYear": "string"
  },
  "iRmark": "string",
  "xml": "string",
  "taxYear": "Year2017",
  "employerReferences": {
    "officeNo": "string",
    "payeRef": "string",
    "aoRef": "string",
    "econ": "string",
    "cotaxRef": "string",
    "sautr": "string"
  },
  "govTalkSubmission": {
    "rawResponse": "string",
    "messageClass": "string",
    "pollInterval": 0,
    "lastPoll": "2019-11-12T04:22:36",
    "correlationId": "string",
    "url": "string",
    "status": "NotSubmitted",
    "message": "string",
    "iRmark": "string",
    "errorsJson": "string",
    "errors": [
      {
        "raisedBy": "string",
        "number": "string",
        "type": "string",
        "text": "string",
        "location": "string"
      }
    ],
    "submittedAt": "2019-11-12T04:22:36",
    "id": "string"
  },
  "id": "string"
}
Contained in Models

- none -

Consumed by Operations
Create FPS
Update FPS
Completing a Payrun Review and Submit the FPS