Response is the information returned from the Request call. This will be returned in the form of a Map<String, Object>.
Below is the list of Keys or Parameters returned in the Response Map:
Returns the same version sent in the Request
See the list of available actions.
Returns the same action sent in the Request.
Timestamp in milliseconds (Unix).
The time at which the Response was returned. This can be used to troubleshoot.
Either true or false.
True if the Request satisfies the Breadwinner validations; False if it does not
Returns Error list as a JSON string
List of errors that occurred while validating the request before making the request to Xero.
Returns the response of the record(s) as a JSON string.
Includes the records data as well as any errors that were sent to Breadwinner from Xero.
A short string indicating the error code reported.
A detailed explanation of the Error occurred. Example: Breadwinner was unable to process the request as the action parameter was invalid.
Errors that occur while validating the request, or while making a request to Xero are returned as ‘apiErrors’ in the response.
Errors occurred within Xero while processing the request, or while processing the data in Breadwinner are sent as ‘errors’ in the responseJSON key of the Response map.
Breadwinner does validation prior to calling out to Xero.