API ReferenceDeposit Summaries

Get all deposit summaries

Beta
Get all deposit summaries

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 integration vendor associated with the data diff
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
invoice_idstringOptional
The Propexo unique identifier for the invoice
refund_is_dueboolean or stringOptional
Whether the refund is due for the deposit summary
invoice_id_not_nullboolean or stringOptional

Filter to only return deposit summaries where the invoice_id is not null

Response

Successful response
metaobject
resultslist of objects

Errors