Skip to main content
POST
/
gb
/
payroll
Run Payroll
curl --request POST \
  --url https://sandbox.intermezzo.ai/gb/payroll \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "payDate": "2023-12-25",
  "payCycle": "year",
  "externalRef": "<string>",
  "payrollGroup": [
    {
      "employeeId": "<string>",
      "payDetails": {
        "earnings": [
          {
            "earningType": "Salary",
            "amount": 1,
            "earningFrequency": "year",
            "isLumpsum": true
          }
        ],
        "benefits": [
          {
            "name": "Company Car",
            "amount": 1,
            "makeGoodAmount": 1,
            "foregoneAmount": 1
          }
        ],
        "deductions": [
          {
            "name": "<string>",
            "amount": 1
          }
        ],
        "reimbursements": [
          {
            "name": "<string>",
            "amount": 1
          }
        ]
      }
    }
  ]
}'
{
  "run": {
    "id": "<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

Authorization
string
header
required

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

Body

application/json

Input parameters

payCycle
enum<string>
required
Available options:
year,
month,
week
payrollGroup
PayrollRequestBase · object[]
required
payDate
string<date>

Payment Date for this payroll

externalRef
string | null

External reference for payroll run

Response

Successful Response

run
object | null
required
payslips
Payslip · object[]
required
errors
Errors · object[] | null
required
I