Billing and Payments

Get a resident charge by ID

GET
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.

Path parameters

resident_charge_idstringRequired

Query parameters

order-bystringOptional
offsetintegerOptional
limitintegerOptional

Response

This endpoint returns an object
meta
object
results
object
GET
$curl https://api.propexo.com/v1/resident-charges/resident_charge_id \
> -H "Authorization: Bearer <token>"
Response
1{
2 "meta": {
3 "orderBy": [
4 {}
5 ],
6 "offset": 1,
7 "limit": 1,
8 "hasMore": true,
9 "total": 1
10 },
11 "results": {
12 "id": "id",
13 "created_at": "created_at",
14 "updated_at": "updated_at",
15 "x_id": "x_id",
16 "x_property_id": "x_property_id",
17 "integration_id": "integration_id",
18 "integration_vendor": "integration_vendor",
19 "property_id": "property_id",
20 "allocations": [
21 {
22 "id": "id",
23 "x_id": "x_id",
24 "amount_raw": "amount_raw",
25 "created_at": "created_at",
26 "updated_at": "updated_at"
27 }
28 ],
29 "last_seen": "last_seen",
30 "x_gl_account_id": "x_gl_account_id",
31 "x_location_id": "x_location_id",
32 "x_lease_id": "x_lease_id",
33 "x_resident_id": "x_resident_id",
34 "x_unit_id": "x_unit_id",
35 "amount_in_cents": 1.1,
36 "amount_raw": "amount_raw",
37 "due_date": "due_date",
38 "name": "name",
39 "description": "description",
40 "reference_number": "reference_number",
41 "transaction_date": "transaction_date",
42 "transaction_source": "transaction_source",
43 "is_open": true,
44 "resident_id": "resident_id",
45 "financial_account_id": "financial_account_id"
46 }
47}