Create Resident Charge: RealPage Partner Exchange

POST

/v1/resident-charges/realpage_rpx/

POST

/v1/resident-charges/realpage_rpx/

curl -X POST https://api.propexo.com/v1/resident-charges/realpage_rpx/ \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "integration_id": "intg-9f8b7c6d5e4a3b2c1d0e",
  "property_id": "prop-12345abcde67890fghij",
  "resident_id": "res-98765zyxwv43210utsrq",
  "charge_code_id": "charge-00123",
  "transaction_date": "2024-01-15T09:30:00Z",
  "amount_in_cents": 12500,
  "description": "January Rent Charge",
  "transaction_batch_id": "batch-20240115A"
}'

{
  "meta": {
    "job_id": "job-20240115-abcdef123456"
  },
  "result": {
    "integration_id": "intg-9f8b7c6d5e4a3b2c1d0e",
    "property_id": "prop-12345abcde67890fghij",
    "resident_id": "res-98765zyxwv43210utsrq",
    "charge_code_id": "charge-00123",
    "transaction_date": "2024-01-15T09:30:00Z",
    "amount_in_cents": 12500,
    "description": "January Rent Charge",
    "reference_number": "ref-20240115-0001",
    "transaction_batch_id": "batch-20240115A"
  }
}

Create Resident Charge: RealPage Partner Exchange

Method	Interface
PostSingleCharge	Transactions

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

property_idstringRequired

The Propexo unique identifier for the property

resident_idstringRequired

The Propexo unique identifier for the resident

charge_code_idstringRequired

The Propexo charge code to associate with this new charge

transaction_datestringRequired

The transaction date of the resident charge. The timestamp will be stripped off and only the date will be used

amount_in_centsintegerRequired

The amount of the resident charge, in cents

descriptionstringRequired

Description of the resident charge

transaction_batch_idstringRequired

A unique value provided by Realpage to associate a charge with a batch. This can be an alphanumeric string.

reference_numberstringOptional

The reference number for the resident charge

Response

Successful response

metaobject

resultobject

Errors

400

Bad Request Error