Billing and Payments

Get all resident payments

GET

The Resident Payments 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 payments that the resident has made.

Query parameters

order-bystringOptional

offsetintegerOptional

limitintegerOptional

property_idstringOptional

integration_idstringOptional

integration_vendorenumOptional

The property management system of record

transaction_date_startstringOptional

transaction_date_endstringOptional

Response

This endpoint returns an object

meta

object

results

list of objects

GET

1 curl https://api.propexo.com/v1/resident-payments \
2      -H "Authorization: Bearer <token>"

200Retrieved

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       "payment_method_normalized": "sample_value",
36       "payment_method_raw": "sample_value",
37       "amount_in_cents": 325000,
38       "amount_raw": "sample_value",
39       "name": "sample_value",
40       "description": "sample_value",
41       "reference_number": "sample_value",
42       "transaction_date": "sample_value",
43       "is_open": true,
44       "resident_id": "sample_value",
45       "financial_account_id": "sample_value"
46     }
47   ]
48 }

Built with

1	curl https://api.propexo.com/v1/resident-payments \
2	-H "Authorization: Bearer <token>"

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	"payment_method_normalized": "sample_value",
36	"payment_method_raw": "sample_value",
37	"amount_in_cents": 325000,
38	"amount_raw": "sample_value",
39	"name": "sample_value",
40	"description": "sample_value",
41	"reference_number": "sample_value",
42	"transaction_date": "sample_value",
43	"is_open": true,
44	"resident_id": "sample_value",
45	"financial_account_id": "sample_value"
46	}
47	]
48	}