Resubmit change request
curl --request PUT \
--url https://api.cadanapay.com/v1/persons/{personId}/changeRequests/{changeRequestId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"compInfo": {
"type": "net",
"frequency": "monthly",
"allowances": [
{
"name": "Housing",
"amount": {
"amount": 10000,
"currency": "USD"
},
"isTaxable": true
}
],
"employmentModel": "eor"
},
"effectiveDate": "2027-01-01",
"jobInfo": {
"startDate": "2023-01-01",
"employeeNumber": "1",
"title": "Software Engineer",
"department": "Product",
"customFields": [
{
"id": "8ef9a712-cdae-4110-b1ea-9ba95abbee6e",
"name": "Tshirt Size",
"value": "M"
}
],
"entityId": "37ad8c1e-0187-4e10-8c54-395e3385b4d2"
},
"notes": "<string>"
}
'import requests
url = "https://api.cadanapay.com/v1/persons/{personId}/changeRequests/{changeRequestId}"
payload = {
"compInfo": {
"type": "net",
"frequency": "monthly",
"allowances": [
{
"name": "Housing",
"amount": {
"amount": 10000,
"currency": "USD"
},
"isTaxable": True
}
],
"employmentModel": "eor"
},
"effectiveDate": "2027-01-01",
"jobInfo": {
"startDate": "2023-01-01",
"employeeNumber": "1",
"title": "Software Engineer",
"department": "Product",
"customFields": [
{
"id": "8ef9a712-cdae-4110-b1ea-9ba95abbee6e",
"name": "Tshirt Size",
"value": "M"
}
],
"entityId": "37ad8c1e-0187-4e10-8c54-395e3385b4d2"
},
"notes": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
compInfo: {
type: 'net',
frequency: 'monthly',
allowances: [{name: 'Housing', amount: {amount: 10000, currency: 'USD'}, isTaxable: true}],
employmentModel: 'eor'
},
effectiveDate: '2027-01-01',
jobInfo: {
startDate: '2023-01-01',
employeeNumber: '1',
title: 'Software Engineer',
department: 'Product',
customFields: [{id: '8ef9a712-cdae-4110-b1ea-9ba95abbee6e', name: 'Tshirt Size', value: 'M'}],
entityId: '37ad8c1e-0187-4e10-8c54-395e3385b4d2'
},
notes: '<string>'
})
};
fetch('https://api.cadanapay.com/v1/persons/{personId}/changeRequests/{changeRequestId}', 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.cadanapay.com/v1/persons/{personId}/changeRequests/{changeRequestId}",
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([
'compInfo' => [
'type' => 'net',
'frequency' => 'monthly',
'allowances' => [
[
'name' => 'Housing',
'amount' => [
'amount' => 10000,
'currency' => 'USD'
],
'isTaxable' => true
]
],
'employmentModel' => 'eor'
],
'effectiveDate' => '2027-01-01',
'jobInfo' => [
'startDate' => '2023-01-01',
'employeeNumber' => '1',
'title' => 'Software Engineer',
'department' => 'Product',
'customFields' => [
[
'id' => '8ef9a712-cdae-4110-b1ea-9ba95abbee6e',
'name' => 'Tshirt Size',
'value' => 'M'
]
],
'entityId' => '37ad8c1e-0187-4e10-8c54-395e3385b4d2'
],
'notes' => '<string>'
]),
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://api.cadanapay.com/v1/persons/{personId}/changeRequests/{changeRequestId}"
payload := strings.NewReader("{\n \"compInfo\": {\n \"type\": \"net\",\n \"frequency\": \"monthly\",\n \"allowances\": [\n {\n \"name\": \"Housing\",\n \"amount\": {\n \"amount\": 10000,\n \"currency\": \"USD\"\n },\n \"isTaxable\": true\n }\n ],\n \"employmentModel\": \"eor\"\n },\n \"effectiveDate\": \"2027-01-01\",\n \"jobInfo\": {\n \"startDate\": \"2023-01-01\",\n \"employeeNumber\": \"1\",\n \"title\": \"Software Engineer\",\n \"department\": \"Product\",\n \"customFields\": [\n {\n \"id\": \"8ef9a712-cdae-4110-b1ea-9ba95abbee6e\",\n \"name\": \"Tshirt Size\",\n \"value\": \"M\"\n }\n ],\n \"entityId\": \"37ad8c1e-0187-4e10-8c54-395e3385b4d2\"\n },\n \"notes\": \"<string>\"\n}")
req, _ := http.NewRequest("PUT", 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.put("https://api.cadanapay.com/v1/persons/{personId}/changeRequests/{changeRequestId}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"compInfo\": {\n \"type\": \"net\",\n \"frequency\": \"monthly\",\n \"allowances\": [\n {\n \"name\": \"Housing\",\n \"amount\": {\n \"amount\": 10000,\n \"currency\": \"USD\"\n },\n \"isTaxable\": true\n }\n ],\n \"employmentModel\": \"eor\"\n },\n \"effectiveDate\": \"2027-01-01\",\n \"jobInfo\": {\n \"startDate\": \"2023-01-01\",\n \"employeeNumber\": \"1\",\n \"title\": \"Software Engineer\",\n \"department\": \"Product\",\n \"customFields\": [\n {\n \"id\": \"8ef9a712-cdae-4110-b1ea-9ba95abbee6e\",\n \"name\": \"Tshirt Size\",\n \"value\": \"M\"\n }\n ],\n \"entityId\": \"37ad8c1e-0187-4e10-8c54-395e3385b4d2\"\n },\n \"notes\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.cadanapay.com/v1/persons/{personId}/changeRequests/{changeRequestId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"compInfo\": {\n \"type\": \"net\",\n \"frequency\": \"monthly\",\n \"allowances\": [\n {\n \"name\": \"Housing\",\n \"amount\": {\n \"amount\": 10000,\n \"currency\": \"USD\"\n },\n \"isTaxable\": true\n }\n ],\n \"employmentModel\": \"eor\"\n },\n \"effectiveDate\": \"2027-01-01\",\n \"jobInfo\": {\n \"startDate\": \"2023-01-01\",\n \"employeeNumber\": \"1\",\n \"title\": \"Software Engineer\",\n \"department\": \"Product\",\n \"customFields\": [\n {\n \"id\": \"8ef9a712-cdae-4110-b1ea-9ba95abbee6e\",\n \"name\": \"Tshirt Size\",\n \"value\": \"M\"\n }\n ],\n \"entityId\": \"37ad8c1e-0187-4e10-8c54-395e3385b4d2\"\n },\n \"notes\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"code": "invalid_request_body",
"message": "The request body provided is not valid",
"params": {
"field": "Value is invalid."
}
}{
"code": "resource_not_found",
"message": "Requested resource could not be found."
}{
"code": "internal_error",
"message": "An unexpected error occurred. Please try again later."
}Persons
Resubmit change request
Resubmit a change request that was sent back for changes (status ChangesRequested). Takes the same body as Submit change request and returns it to review.
PUT
/
v1
/
persons
/
{personId}
/
changeRequests
/
{changeRequestId}
Resubmit change request
curl --request PUT \
--url https://api.cadanapay.com/v1/persons/{personId}/changeRequests/{changeRequestId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"compInfo": {
"type": "net",
"frequency": "monthly",
"allowances": [
{
"name": "Housing",
"amount": {
"amount": 10000,
"currency": "USD"
},
"isTaxable": true
}
],
"employmentModel": "eor"
},
"effectiveDate": "2027-01-01",
"jobInfo": {
"startDate": "2023-01-01",
"employeeNumber": "1",
"title": "Software Engineer",
"department": "Product",
"customFields": [
{
"id": "8ef9a712-cdae-4110-b1ea-9ba95abbee6e",
"name": "Tshirt Size",
"value": "M"
}
],
"entityId": "37ad8c1e-0187-4e10-8c54-395e3385b4d2"
},
"notes": "<string>"
}
'import requests
url = "https://api.cadanapay.com/v1/persons/{personId}/changeRequests/{changeRequestId}"
payload = {
"compInfo": {
"type": "net",
"frequency": "monthly",
"allowances": [
{
"name": "Housing",
"amount": {
"amount": 10000,
"currency": "USD"
},
"isTaxable": True
}
],
"employmentModel": "eor"
},
"effectiveDate": "2027-01-01",
"jobInfo": {
"startDate": "2023-01-01",
"employeeNumber": "1",
"title": "Software Engineer",
"department": "Product",
"customFields": [
{
"id": "8ef9a712-cdae-4110-b1ea-9ba95abbee6e",
"name": "Tshirt Size",
"value": "M"
}
],
"entityId": "37ad8c1e-0187-4e10-8c54-395e3385b4d2"
},
"notes": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
compInfo: {
type: 'net',
frequency: 'monthly',
allowances: [{name: 'Housing', amount: {amount: 10000, currency: 'USD'}, isTaxable: true}],
employmentModel: 'eor'
},
effectiveDate: '2027-01-01',
jobInfo: {
startDate: '2023-01-01',
employeeNumber: '1',
title: 'Software Engineer',
department: 'Product',
customFields: [{id: '8ef9a712-cdae-4110-b1ea-9ba95abbee6e', name: 'Tshirt Size', value: 'M'}],
entityId: '37ad8c1e-0187-4e10-8c54-395e3385b4d2'
},
notes: '<string>'
})
};
fetch('https://api.cadanapay.com/v1/persons/{personId}/changeRequests/{changeRequestId}', 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.cadanapay.com/v1/persons/{personId}/changeRequests/{changeRequestId}",
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([
'compInfo' => [
'type' => 'net',
'frequency' => 'monthly',
'allowances' => [
[
'name' => 'Housing',
'amount' => [
'amount' => 10000,
'currency' => 'USD'
],
'isTaxable' => true
]
],
'employmentModel' => 'eor'
],
'effectiveDate' => '2027-01-01',
'jobInfo' => [
'startDate' => '2023-01-01',
'employeeNumber' => '1',
'title' => 'Software Engineer',
'department' => 'Product',
'customFields' => [
[
'id' => '8ef9a712-cdae-4110-b1ea-9ba95abbee6e',
'name' => 'Tshirt Size',
'value' => 'M'
]
],
'entityId' => '37ad8c1e-0187-4e10-8c54-395e3385b4d2'
],
'notes' => '<string>'
]),
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://api.cadanapay.com/v1/persons/{personId}/changeRequests/{changeRequestId}"
payload := strings.NewReader("{\n \"compInfo\": {\n \"type\": \"net\",\n \"frequency\": \"monthly\",\n \"allowances\": [\n {\n \"name\": \"Housing\",\n \"amount\": {\n \"amount\": 10000,\n \"currency\": \"USD\"\n },\n \"isTaxable\": true\n }\n ],\n \"employmentModel\": \"eor\"\n },\n \"effectiveDate\": \"2027-01-01\",\n \"jobInfo\": {\n \"startDate\": \"2023-01-01\",\n \"employeeNumber\": \"1\",\n \"title\": \"Software Engineer\",\n \"department\": \"Product\",\n \"customFields\": [\n {\n \"id\": \"8ef9a712-cdae-4110-b1ea-9ba95abbee6e\",\n \"name\": \"Tshirt Size\",\n \"value\": \"M\"\n }\n ],\n \"entityId\": \"37ad8c1e-0187-4e10-8c54-395e3385b4d2\"\n },\n \"notes\": \"<string>\"\n}")
req, _ := http.NewRequest("PUT", 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.put("https://api.cadanapay.com/v1/persons/{personId}/changeRequests/{changeRequestId}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"compInfo\": {\n \"type\": \"net\",\n \"frequency\": \"monthly\",\n \"allowances\": [\n {\n \"name\": \"Housing\",\n \"amount\": {\n \"amount\": 10000,\n \"currency\": \"USD\"\n },\n \"isTaxable\": true\n }\n ],\n \"employmentModel\": \"eor\"\n },\n \"effectiveDate\": \"2027-01-01\",\n \"jobInfo\": {\n \"startDate\": \"2023-01-01\",\n \"employeeNumber\": \"1\",\n \"title\": \"Software Engineer\",\n \"department\": \"Product\",\n \"customFields\": [\n {\n \"id\": \"8ef9a712-cdae-4110-b1ea-9ba95abbee6e\",\n \"name\": \"Tshirt Size\",\n \"value\": \"M\"\n }\n ],\n \"entityId\": \"37ad8c1e-0187-4e10-8c54-395e3385b4d2\"\n },\n \"notes\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.cadanapay.com/v1/persons/{personId}/changeRequests/{changeRequestId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"compInfo\": {\n \"type\": \"net\",\n \"frequency\": \"monthly\",\n \"allowances\": [\n {\n \"name\": \"Housing\",\n \"amount\": {\n \"amount\": 10000,\n \"currency\": \"USD\"\n },\n \"isTaxable\": true\n }\n ],\n \"employmentModel\": \"eor\"\n },\n \"effectiveDate\": \"2027-01-01\",\n \"jobInfo\": {\n \"startDate\": \"2023-01-01\",\n \"employeeNumber\": \"1\",\n \"title\": \"Software Engineer\",\n \"department\": \"Product\",\n \"customFields\": [\n {\n \"id\": \"8ef9a712-cdae-4110-b1ea-9ba95abbee6e\",\n \"name\": \"Tshirt Size\",\n \"value\": \"M\"\n }\n ],\n \"entityId\": \"37ad8c1e-0187-4e10-8c54-395e3385b4d2\"\n },\n \"notes\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"code": "invalid_request_body",
"message": "The request body provided is not valid",
"params": {
"field": "Value is invalid."
}
}{
"code": "resource_not_found",
"message": "Requested resource could not be found."
}{
"code": "internal_error",
"message": "An unexpected error occurred. Please try again later."
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
Required when using a Platform API token. The tenant key identifying which business to operate on.
Path Parameters
The unique identifier for the person
The unique identifier for the change request
Body
application/json
Submit change request payload
Person's compensation information, how much will they get paid, currency and frequency
Show child attributes
Show child attributes
The date the change takes effect, in yyyy-MM-dd
Example:
"2027-01-01"
Available options:
annual_pay_adjustment, promotion, role_change, error_correction, other Person's job information, start date, job title, and employee number
Show child attributes
Show child attributes
Context for the review
Required when the change lowers the worker's salary plus allowances
Show child attributes
Show child attributes
Response
Change request resubmitted