Update Payroll
curl --request PATCH \
--url https://sandbox.intermezzo.ai/gb/payroll/{payrun_id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"payrollGroup": [
{
"employeeId": "<string>",
"payDetails": {
"earnings": [
{
"amount": 1,
"earningFrequency": "month",
"isLumpsum": false
}
],
"benefits": [
{
"amount": "0.00",
"makeGoodAmount": "0.00",
"foregoneAmount": "0.00"
}
],
"deductions": [
{
"name": "<string>",
"amount": 1
}
],
"reimbursements": [
{
"name": "<string>",
"amount": 1
}
]
}
}
]
}
'import requests
url = "https://sandbox.intermezzo.ai/gb/payroll/{payrun_id}"
payload = { "payrollGroup": [
{
"employeeId": "<string>",
"payDetails": {
"earnings": [
{
"amount": 1,
"earningFrequency": "month",
"isLumpsum": False
}
],
"benefits": [
{
"amount": "0.00",
"makeGoodAmount": "0.00",
"foregoneAmount": "0.00"
}
],
"deductions": [
{
"name": "<string>",
"amount": 1
}
],
"reimbursements": [
{
"name": "<string>",
"amount": 1
}
]
}
}
] }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
payrollGroup: [
{
employeeId: '<string>',
payDetails: {
earnings: [{amount: 1, earningFrequency: 'month', isLumpsum: false}],
benefits: [{amount: '0.00', makeGoodAmount: '0.00', foregoneAmount: '0.00'}],
deductions: [{name: '<string>', amount: 1}],
reimbursements: [{name: '<string>', amount: 1}]
}
}
]
})
};
fetch('https://sandbox.intermezzo.ai/gb/payroll/{payrun_id}', 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://sandbox.intermezzo.ai/gb/payroll/{payrun_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'payrollGroup' => [
[
'employeeId' => '<string>',
'payDetails' => [
'earnings' => [
[
'amount' => 1,
'earningFrequency' => 'month',
'isLumpsum' => false
]
],
'benefits' => [
[
'amount' => '0.00',
'makeGoodAmount' => '0.00',
'foregoneAmount' => '0.00'
]
],
'deductions' => [
[
'name' => '<string>',
'amount' => 1
]
],
'reimbursements' => [
[
'name' => '<string>',
'amount' => 1
]
]
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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://sandbox.intermezzo.ai/gb/payroll/{payrun_id}"
payload := strings.NewReader("{\n \"payrollGroup\": [\n {\n \"employeeId\": \"<string>\",\n \"payDetails\": {\n \"earnings\": [\n {\n \"amount\": 1,\n \"earningFrequency\": \"month\",\n \"isLumpsum\": false\n }\n ],\n \"benefits\": [\n {\n \"amount\": \"0.00\",\n \"makeGoodAmount\": \"0.00\",\n \"foregoneAmount\": \"0.00\"\n }\n ],\n \"deductions\": [\n {\n \"name\": \"<string>\",\n \"amount\": 1\n }\n ],\n \"reimbursements\": [\n {\n \"name\": \"<string>\",\n \"amount\": 1\n }\n ]\n }\n }\n ]\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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.patch("https://sandbox.intermezzo.ai/gb/payroll/{payrun_id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"payrollGroup\": [\n {\n \"employeeId\": \"<string>\",\n \"payDetails\": {\n \"earnings\": [\n {\n \"amount\": 1,\n \"earningFrequency\": \"month\",\n \"isLumpsum\": false\n }\n ],\n \"benefits\": [\n {\n \"amount\": \"0.00\",\n \"makeGoodAmount\": \"0.00\",\n \"foregoneAmount\": \"0.00\"\n }\n ],\n \"deductions\": [\n {\n \"name\": \"<string>\",\n \"amount\": 1\n }\n ],\n \"reimbursements\": [\n {\n \"name\": \"<string>\",\n \"amount\": 1\n }\n ]\n }\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.intermezzo.ai/gb/payroll/{payrun_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"payrollGroup\": [\n {\n \"employeeId\": \"<string>\",\n \"payDetails\": {\n \"earnings\": [\n {\n \"amount\": 1,\n \"earningFrequency\": \"month\",\n \"isLumpsum\": false\n }\n ],\n \"benefits\": [\n {\n \"amount\": \"0.00\",\n \"makeGoodAmount\": \"0.00\",\n \"foregoneAmount\": \"0.00\"\n }\n ],\n \"deductions\": [\n {\n \"name\": \"<string>\",\n \"amount\": 1\n }\n ],\n \"reimbursements\": [\n {\n \"name\": \"<string>\",\n \"amount\": 1\n }\n ]\n }\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"run": {
"id": "<string>",
"externalRef": "<string>"
},
"payslips": [
{
"employeeId": "<string>",
"currentPayPeriod": {
"employee": {
"totals": {
"grossWages": "0.00",
"netWages": "0.00",
"totalDeductions": "0.00",
"totalReimbursements": "0.00",
"netPay": "0.00"
},
"benefits": {
"benefitsInKind": "0.00"
},
"taxes": {
"incomeTaxAssessmentBase": "0.00",
"incomeTax": "0.00"
},
"insurance": {
"insuranceAssessmentBase": "0.00",
"nationalInsurance": "0.00"
},
"deductions": [
{
"name": "<string>",
"amount": "0.00"
}
],
"reimbursements": [
{
"name": "<string>",
"amount": "0.00"
}
]
},
"employer": {
"secondaryClass1Nic": "0.00",
"class1ANic": "0.00",
"employerPensionContribution": "0.00"
}
},
"paymentPeriod": "Month"
}
],
"errors": [
{
"employeeId": "<string>",
"error": "<string>"
}
]
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Great Britain Paycheck Calculator
Update Payroll
PATCH
/
gb
/
payroll
/
{payrun_id}
Update Payroll
curl --request PATCH \
--url https://sandbox.intermezzo.ai/gb/payroll/{payrun_id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"payrollGroup": [
{
"employeeId": "<string>",
"payDetails": {
"earnings": [
{
"amount": 1,
"earningFrequency": "month",
"isLumpsum": false
}
],
"benefits": [
{
"amount": "0.00",
"makeGoodAmount": "0.00",
"foregoneAmount": "0.00"
}
],
"deductions": [
{
"name": "<string>",
"amount": 1
}
],
"reimbursements": [
{
"name": "<string>",
"amount": 1
}
]
}
}
]
}
'import requests
url = "https://sandbox.intermezzo.ai/gb/payroll/{payrun_id}"
payload = { "payrollGroup": [
{
"employeeId": "<string>",
"payDetails": {
"earnings": [
{
"amount": 1,
"earningFrequency": "month",
"isLumpsum": False
}
],
"benefits": [
{
"amount": "0.00",
"makeGoodAmount": "0.00",
"foregoneAmount": "0.00"
}
],
"deductions": [
{
"name": "<string>",
"amount": 1
}
],
"reimbursements": [
{
"name": "<string>",
"amount": 1
}
]
}
}
] }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
payrollGroup: [
{
employeeId: '<string>',
payDetails: {
earnings: [{amount: 1, earningFrequency: 'month', isLumpsum: false}],
benefits: [{amount: '0.00', makeGoodAmount: '0.00', foregoneAmount: '0.00'}],
deductions: [{name: '<string>', amount: 1}],
reimbursements: [{name: '<string>', amount: 1}]
}
}
]
})
};
fetch('https://sandbox.intermezzo.ai/gb/payroll/{payrun_id}', 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://sandbox.intermezzo.ai/gb/payroll/{payrun_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'payrollGroup' => [
[
'employeeId' => '<string>',
'payDetails' => [
'earnings' => [
[
'amount' => 1,
'earningFrequency' => 'month',
'isLumpsum' => false
]
],
'benefits' => [
[
'amount' => '0.00',
'makeGoodAmount' => '0.00',
'foregoneAmount' => '0.00'
]
],
'deductions' => [
[
'name' => '<string>',
'amount' => 1
]
],
'reimbursements' => [
[
'name' => '<string>',
'amount' => 1
]
]
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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://sandbox.intermezzo.ai/gb/payroll/{payrun_id}"
payload := strings.NewReader("{\n \"payrollGroup\": [\n {\n \"employeeId\": \"<string>\",\n \"payDetails\": {\n \"earnings\": [\n {\n \"amount\": 1,\n \"earningFrequency\": \"month\",\n \"isLumpsum\": false\n }\n ],\n \"benefits\": [\n {\n \"amount\": \"0.00\",\n \"makeGoodAmount\": \"0.00\",\n \"foregoneAmount\": \"0.00\"\n }\n ],\n \"deductions\": [\n {\n \"name\": \"<string>\",\n \"amount\": 1\n }\n ],\n \"reimbursements\": [\n {\n \"name\": \"<string>\",\n \"amount\": 1\n }\n ]\n }\n }\n ]\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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.patch("https://sandbox.intermezzo.ai/gb/payroll/{payrun_id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"payrollGroup\": [\n {\n \"employeeId\": \"<string>\",\n \"payDetails\": {\n \"earnings\": [\n {\n \"amount\": 1,\n \"earningFrequency\": \"month\",\n \"isLumpsum\": false\n }\n ],\n \"benefits\": [\n {\n \"amount\": \"0.00\",\n \"makeGoodAmount\": \"0.00\",\n \"foregoneAmount\": \"0.00\"\n }\n ],\n \"deductions\": [\n {\n \"name\": \"<string>\",\n \"amount\": 1\n }\n ],\n \"reimbursements\": [\n {\n \"name\": \"<string>\",\n \"amount\": 1\n }\n ]\n }\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.intermezzo.ai/gb/payroll/{payrun_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"payrollGroup\": [\n {\n \"employeeId\": \"<string>\",\n \"payDetails\": {\n \"earnings\": [\n {\n \"amount\": 1,\n \"earningFrequency\": \"month\",\n \"isLumpsum\": false\n }\n ],\n \"benefits\": [\n {\n \"amount\": \"0.00\",\n \"makeGoodAmount\": \"0.00\",\n \"foregoneAmount\": \"0.00\"\n }\n ],\n \"deductions\": [\n {\n \"name\": \"<string>\",\n \"amount\": 1\n }\n ],\n \"reimbursements\": [\n {\n \"name\": \"<string>\",\n \"amount\": 1\n }\n ]\n }\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"run": {
"id": "<string>",
"externalRef": "<string>"
},
"payslips": [
{
"employeeId": "<string>",
"currentPayPeriod": {
"employee": {
"totals": {
"grossWages": "0.00",
"netWages": "0.00",
"totalDeductions": "0.00",
"totalReimbursements": "0.00",
"netPay": "0.00"
},
"benefits": {
"benefitsInKind": "0.00"
},
"taxes": {
"incomeTaxAssessmentBase": "0.00",
"incomeTax": "0.00"
},
"insurance": {
"insuranceAssessmentBase": "0.00",
"nationalInsurance": "0.00"
},
"deductions": [
{
"name": "<string>",
"amount": "0.00"
}
],
"reimbursements": [
{
"name": "<string>",
"amount": "0.00"
}
]
},
"employer": {
"secondaryClass1Nic": "0.00",
"class1ANic": "0.00",
"employerPensionContribution": "0.00"
}
},
"paymentPeriod": "Month"
}
],
"errors": [
{
"employeeId": "<string>",
"error": "<string>"
}
]
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Body
application/json
Was this page helpful?
⌘I