🧑‍🤝‍🧑
Citizen Facing Forms
Council Wide Digital PlatformNo Code Service CreationGCloud Information
  • Introduction
  • LGaaP Services
  • This Guide
  • Platform Functionality
    • Platform Functionality
    • Integration Error Guidance
  • 💙Benefit/Welfare Forms
    • Introduction
    • eClaim
      • Local Council Tax Support
      • Universal Credit
      • Dynamic Evidence
      • Fast Track
      • Benefit App Integration
      • EDMS Integration
      • Reporting
      • Form Level Settings
      • Form Configuration (Files)
      • Value Add Functionality
        • Call Validate - ID Checking
        • Risk Based Verification
          • Settings
          • Configuration (Files)
    • Calculator
      • Settings
      • Calculator Configuration
    • eChanges
      • Intelligent Change Processing
      • Universal Credit
      • Dynamic Evidence
      • Fast Track
      • Benefit App Integration
      • EDMS Integration
      • Form Level Settings
      • Form Configuration (Files)
      • Value Add Functionality
        • Risk Based Verification
          • Settings
          • Configuration (Files)
    • HBAA - Full Case Review
      • Intelligent Change Processing
      • Universal Credit
      • Review Your Claim
      • Dynamic Evidence
      • Benefit App Integration
      • EDMS Integration
      • Form Level Settings
      • Form Configuration (Files)
    • Self Employed Earnings
      • Settings
      • Configuration (Files)
    • Free School Meal Holidays
      • Integrations
        • Ordnance Survey
        • OpenProcess
          • Dynamic Notifications
          • Issuing Vouchers
        • Loqate - Bank Check
        • DfE - ECS
        • Benefit Check
      • Checking integrations
      • BACS Extract
      • Data Extract
    • Additional Services
  • 💳Council Tax Forms
    • Council Tax Services
      • Introduction
      • Direct Debit
        • Real-time Checks
        • Back-office Automation
        • EDMS Automation
        • Settings
        • Direct Debit Email
      • Single Person Discount
        • Real-time Checks
        • Back-office Automation
        • EDMS Automation
        • Settings
      • Change of Address
        • Real-time Checks
        • Back-office Automation
        • EDMS Automation
        • Settings
        • Notification Configuration
      • Discounts / Exemptions
        • Real-time Checks
        • Back-office Automation
        • EDMS Automation
        • Settings
        • Configuration
      • Special Arrangements
        • Real-time Checks
        • Back-office Automation
        • EDMS Automation
        • Settings
      • Request a Refund
        • Real-time Checks
        • Back-office Automation
        • EDMS Automation
        • Settings
      • Local Council Tax Support
        • Real-time Checks
        • Back-office Automation
        • EDMS Automation
      • RPO Localisation
      • Additional Services
      • Landlord Voids & Lets Processing
        • Real-time Checks
        • Back-office Automation
        • File Format
        • EDMS Notification
  • 🚚Bin / Waste Forms
    • Introduction
    • Report a Missed Bin
      • Back Office Integration
      • Settings
      • Missed Bin Configuration
    • Request a Bin
      • Back-office integration
      • Settings
      • Request a Bin Configuration
    • Bulky Waste Collection
      • Back-office integration
      • Settings
      • Bulky Waste Configuration
        • Bulky Waste configuration - new April 2024
    • Request Assisted Collection
      • Back-office integration
      • Settings
      • Assisted Collection Config
    • Clinical Waste Collection
      • Back-office integration
      • Settings
      • Clinical Configuration
    • Garden Waste Subscriptions
      • Garden Waste Form
      • Back-office integration
      • Settings
    • Waste Localisation
    • Agent Payments
  • 🏭Business Rates Forms
    • Direct Debit
      • EDMS Integration
      • Settings
      • Configuration
    • Relief Application
      • EDMS Integration
      • Settings
    • Moves, Reliefs and Pay
      • EDMS Integration
      • Settings
    • Additional Services
  • 🏪Licensing Forms
    • Temporary Event Notice App
      • Back-office Integration
      • EDMS Integration
    • Taxi Driver - Licence Renewal
      • Back-office Integration
      • EDMS Integration
      • Settings
    • Taxi Driver - Vehicle Licence
      • Back-office Integration
      • EDMS Integration
  • 💚Social Care Forms
    • Social Care Financial Assessments
      • Settings
      • SCFA Calculator
      • EDMS Integration
