Guidelines for Loading Taxable Benefits for the UK

Taxable Benefits isn’t an auto-generated card, if recording taxable benefit data for the first time. You need to create the Taxable Benefits card and its association with the employee’s tax reporting unit.

Taxable Benefits Calculation Card Attributes

The Statutory Deductions calculation card uses these attributes:

HCM Data Loader Attribute Alternative User Key Attributes Functional Description
SourceSystemId CardSequence, AssignmentNumber, DirCardDefinitionName, LegislativeDataGroupName A unique identifier for the Taxable Benefits calculation card. For new calculation card supply the source key attributes. You can also identify calculation cards with the user key attributes.
SourceSystemOwner N/A The name of the source system owner used to generate the source system ID.
LegislativeDataGroupName N/A The name of the legislative data group for the calculation card.
DirCardDefinitionName N/A The name of the card definition. Specify ‘Taxable Benefits’
AssignmentId(SourceSystemId) AssignmentNumber Either supply the source system ID, or assignment number that identifies the employee assignment this calculation card is for.
EffectiveStartDate N/A The start date of the calculation card.
CardSeqeunce N/A Specify ‘1’.

These attributes are supplied against the CalculationCard discriminator. Always supply the CalculationCard record, even when updating an existing card.

Card Components

The following table lists the multiple card components applicable to the Taxable Benefits calculation card. Provide a card component record for each taxable benefits type required. The attributes to provide for each card component are common but some card components reference other card components as parents and when this is the case both card components should be supplied together.

Card Components Applicable to the Taxable Benefits Calculation Card

Card Component Name Parent Card Component
Car and Car Fuel N/A
Period of Unavailability Car Car and Car Fuel
Expenses Payments on Behalf of Employee N/A
Other Items N/A
Assets Placed at Employee Disposal N/A
Service Supplied N/A
Qualifying Relocation Expenses and Benefits N/A
Private Medical Treatment or Insurance N/A
Interest Free and Low Interest Loans N/A
Basic Mileage Details N/A
Mileage Allowance Payments Basic Mileage Details
Employer Providing Living Accommodation N/A
Vouchers and Credit Cards N/A
Assets Transferred N/A
Payments Made on Behalf of Employee N/A
Van and Van Fuel N/A
Period of Unavailability Van Van and Van Fuel

Card Component Attributes

When loading a new card component it may be that the Taxable Benefits calculation card already exists. Ensure that the new card component doesn’t pre-date the Taxable Benefits card.

The various Taxable Benefits card components use these attributes:

HCM Data Loader Attribute Alternative User Key Attributes Functional Description
SourceSystemId CardSequence, ComponentSequence, AssignmentNumber, DirCardDefinitionName, LegislativeDataGroupName, DirCardCompDefName A unique identifier for the card component. For new card components supply the source key attributes. You can also identify card components with the user key attributes.
SourceSystemOwner N/A The name of the source system owner used to generate the source system ID.
LegislativeDataGroupName N/A The name of the legislative data group for the card component definition.
DirCardId(SourceSystemId) CardSequence, AssignmentNumber, DirCardDefinitionName, LegislativeDataGroupName The parent Taxable Benefits calculation card should be identified by using the same key type used to identify the calculation card.

When using source keys, supply this attribute with the value supplied for the calculation card’s SourceSystemId attribute. Otherwise, supply the user key attributes with the same values as the parent calculation card.

DirCardCompDefName N/A The component definition name. Refer to the table below for the list of card component names.
ParentDirCardCompId(SourceSystemId) CardSequence, ParentComponentSequence, AssignmentNumber, DirCardDefinitionName, LegislativeDataGroupName, ParentDirCardCompDefName Identify the parent card component. You can either, provide this attribute with the SourceSystemId value supplied for the parent card component, or, provide the user key attributes. Only supply for card components that have a parent. Refer to the table below.
EffectiveStartDate N/A The start date of the card component. This must be the same as or after the EffectiveStartDate on the Taxable Benefits calculation card.
EffectiveEndDate N/A The end date is optional for the card component.
ComponentSequence N/A
Context1 N/A A mandatory value to identify the benefit. For example, for car it should be the car registration details.

