Skip to end of metadata
Go to start of metadata

About

Our API is built around a RESTful design with payloads in JSON or XML format.

 

NameDescription
PingConnectivity testing and development integration
OrganisationCompany-level operations including registration

 

Statuses

The following statuses show the current status of the API development.

StatusDescription
DEVIn development, not accessible in Beta or Production
BETAAvailable in Beta
PRODAvailable in Beta and Production

Data Types

These data types apply to both request parameters and download data (except payloads).

TypeFormatExample
intNumbers, no commas, no decimals123456
decimalNumbers, no commas, decimals (2 for money, some support more)123456.78
dateyyyy-mm-dd, date, no time, no timezone2016-06-30
datetimeyyyy-mm-ddTHH:MM:ss.fffffff+zzzzz, date, time (24 hour clock), milliseconds, timezone info, see Combined date and time representations2016-06-30T14:30:59.1234567+10:00
boolTrue/Falsetrue
stringAny charactersThis is a string

Tips

 

  • No labels