HomeUse case library Retrieve list of instances & system configurations for a given instance

USE CASE

Last updated: Mar 25, 2024

Retrieve list of instances & system configurations for a given instance

A set of endpoints exposing Tax Provision instance-related data. Allows:
  • Retrieval of all ONESOURCE Tax Provision instances (Instance IDs) which the caller has access to.
  • Retrieval of a full list of the system parameters configured for a given instance in Tax Provision.
  • Data access
  • Data & document management

For Tax Provision Administrators and tax accounting managers in large multinational corporations and accounting firms, the Tax Provision Instances API offers an efficient solution to obtain a full list of the Tax Provision instances available for the company, as well as a full list of the system parameters configured for a given instance This can be useful when needing to include an Instance ID as an input in calls to other APIs, or for understanding the configuration parameters of an instance.

Key Benefits

  • Efficient Workflow
    • The API allows administrators to get a list of the instances available to their user role.
    • The API allows administrators to get a list of system parameters for a given instance ID

Scenario

Using the ONESOURCE Tax Provision Instances Management API

  1. 1Judy is a new ONESOURCE Tax Provision Administrator for her company and she needs to know the ONESOURCE Tax Provision Instances for her company.
  2. 2In the past she has performed this activity by logging into ONESOURCE Tax Provision and navigating to the Platform Administration screen to view a listing of all the instances.
  3. 3Judy has just learned that her IT department has created a new utility tool that utilizes the Instances API. Judy decides to retrieve a list of the instances assigned to her company using the new utility and is surprised with how easy and fast she can complete this task without needing to log into the ONESOURCE Tax Provision software and manually check.
  4. 4Using the instance IDs she has obtained, she can now use the same API to get a list of all system parameter settings that are being used by these instances.
  5. 5This is an efficient and effective way to quickly review and determine if 1) the parameters being used are correct; 2) there are missing parameters needed to enable additional functionality.