Transactions

links

object

next

object

href

string

prev

object

href

string

transactions

array of objects

An array of transactions with entity types dependent on the account type (deposit, investment, loan, or line of credit)

Any of:

depositTransaction

accountId

string

Corresponds to AccountId in Account

amount

number

The amount of money in the account currency. If balanceType is `ASSET`: 1. If `debitCreditMemo` = `DEBIT`, sign is "+" or not present 2. If `CREDIT`, sign is "-" If balanceType is `LIABILITY`: 1. If `debitCreditMemo` = `DEBIT`, sign is "-" 2. If `CREDIT`, sign is "+" or not present

category

string

Transaction category, preferably MCC or SIC.

debitCreditMemo

string

Akoya will ensure that this is correctly populated with one of DEBIT or CREDIT and matches the sign of the status field.

DEBITCREDIT

description

string

The description of the transaction

imageIds

array

fiAttributes

Array of FI-specific attributes

foreignAmount

number

The amount of money in the foreign currency

foreignCurrency

string

The ISO 4217 code of the foreign currency

lineItem

array of objects

Breakdown of the transaction details

object

amount

number

The amount of money attributable to this line item

checkNumber

number

Check number

description

string

The description of the line item

imageIds

array

links

array of objects

Links (unique to this Transaction) used to retrieve images of checks or transaction receipts, or invoke other APIs

object

href

string

URL to invoke the action on the resource

action

string

HTTP Method to use for the request

GETPOSTPATCHDELETEPUT

types

array of strings

Content-types that can be used in the Accept header.

string

memo

string

Secondary item description

reference

string

A reference number

links

Links (unique to this Transaction) used to retrieve images of checks or transaction receipts, or invoke other APIs

memo

string

Secondary transaction description

postedTimestamp

string

The date and time that the transaction was posted to the account. If not provided then TransactionTimestamp can be used as PostedTimeStamp.

reference

string

A tracking reference identifier

referenceTransactionId

string

Akoya ensures that this field is populated for all transactions which are reversals, otherwise it is null. Either way it is always present. For reverse postings, the identity of the transaction being reversed. For the correction transaction, the identity of the reversing post. For credit card posting transactions, the identity of the authorization transaction.

status

string

AUTHORIZATION, MEMO, PENDING, or POSTED

PENDINGMEMOPOSTEDAUTHORIZATION

subCategory

string

Transaction category detail

transactionId

string

Long term persistent identity of the transaction (unique to account). Transaction IDs should: 1. be the same for pending and posted 2. be different for reversed transactions 3. `referenceTransactionId` should be present for reversed transactions'

transactionTimestamp

string

The date and time that the transaction was added to the server backend systems. Akoya ensures that this field is populated for all transactions to which it applies, otherwise it is null. Either way it is always present.

payee

string

Payee name

checkNumber

integer

Check Number

transactionType

string

DepositTransaction Type

CHECKWITHDRAWALTRANSFERPOSDEBITATMWITHDRAWALBILLPAYMENTFEEDEPOSITADJUSTMENTINTERESTDIVIDENDDIRECTDEPOSITATMDEPOSITPOSCREDIT

loanTransaction

accountId

string

Corresponds to AccountId in Account

amount

number

The amount of money in the account currency. If balanceType is `ASSET`: 1. If `debitCreditMemo` = `DEBIT`, sign is "+" or not present 2. If `CREDIT`, sign is "-" If balanceType is `LIABILITY`: 1. If `debitCreditMemo` = `DEBIT`, sign is "-" 2. If `CREDIT`, sign is "+" or not present

category

string

Transaction category, preferably MCC or SIC.

debitCreditMemo

string

Akoya will ensure that this is correctly populated with one of DEBIT or CREDIT and matches the sign of the status field.

DEBITCREDIT

description

string

The description of the transaction

imageIds

array

fiAttributes

Array of FI-specific attributes

foreignAmount

number

The amount of money in the foreign currency

foreignCurrency

string

The ISO 4217 code of the foreign currency

lineItem

array of objects

Breakdown of the transaction details

object

amount

number

The amount of money attributable to this line item

checkNumber

number

Check number

description

string

The description of the line item

imageIds

array

links

array of objects

Links (unique to this Transaction) used to retrieve images of checks or transaction receipts, or invoke other APIs

