Skip to navigation
Yardi (Legacy)Deposit Summaries

Update Deposit Summary: Yardi

Beta

Update Deposit Summary: Yardi. 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.

InterfaceMethod
Billing and PaymentsImportCheck_Login

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

deposit_summary_idstringRequired
The Propexo unique identifier for the deposit summary

Request

This endpoint expects an object.
total_amount_in_centsintegerRequired

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_idstringRequired>=1 character
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_methodenumRequired

The payment method used for the refund payout. Note: To use EFT, the associated bank account must be configured for electronic payments.

Allowed values:
check_numberstringRequired>=1 character

The check number. Note: Must be unique per pay out.

notesstringRequired>=1 character
The notes for the check.
post_monthstringRequired
The post month of the check.
check_run_datestringRequired
The date the check was run.
financial_account_idstringOptional
The Propexo unique identifier for the financial account
check_cleared_datestringOptional
The date the check was cleared.
is_not_reconciledbooleanOptional
Whether the check is not reconciled

Response

Successful response
metaobject
resultobject

Errors

400
Bad Request Error