Get all deposits | Propexo

curl https://api.propexo.com/v1/deposits/ \
     -H "Authorization: Bearer <token>"

{
  "meta": {
    "orderBy": [
      {}
    ],
    "offset": 0,
    "limit": 100,
    "hasMore": true,
    "total": 1000
  },
  "results": [
    {
      "id": "clwktsp9v000008l31iv218hn",
      "created_at": "2024-03-21T15:38:08.337Z",
      "updated_at": "2024-03-22T10:59:45.119Z",
      "last_seen": "2024-03-22T10:59:45.119Z",
      "x_id": "t00000010-pet",
      "x_property_id": "100",
      "x_resident_id": "t00000010",
      "x_building_id": null,
      "x_deposit_type": "Pet",
      "x_lease_id": "t00000010",
      "x_location_id": null,
      "amount_charged_in_cents": 1000,
      "amount_paid_in_cents": 1000,
      "amount_refunded_in_cents": null,
      "notes": null,
      "refund_amount_due_in_cents": null,
      "custom_data": {},
      "integration_data": {},
      "integration_id": "clwh5u07w000508me66sfh3um",
      "integration_vendor": "YARDI",
      "lease_id": "testintegration:100:t00000010",
      "resident_id": "testintegration:100:t00000010",
      "property_id": "clwi5xiix000008l6ctdgafyh"
    }
  ]
}

Get all deposits

curl https://api.propexo.com/v1/deposits/ \
     -H "Authorization: Bearer <token>"

{
  "meta": {
    "orderBy": [
      {}
    ],
    "offset": 0,
    "limit": 100,
    "hasMore": true,
    "total": 1000
  },
  "results": [
    {
      "id": "clwktsp9v000008l31iv218hn",
      "created_at": "2024-03-21T15:38:08.337Z",
      "updated_at": "2024-03-22T10:59:45.119Z",
      "last_seen": "2024-03-22T10:59:45.119Z",
      "x_id": "t00000010-pet",
      "x_property_id": "100",
      "x_resident_id": "t00000010",
      "x_building_id": null,
      "x_deposit_type": "Pet",
      "x_lease_id": "t00000010",
      "x_location_id": null,
      "amount_charged_in_cents": 1000,
      "amount_paid_in_cents": 1000,
      "amount_refunded_in_cents": null,
      "notes": null,
      "refund_amount_due_in_cents": null,
      "custom_data": {},
      "integration_data": {},
      "integration_id": "clwh5u07w000508me66sfh3um",
      "integration_vendor": "YARDI",
      "lease_id": "testintegration:100:t00000010",
      "resident_id": "testintegration:100:t00000010",
      "property_id": "clwi5xiix000008l6ctdgafyh"
    }
  ]
}

Get all deposits

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

order-bystringOptionalDefaults to created_at:desc

Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc

offsetinteger or nullOptional>=0Defaults to 0

Can be used for paginating results

limitinteger or nullOptional0-250Defaults to 100

A number between 1 and 250 to determine the number of results to return in a single query

location_idstringOptional

The Propexo unique identifier for the location associated with the property (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations.

property_idstringOptional

The Propexo unique identifier for the property

resident_idstringOptional

The Propexo unique identifier for the resident

integration_idstringOptional

The Propexo unique identifier for the integration

integration_vendorenumOptional

The property management system of record

x_building_idstringOptional

The external ID of the building (not necessarily the property) from the integration vendor

x_property_idstringOptional

The external ID of the property from the integration vendor

lease_idstringOptional

The Propexo unique identifier for the lease

refund_is_dueboolean or stringOptional

Whether the refund is due for the deposit

Response

Successful response

metaobject

resultslist of objects

Errors

400

Bad Request Error

$	curl https://api.propexo.com/v1/deposits/ \
>	-H "Authorization: Bearer <token>"

1	{
2	"meta": {
3	"orderBy": [
4	{}
5	],
6	"offset": 0,
7	"limit": 100,
8	"hasMore": true,
9	"total": 1000
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	"last_seen": "2024-03-22T10:59:45.119Z",
17	"x_id": "t00000010-pet",
18	"x_property_id": "100",
19	"x_resident_id": "t00000010",
20	"x_building_id": null,
21	"x_deposit_type": "Pet",
22	"x_lease_id": "t00000010",
23	"x_location_id": null,
24	"amount_charged_in_cents": 1000,
25	"amount_paid_in_cents": 1000,
26	"amount_refunded_in_cents": null,
27	"notes": null,
28	"refund_amount_due_in_cents": null,
29	"custom_data": {},
30	"integration_data": {},
31	"integration_id": "clwh5u07w000508me66sfh3um",
32	"integration_vendor": "YARDI",
33	"lease_id": "testintegration:100:t00000010",
34	"resident_id": "testintegration:100:t00000010",
35	"property_id": "clwi5xiix000008l6ctdgafyh"
36	}
37	]
38	}