Response
This 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:
Key (String) | Value (Object) | Additional Detail |
version | ‘1.0’ | Returns the same version sent in the Request |
action | See the list of available actions. | Returns the same action sent in the Request. |
timestamp | Timestamp in milliseconds (Unix). | The time at which the Response was returned. This can be used to troubleshoot. |
validRequest | Either true or false. | True if the Request satisfies the Breadwinner validations; False if it does not |
apiErrors | Returns Error list as a JSON string | List of errors that occurred while validating the request before making the request to QuickBooks. |
responseJSON | 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 QuickBooks. |
Key (String) | Data Type | Description |
code | String | A short string indicating the error code reported. |
message | String | A short subject of the error message. Example: Invalid Action |
detail | String | A detailed explanation of the Error occurred. Example: Breadwinner was unable to process the request as the action parameter was invalid. |
Errors
Before requesting QuickBooks
Errors that occur while validating the request, or while making a request to QuickBooks are returned as ‘apiErrors’ in the response.
After requesting QuickBooks
Errors occurred within QuickBooks 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 QuickBooks.
