Guides

Calculate the Gross Daily Pay and typical Net Costs for an employee.
This endpoint is currently being beta tested and subject to un-announced breaking changes.

Store values

Parameters

NotionalDayRate number

The total chargeable rate per day.

CalculationDate string

Used to find associated legislative values, default Today. (optional)

Fee number

The charge for providing this service, per pay period.

FeeIsPercentage

boolean

If true, 'Fee' will be treated as a percentage.

ApprenticeshipLevyRateOverride number

Override the Apprenticeship Levy Rate. 0.50 for 0.5%. (optional)

EmployersPensionContribution number

The employers pension contributions, per pay period.

EmployersPensionContributionIsPercentage

boolean

If true, EmployersPensionContribution will be treated as a percentage.

EmployeesPensionContribution number

The employees pension contributions, per pay period.

EmployeesPensionContributionIsPercentage

boolean

If true, EmployeesPensionContribution will be used as a percentage.

UseAeBandings

boolean

If true, legislative Ae Bandings will be applied during calculation.

HolidayWeeks number

The holiday weeks to use for the calculation.

DaysWorkedPerWeek integer

Number of days the employee works per week.

PayPeriod string

The pay frequency to be used for the calculation.

PensionRule string

The type of pension scheme being enrolled into, default SalarySacrifice. (optional)

Try it

OAuth Token

Api Key

Response Code

Response Body

Response Headers

The API Key you provided may not be valid.
Please check it or use the OAuth Token.

Possible Responses

200	Success	`Contract.NetOfOnCostsResponse`	application/json
400	Bad Request
403	Forbidden