Create Rate Scheme
curl --request POST \
--url https://api.sonderplan.com/v2/rate-scheme \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "Sydney Grading Suites Standard Rates",
"type_id": 1,
"currency": "AUD",
"description": "Standard rates for grading suites located in Sydney",
"booking_description_template": "[rateSchemeName] - [rateSchemeDescription]\n [bookingName] - [rateSchemeStartDateCode]|(D jS M Y g:iA) --> [rateSchemeEndDateCode]|(D jS M Y g:iA)",
"resources": [
{
"name": "Edit Suite 1",
"description": "Sydney Office, Level 2",
"type_id": 1,
"type_person_id": 0,
"parent_id": 2908,
"parent_name": "Cameras",
"icon": [
{
"name": "Avid_Icon",
"size": 174285,
"alias": "7e73ab25155974c230d09494548201b9f5056ef",
"extension": "png",
"mime_type": "image/png"
}
]
}
],
"clients": [
{
"id": 2342354,
"name": "Sam Smith",
"type": "person"
}
],
"projects": [
{
"id": 2342354,
"start": 1547501100,
"end": 1547538900
}
],
"hour_rate": "124.20",
"hour_buy_rate": "90.00",
"hour_rate_percent": true,
"day_rate": "1200.00",
"day_buy_rate": "800.00",
"day_rate_percent": true,
"week_rate": "5000.00",
"week_buy_rate": "2100.00",
"fixed_date": true,
"date_start": "<string>",
"date_end": "<string>",
"time_start": "<string>",
"time_end": "<string>",
"overtime_hours": 123,
"override_base": true,
"default_unit": 123,
"default_tax": 123,
"taxes": [
{
"id": 3247,
"name": "GST",
"rate": "10.00",
"total": "151.00"
}
]
}
'import requests
url = "https://api.sonderplan.com/v2/rate-scheme"
payload = {
"name": "Sydney Grading Suites Standard Rates",
"type_id": 1,
"currency": "AUD",
"description": "Standard rates for grading suites located in Sydney",
"booking_description_template": "[rateSchemeName] - [rateSchemeDescription]
[bookingName] - [rateSchemeStartDateCode]|(D jS M Y g:iA) --> [rateSchemeEndDateCode]|(D jS M Y g:iA)",
"resources": [
{
"name": "Edit Suite 1",
"description": "Sydney Office, Level 2",
"type_id": 1,
"type_person_id": 0,
"parent_id": 2908,
"parent_name": "Cameras",
"icon": [
{
"name": "Avid_Icon",
"size": 174285,
"alias": "7e73ab25155974c230d09494548201b9f5056ef",
"extension": "png",
"mime_type": "image/png"
}
]
}
],
"clients": [
{
"id": 2342354,
"name": "Sam Smith",
"type": "person"
}
],
"projects": [
{
"id": 2342354,
"start": 1547501100,
"end": 1547538900
}
],
"hour_rate": "124.20",
"hour_buy_rate": "90.00",
"hour_rate_percent": True,
"day_rate": "1200.00",
"day_buy_rate": "800.00",
"day_rate_percent": True,
"week_rate": "5000.00",
"week_buy_rate": "2100.00",
"fixed_date": True,
"date_start": "<string>",
"date_end": "<string>",
"time_start": "<string>",
"time_end": "<string>",
"overtime_hours": 123,
"override_base": True,
"default_unit": 123,
"default_tax": 123,
"taxes": [
{
"id": 3247,
"name": "GST",
"rate": "10.00",
"total": "151.00"
}
]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'Sydney Grading Suites Standard Rates',
type_id: 1,
currency: 'AUD',
description: 'Standard rates for grading suites located in Sydney',
booking_description_template: '[rateSchemeName] - [rateSchemeDescription]\n [bookingName] - [rateSchemeStartDateCode]|(D jS M Y g:iA) --> [rateSchemeEndDateCode]|(D jS M Y g:iA)',
resources: [
{
name: 'Edit Suite 1',
description: 'Sydney Office, Level 2',
type_id: 1,
type_person_id: 0,
parent_id: 2908,
parent_name: 'Cameras',
icon: [
{
name: 'Avid_Icon',
size: 174285,
alias: '7e73ab25155974c230d09494548201b9f5056ef',
extension: 'png',
mime_type: 'image/png'
}
]
}
],
clients: [{id: 2342354, name: 'Sam Smith', type: 'person'}],
projects: [{id: 2342354, start: 1547501100, end: 1547538900}],
hour_rate: '124.20',
hour_buy_rate: '90.00',
hour_rate_percent: true,
day_rate: '1200.00',
day_buy_rate: '800.00',
day_rate_percent: true,
week_rate: '5000.00',
week_buy_rate: '2100.00',
fixed_date: true,
date_start: '<string>',
date_end: '<string>',
time_start: '<string>',
time_end: '<string>',
overtime_hours: 123,
override_base: true,
default_unit: 123,
default_tax: 123,
taxes: [{id: 3247, name: 'GST', rate: '10.00', total: '151.00'}]
})
};
fetch('https://api.sonderplan.com/v2/rate-scheme', 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.sonderplan.com/v2/rate-scheme",
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([
'name' => 'Sydney Grading Suites Standard Rates',
'type_id' => 1,
'currency' => 'AUD',
'description' => 'Standard rates for grading suites located in Sydney',
'booking_description_template' => '[rateSchemeName] - [rateSchemeDescription]
[bookingName] - [rateSchemeStartDateCode]|(D jS M Y g:iA) --> [rateSchemeEndDateCode]|(D jS M Y g:iA)',
'resources' => [
[
'name' => 'Edit Suite 1',
'description' => 'Sydney Office, Level 2',
'type_id' => 1,
'type_person_id' => 0,
'parent_id' => 2908,
'parent_name' => 'Cameras',
'icon' => [
[
'name' => 'Avid_Icon',
'size' => 174285,
'alias' => '7e73ab25155974c230d09494548201b9f5056ef',
'extension' => 'png',
'mime_type' => 'image/png'
]
]
]
],
'clients' => [
[
'id' => 2342354,
'name' => 'Sam Smith',
'type' => 'person'
]
],
'projects' => [
[
'id' => 2342354,
'start' => 1547501100,
'end' => 1547538900
]
],
'hour_rate' => '124.20',
'hour_buy_rate' => '90.00',
'hour_rate_percent' => true,
'day_rate' => '1200.00',
'day_buy_rate' => '800.00',
'day_rate_percent' => true,
'week_rate' => '5000.00',
'week_buy_rate' => '2100.00',
'fixed_date' => true,
'date_start' => '<string>',
'date_end' => '<string>',
'time_start' => '<string>',
'time_end' => '<string>',
'overtime_hours' => 123,
'override_base' => true,
'default_unit' => 123,
'default_tax' => 123,
'taxes' => [
[
'id' => 3247,
'name' => 'GST',
'rate' => '10.00',
'total' => '151.00'
]
]
]),
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.sonderplan.com/v2/rate-scheme"
payload := strings.NewReader("{\n \"name\": \"Sydney Grading Suites Standard Rates\",\n \"type_id\": 1,\n \"currency\": \"AUD\",\n \"description\": \"Standard rates for grading suites located in Sydney\",\n \"booking_description_template\": \"[rateSchemeName] - [rateSchemeDescription]\\n [bookingName] - [rateSchemeStartDateCode]|(D jS M Y g:iA) --> [rateSchemeEndDateCode]|(D jS M Y g:iA)\",\n \"resources\": [\n {\n \"name\": \"Edit Suite 1\",\n \"description\": \"Sydney Office, Level 2\",\n \"type_id\": 1,\n \"type_person_id\": 0,\n \"parent_id\": 2908,\n \"parent_name\": \"Cameras\",\n \"icon\": [\n {\n \"name\": \"Avid_Icon\",\n \"size\": 174285,\n \"alias\": \"7e73ab25155974c230d09494548201b9f5056ef\",\n \"extension\": \"png\",\n \"mime_type\": \"image/png\"\n }\n ]\n }\n ],\n \"clients\": [\n {\n \"id\": 2342354,\n \"name\": \"Sam Smith\",\n \"type\": \"person\"\n }\n ],\n \"projects\": [\n {\n \"id\": 2342354,\n \"start\": 1547501100,\n \"end\": 1547538900\n }\n ],\n \"hour_rate\": \"124.20\",\n \"hour_buy_rate\": \"90.00\",\n \"hour_rate_percent\": true,\n \"day_rate\": \"1200.00\",\n \"day_buy_rate\": \"800.00\",\n \"day_rate_percent\": true,\n \"week_rate\": \"5000.00\",\n \"week_buy_rate\": \"2100.00\",\n \"fixed_date\": true,\n \"date_start\": \"<string>\",\n \"date_end\": \"<string>\",\n \"time_start\": \"<string>\",\n \"time_end\": \"<string>\",\n \"overtime_hours\": 123,\n \"override_base\": true,\n \"default_unit\": 123,\n \"default_tax\": 123,\n \"taxes\": [\n {\n \"id\": 3247,\n \"name\": \"GST\",\n \"rate\": \"10.00\",\n \"total\": \"151.00\"\n }\n ]\n}")
req, _ := http.NewRequest("POST", 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.post("https://api.sonderplan.com/v2/rate-scheme")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Sydney Grading Suites Standard Rates\",\n \"type_id\": 1,\n \"currency\": \"AUD\",\n \"description\": \"Standard rates for grading suites located in Sydney\",\n \"booking_description_template\": \"[rateSchemeName] - [rateSchemeDescription]\\n [bookingName] - [rateSchemeStartDateCode]|(D jS M Y g:iA) --> [rateSchemeEndDateCode]|(D jS M Y g:iA)\",\n \"resources\": [\n {\n \"name\": \"Edit Suite 1\",\n \"description\": \"Sydney Office, Level 2\",\n \"type_id\": 1,\n \"type_person_id\": 0,\n \"parent_id\": 2908,\n \"parent_name\": \"Cameras\",\n \"icon\": [\n {\n \"name\": \"Avid_Icon\",\n \"size\": 174285,\n \"alias\": \"7e73ab25155974c230d09494548201b9f5056ef\",\n \"extension\": \"png\",\n \"mime_type\": \"image/png\"\n }\n ]\n }\n ],\n \"clients\": [\n {\n \"id\": 2342354,\n \"name\": \"Sam Smith\",\n \"type\": \"person\"\n }\n ],\n \"projects\": [\n {\n \"id\": 2342354,\n \"start\": 1547501100,\n \"end\": 1547538900\n }\n ],\n \"hour_rate\": \"124.20\",\n \"hour_buy_rate\": \"90.00\",\n \"hour_rate_percent\": true,\n \"day_rate\": \"1200.00\",\n \"day_buy_rate\": \"800.00\",\n \"day_rate_percent\": true,\n \"week_rate\": \"5000.00\",\n \"week_buy_rate\": \"2100.00\",\n \"fixed_date\": true,\n \"date_start\": \"<string>\",\n \"date_end\": \"<string>\",\n \"time_start\": \"<string>\",\n \"time_end\": \"<string>\",\n \"overtime_hours\": 123,\n \"override_base\": true,\n \"default_unit\": 123,\n \"default_tax\": 123,\n \"taxes\": [\n {\n \"id\": 3247,\n \"name\": \"GST\",\n \"rate\": \"10.00\",\n \"total\": \"151.00\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sonderplan.com/v2/rate-scheme")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"Sydney Grading Suites Standard Rates\",\n \"type_id\": 1,\n \"currency\": \"AUD\",\n \"description\": \"Standard rates for grading suites located in Sydney\",\n \"booking_description_template\": \"[rateSchemeName] - [rateSchemeDescription]\\n [bookingName] - [rateSchemeStartDateCode]|(D jS M Y g:iA) --> [rateSchemeEndDateCode]|(D jS M Y g:iA)\",\n \"resources\": [\n {\n \"name\": \"Edit Suite 1\",\n \"description\": \"Sydney Office, Level 2\",\n \"type_id\": 1,\n \"type_person_id\": 0,\n \"parent_id\": 2908,\n \"parent_name\": \"Cameras\",\n \"icon\": [\n {\n \"name\": \"Avid_Icon\",\n \"size\": 174285,\n \"alias\": \"7e73ab25155974c230d09494548201b9f5056ef\",\n \"extension\": \"png\",\n \"mime_type\": \"image/png\"\n }\n ]\n }\n ],\n \"clients\": [\n {\n \"id\": 2342354,\n \"name\": \"Sam Smith\",\n \"type\": \"person\"\n }\n ],\n \"projects\": [\n {\n \"id\": 2342354,\n \"start\": 1547501100,\n \"end\": 1547538900\n }\n ],\n \"hour_rate\": \"124.20\",\n \"hour_buy_rate\": \"90.00\",\n \"hour_rate_percent\": true,\n \"day_rate\": \"1200.00\",\n \"day_buy_rate\": \"800.00\",\n \"day_rate_percent\": true,\n \"week_rate\": \"5000.00\",\n \"week_buy_rate\": \"2100.00\",\n \"fixed_date\": true,\n \"date_start\": \"<string>\",\n \"date_end\": \"<string>\",\n \"time_start\": \"<string>\",\n \"time_end\": \"<string>\",\n \"overtime_hours\": 123,\n \"override_base\": true,\n \"default_unit\": 123,\n \"default_tax\": 123,\n \"taxes\": [\n {\n \"id\": 3247,\n \"name\": \"GST\",\n \"rate\": \"10.00\",\n \"total\": \"151.00\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"success": {
"id": 1
}
}{
"error": {
"code": "404",
"message": "Requested resource was not found"
}
}Rate Scheme
Create Rate Scheme
WRITE access to the ADMIN module is required to access this endpointPOST
/
v2
/
rate-scheme
Create Rate Scheme
curl --request POST \
--url https://api.sonderplan.com/v2/rate-scheme \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "Sydney Grading Suites Standard Rates",
"type_id": 1,
"currency": "AUD",
"description": "Standard rates for grading suites located in Sydney",
"booking_description_template": "[rateSchemeName] - [rateSchemeDescription]\n [bookingName] - [rateSchemeStartDateCode]|(D jS M Y g:iA) --> [rateSchemeEndDateCode]|(D jS M Y g:iA)",
"resources": [
{
"name": "Edit Suite 1",
"description": "Sydney Office, Level 2",
"type_id": 1,
"type_person_id": 0,
"parent_id": 2908,
"parent_name": "Cameras",
"icon": [
{
"name": "Avid_Icon",
"size": 174285,
"alias": "7e73ab25155974c230d09494548201b9f5056ef",
"extension": "png",
"mime_type": "image/png"
}
]
}
],
"clients": [
{
"id": 2342354,
"name": "Sam Smith",
"type": "person"
}
],
"projects": [
{
"id": 2342354,
"start": 1547501100,
"end": 1547538900
}
],
"hour_rate": "124.20",
"hour_buy_rate": "90.00",
"hour_rate_percent": true,
"day_rate": "1200.00",
"day_buy_rate": "800.00",
"day_rate_percent": true,
"week_rate": "5000.00",
"week_buy_rate": "2100.00",
"fixed_date": true,
"date_start": "<string>",
"date_end": "<string>",
"time_start": "<string>",
"time_end": "<string>",
"overtime_hours": 123,
"override_base": true,
"default_unit": 123,
"default_tax": 123,
"taxes": [
{
"id": 3247,
"name": "GST",
"rate": "10.00",
"total": "151.00"
}
]
}
'import requests
url = "https://api.sonderplan.com/v2/rate-scheme"
payload = {
"name": "Sydney Grading Suites Standard Rates",
"type_id": 1,
"currency": "AUD",
"description": "Standard rates for grading suites located in Sydney",
"booking_description_template": "[rateSchemeName] - [rateSchemeDescription]
[bookingName] - [rateSchemeStartDateCode]|(D jS M Y g:iA) --> [rateSchemeEndDateCode]|(D jS M Y g:iA)",
"resources": [
{
"name": "Edit Suite 1",
"description": "Sydney Office, Level 2",
"type_id": 1,
"type_person_id": 0,
"parent_id": 2908,
"parent_name": "Cameras",
"icon": [
{
"name": "Avid_Icon",
"size": 174285,
"alias": "7e73ab25155974c230d09494548201b9f5056ef",
"extension": "png",
"mime_type": "image/png"
}
]
}
],
"clients": [
{
"id": 2342354,
"name": "Sam Smith",
"type": "person"
}
],
"projects": [
{
"id": 2342354,
"start": 1547501100,
"end": 1547538900
}
],
"hour_rate": "124.20",
"hour_buy_rate": "90.00",
"hour_rate_percent": True,
"day_rate": "1200.00",
"day_buy_rate": "800.00",
"day_rate_percent": True,
"week_rate": "5000.00",
"week_buy_rate": "2100.00",
"fixed_date": True,
"date_start": "<string>",
"date_end": "<string>",
"time_start": "<string>",
"time_end": "<string>",
"overtime_hours": 123,
"override_base": True,
"default_unit": 123,
"default_tax": 123,
"taxes": [
{
"id": 3247,
"name": "GST",
"rate": "10.00",
"total": "151.00"
}
]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'Sydney Grading Suites Standard Rates',
type_id: 1,
currency: 'AUD',
description: 'Standard rates for grading suites located in Sydney',
booking_description_template: '[rateSchemeName] - [rateSchemeDescription]\n [bookingName] - [rateSchemeStartDateCode]|(D jS M Y g:iA) --> [rateSchemeEndDateCode]|(D jS M Y g:iA)',
resources: [
{
name: 'Edit Suite 1',
description: 'Sydney Office, Level 2',
type_id: 1,
type_person_id: 0,
parent_id: 2908,
parent_name: 'Cameras',
icon: [
{
name: 'Avid_Icon',
size: 174285,
alias: '7e73ab25155974c230d09494548201b9f5056ef',
extension: 'png',
mime_type: 'image/png'
}
]
}
],
clients: [{id: 2342354, name: 'Sam Smith', type: 'person'}],
projects: [{id: 2342354, start: 1547501100, end: 1547538900}],
hour_rate: '124.20',
hour_buy_rate: '90.00',
hour_rate_percent: true,
day_rate: '1200.00',
day_buy_rate: '800.00',
day_rate_percent: true,
week_rate: '5000.00',
week_buy_rate: '2100.00',
fixed_date: true,
date_start: '<string>',
date_end: '<string>',
time_start: '<string>',
time_end: '<string>',
overtime_hours: 123,
override_base: true,
default_unit: 123,
default_tax: 123,
taxes: [{id: 3247, name: 'GST', rate: '10.00', total: '151.00'}]
})
};
fetch('https://api.sonderplan.com/v2/rate-scheme', 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.sonderplan.com/v2/rate-scheme",
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([
'name' => 'Sydney Grading Suites Standard Rates',
'type_id' => 1,
'currency' => 'AUD',
'description' => 'Standard rates for grading suites located in Sydney',
'booking_description_template' => '[rateSchemeName] - [rateSchemeDescription]
[bookingName] - [rateSchemeStartDateCode]|(D jS M Y g:iA) --> [rateSchemeEndDateCode]|(D jS M Y g:iA)',
'resources' => [
[
'name' => 'Edit Suite 1',
'description' => 'Sydney Office, Level 2',
'type_id' => 1,
'type_person_id' => 0,
'parent_id' => 2908,
'parent_name' => 'Cameras',
'icon' => [
[
'name' => 'Avid_Icon',
'size' => 174285,
'alias' => '7e73ab25155974c230d09494548201b9f5056ef',
'extension' => 'png',
'mime_type' => 'image/png'
]
]
]
],
'clients' => [
[
'id' => 2342354,
'name' => 'Sam Smith',
'type' => 'person'
]
],
'projects' => [
[
'id' => 2342354,
'start' => 1547501100,
'end' => 1547538900
]
],
'hour_rate' => '124.20',
'hour_buy_rate' => '90.00',
'hour_rate_percent' => true,
'day_rate' => '1200.00',
'day_buy_rate' => '800.00',
'day_rate_percent' => true,
'week_rate' => '5000.00',
'week_buy_rate' => '2100.00',
'fixed_date' => true,
'date_start' => '<string>',
'date_end' => '<string>',
'time_start' => '<string>',
'time_end' => '<string>',
'overtime_hours' => 123,
'override_base' => true,
'default_unit' => 123,
'default_tax' => 123,
'taxes' => [
[
'id' => 3247,
'name' => 'GST',
'rate' => '10.00',
'total' => '151.00'
]
]
]),
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.sonderplan.com/v2/rate-scheme"
payload := strings.NewReader("{\n \"name\": \"Sydney Grading Suites Standard Rates\",\n \"type_id\": 1,\n \"currency\": \"AUD\",\n \"description\": \"Standard rates for grading suites located in Sydney\",\n \"booking_description_template\": \"[rateSchemeName] - [rateSchemeDescription]\\n [bookingName] - [rateSchemeStartDateCode]|(D jS M Y g:iA) --> [rateSchemeEndDateCode]|(D jS M Y g:iA)\",\n \"resources\": [\n {\n \"name\": \"Edit Suite 1\",\n \"description\": \"Sydney Office, Level 2\",\n \"type_id\": 1,\n \"type_person_id\": 0,\n \"parent_id\": 2908,\n \"parent_name\": \"Cameras\",\n \"icon\": [\n {\n \"name\": \"Avid_Icon\",\n \"size\": 174285,\n \"alias\": \"7e73ab25155974c230d09494548201b9f5056ef\",\n \"extension\": \"png\",\n \"mime_type\": \"image/png\"\n }\n ]\n }\n ],\n \"clients\": [\n {\n \"id\": 2342354,\n \"name\": \"Sam Smith\",\n \"type\": \"person\"\n }\n ],\n \"projects\": [\n {\n \"id\": 2342354,\n \"start\": 1547501100,\n \"end\": 1547538900\n }\n ],\n \"hour_rate\": \"124.20\",\n \"hour_buy_rate\": \"90.00\",\n \"hour_rate_percent\": true,\n \"day_rate\": \"1200.00\",\n \"day_buy_rate\": \"800.00\",\n \"day_rate_percent\": true,\n \"week_rate\": \"5000.00\",\n \"week_buy_rate\": \"2100.00\",\n \"fixed_date\": true,\n \"date_start\": \"<string>\",\n \"date_end\": \"<string>\",\n \"time_start\": \"<string>\",\n \"time_end\": \"<string>\",\n \"overtime_hours\": 123,\n \"override_base\": true,\n \"default_unit\": 123,\n \"default_tax\": 123,\n \"taxes\": [\n {\n \"id\": 3247,\n \"name\": \"GST\",\n \"rate\": \"10.00\",\n \"total\": \"151.00\"\n }\n ]\n}")
req, _ := http.NewRequest("POST", 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.post("https://api.sonderplan.com/v2/rate-scheme")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Sydney Grading Suites Standard Rates\",\n \"type_id\": 1,\n \"currency\": \"AUD\",\n \"description\": \"Standard rates for grading suites located in Sydney\",\n \"booking_description_template\": \"[rateSchemeName] - [rateSchemeDescription]\\n [bookingName] - [rateSchemeStartDateCode]|(D jS M Y g:iA) --> [rateSchemeEndDateCode]|(D jS M Y g:iA)\",\n \"resources\": [\n {\n \"name\": \"Edit Suite 1\",\n \"description\": \"Sydney Office, Level 2\",\n \"type_id\": 1,\n \"type_person_id\": 0,\n \"parent_id\": 2908,\n \"parent_name\": \"Cameras\",\n \"icon\": [\n {\n \"name\": \"Avid_Icon\",\n \"size\": 174285,\n \"alias\": \"7e73ab25155974c230d09494548201b9f5056ef\",\n \"extension\": \"png\",\n \"mime_type\": \"image/png\"\n }\n ]\n }\n ],\n \"clients\": [\n {\n \"id\": 2342354,\n \"name\": \"Sam Smith\",\n \"type\": \"person\"\n }\n ],\n \"projects\": [\n {\n \"id\": 2342354,\n \"start\": 1547501100,\n \"end\": 1547538900\n }\n ],\n \"hour_rate\": \"124.20\",\n \"hour_buy_rate\": \"90.00\",\n \"hour_rate_percent\": true,\n \"day_rate\": \"1200.00\",\n \"day_buy_rate\": \"800.00\",\n \"day_rate_percent\": true,\n \"week_rate\": \"5000.00\",\n \"week_buy_rate\": \"2100.00\",\n \"fixed_date\": true,\n \"date_start\": \"<string>\",\n \"date_end\": \"<string>\",\n \"time_start\": \"<string>\",\n \"time_end\": \"<string>\",\n \"overtime_hours\": 123,\n \"override_base\": true,\n \"default_unit\": 123,\n \"default_tax\": 123,\n \"taxes\": [\n {\n \"id\": 3247,\n \"name\": \"GST\",\n \"rate\": \"10.00\",\n \"total\": \"151.00\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sonderplan.com/v2/rate-scheme")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"Sydney Grading Suites Standard Rates\",\n \"type_id\": 1,\n \"currency\": \"AUD\",\n \"description\": \"Standard rates for grading suites located in Sydney\",\n \"booking_description_template\": \"[rateSchemeName] - [rateSchemeDescription]\\n [bookingName] - [rateSchemeStartDateCode]|(D jS M Y g:iA) --> [rateSchemeEndDateCode]|(D jS M Y g:iA)\",\n \"resources\": [\n {\n \"name\": \"Edit Suite 1\",\n \"description\": \"Sydney Office, Level 2\",\n \"type_id\": 1,\n \"type_person_id\": 0,\n \"parent_id\": 2908,\n \"parent_name\": \"Cameras\",\n \"icon\": [\n {\n \"name\": \"Avid_Icon\",\n \"size\": 174285,\n \"alias\": \"7e73ab25155974c230d09494548201b9f5056ef\",\n \"extension\": \"png\",\n \"mime_type\": \"image/png\"\n }\n ]\n }\n ],\n \"clients\": [\n {\n \"id\": 2342354,\n \"name\": \"Sam Smith\",\n \"type\": \"person\"\n }\n ],\n \"projects\": [\n {\n \"id\": 2342354,\n \"start\": 1547501100,\n \"end\": 1547538900\n }\n ],\n \"hour_rate\": \"124.20\",\n \"hour_buy_rate\": \"90.00\",\n \"hour_rate_percent\": true,\n \"day_rate\": \"1200.00\",\n \"day_buy_rate\": \"800.00\",\n \"day_rate_percent\": true,\n \"week_rate\": \"5000.00\",\n \"week_buy_rate\": \"2100.00\",\n \"fixed_date\": true,\n \"date_start\": \"<string>\",\n \"date_end\": \"<string>\",\n \"time_start\": \"<string>\",\n \"time_end\": \"<string>\",\n \"overtime_hours\": 123,\n \"override_base\": true,\n \"default_unit\": 123,\n \"default_tax\": 123,\n \"taxes\": [\n {\n \"id\": 3247,\n \"name\": \"GST\",\n \"rate\": \"10.00\",\n \"total\": \"151.00\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"success": {
"id": 1
}
}{
"error": {
"code": "404",
"message": "Requested resource was not found"
}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/json
Rate Scheme object that needs to be added
Standard rate scheme model that returns all properties by default
Name of the rate scheme
Example:
"Sydney Grading Suites Standard Rates"
1 = Service Rate, 2 = Seasonal Adjustment (Deprecated), 3 = Hourly Adjustment (Deprecated), 4 = Client Rate, 5 = Advanced Adjustment (Deprecated), 6 = Project Rate, 7 = Overtime Adjustment (Deprecated), 8 = Custom Field Option Adjustment (Deprecated), 9 = Resource Base, 10 = Resource Weekend, 11 = Resource Public Holiday
Example:
1
Currency code (three character format)
Example:
"AUD"
General information about the rate scheme
Example:
"Standard rates for grading suites located in Sydney"
Template used for quote/invoice line item descriptions when prefilled from a booking
Example:
"[rateSchemeName] - [rateSchemeDescription]\n [bookingName] - [rateSchemeStartDateCode]|(D jS M Y g:iA) --> [rateSchemeEndDateCode]|(D jS M Y g:iA)"
Resources that this rate scheme is scoped to
Show child attributes
Show child attributes
Clients that this rate scheme is scoped to
Show child attributes
Show child attributes
Projects that this rate scheme is scoped to
Show child attributes
Show child attributes
Amount chargable hourly
Example:
"124.20"
Amount payable hourly
Example:
"90.00"
Hourly rate is percentage based
Amount chargable daily
Example:
"1200.00"
Amount payable daily
Example:
"800.00"
Daily rate is percentage based
Amount chargable weekly
Example:
"5000.00"
Amount payable weekly
Example:
"2100.00"
True if the rate scheme does not recur every year
Date this rate scheme will begin applying, in YYYY-MM-DD format
Date this rate scheme will cease applying, in YYYY-MM-DD format
Time this rate scheme will begin applying, in 00:00:00 format
Time this rate scheme will cease applying, in 00:00:00 format
Number of hours of booking before overtime rate is applicable
If true, other base rates will be replaced with this one
0 = Hourly, 1 = Daily
0 = Dont Apply Tax, 1 = Apply Tax
Show child attributes
Show child attributes
Response
Successful Operation
Show child attributes
Show child attributes
⌘I