The list of endpoints available in Public API

The list of endpoints available in Public API

To make calls against the APIs, please refer to the endpoints below or to the swagger:

Endpoints
Description
GET /ping In the ApprovalMax Public API, the GET /ping endpoint is a simple endpoint used for checks the overall availability and responsiveness of the ApprovalMax Public API.

When a GET request is made to the /ping endpoint, the API will respond with a success status code (e.g., 200 OK) and a simple message indicating that the API is available and operational. 
GET /api/v1/companies
The GET /api/v1/companies endpoint in the ApprovalMax API allows you to retrieve information about the Organisations embedded in token. When a GET request is made to this endpoint, the API returns a response containing a list of Organisations: name and companyId.

GET /api/v1/companies/:companyId/xero/purchase-orders/:requestId
This endpoint allows you to retrieve specific Purchase Order details for a particular Organisation you have provided access to.

To use this endpoint, you will need to replace :companyId with the unique identifier of the Organisation and :requestId with the unique identifier of the Purchase Order you are interested in.

When a GET request is made to this endpoint, the API will return a response containing the details of the Purchase Order.  The response includes information such as the Purchase Order number, date, item details, quantities, and any additional relevant data related to the Purchase Order.
GET /api/v1/companies/:companyId/xero/purchase-orders
This endpoint allows you to retrieve a list of Purchase Orders associated with a specific Organisation in Xero you have provided access to.

To use this endpoint, you will need to replace :companyId with the unique identifier of the Organisation you are interested in, and, optionally, select the request status, specify dates, select the preferred sorting, input pagination and number of the request per page.

When a GET request is made to this endpoint, the API will return a response containing a list of Purchase Orders with selected parameters associated with the specified Organisation. 
GET api/v1/companies/:companyId/xero/bills/:requestId
This endpoint allows you to retrieve specific Bill details for a particular Organisation you have provided access to.

To use this endpoint, you will need to replace :companyId with the unique identifier of the Organisation and :requestId with the unique identifier of the Bill you are interested in.

When a GET request is made to this endpoint, the API will return a response containing the details of the Bill.  The response includes information such as the Bill number, date, item details, quantities, and any additional relevant data related to the Bill.
GET /api/v1/companies/:companyId/xero/bills
This endpoint allows you to retrieve a list of Bills associated with a specific Organisation in Xero you have provided access to.

To use this endpoint, you will need to replace :companyId with the unique identifier of the Organisation you are interested in, and, optionally, select the request status, specify dates, select the preferred sorting, input pagination and number of the request per page.

When a GET request is made to this endpoint, the API will return a response containing a list of Bills with selected parameters associated with the specified Organisation. 
GET api/v1/companies/:companyId/xero/batch-payment/:requestId
This endpoint allows you to retrieve specific Batch Payment details for a particular Organisation you have provided access to.

To use this endpoint, you will need to replace :companyId with the unique identifier of the Organisation and :requestId with the unique identifier of the Batch Payment you are interested in.

When a GET request is made to this endpoint, the API will return a response containing the details of the Batch Payment.  The response includes information such as the Batch Payment number, date, item details, quantities, and any additional relevant data related to the Batch Payment.
GET /api/v1/companies/:companyId/xero/batch-payment
This endpoint allows you to retrieve a list of Batch Payments associated with a specific Organisation in Xero you have provided access to.

To use this endpoint, you will need to replace :companyId with the unique identifier of the Organisation you are interested in, and, optionally, select the request status, specify dates, select the preferred sorting, input pagination and number of the request per page.

When a GET request is made to this endpoint, the API will return a response containing a list of Batch Payments with selected parameters associated with the specified Organisation. 

    • Related Articles

    • How to call the API?

      Please refer to the Swagger page or the list of available endpoints to find endpoints and their data models. To successfully make API calls, ensure that you include the following headers in your requests: Authorisation header: this is crucial for ...

    • Connections list overview

      The Connections List page is a dedicated webpage designed to facilitate the management of connections in ApprovalMax. It provides a secure environment for users to effectively manage their connections and ensure optimal security. On the Connections ...

    • How to grant access to an Organisation in the ApprovalMax Public API

      The process of granting access to an Organisation consists of the following steps: 1. Initiate user authorisation: generate an URL with the necessary parameters. This URL will direct account owners/ account managers to the ApprovalMax Public API ...

    • Who has access to the Connections List?

      Access to the Connections List is strictly limited to Account Owners or Account Managers. This restriction is in place to ensure the confidentiality and security of the data accessed through this list. Each user is only able to view and manage their ...

    • Prerequisites for using the Public API

      Before proceeding with the authorisation process for the ApprovalMax Public API feature, there are certain prerequisites that need to be met. These include: 1. Granting access to the Developer Portal: in order to access the Developer Portal and ...