Get Rate Schemes

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"
            }
          ]
        }
      ],
      "clients": [
        {
          "id": 2342354,
          "name": "Sam Smith",
          "type": "person"
        }
      ],
      "projects": [
        {
          "id": 2342354,
          "name": "Andor S1 EP7 Annoucement",
          "code": "AND-S1-EP7",
          "description": "Colonel Yularen announces that the ISB has gained more surveillance and punitive authority, while Meero is challenged by Blevin for breaking protocol by accessing Imperial data without authorization.",
          "start": 1547501100,
          "end": 1547538900,
          "parent_id": 9348,
          "status_id": 1
        }
      ],
      "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
    }
  }
}

GET

rate-scheme

Get Rate Schemes

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"
            }
          ]
        }
      ],
      "clients": [
        {
          "id": 2342354,
          "name": "Sam Smith",
          "type": "person"
        }
      ],
      "projects": [
        {
          "id": 2342354,
          "name": "Andor S1 EP7 Annoucement",
          "code": "AND-S1-EP7",
          "description": "Colonel Yularen announces that the ISB has gained more surveillance and punitive authority, while Meero is challenged by Blevin for breaking protocol by accessing Imperial data without authorization.",
          "start": 1547501100,
          "end": 1547538900,
          "parent_id": 9348,
          "status_id": 1
        }
      ],
      "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

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

string

One or more (comma seperated) ids of Rate Schemes to retrieve

fields

string

Comma seperated list of fields you wish to return

page

integer

Specify the page of results you wish to return

limit

integer

The number of results returned per page. Default if not specified is 10

order_asc

string

Specify the field (with type of string or integer) you wish to order (ascending) the response with

order_desc

string

Specify the field (with type of string or integer) you wish to order (descending) the response with

filter_operator

enum<string>

default:OR

Specify if multiple filters should be combined with OR or AND logic

Available options:

OR,

AND

Response

Successful Operation

data

Rate Scheme Model · object[]

Show child attributes

data.id

integer

Automatically generated, unique rate scheme id

Example:

13409

data.name

string

Name of the rate scheme

Example:

"Sydney Grading Suites Standard Rates"

data.type_id

integer

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

data.description

string

General information about the rate scheme

Example:

"Standard rates for grading suites located in Sydney"

data.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)"

data.resources

Resource Summary Model · object[]

Resources that this rate scheme is scoped to

Show child attributes

data.resources.id

integer

Automatically generated unique resource id

Example:

9458

data.resources.name

string

Name of the resource

Example:

"Edit Suite 1"

data.resources.description

string

Additional info about the resource

Example:

"Sydney Office, Level 2"

data.resources.type_id

enum<integer>

1 = Room, 2 = Person, 3 = Equipment, 4 = Resource Group, 5 = Action

Available options:

1,

2,

3,

4,

5

Example:

1

data.resources.type_person_id

integer

Unique id of the person (only applies if this resource is a person)

Example:

0

data.resources.parent_id

integer

Unique id of the resource group that this resource is a child of

Example:

2908

data.resources.parent_name

string

Name of the parent

Example:

"Cameras"

data.resources.updated

integer

The UNIX time value of the last update

Example:

1388552400

data.resources.icon

File Summary Model · object[]

Show child attributes

data.resources.icon.id

integer

Automatically generated File ID

Example:

2342354

data.resources.icon.name

string

Original file name

Example:

"Avid_Icon"

data.resources.icon.size

integer

File size (in bytes)

Example:

174285

data.resources.icon.alias

string

Automatically generated file alias

Example:

"7e73ab25155974c230d09494548201b9f5056ef"

data.resources.icon.extension

string

File extension

Example:

"png"

data.resources.icon.mime_type

string

File mime type

Example:

"image/png"

data.clients

Client Summary Model · object[]

Clients that this rate scheme is scoped to

Show child attributes

data.clients.id

integer

Automatically generated Project ID

Example:

2342354

data.clients.name

string

Full name of the contact

Example:

"Sam Smith"

data.clients.type

enum<string>

Type of the contact

Available options:

person,

organization

Example:

"person"

data.projects

Project Summary Model · object[]

Projects that this rate scheme is scoped to

Show child attributes

data.projects.id

integer

Automatically generated Project ID

Example:

2342354

data.projects.name

string

Title of the project

Example:

"Andor S1 EP7 Annoucement"

data.projects.code

string

Short code used to identify the project

Example:

"AND-S1-EP7"

data.projects.description

string

A short description or synopsis of the project

Example:

"Colonel Yularen announces that the ISB has gained more surveillance and punitive authority, while Meero is challenged by Blevin for breaking protocol by accessing Imperial data without authorization."

data.projects.start

integer

Unix Timestamp of the project start time frame.

Example:

1547501100

data.projects.end

integer

Unix timestamp of the project end time frame.

Example:

1547538900

data.projects.parent_id

integer

Project Parent ID

Example:

9348

data.projects.status_id

integer

Project Status ID

Example:

1

data.hour_rate

integer<float>

Amount chargable hourly

Example:

"124.20"

data.hour_buy_rate

integer<float>

Amount payable hourly

Example:

"90.00"

data.hour_rate_percent

boolean

deprecated

Hourly rate is percentage based

data.day_rate

integer<float>

Amount chargable daily

Example:

"1200.00"

data.day_buy_rate

integer<float>

Amount payable daily

Example:

"800.00"

data.day_rate_percent

boolean

deprecated

Daily rate is percentage based

data.week_rate

integer<float>

Amount chargable weekly

Example:

"5000.00"

data.week_buy_rate

integer<float>

Amount payable weekly

Example:

"2100.00"

data.fixed_date

boolean

deprecated

True if the rate scheme does not recur every year

data.date_start

string

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

data.date_end

string

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

data.time_start

string

deprecated

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

data.time_end

string

deprecated

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

data.overtime_hours

integer<float>

Number of hours of booking before overtime rate is applicable

data.override_base

boolean

deprecated

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

data.default_unit

integer

deprecated

0 = Hourly, 1 = Daily

data.default_tax

integer

deprecated

0 = Dont Apply Tax, 1 = Apply Tax

data.taxes

Invoice Item Taxes · object[]

Show child attributes

data.taxes.id

integer

Unique id of the tax applied

Example:

3247

data.taxes.name

string

Name of the tax

Example:

"GST"

data.taxes.rate

string

Rate of the tax

Example:

"10.00"

data.taxes.total

string<float>

Total amount of tax

Example:

"151.00"

data.currency

string

Currency code (three character format)

Example:

"AUD"

data.created_id

integer

The unique ID of the person (user) who created this record

Example:

3

data.created

integer

The UNIX time value of the creation time

Example:

1388552400

data.updated_id

integer

The unique ID of the person (user) who last updated this record

Example:

3

data.updated

integer

The UNIX time value of the last update

Example:

1388552400

Instance

Billable Item

Booking

Calendar Subscription

Contact

Custom Field

Group

Invoice

Quote

Invoice Template

User

Project

Rate Scheme

Resource

Workspace

Status

Tax

Time Activity

Time Entry

Get Rate Schemes

Authorizations

Query Parameters

Response