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 '
{
  "payroll_group": [
    {
      "employee_id": "<string>",
      "pay_details": {
        "earnings": [
          {
            "wage_type_code": "<string>",
            "amount": 123,
            "earning_type": "AMOUNT",
            "earning_frequency": "MONTH",
            "is_lumpsum": false,
            "sacrificed_amount": 1
          }
        ],
        "benefits": [
          {
            "wage_type_code": "<string>",
            "amount": "0.00",
            "make_good_amount": "0.00",
            "foregone_amount": "0.00",
            "cash_alternative_amount": "0.00"
          }
        ],
        "deductions": [
          {
            "name": "<string>",
            "amount": 1,
            "wage_type_code": "<string>",
            "sacrificed_amount": 1
          }
        ],
        "reimbursements": [
          {
            "wage_type_code": "<string>",
            "amount": 1
          }
        ]
      },
      "nic_prior_period_niable_earnings": [
        123
      ]
    }
  ],
  "pay_group_id": "<string>",
  "pay_calendar_id": "<string>"
}
'
import requests

url = "https://dev.intermezzo.ai/gb/organizations/{organization_id}/payrolls"

payload = {
    "payroll_group": [
        {
            "employee_id": "<string>",
            "pay_details": {
                "earnings": [
                    {
                        "wage_type_code": "<string>",
                        "amount": 123,
                        "earning_type": "AMOUNT",
                        "earning_frequency": "MONTH",
                        "is_lumpsum": False,
                        "sacrificed_amount": 1
                    }
                ],
                "benefits": [
                    {
                        "wage_type_code": "<string>",
                        "amount": "0.00",
                        "make_good_amount": "0.00",
                        "foregone_amount": "0.00",
                        "cash_alternative_amount": "0.00"
                    }
                ],
                "deductions": [
                    {
                        "name": "<string>",
                        "amount": 1,
                        "wage_type_code": "<string>",
                        "sacrificed_amount": 1
                    }
                ],
                "reimbursements": [
                    {
                        "wage_type_code": "<string>",
                        "amount": 1
                    }
                ]
            },
            "nic_prior_period_niable_earnings": [123]
        }
    ],
    "pay_group_id": "<string>",
    "pay_calendar_id": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    payroll_group: [
      {
        employee_id: '<string>',
        pay_details: {
          earnings: [
            {
              wage_type_code: '<string>',
              amount: 123,
              earning_type: 'AMOUNT',
              earning_frequency: 'MONTH',
              is_lumpsum: false,
              sacrificed_amount: 1
            }
          ],
          benefits: [
            {
              wage_type_code: '<string>',
              amount: '0.00',
              make_good_amount: '0.00',
              foregone_amount: '0.00',
              cash_alternative_amount: '0.00'
            }
          ],
          deductions: [
            {name: '<string>', amount: 1, wage_type_code: '<string>', sacrificed_amount: 1}
          ],
          reimbursements: [{wage_type_code: '<string>', amount: 1}]
        },
        nic_prior_period_niable_earnings: [123]
      }
    ],
    pay_group_id: '<string>',
    pay_calendar_id: '<string>'
  })
};

