Create Employees

curl --request POST \
  --url https://preview.intermezzo.ai/gb/organizations/{organization_id}/employees/list \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
[
  {
    "valid_from": "2023-12-25",
    "external_ref": "<string>",
    "core": {
      "employee_name": "John Smith",
      "birth_date": "2023-12-25",
      "personal_email": "jsmith@example.com",
      "work_email": "jsmith@example.com",
      "phone_numbers": [
        {
          "phone_number": "<string>",
          "is_primary": false
        }
      ]
    },
    "address": {
      "address": "10 Downing Street, London, SW1A 2AA"
    },
    "job": {
      "start_date": "2023-12-25",
      "contracted_weekly_hours": 40,
      "department": "<string>",
      "contracted_weekdays": [],
      "worker_type": "EMPLOYEE",
      "director_since": "2023-12-25",
      "pay_basis": "SALARIED",
      "apprenticeship": {
        "start_date": "2023-12-25",
        "level": 4,
        "expected_end_date": "2023-12-25"
      },
      "p45_issued": false,
      "irregular_payment_pattern": false,
      "ordinarily_works_in_uk": true,
      "proration_basis": {
        "business_days_per_year": 123
      }
    },
    "tax": {
      "tax_code": "1257L",
      "rti_id": "<string>",
      "postgraduate_loan": false,
      "p45_gross_pay": "0.00",
      "p45_tax_amount": "0.00"
    },
    "insurance": {
      "national_insurance_number": "<string>"
    },
    "compensation": {
      "pay_group_id": "<string>",
      "earnings": [
        {
          "wage_type_code": "<string>",
          "amount": 123,
          "external_ref": "<string>",
          "earning_type": "AMOUNT",
          "earning_frequency": "MONTH",
          "is_lumpsum": false,
          "sacrificed_amount": 1
        }
      ],
      "benefits": [
        {
          "wage_type_code": "<string>",
          "external_ref": "<string>",
          "amount": "0.00",
          "make_good_amount": "0.00",
          "foregone_amount": "0.00",
          "cash_alternative_amount": "0.00"
        }
      ],
      "deductions": [
        {
          "wage_type_code": "<string>",
          "amount": 1,
          "external_ref": "<string>",
          "sacrificed_amount": 1
        }
      ],
      "reimbursements": [
        {
          "wage_type_code": "<string>",
          "amount": 1,
          "external_ref": "<string>"
        }
      ]
    },
    "bank": {
      "accounts": [
        {
          "account_number": "31926819",
          "sort_code": "200015",
          "financial_institution_name": "Lloyds Bank",
          "is_primary": false,
          "is_active": true,
          "allocation_percentage": 50
        }
      ]
    }
  }
]
'

import requests

url = "https://preview.intermezzo.ai/gb/organizations/{organization_id}/employees/list"

payload = [
    {
        "valid_from": "2023-12-25",
        "external_ref": "<string>",
        "core": {
            "employee_name": "John Smith",
            "birth_date": "2023-12-25",
            "personal_email": "jsmith@example.com",
            "work_email": "jsmith@example.com",
            "phone_numbers": [
                {
                    "phone_number": "<string>",
                    "is_primary": False
                }
            ]
        },
        "address": { "address": "10 Downing Street, London, SW1A 2AA" },
        "job": {
            "start_date": "2023-12-25",
            "contracted_weekly_hours": 40,
            "department": "<string>",
            "contracted_weekdays": [],
            "worker_type": "EMPLOYEE",
            "director_since": "2023-12-25",
            "pay_basis": "SALARIED",
            "apprenticeship": {
                "start_date": "2023-12-25",
                "level": 4,
                "expected_end_date": "2023-12-25"
            },
            "p45_issued": False,
            "irregular_payment_pattern": False,
            "ordinarily_works_in_uk": True,
            "proration_basis": { "business_days_per_year": 123 }
        },
        "tax": {
            "tax_code": "1257L",
            "rti_id": "<string>",
            "postgraduate_loan": False,
            "p45_gross_pay": "0.00",
            "p45_tax_amount": "0.00"
        },
        "insurance": { "national_insurance_number": "<string>" },
        "compensation": {
            "pay_group_id": "<string>",
            "earnings": [
                {
                    "wage_type_code": "<string>",
                    "amount": 123,
                    "external_ref": "<string>",
                    "earning_type": "AMOUNT",
                    "earning_frequency": "MONTH",
                    "is_lumpsum": False,
                    "sacrificed_amount": 1
                }
            ],
            "benefits": [
                {
                    "wage_type_code": "<string>",
                    "external_ref": "<string>",
                    "amount": "0.00",
                    "make_good_amount": "0.00",
                    "foregone_amount": "0.00",
                    "cash_alternative_amount": "0.00"
                }
            ],
            "deductions": [
                {
                    "wage_type_code": "<string>",
                    "amount": 1,
                    "external_ref": "<string>",
                    "sacrificed_amount": 1
                }
            ],
            "reimbursements": [
                {
                    "wage_type_code": "<string>",
                    "amount": 1,
                    "external_ref": "<string>"
                }
            ]
        },
        "bank": { "accounts": [
                {
                    "account_number": "31926819",
                    "sort_code": "200015",
                    "financial_institution_name": "Lloyds Bank",
                    "is_primary": False,
                    "is_active": True,
                    "allocation_percentage": 50
                }
            ] }
    }
]
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([
    {
      valid_from: '2023-12-25',
      external_ref: '<string>',
      core: {
        employee_name: 'John Smith',
        birth_date: '2023-12-25',
        personal_email: 'jsmith@example.com',
        work_email: 'jsmith@example.com',
        phone_numbers: [{phone_number: '<string>', is_primary: false}]
      },
      address: {address: '10 Downing Street, London, SW1A 2AA'},
      job: {
        start_date: '2023-12-25',
        contracted_weekly_hours: 40,
        department: '<string>',
        contracted_weekdays: [],
        worker_type: 'EMPLOYEE',
        director_since: '2023-12-25',
        pay_basis: 'SALARIED',
        apprenticeship: {start_date: '2023-12-25', level: 4, expected_end_date: '2023-12-25'},
        p45_issued: false,
        irregular_payment_pattern: false,
        ordinarily_works_in_uk: true,
        proration_basis: {business_days_per_year: 123}
      },
      tax: {
        tax_code: '1257L',
        rti_id: '<string>',
        postgraduate_loan: false,
        p45_gross_pay: '0.00',
        p45_tax_amount: '0.00'
      },
      insurance: {national_insurance_number: '<string>'},
      compensation: {
        pay_group_id: '<string>',
        earnings: [
          {
            wage_type_code: '<string>',
            amount: 123,
            external_ref: '<string>',
            earning_type: 'AMOUNT',
            earning_frequency: 'MONTH',
            is_lumpsum: false,
            sacrificed_amount: 1
          }
        ],
        benefits: [
          {
            wage_type_code: '<string>',
            external_ref: '<string>',
            amount: '0.00',
            make_good_amount: '0.00',
            foregone_amount: '0.00',
            cash_alternative_amount: '0.00'
          }
        ],
        deductions: [
          {
            wage_type_code: '<string>',
            amount: 1,
            external_ref: '<string>',
            sacrificed_amount: 1
          }
        ],
        reimbursements: [{wage_type_code: '<string>', amount: 1, external_ref: '<string>'}]
      },
      bank: {
        accounts: [
          {
            account_number: '31926819',
            sort_code: '200015',
            financial_institution_name: 'Lloyds Bank',
            is_primary: false,
            is_active: true,
            allocation_percentage: 50
          }
        ]
      }
    }
  ])
};

