SureTax Returns API
Forms
The Forms API is designed to generate and get information about Tax Forms.
Operations
The Forms Resource has the following operations available
| Verb | Operation Id | End Point | Description |
|---|---|---|---|
| GET | GET External Reporting Entities | /api/v1/Forms/ExternalReportingEntities | The External Reporting Entities API facilitates the retrieval of an up-to-date roster of active reporting entities linked to a designated Parent Account. Each reporting entity is uniquely identified by a distinct ID, ensuring seamless management and tracking. |
| GET | GET Due Forms | /api/v1/Forms/DueForms | 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. |
| GET | GET Generation Request Status | /api/v1/Forms/GenerationRequestStatus | This API endpoint is utilized to continuously check the status of form generation requests until the process reaches its final completion status. It enables clients to monitor the progress of form generation activities until they are successfully completed or terminated. |
| GET | GET Form Instances | /api/v1/Forms/FormInstances | This API endpoint retrieves comprehensive details regarding a specific generated form instance. It provides clients with essential information such as form ID, name, format, size, availability of logs, visualization support, and current status. |
| DELETE | DELETE Form Instances | /api/v1/Forms/FormInstances | This API endpoint enables the deletion of generated form instances from the system. It provides clients with the ability to remove specific form instances that are no longer needed or relevant, helping to maintain data integrity and system cleanliness. |
| PATCH | PATCH Form Instances | /api/v1/Forms/FormInstances | This API endpoint facilitates the updating of the status associated with a form instance. It allows clients to modify the status of a form instance based on their specific requirements or workflow processes. |
| GET | GET Form Instance Download URL | /api/v1/Forms/FormInstanceDownloadURL | This API endpoint provides clients with the download URL for accessing a specific form instance. A unique URL is generated for restricted access. The URL includes necessary authentication data, ensuring secure access to the form instance and contains expiration time. |
| POST | POST Due Form Instances | /api/v1/Forms/DueFormInstances | This API endpoint initiates the process of generating forms within the system. It serves as the trigger for creating various forms necessary for compliance or reporting purposes. |
| GET | GET Form Instance URL | /api/v1/Forms/FormInstanceURL | This API endpoint facilitates the retrieval of a URL that enables users to view or edit a specific form instance within the client UI. The URL generated by this endpoint grants direct access to the form instance. |
| GET | GET Form Instance Change Log ID | /api/v1/Forms/FormInstanceChangeLog | This API endpoint retrieves the change log associated with a generated form instance. The change log provides a detailed record of any modifications made to the form instance. |
| POST | POST Regenerate Form Instance | /api/v1/Forms/RegenerateFormInstance | This endpoint is used to regenerate a specific form instance based on the latest data or configuration. This action is typically performed when a form needs to be updated with new information or recalculated. |
| POST | POST Tax Items | /api/v1/Forms/TaxItems | This API endpoint enables upload of transactions from the external tax system into SureTax, facilitating further processing and generation of forms. By triggering this endpoint, users can seamlessly upload tax-related data. |
| DELETE | DELETE Tax Items | /api/v1/Forms/TaxItems | This API endpoint enables the deletion of tax items, providing the capability to remove specific tax items. Deletion operations are filtered based on externalReportingEntity and companyCode parameters, allowing targeted removal of tax items associated with specific entities and companies. |
| POST | POST Reset Form Instance | /api/v1/Forms/ResetFormInstance | This endpoint is used to reset a specific form instance to its initial state. This action clears any modifications or updates made to the form instance, restoring it to its default configuration. |
| GET | GET Upload Request Status | /api/v1/Forms/UploadRequestStatus | This API endpoint allows users to retrieve the status of a specific upload process and obtain detailed error messages for any tax items that may have inconsistencies. By querying this endpoint, users can monitor the progress of their upload requests, ... |
| GET | GET Upload History | /api/v1/Forms/UploadHistory | This API endpoint retrieves the list of X-Request-IDs associated with previous Upload requests. Each X-Request-ID serves as a unique identifier for an individual upload request, allowing users to track and reference past interactions with the system. |
| GET | GET Tax Items Delete Request Status | /api/v1/Forms/TaxItemsDeleteRequestStatus | This API endpoint provides users with the status of the deletion process for tax items, along with any associated error messages. |
| GET | GET Submission Request Status | /api/v1/Forms/SubmissionRequestStatus | This endpoint is used to retrieve the current status of a submission request for a specific form instance. This status provides information about whether the form submission was successful, failed, or is still in progress. |
| POST | POST Submit Form Instances | /api/v1/Forms/SubmitFormInstances | This endpoint is used to submit one or more form instances for processing. This operation finalizes the forms and submits them to the relevant system or authority for review or further action. |
| GET | GET Form Instance Generation Log | /api/v1/Forms/FormInstanceGenerationLog | This API endpoint retrieves the generation log associated with a specific form instance. It allows clients to access detailed information about the process of generating the form, including any messages, warnings, or errors encountered during the generation process. |
| GET | GET EnrichedTaxItems | /api/v1/Forms/EnrichedTaxItems | Fetch enriched tax items including reporting authority and detailed tax information based on filters such as reporting entity, company code, fiscal year, and date range. |