Update an owner transfer
Changes an owner transfer's amount, date, properties, memo, reference or payment details. Properties left out are unchanged. Changing fromPropertyId or toPropertyId changes which way the money goes.
Authorization
AuthorizationstringrequiredPath parameters
ownerTransferIdstringrequiredThe owner transfer. A Snowflake id sent as a decimal string.
Body
application/json
Only the properties you send are changed.
amountnumberHow much moves, in dollars and cents. At least 1.00.
transferDatestring · date-timeThe moment to date the transfer, read in the company's timezone.
fromPropertyIdstringThe property the money leaves.
toPropertyIdstringThe property the money arrives at.
memostringA note on the transfer. At most 1000 characters.
referencestringA reference on the transfer. At most 200 characters.
paymentMethodenum<string>How the money actually moved.
externalTransactionIdstringThe reference from whatever system actually moved the money. At most 100 characters.
metadataobjectFree-form key-value pairs to keep on the transfer.
Response
200 · The updated transfer.
idstringThe owner transfer. A Snowflake id sent as a decimal string.
ownerIdstringThe owner whose money is being moved. Both properties must be theirs.
transferDatestring · dateThe day the money moved.
amountnumberHow much moved, in dollars and cents. Always positive: it leaves the source property and arrives at the destination property.
sourceobjectThe source side of the transfer — where the money leaves.
destinationobjectThe destination side of the transfer — where the money arrives.
memostringA note on the transfer. Absent when none was set.
referencestringA reference on the transfer. Absent when none was set.
filesobject[]Files attached to the record.
metadataobjectFree-form key-value pairs kept on the transfer.
createdstring · date-timeWhen the transfer 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.