The MasterData APIs can be used to retrieve list of Entities, details of a particular Entity, Entity Hierarchy, Jurisdictions supported, List of Template Families, List of Templates in a family and specifying exchange rate data.

For firms that use ONESOURCE Client Manager – a ONESOURCE platform feature generally used by service providers to segregate data and returns into Clients (or domains), these APIs can also be used to retrieve the list of Clients

1. List of Clients

Response

2. List of Entities

Response

3. Create Entity

Request

Response

4. Entity details by ID

Response

5. Get Entity Hierarchy

Response

6. List of Jurisdictions

Response

7. List of Template Families

Response

8. List of Templates in a family

Request

Response

9. Exchange Rate Maps

Request

Response

Note: The below endpoints are only available on EAP stage.

[ EMEA Base URL: api-emea.onesourcetax.com/indirect-tax-compliance/eap/master-data ]

[ APAC Base URL: api-apac.onesourcetax.com/indirect-tax-compliance/eap/master-data ]

Add, Modify & Delete entities:

 1. Add entity: 

Overview: Entity manager API supports the creation of new entity & managing the entities. Following activities can be accomplished with these API’s:

• Add, modify, and delete the entity
• Add, modify, and delete the entity master data. E.g., VAT number

For creating an entity using API endpoint (/entities), below are the mandatory parameters:

• Name: Name of the entity. E.g., API_Test
• Short name: Short name of the entity. E.g., API_Test
• Legal entity type: Legal type of entity. E.g., Company
• Identifier: Entity identifier. E.g., API_Test
• Jurisdiction: ID of jurisdiction to which entity belongs. E.g., nl

{

  "entities": [

    {

      "name": "Entity Name 1",

      "shortName": "Entity Short Name 1",

      "businessSegment": "",

      "geography": "",

      "legalEntityType": "Company",

      "managerLogin": "",

      "partnerLogin": "",

      "directorLogin": "",

      "type": "",

      "identifier": "Entity Identifier 1",

      "taxId": "HU12345678",

      "team": "",

      "city": "",

      "service": "",

      "reportingCompanyName": "Company Name",

      "jurisdictionId": "hu"

    }

  ]

}

{

  "items": [

    {

      "id": "00000000-0000-0000-0000-000000000000",

      "name": " Entity Name 1",

      "shortName": " Entity Short Name 1",

      "businessSegment": "",

      "geography": "",

      "active": true,

      "access": "Write",

      "legalEntityType": "Company",

      "managerLogin": "",

      "partnerLogin": "",

      "directorLogin": "",

      "type": "",

      "identifier": "Entity Identifier 1",

      "taxId": "HU12345678",

      "team": "",

      "city": "",

      "service": "",

      "jurisdiction": {

        "id": "hu",

        "name": "Hungary"

      },

      "createdBy": "Administrator",

      "createDate": " 2023-06-21",

      "lastUpdatedBy": "",

      "reportingCompanyName": "Company Name",

      "lastUpdatedDate": ""

    }

  ]

}

After the creation of the entity, the user is provided with a unique id & status:

2. Modify entity: 

Using this request user can update the existing entity name/short name into the OIC application.

For creating an entity using API endpoint (entities/{id}), below are the mandatory parameters:

{

      "name": "TestEntity_100",

      "shortName": "TestEntity_100",

      "businessSegment": "TestEntity_100",

      "geography": "Japan",

      "legalEntityType": "Company",

      "managerLogin": "Tom Hanks",

      "partnerLogin": "Emma Watson",

      "directorLogin": "Alan Shore",

      "type": "TestEntity_100",

      "identifier": "TestEntity_100",

      "taxId": "ABC8787877",

      "team": "",

      "city": "London",

      "service": "BlahCubed",

      "reportingCompanyName": "Company Name",

      "jurisdictionId": "nl"

}

Response:

3. Delete entity: 

Using this request user can delete any existing entity into the OIC application.

Note: An Entity can be deleted by using the id.

Response:

Add & Modify Group:

Overview: Group Entity API supports the creation of new group structure & managing the group structure. Following activities can be accomplished with these API’s:

• Add and delete the VAT group

1. Add Group:

For creating a group entity using API endpoint (/entity-hierarchy-nodes/{id}), below are the mandatory parameters:

• Id: ID (Unique) of Entity
• name: Name of Entity
• is-group: Defines if the Entity is a group or not (True/False)
• display-order: Order of entities under Group. Integer value i.e., 0 if group
• entry-date: Entry Date of Entity under the Group
• exit-date: Exit Date of Entity under the Group
• ownership: Defines the percentage ownership of Entity.
• entities: Details of each entity under the group

