System Setup

Last modified 07:55, 24 Apr 2017

Configuration Keys

There are two new configuration keys concerning the new pre-population data available under HMRC’s Making Tax Digital project.

Setting PT_DigitalTax_Enable to a Key Value of 1 enables the View DTA option in the ribbon bar within a client’s Tax Return, allowing the API calls to be made and producing the report of client’s data held by HMRC. When this key is set to a value of 0, the option in the ribbon bar is visible but disabled for users.

Setting PT_DigitalTax_Employment_Enable to a Key Value of 1 enables the API calls relating to employment, pensions and State Benefits (other than State Pension) to be made.

Note

The employment data has not yet been made active by HMRC and is included in preparation for HMRC making this information live. The PT_DigitalTax_Employment_Enable key should remain set to 0 until Wolters Kluwer inform customers that it is available.

Both are located under File > Maintenance > User Defined > Configuration and are set with a default Key Value of 0.

File - Maintenance - User Defined - Configuration.png

HMRC Authorisation

For the software to gain access to HMRC’s pre-population data, existing agent credentials, currently used for online filing and to access the HMRC Agent Portal, must be authorised. This provides an OAuth 2.0 token which is stored by CCH Central, which is then used when the API calls are subsequently made.

Agent credentials may be stored in a number of locations within CCH Central, which depends upon the current system set up. Each of these locations has the ability to authorise credentials.

HMRC agent credentials must be entered correctly and saved in CCH Central to enable access to the APIs. User ID and passwords cannot be entered manually into HMRC’s authorisation page.

The ability to authorise agent credentials are subject to task permissions (see the following section). It is set up in such a way to allow a single user, e.g. an IT administrator, to authorise multiple sets of credentials as well as cater for individuals authorising their own credentials.

Tax System Parameters – Online Filing tab

Agent credentials can be entered at database or company/office/department level within the Online Filing tab.

This is accessed under File > Maintenance > Tax Settings > Personal Tax > Tax System Parameters.

Where credentials are used at database level, a new Authorise HMRC DTA row shows the current authorisation status and is where the process is controlled from.

new Authorise HMRC DTA row.png

Where credentials are used at company/office/department level, a new Authorise HMRC DTA column in the table shows the current authorisation status and is where the process is controlled from.

new Authorise HMRC DTA column at company office department level.png

To authorise a set of agent credentials, click on the associated Not Authorised hyperlink. Select Authorise credentials in the menu box that appears.

Authorise credentials from hyperlink.png

A webpage entitled ‘Authority to interact with HMRC on your behalf’ opens, which lists the information sources CCH Central will access. At the bottom of the page are the options to grant authority or not. Select Grant authority.

The webpage will close and a success message is shown. Click OK to clear the message and see the updated Authorise HMRC DTA status of the credentials used for the authorisation process.

HMRC Authorization was successful.png

Employee Details – Online filing details tab

An employee can have agent credentials entered against their record in CCH Central. This is accessed under the Online filing details tab when viewing the employee details record.  

Online filing details tab.png

 

 

 

 

 

 

 

A new Authorise HMRC DTA row shows the current authorisation status and is where the process is controlled from.

Click on the Not Authorised hyperlink and select Authorise credentials in the menu box that appears.

Authorise credentials from hyperlink.png

A webpage entitled ‘Authority to interact with HMRC on your behalf’ opens, which lists the information sources CCH Central will access. At the bottom of the page are the options to grant authority or not. Select Grant authority.

The webpage will close and a success message is shown. Click OK to clear the message and see the updated Authorise HMRC DTA status.

HMRC Authorization was successful.png

Digital Tax Maintenance Menu

An option to authorise credentials has been added to the maintenance menu. This is accessed under File > Maintenance > Digital Tax > HMRC Authorisation.

Credentials are searched for and authorised in the following order, based on the user:

  1. Employee credentials, in the current user’s online filing details tab.
  2. Company/office/department credentials based on whichever the user is assigned to.
  3. Database level.

This option is particularly designed for scenarios where each employee has their own unique set of agent credentials, or where all their clients are assigned to the user’s company / office / department.

Where credentials are shared between multiple users or a user works on clients assigned to a different company / office / department, the recommend method for authorising is via the Tax System Parameters or the Employee Details online filing tabs.

Status

There are three statuses associated with the HMRC DTA authorisation.

Where the credentials have not been authorised and no OAuth 2.0 token exists in the CCH Central database, a Not Authorised status is displayed.

Authorised & Valid.png

Where credentials have been successfully authorised and a valid OAuth 2.0 token exists in the CCH Central database, an Authorised & Valid status is displayed.

Authorised & Expired.png

The OAuth 2.0 token will expire, e.g. when the authorisation period determined by HMRC has been exceeded. Where credentials have been authorised and an OAuth 2.0 token exists, but this token is expired, an Authorised & Expired status is displayed.

Where the same set of credentials are used in more than one place, for example against an office and against a specific employee, the credentials themselves only need be authorised once. The status automatically updates within CCH Central wherever the same credentials are used.

Clearing tokens

In cases where the OAuth 2.0 access token may need to be removed, the Authorise HMRC DTA menu box includes an option to Clear token.

Authorise credentials from hyperlink.png

Selecting this option and confirming the deletion of the token against the selected credentials will revert the status to Not Authorised.

Task Permissions

A number of task permissions have been added to allow access to the various new Digital Tax features to be controlled.

These are accessed under File > Maintenance > Security > Task Permissions.

HMRC Authorisation

Separate permissions have been added for the ability to authorise credentials and the ability to clear a token to remove it from credentials that were authorised.

For credentials that are stored at database or company/office/department level, two new task permissions have been added under the Personal Tax product, listed within the Menus group:

  • [Maintenance] [Tax settings] [Personal Tax] [Tax system parameters] [Authorise HMRC DTA] [Authorise credentials]
  • [Maintenance] [Tax settings] [Personal Tax] [Tax system parameters] [Authorise HMRC DTA] [Clear token]

For credentials that are stored against an employee’s record, task permissions have been added under the Personal Tax product, listed within the Employee group:

  • #Employee #Online filing details #Authorise HMRC DTA #Authorise credentials
  • #Employee #Online filing details #Authorise HMRC DTA #Clear token

Where the Maintenance > Digital Tax > HMRC Authorisation option is used, the associated task permission to access this maintenance menu option is under the Central product, listed within the Maintenance group.

  • [Maintenance] [Digital Tax] [HMRC Authorisation]

Digital Tax Account access

User access to HMRC’s pre-population data is controlled with a new task permission. Where a user has permission to access a client but not the new View DTA option, the icon will be enabled but the user will see a permission denied message.

This task permission is under the Personal Tax product, listed within the Menus group:

  • [Task Bar] [Digital Tax Account access]
Page statistics
248 view(s) and 22 edit(s)
Social share
Share this page?

Tags

This page has no custom tags.
(not set)

Comments

You must to post a comment.

Attachments

 

 | Cookie Policy | Copyright | Privacy Policy Terms of Use | Contact Us |