These attributes are supplied against the CardComponent discriminator.

Component Details

Each Taxable Benefits card component utilizes one or more flexfield contexts. Provide a Component Detail record for each flexfield context within each component card, to load the flexfield segment values.

This table lists the flexfield contexts applicable for each card component:

Card Component Name Flexfield Context
Car and Car Fuel
  • Basic Car Details (ORA_HRX_GB_BSC_CAR_2017)
  • Car Processing Details (ORA_HRX_GB_CAR_PRC_2017)
  • Fuel Processing Details (ORA_HRX_GB_FUEL_PRC_2017)
Period of Unavailability Car
  • Period Of Unavailability (ORA_HRX_GB_PERD_UNAVAIL_2017)
Expenses Payments on Behalf of Employee
  • Expenses Payments (ORA_HRX_GB_EXPS_PYMT_2017)
Other Items
  • Other Items (ORA_HRX_GB_OTH_ITEM_2017)
Assets Placed at Employee Disposal
  • Assets Placed at Employees Disposal (ORA_HRX_GB_ASSET_EMP_DISP_2017)
Service Supplied
  • Basic Benefit Information (ORA_HRX_GB_BSC_BENEFIT_2017)
Qualifying Relocation Expenses and Benefits
  • Qualifying Relocation Expenses (ORA_HRX_GB_QUAL_RL_EXPS_2017)
Private Medical Treatment or Insurance
  • Basic Benefit Information (ORA_HRX_GB_BSC_BENEFIT_2017)
Interest Free and Low Interest Loans
  • Interest Free and Low Interest Loans (ORA_HRX_GB_INTRST_LOAN_2017)
Basic Mileage Details
  • Basic Mileage Details (ORA_HRX_GB_BSC_MILEAGE_2017)
Mileage Allowance Payments
  • Mileage Allowance Payments (ORA_HRX_GB_MILEAGE_PASSNGR_2017)
Employer Providing Living Accommodation
  • Basic Accommodation Details (ORA_HRX_GB_BSC_ACCOMD_2017)
  • Employer Provided Living Accommodation (ORA_HRX_GB_EMPR_LIV_ACCOMD_2017)
Vouchers and Credit Cards
  • Basic Benefit Information (ORA_HRX_GB_BSC_BENEFIT_2017)
Assets Transferred
  • Assets Transferred (ORA_HRX_GB_ASSET_TRNFER_2017)
Payments Made on Behalf of Employee
  • Payments Made on Behalf of Employee (ORA_HRX_GB_PYMT_BEHALF_EMP_2017)
Van and Van Fuel
  • Fuel Processing Details (ORA_HRX_GB_FUEL_PRC_2017)
  • Van Processing Details (ORA_HRX_GB_VAN_PRC_2017)
Period of Unavailability Van
  • Period Of Unavailability (ORA_HRX_GB_PERD_UNAVAIL_2017)
Note: You can find the flexfield segment attribute names for these flexfield contexts using the View Business Objects task.

Component Detail Attributes

These are the common attributes to supply for every component detail. The flexfield context will then determine the flexfield segment attributes to also include:

HCM Data Loader Attribute Alternative User Key Attributes Functional Description
SourceSystemId CardSequence, ComponentSequence, DirInformationCategory, LegislativeDataGroupName, AssignmentNumber, DirCardDefinitionName, DirCardCompDefName A unique identifier for the component detail. For new component detail records supply the source key attributes. You can also identify card components with the user key attributes.
SourceSystemOwner N/A The name of the source system owner used to generate the source system ID.
LegislativeDataGroupName N/A The name of the legislative data group for the card component definition.
DirCardCompId(SourceSystemId) CardSequence, ComponentSequence, AssignmentNumber, DirCardDefinitionName, LegislativeDataGroupName, DirCardCompDefName The parent card component should be referenced using the same key type used to identify the parent record.

