> ## 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 bank deposit to a customer payment receipt
> Required API key scope: `accounting:write`
Atomically links an inbound bank transaction to an `order_payments` receipt
by setting `bank_transactions.matched_order_payment_id` and flipping
`reconciliation_status` to `'matched'`.
**No GL postings occur.** The GL entry (DR Bank / CR AR) was posted
when the payment receipt was recorded. This operation records only the
reconciliation link for the bank statement.
**Guards enforced:**
- Transaction must be inbound (`direction='in'` or NULL); outbound transactions
use the AP-side matcher instead.
- Transaction must not already be matched to a customer payment.
- Payment status must be `posted`, `partial_refund`, or `succeeded`.
- Entity isolation: bank transaction and order payment must belong to the
same entity as the API key.
**Amount warning:** If the absolute difference between the bank transaction
amount and the payment amount exceeds $0.05, `amount_warning` is populated
in the response (non-blocking, for operator awareness).
**A.2 Multi-invoice payments:** Payments where `order_id IS NULL` (applied
across multiple invoices) are fully supported as match targets.
**Idempotency:** Matching an already-matched transaction to the same payment
is a no-op returning the same `matched: true` response.
## OpenAPI
````yaml /openapi.yaml post /accounting/bank-transactions/{bank_transaction_id}/match-customer-payment
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:
/accounting/bank-transactions/{bank_transaction_id}/match-customer-payment:
post:
tags:
- Accounting
summary: Match a bank deposit to a customer payment receipt
description: >
Required API key scope: `accounting:write`
Atomically links an inbound bank transaction to an `order_payments`
receipt
by setting `bank_transactions.matched_order_payment_id` and flipping
`reconciliation_status` to `'matched'`.
**No GL postings occur.** The GL entry (DR Bank / CR AR) was posted
when the payment receipt was recorded. This operation records only the
reconciliation link for the bank statement.
**Guards enforced:**
- Transaction must be inbound (`direction='in'` or NULL); outbound
transactions
use the AP-side matcher instead.
- Transaction must not already be matched to a customer payment.
- Payment status must be `posted`, `partial_refund`, or `succeeded`.
- Entity isolation: bank transaction and order payment must belong to
the
same entity as the API key.
**Amount warning:** If the absolute difference between the bank
transaction
amount and the payment amount exceeds $0.05, `amount_warning` is
populated
in the response (non-blocking, for operator awareness).
**A.2 Multi-invoice payments:** Payments where `order_id IS NULL`
(applied
across multiple invoices) are fully supported as match targets.
**Idempotency:** Matching an already-matched transaction to the same
payment
is a no-op returning the same `matched: true` response.
operationId: matchBankToCustomerPaymentV1
parameters:
- name: bank_transaction_id
in: path
required: true
schema:
type: string
format: uuid
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- order_payment_id
properties:
order_payment_id:
type: string
format: uuid
description: UUID of the order_payment to match to this bank transaction
reconciliation_id:
type: string
format: uuid
nullable: true
description: Optional active reconciliation session this match belongs to
responses:
'200':
description: Matched successfully
content:
application/json:
schema:
type: object
properties:
data:
type: object
properties:
bank_transaction_id:
type: string
format: uuid
order_payment_id:
type: string
format: uuid
order_id:
type: string
format: uuid
nullable: true
matched:
type: boolean
amount_warning:
type: string
nullable: true
'400':
$ref: '#/components/responses/Error'
'401':
$ref: '#/components/responses/Error'
'403':
$ref: '#/components/responses/Error'
'409':
description: Transaction already matched or payment already matched
content:
application/json:
schema:
$ref: '#/components/schemas/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:
Error:
description: |
Alias for ErrorEnvelope. Canonical error response shape used by all
API endpoints. Refer to ErrorEnvelope for the full field definition.
allOf:
- $ref: '#/components/schemas/ErrorEnvelope'
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.
````