After the creation of the group entity, the user is provided with a unique id & status:

2. Delete Group:

Using this request user can delete the existing VAT group into the OIC application.

Note: A Group entity can be deleted by using the id. All child entities under that node id will be deleted.

Response:

Mappings: Allocation spec

Overview: Allocation specification is placeholder for all different type of mapping. Following activities can be completed by the user with these API’s endpoints:

• Add, modify, and delete the Allocation specification.

1. Get the list of all existing allocation specifications:

The endpoint returns a list of all existing allocation specifications.

Response:

{

  "items":

  [

        {

            "id": 465,

            "name": "DTR-Spec-API-22",

            "useErpCodes": false,

            "useNorwayCodes": false,

            "inUse": "No",

            "createdBy": "api.user",

            "createdDate": "2023-07-10T06:46:01",

            "lastUpdatedBy": "api.user",

            "lastUpdatedDate": "2023-07-10T06:46:01"

        }

    ]

}

Response code:

2. Add a new allocation specification:

This endpoint creates a new Allocation specification in the system, below are the mandatory parameters:

• name: Name of the allocation spec. E.g., Test_allocation_spec
• useErpCodes: If this allocation spec will be used for ERP codes. E.g., false
• useNorwayCodes: If this allocation spec will be used for Norway codes. E.g., false

After the creation of the allocation spec, an unique id will be generated. E.g., 470

Response:

3. Fetch specific allocation spec information:

This endpoint is used to fetch the allocation spec detail for the mentioned id.

Response:

{

    "id": 470,

    "name": "Test_allocation_spec",

    "useErpCodes": false,

    "useNorwayCodes": false,

    "inUse": "No",

    "createdBy": "api.user",

    "createdDate": "2023-08-09T07:24:53",

    "lastUpdatedBy": "api.user",

    "lastUpdatedDate": "2023-08-09T07:24:53"

}

Response code:

4. Modify allocation spec:

This endpoint is used to modify the allocation spec, id need to supply in the modify request:

Response:

5. Delete an allocation spec:

This endpoint deletes Allocation specification from the system, id need to be mentioned in the delete request:

Response:

Mappings: Entity Code

Overview: Entity map API supports the mapping of source and destination entities. Following activities can be accomplished with these API’s:

• Add, modify, and deletion of entity mapping.

​​​​​ 1. Add entity map:

For creating entity mapping using API endpoint (/allocations/{allocationId}/entity-maps), below are the mandatory parameters:

• sourceEntityName: Name of source Entity. E.g., API_Test
• targetEndityId: ID (Unique) of Entity. E.g., 5f5000cc-adcd-4666-ab2e-1b7f76d9a1be

After the creation of the entity map, the user is provided with a unique id & status:

Response:

Please refer below help page for more details related to the Entity Mapping:

ONESOURCE Indirect Compliance Help > Entity Mapping

2. Modify entity map:

For modifying entity mapping, id need to be supplied in the request, below are the mandatory parameters:

• sourceEntityName: Name of source Entity. E.g., API_Test
• targetEndityId: ID (Unique) of Entity. E.g., 5f5000cc-adcd-4666-ab2e-1b7f76d9a1be

Response:

3. Delete entity map:

For deleting entity mapping, id need to be supplied in the request:

Note: An Entity Map can be deleted by using the id.

Response:

Mappings: Tax Codes

Overview: Tax code map API supports the mapping of source and destination tax code mapping. Following activities can be accomplished with these API’s:

• Add, modify, and delete the tax code mapping.

1. Add Tax code map:

For creating entity mapping using API endpoint (/allocations/{allocationId}/jurisdictions/{jurisdictionId}/transaction-types/{transactionType}/tax-code-maps), below are the mandatory parameters:

• sourceTaxCode:  Source tax code details. E.g., MyTaxCode
• targetTaxCode: Target tax code details. E.g., AP_DOMPURGDS_SA

After the creation of the tax code map, the user is provided with a unique id & status:

Response:

Please refer below help page for more details related to the Tax code mapping:

ONESOURCE Indirect Compliance Help > Tax code mapping

2. Modify Tax code map:

For modifying tax code mapping, id need to be supplied in the request, below are the mandatory parameters:

• sourceTaxCode:  Source tax code details. E.g., MyTaxCode
• targetTaxCode: Target tax code details. E.g., AP_DOMPURGDS_SA

