API ReferenceBilling and Payments

Create resident payment

Create a resident payment for an integration.

Headers

AuthorizationstringRequired

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

Request

This endpoint expects an object.
integration_idstringRequired
lease_idstringOptional
The Propexo unique identifier for the lease
financial_account_idstringOptional
The Propexo unique identifier for the financial account
resident_idstringOptional
The Propexo unique identifier for the resident
transaction_datedatetimeOptionalDefaults to 1970-01-01T00:00:00.000Z
The transaction date of the resident payment
amount_in_centsintegerOptional
The amount of the resident payment, in cents
payment_typeenumOptional
The method of payment
send_email_receiptbooleanOptionalDefaults to false
Indicates whether the payee would like to have a receipt emailed
descriptionstringOptional
Description of the resident payment
reference_numberstringOptional
The reference number for the resident payment
charge_code_idstringOptional
The Propexo unique identifier for the charge code
notesstringOptional
Notes associated with the resident payment
allocate_prepaysbooleanOptionalDefaults to false
Whether to allocate prepays to the resident payment. This is a flag passed directly to Rent Manager
batch_idstringOptional
An identifier for the transaction batch. This should be unique to your system.
property_idstringOptional
The Propexo unique identifier for the property
unit_idstringOptional
The Propexo unique identifier for the unit

Response

Successful response
job_idstring
The ID of the job created to handle this operation
dataobject

Errors