Create a recurring resident charge

POST
Create a recurring resident charge for an integration.

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
is_activebooleanOptional
Whether the recurring resident charge is active
amount_in_centsintegerOptional
The amount of the recurring resident charge, in cents
descriptionstringOptional
Description of the recurring resident charge
charge_due_dayintegerOptional
The day of the month the charge is due
start_datedatetime or stringOptional
The start date associated with the recurring resident charge
end_datedatetime or stringOptional
The end date associated with the recurring resident charge
frequency_normalized"MONTHLY" or "WEEKLY"Optional
Allowed values: MONTHLYWEEKLY
The frequency of the recurring resident charge
reference_numberstringOptional
The reference number for the recurring resident charge

Response

This endpoint returns an object.
job_idstring
The ID of the job created to handle this operation
dataobject

Errors

Built with