Skip to main content
POST
/
payroll
/
initiatePayroll
initiatePayroll
curl --request POST \
  --url https://sandbox.rollfi.xyz/payroll/initiatePayroll \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "method": "initiatePayroll",
  "companyId": "8D728FCE-2993-42E0-8797-832C930506E1",
  "payPeriodId": "F4C96CCA-24D4-4DF4-B624-1544989F7D21",
  "runNow": false
}
'
import requests

url = "https://sandbox.rollfi.xyz/payroll/initiatePayroll"

payload = {
"method": "initiatePayroll",
"companyId": "8D728FCE-2993-42E0-8797-832C930506E1",
"payPeriodId": "F4C96CCA-24D4-4DF4-B624-1544989F7D21",
"runNow": False
}
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}

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

print(response.text)
const options = {
method: 'POST',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({
method: 'initiatePayroll',
companyId: '8D728FCE-2993-42E0-8797-832C930506E1',
payPeriodId: 'F4C96CCA-24D4-4DF4-B624-1544989F7D21',
runNow: false
})
};

fetch('https://sandbox.rollfi.xyz/payroll/initiatePayroll', 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://sandbox.rollfi.xyz/payroll/initiatePayroll",
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([
'method' => 'initiatePayroll',
'companyId' => '8D728FCE-2993-42E0-8797-832C930506E1',
'payPeriodId' => 'F4C96CCA-24D4-4DF4-B624-1544989F7D21',
'runNow' => false
]),
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>",
"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://sandbox.rollfi.xyz/payroll/initiatePayroll"

payload := strings.NewReader("{\n \"method\": \"initiatePayroll\",\n \"companyId\": \"8D728FCE-2993-42E0-8797-832C930506E1\",\n \"payPeriodId\": \"F4C96CCA-24D4-4DF4-B624-1544989F7D21\",\n \"runNow\": false\n}")

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

req.Header.Add("Authorization", "Basic <encoded-value>")
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://sandbox.rollfi.xyz/payroll/initiatePayroll")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"method\": \"initiatePayroll\",\n \"companyId\": \"8D728FCE-2993-42E0-8797-832C930506E1\",\n \"payPeriodId\": \"F4C96CCA-24D4-4DF4-B624-1544989F7D21\",\n \"runNow\": false\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://sandbox.rollfi.xyz/payroll/initiatePayroll")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"method\": \"initiatePayroll\",\n \"companyId\": \"8D728FCE-2993-42E0-8797-832C930506E1\",\n \"payPeriodId\": \"F4C96CCA-24D4-4DF4-B624-1544989F7D21\",\n \"runNow\": false\n}"

response = http.request(request)
puts response.read_body
{
  "payPeriod": {
    "payPeriodId": "3b51b98b-2915-4854-b87c-f7952ef086ec",
    "status": "inProcess",
    "message": "The PayPeriod has been initiated successfully."
  }
}

Authorizations

Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Body

application/json
method
string
required
companyId
string<uuid>
required
payPeriodId
string<uuid>
required
runNow
boolean

Response

payPeriod
object
required