tax & accounting web services

GOSYSTEM TAX™

TAX & ACCOUNTINGWEBSERVICESDocument Version 2.0

Last Updated: 09/01/2020

COPYRIGHT NOTICE©2019-2020 Thomson Reuters/Tax & Accounting. All rights reserved. Republication or redistribution ofThomson Reuters content, including by framing or similar means, is prohibited without the prior written consentof Thomson Reuters. Thomson Reuters and the Kinesis logo are trademarks of Thomson Reuters and itsaffiliated companies.More information can be found here.

Last Updated: 09/01/2020

https://www.thomsonreuters.com/en/policies/copyright.html

TABLE OF CONTENTS1 Overview 11.1 Document History 11.2 Web Services 21.3 Common Features 21.4 XML Firewall Requirements 21.5 Polling Recommendations 31.6 SAML Tokens 31.7 Client DLL Logging 5

2 RS Tax Services 72.1 Service Details 72.1.1 WSDLVersions 72.1.2 Soap Headers 82.1.3 Authentication 82.1.4 Return XML Structure 92.1.5 Web Methods 102.1.5.1 AppendChunk 102.1.5.2 CreateLocator 112.1.5.3 Create1065Locator 122.1.5.4 Create1120Locator 142.1.5.5 CreateLocatorWithEntityTypeAndReturnType 192.1.5.6 CreateUser 232.1.5.7 DeactivateLocator 272.1.5.8 ExportLocator 292.1.5.9 FileDownload 312.1.5.10 FileDownloadComplete 322.1.5.11 GetExportStatus 332.1.5.12 GetFileSize 342.1.5.13 GetImportStatus 352.1.5.14 GetInitializeTEQStatus 362.1.5.15 GetPlatformExtensionStatus 372.1.5.16 GetPrintStatus 382.1.5.17 GetProformaStatus 392.1.5.18 GetSaveAsStatus 402.1.5.19 GetTransferStatus 42

ii

2.1.5.20 GetTransfertoMTIStatus 432.1.5.21 GetXmlValidatorErrors (MTI Only) 452.1.5.22 ImportLocator 462.1.5.23 InitializeTEQ 472.1.5.24 LocatorAssignment 482.1.5.25 PrintLocator 522.1.5.26 ProformaLocator 542.1.5.27 RunPlatformExtension 562.1.5.28 SaveAs 562.1.5.29 TransferLocator 592.1.5.30 TransferToMTI 602.1.5.31 ValidateCredentials 612.1.5.32 ValidateLocator 62

2.2 RSTAXSERVICES Client DLL 652.2.1 Using the .NET/COM–Callable InterfaceModule 652.2.2 Server Configuration 652.2.3 Client Install Package 65

3 Appendix A: Document Change History 68

1 OVERVIEWThomson Reuters Web Services facilitate client integration with the GoSystem product. Using Web Services,client applications can check e-file status, import or export tax return data, print returns, and more.

This document describes the available Web Services, their functionality and programming interfaces, and theauthentication requirements for each service.

1.1 DOCUMENT HISTORYThe following table lists the most recent document changes and the associated version. For a complete historyof document changes, see Appendix A: Document Change History (page 68).

DATE VERSION NOTES

3/2/2011 1.0.135.3 l Added EFSSmethod,SubmitEFileForBatchId.l Added documentation forWSDL Versions (page 7) to the RSTAXSERVICEweb service section.

10/1/2012 1.0.146.1 l Added RSTaxServicemethodsCreate1065Locator (page 12),Create1120Locator (page 14),CreateLocatorWithEntityTypeAndReturnType (page 19)

l Added EFSSmethodsCreateEFile

2/17/2013

1.0.152.1 Added RSTaxServicemethodsRunPlatformExtension (page 56),GetPlatformExtensionStatus (page 37)

7/11/2013 1.0.152.4 l Removed EFSS portion of documentation since product has been brokenapart fromRSTaxServices.

l UpdatedCreate1120Locator (page 14) andCreateLocatorWithEntityTypeAndReturnType (page 19)methods toreflect ReturnTypes “H” and “P”

2/24/2020 2.0 UpdatedCreateUser (page 23).

GOSYSTEM TAXTAX & ACCOUNTINGWEB SERVICES V2.0

2 1 Overview1.2 Web Services

1.2 WEB SERVICESTwo services are available:

l E-File Status Service (EFSS)

The E-file Status Service allows client applications to submit returns for e-filing and to check the status forthose returns. Documentation for the EFSS service is located in the document, EFSS EFileWebServices, available from Thomson Reuters support.

l RSTaxServices

The RTAXSERVICESweb service provides various tax return-oriented capabilities, including but notlimited to importing, exporting, and printing tax returns.

1.3 COMMON FEATURESThe Web Services discussed in this document are written using Microsoft ASP.NET and use features of theMicrosoft Web Service Extensions (WSE) to handle WS-Security headers. WS-Security headers are required,whether your application is calling from aWindows or from a non-Windows environment.

The Services generally accept Username or SAML tokens that follow specific formatting rules. The formatsrequired for each service are noted in the documentation for that service.

In addition to creating raw SOAP/XML requests, the services offer COM or .NET-callable code that you can useinstead of writing your own code. This can greatly speed application development, since it is not necessary toknow the internal XML formats involved with making application calls or building security tokens.Documentation for using these client modules is included in the service descriptions found in this document.

1.4 XML FIREWALL REQUIREMENTSThomson Reuters uses hardware XML Firewall proxies between your application and the web services servers.Firewall rules are configured to prevent various forms of XML-based attacks, as well as disallow servicerequests that are improperly constructed (including containing the properly formatted type of security token).

In addition, we will normally prevent access to service methods based on the source IP address of the callingapplication. You will therefore need to provide Thomson Reuters with a list of IP address ranges thatare allowed to make web service calls from your network.


1 Overview 3

1.5 Polling Recommendations

All web service calls involve various timestamps or time restrictions. This means the machinecalling the web service must have a properly synchronized clock using a standard timeprovider, or the requests may be rejected if your machine clock and ours are too far out of sync.

1.5 POLLING RECOMMENDATIONSMany of the RSTAXSERVICESweb service methods call back into a batch system. The effect of anImportLocator, for example, is to schedule a batch job to handle the import of data into GoSystem. In order tocheck on the status of this batch job, one would use theGetImportStatus method to periodically check for jobcompletion. There are many other methods that use this combination of job initiation and subsequent polling forcompletion status, including Proforma, Transfer, Export, Print, and others.

There are certain strategies to keep in mind when coding for these operations, especially as it is very easy totrip the DoS rules enforced in our XML Firewall device by making too many web service calls with too high afrequency.

As a general rule, your application is allowed to make up to 90 web method calls per minute or 15calls in a burst (all at once) per GoSystem user id before your application will be blocked frommaking additional calls for a short period of time.

The following are some best practices to keep in mind while working on your integration.

l Since the initial call to perform a batch operation (Import, Export, Print, etc.) involves some initializationsteps such as creation and queuing of a new batch job, there will always be a short lag between the timeyou initiate the operation and when you can expect to receive something more meaningful than a state of"Running". We therefore recommend a minimum delay of 20- 30 seconds between any Initiate* call andthe firstGet*Status call.

l SubsequentGet*Status calls should be spaced out with a minimum 20 second delay between each call.

1.6 SAML TOKENSIn many cases authentication credentials for a service using SAML tokens use X.500 Distinguished Namesyntax. Internet RFC 1779 defines the syntax of X.500 Distinguished Names.


