Custom Table

Return, update and create entries in a custom table in the EXO Business database.

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

URL	Supports
{URI}/customtable {URI}/customtable?table=X_TABLE&pk=FIELD {URI}/customtable/{recordid}?table=X_TABLE&pk=FIELD	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.

Custom tables can be created in the EXO Configurator, or manually in SQL Server. If you are creating a custom table manually, it must include a primary key field; this field must be an integer, and should be named SEQNO. All other fields must be added as Extra Fields - again, this can be done manually or in the EXO Configurator.

Note: EXO Business 2015.3 or later is required to manage custom tables and Extra Fields on custom tables in the EXO Configurator.

The endpoint is called in the format customtable?table=X_TABLE&pk=FIELD, where X_TABLE is the name of the custom table and FIELD is the name of the table’s primary key field (this should be SEQNO).

To read or write to a specific record in the table, make a call to customtable/ID?table=X_TABLE&pk=FIELD Where ID is the ID code (usually the SEQNO) of the record.

A GET request on the customtable endpoint by itself returns a list of all custom tables.

The extrafields attribute is an array of Extra Field name/value pairs in the format:

{
"key": "NAME",
"value": "VALUE"
}

Where NAME is the name of the field and VALUE is the value being read from or written to it.

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

extrafields array
Type: array
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

{
- extrafields
  - {
    - 0
      - {
        key : STOCKCODE
        value : AIRFIL01
      - }
    - 1
      - {
        key : STOCKGROUP
        value : 0
      - }
    - 2
      - {
        key : X_KANBAN
        value : Y
      - }
    - 3
      - {
        key : X_ORDCURRENCY
        value : 199.99
      - }
    - 4
      - {
        key : X_ORDDATE
        value : 2014-04-02
      - }
    - 5
      - {
        key : X_ORDDEC
        value : 99.99
      - }
    - 6
      - {
        key : X_ORDQTY
        value : 100
      - }
    - 7
      - {
        key : X_ORDTEXT
        value : POST
      - }
    - 8
      - {
        key : X_DROPDOWN
        value : Y
      - }
    - 9
      - {
        key : X_DROPSELECT
        value : 1
      - }
    - 10
      - {
        key : X_DROPSQL
        value : 1
      - }
  - }
- id : 1
- href : {URI}https://exo-stage.api.myob.com/customtable/1
}

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