Instance
Billable Item
Booking
Calendar Subscription
Invoice
Quote
Invoice Template
Project
Time Activity
Get Quotes
In Sonderplan, a quote is a detailed proposal that outlines the estimated costs for a project or set of bookings.
Quotes typically include information such as the client, associated bookings, resources, rates, taxes, discounts, and any additional charges or custom details. They are used to provide clients with a clear breakdown of costs before confirming a project, helping ensure transparency and agreement on pricing.
Once approved, quotes can often be converted into invoices or used as a basis for further planning.
READ access to the SALES module is required to access this endpointcurl --request GET \
--url https://api.sonderplan.com/v2/quote \
--header 'Authorization: Bearer <token>'{
"data": [
{
"id": 1,
"prefix": "INV-",
"number": 892,
"date": 1547501100,
"date_time_iso": "2022-02-22T09:00:00+11:00",
"expiry_date": 1547501100,
"expiry_date_time_iso": "2022-02-22T09:00:00+11:00",
"items": [
{
"id": 982342,
"item_text": "Edit Suite 1 Grading",
"item_uuid": "r2394",
"ratescheme_id": 989234,
"description": "Session booked between 10th Jan -> 12th Jan 2023",
"quantity": "2.4",
"unit": "hourly",
"unit_amount": "20.65",
"unit_buy_amount": "10.15",
"tax": true,
"taxes": [
{
"id": 3247,
"name": "GST",
"rate": "10.00",
"total": "151.00"
}
],
"discount": "20.00%",
"total": "495.00",
"buy_total": "200.00",
"buy_total_fixed": false,
"order": 2,
"parent_group_id": 234842
}
],
"groups": [
{
"id": 23425,
"name": "Video Editing Services",
"description": "Includes all editing services",
"order": 2,
"hide_items": true
}
],
"status": [
{
"id": 2,
"name": "Sent"
}
],
"project": [
{
"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.",
"status_id": 1
}
],
"client": [
{
"id": 4,
"uuid": "p4",
"name": "Jane Someone",
"type": "person",
"email": "[email protected]",
"contact_person": {
"id": 2837,
"name": "Fred Flintstone"
}
}
],
"custom_fields": [
{
"id": 7823,
"name": "Type",
"value": "Video Editing",
"value_id": 8973,
"update_key": "2_1_7823"
}
],
"terms": "Expires in 30 days, subject to stock confirmation etc",
"template_id": 213,
"cloned_id": 545647,
"reference": "QU-9893",
"currency": "AUD",
"sub_total": "1289.29",
"discount_total": "872.98",
"net_total": "416.31",
"tax_total": "129.87",
"total": "546.18",
"created_sp_flag": "true",
"created_id": 3,
"created": 1388552400,
"created_name": "John Smith",
"updated_id": 3,
"updated": 1388552400,
"updated_name": "John Smith"
}
],
"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 quotes to retrieve
Perform a partial match text search for the quote prefix
One or more (comma seperated) quote numbers to retrieve
Perform an exact match for the quote status_id. 1 = Draft, 2 = Sent, 3 = Accepted, 4 = Invoiced, 5 = Declined
Perform an exact match for the quote project_id
Return quotes with created date greater than this UNIX timestamp
Return quotes with created date less than this UNIX timestamp
If true, return quotes created in Sonderplan. If false, return quotes created in FoxOMS
Return quotes using the specified template_id
Return quotes using the specified currency shortcode
Return results that were added, edited or deleted since this UNIX timestamp
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 quote model that returns most properties by default
Automatically generated unique quote id
1
Prefix to the quote number
"INV-"
Number of the quote
892
Unix time of the quote date
1547501100
ISO-8601 formatted result of the quote date
"2022-02-22T09:00:00+11:00"
Unix time of the quote expiry date
1547501100
ISO-8601 formatted result of the quote expiry date
"2022-02-22T09:00:00+11:00"
Standard invoice item model that returns all properties by default
Automatically generated unique item id
982342
Item title text
"Edit Suite 1 Grading"
The unique ID of the item in string format, with r prefix for resource, b prefix for billable item and s for service
"r2394"
Unique ID of the rate scheme that populated this invoice item
989234
Item description text
"Session booked between 10th Jan -> 12th Jan 2023"
The amount of items billed for
"2.4"
The unit that this item is charging by
"hourly"
Individual unit cost charged to the client for this item
"20.65"
Individual unit cost payed by this business for this item
"10.15"
Legacy option showing if the tax defined within the invoice was applied to this invoice
Standard invoice item taxes model that returns tax information
Discount amount that applies to this item. Suffix with a % symbol to make this a percentage discount
"20.00%"
Total amount after discount
"495.00"
Total buy amount
"200.00"
Is the buy_total a fixed amount
false
Zero indexed order integer
2
Id of the group that this item is within
234842
Standard invoice item groups model that returns all properties by default
Automatically generated unique item id
23425
Name given to the item group
"Video Editing Services"
Description given to the item group
"Includes all editing services"
Zero indexed order integer of relative position amongst other items and groups
2
If true, items within this group will not be shown on Print and PDF exports
Simplified project model containing only a subset of fields
Automatically generated Project ID
2342354
Title of the project
"Andor S1 EP7 Annoucement"
Short code used to identify the project
"AND-S1-EP7"
A short description or synopsis of the project
"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."
Project Status ID
1
Client model with some fields
4
"p4"
"Jane Someone"
person, organization "person"
The primary email for this contact
Used to show the values of custom fields on linked modules
The ID of the custom field
7823
The name of the custom field
"Type"
The text value of the custom field, null if not defined
"Video Editing"
The ID of the selected option, (applied only if the custom field is of type select)
8973
The update key to pass back when updating this field
"2_1_7823"
Specific terms for this quote
"Expires in 30 days, subject to stock confirmation etc"
The template id selected for this quote, 0 = Default or no template
213
The id of the quote or invoice that this was duplicated from
545647
Text reference to a quote, invoice or purchase order
"QU-9893"
Currency code (three character format) that this quote is in
"AUD"
Total of all quote items before tax and discounts are applied
"1289.29"
Total amount discounted from the quote
"872.98"
Subtotal minus any discounts
"416.31"
The amount of tax charged on the quote
"129.87"
The grand total (net + tax) of the quote
"546.18"
True if this quote was created in Sonderplan
"true"
The unique ID of the person (user) who created this record
3
The UNIX time value of the creation time
1388552400
The full name of the person (user) who created this record
"John Smith"
The unique ID of the person (user) who last updated this record
3
The UNIX time value of the last update
1388552400
The full name of the person (user) who last updated this record
"John Smith"
curl --request GET \
--url https://api.sonderplan.com/v2/quote \
--header 'Authorization: Bearer <token>'{
"data": [
{
"id": 1,
"prefix": "INV-",
"number": 892,
"date": 1547501100,
"date_time_iso": "2022-02-22T09:00:00+11:00",
"expiry_date": 1547501100,
"expiry_date_time_iso": "2022-02-22T09:00:00+11:00",
"items": [
{
"id": 982342,
"item_text": "Edit Suite 1 Grading",
"item_uuid": "r2394",
"ratescheme_id": 989234,
"description": "Session booked between 10th Jan -> 12th Jan 2023",
"quantity": "2.4",
"unit": "hourly",
"unit_amount": "20.65",
"unit_buy_amount": "10.15",
"tax": true,
"taxes": [
{
"id": 3247,
"name": "GST",
"rate": "10.00",
"total": "151.00"
}
],
"discount": "20.00%",
"total": "495.00",
"buy_total": "200.00",
"buy_total_fixed": false,
"order": 2,
"parent_group_id": 234842
}
],
"groups": [
{
"id": 23425,
"name": "Video Editing Services",
"description": "Includes all editing services",
"order": 2,
"hide_items": true
}
],
"status": [
{
"id": 2,
"name": "Sent"
}
],
"project": [
{
"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.",
"status_id": 1
}
],
"client": [
{
"id": 4,
"uuid": "p4",
"name": "Jane Someone",
"type": "person",
"email": "[email protected]",
"contact_person": {
"id": 2837,
"name": "Fred Flintstone"
}
}
],
"custom_fields": [
{
"id": 7823,
"name": "Type",
"value": "Video Editing",
"value_id": 8973,
"update_key": "2_1_7823"
}
],
"terms": "Expires in 30 days, subject to stock confirmation etc",
"template_id": 213,
"cloned_id": 545647,
"reference": "QU-9893",
"currency": "AUD",
"sub_total": "1289.29",
"discount_total": "872.98",
"net_total": "416.31",
"tax_total": "129.87",
"total": "546.18",
"created_sp_flag": "true",
"created_id": 3,
"created": 1388552400,
"created_name": "John Smith",
"updated_id": 3,
"updated": 1388552400,
"updated_name": "John Smith"
}
],
"meta": {
"pagination": {
"total": 1,
"count": 1,
"per_page": 1,
"current_page": 1
}
}
}