Update Deposit Summary: Yardi REST
Update Deposit Summary: Yardi REST
Update Deposit Summary: Yardi REST. This endpoint will initiate a deposit summary as paid if the total amount of the invoice is passed in.
Partial payments will be accepted, but the invoice will not be marked as paid until the full amount is paid.
If the deposit summary has already been paid, Yardi will throw an error.
| Interface | Method |
|---|---|
| Resident Transactions | /ItfResidentTransactions/ImportChecks |
Authentication
AuthorizationBearer
Bearer authentication of the form Bearer <token>, where token is your auth token.
Path parameters
deposit_summary_id
The Propexo unique identifier for the deposit summary
Request
This endpoint expects an object.
total_amount_in_cents
The total amount in cents paid out to the resident for the deposit refund. Note: Partial payments will be accepted, but the invoice will not be marked as paid until the full amount is paid.
x_bank_id
The external ID of the bank from the integration vendor. You'll likely want to work with your customer to find the appropriate value here.
payment_method
The payment method used for the refund payout. Note: To use EFT, the associated bank account must be configured for electronic payments.
check_number
The check number. Note: Must be unique per pay out.
notes
The notes for the check.
post_month
The post month of the check.
check_run_date
The date the check was run.
financial_account_id
The Propexo unique identifier for the financial account
check_cleared_date
The date the check was cleared.
is_not_reconciled
Whether the check is not reconciled
Response
Successful response
meta
result
Errors
400
Bad Request Error