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
$curl https://api.propexo.com/v1/resident-payments \
> -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 {
13 "id": "id",
14 "created_at": "created_at",
15 "updated_at": "updated_at",
16 "x_id": "x_id",
17 "x_property_id": "x_property_id",
18 "integration_id": "integration_id",
19 "integration_vendor": "integration_vendor",
20 "property_id": "property_id",
21 "allocations": [
22 {
23 "id": "id",
24 "x_id": "x_id",
25 "amount_raw": "amount_raw",
26 "created_at": "created_at",
27 "updated_at": "updated_at"
28 }
29 ],
30 "last_seen": "last_seen",
31 "x_gl_account_id": "x_gl_account_id",
32 "x_location_id": "x_location_id",
33 "x_lease_id": "x_lease_id",
34 "x_resident_id": "x_resident_id",
35 "x_unit_id": "x_unit_id",
36 "payment_method_normalized": "payment_method_normalized",
37 "payment_method_raw": "payment_method_raw",
38 "amount_in_cents": 1.1,
39 "amount_raw": "amount_raw",
40 "name": "name",
41 "description": "description",
42 "reference_number": "reference_number",
43 "transaction_date": "transaction_date",
44 "is_open": true,
45 "resident_id": "resident_id",
46 "financial_account_id": "financial_account_id"
47 }
48 ]
49}