Billing and Payments

Get a resident payment by ID

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.

Path parameters

resident_payment_idstringRequired

Query parameters

order-bystringOptional

offsetintegerOptional

limitintegerOptional

Response

This endpoint returns an object

meta

object

results

object

GET

1 curl https://api.propexo.com/v1/resident-payments/resident_payment_id \
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     "id": "clwktsp9v000008l31iv218hn",
13     "created_at": "2024-03-21T15:38:08.337Z",
14     "updated_at": "2024-03-22T10:59:45.119Z",
15     "x_id": "sample_value",
16     "x_property_id": "sample_value",
17     "integration_id": "clwh5u07w000508me66sfh3um",
18     "integration_vendor": "BUILDIUM",
19     "property_id": "clwi5xiix000008l6ctdgafyh",
20     "allocations": [
21       {
22         "id": "id",
23         "x_id": "x_id",
24         "created_at": "created_at",
25         "updated_at": "updated_at"
26       }
27     ],
28     "last_seen": "2024-03-22T10:59:45.119Z",
29     "x_gl_account_id": "sample_value",
30     "x_location_id": "null",
31     "x_lease_id": "sample_value",
32     "x_resident_id": "sample_value",
33     "x_unit_id": "sample_value",
34     "payment_method_normalized": "sample_value",
35     "payment_method_raw": "sample_value",
36     "amount_in_cents": 325000,
37     "amount_raw": "sample_value",
38     "name": "sample_value",
39     "description": "sample_value",
40     "reference_number": "sample_value",
41     "transaction_date": "sample_value",
42     "is_open": true,
43     "resident_id": "sample_value",
44     "financial_account_id": "sample_value"
45   }
46 }

Built with

1	curl https://api.propexo.com/v1/resident-payments/resident_payment_id \
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	"id": "clwktsp9v000008l31iv218hn",
13	"created_at": "2024-03-21T15:38:08.337Z",
14	"updated_at": "2024-03-22T10:59:45.119Z",
15	"x_id": "sample_value",
16	"x_property_id": "sample_value",
17	"integration_id": "clwh5u07w000508me66sfh3um",
18	"integration_vendor": "BUILDIUM",
19	"property_id": "clwi5xiix000008l6ctdgafyh",
20	"allocations": [
21	{
22	"id": "id",
23	"x_id": "x_id",
24	"created_at": "created_at",
25	"updated_at": "updated_at"
26	}
27	],
28	"last_seen": "2024-03-22T10:59:45.119Z",
29	"x_gl_account_id": "sample_value",
30	"x_location_id": "null",
31	"x_lease_id": "sample_value",
32	"x_resident_id": "sample_value",
33	"x_unit_id": "sample_value",
34	"payment_method_normalized": "sample_value",
35	"payment_method_raw": "sample_value",
36	"amount_in_cents": 325000,
37	"amount_raw": "sample_value",
38	"name": "sample_value",
39	"description": "sample_value",
40	"reference_number": "sample_value",
41	"transaction_date": "sample_value",
42	"is_open": true,
43	"resident_id": "sample_value",
44	"financial_account_id": "sample_value"
45	}
46	}