QW DataMappingGuide
QW DataMappingGuide
Table of Contents
1 Introduction ..................................................................................................................... 3
2 Structure .......................................................................................................................... 5
3 Security ............................................................................................................................ 9
4 International .................................................................................................................. 10
5 Data Synchronization and Error Recovery ................................................................. 11
6 FI Profile ......................................................................................................................... 13
7 Activation and Account Info ........................................................................................ 15
8 Email ............................................................................................................................... 19
9 Recurring Transactions ................................................................................................ 20
10 Banking and Credit Cards .......................................................................................... 21
11 Payments ...................................................................................................................... 32
12 Investments .................................................................................................................. 41
13 Appendix A – Complicated Security Transaction Mapping Support .................... 69
1 Introduction
Quicken supports online account access and online payment using the V1 message sets as defined in
the OFX 1.0.2 and 1.0.3 specifications. Although sending SGML, Quicken also supports servers
returning XML headers under the OFX 2.0.2 and 2.0.3 specifications. This data mapping guide
explains how OFX tags are used in Quicken. Tags with special meaning or that are not used (ignored)
in Quicken are listed.
The purpose of the Quicken Data Mapping Guide is to assist Business Analysts and Developers at
Financial Institutions (FI’s) or OFX Server Providers in the development of their OFX servers and help
generate the best customer experience for our mutual customers. The information in this guide is
specific to Quicken for Windows for the United States except as noted. For technical information about
OFX, refer to the OFX specification (http://www.ofx.net).
Tag Description
<ALPHAVALUE> …, A-32
Requires an alphanumeric value up to 32 characters
<NUMERICVALUE> …, N-9
Requires a numeric value between 1 and 9 digits
Tag Description
DATA “OFXSGML”
SECURITY “NONE”
CHARSET “1252”
COMPRESSION “NONE”
FID Unique financial institution identifier. This value is required and must
not change for a financial institution presence. Typically INTU.BID is
(in FI)
the same as the FID.
The FID and ORG are stored on the Intuit branding server and are sent
to the server in OFX requests. The server must echo these values.
requests. The server must echo these values.
ORG Organization defining the FID; associated with the financial institution,
not the service provider. <ORG>Intuit and <ORG>OFX are reserved
(in FI)
values.
SESSCOOKIE The server can provide a SESSCOOKIE that is stored by the product
and passed back to the server in the next request.
IMPORTANT: The URL on the certificate must match the OFX session URL exactly (case sensitive).
See the OFX Specification for further information on security.
CURDEF Quicken for the United States only accepts online transactions in U.S.
dollars (USD).
CURRATE
CURRENCY
CURSYM
ORIGCURRENCY
NOTE: If FIs support the Bill Pay Message Set, FULL sync must be supported. In Banking,
FULL sync is recommended so that other clients can be informed of pending
transfers and emails. In the profile, synchronization type is specified using
<SYNCMODE>FULL or <SYNCMODE>LITE.
REFRESH Quicken sends <REFRESH>Y to full sync servers and <TOKEN>0 to lite
sync servers for the initial INTRASYNCRQ, PAYEESYNCRQ,
PMTSYNCRQ and RECPMTSYNCRQ
TOKEN Quicken sends a <TOKEN>0 or the TOKEN from the last sync
response. If, for any reason, the TOKEN is not recognized, servers
should return a <TOKEN>-1 and <LOSTSYNC>Y so the client can send
a <TOKEN>0 or <REFRESH>Y in the next request.
In addition to the FID, ORG, and profile URL, the Intuit branding server stores contact information,
services, and the marketing INI file URL for a financial institution’s logos and marketspace tab. The
contact information from the branding server is displayed to customers.
Please see the Good Funds document to learn about the private tags you will need to use if you will be
supporting one of the Good Funds Bill Pay models.
NOTE: Servers should always return a full profile response (not <CODE>1) even if the
value of DTPROFUP in the request indicates the client is up-to-date.
Below is some additional information explaining Quicken profile response tag usage.
CASESEN SPECIAL Servers should balance security and usability concerns when
SPACES determining PIN realm configuration. The USERPASS should not
(in SIGNONINFO) contain the special characters ‘<’, ‘>’ or ‘&’ (assuming <SPECIAL>Y is
present in the profile).
REFRESHSUPT Not supported. (Quicken does not send <REFRESH>Y to lite sync
servers.)
SIGNONREALM The SIGNONREALM for each message set must be defined in the
SIGNONINFOLIST. All message sets must use the same SIGNONREALM
so there must be only one SIGNONINFO defined in the profile.
SPNAME If supported, servers should provide a unique name for this tag. This
value must not change once the server is launched.
URL The URLs in the PROFRS should match exactly (case-sensitive) the
financial institution profile URL stored on the Intuit branding server.
The profile URL and Message set URLs must be “Hyper Text Transfer
Protocol Secure” (HTTPS) URLs.
The <URL> values for each message set should all be identical.
Quicken does not allow different URLs in different message sets in the
same profile response.
RESPFILEER Must be ‘Y’ in the Bill Pay Message Set (if supported) and ‘Y’ in the Bank
Message Set if transfers is supported.
SYNCMODE Must be “FULL” in the Bill Pay Message Set; “FULL” recommended (but
not required) in the Bank Message Set if transfers or email are
supported.
• OFX servers are required to support the ACCTINFO request. Accordingly, the profile response
should contain a SIGNUPMSGSET aggregate with <AVAILACCTS>Y.
• Servers must return a single ACCTINFO aggregate for each account, containing
<xxxACCTFROM> aggregates for each service for which the account is activated. Do not put
more than one account in any ACCTINFO aggregate.
• CREDITLINE accounts can be activated for online account access but not online payments in
Quicken.
• If you support Banking and Payments, Intuit products require that the same account be
returned in one <ACCTINFO> wrapper.
Example:
<ACCTINFO>
<BANKACCTINFO>
<BANKACCTFROM>
… account # 123-456
</BANKACCTFROM>
</BANKACCTINFO>
<BPACCTINFO>
<BANKACCTFROM>
… account # 123-456
</BANKACCTFROM>
</BPACCTINFO>
</ACCTINFO>
<BANKACCTINFO>
<BANKACCTFROM>
… account # 888-777
</BANKACCTFROM>
</BANKACCTINFO>
</ACCTINFO>
Supported by
OFX Tag Quicken Quicken Usage
ACCTINFO Yes
BANKACCTINFO Yes
BANKACCTFROM Yes
BPACCTINFO Yes
BANKACCTFROM Yes
CCACCTINFO Yes
CCACCTFROM Yes
INVACCTFROM Yes
XFERSRC / No. May be used XFERSRC and XFERDEST are not used in Quicken.
XFERDEST in future If transfers are supported, Quicken automatically
(Bank and CC versions. allows transfers between all bank accounts for a
accounts) particular user. It is up to the server to return an
error if such a transfer is not permitted. In this case,
it is also recommended that a description of the
problem be returned in <MESSAGE>.
Below are some noted exceptions and explanations concerning Quicken functionality. Quicken does
not support MIME messages.
Email replies (with <TRNUID>0) are shown as Unread in the E-mail tab in the Online Center; e-mail
acknowledgement responses (with non-zero TRNUID that matches a previously sent <xxxMAILRQ>)
are shown as Sent.
Email about an online payment (PMTMAILRQ) must include the SRVRTID and PMTINFO from the
payment.
INCIMAGES Quicken sends N in xxxMAILRQ, and does not support images in the
reply.
1. When a new payment is spawned, the server can return a RECPMTMODRS with an updated
NINSTS and DTDUE that accurately reflects the remaining number of payments left. QWIN will
correctly display these updated values in the Scheduled Payments screen.
2. When a new payment is spawned, the server can return a RECPMTMODRS with the original
NINSTS and DTDUE. Quicken will then calculate the remaining number of payments left.
NOTE: If the server updates NINSTS and DTDUE, it must update both. If only one of the tag
values is updated, Quicken will not display the correct value to the customer.
Quicken does not support interbank transfers, wire transfers, or stop checks, nor does it support
returned check or deposit notifications. Also, Quicken does not support the following tags in the
profile response.
Supported by
OFX Tag Quicken Quicken Usage
BANKMSGSRQV1 Yes
STMTTRNRQ Yes
STMTRQ Yes
BANKACCTFROM Yes
BANKID Yes
ACCTID Yes
INCTRAN
Supported by
OFX Tag Quicken Quicken Usage
BANKMSGSRSV1 Yes
STMTTRNRS Yes
STMTRS Yes
BANKACCTFROM Yes
BANKID Yes
ACCTID Yes
BANKTRANLIST Yes
DTSTART Yes
STMTTRN Yes
CHECKNUM Yes Quicken uses CHECKNUM for the Num field in the
Quicken register. Separate transactions should not
return the same CHECKNUM for a particular
account because CHECKNUM by Quicken is used
for matching.
Example:
<TOTAL>203.02
Quicken adds data from the downloaded transaction to any fields that did not have data entered into
it manually when the matched transaction is accepted. For example, a manually entered transaction
that did not have a memo is matched to a downloaded transaction that does have a memo; when the
transaction is accepted the memo will be added to the existing transaction.
CREDIT Positive
DEBIT Negative
DIV Positive
FEE Negative
SRVCHG Negative
DEP Positive
CHECK Negative
PAYMENT Negative, but will be positive for Line of Credit and Credit Card
Accounts
CASH Negative
DIRECTDEP Positive
DIRECTDEBIT Negative
REPEATPMT Negative, but will be positive for Line of Credit and Credit Card
Accounts
Quicken does not support modifying or canceling transfers, or scheduled or recurring (INTRABANK)
transfers.
The XFERPROF aggregate must be present in the Bank Message Set portion of the profile response in
order for Quicken to allow transfers. If <CANSCHED>Y then Quicken will send a DTDUE of today in the
request; otherwise no DTDUE will be sent. The PROCENDTM tag in XFERPROF must be present, but is
NOTE: Quicken will send a DTDUE of “today” if <CANSCHED>Y is present in the profile.
Some versions of QuickBooks, however, will send a DTDUE of tomorrow in a
transfer request if the profile contains <CANSCHED>Y. For this reason we
recommend <CANSCHED>N in the profile since both products will omit the
DTDUE in the transfer request.
Quicken does not use XFERSRC and XFERDEST in the profile to add limits to the ability to transfer
money to any account. Servers need to validate if the accounts are valid transfer accounts and fail
transfers to/from invalid accounts by sending an OFX error in the response.
Supported by
OFX Tag Quicken Quicken Usage
INTRARQ Yes
XFERINFO Yes
BANKACCTFROM Yes
CCACCTFROM Yes
BANKACCTTO Yes
CCACCTTO Yes
TRNAMT Yes
INTRARS Yes
SRVRTID Yes
XFERINFO Yes
BANKACCTFROM Yes
CCACCTFROM Yes
BANKACCTTO Yes
CCACCTTO Yes
DTXFERPRJ Yes Quicken displays the date effective for the transfer
in the Transmission Summary.
DTPOSTED
If no date is returned, Quicken shows the transfer
effective the next business day.
XFERPRCSTS Yes
Quicken allows the following account types (ACCTTYPE) to be used for bill pay: CHECKING, SAVINGS,
MONEYMRKT.
Below is a table detailing Quicken’s behavior with regard to Bill Pay profile tags.
DFLTDAYSTOPAY The default lead time for a payee without an explicit DAYSTOPAY. Not
used for Good Funds payees (see the Good Funds Specification
document). For details on DAYSTOPAY, see the Payee Tags section.
DIFFLASTPMT
HASEXTDPMTS Not used in Quicken. Quicken does not support extended payments.
PMTBYXFER Not used in Quicken. Quicken does not support payments by transfer.
XFERDAYSWITH
XFERDFLTDAYSTOPAY
Supported by
OFX Tag Quicken Quicken Usage
In addition to synchronizing payments Quicken allows customers to create payments for servers that
support this functionality.
Quicken does not support modifying payments (PMTMODRQ). Customers must first transmit a
payment cancel request and then create a new payment for payments that need to be modified.
Quicken updates the payment with the information included in a PMTMODRS included with a sync
response.
Below is a table explaining Quicken support for various payments specific tags.
Supported by
OFX Tag Quicken Quicken Usage
FINALAMT
NOTE: Quicken has limited support for options. Refer to the tables below for some tag
details. Contact the Implementation Team for additional information if necessary.
The tags below must be included in the profile sent from the server to Quicken.
TRANDNLD This should be set to Y. Although OFX does not require servers to
provide transaction information, it is strongly recommended to facilitate
investment performance and tax reporting in Quicken.
OODNLD Not used in Quicken. Quicken does not support open orders. Profile
setting should be set to N.
CANEMAIL Not used in Quicken. Quicken does not support investment e-mail.
Profile setting should be set to N.
Supported by
OFX Tag Quicken Quicken Usage
INCTRAN Yes
INCPOS Yes
Supported by
OFX Tag Quicken Quicken Usage
For servers that batch the data, use the date through
which the transactions and positions are updated.
CURDEF CURRATE No Quicken for the United States only accepts online
transactions in U.S. dollars (USD).
CURRENCY CURSYM
ORIGCURRENCY
The investment statement response INVTRANLIST can contain investment transaction aggregates as well
as INVBANKTRAN cash transactions.
Quicken defines the transactions area as the Transaction List and the process of accepting transactions
into the investment account as Compare to List.
NOTE: All Quicken actions are found in the Quicken Investment Transaction Log.
INVTRANLIST Yes
TOTAL=
N i
BUYOPT Yes Mapped to the transaction list Bought Units=Positiv
action. e
TOTAL=
TOTAL=
For details on tags that appear in each of the Statement download aggregates go to Investment
Transaction Tags in section 12.3.3.
Initial download (no Whenever possible, servers should provide full transaction history. See
DTSTART in Section 2.2.2, “Data Volume” for information about response file size
INVSTMTRQ) limitations.
Cash treatment Cash transactions in the account that do not contain a security should
use INVBANKTRAN.
Share dividend If the share dividend is taxable, use REINVEST. If it is non-taxable, use
SPLIT.
Acquisition, merger, or Use two TRANSFER transactions with <TFERACTION>IN for acquiring
security name change company and <TFERACTION>OUT for acquired company. Provide one
set of TRANSFER transactions for each lot to maintain the holding
period. To keep tax holding history intact in Quicken set the DTTRADE
of the <TFERACTION>OUT and <TFERACTION>IN transaction to the
date of the original lot purchase date for each lot owned.
Single mutual fund Quicken customers can identify an investment account as a single
account mutual fund account.
Mutual fund exchanges For a taxable mutual fund exchange, use a SELLMF followed by a
BUYMF. For a non-taxable mutual fund exchange, use two TRANSFER
transactions with <TFERACTION>IN and <TFERACTION>OUT.
DTTRADE Quicken uses this date for the investment transaction, without
(in INVTRAN) converting to local time zone.
During the settlement period of a trade, the cash balance in the Quicken
transaction list already reflects the trade although the server’s cash
balance (in the Online Center Balances tab) will not reflect it until the
settlement date. Servers may choose to download an Unsettled Funds
balance to display in the Balances tab to explain the discrepancy.
MEMO Quicken uses the first 64 characters of the MEMO in the transaction.
For a TRANSFER in, Quicken uses the Price multiplied by the Shares as
the cost basis.
COMMISSION Quicken uses the sum of the COMMISSION, FEES, LOAD, and TAXES for
the investment transaction Comm/Fee field. Use positive amounts for
FEES buys, reinvestments, and sell transactions. All amounts need to be
rounded to the nearest cent.
LOAD
The FEE associated with mutual fund <REINVEST> transactions is
TAXES entered into Quicken as a MiscInc transaction. The category will be
assigned based on the <INCOMETYPE>.
DENOMINATOR Quicken supports positive integers in the split ratio, not decimal values.
So a stock split of 1.33 to 1 should be mapped to <NUMERATOR>133
NEWUNITS and <DENOMINATOR>100. The ratio NEWUNITS/OLDUNITS are the
same values as the NUMERATOR/DENOMINATOR. Used for the Old
NUMERATOR Units and New Units investment transaction fields.
OLDUNITS
GAIN GAIN is shown in the Transaction Details dialog in Quicken, but is not
used in the investment transaction. It may be used further in future
versions of Quicken. Use a positive amount.
FRACCASH Rather than returning FRACCASH, servers should include the fractional
share in the SPLIT, and return a SELLxxx for the fractional share to
provide the sales price and maintain the holding period. Using SPLIT
and SELLxxx transactions enables Quicken to correctly report the share
balance and report any capital gains from the sale of the fractional
shares.
MARKDOWN MARKUP and MARKDOWN are not used in Quicken. See <TOTAL> for
how Quicken will calculate Price in transactions. Transaction Details in
MARKUP the Online Center displays MARKUP or MARKDOWN.
Servers should include the option price in the MEMO with instructions to
the customer to update the exercise share price, and provide the cost
basis impact (premium, commission) of the option in the COMMISSION
or FEES for the purchase of the underlying security. Otherwise the
customer will need to manually adjust their investment transaction in
Quicken:
Adjust the underlying buy or sell transaction’s cost basis using the
option purchase basis.
OPTSELLTYPE
RELTYPE
STATEWITHHOLDING Quicken creates a separate MiscExp transaction for any federal tax
WITHHOLDING or state tax STATEWITHHOLDING associated with an
WITHHOLDING investment sell or 401(k) withdrawal. Use positive amounts and do not
include these values in the calculation of TOTAL.
SUBACCTFROM Not used in Quicken. Quicken does not track sub accounts and does not
support journaling (JRNLFUND or JRNLSEC).
SUBACCTFUND
Quicken determines whether a transaction is short or long based on the
SUBACCTSEC holdings for that security at the time the transaction is accepted into the
investment transaction list. Quicken does not distinguish between cash
SUBACCTTO and margin.
TOTAL Quicken uses the TOTAL for the Amount field in the investment
transaction. It is mandatory to transmit TOTAL for each transaction
downloaded.
Quicken divides the total (+/- commissions, fees, load, taxes) by the
number of Shares to determine the Price. Note that <ACCRDINT>,
<PENALTY>, <WITHHOLDING> and <STATEWITHHOLDING> must not
be included in <TOTAL>.
For SELLxxx, INCOME, and RETOFCAP transactions, the total for the
transaction is a positive amount:
UNITPRICE Servers should use a positive amount, and not include any
markup/markdown specified separately. See TOTAL for details about
Price field calculation in Quicken.
For stocks, mutual funds, and other securities: share price. Quicken
shows security prices up to 6 decimal places in decimals unless it is a
round 1/16-type fraction. Stock securities default to display in fractions
when the price is a round 1/16.
UNITS UNITS are used for the Shares investment transaction field. Use a
positive number for buy transactions, and a negative amount for sell
SHPERCTRCT transactions.
For bonds: face value. The Shares field is UNITS divided by 100. If the
factor is not 100, servers should calculate the UNITPRICE by multiplying
the conversion factor by the market price.
• To help Quicken correctly setup initial positions during first time download.
• To display the investment positions from the server in the Online Center of the Holdings Tab.
To correct account balances due to missing transactions, Quicken creates Placeholder transactions to
adjust holdings (share balances). The Placeholder transaction adjusts as a customer enters previous
transaction history to account for transactions that have not yet been recorded or downloaded.
To accomplish the Placeholder transaction entry, Quicken compares the unit totals in the transaction
history to the units in the INVPOS to determine the amount of shares in the Placeholder transaction.
Placeholder transactions are created in two situations:
• During the first time download of an empty account, Quicken creates a Placeholder transaction at
the beginning of the download period. This adjustment creates the opening share balances based
on INVPOS and the downloaded transactions so that the current holdings are correct.
The list of recent transactions returned must correspond to those reflected in the INVPOSLIST. If some
transactions are not yet returned, they must not yet be reflected in the INVPOSLIST either.
Supported by
OFX Tag Quicken Quicken Usage
INVPOSLIST Yes
POSxxx Yes
UNITS Yes Quicken uses the positions list and the transactions
downloaded to create the opening positions for
POSTYPE each security in the download during the first OFX
session. Servers must provide accurate holdings
information so Quicken can create the placeholder
transactions.
REINVDIV
REINVCG
SECURED
UNITSSTREET
UNITSUSER
Quicken, based on the balance tags specified in the financial institution blueprint, uses AVAILCASH or a
combination of balances tags to estimate the current cash balance in the account during the first
Quicken download of the account. Servers should provide a cash balance in AVAILCASH or a BALLIST
tag to represent the cash balance. If a server provides a cash balance of zero, the customer must
manually provide the cash balance. Servers should notify the Intuit FI team which tag represents the cash
balance so the Intuit financial institution blueprint file can reflect that information.
Servers should return their balances as they are shown in their statements. Balances should only include
transactions that have been downloaded. Quicken displays balances to the 2nd decimals place.
Supported in
OFX Tag Quicken Quicken Usage
INVBAL Yes
BUYPOWER Yes Used for the Buying Power balance in the Online
Center Balances tab.
For 401(k) accounts, Quicken displays TOTAL from <INV401KBAL> as the net worth of the account. In
addition, all other tags returned in <INV401KBAL> are displayed in the Online Center under the
Balances tab.
Quicken requires that a security have a valid Ticker symbol (if available) to download prices from the real-
time feed. If the Ticker symbol for a particular security is recognized, the prices can be automatically
updated when the customer performs a download. If the Ticker symbol is not recognized or is not
Supported by
OFX Tag Quicken Quicken Usage
SECINFO Yes
SECID Yes
Supported by
OFX Tag Quicken Quicken Usage
LOANINFO Yes When Quicken sees a LOANINFO for the first time,
it uses the LOANDESC, INITIALLOANBAL,
LOANSTARTDATE, CURRENTLOANBAL, DTASOF,
LOANRATE, and LOANID to create a new loan
account in Quicken.
INV401KBAL Yes Balances by cash source and from the BALLIST are
shown in the Balances tab
Futures No N/A No
Repurchase No N/A No
Agreements
Rights No N/A No
Warrants No N/A No