4 1 Overview1.6 SAML Tokens

Particular X.500 attributes are separated by a standard delimiter (either comma “,”, semicolon “;”or forward slash “/”).

Certain special characters, if contained inside the string value of the attribute, must be escapedusing a backslash character “\”. The characters that require backslash escaping are any of thefollowing: comma ',', plus sign '+', equals sign '=', double quote ' " ', carriage return, less than sign'<', greater than sign '>', pound sign '#', semicolon ';', and forward slash '/'.

Text values with embedded white space characters should be double quoted, and you may alsouse double-quoting instead of escaping for text containing any of the special characters exceptdouble quotes.

Since some of these special characters appear in base-64 encoding, this means that for base-64text you will need to either double quote the string, or scan and escape all special characters foundin the string using a backslash.

X.500 syntax also supports hexadecimal encoding of binary or text data. This is done by starting the string witha pound sign “#” followed by the hex data, for example “#1b2b3c4d”. Hex encoding text data that mightcontain any of the special characters listed above is a convenient way to avoid looking for and escaping thespecial characters, and is the only way to pass non-text binary data.

Following are examples of valid X.500 DNs:

Comma delimiter

o=testorg, ou=testou, UID=testuid, userPassword=testpassword

Slash delimiter

o=testorg/ou=testou/UID=testuid/Userpassword=testpassword (LDAP uses slashes)

Escaped slash

o=testorg,ou=testou,UID=testuid, userPassword=test\/password

Quoted text

o=testorg,ou=testou,UID="test uid",userPassword=testpassword

Embedded spaces require double quotes around the text in question.

Quoted special chars

o=testorg,ou=testou,UID="te,st/ui;d",userPassword=testpassword


1 Overview 51.7 Client DLL Logging

Adding quotes around text avoids the need for escaping some characters.

Names or values may be encoded or quoted:

#6f=testorg,#6F75=testou,UID=#74657374756964,"userPassword"=testpassword

All values can be hex encoded:

o=#746573742b6f7267, ou=#746573742c6f75, uid=#746573743b756964,userPassword=#746573742f70617373776f7264

1.7 CLIENT DLL LOGGINGThe RSTAXSERVICESweb service has a corresponding client DLL that wraps the proxies to the respectiveweb services and provides higher-level, abstracted functionality for certain operations (the ImportLocatorclient method, for ex., wraps the RSTAXSERVICESweb service calls AppendChunk and ImportLocator).

At times, it may become necessary for a developer to enable logging for either or both of these client DLLs. Theclient logging facility, packaged into the ThomsonReuters.WebServices.ClientLogging assembly, is off bydefault. To enable it, you will need to add the following information to your primary application's app.config file(the entire .config file is shown for clarity):

Note that this information must be present in your calling application's .config file or the ClientLogging assemblywill not find it and logging will remain off.

You can set the TraceLogName to whatever filename you like, or just leave it alone.


6 1 Overview1.7 Client DLL Logging

If TraceLogOutputPath is left as shown, the log file will be written to the local folder where your application isrunning. You may find you need to change the location based on local permissions (for example, Windows 7restricts access to certain areas of the file system if you do not have the correct permissions).

The ClientLogging assembly captures and writes TRACE information. The level of detail captured can becontrolled by the value parameter of the TraceSwitch. As indicated in the comments, a value of '0' disableslogging; '1' gives error messages only; '2' gives errors and warnings; '3' gives errors, warnings, and informationmessages; and '4' gives verbose messages plus all the others.

For an example of the various configuration settings and to see the logging in action, see theRSTaxWPFDemo installed as part of the TaxAccountingWebServices client setup.


2 RS TAX SERVICESService URL: https://rswebsvc.thomson.com/RSTaxServices/RSTaxServices20101115.asmx

Service WSDL:https://rswebsvc.thomson.com/RSTaxServices/RSTaxServices20111115.asmx?WSDL

The URL is case sensitive. Please use the case shown above.

The RSTAXSERVICESweb service supports the full tax return “life-cycle” of your tax data, including import,compute, export, and print.

A client interface DLL is available to customers who wish to use it. The interface DLL wraps individual webservice methods into easy to use API calls that internally handle all of the communications and securityrequirements (such asWS-* and SAML) for you automatically. The DLL contains both .NET and COMinterfaces.

2.1 SERVICE DETAILS

2.1.1 WSDL VERSIONS

Whenever newmethods are added to the RSTAXSERVICESweb service a newWSDL is generated. Thispreserves existing functionality and helps minimize the impact of changes on previous versions.

This version information is only relevant if you (1) generate your own proxy to the web service (as opposed tousing the provided client DLL) and (2) need to use the latest functionality exposed in a particular WSDL. If youdo not need to take advantage of new functionality, there is no need or requirement to upgrade to the latestWSDL; prior WSDLs and their corresponding client DLLs (or proxies) will continue to operate as usual.

https://rswebsvc.thomson.com/RSTaxServices/RSTaxServices20111115.asmx?WSDL (corresponds toclient dll version 1.0.152.1)

https://rswebsvc.thomson.com/RSTaxServices/RSTaxServices20101102.asmx?WSDL (corresponds toclient dll version 1.0.127.2)

https://rswebsvc.thomson.com/RSTaxServices/RSTaxServices20100625.asmx?WSDL (corresponds toclient version 1.0.103.4)

https://rswebsvc.thomson.com/RSTaxServices/RSTaxServices.asmx?WSDL (corresponds to client dllversions prior to 1.0.103.4)


https://rswebsvc.thomson.com/RSTaxServices/RSTaxServices20101115.asmx

https://rswebsvc.thomson.com/RSTaxServices/RSTaxServices20111115.asmx?WSDL




https://rswebsvc.thomson.com/RSTaxServices/RSTaxServices.asmx?WSDL

8 2 RS Tax Services2.1 Service Details

2.1.2 SOAP HEADERS

The service requires WS-Addressing and WS-Security SOAP headers. A typical sample is shown below. All ofthe elements in this example are required. Note the <wsa:Action> value will vary by the method being called.The service is built on Microsoft WSE 3.0 and therefore supports WS-Security 1.0 and 1.1, and WS-Addressing(08/2004 draft).

2.1.3 AUTHENTICATION

The web service requires authentication. Authentication is provided by GoSystem Tax RS login credentialsinside a SAML 1.0 or SAML 1.1 token, contained within a valid WS-Security SOAP header. The GoSystem TaxRS user must have appropriate access to the tax return (as configured in the Access Control dialogs in theapplication) in order to import or export the return.

The structure of the SAML assertion is shown below (boldface elements are required). Note theAttributeStatement is optional; only one attribute is currently defined, “Application”, and the code does not usethe attribute other than for logging purposes. The AuthenticationStatement is required. The Conditions elementincluding the AudienceRestrictionCondition is required.

The NameIdentifer element inside the Subject element must meet the following requirements:


2 RS Tax Services 92.1 Service Details

l For GoSystem RS credentials:

o The NameIdentifier is in x.500 format, where the o=firm, ou=location, uid=GoSystem login ID, anduserPassword=GoSystem login password (case-sensitive).

l For custom credentials:

o Typically x.500 format; contact Thomson Reuters if you need to use custom credentials.

2.1.4 RETURN XML STRUCTURE

All methods in this service return “Status XML”, which is formatted as follows:



Note the bracketed elements are optional in the above format, so they may or may not exist in any particularstatus return. The optional detail elements can be any valid XML subtree, and the contents will depend on theprocess that added the detail.

2.1.5 WEB METHODS

The RSTAXSERVICESweb service includes the following web methods:

In the following descriptions, the SOAP headers are not shown for clarity; however, they arerequired per the above documentation.

2.1.5.1 APPENDCHUNK

Upload a portion of a file (for jobs requiring uploading such as Imports). Call this method as many times asneeded to upload the entire file. Upload file block size should not exceed 1 Meg per call. Chunks must beuploaded in sequence and an exception occurs if any chunk is out of sequence.

SOAP Body request format:

Parameters

fileName - File name for the file. ** Must follow the standard FileID pattern: <unique guid>-<base filename>,ex. “3f7b9554-6a63-3c3c-2216-b732c4fe3aa3-MYFILENAME.xml”

buffer - byte array in base64 string form of this file block

offset - File offset location for this block; note for any given call, this should exactly match the current file sizeuploaded so far, as this parameter determines whether the block is properly in sequence.

bytesRead - number of raw bytes in the buffer of this chunk.



Returns

An XML string which contains a root element named Status with the following attributes will be returned:

Error (non-zero - error, 0 – no error, chunk uploaded successfully)

Return Value Success Example:

<Status Error="0" Code="0" Descrip="Append successful"/>

Return Value Fail Example:

<Status Error="1" Code="-1" Descrip="Error during file upload" />

2.1.5.2 CREATELOCATOR

Create a newGoSystem locator.


Parameters

account - Account Code

taxYear - 4-digit Tax Year (YYYY)

taxType - Tax return type; valid types include: 1040, 1041, 1065, 1120, 990, 706, 709, 5500. The single-character internal tax type is also acceptable.

taxPayerName - Tax Payer Name

taxPayerInitial - Optional Tax Payer Initial

spouseInitial - Optional Spouse Initial



taxPayerEmail - Tax Payer Email Address (required if using MyTaxInfo else optional)

taxPayerSSN - Tax Payer SSN (required if using MyTaxInfo else optional)

password - RS password of locator (optional)

Returns

An XML string containing a root element named Status with the following attributes will be returned:

Error (1 - error, 0 – no error)

Code, Descrip, Info

CODE DESCRIP INFO

1 "Finished" "Locator Created Successfully"

2 "Finished" "No locator numbers available. Try again later"

3 "Finished" "Invalid Year"

4 "Finished" "Invalid Account"

5 "Finished" "Unable to create locator data"

6 "Finished" "User does not have rights to Create locator"

7 "Finished" "Invalid locator type specified"

Ident - This attribute will exist and contain the newly created locator number only on success (where Code = 1and Error = 0) as shown in the below examples.


<Status Error="0" Code="1" Descrip="Finished" Info="Locator CreatedSuccessfully" Ident="ABC123"/>


<Status Error="1" Code="2" Descrip="Finished" Info="No locator numbersavailable. Try again later" />

2.1.5.3 CREATE1065LOCATOR

Create a new 1065 Tax Type GoSystem locator.




Parameters



returnType – Tax return type for a 1065 Locator. The only valid entry allowed is “P”.


clientCode – Optional code that can be entered to assist with identifying the locator to the customer.


entityType – The specific 1065 Entity Type to create. The valid entries are “G”, “D”, “C”, and “E” types

Returns



Code, Descrip, Info

CODE DESCRIP INFO






CODE DESCRIP INFO










2.1.5.4 CREATE1120LOCATOR

Create a new 1120 Tax Type GoSystem locator.


Parameters





returnType – Tax return type for a 1120 Locator. The valid parameter entries are:

TAX RETURN TYPE PARAMETER ENTRY

"1120 – C Corporation" C

"1120S – S Corporation" S

"1120A –Cooperative Associations" A

"1120F – Foreign Corporation" F

“1120H –Homeowner’s Association” H

"1120-RIC – Regulated Investment Company" R

"1120-REIT – Real Estate Investment Trust" T

“1120-PC – Property & Casualty Insurance Company” P

"1120-L – Life Insurance Company" L

taxPayerName – The name of the 1120 entity.



entityType – The specific 1120 Entity Type to create.

The following table maps the allowable entity types supported by GoSystem:



ENTITY TYPE PARAMETER ENTRY

"Corporate Single Entity" G

"Parent" P

“Subsidiary” S

“Division” D

“Eliminations” E

“Top Consolidation” T

“Sub Consolidation” C

“Non-Life Eliminations” L

“Non-Life Top Consolidation” X

“Non-Life Sub Consolidation” M

“Life Non-Life Consolidation” Y

“Life Non-Life Eliminations” N

The following table maps entity types allowed for each return type supported:

TAX RETURN TYPE ALLOWABLE ENTITY TYPEPARAMETER ENTRIES

"C" “G”, “P”, “S”, “D”, “E”, “T”, “C”, “L”, “X”,”M”, “N”, “Y”




"S" “G”, “P”, “S”, “D”, “E”, “T”, “C”

“A” “G”

“F” “G”

“H” “G”

“R” “G”

“T” “G”,”P”,”S”,”D”,”E”,”T”,”C”

“P” “G”, “P”, “S”, “D”, “E”, “T”, “C”, “L”, “X”,”M”, “N”, “Y”

“L” “G”,”P”,”S”,”D”,”E”,”T”,”C”,”Y”,”N”

dataSource -

The following table maps the allowable data source type supported by GoSystem:

DATASOURCE TYPE PARAMETER ENTRY

"Consolidation/Eliminations" C

"ElectronicOrganizer" E

"ElectronicOrganizer" Z

“Life Annual Statement” L

“Separate Accounts Annual Statement” S



The following table maps DataSource parameters to entity type and return type parameters:

TAX RETURNTYPE ENTRIES

ENTITY TYPEENTRIES

DATASOURCEENTRY

C E,T,C,L,M,X,N,Y C

C G,P,S,D E

S,A,F,R,T N/A Z

L E,T,C, N,Y C

L G,P,S,D E,L,S

FEIN – The Federal EIN for the entity.

Returns



Code, Descrip, Info

CODE DESCRIP INFO















2.1.5.5 CREATELOCATORWITHENTITYTYPEANDRETURNTYPE

Create a newGoSystem locator with specific Entity Type and Tax Type.


Parameters



taxType – Tax return type for the Locator. Valid entries are 1040, 1065, 1120, 1041, 990, 706, 709, and 5500.


taxPayerInitial - Optional Tax Payer Initial

spouseInitial - Optional Spouse Initial

taxPayerEmail - Tax Payer Email Address (required if using MyTaxInfo else optional)



taxPayerSSN - Tax Payer SSN (required if using MyTaxInfo else optional) . If taxType is 1120, this valuerepresents the FEIN for the entity.


entityType – The specific 1065 Entity Type to create. The valid entries are “G”, “D”, “C”, and “E” types

returnType – The type of return for the tax type entered.

If the taxType is 1120, the valid parameter entries are:

TAX RETURN TYPE PARAMETER ENTRY

"1120 – C Corporation" C

"1120S – S Corporation" S

"1120A –Cooperative Associations" A

"1120F – Foreign Corporation" F

“1120H –Homeowner’s Association” H

"1120-RIC – Regulated Investment Company" R

"1120-REIT – Real Estate Investment Trust" T

“1120-PC – Property & Casualty Insurance Company” P

