Skip to main content
POST
/
gb
/
organizations
/
{organization_id}
/
payrolls
Run Payroll
curl --request POST \
  --url https://dev.intermezzo.ai/gb/organizations/{organization_id}/payrolls \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "payrollGroup": [
    {
      "employeeId": "<string>",
      "payDetails": {
        "earnings": [
          {
            "wageTypeCode": "<string>",
            "amount": 1,
            "earningFrequency": "MONTH",
            "isLumpsum": false
          }
        ],
        "benefits": [
          {
            "wageTypeCode": "<string>",
            "amount": "0.00",
            "makeGoodAmount": "0.00",
            "foregoneAmount": "0.00"
          }
        ],
        "deductions": [
          {
            "name": "<string>",
            "amount": 1
          }
        ],
        "reimbursements": [
          {
            "wageTypeCode": "<string>",
            "amount": 1
          }
        ]
      }
    }
  ],
  "payGroupId": "<string>",
  "payCalendarId": "<string>"
}
'
{
  "taskId": "<string>",
  "status": "draft",
  "payrollStatusId": "<string>"
}

Authorizations

Authorization
string
header
required

Get token from Auth0 and paste it here

Headers

X-Include-Execution-History
boolean
default:false

Path Parameters

organization_id
required

Body

application/json

Input parameters

payrollGroup
PayrollRequestBase · object[]
required
payGroupId
required
payCalendarId
required
externalRef
string | null

External reference for payroll run

Response

Successful Response

taskId
string
required
status
enum<string>
required

Payrun status

Available options:
draft,
processing,
approved,
paid
payrollStatusId
string
required