​
message
string
required

The developer error message for your logs.

Example:

"QBD Connection Error (0x80040420): The QuickBooks user has denied access."

​
userFacingMessage
string
required

The user-friendly error message, written specifically for displaying to your end-users in your app's UI.

This value exists for every error. E.g., a QBD connection error might recommend the end-user to confirm their QuickBooks Desktop is open and that they're logged in. But if a Conductor API key is expired, e.g., this message will be masked and just say "An internal server error occurred. Please try again later."

Example:

"We could not connect to QuickBooks Desktop because we must re-authorize our connection. To fix this, open QuickBooks Desktop, log in as Admin, navigate to 'Edit > Preferences > Integrated Applications', click 'Company Preferences', select our app, click 'Properties...', ensure 'Allow this application to log in automatically' is checked, then click 'OK'. Then try again."

​
type
enum<string>
required

The type of error that occurred.

Available options:
INTEGRATION_ERROR,
INTEGRATION_CONNECTION_ERROR,
INVALID_REQUEST_ERROR,
AUTHENTICATION_ERROR,
PERMISSION_ERROR,
INTERNAL_ERROR
Example:

"INTEGRATION_CONNECTION_ERROR"

​
code
string
required

The unique error code from Conductor, which is useful for adding special handling for specific errors. E.g., 'RESOURCE_MISSING', 'API_KEY_INVALID', or 'QBD_REQUEST_ERROR'. In contrast, the error field type is more general and categorizes the error.

Example:

"QBD_CONNECTION_ERROR"

​
httpStatusCode
number
required

The HTTP status code of the response that returned this error.

Example:

502

​
requestId
string
required

The unique identifier for the request that returned this error.

If you need to contact us about a specific request, providing the request identifier will ensure the fastest possible resolution.

Example:

"req_1234567890"

​
integrationCode
string

The unique error code supplied by the third-party integration for errors returned by the integration (e.g., QuickBooks Desktop) or integration connector (e.g., Web Connector). This is useful for adding special handling for specific errors from the third-party integration or connector.

The integration's corresponding error message for this code is in error.message.

Example:

"0x80040420"