Skip to content

IFS Connect for Integrating Generic Tax Output with Service Provider REST Endpoints

The purpose with this page is to provide a guide on how to configure IFS Connect for integrating generic tax output with service provider REST endpoints.

Example connect configuration files are given.

Routing Rule: Example_Tax_Generic_Output

Routing Address: Example_Tax_Generic_Output

Fill the values properly in the example files as described below as the first step to make the integration works.

Configure Routing Address

  1. Navigate to Routing Addresses.

  2. Go to REST Address Data and fill the information as follows.

    • Rest Root End Point: Provide the REST end point URL for the service.

    • Client Id: The client identifier issued during application registration process with the service provider.

    • Client Secret: The client secret issued during application registration process with the service provider.

    • Token Endpoint: Provide the endpoint URL for authorization server.

    • Token Endpoint Parameters: This is not a mandatory parameter. But if the service endpoint requires more information like scope fill it with comma separated name value pairs. Ex: scope=tr:example:auth:api:testscope, test=testvalue

Configuration guideline when Authorization Server Returns “token” instead of “access_token”

Now ‘authorization’ and ‘accessing the resource/service’ is a twostep process.

Step 1: Set up IFS Connect for Authorization

Step 2: Set up IFS Connect for Accessing the resource/service

Step1:

JSON payload required for authorization is set from the logic using the values entered for client ID and client secret in the application.

  1. Navigate to External Tax Reporting.
  2. Go to Service Provider Connection Information.
  3. Provide the values for Client ID and Client Secret.

Synchronous REST call is made to the authorization server to get the token back to the logic.

Add a new routing address to fetch token.
  1. Navigate to Routing Addresses and add a new routing address.
  2. Select REST as Transport Connector.
  3. Provide a value to Address Name.
  4. Select Next and go to REST Address Data.

  5. In REST Address Data fill the information as follows.

    • Sender Instance: REST_SENDER1

    • Authentication Method: None

    • Rest Root End Point: Provide the Authorization end point URL

    • Rest HTTP Method: Select POST

    • Select Finish.
Add a new routing rule.
  1. Navigate to Routing Rules.
  2. Select the Outbound tab and add new routing rule.
  3. Select Outbound as Direction and move to Next.
  4. Select APPLICATION_MESSAGE as Route From and ensure the Enable is selected.
  5. Enter a proper description in the Rule Name.
  6. Do not Pick the value for queue and select Finish.

  7. Navigate to group Content Based Conditions and add new. Add a condition as follows.

    MESSAGE_FUNCTION as Search, equals as Operation and TAX_GENERIC_OUTPUT_AUTH as Match.
    9. Navigate to group Destination Addresses and select Set Destination Addresses.
    10. Search for the Routing Address created above and select it.

Step 2:

The token is extracted and send back with the request payload from the logic through IFS connect.

This requires setup for new routing rule and routing address.

Add a new routing address to access the resource/service.
  1. Navigate to Routing Addresses and add a new routing address.
  2. Select REST as Transport Connector.
  3. Provide a value to Address Name.
  4. Select Next and go to REST Address Data.

  5. In REST Address Data fill the information as follows.

    • Sender Instance: REST_SENDER1

    • Authentication Method: None

    • Rest Root End Point: Provide the Service/Resource end point URL

    • Rest HTTP Method: Select POST

    • Select Finish.
Add a new routing rule

  1. Navigate to Routing Rules.

  2. Select the Outbound tab and add new routing rule.

  3. Select Outbound as Direction and move to Next.

  4. Select APPLICATION_MESSAGE as Route From and ensure the Enable is selected.

  5. Enter a proper description in the Rule Name.

  6. Pick the OUT1 as queue and select Finish.

  7. Navigate to group Content Based Conditions and add new. Add a condition as follows.

    MESSAGE_FUNCTION as Search, equals as Operation and TAX_GENERIC_OUTPUT as Match.

  8. Navigate to group Destination Addresses and select Set Destination Addresses.

  9. Search for the Routing Address created above and select it.

IFS Connect configuration for sending Generic Tax Output to a server location.

There are example IFS connect configuration files given to send generic tax output (JSON object) to FTP location.

Routing Rule: Example_Tax_Generic_Output_Server

Routing Address: Example_Tax_Generic_Output_Server

There is an record for the created output file in Application Messages . Users can setup different ways how the file should be exported using different transport connecters in routing addresses.