Sections

• Overview
• API Usage
• Errors

Methods

Calls to the API must be for genuine use and responses from the API must not be stored for the purpose of creating an offline copy of the information stored. Failure to comply with this requirement will infringe the API License.

Organisation API Calls

Register Organisation

POST /organisation

Purpose

To register an organisation as having a relationship with you (our partner) and, optionally to an existing organisation already registered to you.

Inputs

• legalname - The organisations legal name (i.e. the entity you do business with.
• reportname - Used on any reports we generate for you.
• parentorgid - OPTIONAL - The parent orgid. This must be a valid ID of another organisation already registed to you. This enables any of your clients company structures to be represented so that they can be broken down for reporting purposes if desired.

Example Request

POST /organisation HTTP/1.1
Accept: application/json
Content-Type: application/json

{
    "legalname": "Amce Traders Inc.",
    "reportname": "Amce Traders",
    "parentorgid": 123
}

Output

A unique organisation ID. You will need this ID whenever you register a store against this organisation. The response headers will return status code "201 Created".

In the event of an error the orgid will not be returned. Instead, a JSON object containing an errors array will be returned. For details on the errors array please read the Errors page.

Example Response

Response on Success:

HTTP/1.1 201 Created
Content-Type: application/json

{
    "orgid": 123
}

Response on Error:

HTTP/1.1 400 Human readable error message
Content-Type: application/json

{
    "errors":
    [
        {
            "id": n,
            "message": "Human readable message"
        }
    ]
}