Powered by GitBook
On this page
  • Localisation Settings
  • Direct Debit Recovery Messages
  • Direct Debit Frequency Options
  • Special Arrangement - Direct Debit - Frequency Options
  • Local Disregard Details
  • Local Exemption Details

Was this helpful?

Export as PDF
  1. Council Tax Forms
  2. Council Tax Services

RPO Localisation

Beyond the settings / localisation already mentioned in each of the forms, there is additional localisation, which IEG4 update as a part of your implementation, for Revenues Process Orchestration to enable council specific behaviours.

Localisation Settings

The following settings, which are those IEG4 set, span the Revenues forms and control key elements of behaviour:

Localisation Configuration Options

Example

Description

BaseUrl

URL

URL of the back office system e.g. Integrator, Capita ABC, Web Broker

System

TEST

NEC Specific System Parameter

Domain

RBTEST3

NEC Specific System Parameter

LengthOfAccountNumber

WithoutCheckDigit

7

Some APIs don’t use the full account number. This tells the system the number of digits without the check digit.

NumberOfDaysTo

SuspendNewAccount

14

For NEC you can suppress billing after automation. This is the number of days to suppress billing for.

ReasonForAccountSuspension

SB

For NEC you can suppress billing after automation. This is the reason code to send in the API.

RollUpChangeInCircs

1

This ensures if Benefits forms are in place too, that we automate a change in circumstance where the person is on benefits and reporting someone as moved out.

SourceId

IEG4

This is only relevant for Capita. It explains where the data has come from.

SourceUserId

IEG4

This is only relevant for Capita. It explains where the data has come from.

UserId

aisdba

This is only relevant for Capita. This user needs to be a valid user in Academy. aisdba is the Database Administrator and thus will exist and have super user permission.

NumberOfDaysToCheckForExistingAccount

0

This setting ensures our system looks to see if there is already a VOID account in place on the date someone else is reporting they moved in. It is set to 0 to ensure that if they report the same say i.e. not different by a day, the system automatically makes them liable.

This setting is NEC specific.

NumberOfDaysToSuspend

AccountForBalanceTransfer

NULL

For NEC you can suppress billing after automation where benefit was in place. To ensure the transfer account process takes account of the subsequent benefit calculation.

DefaultNotepadChapter

General

For NEC you can update specific notepad chapters. This setting controls which is used.

NumberOfDaysTo

SuspendCoaMovingInPlan

14

These are Change of Address specific settings that allow billing to be suppressed for a different number of days where necessary for Move In, Move Out and Move Within

NumberOfDaysTo

SuspendCoaMovingOutPlan

14

These are Change of Address specific settings that allow billing to be suppressed for a different number of days where necessary for Move In, Move Out and Move Within

NumberOfDaysTo

SuspendCoaMovingWithinPlan

14

These are Change of Address specific settings that allow billing to be suppressed for a different number of days where necessary for Move In, Move Out and Move Within

NumberOfDays

ToSuspendDirectDebitPlan

4

This is a setting that sets the max time to suppress billing for a DD.

NumberOfDaysTo

SuspendSpdLivingAlonePlan

4

This is a setting that sets the max time to suppress billing for a SPD where they live alone.

NumberOfDaysToSuspend

SpdOccupantMovedInPlan

4

This is a setting that sets the max time to suppress billing for a SPD where someone has moved in

NumberOfDaysToSuspend

