depositSummaries

Update deposit summary

Update a deposit summary for an integration.

put/v1/deposit-summaries/{deposit_summary_id}

Request

  • Base URL: https://api.propexo.com
  • URL: https://api.propexo.com/v1/deposit-summaries/{deposit_summary_id}
  • Auth: HTTP bearer

Path parameters

deposit_summary_idstring required

The ID of the resource.

Request body

check_numberstring

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

total_amount_in_centsinteger

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_idstring

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'CHECK' | 'EFT'

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

notesstring

The notes for the check.

financial_account_idstring

The Propexo unique identifier for the financial account

is_not_reconciledboolean

Whether the check is not reconciled

Response

Successful response

job_idstring required

The ID of the job created to handle this operation

dataV1DepositSummariesDepositSummaryIdPutOutputData required

Changes

No recorded changes to this operation across all 1 revision of this API.