Response:

3. Delete Tax code map:

For deleting tax code mapping, id need to be supplied in the request:

Note: An Tax code map can be deleted by using the id.

Response:

Mappings: Exchange rate mapping

Overview: The purpose of Exchange Rate map is to apply exchange rates to the transaction amounts in the source file upon allocation. Exchange rate maps apply exchange rates configured in Indirect Tax Compliance to transaction amounts in your source file upon allocation.

Following activities can be accomplished with these API’s:

• Add, modify, and delete the Exchange Rate mapping.

1. Get all the existing exchange rate mappings:

The endpoint returns a list of all existing transaction date types.

Response:

{

  "items": [

    {

      "id": 1,

      "entityId": "c123456d-7890-123c-a456-789c01e23f4a",

      "entityName": "Entity 1",

      "transactionType": "AP",

      "exchangeRateSource": "SourceFile",

      "effectiveDateType": "InvoiceDate",

      "dateOffset": 0

    },

    {

      "id": 2,

      "entityId": "c987654d-3210-987c-a654-321c09e87f6a",

      "entityName": "Entity 2",

      "transactionType": "AR",

      "exchangeRateSource": "Custom Source 1",

      "effectiveDateType": "PostingDate",

      "dateOffset": 2

    }

                ]

}

Response code:

Please refer below help document link for more details on Exchange Rate Mapping:

ONESOURCE Indirect Tax Compliance > Exchange Rate Mapping

2. Add Exchange Rate map:

This endpoint creates a new exchange rate mapping in the system, below are the mandatory parameters:

• entityId: This is the entity id witch whom this exchange rate will be applied.
• transactionType: This is the transaction type of data. E.g., AP or AR
• exchangeRateSourceId: This is the type of exchange rate source. E.g., Source, ECB & Custom
• effectiveDateType: Which date need to use for applying the exchange rates. E.g., Invoice Date or Reporting Date

After the creation of the irrecoverable code map, an unique id will be generated.

Response:

​​​​ 3. Get exchange rate mapping using the id:

This endpoint returns details of existing exchange rate mapping for the given id.

Response:

{

  "id": 1,

  "entityId": "c123456d-7890-123c-a456-789c01e23f4a",

  "entityName": "Entity 1",

  "transactionType": "AP",

  "exchangeRateSource": "SourceFile",

  "effectiveDateType": "InvoiceDate",

  "dateOffset": 0

}

Response code:

4. Modify Exchange Rate map:

This endpoint updates existing exchange rate mapping in the system, id need to supply in the modify request:

Request

{

  "entityId": "c123456d-7890-123c-a456-789c01e23f4a",

  "transactionType": -1,

  "exchangeRateSource": "ECB",

  "effectiveDateType": "InvoiceDate",

  "dateOffset": 0

}

Response:

5. Delete Exchange Rate map:

This endpoint deletes exchange rate mapping from the system, id need to be mentioned in the delete request:

Response:

Mappings: Transaction type map

Overview: Transaction Type mapping is used to determine the type of transactions (payable/receivable) in the source file.

Following activities can be completed by the user with these API’s endpoints:

• Add, modify, and delete the Transaction Type mapping.

1. Get all the existing Transaction Type sources:

The endpoint returns a list of all existing Transaction Type sources.

Response:

{

  "items": [

    {

      "id": 1,

      "sourceTransactionType": "Recievable",

      "targetTransactionType": "AR"

    },

    {

      "id": 2,

      "sourceTransactionType": "Payable",

      "targetTransactionType": "AP"

    }

  ]

}

Response code:

2. Add Transaction Type map:

This endpoint creates a new Transaction Type mapping in the system, below are the mandatory parameters:

• sourceTransactionType: Source file mentioned in the import file. E.g., Payable or receivable
• targetTransactionType: Target Transaction type available in the system. E.g., AP or AR

After the creation of the transaction type code map, an unique id will be generated.

Response:

3. Fetch Transaction Type information form the allocation spec:

This endpoint is used to fetch the Transaction type information from the Allocation Specification using its id.

Response:

{

  "id": 1,

  "sourceTransactionType": "Recievable",

  "targetTransactionType": "AR"

}

Response code:

4. Modify Transaction Type map:

This endpoint is used to Update the Transactiontype map in the given allocation specification, id need to supply in the modify request:

Response:

5. Delete Transaction Type map:

This endpoint deletes Transaction Type mapping from the system, id need to be mentioned in the delete request:

Response: