ReportResponse[Payslip]

Used to encapsulate a response for any of the reports.
See the Introduction Guide for Reports for more details

Name / Description Type / Format Example
type
The content-type, this would usually be the same as the accept header you provided when you requested the report
string "string"
content
This could contain a link to a PDF file, HTML content or other content, depending on the Type value.
string "string"
model
If the type is application.json then this will contain a JSON representation of the relevant model
Payslip {Payslip}
{
  "type": "string",
  "content": "string",
  "model": {
    "isClosed": true,
    "period": "string",
    "from": "2019-11-13T21:54:22",
    "to": "2019-11-13T21:54:22",
    "paymentDate": "2019-11-13T21:54:22",
    "note": "string",
    "allowanceNote": "string",
    "employee": {
      "id": "string",
      "name": "string",
      "metadata": {},
      "url": "string"
    },
    "logoUrl": "string",
    "employer": {
      "id": "string",
      "name": "string",
      "metadata": {},
      "url": "string"
    },
    "hmrcDetails": {
      "officeNumber": "string",
      "payeReference": "string",
      "accountsOfficeReference": "string",
      "econ": "string",
      "utr": "string",
      "coTax": "string",
      "employmentAllowance": true,
      "employmentAllowanceMaxClaim": 0.0,
      "smallEmployersRelief": true,
      "apprenticeshipLevy": true,
      "apprenticeshipLevyAllowance": 0.0,
      "quarterlyPaymentSchedule": true,
      "carryForwardUnpaidLiabilities": true,
      "id": "string"
    },
    "payOptions": {
      "period": "Monthly",
      "payAmount": 0.0,
      "basis": "Hourly",
      "nationalMinimumWage": true,
      "payAmountMultiplier": 0.0,
      "autoAdjustForLeave": true,
      "method": "Cash",
      "payCode": "string",
      "withholdTaxRefundIfPayIsZero": true,
      "mileageVehicleType": "Car",
      "mapsMiles": 0,
      "taxAndNi": {
        "niTable": "string",
        "secondaryClass1NotPayable": true,
        "postgradLoan": true,
        "studentLoan": "None",
        "taxCode": "string",
        "week1Month1": true
      },
      "fpsFields": {
        "irregularPaymentPattern": true,
        "nonIndividual": true,
        "hoursNormallyWorked": "LessThan16",
        "flexibleDrawdown": {
          "hasFlexibleDrawdown": true,
          "death": true,
          "pension": true,
          "taxablePayment": 0.0,
          "nonTaxablePayment": 0.0
        },
        "trivialCommutationPayment": {
          "hasTrivialCommutationPayment": true,
          "tcls": 0.0,
          "personalPension": 0.0,
          "occupationalPension": 0.0
        }
      },
      "regularPayLines": [
        {
          "value": 0.0,
          "rate": 0.0,
          "multiplier": 0.0,
          "description": "string",
          "code": "string"
        }
      ]
    },
    "employmentDetails": {
      "cisSubContractor": true,
      "payrollCode": "string",
      "isApprentice": true,
      "workingPattern": "string",
      "forcePreviousPayrollCode": "string",
      "starterDetails": {
        "startDate": "2019-11-13T21:54:22",
        "starterDeclaration": "A",
        "overseasEmployerDetails": {
          "overseasEmployer": true,
          "overseasSecondmentStatus": "MoreThan183Days",
          "eeaCitizen": true,
          "epm6Scheme": true
        }
      },
      "directorshipDetails": {
        "isDirector": true,
        "startDate": "2019-11-13T21:54:22",
        "leaveDate": "2019-11-13T21:54:22",
        "niAlternativeMethod": true
      },
      "leaverDetails": {
        "hasLeft": true,
        "leaveDate": "2019-11-13T21:54:22",
        "isDeceased": true
      },
      "cis": {
        "type": "SoleTrader",
        "utr": "string",
        "tradingName": "string",
        "companyUtr": "string",
        "companyNumber": "string",
        "vatRegistered": true,
        "vatNumber": "string",
        "vatRate": 0.0,
        "verification": {
          "manuallyEntered": true,
          "matchInsteadOfVerify": true,
          "number": "string",
          "date": "2019-11-13T21:54:22",
          "taxStatus": "Gross",
          "verificationRequest": "string",
          "verificationResponse": {
            "employeeUniqueId": "string",
            "emailStatementTo": "string",
            "numberOfPayments": 0,
            "item": {
              "id": "string",
              "name": "string",
              "metadata": {},
              "url": "string"
            },
            "displayName": "string",
            "action": "string",
            "type": "string",
            "name": {
              "ttl": "string",
              "fore": [
                "string"
              ],
              "initials": "string",
              "sur": "string"
            },
            "tradingName": "string",
            "worksRef": "string",
            "unmatchedRate": "string",
            "utr": "string",
            "crn": "string",
            "nino": "string",
            "partnership": {
              "name": "string",
              "utr": "string"
            },
            "address": {
              "line": [
                "string"
              ],
              "postcode": "string",
              "postCode": "string",
              "ukPostcode": "string",
              "country": "string"
            },
            "telephone": "string",
            "totalPaymentsUnrounded": "string",
            "costOfMaterialsUnrounded": "string",
            "umbrellaFee": "string",
            "validationMsg": "string",
            "verificationNumber": "string",
            "totalPayments": "string",
            "costOfMaterials": "string",
            "totalDeducted": "string",
            "matched": "string",
            "taxTreatment": "string"
          }
        }
      }
    },
    "personalDetails": {
      "address": {
        "line1": "string",
        "line2": "string",
        "line3": "string",
        "line4": "string",
        "line5": "string",
        "postCode": "string",
        "country": "England"
      },
      "maritalStatus": "Single",
      "title": "string",
      "firstName": "string",
      "middleName": "string",
      "lastName": "string",
      "email": "string",
      "emailPayslip": true,
      "passwordProtectPayslip": true,
      "emailStatement": true,
      "photoUrl": "string",
      "telephone": "string",
      "mobile": "string",
      "dateOfBirth": "2019-11-13T21:54:22",
      "statePensionAge": 0,
      "gender": "Male",
      "niNumber": "string",
      "passportNumber": "string",
      "partnerDetails": {
        "firstName": "string",
        "initials": "string",
        "lastName": "string",
        "niNumber": "string"
      }
    },
    "totals": {
      "basicPay": 0.0,
      "gross": 0.0,
      "grossForNi": 0.0,
      "grossForTax": 0.0,
      "employerNi": 0.0,
      "employeeNi": 0.0,
      "tax": 0.0,
      "netPay": 0.0,
      "adjustments": 0.0,
      "takeHomePay": 0.0,
      "nonTaxOrNICPmt": 0.0,
      "itemsSubjectToClass1NIC": 0.0,
      "dednsFromNetPay": 0.0,
      "smp": 0.0,
      "spp": 0.0,
      "sap": 0.0,
      "shpp": 0.0,
      "spbp": 0.0,
      "studentLoanRecovered": 0.0,
      "postgradLoanRecovered": 0.0,
      "pensionablePay": 0.0,
      "employeePensionContribution": 0.0,
      "employeePensionContributionAvc": 0.0,
      "employerPensionContribution": 0.0,
      "empeePenContribnsNotPaid": 0.0,
      "empeePenContribnsPaid": 0.0,
      "attachmentOrderDeductions": 0.0,
      "cisDeduction": 0.0,
      "cisVat": 0.0,
      "cisUmbrellaFee": 0.0,
      "pbik": 0.0,
      "mapsMiles": 0,
      "totalCost": 0.0
    },
    "totalsYtd": {
      "basicPay": 0.0,
      "gross": 0.0,
      "grossForNi": 0.0,
      "grossForTax": 0.0,
      "employerNi": 0.0,
      "employeeNi": 0.0,
      "tax": 0.0,
      "netPay": 0.0,
      "adjustments": 0.0,
      "takeHomePay": 0.0,
      "nonTaxOrNICPmt": 0.0,
      "itemsSubjectToClass1NIC": 0.0,
      "dednsFromNetPay": 0.0,
      "smp": 0.0,
      "spp": 0.0,
      "sap": 0.0,
      "shpp": 0.0,
      "spbp": 0.0,
      "studentLoanRecovered": 0.0,
      "postgradLoanRecovered": 0.0,
      "pensionablePay": 0.0,
      "employeePensionContribution": 0.0,
      "employeePensionContributionAvc": 0.0,
      "employerPensionContribution": 0.0,
      "empeePenContribnsNotPaid": 0.0,
      "empeePenContribnsPaid": 0.0,
      "attachmentOrderDeductions": 0.0,
      "cisDeduction": 0.0,
      "cisVat": 0.0,
      "cisUmbrellaFee": 0.0,
      "pbik": 0.0,
      "mapsMiles": 0,
      "totalCost": 0.0
    },
    "lines": [
      {
        "type": "BasicPay",
        "code": "string",
        "description": "string",
        "secondaryDescription": "string",
        "value": 0.0,
        "currencySymbol": "string",
        "formattedValue": "string",
        "hasSecondaryDescription": true
      }
    ],
    "employerNi": 0.0,
    "employerPensionContribs": 0.0
  }
}
Contained in Models

- none -

Consumed by Operations

- none -

Returned by Operations
Payslip