Skip to main content
POST
/
calculator
/
grosstonet
Calculate gross to net values
curl --request POST \
  --url https://api.sandbox.flowpayroll.ai/v1/calculator/grosstonet \
  --header 'Content-Type: application/json' \
  --header 'X-Auth-Token: <api-key>' \
  --data '
{
  "taxCode": "1257L",
  "gross": 123,
  "period": 123,
  "niCategory": "A",
  "postGradLoanPlan": true,
  "grossToDate": 123,
  "week1Month1": true,
  "taxToDate": 1000
}
'
{
  "message": {
    "text": "<string>",
    "token": "<string>",
    "tokenArguments": [
      {
        "name": "<string>",
        "value": "<string>"
      }
    ]
  },
  "content": {
    "data": {
      "taxForPeriod": 123,
      "employeeNi": 123,
      "employerNi": 123,
      "studentLoan": 123,
      "postGradLoan": 123,
      "netPay": 123
    },
    "metadata": {
      "dateFormat": "yyyy-MM-dd",
      "dateTimeFormat": "yyyy-MM-ddTHH:mm:ss.fffZ",
      "paginationToken": "<string>"
    }
  },
  "validationIssues": [
    {
      "field": "<string>",
      "reason": "<string>",
      "reasonToken": "<string>",
      "reasonTokenArguments": [
        {
          "name": "<string>",
          "value": "<string>"
        }
      ]
    }
  ],
  "messageToken": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.flowpayroll.ai/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

X-Auth-Token
string
header
required

Access token obtained from OAuth2 client credentials flow

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