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 response /#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 error 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 examples breadwinner does validation prior to calling out to quickbooks invalid request { action=readcustomer, apierrors={"errors" \[ {"message" "breadwinner was unable to process the request as the version parameter was not valid ", "code" "invalid version", "detail" "the version 1 1, is not supported by breadwinner please refer to the breadwinner api docs for the list of supported versions " } ] }, timestamp=1635186915365, validrequest=false, version=1 1 } the errors that quickbooks returns will be included as "errors" in the "responsejson" below is the example that was reformatted for easier reading 400 { action=createcustomer, responsejson={ "customers" null, "statuscode" 400, "status" "bad request", "errors" \[ { "message" "no name provided", "detail" "title, givenname, middlename, familyname, displayname, suffix one of these must be non empty ", "code" "6080" } ] }, timestamp=1635239587001, validrequest=true, version=1 0 }