# Accounting Dimensions — DayZero API 6 endpoints. OpenAPI for just this tag: https://www.ondayzero.com/docs/reference/accounting-dimensions/openapi.json · HTML: https://www.ondayzero.com/docs/reference/accounting-dimensions · All tags: https://www.ondayzero.com/docs/reference/index.md ## Endpoints - `GET /api/v1/accounting-dimensions` — List classes/locations - `POST /api/v1/accounting-dimensions` — Create class/location - `GET /api/v1/accounting-dimensions/pnl` — Dimensional P&L - `DELETE /api/v1/accounting-dimensions/{dimension_id}` — Deactivate class/location - `GET /api/v1/accounting-dimensions/{dimension_id}` — Get class/location - `PUT /api/v1/accounting-dimensions/{dimension_id}` — Update class/location --- ## GET /api/v1/accounting-dimensions > List classes/locations - **Tag:** accounting-dimensions - **Operation ID:** `list_dimensions` ### Description List accounting dimensions, optionally filtered by type. ### Authentication Bearer token in `Authorization` header. Required header: `x-business-id: `. ### Parameters - `dimension_type` (query, string, optional) — Filter by 'class' or 'location'. - `include_inactive` (query, boolean, optional) ### Responses #### 200 — Successful Response Schema: `SuccessEnvelope_AccountingDimensionsListResponse_` - `success` (boolean) - `message` (string) - `code` (string) - `data` (AccountingDimensionsListResponse) #### 401 — Unauthorized - Missing or expired token, an MCP OAuth token used against the REST API, or no access to this business Schema: `ErrorResponse` - `error` (string · required) — Error category: `validation_error`, `unauthorized`, `forbidden`, `not_found`, `conflict`, `rate_limited`, `server_error`, or `service_unavailable`. - `message` (string · required) — Human-readable explanation, safe to show to end users. - `code` (string · required) — Stable machine-readable code in `CATEGORY_NNN` form (e.g. `NOT_FOUND_006`, `AUTH_010`, `GEN_002`). - `request_id` (string) — Correlation id for support requests. Echoes the `x-request-id` request header when one was supplied. - `errors` (object) — Field-level validation messages keyed by field name. Present on 400/422 validation failures only. #### 403 — Forbidden - Insufficient permissions Schema: `ErrorResponse` - `error` (string · required) — Error category: `validation_error`, `unauthorized`, `forbidden`, `not_found`, `conflict`, `rate_limited`, `server_error`, or `service_unavailable`. - `message` (string · required) — Human-readable explanation, safe to show to end users. - `code` (string · required) — Stable machine-readable code in `CATEGORY_NNN` form (e.g. `NOT_FOUND_006`, `AUTH_010`, `GEN_002`). - `request_id` (string) — Correlation id for support requests. Echoes the `x-request-id` request header when one was supplied. - `errors` (object) — Field-level validation messages keyed by field name. Present on 400/422 validation failures only. #### 422 — Validation Error Schema: `ErrorResponse` - `error` (string · required) — Error category: `validation_error`, `unauthorized`, `forbidden`, `not_found`, `conflict`, `rate_limited`, `server_error`, or `service_unavailable`. - `message` (string · required) — Human-readable explanation, safe to show to end users. - `code` (string · required) — Stable machine-readable code in `CATEGORY_NNN` form (e.g. `NOT_FOUND_006`, `AUTH_010`, `GEN_002`). - `request_id` (string) — Correlation id for support requests. Echoes the `x-request-id` request header when one was supplied. - `errors` (object) — Field-level validation messages keyed by field name. Present on 400/422 validation failures only. ### Code samples #### cURL ```bash curl -X GET 'https://api.ondayzero.com/api/v1/accounting-dimensions' \ -H 'Authorization: Bearer dz_your_token' \ -H 'x-business-id: YOUR_BUSINESS_ID' ``` #### JavaScript ```javascript const response = await fetch('https://api.ondayzero.com/api/v1/accounting-dimensions', { method: 'GET', headers: { Authorization: 'Bearer dz_your_token', 'x-business-id': 'YOUR_BUSINESS_ID', }, }); const data = await response.json(); ``` #### Python ```python import httpx headers = { "Authorization": "Bearer dz_your_token", "x-business-id": "YOUR_BUSINESS_ID", } response = httpx.get("https://api.ondayzero.com/api/v1/accounting-dimensions", headers=headers) data = response.json() ``` ### See also - HTML version: https://www.ondayzero.com/docs/reference/accounting-dimensions/list-dimensions - OpenAPI slice: https://www.ondayzero.com/docs/reference/accounting-dimensions/list-dimensions/openapi.json - Other endpoints in **accounting-dimensions**: https://www.ondayzero.com/docs/reference/accounting-dimensions (markdown bundle: https://www.ondayzero.com/docs/reference/accounting-dimensions.md, OpenAPI: https://www.ondayzero.com/docs/reference/accounting-dimensions/openapi.json) - Endpoint catalog: https://www.ondayzero.com/docs/reference/index.md --- ## POST /api/v1/accounting-dimensions > Create class/location - **Tag:** accounting-dimensions - **Operation ID:** `create_dimension` ### Description Create a new accounting dimension. ### Authentication Bearer token in `Authorization` header. Required header: `x-business-id: `. ### Request body Schema: `AccountingDimensionCreateRequest` - `dimension_type` (string · required) (one of: class, location) — Either 'class' or 'location'. - `name` (string · required) - `code` (string) - `parent_id` (string) — Optional parent dimension (for sub-classes/locations). ### Responses #### 201 — Successful Response Schema: `SuccessEnvelope_AccountingDimensionResponse_` - `success` (boolean) - `message` (string) - `code` (string) - `data` (AccountingDimensionResponse) #### 400 — Bad Request - Invalid input Schema: `ErrorResponse` - `error` (string · required) — Error category: `validation_error`, `unauthorized`, `forbidden`, `not_found`, `conflict`, `rate_limited`, `server_error`, or `service_unavailable`. - `message` (string · required) — Human-readable explanation, safe to show to end users. - `code` (string · required) — Stable machine-readable code in `CATEGORY_NNN` form (e.g. `NOT_FOUND_006`, `AUTH_010`, `GEN_002`). - `request_id` (string) — Correlation id for support requests. Echoes the `x-request-id` request header when one was supplied. - `errors` (object) — Field-level validation messages keyed by field name. Present on 400/422 validation failures only. #### 401 — Unauthorized - Missing or expired token, an MCP OAuth token used against the REST API, or no access to this business Schema: `ErrorResponse` - `error` (string · required) — Error category: `validation_error`, `unauthorized`, `forbidden`, `not_found`, `conflict`, `rate_limited`, `server_error`, or `service_unavailable`. - `message` (string · required) — Human-readable explanation, safe to show to end users. - `code` (string · required) — Stable machine-readable code in `CATEGORY_NNN` form (e.g. `NOT_FOUND_006`, `AUTH_010`, `GEN_002`). - `request_id` (string) — Correlation id for support requests. Echoes the `x-request-id` request header when one was supplied. - `errors` (object) — Field-level validation messages keyed by field name. Present on 400/422 validation failures only. #### 403 — Forbidden - Insufficient permissions Schema: `ErrorResponse` - `error` (string · required) — Error category: `validation_error`, `unauthorized`, `forbidden`, `not_found`, `conflict`, `rate_limited`, `server_error`, or `service_unavailable`. - `message` (string · required) — Human-readable explanation, safe to show to end users. - `code` (string · required) — Stable machine-readable code in `CATEGORY_NNN` form (e.g. `NOT_FOUND_006`, `AUTH_010`, `GEN_002`). - `request_id` (string) — Correlation id for support requests. Echoes the `x-request-id` request header when one was supplied. - `errors` (object) — Field-level validation messages keyed by field name. Present on 400/422 validation failures only. #### 404 — Not Found - Resource does not exist Schema: `ErrorResponse` - `error` (string · required) — Error category: `validation_error`, `unauthorized`, `forbidden`, `not_found`, `conflict`, `rate_limited`, `server_error`, or `service_unavailable`. - `message` (string · required) — Human-readable explanation, safe to show to end users. - `code` (string · required) — Stable machine-readable code in `CATEGORY_NNN` form (e.g. `NOT_FOUND_006`, `AUTH_010`, `GEN_002`). - `request_id` (string) — Correlation id for support requests. Echoes the `x-request-id` request header when one was supplied. - `errors` (object) — Field-level validation messages keyed by field name. Present on 400/422 validation failures only. #### 422 — Validation Error Schema: `ErrorResponse` - `error` (string · required) — Error category: `validation_error`, `unauthorized`, `forbidden`, `not_found`, `conflict`, `rate_limited`, `server_error`, or `service_unavailable`. - `message` (string · required) — Human-readable explanation, safe to show to end users. - `code` (string · required) — Stable machine-readable code in `CATEGORY_NNN` form (e.g. `NOT_FOUND_006`, `AUTH_010`, `GEN_002`). - `request_id` (string) — Correlation id for support requests. Echoes the `x-request-id` request header when one was supplied. - `errors` (object) — Field-level validation messages keyed by field name. Present on 400/422 validation failures only. ### Code samples #### cURL ```bash curl -X POST 'https://api.ondayzero.com/api/v1/accounting-dimensions' \ -H 'Authorization: Bearer dz_your_token' \ -H 'x-business-id: YOUR_BUSINESS_ID' \ -H 'Content-Type: application/json' \ -d '{ "dimension_type": "class", "name": "string" }' ``` #### JavaScript ```javascript const response = await fetch('https://api.ondayzero.com/api/v1/accounting-dimensions', { method: 'POST', headers: { Authorization: 'Bearer dz_your_token', 'x-business-id': 'YOUR_BUSINESS_ID', 'Content-Type': 'application/json', }, body: JSON.stringify({ "dimension_type": "class", "name": "string" }), }); const data = await response.json(); ``` #### Python ```python import httpx headers = { "Authorization": "Bearer dz_your_token", "x-business-id": "YOUR_BUSINESS_ID", } payload = {'dimension_type': 'class', 'name': 'string'} response = httpx.post("https://api.ondayzero.com/api/v1/accounting-dimensions", headers=headers, json=payload) data = response.json() ``` ### See also - HTML version: https://www.ondayzero.com/docs/reference/accounting-dimensions/create-dimension - OpenAPI slice: https://www.ondayzero.com/docs/reference/accounting-dimensions/create-dimension/openapi.json - Other endpoints in **accounting-dimensions**: https://www.ondayzero.com/docs/reference/accounting-dimensions (markdown bundle: https://www.ondayzero.com/docs/reference/accounting-dimensions.md, OpenAPI: https://www.ondayzero.com/docs/reference/accounting-dimensions/openapi.json) - Endpoint catalog: https://www.ondayzero.com/docs/reference/index.md --- ## GET /api/v1/accounting-dimensions/pnl > Dimensional P&L - **Tag:** accounting-dimensions - **Operation ID:** `dimensional_pnl` ### Description Profit & loss broken down by class or location for a date range. ### Authentication Bearer token in `Authorization` header. Required header: `x-business-id: `. ### Parameters - `dimension_type` (query, string, required) — 'class' or 'location'. - `start_date` (query, string · date, required) — Period start (inclusive). - `end_date` (query, string · date, required) — Period end (inclusive). ### Responses #### 200 — Successful Response Schema: `SuccessEnvelope_DimensionalPnLResponse_` - `success` (boolean) - `message` (string) - `code` (string) - `data` (DimensionalPnLResponse) #### 400 — Bad Request - Invalid input Schema: `ErrorResponse` - `error` (string · required) — Error category: `validation_error`, `unauthorized`, `forbidden`, `not_found`, `conflict`, `rate_limited`, `server_error`, or `service_unavailable`. - `message` (string · required) — Human-readable explanation, safe to show to end users. - `code` (string · required) — Stable machine-readable code in `CATEGORY_NNN` form (e.g. `NOT_FOUND_006`, `AUTH_010`, `GEN_002`). - `request_id` (string) — Correlation id for support requests. Echoes the `x-request-id` request header when one was supplied. - `errors` (object) — Field-level validation messages keyed by field name. Present on 400/422 validation failures only. #### 401 — Unauthorized - Missing or expired token, an MCP OAuth token used against the REST API, or no access to this business Schema: `ErrorResponse` - `error` (string · required) — Error category: `validation_error`, `unauthorized`, `forbidden`, `not_found`, `conflict`, `rate_limited`, `server_error`, or `service_unavailable`. - `message` (string · required) — Human-readable explanation, safe to show to end users. - `code` (string · required) — Stable machine-readable code in `CATEGORY_NNN` form (e.g. `NOT_FOUND_006`, `AUTH_010`, `GEN_002`). - `request_id` (string) — Correlation id for support requests. Echoes the `x-request-id` request header when one was supplied. - `errors` (object) — Field-level validation messages keyed by field name. Present on 400/422 validation failures only. #### 403 — Forbidden - Insufficient permissions Schema: `ErrorResponse` - `error` (string · required) — Error category: `validation_error`, `unauthorized`, `forbidden`, `not_found`, `conflict`, `rate_limited`, `server_error`, or `service_unavailable`. - `message` (string · required) — Human-readable explanation, safe to show to end users. - `code` (string · required) — Stable machine-readable code in `CATEGORY_NNN` form (e.g. `NOT_FOUND_006`, `AUTH_010`, `GEN_002`). - `request_id` (string) — Correlation id for support requests. Echoes the `x-request-id` request header when one was supplied. - `errors` (object) — Field-level validation messages keyed by field name. Present on 400/422 validation failures only. #### 422 — Validation Error Schema: `ErrorResponse` - `error` (string · required) — Error category: `validation_error`, `unauthorized`, `forbidden`, `not_found`, `conflict`, `rate_limited`, `server_error`, or `service_unavailable`. - `message` (string · required) — Human-readable explanation, safe to show to end users. - `code` (string · required) — Stable machine-readable code in `CATEGORY_NNN` form (e.g. `NOT_FOUND_006`, `AUTH_010`, `GEN_002`). - `request_id` (string) — Correlation id for support requests. Echoes the `x-request-id` request header when one was supplied. - `errors` (object) — Field-level validation messages keyed by field name. Present on 400/422 validation failures only. ### Code samples #### cURL ```bash curl -X GET 'https://api.ondayzero.com/api/v1/accounting-dimensions/pnl' \ -H 'Authorization: Bearer dz_your_token' \ -H 'x-business-id: YOUR_BUSINESS_ID' ``` #### JavaScript ```javascript const response = await fetch('https://api.ondayzero.com/api/v1/accounting-dimensions/pnl', { method: 'GET', headers: { Authorization: 'Bearer dz_your_token', 'x-business-id': 'YOUR_BUSINESS_ID', }, }); const data = await response.json(); ``` #### Python ```python import httpx headers = { "Authorization": "Bearer dz_your_token", "x-business-id": "YOUR_BUSINESS_ID", } response = httpx.get("https://api.ondayzero.com/api/v1/accounting-dimensions/pnl", headers=headers) data = response.json() ``` ### See also - HTML version: https://www.ondayzero.com/docs/reference/accounting-dimensions/dimensional-pnl - OpenAPI slice: https://www.ondayzero.com/docs/reference/accounting-dimensions/dimensional-pnl/openapi.json - Other endpoints in **accounting-dimensions**: https://www.ondayzero.com/docs/reference/accounting-dimensions (markdown bundle: https://www.ondayzero.com/docs/reference/accounting-dimensions.md, OpenAPI: https://www.ondayzero.com/docs/reference/accounting-dimensions/openapi.json) - Endpoint catalog: https://www.ondayzero.com/docs/reference/index.md --- ## DELETE /api/v1/accounting-dimensions/{dimension_id} > Deactivate class/location - **Tag:** accounting-dimensions - **Operation ID:** `deactivate_dimension` ### Description Soft-delete (deactivate) an accounting dimension. ### Authentication Bearer token in `Authorization` header. Required header: `x-business-id: `. ### Parameters - `dimension_id` (path, string, required) ### Responses #### 200 — Successful Response Schema: `SuccessEnvelope_AccountingDimensionResponse_` - `success` (boolean) - `message` (string) - `code` (string) - `data` (AccountingDimensionResponse) #### 401 — Unauthorized - Missing or expired token, an MCP OAuth token used against the REST API, or no access to this business Schema: `ErrorResponse` - `error` (string · required) — Error category: `validation_error`, `unauthorized`, `forbidden`, `not_found`, `conflict`, `rate_limited`, `server_error`, or `service_unavailable`. - `message` (string · required) — Human-readable explanation, safe to show to end users. - `code` (string · required) — Stable machine-readable code in `CATEGORY_NNN` form (e.g. `NOT_FOUND_006`, `AUTH_010`, `GEN_002`). - `request_id` (string) — Correlation id for support requests. Echoes the `x-request-id` request header when one was supplied. - `errors` (object) — Field-level validation messages keyed by field name. Present on 400/422 validation failures only. #### 403 — Forbidden - Insufficient permissions Schema: `ErrorResponse` - `error` (string · required) — Error category: `validation_error`, `unauthorized`, `forbidden`, `not_found`, `conflict`, `rate_limited`, `server_error`, or `service_unavailable`. - `message` (string · required) — Human-readable explanation, safe to show to end users. - `code` (string · required) — Stable machine-readable code in `CATEGORY_NNN` form (e.g. `NOT_FOUND_006`, `AUTH_010`, `GEN_002`). - `request_id` (string) — Correlation id for support requests. Echoes the `x-request-id` request header when one was supplied. - `errors` (object) — Field-level validation messages keyed by field name. Present on 400/422 validation failures only. #### 404 — Not Found - Resource does not exist Schema: `ErrorResponse` - `error` (string · required) — Error category: `validation_error`, `unauthorized`, `forbidden`, `not_found`, `conflict`, `rate_limited`, `server_error`, or `service_unavailable`. - `message` (string · required) — Human-readable explanation, safe to show to end users. - `code` (string · required) — Stable machine-readable code in `CATEGORY_NNN` form (e.g. `NOT_FOUND_006`, `AUTH_010`, `GEN_002`). - `request_id` (string) — Correlation id for support requests. Echoes the `x-request-id` request header when one was supplied. - `errors` (object) — Field-level validation messages keyed by field name. Present on 400/422 validation failures only. #### 422 — Validation Error Schema: `ErrorResponse` - `error` (string · required) — Error category: `validation_error`, `unauthorized`, `forbidden`, `not_found`, `conflict`, `rate_limited`, `server_error`, or `service_unavailable`. - `message` (string · required) — Human-readable explanation, safe to show to end users. - `code` (string · required) — Stable machine-readable code in `CATEGORY_NNN` form (e.g. `NOT_FOUND_006`, `AUTH_010`, `GEN_002`). - `request_id` (string) — Correlation id for support requests. Echoes the `x-request-id` request header when one was supplied. - `errors` (object) — Field-level validation messages keyed by field name. Present on 400/422 validation failures only. ### Code samples #### cURL ```bash curl -X DELETE 'https://api.ondayzero.com/api/v1/accounting-dimensions/{dimension_id}' \ -H 'Authorization: Bearer dz_your_token' \ -H 'x-business-id: YOUR_BUSINESS_ID' ``` #### JavaScript ```javascript const response = await fetch('https://api.ondayzero.com/api/v1/accounting-dimensions/{dimension_id}', { method: 'DELETE', headers: { Authorization: 'Bearer dz_your_token', 'x-business-id': 'YOUR_BUSINESS_ID', }, }); const data = await response.json(); ``` #### Python ```python import httpx headers = { "Authorization": "Bearer dz_your_token", "x-business-id": "YOUR_BUSINESS_ID", } response = httpx.delete("https://api.ondayzero.com/api/v1/accounting-dimensions/{dimension_id}", headers=headers) data = response.json() ``` ### See also - HTML version: https://www.ondayzero.com/docs/reference/accounting-dimensions/deactivate-dimension - OpenAPI slice: https://www.ondayzero.com/docs/reference/accounting-dimensions/deactivate-dimension/openapi.json - Other endpoints in **accounting-dimensions**: https://www.ondayzero.com/docs/reference/accounting-dimensions (markdown bundle: https://www.ondayzero.com/docs/reference/accounting-dimensions.md, OpenAPI: https://www.ondayzero.com/docs/reference/accounting-dimensions/openapi.json) - Endpoint catalog: https://www.ondayzero.com/docs/reference/index.md --- ## GET /api/v1/accounting-dimensions/{dimension_id} > Get class/location - **Tag:** accounting-dimensions - **Operation ID:** `get_dimension` ### Description Get a single accounting dimension. ### Authentication Bearer token in `Authorization` header. Required header: `x-business-id: `. ### Parameters - `dimension_id` (path, string, required) ### Responses #### 200 — Successful Response Schema: `SuccessEnvelope_AccountingDimensionResponse_` - `success` (boolean) - `message` (string) - `code` (string) - `data` (AccountingDimensionResponse) #### 401 — Unauthorized - Missing or expired token, an MCP OAuth token used against the REST API, or no access to this business Schema: `ErrorResponse` - `error` (string · required) — Error category: `validation_error`, `unauthorized`, `forbidden`, `not_found`, `conflict`, `rate_limited`, `server_error`, or `service_unavailable`. - `message` (string · required) — Human-readable explanation, safe to show to end users. - `code` (string · required) — Stable machine-readable code in `CATEGORY_NNN` form (e.g. `NOT_FOUND_006`, `AUTH_010`, `GEN_002`). - `request_id` (string) — Correlation id for support requests. Echoes the `x-request-id` request header when one was supplied. - `errors` (object) — Field-level validation messages keyed by field name. Present on 400/422 validation failures only. #### 403 — Forbidden - Insufficient permissions Schema: `ErrorResponse` - `error` (string · required) — Error category: `validation_error`, `unauthorized`, `forbidden`, `not_found`, `conflict`, `rate_limited`, `server_error`, or `service_unavailable`. - `message` (string · required) — Human-readable explanation, safe to show to end users. - `code` (string · required) — Stable machine-readable code in `CATEGORY_NNN` form (e.g. `NOT_FOUND_006`, `AUTH_010`, `GEN_002`). - `request_id` (string) — Correlation id for support requests. Echoes the `x-request-id` request header when one was supplied. - `errors` (object) — Field-level validation messages keyed by field name. Present on 400/422 validation failures only. #### 404 — Not Found - Resource does not exist Schema: `ErrorResponse` - `error` (string · required) — Error category: `validation_error`, `unauthorized`, `forbidden`, `not_found`, `conflict`, `rate_limited`, `server_error`, or `service_unavailable`. - `message` (string · required) — Human-readable explanation, safe to show to end users. - `code` (string · required) — Stable machine-readable code in `CATEGORY_NNN` form (e.g. `NOT_FOUND_006`, `AUTH_010`, `GEN_002`). - `request_id` (string) — Correlation id for support requests. Echoes the `x-request-id` request header when one was supplied. - `errors` (object) — Field-level validation messages keyed by field name. Present on 400/422 validation failures only. #### 422 — Validation Error Schema: `ErrorResponse` - `error` (string · required) — Error category: `validation_error`, `unauthorized`, `forbidden`, `not_found`, `conflict`, `rate_limited`, `server_error`, or `service_unavailable`. - `message` (string · required) — Human-readable explanation, safe to show to end users. - `code` (string · required) — Stable machine-readable code in `CATEGORY_NNN` form (e.g. `NOT_FOUND_006`, `AUTH_010`, `GEN_002`). - `request_id` (string) — Correlation id for support requests. Echoes the `x-request-id` request header when one was supplied. - `errors` (object) — Field-level validation messages keyed by field name. Present on 400/422 validation failures only. ### Code samples #### cURL ```bash curl -X GET 'https://api.ondayzero.com/api/v1/accounting-dimensions/{dimension_id}' \ -H 'Authorization: Bearer dz_your_token' \ -H 'x-business-id: YOUR_BUSINESS_ID' ``` #### JavaScript ```javascript const response = await fetch('https://api.ondayzero.com/api/v1/accounting-dimensions/{dimension_id}', { method: 'GET', headers: { Authorization: 'Bearer dz_your_token', 'x-business-id': 'YOUR_BUSINESS_ID', }, }); const data = await response.json(); ``` #### Python ```python import httpx headers = { "Authorization": "Bearer dz_your_token", "x-business-id": "YOUR_BUSINESS_ID", } response = httpx.get("https://api.ondayzero.com/api/v1/accounting-dimensions/{dimension_id}", headers=headers) data = response.json() ``` ### See also - HTML version: https://www.ondayzero.com/docs/reference/accounting-dimensions/get-dimension - OpenAPI slice: https://www.ondayzero.com/docs/reference/accounting-dimensions/get-dimension/openapi.json - Other endpoints in **accounting-dimensions**: https://www.ondayzero.com/docs/reference/accounting-dimensions (markdown bundle: https://www.ondayzero.com/docs/reference/accounting-dimensions.md, OpenAPI: https://www.ondayzero.com/docs/reference/accounting-dimensions/openapi.json) - Endpoint catalog: https://www.ondayzero.com/docs/reference/index.md --- ## PUT /api/v1/accounting-dimensions/{dimension_id} > Update class/location - **Tag:** accounting-dimensions - **Operation ID:** `update_dimension` ### Description Update an accounting dimension. ### Authentication Bearer token in `Authorization` header. Required header: `x-business-id: `. ### Parameters - `dimension_id` (path, string, required) ### Request body Schema: `AccountingDimensionUpdateRequest` - `name` (string) - `code` (string) - `parent_id` (string) - `is_active` (boolean) ### Responses #### 200 — Successful Response Schema: `SuccessEnvelope_AccountingDimensionResponse_` - `success` (boolean) - `message` (string) - `code` (string) - `data` (AccountingDimensionResponse) #### 400 — Bad Request - Invalid input Schema: `ErrorResponse` - `error` (string · required) — Error category: `validation_error`, `unauthorized`, `forbidden`, `not_found`, `conflict`, `rate_limited`, `server_error`, or `service_unavailable`. - `message` (string · required) — Human-readable explanation, safe to show to end users. - `code` (string · required) — Stable machine-readable code in `CATEGORY_NNN` form (e.g. `NOT_FOUND_006`, `AUTH_010`, `GEN_002`). - `request_id` (string) — Correlation id for support requests. Echoes the `x-request-id` request header when one was supplied. - `errors` (object) — Field-level validation messages keyed by field name. Present on 400/422 validation failures only. #### 401 — Unauthorized - Missing or expired token, an MCP OAuth token used against the REST API, or no access to this business Schema: `ErrorResponse` - `error` (string · required) — Error category: `validation_error`, `unauthorized`, `forbidden`, `not_found`, `conflict`, `rate_limited`, `server_error`, or `service_unavailable`. - `message` (string · required) — Human-readable explanation, safe to show to end users. - `code` (string · required) — Stable machine-readable code in `CATEGORY_NNN` form (e.g. `NOT_FOUND_006`, `AUTH_010`, `GEN_002`). - `request_id` (string) — Correlation id for support requests. Echoes the `x-request-id` request header when one was supplied. - `errors` (object) — Field-level validation messages keyed by field name. Present on 400/422 validation failures only. #### 403 — Forbidden - Insufficient permissions Schema: `ErrorResponse` - `error` (string · required) — Error category: `validation_error`, `unauthorized`, `forbidden`, `not_found`, `conflict`, `rate_limited`, `server_error`, or `service_unavailable`. - `message` (string · required) — Human-readable explanation, safe to show to end users. - `code` (string · required) — Stable machine-readable code in `CATEGORY_NNN` form (e.g. `NOT_FOUND_006`, `AUTH_010`, `GEN_002`). - `request_id` (string) — Correlation id for support requests. Echoes the `x-request-id` request header when one was supplied. - `errors` (object) — Field-level validation messages keyed by field name. Present on 400/422 validation failures only. #### 404 — Not Found - Resource does not exist Schema: `ErrorResponse` - `error` (string · required) — Error category: `validation_error`, `unauthorized`, `forbidden`, `not_found`, `conflict`, `rate_limited`, `server_error`, or `service_unavailable`. - `message` (string · required) — Human-readable explanation, safe to show to end users. - `code` (string · required) — Stable machine-readable code in `CATEGORY_NNN` form (e.g. `NOT_FOUND_006`, `AUTH_010`, `GEN_002`). - `request_id` (string) — Correlation id for support requests. Echoes the `x-request-id` request header when one was supplied. - `errors` (object) — Field-level validation messages keyed by field name. Present on 400/422 validation failures only. #### 422 — Validation Error Schema: `ErrorResponse` - `error` (string · required) — Error category: `validation_error`, `unauthorized`, `forbidden`, `not_found`, `conflict`, `rate_limited`, `server_error`, or `service_unavailable`. - `message` (string · required) — Human-readable explanation, safe to show to end users. - `code` (string · required) — Stable machine-readable code in `CATEGORY_NNN` form (e.g. `NOT_FOUND_006`, `AUTH_010`, `GEN_002`). - `request_id` (string) — Correlation id for support requests. Echoes the `x-request-id` request header when one was supplied. - `errors` (object) — Field-level validation messages keyed by field name. Present on 400/422 validation failures only. ### Code samples #### cURL ```bash curl -X PUT 'https://api.ondayzero.com/api/v1/accounting-dimensions/{dimension_id}' \ -H 'Authorization: Bearer dz_your_token' \ -H 'x-business-id: YOUR_BUSINESS_ID' \ -H 'Content-Type: application/json' \ -d '{ "name": "string", "code": "string", "parent_id": "string", "is_active": false }' ``` #### JavaScript ```javascript const response = await fetch('https://api.ondayzero.com/api/v1/accounting-dimensions/{dimension_id}', { method: 'PUT', headers: { Authorization: 'Bearer dz_your_token', 'x-business-id': 'YOUR_BUSINESS_ID', 'Content-Type': 'application/json', }, body: JSON.stringify({ "name": "string", "code": "string", "parent_id": "string", "is_active": false }), }); const data = await response.json(); ``` #### Python ```python import httpx headers = { "Authorization": "Bearer dz_your_token", "x-business-id": "YOUR_BUSINESS_ID", } payload = {'name': 'string', 'code': 'string', 'parent_id': 'string', 'is_active': False} response = httpx.put("https://api.ondayzero.com/api/v1/accounting-dimensions/{dimension_id}", headers=headers, json=payload) data = response.json() ``` ### See also - HTML version: https://www.ondayzero.com/docs/reference/accounting-dimensions/update-dimension - OpenAPI slice: https://www.ondayzero.com/docs/reference/accounting-dimensions/update-dimension/openapi.json - Other endpoints in **accounting-dimensions**: https://www.ondayzero.com/docs/reference/accounting-dimensions (markdown bundle: https://www.ondayzero.com/docs/reference/accounting-dimensions.md, OpenAPI: https://www.ondayzero.com/docs/reference/accounting-dimensions/openapi.json) - Endpoint catalog: https://www.ondayzero.com/docs/reference/index.md