json/v1.0/contact.json in sk_api_schema-0.10.3 vs json/v1.0/contact.json in sk_api_schema-0.10.4
- old
+ new
@@ -220,10 +220,23 @@
},
"converted_at":{
"description": "Date the contact converted from lead to client or any other contact type (supplier)",
"format":"date-time",
"type":"string"
+ },
+ "sales_potential":{
+ "description": "Sales potential for the contact e.g what is his budget, how much can he spend?",
+ "type":"number"
+ },
+ "probability":{
+ "description": "Likelihood that the sales potential will be realised in percent e.g. How hot is the contact, How much of the sales potential will we get also see expected_revenue?",
+ "type":"number"
+ },
+ "expected_revenue":{
+ "description": "Product of the probability and sales potential. e.g how much of the sales_potential can we get?",
+ "readonly":true,
+ "type":"number"
}
},
"links":[
{ "rel": "self",
"href": "contacts/{id}"
@@ -236,11 +249,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": "Wildcard search in first, last_name, organisation, email, number",
@@ -303,9 +316,27 @@
"filter[type]":{
"title" : "Type",
"description": "Type of the contact: ",
"enum":["Client", "Lead", "Supplier"],
"type" : "string"
+ },
+ "filter[probability_from]":{
+ "title" : "By probability from",
+ "description": "Find contacts 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 contacts with a probability smaller(<=) than given number."
+ },
+ "filter[sales_potential_from]":{
+ "title" : "By sales potential from",
+ "description": "Find contacts with a sales potential greater(>=) than given number.",
+ "type":"number"
+ },
+ "filter[sales_potential_to]": {
+ "title": "By sales potential to",
+ "description": "Find contacts with a sales potential smaller(<=) than given number."
},
"sort_by":{
"title" : "Sort by",
"description": "Sort the results by the given field => number",
"enum":["organisation", "number","email","first_name","last_name", "created_at", "updated_at"],
\ No newline at end of file