PMS Generic APIsBilling and Payments

Create a recurring resident charge

Create a recurring resident charge for an integration.

Authentication

AuthorizationBearer

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
resident_idstringOptional
The Propexo unique identifier for the resident
charge_code_idstringOptional
The Propexo unique identifier for the charge code
amount_in_centsintegerOptional
The amount of the recurring resident charge, in cents
start_datestringOptional
The start date associated with the recurring resident charge
descriptionstringOptional
Description of the recurring resident charge
end_datestringOptional
The end date associated with the recurring resident charge
month_to_month_amount_in_centsintegerOptional

The month-to-month amount for the recurring charge in cents

month_to_month_fee_in_centsintegerOptional

The month-to-month fee for the recurring charge in cents

last_posted_datestringOptional

The last date the charge was posted. Format will be converted to MM/DD/YYYY for Entrata

charge_timing_idstringOptional
The propexo charge timing ID that defines when the charge should be applied
charge_code_type_idstringOptional
The propexo charge code type ID
financial_account_idstringOptional
The Propexo unique identifier for the financial account
is_activebooleanOptional
Whether the recurring resident charge is active
charge_due_dayintegerOptional1-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

frequency_normalizedenumOptional
The frequency of the recurring resident charge
Allowed values:
reference_numberstringOptional
The reference number for the recurring resident charge
day_dueintegerOptional1-31
The day of the month the charge is due
frequency_rawintegerOptional1-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