Skip to main content

Get a resident payment by ID

GEThttps://api.propexo.com/v1/resident-payments/:resident_payment_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.

Authentication​

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

Path parameters​

resident_payment_id stringrequired

The ID of the resource.

Query parameters​

order-by string

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

Default value: created_at:desc
updated_at_gte string | null

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

updated_at_lte string | null

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

last_seen_gte string | null

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_lte string | null

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

offset integer | null

Possible values: >= 0

Can be used for paginating results

Default value: 0
limit integer | null

Possible values: >= 0 and <= 250

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

Default value: 100

Response​

Successful response

    meta objectrequired
    offsetinteger

    The offset of the first result

    Possible values: >= 0

    Example: 0
    limitinteger

    The number of results to return

    Possible values: >= 0 and <= 250

    Example: 100
    orderBy object[]required

    The order of the results

  • Array [
    • object
  • ]
    • hasMoreboolean | nullnullable

    Whether there are more results

    totalinteger

    The total number of results

    Possible values: >= 0

    Example: 1000
    results objectrequired
    idstringrequired

    The Propexo unique identifier for the resident payment

    Example: clwktsp9v000008l31iv218hn
    created_atstringrequired

    The date record first entered Propexo

    Example: 2024-03-21T15:38:08.337Z
    updated_atstringrequired

    The date record was last updated in Propexo

    Example: 2024-03-22T10:59:45.119Z
    last_seenstring | nullnullablerequired

    The date the record was last seen from the PMS

    Example: 2024-03-22T10:59:45.119Z
    x_idstringrequired

    The external ID from the integration vendor

    MethodInterface
    /v1/leases/paymentsLeases
    /v1/leases/refundsLeases
    Example: 4343717769
    x_property_idstringrequired

    The external ID of the property from the integration vendor

    MethodInterface
    /v1/leases/paymentsLeases
    /v1/leases/refundsLeases
    Example: 59537182
    x_gl_account_idstring | nullnullablerequired

    The external ID of the general ledger account from the integration vendor

    MethodInterface
    /v1/leases/paymentsLeases
    /v1/leases/refundsLeases
    Example: 357281058
    x_location_idnullrequired

    The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations.

    Notice

    This field will always be null for PROPERTYWARE_REST

    Example: null
    x_lease_idstring | nullnullablerequired

    The external ID of the lease from the integration vendor

    MethodInterface
    /v1/leases/paymentsLeases
    /v1/leases/refundsLeases
    Example: 27845671
    x_resident_idnullrequired

    The external ID of the resident from the integration vendor

    Notice

    This field will always be null for PROPERTYWARE_REST

    Example: null
    x_unit_idstring | nullnullablerequired

    The external ID of the unit from the integration vendor

    MethodInterface
    /v1/leases/paymentsLeases
    /v1/leases/refundsLeases
    Example: 557838
    x_charge_code_idnullrequired

    The external ID of the charge code from the integration vendor

    Notice

    This field will always be null for PROPERTYWARE_REST

    Example: null
    payment_method_normalizedstring | nullnullablerequired

    The normalized method of payment for the resident payment

    MethodInterface
    /v1/leases/paymentsLeases
    Example: CHECK
    payment_method_rawstring | nullnullablerequired

    The raw method of payment for the resident payment

    MethodInterface
    /v1/leases/paymentsLeases
    Example: SECTION8
    amount_in_centsnumber | nullnullablerequired

    The amount of the resident payment, in cents

    MethodInterface
    /v1/leases/paymentsLeases
    /v1/leases/refundsLeases
    Example: -20000
    amount_rawstring | nullnullablerequired

    The raw value for amount from the PMS

    MethodInterface
    /v1/leases/paymentsLeases
    /v1/leases/refundsLeases
    Example: 200.00
    namestring | nullnullablerequired

    The name associated with the resident payment

    MethodInterface
    /v1/leases/paymentsLeases
    /v1/leases/refundsLeases
    Example: PAYMENT
    descriptionstring | nullnullablerequired

    Description of the resident payment

    MethodInterface
    /v1/leases/paymentsLeases
    Example: Paid in person by Jerry
    reference_numberstring | nullnullablerequired

    The reference number for the resident payment

    MethodInterface
    /v1/leases/paymentsLeases
    /v1/leases/refundsLeases
    Example: 5122
    transaction_datestring | nullnullablerequired

    The transaction date of the resident payment

    MethodInterface
    /v1/leases/paymentsLeases
    /v1/leases/refundsLeases
    Example: 2023-04-21T00:00:00.000Z
    is_opennullrequired

    Whether the resident payment is open and not yet settled

    Notice

    This field will always be null for PROPERTYWARE_REST

    Example: null
    post_monthnullrequired

    The post month for the resident payment

    Notice

    This field will always be null for PROPERTYWARE_REST

    Example: null
    custom_data object | nullrequired
    object
    integration_idstringrequired

    The Propexo unique identifier for the integration

    Example: clwh5u07w000508me66sfh3um
    integration_vendorEnum18required

    The property management system of record

    Show 13 enum values
    PROPERTYWARE_RESTAPPFOLIOBUILDIUMENTRATAMRIPROPERTYWAREREALPAGEREALPAGE_RPXRENTMANAGERRENTVINERESMANYARDIYARDI_REST
    Example: PROPERTYWARE_REST
    property_idstringrequired

    The Propexo unique identifier for the property

    Example: clwi5xiix000008l6ctdgafyh
    resident_idnullrequired

    The Propexo unique identifier for the resident

    Notice

    This field will always be null for PROPERTYWARE_REST

    Example: null
    financial_account_idstring | nullnullablerequired

    The Propexo unique identifier for the financial account

    MethodInterface
    /v1/leases/paymentsLeases
    /v1/leases/refundsLeases
    Example: cm111hjt5000708lbbs44cjts
    unit_idnullrequired

    The Propexo unique identifier for the unit

    Notice

    This field will always be null for PROPERTYWARE_REST

    Example: null
    lease_idstring | nullnullablerequired

    The Propexo unique identifier for the lease

    MethodInterface
    /v1/leases/paymentsLeases
    /v1/leases/refundsLeases
    Example: cm70kirrr29460295341h2g0bn44mxca
    charge_code_idnullrequired

    The Propexo unique identifier for the charge code

    Notice

    This field will always be null for PROPERTYWARE_REST

    Example: null
    allocations object[]required

    Array of payment allocations, splits, and related transactions associated with the resident payment

  • Array [
    • idstringrequired

    The Propexo unique identifier for the resident allocation

    Example: clwktsp9v000008l31iv218hn
    x_idstringrequired

    The external ID from the integration vendor

    MethodInterface
    /v1/accounting/generalledgerAccounting
    Example: 5738100275-8635281836
    x_source_idstring | nullnullablerequired

    The external ID of the source transaction from the integration vendor

    MethodInterface
    /v1/accounting/generalledgerAccounting
    Example: 574622569
    x_destination_idstring | nullnullablerequired

    The external ID of the destination transaction from the integration vendor

    MethodInterface
    /v1/accounting/generalledgerAccounting
    Example: 573829483
    financial_account_idstring | nullnullablerequired

    The Propexo unique identifier for the financial account

    MethodInterface
    /v1/accounting/generalledgerAccounting
    Example: cm1b8bftm000208l485ya3klj
    amount_in_centsnumber | nullnullablerequired

    The amount of the resident allocation, in cents

    MethodInterface
    /v1/accounting/generalledgerAccounting
    Example: 20000
    amount_rawstring | nullnullablerequired

    The raw value for amount from the PMS

    MethodInterface
    /v1/accounting/generalledgerAccounting
    Example: 200
    resident_charge_idstring | nullnullablerequired

    The Propexo unique identifier for the resident charge

    Notice

    This field is not currently hydrated for PROPERTYWARE_REST

    resident_payment_idstring | nullnullablerequired

    The Propexo unique identifier for the resident payment

    created_atstringrequired

    The date record first entered Propexo

    Example: 2024-03-21T15:38:08.337Z
    updated_atstringrequired

    The date record was last updated in Propexo

    Example: 2024-03-22T10:59:45.119Z
    last_seenstring | nullnullablerequired

    The date the record was last seen from the PMS

    Example: 2024-03-22T10:59:45.119Z
    custom_data object | nullrequired
    object
  • ]

