Entities

This page serves as a repository of requests and response payloads, providing a convenient reference for the seamless integration of TDS APIs. Users can access the data from this page whenever needed for different API interactions.


Compliance API

Search TAN API

FieldTypeDescriptionExample
nameOrgnstringName of the TAN EntityRON DOE PRIVATE LIMITED
nameLaststringLast Name of TAN Entity if IndividualDOE
nameFirststringFirst Name of TAN Entity if IndividualJOHN
nameMidstringMiddle Name of TAN Entity if IndividualRON
addLine1stringAddress Line 11, ABC Tower,
addLine2stringAddress Line 2Nr. ABC Tower
addLine3stringAddress Line 3Opp. XYZ
addLine4stringAddress Line 4ABCLMN Lane
addLine5stringAddress Line 5Ahmedabad, India-380015
stateCdnumberState 9
pinnumberPIN Code of the address380015
phoneNumstringPhone Number of the TAN Entity99xxxxxx83
dtTanAllotmentnumberDate of TAN Allotment1499324427000
emailId1stringEmail ID corresponding to TAN Entity[email protected]
emailId2stringAlternate Email ID corresponding to TAN Entity[email protected]

Section 206AB & 206CCA Sync API

KeyTypeDescriptionExample
panstring10-character alphanumeric unique identifier for an income taxpayerXXXPX1234A
namestringName of Taxpayer (masked)SXXXXJ MXXXXXXXXR
pan_allotment_datenumberPAN allotment date1527100200000
financial_yearstringThe financial year for which compliance check u/s 206AB & 206CCA is done. It will return the current financial year.2023-24
specifiedperson_us_206ab&_206ccastringFlag for compliance check.
Possible values:
Y
N

If Y, then a higher TDS/TCS rate is to be applied for specified persons u/s 206AB & 206CCA.
Y
pan_statusstringPossible values:
Operative
Inoperative
Operative
NotestringDisclaimerIt may be noted that as per the provisos of Section 206AB & 206CCA of the Act, the specified persons shall not include a non-resident who does not have a permanent establishment in India. Tax Deductors & Collectors are expected to carry out necessary due diligence in respect of a specified
person established by this functionality to consider him as non-specified if he falls under these provisos.

Section 206AB & 206CCA Async API (Submit Job)

KeyTypeDescriptionExample
job_idstringThe Job ID of the particular JOB. You can check the job status with the
Get Job Status AP
f24cd229-42c8-43de-af79-8ce2d3c4c3db
statusstringJob Status.JOBQUEUED

Section 206AB & 206CCA Async API (Poll Job)

KeyTypeDescriptionExample
job_idstringThe Job ID of the particular JOB. You can check the job status with the Get Job Statusf24cd229-42c8-43de-af79-8ce2d3c4c3db
statusstringJob Status. Possible Values:
JOBQUEUED
JOBDONE
JOBFAILED
JOBQUEUED
signed_urlstringLink to where you can find the result of the compliance check performed on the PAN numbers sent in the previous step. Will be provided when the status is JOBDONEhttps://s3.ap-south-1.amazonaws.com/test-compliance.reporting-portal.itd.sandbox.co.in/TDS/206-AB/f845f37e-7f05-4de9-a282-a3b23b9d370a/Compliance_Check_206AB_206CCA_1687547602270.xlsx"
panstring10-character alphanumeric unique identifier for an income taxpayerXXXPX1234A
namestringName of Taxpayer (masked)SXXXXJ MXXXXXXXXR
pan_allotment_datenumberPAN allotment date24-05-2018
specifiedperson_us_206ab&_206ccastringFlag for compliance check.
Possible value:
Y
N

If Y, then a higher TDS/TCS rate is to be applied for specified persons u/s 206AB & 206CCA.
N
pan_statusstringPossible value:
Operative,
Inoperative
Operative
specifiedperson_us_206ab&_206ccastringIt may be noted that as per the provisos of Section 206AB & 206CCA of the Act, the specified persons shall not include a non-resident who does not
have a permanent establishment in India. Tax Deductors & Collectors are expected to carry out necessary due diligence in respect of a specified
person established by this functionality to consider him as non-specified if he falls under these provisos.
Y*

TDS Return API using TXT & CSI (Submit Job)

KeyTypeDescriptionExample
job_idstringThe ID of this job. It will be used later on to check the status.f24cd229-42c8-43de-af79-8ce2d3c4c3db
statusstringstatus of the jobcreated
created_atnumberEPOCH timestamp of when job was created1701250588000
txt_urlstringPre-signed URL where you need to upload txt filehttps://.......

.
csi_urlstringPre signed URL where you need to upload csi filehttps://.....

.
tanstringTAN of the deductor for which the TDS return is being filedAHMJ01234A
formstringTDS return form type 26Q
financial_yearstringFinancial YearFY 2023-24
quarterstringQuarterQ4
filing_typestringFiling Typeoriginal

TDS Return API using TXT & CSI (Poll Job)

KeyTypeDescriptionExample
job_idstringID of the particular txt and csi uploaded. f24cd229-42c8-43de-af79-8ce2d3c4c3db
statusstringThe status the particular fvu upload. Possible Values:
created
queued
failed
succeeded
succeeded
receipt_urlstringProvides Acknowledgment of TDS Return. Will be visible only when the status is succeededhttps://s3.ap-south-1.amazonaws.com/efile.tds-compliance.sandbox.co.in/receipt.pdf
fvu_urlstringProvides FVU File of TDS Return. Will be visible only when the status is succeededhttps://....
form27a_urlstringProvides Form 27A of TDS Return. Will be visible only when the status is succeededhttps://.....
messagestringReason for not e-filing TDS return. Will be visible only when the status is failed
For possible values, refer to the TIN-FC Error Codes & Messages
Regular Statement with the same TAN, Financial Year, FORM, and Quarter is already furnished

