Get all resident charges — Propexo

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.

Query parameters

order-bystringOptional

offsetintegerOptional

limitintegerOptional

property_idstringOptional

integration_idstringOptional

integration_vendorenumOptional

The property management system of record

transaction_date_startunionRequired

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

transaction_date_endunionRequired

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

Response

This endpoint returns an object

meta

object

results

list of objects

1 curl -G https://api.propexo.com/v1/resident-charges \ 2 -H "Authorization: Bearer <token>" \ 3 --data-urlencode transaction_date_start=2024-01-15T09:30:00Z \ 4 --data-urlencode transaction_date_end=2024-01-15T09:30:00Z

1 { 2 "meta": { 3 "orderBy": [ 4 {} 5 ], 6 "offset": 1, 7 "limit": 1, 8 "hasMore": true, 9 "total": 1 10 }, 11 "results": [ 12 { 13 "id": "clwktsp9v000008l31iv218hn", 14 "created_at": "2024-03-21T15:38:08.337Z", 15 "updated_at": "2024-03-22T10:59:45.119Z", 16 "x_id": "sample_value", 17 "x_property_id": "sample_value", 18 "integration_id": "clwh5u07w000508me66sfh3um", 19 "integration_vendor": "BUILDIUM", 20 "property_id": "clwi5xiix000008l6ctdgafyh", 21 "allocations": [ 22 { 23 "id": "id", 24 "x_id": "x_id", 25 "created_at": "created_at", 26 "updated_at": "updated_at" 27 } 28 ], 29 "last_seen": "2024-03-22T10:59:45.119Z", 30 "x_gl_account_id": "sample_value", 31 "x_location_id": "null", 32 "x_lease_id": "sample_value", 33 "x_resident_id": "sample_value", 34 "x_unit_id": "sample_value", 35 "amount_in_cents": 325000, 36 "amount_raw": "sample_value", 37 "due_date": "due_date", 38 "name": "sample_value", 39 "description": "sample_value", 40 "reference_number": "sample_value", 41 "transaction_date": "sample_value", 42 "transaction_source": "null", 43 "is_open": true, 44 "resident_id": "sample_value", 45 "financial_account_id": "sample_value" 46 } 47 ] 48 }

1	curl -G https://api.propexo.com/v1/resident-charges \
2	-H "Authorization: Bearer <token>" \
3	--data-urlencode transaction_date_start=2024-01-15T09:30:00Z \
4	--data-urlencode transaction_date_end=2024-01-15T09:30:00Z

1	{
2	"meta": {
3	"orderBy": [
4	{}
5	],
6	"offset": 1,
7	"limit": 1,
8	"hasMore": true,
9	"total": 1
10	},
11	"results": [
12	{
13	"id": "clwktsp9v000008l31iv218hn",
14	"created_at": "2024-03-21T15:38:08.337Z",
15	"updated_at": "2024-03-22T10:59:45.119Z",
16	"x_id": "sample_value",
17	"x_property_id": "sample_value",
18	"integration_id": "clwh5u07w000508me66sfh3um",
19	"integration_vendor": "BUILDIUM",
20	"property_id": "clwi5xiix000008l6ctdgafyh",
21	"allocations": [
22	{
23	"id": "id",
24	"x_id": "x_id",
25	"created_at": "created_at",
26	"updated_at": "updated_at"
27	}
28	],
29	"last_seen": "2024-03-22T10:59:45.119Z",
30	"x_gl_account_id": "sample_value",
31	"x_location_id": "null",
32	"x_lease_id": "sample_value",
33	"x_resident_id": "sample_value",
34	"x_unit_id": "sample_value",
35	"amount_in_cents": 325000,
36	"amount_raw": "sample_value",
37	"due_date": "due_date",
38	"name": "sample_value",
39	"description": "sample_value",
40	"reference_number": "sample_value",
41	"transaction_date": "sample_value",
42	"transaction_source": "null",
43	"is_open": true,
44	"resident_id": "sample_value",
45	"financial_account_id": "sample_value"
46	}
47	]
48	}