Skip to content
campaiDeveloper
campai.com

Finance · Accounting · Dimensions

DELETE/{organizationId}/finance/accounting/dimensions/{dimensionId}

Delete dimension

Deletes an unused, user-created accounting dimension for an organization. It takes organizationId and dimensionId and returns no value on success.

Permissions

Send an API key of the organization in the path, using the X-API-Key header.

Who may call it

  • The caller must have organization access with the accountingPlan.edit permission.

Request

Path parameters

  • organizationIdidrequired
  • dimensionIdidrequired
Request
curl --fail-with-body --silent --show-error --max-time 30 --globoff \
  --request DELETE 'https://cloud.campai.com/api/YOUR_ORGANIZATION_ID/finance/accounting/dimensions/YOUR_DIMENSION_ID' \
  --header 'X-API-Key: YOUR_API_KEY'

Response

200 Successful response

No response body is specified.

What else happens

  • Deletes the dimension if it exists, is not built in, and is not in use.

Errors

Other errors

StatusErrorWhen
400Dimensions are not available for this productIf dimensions are not available for the product, the endpoint returns HTTP 400 with key finance.accounting.dimension.notSupportedByProduct. Only region eu
400Cannot delete a built-in dimensionIf the dimension is built in, the endpoint returns HTTP 400 with key finance.accounting.dimension.cannotDeleteBuiltIn. Only region us
400A dimension that is already in use cannot be deletedIf the dimension is already in use, the endpoint returns HTTP 400 with key finance.accounting.dimension.cannotDeleteAlreadyUsed. Only region us
404Dimension not foundIf the dimension is not found in the organization, the endpoint returns HTTP 404 with key finance.accounting.dimension.notFound. Only region us

Errors nearly every request can meet are listed under Errors.