TDS Return API using FVU & Form27A (Submit Job)

KeyTypeDescriptionExample
job_idstringThe ID of this job. It will be used later on to check the status.f24cd229-42c8-43de-af79-8ce2d3c4c3db
statusstringstatus of the jobcreated
created_atnumberEPOCH timestamp of when job was created1701250588000
fvu_urlstringPre-signed URL where you need to upload zip file of FVU and Form27Ahttps://.......

.
tanstringTAN of the deductor for which the TDS return is being filedAHMJ01234A
formstringTDS return form type 26Q
financial_yearstringFinancial YearFY 2023-24
quarterstringQuarterQ4
filing_typestringFiling Typeoriginal

TDS Return API using FVU & Form27A (Poll Job)

KeyTypeDescriptionExample
job_idstringID of the particular txt and csi uploaded. f24cd229-42c8-43de-af79-8ce2d3c4c3db
statusstringThe status the particular fvu upload. Possible Values:
created
queued
failed
succeeded
succeeded
receipt_urlstringProvides Acknowledgment of TDS Return. Will be visible only when the status is succeededhttps://s3.ap-south-1.amazonaws.com/efile.tds-compliance.sandbox.co.in/receipt.pdf
fvu_urlstringProvides FVU File of TDS Return. Will be visible only when the status is succeededhttps://....
form27a_urlstringProvides Form 27A of TDS Return. Will be visible only when the status is succeededhttps://.....
messagestringReason for not e-filing TDS return. Will be visible only when the status is failed
For possible values, refer to the TIN-FC Error Codes & Messages
Regular Statement with the same TAN, Financial Year, FORM, and Quarter is already furnished

Download Form16A Submit Job API

ParamTypeDescriptionExample
job_idstringUnique identifier of the jobf24cd229-42c8-43de-af79-8ce2d3c4c3db
tanstringTAN of deductorMUMR09719B
financial_yearstringFinancial YearFY 2023-24
quarterstringQuarterQ1
statusstringThe status of the job submitted.JOBQUEUED

Download Form16A Poll Job API

ParamTypeDescriptionExample
job_idstringThe Job ID of the particular JOB. You can check the job status with the Get Job Statusf24cd229-42c8-43de-af79-8ce2d3c4c3db
statusstringJob Status. Possible Values:
JOBQUEUED
JOBDONE
JOBFAILED
JOBQUEUED
signed_urlstringLink where we will provide the ZIP file of all the Form 16/16A in PDF format. Will be provided when the status is JOBDONEhttps://.

..
messagestringError message. Will be provided when the status is JOBFAILEDInvalid KYC data

Reporting API

TDS Reporting Submit Job API

ParamTypeDescription
job_idstringUnique Job ID to track the request
presigned_urlstringS3 URL to make the PUT request

Form 24Q

Payer

ParamTypeRequiredValidationDescription
namestringYesMax Length: 75Name of the Payer
tanstringYesPattern : [A-Z]{4}[0-9]{5}[A-Z]{1}TAN of the Payer
panstringYesPattern : [A-Z]{3}[PCFTGHLABJ]{1}[A-Z]{1}[0-9]{4}[A-Z]{1}PAN of the Payer
gstinstringNoPattern : [0-9]{2}[a-zA-Z]{5}[0-9]{4}[a-zA-Z]{1}[1-9A-Za-z]{1}[CZ]{1}[0-9a-zA-Z]{1}$|^[0-9]{4}[a-zA-Z]{3}[0-9]{5}[uUnN]{2}[0-9a-zA-Z]{1}GSTIN of the Payer
branchstringNoMax Length: 75Branch details of the Payer if multiple locations.
streetstringYesMax Length: 25Name of premise
areastringYesMax Length: 25Area of location
citystringYesMax Length: 25City of location
stateenumerationYesStateState of location
postal_codestringYesPattern : [0-9]{6}Pincode of location
emailstringYesMax Length: 75Primary email for contact
mobilestringYesPattern: [1-9]{1}[0-9]{9}Primary mobile number for contact
Responsible Person
ParamTypeRequiredValidationDescription
designationstringYesMax Length: 20Designation of the responsible person
namestringYesMax Length: 75Name of the responsible person
panstringYesPattern : [A-Z]{3}[PCFTGHLABJ]{1}[A-Z]{1}[0-9]{4}[A-Z]{1}PAN of the responsible person
streetstringYesMax Length: 25Name of the premise
areastringYesMax Length: 25Area of the location
citystringYesMax Length: 25City of location
stateenumerationYesStateState of location
postal_codestringYesPattern : [0-9]{6}Pincode of location
emailstringYesMax Length: 75Primary email for contact
mobilestringYesPattern: [1-9]{1}[0-9]{9}Primary mobile number for contact

Payee

ParamTypeRequiredValidationDescription
sr_nonumberYes-Serial Number
panstringYesPattern : [A-Z]{3}[PCFTGHLABJ]{1}[A-Z]{1}[0-9]{4}[A-Z]{1}PAN of the Payee. If payee doesn't have PAN then possible values are
PANNOTAVBL,PANAPPLIED, PANINVALID,
namestringYesMax Length: 75Name of the Payee
opting_for_taxation_us_115_bacbooleanYes-Whether Employee has opted for taxation u/s 115BAC.
employee_categoryenumerationYes-Category of Employee, Possible Values:
Women, Senior Citizen, Super Senior Citizen, General

Challan

