Skip to content
campaiDeveloper
campai.com

Finance · Accounting · Dimensions

GET/{organizationId}/finance/accounting/dimensionsReads only

List dimensions

Lists active and inactive accounting dimensions and their options for an organization. Pass the organization ID to receive an array of dimensions.

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.read permission.

Request

Path parameters

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

Response

200 Successful response

Content-Type: application/json

A list of object.

  • _idid
  • labelstring

    1–64 characters

  • rolestring
    fund custom
  • receiptTypesstring[]

    at least 1 items

    expense revenue invoice deposit donation offer confirmation
  • requiredboolean
  • activeboolean
  • builtInboolean
  • optionsobject[]
    4 properties
    • keystring

      1–64 characters

    • labelstring

      1–64 characters

    • activeboolean
    • restrictionstringnullable
      donor
Response200
[
  {
    "_id": "000000000000000000000001",
    "label": "string",
    "role": "fund",
    "receiptTypes": [
      "expense"
    ],
    "required": true,
    "active": true,
    "builtIn": true,
    "options": [
      {
        "key": "string",
        "label": "string",
        "active": true,
        "restriction": null
      }
    ]
  }
]

Errors

No errors of its own are known for this endpoint.

Errors nearly every request can meet are listed under Errors.