Approved Data Schema

Billing Authority Data

The following points of data are required from a billing authority’s ratings data for us to on-board each new BID customer and to ensure our ability to synchronise data in the future:


Header Name

Notes

Data Type


hereditamentBAR

Unique “Billing Authority Reference” for the hereditament, as shared with the Valuations Office Agency (i.e. the full reference that can be used to cross reference with Valuations Office Agency data)

String


hereditamentAddress

Street address for the hereditament

String


hereditamentPostcode

Postcode for the hereditament

String


currentRV

The Current Rateable Value of the hereditament, based on any revaluation from 01 April 2017 onwards

Decimal Number


hereditamentDescription

Valuations Office Agency analysis code description for the hereditament

String


accountRef

(where no customerRef - see below)

Postcode for the Unique reference for the billing account, used to identify a hereditament/liable party pairing. Used as a foreign key in our database to support data mapping for future imports.

String


customerRef

(where no accountRef - see above)

Unique reference for the primary liable party regardless of hereditament. Used as a foreign key in our database to support data mapping for future imports.

String


accountHolderName

Name of the primary liable party

String


accountHolderAddress

Street address for the primary liable party

String


accountHolderPostcode

Postcode for the primary liable party

String


accountLevy

Levy charged to the account in this year

Decimal Number


Optional Fields


Header Name

Notes

Data Type


hereditamentUPRN

Unique Property Reference Number for the hereditament, as listed in the National Land and Property Gazetteer (i.e. it can be used to cross reference with Geoplace data). Providing this data will allow us to offer more accurate mapping tools

String


billingRV

The Rateable Value of the hereditament used for billing, if different from the Current Rateable Value

Decimal Number


hereditamentOccupancy

Is the hereditament occupied (true) or empty (false).

Boolean


accountLevyInvoice

Unique reference number for the levy invoice raised

String


accountBalance

The amount of levy that remains unpaid

Decimal number


Data formatting Notes

  • Headers must be included in camelCase and match the Header Names detailed in the first column of the table above. A preformatted template will be made available upon request.

  • Unless otherwise stated, number values should be formatted as Strings, in order to avoid conversion problems (missing leading zeros etc).

  • Data updates must be provided in the same format at the original import data. Otherwise we will be unable to automatically update your records.

Customer Data

Where a customer has existing data and wishes that to be matched to the Billing Authority Data described above, it must contain either the `billingAuthorityRef` and (ideally) / or the `accountRef` / `customerRef`.

If a customer is unable to provide their data in this format, and more than four hours of data cleansing and mapping work is required, additional work will be billed at a rate of £70 per hour.