Skip to main content
POST
/
payroll
/
cancelPayrollSubmission
cancelPayrollSubmission
curl --request POST \
  --url https://sandbox.rollfi.xyz/payroll/cancelPayrollSubmission \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "method": "cancelPayrollSubmission",
  "companyId": "3A08507F-E78B-4ABF-98D8-87D382E7CE14",
  "payPeriodId": "3C068DE4-038F-4874-B99B-4AFD7CB39351"
}
'
import requests

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

payload = {
    "method": "cancelPayrollSubmission",
    "companyId": "3A08507F-E78B-4ABF-98D8-87D382E7CE14",
    "payPeriodId": "3C068DE4-038F-4874-B99B-4AFD7CB39351"
}
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: 'cancelPayrollSubmission',
    companyId: '3A08507F-E78B-4ABF-98D8-87D382E7CE14',
    payPeriodId: '3C068DE4-038F-4874-B99B-4AFD7CB39351'
  })
};

fetch('https://sandbox.rollfi.xyz/payroll/cancelPayrollSubmission', 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/cancelPayrollSubmission",
  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' => 'cancelPayrollSubmission',
    'companyId' => '3A08507F-E78B-4ABF-98D8-87D382E7CE14',
    'payPeriodId' => '3C068DE4-038F-4874-B99B-4AFD7CB39351'
  ]),
  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/cancelPayrollSubmission"

	payload := strings.NewReader("{\n  \"method\": \"cancelPayrollSubmission\",\n  \"companyId\": \"3A08507F-E78B-4ABF-98D8-87D382E7CE14\",\n  \"payPeriodId\": \"3C068DE4-038F-4874-B99B-4AFD7CB39351\"\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/cancelPayrollSubmission")
  .header("Authorization", "Basic <encoded-value>")
  .header("Content-Type", "application/json")
  .body("{\n  \"method\": \"cancelPayrollSubmission\",\n  \"companyId\": \"3A08507F-E78B-4ABF-98D8-87D382E7CE14\",\n  \"payPeriodId\": \"3C068DE4-038F-4874-B99B-4AFD7CB39351\"\n}")
  .asString();
require 'uri'
require 'net/http'

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

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\": \"cancelPayrollSubmission\",\n  \"companyId\": \"3A08507F-E78B-4ABF-98D8-87D382E7CE14\",\n  \"payPeriodId\": \"3C068DE4-038F-4874-B99B-4AFD7CB39351\"\n}"

response = http.request(request)
puts response.read_body
{
  "payPeriod": {
    "payPeriodId": "DEE97E29-BF4A-40D1-9324-11D70BE38582",
    "message": "Payroll submission has been cancelled successfully. You can now make changes and resubmit before the deadline."
  }
}
{
  "error": {
    "code": 400,
    "message": "invalid payPeriodId"
  }
}

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
required
payPeriodId
string
required

Response

payPeriod
object
required