Activity

Return details of activities (appointments and tasks).

Date Released:November 14th 2014 Date Updated: November 14th 2014
URLSupports

{URI}/activity?assignedto={staffid}&startdate=YYYY-MM-DD&enddate=YYYY-MM-DD

{URI}/activity/{activityid}

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

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.

This endpoint returns all activities assigned to the specified staff member ID that occur between the specified start and end dates. If a staff ID is not specified, activities for all staff members are returned. If dates are not specified, the start date defaults to today and the end date defaults to one month from today.

Entering an activity ID returns that activity only - start and end dates are not required.

Note: For all-day activities, the start and end dates cannot be the same - when PUTing or POSTing an all-day activity, you will need to post end date + 1. Similarly, when GETing an all-day activity, you will most likely need to display end date - 1 to the user.

search returns activities that match the specified search string.

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

The elements list below details information for Activity. 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

    • parentid integer
    • Required on PUT
    • recurrenceindex integer
    • Type: integer
    • type integer,null
    • Type: integer,null
    • subject string,null
    • Type: string,null
    • details string,null
    • Type: string,null
    • startdatetime string,null
    • Type: string,null
    • enddatetime string,null
    • Type: string,null
    • companyid object,null
    • EXO Business Company Link
      Title: CompanyId
      Required on PUT
      • companytype integer
      • Type: integer
      • accno integer
      • Type: integer
    • company 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 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 undefined
        • Type: undefined
        • defaultcompanyid undefined
        • Required on PUT
        • 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
      • 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
    • companyname string,null
    • Type: string,null
    • companyphone string,null
    • Type: string,null
    • companyemail string,null
    • Type: string,null
    • companylatitude number,null
    • Type: number,null
    • companylongitude number,null
    • Type: number,null
    • contactid integer,null
    • Required on PUT
    • contactname string,null
    • Type: string,null
    • contactdirectphone string,null
    • Type: string,null
    • contactmobile string,null
    • Type: string,null
    • contactemail string,null
    • Type: string,null
    • contactlatitude number,null
    • Type: number,null
    • contactlongitude number,null
    • Type: number,null
    • contact undefined
    • Type: undefined
    • opportunityid integer,null
    • Required on PUT
    • assignedtoid integer,null
    • Required on PUT
    • assignedtostaffname string,null
    • Type: string,null
    • assignedto 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
    • assignedbyid integer,null
    • Required on PUT
    • assignedbystaffname string,null
    • Type: string,null
    • assignedby 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
    • reminderdate string,null
    • Type: string,null
    • reminderminutes integer,null
    • Type: integer,null
    • completed boolean,null
    • Type: boolean,null
    • completeddatetime string,null
    • Type: string,null
    • showtimeas integer,null
    • Type: integer,null
    • activitytypeid integer,null
    • Required on PUT
    • activitytype 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
    • activitytypetext string,null
    • Type: string,null
    • activitystatusid integer,null
    • Required on PUT
    • activitystatus 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
    • activitystatustext string,null
    • Type: string,null
    • priority string,null
    • Type: string,null
    • actualstart string,null
    • Type: string,null
    • actualfinish string,null
    • Type: string,null
    • createdbyid integer,null
    • Required on PUT
    • createdbystaffname string,null
    • Type: string,null
    • createdby 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
    • createdate string,null
    • Type: string,null
    • modifiedbyid integer,null
    • Required on PUT
    • modifiedbystaffname string,null
    • Type: string,null
    • modifiedby 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
    • modifieddate string,null
    • Type: string,null
    • completedpercent number,null
    • Type: number,null
    • syncactivity boolean,null
    • Type: boolean,null
    • campaignid integer,null
    • Required on PUT
    • campaignwaveid integer
    • Required on PUT
    • jobid integer,null
    • Required on PUT
    • serviceableunitid integer,null
    • Required on PUT
    • salesorderid integer,null
    • Required on PUT
    • salesorder object,null
    • Type: object,null
      • debtorid integer
      • Required on PUT
      • lines array,null
      • Type: array,null
      • taxrounding number
      • Type: number
      • deliverycount integer
      • Type: integer
      • invoicecount integer
      • Type: integer
      • pickedcount integer
      • Type: integer
      • releasecount integer
      • Type: integer
      • hasuninvoiced boolean
      • Type: boolean
      • hasunpicked boolean
      • Type: boolean
      • hasunreleased boolean
      • Type: boolean
      • hasunsupplied boolean
      • Type: boolean
      • allowcustomerordernumber boolean
      • Type: boolean
      • customerordernumber string,null
      • Type: string,null
      • accountname string,null
      • Type: string,null
      • istaxinclusive boolean
      • Type: boolean
      • hasbackorders boolean
      • Type: boolean
      • branchid integer
      • Required on PUT
      • branch object,null
      • Type: object,null
        • name string,null
        • Type: string,null
        • code 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
      • defaultlocationid integer
      • Required on PUT
      • defaultlocation object,null
      • Type: object,null
        • code string,null
        • Type: string,null
        • name string,null
        • Type: string,null
        • active boolean
        • Type: boolean
        • excludefromvaluation boolean
        • Type: boolean
        • excludefromfreestock boolean
        • Type: boolean
        • excludefromsales boolean
        • Type: boolean
        • rel string,null
        • Type: string,null
        • title string,null
        • Type: string,null
        • id integer
        • Required on PUT
        • href string,null
        • Type: string,null
      • narrative string,null
      • Type: string,null
      • currencyid integer
      • Required on PUT
      • currency object,null
      • Type: object,null
        • code string,null
        • Type: string,null
        • name string,null
        • Type: string,null
        • symbol string,null
        • Type: string,null
        • buyrate number
        • Type: number
        • sellrate number
        • Type: number
        • rel string,null
        • Type: string,null
        • title string,null
        • Type: string,null
        • id integer
        • Required on PUT
        • href string,null
        • Type: string,null
      • contactid integer,null
      • Required on PUT
      • contact undefined
      • Type: undefined
      • salespersonid integer
      • 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
      • exchangerate number
      • Type: number
      • taxtotal number
      • Type: number
      • subtotal number
      • Type: number
      • reference string,null
      • Type: string,null
      • instructions string,null
      • Type: string,null
      • createdate string
      • Type: string
      • orderdate any
      • Type: any
      • duedate any
      • Type: any
      • finalisationdate string,null
      • Type: string,null
      • activationdate 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
      • status integer
      • Type: integer
      • statusdescription string,null
      • Type: string,null
      • finalised integer
      • Type: integer
      • ordertotal number
      • Type: number
      • localvalue number
      • Type: number
      • lock object,null
      • Type: object,null
        • id integer
        • Required on PUT
        • computer object,null
        • Type: object,null
          • name string,null
          • Type: string,null
          • identifier string,null
          • Required on PUT
          • rel string,null
          • Type: string,null
          • title string,null
          • Type: string,null
          • id integer
          • Required on PUT
          • href 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
    • subscriptionid integer,null
    • Required on PUT
    • purchaseorderid integer,null
    • Required on PUT
    • alldayevent boolean,null
    • Type: boolean,null
    • reminder boolean,null
    • Type: boolean,null
    • eventtype integer,null
    • Type: integer,null
    • label string,null
    • Type: string,null
    • recurrencecount integer
    • Type: integer
    • 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

  • {
    • parentid : 1
    • recurrenceindex : -1
    • type : 0
    • subject : Meeting
    • details :
    • startdatetime : 2016-11-01T00:00:00+11:00
    • enddatetime : 2016-11-02T00:00:00+11:00
    • companyid
      • {
        • companytype : 1
        • accno : 32
      • }
    • companyname : TASHI MOTORS
    • companyphone : 02 8765 4432
    • companyemail : info@tashimotors.example.com
    • companylatitude : -33.909931
    • companylongitude : 151.053238
    • contactid : -1
    • contactname
    • opportunityid : -1
    • assignedtoid : 8
    • assignedtostaffname : EXO BUSINESS ADMIN ACCOUNT
    • assignedbyid : 8
    • assignedbystaffname : EXO BUSINESS ADMIN ACCOUNT
    • reminderdate : 2016-10-30T23:45:00+11:00
    • reminderminutes : 15
    • completed : false
    • completeddatetime
    • showtimeas : 0
    • activitytypeid : 7
    • activitytypetext : Proposal
    • activitystatusid : 100
    • activitystatustext : Not Started
    • priority : High
    • actualstart : 2016-11-01T00:00:00+11:00
    • actualfinish : 2016-11-02T00:00:00+11:00
    • createdbyid : 8
    • createdbystaffname
    • createdate : 2016-11-01T16:17:58+11:00
    • modifiedbyid : -1
    • modifiedbystaffname
    • modifieddate
    • completedpercent : 0
    • syncactivity : false
    • campaignid
    • campaignwaveid : 0
    • jobid : -1
    • serviceableunitid : -1
    • salesorderid : -1
    • subscriptionid : -1
    • purchaseorderid : -1
    • alldayevent : true
    • reminder : false
    • eventtype : 0
    • label : Business
    • recurrencecount : -1
    • extrafields
      • {
        • 0
          • {
            • key : X_DECIMAL_EXTRA
            • value
          • }
        • 1
          • {
            • key : X_INTEGER_EXTRA
            • value
          • }
        • 2
          • {
            • key : X_CHECKBOX_TEST
            • value : N
          • }
        • 3
          • {
            • key : X_DATE_TEST
            • value : 2014-10-14
          • }
        • 4
          • {
            • key : X_TEST_DROPDOWN
            • value : 3
          • }
        • 5
          • {
            • key : X_TEST_DROPDOWNEDIT
            • value : 3. TIM MCINTOSH
          • }
        • 6
          • {
            • key : X_TEST_READONLY
            • value : Readonly extra field
          • }
        • 7
          • {
            • key : X_TEST_TEXT
            • value : Extra field text
          • }
        • 8
          • {
            • key : X_TEST_URL
            • value : www.myob.co.nz
          • }
        • 9
          • {
            • key : X_TEST_URLLABEL
            • value : www.myob.co.nz
          • }
      • }
    • id : 1
    • href : {URI}https://exo-stage.api.myob.com/activity/1
  • }

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