Create Employee Payroll Run

curl --request POST \
  --url https://api.bindbee.dev/api/hris/v1/employee-payroll-runs \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Connector-Token: <api-key>' \
  --data '{}'

import requests

url = "https://api.bindbee.dev/api/hris/v1/employee-payroll-runs"

payload = {}
headers = {
    "Authorization": "Bearer <token>",
    "X-Connector-Token": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {
    Authorization: 'Bearer <token>',
    'X-Connector-Token': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({})
};

fetch('https://api.bindbee.dev/api/hris/v1/employee-payroll-runs', 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://api.bindbee.dev/api/hris/v1/employee-payroll-runs",
  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([
    
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "X-Connector-Token: <api-key>"
  ],
]);

$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://api.bindbee.dev/api/hris/v1/employee-payroll-runs"

	payload := strings.NewReader("{}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("X-Connector-Token", "<api-key>")
	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://api.bindbee.dev/api/hris/v1/employee-payroll-runs")
  .header("Authorization", "Bearer <token>")
  .header("X-Connector-Token", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.bindbee.dev/api/hris/v1/employee-payroll-runs")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["X-Connector-Token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{}"

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

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

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

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

POST

api

hris

employee-payroll-runs

Create Employee Payroll Run

curl --request POST \
  --url https://api.bindbee.dev/api/hris/v1/employee-payroll-runs \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Connector-Token: <api-key>' \
  --data '{}'

import requests

url = "https://api.bindbee.dev/api/hris/v1/employee-payroll-runs"

payload = {}
headers = {
    "Authorization": "Bearer <token>",
    "X-Connector-Token": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {
    Authorization: 'Bearer <token>',
    'X-Connector-Token': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({})
};

fetch('https://api.bindbee.dev/api/hris/v1/employee-payroll-runs', 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://api.bindbee.dev/api/hris/v1/employee-payroll-runs",
  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([
    
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "X-Connector-Token: <api-key>"
  ],
]);

$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://api.bindbee.dev/api/hris/v1/employee-payroll-runs"

	payload := strings.NewReader("{}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("X-Connector-Token", "<api-key>")
	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://api.bindbee.dev/api/hris/v1/employee-payroll-runs")
  .header("Authorization", "Bearer <token>")
  .header("X-Connector-Token", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.bindbee.dev/api/hris/v1/employee-payroll-runs")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["X-Connector-Token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{}"

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

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

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

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

Usecases

Create an Employee Payroll Run - write earnings, deductions, and taxes for an employee into the customer’s payroll system

This endpoint creates an Employee Payroll Run in the connected HRIS via Bindbee’s unified Employee Payroll Runs model.

Provider-specific behavior

Different HRIS systems can have slightly different requirements and behaviors when creating payroll runs. Use the accordions below to see details for each provider.

Workday

When the underlying HRIS is Workday, an earning can be created using a payload like:

{
  "employee": "019b2647-8e14-7fcf-aa9e-aeff6ab205b2",
  "start_date": "2025-12-01",
  "end_date": "2025-12-31",
  "earnings":
  [
    {
      "type": "Workday_Earning_Code",
      "amount": 200,
      "id": "W_1042S_2015"
    }
  ]
}

Similarly, a deduction can be created using a payload like:

{
  "employee": "019b2647-8e14-7fcf-aa9e-aeff6ab205b2",
  "start_date": "2025-12-01",
  "end_date": "2025-12-31",
  "deductions":
  [
    {
      "type": "Workday_Deduction_Code",
      "amount": 200,
      "id": "W_1042S_2015"
    }
  ]
}

Important note

For Workday, you can add either earnings or deductions at a time - you cannot add both simultaneously.
You can only add 1 earning or deduction at a time, no more than that.
payroll_run field must be set to null for Workday integration.

The possible types for earnings are:

Workday_Earning_Code
WID

The possible types for deductions are:

Workday_Deduction_Code
WID

ADP

When the underlying HRIS is ADP , an employee_payroll_run can be created using a payload like:

{
  "employee": "01929ee7-28b6-7abc-b4d3-e78610669c82",
  "earnings":
    [
      {
        "code": "BN",
        "amount": 0.01
      },
      {
        "code": "R",
        "amount": 0.04
      }
    ],
  "deductions":
    [
      {
        "code": "REI",
        "amount": 0.01
      },
      {
          "code": "KL1",
          "amount": 0.04
      }
    ],
  "taxes":
    [
      {
          "code": "9"
      }
    ],
  "payroll_file": "023321",
  "payroll_process_name": "Ded Ear writeback"
}

UKG Ready

When the underlying HRIS is UKG Ready , an employee_payroll_run can be created using a payload like:

{
  "employee": "0194cbef-a29f-7afe-8fb6-bcb706383346",
  "payroll_run": "0194cbef-a8e7-7784-ae98-bb6adaac63c6",
  "paystatement_type_id": 51743758,
  "deductions":
    [
      {
        "company_deduction": 5.5,
        "employee_deduction": 10.2,
        "name": "Student Loan"
      },
      {
        "company_deduction": 1.5,
        "name": "Dental PreTax"
      }
    ],
  "earnings":
    [
      {
        "name": "Overtime",
        "amount": 12.9
      }
    ]
}

SAP SuccessFactors (SAP SF)

When the underlying HRIS is SAP SuccessFactors, an employee_payroll_run can be created using a payload like:

{
  "employee": "019bdafb-0afb-782b-b03b-01c23271653d",
  "payroll_provider_id": "BindBee",
  "payroll_person_id": "310",
  "payroll_employment_id": "270",
  "start_date": "2026-01-26T08:00:00Z",
  "end_date": "2026-01-31T08:00:00Z",
  "deductions": [
    {
      "employee_deduction": 200,
      "name": "401K"
    }
  ],
  "earnings": [
    {
      "name": "GROSS",
      "amount": 2000
    }
  ],
  "taxes": [
    {
      "name": "Testing_Tax",
      "amount": 101
    }
  ]
}

Where to find these fields:

payroll_provider_id: Use the ID provided by the customer if it’s available. If not, any valid string can be used.
payroll_person_id: This value can be found in the employee’s raw_data.
payroll_employment_id: Source this either from the employee’s raw_data or from Binbee’s employment model (remote_id).
Deductions: When adding deductions, ensure the deduction codes are included in the name field.

Important notes

All top-level fields are mandatory.
earnings, deductions, and taxes can be sent together.
All fields inside each array are compulsory.

Authorizations

Authorization

string

header

default:<BINDBEE_API_KEY>

required

Your Bindbee API key, sent as Authorization: Bearer <BINDBEE_API_KEY>. Required on every request.

X-Connector-Token

string

header

default:<CONNECTOR_TOKEN>

required

The connector token for one customer's connection. This is not your Bindbee API key. Required on requests that read or write a single customer's data.

Headers

x-idempotency-key

string | null

Key to guarantee idempotent write execution.

Body

application/json

The body is of type Body · object | null.

Response

Successful Response

API Basics

Platform

HR & Payroll (HRIS)

Recruiting (ATS)

Learning (LMS)

Create Employee Payroll Run

Provider-specific behavior

Important note

Where to find these fields:

Important notes

Authorizations

Headers

Body

Response

​Provider-specific behavior

​Important note

​Where to find these fields:

​Important notes

Authorizations

Headers

Body

Response

Provider-specific behavior

Important note

Where to find these fields:

Important notes