SpdOccupantMovedOutPlan

4

This is a setting that sets the max time to suppress billing for a SPD where someone has moved out

NumberOfDaysToSuspend

SpdOccupantPassedAwayPlan

4

This is a setting that sets the max time to suppress billing for a SPD where someone has passed away

LengthOfPropertyReference

14

This tells our system the back office’s standard property reference length

EmptyFurnishedDiscountCode

PCLBUNOCC0

Back office applications can have codes that represent different discount types. This is an example of a code for an empty but furnished discount.

EmptyUnfurnishedDiscountCode

PCLCEMPTY

Back office applications can have codes that represent different discount types. This is an example of a code for an empty and unfurnished discount.

SinglePersonDiscountCode

01

This is the code used where applicable to set a SPD

NumberOfDaysTo

SuspendCtdAdaptedPropertyPlan

14

These are discount specific suppressions that enable billing to be suppressed in different use cases. This one is for a person that has applied for Disabled Band Reduction.

NumberOfDaysToSuspend

CtdDisregardAllButOnePlan

14

These are discount specific suppressions that enable billing to be suppressed in different use cases. This one is for a person that has applied for a Disregard discount as one person is liable.

NumberOfDaysToSuspend

CtdDisregardAllNotSamePlan

14

These are discount specific suppressions that enable billing to be suppressed in different use cases. This one is for a person that has applied for two or more different disregards

NumberOfDaysToSuspend

CtdDisregardAllSamePlan

14

These are discount specific suppressions that enable billing to be suppressed in different use cases. This one is for a person that has applied for a Disregard for all occupiers i.e. exemption.

NumberOfDaysToSuspend

CtdEmptyPropertyPlan

14

These are discount specific suppressions that enable billing to be suppressed in different use cases. This one is for a person that has applied for an empty property discount.

NumberOfDaysToSuspendSpd

AdjustedEffectiveFromDate

14

These are discount specific suppressions that enable billing to be suppressed in different use cases. This one is for a person that has been awarded an SPD as the result of a change.

DirectDebitsBouncedNotepadChapter

ARUDCANX

Where NEC is the back office this is the default notepad chapter to check for bounced direct debits.

UpdatePersonDeceasedReasonCode

DECEASED

This is the deceased reason code as held in NEC, which can differ bizarrely from one council to another.

DirectDebitsBouncedTransactionCode

D/D CASH

Where Civica/Capita are the back office this tells the form the transaction type to check for.

DirectDebitsBouncedWithinDays

365

This tells the form the number of days back from today, for the current financial year, to check for bounced direct debit transactions.

NoOfBouncedTransaction

2

This tells the form the count of transaction types within the number of days specified above to look out for.

UseCheckForOutstanding

RecoveryBalances

1

With Special Arrangements if set to 1 this will ensure the details of existing outstanding recovery balances are retrieved.

FailProcessDueToBenefits

0

Capita only: If set to 1 then within the SPD form a message will display and the form cannot be submitted where the Has Benefits indicator is set to Y. The same applies to the COA form for Move Out (and Within where the moving out account has benefits). For Move In (and the incoming address of Move Within) the form can be submitted but the process will fail if benefits are in place and create an exception.

CoaBillingEnabled

1

This will ensure bills are calculated and generated for COA on the accounts ended/opened if set to 1.

SpdBillingEnabled

1

This will ensure bills are calculated and generated for SPD on the accounts ended/opened if set to 2

NumberOfDaysBeforeReview

365

This ensures that a review date is set 365 days after the effective date

MaximumNumberOfDays

AllowedForBackdating

90

This is the maximum number of days the API update for Single Person Discount will allow. So if a person applies for a single person discount with an effective date of 6 months ago, it will default to 3 months ago if set to 90 days like in this example. NOTE: only applies to NEC

AllowWhenInactive

0

If set to 1, Direct Debits can be set up on the current account.

CheckBankAccountExists

0

