API ReferenceBilling and Payments

Create resident charge

Create a resident charge for an integration.

Headers

AuthorizationstringRequired

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

Request

This endpoint expects an object.
integration_idstringRequired
lease_idstringOptional
The Propexo unique identifier for the lease
financial_account_idstringOptional
The Propexo unique identifier for the financial account
amount_in_centsintegerOptional
The amount of the resident charge, in cents
reference_numberstringOptional
The reference number for the resident charge
transaction_datedatetimeOptionalDefaults to 1970-01-01T00:00:00.000Z
The transaction date of the resident charge
descriptionstringOptional
Description of the resident charge
charge_code_idstringOptional
The Propexo ID for the charge code associated with this new charge
post_monthdatetime or stringOptional
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_idstringOptional
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_requiredbooleanOptionalDefaults to false
Whether or not the resident charge requires approval. This will require the charge be approved first before being posted to the ledger
property_idstringOptional
The Propexo unique identifier for the property
resident_idstringOptional
The Propexo unique identifier for the resident
transaction_batch_idstringOptional
A unique value provided by Realpage to associate a charge with a batch. This can be an alphanumeric string.
notesstringOptional
Notes associated with the resident charge
batch_idstringOptional
An identifier for the transaction batch. This should be unique to your system.
unit_idstringOptional
The Propexo unique identifier for the unit

Response

Successful response
job_idstring
The ID of the job created to handle this operation
dataobject

Errors