Fetch Max ITC Configuration

Upload a sale document with JSON payload.

Request Method

GET

Request URL

{{BASE_URL}}/integration/v1/config/get

Replace the {{BASE_URL}} with the one mentioned here based on whether you are using sandbox or production.

Request Headers

Parameter	Data Type	Field Validations	Description
x-cleartax-auth-token	String	Cannot be empty.	Mandatory. User auth token.

Request Path Params

There are no path parameters for this API.

Request Query Params

There are no query parameters for this API.

Request Body

There is no request body for this API.

Sample Request

GET https://api-sandbox.clear.in/integration/v1/config/get

Response Status Codes

HTTP Status Code	Description
200	Configuration is fetched successfully.
400	If the request schema is not valid.
401	If the user is not authenticated for the operation.
403	If the user is not authorized for the operation.
500	If there are any unhandled exceptions on Clear side.

Response Schema

Parameter	Data Type	Field Constraints	Description
userEmail	String		User email as registered on Clear.
customTemplateId	String	UUID	Custom template ID to be used for uploading purchase documents.
reconType	String	Enum: MAX_ITC_2A_PR, MAX_ITC_2B_PR, MAX_ITC_6A_PR, MAX_ITC_8A_PR	Type of reconciliation to be triggered. MAX_ITC_2A_PR - Govt 2A vs Taxpayer PR MAX_ITC_2B_PR - Govt 2B vs Taxpayer PR MAX_ITC_6A_PR - Govt 6A vs Taxpayer PR MAX_ITC_8A_PR - Govt 8A vs Taxpayer PR
sectionNames	Array	Enum:	An array of Section Names for which 2A or 2B is to be downloaded.
pullReturnPeriodStart	String	Format: MMYYYY	Return period from which the 2A or 2B data is to be downloaded from GSTN.
pullReturnPeriodEnd	String	Format: MMYYYY	Return period up to which the 2A or 2B data is to be downloaded from GSTN. Default: Current return period
reconReturnPeriodStart	String	Format: MMYYYY	Return period from which the purchase data is to be considered in Clear.
reconReturnPeriodEnd	String	Format: MMYYYY	Return period up to which the purchase data is to be considered in Clear. Default: Current return period
active	Boolean	NA	Configuration Status. The flag specifies if the configuration is active or inactive.
error	String	Enum: AUTHORIZATION_FAILED, NOT_CONFIGURED	Error code. AUTHORIZATION_FAILED - If authorization failed. NOT_CONFIGURED - If the configuration is not available.

Sample Response

Success - HTTP Status Code - 200

{
  "userEmail": "[e-mail]",
  "customTemplateId": "60e5613ff71f4a7aeca4336b",
  "reconType": "MAX_ITC_2A_PR",
  "sectionNames": [
    "B2B",
    "CDN"
  ],
  "pullReturnPeriodStart": "042021",
  "pullReturnPeriodEnd": "122021",
  "reconReturnPeriodStart": "042021",
  "reconReturnPeriodEnd": "122021",
  "active": true,
  "error": null
}

Authentication Error - HTTP Status Code - 401

[
  {
    "errorCode": "INTERNAL_ERROR",
    "errorMessage": "Required request header 'x-cleartax-auth-token' for method parameter type String is not present",
    "errorField": null,
    "errorValues": null,
    "errorResolution": null
  }
]

API Validations

1. A valid auth token is required.

2. A configuration must have been already set up in your Clear account.

API Constraints

1. This API needs to be authenticated with a valid user authentication token. If the auth token is not present or is invalid, the API will return HTTP Status Code 401.

2. If the auth token is valid, but the user does not have the authorization, then the API will return HTTP Status Code 403. The user, whose auth token is used, should have permission to create a document.