Skip to main content
POST
/
tcs
/
analytics
/
potential-notices
/
search
Fetch Jobs
curl --request POST \
  --url https://api.sandbox.co.in/tcs/analytics/potential-notices/search \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <x-api-key>' \
  --data '{
  "@entity": "<string>",
  "tan": "<string>",
  "quarter": "Q1",
  "financial_year": "FY 2024-25",
  "from_date": 123,
  "to_date": 123,
  "page_size": 49,
  "last_evaluated_key": "<string>"
}'
{
  "code": 200,
  "timestamp": 1715757773000,
  "transaction_id": "109469b2-0748-4135-a569-e86fc9e45756",
  "data": {
    "@entity": "in.co.sandbox.tcs.analytics.potential_notice.paginated_list",
    "items": [
      {
        "@entity": "in.co.sandbox.tcs.analytics.potential_notices.job",
        "job_id": "096c4812-1829-4ee1-a3c6-3bd291654b72",
        "tan": "AHMS12345C",
        "financial_year": "FY 2023-24",
        "quarter": "Q2",
        "form": "26Q",
        "created_at": 1714529043000,
        "updated_at": 1714529044000,
        "status": "succeeded",
        "return_receipt_number": 123456789012345
      },
      {
        "@entity": "in.co.sandbox.tcs.analytics.potential_notices.job",
        "job_id": "096c4812-1829-4ee1-a3c6-3bd291654b72",
        "tan": "AHMS12345C",
        "financial_year": "FY 2023-24",
        "quarter": "Q2",
        "form": "26Q",
        "created_at": 1714530043000,
        "updated_at": 1714530044000,
        "status": "failed",
        "message": "Validation error"
      }
    ],
    "last_evaluated_key": "eydadadadada...=="
  }
}

Headers

x-api-key
string
required

API key for identification

Authorization
string
required

JWT access token

x-api-version
string

API Version

Body

application/json
@entity
string
Allowed value: "in.co.sandbox.tds.analytics.potential_notice.jobs.search"
tan
string

TAN of deductor. Regular Expression: [A-Z]{4}[0-9]{5}[A-Z]{1}

quarter
enum<string>

Quarter for which TDS is being filed

Available options:
Q1,
Q2,
Q3,
Q4
financial_year
string

Financial Year for which TDS is being filed. (eg. FY 2024-25)

Example:

"FY 2024-25"

from_date
integer

Date from which jobs are to be fetched. Value in EPOCH timestamp

to_date
integer

Date till which jobs are to be fetched. Value in EPOCH timestamp

page_size
integer

Number of records in the API response. Maximum allowed size is 50

Required range: x <= 50
last_evaluated_key
string

Base64 encoding of the stringified JSON object, which includes x-api-key, created_at, and job_id

Response

200 - application/json

200 - OK

code
integer
timestamp
integer
transaction_id
string
data
object