Get a resident charge by ID

GET

/v1/resident-charges/:resident_charge_id

GET

/v1/resident-charges/:resident_charge_id

$ curl https://api.propexo.com/v1/resident-charges/resident_charge_id \
>      -H "Authorization: Bearer <token>"

1 {
2   "meta": {
3     "orderBy": [
4       {}
5     ],
6     "offset": 0,
7     "limit": 100,
8     "hasMore": true,
9     "total": 1000
10   },
11   "results": {
12     "allocations": [
13       {
14         "id": "clwktsp9v000008l31iv218hn",
15         "x_id": "string",
16         "x_source_id": "string",
17         "x_destination_id": "string",
18         "financial_account_id": "string",
19         "amount_in_cents": 325000,
20         "amount_raw": "string",
21         "resident_charge_id": "string",
22         "resident_payment_id": "string",
23         "created_at": "2024-03-21T15:38:08.337Z",
24         "updated_at": "2024-03-22T10:59:45.119Z",
25         "last_seen": "2024-03-22T10:59:45.119Z",
26         "custom_data": {}
27       }
28     ],
29     "amount_in_cents": 5500,
30     "amount_open_in_cents": null,
31     "amount_open_raw": null,
32     "amount_paid_in_cents": 5500,
33     "amount_paid_raw": "55.00",
34     "amount_raw": "55.00",
35     "charge_code_id": "cm7j8pg9833257334651idtqhw61p5zy",
36     "created_at": "2024-03-21T15:38:08.337Z",
37     "custom_data": {},
38     "description": "Application fee [Open Charge]",
39     "due_date": null,
40     "financial_account_id": "clwqs19bb000008l1bbcv2bs4",
41     "id": "clwktsp9v000008l31iv218hn",
42     "integration_id": "clwh5u07w000508me66sfh3um",
43     "integration_vendor": "YARDI_REST",
44     "is_open": null,
45     "last_seen": "2024-03-22T10:59:45.119Z",
46     "lease_id": null,
47     "name": "Application Fee",
48     "post_month": "2021-04",
49     "property_id": "clwi5xiix000008l6ctdgafyh",
50     "reference_number": "20240023944",
51     "resident_id": "clwqs19bb000008l1bbcv2bs4",
52     "transaction_date": "2021-04-06T00:00:00.000Z",
53     "transaction_source": "RESIDENT",
54     "unit_id": "cmhavc6z669743697761kvjgrutkpgq9",
55     "updated_at": "2024-03-22T10:59:45.119Z",
56     "x_charge_code_id": "rent",
57     "x_gl_account_id": "234634644",
58     "x_id": "72293948",
59     "x_lease_id": null,
60     "x_location_id": null,
61     "x_property_id": "kjhjhjwe",
62     "x_resident_id": "t0093884",
63     "x_unit_id": "312441"
64   }
65 }

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.

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_idstringRequired

The ID of the resource.

Query parameters

order-bystringOptionalDefaults to created_at:desc

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 or nullOptional

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

updated_at_ltestring or nullOptional

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

last_seen_gtestring or nullOptional

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 or nullOptional

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

offsetinteger or nullOptional>=0Defaults to 0

Can be used for paginating results

limitinteger or nullOptional0-250Defaults to 100

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

Response

Successful response

metaobject

resultsobject

Errors

400

Bad Request Error