Record an owner contribution
Records money an owner has put into one of their properties. The amount is added to that property's balance and posted as a deposit.
Authorization
AuthorizationstringrequiredBody
application/json
ownerIdstringrequiredThe owner putting money in. Must belong to the caller's company and be active.
propertyIdstringrequiredThe property the money goes into.
contributionDatestring · daterequiredThe day the money was contributed.
amountnumberrequiredHow much the owner contributed, in dollars and cents. At least 1.00. Always positive — money coming into the property.
memostringA note on the contribution. At most 1000 characters.
referencestringA reference on the contribution. At most 200 characters.
paymentMethodenum<string>How the owner actually sent the money.
externalTransactionIdstringThe reference from whatever system actually moved the money. At most 100 characters.
metadataobjectFree-form key-value pairs to keep on the contribution.
Response
200 · The contribution that was recorded.
idstringThe owner contribution. A Snowflake id sent as a decimal string.
ownerIdstringThe owner who put the money in.
contributionDatestring · dateThe day the money was contributed.
totalAmountnumberHow much the owner contributed, in dollars and cents. Always positive — money coming into the property from the owner.
allocatedAmountnumberHow much of it has been matched to an accounting transaction.
dueAmountnumberWhat has not yet been matched: totalAmount less allocatedAmount.
memostringA note on the contribution. Absent when none was set.
referencestringA reference on the contribution. Absent when none was set.
lineItemsobject[]The contribution broken down by property, in display order.
filesobject[]Files attached to the record.
metadataobjectFree-form key-value pairs kept on the contribution.
createdstring · date-timeWhen the contribution was created, in the company's timezone.
updatedstring · date-timeWhen it last changed, in the company's timezone.
creatorobjectWho created the record.
ownerobjectThe owner named by ownerId, as the full owner record.
portfoliosobject[]The portfolios the lines belong to, resolved.
propertiesobject[]The properties the lines apply to, resolved.
transactionsobject[]The accounting transactions behind the allocations, resolved.
bankAccountsobject[]The bank accounts those transactions moved money through, resolved. Account and routing numbers are masked to their last four digits.
chartOfAccountsobject[]The chart of accounts the lines book to, resolved.
hydratedFilesobject[]The attachments in files, resolved to full file records with signed download URLs.
creatorInfoobjectThe person behind creator, resolved. Exactly one of propertyManager, vendor, tenant and owner is present, matching creator.type.