Approve Payroll

curl --request POST \
  --url https://dev.intermezzo.ai/gb/organizations/{organization_id}/payrolls/{payroll_status_id}/approve \
  --header 'Authorization: Bearer <token>'

import requests

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

headers = {"Authorization": "Bearer <token>"}

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

print(response.text)

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

fetch('https://dev.intermezzo.ai/gb/organizations/{organization_id}/payrolls/{payroll_status_id}/approve', 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/{payroll_status_id}/approve",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

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

	req, _ := http.NewRequest("POST", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	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/{payroll_status_id}/approve")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "id": "<string>",
  "external_ref": "<string>",
  "status": "DRAFT",
  "status_id": "<string>"
}

Approve Payroll

Approve a payrun for GB employees.

This endpoint approves the payrun and updates GB-specific cumulative values (YTD gross, tax, taxable pay, allowances, and pension contributions).

Both operations run within a single transaction - if cumulative values update fails, the payrun approval will be rolled back.

If any payslips have NMW compliance warnings, approval is blocked unless force_approve=True is passed to acknowledge the violations.

Approval is rejected (409 UNFINISHED_PAYRUN) while another approved payrun that pays an employee of this one has not yet succeeded, and (409 HMRC_CREDENTIALS_NOT_CONFIGURED) while the organization has no HMRC credentials.

Approval is refused (422) when an employee’s first FPS would carry a starter block HMRC rejects.

POST

organizations

{organization_id}

payrolls

{payroll_status_id}

approve

Approve Payroll

curl --request POST \
  --url https://dev.intermezzo.ai/gb/organizations/{organization_id}/payrolls/{payroll_status_id}/approve \
  --header 'Authorization: Bearer <token>'

import requests

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

headers = {"Authorization": "Bearer <token>"}

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

print(response.text)

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

fetch('https://dev.intermezzo.ai/gb/organizations/{organization_id}/payrolls/{payroll_status_id}/approve', 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/{payroll_status_id}/approve",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

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

	req, _ := http.NewRequest("POST", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	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/{payroll_status_id}/approve")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "id": "<string>",
  "external_ref": "<string>",
  "status": "DRAFT",
  "status_id": "<string>"
}

Authorizations

Authorization

string

header

required

Get token from Auth0 and paste it here

Path Parameters

payroll_status_id

string

required

organization_id

string

required

Query Parameters

force_approve

boolean

default:false

Acknowledge NMW violations and approve anyway

Response

Successful Response

string

required

external_ref

string | null

required

status

enum<string>

required

Payrun status

Available options:

DRAFT,

PROCESSING,

APPROVED,

PAID

status_id

string

required

Core

Great Britain

Approve Payroll

Authorizations

Path Parameters

Query Parameters

Response