editUsersOfSupplementalPayPeriod
curl --request PUT \
--url https://sandbox.rollfi.xyz/payroll/editUsersOfSupplementalPayPeriod \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"method": "editUsersOfSupplementalPayPeriod",
"companyId": "C8D57032-BF6F-4510-AA41-08A358365531",
"payPeriodId": "4083B766-8F3A-4A23-ABB7-FB67FA1F97D3",
"payrollLineItems": [
{
"userId": "123DA511-5970-4C2F-AF7E-5C0FB11D23A3",
"amount": 2000,
"paymentMethod": "Check"
}
]
}
'import requests
url = "https://sandbox.rollfi.xyz/payroll/editUsersOfSupplementalPayPeriod"
payload = {
"method": "editUsersOfSupplementalPayPeriod",
"companyId": "C8D57032-BF6F-4510-AA41-08A358365531",
"payPeriodId": "4083B766-8F3A-4A23-ABB7-FB67FA1F97D3",
"payrollLineItems": [
{
"userId": "123DA511-5970-4C2F-AF7E-5C0FB11D23A3",
"amount": 2000,
"paymentMethod": "Check"
}
]
}
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({
method: 'editUsersOfSupplementalPayPeriod',
companyId: 'C8D57032-BF6F-4510-AA41-08A358365531',
payPeriodId: '4083B766-8F3A-4A23-ABB7-FB67FA1F97D3',
payrollLineItems: [
{
userId: '123DA511-5970-4C2F-AF7E-5C0FB11D23A3',
amount: 2000,
paymentMethod: 'Check'
}
]
})
};
fetch('https://sandbox.rollfi.xyz/payroll/editUsersOfSupplementalPayPeriod', 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/editUsersOfSupplementalPayPeriod",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'method' => 'editUsersOfSupplementalPayPeriod',
'companyId' => 'C8D57032-BF6F-4510-AA41-08A358365531',
'payPeriodId' => '4083B766-8F3A-4A23-ABB7-FB67FA1F97D3',
'payrollLineItems' => [
[
'userId' => '123DA511-5970-4C2F-AF7E-5C0FB11D23A3',
'amount' => 2000,
'paymentMethod' => 'Check'
]
]
]),
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/editUsersOfSupplementalPayPeriod"
payload := strings.NewReader("{\n \"method\": \"editUsersOfSupplementalPayPeriod\",\n \"companyId\": \"C8D57032-BF6F-4510-AA41-08A358365531\",\n \"payPeriodId\": \"4083B766-8F3A-4A23-ABB7-FB67FA1F97D3\",\n \"payrollLineItems\": [\n {\n \"userId\": \"123DA511-5970-4C2F-AF7E-5C0FB11D23A3\",\n \"amount\": 2000,\n \"paymentMethod\": \"Check\"\n }\n ]\n}")
req, _ := http.NewRequest("PUT", 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.put("https://sandbox.rollfi.xyz/payroll/editUsersOfSupplementalPayPeriod")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"method\": \"editUsersOfSupplementalPayPeriod\",\n \"companyId\": \"C8D57032-BF6F-4510-AA41-08A358365531\",\n \"payPeriodId\": \"4083B766-8F3A-4A23-ABB7-FB67FA1F97D3\",\n \"payrollLineItems\": [\n {\n \"userId\": \"123DA511-5970-4C2F-AF7E-5C0FB11D23A3\",\n \"amount\": 2000,\n \"paymentMethod\": \"Check\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.rollfi.xyz/payroll/editUsersOfSupplementalPayPeriod")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"method\": \"editUsersOfSupplementalPayPeriod\",\n \"companyId\": \"C8D57032-BF6F-4510-AA41-08A358365531\",\n \"payPeriodId\": \"4083B766-8F3A-4A23-ABB7-FB67FA1F97D3\",\n \"payrollLineItems\": [\n {\n \"userId\": \"123DA511-5970-4C2F-AF7E-5C0FB11D23A3\",\n \"amount\": 2000,\n \"paymentMethod\": \"Check\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"payrollLineItems": [
{
"userId": "123DA511-5970-4C2F-AF7E-5C0FB11D23A3",
"status": "Updated",
"message": "The PayrollLineItem for Celina Gos has been updated successfully."
}
]
}Payroll
editUsersOfSupplementalPayPeriod
The editUsersOfSupplementalPayPeriod API is used to modify high level payroll details for employees
When to use:
- When correcting payment amounts before payroll submission
- When changing payment methods for existing supplemental payroll entries
Notes:
- Automatically recalculates taxes and net totals
- Payment method can only be changed to
Direct Depositif the user in the payroll is set up with a bank account
PUT
/
payroll
/
editUsersOfSupplementalPayPeriod
editUsersOfSupplementalPayPeriod
curl --request PUT \
--url https://sandbox.rollfi.xyz/payroll/editUsersOfSupplementalPayPeriod \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"method": "editUsersOfSupplementalPayPeriod",
"companyId": "C8D57032-BF6F-4510-AA41-08A358365531",
"payPeriodId": "4083B766-8F3A-4A23-ABB7-FB67FA1F97D3",
"payrollLineItems": [
{
"userId": "123DA511-5970-4C2F-AF7E-5C0FB11D23A3",
"amount": 2000,
"paymentMethod": "Check"
}
]
}
'import requests
url = "https://sandbox.rollfi.xyz/payroll/editUsersOfSupplementalPayPeriod"
payload = {
"method": "editUsersOfSupplementalPayPeriod",
"companyId": "C8D57032-BF6F-4510-AA41-08A358365531",
"payPeriodId": "4083B766-8F3A-4A23-ABB7-FB67FA1F97D3",
"payrollLineItems": [
{
"userId": "123DA511-5970-4C2F-AF7E-5C0FB11D23A3",
"amount": 2000,
"paymentMethod": "Check"
}
]
}
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({
method: 'editUsersOfSupplementalPayPeriod',
companyId: 'C8D57032-BF6F-4510-AA41-08A358365531',
payPeriodId: '4083B766-8F3A-4A23-ABB7-FB67FA1F97D3',
payrollLineItems: [
{
userId: '123DA511-5970-4C2F-AF7E-5C0FB11D23A3',
amount: 2000,
paymentMethod: 'Check'
}
]
})
};
fetch('https://sandbox.rollfi.xyz/payroll/editUsersOfSupplementalPayPeriod', 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/editUsersOfSupplementalPayPeriod",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'method' => 'editUsersOfSupplementalPayPeriod',
'companyId' => 'C8D57032-BF6F-4510-AA41-08A358365531',
'payPeriodId' => '4083B766-8F3A-4A23-ABB7-FB67FA1F97D3',
'payrollLineItems' => [
[
'userId' => '123DA511-5970-4C2F-AF7E-5C0FB11D23A3',
'amount' => 2000,
'paymentMethod' => 'Check'
]
]
]),
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/editUsersOfSupplementalPayPeriod"
payload := strings.NewReader("{\n \"method\": \"editUsersOfSupplementalPayPeriod\",\n \"companyId\": \"C8D57032-BF6F-4510-AA41-08A358365531\",\n \"payPeriodId\": \"4083B766-8F3A-4A23-ABB7-FB67FA1F97D3\",\n \"payrollLineItems\": [\n {\n \"userId\": \"123DA511-5970-4C2F-AF7E-5C0FB11D23A3\",\n \"amount\": 2000,\n \"paymentMethod\": \"Check\"\n }\n ]\n}")
req, _ := http.NewRequest("PUT", 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.put("https://sandbox.rollfi.xyz/payroll/editUsersOfSupplementalPayPeriod")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"method\": \"editUsersOfSupplementalPayPeriod\",\n \"companyId\": \"C8D57032-BF6F-4510-AA41-08A358365531\",\n \"payPeriodId\": \"4083B766-8F3A-4A23-ABB7-FB67FA1F97D3\",\n \"payrollLineItems\": [\n {\n \"userId\": \"123DA511-5970-4C2F-AF7E-5C0FB11D23A3\",\n \"amount\": 2000,\n \"paymentMethod\": \"Check\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.rollfi.xyz/payroll/editUsersOfSupplementalPayPeriod")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"method\": \"editUsersOfSupplementalPayPeriod\",\n \"companyId\": \"C8D57032-BF6F-4510-AA41-08A358365531\",\n \"payPeriodId\": \"4083B766-8F3A-4A23-ABB7-FB67FA1F97D3\",\n \"payrollLineItems\": [\n {\n \"userId\": \"123DA511-5970-4C2F-AF7E-5C0FB11D23A3\",\n \"amount\": 2000,\n \"paymentMethod\": \"Check\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"payrollLineItems": [
{
"userId": "123DA511-5970-4C2F-AF7E-5C0FB11D23A3",
"status": "Updated",
"message": "The PayrollLineItem for Celina Gos has been updated successfully."
}
]
}Authorizations
Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.
Body
application/json
Response
Show child attributes
Show child attributes
⌘I
