Get a resident charge by ID

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

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. Credits to a resident's ledger are stored as negative charges. 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_charge_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 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
Interface	Method
Lease Transactions	GET /leases/:leaseId/transactions
Example: cl9b1nqwe0020jsxq8ab1c2aq
x_property_idstringrequired
The external ID of the property from the integration vendor
Interface	Method
Lease Transactions	GET /leases/:leaseId/transactions
Example: cl9b1nqwe0001jsxq8ab1c2aa
x_gl_account_idstring | nullnullablerequired
The external ID of the general ledger account from the integration vendor
Interface	Method
Lease Transactions	GET /leases/:leaseId/transactions
Example: cl9b1nqwe0010jsxq8ab1c2aj
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 BUILDIUM
Example: null
x_lease_idstring | nullnullablerequired
The external ID of the lease from the integration vendor
Interface	Method
Lease Transactions	GET /leases/:leaseId/transactions
Example: cl9b1nqwe0006jsxq8ab1c2af
x_resident_idstring | nullnullablerequired
The external ID of the resident from the integration vendor
Interface	Method
Lease Transactions	GET /leases/:leaseId/transactions
Example: cl9b1nqwe0005jsxq8ab1c2ae
x_unit_idstring | nullnullablerequired
The external ID of the unit from the integration vendor
Interface	Method
Lease Transactions	GET /leases/:leaseId/transactions
Example: cl9b1nqwe0002jsxq8ab1c2ab
x_charge_code_idnullrequired
The external ID of the charge code from the integration vendor
Notice
This field will always be null for BUILDIUM
Example: null
amount_in_centsnumber | nullnullablerequired
The amount of the resident charge, in cents
Interface	Method
Lease Transactions	GET /leases/:leaseId/transactions
Example: 150000
amount_rawstring | nullnullablerequired
The raw value for amount from the PMS
Interface	Method
Lease Transactions	GET /leases/:leaseId/transactions
Example: 1500.00
amount_open_in_centsnullrequired
The amount open on the resident charge, in cents
Notice
This field will always be null for BUILDIUM
Example: null
amount_open_rawnullrequired
The raw value for open amount from the PMS
Notice
This field will always be null for BUILDIUM
Example: null
amount_paid_in_centsnullrequired
The amount paid on the resident charge, in cents
Notice
This field will always be null for BUILDIUM
Example: null
amount_paid_rawnullrequired
The raw value for amount paid from the PMS
Notice
This field will always be null for BUILDIUM
Example: null
due_datenullrequired
The due date associated with the resident charge
Notice
This field will always be null for BUILDIUM
Example: null
namestring | nullnullablerequired
The name associated with the resident charge
Interface	Method
Lease Transactions	GET /leases/:leaseId/transactions
Example: Charge
descriptionstring | nullnullablerequired
Description of the resident charge
Interface	Method
Lease Transactions	GET /leases/:leaseId/transactions
Example: October rent
reference_numberstring | nullnullablerequired
The reference number for the resident charge
Interface	Method
Lease Transactions	GET /leases/:leaseId/transactions
Example: 10482
transaction_datestring | nullnullablerequired
The transaction date of the resident charge
Interface	Method
Lease Transactions	GET /leases/:leaseId/transactions
Example: 2024-10-01T00:00:00.000Z
transaction_sourcenullrequired
The transaction source of the resident charge
Notice
This field will always be null for BUILDIUM
Example: null
is_opennullrequired
Whether the resident charge is open and not yet settled
Notice
This field will always be null for BUILDIUM
Example: null
post_monthnullrequired
The post month for the resident charge
Notice
This field will always be null for BUILDIUM
Example: null
custom_dataobject | nullnullablerequired
integration_idstringrequired
The Propexo unique identifier for the integration
Example: clwh5u07w000508me66sfh3um
integration_vendorEnum14required
The property management system of record
Show 13 enum values
APPFOLIOBUILDIUMENTRATAMRIPROPERTYWAREPROPERTYWARE_RESTREALPAGEREALPAGE_RPXRENTMANAGERRENTVINERESMANYARDIYARDI_REST
Example: BUILDIUM
property_idstringrequired
The Propexo unique identifier for the property
Example: clwi5xiix000008l6ctdgafyh
resident_idstring | nullnullablerequired
The Propexo unique identifier for the resident
Interface	Method
Lease Transactions	GET /leases/:leaseId/transactions
Example: cl9b1nqwe0005jsxq8ab1c2ae
financial_account_idstring | nullnullablerequired
The Propexo unique identifier for the financial account
Interface	Method
Lease Transactions	GET /leases/:leaseId/transactions
Example: cl9b1nqwe0018jsxq8ab1c2at
unit_idstring | nullnullablerequired
The Propexo unique identifier for the unit
Interface	Method
Lease Transactions	GET /leases/:leaseId/transactions
Example: cmoeilj0i000004kz8v7k5qxu
lease_idstring | nullnullablerequired
The Propexo unique identifier for the lease
Interface	Method
Lease Transactions	GET /leases/:leaseId/transactions
Example: cmoeilj0i000004kz8v7k5qxu
charge_code_idnullrequired
The Propexo unique identifier for the charge code
Notice
This field will always be null for BUILDIUM
Example: null
allocations object[]required
Array of payment allocations, splits, and related transactions associated with the resident charge
Array [
idstringrequired
The Propexo unique identifier for the resident allocation
Example: clwktsp9v000008l31iv218hn
x_idstringrequired
The external ID from the integration vendor
x_source_idstring | nullnullablerequired
The external ID of the source transaction from the integration vendor
Notice
This field is not currently hydrated for BUILDIUM
x_destination_idstring | nullnullablerequired
The external ID of the destination transaction from the integration vendor
Notice
This field is not currently hydrated for BUILDIUM
financial_account_idstring | nullnullablerequired
The Propexo unique identifier for the financial account
Notice
This field is not currently hydrated for BUILDIUM
amount_in_centsnumber | nullnullablerequired
The amount of the resident allocation, in cents
Notice
This field is not currently hydrated for BUILDIUM
Example: 325000
amount_rawstring | nullnullablerequired
The raw value for amount from the PMS
Notice
This field is not currently hydrated for BUILDIUM
resident_charge_idstring | nullnullablerequired
The Propexo unique identifier for the resident charge
resident_payment_idstring | nullnullablerequired
The Propexo unique identifier for the resident payment
Notice
This field is not currently hydrated for BUILDIUM
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_dataobject | nullnullablerequired
]

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-charges/:resident_charge_id