"1120-L – Life Insurance Company" L

If the taxType is 1065, the only valid parameter entry is “P”.

entityType – The specific Entity Type to create.

The following table maps the allowable entity types supported by GoSystem 1120 taxType:




"Corporate Single Entity" G

"Parent" P

“Subsidiary” S

“Division” D

“Eliminations” E

“Top Consolidation” T

“Sub Consolidation” C

“Non-Life Eliminations” L

“Non-Life Top Consolidation” X

“Non-Life Sub Consolidation” M

“Life Non-Life Consolidation” Y

“Life Non-Life Eliminations” N

If the taxType is 1120, the following table maps entity types allowed for each return type supported in an1120 return:




"C" “G”, “P”, “S”, “D”, “E”, “T”, “C”, “L”, “X”,”M”, “N”, “Y”

"S" “G”, “P”, “S”, “D”, “E”, “T”, “C”

“A” “G”

“F” “G”

“H” “G”

“R” “G”

“T” “G”,”P”,”S”,”D”,”E”,”T”,”C”

“P” “G”, “P”, “S”, “D”, “E”, “T”, “C”, “L”, “X”,”M”, “N”, “Y”

“L” “G”,”P”,”S”,”D”,”E”,”T”,”C”,”Y”,”N”

The following table maps the allowable entity types supported by GoSystem 1065 taxType:


"Single Entity" G

“Division” D

“Divisional Consolidation” C

“EliminationsCompany” E

All of the above Entity Types are available for the “P” returnType for a 1065 taxType.




Returns



Code, Descrip, Info

CODE DESCRIP INFO













2.1.5.6 CREATEUSER

Create a newGoSystem user and to assign the user to locator groups.




Parameters

xmlDocument – An XML representation of a new user. Format is as follows:



To add or remove the assignment groups, the example XML is below:



Returns


Error (-1 - error, 0 – no error)

Code, Descrip, Info

CODE DESCRIP INFO

0 "User created successfully"

-1 "<multiple possibilities; most often a bad param>"

-2 "Unable to create user"

-3 "Validation error" <containsmore detailed info>

-4 "XML Parser error"

-5 "An xml value exceeds the size of thecorresponding database field"

-6 "Password error" <containsmore detailed info>

-7 “Group not specified” <containsmore detailed info>

-8 “Specified user already exists“ <containsmore detailed info>

-9 “All purchased user logins have been used”

-10 “Unable to create user” <containsmore detailed info>



Return Value Success:

<Status Error="0" Code="0" Descrip="User created successfully" />

Return Value Fail:

<Status Error="1" Code="-1" Descrip="<multiple possibilities; most oftena bad param>" />

<Status Error="1" Code="-2" Descrip="Unable to create user" />

<Status Error="1" Code="-3" Descrip="Validation error" Info="<containsmore detailed info>" />

<Status Error="1" Code="-4" Descrip="XML Parser error" />

<Status Error="1" Code="-5" Descrip="An xml value exceeds the size of thecorresponding database field"/>

<Status Error="1" Code="-6" Descrip="Password error" Info="<contains moredetailed info>" />

<Status Error="1" Code="-7" Descrip="Group not specified" Info="<containsmore detailed info>" />

<Status Error="1" Code="-8" Descrip="Specified user already exists"Info="<contains more detailed info>"/>

<Status Error="1" Code="-9" Descrip="All purchased user logins have beenused" />

<Status Error="1" Code="-10" Descrip="Unable to create user"Info="<contains more detailed info>" />

2.1.5.7 DEACTIVATELOCATOR

Deactivate a locator.




Parameters

account – The GoSystem account.

locatorId – The GoSystem locator id to deactivate.

taxYear – The tax year of the locator to deactivate.

taxType – The tax type of the locator to deactivate.

password – The locator's password, if any. Blank otherwise.

Returns


Error (-1 - error, 0 – no error)

Code, Descrip

CODE DESCRIP

0 "Locator Deactivated"

-1 "<multiple possibilities; most often a bad param indication >"

-2 "Failed to retrieve locator"

-3 "Invalid password"

-4 "The locator is busy"

-5 "A general failure occurred attempting to deactivate a return"



CODE DESCRIP

-6 "Locator in use"

-7 “Unable to deactivate return”


<Status Error="0" Code="0" Descrip="Locator Deactivated" />

Return Value Fail:

<Status Error="1" Code="-1" Descrip="<multiple possibilities; most oftena bad param indication >" />

<Status Error="1" Code="-2" Descrip="Failed to retrieve locator" />

<Status Error="1" Code="-3" Descrip="Invalid Password" />

<Status Error="1" Code="-4" Descrip="The locator is busy" />

<Status Error="1" Code="-5" Descrip="A general failure occurredattempting to deactivate a return" />

<Status Error="1" Code="-6" Descrip="Locator In Use" />

<Status Error="1" Code="-7" Descrip="Unable to deactivate return" />

2.1.5.8 EXPORTLOCATOR

Export a tax return from GoSystem or MyTaxInfo. After initiating the export, your code must poll using theGetExportStatus (page 33)method to wait for the batch operation to complete. Upon successful completion,use the FileDownload (page 31)method to download the file to your local machine.




Parameters

exportType - The export type parameter should be one of the following string literal values (listed under“ExportType”):

EXPORTTYPE EXPORTED FILE FORMAT DESCRIPTION

DCEXPORT CSV Export GoSystem tax return data.

IEXEXPORT XML Export GoSystem tax return data.

MTIEXPORT XML Export MyTaxInfo (MTI) tax return data.

TEQXMLEXP XML Export Tax Equalization (TEQ) tax return data.

WOXMLEXP XML (deprecated) Export MyTaxInfo (MTI) tax return data

account - GoSystem RSAccount of the tax return

locatorId - GoSystem RS Locator number of the tax return

taxYear - 4-digit tax year of the tax return, ex. "2019"

taxType - Tax return type. One of the following string literals: 1040, 1041, 1065, 1120, 990, 706, 709, 5500.The single-character internal tax type is also acceptable.

password - GoSystem RS password on the return, if any (blank string otherwise)

Returns

Status XML:Code="0" and Ident attribute=”JobID” of the Export job if successful. Use the Job ID as theparameter toGetExportStatus (page 33).



2.1.5.9 FILEDOWNLOAD

Download a file chunk of an output file such as the results of an Export job. You must call this method iterativelyfor as many chunks as needed to retrieve the entire file; use a maximum of 1 Meg chunk size. Use theGetFileSize (page 34)method to retrieve file size before calling FileDownload so you will know howmanychunks will be required. Be sure to call FileDownloadComplete (page 32) after every successful download ofan entire file.


Parameters

jobId - The batch job id returned in the Ident attribute of an ExportLocator (page 29)method call.

fileId - Single File ID string from the list returned in the Ident attribute of the Status XML when the jobcompletion status was polled.

offset – Offset index into file of the requested block; must be less than file size

bufferSize – size in bytes of the chunk to return

Returns



Code – The Code attribute of the XML string will be one of the following values (also includes the Descripattribute as follows):

CODE DESCRIP

0 "File downloaded successfully"

-1 "Error downloading file"



Ident - This attribute will only exist and contain the name of the file downloaded if the download is successful(Code=0, Error=0) as shown in the example below.

In addition, an XML element named chunk will be included that contains the base64 encoded string of thebinary chunk from the file if successful.