object

href

string

URL to invoke the action on the resource

action

string

HTTP Method to use for the request

GETPOSTPATCHDELETEPUT

types

array of strings

Content-types that can be used in the Accept header.

string

memo

string

Secondary item description

reference

string

A reference number

links

Links (unique to this Transaction) used to retrieve images of checks or transaction receipts, or invoke other APIs

memo

string

Secondary transaction description

postedTimestamp

string

The date and time that the transaction was posted to the account. If not provided then TransactionTimestamp can be used as PostedTimeStamp.

reference

string

A tracking reference identifier

referenceTransactionId

string

Akoya ensures that this field is populated for all transactions which are reversals, otherwise it is null. Either way it is always present. For reverse postings, the identity of the transaction being reversed. For the correction transaction, the identity of the reversing post. For credit card posting transactions, the identity of the authorization transaction.

status

string

AUTHORIZATION, MEMO, PENDING, or POSTED

PENDINGMEMOPOSTEDAUTHORIZATION

subCategory

string

Transaction category detail

transactionId

string

Long term persistent identity of the transaction (unique to account). Transaction IDs should: 1. be the same for pending and posted 2. be different for reversed transactions 3. `referenceTransactionId` should be present for reversed transactions'

transactionTimestamp

string

The date and time that the transaction was added to the server backend systems. Akoya ensures that this field is populated for all transactions to which it applies, otherwise it is null. Either way it is always present.

paymentDetails

object

escrowAmount

number

The amount of payment applied to escrow

feesAmount

number

The amount of payment applied to fees

insuranceAmount

number

The amount of payment applied to life/health/accident insurance on the loan

interestAmount

number

The amount of payment applied to interest

pmiAmount

number

The amount of payment applied to PMI

principalAmount

number

The amount of payment applied to principal

transactionType

string

LoanTransaction Type

ADJUSTMENTFEEINTERESTPAYMENT

locTransaction

accountId

string

Corresponds to AccountId in Account

amount

number

The amount of money in the account currency. If balanceType is `ASSET`: 1. If `debitCreditMemo` = `DEBIT`, sign is "+" or not present 2. If `CREDIT`, sign is "-" If balanceType is `LIABILITY`: 1. If `debitCreditMemo` = `DEBIT`, sign is "-" 2. If `CREDIT`, sign is "+" or not present

category

string

Transaction category, preferably MCC or SIC.

debitCreditMemo

string

Akoya will ensure that this is correctly populated with one of DEBIT or CREDIT and matches the sign of the status field.

DEBITCREDIT

description

string

The description of the transaction

imageIds

array

fiAttributes

Array of FI-specific attributes

foreignAmount

number

The amount of money in the foreign currency

foreignCurrency

string

The ISO 4217 code of the foreign currency

lineItem

array of objects

Breakdown of the transaction details

object

amount

number

The amount of money attributable to this line item

checkNumber

number

Check number

description

string

The description of the line item

imageIds

array

links

array of objects

Links (unique to this Transaction) used to retrieve images of checks or transaction receipts, or invoke other APIs

object

href

string

URL to invoke the action on the resource

action

string

HTTP Method to use for the request

GETPOSTPATCHDELETEPUT

types

array of strings

Content-types that can be used in the Accept header.

string

memo

string

Secondary item description

reference

string

A reference number

links

Links (unique to this Transaction) used to retrieve images of checks or transaction receipts, or invoke other APIs

memo

string

Secondary transaction description

postedTimestamp

string

The date and time that the transaction was posted to the account. If not provided then TransactionTimestamp can be used as PostedTimeStamp.

reference

string

A tracking reference identifier

referenceTransactionId

string

Akoya ensures that this field is populated for all transactions which are reversals, otherwise it is null. Either way it is always present. For reverse postings, the identity of the transaction being reversed. For the correction transaction, the identity of the reversing post. For credit card posting transactions, the identity of the authorization transaction.

status

string

AUTHORIZATION, MEMO, PENDING, or POSTED

PENDINGMEMOPOSTEDAUTHORIZATION

subCategory

string

Transaction category detail

transactionId

string

Long term persistent identity of the transaction (unique to account). Transaction IDs should: 1. be the same for pending and posted 2. be different for reversed transactions 3. `referenceTransactionId` should be present for reversed transactions'