fetch('https://dev.intermezzo.ai/gb/organizations/{organization_id}/payrolls', 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://dev.intermezzo.ai/gb/organizations/{organization_id}/payrolls",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'payroll_group' => [
        [
                'employee_id' => '<string>',
                'pay_details' => [
                                'earnings' => [
                                                                [
                                                                                                                                'wage_type_code' => '<string>',
                                                                                                                                'amount' => 123,
                                                                                                                                'earning_type' => 'AMOUNT',
                                                                                                                                'earning_frequency' => 'MONTH',
                                                                                                                                'is_lumpsum' => false,
                                                                                                                                'sacrificed_amount' => 1
                                                                ]
                                ],
                                'benefits' => [
                                                                [
                                                                                                                                'wage_type_code' => '<string>',
                                                                                                                                'amount' => '0.00',
                                                                                                                                'make_good_amount' => '0.00',
                                                                                                                                'foregone_amount' => '0.00',
                                                                                                                                'cash_alternative_amount' => '0.00'
                                                                ]
                                ],
                                'deductions' => [
                                                                [
                                                                                                                                'name' => '<string>',
                                                                                                                                'amount' => 1,
                                                                                                                                'wage_type_code' => '<string>',
                                                                                                                                'sacrificed_amount' => 1
                                                                ]
                                ],
                                'reimbursements' => [
                                                                [
                                                                                                                                'wage_type_code' => '<string>',
                                                                                                                                'amount' => 1
                                                                ]
                                ]
                ],
                'nic_prior_period_niable_earnings' => [
                                123
                ]
        ]
    ],
    'pay_group_id' => '<string>',
    'pay_calendar_id' => '<string>'
  ]),
  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://dev.intermezzo.ai/gb/organizations/{organization_id}/payrolls"

	payload := strings.NewReader("{\n  \"payroll_group\": [\n    {\n      \"employee_id\": \"<string>\",\n      \"pay_details\": {\n        \"earnings\": [\n          {\n            \"wage_type_code\": \"<string>\",\n            \"amount\": 123,\n            \"earning_type\": \"AMOUNT\",\n            \"earning_frequency\": \"MONTH\",\n            \"is_lumpsum\": false,\n            \"sacrificed_amount\": 1\n          }\n        ],\n        \"benefits\": [\n          {\n            \"wage_type_code\": \"<string>\",\n            \"amount\": \"0.00\",\n            \"make_good_amount\": \"0.00\",\n            \"foregone_amount\": \"0.00\",\n            \"cash_alternative_amount\": \"0.00\"\n          }\n        ],\n        \"deductions\": [\n          {\n            \"name\": \"<string>\",\n            \"amount\": 1,\n            \"wage_type_code\": \"<string>\",\n            \"sacrificed_amount\": 1\n          }\n        ],\n        \"reimbursements\": [\n          {\n            \"wage_type_code\": \"<string>\",\n            \"amount\": 1\n          }\n        ]\n      },\n      \"nic_prior_period_niable_earnings\": [\n        123\n      ]\n    }\n  ],\n  \"pay_group_id\": \"<string>\",\n  \"pay_calendar_id\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", 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.post("https://dev.intermezzo.ai/gb/organizations/{organization_id}/payrolls")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"payroll_group\": [\n    {\n      \"employee_id\": \"<string>\",\n      \"pay_details\": {\n        \"earnings\": [\n          {\n            \"wage_type_code\": \"<string>\",\n            \"amount\": 123,\n            \"earning_type\": \"AMOUNT\",\n            \"earning_frequency\": \"MONTH\",\n            \"is_lumpsum\": false,\n            \"sacrificed_amount\": 1\n          }\n        ],\n        \"benefits\": [\n          {\n            \"wage_type_code\": \"<string>\",\n            \"amount\": \"0.00\",\n            \"make_good_amount\": \"0.00\",\n            \"foregone_amount\": \"0.00\",\n            \"cash_alternative_amount\": \"0.00\"\n          }\n        ],\n        \"deductions\": [\n          {\n            \"name\": \"<string>\",\n            \"amount\": 1,\n            \"wage_type_code\": \"<string>\",\n            \"sacrificed_amount\": 1\n          }\n        ],\n        \"reimbursements\": [\n          {\n            \"wage_type_code\": \"<string>\",\n            \"amount\": 1\n          }\n        ]\n      },\n      \"nic_prior_period_niable_earnings\": [\n        123\n      ]\n    }\n  ],\n  \"pay_group_id\": \"<string>\",\n  \"pay_calendar_id\": \"<string>\"\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://dev.intermezzo.ai/gb/organizations/{organization_id}/payrolls")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"payroll_group\": [\n    {\n      \"employee_id\": \"<string>\",\n      \"pay_details\": {\n        \"earnings\": [\n          {\n            \"wage_type_code\": \"<string>\",\n            \"amount\": 123,\n            \"earning_type\": \"AMOUNT\",\n            \"earning_frequency\": \"MONTH\",\n            \"is_lumpsum\": false,\n            \"sacrificed_amount\": 1\n          }\n        ],\n        \"benefits\": [\n          {\n            \"wage_type_code\": \"<string>\",\n            \"amount\": \"0.00\",\n            \"make_good_amount\": \"0.00\",\n            \"foregone_amount\": \"0.00\",\n            \"cash_alternative_amount\": \"0.00\"\n          }\n        ],\n        \"deductions\": [\n          {\n            \"name\": \"<string>\",\n            \"amount\": 1,\n            \"wage_type_code\": \"<string>\",\n            \"sacrificed_amount\": 1\n          }\n        ],\n        \"reimbursements\": [\n          {\n            \"wage_type_code\": \"<string>\",\n            \"amount\": 1\n          }\n        ]\n      },\n      \"nic_prior_period_niable_earnings\": [\n        123\n      ]\n    }\n  ],\n  \"pay_group_id\": \"<string>\",\n  \"pay_calendar_id\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body
{
  "task_id": "<string>",
  "payroll_status_id": "<string>"
}
{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<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

​
payroll_group
PayrollRequestBase · object[]
required
​
pay_group_id
required
​
pay_calendar_id
required
​
external_ref
string | null

External reference for payroll run

Response

Successful Response

​
task_id
string
required
​
status
enum<string>
required

Payrun status

Available options:
draft,
processing,
approved,
paid
​
payroll_status_id
string
required