> ## Documentation Index > Fetch the complete documentation index at: https://docs.arcuserp.com/llms.txt > Use this file to discover all available pages before exploring further. # Apply or release the account credit hold > Applies or releases the credit hold on an account. Delegates to the canonical `setCreditHold` writer (`utils/credit-hold-helpers.mjs`), which owns the single SSOT path for every flip of `accounts.is_credit_hold` (Rule 23). Side effects on apply (`on_hold: true`): * `accounts.is_credit_hold = true` * For every open sales order on this account (`order_status IN ('draft','open','processing','awaiting_ach_clearance')`), sets `orders.is_credit_hold_blocked = true` and `credit_hold_blocked_at = NOW()`. The `orders_credit_hold_sync` CHECK constraint enforces the pair stays consistent. * Realtime broadcast `account.credit_hold_changed` with full payload + secondary `account.updated` broadcast. * `activity_log` entry with action `account_credit_hold_changed`. Side effects on release (`on_hold: false`): * `accounts.is_credit_hold = false` * Clears `is_credit_hold_blocked` / `credit_hold_blocked_at` on every order still carrying the flag for this account. * Same broadcast + activity log shape. Idempotent: a re-POST that matches the current state returns 200 with `changed: false` and emits no new broadcast or activity row. `is_credit_hold` is intentionally `readOnly` on the Account schema and BLOCKED by the PATCH allowlist on `PATCH /v1/accounts/{id}` (returns 422 `forbidden_field`). This dedicated action endpoint is the SSOT write surface, mirroring NetSuite's `creditHoldOverride` writable field on the customer record. Requires `accounts:write` scope. ## OpenAPI ````yaml /openapi.yaml post /accounts/{id}/credit-hold openapi: 3.1.0 info: title: Arcus ERP Public API version: 1.0.0 description: > Arcus ERP public REST API. Designed for external integrations and data migration. **Authentication.** Bearer token (API key) via the `Authorization` header. Format: `Authorization: Bearer ark_live_ent__` (or `ark_test_*` for sandbox). API keys are issued per-entity in **Settings > Developers > API Keys**. **Entity scoping.** The entity is encoded in the API key prefix; routes are flat (e.g. `/v1/accounts`, `/v1/orders`, `/v1/products`). A small set of platform endpoints (migration, reconciliation, events, webhook endpoints, API keys) use the `/v1/entities/{entity_id}/...` form -- those are noted in their tags. **Key capabilities.** - Related-resource hydration via `?expand[]=` (see `x-arcus-expand` on each resource). - Cursor-based pagination (`starting_after` / `ending_before` / `limit`). - Idempotency via the `Idempotency-Key` header. - Webhook events for asynchronous notification. - Conditional requests / ETag for cache validation. servers: - url: https://api.arcuserp.com/v1 description: Arcus ERP API (accepts both live `ark_live_*` and test `ark_test_*` keys) - url: https://dev-api.arcuserp.com/v1 description: >- Dev sandbox API (test-only data, accepts `ark_test_*` keys against dev RDS) security: [] paths: /accounts/{id}/credit-hold: parameters: - name: id in: path required: true schema: type: string format: uuid post: tags: - Accounts summary: Apply or release the account credit hold description: | Applies or releases the credit hold on an account. Delegates to the canonical `setCreditHold` writer (`utils/credit-hold-helpers.mjs`), which owns the single SSOT path for every flip of `accounts.is_credit_hold` (Rule 23). Side effects on apply (`on_hold: true`): * `accounts.is_credit_hold = true` * For every open sales order on this account (`order_status IN ('draft','open','processing','awaiting_ach_clearance')`), sets `orders.is_credit_hold_blocked = true` and `credit_hold_blocked_at = NOW()`. The `orders_credit_hold_sync` CHECK constraint enforces the pair stays consistent. * Realtime broadcast `account.credit_hold_changed` with full payload + secondary `account.updated` broadcast. * `activity_log` entry with action `account_credit_hold_changed`. Side effects on release (`on_hold: false`): * `accounts.is_credit_hold = false` * Clears `is_credit_hold_blocked` / `credit_hold_blocked_at` on every order still carrying the flag for this account. * Same broadcast + activity log shape. Idempotent: a re-POST that matches the current state returns 200 with `changed: false` and emits no new broadcast or activity row. `is_credit_hold` is intentionally `readOnly` on the Account schema and BLOCKED by the PATCH allowlist on `PATCH /v1/accounts/{id}` (returns 422 `forbidden_field`). This dedicated action endpoint is the SSOT write surface, mirroring NetSuite's `creditHoldOverride` writable field on the customer record. Requires `accounts:write` scope. operationId: setAccountCreditHold requestBody: required: true content: application/json: schema: type: object required: - on_hold properties: on_hold: type: boolean description: | `true` to apply the credit hold (and cascade-block open sales orders), `false` to release. reason: type: string description: | Optional human-readable reason recorded in the `activity_log` row and the `account.credit_hold_changed` broadcast payload. Defaults to `manual` on apply and `released` on release when omitted. example: manual responses: '200': description: Credit hold transition result content: application/json: schema: type: object properties: data: type: object properties: account_id: type: string format: uuid is_credit_hold: type: boolean description: The resulting state after the transition. changed: type: boolean description: | `true` if the account state actually flipped. `false` if the account was already in the target state (idempotent no-op). blocked_order_ids: type: array description: | UUIDs of open sales orders newly blocked by this transition. Present only when `on_hold: true`. items: type: string format: uuid released_order_ids: type: array description: | UUIDs of orders whose credit-hold block was just cleared. Present only when `on_hold: false`. items: type: string format: uuid '401': $ref: '#/components/responses/Error' '403': $ref: '#/components/responses/Error' '404': $ref: '#/components/responses/Error' '422': description: Validation error (missing or invalid `on_hold`). content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' security: - ApiKeyAuth: - accounts:write components: responses: Error: description: Error response (400/401/403/404/409/422/429/500) content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' schemas: ErrorEnvelope: type: object description: | Canonical error response envelope. All API errors use this shape. required: - error - code properties: error: type: string description: Machine-readable error key example: not_found code: type: string description: Machine-readable error code (often same as error) example: not_found type: type: string enum: - validation_error - permission_error - not_found - conflict - rate_limit - internal - expand_error - not_implemented example: not_found hint: type: string description: Human-readable one-sentence explanation (English) example: >- The requested order does not exist or does not belong to this entity. param: type: string description: The parameter that caused the error, if applicable example: expand[0] required: type: string description: The scope required (only on insufficient_scope errors) example: accounts:read request_id: type: string description: >- Unique request ID for support tracing (maps to CloudWatch log stream) example: req_abc123 securitySchemes: ApiKeyAuth: type: http scheme: bearer description: | API key issued per entity via Settings > Developers > API Keys. Each key carries scopes (e.g. orders:read, products:write). Bearer token format: Authorization: Bearer ark_live_ent__ Test keys use ark_test_ent__. Both are issued per entity via Settings > Developers > API Keys. ````