Get a bank ledger transfer
Fetches one bank ledger transfer, with each bank leg read back from its underlying transaction. Requires the bank_ledger_transfers:read permission.
Authorization
AuthorizationstringrequiredPath parameters
bankLedgerTransferIdstringrequiredSnowflake id of the bank ledger transfer.
Response
200 · The bank ledger transfer.
idstringSnowflake id of the transfer.
createdstring · date-timeWhen the transfer was recorded, in the company's timezone.
updatedstring · date-timeWhen the transfer was last adjusted, in the company's timezone.
transferDatestring · date-timeThe date the money moved, in the company's timezone. This is the transaction date on the underlying entries.
transferTypeenum<string>What kind of movement this is: bankToBank between two of the company's bank accounts, bankDeposit into one bank account from a non-bank account, bankWithdrawal out of one bank account to a non-bank account. Fixed at creation — an adjustment cannot change it.
amountnumberHow much moved, as a positive decimal. The direction is carried by transferType, never by the sign.
propertyIdstringThe property the movement is attributed to. Absent when it is not attributed to one.
paymentMethodenum<string>How the money moved, read back from the underlying transactions. Absent when the transfer has no linked transactions.
outTransactionIdstringThe out transaction that credits the outgoing bank account's cash. Absent on a bankDeposit.
inTransactionIdstringThe in transaction that debits the incoming bank account's cash. Absent on a bankWithdrawal.
outgoingobjectWhere the money left from, read back from the out transaction. Absent on a bankDeposit.
incomingobjectWhere the money landed, read back from the in transaction. Absent on a bankWithdrawal.
offsetAccountobjectThe non-bank side of a one-legged transfer: what the deposit came from, or what the withdrawal was spent on. Absent on a bankToBank.
memostringFree-text note. Absent when none was set.
referencestringYour own reference, for example a wire confirmation number. Absent when none was set.
metadataobjectArbitrary string-to-string map stored with the transfer. An empty object when nothing was stored.
creatorobjectWho recorded the transfer. Deprecated mirrors of id — propertyManagerId, tenantId, vendorId, ownerId — are also present, whichever matches type.
deletedstring · date-timeWhen the transfer was soft-deleted. These endpoints never return deleted transfers, so it is always absent.