Billing and Payments

Create a recurring resident charge

POST
Create a recurring resident charge 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
is_active
booleanOptional
Whether the recurring resident charge is active
amount_in_cents
integerOptional
The amount of the recurring resident charge, in cents
description
stringOptional
Description of the recurring resident charge
charge_due_day
integerOptional
The day of the month the charge is due
start_date
unionOptional
The start date associated with the recurring resident charge
end_date
unionOptional
The end date associated with the recurring resident charge
frequency_normalized
enumOptional
The frequency of the recurring resident charge
Allowed values: MONTHLYWEEKLY
reference_number
stringOptional
The reference number for the recurring resident charge

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.