POST
/
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

​
Authorization
string
header
required

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
string
required

Name of the rate scheme

Example:

"Sydney Grading Suites Standard Rates"

​
type_id
integer
required

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
string
required

Currency code (three character format)

Example:

"AUD"

​
description
string

General information about the rate scheme

Example:

"Standard rates for grading suites located in Sydney"

​
booking_description_template
string

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
object[]

Resources that this rate scheme is scoped to

Resource model summarised

​
hour_rate
integer

Amount chargable hourly

Example:

"124.20"

​
hour_buy_rate
integer

Amount payable hourly

Example:

"90.00"

​
hour_rate_percent
boolean
deprecated

Hourly rate is percentage based

​
day_rate
integer

Amount chargable daily

Example:

"1200.00"

​
day_buy_rate
integer

Amount payable daily

Example:

"800.00"

​
day_rate_percent
boolean
deprecated

Daily rate is percentage based

​
week_rate
integer

Amount chargable weekly

Example:

"5000.00"

​
week_buy_rate
integer

Amount payable weekly

Example:

"2100.00"

​
fixed_date
boolean
deprecated

True if the rate scheme does not recur every year

​
date_start
string

Date this rate scheme will begin applying, in YYYY-MM-DD format

​
date_end
string

Date this rate scheme will cease applying, in YYYY-MM-DD format

​
time_start
string
deprecated

Time this rate scheme will begin applying, in 00:00:00 format

​
time_end
string
deprecated

Time this rate scheme will cease applying, in 00:00:00 format

​
overtime_hours
integer

Number of hours of booking before overtime rate is applicable

​
override_base
boolean
deprecated

If true, other base rates will be replaced with this one

​
default_unit
integer
deprecated

0 = Hourly, 1 = Daily

​
default_tax
integer
deprecated

0 = Dont Apply Tax, 1 = Apply Tax

​
taxes
object[]

Standard invoice item taxes model that returns tax information

Response

200
application/json
Successful Operation
​
success
object