WebServices Manual
-
Upload
jeyshree-gkm -
Category
Documents
-
view
72 -
download
0
description
Transcript of WebServices Manual
-
5/22/2018 WebServices Manual
1/40
1 DIT Web Services
This section provides the details of Web Services provided by DIT including data typesand required user privileges. DIT offers following Web Services.
i. Retrieve PA Infor!ation
ii. Sub!it "ul# ITR
iii. Retrieve $%AS Infor!ation
iv. Retrieve Rectification Status
v. Retrieve Refund Status
vi. Retrieve ITR&' Status
vii. Add (lient Details
viii.Sub!it "ul# PA
i). Retrieve TA Infor!ation
). Retrieve ITR&'
-
5/22/2018 WebServices Manual
2/40
1.1 Retrieve PA Infor!ation
https*++inco!eta)indiaefiling.gov.in+e&,ilingWS+ditws+PanWS.wsdl
This web service is only for "ul# Pan -uery user/)ternal Agency0.
1.1.1 Parameters
Request
S. No. Input
Fields
Description Validation Mandatory
1 userName User ID of the user The User ID should be of 10
characters.
Yes
2 password Password of the user Yes3 Pan PAN of the client PAN should be of 10 characters.
Examle! AAAPA0000A
Yes
Response
S. No. Output Fields Description
1 Pan PAN
2 Ffullname "ather#s full name3 Address Address of the
4 Dob Date of $irth of
5 Fullname Assess full name
6 Error Error if an%
1.1.2 SOAP
Request
&soaen'!En'eloe xmlns!soaen'()htt!**schemas.xmlsoa.or+*soa*en'eloe*)xmlns!an()htt!**anws.dit.tcs.com*) xmlns!t%()htt!**anws.dit.tcs.com*t%es*),
&soaen'!-eader*,
&soaen'!$od%,
&an!+etPanInfo,
&lo+in,
&t%!userName,xxxxxxxxxx&*t%!userName,
https://incometaxindiaefiling.gov.in/e-FilingWS/ditws/PanWS.wsdlhttps://incometaxindiaefiling.gov.in/e-FilingWS/ditws/PanWS.wsdl -
5/22/2018 WebServices Manual
3/40
&t%!assword,xxxxxxxxxx&*t%!assword,
&*lo+in,
&anNo,
&t%!anNo,xxxxxxxxxx&*t%!anNo,
&*anNo,
&*an!+etPanInfo,
&*soaen'!$od%,
&*soaen'!En'eloe,
Response:
&en'!En'eloe xmlns!en'()htt!**schemas.xmlsoa.or+*soa*en'eloe*),
&en'!-eader *,
&en'!$od%,&ns!+etPanInfo/esonse xmlns!ns()htt!**anws.dit.tcs.com*t%es*)
xmlns()) xmlns!ns()htt!**anws.dit.tcs.com*),
&result,
&ns!an,xxxxxxxxxx&*ns!an,
&ns!ffullname,xxxxxxxxxx&*ns!ffullname,
&ns!address,xxxxxxxxxx&*ns!address,
&ns!dob,xxxxxxxxxx&*ns!dob,
&ns!fullname,xxxxxxxxxx&*ns!fullname,
&ns!error xmlns!xsi()htt!**www.w.or+*001*2345chema6instance)
xsi!nil()true) *,
&*result,
&*ns!+etPanInfo/esonse,
&*en'!$od%,
&*en'!En'eloe,
Error
1env*/nvelope )!lns*env23http*++sche!as.)!lsoap.org+soap+envelope+34
1env*5eader+4
1env*"ody4
1env*,ault )!lns*ns623http*++sche!as.)!lsoap.org+soap+envelope+34
1faultcode4ns6*(lient+Server1+faultcode4
-
5/22/2018 WebServices Manual
4/40
1faultstring )!l*lang23en34/rror 7essage1+faultstring4
1+env*,ault4
1+env*"ody4
1+env*/nvelope4
1.1.3 Error Messages
Scenario Error Message
8ser ID not provided in request Please provide the 8ser ID.
Incorrect 8ser ID Authentication failed. Please provide a valid 8ser ID.
Password not provided in request Please provide the Password.
Incorrect Password Authentication failed. Please provide a valid Password.
PA field left blan# Please provide a PA .
9ess nu!ber of characters entered in PA Invalid PA. Please retry.
PA entered in wrong for!at Invalid PA. Please retry.
PA does not e)ist PA does not e)ist.
-
5/22/2018 WebServices Manual
5/40
1.2 Submit Bul IT!
https*++inco!eta)indiaefiling.gov.in+e&,ilingWS+ditws+sub!itITR.wsdl
1.2.1 Parameters
Request
S. No. Input Fields Description Validation Mandatory
1 userID User ID of the user The User ID should be
of 10 characters.
Yes
2 password Password of the user Yes
3 certChan 7ertification chain Yes
4 s!nature 5i+nature Yes
5 "p
Attachment8i attachment which containsIT/ xml files
Yes
Response
S. No. Output Fields Description
1 result To#en u!ber
1.2.2 SOAP
Request
&soaen'!En'eloe xmlns!soaen'()htt!**schemas.xmlsoa.or+*soa*en'eloe*)
xmlns!'()htt!**incometaxindiaefilin+.+o'.in*ws*ds*common*'9190),
&soaen'!-eader*,
&soaen'!$od%,
&'!DIT:5AuthInfoEle, &'!userID,xxxxxxxxxx&*'!userID,
&'!assword,xxxxxxxxxx&*'!assword,
&'!cert7hain,xxxxxxxxxx&*'!cert7hain,
&'!si+nature,xxxxxxxxxx&*'!si+nature,
&*'!DIT:5AuthInfoEle,
&*soaen'!$od%,
https://incometaxindiaefiling.gov.in/e-FilingWS/ditws/submitITR.wsdlhttps://incometaxindiaefiling.gov.in/e-FilingWS/ditws/submitITR.wsdl -
5/22/2018 WebServices Manual
6/40
&*soaen'!En'eloe,
Response
&en'!En'eloe xmlns!en'()htt!**schemas.xmlsoa.or+*soa*en'eloe*),
&en'!-eader*,
&en'!$od%,
&ns!DIT:5/esonseEle xmlns!ns()htt!**incometaxindiaefilin+.+o'.in*ws*ds*common*'9190),
&ns!result,xxxxxxxxxx&*ns!result,
&*ns!DIT:5/esonseEle,
&*en'!$od%,
&*en'!En'eloe,
Error1env*/nvelope )!lns*env23http*++sche!as.)!lsoap.org+soap+envelope+34
1env*5eader+4
1env*"ody4
1env*,ault )!lns*ns623http*++sche!as.)!lsoap.org+soap+envelope+34
1faultcode4ns6*(lient+Server1+faultcode4
1faultstring )!l*lang23en34/rror 7essage1+faultstring4
1+env*,ault4
1+env*"ody4
1+env*/nvelope4
1.2.3 Error Messages
Scenario Error Message
8ser ID not provided in request Please provide the 8ser ID.
Incorrect 8ser ID Authentication failed. Please provide a valid 8ser ID.
Password not provided in request Please provide the Password.
Incorrect Password Authentication failed. Please provide a valid Password.
-
5/22/2018 WebServices Manual
7/40
(ertificate chain not provided Please provide the (ertificate (hain
Signature not provided Please provide a Digital Signature (ertificate.
The digital signature certificate does not !atch with theone registered
Invalid Digital Signature (ertificate. Please retry.
Invalid Digital signature certificate. Invalid Digital Signature (ertificate. Please contact your(ertificate Provider.
The trusted parent certificate could not be verified Invalid Digital Signature (ertificate. The trusted parentcertificate could not be verified.
1.2." IT! #M$ %I$E %ormat
The /nd user ITR :79 file consists of the Ta) returns data which the Service provider prepared for the/nd user.This :79 file should be a valid 8T,&; /ncoding )!l file and should adhere to the sche!a provided by theDepart!ent of Inco!e Ta).
In case the /nd user needs to sign the file with his class ll Digital (ertificate< SP should provide aninterface to the /nd user to sign his :79 using the /nveloping :79 digital Signature API described below.
1.2.4.1 XML Signature Representation
= :79 Signature is identified by the root 1Signature4 ele!ent.
$ Infor!ation about the original data ob>ect that is signed is represented in the 1Signature4 ele!ent via 8ri?s.
ITRService interface is supporting below given type of signature
Envelo&ing signature* where the data ob>ect is e!bedded within the :79 Signature.
1.2.".1.1 Basic #M$ Signature Structure
&5i+nature ID;,
&5i+nedInfo,
&7anonicali
-
5/22/2018 WebServices Manual
8/40
&Di+est3ethod*,
&Di+est>alue*,
&*/eference,?@
&*5i+nedInfo,
&5i+nature>alue*, =&e%Info*,?;
=&BbCect ID; *,?
&*5i+nature,
;!
-
5/22/2018 WebServices Manual
9/40
1.2.".1.2 #M$ Signature 'eneration
1.2.".1.3 #M$ Signature S(nta)
(ore Synta)* these are !andatory and are required to be supported by the confir!ing
i!ple!entations.
@ptional Signature Synta)* these ele!ents are optional to i!ple!ent. (an only appear
as a child of the 1@b>ect4 ele!ent.
*ore S(nta)+
The 1Signature4 /le!ent* is the !ain ele!ent of :79 Signature. It can e)ist as a
standalone docu!ent< can envelop the data ob>ect that it signs< or it can be envelopedby the data ob>ect.
The 1Signature4 has the following child ele!ents in order in which they appear*
ds*SignedInfo.
ds*Signature'alue.
ds*eyInfo.
ds*@b>ect.
ApplyTransforms
CalcDigest
Add DigestAlgorithm
Add TransformAlgorithm
Add
XM Data
ApplyCanonicli!ation Algorithm
Add
ApplySignature Algorithm
"ptional#eyInformation
-
5/22/2018 WebServices Manual
10/40
T,e -Signaturealue/ Element* contains the actual value of the digital signature. It
does not have any child ele!ents
and has one Id attribute.
T,e -Signe0Ino/ Element* it contains references to the original data ob>ect and
includes the canonincaliBation and signature algorith!s. The encrypted digest of thecanonical for! of the 1SignedInfo4represents the value of the :79 signature. And it has
an Id attribute and the following child ele!ents*
ds*(anonicaliBation7ethod.
ds*Signature7ethod.
ds*Reference.
T,e -*anonicaliationMet,o0/* specifies the canonicaliBation algorith!
applied to the 1SignedInfo4< the algorith! used is identified by the Algorith!
attribute< and it per!it one child ele!ent which can be fro! any na!espace.
T,e -SignatureMet,o0/ Element+specifies the algorith! used for signature
generation< this algorith! identifies all cryptographic functions involved in the
signature generation< and it has one attribute algorith!< and includes this
ele!ent*
T,e Signature met,o0 s,oul0 be RSA-SHA1as
1Signature7ethod Algorith!23http*++www.wC.org+$666+6+)!ldsigErsa&sha=3+4
T,e -!eerence/ Element+ it carries the digest value of the data ob>ect and
optionally references to the original data ob>ect. It !ay include a 1Transfor!s4< it
has the following child ele!ents*
ds* Digest7et>hod.
ds* Digest'alue.
And it has three attributes*
o Id.
o 8RI.
o Type.
T,e !eerence element !I s,oul0 be t,e PA4 o t,e SE! as
&/eference U/I()2222211112),
T,e -DigestMet,o0/ Element* specifies the digest algorith! to be used for
the original data ob>ect or transfor!ed if any 1Transfor!s4 e)ists.
The Di+est3ethod should follow the sha1 Al+orithm
-
5/22/2018 WebServices Manual
11/40
&Di+est3ethod Al+orithm()htt!**www.w.or+*000*0F*xmldsi+sha1)*,
T,e -Digestalue/ Element* contains the value of the digest.
T,e -5e(Ino/ Element* is an optional ele!ent that enables #ey infor!ation to
be pac#aged along with the :79 Signature. It can contain #eys< #eys na!esecta!e of the /nd 8ser (ertificate
o The :F6(ertificate G This is the co!plete chain of the
:F6(ertificate of the /nd user certificate and should
have all the certificate chains
.
The -Ob6ect//le!ent* is an child ele!ent of 1Signature4< and typically used
for enveloping signature where the data ob>ect being signed is included in the
1Signature4 ele!ent. It can have any child ele!ents and it has tree attributes*
ID< 7i!e Type< and /ncoding.
The ID attribute should be the PA nu!ber of the 8ser as 1@b>ect
Id23:::::====:34 and the @b>ect /le!ent contains the 8ser IT Return :79
/le!ents.
1.2.".1." Algorit,m Su&&orte0
:79 Signature specification defines a standard usage !odel for a set of algorith!s that can
be used with the specification. 7essage Digest*
o S5A&=.
Signature Algorith!s*
o P(S= RSAHS5A=0.
(anonicaliBation Algorith!s*
o (anonical :79 with co!!ents.
-
5/22/2018 WebServices Manual
12/40
The SP has to ip all the Signed and unsigned :79 together as one IP file and upload it through the Web
Service.
The SP shall not !erge the signed :79 together as one bul# :79.
The SP shall !erge the 8nsigned :79 together as one bul# :!l but he has to ip the file together
-
5/22/2018 WebServices Manual
13/40
1.3 !etrieve 27AS Inormation
https*++inco!eta)indiaefiling.gov.in+e&,ilingWS+ditws+Jet$%asInfo.wsdl
1.3.1 Parameters
Request
S. No. Input
Fields
Description Validation Mandatory
1 userName User ID of the user The User ID should beof 10 characters.
Yes
2 password Password of the user Yes
3 Pan PAN for which GA5 information is
reHuired
PAN should be of 10
characters.Examle!
AAAPA0000A
Yes
4 dob Date Bf $irth*Incororation of thePAN
It should be a 'alidxml date. The format
is YYYY6336DD.
Examle! 1F60J61K
Yes
5 assessmen
t$earAssessment Year Examle! 01161 Yes
Response TDS @n Salary TDS @ther than Salary T(S Ta)pay!ents@9TAS data0
TDS @n Salary*
S. No. Output Fields Description
1 TAN TAN
Emlo%erBrDeductorBr7ollecterName TAN Name
Inc7hr+5al Income char+eable on salar%
TotalTD55al Total TD5 5alar%
TDS @n @ther than Salary*
https://incometaxindiaefiling.gov.in/e-FilingWS/ditws/Get26asInfo.wsdlhttps://incometaxindiaefiling.gov.in/e-FilingWS/ditws/Get26asInfo.wsdl -
5/22/2018 WebServices Manual
14/40
S. No. Output Fields Description
1 TAN TAN
Emlo%erBrDeductorBr7ollecterName TAN Name
TotTD5BnAmtPaid Total TD5 amount aid
7laimButBfTotTD5BnAmtPaid Total TD5 amount claimed
T(S*
S. No. Output Fields Description
1 TAN TAN
Emlo%erBrDeductorBr7ollecterName TAN Name
TotalT75 Total T75
AmtT757laimedThisYear Amount claimed for this %ear
Ta) Pay!ents*
S. No. Output Fields Description
1 $5/7ode $5/ 7ode
DateDe Date deosited
5rlNoBf7haln 5erial Number of 7hallan
Amt Amount
If no infor!ation is present for the PA and assess!ent year then Ko record found for theAssess!ent LearK will be displayed.
1.3.2 SOAP
Request
&soaen'!En'eloe xmlns!soaen'()htt!**schemas.xmlsoa.or+*soa*en'eloe*)xmlns!'()htt!**incometaxindiaefilin+.+o'.in*ditws*tds*'9190),
&soaen'!-eader*,
&soaen'!$od%,
&'!+etTD5Details,
&'!4o+inInfo,
&'!userName,xxxxxxxxxx&*'!userName,
&'!assword,xxxxxxxxxx&*'!assword,
&*'!4o+inInfo,
&'!7lientInfo,
-
5/22/2018 WebServices Manual
15/40
&'!an,xxxxxxxxxx&*'!an,
&'!dob,xxxxxxxxxx&*'!dob,
&'!assessmentYear,xxxxxxxxxx&*'!assessmentYear,
&*'!7lientInfo,
&*'!+etTD5Details,
&*soaen'!$od%,
&*soaen'!En'eloe,
Response
1env*/nvelope )!lns*env23http*++sche!as.)!lsoap.org+soap+envelope+34
1env*5eader+4
1env*"ody4
1JetTDSResponse )!lns*ns$23http*++inco!eta)indiaefiling.gov.in+!aster3)!lns*nsC23http*++inco!eta)indiaefiling.gov.in+ditws+tds+vH=H634
1nsC*TDSonSalaries4
1ns$*TDSonSalary4
1ns$*/!ployer@rDeductor@r(ollectDetl4
1ns$*TA4))))))))))1+ns$*TA4
1ns$*/!ployer@rDeductor@r(ollectera!e4))))))))))1+ns$*/!ployer@rDeductor@r(ollectera!e4
1+ns$*/!ployer@rDeductor@r(ollectDetl4
1ns$*Inc(hrgSal4))))))))))1+ns$*Inc(hrgSal4
1ns$*TotalTDSSal4))))))))))1+ns$*TotalTDSSal4
1+ns$*TDSonSalary4
1+nsC*TDSonSalaries4
1nsC*TDSon@thThanSals4
1ns$*TDSon@thThanSal4
1ns$*/!ployer@rDeductor@r(ollectDetl4
1ns$*TA4))))))))))1+ns$*TA4
1ns$*/!ployer@rDeductor@r(ollectera!e4))))))))))S1+ns$*/!ployer@rDeductor@r(ollectera!e4
1+ns$*/!ployer@rDeductor@r(ollectDetl4
1ns$*TotTDS@nA!tPaid4))))))))))1+ns$*TotTDS@nA!tPaid4
1ns$*(lai!@ut@fTotTDS@nA!tPaid4))))))))))1+ns$*(lai!@ut@fTotTDS@nA!tPaid4
1+ns$*TDSon@thThanSal4
-
5/22/2018 WebServices Manual
16/40
1+nsC*TDSon@thThanSals4
1nsC*ScheduleT(S4
1ns$*T(S4
1ns$*/!ployer@rDeductor@r(ollectDetl4
1ns$*TA4))))))))))1+ns$*TA4
1ns$*/!ployer@rDeductor@r(ollectera!e4))))))))))1+ns$*/!ployer@rDeductor@r(ollectera!e4
1+ns$*/!ployer@rDeductor@r(ollectDetl4
1ns$*TotalT(S4))))))))))1+ns$*TotalT(S4
1ns$*A!tT(S(lai!edThisLear4))))))))))1+ns$*A!tT(S(lai!edThisLear4
1+ns$*T(S4
1+nsC*ScheduleT(S4
1nsC*Ta)Pay!ents4
1ns$*Ta)Pay!ent4
1ns$*"SR(ode4))))))))))1+ns$*"SR(ode4
1ns$*DateDep4))))))))))1+ns$*DateDep4
1ns$*Srlo@f(haln4))))))))))1+ns$*Srlo@f(haln4
1ns$*A!t4))))))))))1+ns$*A!t4
1+ns$*Ta)Pay!ent4
1+nsC*Ta)Pay!ents4 1+JetTDSResponse4
1+env*"ody4
1+env*/nvelope4
Error
1env*/nvelope )!lns*env23http*++sche!as.)!lsoap.org+soap+envelope+34
1env*5eader+4
1env*"ody4
1env*,ault )!lns*ns623http*++sche!as.)!lsoap.org+soap+envelope+34
-
5/22/2018 WebServices Manual
17/40
1faultcode4ns6*(lient+Server1+faultcode4
1faultstring )!l*lang23en34/rror 7essage1+faultstring4
1+env*,ault4
1+env*"ody4
1+env*/nvelope4
1.3.3 Error Messages
Scenario Error Message
8ser ID not provided in request Please provide the 8ser ID.
Incorrect 8ser ID Authentication failed. Please provide a valid 8ser ID.
Password not provided in request Please provide the Password.
Incorrect Password Authentication failed. Please provide a valid Password.
PA field left blan# Please provide a PA.
9ess nu!ber of characters entered in PA Invalid PA. Please retry.
PA entered in wrong for!at Invalid PA. Please retry.
PA does not e)ist PA does not e)ist.
PA not added as a client for /RI This PA is not added as a client.
Assess!ent year is not selected Please provide the Assess!ent Lear.
Date of birth+incorporation field is left blan# Please provide date of birth
Date of birth+incorporation is not !atching Date of "irth is not !atching
-
5/22/2018 WebServices Manual
18/40
1." !etrieve !ectiication Status
https*++inco!eta)indiaefiling.gov.in+e&,ilingWS+ditws+rectificationstatus.wsdl
1.".1 Parameters
Request
S. No. Input
Fields
Description Validation Mandatory
1 userName User ID of the user The User ID should be of 10characters.
Yes
2 password Password of the user Yes
3 Pan PAN of the client PAN should be of 10 characters.Examle! AAAPA0000A
Yes
4 assessmen
t$ear Assessment Year E2!01161 Yes
Response
S. No. Output Fields Description
1 pano PA
asseess!entLear Assess!ent Lear
itra!e ITR na!e
rectificationReferenceo Rectification Reference u!ber
K date Rectification Date
G cpc@rdero (P( order nu!ber
date (P( order date
J status Status
1.".2 SOAP
Request
&soaen'!En'eloe xmlns!soaen'()htt!**schemas.xmlsoa.or+*soa*en'eloe*)
xmlns!'()htt!**incometaxindiaefilin+.+o'.in*ditws*IT/>5tatus*'9190),
&soaen'!-eader*,
&soaen'!$od%,
&'!+et/ectification5tatus/eHuest,
&4o+inInfo,
&userName,xxxxxxxxxx&*userName,
https://incometaxindiaefiling.gov.in/e-FilingWS/ditws/rectificationstatus.wsdlhttps://incometaxindiaefiling.gov.in/e-FilingWS/ditws/rectificationstatus.wsdl -
5/22/2018 WebServices Manual
19/40
&assword,xxxxxxxxxx&*assword,
&*4o+inInfo,
&/ectificationInut,
&anNo,xxxxxxxxxx&*anNo,
&asseessmentYear,xxxxxxxxxx&*asseessmentYear,
&*/ectificationInut,
&*'!+et/ectification5tatus/eHuest,
&*soaen'!$od%,
&*soaen'!En'eloe,
Response
&en'!En'eloe xmlns!en'()htt!**schemas.xmlsoa.or+*soa*en'eloe*),
&en'!-eader*,
&en'!$od%, &ns!+et/ectification5tatus/esonse
xmlns!ns()htt!**incometaxindiaefilin+.+o'.in*ditws*IT/>5tatus*'9190),
&result,
&anNo,xxxxxxxxxx&*anNo,
&asseessmentYear,xxxxxxxxxx&*asseessmentYear,
&itrName,xxxxxxxxxx&*itrName,
&rectification,
&rectification/eferenceNo,xxxxxxxxxx&*rectification/eferenceNo, &date,xxxxxxxxxx&*date,
&*rectification,
&ccBrder,
&ccBrderNo,xxxxxxxxxx&*ccBrderNo,
&date,xxxxxxxxxx&*date,
&*ccBrder,
&details xsi!nil()true) xmlns!xsi()htt!**www.w.or+*001*2345chema6instance)*,
&status,xxxxxxxxxx&*status,
&*result,
&*ns!+et/ectification5tatus/esonse,
&*en'!$od%,
&*en'!En'eloe,
-
5/22/2018 WebServices Manual
20/40
Error
1env*/nvelope )!lns*env23http*++sche!as.)!lsoap.org+soap+envelope+34
1env*5eader+4
1env*"ody4
1env*,ault )!lns*ns623http*++sche!as.)!lsoap.org+soap+envelope+34
1faultcode4ns6*(lient+Server1+faultcode4
1faultstring )!l*lang23en34/rror 7essage1+faultstring4
1+env*,ault4
1+env*"ody4
1+env*/nvelope4
1.".3 Error Messages
Scenario Error Message
8ser ID not provided in request Please provide the 8ser ID.
Incorrect 8ser ID Authentication failed. Please provide a valid 8ser ID.
Password not provided in request Please provide the Password.
Incorrect Password Authentication failed. Please provide a valid Password.
PA field left blan# Please provide a PA .
9ess nu!ber of characters entered in PA Invalid PA. Please retry.
PA entered in wrong for!at Invalid PA. Please retry.
PA does not e)ist PA does not e)ist.
PA not added as a client for /RI This PA is not added as a client.
Assess!ent year is not selected Please provide the Assess!ent Lear.
Assess!ent year entered in wrong for!at /nter 'alid Assess!ent Lear
-
5/22/2018 WebServices Manual
21/40
1.8 !etrieve !eun0 Status
https*++inco!eta)indiaefiling.gov.in+e&,ilingWS+ditws+refundstatus.wsdl
1.8.1 ParametersRequest
S. No. Input
Fields
Description Validation Mandatory
1 userName User ID of the user The User ID should be of 10
characters.
Yes
2 password Password of the user Yes
3 Pan PAN of the client PAN should be of 10 characters.Examle! AAAPA0000A
Yes
4 assessmen
t$earAssessment Year E2!01161 Yes
Response
S. No. Output Fields Description
1 result Refund Status
1.8.2 SOAP
Request
&soaen'!En'eloe xmlns!soaen'()htt!**schemas.xmlsoa.or+*soa*en'eloe*)
xmlns!'()htt!**incometaxindiaefilin+.+o'.in*ditws*IT/>5tatus*'9190),
&soaen'!-eader*,
&soaen'!$od%,
&'!+et/efund5tatus/eHuest,
&4o+inInfo,
&userName,xxxxxxxxxx&*userName,
&assword,xxxxxxxxxx&*assword,
&*4o+inInfo,
&/efundInut,
&anNo,xxxxxxxxxx&*anNo,
&asseessment%ear,xxxxxxxxxx&*asseessment%ear,
https://incometaxindiaefiling.gov.in/e-FilingWS/ditws/refundstatus.wsdlhttps://incometaxindiaefiling.gov.in/e-FilingWS/ditws/refundstatus.wsdl -
5/22/2018 WebServices Manual
22/40
&*/efundInut,
&*'!+et/efund5tatus/eHuest,
&*soaen'!$od%,
&*soaen'!En'eloe,
Response
&en'!En'eloe xmlns!en'()htt!**schemas.xmlsoa.or+*soa*en'eloe*),
&en'!-eader*,
&en'!$od%,
&ns!+et/efund5tatus/esonsexmlns!ns()htt!**incometaxindiaefilin+.+o'.in*ditws*IT/>5tatus*'9190),
&result,xxxxxxxxxx&*result,
&*ns!+et/efund5tatus/esonse,
&*en'!$od%,
&*en'!En'eloe,
Error
1env*/nvelope )!lns*env23http*++sche!as.)!lsoap.org+soap+envelope+34
1env*5eader+4
1env*"ody4
1env*,ault )!lns*ns623http*++sche!as.)!lsoap.org+soap+envelope+34
1faultcode4ns6*(lient+Server1+faultcode4 1faultstring )!l*lang23en34/rror 7essage1+faultstring4
1+env*,ault4
1+env*"ody4
1+env*/nvelope4
1.8.3 Error Messages
Scenario Error Message
8ser ID not provided in request Please provide the 8ser ID.
Incorrect 8ser ID Authentication failed. Please provide a valid 8ser ID.
Password not provided in request Please provide the Password.
-
5/22/2018 WebServices Manual
23/40
Incorrect Password Authentication failed. Please provide a valid Password.
PA field left blan# Please provide a PA.
9ess nu!ber of characters entered in PA Invalid PA. Please retry.
PA entered in wrong for!at Invalid PA. Please retry.
PA does not e)ist PA does not e)ist.
PA not added as a client for /RI This PA is not added as a client.
Assess!ent year is not selected Please provide the Assess!ent Lear.
-
5/22/2018 WebServices Manual
24/40
1.7 !etrieve IT!9 Status
htts!**incometaxindiaefilin+.+o'.in*e6"ilin+:5*ditws*itr'status.wsdl
1.7.1 Parameters
Request
S. No. Input
Fields
Description Validation Mandatory
1 Pan PAN PAN should be of 10 characters.
Examle! AAAPA0000A
Yes
2 assessment
Year
Assessment Year E2!01161 $es
Response
S. No. Output Fields Description
1 result ITR&' Status
1.7.2 SOAP
Request
&soaen'!En'eloe xmlns!soaen'()htt!**schemas.xmlsoa.or+*soa*en'eloe*)xmlns!'()htt!**incometaxindiaefilin+.+o'.in*ditws*IT/>5tatus*'9190),
&soaen'!-eader*,
&soaen'!$od%,
&'!+etIT/>5tatus/eHuest,
&PAN,xxxxxxxxxx&*PAN,
&AssessmentYear,xxxxxxxxxx&*AssessmentYear,
&*'!+etIT/>5tatus/eHuest,
&*soaen'!$od%,&*soaen'!En'eloe,
Response
&en'!En'eloe xmlns!en'()htt!**schemas.xmlsoa.or+*soa*en'eloe*),
&en'!-eader *,
&en'!$od%,
https://incometaxindiaefiling.gov.in/e-FilingWS/ditws/itrvstatus.wsdlhttps://incometaxindiaefiling.gov.in/e-FilingWS/ditws/itrvstatus.wsdl -
5/22/2018 WebServices Manual
25/40
&ns!+etIT/>5tatus/esonse xmlns())
xmlns!ns()htt!**incometaxindiaefilin+.+o'.in*ditws*IT/>5tatus*'9190),
&result,xxxxxxxxxx&*result,
&*ns!+etIT/>5tatus/esonse,
&*en'!$od%,
&*en'!En'eloe,
Error
1env*/nvelope )!lns*env23http*++sche!as.)!lsoap.org+soap+envelope+34
1env*5eader+4
1env*"ody4
1env*,ault )!lns*ns623http*++sche!as.)!lsoap.org+soap+envelope+34
1faultcode4ns6*(lient+Server1+faultcode4
1faultstring )!l*lang23en34/rror 7essage1+faultstring4 1+env*,ault4
1+env*"ody4
1+env*/nvelope4
1.7.3 Error Messages
Scenario Error MessagePA field left blan# Please provide a PA .
9ess nu!ber of characters entered in PA Invalid PA. Please retry.
PA entered in wrong for!at Invalid PA. Please retry.
PA does not e)ist PA does not e)ist.
PA not added as a client for /RI This PA is not added as a client.
Assess!ent year is not selected Please provide the Assess!ent Lear.
Assess!ent year entered in wrong for!at /nter 'alid Assess!ent Lear
-
5/22/2018 WebServices Manual
26/40
1.: A00 *lient Details
htts!**incometaxindiaefilin+.+o'.in*e6"ilin+:5*ditws*add7lientDetails.wsdl
1.:.1 Parameters
Request
S. No. Input
Fields
Description Validation Mandatory
1 userName User ID of the user The User ID should be of 10
characters.
Yes
2 password Password of the user Yes3 Pan PAN of the client PAN should be of 10 characters.
Examle! AAAPA0000AYes
4 dob Date Bf$irth*Incororation of
the PAN
It should be a 'alid xml date.The format is YYYY6336DD.
Examle! 1F60J61K
Yes
5 emal E6mail Id of client It should be 'alid e6mail id Yes
6 addClent
%ptonBtions for add client It should be either of!
tdsBtion L ad'anceTaxBtion
orTaxNot"iled"or4astTwoYears
Yes
& tanNumber TAN TAN should be of 10 characters. Yes if #tdsBtion#
is slected
' fnancal
$ear"inancial Year Ex! 01161 Yes if #tdsBtion#
is slected
( bsrCode $5/ 7ode It should be di+it. Yes if
#ad'anceTaxBtionT%e# is
slected
1) assessment$ear Assessment Year E2!01161 Yes if#ad'anceTaxBti
onT%e# isslected
11 amountPa
dAmount Paid It should be numeric and
maximum of 1 di+its.
Yes if
#ad'anceTaxBti
onT%e# isslected
https://incometaxindiaefiling.gov.in/e-FilingWS/ditws/addClientDetails.wsdlhttps://incometaxindiaefiling.gov.in/e-FilingWS/ditws/addClientDetails.wsdl -
5/22/2018 WebServices Manual
27/40
Response
S. No. Output Fields Description
1 result Add (lient Status
1.:.2 SOAP
Request
&soaen'!En'eloe xmlns!soaen'()htt!**schemas.xmlsoa.or+*soa*en'eloe*)
xmlns!'()htt!**incometaxindiaefilin+.+o'.in*ditws*add7lientDetails*'9190),
&soaen'!-eader*,
&soaen'!$od%,
&'!add7lientDetails,
&'!4o+inInfo,
&'!userName,xxxxxxxxxx&*'!userName,
&'!assword,xxxxxxxxxx&*'!assword,
&*'!4o+inInfo,
&'!add7lient,
&'!add7lientDetails,
&'!anNumber,xxxxxxxxxx&*'!anNumber,
&'!dateBf$irth,xxxxxxxxxx&*'!dateBf$irth,
&'!email,xxxxxxxxxx&*'!email,
&'!add7lientBtion,xxxxxxxxxx&*'!add7lientBtion,
&'!add7lientBtionDetails,
&'!tdsBtion,
&'!tanNumber,xxxxxxxxxx&*'!tanNumber,
&'!financialYear,xxxxxxxxxx&*'!financialYear,
&*'!tdsBtion,
&'!ad'anceTaxBtion,
&'!bsr7ode,xxxxxxxxxx&*'!bsr7ode,
&'!assessmentYear,xxxxxxxxxx&*'!assessmentYear,
&'!amountPaid,xxxxxxxxxx&*'!amountPaid,
&*'!ad'anceTaxBtion,
&*'!add7lientBtionDetails,
-
5/22/2018 WebServices Manual
28/40
&*'!add7lientDetails,
&*'!add7lient,
&*'!add7lientDetails,
&*soaen'!$od%,
&*soaen'!En'eloe,
Response
&en'!En'eloe xmlns!en'()htt!**schemas.xmlsoa.or+*soa*en'eloe*),
&en'!-eader*,
&en'!$od%,
&ns!add7lientDetails/esonsexmlns!ns()htt!**incometaxindiaefilin+.+o'.in*ditws*add7lientDetails*'9190),
&ns!result,xxxxxxxxxx&*ns!result,
&*ns!add7lientDetails/esonse,
&*en'!$od%,
&*en'!En'eloe,
Error
1env*/nvelope )!lns*env23http*++sche!as.)!lsoap.org+soap+envelope+34
1env*5eader+4
1env*"ody4
1env*,ault )!lns*ns623http*++sche!as.)!lsoap.org+soap+envelope+34 1faultcode4ns6*(lient+Server1+faultcode4
1faultstring )!l*lang23en34/rror 7essage1+faultstring4
1+env*,ault4
1+env*"ody4
1+env*/nvelope4
1.:.3 Error Messages
Scenario Error Message
8ser ID not provided in request Please provide the 8ser ID.
Incorrect 8ser ID Authentication failed. Please provide a valid 8ser ID.
Password not provided in request Please provide the Password.
-
5/22/2018 WebServices Manual
29/40
Incorrect Password Authentication failed. Please provide a valid Password.
PA field left blan# Please provide a PA .
9ess nu!ber of characters entered in PA Invalid PA. Please retry.
PA entered in wrong for!at Invalid PA. Please retry.
PA does not e)ist PA does not e)ist.
Assess!ent year is not selected Please provide the Assess!ent Lear.
Assess!ent year entered in wrong for!at /nter 'alid Assess!ent Lear
o ta) paid in the last $ yearsK option is selected but userKsta) records are available in TDS+@9TAS db
,iling of Ta) has been done in the last two years. Pleaseenter the details.
Details donKt !atch with @9TAS db Incorrect Advance Ta)+Self Assess!ent Ta). Please retry.
A!ount paid field left blan# Please provide the A!ount.
9ess than M digits entered in "SR code field Please enter a valid M digit "SR (ode.
"SR code field is left blan# Please provide the "SR (ode.
Details donKt !atch with TDS+T(S db Incorrect TDS+T(S infor!ation. Please retry.
o financial year is entered Please provide the ,inancial Lear.
/&!ail ID entered in an incorrect for!at Invalid /&!ail ID. Please retry.
/&!ail ID of the assesse is not entered Please provide the /&!ail ID.
Incorrect date of birth entered Invalid Date of "irth. Please retry.
Date of birth field left blan# Please provide a Date of "irth.
PA already added as a client with the sa!e /RI This PA is already added as a client.
-
5/22/2018 WebServices Manual
30/40
1.; Submit Bul PA4
htts!**incometaxindiaefilin+.+o'.in*e6"ilin+:5*ditws*submit$ulMPan.wsdl
1.;.1 Parameters
Request
S. No. Input
Fields
Description Validation Mandatory
1 userName User ID of the user The User ID should be of 10characters.
Yes
2 password Password of the user Yes
3 *ml fle :79 file as S@AP
attach!ent
Yes
Response
S. No. Output Fields Description
1 result To#en u!ber
1.;.2 SOAP
Request
&soaen'!En'eloe xmlns!soaen'()htt!**schemas.xmlsoa.or+*soa*en'eloe*)
xmlns!'()htt!**incometaxindiaefilin+.+o'.in*bulMPanser'ice*'9190),
&soaen'!-eader*,
&soaen'!$od%,
&'!submit$ulMPan,
&'!4o+inInfo,
&'!userName,xxxxxxxxxx&*'!userName,
&'!assword,xxxxxxxxxx&*'!assword,
&*'!4o+inInfo,
&*'!submit$ulMPan,
&*soaen'!$od%,
&*soaen'!En'eloe,
Response
https://incometaxindiaefiling.gov.in/e-FilingWS/ditws/submitBulkPan.wsdlhttps://incometaxindiaefiling.gov.in/e-FilingWS/ditws/submitBulkPan.wsdl -
5/22/2018 WebServices Manual
31/40
&en'!En'eloe xmlns!en'()htt!**schemas.xmlsoa.or+*soa*en'eloe*),
&en'!-eader*,
&en'!$od%,
&ns!DIT:5/esonse xmlns!ns()htt!**incometaxindiaefilin+.+o'.in*bulMPanser'ice*'9190),
&ns!result,xxxxxxxxxx&*ns!result,
&*ns!DIT:5/esonse,
&*en'!$od%,
&*en'!En'eloe,
Error
1env*/nvelope )!lns*env23http*++sche!as.)!lsoap.org+soap+envelope+34
1env*5eader+4
1env*"ody4 1env*,ault )!lns*ns623http*++sche!as.)!lsoap.org+soap+envelope+34
1faultcode4ns6*(lient+Server1+faultcode4
1faultstring )!l*lang23en34/rror 7essage1+faultstring4
1+env*,ault4
1+env*"ody4
1+env*/nvelope4
1.;.3 Error Messages
Scenario Error Message
8ser ID not provided in request Please provide the 8ser ID.
Incorrect 8ser ID Authentication failed. Please provide a valid 8ser ID.
Password not provided in request Please provide the Password.
Incorrect Password Authentication failed. Please provide a valid Password.
:79 not provided Please provide an :79 file.
Two :79 files provided Please provide only one :79 file.
on :79 file is selected Please provide a valid :79.
Incorrect :79 sche!a The :79 Sche!a is invalid. Please provide the :79 in thecorrect sche!a.
-
5/22/2018 WebServices Manual
32/40
1.< !etrieve TA4 Inormation
htts!**incometaxindiaefilin+.+o'.in*e6"ilin+:5*ditws*etTAN.wsdl
1.
-
5/22/2018 WebServices Manual
33/40
1.
-
5/22/2018 WebServices Manual
34/40
&ABT%e,xxxxxxxxxx&*ABT%e,
&ran+e7ode,xxxxxxxxxx&*ran+e7ode,
&ABNumber,xxxxxxxxxx&*ABNumber,
&*TanInfo,
&*ns!TanInfo/esonse,
&*en'!$od%,
&*en'!En'eloe,
Error
1env*/nvelope )!lns*env23http*++sche!as.)!lsoap.org+soap+envelope+34
1env*5eader+4
1env*"ody4
1env*,ault )!lns*ns623http*++sche!as.)!lsoap.org+soap+envelope+34 1faultcode4ns6*(lient+Server1+faultcode4
1faultstring )!l*lang23en34/rror 7essage1+faultstring4
1+env*,ault4
1+env*"ody4
1+env*/nvelope4
1.
-
5/22/2018 WebServices Manual
35/40
1.1= !etrieve IT!9
htts!**incometaxindiaefilin+.+o'.in*e6"ilin+:5*ditws*+etIT/>.wsdl
1.1=.1 !etrieve IT!9 >it, Acno>le0gment 4umber
1.10.1.1 Parameters
Request
S. No. Input
Fields
Description Validation Mandatory
1 userID User ID of the user The User ID should be of 10
characters.
Yes
2 password Password of the user Yes
3 certChan Yes
4 s!nature Yes
5 ac-nowled
!ementNo
Efilin+
AcMnowled+mentNumber
Yes
Response
S. No. Output Fields Description
1 result Status of ITR processing
1.10.1.2 SOAP
Request
&soaen'!En'eloe xmlns!soaen'()htt!**schemas.xmlsoa.or+*soa*en'eloe*)xmlns!'()htt!**incometaxindiaefilin+.+o'.in*ws*ds*itr'*'9190)
xmlns!'1()htt!**incometaxindiaefilin+.+o'.in*ws*ds*common*'9190),
https://incometaxindiaefiling.gov.in/e-FilingWS/ditws/getITRV.wsdlhttps://incometaxindiaefiling.gov.in/e-FilingWS/ditws/getITRV.wsdl -
5/22/2018 WebServices Manual
36/40
&soaen'!-eader*,
&soaen'!$od%,
&'!itr'AcMNo/eHuestEle,
&'!authInfo,
&'1!userID,2222222222&*'1!userID,
&'1!assword,xxxxxxxxxx&*'1!assword,
&'1!cert7hain,xxxxxxxxxx&*'1!cert7hain,
&'1!si+nature,xxxxxxxxxx&*'1!si+nature,
&*'!authInfo,
&'!acMnowled+ementNo,xxxxxxxxxx&*'!acMnowled+ementNo,
&*'!itr'AcMNo/eHuestEle,
&*soaen'!$od%,
&*soaen'!En'eloe,
Response
&en'!En'eloe xmlns!en'()htt!**schemas.xmlsoa.or+*soa*en'eloe*),
&en'!-eader*,
&en'!$od%,
&ns!DIT:5/esonseEle xmlns!ns()htt!**incometaxindiaefilin+.+o'.in*ws*ds*common*'9190),
&ns!result,xxxxxxxxxx&*ns!result,
&*ns!DIT:5/esonseEle,
&*en'!$od%,
&*en'!En'eloe,
Error
1env*/nvelope )!lns*env23http*++sche!as.)!lsoap.org+soap+envelope+34 1env*5eader+4
1env*"ody4
1env*,ault )!lns*ns623http*++sche!as.)!lsoap.org+soap+envelope+34
1faultcode4ns6*(lient1+faultcode4
1faultstring )!l*lang23en34/rror 7essage1+faultstring4
1+env*,ault4
http://schemas.xmlsoap.org/soap/envelope/http://incometaxindiaefiling.gov.in/ws/ds/common/v_1_0http://schemas.xmlsoap.org/soap/envelope/http://incometaxindiaefiling.gov.in/ws/ds/common/v_1_0 -
5/22/2018 WebServices Manual
37/40
1+env*"ody4
1+env*/nvelope4
1.10.1.3 Error Messages
Scenario Error Message
8ser ID not provided in request Please provide the 8ser ID.
Incorrect 8ser ID Authentication failed. Please provide a valid 8ser ID.
Password not provided in request Please provide the Password.
Incorrect Password Authentication failed. Please provide a valid Password.
(ertificate chain not provided Please provide the (ertificate (hain
Signature not provided Please provide a Digital Signature (ertificate.
The digital signature certificate does not !atch with theone registered
Invalid Digital Signature (ertificate. Please retry.
Invalid Digital signature certificate. Invalid Digital Signature (ertificate. Please contact your (ertificate Provider.
The trusted parent certificate could not be verified Invalid Digital Signature (ertificate. The trusted parentcertificate could not be verified.
Ac#nowledg!ent u!ber not provided in request Please provide Ac#nowledg!ent u!ber
Ac#nowledg!ent u!ber not provided is not valid Invalid ac#nowledg!ent nu!ber
-
5/22/2018 WebServices Manual
38/40
1.1=.2 !etrieve IT!9 >it, Toen 4umber an0 PA4
1.10.2.1 Parameters
Request
S. No. Input Fields Description Validation Mandatory
1 userID User ID of the user The User ID should be of 10
characters.
Yes
2 password Password of the
user
Yes
3 certChan Yes
4 s!nature Yes
5 to-enNumber ToMen Number of
$ulM IT/ uload
Yes
6 panID PAN of client The anID should be of 10characters.
Yes
Response
S. No. Output Fields Description
1 result Status of ITR processing
1.10.2.2 SOAP
Request
&soaen'!En'eloe xmlns!soaen'()htt!**schemas.xmlsoa.or+*soa*en'eloe*)
xmlns!'()htt!**incometaxindiaefilin+.+o'.in*ws*ds*itr'*'9190)xmlns!'1()htt!**incometaxindiaefilin+.+o'.in*ws*ds*common*'9190),
&soaen'!-eader*,
&soaen'!$od%,
&'!itr'ToMenNo/eHuestEle,
&'!authInfo,
&'1!userID,2222222222&*'1!userID,
&'1!assword,2222222222&*'1!assword,
&'1!cert7hain,2222222222&*'1!cert7hain,
-
5/22/2018 WebServices Manual
39/40
&'1!si+nature,2222222222&*'1!si+nature,
&*'!authInfo,
&'!toMenNumber,2222222222&*'!toMenNumber,
&'!anID,2222222222&*'!anID,
&*'!itr'ToMenNo/eHuestEle,
&*soaen'!$od%,
&*soaen'!En'eloe,
Response
&en'!En'eloe xmlns!en'()htt!**schemas.xmlsoa.or+*soa*en'eloe*),
&en'!-eader*,
&en'!$od%,
&ns!DIT:5/esonseEle xmlns!ns()htt!**incometaxindiaefilin+.+o'.in*ws*ds*common*'9190),
&ns!result,xxxxxxxxxx&*ns!result,
&*ns!DIT:5/esonseEle,
&*en'!$od%,
&*en'!En'eloe,
Error
1env*/nvelope )!lns*env23http*++sche!as.)!lsoap.org+soap+envelope+34
1env*5eader+4
1env*"ody4
1env*,ault )!lns*ns623http*++sche!as.)!lsoap.org+soap+envelope+34
1faultcode4ns6*(lient1+faultcode4 1faultstring )!l*lang23en34/rror 7essage1+faultstring4
1+env*,ault4
1+env*"ody4
1+env*/nvelope4
http://schemas.xmlsoap.org/soap/envelope/http://incometaxindiaefiling.gov.in/ws/ds/common/v_1_0http://schemas.xmlsoap.org/soap/envelope/http://incometaxindiaefiling.gov.in/ws/ds/common/v_1_0 -
5/22/2018 WebServices Manual
40/40
1.10.2.3 Error Messages
Scenario Error Message
8ser ID not provided in request Please provide the 8ser ID.
Incorrect 8ser ID Authentication failed. Please provide a valid 8ser ID.
Password not provided in request Please provide the Password.
Incorrect Password Authentication failed. Please provide a valid Password.
(ertificate chain not provided Please provide the (ertificate (hain
Signature not provided Please provide a Digital Signature (ertificate.
The digital signature certificate does not !atch with theone registered
Invalid Digital Signature (ertificate. Please retry.
Invalid Digital signature certificate. Invalid Digital Signature (ertificate. Please contact your (ertificate Provider.
The trusted parent certificate could not be verified Invalid Digital Signature (ertificate. The trusted parentcertificate could not be verified.
To#en u!ber not provided in request Please provide To#en u!ber
To#en u!ber not provided is not valid Invalid to#en
Specified To#en not yet processed To#en not yet processed
PA not provided in request Please provide a PA
Invalid PA Invalid PA. Please retry.
ITR for PA provided was not uploaded with To#en
provided
Pan not in to#en