Fetch Jobs

Fetch Jobs

curl --request POST \
  --url https://api.sandbox.co.in/tcs/reports/txt/search \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <x-api-key>' \
  --data '
{
  "@entity": "in.co.sandbox.tcs.reports.jobs.search",
  "tan": "AHMA09719B",
  "quarter": "Q1",
  "financial_year": "FY 2024-25",
  "from_date": 123,
  "to_date": 123,
  "page_size": 123,
  "last_evaluated_key": "<string>"
}
'

{
  "code": 200,
  "timestamp": 1715757773000,
  "transaction_id": "109469b2-0748-4135-a569-e86fc9e45756",
  "data": {
    "@entity": "in.co.sandbox.tcs.reports.paginated_list",
    "items": [
      {
        "@entity": "in.co.sandbox.tcs.reports.job",
        "job_id": "c01f847c-c42e-4577-9d01-a7208401a922",
        "tan": "AHMA09719B",
        "quarter": "Q3",
        "financial_year": "FY 2023-24",
        "previous_receipt_number": "123456789012345",
        "status": "created",
        "created_at": 1701250588000
      },
      {
        "@entity": "in.co.sandbox.tcs.reports.job",
        "job_id": "0fb396f6-9eb6-48b9-926d-25296286f9ee",
        "tan": "BLRC23456F",
        "quarter": "Q4",
        "financial_year": "FY 2023-24",
        "previous_receipt_number": "123456789012345",
        "status": "queued",
        "created_at": 1701250588000,
        "updated_at": 17012506755000
      },
      {
        "@entity": "in.co.sandbox.tcs.reports.job",
        "job_id": "46d96540-e4e0-4188-81f5-959f4732490f",
        "tan": "AHMA09719B",
        "quarter": "Q3",
        "financial_year": "FY 2023-24",
        "previous_receipt_number": "123456789012345",
        "filling_type": "original",
        "status": "succeeded",
        "created_at": 1701250588000,
        "updated_at": 17012507755000
      },
      {
        "@entity": "in.co.sandbox.tcs.reports.job",
        "job_id": "77a45361-9646-4ee0-93ed-9471bb8a615e",
        "tan": "BLRC23456F",
        "quarter": "Q3",
        "financial_year": "FY 2023-24",
        "previous_receipt_number": "123456789012345",
        "filling_type": "original",
        "status": "failed",
        "created_at": 1701250588000,
        "updated_at": 17012507755000,
        "message": "Validation error"
      }
    ],
    "last_evaluated_key": "eydadadadada...=="
  }
}

POST

tcs

reports

txt

Fetch Jobs

curl --request POST \
  --url https://api.sandbox.co.in/tcs/reports/txt/search \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <x-api-key>' \
  --data '
{
  "@entity": "in.co.sandbox.tcs.reports.jobs.search",
  "tan": "AHMA09719B",
  "quarter": "Q1",
  "financial_year": "FY 2024-25",
  "from_date": 123,
  "to_date": 123,
  "page_size": 123,
  "last_evaluated_key": "<string>"
}
'

{
  "code": 200,
  "timestamp": 1715757773000,
  "transaction_id": "109469b2-0748-4135-a569-e86fc9e45756",
  "data": {
    "@entity": "in.co.sandbox.tcs.reports.paginated_list",
    "items": [
      {
        "@entity": "in.co.sandbox.tcs.reports.job",
        "job_id": "c01f847c-c42e-4577-9d01-a7208401a922",
        "tan": "AHMA09719B",
        "quarter": "Q3",
        "financial_year": "FY 2023-24",
        "previous_receipt_number": "123456789012345",
        "status": "created",
        "created_at": 1701250588000
      },
      {
        "@entity": "in.co.sandbox.tcs.reports.job",
        "job_id": "0fb396f6-9eb6-48b9-926d-25296286f9ee",
        "tan": "BLRC23456F",
        "quarter": "Q4",
        "financial_year": "FY 2023-24",
        "previous_receipt_number": "123456789012345",
        "status": "queued",
        "created_at": 1701250588000,
        "updated_at": 17012506755000
      },
      {
        "@entity": "in.co.sandbox.tcs.reports.job",
        "job_id": "46d96540-e4e0-4188-81f5-959f4732490f",
        "tan": "AHMA09719B",
        "quarter": "Q3",
        "financial_year": "FY 2023-24",
        "previous_receipt_number": "123456789012345",
        "filling_type": "original",
        "status": "succeeded",
        "created_at": 1701250588000,
        "updated_at": 17012507755000
      },
      {
        "@entity": "in.co.sandbox.tcs.reports.job",
        "job_id": "77a45361-9646-4ee0-93ed-9471bb8a615e",
        "tan": "BLRC23456F",
        "quarter": "Q3",
        "financial_year": "FY 2023-24",
        "previous_receipt_number": "123456789012345",
        "filling_type": "original",
        "status": "failed",
        "created_at": 1701250588000,
        "updated_at": 17012507755000,
        "message": "Validation error"
      }
    ],
    "last_evaluated_key": "eydadadadada...=="
  }
}

Headers

Authorization

string

required

JWT access token

x-api-key

string

required

API key for identification

x-api-version

string

Body

application/json

@entity

enum<string>

Available options:

in.co.sandbox.tcs.reports.jobs.search

tan

string

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

Example:

"AHMA09719B"

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

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

Show child attributes

data.@entity

string

data.items

object[]

Show child attributes

data.items.@entity

string

data.items.job_id

string

data.items.tan

string

data.items.quarter

string

data.items.financial_year

string

data.items.previous_receipt_number

string<utc-millisec>

data.items.status

string

data.items.created_at

integer

data.last_evaluated_key

string

Poll Job

Submit Job

⌘I

Calculator

Analytics

Reports

Compliance

Annexures

Headers

Body

Response