Process APIs Overview

Process APIs can be used to automate various tasks and actions within the OIC application, utilizing features that help prepare, finalize and file returns, as well as utilize features to assist with audit & review, such as printing returns and downloading e-filing receipts.

Leveraging the suite of APIs to support the automation of processes within the application, can help businesses operate their tax department more efficiently, and free up time for users to focus on value – add, as opposed to process driven, activities.

Process APIs Description

The Process APIs can help users automate repetitive tasks that need to be performed on a regular basis and take up team members' time during the busy filing period. In general, they fall into 3 categories – managing processes with returns, initiating e-filing processes and printing returns to PDF.

Within returns, users can use the workbook API to populate cells on the company information sheet needed for audit and e-filing purposes, as well as make adjustments directly into manual entry cells on the various schedules to account for missing data and/or corrections.

The Return Status API`s allows users to update the status of the return without the need to interact with the UI. This API allows users to retrieve the latest status of the return and file the return directly based on the return status set.

The E-filing API`s automates the e-filing operation to export the return, file the return download the receipts. OIC can electronically submit returns for various jurisdictions. The requirements and type of support for e-filing vary per jurisdiction; for some jurisdictions OIC supports direct e-filing integration with Tax Authorities, and for others OIC, it supports the return or listing export, to the supported filing format e.g., *.xml, *.txt, *.csv to then upload in the Tax Authority portal.

For the most recent coverage of ONESOURCE e-filing jurisdictions, please contact a member of the ONESOURCE team.

The Print APIs allow users to automatically print returns to PDF, configuring a variety of parameters to define which pages and supplementary information to include, as well as apply Print Styles to apply company branding to printed returns.

Key Benefits:

The Process APIs can help businesses achieve the following benefits.

1. 1Remove dependency on performing actions through the UI.
2. 2Automate processes to run iteratively to bulk perform operations e.g., printing returns or generating e-filing outputs, which can save huge amounts of time for tax teams.
3. 3Schedule jobs to run outside of business hours, so teams can continue work unimpeded with the relevant information needed to review / file generated automatically.
4. 4Ensure entity information is kept up to date on returns, by using the workbook adjustments API.
5. 5Automatically push adjustments to returns based on information maintained outside of OIC to reduce need for preparers to consistently make the same adjustments each period.
6. 6Help remove the need for users to perform repetitive tasks within the application, assisting the team to operate more efficiently and focus on value-add activity.
7. 7Automatically extract PDFs of returns to share with stakeholders, along with Efiling receipts for audit purposes, helping provide additional visibility to tax teams.

Workbook API - Process Flow

Workbook API allows users to understand what sheets and cells can be modified, push data into the available cells within the return and confirm once the return has been successfully updated. Users can also use this API to extract information that has been input into manual entry cells on the returns.

Flow chart of the process described

Workbook API - Scenario 1

• A user utilizes the Datasets API to create new returns for their Australia entities.
• In order to successfully file the returns, information must be added to the P sheet e.g. Australian Business Number and Company Address.
• Users retrieve information on what data is needed on the P sheet using the GET/Import Types and GET/Import Type Metadata.
• The user can then use the Patch/Import Data to specify the values they wish to populate, in each of the respective fields.
• The user can then check the status, and validate that the information has been imported correctly, using the GET/Import Status and GET/Imported Data endpoints.

Return Status API - Process Flow

The Return Status API allows users to retrieve the current status of a return and update it using the update API which allows users to proceed for filing. Depending upon the status set, the return will move from an editable to non-editable state.

Return Status API – Scenario 1

Return Status API - Scenario 1

• A tax team prepares returns for their global filing requirements, across 30 jurisdictions.
• For each jurisdiction, the returns must be reviewed and approved prior to filings. The reviewer should only be able to view the final return with all notes made during the preparation process and corresponding schedules & adjustments.
• The return needs to be in a Non editable state so that the reviewers can only view and approve for filing the return.
• The tax team can schedule a process to run periodically, that will automate status updating of the return for reviewers to access.

E-Filing API - Process Flow

The E-filing API allows users to initiate E-Filing operations, get the status of operations in progress and download E-Filing artifacts and receipts:

Flow chart of the E-filing API

E-filing API - Scenario 1

• A tax team, operating from a Shared Service Center, looks after the global compliance obligations for a multinational operating in 30 jurisdictions, with over 200 returns requiring filing each month.
• This process can be time consuming to navigate through the UI and initiate the e-filing operation for each of these returns on an individual basis.
• The tax team decides to utilize the E-filing API to schedule a process, which runs on a periodic basis, to check for returns, which are finalized and initiate the e-filing operation.
• Once the status is checked and completed, artifacts and receipts are extracted.
• Where e-filing outputs need to be manually uploaded to tax authorities, the outputs generated using the OIC E-filing API can be easily submitted, as per each country's requirements.
• This process removes the need to manually e-file large numbers of returns and frees up time for the tax team to analyze VAT data and trends.

Print API – Process Flow

The Print API allows users to generate customizable PDFs of returns, which can be shared with internal and external stakeholders for audit purposes and review.

Flowchart of the Print API

Print API - Scenario 1

• A tax team prepares returns for their global filing requirements, across 18 jurisdictions.
• For each jurisdiction, returns must be reviewed and approved prior to filings. Reviewers need to be able to view the final return, with all notes made during the preparation process, and corresponding schedules & adjustments.
• The team can use Print Styles to customize a standard template for each jurisdiction, incorporating the relevant information needed for review.
• The tax team in charge can schedule a process to run periodically, that will automate return PDFs generation, and save them in a predefined shared location, for reviewers to access.
• Reviewers can easily access the PDFs of returns and provide the necessary approvals, for the team to proceed with filing.

See also:

For More details on process for end-to-end filing refer to the below link: ONESOURCE Indirect Compliance Help > Electronic filing

• Print returns
• Print styles
• Returns
• Returns status
• Company Information sheet