ParamTypeRequiredValidationDescription
challan_serialstringYesPattern : [0-9]{5}Bank Challan No
bsr_codestringYesPattern : [0-9]{7}Bank-Branch Code/ Form 24G Receipt Number
paid_datenumberYesLength: 13EPOCH timestamp of the challan paid date
minor_headenumerationYesMinor HeadMinor Head of challan
tds_amountnumberYesLength: 15Income Tax
surchargenumberYesLength: 15Surcharge on Income Tax
health_and_education_cessnumberYesLength: 15Education cess on Income Tax
interestnumberYesLength: 15Interest levied upon late deduction
late_filing_feesnumberYesLength: 15Penalty levied upon late filing
other_penaltynumberYesLength: 15Any Other Penalty

Payment

ParamTypeRequiredValidationDescription
payee_sr_nonumberYes-Payee Serial Number
challan_serialstringYesPattern : [0-9]{5}Bank Challan No
bsr_codestringYesPattern : [0-9]{7}Bank-Branch Code/ Form 24G Receipt Number
sectionenumerationYesSectionTDS section of deduction
credit_amountnumberYesLength: 15,2Payment amount
credit_datenumberYesLength: 13EPOCH timestamp of Payment date
tds_amountnumberYesLength: 15,2Tax amount of deduction
surchargenumberYesLength: 15,2Surcharge on Tax amount
health_and_education_cessnumberYesLength: 15,2Eduction of the Tax amount
deduction_datenumberYesLength: 13EPOCH timestamp of Deduction date
reason_for_lower_deductionenumerationNoReason for lower deductionReason for non-deduction / lower deduction/ higher deduction/threshold
certificate_numberstringNoMax Length: 10Certificate number issued by the Assessing Officer u/s 197 for non-deduction/lower deduction.

πŸ“˜

Salary Details entity is required for Quarter 4 returns only

Salary Details

