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

# Match a deposit to invoices

> Records a customer payment against one or more open invoices and links it to the inbound bank deposit, posting the journal entry. Requires `accounting:write` scope.



## OpenAPI

````yaml /openapi.yaml post /accounting/bank-transactions/{id}/match-deposit-to-invoices
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.


    **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:
  /accounting/bank-transactions/{id}/match-deposit-to-invoices:
    post:
      tags:
        - Accounting
      summary: Match a deposit to invoices
      description: >-
        Records a customer payment against one or more open invoices and links
        it to the inbound bank deposit, posting the journal entry. Requires
        `accounting:write` scope.
      operationId: matchDepositToInvoicesAndRecord
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
            format: uuid
          description: Bank transaction (deposit) UUID.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - account_id
                - applications
              properties:
                account_id:
                  type: string
                  format: uuid
                  description: Customer account the deposit pays.
                applications:
                  type: array
                  items:
                    type: object
                  description: Per-invoice application amounts.
                route_unapplied:
                  type: string
                  nullable: true
                  description: How to route any unapplied remainder.
                reconciliation_id:
                  type: string
                  format: uuid
                  nullable: true
                payment_method:
                  type: string
                  nullable: true
      responses:
        '200':
          description: Deposit matched; payment recorded and posted.
          content:
            application/json:
              schema:
                type: object
                description: >-
                  The canonical handler's payload. Additional properties are
                  returned; the one this spec pins is the book-side stamp added
                  2026-09-19 by BANKFEED wave 4 lane W4-G.
                properties:
                  book_side:
                    $ref: '#/components/schemas/BookSideStamp'
        '400':
          description: Invalid UUID or application set.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
        '401':
          $ref: '#/components/responses/Error'
        '403':
          $ref: '#/components/responses/Error'
        '404':
          $ref: '#/components/responses/Error'
      security:
        - ApiKeyAuth:
            - accounting:write
components:
  schemas:
    BookSideStamp:
      type: object
      nullable: true
      description: |
        What the GENERAL LEDGER now says about the money this bank line
        explains. Added 2026-09-19 by BANKFEED wave 4 lane W4-G, and it is
        purely additive: no request field changed and no existing response
        field changed meaning.

        A bank reconciliation has two sides. The bank side is
        `reconciliation_status` on the bank transaction. The BOOK side is
        `reconciled_at` on the journal entry's line on that bank account's GL
        account, and until this lane no verb outside a statement session ever
        wrote it, so matched money could read UNCLEARED in the ledger forever.

        STILL NO GL IS POSTED. The stamp writes no debit and no credit; the
        trial balance is identical before and after, and a closed period cannot
        be moved by it. What it changes is which lines the reconciliation
        workbench and the bank register's open-items tile still treat as
        outstanding.

        `stamped: 0` with a `reason` is an honest answer, not an error:
        `no_leg_on_bank_gl` means the entry carries no line on THIS account's GL
        (a payout settled to a different account, for example);
        `already_reconciled` means a session or a baseline had already cleared
        it; `missing_argument` means the record carries no journal entry to
        stamp.
      properties:
        stamped:
          type: integer
          description: How many journal-entry lines were stamped. Normally 0 or 1.
        line_ids:
          type: array
          items:
            type: string
            format: uuid
          description: The journal_entry_lines rows that were stamped.
        reason:
          type: string
          nullable: true
          enum:
            - no_leg_on_bank_gl
            - already_reconciled
            - entry_not_live
            - missing_argument
            - stamp_failed
          description: Null when a line was stamped; otherwise why none was.
        historical_import:
          type: boolean
          description: |
            True when the stamped entry came from a data migration. Recorded so
            the class is countable; a migrated document whose cash really did
            clear the bank is cleared, and saying otherwise would leave it
            outstanding forever.
        correction_legs:
          type: array
          description: >
            WHICH ENTRIES ANSWERED, when the book side was not on the entry you

            matched. Added 2026-09-23 by BANKFEED wave 4 lane R6-AN.


            A settlement correction repairs by POSTING and never by mutating, so

            after one the ORIGINAL entry keeps only its line on the bank the

            money was never in, and the line this bank account actually clears

            belongs to the CORRECTION. Before this, a match on such a payout

            reported `no_leg_on_bank_gl` (a true sentence about the wrong
            entry),

            left the real book side uncleared, and the same cash went on being

            offered as an unlinked-cash candidate for a second bank line.


            Empty on every ordinary match, including one whose own correction

            this same request posted. Non-empty only when a live PRE-EXISTING

            correction held the book side; `stamped` is then the count from
            those

            entries and `reason` is null, exactly as if the line had been found

            on the entry itself.
          items:
            type: object
            properties:
              journal_entry_id:
                type: string
                format: uuid
              entry_number:
                type: string
              entry_date:
                type: string
                format: date
              stamped:
                type: integer
                description: Lines stamped on this correction entry. Normally 0 or 1.
    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.