Get all resident payments

GEThttps://api.propexo.com/v1/resident-payments/

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.

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

property_id string

The Propexo unique identifier for the property

integration_id string

The Propexo unique identifier for the integration

integration_vendor string

Show 13 enum values

APPFOLIOBUILDIUMENTRATAMRIPROPERTYWAREPROPERTYWARE_RESTREALPAGEREALPAGE_RPXRENTMANAGERRENTVINERESMANYARDIYARDI_REST

The property management system of record

resident_id string

The Propexo unique identifier for the resident

lease_id string

The Propexo unique identifier for the lease

transaction_date_start string | null

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

transaction_date_end string | null

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

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 object[]required

Array [

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

Method
artransactions/getLeaseArTransactions

Example: transX456

x_property_idstringrequired

The external ID of the property from the integration vendor

Method
artransactions/getLeaseArTransactions

Example: property456

x_gl_account_idnullrequired

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

Notice

This field will always be null for ENTRATA

Example: null

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 ENTRATA

Example: null

x_lease_idstring | nullnullablerequired

The external ID of the lease from the integration vendor

Method
artransactions/getLeaseArTransactions

Example: lease123

x_resident_idstring | nullnullablerequired

The external ID of the resident from the integration vendor

Method
artransactions/getLeaseArTransactions

Example: resX456

x_unit_idstring | nullnullablerequired

The external ID of the unit from the integration vendor

Method
artransactions/getLeaseArTransactions

Example: 12345

x_charge_code_idstring | nullnullablerequired

The external ID of the charge code from the integration vendor

Method
artransactions/getLeaseArTransactions

Example: 12312

payment_method_normalizednullrequired

The normalized method of payment for the resident payment

Notice

This field will always be null for ENTRATA

Example: null

payment_method_rawnullrequired

The raw method of payment for the resident payment

Notice

This field will always be null for ENTRATA

Example: null

amount_in_centsnumber | nullnullablerequired

The amount of the resident payment, in cents

Method
artransactions/getLeaseArTransactions

Example: 150000

amount_rawstring | nullnullablerequired

The raw value for amount from the PMS

Method
artransactions/getLeaseArTransactions

Example: 1500.00

namestring | nullnullablerequired

The name associated with the resident payment

Method
artransactions/getLeaseArTransactions

Example: Rent Payment

descriptionstring | nullnullablerequired

Description of the resident payment

Method
artransactions/getLeaseArTransactions

Example: Payment for July 2024 rent

reference_numbernullrequired

The reference number for the resident payment

Notice

This field will always be null for ENTRATA

Example: null

transaction_datestring | nullnullablerequired

The transaction date of the resident payment

Method
artransactions/getLeaseArTransactions

Example: 2024-06-01T00:00:00.000Z

is_opennullrequired

Whether the resident payment is open and not yet settled

Notice

This field will always be null for ENTRATA

Example: null

post_monthstring | nullnullablerequired

The post month for the resident payment

Method
artransactions/getLeaseArTransactions

Possible values: Value must match regular expression ^\d{4}-(?:0[1-9]|1[0-2])$

Example: 2024-02

custom_data object | nullrequired

object

integration_idstringrequired

The Propexo unique identifier for the integration

Example: clwh5u07w000508me66sfh3um

integration_vendorEnum15required

The property management system of record

Show 13 enum values

ENTRATAAPPFOLIOBUILDIUMMRIPROPERTYWAREPROPERTYWARE_RESTREALPAGEREALPAGE_RPXRENTMANAGERRENTVINERESMANYARDIYARDI_REST

Example: ENTRATA

property_idstringrequired

The Propexo unique identifier for the property

Example: clwi5xiix000008l6ctdgafyh

resident_idstring | nullnullablerequired

The Propexo unique identifier for the resident

Method
artransactions/getLeaseArTransactions

Example: cl7t4tlme0000usxq5zk0e5gl

financial_account_idnullrequired

The Propexo unique identifier for the financial account

Notice

This field will always be null for ENTRATA

Example: null

unit_idstring | nullnullablerequired

The Propexo unique identifier for the unit

Method
artransactions/getLeaseArTransactions

Example: cm7jclb5o3805238169fbbucm1ar587b

lease_idstring | nullnullablerequired

The Propexo unique identifier for the lease

Method
artransactions/getLeaseArTransactions

Example: cm7jclb5o3805238169fbbucm1ar587b

charge_code_idstring | nullnullablerequired

The Propexo unique identifier for the charge code

Method
artransactions/getLeaseArTransactions

Example: cm7jclb5o3805238169fbbucm1ar587b

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

Method
arpayments/getArPayments

Example: allocX456

x_source_idstring | nullnullablerequired

The external ID of the source transaction from the integration vendor

Method
arpayments/getArPayments

Example: sourceX123

x_destination_idstring | nullnullablerequired

The external ID of the destination transaction from the integration vendor

Method
arpayments/getArPayments

Example: destChargeX123

financial_account_idnullrequired

The Propexo unique identifier for the financial account

Notice

This field will always be null for ENTRATA

Example: null

amount_in_centsnumber | nullnullablerequired

The amount of the resident allocation, in cents

Method
arpayments/getArPayments

Example: 50000

amount_rawstring | nullnullablerequired

The raw value for amount from the PMS

Method
arpayments/getArPayments

Example: 500.00

resident_charge_idstring | nullnullablerequired

The Propexo unique identifier for the resident charge

Notice

This field is not currently hydrated for ENTRATA

resident_payment_idstring | nullnullablerequired

The Propexo unique identifier for the resident payment

Notice

This field is not currently hydrated for ENTRATA

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

GET /v1/resident-payments/
curl https://api.propexo.com/v1/resident-payments/ \
     -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": "transX456",
      "x_property_id": "property456",
      "x_gl_account_id": null,
      "x_location_id": null,
      "x_lease_id": "lease123",
      "x_resident_id": "resX456",
      "x_unit_id": "12345",
      "x_charge_code_id": "12312",
      "payment_method_normalized": null,
      "payment_method_raw": null,
      "amount_in_cents": 150000,
      "amount_raw": "1500.00",
      "name": "Rent Payment",
      "description": "Payment for July 2024 rent",
      "reference_number": null,
      "transaction_date": "2024-06-01T00:00:00.000Z",
      "is_open": null,
      "post_month": "2024-02",
      "custom_data": "Unknown Type: object,null",
      "integration_id": "clwh5u07w000508me66sfh3um",
      "integration_vendor": "ENTRATA",
      "property_id": "clwi5xiix000008l6ctdgafyh",
      "resident_id": "cl7t4tlme0000usxq5zk0e5gl",
      "financial_account_id": null,
      "unit_id": "cm7jclb5o3805238169fbbucm1ar587b",
      "lease_id": "cm7jclb5o3805238169fbbucm1ar587b",
      "charge_code_id": "cm7jclb5o3805238169fbbucm1ar587b",
      "allocations": [
        {
          "id": "clwktsp9v000008l31iv218hn",
          "x_id": "allocX456",
          "x_source_id": "sourceX123",
          "x_destination_id": "destChargeX123",
          "financial_account_id": null,
          "amount_in_cents": 50000,
          "amount_raw": "500.00",
          "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"
        }
      ]
    }
  ]
}

Get all resident payments

Authentication​

Query parameters​

Response​

Errors​

Authentication

Query parameters

Response

Errors