Billing and Payments

Create resident charge

POST
Create a resident charge for an integration.

Request

This endpoint expects an object.
integration_id
stringRequired
lease_id
stringOptional
The Propexo unique identifier for the lease
financial_account_id
stringOptional
The Propexo unique identifier for the financial account
amount_in_cents
integerOptional
The amount of the resident charge, in cents
reference_number
stringOptional
The reference number for the resident charge
transaction_date
datetimeOptional
The transaction date of the resident charge
description
stringOptional
Description of the resident charge
property_id
stringOptional
The Propexo unique identifier for the property
resident_id
stringOptional
The Propexo unique identifier for the resident
charge_code_id
stringOptional
The Propexo ID for the charge code associated with this new charge
transaction_batch_id
stringOptional
A unique value provided by Realpage to associate a charge with a batch. This can be an alphanumeric string.
notes
stringOptional
Notes associated with the resident charge
batch_id
stringOptional
An identifier for the transaction batch. This should be unique to your system.
unit_id
stringOptional
The Propexo unique identifier for the unit

Response

This endpoint returns an object
job_id
string
The ID of the job created to handle this operation
data
object
Returned data from the operation. This is dependent on the vendor specific endpoint's returned data.
POST
$curl -X POST https://api.propexo.com/v1/resident-charges \
> -H "Authorization: Bearer <token>" \
> -H "Content-Type: application/json" \
> -d '{
> "integration_id": "integration_id"
>}'
Response
1{
2 "job_id": "job_id",
3 "data": {}
4}