GET api/Customer/CustomerInformation

Provides Customer Master Data

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

Collection of CustomerViewModel
NameDescriptionTypeAdditional information
CustomerId

This is a four digit unique Customer Id

integer

None.

CustomerNumber

This is a four digit unique Customer Number

integer

None.

CustomerName

This is Customer Name

string

None.

SiteId

This is a Site Id

integer

None.

SiteUseCode

string

None.

CustomerStatus

Customer Status i.e. Active or Inactive

string

None.

Address1

Customer's First Address

string

None.

Address2

Customer's Alternative Address

string

None.

Address3

Customer's second Alternative Address and can be null

string

None.

Address4

Customer's third Alternative Address and can be null

string

None.

MobileNo

Customer's Mobile Number

string

None.

PostalCode

Customer's Postal Code

string

None.

GstNo

Customer's GST No and each customer will have unique number

string

None.

PanNo

Customer's Pan No and each customer will have unique number

string

None.

ContactPerson

Customer's Contact Person Name

string

None.

EmailAddress

Customer's email Address

string

None.

Is_Active

Return Y if customer is active otherwise N

character

None.

CustomerState

Customer State

string

None.

CustomerZone

Customer Zone

string

None.

SalesChannelCode

Sales Channel

string

None.

CustomerTerritory

Customer Territory

string

None.

CustomerCity

Customer City

string

None.

PARTY_CTRL_DT

date

None.

HCA_CTRL_DT

date

None.

HCS_CTRL_DT

date

None.

HPS_CTRL_DT

date

None.

HCSU_CTRL_DT

date

None.

JRDV_CTRL_DT

date

None.

RAT_CTRL_DT

date

None.

Related_Cust_Id

integer

None.

Sales_Rep_Name

string

None.

OPERATING_UNIT

string

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "CustomerId": 1,
    "CustomerNumber": 2,
    "CustomerName": "sample string 3",
    "SiteId": 4,
    "SiteUseCode": "sample string 5",
    "CustomerStatus": "sample string 6",
    "Address1": "sample string 7",
    "Address2": "sample string 8",
    "Address3": "sample string 9",
    "Address4": "sample string 10",
    "MobileNo": "sample string 11",
    "PostalCode": "sample string 12",
    "GstNo": "sample string 13",
    "PanNo": "sample string 14",
    "ContactPerson": "sample string 15",
    "EmailAddress": "sample string 16",
    "Is_Active": "A",
    "CustomerState": "sample string 18",
    "CustomerZone": "sample string 19",
    "SalesChannelCode": "sample string 20",
    "CustomerTerritory": "sample string 21",
    "CustomerCity": "sample string 22",
    "PARTY_CTRL_DT": "2025-01-09T09:03:32.3638835+05:30",
    "HCA_CTRL_DT": "2025-01-09T09:03:32.3638835+05:30",
    "HCS_CTRL_DT": "2025-01-09T09:03:32.3638835+05:30",
    "HPS_CTRL_DT": "2025-01-09T09:03:32.3638835+05:30",
    "HCSU_CTRL_DT": "2025-01-09T09:03:32.3638835+05:30",
    "JRDV_CTRL_DT": "2025-01-09T09:03:32.3638835+05:30",
    "RAT_CTRL_DT": "2025-01-09T09:03:32.3638835+05:30",
    "Related_Cust_Id": 30,
    "Sales_Rep_Name": "sample string 31",
    "OPERATING_UNIT": "sample string 32"
  },
  {
    "CustomerId": 1,
    "CustomerNumber": 2,
    "CustomerName": "sample string 3",
    "SiteId": 4,
    "SiteUseCode": "sample string 5",
    "CustomerStatus": "sample string 6",
    "Address1": "sample string 7",
    "Address2": "sample string 8",
    "Address3": "sample string 9",
    "Address4": "sample string 10",
    "MobileNo": "sample string 11",
    "PostalCode": "sample string 12",
    "GstNo": "sample string 13",
    "PanNo": "sample string 14",
    "ContactPerson": "sample string 15",
    "EmailAddress": "sample string 16",
    "Is_Active": "A",
    "CustomerState": "sample string 18",
    "CustomerZone": "sample string 19",
    "SalesChannelCode": "sample string 20",
    "CustomerTerritory": "sample string 21",
    "CustomerCity": "sample string 22",
    "PARTY_CTRL_DT": "2025-01-09T09:03:32.3638835+05:30",
    "HCA_CTRL_DT": "2025-01-09T09:03:32.3638835+05:30",
    "HCS_CTRL_DT": "2025-01-09T09:03:32.3638835+05:30",
    "HPS_CTRL_DT": "2025-01-09T09:03:32.3638835+05:30",
    "HCSU_CTRL_DT": "2025-01-09T09:03:32.3638835+05:30",
    "JRDV_CTRL_DT": "2025-01-09T09:03:32.3638835+05:30",
    "RAT_CTRL_DT": "2025-01-09T09:03:32.3638835+05:30",
    "Related_Cust_Id": 30,
    "Sales_Rep_Name": "sample string 31",
    "OPERATING_UNIT": "sample string 32"
  }
]

