Skip to main content
POST
/
it
/
reports
/
tax-pnl
/
securities
/
foreign
Submit Job
curl --request POST \
  --url https://test-api.sandbox.co.in/it/reports/tax-pnl/securities/foreign \
  --header 'Authorization: <authorization>' \
  --header 'x-accept-type: <x-accept-type>' \
  --header 'x-api-key: <x-api-key>' \
  --header 'x-api-version: <x-api-version>'
{
  "code": 200,
  "timestamp": 1747891175423,
  "data": {
    "created_at": 1747891176339,
    "updated_at": 1747891176339,
    "@entity": "in.co.sandbox.it.reports.tax_pnl.securities.job",
    "security_type": "domestic",
    "url": "https://in-co-sandbox-it-reports-tax-pnl-sec-dev.s3.ap-south-1.amazonaws.com/domestic/9c6846f0-92db-4da3-b982-1b97967c320e/workbook.input?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Credential=EXAMPLEACCESSKEY%2F20250522%2Fap-south-1%2Fs3%2Faws4_request&X-Amz-Date=20250522T051936Z&X-Amz-Expires=86400&X-Amz-Signature=EXAMPLE_SIGNATURE&X-Amz-SignedHeaders=host&x-amz-checksum-crc32=AAAAAA%3D%3D&x-amz-sdk-checksum-algorithm=CRC32&x-id=PutObject",
    "status": "created",
    "job_id": "9c6846f0-92db-4da3-b982-1b97967c320e"
  },
  "transaction_id": "9c6846f0-92db-4da3-b982-1b97967c320e"
}

Headers

ā€‹
x-accept-type
string
required

Specifies the response format expected from the API. Use application/json for JSON responses or application/xlsx for Excel file downloads.

ā€‹
x-api-key
string
required

Your API key used to authenticate and authorize the request.

ā€‹
x-api-version
string
required

Indicates the version of the API you want to use. Ensures backward-compatible behavior.

ā€‹
Authorization
string
required

Bearer token for user-level authorization. Typically passed as Bearer {{access_token}}.

Query Parameters

ā€‹
input
enum<string>
required

Type of input file. Allowed values: tradewise_settlement or tradebook.

Available options:
tradebook,
tradewise_settlement
ā€‹
financial_year
string
required

Financial year for which the report is generated. Use format FY 20XX-XX (e.g., FY 2024-25).

Pattern: ^FY (19|20)\d{2}-\d{2}$

Response

200 - application/json

200

ā€‹
code
integer
ā€‹
timestamp
integer
ā€‹
data
object
ā€‹
transaction_id
string