> ## 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.

# Update a posted bank deposit

> Adds or removes items on a posted deposit ticket, or changes its date or memo: the ticket's journal entry is reversed on the ticket's own date and the whole ticket is re-posted (one live entry per ticket), so both the original and the new date's periods must be open. A removed check goes back to received, removed drawer cash returns to its session, and removed items are released, never deleted; every refusal writes nothing and is named by `code` (the 400, 404, 409 and 422 responses list them). Requires `accounting:write` scope and the key creator's `accounting.deposits.void` permission.



## OpenAPI

````yaml /openapi.yaml patch /deposits/{id}
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_<code>_<random>` (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.

    **Changelog.** Entries are dated and name every published contract whose
    MEANING moved, not

    only the ones whose field names changed. The narrative version of the same
    entries, written

    for integrators, is published at https://arcuserp.mintlify.app/changelog.


    **October 2026: the order status values are the ones the API sends.** The
    `Order` schema's

    `order_status`, `payment_status`, `fulfillment_status` and `document_type`
    now list the values

    the order endpoints actually return (`order_status`: draft, open,
    processing, fulfilled,

    cancelled, archived, expired, awaiting_ach_clearance; `payment_status`:
    unpaid, partial,

    processing, paid, refunded, terms, overdue, overpaid, partially_refunded;
    `fulfillment_status`:

    unfulfilled, partial, fulfilled, backordered, awaiting_pickup;
    `document_type` adds

    late_fee_invoice). The values themselves did not change; the schema had
    listed names the API

    never sends (`confirmed`, `partially_paid`, `partially_fulfilled`, `voided`,
    `on_hold`), so a

    client generated from it could reject a real order. On `POST /v1/orders`,
    `order_status` is

    limited to `draft` only for a `sales_order` or `invoice`. The refusals of
    the order, refund,

    settings and deposit endpoints are now listed with their `code` values on
    each response.


    **October 2026: a pair of bank lines in transit at a month end is an open
    item there.** `GET /v1/entities/{entity_id}/reconciliation/account-audit`,
    `answers.books_against_bank`,

    each `month_ends` row: when the two bank lines of a pair matched together to
    one bill payment (a

    wire and its return) fall on either side of that date,
    `bank_unbooked_amount` and

    `bank_unbooked_count` now include the line already in the bank, and
    `gl_uncleared_amount` and

    `gl_uncleared_count` include the payment's bank leg;
    `explained_by_open_items` therefore explains

    that date instead of leaving the part in transit unexplained. No field is
    renamed and no other

    date moves; once both lines are in the bank the pair counts nowhere, as
    every other match.


    **2026-09-22 (planned 2026-09-21), REORDER-BUYER-TRUTH: demand changed what
    it MEANS on three

    published contracts, with no field renamed.** An integrator that pins field
    names sees no

    breakage and different numbers, which is why this entry exists.

      - **Demand now counts build consumption.** `demand_avg_per_day` on the public product, kit
        and inventory-balance objects, and `daily_demand` / `demand_basis` / `net_suggested_qty`
        on `GET /v1/purchasing/reorder-report`, are composed from fulfilled sales lines PLUS
        posted `build_consume` inventory draws: each physical decrement of a product counts
        exactly once. The previous rule adopted an internal-consumption basis only when the sales
        blend was exactly zero, so a product both sold AND consumed into work orders planned as
        if the build draws did not exist. Products drawn into work orders move; on one
        production-shaped dataset five did, the largest from 0.05/day to 14.95/day.
      - **`demand_basis` now carries four values, not two:** `sales`, `sales_and_builds`,
        `builds` and `consumption`. A consumer with a two-branch reader (anything that is not
        `consumption` is `sales`) silently hides the two new ones.
      - **`current_demand_units` on `GET /v1/inventory/balances/:id` moved, by a second rule.**
        It counts committed-but-unshipped CUSTOMER demand, and it now counts a kit component's
        own line rather than its parent kit line, and excludes non-sales documents. On one
        production dataset 269 of 1,043 balance rows changed, 227 of them downward; the largest
        single move was 1,941 to 25, on a product whose open PURCHASE order line had been
        reported as customer demand. Re-baseline anything that alerts or reorders off this field.
      - `run_rate_30/90/180/365` and `blended_daily` on the same balance object move for the
        first reason above.
      - **Added, not changed:** `GET /v1/purchasing/reorder-report` accepts `demand_window` and
        returns the unit, cover-through and reorder-point-provenance fields documented on that
        operation; `order_multiple` is accepted and returned on the product-vendor doors.
      - **Volume note.** The `inventory.low_stock`, `inventory.out_of_stock` and
        `inventory.back_in_stock` webhook events are population-gated on
        `on_hand <= reorder_point`, and reorder points move with the demand above, so
        subscribers should expect a one-time step change in event volume around the release.
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:
  /deposits/{id}:
    patch:
      tags:
        - Accounting
      summary: Update a posted bank deposit
      description: >-
        Adds or removes items on a posted deposit ticket, or changes its date or
        memo: the ticket's journal entry is reversed on the ticket's own date
        and the whole ticket is re-posted (one live entry per ticket), so both
        the original and the new date's periods must be open. A removed check
        goes back to received, removed drawer cash returns to its session, and
        removed items are released, never deleted; every refusal writes nothing
        and is named by `code` (the 400, 404, 409 and 422 responses list them).
        Requires `accounting:write` scope and the key creator's
        `accounting.deposits.void` permission.
      operationId: editDepositV1
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
            format: uuid
        - name: Idempotency-Key
          in: header
          required: false
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - expected_updated_at
                - reason
              properties:
                expected_updated_at:
                  type: string
                  format: date-time
                  description: >-
                    The ticket's updated_at as last read; a stale value is
                    refused deposit_changed_since_loaded.
                reason:
                  type: string
                  minLength: 3
                  maxLength: 500
                deposit_date:
                  type: string
                  format: date
                memo:
                  type: string
                  nullable: true
                remove_item_ids:
                  type: array
                  items:
                    type: string
                    format: uuid
                add_items:
                  type: array
                  items:
                    type: object
                    properties:
                      item_type:
                        type: string
                        enum:
                          - check
                          - cash
                          - register_cash
                          - external
                      bank_check_id:
                        type: string
                        format: uuid
                      register_session_id:
                        type: string
                        format: uuid
                      order_payment_id:
                        type: string
                        format: uuid
                      amount:
                        type: number
      responses:
        '200':
          description: The edited ticket, with the entries it moved beside it
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                    format: uuid
                  deposit_number:
                    type: string
                  deposit_date:
                    type: string
                    format: date
                  total_amount:
                    type: number
                  journal_entry_id:
                    type: string
                    format: uuid
                  released_items:
                    type: array
                    items:
                      type: object
                  memo_only:
                    type: boolean
                  previous_deposit_date:
                    type: string
                    format: date
                  reversed_entry:
                    type: object
                    nullable: true
                    description: >-
                      The entry the edit reversed: id, entry_number, entry_date
                      (the contra's date, the ticket's original date), amount
                  reversal_entry:
                    type: object
                    nullable: true
                  posted_entry:
                    type: object
                    nullable: true
                    description: >-
                      The ticket's new live entry: id, entry_number, entry_date,
                      amount
                  sweep_reversed_entry:
                    type: object
                    nullable: true
                  sweep_posted_entry:
                    type: object
                    nullable: true
                  sentence:
                    type: string
        '400':
          description: >-
            `code` is one of `deposit_edit_bad_request`,
            `deposit_historical_import`, `deposit_edit_invalid_item`,
            `deposit_edit_date_invalid` (`type: validation_error`).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DepositRefusal'
        '401':
          $ref: '#/components/responses/Error'
        '403':
          $ref: '#/components/responses/Error'
        '404':
          description: '`code: deposit_not_found`.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DepositRefusal'
        '409':
          description: >-
            The ticket or an item is not in a state the edit can take; `code` is
            one of `deposit_voided`, `deposit_reconciled_not_editable`,
            `deposit_claimed_by_bank_line`, `deposit_item_claimed_by_bank_line`,
            `deposit_in_completed_reconciliation`, `deposit_entry_not_live`,
            `deposit_changed_since_loaded`, `check_not_received`,
            `check_on_another_ticket`, `payment_on_another_ticket`,
            `register_cash_over_deposit`, `vendor_credit_over_disburse`,
            `vendor_check_released_from_a_newer_ticket`,
            `register_cash_release_waits_on_session_reader`,
            `deposit_edit_swept_session_closed`. The `Idempotency-Key` header
            adds two 409 answers of its own, as on every operation that takes
            it: `idempotency_key_in_use` (a request with the same key is still
            running; retry it) and `idempotency_key_collision` (the key was used
            for a different request body; use a fresh key).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DepositRefusal'
        '422':
          description: >-
            `code` is one of `closed_period_blocks_edit` (the original or the
            new date's period is closed), `deposit_item_not_on_ticket`,
            `deposit_edit_would_empty`, `deposit_edit_no_change`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DepositRefusal'
      security:
        - ApiKeyAuth: []
components:
  schemas:
    DepositRefusal:
      description: >
        The refusal envelope of the deposit edit doors (PATCH /deposits/{id} and
        POST /deposits/{id}/edit-preview):

        the canonical envelope plus `message`, one sentence naming what refused
        the edit. Nothing is written.
      allOf:
        - $ref: '#/components/schemas/ErrorEnvelope'
        - type: object
          properties:
            message:
              type: string
              description: One sentence naming what refused the edit.
            field:
              type: string
              description: On `deposit_edit_bad_request`, the request field at fault.
            reason_code:
              type: string
              description: >-
                On `deposit_edit_date_invalid` and `deposit_edit_invalid_item`,
                the narrower reason.
            received:
              type: string
              description: >-
                On `deposit_edit_date_invalid` with `reason_code:
                invalid_format`, the date as sent.
            picked:
              type: string
              format: date
              description: >-
                On `deposit_edit_date_invalid` with `reason_code`
                `future_beyond_allowed_range` or
                `backdate_beyond_allowed_range`, the date asked for.
            today:
              type: string
              format: date
              description: On those two reasons, the date the range is measured from (UTC).
            delta_days:
              type: integer
              description: >-
                On those two reasons, the days from `today` to `picked`
                (negative in the past).
            max_future_days:
              type: integer
              description: >-
                On `future_beyond_allowed_range`, how many days ahead a date may
                be.
            max_backdate_days:
              type: integer
              description: >-
                On `backdate_beyond_allowed_range`, how many days back a date
                may be.
    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
  responses:
    Error:
      description: Error response (400/401/403/404/409/422/429/500)
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
  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_<code>_<random>
        Test keys use ark_test_ent_<code>_<random>. Both are issued per entity
        via Settings > Developers > API Keys.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.