HmrcLiability

Name / Description Type / Format Example
title
A descriptive name for the Period
string "string"
taxYear string "Year2017" "Year2018" "Year2019" "Year2020"
periodEnding string date-time "2019-11-14T12:22:48"
periodComplete
Indicates whether or not all PayRuns for this period have been completed
boolean true
recoverableAmountsEpsCreated
If there are recoverable amount present (ie, SMP) and the Period is complete then this field Indicates whether or not an EPS has been created up to the final tax month of this period to declare the recoverable amounts
boolean true
apprenticeshipLevyEpsCreated
If there is an Apprenticeship LEvy amount present and the Period is complete then this field Indicates whether or not an EPS has been created up to the final tax month of this period to declare the amount
boolean true
payRuns PayRun[] {PayRun}
tax
Amount due to HMRC for PAYE in period
number double 0.0
cisDeductions
Amount due to HMRC for CIS Deductions made in period
number double 0.0
postgradLoanDeductions
Amount due to HMRC for Postgrad Loan Deductions made in period
number double 0.0
studentLoanDeductions
Amount due to HMRC for Student Loan Deductions made in period
number double 0.0
employeeNic
Amount due to HMRC for Employee NIC Contributions withheld in period
number double 0.0
employerNic
Amount due to HMRC for Employer NIC Contributions due on payments in period
number double 0.0
smp
SMP recovered from payments in period
number double 0.0
smpNic
SMP NIC Compensation for period
number double 0.0
spp
SPP recovered from payments in period
number double 0.0
sppNic
SPP Nic Compensation for period
number double 0.0
sap
SAP recovered from payments in period
number double 0.0
sapNic
SAP Nic Compensation for period
number double 0.0
shpp
ShPP recovered from payments in period
number double 0.0
shppNic
ShPP Nic Compensation for period
number double 0.0
spbp
SPBP recovered from payments in period
number double 0.0
spbpNic
SPBP Nic Compensation for period
number double 0.0
eligibleForEmploymentAllowance
Indicates whether the Employer settings say the Employer is eligible for Employment Allowance
boolean true
employmentAllowanceClaim
Amount to claim with respect to the Employment Allowance
number double 0.0
employmentAllowanceClaimAuto
If set to true, we'll automatically claim the maximum allowed.
If set to false then you can enter your own value.
If EligibleForEmploymentAllowance is false then the EmploymentAllowanceClaim will always be overwritten with a zero value regardless of this property
boolean true
liableForApprenticeshipLevy
Indicates whether the Employer settings say the Employer is liable for the Apprenticeship Levy
boolean true
apprenticeshipLevy
Amount due with respect to the Apprenticeship Levy
number double 0.0
apprenticeshipLevyAuto
If set to true, we'll automatically calculate your liability
If set to false then you can enter your own value.
If LiableForApprenticeshipLevy is false then the ApprenticeshipLevy will always be overwritten with a zero value regardless of this property
boolean true
liabilityArisingInPeriod
Total Liability (before any deductions) arising in this Period
number double 0.0
dueInPreviousPeriods
Amount due to HMRC in previous periods for this Tax Year
number double 0.0
paidInPreviousPeriods
Amount paid to HMRC in previous periods for this Tax Year
number double 0.0
employmentAllowanceClaimInPreviousPeriods
The amount of Employment Allowance claimed in previous periods for this Tax Year
number double 0.0
receivedFromHMRCToRefundTax
Any amount received from HMRC to refund Tax in Period
number double 0.0
receivedFromHMRCToPayStatutoryPay
Any amount received from HMRC to pay Statutory Pay Period
number double 0.0
cisDeductionsSuffered
CIS Deductions Suffered in Period
number double 0.0
adjustment
Any manual adjustment for Period
number double 0.0
netLiabilityForPeriod
Net Liability (including any deductions/additions) arising in this Period
number double 0.0
totalPaid
The total value of all payments in this period
number double 0.0
payments HmrcPayment[] {HmrcPayment}
id
The unique id of the object
string uuid "string"
{
  "title": "string",
  "taxYear": "Year2017",
  "periodEnding": "2019-11-14T12:22:48",
  "periodComplete": true,
  "recoverableAmountsEpsCreated": true,
  "apprenticeshipLevyEpsCreated": true,
  "payRuns": [
    {
      "taxYear": "Year2017",
      "taxMonth": 0,
      "payPeriod": "Monthly",
      "period": 0,
      "startDate": "2019-11-14T12:22:48",
      "endDate": "2019-11-14T12:22:48",
      "paymentDate": "2019-11-14T12:22:48",
      "employeeCount": 0,
      "subContractorCount": 0,
      "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
      },
      "isClosed": true,
      "dateClosed": "2019-11-14T12:22:48",
      "autoPilotCloseDate": "2019-11-14T12:22:48",
      "entries": [
        {
          "id": "string",
          "name": "string",
          "metadata": {},
          "url": "string"
        }
      ]
    }
  ],
  "tax": 0.0,
  "cisDeductions": 0.0,
  "postgradLoanDeductions": 0.0,
  "studentLoanDeductions": 0.0,
  "employeeNic": 0.0,
  "employerNic": 0.0,
  "smp": 0.0,
  "smpNic": 0.0,
  "spp": 0.0,
  "sppNic": 0.0,
  "sap": 0.0,
  "sapNic": 0.0,
  "shpp": 0.0,
  "shppNic": 0.0,
  "spbp": 0.0,
  "spbpNic": 0.0,
  "eligibleForEmploymentAllowance": true,
  "employmentAllowanceClaim": 0.0,
  "employmentAllowanceClaimAuto": true,
  "liableForApprenticeshipLevy": true,
  "apprenticeshipLevy": 0.0,
  "apprenticeshipLevyAuto": true,
  "liabilityArisingInPeriod": 0.0,
  "dueInPreviousPeriods": 0.0,
  "paidInPreviousPeriods": 0.0,
  "employmentAllowanceClaimInPreviousPeriods": 0.0,
  "receivedFromHMRCToRefundTax": 0.0,
  "receivedFromHMRCToPayStatutoryPay": 0.0,
  "cisDeductionsSuffered": 0.0,
  "adjustment": 0.0,
  "netLiabilityForPeriod": 0.0,
  "totalPaid": 0.0,
  "payments": [
    {
      "amount": 0.0,
      "date": "2019-11-14T12:22:48",
      "id": "string"
    }
  ],
  "id": "string"
}
Contained in Models
P32
Consumed by Operations
Update HmrcLiability
Returned by Operations
Get HmrcLiability
Update HmrcLiability