Company Search Template

List all company search templates or return search results based on a company search template set up in MYOB EXO Business.

Date Released: July 17th 2015 Date Updated: July 17th 2015
URLSupports

{URI}/companysearchtemplate

{URI}/companysearchtemplate/{id}{parameters}

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.

Calling the endpoint by itself returns a list of company search templates (search templates whose type is "Y").

To use a company search template to return search results, call the endpoint with the ID number of the search template you want to use, for example:

http://exo.api.myob.com/companysearchtemplate/1

Depending on the template being called, the call may need to pass parameters to filter the search results, for example:

http://exo.api.myob.com/companysearchtemplate/1?q=auto

This will return search results using the search template with the ID number 1 and passing in the search string "auto" as parameters.

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

    • name string,null
    • Type: string,null
    • active boolean
    • Type: boolean
    • type string,null
    • Type: string,null
    • parameters 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

  • {
    • 0
      • {
        • name : Active Companies
        • active : true
        • type : Y
        • parameters
          • {
          • }
        • id : 14
        • href : {URI}https://exo-stage.api.myob.com/searchtemplate/14
      • }
    • 1
      • {
        • name : All Companies
        • active : true
        • type : Y
        • parameters
          • {
          • }
        • id : 15
        • href : {URI}https://exo-stage.api.myob.com/searchtemplate/15
      • }
    • 3
      • {
        • name : My Active Companies
        • active : true
        • type : Y
        • parameters
          • {
            • 0
              • {
                • paramname : USER
                • paramtype : INT
              • }
          • }
        • id : 13
        • href : {URI}https://exo-stage.api.myob.com/searchtemplate/13
      • }
    • 4
      • {
        • name : My Own Companies
        • active : true
        • type : Y
        • parameters
          • {
            • 0
              • {
                • paramname : USER
                • paramtype : INT
              • }
          • }
        • id : 17
        • href : {URI}https://exo-stage.api.myob.com/searchtemplate/17
      • }
  • }

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