Prospect

Return, update and create a prospect (non account).

Date Released: Oct 25th 2013 Date Updated: November 14th 2014

URL	Supports
{URI}/prospect/ {URI}/prospect/search?q={query} {URI}/prospect/{prospectid}/contact	GET \| PUT \| POST GET \| PUT \| POST GET \| PUT \| POST
{URI} is exo.api.myob.com when connecting to the cloud or the address of the machine hosting the API when connecting on premise.

URL

Supports

{URI}/prospect/

{URI}/prospect/search?q={query}

{URI}/prospect/{prospectid}/contact

{URI} is exo.api.myob.com when connecting to the cloud or the address of the machine hosting the API when connecting on premise.

search returns prospects that match the specified search string.

contact returns a list of contacts associated with the specified prospect. You can also remove the association between a prospect and a contact with a DELETE call to this endpoint, e.g. a DELETE call to {URI}/prospect/10/contact/2 will remove the association between prospect 10 and contact 2 (but will not delete the contact itself).

Id fields are required when updating a prospect (PUT). Account Name is the only field required when creating a new debtor (POST). The API will retrieve the information relating to a specific Id so you have all the information available.

Note: Actual fields returned may differ slightly depending on local settings and configuration.

The elements list below details information for Prospect. To view the descriptions for the elements you can either hover any attribute to reveal details or click here to show all details inline.

Attribute Details

alphacode string,null
Type: string,null
templatedebtorid string,null
Required on PUT
basepriceid integer,null
Required on PUT
baseprice object,null
Type: object,null
- name string,null
- Type: string,null
- rel string,null
- Type: string,null
- title string,null
- Type: string,null
- id integer
- Required on PUT
- href string,null
- Type: string,null
companytype integer
Type: integer
accountname string
Type: string
email string,null
Type: string,null
phone string,null
Type: string,null
postaladdress object
Type: object
- line1 string,null
- Type: string,null
- line2 string,null
- Type: string,null
- line3 string,null
- Type: string,null
- line4 string,null
- Type: string,null
- line5 string,null
- Type: string,null
postalcode string,null
Type: string,null
deliveryaddress object
Type: object
- line1 string,null
- Type: string,null
- line2 string,null
- Type: string,null
- line3 string,null
- Type: string,null
- line4 string,null
- Type: string,null
- line5 string,null
- Type: string,null
- line6 string,null
- Type: string,null
defaultcontactid integer,null
Required on PUT
defaultcontact object,null
EXO Business Contact
Title: Contact
- jobtitle string,null
- Type: string,null
- firstname string,null
- Type: string,null
- lastname string,null
- Type: string,null
- fullname string,null
- Type: string,null
- directphonenumber string,null
- Type: string,null
- mobilephonenumber string,null
- Type: string,null
- email string,null
- Type: string,null
- postaladdress object
- Type: object
- - line1 string,null
  - Type: string,null
  - line2 string,null
  - Type: string,null
  - line3 string,null
  - Type: string,null
  - line4 string,null
  - Type: string,null
  - line5 string,null
  - Type: string,null
- postalcode string,null
- Type: string,null
- deliveryaddress object
- Type: object
- - line1 string,null
  - Type: string,null
  - line2 string,null
  - Type: string,null
  - line3 string,null
  - Type: string,null
  - line4 string,null
  - Type: string,null
  - line5 string,null
  - Type: string,null
  - line6 string,null
  - Type: string,null
- advertsourceid integer,null
- Required on PUT
- advertsource object,null
- Type: object,null
- - description string,null
  - Type: string,null
  - processid integer
  - Required on PUT
  - communicationprocess object,null
  - Type: object,null
  - - description string,null
    - Type: string,null
    - rel string,null
    - Type: string,null
    - title string,null
    - Type: string,null
    - id integer
    - Required on PUT
    - href string,null
    - Type: string,null
  - rel string,null
  - Type: string,null
  - title string,null
  - Type: string,null
  - id integer
  - Required on PUT
  - href string,null
  - Type: string,null
- active boolean,null
- Type: boolean,null
- optoutemarketing boolean,null
- Type: boolean,null
- salespersonid integer,null
- Required on PUT
- salesperson object,null
- Type: object,null
- - name string,null
  - Type: string,null
  - jobtitle string,null
  - Type: string,null
  - rel string,null
  - Type: string,null
  - title string,null
  - Type: string,null
  - id integer
  - Required on PUT
  - href string,null
  - Type: string,null