ParamTypeRequiredValidationDescription
payee_sr_nonumberYes-Payee Serial Number
employment_from_datenumberFor 192 Record OnlyLength: 13Timestamp from when employed with the current employer in the current FY
employment_to_datenumberFor 192 Record OnlyLength: 13Timestamp to which employed with the current employer in the current FY
gross_salary_from_previous_employersnumberFor 192 Record OnlyLength: 15,2Total Taxable Amount on which TDS was deducted by the previous employer
tds_by_previous_employersnumberFor 192 Record OnlyLength: 15,2TDS deducted by the previous employer in the current FY
income_tax_payablenumberYesLength: 15,2Income Tax Payable by the employee
surchargenumberYesLength: 15,2Amount of Surcharge applicable
cessnumberYesLength: 15,2Amount of Cess appliable
tds_on_salarynumberFor 192 Record OnlyLength: 15,2Total TDS deducted by the current employer in the current FY
salary_as_per_provisions_contained_in_section_17_1numberFor 192 Record OnlyLength: 15,2Gross Salary amount as per Section 17(1)
value_of_perquisites_us_17_2numberFor 192 Record OnlyLength: 15,2Value of Perquisities as per Section 17(2)
profits_in_lieu_of_salary_us_17_3numberFor 192 Record OnlyLength: 15,2Profits in lieu of Salary as per Section 17(3)
travel_concession_or_assistance_us_10_5numberFor 192 Record OnlyLength: 15,2Travel concession or assistance as per Section 10 (5)
death_cum_retirement_gratuity_us_10_10numberFor 192 Record OnlyLength: 15,2Death-cum-retirement gratuity amount as per Section 10(10)
commuted_value_of_pension_us_10_10_anumberFor 192 Record OnlyLength: 15,2Value of the commuted pension as per Section 10(10A)
cash_equivalent_of_leave_salary_encashment_us_10_10_aanumberFor 192 Record OnlyLength: 15,2Value of leave encashment as per Section 10(10AA)
house_rent_allowance_us_10_13_anumberFor 192 Record OnlyLength: 15,2Amount of house rent allowance as per Section 10(13A)
other_special_allowances_under_section_10_14numberFor 192 Record OnlyLength: 15,2
landlord_1_namestringNoMax Length: 75Name of landlord 1 when aggregate rent paid has exceeded INR 1 Lakh in the current FY
landlord_1_panstringNoPattern : [A-Z]{3}[PCFTGHLABJ]{1}[A-Z]{1}[0-9]{4}[A-Z]{1}PAN of landlord 1
landlord_2_namestringNoMax Length: 75Name of landlord 2 when aggregate rent paid has exceeded INR 1 Lakh in the current FY
landlord_2_panstringNoPattern : [A-Z]{3}[PCFTGHLABJ]{1}[A-Z]{1}[0-9]{4}[A-Z]{1}PAN of landlord 2
landlord_3_namestringNoMax Length: 75Name of landlord 3 when aggregate rent paid has exceeded INR 1 Lakh in the current FY
landlord_3_panstringNoPattern : [A-Z]{3}[PCFTGHLABJ]{1}[A-Z]{1}[0-9]{4}[A-Z]{1}PAN of landlord 3
landlord_4_namestringNoMax Length: 75Name of landlord 4 when aggregate rent paid has exceeded INR 1 Lakh in the current FY
landlord_4_panstringNoPattern : [A-Z]{3}[PCFTGHLABJ]{1}[A-Z]{1}[0-9]{4}[A-Z]{1}PAN of landlord 4
total_amount_of_any_other_exemption_us_10numberFor 192 Record OnlyLength: 15,2Any other exemption under section 10
standard_deduction_us_16_ianumberYesLength: 15,2Amount of Standard Deduction as per Section 16(ia)
entertainment_allowance_us_16_iinumberYesLength: 15,2Amount of Entertainment Allowance as per Section 16(ii)
tax_on_employment_us_16_iiinumberYesLength: 15,2Amount of Professional Tax as per Section 16(iii)
income_from_house_property_reported_by_employee_offered_for_tdsnumberFor 192 Record OnlyLength: 15,2
Can have negative values
Income under the head house property offered for TDS for Section 192 (2B) (includes admissible loss)
lender_1_namestringNoMax Length: 75Name of Lender 1 if the interest on house loan claimed under section 24(b)
lender_1_panstringNoPattern : [A-Z]{3}[PCFTGHLABJ]{1}[A-Z]{1}[0-9]{4}[A-Z]{1}PAN of lender 1
lender_2_namestringNoMax Length: 75Name of Lender 2 if the interest on house loan claimed under section 24(b)
lender_2_panstringNoPattern : [A-Z]{3}[PCFTGHLABJ]{1}[A-Z]{1}[0-9]{4}[A-Z]{1}PAN of lender 2
lender_3_namestringNoMax Length: 75Name of Lender 3 if the interest on house loan claimed under section 24(b)
lender_3_panstringNoPattern : [A-Z]{3}[PCFTGHLABJ]{1}[A-Z]{1}[0-9]{4}[A-Z]{1}PAN of lender 3
lender_4_namestringNoMax Length: 75Name of Lender 4 if the interest on house loan claimed under section 24(b)
lender_4_panstringNoPattern : [A-Z]{3}[PCFTGHLABJ]{1}[A-Z]{1}[0-9]{4}[A-Z]{1}PAN of lender 4
income_under_the_head_other_sources_offered_for_tdsnumberFor 192 Record OnlyLength: 15,2Income under the head of other sources offer for TDS under Section 192 (2b)
gross_amount_us_80_cnumberYesLength: 15,2The gross amount contributed u/s 80C
deductible_amount_us_80_cnumberYesLength: 15,2The deductible amount u/s 80C
gross_amount_us_80_cccnumberYesLength: 15,2The gross amount contributed u/s 80CCC
deductible_amount_us_80_cccnumberYesLength: 15,2The deductible amount u/s 80CCC
gross_amount_us_80_ccd_1numberYesLength: 15,2The gross amount contributed u/s 80CCD(1)
deductible_amount_us_80_ccd_1numberYesLength: 15,2The deductible amount u/s 80CCD(1)
gross_amount_us_80_ccd_1_bnumberYesLength: 15,2The gross amount contributed u/s 80CCD(1B)
deductible_amount_us_80_ccd_1_bnumberYesLength: 15,2The deductible amount u/s 80CCD(1B)
gross_amount_us_80_ccd_2numberYesLength: 15,2The gross amount contributed u/s 80CCD(2)
deductible_amount_us_80_ccd_2numberYesLength: 15,2The deductible amount u/s 80CCD(2)
gross_amount_us_80_ccgnumberYesLength: 15,2The gross amount contributed u/s 80CCG
deductible_amount_us_80_ccgnumberYesLength: 15,2The deductible amount u/s 80CCG
gross_amount_us_80_cchnumberFor 192 Record OnlyLength: 15,2
deductible_amount_us_80_cchnumberFor 192 Record OnlyLength: 15,2
gross_amount_us_80_dnumberYesLength: 15,2The gross amount contributed u/s80D
deductible_amount_us_80_dnumberYesLength: 15,2The deductible amount u/s 80D
gross_amount_us_80_ddnumberFor 194P Record OnlyLength: 15,2The gross amount contributed u/s 80DD
deductible_amount_us_80_ddnumberFor 194P Record OnlyLength: 15,2The deductible amount u/s 80DD
qualifying_amount_us_80_ddnumberFor 194P Record OnlyLength: 15,2The deductible amount u/s 80DD
gross_amount_us_80_enumberYesLength: 15,2The gross amount contributed u/s80E
deductible_amount_us_80_enumberYesLength: 15,2The deductible amount u/s 80E
gross_amount_us_80_eenumberFor 194P Record OnlyLength: 15,2The gross amount contributed u/s80EE
deductible_amount_us_80_eenumberFor 194P Record OnlyLength: 15,2The deductible amount u/s 80EE
qualifying_amount_us_80_eenumberFor 194P Record OnlyLength: 15,2The deductible amount u/s 80EE
gross_amount_us_80_eeanumberFor 194P Record OnlyLength: 15,2The gross amount contributed u/s80EEA
deductible_amount_us_80_eeanumberFor 194P Record OnlyLength: 15,2The deductible amount u/s 80EEA
qualifying_amount_us_80_eeanumberFor 194P Record OnlyLength: 15,2Qualifying amount u/s 80EEA
gross_amount_us_80_gnumberYesLength: 15,2The gross amount contributed u/s80G
deductible_amount_us_80_gnumberYesLength: 15,2The deductible amount u/s 80G
qualifying_amount_us_80_gnumberYesLength: 15,2Qualifying amount u/s 80G
gross_amount_us_80_ggnumberFor 194P Record OnlyLength: 15,2The gross amount contributed u/s80GG
deductible_amount_us_80_ggnumberFor 194P Record OnlyLength: 15,2The deductible amount u/s 80GG
qualifying_amount_us_80_ggnumberFor 194P Record OnlyLength: 15,2Qualifying amount u/s 80GG
gross_amount_us_80_ggcnumberFor 194P Record OnlyLength: 15,2The gross amount contributed u/s80GGC
deductible_amount_us_80_ggcnumberFor 194P Record OnlyLength: 15,2The deductible amount u/s 80GGC
qualifying_amount_us_80_ggcnumberFor 194P Record OnlyLength: 15,2Qualifying amount u/s 80GGC
gross_amount_us_80_ttanumberFor 192 Record OnlyLength: 15,2The gross amount contributed u/s80TTA
deductible_amount_us_80_ttanumberFor 192 Record OnlyLength: 15,2The deductible amount u/s 80TTA
qualifying_amount_us_80_ttanumberFor 192 Record OnlyLength: 15,2Qualifying amount u/s 80TTA
gross_amount_us_80_ttbnumberFor 194P Record OnlyLength: 15,2The gross amount contributed u/s 80TTB
deductible_amount_us_80_ttbnumberFor 194P Record OnlyLength: 15,2The deductible amount u/s 80TTB
qualifying_amount_us_80_ttbnumberFor 194P Record OnlyLength: 15,2Qualifying amount u/s 80TTB
gross_amount_us_80_unumberFor 194P Record OnlyLength: 15,2The gross amount contributed u/s 80U
deductible_amount_us_80_unumberFor 194P Record OnlyLength : 15,2The deductible amount u/s 80U
qualifying_amount_us_80_unumberFor 194P Record OnlyLength : 15,2Qualifying amount u/s 80U
gross_amount_for_other_deductionsnumberYesLength : 15,2The gross amount for other deductions that are not mentioned
deductible_amount_for_other_deductionsnumberYesLength : 15,2The deductible amount for other deductions that are not mentioned
qualifying_amount_for_other_deductionsnumberYesLength : 15,2The deductible amount for other deductions that are not mentioned
rebate_us_87_anumberNoLength : 15,2 Rebate
relief_us_89numberYesLength : 15,2
payments_from_super_annuation_fundnumberNoLength : 15,2Payment to employee from the superannuation fund
name_of_fundstringNoMax Length: 75Name of superannuation fund
fund_contribution_fromnumberNoLength: 13EPOCH Timestamp from when the employee contributed to the fund in the current FY
fund_contribution_tonumberNoLength: 13EPOCH Timestamp to when the employee contributed to the fund in the current FY
average_rate_of_deduction_of_taxnumberNoLength: 7,4
tds_on_repayment_from_super_annuation_fundnumberNoLength: 15,2Tax deducted in repayment from the superannuation fund
gross_pension_under_194pnumberFor 194P Record OnlyLength : 15,2Gross pension reported u/s 194P
interest_income_by_bank_under_194pnumberFor 194P Record OnlyLength: 15,2Interest income from bank reported u/s 194P
net_tax_payable_under_194pnumberFor 194P Record OnlyLength: 15,2Net Tax Payable u/s194P

