Skip to main content

Get all recurring resident charges

GEThttps://api.propexo.com/v1/recurring-resident-charges/

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
location_id string

The Propexo unique identifier for the location associated with the property (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations.

property_id string

The Propexo unique identifier for the property

lease_id string

The Propexo unique identifier for the lease

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

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 recurring resident charge

    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

    InterfaceMethod
    Billing and PaymentsGetResidentsLeaseCharges_Login
    Example: 91
    x_property_idstringrequired

    The external ID of the property from the integration vendor

    InterfaceMethod
    Billing and PaymentsGetResidentsLeaseCharges_Login
    Example: kjhjhjwe
    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 YARDI

    Example: null
    x_charge_code_idstring | nullnullablerequired

    The external ID of the charge code from the integration vendor

    InterfaceMethod
    Billing and PaymentsGetResidentsLeaseCharges_Login
    Example: appfee
    x_financial_account_idstring | nullnullablerequired

    The external ID of the financial account from the integration vendor

    InterfaceMethod
    Billing and PaymentsGetResidentsLeaseCharges_Login
    Example: 234634644
    x_lease_idstring | nullnullablerequired

    The external ID of the lease from the integration vendor

    InterfaceMethod
    Billing and PaymentsGetResidentsLeaseCharges_Login
    Example: t0000001
    amount_in_centsnumber | nullnullablerequired

    The total amount of the recurring resident charge

    InterfaceMethod
    Billing and PaymentsGetResidentsLeaseCharges_Login
    Example: 150000
    amount_rawstring | nullnullablerequired

    The raw value for amount from the PMS

    InterfaceMethod
    Billing and PaymentsGetResidentsLeaseCharges_Login
    Example: 55.00
    is_activenullrequired

    Whether the recurring resident charge is active

    Notice

    This field will always be null for YARDI

    Example: null
    descriptionstring | nullnullablerequired

    Description of the recurring resident charge

    InterfaceMethod
    Billing and PaymentsGetResidentsLeaseCharges_Login
    Example: Application fee [Lease Charge]
    reference_numbernullrequired

    The reference number for the recurring resident charge

    Notice

    This field will always be null for YARDI

    Example: null
    start_datestring | nullnullablerequired

    The start date associated with the recurring resident charge

    InterfaceMethod
    Billing and PaymentsGetResidentsLeaseCharges_Login
    Example: 2025-07-15T00:00:00.000Z
    end_datestring | nullnullablerequired

    The end date associated with the recurring resident charge

    InterfaceMethod
    Billing and PaymentsGetResidentsLeaseCharges_Login
    Example: 2025-07-15T00:00:00.000Z
    frequency_rawnullrequired

    The raw value of the frequency of the recurring resident charge

    Notice

    This field will always be null for YARDI

    Example: null
    frequency_normalizednullrequired

    The frequency of the recurring resident charge

    Notice

    This field will always be null for YARDI

    Example: null
    charge_due_daynullrequired

    The due date associated with the recurring resident charge

    Notice

    This field will always be null for YARDI

    Example: null
    custom_data object | nullrequired
    object
    financial_account_idstring | nullnullablerequired

    The Propexo unique identifier for the financial account

    InterfaceMethod
    Billing and PaymentsGetResidentsLeaseCharges_Login
    Example: clwqs19bb000008l1bbcv2bs4:hjhbbwe:3267723
    lease_idstring | nullnullablerequired

    The Propexo unique identifier for the lease

    InterfaceMethod
    Billing and PaymentsGetResidentsLeaseCharges_Login
    Example: clwqs19bb000008l1bbcv2bs4:efweee:t9938827
    charge_code_idstring | nullnullablerequired

    The Propexo unique identifier for the charge code

    InterfaceMethod
    Billing and PaymentsGetResidentsLeaseCharges_Login
    Example: clwqs19bb000008l1bbcv2bs4:na:appfee
    integration_idstringrequired

    The Propexo unique identifier for the integration

    Example: clwh5u07w000508me66sfh3um
    integration_vendorEnum24required

    The property management system of record

    Show 13 enum values
    YARDIAPPFOLIOBUILDIUMENTRATAMRIPROPERTYWAREPROPERTYWARE_RESTREALPAGEREALPAGE_RPXRENTMANAGERRENTVINERESMANYARDI_REST
    Example: YARDI
    property_idstringrequired

    The Propexo unique identifier for the property

    Example: clwi5xiix000008l6ctdgafyh
  • ]

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/recurring-resident-charges/
curl https://api.propexo.com/v1/recurring-resident-charges/ \
     -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": "91",
      "x_property_id": "kjhjhjwe",
      "x_location_id": null,
      "x_charge_code_id": "appfee",
      "x_financial_account_id": "234634644",
      "x_lease_id": "t0000001",
      "amount_in_cents": 150000,
      "amount_raw": "55.00",
      "is_active": null,
      "description": "Application fee [Lease Charge]",
      "reference_number": null,
      "start_date": "2025-07-15T00:00:00.000Z",
      "end_date": "2025-07-15T00:00:00.000Z",
      "frequency_raw": null,
      "frequency_normalized": null,
      "charge_due_day": null,
      "custom_data": "Unknown Type: object,null",
      "financial_account_id": "clwqs19bb000008l1bbcv2bs4:hjhbbwe:3267723",
      "lease_id": "clwqs19bb000008l1bbcv2bs4:efweee:t9938827",
      "charge_code_id": "clwqs19bb000008l1bbcv2bs4:na:appfee",
      "integration_id": "clwh5u07w000508me66sfh3um",
      "integration_vendor": "YARDI",
      "property_id": "clwi5xiix000008l6ctdgafyh"
    }
  ]
}