Get all resident charges

GET
/v1/resident-charges/

The Resident Charges model provides a limited, one-sided view of a resident’s financial history with a PMC and should not be treated as a comprehensive report of all charges that the resident owes.

Query parameters

order-bystringOptional

Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc

offsetintegerOptional

Can be used for paginating results

limitintegerOptional

A number between 1 and 250 to determine the number of results to return in a single query

property_idstringOptional

The Propexo unique identifier for the property

integration_idstringOptional

The Propexo unique identifier for the integration

integration_vendorenumOptional

The property management system of record

transaction_date_startstringOptional

The start of the transaction date range to search. Inclusive.

transaction_date_endstringOptional

The end of the transaction date range to search. Inclusive.

Response

This endpoint returns an object.
metaobject
resultslist of objects

Errors