billingAndPayments

Create a recurring resident charge

Create a recurring resident charge for an integration.

post/v1/recurring-resident-charges/

Request

  • Base URL: https://api.propexo.com
  • URL: https://api.propexo.com/v1/recurring-resident-charges/
  • Auth: HTTP bearer

Request body

integration_idstring required
lease_idstring

The Propexo unique identifier for the lease

resident_idstring

The Propexo unique identifier for the resident

charge_code_idstring

The Propexo unique identifier for the charge code

amount_in_centsinteger

The amount of the recurring resident charge, in cents

descriptionstring

Description of the recurring resident charge

month_to_month_amount_in_centsinteger

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

month_to_month_fee_in_centsinteger

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

charge_timing_idstring

The propexo charge timing ID that defines when the charge should be applied

charge_code_type_idstring

The propexo charge code type ID

financial_account_idstring

The Propexo unique identifier for the financial account

is_activeboolean

Whether the recurring resident charge is active

charge_due_dayinteger

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_normalized'DAILY' | 'MONTHLY' | 'WEEKLY'

The frequency of the recurring resident charge

reference_numberstring

The reference number for the recurring resident charge

day_dueinteger

The day of the month the charge is due

frequency_rawinteger

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

Response

Successful response

job_idstring required

The ID of the job created to handle this operation

dataV1RecurringResidentChargesPostOutputData required

Changes

No recorded changes to this operation across all 1 revision of this API.