All API resources
API reference

Dimensions

Tracking categories, such as Property or Department, whose options tag journal lines.

Base URL https://app.prosaic.works/api/public/v1. Every request needs an API key or access token; see the overview.

List dimensions

GET/api/public/v1/entities/{entityId}/dimensions

SDK: prosaic.dimensions.list(entityId)

Returns the entity's active dimensions (tracking categories such as Property or Department) with their active options. Use each option's id as a value in dimensionOptionIds when creating journals (POST /api/public/v1/entities/{entityId}/journals) or reconciling transactions (POST /api/public/v1/entities/{entityId}/transactions/{transactionId}/reconcile).

Archived dimensions and archived options are excluded. Requires API key authentication and entity access.

Path parameters

  • entityIdstringrequired

Responses

200 Successful response

  • dataarray of objectsrequired
    Show 5 child attributes
    • idstringrequired
    • namestringrequired
    • typeKeystringrequired
    • enforcementstringrequired
    • optionsarray of objectsrequired
      Show 3 child attributes
      • idstringrequired
      • namestringrequired
      • codestringrequirednullable
  • metaobject
    Show 1 child attribute
    • countnumberrequired
  • 401 Invalid or missing API key
  • 403 API key does not have access to this entity
Node SDK
const { data } = await prosaic.dimensions.list(entityId);
curl
curl https://app.prosaic.works/api/public/v1/entities/$ENTITY_ID/dimensions \
  -H "Authorization: Bearer $PROSAIC_API_KEY"