GET request/customer/{customerId}

Displays specific customer's company information

Request Information

URI Parameters

Name	Description	Type	Additional information
customerId		integer	Required

Body Parameters

None.

Response Information

Resource Description

CustomerView

Name	Type	Additional information
BillingAddress	AddressInfo	None.
ChannelId	integer	None.
CompanyName	string	None.
CompanyRegistrationNumber	string	None.
CompanyType	byte	None.
CompanyTypeName	string	None.
CorrespondenceAddress	AddressInfo	None.
CreatedBy	integer	None.
CreditSafeReferenceId	string	None.
CustomerId	integer	None.
CustomerTypeId	byte	None.
CustomerTypeName	string	None.
DirectDebitInfo	DirectDebitInfoDto	None.
ElectricityCommission	decimal number	None.
Email	string	None.
GasCommission	decimal number	None.
IndustrySector	integer	None.
IndustryType	string	None.
Landline	string	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	integer	None.
SICDescription	string	None.
UserId	integer	None.
UserName	string	None.
VATNumber	string	None.
VatRate	decimal number	None.

Response Formats

application/json, text/json

Sample:

{
  "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
}

text/html

Sample:

{"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}

application/xml, text/xml

Sample:

<CustomerView xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MyUtilityGeniusForBusiness.Api.Models.CustomerDto">
  <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>
  <ChannelId>1</ChannelId>
  <CompanyName>sample string 5</CompanyName>
  <CompanyRegistrationNumber>sample string 6</CompanyRegistrationNumber>
  <CompanyType>64</CompanyType>
  <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>
  <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: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>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>
</CustomerView>