Contract-based REST API
The contract-based representational state transfer (REST) application programming interface (API) of MYOB Advanced provides the REST interface of the MYOB Advanced contract-based web services through which external systems can get data records from MYOB Advanced, process these records, and save new or updated records to MYOB Advanced.
Representation of a record in JSON format
By using the contract-based REST API, you obtain existing records from MYOB Advanced, create new records, update, and delete them. You work with the records in MYOB Advanced by using the entities that are defined in the contract of the endpoint that use to access the service. You pass records to and receive them from the contract-based REST API in JavaScript object notation (JSON) format. JSON is a text format for transmitting data objects that consist of key-value pairs.
To represent a record in JSON format, use the rules that are described in the following sections. You do not need to specify the values of all fields of an entity; you can specify the values of only the needed fields.
Login to the service
Each time your application starts work with the MYOB Advanced contract-based REST service, you have to log in to MYOB Advanced. To log in to MYOB Advanced, access the needed URL address with the POST HTTP method and pass the credentials in the request body. See details on the URL, parameters, HTTP method, and response format in the following sections.
Logout from the service
Each time your application finishes work with the MYOB Advanced contract-based REST service, you have to log out from MYOB Advanced. To log out from MYOB Advanced, you access the needed URL address with the POST HTTP method and pass the credentials in the request body. See the following sections for details on the URL, parameters, HTTP method, and response format.
Creation of a record
When you need to create a record by using the contract-based REST API, access the needed URL address with the PUT HTTP method and pass the record representation in JSON format in the request body. See the following sections for details on the URL, parameters, HTTP method, and response format.
Update of a record
When you need to update an existing record by using the contract-based REST API, you access the needed URL with the PUT HTTP method and pass the record representation in JSON format in the request body. See the following sections for details on the URL, parameters, HTTP method, and response format.
Retrieval of a record by key fields
To retrieve a record by the values of its key fields from MYOB Advanced by using the contract-based REST API, you access the needed URL address with the GET HTTP method and specify the fields that should be returned in the parameters of the method. See the following sections for details on the URL, parameters, HTTP method, and response format.
Retrieval of a record by ID
Retrieval of records by conditions
Retrieval of data from an inquiry form
Parameters for retrieving records
$filter parameter
$top parameter
$skip parameter
$expand parameter
$custom parameter
Removal of a record
Execution of an action
Attachment of a file to a record
Retrieval of a file attached to a record
Retrieval of the schema of custom fields
Here's a note.
Here's a tip.
Here's a warning.
AUSTRALIA ONLY
NEW ZEALAND