The Garnishment object

Garnishment is a served order and funds frozen, booked to the issuer payable, or released.

Attributes

account_idstringRequired

Example acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm

amountintegerRequired

benefit_credits_amountintegerRequired

Federal benefit payments found in the lookback

created_atstring · date-timeRequired

customer_idstringRequired

Example cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm

held_amountintegerRequired

The legal hold: the order's amount, capped at what was available after the protected funds

hold_idstringOptional

Example hold_2tVh8nqLxq4GbDe0K1F6S9zRcWm

hold_untilstring · date or nullOptional

IRS levy: no remittance before the 21st day after service

idstringRequired

irs_levybooleanRequired

issuerstringRequired

kindstringRequired

lookback_fromstring · dateRequired

A business date, YYYY-MM-DD

lookback_tostring · dateRequired

A business date, YYYY-MM-DD

notesstringRequired

notice_channelstringOptional

notice_due_bystring · date or nullOptional

212.7: three business days after the account review

notice_referencestringOptional

notice_sent_onstring · date or nullOptional

A business date, YYYY-MM-DD

protected_amountintegerRequired

received_atstring · dateRequired

A business date, YYYY-MM-DD

referencestringRequired

remit_journal_idstringOptional

Example jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm

remitted_amountintegerRequired

reviewed_onstring · dateRequired

A business date, YYYY-MM-DD

statusstringRequired

Open, payable, released; remitted is a legacy internal-transfer status

updated_atstring · date-timeRequired