Billing and Payments

Create resident payment

POST
Create a resident payment for an integration.

Request

This endpoint expects an object.
integration_id
stringRequired
lease_id
stringOptional
The Propexo unique identifier for the lease
financial_account_id
stringOptional
The Propexo unique identifier for the financial account
resident_id
stringOptional
The Propexo unique identifier for the resident
transaction_date
datetimeOptional
The transaction date of the resident payment
amount_in_cents
integerOptional
The amount of the resident payment, in cents
payment_method_raw
enumOptional
The raw method of payment for the resident payment
send_email_receipt
booleanOptional
Indicates whether the payee would like to have a receipt emailed
description
stringOptional
Description of the resident payment
reference_number
stringOptional
The reference number for the resident payment
charge_code_id
stringOptional
The Propexo unique identifier for the charge code
notes
stringOptional
Notes associated with the resident payment
payment_type
enumOptional
The method of payment
batch_id
stringOptional
An identifier for the transaction batch. This should be unique to your system.
property_id
stringOptional
The Propexo unique identifier for the property
unit_id
stringOptional
The Propexo unique identifier for the unit

Response

This endpoint returns an object
job_id
string
The ID of the job created to handle this operation
data
object
Returned data from the operation. This is dependent on the vendor specific endpoint's returned data.
Built with