billingAndPayments

Get a resident payment by ID

The Resident Payments 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 payments that the resident has made. Due to the PMS API structure, this is a naturally high-volume endpoint. Since Propexo pricing is based on records returned, this may result in signficantly higher overall costs. We encourage you to reach out to support before activating.

get/v1/resident-payments/{resident_payment_id}

Request

  • Base URL: https://api.propexo.com
  • URL: https://api.propexo.com/v1/resident-payments/{resident_payment_id}
  • Auth: HTTP bearer

Path parameters

resident_payment_idstring required

The ID of the resource.

Query parameters

order-bystring

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

updated_at_gtestring nullable

Filter to records updated at or after this datetime. Format: ISO 8601 (e.g. 2026-01-01T00:00:00Z)

updated_at_ltestring nullable

Filter to records updated at or before this datetime. Format: ISO 8601 (e.g. 2026-12-31T23:59:59Z)

last_seen_gtestring nullable

Filter to records whose last_seen date is on or after this datetime. Format: ISO 8601 (e.g. 2026-01-01T00:00:00Z)

last_seen_ltestring nullable

Filter to records whose last_seen date is on or before this datetime. Format: ISO 8601 (e.g. 2026-12-31T23:59:59Z)

offsetinteger nullable

Can be used for paginating results

limitinteger nullable

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

Response

Successful response

Changes

No recorded changes to this operation across all 1 revision of this API.