GET request/customer/search?search_text={search_text}&search_type={search_type}&userId={userId}

Get Customer's Company information

Request Information

URI Parameters

Name	Description	Type	Additional information
search_text		string	None.
search_type	1- Company Name 2- Contact name 3 - Payment 4 - Mpan/Mprn	byte	None.
userId		integer	None.

Body Parameters

None.

Response Information

Resource Description

Collection of CustomersInfoView

Name	Description	Type	Additional information
Details		CustomerView	None.
Summary		CustomerSummaryDto	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "details": {
      "customerId": 1,
      "sicDescription": "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",
      "createdBy": 1,
      "companyName": "sample string 5",
      "sicCode": 1,
      "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 6",
      "landline": "sample string 7",
      "mobile": "sample string 8",
      "email": "sample string 9",
      "vatNumber": "sample string 10",
      "parentCustomerId": 1,
      "microBusiness": true,
      "noOfPupils": 1,
      "industryType": "sample string 11",
      "vatRate": 1.0,
      "paperBilling": true,
      "channelId": 1,
      "industrySector": 1,
      "creditSafeReferenceId": "sample string 12",
      "customerTypeId": 64
    },
    "summary": {
      "totalLiveElecSite": "sample string 1",
      "totalLiveGasSite": "sample string 2",
      "totalAnnualLiveElecQuantity": "sample string 3",
      "totalAnnualLiveGasQuantity": "sample string 4",
      "totalAnnualLiveElecValue": "sample string 5",
      "totalAnnualLiveGasValue": "sample string 6",
      "totalAnnualLiveElecCommission": "sample string 7",
      "totalAnnualLiveGasCommission": "sample string 8",
      "gasCommission": "sample string 9",
      "electricityCommission": "sample string 10"
    }
  },
  {
    "details": {
      "customerId": 1,
      "sicDescription": "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",
      "createdBy": 1,
      "companyName": "sample string 5",
      "sicCode": 1,
      "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 6",
      "landline": "sample string 7",
      "mobile": "sample string 8",
      "email": "sample string 9",
      "vatNumber": "sample string 10",
      "parentCustomerId": 1,
      "microBusiness": true,
      "noOfPupils": 1,
      "industryType": "sample string 11",
      "vatRate": 1.0,
      "paperBilling": true,
      "channelId": 1,
      "industrySector": 1,
      "creditSafeReferenceId": "sample string 12",
      "customerTypeId": 64
    },
    "summary": {
      "totalLiveElecSite": "sample string 1",
      "totalLiveGasSite": "sample string 2",
      "totalAnnualLiveElecQuantity": "sample string 3",
      "totalAnnualLiveGasQuantity": "sample string 4",
      "totalAnnualLiveElecValue": "sample string 5",
      "totalAnnualLiveGasValue": "sample string 6",
      "totalAnnualLiveElecCommission": "sample string 7",
      "totalAnnualLiveGasCommission": "sample string 8",
      "gasCommission": "sample string 9",
      "electricityCommission": "sample string 10"
    }
  }
]

text/html

Sample:

[{"details":{"customerId":1,"sicDescription":"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","createdBy":1,"companyName":"sample string 5","sicCode":1,"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 6","landline":"sample string 7","mobile":"sample string 8","email":"sample string 9","vatNumber":"sample string 10","parentCustomerId":1,"microBusiness":true,"noOfPupils":1,"industryType":"sample string 11","vatRate":1.0,"paperBilling":true,"channelId":1,"industrySector":1,"creditSafeReferenceId":"sample string 12","customerTypeId":64},"summary":{"totalLiveElecSite":"sample string 1","totalLiveGasSite":"sample string 2","totalAnnualLiveElecQuantity":"sample string 3","totalAnnualLiveGasQuantity":"sample string 4","totalAnnualLiveElecValue":"sample string 5","totalAnnualLiveGasValue":"sample string 6","totalAnnualLiveElecCommission":"sample string 7","totalAnnualLiveGasCommission":"sample string 8","gasCommission":"sample string 9","electricityCommission":"sample string 10"}},{"details":{"customerId":1,"sicDescription":"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","createdBy":1,"companyName":"sample string 5","sicCode":1,"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 6","landline":"sample string 7","mobile":"sample string 8","email":"sample string 9","vatNumber":"sample string 10","parentCustomerId":1,"microBusiness":true,"noOfPupils":1,"industryType":"sample string 11","vatRate":1.0,"paperBilling":true,"channelId":1,"industrySector":1,"creditSafeReferenceId":"sample string 12","customerTypeId":64},"summary":{"totalLiveElecSite":"sample string 1","totalLiveGasSite":"sample string 2","totalAnnualLiveElecQuantity":"sample string 3","totalAnnualLiveGasQuantity":"sample string 4","totalAnnualLiveElecValue":"sample string 5","totalAnnualLiveGasValue":"sample string 6","totalAnnualLiveElecCommission":"sample string 7","totalAnnualLiveGasCommission":"sample string 8","gasCommission":"sample string 9","electricityCommission":"sample string 10"}}]

