UploadCustomers


 

Overview

Quick Links

This method can be called to upload a set of Customers.

Resource Information

Request Format XML
Response Format XML

Request Header

Name Type Description
String String Authentication Token

Request Body

Name Type Description
customers List of Customers A list of Customer objects to upload

Response

Name Type Description
Result String true or false, depending on success.
ResultCode String String indicating the result. Either "Success" or "Error"
ResultMessage String Empty when call successful, error message otherwise

In the case of an internal unhandled fault, a Fault object is returned instead. Providing information on what occurred exactly.

Examples

Request

<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
    <Header xmlns:s="System"><s:String>8d7bcad4-4b54-427b-868f-709003232aa6</s:String></Header>
    <Body>
        <UploadCustomers xmlns="http://tempuri.org/">
            <customers>
                <Customer xmlns="http://schemas.datacontract.org/2004/07/Kolonel.Public.Service.API.Contracts.V1_0">
                    <Addresses>
                        <Address>
                            <AddressLine1>Kalverstraat</AddressLine1>
                            <City>Amsterdam</City>
                            <Country>Netherlands</Country>
                            <HouseNumber>123</HouseNumber>
                            <HouseNumberAddition>a</HouseNumberAddition>
                            <Name>Invoice Address</Name>
                            <PostalCode>1000 AA</PostalCode>
                        </Address>
                    </Addresses>
                    <BillFromDate>2014-12-01T00:00:00</BillFromDate>
                    <CustomerCode>UniqueExternalCustomerId</CustomerCode>
                    <CustomerName>J. Jansen</CustomerName>
                    <DateValues>
                        <NameValuePair>
                            <Name>Birthdate</Name>
                            <Value>1980-01-01T00:00:00</Value>
                        </NameValuePair>
                    </DateValues>
                    <EmailAddresses>
                        <EmailAddress>
                            <DisplayName>J. Jansen</DisplayName>
                            <Email>jjansen@jansen.nl</Email>
                            <Key>invoiceEmail</Key>
                        </EmailAddress>
                    </EmailAddresses>
                    <ImportTagName>CustomerClusterName</ImportTagName>
                    <InvoicePeriodAlignToUOM>true</InvoicePeriodAlignToUOM>
                    <InvoicePeriodSize>1</InvoicePeriodSize>
                    <InvoicePeriodUOM>Month</InvoicePeriodUOM>
                    <InvoiceSeparatelyPerPeriod>true</InvoiceSeparatelyPerPeriod>
                    <IsBillingSuspended>false</IsBillingSuspended>
                    <LCID>1033</LCID>
                    <NumericValues>
                        <NameValuePair>
                            <Name>DiscountPercentage</Name>
                            <Value>40</Value>
                        </NameValuePair>
                    </NumericValues>
                    <StringValues>
                        <NameValuePair>
                            <Name>VAT Nr</Name>
                            <Value>NL09899657690B</Value>
                        </NameValuePair>
                    </StringValues>
                    <TimezoneId>W. Europe Standard Time</TimezoneId>
                </Customer>
            </customers>
        </UploadCustomers>
    </Body>
</Envelope>

Response

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
    <s:Body>
        <UploadCustomersResponse xmlns="http://tempuri.org/">
            <UploadCustomersResult xmlns:a="http://schemas.datacontract.org/2004/07/Kolonel.Public.Service.API.Contracts.V1_0" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
                <a:Result>true</a:Result>
                <a:ResultCode>Success</a:ResultCode>
                <a:ResultMessage/>
            </UploadCustomersResult>
        </UploadCustomersResponse>
    </s:Body>
</s:Envelope>