transactionTimestamp

string

The date and time that the transaction was added to the server backend systems. Akoya ensures that this field is populated for all transactions to which it applies, otherwise it is null. Either way it is always present.

checkNumber

integer

Check number

paymentDetails

object

escrowAmount

number

The amount of payment applied to escrow

feesAmount

number

The amount of payment applied to fees

insuranceAmount

number

The amount of payment applied to life/health/accident insurance on the loan

interestAmount

number

The amount of payment applied to interest

pmiAmount

number

The amount of payment applied to PMI

principalAmount

number

The amount of payment applied to principal

transactionType

string

LocTransaction Type

CHECKWITHDRAWALTRANSFERPOSDEBITATMWITHDRAWALBILLPAYMENTFEEDEPOSITADJUSTMENTINTERESTDIVIDENDDIRECTDEPOSITATMDEPOSITPOSCREDIT

investmentTransaction

accountId

string

Corresponds to AccountId in Account

amount

number

The amount of money in the account currency. If balanceType is `ASSET`: 1. If `debitCreditMemo` = `DEBIT`, sign is "+" or not present 2. If `CREDIT`, sign is "-" If balanceType is `LIABILITY`: 1. If `debitCreditMemo` = `DEBIT`, sign is "-" 2. If `CREDIT`, sign is "+" or not present

category

string

Transaction category, preferably MCC or SIC.

debitCreditMemo

string

Akoya will ensure that this is correctly populated with one of DEBIT or CREDIT and matches the sign of the status field.

DEBITCREDIT

description

string

The description of the transaction

imageIds

array

fiAttributes

Array of FI-specific attributes

foreignAmount

number

The amount of money in the foreign currency

foreignCurrency

string

The ISO 4217 code of the foreign currency

lineItem

array of objects

Breakdown of the transaction details

object

amount

number

The amount of money attributable to this line item

checkNumber

number

Check number

description

string

The description of the line item

imageIds

array

links

array of objects

Links (unique to this Transaction) used to retrieve images of checks or transaction receipts, or invoke other APIs

object

href

string

URL to invoke the action on the resource

action

string

HTTP Method to use for the request

GETPOSTPATCHDELETEPUT

types

array of strings

Content-types that can be used in the Accept header.

string

memo

string

Secondary item description

reference

string

A reference number

links

Links (unique to this Transaction) used to retrieve images of checks or transaction receipts, or invoke other APIs

memo

string

Secondary transaction description

postedTimestamp

string

The date and time that the transaction was posted to the account. If not provided then TransactionTimestamp can be used as PostedTimeStamp.

reference

string

A tracking reference identifier

referenceTransactionId

string

Akoya ensures that this field is populated for all transactions which are reversals, otherwise it is null. Either way it is always present. For reverse postings, the identity of the transaction being reversed. For the correction transaction, the identity of the reversing post. For credit card posting transactions, the identity of the authorization transaction.

status

string

AUTHORIZATION, MEMO, PENDING, or POSTED

PENDINGMEMOPOSTEDAUTHORIZATION

subCategory

string

Transaction category detail

transactionId

string

Long term persistent identity of the transaction (unique to account). Transaction IDs should: 1. be the same for pending and posted 2. be different for reversed transactions 3. `referenceTransactionId` should be present for reversed transactions'

transactionTimestamp

string

The date and time that the transaction was added to the server backend systems. Akoya ensures that this field is populated for all transactions to which it applies, otherwise it is null. Either way it is always present.

accruedInterest

number

Accrued Interest.

commission

number

Transaction commission.

confirmationNumber

string

Confirmation number of the transaction.

faceValue

number

Cash value for bonds.

fees

number

Fees applied to the trade.

fractionalCash

number

Cash for fractional units (used for stock splits).

gain

number

For sales.

incomeType

string

Type of investment income. CGLONG (capital gains-long term), CGSHORT (capital gains-short term), MISC.

CGLONGCGSHORTMISC

inv401kSource

string

load

number

Load on the transaction.

loanId

string

For 401k accounts only. This indicates the transaction was due to a loan or a loan repayment.

loanInterest

number

How much loan pre-payment is interest.

loanPrincipal

number

How much loan pre-payment is principal.

markup

number

Portion of unit price that is attributed to the dealer markup.

newUnits

number

