Update Payroll

curl --request PATCH \
  --url https://sandbox.intermezzo.ai/gb/payroll/{payrun_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "payCycle": "year",
  "payrollGroup": [
    {
      "employeeId": "<string>",
      "payDetails": {
        "earnings": [
          {
            "earningType": "Salary",
            "amount": 1,
            "earningFrequency": "month",
            "isLumpsum": false
          }
        ],
        "benefits": [
          {
            "name": "Company Car",
            "amount": "0.00",
            "makeGoodAmount": "0.00",
            "foregoneAmount": "0.00"
          }
        ],
        "deductions": [
          {
            "name": "<string>",
            "amount": 1
          }
        ],
        "reimbursements": [
          {
            "name": "<string>",
            "amount": 1
          }
        ]
      }
    }
  ],
  "payDate": "2023-12-25",
  "externalRef": "<string>"
}
'

{
  "run": {
    "id": "<string>",
    "externalRef": "<string>",
    "status": "draft"
  },
  "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>"
    }
  ]
}

PATCH

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 '
{
  "payCycle": "year",
  "payrollGroup": [
    {
      "employeeId": "<string>",
      "payDetails": {
        "earnings": [
          {
            "earningType": "Salary",
            "amount": 1,
            "earningFrequency": "month",
            "isLumpsum": false
          }
        ],
        "benefits": [
          {
            "name": "Company Car",
            "amount": "0.00",
            "makeGoodAmount": "0.00",
            "foregoneAmount": "0.00"
          }
        ],
        "deductions": [
          {
            "name": "<string>",
            "amount": 1
          }
        ],
        "reimbursements": [
          {
            "name": "<string>",
            "amount": 1
          }
        ]
      }
    }
  ],
  "payDate": "2023-12-25",
  "externalRef": "<string>"
}
'

{
  "run": {
    "id": "<string>",
    "externalRef": "<string>",
    "status": "draft"
  },
  "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>"
    }
  ]
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

payrun_id

required

Body

application/json

Input parameters

payCycle

enum<string>

required

Available options:

year,

month,

week

payrollGroup

PayrollRequestBase · object[]

required

Show child attributes

payrollGroup.employeeId

required

Employee identification number

payrollGroup.payDetails

Gross · object

required

Show child attributes

payrollGroup.payDetails.earnings

Earnings · object[] | null

required

Show child attributes

payrollGroup.payDetails.earnings.earningType

enum<string>

required

Available options:

Salary,

Commissions,

Bonus,

Allowances,

Other

payrollGroup.payDetails.earnings.amount

required

Earnings amount (taxable gross)

Required range: x >= 0

payrollGroup.payDetails.earnings.earningFrequency

enum<string> | null

default:month

If recurring, specify the frequency

Available options:

year,

month,

week

payrollGroup.payDetails.earnings.isLumpsum

boolean | null

default:false

True if onetime. Defaults to False

payrollGroup.payDetails.benefits

Benefits · object[] | null

required

Show child attributes

payrollGroup.payDetails.benefits.name

enum<string>

required

Available options:

Company Car,

Car Fuel,

Van,

Van Fuel,

Living Accommodation,

Beneficial Loan,

Medical Insurance,

Asset Transferred,

Asset Available,

Mileage Allowance,

Entertainment,

Credit Card,

Vouchers,

Telephone,

Mobile Telephone,

Relocation Expenses,

Services Provided,

Professional Subscription,

Other Benefit,

School Fees,

Educational Assistance,

Childcare,

Holiday,

Non-Executive Director Fees,

Scholarships

payrollGroup.payDetails.benefits.amount

default:0.00

Amount of benefit

Required range: x >= 0

payrollGroup.payDetails.benefits.makeGoodAmount

default:0.00

Amount paid by employee for the benefit

Required range: x >= 0

payrollGroup.payDetails.benefits.foregoneAmount

default:0.00

If subject to OpRa, amount foregone

Required range: x >= 0

payrollGroup.payDetails.deductions

Deductions · object[] | null

Show child attributes

payrollGroup.payDetails.deductions.name

string

required

payrollGroup.payDetails.deductions.amount

required

Required range: x >= 0

payrollGroup.payDetails.reimbursements

Reimbursement · object[] | null

Show child attributes

payrollGroup.payDetails.reimbursements.name

string

required

payrollGroup.payDetails.reimbursements.amount

required

Required range: x >= 0

payDate

string<date>

Payment Date for this payroll

externalRef

string | null

External reference for payroll run

Response

Successful Response

run

RunDetails · object

required

Show child attributes

run.id

string

required

run.externalRef

string | null

required

run.status

enum<string>

required

Payrun status

Available options:

draft,

approved,

paid

payslips

Payslip · object[]

required

Show child attributes

payslips.employeeId

string

required

payslips.currentPayPeriod

CurrentPayPeriod · object

required

Show child attributes

payslips.currentPayPeriod.employee

EmployeeCurrentPayPeriod · object

Show child attributes

payslips.currentPayPeriod.employee.totals

EmployeeTotals · object

Show child attributes

payslips.currentPayPeriod.employee.totals.grossWages

string

default:0.00

payslips.currentPayPeriod.employee.totals.netWages

string

default:0.00

payslips.currentPayPeriod.employee.totals.totalDeductions

string

default:0.00

payslips.currentPayPeriod.employee.totals.totalReimbursements

string

default:0.00

payslips.currentPayPeriod.employee.totals.netPay

string

default:0.00

payslips.currentPayPeriod.employee.benefits

EmployeeBenefits · object

Show child attributes

payslips.currentPayPeriod.employee.benefits.benefitsInKind

string

default:0.00

payslips.currentPayPeriod.employee.taxes

EmployeeTaxes · object

Show child attributes

payslips.currentPayPeriod.employee.taxes.incomeTaxAssessmentBase

string

default:0.00

payslips.currentPayPeriod.employee.taxes.incomeTax

string

default:0.00

payslips.currentPayPeriod.employee.insurance

EmployeeInsurance · object

Show child attributes

payslips.currentPayPeriod.employee.insurance.insuranceAssessmentBase

string

default:0.00

payslips.currentPayPeriod.employee.insurance.nationalInsurance

string

default:0.00

payslips.currentPayPeriod.employee.deductions

DeductionsResponse · object[]

Show child attributes

payslips.currentPayPeriod.employee.deductions.name

string | null

payslips.currentPayPeriod.employee.deductions.amount

string

default:0.00

payslips.currentPayPeriod.employee.reimbursements

ReimbursementResponse · object[] | null

Show child attributes

payslips.currentPayPeriod.employee.reimbursements.name

string | null

payslips.currentPayPeriod.employee.reimbursements.amount

string

default:0.00

payslips.currentPayPeriod.employer

EmployerCurrentPayPeriod · object

Show child attributes

payslips.currentPayPeriod.employer.secondaryClass1Nic

string

default:0.00

payslips.currentPayPeriod.employer.class1ANic

string

default:0.00

payslips.currentPayPeriod.employer.employerPensionContribution

string

default:0.00

payslips.paymentPeriod

enum<string>

default:Month

Available options:

Year,

Month,

Week,

Day

errors

Errors · object[] | null

required

Show child attributes

errors.employeeId

required

errors.error

string

required

Run Payroll

Approve Payroll

⌘I

Core

Germany

Great Britain

Update Payroll

Authorizations

Path Parameters

Body

Response