Update an owner distribution
Changes a distribution's date or memo. Nothing else can be changed here, and at least one of the two must be sent. The date may not be in the future.
Authorization
AuthorizationstringrequiredPath parameters
ownerDistributionIdstringrequiredThe owner distribution. A Snowflake id sent as a decimal string.
Body
application/json
Send at least one of the two properties.
distributionDatestring · dateThe day the money was distributed. Must be today or earlier — a future date is rejected.
memostringA note on the distribution. At most 1000 characters.
Response
200 · The updated distribution.
idstringThe owner distribution. A Snowflake id sent as a decimal string.
ownerIdstringThe owner the money goes to.
distributionDatestring · dateThe day the money was distributed.
totalAmountnumberHow much is being distributed, in dollars and cents. Always positive — money going out of the property and to 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 distribution. Absent when none was set.
referencestringA reference on the distribution. Absent when none was set.
isOwnerRequestedbooleantrue when the owner asked for the money rather than the manager initiating it.
leaseSubsidyIdstringThe lease subsidy this distribution passes through, when it comes from one. Absent otherwise.
lineItemsobject[]The distribution broken down by property, in display order.
filesobject[]Files attached to the record.
metadataobjectFree-form key-value pairs kept on the distribution.
createdstring · date-timeWhen the distribution 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.