Create Recurring Resident Charge: Rentvine | Propexo

curl -X POST https://api.propexo.com/v1/recurring-resident-charges/rentvine/ \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "integration_id": "intg_9f8b7c6d5e4a3b2c1d0e",
  "lease_id": "lease_1234567890abcdef",
  "financial_account_id": "finacct_0987654321fedcba",
  "amount_in_cents": 150000,
  "description": "Monthly Rent Charge",
  "day_due": 5,
  "start_date": "2024-07-01T00:00:00Z"
}'

{
  "meta": {
    "job_id": "job_abcdef1234567890"
  },
  "result": {
    "integration_id": "intg_9f8b7c6d5e4a3b2c1d0e",
    "lease_id": "lease_1234567890abcdef",
    "financial_account_id": "finacct_0987654321fedcba",
    "amount_in_cents": 150000,
    "description": "Monthly Rent Charge",
    "day_due": 5,
    "start_date": "2024-07-01T00:00:00Z",
    "end_date": "2025-06-30T23:59:59Z",
    "frequency_raw": 1
  }
}

Create Recurring Resident Charge: Rentvine

Method	Interface
POST /api/manager/leases/{leaseID}/recurring-charges	Leases

Notice

This write operation will set the created_record_id flag on the write-status endpoint and allow for new record to be read back in immediately.

Create Recurring Resident Charge: Rentvine | Method | Interface | |---|---| | POST /api/manager/leases/{leaseID}/recurring-charges | Leases | <Note title="Notice">This write operation will set the created_record_id flag on the write-status endpoint and allow for new record to be read back in immediately.</Note>

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

amount_in_centsintegerRequired

The amount of the recurring resident charge, in cents

descriptionstringRequired

Description of the recurring resident charge

day_dueintegerRequired<=31

The day of the month the charge is due

start_datestringRequired

The start date associated with the recurring resident charge

end_datestringOptional

The end date associated with the recurring resident charge

frequency_rawintegerOptional<=24

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

Response

Successful response

metaobject

resultobject

Errors

400

Bad Request Error