Rate Scheme
Create Rate Scheme
Instance
Billable Item
Booking
Calendar Subscription
Invoice
Quote
Invoice Template
Project
Time Activity
Rate Scheme
Create Rate Scheme
WRITE
access to the ADMIN
module is required to access this endpointPOST
/
v2
/
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,
"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"
}
]
}
],
"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"
}'
{
"success": {
"id": 1
}
}
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
Response
200
application/json
Successful Operation
The response is of type object
.
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,
"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"
}
]
}
],
"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"
}'
{
"success": {
"id": 1
}
}