Number of shares after split.

oldUnits

number

Number of shares before split.

payrollDate

string

The date for the 401k transaction was obtained in payroll.

penalty

number

Indicates amount withheld due to a penalty.

positionType

string

price

number

Unit purchase price.

priorYearContrib

boolean

Indicates this buy was made using prior years contribution. TRUE or FALSE.

runningBalance

number

Running balance of the position.

securityId

string

Unique identifier of security.

securityIdType

string

Security identifier type.

BUSIPISINSEDOLSICCVALORWKN

securityType

string

STOCKMUTUALFUNDDEBTOPTIONSWEEPOTHERBOND

shares

number

Number of shares (with decimals). Negative numbers indicate securities are being removed from the account.

splitRatioDenominator

number

Split ratio denominator.

splitRatioNumerator

number

Split ratio numerator.

stateWithholding

number

State tax withholding.

subAccountFund

string

From which account money came in.

CASHMARGINSHORTOTHERS

subAccountSec

string

Sub-account security type.

CASHMARGINSHORTOTHERS

symbol

string

Ticker symbol.

taxes

number

Taxes on the trade.

taxExempt

boolean

Tax-exempt transaction TRUE or FALSE.

transactionReason

string

Reason for this transaction; CALL (the debt was called), SELL (the debt was sold), MATURITY (the debt reached maturity)

CALLSELLMATURITY

transactionType

string

InvestmentTransaction Type

PURCHASEDSOLDPURCHASEDTOCOVERADJUSTMENTPURCHASETOOPENPURCHASETOCLOSESOLDTOOPENSOLDTOCLOSEINTERESTMARGININTERESTREINVESTOFINCOMERETURNOFCAPITALTRANSFERCONTRIBUTIONFEEOPTIONEXERCISEOPTIONEXPIRATIONDIVIDENDDIVIDENDREINVESTSPLITCLOSUREINCOMEEXPENSECLOSUREOPTINVEXPENSEJRNLSECJRNLFUNDOTHERDIVSRVCHGDEPDEPOSITATMPOSXFERCHECKPAYMENTCASHDIRECTDEPDIRECTDEBITREPEATPMT

transferAction

string

Transfer direction.

INOUT

unitPrice

number

Price per commonly-quoted unit. Does not include markup/markdown, unitprice. Share price for stocks, mutual funds, and others. Percentage of par for bonds. Per share (not contract) for options.

units

number

For security-based actions other than stock splits, quantity. Shares for stocks, mutual funds, and others. Face value for bonds. Contracts for options.

unitType

string

withholding

number

Federal tax withholding.

insuranceTransaction

accountId

string

Corresponds to AccountId in Account

amount

number

The amount of money in the account currency. If balanceType is `ASSET`: 1. If `debitCreditMemo` = `DEBIT`, sign is "+" or not present 2. If `CREDIT`, sign is "-" If balanceType is `LIABILITY`: 1. If `debitCreditMemo` = `DEBIT`, sign is "-" 2. If `CREDIT`, sign is "+" or not present

category

string

Transaction category, preferably MCC or SIC.

debitCreditMemo

string

Akoya will ensure that this is correctly populated with one of DEBIT or CREDIT and matches the sign of the status field.

DEBITCREDIT

description

string

The description of the transaction

imageIds

array

fiAttributes

Array of FI-specific attributes

foreignAmount

number

The amount of money in the foreign currency

foreignCurrency

string

The ISO 4217 code of the foreign currency

lineItem

array of objects

Breakdown of the transaction details

object

amount

number

The amount of money attributable to this line item

checkNumber

number

Check number

description

string

The description of the line item

imageIds

array

links

array of objects

Links (unique to this Transaction) used to retrieve images of checks or transaction receipts, or invoke other APIs

object

href

string

URL to invoke the action on the resource

action

string

HTTP Method to use for the request

GETPOSTPATCHDELETEPUT

types

array of strings

Content-types that can be used in the Accept header.

string

memo

string

Secondary item description

reference

string

A reference number

links

Links (unique to this Transaction) used to retrieve images of checks or transaction receipts, or invoke other APIs

memo

string

Secondary transaction description

postedTimestamp

string

The date and time that the transaction was posted to the account. If not provided then TransactionTimestamp can be used as PostedTimeStamp.

reference

string