If set to 1, we will check if the bank account already exists. This is a NEC specific function.

Direct Debit Recovery Messages

It's possible within the IEG4 forms, to intelligently display different messages based upon a person's recovery stage for their account. The following table illustrates an example of this.

StageCode

StageName

Enabled

AllowDirectDebit

Message

L

Liability Order

1

0

S

Summons

1

0

B

Bill

1

1

R

First Reminder

1

1

Where:

  • Stage Code is the back office identifier for a recovery stage

  • Stage Name is the name of the recovery stage

  • Enabled means a check is happening for that stage

  • Allow Direct Debit if set to 1 means a person can still set up a Direct Debit. But not if set to 0 for the given recovery stage

  • Message is what should be presented where the customer cannot set up a Direct Debit

Direct Debit Frequency Options

The following is an example Direct Debit localisation file. This controls:

  1. The frequency options e.g. Annually, Monthly, Half Yearly etc.

  2. The code specific to the frequency if applicable e.g. A, M, S are the codes for the above

  3. The options available for the frequency e.g. for Monthly:

    1. 1st of the month - 10 instalments

    2. 1st of the month every month

  4. The code specific to the frequency option e.g. for 1st of the month every month the code the back office API expects is DD01NS

Not only do these effect the integration but also the options the customer can select in the forms:

[
  {
    "type": "Annually",
    "codeMapping": "A",
    "dateOptions": [
      {
        "name": "Annual on the 1st",
        "value": "DD01"
      },
      {
        "name": "Annual on the 8th",
        "value": "DD08"
      },
      {
        "name": "Annual on the 15th",
        "value": "DD15"
      },
      {
        "name": "Annual on the 20th",
        "value": "DD20"
      },
      {
        "name": "Annual on the 25th",
        "value": "DD25"
      }
    ]
  },
  {
    "type": "Monthly",
    "codeMapping": "M",
    "dateOptions": [
      {
        "name": "1st of the month - 10 instalments",
        "value": "DD01"
      },
      {
        "name": "1st of the month every month",
        "value": "DD01NS"
      },
      {
        "name": "8th of the month - 10 instalments",
        "value": "DD08"
      },
      {
        "name": "8th of the month every month",
        "value": "DD08NS"
      },
      {
        "name": "15th of the month - 10 instalments",
        "value": "DD15"
      },
      {
        "name": "15th of the month every month",
        "value": "DD15NS"
      },
      {
        "name": "20th of the month - 10 instalments",
        "value": "DD20"
      },
      {
        "name": "20th of the month every month",
        "value": "DD20NS"
      },
      {
        "name": "25th of the month - 10 instalments",
        "value": "DD25"
      },
      {
        "name": "25th of the month every month",
        "value": "DD25NS"
      }
    ]
  },
  {
    "type": "Half yearly",
    "codeMapping": "S",
    "dateOptions": [
      {
        "name": "6 monthly on the 1st",
        "value": "DD01"
      },
      {
        "name": "6 monthly on the 8th",
        "value": "DD08"
      },
      {
        "name": "6 monthly on the 15th",
        "value": "DD15"
      },
      {
        "name": "6 monthly on the 20th",
        "value": "DD20"
      },
      {
        "name": "6 monthly on the 25th",
        "value": "DD25"
      }
    ]
  }
]

Special Arrangement - Direct Debit - Frequency Options

The following is an example Direct Debit localisation file for the Special Arrangement form . This controls:

  1. The frequency options e.g. Annually, Monthly, Half Yearly etc.

  2. The code specific to the frequency if applicable e.g. A, M, S are the codes for the above

  3. The options available for the frequency e.g. for Monthly:

    1. 5th

    2. 15th

    3. 25th

  4. The code specific to the frequency option e.g. for 5th of the month every month the code the back office API expects is DD

