Update organisation opening balances by tax year
Updates the opening balances for the current organisation for a specific tax year
curl --request POST \
--url https://api.sandbox.flowpayroll.ai/v1/organisation/balances/opening/{taxYear} \
--header 'Content-Type: application/json' \
--header 'X-Auth-Token: <api-key>' \
--header 'X-Org-Id: <api-key>' \
--data '
{
"baseValues": {
"gross": 306,
"grossTaxable": 306,
"grossNi": 306,
"grossForEmployerNi": 306,
"grossForEmployerClass1ANi": 306,
"grossPensionable": 306,
"grossForCourtOrders": 306,
"tax": 45.2,
"ni": 25.3,
"pension": 0,
"employerNi": 35.4,
"employerClass1ANI": 35.4,
"employerPension": 0,
"studentLoan": 0,
"postgraduateLoan": 0,
"net": 235.5,
"netDeductions": 0,
"totalPayable": 235.5,
"totalEmployerCost": 306,
"niBand": {},
"statutory": {
"SSP": 0,
"SMP": 0
},
"pensionContributionsByType": {
"NetPayArrangement": 0,
"ReliefAtSource": 0,
"SalarySacrifice": 0
},
"qualifyingEarningsForPension": 0,
"apprenticeshipLevy": 1.53,
"employmentAllowance": 0,
"apprenticeshipLevyAllowance": 0,
"statutoryRecovery": {
"StatutoryMaternityPay": {
"reclaimed": 100,
"nicCompensationRecovered": 8.5
}
},
"isEmpty": false
},
"apprenticeshipLevyAllowanceYtd": {
"amountLeft": 100,
"amountUsed": 100
},
"apprenticeshipLevyYtd": 100,
"employmentAllowanceYtd": {
"amountLeft": 100,
"amountUsed": 100
},
"cisDeductions": {
"amountLeft": 100,
"amountUsed": 100
},
"statutoryPaymentsReclaims": {}
}
'import requests
url = "https://api.sandbox.flowpayroll.ai/v1/organisation/balances/opening/{taxYear}"
payload = {
"baseValues": {
"gross": 306,
"grossTaxable": 306,
"grossNi": 306,
"grossForEmployerNi": 306,
"grossForEmployerClass1ANi": 306,
"grossPensionable": 306,
"grossForCourtOrders": 306,
"tax": 45.2,
"ni": 25.3,
"pension": 0,
"employerNi": 35.4,
"employerClass1ANI": 35.4,
"employerPension": 0,
"studentLoan": 0,
"postgraduateLoan": 0,
"net": 235.5,
"netDeductions": 0,
"totalPayable": 235.5,
"totalEmployerCost": 306,
"niBand": {},
"statutory": {
"SSP": 0,
"SMP": 0
},
"pensionContributionsByType": {
"NetPayArrangement": 0,
"ReliefAtSource": 0,
"SalarySacrifice": 0
},
"qualifyingEarningsForPension": 0,
"apprenticeshipLevy": 1.53,
"employmentAllowance": 0,
"apprenticeshipLevyAllowance": 0,
"statutoryRecovery": { "StatutoryMaternityPay": {
"reclaimed": 100,
"nicCompensationRecovered": 8.5
} },
"isEmpty": False
},
"apprenticeshipLevyAllowanceYtd": {
"amountLeft": 100,
"amountUsed": 100
},
"apprenticeshipLevyYtd": 100,
"employmentAllowanceYtd": {
"amountLeft": 100,
"amountUsed": 100
},
"cisDeductions": {
"amountLeft": 100,
"amountUsed": 100
},
"statutoryPaymentsReclaims": {}
}
headers = {
"X-Auth-Token": "<api-key>",
"X-Org-Id": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'X-Auth-Token': '<api-key>',
'X-Org-Id': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
baseValues: {
gross: 306,
grossTaxable: 306,
grossNi: 306,
grossForEmployerNi: 306,
grossForEmployerClass1ANi: 306,
grossPensionable: 306,
grossForCourtOrders: 306,
tax: 45.2,
ni: 25.3,
pension: 0,
employerNi: 35.4,
employerClass1ANI: 35.4,
employerPension: 0,
studentLoan: 0,
postgraduateLoan: 0,
net: 235.5,
netDeductions: 0,
totalPayable: 235.5,
totalEmployerCost: 306,
niBand: {},
statutory: {SSP: 0, SMP: 0},
pensionContributionsByType: {NetPayArrangement: 0, ReliefAtSource: 0, SalarySacrifice: 0},
qualifyingEarningsForPension: 0,
apprenticeshipLevy: 1.53,
employmentAllowance: 0,
apprenticeshipLevyAllowance: 0,
statutoryRecovery: {StatutoryMaternityPay: {reclaimed: 100, nicCompensationRecovered: 8.5}},
isEmpty: false
},
apprenticeshipLevyAllowanceYtd: {amountLeft: 100, amountUsed: 100},
apprenticeshipLevyYtd: 100,
employmentAllowanceYtd: {amountLeft: 100, amountUsed: 100},
cisDeductions: {amountLeft: 100, amountUsed: 100},
statutoryPaymentsReclaims: {}
})
};
fetch('https://api.sandbox.flowpayroll.ai/v1/organisation/balances/opening/{taxYear}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.sandbox.flowpayroll.ai/v1/organisation/balances/opening/{taxYear}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'baseValues' => [
'gross' => 306,
'grossTaxable' => 306,
'grossNi' => 306,
'grossForEmployerNi' => 306,
'grossForEmployerClass1ANi' => 306,
'grossPensionable' => 306,
'grossForCourtOrders' => 306,
'tax' => 45.2,
'ni' => 25.3,
'pension' => 0,
'employerNi' => 35.4,
'employerClass1ANI' => 35.4,
'employerPension' => 0,
'studentLoan' => 0,
'postgraduateLoan' => 0,
'net' => 235.5,
'netDeductions' => 0,
'totalPayable' => 235.5,
'totalEmployerCost' => 306,
'niBand' => [
],
'statutory' => [
'SSP' => 0,
'SMP' => 0
],
'pensionContributionsByType' => [
'NetPayArrangement' => 0,
'ReliefAtSource' => 0,
'SalarySacrifice' => 0
],
'qualifyingEarningsForPension' => 0,
'apprenticeshipLevy' => 1.53,
'employmentAllowance' => 0,
'apprenticeshipLevyAllowance' => 0,
'statutoryRecovery' => [
'StatutoryMaternityPay' => [
'reclaimed' => 100,
'nicCompensationRecovered' => 8.5
]
],
'isEmpty' => false
],
'apprenticeshipLevyAllowanceYtd' => [
'amountLeft' => 100,
'amountUsed' => 100
],
'apprenticeshipLevyYtd' => 100,
'employmentAllowanceYtd' => [
'amountLeft' => 100,
'amountUsed' => 100
],
'cisDeductions' => [
'amountLeft' => 100,
'amountUsed' => 100
],
'statutoryPaymentsReclaims' => [
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Auth-Token: <api-key>",
"X-Org-Id: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.sandbox.flowpayroll.ai/v1/organisation/balances/opening/{taxYear}"
payload := strings.NewReader("{\n \"baseValues\": {\n \"gross\": 306,\n \"grossTaxable\": 306,\n \"grossNi\": 306,\n \"grossForEmployerNi\": 306,\n \"grossForEmployerClass1ANi\": 306,\n \"grossPensionable\": 306,\n \"grossForCourtOrders\": 306,\n \"tax\": 45.2,\n \"ni\": 25.3,\n \"pension\": 0,\n \"employerNi\": 35.4,\n \"employerClass1ANI\": 35.4,\n \"employerPension\": 0,\n \"studentLoan\": 0,\n \"postgraduateLoan\": 0,\n \"net\": 235.5,\n \"netDeductions\": 0,\n \"totalPayable\": 235.5,\n \"totalEmployerCost\": 306,\n \"niBand\": {},\n \"statutory\": {\n \"SSP\": 0,\n \"SMP\": 0\n },\n \"pensionContributionsByType\": {\n \"NetPayArrangement\": 0,\n \"ReliefAtSource\": 0,\n \"SalarySacrifice\": 0\n },\n \"qualifyingEarningsForPension\": 0,\n \"apprenticeshipLevy\": 1.53,\n \"employmentAllowance\": 0,\n \"apprenticeshipLevyAllowance\": 0,\n \"statutoryRecovery\": {\n \"StatutoryMaternityPay\": {\n \"reclaimed\": 100,\n \"nicCompensationRecovered\": 8.5\n }\n },\n \"isEmpty\": false\n },\n \"apprenticeshipLevyAllowanceYtd\": {\n \"amountLeft\": 100,\n \"amountUsed\": 100\n },\n \"apprenticeshipLevyYtd\": 100,\n \"employmentAllowanceYtd\": {\n \"amountLeft\": 100,\n \"amountUsed\": 100\n },\n \"cisDeductions\": {\n \"amountLeft\": 100,\n \"amountUsed\": 100\n },\n \"statutoryPaymentsReclaims\": {}\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Auth-Token", "<api-key>")
req.Header.Add("X-Org-Id", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.sandbox.flowpayroll.ai/v1/organisation/balances/opening/{taxYear}")
.header("X-Auth-Token", "<api-key>")
.header("X-Org-Id", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"baseValues\": {\n \"gross\": 306,\n \"grossTaxable\": 306,\n \"grossNi\": 306,\n \"grossForEmployerNi\": 306,\n \"grossForEmployerClass1ANi\": 306,\n \"grossPensionable\": 306,\n \"grossForCourtOrders\": 306,\n \"tax\": 45.2,\n \"ni\": 25.3,\n \"pension\": 0,\n \"employerNi\": 35.4,\n \"employerClass1ANI\": 35.4,\n \"employerPension\": 0,\n \"studentLoan\": 0,\n \"postgraduateLoan\": 0,\n \"net\": 235.5,\n \"netDeductions\": 0,\n \"totalPayable\": 235.5,\n \"totalEmployerCost\": 306,\n \"niBand\": {},\n \"statutory\": {\n \"SSP\": 0,\n \"SMP\": 0\n },\n \"pensionContributionsByType\": {\n \"NetPayArrangement\": 0,\n \"ReliefAtSource\": 0,\n \"SalarySacrifice\": 0\n },\n \"qualifyingEarningsForPension\": 0,\n \"apprenticeshipLevy\": 1.53,\n \"employmentAllowance\": 0,\n \"apprenticeshipLevyAllowance\": 0,\n \"statutoryRecovery\": {\n \"StatutoryMaternityPay\": {\n \"reclaimed\": 100,\n \"nicCompensationRecovered\": 8.5\n }\n },\n \"isEmpty\": false\n },\n \"apprenticeshipLevyAllowanceYtd\": {\n \"amountLeft\": 100,\n \"amountUsed\": 100\n },\n \"apprenticeshipLevyYtd\": 100,\n \"employmentAllowanceYtd\": {\n \"amountLeft\": 100,\n \"amountUsed\": 100\n },\n \"cisDeductions\": {\n \"amountLeft\": 100,\n \"amountUsed\": 100\n },\n \"statutoryPaymentsReclaims\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sandbox.flowpayroll.ai/v1/organisation/balances/opening/{taxYear}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Auth-Token"] = '<api-key>'
request["X-Org-Id"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"baseValues\": {\n \"gross\": 306,\n \"grossTaxable\": 306,\n \"grossNi\": 306,\n \"grossForEmployerNi\": 306,\n \"grossForEmployerClass1ANi\": 306,\n \"grossPensionable\": 306,\n \"grossForCourtOrders\": 306,\n \"tax\": 45.2,\n \"ni\": 25.3,\n \"pension\": 0,\n \"employerNi\": 35.4,\n \"employerClass1ANI\": 35.4,\n \"employerPension\": 0,\n \"studentLoan\": 0,\n \"postgraduateLoan\": 0,\n \"net\": 235.5,\n \"netDeductions\": 0,\n \"totalPayable\": 235.5,\n \"totalEmployerCost\": 306,\n \"niBand\": {},\n \"statutory\": {\n \"SSP\": 0,\n \"SMP\": 0\n },\n \"pensionContributionsByType\": {\n \"NetPayArrangement\": 0,\n \"ReliefAtSource\": 0,\n \"SalarySacrifice\": 0\n },\n \"qualifyingEarningsForPension\": 0,\n \"apprenticeshipLevy\": 1.53,\n \"employmentAllowance\": 0,\n \"apprenticeshipLevyAllowance\": 0,\n \"statutoryRecovery\": {\n \"StatutoryMaternityPay\": {\n \"reclaimed\": 100,\n \"nicCompensationRecovered\": 8.5\n }\n },\n \"isEmpty\": false\n },\n \"apprenticeshipLevyAllowanceYtd\": {\n \"amountLeft\": 100,\n \"amountUsed\": 100\n },\n \"apprenticeshipLevyYtd\": 100,\n \"employmentAllowanceYtd\": {\n \"amountLeft\": 100,\n \"amountUsed\": 100\n },\n \"cisDeductions\": {\n \"amountLeft\": 100,\n \"amountUsed\": 100\n },\n \"statutoryPaymentsReclaims\": {}\n}"
response = http.request(request)
puts response.read_body{
"message": {
"text": "<string>",
"token": "<string>",
"tokenArguments": [
{
"name": "<string>",
"value": "<string>"
}
]
},
"content": {
"data": {},
"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>",
"data": {
"baseValues": {
"gross": 306,
"grossTaxable": 306,
"grossNi": 306,
"grossForEmployerNi": 306,
"grossForEmployerClass1ANi": 306,
"grossPensionable": 306,
"grossForCourtOrders": 306,
"tax": 45.2,
"ni": 25.3,
"pension": 0,
"employerNi": 35.4,
"employerClass1ANI": 35.4,
"employerPension": 0,
"studentLoan": 0,
"postgraduateLoan": 0,
"net": 235.5,
"netDeductions": 0,
"totalPayable": 235.5,
"totalEmployerCost": 306,
"niBand": {},
"statutory": {
"SSP": 0,
"SMP": 0
},
"pensionContributionsByType": {
"NetPayArrangement": 0,
"ReliefAtSource": 0,
"SalarySacrifice": 0
},
"qualifyingEarningsForPension": 0,
"apprenticeshipLevy": 1.53,
"employmentAllowance": 0,
"apprenticeshipLevyAllowance": 0,
"statutoryRecovery": {
"StatutoryMaternityPay": {
"reclaimed": 100,
"nicCompensationRecovered": 8.5
}
},
"isEmpty": false
},
"organisationId": "org_123",
"createdBy": "user_123",
"updatedBy": "user_456",
"createdDate": "2024-01-01T00:00:00Z",
"updatedDate": "2024-01-02T00:00:00Z",
"apprenticeshipLevyAllowanceYtd": {
"amountLeft": 100,
"amountUsed": 100
},
"apprenticeshipLevyYtd": 100,
"employmentAllowanceYtd": {
"amountLeft": 100,
"amountUsed": 100
},
"cisDeductions": {
"amountLeft": 100,
"amountUsed": 100
},
"statutoryPaymentsReclaims": {}
}
}{
"message": {
"text": "<string>",
"token": "<string>",
"tokenArguments": [
{
"name": "<string>",
"value": "<string>"
}
]
},
"content": {
"data": {},
"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>"
}{
"message": {
"text": "<string>",
"token": "<string>",
"tokenArguments": [
{
"name": "<string>",
"value": "<string>"
}
]
},
"content": {
"data": {},
"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>"
}Authorizations
Access token obtained from OAuth2 client credentials flow
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).
Path Parameters
The tax year to update balances for
1800 <= x <= 3000Body
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Apprenticeship levy owed YTD
100
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Dictionary where keys should be one of the StatutoryTypeEnum values (StatutorySickPay, StatutoryMaternityPay, StatutoryPaternityPay, StatutoryAdoptionPay, SharedParentalPay, StatutoryParentalBereavementPay, StatutorySharedParentalPay, StatutoryNeoNatalCarePay)
Show child attributes
Show child attributes
Was this page helpful?
curl --request POST \
--url https://api.sandbox.flowpayroll.ai/v1/organisation/balances/opening/{taxYear} \
--header 'Content-Type: application/json' \
--header 'X-Auth-Token: <api-key>' \
--header 'X-Org-Id: <api-key>' \
--data '
{
"baseValues": {
"gross": 306,
"grossTaxable": 306,
"grossNi": 306,
"grossForEmployerNi": 306,
"grossForEmployerClass1ANi": 306,
"grossPensionable": 306,
"grossForCourtOrders": 306,
"tax": 45.2,
"ni": 25.3,
"pension": 0,
"employerNi": 35.4,
"employerClass1ANI": 35.4,
"employerPension": 0,
"studentLoan": 0,
"postgraduateLoan": 0,
"net": 235.5,
"netDeductions": 0,
"totalPayable": 235.5,
"totalEmployerCost": 306,
"niBand": {},
"statutory": {
"SSP": 0,
"SMP": 0
},
"pensionContributionsByType": {
"NetPayArrangement": 0,
"ReliefAtSource": 0,
"SalarySacrifice": 0
},
"qualifyingEarningsForPension": 0,
"apprenticeshipLevy": 1.53,
"employmentAllowance": 0,
"apprenticeshipLevyAllowance": 0,
"statutoryRecovery": {
"StatutoryMaternityPay": {
"reclaimed": 100,
"nicCompensationRecovered": 8.5
}
},
"isEmpty": false
},
"apprenticeshipLevyAllowanceYtd": {
"amountLeft": 100,
"amountUsed": 100
},
"apprenticeshipLevyYtd": 100,
"employmentAllowanceYtd": {
"amountLeft": 100,
"amountUsed": 100
},
"cisDeductions": {
"amountLeft": 100,
"amountUsed": 100
},
"statutoryPaymentsReclaims": {}
}
'import requests
url = "https://api.sandbox.flowpayroll.ai/v1/organisation/balances/opening/{taxYear}"
payload = {
"baseValues": {
"gross": 306,
"grossTaxable": 306,
"grossNi": 306,
"grossForEmployerNi": 306,
"grossForEmployerClass1ANi": 306,
"grossPensionable": 306,
"grossForCourtOrders": 306,
"tax": 45.2,
"ni": 25.3,
"pension": 0,
"employerNi": 35.4,
"employerClass1ANI": 35.4,
"employerPension": 0,
"studentLoan": 0,
"postgraduateLoan": 0,
"net": 235.5,
"netDeductions": 0,
"totalPayable": 235.5,
"totalEmployerCost": 306,
"niBand": {},
"statutory": {
"SSP": 0,
"SMP": 0
},
"pensionContributionsByType": {
"NetPayArrangement": 0,
"ReliefAtSource": 0,
"SalarySacrifice": 0
},
"qualifyingEarningsForPension": 0,
"apprenticeshipLevy": 1.53,
"employmentAllowance": 0,
"apprenticeshipLevyAllowance": 0,
"statutoryRecovery": { "StatutoryMaternityPay": {
"reclaimed": 100,
"nicCompensationRecovered": 8.5
} },
"isEmpty": False
},
"apprenticeshipLevyAllowanceYtd": {
"amountLeft": 100,
"amountUsed": 100
},
"apprenticeshipLevyYtd": 100,
"employmentAllowanceYtd": {
"amountLeft": 100,
"amountUsed": 100
},
"cisDeductions": {
"amountLeft": 100,
"amountUsed": 100
},
"statutoryPaymentsReclaims": {}
}
headers = {
"X-Auth-Token": "<api-key>",
"X-Org-Id": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'X-Auth-Token': '<api-key>',
'X-Org-Id': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
baseValues: {
gross: 306,
grossTaxable: 306,
grossNi: 306,
grossForEmployerNi: 306,
grossForEmployerClass1ANi: 306,
grossPensionable: 306,
grossForCourtOrders: 306,
tax: 45.2,
ni: 25.3,
pension: 0,
employerNi: 35.4,
employerClass1ANI: 35.4,
employerPension: 0,
studentLoan: 0,
postgraduateLoan: 0,
net: 235.5,
netDeductions: 0,
totalPayable: 235.5,
totalEmployerCost: 306,
niBand: {},
statutory: {SSP: 0, SMP: 0},
pensionContributionsByType: {NetPayArrangement: 0, ReliefAtSource: 0, SalarySacrifice: 0},
qualifyingEarningsForPension: 0,
apprenticeshipLevy: 1.53,
employmentAllowance: 0,
apprenticeshipLevyAllowance: 0,
statutoryRecovery: {StatutoryMaternityPay: {reclaimed: 100, nicCompensationRecovered: 8.5}},
isEmpty: false
},
apprenticeshipLevyAllowanceYtd: {amountLeft: 100, amountUsed: 100},
apprenticeshipLevyYtd: 100,
employmentAllowanceYtd: {amountLeft: 100, amountUsed: 100},
cisDeductions: {amountLeft: 100, amountUsed: 100},
statutoryPaymentsReclaims: {}
})
};
fetch('https://api.sandbox.flowpayroll.ai/v1/organisation/balances/opening/{taxYear}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.sandbox.flowpayroll.ai/v1/organisation/balances/opening/{taxYear}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'baseValues' => [
'gross' => 306,
'grossTaxable' => 306,
'grossNi' => 306,
'grossForEmployerNi' => 306,
'grossForEmployerClass1ANi' => 306,
'grossPensionable' => 306,
'grossForCourtOrders' => 306,
'tax' => 45.2,
'ni' => 25.3,
'pension' => 0,
'employerNi' => 35.4,
'employerClass1ANI' => 35.4,
'employerPension' => 0,
'studentLoan' => 0,
'postgraduateLoan' => 0,
'net' => 235.5,
'netDeductions' => 0,
'totalPayable' => 235.5,
'totalEmployerCost' => 306,
'niBand' => [
],
'statutory' => [
'SSP' => 0,
'SMP' => 0
],
'pensionContributionsByType' => [
'NetPayArrangement' => 0,
'ReliefAtSource' => 0,
'SalarySacrifice' => 0
],
'qualifyingEarningsForPension' => 0,
'apprenticeshipLevy' => 1.53,
'employmentAllowance' => 0,
'apprenticeshipLevyAllowance' => 0,
'statutoryRecovery' => [
'StatutoryMaternityPay' => [
'reclaimed' => 100,
'nicCompensationRecovered' => 8.5
]
],
'isEmpty' => false
],
'apprenticeshipLevyAllowanceYtd' => [
'amountLeft' => 100,
'amountUsed' => 100
],
'apprenticeshipLevyYtd' => 100,
'employmentAllowanceYtd' => [
'amountLeft' => 100,
'amountUsed' => 100
],
'cisDeductions' => [
'amountLeft' => 100,
'amountUsed' => 100
],
'statutoryPaymentsReclaims' => [
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Auth-Token: <api-key>",
"X-Org-Id: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.sandbox.flowpayroll.ai/v1/organisation/balances/opening/{taxYear}"
payload := strings.NewReader("{\n \"baseValues\": {\n \"gross\": 306,\n \"grossTaxable\": 306,\n \"grossNi\": 306,\n \"grossForEmployerNi\": 306,\n \"grossForEmployerClass1ANi\": 306,\n \"grossPensionable\": 306,\n \"grossForCourtOrders\": 306,\n \"tax\": 45.2,\n \"ni\": 25.3,\n \"pension\": 0,\n \"employerNi\": 35.4,\n \"employerClass1ANI\": 35.4,\n \"employerPension\": 0,\n \"studentLoan\": 0,\n \"postgraduateLoan\": 0,\n \"net\": 235.5,\n \"netDeductions\": 0,\n \"totalPayable\": 235.5,\n \"totalEmployerCost\": 306,\n \"niBand\": {},\n \"statutory\": {\n \"SSP\": 0,\n \"SMP\": 0\n },\n \"pensionContributionsByType\": {\n \"NetPayArrangement\": 0,\n \"ReliefAtSource\": 0,\n \"SalarySacrifice\": 0\n },\n \"qualifyingEarningsForPension\": 0,\n \"apprenticeshipLevy\": 1.53,\n \"employmentAllowance\": 0,\n \"apprenticeshipLevyAllowance\": 0,\n \"statutoryRecovery\": {\n \"StatutoryMaternityPay\": {\n \"reclaimed\": 100,\n \"nicCompensationRecovered\": 8.5\n }\n },\n \"isEmpty\": false\n },\n \"apprenticeshipLevyAllowanceYtd\": {\n \"amountLeft\": 100,\n \"amountUsed\": 100\n },\n \"apprenticeshipLevyYtd\": 100,\n \"employmentAllowanceYtd\": {\n \"amountLeft\": 100,\n \"amountUsed\": 100\n },\n \"cisDeductions\": {\n \"amountLeft\": 100,\n \"amountUsed\": 100\n },\n \"statutoryPaymentsReclaims\": {}\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Auth-Token", "<api-key>")
req.Header.Add("X-Org-Id", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.sandbox.flowpayroll.ai/v1/organisation/balances/opening/{taxYear}")
.header("X-Auth-Token", "<api-key>")
.header("X-Org-Id", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"baseValues\": {\n \"gross\": 306,\n \"grossTaxable\": 306,\n \"grossNi\": 306,\n \"grossForEmployerNi\": 306,\n \"grossForEmployerClass1ANi\": 306,\n \"grossPensionable\": 306,\n \"grossForCourtOrders\": 306,\n \"tax\": 45.2,\n \"ni\": 25.3,\n \"pension\": 0,\n \"employerNi\": 35.4,\n \"employerClass1ANI\": 35.4,\n \"employerPension\": 0,\n \"studentLoan\": 0,\n \"postgraduateLoan\": 0,\n \"net\": 235.5,\n \"netDeductions\": 0,\n \"totalPayable\": 235.5,\n \"totalEmployerCost\": 306,\n \"niBand\": {},\n \"statutory\": {\n \"SSP\": 0,\n \"SMP\": 0\n },\n \"pensionContributionsByType\": {\n \"NetPayArrangement\": 0,\n \"ReliefAtSource\": 0,\n \"SalarySacrifice\": 0\n },\n \"qualifyingEarningsForPension\": 0,\n \"apprenticeshipLevy\": 1.53,\n \"employmentAllowance\": 0,\n \"apprenticeshipLevyAllowance\": 0,\n \"statutoryRecovery\": {\n \"StatutoryMaternityPay\": {\n \"reclaimed\": 100,\n \"nicCompensationRecovered\": 8.5\n }\n },\n \"isEmpty\": false\n },\n \"apprenticeshipLevyAllowanceYtd\": {\n \"amountLeft\": 100,\n \"amountUsed\": 100\n },\n \"apprenticeshipLevyYtd\": 100,\n \"employmentAllowanceYtd\": {\n \"amountLeft\": 100,\n \"amountUsed\": 100\n },\n \"cisDeductions\": {\n \"amountLeft\": 100,\n \"amountUsed\": 100\n },\n \"statutoryPaymentsReclaims\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sandbox.flowpayroll.ai/v1/organisation/balances/opening/{taxYear}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Auth-Token"] = '<api-key>'
request["X-Org-Id"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"baseValues\": {\n \"gross\": 306,\n \"grossTaxable\": 306,\n \"grossNi\": 306,\n \"grossForEmployerNi\": 306,\n \"grossForEmployerClass1ANi\": 306,\n \"grossPensionable\": 306,\n \"grossForCourtOrders\": 306,\n \"tax\": 45.2,\n \"ni\": 25.3,\n \"pension\": 0,\n \"employerNi\": 35.4,\n \"employerClass1ANI\": 35.4,\n \"employerPension\": 0,\n \"studentLoan\": 0,\n \"postgraduateLoan\": 0,\n \"net\": 235.5,\n \"netDeductions\": 0,\n \"totalPayable\": 235.5,\n \"totalEmployerCost\": 306,\n \"niBand\": {},\n \"statutory\": {\n \"SSP\": 0,\n \"SMP\": 0\n },\n \"pensionContributionsByType\": {\n \"NetPayArrangement\": 0,\n \"ReliefAtSource\": 0,\n \"SalarySacrifice\": 0\n },\n \"qualifyingEarningsForPension\": 0,\n \"apprenticeshipLevy\": 1.53,\n \"employmentAllowance\": 0,\n \"apprenticeshipLevyAllowance\": 0,\n \"statutoryRecovery\": {\n \"StatutoryMaternityPay\": {\n \"reclaimed\": 100,\n \"nicCompensationRecovered\": 8.5\n }\n },\n \"isEmpty\": false\n },\n \"apprenticeshipLevyAllowanceYtd\": {\n \"amountLeft\": 100,\n \"amountUsed\": 100\n },\n \"apprenticeshipLevyYtd\": 100,\n \"employmentAllowanceYtd\": {\n \"amountLeft\": 100,\n \"amountUsed\": 100\n },\n \"cisDeductions\": {\n \"amountLeft\": 100,\n \"amountUsed\": 100\n },\n \"statutoryPaymentsReclaims\": {}\n}"
response = http.request(request)
puts response.read_body{
"message": {
"text": "<string>",
"token": "<string>",
"tokenArguments": [
{
"name": "<string>",
"value": "<string>"
}
]
},
"content": {
"data": {},
"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>",
"data": {
"baseValues": {
"gross": 306,
"grossTaxable": 306,
"grossNi": 306,
"grossForEmployerNi": 306,
"grossForEmployerClass1ANi": 306,
"grossPensionable": 306,
"grossForCourtOrders": 306,
"tax": 45.2,
"ni": 25.3,
"pension": 0,
"employerNi": 35.4,
"employerClass1ANI": 35.4,
"employerPension": 0,
"studentLoan": 0,
"postgraduateLoan": 0,
"net": 235.5,
"netDeductions": 0,
"totalPayable": 235.5,
"totalEmployerCost": 306,
"niBand": {},
"statutory": {
"SSP": 0,
"SMP": 0
},
"pensionContributionsByType": {
"NetPayArrangement": 0,
"ReliefAtSource": 0,
"SalarySacrifice": 0
},
"qualifyingEarningsForPension": 0,
"apprenticeshipLevy": 1.53,
"employmentAllowance": 0,
"apprenticeshipLevyAllowance": 0,
"statutoryRecovery": {
"StatutoryMaternityPay": {
"reclaimed": 100,
"nicCompensationRecovered": 8.5
}
},
"isEmpty": false
},
"organisationId": "org_123",
"createdBy": "user_123",
"updatedBy": "user_456",
"createdDate": "2024-01-01T00:00:00Z",
"updatedDate": "2024-01-02T00:00:00Z",
"apprenticeshipLevyAllowanceYtd": {
"amountLeft": 100,
"amountUsed": 100
},
"apprenticeshipLevyYtd": 100,
"employmentAllowanceYtd": {
"amountLeft": 100,
"amountUsed": 100
},
"cisDeductions": {
"amountLeft": 100,
"amountUsed": 100
},
"statutoryPaymentsReclaims": {}
}
}{
"message": {
"text": "<string>",
"token": "<string>",
"tokenArguments": [
{
"name": "<string>",
"value": "<string>"
}
]
},
"content": {
"data": {},
"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>"
}{
"message": {
"text": "<string>",
"token": "<string>",
"tokenArguments": [
{
"name": "<string>",
"value": "<string>"
}
]
},
"content": {
"data": {},
"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>"
}