fetch('https://preview.intermezzo.ai/gb/organizations/{organization_id}/employees/list', 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://preview.intermezzo.ai/gb/organizations/{organization_id}/employees/list",
  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([
    [
        'valid_from' => '2023-12-25',
        'external_ref' => '<string>',
        'core' => [
                'employee_name' => 'John Smith',
                'birth_date' => '2023-12-25',
                'personal_email' => 'jsmith@example.com',
                'work_email' => 'jsmith@example.com',
                'phone_numbers' => [
                                [
                                                                'phone_number' => '<string>',
                                                                'is_primary' => false
                                ]
                ]
        ],
        'address' => [
                'address' => '10 Downing Street, London, SW1A 2AA'
        ],
        'job' => [
                'start_date' => '2023-12-25',
                'contracted_weekly_hours' => 40,
                'department' => '<string>',
                'contracted_weekdays' => [
                                
                ],
                'worker_type' => 'EMPLOYEE',
                'director_since' => '2023-12-25',
                'pay_basis' => 'SALARIED',
                'apprenticeship' => [
                                'start_date' => '2023-12-25',
                                'level' => 4,
                                'expected_end_date' => '2023-12-25'
                ],
                'p45_issued' => false,
                'irregular_payment_pattern' => false,
                'ordinarily_works_in_uk' => true,
                'proration_basis' => [
                                'business_days_per_year' => 123
                ]
        ],
        'tax' => [
                'tax_code' => '1257L',
                'rti_id' => '<string>',
                'postgraduate_loan' => false,
                'p45_gross_pay' => '0.00',
                'p45_tax_amount' => '0.00'
        ],
        'insurance' => [
                'national_insurance_number' => '<string>'
        ],
        'compensation' => [
                'pay_group_id' => '<string>',
                'earnings' => [
                                [
                                                                'wage_type_code' => '<string>',
                                                                'amount' => 123,
                                                                'external_ref' => '<string>',
                                                                'earning_type' => 'AMOUNT',
                                                                'earning_frequency' => 'MONTH',
                                                                'is_lumpsum' => false,
                                                                'sacrificed_amount' => 1
                                ]
                ],
                'benefits' => [
                                [
                                                                'wage_type_code' => '<string>',
                                                                'external_ref' => '<string>',
                                                                'amount' => '0.00',
                                                                'make_good_amount' => '0.00',
                                                                'foregone_amount' => '0.00',
                                                                'cash_alternative_amount' => '0.00'
                                ]
                ],
                'deductions' => [
                                [
                                                                'wage_type_code' => '<string>',
                                                                'amount' => 1,
                                                                'external_ref' => '<string>',
                                                                'sacrificed_amount' => 1
                                ]
                ],
                'reimbursements' => [
                                [
                                                                'wage_type_code' => '<string>',
                                                                'amount' => 1,
                                                                'external_ref' => '<string>'
                                ]
                ]
        ],
        'bank' => [
                'accounts' => [
                                [
                                                                'account_number' => '31926819',
                                                                'sort_code' => '200015',
                                                                'financial_institution_name' => 'Lloyds Bank',
                                                                'is_primary' => false,
                                                                'is_active' => true,
                                                                'allocation_percentage' => 50
                                ]
                ]
        ]
    ]
  ]),
  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://preview.intermezzo.ai/gb/organizations/{organization_id}/employees/list"

	payload := strings.NewReader("[\n  {\n    \"valid_from\": \"2023-12-25\",\n    \"external_ref\": \"<string>\",\n    \"core\": {\n      \"employee_name\": \"John Smith\",\n      \"birth_date\": \"2023-12-25\",\n      \"personal_email\": \"jsmith@example.com\",\n      \"work_email\": \"jsmith@example.com\",\n      \"phone_numbers\": [\n        {\n          \"phone_number\": \"<string>\",\n          \"is_primary\": false\n        }\n      ]\n    },\n    \"address\": {\n      \"address\": \"10 Downing Street, London, SW1A 2AA\"\n    },\n    \"job\": {\n      \"start_date\": \"2023-12-25\",\n      \"contracted_weekly_hours\": 40,\n      \"department\": \"<string>\",\n      \"contracted_weekdays\": [],\n      \"worker_type\": \"EMPLOYEE\",\n      \"director_since\": \"2023-12-25\",\n      \"pay_basis\": \"SALARIED\",\n      \"apprenticeship\": {\n        \"start_date\": \"2023-12-25\",\n        \"level\": 4,\n        \"expected_end_date\": \"2023-12-25\"\n      },\n      \"p45_issued\": false,\n      \"irregular_payment_pattern\": false,\n      \"ordinarily_works_in_uk\": true,\n      \"proration_basis\": {\n        \"business_days_per_year\": 123\n      }\n    },\n    \"tax\": {\n      \"tax_code\": \"1257L\",\n      \"rti_id\": \"<string>\",\n      \"postgraduate_loan\": false,\n      \"p45_gross_pay\": \"0.00\",\n      \"p45_tax_amount\": \"0.00\"\n    },\n    \"insurance\": {\n      \"national_insurance_number\": \"<string>\"\n    },\n    \"compensation\": {\n      \"pay_group_id\": \"<string>\",\n      \"earnings\": [\n        {\n          \"wage_type_code\": \"<string>\",\n          \"amount\": 123,\n          \"external_ref\": \"<string>\",\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          \"external_ref\": \"<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          \"wage_type_code\": \"<string>\",\n          \"amount\": 1,\n          \"external_ref\": \"<string>\",\n          \"sacrificed_amount\": 1\n        }\n      ],\n      \"reimbursements\": [\n        {\n          \"wage_type_code\": \"<string>\",\n          \"amount\": 1,\n          \"external_ref\": \"<string>\"\n        }\n      ]\n    },\n    \"bank\": {\n      \"accounts\": [\n        {\n          \"account_number\": \"31926819\",\n          \"sort_code\": \"200015\",\n          \"financial_institution_name\": \"Lloyds Bank\",\n          \"is_primary\": false,\n          \"is_active\": true,\n          \"allocation_percentage\": 50\n        }\n      ]\n    }\n  }\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://preview.intermezzo.ai/gb/organizations/{organization_id}/employees/list")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("[\n  {\n    \"valid_from\": \"2023-12-25\",\n    \"external_ref\": \"<string>\",\n    \"core\": {\n      \"employee_name\": \"John Smith\",\n      \"birth_date\": \"2023-12-25\",\n      \"personal_email\": \"jsmith@example.com\",\n      \"work_email\": \"jsmith@example.com\",\n      \"phone_numbers\": [\n        {\n          \"phone_number\": \"<string>\",\n          \"is_primary\": false\n        }\n      ]\n    },\n    \"address\": {\n      \"address\": \"10 Downing Street, London, SW1A 2AA\"\n    },\n    \"job\": {\n      \"start_date\": \"2023-12-25\",\n      \"contracted_weekly_hours\": 40,\n      \"department\": \"<string>\",\n      \"contracted_weekdays\": [],\n      \"worker_type\": \"EMPLOYEE\",\n      \"director_since\": \"2023-12-25\",\n      \"pay_basis\": \"SALARIED\",\n      \"apprenticeship\": {\n        \"start_date\": \"2023-12-25\",\n        \"level\": 4,\n        \"expected_end_date\": \"2023-12-25\"\n      },\n      \"p45_issued\": false,\n      \"irregular_payment_pattern\": false,\n      \"ordinarily_works_in_uk\": true,\n      \"proration_basis\": {\n        \"business_days_per_year\": 123\n      }\n    },\n    \"tax\": {\n      \"tax_code\": \"1257L\",\n      \"rti_id\": \"<string>\",\n      \"postgraduate_loan\": false,\n      \"p45_gross_pay\": \"0.00\",\n      \"p45_tax_amount\": \"0.00\"\n    },\n    \"insurance\": {\n      \"national_insurance_number\": \"<string>\"\n    },\n    \"compensation\": {\n      \"pay_group_id\": \"<string>\",\n      \"earnings\": [\n        {\n          \"wage_type_code\": \"<string>\",\n          \"amount\": 123,\n          \"external_ref\": \"<string>\",\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          \"external_ref\": \"<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          \"wage_type_code\": \"<string>\",\n          \"amount\": 1,\n          \"external_ref\": \"<string>\",\n          \"sacrificed_amount\": 1\n        }\n      ],\n      \"reimbursements\": [\n        {\n          \"wage_type_code\": \"<string>\",\n          \"amount\": 1,\n          \"external_ref\": \"<string>\"\n        }\n      ]\n    },\n    \"bank\": {\n      \"accounts\": [\n        {\n          \"account_number\": \"31926819\",\n          \"sort_code\": \"200015\",\n          \"financial_institution_name\": \"Lloyds Bank\",\n          \"is_primary\": false,\n          \"is_active\": true,\n          \"allocation_percentage\": 50\n        }\n      ]\n    }\n  }\n]")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://preview.intermezzo.ai/gb/organizations/{organization_id}/employees/list")

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  {\n    \"valid_from\": \"2023-12-25\",\n    \"external_ref\": \"<string>\",\n    \"core\": {\n      \"employee_name\": \"John Smith\",\n      \"birth_date\": \"2023-12-25\",\n      \"personal_email\": \"jsmith@example.com\",\n      \"work_email\": \"jsmith@example.com\",\n      \"phone_numbers\": [\n        {\n          \"phone_number\": \"<string>\",\n          \"is_primary\": false\n        }\n      ]\n    },\n    \"address\": {\n      \"address\": \"10 Downing Street, London, SW1A 2AA\"\n    },\n    \"job\": {\n      \"start_date\": \"2023-12-25\",\n      \"contracted_weekly_hours\": 40,\n      \"department\": \"<string>\",\n      \"contracted_weekdays\": [],\n      \"worker_type\": \"EMPLOYEE\",\n      \"director_since\": \"2023-12-25\",\n      \"pay_basis\": \"SALARIED\",\n      \"apprenticeship\": {\n        \"start_date\": \"2023-12-25\",\n        \"level\": 4,\n        \"expected_end_date\": \"2023-12-25\"\n      },\n      \"p45_issued\": false,\n      \"irregular_payment_pattern\": false,\n      \"ordinarily_works_in_uk\": true,\n      \"proration_basis\": {\n        \"business_days_per_year\": 123\n      }\n    },\n    \"tax\": {\n      \"tax_code\": \"1257L\",\n      \"rti_id\": \"<string>\",\n      \"postgraduate_loan\": false,\n      \"p45_gross_pay\": \"0.00\",\n      \"p45_tax_amount\": \"0.00\"\n    },\n    \"insurance\": {\n      \"national_insurance_number\": \"<string>\"\n    },\n    \"compensation\": {\n      \"pay_group_id\": \"<string>\",\n      \"earnings\": [\n        {\n          \"wage_type_code\": \"<string>\",\n          \"amount\": 123,\n          \"external_ref\": \"<string>\",\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          \"external_ref\": \"<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          \"wage_type_code\": \"<string>\",\n          \"amount\": 1,\n          \"external_ref\": \"<string>\",\n          \"sacrificed_amount\": 1\n        }\n      ],\n      \"reimbursements\": [\n        {\n          \"wage_type_code\": \"<string>\",\n          \"amount\": 1,\n          \"external_ref\": \"<string>\"\n        }\n      ]\n    },\n    \"bank\": {\n      \"accounts\": [\n        {\n          \"account_number\": \"31926819\",\n          \"sort_code\": \"200015\",\n          \"financial_institution_name\": \"Lloyds Bank\",\n          \"is_primary\": false,\n          \"is_active\": true,\n          \"allocation_percentage\": 50\n        }\n      ]\n    }\n  }\n]"

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

{
  "total": 123,
  "succeeded": 123,
  "failed": 123,
  "unprocessed": 123,
  "data": [
    {
      "id": "<string>",
      "external_ref": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "created_by": "<string>",
      "deleted_at": "2023-11-07T05:31:56Z",
      "organization_id": "<string>",
      "status": {},
      "core": {
        "edition": 123,
        "valid_from": "2023-12-25",
        "valid_to": "2023-12-25",
        "created_at": "2023-11-07T05:31:56Z",
        "created_by": "<string>",
        "employee_name": "<string>",
        "gender": "M",
        "marital_status": "Single",
        "birth_date": "2023-12-25",
        "personal_email": "jsmith@example.com",
        "work_email": "jsmith@example.com",
        "phone_numbers": [
          {
            "phone_number": "<string>",
            "phone_type": "mobile",
            "is_primary": false
          }
        ]
      },
      "address": {
        "edition": 123,
        "valid_from": "2023-12-25",
        "valid_to": "2023-12-25",
        "created_at": "2023-11-07T05:31:56Z",
        "created_by": "<string>",
        "address": "<string>"
      },
      "job": {
        "edition": 123,
        "valid_from": "2023-12-25",
        "valid_to": "2023-12-25",
        "created_at": "2023-11-07T05:31:56Z",
        "created_by": "<string>",
        "start_date": "2023-12-25",
        "contracted_weekly_hours": 40,
        "department": "<string>",
        "contracted_weekdays": [
          "Monday"
        ],
        "worker_type": "EMPLOYEE",
        "director_since": "2023-12-25",
        "pay_basis": "SALARIED",
        "apprenticeship": {
          "start_date": "2023-12-25",
          "level": 4,
          "expected_end_date": "2023-12-25"
        },
        "p45_issued": false,
        "irregular_payment_pattern": false,
        "ordinarily_works_in_uk": true,
        "proration_basis": {
          "mode": "CALENDAR_DAY",
          "business_days_per_year": "<string>"
        },
        "end_date": "2023-12-25"
      },
      "tax": {
        "edition": 123,
        "valid_from": "2023-12-25",
        "valid_to": "2023-12-25",
        "created_at": "2023-11-07T05:31:56Z",
        "created_by": "<string>",
        "rti_id": "<string>",
        "tax_code": "<string>",
        "student_loan_type": "Plan1",
        "postgraduate_loan": false,
        "p45_gross_pay": "0.00",
        "p45_tax_amount": "0.00"
      },
      "insurance": {
        "edition": 123,
        "valid_from": "2023-12-25",
        "valid_to": "2023-12-25",
        "created_at": "2023-11-07T05:31:56Z",
        "created_by": "<string>",
        "national_insurance_number": "<string>",
        "nic_category": "A"
      },
      "compensation": {
        "edition": 123,
        "valid_from": "2023-12-25",
        "valid_to": "2023-12-25",
        "created_at": "2023-11-07T05:31:56Z",
        "created_by": "<string>",
        "pay_group_id": "<string>",
        "earnings": [
          {
            "wage_type_code": "<string>",
            "amount": "<string>",
            "external_ref": "<string>",
            "earning_type": "AMOUNT",
            "earning_frequency": "MONTH",
            "is_lumpsum": false,
            "sacrificed_amount": "<string>"
          }
        ],
        "benefits": [
          {
            "wage_type_code": "<string>",
            "external_ref": "<string>",
            "amount": "0.00",
            "make_good_amount": "0.00",
            "foregone_amount": "0.00",
            "cash_alternative_amount": "0.00"
          }
        ],
        "deductions": [
          {
            "wage_type_code": "<string>",
            "amount": "<string>",
            "external_ref": "<string>",
            "sacrificed_amount": "<string>"
          }
        ],
        "reimbursements": [
          {
            "wage_type_code": "<string>",
            "amount": "<string>",
            "external_ref": "<string>"
          }
        ]
      },
      "bank": {
        "edition": 123,
        "valid_from": "2023-12-25",
        "valid_to": "2023-12-25",
        "created_at": "2023-11-07T05:31:56Z",
        "created_by": "<string>",
        "accounts": [
          {
            "account_number": "<string>",
            "sort_code": "<string>",
            "financial_institution_name": "Lloyds Bank",
            "is_primary": false,
            "is_active": true,
            "allocation_percentage": "<string>"
          }
        ]
      }
    }
  ],
  "errors": [
    {
      "input_index": 123,
      "errors": [
        {
          "code": "ADDRESS_NOT_FOUND",
          "message": "<string>",
          "field": "<string>",
          "params": {}
        }
      ]
    }
  ]
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

POST

organizations

{organization_id}

employees

list

Create Employees

curl --request POST \
  --url https://preview.intermezzo.ai/gb/organizations/{organization_id}/employees/list \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
[
  {
    "valid_from": "2023-12-25",
    "external_ref": "<string>",
    "core": {
      "employee_name": "John Smith",
      "birth_date": "2023-12-25",
      "personal_email": "jsmith@example.com",
      "work_email": "jsmith@example.com",
      "phone_numbers": [
        {
          "phone_number": "<string>",
          "is_primary": false
        }
      ]
    },
    "address": {
      "address": "10 Downing Street, London, SW1A 2AA"
    },
    "job": {
      "start_date": "2023-12-25",
      "contracted_weekly_hours": 40,
      "department": "<string>",
      "contracted_weekdays": [],
      "worker_type": "EMPLOYEE",
      "director_since": "2023-12-25",
      "pay_basis": "SALARIED",
      "apprenticeship": {
        "start_date": "2023-12-25",
        "level": 4,
        "expected_end_date": "2023-12-25"
      },
      "p45_issued": false,
      "irregular_payment_pattern": false,
      "ordinarily_works_in_uk": true,
      "proration_basis": {
        "business_days_per_year": 123
      }
    },
    "tax": {
      "tax_code": "1257L",
      "rti_id": "<string>",
      "postgraduate_loan": false,
      "p45_gross_pay": "0.00",
      "p45_tax_amount": "0.00"
    },
    "insurance": {
      "national_insurance_number": "<string>"
    },
    "compensation": {
      "pay_group_id": "<string>",
      "earnings": [
        {
          "wage_type_code": "<string>",
          "amount": 123,
          "external_ref": "<string>",
          "earning_type": "AMOUNT",
          "earning_frequency": "MONTH",
          "is_lumpsum": false,
          "sacrificed_amount": 1
        }
      ],
      "benefits": [
        {
          "wage_type_code": "<string>",
          "external_ref": "<string>",
          "amount": "0.00",
          "make_good_amount": "0.00",
          "foregone_amount": "0.00",
          "cash_alternative_amount": "0.00"
        }
      ],
      "deductions": [
        {
          "wage_type_code": "<string>",
          "amount": 1,
          "external_ref": "<string>",
          "sacrificed_amount": 1
        }
      ],
      "reimbursements": [
        {
          "wage_type_code": "<string>",
          "amount": 1,
          "external_ref": "<string>"
        }
      ]
    },
    "bank": {
      "accounts": [
        {
          "account_number": "31926819",
          "sort_code": "200015",
          "financial_institution_name": "Lloyds Bank",
          "is_primary": false,
          "is_active": true,
          "allocation_percentage": 50
        }
      ]
    }
  }
]
'

import requests

url = "https://preview.intermezzo.ai/gb/organizations/{organization_id}/employees/list"

payload = [
    {
        "valid_from": "2023-12-25",
        "external_ref": "<string>",
        "core": {
            "employee_name": "John Smith",
            "birth_date": "2023-12-25",
            "personal_email": "jsmith@example.com",
            "work_email": "jsmith@example.com",
            "phone_numbers": [
                {
                    "phone_number": "<string>",
                    "is_primary": False
                }
            ]
        },
        "address": { "address": "10 Downing Street, London, SW1A 2AA" },
        "job": {
            "start_date": "2023-12-25",
            "contracted_weekly_hours": 40,
            "department": "<string>",
            "contracted_weekdays": [],
            "worker_type": "EMPLOYEE",
            "director_since": "2023-12-25",
            "pay_basis": "SALARIED",
            "apprenticeship": {
                "start_date": "2023-12-25",
                "level": 4,
                "expected_end_date": "2023-12-25"
            },
            "p45_issued": False,
            "irregular_payment_pattern": False,
            "ordinarily_works_in_uk": True,
            "proration_basis": { "business_days_per_year": 123 }
        },
        "tax": {
            "tax_code": "1257L",
            "rti_id": "<string>",
            "postgraduate_loan": False,
            "p45_gross_pay": "0.00",
            "p45_tax_amount": "0.00"
        },
        "insurance": { "national_insurance_number": "<string>" },
        "compensation": {
            "pay_group_id": "<string>",
            "earnings": [
                {
                    "wage_type_code": "<string>",
                    "amount": 123,
                    "external_ref": "<string>",
                    "earning_type": "AMOUNT",
                    "earning_frequency": "MONTH",
                    "is_lumpsum": False,
                    "sacrificed_amount": 1
                }
            ],
            "benefits": [
                {
                    "wage_type_code": "<string>",
                    "external_ref": "<string>",
                    "amount": "0.00",
                    "make_good_amount": "0.00",
                    "foregone_amount": "0.00",
                    "cash_alternative_amount": "0.00"
                }
            ],
            "deductions": [
                {
                    "wage_type_code": "<string>",
                    "amount": 1,
                    "external_ref": "<string>",
                    "sacrificed_amount": 1
                }
            ],
            "reimbursements": [
                {
                    "wage_type_code": "<string>",
                    "amount": 1,
                    "external_ref": "<string>"
                }
            ]
        },
        "bank": { "accounts": [
                {
                    "account_number": "31926819",
                    "sort_code": "200015",
                    "financial_institution_name": "Lloyds Bank",
                    "is_primary": False,
                    "is_active": True,
                    "allocation_percentage": 50
                }
            ] }
    }
]
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([
    {
      valid_from: '2023-12-25',
      external_ref: '<string>',
      core: {
        employee_name: 'John Smith',
        birth_date: '2023-12-25',
        personal_email: 'jsmith@example.com',
        work_email: 'jsmith@example.com',
        phone_numbers: [{phone_number: '<string>', is_primary: false}]
      },
      address: {address: '10 Downing Street, London, SW1A 2AA'},
      job: {
        start_date: '2023-12-25',
        contracted_weekly_hours: 40,
        department: '<string>',
        contracted_weekdays: [],
        worker_type: 'EMPLOYEE',
        director_since: '2023-12-25',
        pay_basis: 'SALARIED',
        apprenticeship: {start_date: '2023-12-25', level: 4, expected_end_date: '2023-12-25'},
        p45_issued: false,
        irregular_payment_pattern: false,
        ordinarily_works_in_uk: true,
        proration_basis: {business_days_per_year: 123}
      },
      tax: {
        tax_code: '1257L',
        rti_id: '<string>',
        postgraduate_loan: false,
        p45_gross_pay: '0.00',
        p45_tax_amount: '0.00'
      },
      insurance: {national_insurance_number: '<string>'},
      compensation: {
        pay_group_id: '<string>',
        earnings: [
          {
            wage_type_code: '<string>',
            amount: 123,
            external_ref: '<string>',
            earning_type: 'AMOUNT',
            earning_frequency: 'MONTH',
            is_lumpsum: false,
            sacrificed_amount: 1
          }
        ],
        benefits: [
          {
            wage_type_code: '<string>',
            external_ref: '<string>',
            amount: '0.00',
            make_good_amount: '0.00',
            foregone_amount: '0.00',
            cash_alternative_amount: '0.00'
          }
        ],
        deductions: [
          {
            wage_type_code: '<string>',
            amount: 1,
            external_ref: '<string>',
            sacrificed_amount: 1
          }
        ],
        reimbursements: [{wage_type_code: '<string>', amount: 1, external_ref: '<string>'}]
      },
      bank: {
        accounts: [
          {
            account_number: '31926819',
            sort_code: '200015',
            financial_institution_name: 'Lloyds Bank',
            is_primary: false,
            is_active: true,
            allocation_percentage: 50
          }
        ]
      }
    }
  ])
};

fetch('https://preview.intermezzo.ai/gb/organizations/{organization_id}/employees/list', 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://preview.intermezzo.ai/gb/organizations/{organization_id}/employees/list",
  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([
    [
        'valid_from' => '2023-12-25',
        'external_ref' => '<string>',
        'core' => [
                'employee_name' => 'John Smith',
                'birth_date' => '2023-12-25',
                'personal_email' => 'jsmith@example.com',
                'work_email' => 'jsmith@example.com',
                'phone_numbers' => [
                                [
                                                                'phone_number' => '<string>',
                                                                'is_primary' => false
                                ]
                ]
        ],
        'address' => [
                'address' => '10 Downing Street, London, SW1A 2AA'
        ],
        'job' => [
                'start_date' => '2023-12-25',
                'contracted_weekly_hours' => 40,
                'department' => '<string>',
                'contracted_weekdays' => [
                                
                ],
                'worker_type' => 'EMPLOYEE',
                'director_since' => '2023-12-25',
                'pay_basis' => 'SALARIED',
                'apprenticeship' => [
                                'start_date' => '2023-12-25',
                                'level' => 4,
                                'expected_end_date' => '2023-12-25'
                ],
                'p45_issued' => false,
                'irregular_payment_pattern' => false,
                'ordinarily_works_in_uk' => true,
                'proration_basis' => [
                                'business_days_per_year' => 123
                ]
        ],
        'tax' => [
                'tax_code' => '1257L',
                'rti_id' => '<string>',
                'postgraduate_loan' => false,
                'p45_gross_pay' => '0.00',
                'p45_tax_amount' => '0.00'
        ],
        'insurance' => [
                'national_insurance_number' => '<string>'
        ],
        'compensation' => [
                'pay_group_id' => '<string>',
                'earnings' => [
                                [
                                                                'wage_type_code' => '<string>',
                                                                'amount' => 123,
                                                                'external_ref' => '<string>',
                                                                'earning_type' => 'AMOUNT',
                                                                'earning_frequency' => 'MONTH',
                                                                'is_lumpsum' => false,
                                                                'sacrificed_amount' => 1
                                ]
                ],
                'benefits' => [
                                [
                                                                'wage_type_code' => '<string>',
                                                                'external_ref' => '<string>',
                                                                'amount' => '0.00',
                                                                'make_good_amount' => '0.00',
                                                                'foregone_amount' => '0.00',
                                                                'cash_alternative_amount' => '0.00'
                                ]
                ],
                'deductions' => [
                                [
                                                                'wage_type_code' => '<string>',
                                                                'amount' => 1,
                                                                'external_ref' => '<string>',
                                                                'sacrificed_amount' => 1
                                ]
                ],
                'reimbursements' => [
                                [
                                                                'wage_type_code' => '<string>',
                                                                'amount' => 1,
                                                                'external_ref' => '<string>'
                                ]
                ]
        ],
        'bank' => [
                'accounts' => [
                                [
                                                                'account_number' => '31926819',
                                                                'sort_code' => '200015',
                                                                'financial_institution_name' => 'Lloyds Bank',
                                                                'is_primary' => false,
                                                                'is_active' => true,
                                                                'allocation_percentage' => 50
                                ]
                ]
        ]
    ]
  ]),
  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://preview.intermezzo.ai/gb/organizations/{organization_id}/employees/list"

	payload := strings.NewReader("[\n  {\n    \"valid_from\": \"2023-12-25\",\n    \"external_ref\": \"<string>\",\n    \"core\": {\n      \"employee_name\": \"John Smith\",\n      \"birth_date\": \"2023-12-25\",\n      \"personal_email\": \"jsmith@example.com\",\n      \"work_email\": \"jsmith@example.com\",\n      \"phone_numbers\": [\n        {\n          \"phone_number\": \"<string>\",\n          \"is_primary\": false\n        }\n      ]\n    },\n    \"address\": {\n      \"address\": \"10 Downing Street, London, SW1A 2AA\"\n    },\n    \"job\": {\n      \"start_date\": \"2023-12-25\",\n      \"contracted_weekly_hours\": 40,\n      \"department\": \"<string>\",\n      \"contracted_weekdays\": [],\n      \"worker_type\": \"EMPLOYEE\",\n      \"director_since\": \"2023-12-25\",\n      \"pay_basis\": \"SALARIED\",\n      \"apprenticeship\": {\n        \"start_date\": \"2023-12-25\",\n        \"level\": 4,\n        \"expected_end_date\": \"2023-12-25\"\n      },\n      \"p45_issued\": false,\n      \"irregular_payment_pattern\": false,\n      \"ordinarily_works_in_uk\": true,\n      \"proration_basis\": {\n        \"business_days_per_year\": 123\n      }\n    },\n    \"tax\": {\n      \"tax_code\": \"1257L\",\n      \"rti_id\": \"<string>\",\n      \"postgraduate_loan\": false,\n      \"p45_gross_pay\": \"0.00\",\n      \"p45_tax_amount\": \"0.00\"\n    },\n    \"insurance\": {\n      \"national_insurance_number\": \"<string>\"\n    },\n    \"compensation\": {\n      \"pay_group_id\": \"<string>\",\n      \"earnings\": [\n        {\n          \"wage_type_code\": \"<string>\",\n          \"amount\": 123,\n          \"external_ref\": \"<string>\",\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          \"external_ref\": \"<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          \"wage_type_code\": \"<string>\",\n          \"amount\": 1,\n          \"external_ref\": \"<string>\",\n          \"sacrificed_amount\": 1\n        }\n      ],\n      \"reimbursements\": [\n        {\n          \"wage_type_code\": \"<string>\",\n          \"amount\": 1,\n          \"external_ref\": \"<string>\"\n        }\n      ]\n    },\n    \"bank\": {\n      \"accounts\": [\n        {\n          \"account_number\": \"31926819\",\n          \"sort_code\": \"200015\",\n          \"financial_institution_name\": \"Lloyds Bank\",\n          \"is_primary\": false,\n          \"is_active\": true,\n          \"allocation_percentage\": 50\n        }\n      ]\n    }\n  }\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://preview.intermezzo.ai/gb/organizations/{organization_id}/employees/list")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("[\n  {\n    \"valid_from\": \"2023-12-25\",\n    \"external_ref\": \"<string>\",\n    \"core\": {\n      \"employee_name\": \"John Smith\",\n      \"birth_date\": \"2023-12-25\",\n      \"personal_email\": \"jsmith@example.com\",\n      \"work_email\": \"jsmith@example.com\",\n      \"phone_numbers\": [\n        {\n          \"phone_number\": \"<string>\",\n          \"is_primary\": false\n        }\n      ]\n    },\n    \"address\": {\n      \"address\": \"10 Downing Street, London, SW1A 2AA\"\n    },\n    \"job\": {\n      \"start_date\": \"2023-12-25\",\n      \"contracted_weekly_hours\": 40,\n      \"department\": \"<string>\",\n      \"contracted_weekdays\": [],\n      \"worker_type\": \"EMPLOYEE\",\n      \"director_since\": \"2023-12-25\",\n      \"pay_basis\": \"SALARIED\",\n      \"apprenticeship\": {\n        \"start_date\": \"2023-12-25\",\n        \"level\": 4,\n        \"expected_end_date\": \"2023-12-25\"\n      },\n      \"p45_issued\": false,\n      \"irregular_payment_pattern\": false,\n      \"ordinarily_works_in_uk\": true,\n      \"proration_basis\": {\n        \"business_days_per_year\": 123\n      }\n    },\n    \"tax\": {\n      \"tax_code\": \"1257L\",\n      \"rti_id\": \"<string>\",\n      \"postgraduate_loan\": false,\n      \"p45_gross_pay\": \"0.00\",\n      \"p45_tax_amount\": \"0.00\"\n    },\n    \"insurance\": {\n      \"national_insurance_number\": \"<string>\"\n    },\n    \"compensation\": {\n      \"pay_group_id\": \"<string>\",\n      \"earnings\": [\n        {\n          \"wage_type_code\": \"<string>\",\n          \"amount\": 123,\n          \"external_ref\": \"<string>\",\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          \"external_ref\": \"<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          \"wage_type_code\": \"<string>\",\n          \"amount\": 1,\n          \"external_ref\": \"<string>\",\n          \"sacrificed_amount\": 1\n        }\n      ],\n      \"reimbursements\": [\n        {\n          \"wage_type_code\": \"<string>\",\n          \"amount\": 1,\n          \"external_ref\": \"<string>\"\n        }\n      ]\n    },\n    \"bank\": {\n      \"accounts\": [\n        {\n          \"account_number\": \"31926819\",\n          \"sort_code\": \"200015\",\n          \"financial_institution_name\": \"Lloyds Bank\",\n          \"is_primary\": false,\n          \"is_active\": true,\n          \"allocation_percentage\": 50\n        }\n      ]\n    }\n  }\n]")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://preview.intermezzo.ai/gb/organizations/{organization_id}/employees/list")

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  {\n    \"valid_from\": \"2023-12-25\",\n    \"external_ref\": \"<string>\",\n    \"core\": {\n      \"employee_name\": \"John Smith\",\n      \"birth_date\": \"2023-12-25\",\n      \"personal_email\": \"jsmith@example.com\",\n      \"work_email\": \"jsmith@example.com\",\n      \"phone_numbers\": [\n        {\n          \"phone_number\": \"<string>\",\n          \"is_primary\": false\n        }\n      ]\n    },\n    \"address\": {\n      \"address\": \"10 Downing Street, London, SW1A 2AA\"\n    },\n    \"job\": {\n      \"start_date\": \"2023-12-25\",\n      \"contracted_weekly_hours\": 40,\n      \"department\": \"<string>\",\n      \"contracted_weekdays\": [],\n      \"worker_type\": \"EMPLOYEE\",\n      \"director_since\": \"2023-12-25\",\n      \"pay_basis\": \"SALARIED\",\n      \"apprenticeship\": {\n        \"start_date\": \"2023-12-25\",\n        \"level\": 4,\n        \"expected_end_date\": \"2023-12-25\"\n      },\n      \"p45_issued\": false,\n      \"irregular_payment_pattern\": false,\n      \"ordinarily_works_in_uk\": true,\n      \"proration_basis\": {\n        \"business_days_per_year\": 123\n      }\n    },\n    \"tax\": {\n      \"tax_code\": \"1257L\",\n      \"rti_id\": \"<string>\",\n      \"postgraduate_loan\": false,\n      \"p45_gross_pay\": \"0.00\",\n      \"p45_tax_amount\": \"0.00\"\n    },\n    \"insurance\": {\n      \"national_insurance_number\": \"<string>\"\n    },\n    \"compensation\": {\n      \"pay_group_id\": \"<string>\",\n      \"earnings\": [\n        {\n          \"wage_type_code\": \"<string>\",\n          \"amount\": 123,\n          \"external_ref\": \"<string>\",\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          \"external_ref\": \"<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          \"wage_type_code\": \"<string>\",\n          \"amount\": 1,\n          \"external_ref\": \"<string>\",\n          \"sacrificed_amount\": 1\n        }\n      ],\n      \"reimbursements\": [\n        {\n          \"wage_type_code\": \"<string>\",\n          \"amount\": 1,\n          \"external_ref\": \"<string>\"\n        }\n      ]\n    },\n    \"bank\": {\n      \"accounts\": [\n        {\n          \"account_number\": \"31926819\",\n          \"sort_code\": \"200015\",\n          \"financial_institution_name\": \"Lloyds Bank\",\n          \"is_primary\": false,\n          \"is_active\": true,\n          \"allocation_percentage\": 50\n        }\n      ]\n    }\n  }\n]"

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

{
  "total": 123,
  "succeeded": 123,
  "failed": 123,
  "unprocessed": 123,
  "data": [
    {
      "id": "<string>",
      "external_ref": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "created_by": "<string>",
      "deleted_at": "2023-11-07T05:31:56Z",
      "organization_id": "<string>",
      "status": {},
      "core": {
        "edition": 123,
        "valid_from": "2023-12-25",
        "valid_to": "2023-12-25",
        "created_at": "2023-11-07T05:31:56Z",
        "created_by": "<string>",
        "employee_name": "<string>",
        "gender": "M",
        "marital_status": "Single",
        "birth_date": "2023-12-25",
        "personal_email": "jsmith@example.com",
        "work_email": "jsmith@example.com",
        "phone_numbers": [
          {
            "phone_number": "<string>",
            "phone_type": "mobile",
            "is_primary": false
          }
        ]
      },
      "address": {
        "edition": 123,
        "valid_from": "2023-12-25",
        "valid_to": "2023-12-25",
        "created_at": "2023-11-07T05:31:56Z",
        "created_by": "<string>",
        "address": "<string>"
      },
      "job": {
        "edition": 123,
        "valid_from": "2023-12-25",
        "valid_to": "2023-12-25",
        "created_at": "2023-11-07T05:31:56Z",
        "created_by": "<string>",
        "start_date": "2023-12-25",
        "contracted_weekly_hours": 40,
        "department": "<string>",
        "contracted_weekdays": [
          "Monday"
        ],
        "worker_type": "EMPLOYEE",
        "director_since": "2023-12-25",
        "pay_basis": "SALARIED",
        "apprenticeship": {
          "start_date": "2023-12-25",
          "level": 4,
          "expected_end_date": "2023-12-25"
        },
        "p45_issued": false,
        "irregular_payment_pattern": false,
        "ordinarily_works_in_uk": true,
        "proration_basis": {
          "mode": "CALENDAR_DAY",
          "business_days_per_year": "<string>"
        },
        "end_date": "2023-12-25"
      },
      "tax": {
        "edition": 123,
        "valid_from": "2023-12-25",
        "valid_to": "2023-12-25",
        "created_at": "2023-11-07T05:31:56Z",
        "created_by": "<string>",
        "rti_id": "<string>",
        "tax_code": "<string>",
        "student_loan_type": "Plan1",
        "postgraduate_loan": false,
        "p45_gross_pay": "0.00",
        "p45_tax_amount": "0.00"
      },
      "insurance": {
        "edition": 123,
        "valid_from": "2023-12-25",
        "valid_to": "2023-12-25",
        "created_at": "2023-11-07T05:31:56Z",
        "created_by": "<string>",
        "national_insurance_number": "<string>",
        "nic_category": "A"
      },
      "compensation": {
        "edition": 123,
        "valid_from": "2023-12-25",
        "valid_to": "2023-12-25",
        "created_at": "2023-11-07T05:31:56Z",
        "created_by": "<string>",
        "pay_group_id": "<string>",
        "earnings": [
          {
            "wage_type_code": "<string>",
            "amount": "<string>",
            "external_ref": "<string>",
            "earning_type": "AMOUNT",
            "earning_frequency": "MONTH",
            "is_lumpsum": false,
            "sacrificed_amount": "<string>"
          }
        ],
        "benefits": [
          {
            "wage_type_code": "<string>",
            "external_ref": "<string>",
            "amount": "0.00",
            "make_good_amount": "0.00",
            "foregone_amount": "0.00",
            "cash_alternative_amount": "0.00"
          }
        ],
        "deductions": [
          {
            "wage_type_code": "<string>",
            "amount": "<string>",
            "external_ref": "<string>",
            "sacrificed_amount": "<string>"
          }
        ],
        "reimbursements": [
          {
            "wage_type_code": "<string>",
            "amount": "<string>",
            "external_ref": "<string>"
          }
        ]
      },
      "bank": {
        "edition": 123,
        "valid_from": "2023-12-25",
        "valid_to": "2023-12-25",
        "created_at": "2023-11-07T05:31:56Z",
        "created_by": "<string>",
        "accounts": [
          {
            "account_number": "<string>",
            "sort_code": "<string>",
            "financial_institution_name": "Lloyds Bank",
            "is_primary": false,
            "is_active": true,
            "allocation_percentage": "<string>"
          }
        ]
      }
    }
  ],
  "errors": [
    {
      "input_index": 123,
      "errors": [
        {
          "code": "ADDRESS_NOT_FOUND",
          "message": "<string>",
          "field": "<string>",
          "params": {}
        }
      ]
    }
  ]
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Authorizations

Authorization

string

header

required

Get token from Auth0 and paste it here

Headers

X-Acting-User

string | null

The person acting through the access credential, recorded as created_by of what the request writes. Audit only: access is checked on the credential.

Required string length: 1 - 255

Path Parameters

organization_id

string

required

Body

application/json

valid_from

string<date>

required

The date every satellite starts on

external_ref

string

The integrator's own stable key, unique within the organization. Generated when absent.

Required string length: 1 - 255

core

GBEmployeeCore · object | null

Identity of the person, as payroll and filing need it.

Show child attributes

address

GBEmployeeAddress · object | null

The person's residence address, as filed to HMRC.

Show child attributes

job

GBEmployeeJob · object | null

The terms of the employment as a client writes them.

Show child attributes

tax

GBEmployeeTax · object | null

Show child attributes

insurance

GBEmployeeInsurance · object | null

Show child attributes

compensation

GBEmployeeCompensation · object | null

Standing pay elements and the pay group they are paid in (PDR-0007, PDR-0012).

Show child attributes

bank

GBEmployeeBank · object | null

Show child attributes

Response

Successful Response

total

integer

required

Total number of records in the request

succeeded

integer

required

read-only

Number of successfully processed records

failed

integer

required

read-only

Number of failed records

unprocessed

integer

required

read-only

Number of records that passed validation but were not processed

data

GBEmployeeResponse · object[]

Successfully processed records

Show child attributes

errors

OperationError · object[]

Failed records with error details

Show child attributes