POST request/customer

Add New Customer Company

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
BillingAddress	AddressInfo	None.
ChannelId	integer	None.
CompanyName	string	None.
CompanyRegistrationNumber	string	None.
CompanyType	byte	None.
CorrespondenceAddress	AddressInfo	None.
CreditSafeReferenceId	string	None.
CustomerTypeId	byte	None.
Email	string	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.
RegisteredAddress	AddressInfo	None.
SICCode	integer	None.
VATNumber	string	None.
VatRate	decimal number	None.

Request Formats

application/json, text/json

Sample:

{
  "companyName": "sample string 1",
  "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 2",
  "landline": "sample string 3",
  "mobile": "sample string 4",
  "email": "sample string 5",
  "vatNumber": "sample string 6",
  "parentCustomerId": 1,
  "microBusiness": true,
  "noOfPupils": 1,
  "industryType": "sample string 7",
  "vatRate": 1.0,
  "paperBilling": true,
  "channelId": 1,
  "industrySector": 1,
  "creditSafeReferenceId": "sample string 8",
  "customerTypeId": 64
}

text/html

Sample:

{"companyName":"sample string 1","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 2","landline":"sample string 3","mobile":"sample string 4","email":"sample string 5","vatNumber":"sample string 6","parentCustomerId":1,"microBusiness":true,"noOfPupils":1,"industryType":"sample string 7","vatRate":1.0,"paperBilling":true,"channelId":1,"industrySector":1,"creditSafeReferenceId":"sample string 8","customerTypeId":64}

application/xml, text/xml

Sample:

<CustomerPost 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 1</CompanyName>
  <CompanyRegistrationNumber>sample string 2</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 8</CreditSafeReferenceId>
  <CustomerTypeId>64</CustomerTypeId>
  <Email>sample string 5</Email>
  <IndustrySector>1</IndustrySector>
  <IndustryType>sample string 7</IndustryType>
  <Landline>sample string 3</Landline>
  <MicroBusiness>true</MicroBusiness>
  <Mobile>sample string 4</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 6</VATNumber>
  <VatRate>1</VatRate>
</CustomerPost>

Response Information

Resource Description

integer

Response Formats

application/json, text/json, text/html

Sample:

application/xml, text/xml

Sample:

<long xmlns="http://schemas.microsoft.com/2003/10/Serialization/">1</long>