Get a deposit summary by ID | Propexo

curl https://api.propexo.com/v1/deposit-summaries/deposit_summary_id \
     -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": "t0013642",
    "x_property_id": "propexo1",
    "x_resident_id": "t0013642",
    "x_building_id": null,
    "x_invoice_id": "300342655",
    "x_lease_id": "t0172032",
    "x_location_id": null,
    "x_unit_id": null,
    "amount_charged_in_cents": 100000,
    "amount_paid_in_cents": 100000,
    "amount_refunded_in_cents": null,
    "notes": "Move out refund",
    "refund_amount_due_in_cents": 51500,
    "custom_data": {},
    "integration_data": {},
    "integration_id": "clwh5u07w000508me66sfh3um",
    "integration_vendor": "YARDI_REST",
    "invoice_id": "cm7j8pg9833257334651idtqhw61p5zy",
    "lease_id": "cm2dtyq1600008loze5xgf3fb",
    "unit_id": null,
    "resident_id": "cmhavc6z669743697761kvjgrutkpgq9",
    "property_id": "clwi5xiix000008l6ctdgafyh"
  }
}

Get a deposit summary by ID

curl https://api.propexo.com/v1/deposit-summaries/deposit_summary_id \
     -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": "t0013642",
    "x_property_id": "propexo1",
    "x_resident_id": "t0013642",
    "x_building_id": null,
    "x_invoice_id": "300342655",
    "x_lease_id": "t0172032",
    "x_location_id": null,
    "x_unit_id": null,
    "amount_charged_in_cents": 100000,
    "amount_paid_in_cents": 100000,
    "amount_refunded_in_cents": null,
    "notes": "Move out refund",
    "refund_amount_due_in_cents": 51500,
    "custom_data": {},
    "integration_data": {},
    "integration_id": "clwh5u07w000508me66sfh3um",
    "integration_vendor": "YARDI_REST",
    "invoice_id": "cm7j8pg9833257334651idtqhw61p5zy",
    "lease_id": "cm2dtyq1600008loze5xgf3fb",
    "unit_id": null,
    "resident_id": "cmhavc6z669743697761kvjgrutkpgq9",
    "property_id": "clwi5xiix000008l6ctdgafyh"
  }
}

Get a deposit summary by ID

Authentication

AuthorizationBearer

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

Path parameters

deposit_summary_idstringRequired

The ID of the resource.

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

updated_at_gtestring or nullOptional

Filter to records updated at or after this datetime. Format: ISO 8601 (e.g. 2026-01-01T00:00:00Z)

updated_at_ltestring or nullOptional

Filter to records updated at or before this datetime. Format: ISO 8601 (e.g. 2026-12-31T23:59:59Z)

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

Response

Successful response

metaobject

resultsobject

Errors

400

Bad Request Error

$	curl https://api.propexo.com/v1/deposit-summaries/deposit_summary_id \
>	-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	"id": "clwktsp9v000008l31iv218hn",
13	"created_at": "2024-03-21T15:38:08.337Z",
14	"updated_at": "2024-03-22T10:59:45.119Z",
15	"last_seen": "2024-03-22T10:59:45.119Z",
16	"x_id": "t0013642",
17	"x_property_id": "propexo1",
18	"x_resident_id": "t0013642",
19	"x_building_id": null,
20	"x_invoice_id": "300342655",
21	"x_lease_id": "t0172032",
22	"x_location_id": null,
23	"x_unit_id": null,
24	"amount_charged_in_cents": 100000,
25	"amount_paid_in_cents": 100000,
26	"amount_refunded_in_cents": null,
27	"notes": "Move out refund",
28	"refund_amount_due_in_cents": 51500,
29	"custom_data": {},
30	"integration_data": {},
31	"integration_id": "clwh5u07w000508me66sfh3um",
32	"integration_vendor": "YARDI_REST",
33	"invoice_id": "cm7j8pg9833257334651idtqhw61p5zy",
34	"lease_id": "cm2dtyq1600008loze5xgf3fb",
35	"unit_id": null,
36	"resident_id": "cmhavc6z669743697761kvjgrutkpgq9",
37	"property_id": "clwi5xiix000008l6ctdgafyh"
38	}
39	}