Instance
Billable Item
Booking
Calendar Subscription
Invoice
Quote
Invoice Template
Project
Time Activity
Get Rate Schemes
Rate schemes function like rate cards, allowing you to define costs and discounts for each resource. They can be tailored based on criteria such as date, time, client, or a combination of these.
Each rate scheme lets you specify hourly, daily, and weekly buy and sell rates, providing flexibility to match your pricing structure.
READ
access to the ADMIN
module is required to access this endpointcurl --request GET \
--url https://api.sonderplan.com/v2/rate-scheme \
--header 'Authorization: Bearer <token>'
{
"data": [
{
"id": 13409,
"name": "Sydney Grading Suites Standard Rates",
"type_id": 1,
"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": [
{
"id": 9458,
"name": "Edit Suite 1",
"description": "Sydney Office, Level 2",
"type_id": 1,
"type_person_id": 0,
"parent_id": 2908,
"parent_name": "Cameras",
"updated": 1388552400,
"icon": [
{
"id": 2342354,
"name": "Avid_Icon",
"size": 174285,
"alias": "7e73ab25155974c230d09494548201b9f5056ef",
"extension": "png",
"mime_type": "image/png"
}
]
}
],
"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"
}
],
"currency": "AUD",
"created_id": 3,
"created": 1388552400,
"updated_id": 3,
"updated": 1388552400
}
],
"meta": {
"pagination": {
"total": 1,
"count": 1,
"per_page": 1,
"current_page": 1
}
}
}
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Query Parameters
One or more (comma seperated) ids of Rate Schemes to retrieve
Comma seperated list of fields you wish to return
Specify the page of results you wish to return
The number of results returned per page. Default if not specified is 10
Specify the field (with type of string or integer) you wish to order (ascending) the response with
Specify the field (with type of string or integer) you wish to order (descending) the response with
Specify if multiple filters should be combined with OR or AND logic
OR
, AND
Response
Standard rate scheme model that returns all properties by default
Automatically generated, unique rate scheme id
13409
Name of the rate scheme
"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
1
General information about the rate scheme
"Standard rates for grading suites located in Sydney"
Template used for quote/invoice line item descriptions when prefilled from a booking
"[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
Resource model summarised
Automatically generated unique resource id
9458
Name of the resource
"Edit Suite 1"
Additional info about the resource
"Sydney Office, Level 2"
1 = Room, 2 = Person, 3 = Equipment, 4 = Resource Group, 5 = Action
1
, 2
, 3
, 4
, 5
1
Unique id of the person (only applies if this resource is a person)
0
Unique id of the resource group that this resource is a child of
2908
Name of the parent
"Cameras"
The UNIX time value of the last update
1388552400
Simplified file model containing only a subset of fields
Automatically generated File ID
2342354
Original file name
"Avid_Icon"
File size (in bytes)
174285
Automatically generated file alias
"7e73ab25155974c230d09494548201b9f5056ef"
File extension
"png"
File mime type
"image/png"
Amount chargable hourly
"124.20"
Amount payable hourly
"90.00"
Hourly rate is percentage based
Amount chargable daily
"1200.00"
Amount payable daily
"800.00"
Daily rate is percentage based
Amount chargable weekly
"5000.00"
Amount payable weekly
"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
Currency code (three character format)
"AUD"
The unique ID of the person (user) who created this record
3
The UNIX time value of the creation time
1388552400
The unique ID of the person (user) who last updated this record
3
The UNIX time value of the last update
1388552400
curl --request GET \
--url https://api.sonderplan.com/v2/rate-scheme \
--header 'Authorization: Bearer <token>'
{
"data": [
{
"id": 13409,
"name": "Sydney Grading Suites Standard Rates",
"type_id": 1,
"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": [
{
"id": 9458,
"name": "Edit Suite 1",
"description": "Sydney Office, Level 2",
"type_id": 1,
"type_person_id": 0,
"parent_id": 2908,
"parent_name": "Cameras",
"updated": 1388552400,
"icon": [
{
"id": 2342354,
"name": "Avid_Icon",
"size": 174285,
"alias": "7e73ab25155974c230d09494548201b9f5056ef",
"extension": "png",
"mime_type": "image/png"
}
]
}
],
"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"
}
],
"currency": "AUD",
"created_id": 3,
"created": 1388552400,
"updated_id": 3,
"updated": 1388552400
}
],
"meta": {
"pagination": {
"total": 1,
"count": 1,
"per_page": 1,
"current_page": 1
}
}
}