Form 26Q

Payer

ParamTypeRequiredValidationDescription
namestringYesMax Length : 75Name of the Payer
tanstringYesPattern : [A-Z]{4}[0-9]{5}[A-Z]{1}TAN of the Payer
panstringYesPattern : [A-Z]{3}[PCFTGHLABJ]{1}[A-Z]{1}[0-9]{4}[A-Z]{1}PAN of the Payer
branchstringNoMax Length : 75Branch details of the Payer if multiple locations.
gstinstringNoPattern : [0-9]{2}[a-zA-Z]{5}[0-9]{4}[a-zA-Z]{1}[1-9A-Za-z]{1}[CZ]{1}[0-9a-zA-Z]{1}$|^[0-9]{4}[a-zA-Z]{3}[0-9]{5}[uUnN]{2}[0-9a-zA-Z]{1}GSTIN of the Payer
streetstringYesMax Length : 25Name of premise
areastringYesMax Length : 25Area of location
citystringYesMax Length : 25City of location
stateenumYesStateState of location
postal_codestringYesPattern : [0-9]{6}Pincode of location
emailstringYesMax Length : 75Primary email for contact
mobilestringYesPattern: [1-9]{1}[0-9]{9}Primary mobile number for contact
Responsible Person
ParamTypeRequiredValidationDescription
designationstringYesMax Length : 20Designation of the responsible person
namestringYesMax Length : 75Name of the responsible person
panstringYesPattern : [A-Z]{3}[PCFTGHLABJ]{1}[A-Z]{1}[0-9]{4}[A-Z]{1}PAN of the responsible person
streetstringYesMax Length : 25Name of the premise
areastringYesMax Length : 25Area of the location
citystringYesMax Length : 25City of location
stateenumYesStateState of location
postal_codestringYesPattern : [0-9]{6}Pincode of location
emailstringYesMax Length : 75Primary email for contact
mobilestringYesPattern: [1-9]{1}[0-9]{9}Primary mobile number for contact

Payee

ParamTypeRequiredValidationDescription
sr_nonumberYes-Serial Number
panstringYesPattern : [A-Z]{3}[PCFTGHLABJ]{1}[A-Z]{1}[0-9]{4}[A-Z]{1}PAN of the Payee. If payee doesn't have PAN then possible values are
PANNOTAVBL,PANAPPLIED, PANINVALID
namestringYesMax Length : 75Name of the Payee

Challan

ParamTypeRequiredValidationDescription
challan_serialstringYesPattern : [0-9]{5}Bank Challan No
bsr_codestringYesPattern : [0-9]{7}Bank-Branch Code/ Form 24G Receipt Number
paid_datenumberYesLength: 13EPOCH Timestamp of challan paid on date
minor_headenumYesMinor HeadMinor Head of challan
tds_amountnumberYesLength : 15Income Tax
surchargenumberYesLength : 15Surcharge on Income Tax
health_and_education_cessnumberYesLength : 15Education cess on Income Tax
interestnumberYesLength : 15Interest levied upon late deduction
late_filing_feesnumberYesLength : 15Penalty levied upon late filing
other_penaltynumberYesLength : 15Any Other Penalty

