Create Recurring Resident Charge: Propertyware

POSThttps://api.propexo.com/v1/recurring-resident-charges/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

Possible values: > 0

descriptionstringrequired

Description of the recurring resident charge

charge_due_dayintegerrequired

The day of the month the charge is due

Possible values: >= 1 and <= 31

start_datestringrequired
The start date associated with the recurring resident charge
Show 2 variants
• string<date-time>
• stringPattern: ^\d{4}-\d{2}-\d{2}$
end_datestring
The end date associated with the recurring resident charge
Show 2 variants
• string<date-time>
• stringPattern: ^\d{4}-\d{2}-\d{2}$
frequency_normalizedstringrequired
The frequency of the recurring resident charge
Show 2 enum values
MONTHLYWEEKLY
reference_numberstring

The reference number for the recurring resident charge

Response

Successful response

meta objectrequired
job_idstringrequired
result objectrequired

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

Possible values: > 0

descriptionstringrequired

Description of the recurring resident charge

charge_due_dayintegerrequired

The day of the month the charge is due

Possible values: >= 1 and <= 31

start_datestring | nullnullablerequired

Show 2 variants

• string<date-time>
• stringPattern: ^\d{4}-\d{2}-\d{2}$

end_datestring | nullnullablerequired

The end date associated with the recurring resident charge

Show 2 variants

• string<date-time>
• stringPattern: ^\d{4}-\d{2}-\d{2}$

frequency_normalizedstringrequired

The frequency of the recurring resident charge

Show 2 enum values

MONTHLYWEEKLY

reference_numberstring | nullnullablerequired

The reference number for the recurring resident charge

Errors

• 400Bad Request

  error objectrequired
  codestringrequired
  Example: invalid_request
  messagestringrequired
  Example: invalid request
  details object
  property name*any
  Example: {"details":{"issues":[{"code":"unrecognized_keys","keys":["foo"],"path":[],"message":"Unrecognized key(s) in object: 'foo'"}],"name":"ZodError"}}

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": "string",
  "lease_id": "string",
  "financial_account_id": "string",
  "is_active": true,
  "amount_in_cents": 0,
  "description": "string",
  "charge_due_day": 0,
  "start_date": "2024-07-29T15:51:28.071Z",
  "frequency_normalized": "MONTHLY"
}'

200 Successful response

{
  "meta": {
    "job_id": "string"
  },
  "result": {
    "integration_id": "string",
    "lease_id": "string",
    "financial_account_id": "string",
    "is_active": true,
    "amount_in_cents": 0,
    "description": "string",
    "charge_due_day": 0,
    "start_date": "2024-07-29T15:51:28.071Z",
    "end_date": "2024-07-29T15:51:28.071Z",
    "frequency_normalized": "MONTHLY",
    "reference_number": "string"
  }
}