Sales statuses lookup list
The 'Sales status' is a field on the job opportunity record. It is used to indicate the current state of the sales opportunity.
Parameter | Description | Examples | More info |
---|---|---|---|
API | The API area | jobs.json | |
Parameters described in overview | user=user&password=user | ||
Action | Sales statuses | action=salesstatuses | |
Company | Company number | company=1 | |
Response | Returned data | A JSON string containing the data |
Note: There are main sales statuses
- Open
- Lost
- Promoted
Each of these codes has associated with is a set of 'Sales reason' descriptions.
Therefore a combined code that must be used when promoting a job or changing its status -
the salesreasonSalesStatus plus the salesreasonReasonId
e.g. 3-6
Example request:
http://<SERVER>/jsonapi/jobs.json?user=user&password=user&action=salesstatuses&version=3.3&company=8
Example response:
{
"responsecode": 1,
"responsestatus": "OK",
"errorcode": 0,
"errormessage": "",
"totalrows": 19,
"totalpages": 1,
"responsemessage": "",
"pagerows": 0,
"pagenumber": 1,
"success": true,
"data": [
{
"salesreasonStatusReason": "1-2",
"salesreasonStatusReasonDesc": "Open - Contacted",
"salesreasonStatusReasonId": 2,
"salesreasonStatusStatus": 1
},
{
"salesreasonStatusReason": "2-101",
"salesreasonStatusReasonDesc": "Lost - Price too high",
"salesreasonStatusReasonId": 101,
"salesreasonStatusStatus": 2
},
{
"salesreasonStatusReason": "3-6",
"salesreasonStatusReasonDesc": "Promoted - In Progress",
"salesreasonStatusReasonId": 6,
"salesreasonStatusStatus": 3
}
]
}