Skip to main content
POST
Submit Job
This endpoint is part of a job-based async workflow. See the job-based API workflow guide for job creation, payload upload, and status polling.

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
default:FY 2025-26
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}$

Body

application/json
ā€‹
name
string
ā€‹
@entity
string
ā€‹
sheets
object[]

Response

200 - application/json

Job created successfully, presigned URL provided for payload upload

ā€‹
code
integer

HTTP status code

ā€‹
timestamp
integer

Unix timestamp (in milliseconds) indicating when the server generated the response

ā€‹
data
object

Response payload containing job details and presigned URL

ā€‹
transaction_id
string

Unique identifier for tracking the request across systems