- defaultcompany object,null
- EXO Business Company
  Title: BaseCompany
- - companytype integer
  - Type: integer
  - accountname string
  - Type: string
  - email string,null
  - Type: string,null
  - phone string,null
  - Type: string,null
  - postaladdress object
  - Type: object
  - - line1 string,null
    - Type: string,null
    - line2 string,null
    - Type: string,null
    - line3 string,null
    - Type: string,null
    - line4 string,null
    - Type: string,null
    - line5 string,null
    - Type: string,null
  - postalcode string,null
  - Type: string,null
  - deliveryaddress object
  - Type: object
  - - line1 string,null
    - Type: string,null
    - line2 string,null
    - Type: string,null
    - line3 string,null
    - Type: string,null
    - line4 string,null
    - Type: string,null
    - line5 string,null
    - Type: string,null
    - line6 string,null
    - Type: string,null
  - defaultcontactid integer,null
  - Required on PUT
  - defaultcontact undefined
  - Type: undefined
  - contacts object,null
  - Type: object,null
  - - rel string,null
    - Type: string,null
    - title string,null
    - Type: string,null
    - href string,null
    - Type: string,null
  - website string,null
  - Type: string,null
  - salespersonid integer,null
  - Required on PUT
  - salesperson object,null
  - Type: object,null
  - - name string,null
    - Type: string,null
    - jobtitle string,null
    - Type: string,null
    - rel string,null
    - Type: string,null
    - title string,null
    - Type: string,null
    - id integer
    - Required on PUT
    - href string,null
    - Type: string,null
  - balance number
  - Type: number
  - contactname string,null
  - Type: string,null
  - latitude number,null
  - Type: number,null
  - longitude number,null
  - Type: number,null
  - geocodestatus integer,null
  - Type: integer,null
  - lastupdated string,null
  - Type: string,null
  - extrafields array,null
  - Type: array,null
  - rel string,null
  - Type: string,null
  - title string,null
  - Type: string,null
  - id integer
  - Required on PUT
  - href string,null
  - Type: string,null
- defaultcompanyid object,null
- EXO Business Company Link
  Title: CompanyId
  Required on PUT
- - companytype integer
  - Type: integer
  - accno integer
  - Type: integer
- defaultcompanyname string,null
- Type: string,null
- latitude number,null
- Type: number,null
- longitude number,null
- Type: number,null
- geocodestatus integer,null
- Type: integer,null
- extrafields array,null
- Type: array,null
- rel string,null
- Type: string,null
- title string,null
- Type: string,null
- id integer
- Required on PUT
- href string,null
- Type: string,null
contacts object,null
Type: object,null
- rel string,null
- Type: string,null
- title string,null
- Type: string,null
- href string,null
- Type: string,null
website string,null
Type: string,null
salespersonid integer,null
Required on PUT
salesperson object,null
Type: object,null
- name string,null
- Type: string,null
- jobtitle string,null
- Type: string,null
- rel string,null
- Type: string,null
- title string,null
- Type: string,null
- id integer
- Required on PUT
- href string,null
- Type: string,null
balance number
Type: number
contactname string,null
Type: string,null
latitude number,null
Type: number,null
longitude number,null
Type: number,null
geocodestatus integer,null
Type: integer,null
lastupdated string,null
Type: string,null
extrafields array,null
Type: array,null
rel string,null
Type: string,null
title string,null
Type: string,null
id integer
Required on PUT
href string,null
Type: string,null

Example json GET response

{
- alphacode :
- templatedebtorid : 0
- basepriceid : 1
- companytype : 3
- accountname : TASHI MOTORS
- email :
- phone :
- postaladdress
  - {
    - line1 :
    - line2 :
    - line3 :
    - line4 :
    - line5
  - }
- postalcode :
- deliveryaddress
  - {
    - line1 :
    - line2 :
    - line3 :
    - line4 :
    - line5 :
    - line6 :
  - }
- defaultcontactid
- contacts
  - {
    - rel : collection/contact
    - href : {URI}http://localhost:92/prospect/1/contact
  - }
- website :
- salespersonid : 8
- balance : 0
- contactname
- latitude
- longitude
- geocodestatus : -12
- lastupdated : 2014-10-15T12:22:58.45+11:00
- extrafields
  - {
  - }
- id : 1
- href : {URI}/prospect/1
}

{URI} is defined as: http://exo.api.myob.com/

Prospect

Attribute Details

Example json GET response

API

Support

Social

Developer News