Batch Upload API

GET Status

OVERVIEWREQUESTRESPONSETRY IT OUT

Overview

The Status API endpoint is specifically designed to retrieve the status of a previously uploaded file within the SureTax system. This endpoint requires a specific parameter called jobid, which corresponds to the unique identifier generated during the file upload request. By making a request to this endpoint with the appropriate jobid parameter, users can obtain information about the current status of the uploaded file. The SureTax system responds with one of the following statuses:

1. In Progress: This status indicates that the file is currently being processed by the system. The processing may still be ongoing, and users can expect the final status to be updated once the process is complete.

2. Completed: This status signifies that the file processing has been successfully completed. All the necessary calculations and operations related to the uploaded file have been executed without any errors.

3. Failed: In the event of an error during the file processing, this status is returned. It indicates that the system encountered an issue while processing the uploaded file.Furthermore, if there are any errors in processing specific lines within the file, the SureTax system provides additional details about the line(s) that contain the error. This information helps users identify and rectify any issues in the data, ensuring accurate tax calculations and a smooth processing experience.

OperationId: GET Status

Authorization Method(s): OAuth

Verb: GET

End Point: /api/v1/Batch/Status

Query Parameters

Query parameters in an API operation are key-value pairs that are included in the URL of an API request to filter or modify the data returned by the API. They come after the `?` in the URL and are often used to pass optional parameters like search terms, pagination information, sorting criteria, or filters to narrow down the data in the response.

Display String	Field Name	Field Type
Job Id*	jobId	string

*Mandatory parameter

UploadStatusResponse

OVERVIEWEXAMPLE

Overview

Represent details about upload Job status. Provides item level error messages also.

UploadStatusResponse

Display Name	Field Name	Field Type
Upload Status	uploadStatus	string
Message	message	string
Total Number Of Lines	totalNumberOfLines	string
Items With Messages	itemsWithMessages	array[items]

items

Display Name	Field Name	Field Type
Item Number	itemNumber	string
Message	message	string
Item Status	itemStatus	string

Example Response

The following is an example response you can expect for this operation

{
  "uploadStatus": "Completed",
  "message": "",
  "totalNumberOfLines": 3,
  "itemsWithMessages": [
    {
      "itemNumber": "1",
      "message": "Invalid Unit Type",
      "itemStatus": "E"
    },
    {
      "itemNumber": "1",
      "message": "Invalid Unit Type",
      "itemStatus": "E"
    },
    {
      "itemNumber": "1",
      "message": "Invalid Unit Type",
      "itemStatus": "E"
    }
  ]
}

Response Codes

Response codes in an API indicate the outcome of a request. They are three-digit numbers returned by the server to help the client understand if the request was successful, encountered an error, or needs further action. This operation has the following possible responses.

code	description
200	The API Response contains the current status of the upload request.
204	No Content If no records are found for the provided request, the API will respond with a No Content status.
400	Bad request. Invalid parameters or missing required information.
401	Unauthorized access. The request requires user authentication.
500	Internal server error. An error occurred while processing the request.

To execute a web service call for API Key Enabled APIs, Select an environment and enter the client number and validation api key corresponding to that environment.

Select Environment:End Point:

/api/v1/Batch/Status

Add Request Headers:

Batch Upload API

GET Status

Overview

Overview

Example Response

Enter Environment Credentials