Update Recurring Resident Charge: Rent Manager

PUThttps://api.propexo.com/v1/recurring-resident-charges/rentmanager/:recurring_resident_charge_id

Method
POST /RecurringCharges/{RecurringChargeID}

Authentication

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

Path parameters

recurring_resident_charge_id stringrequired

The ID of the resource.

Request

This endpoint expects an object.

charge_code_idstringrequired

The Propexo unique identifier for the charge code

amount_in_centsinteger

The amount of the resident charge, in cents

Possible values: > 0

frequency_normalizedstring
The frequency of the recurring resident charge
Show 3 enum values
DAILYMONTHLYWEEKLY
descriptionstring

Description of the recurring resident charge

start_datestring
The start date associated with the recurring resident charge. Required if frequency is DAILY or WEEKLY
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}$

Response

Successful response

meta objectrequired
job_idstringrequired
result objectrequired
recurring_resident_charge_idstringrequired
The Propexo unique identifier for the recurring resident charge
charge_code_idstringrequired
The Propexo unique identifier for the charge code
amount_in_centsinteger
The amount of the resident charge, in cents
Possible values: > 0
frequency_normalizedstring
The frequency of the recurring resident charge
Show 3 enum values
DAILYMONTHLYWEEKLY
descriptionstring
Description of the recurring resident charge
start_datestring
The start date associated with the recurring resident charge. Required if frequency is DAILY or WEEKLY
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}$

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"}}

PUT /v1/recurring-resident-charges/rentmanager/:recurring_resident_charge_id

curl -X PUT https://api.propexo.com/v1/recurring-resident-charges/rentmanager/:recurring_resident_charge_id \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "charge_code_id": "string"
}'

200 Successful response

{
  "meta": {
    "job_id": "string"
  },
  "result": {
    "recurring_resident_charge_id": "string",
    "charge_code_id": "string",
    "amount_in_cents": 0,
    "frequency_normalized": "DAILY",
    "description": "string",
    "start_date": "2024-07-29T15:51:28.071Z",
    "end_date": "2024-07-29T15:51:28.071Z"
  }
}