When using source keys, supply this attribute with the value supplied for the card component’s SourceSystemId attribute. Otherwise, supply the user key attributes with the same values as the parent card component.

EffectiveStartDate N/A The start date of the component detail, or update to the component detail if you are providing date-effective history. This must be after or equal to the EffectiveStartDate provided for the parentcard component.
EffectiveEndDate N/A

The optional end date of the component detail, or if you are providing date-effective history the last day of the date-effective changes.

DirCardCompDefName The name of the card component this detail is for. This is used to identify the flexfield context and should be supplied even when a source key is used to identify the parent card component.
DirInformationCategory The code for the flexfield context, such as ‘ORA_HRX_GB_BSC_CAR_2017’. Flexfield context codes are visible on the Flexfield Attributes tab of the View Business Objects task.
FLEX:Deduction DeveloperDF Supply the same value as for the DirInformationCategory attribute.

These attributes are supplied against the ComponentDetail discriminator.

Card Association

The card association record associates the Taxable Benefits calculation card with the employee’s tax reporting unit. When the employee has multiple tax reporting units, supply a card association for each tax reporting unit.

The Card Association record type uses these attributes:

HCM Data Loader Attribute Alternative User Key Attributes Functional Description
SourceSystemId CardSequence, TaxReportingUnitName, LegislativeDataGroupName, AssignmentNumber, DirCardDefinitionName A unique identifier for the Taxable Benefits card association. For new card associations supply the source key attributes. You can also identify card components with the user key attributes.
SourceSystemOwner N/A The name of the source system owner used to generate the source system ID.
LegislativeDataGroupName N/A The name of the legislative data group for the card definition.
DirCardId(SourceSystemId) CardSequence, AssignmentNumber, DirCardDefinitionName, LegislativeDataGroupName T

The parent Taxable Benefits calculation card should be identified by using the same key type used to identify the calculation card.

When using source keys, supply this attribute with the value supplied for the calculation card’s SourceSystemId attribute. Otherwise, supply the user key attributes with the same values as the parent calculation card.

EffectiveStartDate N/A The start date of the card association or the update to the card association if you are providing date-effective history. This must be after or equal to the EffectiveStartDate provided for the Tax Withholding calculation card.
TaxReportingUnitName N/A

The name of the tax reporting unit to associate with the Tax Withholding calculation card. If source keys are used to identify the card association, you must still specify the LegislativeDataGroupName attribute to identify the tax reporting unit.

These attributes are supplied against the CardAssociation discriminator.

Card Association Details

The card association details record associates the Taxable Benefits card component with the employee’s assignments. If the employee has more than one payroll assignment provide a card association detail record for each payroll assignment.

The Card Association Detail record type uses these attributes:

HCM Data Loader Attribute Alternative User Key Attributes Functional Description
SourceSystemId CardSequence, TaxReportingUnitName, LegislativeDataGroupName, AssignmentNumber, DirCardDefinitionName A unique identifier for the card association detail record. For new card associations supply the source key attributes. You can also identify card components with the user key attributes.
SourceSystemOwner N/A The name of the source system owner used to generate the source system ID.
DirRepCardId(SourceSystemId) CardSequence, TaxReportingUnitName, LegislativeDataGroupName, AssignmentNumber, DirCardDefinitionName The parent card association record should be identified by using the same key type supplied to against the card association.

When using source keys, supply this attribute with the value supplied for the card’s association SourceSystemId attribute. Otherwise, supply the user key attributes with the same values as the parent card association.

EffectiveStartDate N/A The effective start date of the card association.
EffectiveEndDate N/A The effective end date of the card association.
DirCardCompId(SourceSystemId) CardSequence, ComponentSequence, AssignmentNumber, DirCardDefinitionName, LegislativeDataGroupName, DirCardCompDefName Identify the NI or PAYE card component this association is for.
RelationshipGroupId(SourceSystemId) N/A The surrogate ID of the payroll assignment to associate.
AssociationAssignmentId(SourceSystemId) AssociationAssignmentNumber Identify the employee’s assignment to associate with card component.

These attributes are supplied against the CardAssociationDetail discriminator.