Payment

ParamTypeRequiredValidationDescription
payee_sr_nonumberYes-Payee Serial Number
challan_serialstringYesPattern : [0-9]{5}Bank Challan No
bsr_codestringYesPattern : [0-9]{7}Bank-Branch Code/ Form 24G Receipt Number
sectionenumYesSectionTDS section of deduction
credit_amountnumberYesLength : 15,2Payment amount
credit_datenumberYesLength: 13EPOCH Timestamp of Payment date
tds_amountnumberYesLength : 15,2Tax amount of deduction
surchargenumberYesLength : 15,2Surcharge on Tax amount
health_and_education_cessnumberYesLength : 15,2Health and Eduction Cess amount
deduction_datenumberYesLength: 13EPOCH Timestamp of Deduction date
reason_for_lower_deductionenumNoReason for lower deductionReason for non-deduction / lower deduction/ higher deduction/threshold
certificate_numberstringNoMax Length: 10Certificate number issued by the Assessing Officer u/s 197 for non-deduction/lower deduction.
amount_of_cash_withdrawal_more_than_1_crore_us_194NnumberNoLength : 15,2Value to be mentioned if TDS deducted u/s 194N
amount_of_cash_withdrawal_between_20_lakhs_and_1_crore_us_194N_for_non_filersnumberNoLength : 15,2Value to be mentioned if TDS deducted u/s 194NF, can be 0 if the amount is more than 1CR.
amount_of_cash_withdrawal_more_than_1_crore_us_194N_for_non_filersnumberNoLength : 15,2Value to be mentioned if TDS deducted u/s 194NF, can be 0 if the amount is less than 1CR.
amount_of_cash_withdrawal_more_than_3_crore_us_194N_for_co-operative_societiesnumberNoLength : 15,2Value to be mentioned if TDS deducted u/s 194NC
amount_of_cash_withdrawal_between_20_lakhs_and_3_crore_us_194N_for_non_filersnumberNoLength : 15,2Value to be mentioned if TDS deducted u/s 194N-FT, can be 0 if the amount is more than 3CR.
amount_of_cash_withdrawal_more_than_3_crore_us_194N_for_non_filersnumberNoLength : 15,2Value to be mentioned if TDS deducted u/s 194N-FT, can be 0 if the amount is less than 3CR.

Form 27Q

Payer

ParamTypeRequiredValidationDescription
namestringYesMax Length : 75Name of the Payer
tanstringYesPattern : [A-Z]{4}[0-9]{5}[A-Z]{1}TAN of the Payer
panstringYesPattern : [A-Z]{3}[PCFTGHLABJ]{1}[A-Z]{1}[0-9]{4}[A-Z]{1}PAN of the Payer
branchstringNoMax Length : 75Branch details of the Payer if multiple locations.
gstinstringNoPattern : [0-9]{2}[a-zA-Z]{5}[0-9]{4}[a-zA-Z]{1}[1-9A-Za-z]{1}[CZ]{1}[0-9a-zA-Z]{1}$|^[0-9]{4}[a-zA-Z]{3}[0-9]{5}[uUnN]{2}[0-9a-zA-Z]{1}GSTIN of the Payer
streetstringYesMax Length : 25Name of premise
areastringYesMax Length : 25Area of location
citystringYesMax Length : 25City of location
stateenumYesStateState of location
postal_codestringYesPattern : [0-9]{6}Pincode of location
emailstringYesMax Length : 75Primary email for contact
mobilestringYesPattern: [1-9]{1}[0-9]{9}Primary mobile number for contact
Responsible Person
ParamTypeRequiredValidationDescription
designationstringYesMax Length : 20Designation of the responsible person
namestringYesMax Length : 75Name of the responsible person
panstringYesPattern : [A-Z]{3}[PCFTGHLABJ]{1}[A-Z]{1}[0-9]{4}[A-Z]{1}PAN of the responsible person
streetstringYesMax Length : 25Name of the premise
areastringYesMax Length : 25Area of the location
citystringYesMax Length : 25City of location
stateenumYesStateState of location
postal_codestringYesPattern : [0-9]{6}Pincode of location
emailstringYesMax Length : 75Primary email for contact
mobilestringYesPattern: [1-9]{1}[0-9]{9}Primary mobile number for contact

Payee

ParamTypeRequiredValidationDescription
sr_nonumberYes-Serial Number
panstringYesPattern : [A-Z]{3}[PCFTGHLABJ]{1}[A-Z]{1}[0-9]{4}[A-Z]{1}PAN of the Payee. If a payee doesn't have PAN then possible values are
PANNOTAVBL,PANAPPLIED, PANINVALID,
namestringYesMax Length: 75Name of the Payee
opting_new_regimebooleanYesPossible values:
True
False
Whether Employee has opted for taxation u/s 115BAC(1a).
tax_identification
_number
stringYesMax Length: 25Tax Identification Number of Payee's jurisdiction
streetstringYesMax Length: 25Name of premise of location
areastringYesMax Length: 25Area of location
citystringYesMax Length: 25City of location
statestringYesMax Length : 25State of location
postal_codestringYesMax Length : 8Pincode of location
countryenumYesCountryCountry of residance
emailstringYesMax Length : 75Primary email for contact
isd_codenumberYesMax Length : 5ISD code of country
mobilenumberYesPattern: [1-9]{1}[0-9]{9}Primary mobile number for contact

Challan

