Transactions

Get a transaction

Fetches one ledger transaction with the names of everything it points at and every bill it has been applied to. Requires the reports:read permission.

GET

https://services.magicdoor.com/accounting/company-portal/transactions/{transactionId}

Authorization

Authorizationstringrequired

Bearer token — Send your API token in the Authorization header as Bearer <token>. Requests without a valid token are rejected with 401 Unauthorized.

Path parameters

transactionIdstringrequired

Snowflake id of the transaction.

example: 1830472847398405200

Response

200 · The transaction, its resolved display names, and its allocations.

idstring

Snowflake id of the transaction.

identityenum<string>

What kind of business event produced this transaction. It says which part of the system owns it.

leaseChargeleaseDepositleaseProcessingFeerentalApplicationFeepropertyChargeownerContributionownerDistributionmanagementFeeserviceBillvendorBillcompanyDisbursementmagicDoorBillbankLedgerTransfer

typeenum<string>

Whether this is the original movement or a later reversal of one.

paymentreturnrefunddisputecredittransfer

directionenum<string>

in raises the bank account's cash, out lowers it. amount is always positive, so the direction is the only thing that carries the sign.

inout

statusenum<string>

Where the money stands. success, returned, refunded, disputing and disputed count toward ledger balances; pending, failed and cancelled do not.

pendingfailedsuccesscancelledreturnedrefundeddisputingdisputed

paymentMethodenum<string>

How the money moved.

achdebitCardwalletcreditCardcheckcashiersCheckmoneyOrdercashzelleothercredittransfer

amountnumber

The amount as a positive decimal. Read direction for which way it went.

transactionDatestring · date

The date the transaction is booked on, in the company's timezone.

finalizedDatestring · date

The date the transaction reached a final status. Absent while it is still pending.

memostring

Free-text note. Absent when none was set.

referencestring

External reference such as a check number. Absent when none was set.

bankAccountIdstring

The bank account whose cash this transaction moves.

chartOfAccountIdstring

The chart-of-account entry this transaction posts its bank side to. For a transaction created by a bank ledger transfer this is one of that bank account's linked cash accounts.

portfolioIdstring

The portfolio the transaction is attributed to. Absent when it is not attributed to one.

propertyIdstring

The property the transaction is attributed to. Absent when it is not attributed to one.

propertyNamestring

Display name of that property, resolved for you. Absent when there is no propertyId or the name could not be resolved.

unitIdstring

The unit the transaction is attributed to. Absent when it is not attributed to one.

leaseIdstring

The lease the transaction is attributed to. Absent when it is not attributed to one.

leaseNamestring

Display name of that lease, resolved for you. Absent when there is no leaseId or the name could not be resolved.

tenantIdstring

The tenant who paid or was paid. Absent when no tenant is involved.

tenantNamestring

Display name of that tenant, resolved for you.

ownerIdstring

The owner who paid or was paid. Absent when no owner is involved.

ownerNamestring

Display name of that owner, resolved for you.

vendorIdstring

The vendor who was paid. Absent when no vendor is involved.

vendorNamestring

Display name of that vendor, resolved for you.

subsidizerIdstring

The subsidizer behind the payment, for example a housing authority. Absent when there is none.

rentalApplicationIdstring

The rental application this transaction paid for. Absent when it did not.

checkIdstring

The printed check this transaction belongs to. Absent when there is none.

linkedTransactionIdstring

The transaction this one reverses or was reversed by. Absent when it stands alone.

bankLedgerTransferIdstring

The bank ledger transfer that created this transaction. Absent unless identity is bankLedgerTransfer.

allocationsAllocation[]

Which bills this transaction has been applied to. Empty when it has not been applied to anything.

401 · The access token is missing, expired, or not for this company.

403 · The caller does not hold the `reports:read` permission.

404 · No transaction with this id belongs to the caller's company.

The permission is reports:read, not transactions:read

This endpoint checks reports:read. A key scoped to transactions:read — the permission whose name matches the resource — gets a 403 here. Scope the key to reports:read if it needs to read individual transactions.