PayslipReportResponse

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 you don't want to use our customisable PDFs for Payslips then you can retrieve the raw data used to create a Payslip.
This is the model you will be provided with for each employee.
Payslip {Payslip}
stream
byte array
string byte "string"
{
  "type": "string",
  "content": "string",
  "model": {
    "isClosed": true,
    "period": "string",
    "from": "2024-06-25",
    "to": "2024-06-25",
    "paymentDate": "2024-06-25",
    "note": "string",
    "allowanceNote": "string",
    "employee": {
      "id": "string",
      "name": "string",
      "metadata": {},
      "url": "string"
    },
    "logoUrl": "string",
    "employer": {
      "id": "string",
      "name": "string",
      "metadata": {},
      "url": "string"
    },
    "employerAddress": {
      "line1": "string",
      "line2": "string",
      "line3": "string",
      "line4": "string",
      "line5": "string",
      "postCode": "string",
      "country": "England",
      "foreignCountry": "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,
      "includeEmploymentAllowanceOnMonthlyJournal": true,
      "carryForwardUnpaidLiabilities": true,
      "paymentDateRule": "OnPayDate",
      "paymentDateDayOfMonth": 0,
      "id": "string"
    },
    "payOptions": {
      "period": "Custom",
      "ordinal": 0,
      "method": "Cash",
      "withholdTaxRefundIfPayIsZero": true,
      "taxAndNi": {
        "niTable": "string",
        "secondaryClass1NotPayable": true,
        "postgradLoan": true,
        "postgraduateLoanStartDate": "2024-06-25",
        "postgraduateLoanEndDate": "2024-06-25",
        "studentLoan": "None",
        "studentLoanStartDate": "2024-06-25",
        "studentLoanEndDate": "2024-06-25",
        "taxCode": "string",
        "week1Month1": true,
        "foreignTaxCredit": true
      },
      "fpsFields": {
        "offPayrollWorker": true,
        "irregularPaymentPattern": true,
        "nonIndividual": true,
        "hoursNormallyWorked": "LessThan16"
      },
      "tags": [
        "string"
      ],
      "basis": "Hourly",
      "nationalMinimumWage": true,
      "payCode": "string",
      "mileageVehicleType": "Car",
      "mapsMiles": 0,
      "payAmount": 0.0,
      "payAmountMultiplier": 0.0,
      "baseHourlyRate": 0.0,
      "baseDailyRate": 0.0,
      "basicPay": 0.0,
      "autoAdjustForLeave": true,
      "niTable": "string",
      "regularPayLines": [
        {
          "value": 0.0,
          "rate": 0.0,
          "multiplier": 0.0,
          "description": "string",
          "attachmentOrderId": "string",
          "pensionId": "string",
          "leaveId": "string",
          "loanId": "string",
          "leaveStatutoryDaysPaid": 0.0,
          "leaveStatutoryWeeksPaid": 0.0,
          "code": "string",
          "tags": [
            "string"
          ],
          "childId": "string",
          "isNetToGross": true,
          "targetNetToGrossValue": 0.0,
          "netToGrossDiscrepancy": 0.0,
          "effectiveFrom": "2024-06-25",
          "effectiveTo": "2024-06-25",
          "department": "string",
          "costCentre": "string",
          "departmentId": "string",
          "costCentreId": "string",
          "isAutoGeneratedBasicPayLine": true,
          "percentageOfEffectiveDays": 0.0,
          "totalWorkingDays": 0.0,
          "isAutomaticBackPay": true,
          "ignoreInitialBackPay": true,
          "initialBackPayPublicPayRunId": "string",
          "autoAdjustForLeave": true,
          "contributesToBasicPay": true,
          "calculateAsWhenPaid": true,
          "totalPaidDays": 0.0,
          "roleId": "string",
          "employeeRoleReference": "string",
          "earnedFrom": "2024-06-25",
          "earnedTo": "2024-06-25",
          "periodFrom": "2024-06-25",
          "periodTo": "2024-06-25",
          "annualValue": 0.0,
          "parentId": "string",
          "isAutoCalculatedBackPayLine": true,
          "isZeroHoursTeachersBackPayLine": true,
          "analysisCategoriesCodes": "error too many levels",
          "analysisCategoryCodeIds": [
            "string"
          ],
          "paySpineId": "string",
          "paySpineGradeId": "string",
          "spinalPointId": "string",
          "londonAllowanceId": 0,
          "fullTimeAnnualValue": 0.0,
          "paySpine": "string",
          "payGrade": "string",
          "spinePoint": "string"
        }
      ]
    },
    "employmentDetails": {
      "cisSubContractor": true,
      "payrollCode": "string",
      "jobTitle": "string",
      "onHold": true,
      "onFurlough": true,
      "furloughStart": "2024-06-25",
      "furloughEnd": "2024-06-25",
      "furloughCalculationBasis": "ActualPaidAmount",
      "furloughCalculationBasisAmount": 0.0,
      "partialFurlough": true,
      "furloughHoursNormallyWorked": 0.0,
      "furloughHoursOnFurlough": 0.0,
      "isApprentice": true,
      "apprenticeshipStartDate": "2024-06-25",
      "apprenticeshipEndDate": "2024-06-25",
      "workingPattern": "string",
      "forcePreviousPayrollCode": "string",
      "starterDetails": {
        "startDate": "2024-06-25",
        "starterDeclaration": "A",
        "overseasEmployerDetails": "error too many levels",
        "pensionerPayroll": "error too many levels"
      },
      "directorshipDetails": {
        "isDirector": true,
        "startDate": "2024-06-25",
        "leaveDate": "2024-06-25",
        "niAlternativeMethod": true
      },
      "leaverDetails": {
        "hasLeft": true,
        "leaveDate": "2024-06-25",
        "isDeceased": true,
        "paymentAfterLeaving": true,
        "p45Sent": true,
        "payAccruedBalance": true
      },
      "cis": {
        "type": "SoleTrader",
        "utr": "string",
        "tradingName": "string",
        "companyUtr": "string",
        "companyNumber": "string",
        "vatRegistered": true,
        "vatNumber": "string",
        "vatRate": 0.0,
        "reverseChargeVAT": true,
        "verification": "error too many levels"
      },
      "department": {
        "code": "string",
        "title": "string",
        "color": "string",
        "employeeCount": 0,
        "accountingCode": "string",
        "hasJournalOverrides": true
      },
      "roles": [
        {
          "id": "string",
          "name": "string",
          "metadata": {},
          "url": "string"
        }
      ],
      "isWorkingInFreePort": true,
      "veteranDetails": {
        "isVeteran": true,
        "firstCivilianEmploymentDate": "2024-06-25"
      },
      "continuousEmploymentDate": "2024-06-25",
      "includeSecondedInfoOnStarter": true,
      "isWorkingInInvestmentZone": true
    },
    "personalDetails": {
      "address": {
        "line1": "string",
        "line2": "string",
        "line3": "string",
        "line4": "string",
        "line5": "string",
        "postCode": "string",
        "country": "England",
        "foreignCountry": "string"
      },
      "maritalStatus": "Single",
      "title": "string",
      "firstName": "string",
      "middleName": "string",
      "lastName": "string",
      "alternativeEmail": "string",
      "previousSurName": "string",
      "email": "string",
      "emailPayslip": true,
      "pdfPassword": "string",
      "pdfPasswordType": "InitialsAndDob",
      "emailStatement": true,
      "photoUrl": "string",
      "photoSasUrl": "string",
      "telephone": "string",
      "mobile": "string",
      "dateOfBirth": "2024-06-25",
      "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,
      "grossNotSubjectToEmployersNi": 0.0,
      "grossForTax": 0.0,
      "employerNi": 0.0,
      "employeeNi": 0.0,
      "employerNiOffPayroll": 0.0,
      "realTimeClass1ANi": 0.0,
      "tax": 0.0,
      "netPay": 0.0,
      "adjustments": 0.0,
      "additions": 0.0,
      "deductions": 0.0,
      "takeHomePay": 0.0,
      "nonTaxOrNICPmt": 0.0,
      "itemsSubjectToClass1NIC": 0.0,
      "dednsFromNetPay": 0.0,
      "tcp_Tcls": 0.0,
      "tcp_Pp": 0.0,
      "tcp_Op": 0.0,
      "flexiDd_Death": 0.0,
      "flexiDd_Death_NonTax": 0.0,
      "flexiDd_Pension": 0.0,
      "flexiDd_Pension_NonTax": 0.0,
      "flexiDd_SeriousIllHealth": 0.0,
      "flexiDd_SeriousIllHealth_NonTax": 0.0,
      "smp": 0.0,
      "spp": 0.0,
      "sap": 0.0,
      "shpp": 0.0,
      "spbp": 0.0,
      "ssp": 0.0,
      "studentLoanRecovered": 0.0,
      "postgradLoanRecovered": 0.0,
      "pensionableEarnings": 0.0,
      "pensionablePay": 0.0,
      "nonTierablePay": 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,
      "cisUmbrellaFeePostTax": 0.0,
      "pbik": 0.0,
      "mapsMiles": 0,
      "foreignTaxAmount": 0.0,
      "foreignTaxAmountReclaimed": 0.0,
      "umbrellaFee": 0.0,
      "appLevyDeduction": 0.0,
      "paymentAfterLeaving": 0.0,
      "taxOnPaymentAfterLeaving": 0.0,
      "nilPaid": 0,
      "leavers": 0,
      "starters": 0,
      "p45Gross": 0.0,
      "p45Tax": 0.0,
      "totalCost": 0.0,
      "recoverableAmounts": {
        "taxMonth": 0,
        "smpRecovered": 0.0,
        "sppRecovered": 0.0,
        "sapRecovered": 0.0,
        "shPPRecovered": 0.0,
        "spbpRecovered": 0.0,
        "nicCompensationOnSMP": 0.0,
        "nicCompensationOnSPP": 0.0,
        "nicCompensationOnSAP": 0.0,
        "nicCompensationOnShPP": 0.0,
        "nicCompensationOnSPBP": 0.0,
        "cisDeductionsSuffered": 0.0,
        "total": 0.0
      }
    },
    "totalsYtd": {
      "basicPay": 0.0,
      "gross": 0.0,
      "grossForNi": 0.0,
      "grossNotSubjectToEmployersNi": 0.0,
      "grossForTax": 0.0,
      "employerNi": 0.0,
      "employeeNi": 0.0,
      "employerNiOffPayroll": 0.0,
      "realTimeClass1ANi": 0.0,
      "tax": 0.0,
      "netPay": 0.0,
      "adjustments": 0.0,
      "additions": 0.0,
      "deductions": 0.0,
      "takeHomePay": 0.0,
      "nonTaxOrNICPmt": 0.0,
      "itemsSubjectToClass1NIC": 0.0,
      "dednsFromNetPay": 0.0,
      "tcp_Tcls": 0.0,
      "tcp_Pp": 0.0,
      "tcp_Op": 0.0,
      "flexiDd_Death": 0.0,
      "flexiDd_Death_NonTax": 0.0,
      "flexiDd_Pension": 0.0,
      "flexiDd_Pension_NonTax": 0.0,
      "flexiDd_SeriousIllHealth": 0.0,
      "flexiDd_SeriousIllHealth_NonTax": 0.0,
      "smp": 0.0,
      "spp": 0.0,
      "sap": 0.0,
      "shpp": 0.0,
      "spbp": 0.0,
      "ssp": 0.0,
      "studentLoanRecovered": 0.0,
      "postgradLoanRecovered": 0.0,
      "pensionableEarnings": 0.0,
      "pensionablePay": 0.0,
      "nonTierablePay": 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,
      "cisUmbrellaFeePostTax": 0.0,
      "pbik": 0.0,
      "mapsMiles": 0,
      "foreignTaxAmount": 0.0,
      "foreignTaxAmountReclaimed": 0.0,
      "umbrellaFee": 0.0,
      "appLevyDeduction": 0.0,
      "paymentAfterLeaving": 0.0,
      "taxOnPaymentAfterLeaving": 0.0,
      "nilPaid": 0,
      "leavers": 0,
      "starters": 0,
      "p45Gross": 0.0,
      "p45Tax": 0.0,
      "totalCost": 0.0,
      "recoverableAmounts": {
        "taxMonth": 0,
        "smpRecovered": 0.0,
        "sppRecovered": 0.0,
        "sapRecovered": 0.0,
        "shPPRecovered": 0.0,
        "spbpRecovered": 0.0,
        "nicCompensationOnSMP": 0.0,
        "nicCompensationOnSPP": 0.0,
        "nicCompensationOnSAP": 0.0,
        "nicCompensationOnShPP": 0.0,
        "nicCompensationOnSPBP": 0.0,
        "cisDeductionsSuffered": 0.0,
        "total": 0.0
      }
    },
    "lines": [
      {
        "type": "BasicPay",
        "code": "string",
        "description": "string",
        "secondaryDescription": "string",
        "value": 0.0,
        "multiplier": 0.0,
        "attachmentOrderId": "string",
        "pensionId": "string",
        "loanId": "string",
        "currencySymbol": "string",
        "formattedValue": "string",
        "isNetToGross": true,
        "targetNetToGrossValue": 0.0,
        "leaveId": "string",
        "roleId": "string",
        "isAutoCalculatedBackPayLine": true,
        "isAutomaticBackPay": true,
        "hasSecondaryDescription": true,
        "contributesToBasicPay": true
      }
    ],
    "employerNi": 0.0,
    "employerPensionContribs": 0.0
  },
  "stream": "string"
}
Contained in Models

- none -

Consumed by Operations

- none -

Returned by Operations
Payslip