[
  {
    "type": "Monthly",
    "codeMapping": "M",
    "dateOptions": [
      {
        "name": "5th",
        "value": "DD"
      },
      {
        "name": "15th",
        "value": "DD12"
      },
      {
        "name": "25th",
        "value": "DD01"
      }
    ]
  },
  {
    "type": "Weekly",
    "codeMapping": "W",
    "dateOptions": [
      {
        "name": "Monday",
        "value": "MON"
      },
      {
        "name": "Wednesday",
        "value": "WED"
      },
      {
        "name": "Friday",
        "value": "FRI"
      }
    ]
  }
]

Local Disregard Details

To be able to support differences in the codes back office systems have for disregard codes, we have the ability to hold different codes for each.

[
  {
    "backendProviderDescription": "02 - Student (Invisible)",
    "backendProviderCode": "02",
    "name": "student"
  },
  {
    "backendProviderDescription": "09 - School Leaver",
    "backendProviderCode": "09",
    "name": "schoolleaver"
  },
  {
    "backendProviderDescription": "03 - Child Benefit",
    "backendProviderCode": "03",
    "name": "childbenefitrecipient"
  },
  {
    "backendProviderDescription": "05 - Apprentice",
    "backendProviderCode": "05",
    "name": "apprentice"
  },
  {
    "backendProviderDescription": "07 - Care Worker",
    "backendProviderCode": "07",
    "name": "carer"
  },
  {
    "backendProviderDescription": "06 - Care Home Resident",
    "backendProviderCode": "06",
    "name": "hospitalorresidential"
  },
  {
    "backendProviderDescription": "04 - Smi",
    "backendProviderCode": "04",
    "name": "severelymentallyimpaired"
  },
  {
    "backendProviderDescription": "13 - Foreign Student Spouse",
    "backendProviderCode": "13",
    "name": "studentsoreignspouse"
  },
  {
    "backendProviderDescription": "08 - Religious Community",
    "backendProviderCode": "08",
    "name": "religiouscommunitymember"
  },
  {
    "backendProviderDescription": "01- In Prison ",
    "backendProviderCode": "01",
    "name": "prisoner"
  },
  {
    "backendProviderDescription": "14 - Foreign Diplomat",
    "backendProviderCode": "",
    "name": "diplomat"
  }
]

Local Exemption Details

To support differences in these from one council/back office system to another, we have configuration to link different exemption types to the back office API codes. The following is example configuration:

[
  {
    "backendProviderDescription": "Student household",
    "backendProviderCode": "CLASS N",
    "name": "student"
  },
  {
    "backendProviderDescription": "Providing personal care,",
    "backendProviderCode": "CLASS J",
    "name": "carer"
  },
  {
    "backendProviderDescription": "In hospital / res care",
    "backendProviderCode": "CLASS E",
    "name": "hospitalorresidential"
  },
  {
    "backendProviderDescription": "SMI",
    "backendProviderCode": "CLASS U",
    "name": "severelymentallyimpaired"
  },
  {
    "backendProviderDescription": "Religious occupation",
    "backendProviderCode": "CLASS H",
    "name": "religiouscommunitymember"
  },
  {
    "backendProviderDescription": "Liable Person detained",
    "backendProviderCode": "CLASS D",
    "name": "prisoner"
  },
  {
    "backendProviderDescription": "Foreign Diplomat",
    "backendProviderCode": "CLASS V",
    "name": "diplomat"
  }
]
PreviousEDMS AutomationNextAdditional Services

Last updated 1 year ago

Was this helpful?

Unfortunately, because your account is at Liability Order stage, you have lost the right to pay your Council Tax by instalments. However, we may be able to agree a discretionary payment arrangement based on your financial circumstances. To do this, please complete our online form:

Unfortunately, because your account is at Summons stage, you have lost the right to pay your Council Tax by instalments. However, we may be able to agree a discretionary payment arrangement based on your financial circumstances. To do this, please complete our online form:

💳
Make a repayment proposal
Make a repayment proposal