Skip to main content

Get a deposit summary by ID

GEThttps://api.propexo.com/v1/deposit-summaries/:deposit_summary_id

Authentication​

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

Path parameters​

deposit_summary_id stringrequired

The ID of the resource.

Query parameters​

order-by string

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

Default value: created_at:desc
updated_at_gte string | null

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

updated_at_lte string | null

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

last_seen_gte string | null

Filter to records whose last_seen date is on or after this datetime. Format: ISO 8601 (e.g. 2026-01-01T00:00:00Z)

last_seen_lte string | null

Filter to records whose last_seen date is on or before this datetime. Format: ISO 8601 (e.g. 2026-12-31T23:59:59Z)

offset integer | null

Possible values: >= 0

Can be used for paginating results

Default value: 0
limit integer | null

Possible values: >= 0 and <= 250

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

Default value: 100

Response​

Successful response

    meta objectrequired
    offsetinteger

    The offset of the first result

    Possible values: >= 0

    Example: 0
    limitinteger

    The number of results to return

    Possible values: >= 0 and <= 250

    Example: 100
    orderBy object[]required

    The order of the results

  • Array [
    • object
  • ]
    • hasMoreboolean | nullnullable

    Whether there are more results

    totalinteger

    The total number of results

    Possible values: >= 0

    Example: 1000
    results objectrequired
    idstringrequired

    The Propexo unique identifier for the deposit summary

    Example: clwktsp9v000008l31iv218hn
    created_atstringrequired

    The date record first entered Propexo

    Example: 2024-03-21T15:38:08.337Z
    updated_atstringrequired

    The date record was last updated in Propexo

    Example: 2024-03-22T10:59:45.119Z
    last_seenstring | nullnullablerequired

    The date the record was last seen from the PMS

    Example: 2024-03-22T10:59:45.119Z
    x_idstringrequired

    The external ID from the integration vendor

    Method
    /mriapiservices/api.asp?$api=MRI_S-PMRM_SODAWithApplicantLedger
    Example: 0000008618
    x_property_idstringrequired

    The external ID of the property from the integration vendor

    Method
    /mriapiservices/api.asp?$api=MRI_S-PMRM_SODAWithApplicantLedger
    Example: 100
    x_resident_idstringrequired

    The external ID of the resident from the integration vendor

    Method
    /mriapiservices/api.asp?$api=MRI_S-PMRM_SODAWithApplicantLedger
    Example: 0000008618
    x_building_idstring | nullnullablerequired

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

    Method
    /mriapiservices/api.asp?$api=MRI_S-PMRM_SODAWithApplicantLedger
    Example: 300
    x_invoice_idstring | nullnullablerequired

    The external ID of the invoice from the integration vendor

    Method
    /mriapiservices/api.asp?$api=MRI_S-PMRM_SODAWithApplicantLedger
    Example: cb4y7ht1h64902650881w8135e1gm62n
    x_lease_idstring | nullnullablerequired

    The external ID of the lease from the integration vendor

    Method
    /mriapiservices/api.asp?$api=MRI_S-PMRM_SODAWithApplicantLedger
    Example: 0000008618
    x_location_idnullrequired

    The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations.

    Notice

    This field will always be null for MRI

    Example: null
    x_unit_idstring | nullnullablerequired

    The external ID of the unit from the integration vendor

    Method
    /mriapiservices/api.asp?$api=MRI_S-PMRM_SODAWithApplicantLedger
    Example: 0000008618
    amount_charged_in_centsnullrequired

    The amount charged in cents

    Notice

    This field will always be null for MRI

    Example: null
    amount_paid_in_centsnullrequired

    The amount paid in cents

    Notice

    This field will always be null for MRI

    Example: null
    amount_refunded_in_centsnullrequired

    The amount refunded in cents

    Notice

    This field will always be null for MRI

    Example: null
    notesnullrequired

    Notes associated with the deposit summary

    Notice

    This field will always be null for MRI

    Example: null
    refund_amount_due_in_centsnumber | nullnullablerequired

    The refund amount due in cents

    Important

    Note: This field is currently in BETA and should only be used for testing.

    Method
    /mriapiservices/api.asp?$api=MRI_S-PMRM_SODAWithApplicantLedger
    Example: 1000
    custom_data object | nullrequired
    object
    integration_data object | nullrequired
    object
    integration_idstringrequired

    The Propexo unique identifier for the integration

    Example: clwh5u07w000508me66sfh3um
    integration_vendorEnum16required

    The property management system of record

    Show 13 enum values
    MRIAPPFOLIOBUILDIUMENTRATAPROPERTYWAREPROPERTYWARE_RESTREALPAGEREALPAGE_RPXRENTMANAGERRENTVINERESMANYARDIYARDI_REST
    Example: MRI
    invoice_idstring | nullnullablerequired

    The Propexo unique identifier for the invoice

    Method
    /mriapiservices/api.asp?$api=MRI_S-PMRM_SODAWithApplicantLedger
    Example: cb4y7ht1h64902650881w8135e1gm62n
    lease_idstring | nullnullablerequired

    The Propexo unique identifier for the lease

    Important

    Note: This field is currently in BETA and should only be used for testing.

    Method
    /mriapiservices/api.asp?$api=MRI_S-PMRM_SODAWithApplicantLedger
    Example: cm0y7ht1h64902650881w8135e1gm97m
    unit_idstring | nullnullablerequired

    The Propexo unique identifier for the unit

    Method
    /mriapiservices/api.asp?$api=MRI_S-PMRM_SODAWithApplicantLedger
    Example: cm0y7ht1h64902650881w8135e1gmc12u
    resident_idstringrequired

    The Propexo unique identifier for the resident

    Important

    Note: This field is currently in BETA and should only be used for testing.

    Method
    /mriapiservices/api.asp?$api=MRI_S-PMRM_SODAWithApplicantLedger
    Example: cm0y7ht1h64902650331vw7uaq1fhs24i
    property_idstringrequired

    The Propexo unique identifier for the property

    Example: clwi5xiix000008l6ctdgafyh

