Merit Core API Documentation

Calculate Umbrella Net Pay

Calculates umbrella net pay from the income details provided

• URL

  /CalculateUmbrellaNetPay

• Method:

  GET

• URL Params

  Required:

  Hours=[decimal]

  Rate=[decimal]

  Optional:

  Fee=[decimal]

  Expenses=[decimal]

  Frequency= { 0 = Weekly (default), 1 = Monthly, 2 = Fortnightly, 3 = 4 Weekly }

  NiCategory=[string (default: A)]

  DeductPension=[boolean]

  IncludedHoliday=[boolean]

  TaxAllowanceDivider=[decimal]

  PensionTaxReliefOption={ 0 = None (default), 1 = Relief At Source, 2 = Net Pay Arrangement }

  DeductStudentLoan=[boolean]

  StudentLoanPlanType={ 0 = Plan 1 (default), 1 = Plan 2, 2 = Plan 4 }

  DeductPostGraduateLoan=[boolean]

  PaymentDate=[date yyyy-mm-dd]

• Success Response:

  • Code: 200
    Content: { "income":800.00, "fee":15.0, "expenses":75.54, "ersNI":54.49, "ersPension":13.5, "appLevy":2.85, "retainedHolPay":68.78, "basicPay":569.84, "advancedHolPay":0.0, "taxable":569.84, "eesNI":26.23, "tax":65.4, "eesPension":22.49, "payable":514.26, "unpaidExpenses":0.0, "additionalPay":112.24, "minWageHours":40.0, "minWageRate":11.44, "minWageValue":457.60, "minHolHours":0.0, "minHolRate":0.0, "minHolValue":0.0, "minAdditionalPay":139.00, "upliftOnRetainedHolPayErsNi":0.0, "upliftOnRetainedHolPayAppLevy":0.0, "upliftOnRetainedHolPayErsPension":0.0, "studentLoan":8.0, "postGraduateLoan":9.0 }

• Sample Call:

  curl https://func-meritcore-prod.azurewebsites.net/api/CalculateUmbrellaNetPay?clientId={CLIENTID}&code={APIKEY}&hours=40&deductPension=true&frequency=0&nicategory=A&fee=15&expenses=75.54&includedholiday=false&pensionTaxReliefOption=0&UpliftRetainedHolPayByErsNi=false&UpliftRetainedHolPayByApprenticeshipLevy=false&UpliftRetainedHolPayByErsPension=false&rate=20.00&deductstudentloan=true&studentloanplantype=0&deductpostgraduateloan=true

  Please replace {APIKEY} with your API Key and {CLIENTID} with your Client ID.

Calculate PSC Net Pay

Calculates PSC net pay from the income details provided

• URL

  /CalculatePscNetPay

• Method:

  GET

• URL Params

  Required:

  Income=[decimal]

  Salary=[decimal]

  Optional:

  Fee=[decimal]

  Expenses=[decimal]

  Frequency= { 0 = Weekly (default), 1 = Monthly, 2 = Fortnightly, 3 = 4 Weekly }

  NiCategory=[string (default: A)]

  TaxAllowanceDivider=[decimal]

  PaymentDate=[date yyyy-mm-dd]

• Success Response:

  • Code: 200
    Content: { "salary": 250.0, "income": 502.4, "fee": 15.0, "expenses": 75.54, "ersNI": 11.18, "eesNI": 8.04, "tax": 1.8, "profit": 150.68, "corporationTax": 28.63, "dividend": 122.05, "netSalary": 240.16, "payable": 437.75 }

• Sample Call:

  curl https://func-meritcore-prod.azurewebsites.net/api/CalculatePscNetPay?clientId={CLIENTID}&code={APIKEY}&income=502.4&salary=250&fee=15&expenses=75.54&frequency=0&nicategory=A

  Please replace {APIKEY} with your API Key and {CLIENTID} with your Client ID.

Calculate PAYE Net Pay

Calculates PAYE net pay from the income details provided

• URL

  /CalculatePayeNetPay

• Method:

  GET

• URL Params

  Required:

  Hours=[decimal]

  Rate=[decimal]

  Optional:

  Fee=[decimal]

  Expenses=[decimal]

  Frequency= { 0 = Weekly (default), 1 = Monthly, 2 = Fortnightly, 3 = 4 Weekly }

  NiCategory=[string (default: A)]

  DeductPension=[boolean]

  IncludedHoliday=[boolean]

  TaxAllowanceDivider=[decimal]

  PensionTaxReliefOption={ 0 = None (default), 1 = Relief At Source, 2 = Net Pay Arrangement }

  DeductStudentLoan=[boolean]

  StudentLoanPlanType={ 0 = Plan 1 (default), 1 = Plan 2, 2 = Plan 4 }

  DeductPostGraduateLoan=[boolean]

  PaymentDate=[date yyyy-mm-dd]

• Success Response:

  • Code: 200
    Content: { "grossPay":502.4, "ersNI":45.18, "ersPension":0.0, "accruedHolPay":60.64, "appLevy":2.51, "eesNI":20.83, "eesPension":0.0, "tax":52.0, "payable":423.57, "studentLoan":1.0, "postGraduateLoan":5.0 }

• Sample Call:

  curl https://func-meritcore-prod.azurewebsites.net/api/CalculatePayeNetPay?clientId={CLIENTID}&code={APIKEY}&hours=1&rate=502.4&includedHoliday=false&Frequency=0&NiCategory=A&DeductStudentLoan=True&StudentLoanPlanType=0&deductpostgraduateLoan=true

  Please replace {APIKEY} with your API Key and {CLIENTID} with your Client ID.