Create Recurring Resident Charge: Propertyware

POST

/v1/recurring-resident-charges/propertyware/

POST

/v1/recurring-resident-charges/propertyware/

curl -X POST https://api.propexo.com/v1/recurring-resident-charges/propertyware/ \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "integration_id": "intg-9f8b7c6d5e4a3b2c1d0e",
  "lease_id": "lease-1234567890abcdef",
  "financial_account_id": "finacct-0987654321fedcba",
  "is_active": true,
  "amount_in_cents": 125000,
  "description": "Monthly Parking Fee",
  "charge_due_day": 5,
  "start_date": "2024-01-15T09:30:00Z",
  "frequency_normalized": "MONTHLY"
}'

{
  "meta": {
    "job_id": "job-20240615-abcdef123456"
  },
  "result": {
    "integration_id": "intg-9f8b7c6d5e4a3b2c1d0e",
    "lease_id": "lease-1234567890abcdef",
    "financial_account_id": "finacct-0987654321fedcba",
    "is_active": true,
    "amount_in_cents": 125000,
    "description": "Monthly Parking Fee",
    "charge_due_day": 5,
    "start_date": "2024-01-15T09:30:00Z",
    "end_date": "2025-01-14",
    "frequency_normalized": "MONTHLY",
    "reference_number": "REF-20240115-0001"
  }
}

Create Recurring Resident Charge: Propertyware

Method
updateLease

Notice

Due to PMS limitations, the ID of the created record cannot be retrieved. This will be found on the next data sync.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.

integration_idstringRequired

The Propexo unique identifier for the integration

lease_idstringRequired

The Propexo unique identifier for the lease

financial_account_idstringRequired

The Propexo unique identifier for the financial account

is_activebooleanRequired

Whether the recurring resident charge is active

amount_in_centsintegerRequired

The amount of the recurring resident charge, in cents

descriptionstringRequired

Description of the recurring resident charge

charge_due_dayintegerRequired1-31

The day of the month the charge is due

start_datestringRequired

The start date associated with the recurring resident charge

frequency_normalizedenumRequired

The frequency of the recurring resident charge

Allowed values:

end_datestringOptional

The end date associated with the recurring resident charge

reference_numberstringOptional

The reference number for the recurring resident charge

Response

Successful response

metaobject

resultobject

Errors

400

Bad Request Error