Create Or Update Employee HMRC Adjustment

Creates a recurring HMRC adjustment for an employee

Request

POST https://api.yourpayroll.co.uk/api/v2/business/{businessId}/employee/{employeeId}/hmrcadjustment

Path parameters

Parameter name Value Description Additional
businessId string Required
employeeId string Required

Request body

The request body takes a complete EmployeeRecurringHmrcAdjustmentModel resource, containing the following writable properties:

{
    "amount": "double",
    "applyTaxRelief": "boolean",
    "contributionType": "string",
    "deleted": "boolean",
    "employeeId": "int32",
    "expiryDate": "date-time",
    "externalId": "string",
    "fromDate": "date-time",
    "id": "int32",
    "isActive": "boolean",
    "isFromNIBackCalculation": "boolean",
    "maximumAmountPaid": "double",
    "nationalInsuranceType": "string",
    "notes": "string",
    "totalAmountPaid": "double",
    "type": "string"
}

Properties

Name Type Description
amount double Decimal
applyTaxRelief boolean Boolean
contributionType string HmrcContributionType

Possible values are:

  • EmployerPensionContribution
  • EmployeePensionContribution
  • EmployerNationalInsuranceContribution
  • EmployeeNationalInsuranceContribution
  • StudentLoan
  • PostGradLoan
deleted boolean Boolean
employeeId int32 Int32
expiryDate date-time Nullable
externalId string String
fromDate date-time DateTime
id int32 Nullable
isActive boolean Boolean
isFromNIBackCalculation boolean Boolean
maximumAmountPaid double Nullable
nationalInsuranceType string Nullable

Possible values are:

  • A
  • B
  • C
  • H
  • J
  • M
  • X
  • Z
  • F
  • I
  • L
  • S
  • V
  • D
  • E
  • K
  • N
notes string String
totalAmountPaid double Decimal
type string HmrcAdjustmentTypeEnum

Possible values are:

  • Fixed
  • PercentageGross
  • PercentagePensionableEarnings
  • PercentageTaxableEarnings
  • PercentageNIableEarnings

Response

The following HTTP status codes may be returned, optionally with a response resource.

Status code Description Resource
200 OK

OK

 EmployeeRecurringHmrcAdjustmentModel