GET api/crm/company/get/{customerCode}

Gets an organization by unique company code.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
customerCode

string

Required

Body Parameters

None.

Response Formats

application/json, text/json

Sample:
{
  "CustomerCode": "12345",
  "Name": "Venue Ltd.",
  "Email": "info@venue.com",
  "Info": "Specalist in venues.",
  "Vat": "BE123.456.789",
  "VatTransfer": 0,
  "Website": "http://www.venue.com",
  "Fax": "",
  "Phone": "555.123.456",
  "Status": "active",
  "Type": "prospect",
  "Contacts": [
    {
      "Reference": "C01248",
      "Gender": "female",
      "FirstName": "Lillie",
      "LastName": "Kleisle",
      "Title": "Ceo",
      "PrimaryMail": "Jessie@venues.com",
      "SecondaryMail": "",
      "Phone": "555.123.457",
      "Mobile": "",
      "LanguageCode": "EN",
      "Type": "invoice"
    },
    {
      "Reference": "C01248",
      "Gender": "female",
      "FirstName": "Jessie",
      "LastName": "Dorracott",
      "Title": "Ceo",
      "PrimaryMail": "Clara@venues.com",
      "SecondaryMail": "",
      "Phone": "555.123.457",
      "Mobile": "",
      "LanguageCode": "EN",
      "Type": "contact"
    }
  ],
  "Addresses": [
    {
      "AddressType": "office",
      "AddressLineOne": "Road to venue 12",
      "AddressLineTwo": "",
      "PostalCode": "1234",
      "City": "Sarma",
      "CountryCode": "GB",
      "State": ""
    },
    {
      "AddressType": "invoice",
      "AddressLineOne": "Road to venue 12",
      "AddressLineTwo": "",
      "PostalCode": "1234",
      "City": "Sarma",
      "CountryCode": "GB",
      "State": ""
    }
  ],
  "CustomFields": {
    "companycode": "12321"
  }
}

application/xml, text/xml

Sample:
<Company xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Expodoc.Api.Classes.Contracts.Crm">
  <Addresses>
    <CompanyAddress>
      <AddressLineOne>Road to venue 12</AddressLineOne>
      <AddressLineTwo></AddressLineTwo>
      <AddressType>office</AddressType>
      <City>Sarma</City>
      <CountryCode>GB</CountryCode>
      <PostalCode>1234</PostalCode>
      <State></State>
    </CompanyAddress>
    <CompanyAddress>
      <AddressLineOne>Road to venue 12</AddressLineOne>
      <AddressLineTwo></AddressLineTwo>
      <AddressType>invoice</AddressType>
      <City>Sarma</City>
      <CountryCode>GB</CountryCode>
      <PostalCode>1234</PostalCode>
      <State></State>
    </CompanyAddress>
  </Addresses>
  <Contacts>
    <Contact>
      <FirstName>Lillie</FirstName>
      <Gender>female</Gender>
      <LanguageCode>EN</LanguageCode>
      <LastName>Kleisle</LastName>
      <Mobile></Mobile>
      <Phone>555.123.457</Phone>
      <PrimaryMail>Jessie@venues.com</PrimaryMail>
      <Reference>C01248</Reference>
      <SecondaryMail></SecondaryMail>
      <Title>Ceo</Title>
      <Type>invoice</Type>
    </Contact>
    <Contact>
      <FirstName>Jessie</FirstName>
      <Gender>female</Gender>
      <LanguageCode>EN</LanguageCode>
      <LastName>Dorracott</LastName>
      <Mobile></Mobile>
      <Phone>555.123.457</Phone>
      <PrimaryMail>Clara@venues.com</PrimaryMail>
      <Reference>C01248</Reference>
      <SecondaryMail></SecondaryMail>
      <Title>Ceo</Title>
      <Type>contact</Type>
    </Contact>
  </Contacts>
  <CustomFields xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringanyType>
      <d2p1:Key>companycode</d2p1:Key>
      <d2p1:Value xmlns:d4p1="http://www.w3.org/2001/XMLSchema" i:type="d4p1:string">12321</d2p1:Value>
    </d2p1:KeyValueOfstringanyType>
  </CustomFields>
  <CustomerCode>12345</CustomerCode>
  <Email>info@venue.com</Email>
  <Fax></Fax>
  <Info>Specalist in venues.</Info>
  <Name>Venue Ltd.</Name>
  <Phone>555.123.456</Phone>
  <Status>active</Status>
  <Type>prospect</Type>
  <Vat>BE123.456.789</Vat>
  <VatTransfer>0</VatTransfer>
  <Website>http://www.venue.com</Website>
</Company>