Corgi BankDocumentation
OpenAPI

Prepare immutable association statement from exact reviewed source

POST/hoa/statements

Bank-bound verified customer person with customer scope, session/device and current association business membership required. Writes require fresh five-minute step-up; staff, services and API keys cannot impersonate the association. Independent review requires distinct user AND person identities. Reviewed unit roster, assessments, adjustments and collected lockbox allocations are customer receivables, never deposit ownership or bank GL postings. Pending source/invoice/dues and partial-release capacities are serialized against actual check returns. Current balances reopen unpaid dues only from exact committed return evidence. Statement preparation binds the expected current source SHA256 and retains an immutable association-receivables-json-1 artifact/outbox without claiming delivery. See services/payments/hoa/README.md.

Headers

Idempotency-KeystringRequired

Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.

Body parameters

account_idstringRequired

Example acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm

expected_source_sha256stringRequired
format_versionstringRequired

Returns

200 OK

artifact_sha256stringRequired
created_atstring · date-timeRequired
idstringRequired
prepared_byobjectRequired
12 child attributes
account_idstringRequired

Example acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm

device_sha256stringRequired
membership_changed_bystringRequired
membership_updated_atstring · date-timeRequired
observed_atstring · date-timeRequired
organization_customer_idstringRequired

Example cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm

payment_limit_amountintegerRequired
person_customer_idstringRequired

Example cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm

rolestringRequired
session_sha256stringRequired
step_up_atstring · date-timeRequired
user_idstringRequired

Example user_2tVh8nqLxq4GbDe0K1F6S9zRcWm

requestobjectRequired
3 child attributes
account_idstringRequired

Example acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm

expected_source_sha256stringRequired
format_versionstringRequired
snapshotobjectRequired
8 child attributes
account_idstringRequired

Example acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm

balancesarray of objectsRequired
12 child attributes
adjustment_amountintegerRequired
allocated_amountintegerRequired
assessed_amountintegerRequired
assessment_idstringRequired

Example cpas_2tVh8nqLxq4GbDe0K1F6S9zRcWm

due_datestring · dateRequired

A business date, YYYY-MM-DD

invoice_referencestringRequired
occupancy_referencestringRequired
outstanding_amountintegerRequired
released_amountintegerRequired
returned_amountintegerRequired
unit_change_idstringRequired
unit_referencestringRequired
changesarray of objectsRequired
7 child attributes
content_sha256stringRequired
created_atstring · date-timeRequired
idstringRequired
requestobjectRequired
9 child attributes
account_idstringRequired

Example acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm

adjustmentobject or nullOptional
allocationobject or nullOptional
assessmentobject or nullOptional
evidenceobjectRequired
kindstringRequired
reasonstringRequired
releaseobject or nullOptional
unitobject or nullOptional
reviewobject or nullOptional
6 child attributes
approvebooleanRequired
atstring · date-timeRequired
authorityobjectRequired
content_sha256stringRequired
evidenceobjectRequired
reasonstringRequired
sourceobject or nullOptional
13 child attributes
account_idstringRequired

Example acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm

amountintegerRequired
check_deposit_idstringRequired
collection_journalobjectRequired
collection_journal_sha256stringRequired
currency_codestringRequired
customer_idstringRequired

Example cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm

deposit_journalobjectRequired
deposit_journal_sha256stringRequired
invoicesarray of objectsRequired
item_idstringRequired
lockbox_idstringRequired
remittance_idstringRequired
submitted_byobjectRequired
12 child attributes
account_idstringRequired

Example acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm

device_sha256stringRequired
membership_changed_bystringRequired
membership_updated_atstring · date-timeRequired
observed_atstring · date-timeRequired
organization_customer_idstringRequired

Example cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm

payment_limit_amountintegerRequired
person_customer_idstringRequired

Example cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm

rolestringRequired
session_sha256stringRequired
step_up_atstring · date-timeRequired
user_idstringRequired

Example user_2tVh8nqLxq4GbDe0K1F6S9zRcWm

observed_atstring · date-timeRequired
organization_customer_idstringRequired

Example cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm

outstanding_amountintegerRequired
receiptsarray of objectsRequired
5 child attributes
return_journalobject or nullOptional
18 child attributes
adjusts_periodstringOptional

A sealed period this journal corrects, YYYY-MM

approved_bystringOptional
backdatedbooleanOptional

Effective_date is before posting_date (read only)

committed_atstring · date-timeOptional
effective_datestring · dateRequired

A business date, YYYY-MM-DD

entriesarray of objectsRequired
fx_legsarray of objectsOptional

FXLegs is read only: the legs of a cross-currency journal the ledger's own conversion and close commands posted. A caller's posting never carries them.

idstringOptional
kindstringRequired
posted_bystringOptional
posting_datestring · dateOptional

A business date, YYYY-MM-DD

protected_command_idstringOptional
reasonstringOptional

Required on a backdated journal

release_hold_idstringOptional

Example hold_2tVh8nqLxq4GbDe0K1F6S9zRcWm

require_availablebooleanOptional
reversal_ofstringOptional
source_refstringRequired
source_servicestringRequired
return_journal_sha256stringOptional
return_reasonstringOptional
returnedbooleanRequired
sourceobjectRequired
13 child attributes
account_idstringRequired

Example acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm

amountintegerRequired
check_deposit_idstringRequired
collection_journalobjectRequired
collection_journal_sha256stringRequired
currency_codestringRequired
customer_idstringRequired

Example cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm

deposit_journalobjectRequired
deposit_journal_sha256stringRequired
invoicesarray of objectsRequired
item_idstringRequired
lockbox_idstringRequired
remittance_idstringRequired
source_sha256stringRequired

Errors

Every error is a problem document with a stable code. See Errors.

400401403404409412413422424429500503

to move to open esc to close