<Status Error="0" Code="0" Descrip="File downloaded successfully"Ident="ABCMTI.xml"/>

<chunk>abC1…</chunk>


<Status Error="1" Code="-1" Descrip=" Error downloading file" />

2.1.5.10 FILEDOWNLOADCOMPLETE

Finish a file download. This cleans up all resources associated with the download. You should call this afterevery successful sequence of FileDownload (page 31) calls.


Parameters


Returns






CODE DESCRIP

0 "File Download complete"

1 "Error cleaning up after file download"

-1 "Error completing file download"


<Status Error="0" Code="0" Descrip="File Download complete"/>


<Status Error="1" Code="-1" Descrip="Error completing file download" />

2.1.5.11 GETEXPORTSTATUS

Poll for the status of an ExportLocator (page 29) operation. Call as many times as needed until operation iscomplete. See Polling Recommendations for more information on polling best practices.


Parameters


Returns

Here is the returned Code with Descrip and Info attributes from the returned Status XML. AnyCode whoseDescrip is “Running” means you must poll again; “Finished” means no more polling is required.Code “2”is the desired completion code for a valid Export.

CODE DESCRIP INFO

1 "Running" "Queued for Export"



CODE DESCRIP INFO

2 *** Not used ***

3 "Finished" "Locator In Use"

4 "Running" "Return CheckedOut for Export"

5 "Finished" "Unable to Export"

6 "Running" "Export in progress"

7 "Running" "Staging Export file"


<Status Error="0" Code="2" Descrip="Finished" Info="File export complete"Ident="20060714_15_56_{8A932A61-6A32-4FF2-928E-3919E7E4DA88}\ABCMTI.XML"/>


<Status Error="1" Code="5" Descrip="Finished" Info="Unable to Export" />

2.1.5.12 GETFILESIZE

Get the size of a file to be downloaded, before downloading. Use theGetFileSizemethod to retrieve file sizebefore calling FileDownload (page 31)so you will know howmany chunks will be required.


Parameters

fileName - Single File ID string from the list returned in the Ident attribute of the Status XML when the jobcompletion status was polled.

Returns






CODE DESCRIP

0 "File size calculated successfully"

-1 "File not found – The file <filename> does not exist"

In addition, an XML element named size will be included that contains the (long) size of the file in bytes.


<Status Error="0" Code="0" Descrip="File size calculated successfully"/>

<size>124567</size>

2.1.5.13 GETIMPORTSTATUS

Poll for the status of an ImportLocator (page 46) operation. Call as many times as needed until operation iscomplete. See Polling Recommendations for more information on polling best practices.


Parameters

jobId – The batch job id returned in the Ident attribute of an ImportLocator (page 46)method call.

Returns

The Code attribute of the returned Status XML will be one of the following values (also includes the Descripand Info attributes). AnyCode whose Descrip is “Running” means you must poll again; “Finished” meansno more polling is required.Code “3” is the desired completion code for a valid Import.



CODE DESCRIP INFO

1 "Running" "Queued for Import"

2 "Running" "Generating Import File"

3 "Finished" "File Import complete"

4 "Finished" "File In Use - Submit Again for Import"

5 "Finished" "Couldn't Create New Locator - Submit Again for Import"

6 "Finished" "Unable to Import"

7 "Finished" "Import in progress"

8 "Finished" "Import Check In in Progress"

9 "Finished" "Import aborted. User does not have Add Return Rights"

2.1.5.14 GETINITIALIZETEQSTATUS

Poll for the status of an InitializeTEQ (page 47) operation. Call as many times as needed until operation iscomplete. See Polling Recommendations (page 3) for more information on polling best practices.


Parameters

jobId - The batch job id returned in the Ident attribute of an InitializeTEQ (page 47)method call.

Return Values:

An XML string which contains a root element named Status will be returned. AnyCode whose Descrip is“Running” means you must poll again; “Finished” means no more polling is required.Code “3” is thedesired completion code for a valid Initialize.

The Status XML string will have the following attributes:




Code – The Code attribute of the XML string will be one of the following values (also includes the Descrip andInfo attributes):

CODE DESCRIP INFO

1 "Running" "Queued for Initialize"

2 "Running" "Initializing TEQ"

3 "Finished" "Initialize complete"

4 "Finished" “Unable to Initialize”


6 "Finished" “Invalid Year”

7 "Finished" "Unable to create TEQ locator"

8 "Finished" "User does not have sufficient rights"

9 "Finished" "HYPOLocator already transferred"

Ident - This attribute will exist and contain the newly created TEQ locator number only on success as shown inthe example below (Code = 1, Error = 0).


<Status Error="0" Code="3" Descrip="Finished" Info="Initialize complete"Ident="ABC123"/>


<Status Error="1" Code="7" Descrip="Finished" Info="Unable to create TEQlocator" />

2.1.5.15 GETPLATFORMEXTENSIONSTATUS

Poll for the status of a RunPlatformExtension (page 56) operation. Call as many times as needed untiloperation is complete. See Polling Recommendations (page 3) for more information on polling bestpractices.




Parameters

jobId - The batch job id returned in the Ident attribute of a RunPlatformExtension (page 56)method call.

Returns

Here is the returned Code with Descrip and Info attributes from the returned Status XML. AnyCode whoseDescrip is “Running” means you must poll again; “Finished” means no more polling is required. Code “e”is the desired completion code.

CODE DESCRIP INFO

1 "Running" "Run PlatformExtension in progress"

2 "Finished" "Unable to Run PlatformExtension”

3 "Finished" "Run PlatformExtension completed"

4 "Finished" "Unable to retrieve locator"

2.1.5.16 GETPRINTSTATUS

Poll for the status of a PrintLocator (page 52) operation. Call as many times as needed until operation iscomplete. See Polling Recommendations (page 3) for more information on polling best practices.


Parameters

jobId - The batch job id returned in the Ident attribute of a PrintLocator (page 52)method call.



Returns

Here is the returned Code with Descrip and Info attributes from the returned Status XML. AnyCode whoseDescrip is “Running” means you must poll again; “Finished” means no more polling is required.Code “2”is the desired completion code for a valid Print.

CODE DESCRIP INFO

1 "Running" "Queued for Print"

2 "Finished" "Print Return complete" –Ident has file ID list


4 "Running" "Print in progress"

5 "Finished" "Unable to Print Return"

When the Code is “2”, the Ident attribute has a semicolon-separated list of File IDs to download. For each FileID call, the FileDownload (page 31)method to download the Printed tax return files to your local machine.

2.1.5.17 GETPROFORMASTATUS

Poll for the status of a ProformaLocator (page 54) operation. Call as many times as needed until operation iscomplete. See Polling Recommendations (page 3) for more information on polling best practices.


Parameters

jobId - The batch job id returned in the Ident attribute of an ProformaLocator (page 54)method call.

Return Values





Code – The Code attribute of the XML string will be one of the following values (also includes the Descrip andInfo attributes as follows):

CODE DESCRIP INFO

1 "Running" "ProformaQueued"

2 "Running" "Proforma in progress"

3 "Finished" "Proforma complete"

4 "Finished" "Current year locator does not exist"

5 "Finished" "Next year data archived to CD"

6 "Finished" "Next year tax defaults do not exist"

7 "Finished" "Unable to ProformaReturn: [descriptive reason for failure]"


<Status Error="0" Code="3" Descrip="Finished" Info="Proforma complete" />


<Status Error="1" Code="7" Descrip="Finished" Info="Unable to ProformaReturn: Final return selected"/>

