Code, Descrip
EXPORTTYPE EXPORTED FILE FORMAT DESCRIPTION
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 RS Account 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
StatusXML:Code="0" andIdentattribute=”JobID” of the Export job if successful. Use the Job ID as the parameter toGetExportStatus (page 33).
2.1.5.9 FILEDOWNLOAD
Download a file chunk of an output file such as the results of anExportjob. You must call this method iteratively for as many chunks as needed to retrieve the entire file; use a maximum of 1 Meg chunk size. Use the
GetFileSize (page 34)method to retrieve file size before callingFileDownloadso you will know how many chunks will be required. Be sure to callFileDownloadComplete (page 32)after every successful download of an entire file.
SOAP Body request format:
Parameters
jobId- The batch job id returned in the Ident attribute of anExportLocator (page 29)method call.
fileId- Single File ID string from the list returned in theIdentattribute of theStatusXML when the job completion 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
An XML string which contains a root element namedStatuswith the following attributes will be returned:
Error(1-error,0–no error)
Code– TheCodeattribute of the XML string will be one of the following values (also includes theDescrip attribute 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 namedchunkwill be included that contains the base64 encoded string of the binary chunk from the file if successful.
Return Value Success Example:
<Status Error="0" Code="0" Descrip="File downloaded successfully"
Ident="ABCMTI.xml"/>
<chunk>abC1…</chunk>
Return Value Fail Example:
<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 after every successful sequence ofFileDownload (page 31)calls.
SOAP Body request format:
Parameters
jobId- The batch job id returned in the Ident attribute of anExportLocator (page 29)method call.
Returns
An XML string which contains a root element namedStatuswith the following attributes will be returned:
Error(1-error,0–no error)
Code– TheCodeattribute of the XML string will be one of the following values (also includes theDescrip attribute as follows):
CODE DESCRIP
0 "File Download complete"
1 "Error cleaning up after file download"
-1 "Error completing file download"
Return Value Success Example:
<Status Error="0" Code="0" Descrip="File Download complete"/>
Return Value Fail Example:
<Status Error="1" Code="-1" Descrip="Error completing file download" />
2.1.5.11 GETEXPORTSTATUS
Poll for the status of anExportLocator (page 29)operation. Call as many times as needed until operation is complete. See Polling Recommendations for more information on polling best practices.
SOAP Body request format:
Parameters
jobId- The batch job id returned in the Ident attribute of anExportLocator (page 29)method call.
Returns
Here is the returnedCodewithDescripandInfoattributes from the returnedStatusXML. AnyCodewhose Descripis “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 Checked Out for Export"
5 "Finished" "Unable to Export"
6 "Running" "Export in progress"
7 "Running" "Staging Export file"
Return Value Success Example:
<Status Error="0" Code="2" Descrip="Finished" Info="File export complete"
Ident="20060714_15_56_{8A932A61-6A32-4FF2-928E-3919E7E4DA88}\ABCMTI.XML"/>
Return Value Fail Example:
<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 size before callingFileDownload (page 31)so you will know how many chunks will be required.
SOAP Body request format:
Parameters
fileName- Single File ID string from the list returned in theIdentattribute of the Status XML when the job completion status was polled.
Returns
An XML string which contains a root element namedStatuswith the following attributes will be returned:
Error(1-error,0–no error)
Code– TheCodeattribute of the XML string will be one of the following values (also includes theDescrip attribute as follows):
CODE DESCRIP
0 "File size calculated successfully"
-1 "File not found – The file <filename> does not exist"
In addition, an XML element namedsizewill be included that contains the (long) size of the file in bytes.
Return Value Success Example:
<Status Error="0" Code="0" Descrip="File size calculated successfully"/>
<size>124567</size>
2.1.5.13 GETIMPORTSTATUS
Poll for the status of anImportLocator (page 46)operation. Call as many times as needed until operation is complete. See Polling Recommendations for more information on polling best practices.
SOAP Body request format:
Parameters
jobId– The batch job id returned in theIdentattribute of anImportLocator (page 46)method call.
Returns
TheCodeattribute of the returnedStatusXML will be one of the following values (also includes theDescrip andInfoattributes). AnyCodewhoseDescripis “Running” means you must poll again; “Finished” means no 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 anInitializeTEQ (page 47)operation. Call as many times as needed until operation is complete. SeePolling Recommendations (page 3)for more information on polling best practices.
SOAP Body request format:
Parameters
jobId- The batch job id returned in the Ident attribute of anInitializeTEQ (page 47)method call.