ParamTypeRequiredValidationDescription
challan_serialstringYesPattern : [0-9]{5}Bank Challan No
bsr_codestringYesPattern : [0-9]{7}Bank-Branch Code/ Form 24G Receipt Number
paid_datenumberYesLength: 13Timestamp of challan paid date
minor_headenumYesMinor HeadMinor Head of challan
tds_amountnumberYesLength: 15Income Tax
surchargenumberYesLength: 15Surcharge Amount
health_and_education_cessnumberYesLength: 15Health and education cess amount
interestnumberYesLength : 15Interest levied upon late deduction
late_filing_feesnumberYesLength: 15Penalty levied upon late filing
other_penaltynumberYesLength : 15Any Other Penalty

Payment

ParamTypeRequiredValidationDescription
payee_sr_nonumberYes-Payee Serial Number
challan_serialstringYesPattern : [0-9]{5}Bank Challan No
bsr_codestringYesPattern : [0-9]{7}Bank-Branch Code/ Form 24G Receipt Number
sectionenumYesSectionTDS section of deduction
credit_amountnumberYesLength : 15,2Payment amount
credit_datenumberYesLength: 13EPOCH Timestamp of Payment date
tds_amountnumberYesLength : 15,2Tax amount of deduction
surchargenumberYesLength : 15,2Surcharge Amount
health_and_education_cessnumberYesLength : 15,2Health and education cess amount
deduction_datenumberYesLength: 13EPOCH Timestamp of Deduction date
applicability_of_tds_rate_under_dtaabooleanYes-Whether the TDS rate is applicable under DTAA
nature_of_remittancestringYesNature of remittanceNature of remittance
form_15ca_acknowledgement_numberstringNoMax Length: 10Form 15ca acknowledgement number
grossing_up_indicatorenumNo-Possible values: Y, N
reason_for_lower_deductionenumNoReason for lower deductionReason for non-deduction / lower deduction/ higher deduction/threshold
certificate_numberstringNoMax Length: 10Certificate number issued by the Assessing Officer u/s 197 for non-deduction/lower deduction.
amount_of_cash_withdrawal_more_than_1_crore_us_194NnumberNoLength : 15,2Value to be mentioned if TDS deducted u/s 194N
amount_of_cash_withdrawal_between_20_lakhs_and_1_crore_us_194N_for_non_filersnumberNoLength : 15,2Value to be mentioned if TDS deducted u/s 194NF, can be 0 if the amount is more than 1CR.
amount_of_cash_withdrawal_more_than_1_crore_us_194N_for_non_filersnumberNoLength : 15,2Value to be mentioned if TDS deducted u/s 194NF, can be 0 if the amount is less than 1CR.
amount_of_cash_withdrawal_more_than_3_crore_us_194N_for_co-operative_societiesnumberNoLength : 15,2Value to be mentioned if TDS deducted u/s 194NC
amount_of_cash_withdrawal_between_20_lakhs_and_3_crore_us_194N_for_non_filersnumberNoLength : 15,2Value to be mentioned if TDS deducted u/s 194N-FT, can be 0 if the amount is more than 3CR.
amount_of_cash_withdrawal_more_than_3_crore_us_194N_for_non_filersnumberNoLength : 15,2Value to be mentioned if TDS deducted u/s 194N-FT, can be 0 if the amount is less than 3CR.

TDS Reporting Poll Job API

ParamTypeDescriptionExample
job_idstringThe Job ID of the particular JOB. 1546372e-6fc5-45bb-a2d9-b18d0c662427
statusstringJob Status. Possible Values:
JOBQUEUED
JOBDONE
JOBFAILED
JOBQUEUED
tds_returnstringLink from where you can download the generated TXT file. Will be provided when the status is JOBDONEhttps://...
validation_reportstringLink from where you can download the validation report. Will be provided when the status is JOBFAILEDhttps://...

TCS Reporting Submit Job API

KeyTypeDescription
job_idstringUnique Job ID to track the request
tanstringTAN of collectee
quarterstringQuarter for which TCS is being filed
financial_yearstringFinancial Year for which TCS is being filed
previous_rrr_numberstringReceipt Number of previously filed TCS Return
statusstringStatus of the job
json_urlstringS3 URL to make the PUT request
created_atnumberEPOCH timestamp of when the job was created

Form 27EQ

payer_list

KeyTypeRequiredValidationDescription
namestringYesMax Length: 75Name of the Payer
tanstringYesPattern : [A-Z]{4}[0-9]{5}[A-Z]{1}TAN of the Payer
panstringYesPattern : [A-Z]{3}[PCFTGHLABJ]{1}[A-Z]{1}[0-9]{4}[A-Z]{1}PAN of the Payer
branchstringNoMax Length: 75Branch details of the Payer if multiple locations.
gstinstringNoPattern : [0-9]{2}[a-zA-Z]{5}[0-9]{4}[a-zA-Z]{1}[1-9A-Za-z]{1}[CZ]{1}[0-9a-zA-Z]{1}$|^[0-9]{4}[a-zA-Z]{3}[0-9]{5}[uUnN]{2}[0-9a-zA-Z]{1}GSTIN of the Payer
streetstringYesMax Length: 25Name of premise
areastringYesMax Length: 25Area of location
citystringYesMax Length: 25City of location
stateenumYesStateState of location
postal_codestringYesPattern : [0-9]{6}Pincode of location
emailstringYesMax Length: 75Primary email for contact
mobilestringYesPattern: [1-9]{1}[0-9]{9}Primary mobile number for contact

responsible_person_list

