Get a deposit
Fetches one deposit with its line items, what has been paid against each of them, and the accounts and transactions those payments refer to.
Authorization
AuthorizationstringrequiredPath parameters
leaseIdstringrequiredThe lease the deposit is on. A Snowflake id, sent as a decimal string.
depositIdstringrequiredThe deposit to fetch. A Snowflake id, sent as a decimal string.
Response
200 · The deposit.
idstringId of the deposit. A Snowflake id, sent as a decimal string.
createdstring · date-timeWhen the deposit was created, in the company's timezone.
updatedstring · date-timeWhen it last changed.
billDatestring · dateThe date the deposit is booked into the ledger.
dueDatestring · dateThe date the tenant has to pay it by.
totalAmountnumberHow much deposit was asked for, as a decimal amount.
allocatedAmountnumberHow much has been paid towards it.
dueAmountnumberHow much is still outstanding.
memostringFree-text note on the deposit.
referencestringExternal reference carried on the deposit.
portfolioIdstringPortfolio the deposit rolls up to. A Snowflake id, sent as a decimal string.
propertyIdstringProperty the deposit is on. A Snowflake id, sent as a decimal string.
unitIdstringUnit the deposit is on. A Snowflake id, sent as a decimal string.
leaseIdstringLease the deposit is on. A Snowflake id, sent as a decimal string.
refundablebooleanWhether this deposit is refundable to the tenant.
lineItemsLeaseDepositLineItem[]What the deposit is made up of.
filesLeaseDepositFile[]Files attached to the deposit, by id.
metadataobjectFree-form key/value data carried on the deposit.
creatorobjectWho created the record.
portfolioobjectThe portfolio the lease rolls up to.
propertyobjectThe property the lease's unit sits in.
unitobjectThe unit the lease is for.
leaseobjectThe lease the deposit is on.
transactionsTransaction[]The transactions referenced by the allocations above.
bankAccountsBankAccount[]Bank accounts referenced above.
chartOfAccountsChartOfAccount[]Chart-of-account records referenced above.
hydratedFilesFile[]The files listed in files, resolved to full file records.
creatorInfoobjectThe full record of whoever created this, under whichever one key matches the creator's type.