Create Adjustment
curl --request POST \
--url https://api.example.com/v1/adjustments \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"tutor_id": "<string>",
"period_start": "<string>",
"period_end": "<string>",
"amount_cents": 123,
"note": "<string>"
}
'import requests
url = "https://api.example.com/v1/adjustments"
payload = {
"tutor_id": "<string>",
"period_start": "<string>",
"period_end": "<string>",
"amount_cents": 123,
"note": "<string>"
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
tutor_id: '<string>',
period_start: '<string>',
period_end: '<string>',
amount_cents: 123,
note: '<string>'
})
};
fetch('https://api.example.com/v1/adjustments', 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.example.com/v1/adjustments",
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([
'tutor_id' => '<string>',
'period_start' => '<string>',
'period_end' => '<string>',
'amount_cents' => 123,
'note' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"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.example.com/v1/adjustments"
payload := strings.NewReader("{\n \"tutor_id\": \"<string>\",\n \"period_start\": \"<string>\",\n \"period_end\": \"<string>\",\n \"amount_cents\": 123,\n \"note\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<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.example.com/v1/adjustments")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"tutor_id\": \"<string>\",\n \"period_start\": \"<string>\",\n \"period_end\": \"<string>\",\n \"amount_cents\": 123,\n \"note\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/adjustments")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"tutor_id\": \"<string>\",\n \"period_start\": \"<string>\",\n \"period_end\": \"<string>\",\n \"amount_cents\": 123,\n \"note\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"tutor_id": "<string>",
"period_start": "<string>",
"period_end": "<string>",
"amount_cents": 123,
"note": "<string>",
"voided": false,
"created_at": "<string>"
}{
"error": {
"code": "not_found",
"message": "Session not found",
"status": 404,
"details": {}
}
}{
"error": {
"code": "not_found",
"message": "Session not found",
"status": 404,
"details": {}
}
}{
"error": {
"code": "not_found",
"message": "Session not found",
"status": 404,
"details": {}
}
}{
"error": {
"code": "not_found",
"message": "Session not found",
"status": 404,
"details": {}
}
}Operations
Create Adjustment
Record a payroll adjustment (manual credit/debit) for one of the org’s tutors.
A negative amount_cents is a deduction. tutor_id must be an accepted member
of your org (404 otherwise); period_end must be on or after period_start.
organization_id, created_by, and created_at are server-set.
Send an Idempotency-Key header to make retries safe — a repeat with the same
body replays the original response; a repeat with a different body is a 409.
POST
/
v1
/
adjustments
Create Adjustment
curl --request POST \
--url https://api.example.com/v1/adjustments \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"tutor_id": "<string>",
"period_start": "<string>",
"period_end": "<string>",
"amount_cents": 123,
"note": "<string>"
}
'import requests
url = "https://api.example.com/v1/adjustments"
payload = {
"tutor_id": "<string>",
"period_start": "<string>",
"period_end": "<string>",
"amount_cents": 123,
"note": "<string>"
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
tutor_id: '<string>',
period_start: '<string>',
period_end: '<string>',
amount_cents: 123,
note: '<string>'
})
};
fetch('https://api.example.com/v1/adjustments', 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.example.com/v1/adjustments",
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([
'tutor_id' => '<string>',
'period_start' => '<string>',
'period_end' => '<string>',
'amount_cents' => 123,
'note' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"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.example.com/v1/adjustments"
payload := strings.NewReader("{\n \"tutor_id\": \"<string>\",\n \"period_start\": \"<string>\",\n \"period_end\": \"<string>\",\n \"amount_cents\": 123,\n \"note\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<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.example.com/v1/adjustments")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"tutor_id\": \"<string>\",\n \"period_start\": \"<string>\",\n \"period_end\": \"<string>\",\n \"amount_cents\": 123,\n \"note\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/adjustments")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"tutor_id\": \"<string>\",\n \"period_start\": \"<string>\",\n \"period_end\": \"<string>\",\n \"amount_cents\": 123,\n \"note\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"tutor_id": "<string>",
"period_start": "<string>",
"period_end": "<string>",
"amount_cents": 123,
"note": "<string>",
"voided": false,
"created_at": "<string>"
}{
"error": {
"code": "not_found",
"message": "Session not found",
"status": 404,
"details": {}
}
}{
"error": {
"code": "not_found",
"message": "Session not found",
"status": 404,
"details": {}
}
}{
"error": {
"code": "not_found",
"message": "Session not found",
"status": 404,
"details": {}
}
}{
"error": {
"code": "not_found",
"message": "Session not found",
"status": 404,
"details": {}
}
}Authorizations
Org API key as Token token=ei_live_...
Headers
Body
application/json
POST /v1/adjustments → org_payroll_adjustments. A negative amount_cents
is a deduction. tutor_id must be an accepted member of the key's org.
Was this page helpful?