text/html

Sample:
[{"CustomerId":1,"CustomerNumber":2,"CustomerName":"sample string 3","SiteId":4,"SiteUseCode":"sample string 5","CustomerStatus":"sample string 6","Address1":"sample string 7","Address2":"sample string 8","Address3":"sample string 9","Address4":"sample string 10","MobileNo":"sample string 11","PostalCode":"sample string 12","GstNo":"sample string 13","PanNo":"sample string 14","ContactPerson":"sample string 15","EmailAddress":"sample string 16","Is_Active":"A","CustomerState":"sample string 18","CustomerZone":"sample string 19","SalesChannelCode":"sample string 20","CustomerTerritory":"sample string 21","CustomerCity":"sample string 22","PARTY_CTRL_DT":"2025-01-09T09:03:32.3638835+05:30","HCA_CTRL_DT":"2025-01-09T09:03:32.3638835+05:30","HCS_CTRL_DT":"2025-01-09T09:03:32.3638835+05:30","HPS_CTRL_DT":"2025-01-09T09:03:32.3638835+05:30","HCSU_CTRL_DT":"2025-01-09T09:03:32.3638835+05:30","JRDV_CTRL_DT":"2025-01-09T09:03:32.3638835+05:30","RAT_CTRL_DT":"2025-01-09T09:03:32.3638835+05:30","Related_Cust_Id":30,"Sales_Rep_Name":"sample string 31","OPERATING_UNIT":"sample string 32"},{"CustomerId":1,"CustomerNumber":2,"CustomerName":"sample string 3","SiteId":4,"SiteUseCode":"sample string 5","CustomerStatus":"sample string 6","Address1":"sample string 7","Address2":"sample string 8","Address3":"sample string 9","Address4":"sample string 10","MobileNo":"sample string 11","PostalCode":"sample string 12","GstNo":"sample string 13","PanNo":"sample string 14","ContactPerson":"sample string 15","EmailAddress":"sample string 16","Is_Active":"A","CustomerState":"sample string 18","CustomerZone":"sample string 19","SalesChannelCode":"sample string 20","CustomerTerritory":"sample string 21","CustomerCity":"sample string 22","PARTY_CTRL_DT":"2025-01-09T09:03:32.3638835+05:30","HCA_CTRL_DT":"2025-01-09T09:03:32.3638835+05:30","HCS_CTRL_DT":"2025-01-09T09:03:32.3638835+05:30","HPS_CTRL_DT":"2025-01-09T09:03:32.3638835+05:30","HCSU_CTRL_DT":"2025-01-09T09:03:32.3638835+05:30","JRDV_CTRL_DT":"2025-01-09T09:03:32.3638835+05:30","RAT_CTRL_DT":"2025-01-09T09:03:32.3638835+05:30","Related_Cust_Id":30,"Sales_Rep_Name":"sample string 31","OPERATING_UNIT":"sample string 32"}]

application/xml, text/xml