A tracking reference identifier

referenceTransactionId

string

Akoya ensures that this field is populated for all transactions which are reversals, otherwise it is null. Either way it is always present. For reverse postings, the identity of the transaction being reversed. For the correction transaction, the identity of the reversing post. For credit card posting transactions, the identity of the authorization transaction.

status

string

AUTHORIZATION, MEMO, PENDING, or POSTED

PENDINGMEMOPOSTEDAUTHORIZATION

subCategory

string

Transaction category detail

transactionId

string

Long term persistent identity of the transaction (unique to account). Transaction IDs should: 1. be the same for pending and posted 2. be different for reversed transactions 3. `referenceTransactionId` should be present for reversed transactions'

transactionTimestamp

string

The date and time that the transaction was added to the server backend systems. Akoya ensures that this field is populated for all transactions to which it applies, otherwise it is null. Either way it is always present.

transactionType

string

InsuranceTransaction Type

PAYMENTFEEADJUSTMENTINTEREST

object

code

integer

Error code defined by FDX API Specification or Data Provider indicating the error situation which has occurred

message

string

End user displayable information which might help the customer diagnose an error

debugMessage

string

Message used to debug the root cause of the error. Contents should not be used in consumer's business logic. Can change at any time and should only be used for consumer to communicate with the data provider about an issue. Provider can include an error GUID in message for their use.

object

code

integer

Error code defined by FDX API Specification or Data Provider indicating the error situation which has occurred

message

string

End user displayable information which might help the customer diagnose an error

debugMessage

string

Message used to debug the root cause of the error. Contents should not be used in consumer's business logic. Can change at any time and should only be used for consumer to communicate with the data provider about an issue. Provider can include an error GUID in message for their use.

object

code

integer

Error code defined by FDX API Specification or Data Provider indicating the error situation which has occurred

message

string

End user displayable information which might help the customer diagnose an error

debugMessage

string

Message used to debug the root cause of the error. Contents should not be used in consumer's business logic. Can change at any time and should only be used for consumer to communicate with the data provider about an issue. Provider can include an error GUID in message for their use.

string

object

code

integer

Error code defined by FDX API Specification or Data Provider indicating the error situation which has occurred

message

string

End user displayable information which might help the customer diagnose an error

debugMessage

string

Message used to debug the root cause of the error. Contents should not be used in consumer's business logic. Can change at any time and should only be used for consumer to communicate with the data provider about an issue. Provider can include an error GUID in message for their use.

object

code

integer

Error code defined by FDX API Specification or Data Provider indicating the error situation which has occurred

message

string

End user displayable information which might help the customer diagnose an error

debugMessage

string

Message used to debug the root cause of the error. Contents should not be used in consumer's business logic. Can change at any time and should only be used for consumer to communicate with the data provider about an issue. Provider can include an error GUID in message for their use.

object

code

integer

Error code defined by FDX API Specification or Data Provider indicating the error situation which has occurred

message

string

End user displayable information which might help the customer diagnose an error

debugMessage

string

Message used to debug the root cause of the error. Contents should not be used in consumer's business logic. Can change at any time and should only be used for consumer to communicate with the data provider about an issue. Provider can include an error GUID in message for their use.

object

code

integer

Error code defined by FDX API Specification or Data Provider indicating the error situation which has occurred

message

string

End user displayable information which might help the customer diagnose an error

debugMessage

string

Message used to debug the root cause of the error. Contents should not be used in consumer's business logic. Can change at any time and should only be used for consumer to communicate with the data provider about an issue. Provider can include an error GUID in message for their use.

object

code

integer

Error code defined by FDX API Specification or Data Provider indicating the error situation which has occurred

message

string

End user displayable information which might help the customer diagnose an error

debugMessage

string

Message used to debug the root cause of the error. Contents should not be used in consumer's business logic. Can change at any time and should only be used for consumer to communicate with the data provider about an issue. Provider can include an error GUID in message for their use.

object

code

integer

Error code defined by FDX API Specification or Data Provider indicating the error situation which has occurred

message

string

End user displayable information which might help the customer diagnose an error

debugMessage

string

Message used to debug the root cause of the error. Contents should not be used in consumer's business logic. Can change at any time and should only be used for consumer to communicate with the data provider about an issue. Provider can include an error GUID in message for their use.