Skip to main content
POST
/
tcs
/
analytics
/
potential-notices
/
search
Fetch Jobs
curl --request POST \
  --url https://test-api.sandbox.co.in/tcs/analytics/potential-notices/search \
  --header 'Content-Type: application/json' \
  --header 'authorization: <authorization>' \
  --header 'x-api-key: <x-api-key>' \
  --data '
{
  "@entity": "<string>",
  "tan": "<string>",
  "financial_year": "FY 2024-25",
  "from_date": 123,
  "to_date": 123,
  "page_size": 49,
  "last_evaluated_key": "<string>"
}
'
import requests

url = "https://test-api.sandbox.co.in/tcs/analytics/potential-notices/search"

payload = {
"@entity": "<string>",
"tan": "<string>",
"financial_year": "FY 2024-25",
"from_date": 123,
"to_date": 123,
"page_size": 49,
"last_evaluated_key": "<string>"
}
headers = {
"x-api-key": "<x-api-key>",
"authorization": "<authorization>",
"Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {
'x-api-key': '<x-api-key>',
authorization: '<authorization>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
'@entity': '<string>',
tan: '<string>',
financial_year: 'FY 2024-25',
from_date: 123,
to_date: 123,
page_size: 49,
last_evaluated_key: '<string>'
})
};

fetch('https://test-api.sandbox.co.in/tcs/analytics/potential-notices/search', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://test-api.sandbox.co.in/tcs/analytics/potential-notices/search",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'@entity' => '<string>',
'tan' => '<string>',
'financial_year' => 'FY 2024-25',
'from_date' => 123,
'to_date' => 123,
'page_size' => 49,
'last_evaluated_key' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"authorization: <authorization>",
"x-api-key: <x-api-key>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://test-api.sandbox.co.in/tcs/analytics/potential-notices/search"

payload := strings.NewReader("{\n \"@entity\": \"<string>\",\n \"tan\": \"<string>\",\n \"financial_year\": \"FY 2024-25\",\n \"from_date\": 123,\n \"to_date\": 123,\n \"page_size\": 49,\n \"last_evaluated_key\": \"<string>\"\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("x-api-key", "<x-api-key>")
req.Header.Add("authorization", "<authorization>")
req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://test-api.sandbox.co.in/tcs/analytics/potential-notices/search")
.header("x-api-key", "<x-api-key>")
.header("authorization", "<authorization>")
.header("Content-Type", "application/json")
.body("{\n \"@entity\": \"<string>\",\n \"tan\": \"<string>\",\n \"financial_year\": \"FY 2024-25\",\n \"from_date\": 123,\n \"to_date\": 123,\n \"page_size\": 49,\n \"last_evaluated_key\": \"<string>\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://test-api.sandbox.co.in/tcs/analytics/potential-notices/search")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<x-api-key>'
request["authorization"] = '<authorization>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"@entity\": \"<string>\",\n \"tan\": \"<string>\",\n \"financial_year\": \"FY 2024-25\",\n \"from_date\": 123,\n \"to_date\": 123,\n \"page_size\": 49,\n \"last_evaluated_key\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body
{
  "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}

Pattern: [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