Skip to content
campaiDeveloper
campai.com

Finance · Accounting · Dimensions

POST/{organizationId}/finance/accounting/dimensions

Create dimension

Creates an accounting dimension for an organization using a label, receipt types, required setting, and optional options. Returns the new dimension’s _id.

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

Body

Content-Type: application/json

  • labelstringrequired

    1–64 characters

  • receiptTypesstring[]required

    at least 1 items

    expense revenue invoice deposit donation offer confirmation
  • requiredbooleanrequired
  • optionsobject[]

    default []

    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' \
  --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

Content-Type: application/json

  • _idid
Response200
{
  "_id": "000000000000000000000001"
}

What else happens

  • On success, the endpoint creates an active custom dimension for the organization.

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
400Only options of fund dimensions can be restrictedIf any option has a non-null restriction, the endpoint returns HTTP 400 with key finance.accounting.dimension.restrictionRequiresFund. Only region us
400An organization can have at most {{max, number}} dimensionsIf the organization has reached the dimension limit, the endpoint returns HTTP 400 with key finance.accounting.dimension.limitReached. Only region us
400Fill this dimension in the following automatic sources first: sourcesIf the dimension is required and automatic sources are missing a valid selection, the endpoint returns HTTP 400 with key finance.accounting.dimension.requiredBlocked. 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.