Skip to main content

Input fields

account : String

Internal account id (not account number).

accountNumber : String

The account number eg. A-FF15AE70.

accountReferences : String

Account Reference.

bill : String

Bills (Shortcut).

billingName : String

Account or Billing name.

businessName : String

Business name.

businessNumber : String

Business identifier or number.

device : String

Device ID.

location : String

Location (Supply or Billing, full or partial, address or post code).

meterSerialNumber : String

Meter Serial Number.

mpan : String

MPAN of property.

mprn : String

MPRN of property.

portfolioNumber : String

The portfolio number eg. P-A123B456.

statements : String

Statements (Alias for bills).

telephoneNumber : String

Telephone.

urn : String

URN Number.

user : String

The Account User ID (not account number).

The example data in the variables and responses below are autogenerated values designed to resemble real inputs. They do not represent actual customer data, and in some cases may require additional validation.

Example

{ "account": "address-sense-economic-body-person", "accountNumber": "A-799EBA30", "accountReferences": "general-attorney-city-month-collection", "bill": "evening-represent-lawyer-focus-listen", "billingName": "age-hit-inside-could-board", "businessName": "tonight-member-decide-paper-stage", "businessNumber": "again-adult-chair-responsibility-civil", "device": "relate-question-name-determine-wish", "location": "something-might-development-possible-house", "meterSerialNumber": "office-fly-piece-arrive-fear", "mpan": "whose-then-fill-teach-financial", "mprn": "vote-season-indicate-education-across", "portfolioNumber": "P-4638AFCD", "statements": "these-also-standard-while-now", "telephoneNumber": "commercial-test-wind-region-meeting", "urn": "her-get-day-purpose-item", "user": "create-bit-program-fast-matter" }