> ## 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.
# Exclude a bank feed transaction
> Required API key scope: `accounting:write`
Flips an unreconciled bank feed line to `excluded` (QuickBooks
"Excluded tab" semantics). Excluded lines are invisible to reconciliation
math, counts, and every matcher; frozen against Plaid re-sync updates;
never deleted by the Plaid `removed[]` sweep; and restorable one click
via the restore endpoint.
**Status flips allowed:** `unreconciled -> excluded` ONLY. A `matched`
or `reconciled` line returns 409 (`bank_transaction_not_excludable`) --
unmatch it first.
**Idempotency:** excluding an already-excluded line is a 200 no-op
(`already_excluded: true`, no duplicate audit row).
**No GL postings occur.**
## OpenAPI
````yaml /openapi.yaml post /accounting/bank-transactions/{bank_transaction_id}/exclude
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}/exclude:
post:
tags:
- Accounting
summary: Exclude a bank feed transaction
description: >
Required API key scope: `accounting:write`
Flips an unreconciled bank feed line to `excluded` (QuickBooks
"Excluded tab" semantics). Excluded lines are invisible to
reconciliation
math, counts, and every matcher; frozen against Plaid re-sync updates;
never deleted by the Plaid `removed[]` sweep; and restorable one click
via the restore endpoint.
**Status flips allowed:** `unreconciled -> excluded` ONLY. A `matched`
or `reconciled` line returns 409 (`bank_transaction_not_excludable`) --
unmatch it first.
**Idempotency:** excluding an already-excluded line is a 200 no-op
(`already_excluded: true`, no duplicate audit row).
**No GL postings occur.**
operationId: excludeBankTransactionV1
parameters:
- name: bank_transaction_id
in: path
required: true
schema:
type: string
format: uuid
description: UUID of the unreconciled bank transaction to exclude
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
reason:
type: string
nullable: true
description: >-
Why the line is excluded. Canonical vocabulary:
duplicate_of_migrated | pre_baseline | noise | manual (free
text tolerated, capped at 200 chars; defaults to 'manual'
when omitted).
responses:
'200':
description: Excluded (or idempotent no-op when already excluded)
content:
application/json:
schema:
type: object
properties:
data:
type: object
properties:
bank_transaction_id:
type: string
format: uuid
excluded:
type: boolean
exclude_reason:
type: string
nullable: true
already_excluded:
type: boolean
description: Present true only on the idempotent re-exclude path.
bank_transaction:
type: object
description: The updated row (omitted on the idempotent path).
'400':
$ref: '#/components/responses/Error'
'401':
$ref: '#/components/responses/Error'
'403':
$ref: '#/components/responses/Error'
'404':
$ref: '#/components/responses/Error'
'409':
description: >-
Line is matched/reconciled (bank_transaction_not_excludable) --
unmatch first
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.
````