Errors​

  • 400Bad Request
      error objectrequired
      codestringrequired
      Example: invalid_request
      messagestringrequired
      Example: invalid request
      details object
      property name*any
      Example: {"details":{"issues":[{"code":"unrecognized_keys","keys":["foo"],"path":[],"message":"Unrecognized key(s) in object: 'foo'"}],"name":"ZodError"}}
GET /v1/resident-payments/:resident_payment_id
curl https://api.propexo.com/v1/resident-payments/:resident_payment_id \
     -H "Authorization: Bearer <token>"
200 Successful response
{
  "meta": {
    "offset": 0,
    "limit": 100,
    "orderBy": [
      {}
    ],
    "hasMore": true,
    "total": 1000
  },
  "results": {
    "id": "clwktsp9v000008l31iv218hn",
    "created_at": "2024-03-21T15:38:08.337Z",
    "updated_at": "2024-03-22T10:59:45.119Z",
    "last_seen": "2024-03-22T10:59:45.119Z",
    "x_id": "4343717769",
    "x_property_id": "59537182",
    "x_gl_account_id": "357281058",
    "x_location_id": null,
    "x_lease_id": "27845671",
    "x_resident_id": null,
    "x_unit_id": "557838",
    "x_charge_code_id": null,
    "payment_method_normalized": "CHECK",
    "payment_method_raw": "SECTION8",
    "amount_in_cents": -20000,
    "amount_raw": "200.00",
    "name": "PAYMENT",
    "description": "Paid in person by Jerry",
    "reference_number": "5122",
    "transaction_date": "2023-04-21T00:00:00.000Z",
    "is_open": null,
    "post_month": null,
    "custom_data": "Unknown Type: object,null",
    "integration_id": "clwh5u07w000508me66sfh3um",
    "integration_vendor": "PROPERTYWARE_REST",
    "property_id": "clwi5xiix000008l6ctdgafyh",
    "resident_id": null,
    "financial_account_id": "cm111hjt5000708lbbs44cjts",
    "unit_id": null,
    "lease_id": "cm70kirrr29460295341h2g0bn44mxca",
    "charge_code_id": null,
    "allocations": [
      {
        "id": "clwktsp9v000008l31iv218hn",
        "x_id": "5738100275-8635281836",
        "x_source_id": "574622569",
        "x_destination_id": "573829483",
        "financial_account_id": "cm1b8bftm000208l485ya3klj",
        "amount_in_cents": 20000,
        "amount_raw": 200,
        "resident_charge_id": "string",
        "resident_payment_id": "string",
        "created_at": "2024-03-21T15:38:08.337Z",
        "updated_at": "2024-03-22T10:59:45.119Z",
        "last_seen": "2024-03-22T10:59:45.119Z",
        "custom_data": "Unknown Type: object,null"
      }
    ]
  }
}