Core
- Organizations
- Employees
Germany Paycheck Calculator
UK Paycheck Calculator
USA Paycheck Calculator
UK Paycheck Calculator
Update Payroll
POST
/
uk
/
payrollrun
/
{payrun_id}
/
update
Copy
curl --request POST \
--url https://payroll.intermezzo.ai/uk/payrollrun/{payrun_id}/update \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"payCycle": "month",
"payDate": "2024-06-15",
"payrollGroup": [
{
"employeeId": 12345,
"nationalInsuranceCategory": "A",
"payDetails": {
"benefits": [
{
"amount": 450,
"makeGoodAmount": 100,
"name": "Company Car"
},
{
"amount": 125.5,
"name": "Medical Insurance"
},
{
"amount": 50,
"foregoneAmount": 0,
"makeGoodAmount": 25,
"name": "Professional Subscription"
},
{
"amount": 350,
"foregoneAmount": 500,
"makeGoodAmount": 0,
"name": "Other Benefit"
}
],
"deductions": [
{
"deductionType": "Student Loan",
"loanType": "Plan1"
},
{
"deductionType": "Postgraduate Loan"
},
{
"amount": 200,
"deductionType": "Other",
"name": "Withdrawal"
}
],
"earnings": [
{
"amount": 36000,
"earningFrequency": "year",
"earningType": "Salary",
"isLumpsum": false
},
{
"amount": 1000,
"earningFrequency": "year",
"earningType": "Bonus",
"isLumpsum": true
}
],
"reimbursements": [
{
"amount": 275.5,
"name": "Business Travel"
}
]
},
"taxCode": "1257L"
}
]
}'
Copy
{
"run": {
"runId": "<string>",
"externalRef": "<string>",
"status": "draft"
},
"payslips": [
{
"paymentPeriod": "Month",
"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"
}
}
}
],
"errors": [
{
"employeeId": "<string>",
"error": "<string>"
}
]
}
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Path Parameters
Query Parameters
Body
application/json
Input parameters
Response
200
application/json
Successful Response
The response is of type object
.
Was this page helpful?
Copy
curl --request POST \
--url https://payroll.intermezzo.ai/uk/payrollrun/{payrun_id}/update \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"payCycle": "month",
"payDate": "2024-06-15",
"payrollGroup": [
{
"employeeId": 12345,
"nationalInsuranceCategory": "A",
"payDetails": {
"benefits": [
{
"amount": 450,
"makeGoodAmount": 100,
"name": "Company Car"
},
{
"amount": 125.5,
"name": "Medical Insurance"
},
{
"amount": 50,
"foregoneAmount": 0,
"makeGoodAmount": 25,
"name": "Professional Subscription"
},
{
"amount": 350,
"foregoneAmount": 500,
"makeGoodAmount": 0,
"name": "Other Benefit"
}
],
"deductions": [
{
"deductionType": "Student Loan",
"loanType": "Plan1"
},
{
"deductionType": "Postgraduate Loan"
},
{
"amount": 200,
"deductionType": "Other",
"name": "Withdrawal"
}
],
"earnings": [
{
"amount": 36000,
"earningFrequency": "year",
"earningType": "Salary",
"isLumpsum": false
},
{
"amount": 1000,
"earningFrequency": "year",
"earningType": "Bonus",
"isLumpsum": true
}
],
"reimbursements": [
{
"amount": 275.5,
"name": "Business Travel"
}
]
},
"taxCode": "1257L"
}
]
}'
Copy
{
"run": {
"runId": "<string>",
"externalRef": "<string>",
"status": "draft"
},
"payslips": [
{
"paymentPeriod": "Month",
"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"
}
}
}
],
"errors": [
{
"employeeId": "<string>",
"error": "<string>"
}
]
}
Assistant
Responses are generated using AI and may contain mistakes.