2.1.5.18 GETSAVEASSTATUS

Poll for the status of a SaveAs (page 56) operation. Call as many times as needed until operation is complete.See Polling Recommendations (page 3) for more information on polling best practices.




Parameters


locatorId – The GoSystem locator id on which to perform a 'save as'.

taxYear – The tax year of the locator on which to perform a 'save as'.

taxType – The tax type of the locator on which to perform a 'save as'.


Returns




CODE DESCRIP

0 “Locator saved”

-1 "<multiple possibilities; most often a bad param indication>"

-2 "Failed to retrieve locator"

-3 "Invalid Password"

-4 "The locator is busy"




<Status Error="0" Code="0" Descrip="Locator Saved" />

Return Value Fail:

<Status Error="1" Code="-1" Descrip="<multiple possibilities; most oftena bad param indication>" />




2.1.5.19 GETTRANSFERSTATUS

Poll for the status of a TransferLocator (page 59) operation. Call as many times as needed until operation iscomplete. See Polling Recommendations (page 3) for more information on polling best practices.


Parameters

jobId - The batch job id returned in the Ident attribute of a TransferLocator (page 59)method call.

Return Values

An XML string which contains a root element named Status will be returned. AnyCode whose Descrip is“Running” means you must poll again; “Finished” means no more polling is required.Code “3” is thedesired completion code for a valid Transfer.

The Status XML string will have the following attributes:


Code – The Code attribute of the XML string will be one of the following values (also includes the Descrip andInfo attributes):



CODE DESCRIP INFO

1 "Running" "Queued for Transfer"

2 "Running" "Transferring locator"

3 "Finished" "Transfer complete"

4 "Finished" “Unable to transfer locator”

5 "Finished" "Invalid FromAccount"

6 "Finished" "Invalid To Account"

7 "Finished" “Invalid Year”

8 "Finished" "User does not have sufficient rights"

Ident - This attribute will exist and contain the newly created TEQ locator number only on success as shown inthe example below:

(Code = 1, Error = 0).


<Status Error="0" Code="3" Descrip="Finished" Info="Transfer complete"Ident="ABC123"/>


<Status Error="1" Code="4" Descrip="Finished" Info="Unable to transferlocator" />

2.1.5.20 GETTRANSFERTOMTISTATUS

Poll for the status of a TransferToMTI (page 60)operation. Call as many times as needed until operation iscomplete. See Polling Recommendations (page 3)for more information on polling best practices.




Parameters

jobId - The batch job id returned in the Ident attribute of an TransferToMTI (page 60)method call.

Returns


(Code = 1, Error = 0).


CODE DESCRIP INFO

1 "Running" "JobQueued"

2 "Finished" "Transfer to MTI complete"


4 "Running" "Transfer in progress"

5 "Finished" "Unable to Transfer"

6 "Finished" "Transfer Failed"


<Status Error="0" Code="3" Descrip="Finished" Info="Transfer to MTIcomplete" />


<Status Error="1" Code="5" Descrip="Finished" Info="Unable to Transfer"/>



2.1.5.21 GETXMLVALIDATORERRORS (MTI ONLY)

This method will download XML validation errors for MTI only. You should call this after receiving an XMLvalidation error on an MTI Import or Export call.


Parameters

firm – GoSystem RSFirm

account– GoSystem RSAccount

locatorId – GoSystem RS Locator Number of Tax Return

taxYear – 4-digit tax year of tax return

operationType – Enumerated value indicating retrieval of validation errors for Import or Export operation.Operation type is defined as “eImport” (value ‘0’) or “eExport” (value ‘1’) or use enumeration values defined in“RSTaxServicesInterface.RSTaxServices.OpType”

xmlValidationErrors - Upon success, this parameter will contain contents of XML validation error file in XMLformat.

Returns


Error (non-zero - error, 0 – no error, chunk uploaded successfully)


<Status Error="0" Code="0" Descrip="success"/>




<Status Error="1" Code="-1" Descrip="[descriptive reason for failure]" />

2.1.5.22 IMPORTLOCATOR

Import a tax return into GoSystem.

The sequence of web method calls to import tax return data are:

1. CreateLocator (page 11) (returns a new locator id; omit if you do not need to create a new return)

2. AppendChunk (page 10) (call as many times as needed to upload entire data file; if you are using theRSTAXSERVICES client DLL, then this call is handled within the ImportLocator (page 46)method)

3. ImportLocator (page 46) (if you made a call to CreateLocator (page 11), use the returned locator id inthis call)

4. GetImportStatus (page 35) (call until return indicates success or failure)

Note that when importing a CSV-formatted data file, if the locator id is left blank in the headerrecord, then a new locator will be created independently of any previous call to CreateLocator(page 11).


Parameters

importType

The type of import is unique to a specific file format (i.e., CSV) and product (i.e., Data Connection). Thefollowing values are just a few of the possible import types. Tax & Accounting will provide instructions on whichtype to use or additional values if needed.



IMPORTTYPE EXPORTED FILEFORMAT

DESCRIPTION

DCIMPORT CSV Import tax return data into GoSystem

IEXIMPORT XML Import tax return data into GoSystem

TEQXMLIMP XML Import Tax Equalization (TEQ) tax return data into GoSystem




taxType - Tax return type. One of the following string literals: 1040, 1041, 1065, 1120, 990, 706, 709, 5500.The single-character internal tax type is also acceptable.


entityName - If a return must be created, the taxpayer or entity name to use on the tax return

fileName – filename to import; must match the filename specified in AppendChunk (page 10) during theupload.

Returns

Status xml,Code="0" and Ident attribute=JobID of the Import job if successful. Use the Job ID as theparameter toGetImportStatus (page 35).

2.1.5.23 INITIALIZETEQ

Initialize a new TEQ return.




Parameters



taxType - Tax return type; valid list is: 1040, 1041, 1065, 1120, 990, 706, 709, 5500. The single-characterinternal tax type is also acceptable.

locatorId - 6-digit GoSystem RS Locator number of the tax return to create TEQ return from

password - GoSystem RS Locator password

Returns

Status XML,Code="0" and Ident attribute=JobID of the InitializeTEQ job if successful. Use the Job ID asthe parameter toGetInitializeTEQStatus (page 36).

2.1.5.24 LOCATORASSIGNMENT

Group and user assignments for a locator.




Parameters

xmlLocatorAssignment – An XML representation of a new locator assignment. An XSD is included in theWeb Services Client Setup (LocatorAssignment.xsd) if you wish to validate your XML prior to calling themethod. Note that the RSTAXSERVICES client DLL will perform this validation prior to calling the web service.

Format is as follows:



Returns






CODE DESCRIP INFO

0 “Locator assignment successful” “<see below>”

-1 "<multiple possibilities; most often a badparam indication>"

-2 "Locator assignment failed"

-3 "Validator error" <containsmore detailed info>

-4 "XML Parser error"

-5 “Invalid user”

-6 "Locator assignment failed" <containsmore detailed info>


<Status Error="0" Code="0" Descrip="Locator assignment successful"Info="<see below>" />

Because there are numerous result possibilities associated with locator assignment, additional information willbe contained within the Info tag. A sample of the returned data is as follows:



Note that the web service will return the above data with the characters
at the end ofeach line. These characters represent a newline/carriage return. If you are using theRSTAXSERVICESCLIENT.DLL, then those characters are automatically replaced with the moreconventional '\r\n'.