Errors​

  • 400Bad Request
      error objectrequired
      codestringrequired
      Example: invalid_request
      messagestringrequired
      Example: invalid request
      details object
      property name*any
      Example: {"details":{"issues":[{"code":"unrecognized_keys","keys":["foo"],"path":[],"message":"Unrecognized key(s) in object: 'foo'"}],"name":"ZodError"}}
GET /v1/deposit-summaries/:deposit_summary_id
curl https://api.propexo.com/v1/deposit-summaries/:deposit_summary_id \
     -H "Authorization: Bearer <token>"
200 Successful response
{
  "meta": {
    "offset": 0,
    "limit": 100,
    "orderBy": [
      {}
    ],
    "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": "0000008618",
    "x_property_id": "100",
    "x_resident_id": "0000008618",
    "x_building_id": "300",
    "x_invoice_id": "cb4y7ht1h64902650881w8135e1gm62n",
    "x_lease_id": "0000008618",
    "x_location_id": null,
    "x_unit_id": "0000008618",
    "amount_charged_in_cents": null,
    "amount_paid_in_cents": null,
    "amount_refunded_in_cents": null,
    "notes": null,
    "refund_amount_due_in_cents": 1000,
    "custom_data": "Unknown Type: object,null",
    "integration_data": "Unknown Type: object,null",
    "integration_id": "clwh5u07w000508me66sfh3um",
    "integration_vendor": "MRI",
    "invoice_id": "cb4y7ht1h64902650881w8135e1gm62n",
    "lease_id": "cm0y7ht1h64902650881w8135e1gm97m",
    "unit_id": "cm0y7ht1h64902650881w8135e1gmc12u",
    "resident_id": "cm0y7ht1h64902650331vw7uaq1fhs24i",
    "property_id": "clwi5xiix000008l6ctdgafyh"
  }
}