SureTax Returns API

GET Due Forms

OVERVIEWREQUESTRESPONSETRY IT OUT

Overview

This API retrieves the open obligations from the partner/external system.

This API provides access to retrieve current open obligations from the partner or external system. Open obligations represent pending or ongoing tasks, commitments, or responsibilities within the system.

OperationId: GET Due Forms

Authorization Method(s): OAuth</a

Verb: GET

End Point: /api/v1/Forms/DueForms

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
External Reporting Entity*	ExternalReportingEntity	string
Start Date For Reporting Period*	StartDateForReportingPeriod	string
Reporting Period From Date	ReportingPeriodFromDate	string
Reporting Period To Date	ReportingPeriodToDate	string
Include Locations	IncludeLocations	boolean
Offset	Offset	integer
Limit	Limit	integer
Honor Reporting Period To Date	honorReportingPeriodToDate	boolean
Location Id	LocationId	string
Reporting Country	ReportingCountry	string
Reporting Year	ReportingYear	integer
Reporting Periodicity	ReportingPeriodicity	string
Reporting Period Num	ReportingPeriodNum	string
Form Id	FormId	string
Submission Mode	SubmissionMode	string
Due Date	DueDate	string

*Mandatory parameter

DueFormsResponse

OVERVIEWEXAMPLE

Overview

The response object containing a list of due forms.

DueFormsResponse

Display Name	Field Name	Field Type
Data	data	array[DueFormEntity]

DueFormEntity

Display Name	Field Name	Field Type
Reporting Year	reportingYear	string
Reporting Country	reportingCountry	string
Reporting Period From Date	reportingPeriodFromDate	string
Reporting Period To Date	reportingPeriodToDate	string
Due Date	dueDate	string
Form Id	formId	string
Reporting Periodicity	reportingPeriodicity	string
Reporting Period Num	reportingPeriodNum	string
Submission Mode	submissionMode	string

Example Response

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

{
  "data": [
    {
      "reportingYear": "2023",
      "reportingCountry": "US",
      "reportingPeriodFromDate": "2023-01-01",
      "reportingPeriodToDate": "2023-03-31",
      "dueDate": "2023-04-15",
      "formId": "FORM12345",
      "reportingPeriodicity": "Q",
      "reportingPeriodNum": "04",
      "submissionMode": "M"
    }
  ]
}

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 a list of due forms in the specified format. Success Response - 200 OK. The API will respond with the requested data.
204	204 No Content If no records are found for the provided request, the API will respond with a No Content status.
400	Bad request. The API will respond with an error if there is an issue with the request parameters.
401	401 Unauthorized: The user's authentication is not valid.
500	Internal server error. The API will respond with an error if there is an unexpected server issue.

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/Forms/DueForms

Add Request Headers: