POST api/{siteCode}/Contact/WriteNewContact

This call is used to create new records where the Customer Account Number is not known

Request Information

URI Parameters

NameDescriptionTypeAdditional information
siteCode

The site code.

integer

Required

Body Parameters

The contact record.

ContactRecord
NameDescriptionTypeAdditional information
CustomerProfiles

Profile information/usage instructions

Collection of Customer_Profile

None.

ListAddressRecords

Address records associated to this client record

Collection of AddressRecord

None.

Account_Number

string

Required

String length: inclusive between 0 and 8

Company_Name

string

String length: inclusive between 0 and 50

Remarks

string

String length: inclusive between 0 and 5000

Default_Profile

integer

None.

VAT

string

None.

Country

string

String length: inclusive between 0 and 2

Record_Type

string

String length: inclusive between 0 and 50

Prospect

integer

None.

CustomerUK

integer

None.

CustomerForeign

integer

None.

Overseas_Agent

integer

None.

Airline

integer

None.

Steamship

integer

None.

Forwarder

integer

None.

DomHaulage

integer

None.

IntHaulage

integer

None.

Shed

integer

None.

MiscSupplier

integer

None.

Probation

date

None.

Approved

integer

None.

CreditHold

integer

None.

CreditLimit

decimal number

None.

SalesPerson

string

String length: inclusive between 0 and 50

Size

string

String length: inclusive between 0 and 50

Class

string

String length: inclusive between 0 and 50

Principal

string

String length: inclusive between 0 and 50

SecurityDate

date

None.

CreditInsLimit

decimal number

None.

CreditInsDate

date

None.

AccCodeSales

string

String length: inclusive between 0 and 50

AccCodePurch

string

String length: inclusive between 0 and 50

LanguagePreference

string

String length: inclusive between 0 and 50

InvoiceCurrency

string

String length: inclusive between 0 and 3

SpareField

string

String length: inclusive between 0 and 50

CreditStatus

string

String length: inclusive between 0 and 50

CreditLimitRequested

decimal number

None.

PrincipalAccnum

string

String length: inclusive between 0 and 8

ApprovedDate

date

None.

Request Formats

application/json, text/json

Sample:
{
  "CustomerProfiles": [
    {
      "TURN": null,
      "ID": 0,
      "DAN": null,
      "Arrival_Instructions": null,
      "Clearance_Instructions": "All destination charges should revert to origin",
      "Delivery_Instructions": "Request delivery booking reference prior to arranging transportation",
      "Charging_Instructions": null,
      "Contracted_Rates": null,
      "Export_Instructions": null,
      "General_Instructions": null,
      "Known": null,
      "KnownExpires": null,
      "KnownAgreement": null,
      "IETax": null,
      "IETaxExpiry": null,
      "IETaxCert": null
    }
  ],
  "ListAddressRecords": [
    {
      "ListAddressContacts": [
        {
          "ID": 0,
          "AddressID": 0,
          "Contact_Name": null,
          "Title": null,
          "First_Name": "Persons",
          "Surname": "Name",
          "Position": "Manager",
          "Phone": "020 8400 2000",
          "Fax": null,
          "Email": "persons.email@company.com",
          "Mobile": null,
          "Comments": null,
          "TSTAMP": null
        }
      ],
      "ID": 0,
      "Account_Number": "Account#",
      "Company_Name": "Shipper Name Ltd.",
      "Address_Line_1": "Shipper Address Line 1",
      "Address_Line_2": "Shipper Address Line 2",
      "Address_Line_3": "Shipper City",
      "Address_Line_4": "Shipper County/State",
      "Postal_Code": "PCode",
      "Contact_Name": null,
      "Phone": "01 811 8181",
      "Fax": null,
      "Remarks": null,
      "Position": null,
      "Title": "Mr",
      "First_Name": "Shipper",
      "Surname": "Contact",
      "AccountsAddr": 0,
      "ConsigneeAddr": 0,
      "ShipperAddr": -1,
      "Operations": null,
      "Country": "GB",
      "City": null,
      "Email": "emailAddress@ShipperCompany.com",
      "WebLink": null,
      "Courier": null,
      "VATNumber": null,
      "Mobile": null,
      "UNLOCODE": null,
      "CollectionAddress": -1,
      "DeliveryAddress": 0,
      "SalesAddress": null,
      "SequoiaID": null,
      "SequoiaAccountID": null,
      "Security": null,
      "TSTAMP": null
    }
  ],
  "Account_Number": "Account#",
  "Company_Name": "The New Corporation Limited",
  "Remarks": null,
  "Default_Profile": 1,
  "VAT": null,
  "Country": "UK",
  "Record_Type": null,
  "Prospect": null,
  "CustomerUK": -1,
  "CustomerForeign": 0,
  "Overseas_Agent": null,
  "Airline": 0,
  "Steamship": null,
  "Forwarder": 0,
  "DomHaulage": 0,
  "IntHaulage": 0,
  "Shed": null,
  "MiscSupplier": null,
  "Probation": null,
  "Approved": 0,
  "CreditHold": 0,
  "CreditLimit": null,
  "SalesPerson": null,
  "Size": null,
  "Class": "",
  "Principal": null,
  "SecurityDate": null,
  "CreditInsLimit": 0.0,
  "CreditInsDate": null,
  "AccCodeSales": "",
  "AccCodePurch": "",
  "LanguagePreference": null,
  "InvoiceCurrency": "GBP",
  "SpareField": null,
  "CreditStatus": null,
  "CreditLimitRequested": null,
  "PrincipalAccnum": null,
  "ApprovedDate": null
}

