Developer Resources
Enterprise SOAP API
>
API by Reference
>
Core Services
>
Tax Plan Beneficiary Search
>
Developer Resources
Details
SoapAction | http://jackhenry.com/ws/TaxPlnBenfSrch |
Input Name | TaxPlnBenfSrch |
Output Name | TaxPlnBenfSrchResponse |
Input Namespace | http://jackhenry.com/jxchange/TPG/2008 |
Group Name | Inquiry |
Container | TPG_InquiryMaster.xsd |
XML Examples
TaxPlnBenfSrchXML
<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<SOAP-ENV:Header>
<wsse:Security xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd"
xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
<wsse:UsernameToken xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd">
<wsse:Username>{Insert}</wsse:Username>
<wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">{Insert}</wsse:Password>
<wsu:Created xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">2018-11-28T15:30:50Z</wsu:Created>
</wsse:UsernameToken>
</wsse:Security>
</SOAP-ENV:Header>
<SOAP-ENV:Body>
<TaxPlnBenfSrch xmlns="http://jackhenry.com/jxchange/TPG/2008">
<SrchMsgRqHdr>
<jXchangeHdr>
<JxVer/>
<AuditUsrId></AuditUsrId>
<AuditWsId></AuditWsId>
<AuthenUsrId/>
<ConsumerName/>
<ConsumerProd/>
<Ver_1/>
<jXLogTrackingId>{Insert}</jXLogTrackingId>
<Ver_2/>
<InstRtId>011001276</InstRtId>
<InstEnv>TEST</InstEnv>
<Ver_3/>
<BusCorrelId/>
<Ver_4/>
<WorkflowCorrelId/>
<Ver_5/>
<ValidConsmName>{Insert}</ValidConsmName>
<ValidConsmProd>{Insert}</ValidConsmProd>
<Ver_6/>
</jXchangeHdr>
<MaxRec>10</MaxRec>
<Cursor/>
<Ver_1/>
<Ver_2/>
<Ver_3/>
</SrchMsgRqHdr>
<CustId>C000012</CustId>
<AccountId>
<AcctId/>
<AcctType/>
<Ver_1/>
</AccountId>
<PersonName>
<ComName/>
<FirstName/>
<MiddleName/>
<LastName/>
<x_PersonName>
<TitlePrefix/>
<NameSuffix/>
<LegalName/>
<SalName/>
<Ver_1/>
<AbbName/>
<Ver_2/>
</x_PersonName>
<Ver_1/>
</PersonName>
<TaxId/>
<PlnCode/>
<Custom/>
<Ver_1/>
<IncXtendElemArray>
<IncXtendElemInfo>
<XtendElem/>
<Ver_1/>
</IncXtendElemInfo>
</IncXtendElemArray>
<Ver_2/>
</TaxPlnBenfSrch>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
TaxPlnBenfSrchXMLResponse
<?xml version="1.0" encoding="UTF-8"?>
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:u="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
<s:Header>
<o:Security s:mustUnderstand="1"
xmlns:o="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd">
<u:Timestamp u:Id="_0">
<u:Created>2018-11-28T15:30:51.581Z</u:Created>
<u:Expires>2018-11-28T15:35:51.581Z</u:Expires>
</u:Timestamp>
</o:Security>
</s:Header>
<s:Body>
<TaxPlnBenfSrchResponse xmlns="http://jackhenry.com/jxchange/TPG/2008"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<SrchMsgRsHdr>
<jXchangeHdr>
<JxVer>R2017.4</JxVer>
<AuditUsrId>PA</AuditUsrId>
<AuditWsId>IDG</AuditWsId>
<AuthenUsrId/>
<ConsumerName/>
<ConsumerProd/>
<Ver_1/>
<jXLogTrackingId></jXLogTrackingId>
<Ver_2/>
<InstRtId>011001276</InstRtId>
<InstEnv>TEST</InstEnv>
<Ver_3/>
<BusCorrelId>3e1d0f1a-daf3-49ee-b446-410d977866ec</BusCorrelId>
<Ver_4/>
<WorkflowCorrelId/>
<Ver_5/>
<ValidConsmName></ValidConsmName>
<ValidConsmProd></ValidConsmProd>
</jXchangeHdr>
<SentRec>2</SentRec>
<MoreRec>false</MoreRec>
<Cursor>0</Cursor>
<TotRec>2</TotRec>
<Ver_1/>
</SrchMsgRsHdr>
<CustId>C000012</CustId>
<BenfSrchRecArray>
<BenfSrchRec>
<Benf>
<BenfTaxId>000000001</BenfTaxId>
<BenfSpousCode>Y</BenfSpousCode>
<BenfBirthDt>1992-02-02</BenfBirthDt>
<BenfDeceasedDt>2017-02-02</BenfDeceasedDt>
<BenfPctDist>3.00</BenfPctDist>
<BenfGender>Male</BenfGender>
<BenfAge>26</BenfAge>
<BenfIncMail>N</BenfIncMail>
<BenfDistAmt>.00</BenfDistAmt>
<BenfFedWith>.00</BenfFedWith>
<BenfStateWith>.00</BenfStateWith>
<BenfAddr>
<FreeFormAddrArray>
<AddrLineInfo>
<AddrLine>LINE</AddrLine>
<Ver_1/>
</AddrLineInfo>
</FreeFormAddrArray>
<PostalCode>000000000</PostalCode>
<Ver_1/>
<Ver_2/>
</BenfAddr>
<Ver_1/>
<Ver_2/>
<Ver_3/>
</Benf>
<BenfKey>1</BenfKey>
<PlnCode>EDU</PlnCode>
<Ver_1/>
</BenfSrchRec>
<BenfSrchRec>
<Benf>
<BenfTaxId>000000001</BenfTaxId>
<BenfSpousCode>Y</BenfSpousCode>
<BenfBirthDt>1992-02-02</BenfBirthDt>
<BenfDeceasedDt>2017-02-02</BenfDeceasedDt>
<BenfPctDist>3.00</BenfPctDist>
<BenfGender>Male</BenfGender>
<BenfAge>26</BenfAge>
<BenfIncMail>N</BenfIncMail>
<BenfDistAmt>.00</BenfDistAmt>
<BenfFedWith>.00</BenfFedWith>
<BenfStateWith>.00</BenfStateWith>
<BenfAddr>
<FreeFormAddrArray>
<AddrLineInfo>
<AddrLine>LINE</AddrLine>
<Ver_1/>
</AddrLineInfo>
</FreeFormAddrArray>
<PostalCode>000000000</PostalCode>
<Ver_1/>
<Ver_2/>
</BenfAddr>
<Ver_1/>
<Ver_2/>
<Ver_3/>
</Benf>
<BenfKey>2</BenfKey>
<PlnCode>EDU</PlnCode>
<Ver_1/>
</BenfSrchRec>
</BenfSrchRecArray>
<Ver_1/>
</TaxPlnBenfSrchResponse>
</s:Body>
</s:Envelope>
Have a Question?
Have a how-to question? Seeing a weird error? Get help on
StackOverflow.
Register for the Digital Toolkit Meetup
where we answer technical Q&A from the audience.
Last updated Thu Jun 30 2022