> ## 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. # Suggest payment matches for a deposit > Returns a scored list of candidate customer payment receipts that could match an inbound bank transaction, ranked by amount and date proximity, and flags whether a receipt was deposited to this bank account, a different one, or an unknown one. Read-only; requires `accounting:read` scope, and optional `search`, `window_days`, or `amount_tolerance` parameters widen the match window beyond its default. ## OpenAPI ````yaml /openapi.yaml get /accounting/bank-transactions/{bank_transaction_id}/customer-payment-candidates 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. **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/{bank_transaction_id}/customer-payment-candidates: get: tags: - Accounting summary: Suggest payment matches for a deposit description: >- Returns a scored list of candidate customer payment receipts that could match an inbound bank transaction, ranked by amount and date proximity, and flags whether a receipt was deposited to this bank account, a different one, or an unknown one. Read-only; requires `accounting:read` scope, and optional `search`, `window_days`, or `amount_tolerance` parameters widen the match window beyond its default. operationId: listCustomerPaymentCandidatesV1 parameters: - name: bank_transaction_id in: path required: true schema: type: string format: uuid description: UUID of the inbound bank transaction to score candidates for - name: search in: query required: false schema: type: string description: > Optional. Also return receipts that match this text, whatever their amount or date: the check number, the external reference, the memo, the invoice or order number, the customer name, or the journal entry number. Scoped to your own entity. Shorter than the minimum length, or longer than the maximum, is ignored rather than rejected; `%` and `_` match themselves. - name: window_days in: query required: false schema: type: integer minimum: 0 description: > Optional. Widen the date window from the 7-day default. Clamped to the server ceiling; a value that is not a number is ignored and the default applies. - name: amount_tolerance in: query required: false schema: type: number minimum: 0 description: > Optional. Widen the amount tolerance from the $0.05 default. Clamped to the server ceiling; a value that is not a number is ignored and the default applies. responses: '200': description: Candidate list (may be empty) content: application/json: schema: type: object properties: data: type: object properties: bank_transaction: type: object properties: id: type: string format: uuid amount: type: number transaction_date: type: string format: date-time direction: type: string nullable: true description: type: string order_payments: type: array items: type: object properties: id: type: string format: uuid order_id: type: string format: uuid nullable: true amount: type: number posted_at: type: string format: date-time nullable: true payment_method: type: string nullable: true status: type: string check_number: type: string nullable: true external_reference: type: string nullable: true customer_name: type: string nullable: true score: type: number match_reason: type: string days_apart: type: number is_multi_application: type: boolean application_count: type: integer display_label: type: string applications: type: array description: >- Per-invoice breakdown for multi-application payments (B.1) items: type: object properties: order_id: type: string format: uuid order_number: type: string nullable: true amount_applied: type: number bank_account_scope: type: string enum: - same_bank_account - different_bank_account - unknown_bank_account description: >- Which bank the receipt was deposited to, compared with this bank transaction's bank account. deposited_via: type: string nullable: true enum: - direct - deposit_ticket - null description: >- How the receipt reached its bank. Null when it names no bank. requires_bank_move: type: boolean description: >- True when matching this receipt needs `move_payment_bank` on the match call. recorded_bank: type: object nullable: true description: >- The bank the receipt was deposited to, with its general ledger account. properties: bank_account_id: type: string format: uuid name: type: string nullable: true account_number_last4: type: string nullable: true gl_account: type: object nullable: true properties: id: type: string format: uuid account_number: type: string name: type: string nullable: true deposit_ticket: type: object nullable: true description: >- The posted bank deposit ticket that carried the receipt, when it was deposited on one. properties: id: type: string format: uuid deposit_number: type: string nullable: true correction_date: type: string format: date nullable: true description: >- The calendar date the correction will carry if this receipt is moved to this bank (its journal entry's own date). Set only when requires_bank_move is true. top_candidate: type: object nullable: true bank_account: type: object nullable: true description: >- This transaction's own bank account, returned when any candidate was deposited to another bank so the two can be named side by side. properties: id: type: string format: uuid name: type: string nullable: true account_number_last4: type: string nullable: true already_matched: type: boolean note: type: string nullable: true '400': $ref: '#/components/responses/Error' '401': $ref: '#/components/responses/Error' '403': $ref: '#/components/responses/Error' security: - ApiKeyAuth: [] 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. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.