Skip to main content
POST
Calculate gross to net values

Authorizations

X-Auth-Token
string
header
required

Access token obtained from OAuth2 client credentials flow

X-Org-Id
string
header
required

Organisation to scope the request to. Required when the principal can access more than one organisation; optional for single-organisation principals (the authorizer resolves it automatically).

Body

application/json
taxCode
string
required

Tax code for the calculation

Example:

"1257L"

gross
number
required

Gross amount to calculate from

calculationName
enum<string>
required

Name of the calculation formula to use

Available options:
2024,
2025
period
integer
required

Period for the calculation

payFrequency
enum<string>
required

Unit of the period

Available options:
Weekly,
Fortnightly,
FourWeekly,
Monthly,
Quarterly,
Annual
niCategory
string
required

National Insurance category

Example:

"A"

studentLoanPlan
enum<string>

Student loan plan type

Available options:
Plan1,
Plan2,
Plan4,
Plan5
postGradLoanPlan
boolean

Indicates if the employee has a postgraduate loan plan

grossToDate
number

Gross amount to date

week1Month1
boolean

Indicates if the calculation is for Week 1/Month 1

taxToDate
number

Tax amount to date

Example:

1000

Response

Calculation Complete

message
object
content
object
validationIssues
object[]
messageToken
string