GET api/Customer/ExternalId/{externalId}

Request Information

URI Parameters

Name	Description	Type	Additional information
externalId		string	Required

Body Parameters

None.

Response Information

Resource Description

Customer

Name	Type	Additional information
id	integer	None.
externalId	string	None.
customerNo	integer	None.
companyNo	string	None.
name	string	None.
address1	string	None.
address2	string	None.
address3	string	None.
address4	string	None.
postalNo	string	None.
postalArea	string	None.
emailAddress	string	None.
phone	string	None.
paymentTerms	integer	None.
paymentMethod	integer	None.
taxCode	integer	None.
documentDeliveryMethod1	integer	None.
documentDeliveryMethod2	integer	None.
mobilePhone	string	None.
countryNo	integer	None.
customerPriceGroup1	integer	None.
customerPriceGroup2	integer	None.
customerPriceGroup3	integer	None.
deliveryMethodForCustomer	integer	None.
languageNo	integer	None.
currencyNo	integer	None.
customerPreferences1	integer	None.
orgUnits	CustomerOrgUnits	None.
group1	integer	None.
group2	integer	None.
group3	integer	None.
group4	integer	None.
group5	integer	None.
group6	integer	None.
group7	integer	None.
group8	integer	None.
group9	integer	None.
group10	integer	None.
group11	integer	None.
group12	integer	None.
creditLimit	decimal number	None.
creditDenied	boolean	None.
euVatRegistrationNo	string	None.
information1	string	None.
information2	string	None.
information3	string	None.
information4	string	None.
information5	string	None.
information6	string	None.
information7	string	None.
information8	string	None.
associateProcessing	integer	None.
invoiceCustomerNo	integer	None.
autoInvoiceOperatorNo	integer	None.
autoInvoiceEmailAddress	string	None.
personId	string	None.
yourReference	string	None.
district	integer	None.
eanLocationCode	string	None.
tradeArea	byte	None.
createdDateTime	date	None.
createdByUser	string	None.
changedDateTime	date	None.
changedByUser	string	None.
warehouseNoForCustomer	integer	None.
factoringCompanyNo	integer	None.
factoringNo	string	None.
formId	integer	None.
directDebitingStatus	integer	None.
bankAccount	string	None.
bankNo	integer	None.
autoInvoiceEndpointId	string	None.
autoInvoiceEndpointScheme	string	None.
OrgUnitTypeNo	integer	None.
OrgUnitTypeValue	integer	None.
generalLedgerAccountNoForCustomer	integer	None.
shortName	string	None.
deliveryTermsForCustomer	integer	None.
contactfor	integer	None.
seller	integer	None.
visitPostCode	string	None.
visitPostalArea	string	None.
informationCategory	integer	None.
pager	string	None.
prescribers	Collection of string	None.

Response Formats

application/json, text/json

Sample:

{
  "id": 1,
  "externalId": "sample string 2",
  "customerNo": 1,
  "companyNo": "sample string 3",
  "name": "sample string 4",
  "address1": "sample string 5",
  "address2": "sample string 6",
  "address3": "sample string 7",
  "address4": "sample string 8",
  "postalNo": "sample string 9",
  "postalArea": "sample string 10",
  "emailAddress": "sample string 11",
  "phone": "sample string 12",
  "paymentTerms": 1,
  "paymentMethod": 1,
  "taxCode": 1,
  "documentDeliveryMethod1": 1,
  "documentDeliveryMethod2": 1,
  "mobilePhone": "sample string 13",
  "countryNo": 1,
  "customerPriceGroup1": 1,
  "customerPriceGroup2": 1,
  "customerPriceGroup3": 1,
  "deliveryMethodForCustomer": 1,
  "languageNo": 1,
  "currencyNo": 1,
  "customerPreferences1": 1,
  "orgUnits": {
    "OrgUnit1": 1,
    "OrgUnit2": 1,
    "OrgUnit3": 1,
    "OrgUnit4": 1,
    "OrgUnit5": 1,
    "OrgUnit6": 1,
    "orgUnit7": "sample string 1",
    "orgUnit8": "sample string 2",
    "orgUnit9": "sample string 3",
    "orgUnit10": "sample string 4",
    "orgUnit11": "sample string 5",
    "orgUnit12": "sample string 6"
  },
  "group1": 1,
  "group2": 1,
  "group3": 1,
  "group4": 1,
  "group5": 1,
  "group6": 1,
  "group7": 1,
  "group8": 1,
  "group9": 1,
  "group10": 1,
  "group11": 1,
  "group12": 1,
  "creditLimit": 1.0,
  "creditDenied": true,
  "euVatRegistrationNo": "sample string 14",
  "information1": "sample string 15",
  "information2": "sample string 16",
  "information3": "sample string 17",
  "information4": "sample string 18",
  "information5": "sample string 19",
  "information6": "sample string 20",
  "information7": "sample string 21",
  "information8": "sample string 22",
  "associateProcessing": 1,
  "invoiceCustomerNo": 1,
  "autoInvoiceOperatorNo": 1,
  "autoInvoiceEmailAddress": "sample string 23",
  "personId": "sample string 24",
  "yourReference": "sample string 25",
  "district": 1,
  "eanLocationCode": "sample string 26",
  "tradeArea": 64,
  "createdDateTime": "2025-11-29T00:31:20.4274715+01:00",
  "createdByUser": "sample string 28",
  "changedDateTime": "2025-11-29T00:31:20.4274715+01:00",
  "changedByUser": "sample string 30",
  "warehouseNoForCustomer": 1,
  "factoringCompanyNo": 1,
  "factoringNo": "sample string 31",
  "formId": 1,
  "directDebitingStatus": 1,
  "bankAccount": "sample string 32",
  "bankNo": 1,
  "autoInvoiceEndpointId": "sample string 33",
  "autoInvoiceEndpointScheme": "sample string 34",
  "OrgUnitTypeNo": 35,
  "OrgUnitTypeValue": 36,
  "generalLedgerAccountNoForCustomer": 1,
  "shortName": "sample string 37",
  "deliveryTermsForCustomer": 1,
  "contactfor": 1,
  "seller": 1,
  "visitPostCode": "sample string 38",
  "visitPostalArea": "sample string 39",
  "informationCategory": 1,
  "pager": "sample string 40",
  "prescribers": [
    "sample string 1",
    "sample string 2"
  ]
}

