Global API

API Overview

3min

Global Class

BreadwinnerXeroAPI is a global class that can be used to make requests to Xero via Breadwinner. As it is a part of the managed package, you must prepend the namespace "bread_winner".

Methods

The method call (Map<String, Object> request) is a static global method within the BreadwinnerXeroAPI class, which can be used to make an API request.

Format


Breadwinner accepts the request data in the form of Map<String, Object>, and returns the response data as a Map<String, Object>, thus making the requests and responses dynamic.

For more information, please refer to the Example Requests and Responses section.

Note: This is a synchronous method, it will make HTTP callouts. So, to access BreadwinnerXeroAPI.Call() method asynchronously, please annotate the method you are calling from with the Future(callout=true), or use Queueable Apex.

Example


Data in List Format

All data is sent and received via a list format, including single record responses. This applies to both the request and the response.

Updated 03 Mar 2023
Doc contributor
Did this page help you?