Return Value Fail:

<Status Error="1" Code="-1" Descrip="<multiple possibilities; most oftena bad param>" />

<Status Error="1" Code="-2" Descrip="Locator assignment failed" />

<Status Error="1" Code="-3" Descrip="Validation error" Info="<containsmore detailed info>" />

<Status Error="1" Code="-4" Descrip="XML Parser error" />

<Status Error="1" Code="-5" Descrip="Invalid user" />

<Status Error="1" Code="-6" Descrip="Locator assignment failed"Info="<contains more detailed info>" />

2.1.5.25 PRINTLOCATOR

Print a tax return.

After initiating the print, your code must poll every so often using theGetPrintStatus (page 38)method to waitfor the batch operation to complete on the Thomson Reuters servers, then use the FileDownload (page 31)method to download the file to your local machine.









applicationType – Application type, “GRS” for GoSystem RS or “MTI” for MyTaxInfo

printOutput – Area to Print

PRINTOUTPUT VALUES FORMYTAXINFO ORGANIZER(APPTYPE = "MTI")

0 All Items

1 Itemswith data

2 Completed Items

3 Comments

4 Attachments

5 CustomQuestions

PRINTOUTPUT VALUES FORGOSYSTEM TAX RETURN(APPTYPE = "GRS")

1 Complete Return

2 Federal Return

3 All State & City return(s)

outputType - Output format/type (ex: "PDF", "XML"(future))

Returns

Status XML:Code="0" and Ident attribute=”JobID” if the Print job is successful. Use the Job ID as theparameter toGetPrintStatus (page 38).



The Code attribute of the XML string will be one of the following values (also includes the Descrip attribute asfollows):

CODE DESCRIP

0 "JobQueued"

1 "Invalid locator"

2 "Invalid OutputType"

3 "Invalid Application Type"

4 "Invalid Password"

5 "Unable to queue job"

2.1.5.26 PROFORMALOCATOR

Rolls over a return from one year to the next.


Parameters


locatorId - 6 character Locator Number

taxYear - 4-digit current Tax Year (YYYY) of the locator

taxType - Tax Type (ex: 1040, 1065 etc)

password - RS password (required if password protected)



overwrite - 0-Bypass, 1-Overwrite the return data for the destination year if it already exists. Note setting thisto “1” requires the user to have either the Rollover without delete rights or the Delete Return group right set inAccess Control in the application.

Return Values




CODE DESCRIP

0 "ProformaQueued"

1 "Invalid Locator"

2 "Unable to queue proforma"


4 "User does not have access to account"

5 "User does not sufficient rights"

6 "Product not purchased"

7 "Proforma already in progress"

Ident - This attribute will only exist and contain the Job ID (BatchID) if the job is queued successfully (Code=0,Error=0) as shown in the example below.

Return Value Success Example

<Status Error="0" Code="0" Descrip="Proforma Queued"Ident="20060718\18\55\{D478DE34-C007-4020-9383-AC890E13318E}"/>

Return Value Fail Example

<Status Error="1" Code="1" Descrip="Invalid locator" />

All business rules applied by GoSystem to verify the eligibility of a return for rollover will be incorporated into thismethod.



2.1.5.27 RUNPLATFORMEXTENSION

Runs a platform extension method against a specific locator. This method initiates the operation. UseGetPlatformExtensionStatus (page 37) to poll for completion.


Parameters


taxYear – The tax year of the locator.

taxType – The tax type of the locator.

locatorId – The GoSystem locator id to run the PlatformExtension on.

PlatformExtension – The string identifier of the Platform Extension to run. Check with your accountrepresentative for a complete listing of these identifiers.


Returns


Status xml,Code="0" and Ident attribute=JobID of the RunPlatformExtension job if successful. Use theJobID as the parameter toGetPlatformExtensionStatus (page 37).

2.1.5.28 SAVEAS

Performs a 'save as' operation on an existing locator. This method initiates the operation. UseGetSaveAsStatus to poll for completion.

The new "saved as" locator id will be returned via this method's successful response in the "Ident" attribute.




Parameters


locatorId – The GoSystem locator id on which to perform a 'save as'.

taxYear – The tax year of the locator on which to perform a 'save as'.

taxType – The tax type of the locator on which to perform a 'save as'.

clientCode – The GoSystem client code. (optional)

taxPayerLastName – The taxpayer's last name. (required for 1040, 706, 709 returns)

taxPayerFirstName – The taxpayer's first name. (required)

taxPayerInitial – The taxpayer's initial. (optional)

spouseLastName – The spouse's last name. (optional)

spouseInitial – The spouse's initial. (optional)


Returns





Code, Descrip, Ident

CODE DESCRIP IDENT

0 "Job queued" <new locator id>

-1 “<multiple possibilities; most often abad param indication>”

-2 “Failed to retrieve locator”

-3 “The locator is busy”

-4 “Locator in Use”

-5 “Return cannot be saved undersame taxpayer name“

-6 “Failed to retrieve locator”

-7 “Account has no valid RS productassigned“

-8 “Invalid Password”

-9 “A general failure occurredattempting to perform a 'save as' onthe specified return”

-10 “Unable to queue job”

Return Value Success

<Status Error="0" Code="0" Descrip="Job queued" Ident="<new locator id>"/>

Return Value Fail

<Status Error="1" Code="-1" Descrip="<multiple possibilities; most oftena bad param indication>" />



<Status Error="1" Code="-4" Descrip="Locator In Use" />



<Status Error="1" Code="-5" Descrip="Return cannot be saved under sametaxpayer name" />


<Status Error="1" Code="-7" Descrip="Account has no valid RS productassigned" />


<Status Error="1" Code="-9" Descrip="A general failure occurredattempting to perform a 'save as' on the specified return" />

<Status Error="1" Code="-10" Descrip="Unable to queue job" />

2.1.5.29 TRANSFERLOCATOR

Transfer a locator from one account to another.


Parameters

locatorId - 6-digit GoSystem RS Locator number of the tax return to move


fromAccount - Account Code to transfer locator from

toAccount - Account Code to transfer locator to

copyOrMove - Make a copy or move the locator (C- Copy, M- Move)



Return Value

Status XML,Code="0" and Ident attribute=JobID of the TransferLocator job if successful. Use the Job ID asthe parameter toGetTransferStatus (page 42).

2.1.5.30 TRANSFERTOMTI

Performs a compute and transfers/exports return to MyTaxInfo.


Parameters






useTaxPayerEmail - Value indicating the use of TPEmail

useCCEmail – Value indicating the use of CCEmail

useReplyToEmail – Value indicating the use of ReplyToEmail

Returns






CODE DESCRIP

0 "Transfer Queued"

1 "Invalid Locator"

2 "Unable to queue transfer”


4 "Product not purchased"

Ident - This attribute will only exist and contain the Transfer Job ID (BatchID) if the job is queued successfully(Code=0, Error=0) as shown in the example below.


<Status Error="0" Code="0" Descrip="Transfer Queued"Ident="20060718\18\55\{D478DE34-C007-4020-9383-AC890E13318E}"/>


<Status Error="1" Code="1" Descrip="Invalid Locator" />

2.1.5.31 VALIDATECREDENTIALS

This method validates the credentials supplied in the WS-Security SAML Attribute token. The rules for invalidcredentials are the same as those for the RS application, i.e. you will lock out an account if you supplyinvalid credentials too many times in a row. There are no parameters; the credentials to validate areretrieved from the WS-Security token in the SOAP header.


