# Advisory Firm Templates — DayZero API 7 endpoints. OpenAPI for just this tag: https://www.ondayzero.com/docs/reference/advisory-firm-templates/openapi.json · HTML: https://www.ondayzero.com/docs/reference/advisory-firm-templates · All tags: https://www.ondayzero.com/docs/reference/index.md ## Endpoints - `GET /api/v1/advisory-firms/{firm_id}/templates` — List firm templates - `POST /api/v1/advisory-firms/{firm_id}/templates` — Create a firm template - `DELETE /api/v1/advisory-firms/{firm_id}/templates/{template_id}` — Delete a firm template - `GET /api/v1/advisory-firms/{firm_id}/templates/{template_id}` — Get a firm template - `PATCH /api/v1/advisory-firms/{firm_id}/templates/{template_id}` — Update a firm template - `POST /api/v1/advisory-firms/{firm_id}/templates/{template_id}/deploy` — Deploy a firm template to selected client businesses - `GET /api/v1/advisory-firms/{firm_id}/templates/{template_id}/deployments` — List deployment history for a template --- ## GET /api/v1/advisory-firms/{firm_id}/templates > List firm templates - **Tag:** advisory-firm-templates - **Operation ID:** `list_firm_templates` ### Description List firm-level COA / Bank Rules / Review Checklist templates. Optionally filter by ``kind``. ### Authentication Bearer token in `Authorization` header. Required header: `x-business-id: `. ### Parameters - `firm_id` (path, string, required) - `kind` (query, string, optional) — Filter by template kind ### Responses #### 200 — Successful Response Schema: `SuccessEnvelope_FirmTemplateListResponse_` - `success` (boolean) - `message` (string) - `code` (string) - `data` (FirmTemplateListResponse) #### 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/advisory-firms/{firm_id}/templates' \ -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/advisory-firms/{firm_id}/templates', { 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/advisory-firms/{firm_id}/templates", headers=headers) data = response.json() ``` ### See also - HTML version: https://www.ondayzero.com/docs/reference/advisory-firm-templates/list-firm-templates - OpenAPI slice: https://www.ondayzero.com/docs/reference/advisory-firm-templates/list-firm-templates/openapi.json - Other endpoints in **advisory-firm-templates**: https://www.ondayzero.com/docs/reference/advisory-firm-templates (markdown bundle: https://www.ondayzero.com/docs/reference/advisory-firm-templates.md, OpenAPI: https://www.ondayzero.com/docs/reference/advisory-firm-templates/openapi.json) - Endpoint catalog: https://www.ondayzero.com/docs/reference/index.md --- ## POST /api/v1/advisory-firms/{firm_id}/templates > Create a firm template - **Tag:** advisory-firm-templates - **Operation ID:** `create_firm_template` ### Authentication Bearer token in `Authorization` header. Required header: `x-business-id: `. ### Parameters - `firm_id` (path, string, required) ### Request body Schema: `FirmTemplateCreate` - `kind` (string · required) — Template kind: 'coa', 'bank_rules', or 'review_checklist' - `name` (string · required) - `description` (string) - `payload` (JsonValue · required) → `JsonValue` — Kind-specific payload (list of ledger dicts / rule dicts / checklist step dicts). ### Responses #### 201 — Successful Response Schema: `SuccessEnvelope_FirmTemplateResponse_` - `success` (boolean) - `message` (string) - `code` (string) - `data` (FirmTemplateResponse) #### 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. #### 409 — Conflict - Resource already exists or is in an incompatible state 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 - Request body or parameters failed validation 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/advisory-firms/{firm_id}/templates' \ -H 'Authorization: Bearer dz_your_token' \ -H 'x-business-id: YOUR_BUSINESS_ID' \ -H 'Content-Type: application/json' \ -d '{ "kind": "string", "name": "string", "payload": "string" }' ``` #### JavaScript ```javascript const response = await fetch('https://api.ondayzero.com/api/v1/advisory-firms/{firm_id}/templates', { method: 'POST', headers: { Authorization: 'Bearer dz_your_token', 'x-business-id': 'YOUR_BUSINESS_ID', 'Content-Type': 'application/json', }, body: JSON.stringify({ "kind": "string", "name": "string", "payload": "string" }), }); const data = await response.json(); ``` #### Python ```python import httpx headers = { "Authorization": "Bearer dz_your_token", "x-business-id": "YOUR_BUSINESS_ID", } payload = {'kind': 'string', 'name': 'string', 'payload': 'string'} response = httpx.post("https://api.ondayzero.com/api/v1/advisory-firms/{firm_id}/templates", headers=headers, json=payload) data = response.json() ``` ### See also - HTML version: https://www.ondayzero.com/docs/reference/advisory-firm-templates/create-firm-template - OpenAPI slice: https://www.ondayzero.com/docs/reference/advisory-firm-templates/create-firm-template/openapi.json - Other endpoints in **advisory-firm-templates**: https://www.ondayzero.com/docs/reference/advisory-firm-templates (markdown bundle: https://www.ondayzero.com/docs/reference/advisory-firm-templates.md, OpenAPI: https://www.ondayzero.com/docs/reference/advisory-firm-templates/openapi.json) - Endpoint catalog: https://www.ondayzero.com/docs/reference/index.md --- ## DELETE /api/v1/advisory-firms/{firm_id}/templates/{template_id} > Delete a firm template - **Tag:** advisory-firm-templates - **Operation ID:** `delete_firm_template` ### Authentication Bearer token in `Authorization` header. Required header: `x-business-id: `. ### Parameters - `firm_id` (path, string, required) - `template_id` (path, string, required) ### Responses #### 200 — Successful Response Schema: `SuccessEnvelope_FirmTemplateDeleteResponse_` - `success` (boolean) - `message` (string) - `code` (string) - `data` (FirmTemplateDeleteResponse) #### 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/advisory-firms/{firm_id}/templates/{template_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/advisory-firms/{firm_id}/templates/{template_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/advisory-firms/{firm_id}/templates/{template_id}", headers=headers) data = response.json() ``` ### See also - HTML version: https://www.ondayzero.com/docs/reference/advisory-firm-templates/delete-firm-template - OpenAPI slice: https://www.ondayzero.com/docs/reference/advisory-firm-templates/delete-firm-template/openapi.json - Other endpoints in **advisory-firm-templates**: https://www.ondayzero.com/docs/reference/advisory-firm-templates (markdown bundle: https://www.ondayzero.com/docs/reference/advisory-firm-templates.md, OpenAPI: https://www.ondayzero.com/docs/reference/advisory-firm-templates/openapi.json) - Endpoint catalog: https://www.ondayzero.com/docs/reference/index.md --- ## GET /api/v1/advisory-firms/{firm_id}/templates/{template_id} > Get a firm template - **Tag:** advisory-firm-templates - **Operation ID:** `get_firm_template` ### Authentication Bearer token in `Authorization` header. Required header: `x-business-id: `. ### Parameters - `firm_id` (path, string, required) - `template_id` (path, string, required) ### Responses #### 200 — Successful Response Schema: `SuccessEnvelope_FirmTemplateResponse_` - `success` (boolean) - `message` (string) - `code` (string) - `data` (FirmTemplateResponse) #### 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/advisory-firms/{firm_id}/templates/{template_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/advisory-firms/{firm_id}/templates/{template_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/advisory-firms/{firm_id}/templates/{template_id}", headers=headers) data = response.json() ``` ### See also - HTML version: https://www.ondayzero.com/docs/reference/advisory-firm-templates/get-firm-template - OpenAPI slice: https://www.ondayzero.com/docs/reference/advisory-firm-templates/get-firm-template/openapi.json - Other endpoints in **advisory-firm-templates**: https://www.ondayzero.com/docs/reference/advisory-firm-templates (markdown bundle: https://www.ondayzero.com/docs/reference/advisory-firm-templates.md, OpenAPI: https://www.ondayzero.com/docs/reference/advisory-firm-templates/openapi.json) - Endpoint catalog: https://www.ondayzero.com/docs/reference/index.md --- ## PATCH /api/v1/advisory-firms/{firm_id}/templates/{template_id} > Update a firm template - **Tag:** advisory-firm-templates - **Operation ID:** `update_firm_template` ### Authentication Bearer token in `Authorization` header. Required header: `x-business-id: `. ### Parameters - `firm_id` (path, string, required) - `template_id` (path, string, required) ### Request body Schema: `FirmTemplateUpdate` - `name` (string) - `description` (string) - `payload` (JsonValue) ### Responses #### 200 — Successful Response Schema: `SuccessEnvelope_FirmTemplateResponse_` - `success` (boolean) - `message` (string) - `code` (string) - `data` (FirmTemplateResponse) #### 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. #### 409 — Conflict - Resource already exists or is in an incompatible state 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 - Request body or parameters failed validation 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 PATCH 'https://api.ondayzero.com/api/v1/advisory-firms/{firm_id}/templates/{template_id}' \ -H 'Authorization: Bearer dz_your_token' \ -H 'x-business-id: YOUR_BUSINESS_ID' \ -H 'Content-Type: application/json' \ -d '{ "name": "string", "description": "string", "payload": "string" }' ``` #### JavaScript ```javascript const response = await fetch('https://api.ondayzero.com/api/v1/advisory-firms/{firm_id}/templates/{template_id}', { method: 'PATCH', headers: { Authorization: 'Bearer dz_your_token', 'x-business-id': 'YOUR_BUSINESS_ID', 'Content-Type': 'application/json', }, body: JSON.stringify({ "name": "string", "description": "string", "payload": "string" }), }); const data = await response.json(); ``` #### Python ```python import httpx headers = { "Authorization": "Bearer dz_your_token", "x-business-id": "YOUR_BUSINESS_ID", } payload = {'name': 'string', 'description': 'string', 'payload': 'string'} response = httpx.patch("https://api.ondayzero.com/api/v1/advisory-firms/{firm_id}/templates/{template_id}", headers=headers, json=payload) data = response.json() ``` ### See also - HTML version: https://www.ondayzero.com/docs/reference/advisory-firm-templates/update-firm-template - OpenAPI slice: https://www.ondayzero.com/docs/reference/advisory-firm-templates/update-firm-template/openapi.json - Other endpoints in **advisory-firm-templates**: https://www.ondayzero.com/docs/reference/advisory-firm-templates (markdown bundle: https://www.ondayzero.com/docs/reference/advisory-firm-templates.md, OpenAPI: https://www.ondayzero.com/docs/reference/advisory-firm-templates/openapi.json) - Endpoint catalog: https://www.ondayzero.com/docs/reference/index.md --- ## POST /api/v1/advisory-firms/{firm_id}/templates/{template_id}/deploy > Deploy a firm template to selected client businesses - **Tag:** advisory-firm-templates - **Operation ID:** `deploy_firm_template` ### Description Bulk-applies the template to each business in ``business_ids``. COA templates use ``LedgerService.apply_coa``; bank-rule templates create new ``BankRule`` rows (duplicates by name are treated as skips so re-deploying is idempotent); review-checklist templates are recorded informationally. ### Authentication Bearer token in `Authorization` header. Required header: `x-business-id: `. ### Parameters - `firm_id` (path, string, required) - `template_id` (path, string, required) ### Request body Schema: `FirmTemplateDeployRequest` - `business_ids` (array · string · required) — Business IDs to deploy the template to. ### Responses #### 201 — Successful Response Schema: `SuccessEnvelope_FirmTemplateDeployResponse_` - `success` (boolean) - `message` (string) - `code` (string) - `data` (FirmTemplateDeployResponse) #### 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 - Request body or parameters failed validation 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/advisory-firms/{firm_id}/templates/{template_id}/deploy' \ -H 'Authorization: Bearer dz_your_token' \ -H 'x-business-id: YOUR_BUSINESS_ID' \ -H 'Content-Type: application/json' \ -d '{ "business_ids": [] }' ``` #### JavaScript ```javascript const response = await fetch('https://api.ondayzero.com/api/v1/advisory-firms/{firm_id}/templates/{template_id}/deploy', { method: 'POST', headers: { Authorization: 'Bearer dz_your_token', 'x-business-id': 'YOUR_BUSINESS_ID', 'Content-Type': 'application/json', }, body: JSON.stringify({ "business_ids": [] }), }); const data = await response.json(); ``` #### Python ```python import httpx headers = { "Authorization": "Bearer dz_your_token", "x-business-id": "YOUR_BUSINESS_ID", } payload = {'business_ids': []} response = httpx.post("https://api.ondayzero.com/api/v1/advisory-firms/{firm_id}/templates/{template_id}/deploy", headers=headers, json=payload) data = response.json() ``` ### See also - HTML version: https://www.ondayzero.com/docs/reference/advisory-firm-templates/deploy-firm-template - OpenAPI slice: https://www.ondayzero.com/docs/reference/advisory-firm-templates/deploy-firm-template/openapi.json - Other endpoints in **advisory-firm-templates**: https://www.ondayzero.com/docs/reference/advisory-firm-templates (markdown bundle: https://www.ondayzero.com/docs/reference/advisory-firm-templates.md, OpenAPI: https://www.ondayzero.com/docs/reference/advisory-firm-templates/openapi.json) - Endpoint catalog: https://www.ondayzero.com/docs/reference/index.md --- ## GET /api/v1/advisory-firms/{firm_id}/templates/{template_id}/deployments > List deployment history for a template - **Tag:** advisory-firm-templates - **Operation ID:** `list_firm_template_deployments` ### Authentication Bearer token in `Authorization` header. Required header: `x-business-id: `. ### Parameters - `firm_id` (path, string, required) - `template_id` (path, string, required) ### Responses #### 200 — Successful Response Schema: `SuccessEnvelope_FirmTemplateDeploymentListResponse_` - `success` (boolean) - `message` (string) - `code` (string) - `data` (FirmTemplateDeploymentListResponse) #### 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/advisory-firms/{firm_id}/templates/{template_id}/deployments' \ -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/advisory-firms/{firm_id}/templates/{template_id}/deployments', { 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/advisory-firms/{firm_id}/templates/{template_id}/deployments", headers=headers) data = response.json() ``` ### See also - HTML version: https://www.ondayzero.com/docs/reference/advisory-firm-templates/list-firm-template-deployments - OpenAPI slice: https://www.ondayzero.com/docs/reference/advisory-firm-templates/list-firm-template-deployments/openapi.json - Other endpoints in **advisory-firm-templates**: https://www.ondayzero.com/docs/reference/advisory-firm-templates (markdown bundle: https://www.ondayzero.com/docs/reference/advisory-firm-templates.md, OpenAPI: https://www.ondayzero.com/docs/reference/advisory-firm-templates/openapi.json) - Endpoint catalog: https://www.ondayzero.com/docs/reference/index.md