API ReferenceDeposit Summaries

Update deposit summary

Update a deposit summary for an integration.

Authentication

AuthorizationBearer

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

Path Parameters

deposit_summary_idstringRequired
The ID of the resource.

Request

This endpoint expects an object.
check_numberstringOptional>=1 character

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

post_monthstringOptional
The post month of the check.
payment_datestringOptional
The payment date of the check.
total_amount_in_centsintegerOptional

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_idstringOptional>=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_methodenumOptional

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

Allowed values:
notesstringOptional>=1 character
The notes for the check.
check_run_datestringOptional
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
job_idstring
The ID of the job created to handle this operation
dataobject

Errors