Returns

Status XML, Error = 0,Code = 0 and Descrip = “Authenticated” if authenticated.



2.1.5.32 VALIDATELOCATOR

This method validates a locator number for a given Account, Year and TaxType against a user’s (Tax Payer’s)social security number.


Parameters




locatorId - Locator to be validated

taxPayerSSN - TaxPayer SSN

Returns



Code (0 - no error, -1 – error)

Descrip- "Locator Valid" Or "Locator Invalid" Or "Invalid Credentials"




<Status Error="0" Code="0" Descrip="Locator Valid" />

Return Value Fail:

<Status Error="1" Code="-1" Descrip="Locator Invalid" Info="InvalidCredentials" />

<Status Error="1" Code="-1" Descrip="Locator Invalid" Info="A generalinitialization failure has occurred"/>

<Status Error="1" Code="-1" Descrip="Locator Invalid" Info="A generalinitialization failure has occurred"/>

<Status Error="1" Code="-1" Descrip="Locator Invalid" Info="The accountparameter is null or empty" />

<Status Error="1" Code="-1" Descrip="Locator Invalid" Info="The accountparameter is out of the accepted range" />

<Status Error="1" Code="-1" Descrip="Locator Invalid" Info="The yearparameter is null or empty" />

<Status Error="1" Code="-1" Descrip="Locator Invalid" Info="The yearparameter is out of the accepted range" />

<Status Error="1" Code="-1" Descrip="Locator Invalid" Info="The tax typeparameter is null or empty" />

<Status Error="1" Code="-1" Descrip="Locator Invalid" Info="The tax typeparameter is out of the accepted range" />

<Status Error="1" Code="-1" Descrip="Locator Invalid" Info="The locatorid parameter is null or empty" />

<Status Error="1" Code="-1" Descrip="Locator Invalid" Info="The locatorid parameter is out of the accepted range" />

<Status Error="1" Code="-1" Descrip="Locator Invalid" Info="The SSNparameter is null or empty" />

<Status Error="1" Code="-1" Descrip="Locator Invalid" Info="The SSNparameter is invalid" />


2.2 RSTAXSERVICES CLIENT DLL

2.2.1 USING THE .NET/COM – CALLABLE INTERFACE MODULE

The .NET assembly includes all of the required methods to make use of the various features of the web serviceincluding handling all security-related elements, and allows Thomson Reuters to make necessary changes tothe XML security and credential-passing infrastructure in the future without changing the programming on theclient’s side (updates should involve nothing more than dropping in replacement DLLs from Thomson Reuters).

Users calling from non-Windows environments will need to use the WSDL to generate their own clientprogramming components.

Thomson Reuters provides a compiled Help file (.CHM) which contains all of the documentationnecessary to use the module, including sample source code for each method.

2.2.2 SERVER CONFIGURATION

Because the interface is accessed via a .NET assembly, .NET 4.0 must be installed on the machines that will beusing the Thomson Reuters DLL. In addition, the current version usesWSE 3.0 runtime files. Both the .NETFramework and the WSE runtime can be downloaded from Microsoft.

If your application will be calling the interface from a .NET application, you can simply reference the assembliesand install them with your application.

The control will call the Thomson Reuters web service using SSL on port 443; the client’s firewall must allowoutbound connections on port 443 from the machines accessing the service.

A typical install would therefore be:

l an IIS 5 or IIS 6 web server, or perhaps a Windows 2003 batch job processor (depending on how the clientplans to access the service)

l with .NET Framework 4.0 installed (from Microsoft)

l and WSE 3.0 runtime files (from Microsoft)

l along with the Thomson Reuters-provided DLLs

2.2.3 CLIENT INSTALL PACKAGE

The client install package consists of a number of DLL, documentation, and other files, including:


66

2.2 RSTAXSERVICES Client DLL

ThomsonReuters.WebServices.RSTaxServicesClient.dll

The primary client DLL for accessing the RSTAXSERVICEweb service.

ThomsonReuters.WebServices.EFSSClient.dll

The primary client DLL for accessing the EFSSweb service.

ThomsonReuters.WebServices.ClientLogging.dll

ClientLogging is a configurable logging mechanism that causes either of the RSTAXSERVICES or EFSS clientDLL to output TRACE information to a file. By default, this logging is off. See Client DLL Logging (page 5) formore information.

ThomsonReuters.Validation.DataValidator.dll

The DataValidator provides methods you can use to verify data is in the correct format or is otherwise validbefore making your web service calls. Note that many of these verification calls are baked into theRSTAXSERVICES client DLL (as well as into the service itself) already.

ThomsonReuters.WebServices.Resources.dll

The Resources DLL contains tokens representing the strings returned from the various web methods.

SAMLToken.dll

The SAMLToken DLL is a .NET utility assembly that contains much of the SAML security infrastructure requiredby the RS Tax web service. It is not necessary to make direct use of this assembly; the RSTAXSERVICES orEFSS client DLLs will make use of it for you.

ThomsonReuters.WebServices.RSTaxServicesClient.tlb

The type library corresponding to the RSTAXSERVICE client DLL’s COM interface.

RSTaxServicesInterface.chm

This is the primary help file for RS Tax web services. It contains technical information and sample code.

Demo Code

The client install includes a demo application and source code demonstrating the use of the RSTAXSERVICESClient DLL. It can be found at:

C:\ProgramFiles\Tax & Accounting\Tax & AccountingWeb Services\samples\RSTaxWPFDemo


67

2.2 RSTAXSERVICES Client DLL

This demo requires valid GoSystem credentials and runs against the Tax & Accounting production environmentin order to best simulate how your own application will run. This means that as per theXML Firewall Requirements (page 2), the IP address from which you are calling our web services must beentered into our firewall rules or access to the web service will be blocked.


3 APPENDIX A: DOCUMENT CHANGEHISTORYVERSION DATE NOTES

2.0 Added information toCreateUser (page 23).

Formattingmodifications.

1.0.152.4 Removed EFSS documentation to separate document and updatedmethod parameters onCreate1120Locator (page 14) andCreateLocatorWithEntityTypeAndReturnType (page 19)

1.0.152.2 Added RSTaxServicemethods

1.0.146.1 2012-10-12 AddedUpdated RSTaxService and EFSSmethods.

1.0.135.3 2011-03-02 AddedEFSSmethod,SubmitEFileForBatchId.

Added documentation forWSDL Versions (page 7) to theRSTAXSERVICE web service section.

1.0.133.1 2011-02-03 Added Ident attribute containing new locator id toSaveAs (page 56)method.

1.0.127.2 2010-12-30 Documentation for new methods,CreateUser (page 23) andLocatorAssignment (page 48).

1.0.111.3 2010-09-02 AddedClient DLL Logging (page 5) section toOverview (page 1).

AddedDemo Code (page 66) section toClient Install Package (page65).

1.0.103.4 2010-07-26 Aligned document version with software release version.

Added new Polling Recommendations (page 3) section.

Updated RSTAXSERVICES webmethods per Release Notes.

1.2 2008-10-21 Updated Import/Export types.


69 3 Appendix A: Document Change History

VERSION DATE NOTES

1.1 2008-07-01 Updated functional descriptions of RS Tax Service and EFSS web services.

Additional detail added to theClient Install Package (page 65) section.

1.0 2008-05-12 Formattingmodifications.


tax & accounting web services

Documents