curl https://api.propexo.com/v1/resident-charges/:resident_charge_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": "cl9b1nqwe0020jsxq8ab1c2aq",
    "x_property_id": "cl9b1nqwe0001jsxq8ab1c2aa",
    "x_gl_account_id": "cl9b1nqwe0010jsxq8ab1c2aj",
    "x_location_id": null,
    "x_lease_id": "cl9b1nqwe0006jsxq8ab1c2af",
    "x_resident_id": "cl9b1nqwe0005jsxq8ab1c2ae",
    "x_unit_id": "cl9b1nqwe0002jsxq8ab1c2ab",
    "x_charge_code_id": null,
    "amount_in_cents": 150000,
    "amount_raw": "1500.00",
    "amount_open_in_cents": null,
    "amount_open_raw": null,
    "amount_paid_in_cents": null,
    "amount_paid_raw": null,
    "due_date": null,
    "name": "Charge",
    "description": "October rent",
    "reference_number": "10482",
    "transaction_date": "2024-10-01T00:00:00.000Z",
    "transaction_source": null,
    "is_open": null,
    "post_month": null,
    "custom_data": "Unknown Type: object,null",
    "integration_id": "clwh5u07w000508me66sfh3um",
    "integration_vendor": "BUILDIUM",
    "property_id": "clwi5xiix000008l6ctdgafyh",
    "resident_id": "cl9b1nqwe0005jsxq8ab1c2ae",
    "financial_account_id": "cl9b1nqwe0018jsxq8ab1c2at",
    "unit_id": "cmoeilj0i000004kz8v7k5qxu",
    "lease_id": "cmoeilj0i000004kz8v7k5qxu",
    "charge_code_id": null,
    "allocations": [
      {
        "id": "clwktsp9v000008l31iv218hn",
        "x_id": "string",
        "x_source_id": "string",
        "x_destination_id": "string",
        "financial_account_id": "string",
        "amount_in_cents": 325000,
        "amount_raw": "string",
        "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"
      }
    ]
  }
}