KeyTypeRequiredValidationDescription
designationstringYesMax Length: 20Designation of the responsible person
namestringYesMax Length: 75Name of the responsible person
panstringYesPattern : [A-Z]{3}[PCFTGHLABJ]{1}[A-Z]{1}[0-9]{4}[A-Z]{1}PAN of the responsible person
streetstringYesMax Length: 25Name of the premise
areastringYesMax Length: 25Area of the location
citystringYesMax Length: 25City of location
stateenumYesStateState of location
postal_codestringYesPattern : [0-9]{6}Pincode of location
emailstringYesMax Length: 75Primary email for contact
mobilestringYesPattern: [1-9]{1}[0-9]{9}Primary mobile number for contact

payee_table

KeyTypeRequiredValidationDescription
sr_nonumberYes-Serial Number
panstringYesPattern : [A-Z]{3}[PCFTGHLABJ]{1}[A-Z]{1}[0-9]{4}[A-Z]{1}PAN of the Payee. If a payee doesn't have PAN then possible values are
PANNOTAVBL,PANAPPLIED, PANINVALID
namestringYesMax Length: 75Name of the Payee
nribooleanYesPossible Values: true
false
Whether the Payee is a non-residential India
permanent_establishment_in_indiabooleanYesPossible Values: true
false
Where Payee has a permanent establishment in India
opting_new_regimebooleanYesPossible Values: true
false
Whether Payee has opted for taxation u/s 115BAC(1a).

challan_table

KeyTypeRequiredValidationDescription
challan_serialstringYesPattern : [0-9]{5}Bank Challan No
bsr_codestringYesPattern : [0-9]{7}Bank-Branch Code/ Form 24G Receipt Number
paid_datenumberYesLength: 13Timestamp of challan paid on the date
minor_headenumYesMinor HeadMinor Head of challan
tcs_amountnumberYesLength: 15Income Tax
surchargenumberYesLength: 15Surcharge on Income Tax
health_and_education_cessnumberYesLength: 15Health and education cess amount
interestnumberYesLength: 15Interest levied upon late deduction
late_filing_feesnumberYesLength: 15Penalty levied upon late filing
other_penaltynumberYesLength: 15Any Other Penalty

payment_table

KeyTypeRequiredValidationDescription
payee_sr_nonumberYesPayee Serial Number
challan_serialstringYesPattern : [0-9]{5}Bank Challan No
bsr_codestringYesPattern : [0-9]{7}Bank-Branch Code/ Form 24G Receipt Number
nature_of_paymentenumYesnature of paymentTCS section of the collection
total_value_of_purchasenumberYesLength: 15,2Total value of purchase
payment_amountnumberYesLength: 15,2amount received by the collectee
payment_datenumberYesLength: 13Timestamp of Purchase date/when the amount was received
tcs_amountnumberYesLength: 15,2Tax amount of collection
surchargenumberYesLength: 15,2Surcharge on Tax amount
health_and_education_cessnumberYesLength: 15,2Health and education cess amount
collection_datenumberYesLength: 13Timestamp of when tax was collected
reason_for_lower_collectionenumNoReason for lower collectionReason for non-collection/ lower collection/ higher collection/Threshold
certificate_numbernumberNoMax Length: 10Certificate number issued by the Assessing Officer u/s 197 for non-collection/lower collection.

TCS Reporting Poll Job API

KeyTypeDescription
job_idstringUnique Job ID to track the request
tanstringTAN of collectee
quarterstringQuarter for which TCS is being filed
financial_yearstringFinancial Year for which TCS is being filed
previous_rrr_numberstringReceipt Number of previously filed TCS Return
statusstringStatus of the job. Possible values:
created, queued, succeeded, failed
txt_urlstringLink from where you can download the generated TXT file. Will be provided when the status is succeeded
validation_report_urlstringLink from where you can download the validation report. Will be provided when the status is failed
created_atnumberEPOCH timestamp of when the job was created
updated_atnumberEPOCH timestamp of when the job was last updated

Calculator API

Non-Salary Payments

KeyTypeDescriptionExample
deductee_typestringType of Deducteecompany
is_pan_availablebooleanReturns PAN statusfalse
is_206ab_applicablebooleanReturns 206AB statusfalse
is_pan_operativebooleanReturns PAN operativefalse
residential_statusstringResidential Status of the deducteeresident
sectionstringSection under which the tax is to be deducted194C
codestringCode under which the tax is to be deducted94C
categorystringCategory under which tax is to be deductedcontractual_payment
nature_of_paymentstringThe kind of payment being made.tender_fees
credit_amountnumberPayment amount (in INR)90500
credit_datenumberDate of payment in EPOCH Timestamp1685577600000
deduction_ratenumberApplicable TDS rate20
threshold_amountnumberThe threshold amount after which TDS is applicable100000
due_datenumberDue date of depositing TDS in EPOCH Timestamp1688688000000
deduction_amountnumberTDS amount to be deducted0

TCS Payments

KeyTypeDescriptionExample
deductee_typestringType of Deducteeindividual
is_pan_availablebooleanReturns PAN statusfalse
is_206cca_applicablebooleanReturns 206AB statusfalse
is_pan_operativebooleanReturns PAN operativefalse
residential_statusstringResidential Status of the deducteeresident
sectionstringSection under which the tax is to be collected206C(1)
codestringCode under which the tax is to be collected6CO
categorystringCategory under which tax is to be collectedoverseas_tour_program_package
nature_of_paymentstringThe kind of payment being made.foreign_flight_tickets
payment_amountnumberPayment amount (in INR)695000
payment_datenumberPayment date in EPOCH1685577600000
collection_ratenumberApplicable TCS rate5
threshold_amountnumberThe threshold amount after which TCS is applicable0
due_datenumberDue date of depositing TCS in EPOCH Timestamp1688688000000
collection_amountnumberTCS amount to be collected34750