json/v1.0/estimate.json in sk_api_schema-0.10.3 vs json/v1.0/estimate.json in sk_api_schema-0.10.4
- old
+ new
@@ -184,10 +184,23 @@
},
"gross_margin_pct":{
"description": "Percentage of gross profit to cost of items sold. Calculated from gross_margin_total/net_total*100",
"readonly":true,
"type":"number"
+ },
+ "probability":{
+ "description": "Percentage of estimated confidence in closing the deal. Estimated Probability percentage of the net total amount",
+ "type":"number"
+ },
+ "expected_revenue":{
+ "description": "Product of the probability and net total. In company currency",
+ "readonly":true,
+ "type":"number"
+ },
+ "close_date":{
+ "description": "Date when the deal is expected to be closed.",
+ "type":"number"
}
},
"links":[
{ "rel": "self",
"href": "estimates/{id}"
@@ -200,11 +213,11 @@
"description": "In paginated results set the page to look for",
"type":"number"
},
"per_page":{
"title" : "Per page",
- "description": "Results per page. Default is 10, max is 100",
+ "description": "Results per page. Default is 50, max is 200",
"type":"number"
},
"filter[q]":{
"title" : "Search",
"description": "Search in title, number, address field",
@@ -223,10 +236,20 @@
"filter[tags]":{
"title" : "Tags",
"description": "Filter by a space delimited list of tags",
"type":"string"
},
+ "filter[probability_from]":{
+ "title" : "By probability from",
+ "description": "Find documents with a probability greater(>=) than given number. Minimum is 0 for percent fields, max 100",
+ "type":"number"
+ },
+ "filter[probability_to]":{
+ "title" : "By probability to",
+ "description": "Find accounts with a probability smaller(<=) than given number.",
+ "type":"number"
+ },
"filter[from]":{
"title" : "From date",
"description": "Objects with a date after the date. YYYY-MM-DD",
"format" : "date",
"type" : "string"
@@ -235,18 +258,42 @@
"title" : "To date",
"description": "Objects with date before the date. YYYY-MM-DD",
"format" : "date",
"type" : "string"
},
+ "filter[close_date_from]":{
+ "title" : "Close date from",
+ "description": "Objects with a closing date after the date. YYYY-MM-DD",
+ "format" : "date",
+ "type" : "string"
+ },
+ "filter[close_date_to]":{
+ "title" : "Close date to",
+ "description": "Objects with closing date before the date. YYYY-MM-DD",
+ "format" : "date",
+ "type" : "string"
+ },
"filter[created_at_from]":{
- "title" : "From date",
+ "title" : "Created from",
"description": "Objects with a creation on/after the date(>=). ISO 8601 format YYY-MM-DDThh:mm:ss+z or just a date YYY-MM-DD. If date is given the time is set to the start of the day(00:00:00) so all objects created on this day are included. A time should be already utc time",
"format" : "date-time",
"type" : "string"
},
"filter[created_at_to]":{
- "title" : "To date",
+ "title" : "Created to",
"description": "Objects with a creation until the date(<=). ISO 8601 format YYY-MM-DDThh:mm:ss+z or just a date YYY-MM-DD. If date is given the time is set to the end of the day(23:59:59) so all objects created on that day are included. A time should be already utc time.",
+ "format" : "date-time",
+ "type" : "string"
+ },
+ "filter[updated_at_from]":{
+ "title" : "Updated from",
+ "description": "Objects updated on/after the date(>=). ISO 8601 format YYY-MM-DDThh:mm:ss+z or just a date YYY-MM-DD. If date is given the time is set to the start of the day(00:00:00) so all objects updated on this day are included. A time should be already utc time",
+ "format" : "date-time",
+ "type" : "string"
+ },
+ "filter[updated_at_to]":{
+ "title" : "Updated to",
+ "description": "Objects updated until the date(<=). ISO 8601 format YYY-MM-DDThh:mm:ss+z or just a date YYY-MM-DD. If date is given the time is set to the end of the day(23:59:59) so all objects updated on that day are included. A time should be already utc time.",
"format" : "date-time",
"type" : "string"
},
"filter[languages]":{
"title" : "Languages",