application/xml, text/xml

Sample:
<ContactRecord xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Account_Number>Account#</Account_Number>
  <Company_Name>The New Corporation Limited</Company_Name>
  <Default_Profile>1</Default_Profile>
  <Country>UK</Country>
  <Prospect xsi:nil="true" />
  <CustomerUK>-1</CustomerUK>
  <CustomerForeign>0</CustomerForeign>
  <Overseas_Agent xsi:nil="true" />
  <Airline>0</Airline>
  <Steamship xsi:nil="true" />
  <Forwarder>0</Forwarder>
  <DomHaulage>0</DomHaulage>
  <IntHaulage>0</IntHaulage>
  <Shed xsi:nil="true" />
  <MiscSupplier xsi:nil="true" />
  <Probation xsi:nil="true" />
  <Approved>0</Approved>
  <CreditHold>0</CreditHold>
  <CreditLimit xsi:nil="true" />
  <Class />
  <SecurityDate xsi:nil="true" />
  <CreditInsLimit>0</CreditInsLimit>
  <CreditInsDate xsi:nil="true" />
  <AccCodeSales />
  <AccCodePurch />
  <InvoiceCurrency>GBP</InvoiceCurrency>
  <CreditLimitRequested xsi:nil="true" />
  <ApprovedDate xsi:nil="true" />
  <StatusDate xsi:nil="true" />
  <WebUser xsi:nil="true" />
  <CustomerProfiles>
    <Customer_Profile>
      <Customer_Account_Number>Account#</Customer_Account_Number>
      <ID>0</ID>
      <Clearance_Instructions>All destination charges should revert to origin</Clearance_Instructions>
      <Delivery_Instructions>Request delivery booking reference prior to arranging transportation</Delivery_Instructions>
      <Known xsi:nil="true" />
      <KnownExpires xsi:nil="true" />
      <IETax xsi:nil="true" />
      <IETaxExpiry xsi:nil="true" />
    </Customer_Profile>
  </CustomerProfiles>
  <ListAddressRecords>
    <AddressRecord>
      <ID>0</ID>
      <Account_Number>Account#</Account_Number>
      <Company_Name>Shipper Name Ltd.</Company_Name>
      <Address_Line_1>Shipper Address Line 1</Address_Line_1>
      <Address_Line_2>Shipper Address Line 2</Address_Line_2>
      <Address_Line_3>Shipper City</Address_Line_3>
      <Address_Line_4>Shipper County/State</Address_Line_4>
      <Postal_Code>PCode</Postal_Code>
      <Phone>01 811 8181</Phone>
      <Title>Mr</Title>
      <First_Name>Shipper</First_Name>
      <Surname>Contact</Surname>
      <AccountsAddr>0</AccountsAddr>
      <ConsigneeAddr>0</ConsigneeAddr>
      <ShipperAddr>-1</ShipperAddr>
      <Operations xsi:nil="true" />
      <Country>GB</Country>
      <Email>emailAddress@ShipperCompany.com</Email>
      <Courier xsi:nil="true" />
      <CollectionAddress>-1</CollectionAddress>
      <DeliveryAddress>0</DeliveryAddress>
      <SalesAddress xsi:nil="true" />
      <ListAddressContacts>
        <AddressContact>
          <ID>0</ID>
          <AddressID>0</AddressID>
          <First_Name>Persons</First_Name>
          <Surname>Name</Surname>
          <Position>Manager</Position>
          <Phone>020 8400 2000</Phone>
          <Email>persons.email@company.com</Email>
        </AddressContact>
      </ListAddressContacts>
    </AddressRecord>
  </ListAddressRecords>
</ContactRecord>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

HttpResponseMessage
NameDescriptionTypeAdditional information
Version

Version

None.

Content

HttpContent

None.

StatusCode

HttpStatusCode

None.

ReasonPhrase

string

None.

Headers

Collection of Object

None.

RequestMessage

HttpRequestMessage

None.

IsSuccessStatusCode

boolean

None.