application/xml, text/xml

Sample:

<ArrayOfCustomersInfoView xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MyUtilityGeniusForBusiness.Api.Models.CustomerDto">
  <CustomersInfoView>
    <Details>
      <BillingAddress xmlns:d4p1="http://schemas.datacontract.org/2004/07/MyUtilityGeniusForBusiness.Api.Models.Default">
        <d4p1:City>sample string 3</d4p1:City>
        <d4p1:County>sample string 4</d4p1:County>
        <d4p1:Line1>sample string 1</d4p1:Line1>
        <d4p1:Line2>sample string 2</d4p1:Line2>
        <d4p1:Postcode>sample string 5</d4p1:Postcode>
      </BillingAddress>
      <ChannelId>1</ChannelId>
      <CompanyName>sample string 5</CompanyName>
      <CompanyRegistrationNumber>sample string 6</CompanyRegistrationNumber>
      <CompanyType>64</CompanyType>
      <CorrespondenceAddress xmlns:d4p1="http://schemas.datacontract.org/2004/07/MyUtilityGeniusForBusiness.Api.Models.Default">
        <d4p1:City>sample string 3</d4p1:City>
        <d4p1:County>sample string 4</d4p1:County>
        <d4p1:Line1>sample string 1</d4p1:Line1>
        <d4p1:Line2>sample string 2</d4p1:Line2>
        <d4p1:Postcode>sample string 5</d4p1:Postcode>
      </CorrespondenceAddress>
      <CreditSafeReferenceId>sample string 12</CreditSafeReferenceId>
      <CustomerTypeId>64</CustomerTypeId>
      <Email>sample string 9</Email>
      <IndustrySector>1</IndustrySector>
      <IndustryType>sample string 11</IndustryType>
      <Landline>sample string 7</Landline>
      <MicroBusiness>true</MicroBusiness>
      <Mobile>sample string 8</Mobile>
      <NoOfPupils>1</NoOfPupils>
      <PaperBilling>true</PaperBilling>
      <ParentCustomerId>1</ParentCustomerId>
      <RegisteredAddress xmlns:d4p1="http://schemas.datacontract.org/2004/07/MyUtilityGeniusForBusiness.Api.Models.Default">
        <d4p1:City>sample string 3</d4p1:City>
        <d4p1:County>sample string 4</d4p1:County>
        <d4p1:Line1>sample string 1</d4p1:Line1>
        <d4p1:Line2>sample string 2</d4p1:Line2>
        <d4p1:Postcode>sample string 5</d4p1:Postcode>
      </RegisteredAddress>
      <SICCode>1</SICCode>
      <VATNumber>sample string 10</VATNumber>
      <VatRate>1</VatRate>
      <CompanyTypeName>sample string 3</CompanyTypeName>
      <CreatedBy>1</CreatedBy>
      <CustomerId>1</CustomerId>
      <CustomerTypeName>sample string 4</CustomerTypeName>
      <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>
      <SICDescription>sample string 1</SICDescription>
      <UserId>1</UserId>
      <UserName>sample string 2</UserName>
    </Details>
    <Summary>
      <ElectricityCommission>sample string 10</ElectricityCommission>
      <GasCommission>sample string 9</GasCommission>
      <TotalAnnualLiveElecCommission>sample string 7</TotalAnnualLiveElecCommission>
      <TotalAnnualLiveElecQuantity>sample string 3</TotalAnnualLiveElecQuantity>
      <TotalAnnualLiveElecValue>sample string 5</TotalAnnualLiveElecValue>
      <TotalAnnualLiveGasCommission>sample string 8</TotalAnnualLiveGasCommission>
      <TotalAnnualLiveGasQuantity>sample string 4</TotalAnnualLiveGasQuantity>
      <TotalAnnualLiveGasValue>sample string 6</TotalAnnualLiveGasValue>
      <TotalLiveElecSite>sample string 1</TotalLiveElecSite>
      <TotalLiveGasSite>sample string 2</TotalLiveGasSite>
    </Summary>
  </CustomersInfoView>
  <CustomersInfoView>
    <Details>
      <BillingAddress xmlns:d4p1="http://schemas.datacontract.org/2004/07/MyUtilityGeniusForBusiness.Api.Models.Default">
        <d4p1:City>sample string 3</d4p1:City>
        <d4p1:County>sample string 4</d4p1:County>
        <d4p1:Line1>sample string 1</d4p1:Line1>
        <d4p1:Line2>sample string 2</d4p1:Line2>
        <d4p1:Postcode>sample string 5</d4p1:Postcode>
      </BillingAddress>
      <ChannelId>1</ChannelId>
      <CompanyName>sample string 5</CompanyName>
      <CompanyRegistrationNumber>sample string 6</CompanyRegistrationNumber>
      <CompanyType>64</CompanyType>
      <CorrespondenceAddress xmlns:d4p1="http://schemas.datacontract.org/2004/07/MyUtilityGeniusForBusiness.Api.Models.Default">
        <d4p1:City>sample string 3</d4p1:City>
        <d4p1:County>sample string 4</d4p1:County>
        <d4p1:Line1>sample string 1</d4p1:Line1>
        <d4p1:Line2>sample string 2</d4p1:Line2>
        <d4p1:Postcode>sample string 5</d4p1:Postcode>
      </CorrespondenceAddress>
      <CreditSafeReferenceId>sample string 12</CreditSafeReferenceId>
      <CustomerTypeId>64</CustomerTypeId>
      <Email>sample string 9</Email>
      <IndustrySector>1</IndustrySector>
      <IndustryType>sample string 11</IndustryType>
      <Landline>sample string 7</Landline>
      <MicroBusiness>true</MicroBusiness>
      <Mobile>sample string 8</Mobile>
      <NoOfPupils>1</NoOfPupils>
      <PaperBilling>true</PaperBilling>
      <ParentCustomerId>1</ParentCustomerId>
      <RegisteredAddress xmlns:d4p1="http://schemas.datacontract.org/2004/07/MyUtilityGeniusForBusiness.Api.Models.Default">
        <d4p1:City>sample string 3</d4p1:City>
        <d4p1:County>sample string 4</d4p1:County>
        <d4p1:Line1>sample string 1</d4p1:Line1>
        <d4p1:Line2>sample string 2</d4p1:Line2>
        <d4p1:Postcode>sample string 5</d4p1:Postcode>
      </RegisteredAddress>
      <SICCode>1</SICCode>
      <VATNumber>sample string 10</VATNumber>
      <VatRate>1</VatRate>
      <CompanyTypeName>sample string 3</CompanyTypeName>
      <CreatedBy>1</CreatedBy>
      <CustomerId>1</CustomerId>
      <CustomerTypeName>sample string 4</CustomerTypeName>
      <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>
      <SICDescription>sample string 1</SICDescription>
      <UserId>1</UserId>
      <UserName>sample string 2</UserName>
    </Details>
    <Summary>
      <ElectricityCommission>sample string 10</ElectricityCommission>
      <GasCommission>sample string 9</GasCommission>
      <TotalAnnualLiveElecCommission>sample string 7</TotalAnnualLiveElecCommission>
      <TotalAnnualLiveElecQuantity>sample string 3</TotalAnnualLiveElecQuantity>
      <TotalAnnualLiveElecValue>sample string 5</TotalAnnualLiveElecValue>
      <TotalAnnualLiveGasCommission>sample string 8</TotalAnnualLiveGasCommission>
      <TotalAnnualLiveGasQuantity>sample string 4</TotalAnnualLiveGasQuantity>
      <TotalAnnualLiveGasValue>sample string 6</TotalAnnualLiveGasValue>
      <TotalLiveElecSite>sample string 1</TotalLiveElecSite>
      <TotalLiveGasSite>sample string 2</TotalLiveGasSite>
    </Summary>
  </CustomersInfoView>
</ArrayOfCustomersInfoView>