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
charge_code_id
stringOptional
The Propexo ID for the charge code associated with this new charge
post_month
unionOptional
The post month for the resident charge. The timestamp and day will be stripped off and only the month and year will be used
third_party_charge_id
stringOptional
A unique value provided to Entrata to uniquely identify the transaction from your system. This can be an alphanumeric string. This does not become the ID of the transaction in Entrata. If not provided, Propexo will generate one
is_approval_required
booleanOptional
Whether or not the resident charge requires approval. This will require the charge be approved first before being posted to the ledger
property_id
stringOptional
The Propexo unique identifier for the property
resident_id
stringOptional
The Propexo unique identifier for the resident
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.