Skip to content
campaiDeveloper
campai.com

Finance · Accounting · Dimensions

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

Update dimension

Updates a dimension’s label, receipt types, active and required status, and options. The request takes an organization ID, a dimension ID, and the updated fields. It returns no content 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 and the accountingPlan.edit permission.

Request

Path parameters

  • organizationIdidrequired
  • dimensionIdidrequired

Body

Content-Type: application/json

  • labelstringrequired

    1–64 characters

  • receiptTypesstring[]required

    at least 1 items

    expense revenue invoice deposit donation offer confirmation
  • activebooleanrequired
  • requiredbooleanrequired
  • optionsobject[]required
    4 properties
    • keystringrequired

      1–64 characters

    • labelstringrequired

      1–64 characters

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

No request that worked has been recorded yet, so the body is not shown.

Response

200 Successful response

No response body is specified.

What else happens

  • On success, the dimension’s label, receiptTypes, active, required, and options are updated.

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
400Fund dimensions must be available for every receipt typeIf a fund dimension is not available for every receipt type, the endpoint returns HTTP 400 with key finance.accounting.dimension.fundReceiptTypesRequired. Only region us
400Only options of fund dimensions can be restrictedIf an option of a non-fund dimension has a restriction, the endpoint returns HTTP 400 with key finance.accounting.dimension.restrictionRequiresFund. Only region us
400Built-in dimensions must remain active and requiredIf a built-in dimension is set inactive or not required, the endpoint returns HTTP 400 with key finance.accounting.dimension.builtInStatusImmutable. Only region us
400Fill this dimension in the following automatic sources first: sourcesWhen making a dimension active and required, if automatic sources are missing a selection of an active option, the endpoint returns HTTP 400 with key finance.accounting.dimension.requiredBlocked. The message includes up to five blocking source names. 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

Marked words such as sources are filled in with the actual value when the error happens.

Errors nearly every request can meet are listed under Errors.