Tax Plan Add
Tax Plan Addition
Tax Plan Addition is a jXchange service designed to add a consumer's tax plan on a service provider's database through web services.
Message Flow
In jXchange, the Tax Plan Addition service uses a typical exchange of MType messages to add a created
consumer's tax plan on a service provider's database.
Primary Request
The third-party consumer forwards the TaxPlnAddRq_MType message to the
service provider.
The message contains the following simple elements:
- CustId
- PlnCode
- PlnType
The message contains the following complex elements:
AccountId_CTypeCustom_CTypeMsgRqHdr_CTypePlnCust_CTypeTaxPlnDist_CTypeTaxPlnTaxInfo_CType
The message contains the following array:
ErrOvrRdInfoArray_AType
Primary Response
The service provider returns the TaxPlnAddRs_MType message to the
third-party consumer.
The message contains the following simple element:
- RsStat
The message contains the following complex elements:
Custom_CTypeMsgRsHdr_CType
TaxPlnAddRq_MType
TaxPlnAddRq_MType is a message
MType element.
Contains:
AccountId_CTypeCustom_CTypeErrOvrRdInfoArray_ATypeMsgRqHdr_CTypePlnCust_CTypeTaxPlnDist_CTypeTaxPlnTaxInfo_CType
Simple Elements
The following simple elements are contained within this message.
- CustId
- The identifier attached to a customer. It includes the OvrrdInstRtId attribute.
- PlnCode
- The service provider code that represents plan products for different plan types.
- PlnType
- Tax plan types as approved by the IRS. Canonical values are:
- EDU - Educational IRA
- HSA - Health Savings
- IRA - Regular IRA
- MSA - Medical Savings
- QRP - Keogh
- RCV - ROTH Conversion
- RTH - ROTH Retirement
- SEP - Simplified Employer Plan
- SIM - Simple Retirement
AccountId_CType
AccountId_CType is a complex
CType element. This element contains the incoming account
identification information and any restrictions.
Simple Elements
The following simple elements are contained within this complex.
- AcctId
- The number or character that identifies an account record.
- AcctType
- The number or character that categorizes the AcctId.
- Rstr
- The level of restrictions that can exist at a parent and/or child
node. Canonical values are:
- Hid
- NoAccess
- NoAccessPart
- ReadOnly
- ReadOnlyPart
- ReadWrite
- ReadWritePart
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
ErrOvrRdInfoArray_AType
ErrOvrRdInfoArray_AType is an array
AType element. This is an array of overrides for
faults.
Contains:
ErrOvrRd_CType
ErrOvrRd_CType
ErrOvrRd_CType is a complex CType element. This
element is used to override errors created in a previous request. This element is
optional.
Simple Elements
The following simple elements are contained within this complex.
- BusSvcType
- The business service type used to convey certain Add and Mod message handling. The canonical value is NoValidate.
- ErrCode
- The error code.
MsgRqHdr_CType
MsgRqHdr_CType is a complex CType element. This is
the default message request header.
Contains:
AuthenUsrCred_CTypejXchangeHdr_CType
Simple Elements
The following simple elements are contained within this complex.
- AuthenProdCred
- Authentication of the Consumer Product Credentials in the form of a WS Security element that contains a single SAML V2.0 Assertion.
AuthenUsrCred_CType
AuthenUsrCred_CType is a complex CType element. This element represents authentication of the end-user credentials in
the form of a WS Security element that contains a single SAML V2.0
Assertion.
Simple Elements
The following simple elements are contained within this complex.
- Security
- Defines the wsse:Security SOAP header element per section 4.
jXchangeHdr_CType
jXchangeHdr_CType is a complex
CType element.
Simple Elements
The following simple elements are contained within this complex.
- AuditUsrId
- The user ID that the consumer would like written in the audit as performing the requested service. It varies, but it could be the same as the user ID. It is not used to authenticate. It is used to audit the Soap Header Fault.
- AuditWsId
- The workstation ID that the consumer would like written in the audit as performing the requested service for the Soap Header Fault. It varies, but it could be the same as the user ID.
- AuthenUsrId
- The user ID which the consumer would like the service provider to
authenticate with for the Soap Header Fault. It is a user ID that the provider
understands.
This element deprecates in accordance with XSD contract tenets. Effective date: 2017–01–01. The new complex element for user authentication credentials was added to both the Search Message Request Header
SrchMsgRqHdr_CTypeand the Message Request HeaderMsgRqHdr_CType. AuthenUsrId is ignored by the service providers when the authentication user credentialsAuthenUsrCred_CTypepackage is delivered. The expectation is that the password credentials and the user name token are provided in the authentication user credential complex element in accordance with the standards established by WS-Security. - BusCorrelId
- The correlation identification as related to business functions and activities.
- ConsumerName
- The name of the service consumer (business name) for the Soap Header Fault.
- ConsumerProd
- The name of the product which is consuming the service (business product name) for the Soap Header Fault.
- InstEnv
- An identification provided by the consumer that defines the
environment in which the institution is operating. Canonical values are:
- Prod
- InstRtId
- The identification of the entity of the submitted message. A
financial institution entity uses the routing transit or nine-digit number
assigned to financial institutions for routing as assigned by the American
Bankers Association. Any leading zeros must be provided for a complete routing
and transit number. A non-financial institution entity should use a mutually
agreed upon identification that must contain at least one non-integer character.
The canonical value is JHA.
The element is required in all message requests.
- jXLogTrackingId
- An identification provided by jXchange to be able to trace the request and response of a message from the third-party gateway, internal gateway, and service provider for the Soap Header Fault.
- JxVer
- Contains the version jXchange is running for the Soap Header Fault.
- ValidConsmName
- The consumer name that can be validated by enterprise governance. The canonical values are managed in a consumer/product enterprise table. The canonical value is: JHA.
- ValidConsmProd
- The consumer product name that can be validated by enterprise governance. The canonical values are managed in a consumer/product enterprise table.
- WorkflowCorrelId
- The correlation identification as related to workflow functions and activities.
jXchangeHdr_CType Deprecation Details
- AuthenUsrId
- The user ID which the consumer would like the service provider to
authenticate with for the Soap Header Fault. It is a user ID that the provider
understands.
This element deprecates in accordance with XSD contract tenets. Effective date: 2017–01–01. The new complex element for user authentication credentials was added to both the Search Message Request Header
SrchMsgRqHdr_CTypeand the Message Request HeaderMsgRqHdr_CType. AuthenUsrId is ignored by the service providers when the authentication user credentialsAuthenUsrCred_CTypepackage is delivered. The expectation is that the password credentials and the user name token are provided in the authentication user credential complex element in accordance with the standards established by WS-Security.
PlnCust_CType
PlnCust_CType is a complex
CType element.
Simple Elements
The following simple elements are contained within this complex.
- BenfDistCode
- The code for the method of the distribution.
- CntrbAmtPriorYTD
- The prior tax year-to-date contribution amounts for a tax plan.
- CntrbAmtYTD
- The current tax year-to-date contribution amounts for a tax plan.
- DeathDistDt
- The date the tax plan proceeds were distributed to the beneficiary.
- DeathDist
- The proceeds of the tax plan were distributed due to the death of the plan owner.
- FirstContrbDt
- The date of the first tax plan contribution.
- OrigOwnBirthDt
- The original owners of the tax plan's birth date.
- OrigOwnCustId
- The original owners of the tax plan's customer ID.
- OrigOwnDeceaseDt
- The original owners of the tax plan's date of death.
- OrigOwnName
- The name of the original owner of the tax plan.
- PlanDistDeceasedDt
- The date deceased.
- PlnEstbDt
- The date the tax plan was established.
- PlnFeeAmt
- The fee charge for maintaining the tax plan.
- PlnFeeCode
- The code for the fees charged to the tax plan.
- QRPCustId
- The customer ID of the administrator for a qualified retirement (Keogh) tax plan.
- QRPPlnId
- The plan ID of the employer for a qualified retirement (Keogh) tax plan.
- SoleSpousBenf
- A code that references if the tax plan is taking advantage of the sole spousal distribution.
- SpousPlnCode
- The code to determine if the tax plan qualifies as a spousal retirement plan in accord with IRS Regulations.
- SpousSingleOwn
- References if the tax plan is using the spousal single life election rule.
TaxPlnDist_CType
TaxPlnDist_CType is a complex
CType element.
Contains:
ACHPmtInfo_CType
Simple Elements
The following simple elements are contained within this complex.
- AutoStartDistCode
- The code that references if the tax plan should automatically start distributions.
- CalcBenfAge
- The calculated age of the beneficiary to be used for the RMD amount. This could differ from the beneficiary age.
- DistAcctId
- The account identification for the tax plan distribution for direct deposit.
- DistAcctType
- The account type for the tax plan distribution for direct deposit.
- DistAmtRemCode
- The code that references the remaining amount of the tax plan distribution.
- DistAmtRem
- The description of the remaining amount of the tax plan distribution.
- DistAmt
- The amount of the scheduled distribution from the tax plan.
- DistCalcMthdCode
- The code that references the method that should be used for distributions from the tax plan.
- DistDayofMonth
- The specific day of the month the distribution should be created from the tax plan.
- DistFactor
- The distribution factor to be used in the RMD amount for the tax plan.
- DistFrqCode
- The code that references the frequency of the distributions from the tax plan.
- DistFrq
- The frequency of the distribution should be created from the tax plan.
- DistIncIntCode
- The code that references if the tax plan distributions should include accrued but unpaid interest.
- DistSeqOrderCode
- The code that references the order the funds should be debited from the instruments for the tax plan distributions.
- DistStatCode
- The status of the scheduled distribution from the tax plan.
- DistTrnCode
- The transaction code that is used when making distributions from the tax plan.
- DlyFirstDistCode
- The code that references if the tax play should delay the first mandatory distribution until the following tax year.
- ElecDistAmt
- The elected distribution amount from the tax plan.
- LastDistAmt
- The amount of the last distribution from the tax plan.
- LastDistDt
- The date of the last distribution from the tax plan.
- MinRDAAgeOvrrdCode
- The election taken by the account owner to use the minimum RDA age override, as allowed by the tax plan.
- MndtryDistDt
- The date mandatory distributions must start from the tax plan.
- NxtDistDt
- The next scheduled distribution date from the tax plan.
- OwnDistCalcMthdCode
- The code to determine the method to be used when calculating the RMD amount if the plan still belongs to the original owner.
- RecalcDistAmtCode
- The code that references if the tax plan elected distribution amount should be recalculated automatically on a periodic basis.
- RedLastAnnDistCode
- The code that determines if the last distribution in the year should be reduced so only the minimum distribution required is distributed as governed by the tax plan.
- ReqMinDistAmt
- The required minimum distribution from the tax plan as required by IRS statues.
- SoleSpousDistCode
- The code that references if the sole beneficiary is the spouse.
- StartDistDt
- The date the scheduled distributions started from the tax plan.
- WavMndtryDistCode
- The code that references the reason the mandatory distribution amount is being waived.
ACHPmtInfo_CType
ACHPmtInfo_CType is a complex
CType element. This element is optional.
Simple Elements
The following simple elements are contained within this complex.
- ACHCompDiscrData
- The ACH company discretionary data, as governed by Nacha® rules.
- ACHCompEntryDesc
- The ACH company entry description, as governed by Nacha® rules.
- ACHCompId
- The ACH company ID.
- ACHCompName
- The ACH company name, as governed by Nacha® rules.
- ACHCrAcctId
- The account ID of the credit account for the ACH item.
- ACHCrName
- The account holder's name of the credit account for the ACH item.
- ACHCrRtNum
- The routing and transit number of the credit account's bank for the ACH item.
- ACHDrAcctId
- The account ID of the debit account for the ACH item.
- ACHDrName
- The account holder's name of the debit account for the ACH item.
- ACHDrRtNum
- The routing and transit number of the debit account's bank for the ACH item.
- ACHSendPreNoteCode
- The code that determines if an ACH prenotification should be generated, as governed by Nacha® rules.
- ACHStdEntryClass
- The ACH standard entry class.
- ACHTrnCode
- The transaction code to be used for the ACH item, as governed by Nacha® rules.
TaxPlnTaxInfo_CType
TaxPlnTaxInfo_CType is a complex
CType element.
Simple Elements
The following simple elements are contained within this complex.
- PlnFedWithAltAcctId
- Withholding alternate account number.
- PlnFedWithAltAcctType
- Withholding alternate account type.
- PlnFedWithAltRate
- Withholding alternate rate.
- PlnFedWithCode
- Fed W/H code. Value is passed from the service of record during the pilot phase.
- PlnFedWithEffDt
- Fed W/H effective date.
- PlnFedWithFixAmt
- Federal withholding fixed holding amount.
- PlnFedWithLastYR
- Federal withholding last year.
- PlnFedWithMTD
- Federal withholding month-to-date.
- PlnFedWithQTD
- Federal withholding quarter-to-date.
- PlnFedWithYTD
- Federal withholding year-to-date.
- PlnStateWithAltAcctId
- State withholding alternate account number.
- PlnStateWithAltAcctType
- State withholding alternate account type D.
- PlnStateWithAltRate
- State withholding alternate rate.
- PlnStateWithCode
- State W/H code. Value is passed from the service of record during the pilot phase.
- PlnStateWithEffDt
- State W/H effective date.
- PlnStateWithFixAmt
- State withholding fixed holding amount.
- PlnStateWithLastYR
- State withholding last year.
- PlnStateWithMTD
- State withholding month-to-date.
- PlnStateWithQTD
- State withholding quarter-to-date.
- PlnStateWithYTD
- State withholding year-to-date.
TaxPlnAddRs_MType
TaxPlnAddRs_MType is a message
MType element.
Contains:
Custom_CTypeMsgRsHdr_CType
Simple Elements
The following simple elements are contained within this message.
- RsStat
- The status of the response. Canonical values are:
- Fail
- Success
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
MsgRsHdr_CType
MsgRsHdr_CType is a complex
CType element. This is the default message response
header.
Contains:
jXchangeHdr_CTypeMsgRecInfoArray_AType
jXchangeHdr_CType
jXchangeHdr_CType is a complex
CType element.
Simple Elements
The following simple elements are contained within this complex.
- AuditUsrId
- The user ID that the consumer would like written in the audit as performing the requested service. It varies, but it could be the same as the user ID. It is not used to authenticate. It is used to audit the Soap Header Fault.
- AuditWsId
- The workstation ID that the consumer would like written in the audit as performing the requested service for the Soap Header Fault. It varies, but it could be the same as the user ID.
- AuthenUsrId
- The user ID which the consumer would like the service provider to
authenticate with for the Soap Header Fault. It is a user ID that the provider
understands.
This element deprecates in accordance with XSD contract tenets. Effective date: 2017–01–01. The new complex element for user authentication credentials was added to both the Search Message Request Header
SrchMsgRqHdr_CTypeand the Message Request HeaderMsgRqHdr_CType. AuthenUsrId is ignored by the service providers when the authentication user credentialsAuthenUsrCred_CTypepackage is delivered. The expectation is that the password credentials and the user name token are provided in the authentication user credential complex element in accordance with the standards established by WS-Security. - BusCorrelId
- The correlation identification as related to business functions and activities.
- ConsumerName
- The name of the service consumer (business name) for the Soap Header Fault.
- ConsumerProd
- The name of the product which is consuming the service (business product name) for the Soap Header Fault.
- InstEnv
- An identification provided by the consumer that defines the
environment in which the institution is operating. Canonical values are:
- Prod
- InstRtId
- The identification of the entity of the submitted message. A
financial institution entity uses the routing transit or nine-digit number
assigned to financial institutions for routing as assigned by the American
Bankers Association. Any leading zeros must be provided for a complete routing
and transit number. A non-financial institution entity should use a mutually
agreed upon identification that must contain at least one non-integer character.
The canonical value is JHA.
The element is required in all message requests.
- jXLogTrackingId
- An identification provided by jXchange to be able to trace the request and response of a message from the third-party gateway, internal gateway, and service provider for the Soap Header Fault.
- JxVer
- Contains the version jXchange is running for the Soap Header Fault.
- ValidConsmName
- The consumer name that can be validated by enterprise governance. The canonical values are managed in a consumer/product enterprise table. The canonical value is: JHA.
- ValidConsmProd
- The consumer product name that can be validated by enterprise governance. The canonical values are managed in a consumer/product enterprise table.
- WorkflowCorrelId
- The correlation identification as related to workflow functions and activities.
jXchangeHdr_CType Deprecation Details
- AuthenUsrId
- The user ID which the consumer would like the service provider to
authenticate with for the Soap Header Fault. It is a user ID that the provider
understands.
This element deprecates in accordance with XSD contract tenets. Effective date: 2017–01–01. The new complex element for user authentication credentials was added to both the Search Message Request Header
SrchMsgRqHdr_CTypeand the Message Request HeaderMsgRqHdr_CType. AuthenUsrId is ignored by the service providers when the authentication user credentialsAuthenUsrCred_CTypepackage is delivered. The expectation is that the password credentials and the user name token are provided in the authentication user credential complex element in accordance with the standards established by WS-Security.
MsgRecInfoArray_AType
MsgRecInfoArray_AType is an array
AType element. This is an array of messages that can be
returned in a response.
Contains:
MsgRec_CType
MsgRec_CType
MsgRec_CType is a complex
CType element.
Simple Elements
The following simple elements are contained within this complex.
- ErrCat
- The Soap Header Fault error category.
- ErrCode
- The error code.
- ErrDesc
- The Soap Header Fault error description.
- ErrElem
- The Soap Header Fault when an error or fault occurs. This optional element contains the element which is causing the error condition.
- ErrElemVal
- The Soap Header Fault when an error or fault occurs. This optional element contains the value of the element which is causing the error condition.
- ErrLoc
- The Soap Header Fault error location. This is typically the program that generated the error condition.