Errors
The following are possible errors generated by the Dimensions API.
General dimensions errors
| Error Type |
Error Code |
Message |
Description |
| SystemFault |
10000 |
An application error has occurred while processing your request. |
An incorrect ExtensionType value was found while attaching dimensions to a transaction. |
| INVALID_REQUEST |
CUSTOM_DIMENSION_DISABLED |
Dimension APIs are disabled since you logged into a non-Intuit Enterprise Suite company. |
Occurs when querying a dimension definition for a QuickBooks company that is not enrolled in Intuit Enterprise Suite. |
| VALIDATION_ERROR |
FETCH_PAGINATED_CUSTOM_DIMENSION_VALUES_FAILED |
The page numbers aren’t valid. Try a different value instead. |
Occurs when incorrect pagination values are set for parameters first and last while querying dimensions. |
Validation errors
Validations for create custom dimension values
| Rule |
Error Code |
| Label must not be empty |
DIMENSION_VALUE_LABEL_EMPTY |
| Label must be ≤ 100 characters |
DIMENSION_VALUE_LABEL_TOO_LONG |
| Label must not contain : |
DIMENSION_VALUE_LABEL_INVALID_CHARS |
| Label must be unique within the definition (by fully qualified label) |
DUPLICATE_CUSTOM_DIMENSION_VALUE_LABEL |
| Definition ID must not be empty (SE) |
DIMENSION_DEFINITION_ID_EMPTY |
| Definition must exist (ME) |
DIMENSION_DEFINITION_NOT_FOUND |
| Definition must be active |
DIMENSION_DEFINITION_INACTIVE |
| Parent ID must not be empty string (if provided) |
DIMENSION_VALUE_PARENT_ID_EMPTY |
| Parent value must exist (if parentId provided) |
DIMENSION_VALUE_PARENT_NOT_FOUND |
| Parent value must be active (if parentId provided) |
DIMENSION_VALUE_PARENT_INACTIVE |
| Hierarchy nesting must not exceed level 4 |
DIMENSION_VALUE_MAX_LEVEL_EXCEEDED |
| QBO subscription must be active |
EXPIRED_QBO_SUBSCRIPTION |
Validations for update custom dimension values
| Rule |
Error Code |
| Value must exist |
DIMENSION_VALUE_NOT_FOUND |
| Value must be active (when changing label) |
DIMENSION_VALUE_INACTIVE |
| Definition must exist (ME) |
DIMENSION_DEFINITION_NOT_FOUND |
| Definition must be active |
DIMENSION_DEFINITION_INACTIVE |
Validations for disable custom dimension values
| Rule |
Error Code |
| Value must exist |
DIMENSION_VALUE_NOT_FOUND |
| Definition must exist (ME) |
DIMENSION_DEFINITION_NOT_FOUND |
| Definition must be active |
DIMENSION_DEFINITION_INACTIVE |
| QBO subscription must be active |
EXPIRED_QBO_SUBSCRIPTION |
Label validation errors
| Error Code |
Descriptione |
| DIMENSION_VALUE_LABEL_EMPTY |
Value label is empty |
| DIMENSION_VALUE_LABEL_TOO_LONG |
Value label exceeds 100 characters |
| DIMENSION_VALUE_LABEL_INVALID_CHARS |
Value label contains : |
| DUPLICATE_CUSTOM_DIMENSION_VALUE_LABEL |
A value with the same fully qualified label already exists in the definition |
Definition validation errors
| Error Code |
Descriptione |
| DIMENSION_DEFINITION_ID_EMPTY |
Definition ID is empty |
| DIMENSION_DEFINITION_NOT_FOUND |
The specified definition does not exist |
| DIMENSION_DEFINITION_INACTIVE |
The specified definition is inactive/disabled |
Value validation errors
| Error Code |
Descriptione |
| DIMENSION_VALUE_NOT_FOUND |
The specified value does not exist |
| DIMENSION_VALUE_INACTIVE |
Cannot update a value that is already inactive |
| DIMENSION_VALUE_PARENT_ID_EMPTY |
Parent ID is an empty string |
| DIMENSION_VALUE_PARENT_NOT_FOUND |
The specified parent value does not exist |
| DIMENSION_VALUE_PARENT_INACTIVE |
The specified parent value is inactive |
| DIMENSION_VALUE_MAX_LEVEL_EXCEEDED |
Hierarchy nesting exceeds the maximum depth of 4 levels |
Authorization errors
| Error Code |
Descriptione |
| AUTHORIZATION_DENIED |
Access denied — insufficient permissions for the requested action |
Feature/subscription errors
| Error Code |
Descriptione |
| EXTERNAL_CUSTOM_DIMENSION_MUTATIONS_DISABLED |
Write APIs are not enabled for this account |
| SHARED_CUSTOM_DIMENSION_NOT_SUPPORTED |
Multi-entity dimensions are not enabled for this ME account |
| EXPIRED_QBO_SUBSCRIPTION |
The QBO subscription is inactive or expired |
Multi-entity dimension errors
| Error type |
HTTP Code |
Descripton |
| VALIDATION_ERROR |
400 |
definitionId or id does not exist |
| VALIDATION_ERROR |
400 |
Missing required fields (label, definitionId) |
| VALIDATION_ERROR |
400 |
Label exceeds max length (definition: 40 chars, value: 100 chars) |
| VALIDATION_ERROR |
400 |
Label contains invalid characters |
| VALIDATION_ERROR |
400 |
Duplicate label (fully qualified) under the same definition |
| VALIDATION_ERROR |
400 |
Parent value is inactive or disabled |
| VALIDATION_ERROR |
400 |
Parent definition is inactive or disabled |
| VALIDATION_ERROR |
400 |
Max value hierarchy level exceeded |
| VALIDATION_ERROR |
400 |
Attempting to update a shared dimension through SE API when ME is enabled |
| VALIDATION_ERROR |
400 |
QBO subscription expired or canceled |
| INVALID_REQUEST |
403 |
User lacks authorization |
| INVALID_REQUEST |
403 |
User doesn’t have access to the target realm in ME |
| SYSTEM_ERROR |
500 |
Database constraint violation or internal failure |
System errors
| Error Code |
Descriptione |
| CREATE_CUSTOM_DIMENSION_VALUE_FAILED |
Unexpected error during value creation |
| UPDATE_CUSTOM_DIMENSION_VALUE_FAILED |
Unexpected error during value update |
| DISABLE_CUSTOM_DIMENSION_VALUE_FAILED |
Unexpected error during value disable |
| INTERNAL_SERVER_ERROR |
Unexpected internal system error |