SureTax DRC API
Forms
Operations
The Forms Resource has the following operations available
| Verb | Operation Id | End Point | Description |
|---|---|---|---|
| DELETE | DELETE Form Instances | /api/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. |
| DELETE | DELETE Tax Items | /api/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. It's worth noting that while this endpoint offers valuable functionality, its usage is optional and may not be mandatory for all scenarios. |
| GET | GET Due Forms | /api/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 External Reporting Entities | /api/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 Form Instance Change Log ID | /api/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, including information such as the type of change, timestamp, and the user responsible for the change. By accessing the change log, users can track the history of modifications made to the form instance, facilitating transparency and auditability of the data. |
| GET | GET Form Instance Download URL | /api/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 to enhance security. |
| GET | GET Form Instance Generation Log | /api/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. This information can be valuable for troubleshooting, auditing, and ensuring the accuracy of generated forms. |
| GET | GET Form Instance URL | /api/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, providing users with the ability to either view or modify its contents as needed. The URL includes authentication-related data required for secure access and has an expiration time to ensure security measures. |
| GET | GET Form Instances | /api/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. |
| GET | GET Generation Request Status | /api/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 Submission Request Status | /api/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. It allows users to track the processing state of their form submissions and respond accordingly |
| GET | GET Tax Items | /api/Forms/TaxItems | This endpoint retrieves additional data from tax items that were previously uploaded into the system. |
| GET | GET Tax Items Delete Request Status | /api/Forms/TaxItemsDeleteRequestStatus | This API endpoint provides users with the status of the deletion process for tax items, along with any associated error messages. While not mandatory, it offers valuable insight into the progress and outcome of deletion operations initiated within the system. Users can utilize this endpoint to monitor the status of deletion requests, identify any errors or issues encountered during the process, and take appropriate actions as needed. |
| GET | GET Upload History | /api/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. By accessing the Upload history, users can review and manage the history of their data uploads, facilitating organization and accountability within the system. |
| GET | GET Upload Request Status | /api/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, identify any tax items that failed to upload correctly, and access error messages to troubleshoot and resolve issues effectively. This functionality facilitates seamless data management and ensures the integrity of tax item uploads within the system. |
| PATCH | PATCH Form Instances | /api/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. |
| POST | Post Due Form Instances | /api/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. |
| POST | Post Regenerate Form Instance | /api/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 due to changes in the source data or settings. The regeneration process overwrites the existing form instance with the newly generated one. |
| POST | Post Reset Form Instance | /api/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. The reset operation is typically used when the form needs to be reprocessed or when changes need to be undone. |
| POST | Post Submit Form Instances | /api/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. Once submitted, the forms enter the processing workflow and are no longer editable. The endpoint supports submitting multiple forms at once. |
| POST | Post Tax Items | /api/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, enabling the external system to perform additional processing tasks and generate necessary forms as required. This functionality streamlines the data exchange process, enhancing efficiency and accuracy in tax-related operations. |