Fetch Jobs

post

https://api.sandbox.co.in/tds/compliance/traces/deductors/forms/{certificate_type}/search

Get all jobs created for downloading Form 16 & Form16A

Job Parameters

Param	Type	Description	Example
job_id	string	Unique identifier of the job	f24cd229-42c8-43de-af79-8ce2d3c4c3db
tan	string	TAN of deductor	MUMR09719B
quarter	string	Financial Year	FY 2023-24
financial_year	string	Quarter	Q1
form	string	TDS return form type	26Q
created_at	number	EPOCH timestamp of when the job was created	1701250588000
updated_at	number	EPOCH timestamp of when the job was last updated	1701250598000
remember_me	boolean	Whether to remember the credentials	true
status	string	The status of the particular job. Possible Values: `created`, `queued`, `in_progress`, `failed`, `succeeded`	queued
message	string	Reason for not generating TDS certificates. Will be visible only when the status is `failed`	Invalid security captcha

Path Params

certificate_type

string

enum

required

Allowed:

Body Params

@entity

string

required

Defaults to in.co.sandbox.tds.compliance.certificate.job.search

Entity Name

tan

string

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

quarter

string

Quarter (e.g. Q2)

form

string

TDS return form

financial_year

string

Financial Year (e.g. FY 2022-23)

from_date

string

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

to_date

string

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

page_size

string

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

Headers

authorization

string

required

JWT Authorization token

x-api-key

string

required

API key for identification

x-api-version

string

API Version

Response

200200