POST request/water/customer/exist

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
BusinessReferenceNumber		string	None.
CompanyName		string	None.

Request Formats

application/json, text/json

Sample:

{
  "companyName": "sample string 1",
  "businessReferenceNumber": "sample string 2"
}

text/html

Sample:

{"companyName":"sample string 1","businessReferenceNumber":"sample string 2"}

application/xml, text/xml

Sample:

<CompanyExistPost xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MyUtilityGeniusForBusiness.Api.Models.WaterCustomer">
  <BusinessReferenceNumber>sample string 2</BusinessReferenceNumber>
  <CompanyName>sample string 1</CompanyName>
</CompanyExistPost>

Response Information

Resource Description

WaterCustomerView

Name	Type	Additional information
BillingAddress	AddressInfo	None.
BusinessCategory	byte	None.
ChannelId	integer	None.
CompanyName	string	None.
CompanyRegistrationNumber	string	None.
CompanyType	byte	None.
CompanyTypeId	byte	None.
CompanyTypeName	string	None.
CorrespondenceAddress	AddressInfo	None.
CreditCheckExist	boolean	None.
CreditSafeReferenceId	string	None.
CreditScoreTimestamp	date	None.
CustomerId	integer	None.
CustomerTypeId	byte	None.
CustomerTypeName	string	None.
DBT	integer	None.
Delphi	byte	None.
DirectDebitInfo	WaterDirectDebitInfoDto	None.
ElectricityCommission	decimal number	None.
Email	string	None.
GasCommission	decimal number	None.
IndustrySector	integer	None.
IndustryType	string	None.
Landline	string	None.
Meter_Count	integer	None.
MicroBusiness	boolean	None.
Mobile	string	None.
NoOfPupils	integer	None.
PaperBilling	boolean	None.
ParentCustomerId	integer	None.
PaymentMethod	byte	None.
PaymentTerm	byte	None.
RegisteredAddress	AddressInfo	None.
SICCode	string	None.
SICCodeDescription	string	None.
Site_Count	integer	None.
UserId	integer	None.
UserName	string	None.
VATNumber	string	None.
VatRate	decimal number	None.

Response Formats

application/json, text/json

Sample:

{
  "customerId": 1,
  "sicCodeDescription": "sample string 1",
  "paymentMethod": 64,
  "paymentTerm": 64,
  "directDebitInfo": {
    "sortCode": "sample string 1",
    "accountNumber": "sample string 2",
    "accountName": "sample string 3"
  },
  "gasCommission": 1.0,
  "electricityCommission": 1.0,
  "userId": 1,
  "userName": "sample string 2",
  "companyTypeName": "sample string 3",
  "customerTypeName": "sample string 4",
  "sicCode": "sample string 5",
  "creditScoreTimestamp": "2025-06-26T15:58:05.9115012+00:00",
  "delphi": 64,
  "dbt": 1,
  "businessCategory": 64,
  "companyTypeId": 64,
  "creditCheckExist": true,
  "companyName": "sample string 6",
  "correspondenceAddress": {
    "line1": "sample string 1",
    "line2": "sample string 2",
    "city": "sample string 3",
    "county": "sample string 4",
    "postcode": "sample string 5"
  },
  "registeredAddress": {
    "line1": "sample string 1",
    "line2": "sample string 2",
    "city": "sample string 3",
    "county": "sample string 4",
    "postcode": "sample string 5"
  },
  "billingAddress": {
    "line1": "sample string 1",
    "line2": "sample string 2",
    "city": "sample string 3",
    "county": "sample string 4",
    "postcode": "sample string 5"
  },
  "companyType": 64,
  "companyRegistrationNumber": "sample string 7",
  "landline": "sample string 8",
  "mobile": "sample string 9",
  "email": "sample string 10",
  "vatNumber": "sample string 11",
  "parentCustomerId": 1,
  "microBusiness": true,
  "noOfPupils": 1,
  "industryType": "sample string 12",
  "vatRate": 1.0,
  "paperBilling": true,
  "channelId": 1,
  "industrySector": 1,
  "creditSafeReferenceId": "sample string 13",
  "customerTypeId": 64,
  "site_Count": 1,
  "meter_Count": 1
}

text/html

Sample:

{"customerId":1,"sicCodeDescription":"sample string 1","paymentMethod":64,"paymentTerm":64,"directDebitInfo":{"sortCode":"sample string 1","accountNumber":"sample string 2","accountName":"sample string 3"},"gasCommission":1.0,"electricityCommission":1.0,"userId":1,"userName":"sample string 2","companyTypeName":"sample string 3","customerTypeName":"sample string 4","sicCode":"sample string 5","creditScoreTimestamp":"2025-06-26T15:58:05.9115012+00:00","delphi":64,"dbt":1,"businessCategory":64,"companyTypeId":64,"creditCheckExist":true,"companyName":"sample string 6","correspondenceAddress":{"line1":"sample string 1","line2":"sample string 2","city":"sample string 3","county":"sample string 4","postcode":"sample string 5"},"registeredAddress":{"line1":"sample string 1","line2":"sample string 2","city":"sample string 3","county":"sample string 4","postcode":"sample string 5"},"billingAddress":{"line1":"sample string 1","line2":"sample string 2","city":"sample string 3","county":"sample string 4","postcode":"sample string 5"},"companyType":64,"companyRegistrationNumber":"sample string 7","landline":"sample string 8","mobile":"sample string 9","email":"sample string 10","vatNumber":"sample string 11","parentCustomerId":1,"microBusiness":true,"noOfPupils":1,"industryType":"sample string 12","vatRate":1.0,"paperBilling":true,"channelId":1,"industrySector":1,"creditSafeReferenceId":"sample string 13","customerTypeId":64,"site_Count":1,"meter_Count":1}

application/xml, text/xml

Sample:

<WaterCustomerView xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MyUtilityGeniusForBusiness.Api.Models.WaterCustomer">
  <BillingAddress xmlns:d2p1="http://schemas.datacontract.org/2004/07/MyUtilityGeniusForBusiness.Api.Models.Default">
    <d2p1:City>sample string 3</d2p1:City>
    <d2p1:County>sample string 4</d2p1:County>
    <d2p1:Line1>sample string 1</d2p1:Line1>
    <d2p1:Line2>sample string 2</d2p1:Line2>
    <d2p1:Postcode>sample string 5</d2p1:Postcode>
  </BillingAddress>
  <BusinessCategory i:nil="true" />
  <ChannelId>1</ChannelId>
  <CompanyName>sample string 6</CompanyName>
  <CompanyRegistrationNumber>sample string 7</CompanyRegistrationNumber>
  <CompanyType>64</CompanyType>
  <CompanyTypeId i:nil="true" />
  <CorrespondenceAddress xmlns:d2p1="http://schemas.datacontract.org/2004/07/MyUtilityGeniusForBusiness.Api.Models.Default">
    <d2p1:City>sample string 3</d2p1:City>
    <d2p1:County>sample string 4</d2p1:County>
    <d2p1:Line1>sample string 1</d2p1:Line1>
    <d2p1:Line2>sample string 2</d2p1:Line2>
    <d2p1:Postcode>sample string 5</d2p1:Postcode>
  </CorrespondenceAddress>
  <CreditCheckExist i:nil="true" />
  <CreditSafeReferenceId>sample string 13</CreditSafeReferenceId>
  <CustomerTypeId>64</CustomerTypeId>
  <DBT i:nil="true" />
  <Delphi i:nil="true" />
  <Email>sample string 10</Email>
  <IndustrySector>1</IndustrySector>
  <IndustryType>sample string 12</IndustryType>
  <Landline>sample string 8</Landline>
  <Meter_Count>1</Meter_Count>
  <MicroBusiness>true</MicroBusiness>
  <Mobile>sample string 9</Mobile>
  <NoOfPupils>1</NoOfPupils>
  <PaperBilling>true</PaperBilling>
  <ParentCustomerId>1</ParentCustomerId>
  <RegisteredAddress xmlns:d2p1="http://schemas.datacontract.org/2004/07/MyUtilityGeniusForBusiness.Api.Models.Default">
    <d2p1:City>sample string 3</d2p1:City>
    <d2p1:County>sample string 4</d2p1:County>
    <d2p1:Line1>sample string 1</d2p1:Line1>
    <d2p1:Line2>sample string 2</d2p1:Line2>
    <d2p1:Postcode>sample string 5</d2p1:Postcode>
  </RegisteredAddress>
  <SICCode i:nil="true" />
  <SICCodeDescription i:nil="true" />
  <Site_Count>1</Site_Count>
  <VATNumber>sample string 11</VATNumber>
  <VatRate>1</VatRate>
  <BusinessCategory>64</BusinessCategory>
  <CompanyTypeId>64</CompanyTypeId>
  <CompanyTypeName>sample string 3</CompanyTypeName>
  <CreditCheckExist>true</CreditCheckExist>
  <CreditScoreTimestamp>2025-06-26T15:58:05.9115012+00:00</CreditScoreTimestamp>
  <CustomerId>1</CustomerId>
  <CustomerTypeName>sample string 4</CustomerTypeName>
  <DBT>1</DBT>
  <Delphi>64</Delphi>
  <DirectDebitInfo>
    <AccountName>sample string 3</AccountName>
    <AccountNumber>sample string 2</AccountNumber>
    <SortCode>sample string 1</SortCode>
  </DirectDebitInfo>
  <ElectricityCommission>1</ElectricityCommission>
  <GasCommission>1</GasCommission>
  <PaymentMethod>64</PaymentMethod>
  <PaymentTerm>64</PaymentTerm>
  <SICCode>sample string 5</SICCode>
  <SICCodeDescription>sample string 1</SICCodeDescription>
  <UserId>1</UserId>
  <UserName>sample string 2</UserName>
</WaterCustomerView>