Sample:
<ArrayOfCustomerViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OMSService.Models">
  <CustomerViewModel>
    <Address1>sample string 7</Address1>
    <Address2>sample string 8</Address2>
    <Address3>sample string 9</Address3>
    <Address4>sample string 10</Address4>
    <ContactPerson>sample string 15</ContactPerson>
    <CustomerCity>sample string 22</CustomerCity>
    <CustomerId>1</CustomerId>
    <CustomerName>sample string 3</CustomerName>
    <CustomerNumber>2</CustomerNumber>
    <CustomerState>sample string 18</CustomerState>
    <CustomerStatus>sample string 6</CustomerStatus>
    <CustomerTerritory>sample string 21</CustomerTerritory>
    <CustomerZone>sample string 19</CustomerZone>
    <EmailAddress>sample string 16</EmailAddress>
    <GstNo>sample string 13</GstNo>
    <HCA_CTRL_DT>2025-01-09T09:03:32.3638835+05:30</HCA_CTRL_DT>
    <HCSU_CTRL_DT>2025-01-09T09:03:32.3638835+05:30</HCSU_CTRL_DT>
    <HCS_CTRL_DT>2025-01-09T09:03:32.3638835+05:30</HCS_CTRL_DT>
    <HPS_CTRL_DT>2025-01-09T09:03:32.3638835+05:30</HPS_CTRL_DT>
    <Is_Active>65</Is_Active>
    <JRDV_CTRL_DT>2025-01-09T09:03:32.3638835+05:30</JRDV_CTRL_DT>
    <MobileNo>sample string 11</MobileNo>
    <OPERATING_UNIT>sample string 32</OPERATING_UNIT>
    <PARTY_CTRL_DT>2025-01-09T09:03:32.3638835+05:30</PARTY_CTRL_DT>
    <PanNo>sample string 14</PanNo>
    <PostalCode>sample string 12</PostalCode>
    <RAT_CTRL_DT>2025-01-09T09:03:32.3638835+05:30</RAT_CTRL_DT>
    <Related_Cust_Id>30</Related_Cust_Id>
    <SalesChannelCode>sample string 20</SalesChannelCode>
    <Sales_Rep_Name>sample string 31</Sales_Rep_Name>
    <SiteId>4</SiteId>
    <SiteUseCode>sample string 5</SiteUseCode>
  </CustomerViewModel>
  <CustomerViewModel>
    <Address1>sample string 7</Address1>
    <Address2>sample string 8</Address2>
    <Address3>sample string 9</Address3>
    <Address4>sample string 10</Address4>
    <ContactPerson>sample string 15</ContactPerson>
    <CustomerCity>sample string 22</CustomerCity>
    <CustomerId>1</CustomerId>
    <CustomerName>sample string 3</CustomerName>
    <CustomerNumber>2</CustomerNumber>
    <CustomerState>sample string 18</CustomerState>
    <CustomerStatus>sample string 6</CustomerStatus>
    <CustomerTerritory>sample string 21</CustomerTerritory>
    <CustomerZone>sample string 19</CustomerZone>
    <EmailAddress>sample string 16</EmailAddress>
    <GstNo>sample string 13</GstNo>
    <HCA_CTRL_DT>2025-01-09T09:03:32.3638835+05:30</HCA_CTRL_DT>
    <HCSU_CTRL_DT>2025-01-09T09:03:32.3638835+05:30</HCSU_CTRL_DT>
    <HCS_CTRL_DT>2025-01-09T09:03:32.3638835+05:30</HCS_CTRL_DT>
    <HPS_CTRL_DT>2025-01-09T09:03:32.3638835+05:30</HPS_CTRL_DT>
    <Is_Active>65</Is_Active>
    <JRDV_CTRL_DT>2025-01-09T09:03:32.3638835+05:30</JRDV_CTRL_DT>
    <MobileNo>sample string 11</MobileNo>
    <OPERATING_UNIT>sample string 32</OPERATING_UNIT>
    <PARTY_CTRL_DT>2025-01-09T09:03:32.3638835+05:30</PARTY_CTRL_DT>
    <PanNo>sample string 14</PanNo>
    <PostalCode>sample string 12</PostalCode>
    <RAT_CTRL_DT>2025-01-09T09:03:32.3638835+05:30</RAT_CTRL_DT>
    <Related_Cust_Id>30</Related_Cust_Id>
    <SalesChannelCode>sample string 20</SalesChannelCode>
    <Sales_Rep_Name>sample string 31</Sales_Rep_Name>
    <SiteId>4</SiteId>
    <SiteUseCode>sample string 5</SiteUseCode>
  </CustomerViewModel>
</ArrayOfCustomerViewModel>