Request
Below are the supported actions which can be processed using Breadwinner for Xero Global API.
For each object below, prepend the object name with the supported operation to get the method name. For example, to read a contact, you would use the action readContact.
| read | create | update |
|---|---|---|---|
Contact | Y | Y | Y |
Invoice | Y | Y | Y |
Bill | Y | Y | Y |
Purchase Order | Y | Y | Y |
Payment | Y | Y | N/A |
Breadwinner accepts requests in the form of a Map<String, Object>.
These are the supported keys:
Key (String) | Value (Object) | Required |
|---|---|---|
version | 1.0 | True |
action | See the list of available actions. | True |
skipDML | Defaults to FALSE if not provided. When set to true, the record will be saved to Xero, but will not be replicated back to Salesforce | False |
requestJSON | Pass the data as a JSON string, based on the specified action. | True |
xeroOrgId | Required, if Xero Multi-Org is enabled in Breadwinner. In the case of a single Xero org, Breadwinner by default selects the connected Xero Org. | Conditional |
See the related objects in the left menu for more examples.
