API ReferenceBilling and Payments

Create a recurring resident charge

Create a recurring resident charge 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
is_activebooleanOptionalDefaults to false
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>=1<=31

The day of the month the charge is due. When frequency_normalized is set to ‘WEEKLY’, the charge_due_day must be between 1 and 7

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_normalizedenumOptional
The frequency of the recurring resident charge
Allowed values:
reference_numberstringOptional
The reference number for the recurring resident charge
resident_idstringOptional
The Propexo unique identifier for the resident
charge_code_idstringOptional
The Propexo unique identifier for the charge code
day_dueintegerOptional>=1<=31
The day of the month the charge is due
frequency_rawintegerOptional>=1<=24

The raw value of the frequency of the recurring resident charge (in months)

Response

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

Errors