Read exact association change evidence
/hoa/changes/{id}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.
Path parameters
idstringRequiredReturns
200 OK
content_sha256stringRequiredcreated_atstring · date-timeRequiredidstringRequiredrequestobjectRequired9 child attributes
account_idstringRequiredExample acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm
adjustmentobject or nullOptional3 child attributes
amountintegerRequiredassessment_idstringRequiredExample cpas_2tVh8nqLxq4GbDe0K1F6S9zRcWm
directionstringRequiredallocationobject or nullOptional3 child attributes
amountintegerRequiredassessment_idstringRequiredExample cpas_2tVh8nqLxq4GbDe0K1F6S9zRcWm
check_deposit_idstringRequiredassessmentobject or nullOptional6 child attributes
amountintegerRequireddue_datestring · dateRequiredA business date, YYYY-MM-DD
invoice_referencestringRequiredperiod_endstring · dateRequiredA business date, YYYY-MM-DD
period_startstring · dateRequiredA business date, YYYY-MM-DD
unit_change_idstringRequiredevidenceobjectRequired2 child attributes
referencestringRequiredsha256stringRequiredkindstringRequiredreasonstringRequiredreleaseobject or nullOptional2 child attributes
allocation_idstringRequiredamountintegerRequiredunitobject or nullOptional6 child attributes
activebooleanRequiredassociation_mandateobjectRequired2 child attributes
referencestringRequiredsha256stringRequiredoccupancy_referencestringRequiredprior_change_idstringOptionalreferencestringRequiredroster_evidenceobjectRequired2 child attributes
referencestringRequiredsha256stringRequiredreviewobject or nullOptional6 child attributes
approvebooleanRequiredatstring · date-timeRequiredauthorityobjectRequired12 child attributes
account_idstringRequiredExample acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm
device_sha256stringRequiredmembership_changed_bystringRequiredmembership_updated_atstring · date-timeRequiredobserved_atstring · date-timeRequiredorganization_customer_idstringRequiredExample cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm
payment_limit_amountintegerRequiredperson_customer_idstringRequiredExample cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm
rolestringRequiredsession_sha256stringRequiredstep_up_atstring · date-timeRequireduser_idstringRequiredExample user_2tVh8nqLxq4GbDe0K1F6S9zRcWm
content_sha256stringRequiredevidenceobjectRequired2 child attributes
referencestringRequiredsha256stringRequiredreasonstringRequiredsourceobject or nullOptional13 child attributes
account_idstringRequiredExample acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm
amountintegerRequiredcheck_deposit_idstringRequiredcollection_journalobjectRequired18 child attributes
adjusts_periodstringOptionalA sealed period this journal corrects, YYYY-MM
approved_bystringOptionalbackdatedbooleanOptionalEffective_date is before posting_date (read only)
committed_atstring · date-timeOptionaleffective_datestring · dateRequiredA business date, YYYY-MM-DD
entriesarray of objectsRequired4 child attributes
amountintegerRequiredMinor units of the currency (cents for USD)
currency_codestringRequiredISO 4217 code
directionstringRequiredledger_account_idstringRequiredExample lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm
fx_legsarray of objectsOptionalFXLegs 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.
7 child attributes
currency_codestringRequiredequivalent_ledger_account_idstringRequiredExample lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm
native_amountintegerRequiredposition_ledger_account_idstringRequiredExample lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm
rate_sheet_idstringRequiredusd_equivalent_amountintegerRequiredusd_per_foreign_majorstringRequiredidstringOptionalkindstringRequiredposted_bystringOptionalposting_datestring · dateOptionalA business date, YYYY-MM-DD
protected_command_idstringOptionalreasonstringOptionalRequired on a backdated journal
release_hold_idstringOptionalExample hold_2tVh8nqLxq4GbDe0K1F6S9zRcWm
require_availablebooleanOptionalreversal_ofstringOptionalsource_refstringRequiredsource_servicestringRequiredcollection_journal_sha256stringRequiredcurrency_codestringRequiredcustomer_idstringRequiredExample cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm
deposit_journalobjectRequired18 child attributes
adjusts_periodstringOptionalA sealed period this journal corrects, YYYY-MM
approved_bystringOptionalbackdatedbooleanOptionalEffective_date is before posting_date (read only)
committed_atstring · date-timeOptionaleffective_datestring · dateRequiredA business date, YYYY-MM-DD
entriesarray of objectsRequired4 child attributes
amountintegerRequiredMinor units of the currency (cents for USD)
currency_codestringRequiredISO 4217 code
directionstringRequiredledger_account_idstringRequiredExample lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm
fx_legsarray of objectsOptionalFXLegs 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.
7 child attributes
currency_codestringRequiredequivalent_ledger_account_idstringRequiredExample lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm
native_amountintegerRequiredposition_ledger_account_idstringRequiredExample lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm
rate_sheet_idstringRequiredusd_equivalent_amountintegerRequiredusd_per_foreign_majorstringRequiredidstringOptionalkindstringRequiredposted_bystringOptionalposting_datestring · dateOptionalA business date, YYYY-MM-DD
protected_command_idstringOptionalreasonstringOptionalRequired on a backdated journal
release_hold_idstringOptionalExample hold_2tVh8nqLxq4GbDe0K1F6S9zRcWm
require_availablebooleanOptionalreversal_ofstringOptionalsource_refstringRequiredsource_servicestringRequireddeposit_journal_sha256stringRequiredinvoicesarray of objectsRequired2 child attributes
amountintegerRequiredreferencestringRequireditem_idstringRequiredlockbox_idstringRequiredremittance_idstringRequiredsubmitted_byobjectRequired12 child attributes
account_idstringRequiredExample acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm
device_sha256stringRequiredmembership_changed_bystringRequiredmembership_updated_atstring · date-timeRequiredobserved_atstring · date-timeRequiredorganization_customer_idstringRequiredExample cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm
payment_limit_amountintegerRequiredperson_customer_idstringRequiredExample cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm
rolestringRequiredsession_sha256stringRequiredstep_up_atstring · date-timeRequireduser_idstringRequiredExample user_2tVh8nqLxq4GbDe0K1F6S9zRcWm
Errors
Every error is a problem document with a stable code. See Errors.
400401403404409412413422424429500503