application/xml, text/xml

Sample:

<Customer xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <id>1</id>
  <externalId>sample string 2</externalId>
  <customerNo>1</customerNo>
  <companyNo>sample string 3</companyNo>
  <name>sample string 4</name>
  <address1>sample string 5</address1>
  <address2>sample string 6</address2>
  <address3>sample string 7</address3>
  <address4>sample string 8</address4>
  <postalNo>sample string 9</postalNo>
  <postalArea>sample string 10</postalArea>
  <emailAddress>sample string 11</emailAddress>
  <phone>sample string 12</phone>
  <paymentTerms>1</paymentTerms>
  <paymentMethod>1</paymentMethod>
  <taxCode>1</taxCode>
  <documentDeliveryMethod1>1</documentDeliveryMethod1>
  <documentDeliveryMethod2>1</documentDeliveryMethod2>
  <mobilePhone>sample string 13</mobilePhone>
  <countryNo>1</countryNo>
  <customerPriceGroup1>1</customerPriceGroup1>
  <customerPriceGroup2>1</customerPriceGroup2>
  <customerPriceGroup3>1</customerPriceGroup3>
  <deliveryMethodForCustomer>1</deliveryMethodForCustomer>
  <languageNo>1</languageNo>
  <currencyNo>1</currencyNo>
  <customerPreferences1>1</customerPreferences1>
  <orgUnits>
    <OrgUnit1>1</OrgUnit1>
    <OrgUnit2>1</OrgUnit2>
    <OrgUnit3>1</OrgUnit3>
    <OrgUnit4>1</OrgUnit4>
    <OrgUnit5>1</OrgUnit5>
    <OrgUnit6>1</OrgUnit6>
    <orgUnit7>sample string 1</orgUnit7>
    <orgUnit8>sample string 2</orgUnit8>
    <orgUnit9>sample string 3</orgUnit9>
    <orgUnit10>sample string 4</orgUnit10>
    <orgUnit11>sample string 5</orgUnit11>
    <orgUnit12>sample string 6</orgUnit12>
  </orgUnits>
  <group1>1</group1>
  <group2>1</group2>
  <group3>1</group3>
  <group4>1</group4>
  <group5>1</group5>
  <group6>1</group6>
  <group7>1</group7>
  <group8>1</group8>
  <group9>1</group9>
  <group10>1</group10>
  <group11>1</group11>
  <group12>1</group12>
  <creditLimit>1</creditLimit>
  <creditDenied>true</creditDenied>
  <euVatRegistrationNo>sample string 14</euVatRegistrationNo>
  <information1>sample string 15</information1>
  <information2>sample string 16</information2>
  <information3>sample string 17</information3>
  <information4>sample string 18</information4>
  <information5>sample string 19</information5>
  <information6>sample string 20</information6>
  <information7>sample string 21</information7>
  <information8>sample string 22</information8>
  <associateProcessing>1</associateProcessing>
  <invoiceCustomerNo>1</invoiceCustomerNo>
  <autoInvoiceOperatorNo>1</autoInvoiceOperatorNo>
  <autoInvoiceEmailAddress>sample string 23</autoInvoiceEmailAddress>
  <personId>sample string 24</personId>
  <yourReference>sample string 25</yourReference>
  <district>1</district>
  <eanLocationCode>sample string 26</eanLocationCode>
  <tradeArea>64</tradeArea>
  <createdDateTime>2025-11-29T00:31:20.4274715+01:00</createdDateTime>
  <createdByUser>sample string 28</createdByUser>
  <changedDateTime>2025-11-29T00:31:20.4274715+01:00</changedDateTime>
  <changedByUser>sample string 30</changedByUser>
  <warehouseNoForCustomer>1</warehouseNoForCustomer>
  <factoringCompanyNo>1</factoringCompanyNo>
  <factoringNo>sample string 31</factoringNo>
  <formId>1</formId>
  <directDebitingStatus>1</directDebitingStatus>
  <bankAccount>sample string 32</bankAccount>
  <bankNo>1</bankNo>
  <autoInvoiceEndpointId>sample string 33</autoInvoiceEndpointId>
  <autoInvoiceEndpointScheme>sample string 34</autoInvoiceEndpointScheme>
  <OrgUnitTypeNo>35</OrgUnitTypeNo>
  <OrgUnitTypeValue>36</OrgUnitTypeValue>
  <generalLedgerAccountNoForCustomer>1</generalLedgerAccountNoForCustomer>
  <shortName>sample string 37</shortName>
  <deliveryTermsForCustomer>1</deliveryTermsForCustomer>
  <contactfor>1</contactfor>
  <seller>1</seller>
  <visitPostCode>sample string 38</visitPostCode>
  <visitPostalArea>sample string 39</visitPostalArea>
  <informationCategory>1</informationCategory>
  <pager>sample string 40</pager>
  <prescribers>
    <string>sample string 1</string>
    <string>sample string 2</string>
  </prescribers>
</Customer>