Skip to main content

Sample messages

Supplier Import​

<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!DOCTYPE cXML SYSTEM "http://xml.cXML.org/schemas/cXML/1.2.048/cXML.dtd">
<cXML xml:lang="en" payloadID="[email protected]" timestamp="2021-03-31T18:39:09-08:00" version="1.2.0.14">
    <Header>
        <From>
            <Credential domain="ProactisOrganizationId">
                <Identity>Identity</Identity>
            </Credential>
        </From>
        <To>
            <Credential domain="ProactisOrganizationId">
                <Identity>Identity</Identity>
            </Credential>
        </To>
        <Sender>
            <Credential domain="ProactisOrganizationId">
                <Identity>Identity</Identity>
            </Credential>
            <UserAgent>User-agent</UserAgent>
        </Sender>
    </Header>
    <Message deploymentMode="production">

        <!--REQUIRED: Options for type: "new", "update" and "delete"-->
        <OrganizationChangeMessage type="new">

            <!--REQUIRED-->
            <Organization>

                <!--REQUIRED: Name of the Supplier-->
                <Name xml:lang="en">Organization name</Name>

                <!--REQUIRED-->
                <Credential domain="Number">

                    <!--REQUIRED: Number of the Supplier-->
                    <Identity>OrganizationNumber</Identity>

                </Credential>

                <!--OPTIONAL-->
                <Credential domain="DUNS">

                    <!--REQUIRED: DUNS number of the Supplier-->
                    <Identity>DunsNumber</Identity>

                </Credential>

                <!--OPTIONAL-->
                <Credential domain="VAT">

                    <!--REQUIRED: VAT number of the Supplier-->
                    <Identity>VatNumber</Identity>

                </Credential>

                <!--OPTIONAL-->
                <Credential domain="COC">

                    <!--REQUIRED: Chamber Of Commerce number of the Supplier-->
                    <Identity>CocNumber</Identity>

                </Credential>

                <!--OPTIONAL-->
                <Credential domain="GLN">

                    <!--REQUIRED: GLN number of the Supplier-->
                    <Identity>GLNNumber</Identity>

                </Credential>

                <!--REQUIRED: Only accepting OrganizationRole name of "supplier"-->
                <OrganizationRole name="supplier"/>

                <!--REQUIRED-->
                <Address>

                    <!--REQUIRED-->
                    <Name xml:lang="en">Address name</Name>

                    <!--OPTIONAL-->
                    <PostalAddress>

                        <!--REQUIRED-->
                        <Street>Street</Street>

                        <!--REQUIRED-->
                        <City>City</City>

                        <!--OPTIONAL-->
                        <PostalCode>12345</PostalCode>

                        <!--REQUIRED-->
                        <Country isoCountryCode="US"/>

                    </PostalAddress>

                    <!--OPTIONAL-->
                    <Email>[email protected]</Email>

                    <!--OPTIONAL-->
                    <Phone>

                        <!--REQUIRED-->
                        <TelephoneNumber>

                            <!--REQUIRED-->
                            <CountryCode isoCountryCode="US">1</CountryCode>

                            <!--REQUIRED: Value can be empty-->
                            <AreaOrCityCode>234</AreaOrCityCode>

                            <!--REQUIRED-->
                            <Number>345-6789</Number>

                        </TelephoneNumber>

                    </Phone>

                    <!--OPTIONAL-->
                    <Fax>

                        <!--REQUIRED: Only TelephoneNumber is supported for Fax-->
                        <TelephoneNumber>

                            <!--REQUIRED-->
                            <CountryCode isoCountryCode="US">1</CountryCode>

                            <!--REQUIRED: Value can be empty-->
                            <AreaOrCityCode/>

                            <!--REQUIRED-->
                            <Number>012-345-6789</Number>

                        </TelephoneNumber>

                    </Fax>

                    <!--OPTIONAL-->
                    <URL name="website name">http://main.url.com</URL>

                </Address>

                <!--OPTIONAL-->
                <Description xml:lang="en">Description of Organization</Description>

                <!--OPTIONAL: Visiting address of the Supplier-->
                <Person>
                    <Contact role="visitingAddress">
                        <Name xml:lang="en">Visiting Address</Name>
                        <PostalAddress>
                            <Street>Street</Street>
                            <Street>Second line Street</Street>
                            <City>City</City>
                            <State>State</State>
                            <PostalCode>12345</PostalCode>
                            <Country isoCountryCode=""/>
                        </PostalAddress>
                    </Contact>
                    <PersonRole name="supplier"/>
                </Person>

                <!--OPTIONAL: Multiple commodities are allowed (with unique codes)-->
                <Commodity>

                    <!--REQUIRED: Only Commodities with Classification "SpendingPool" or "CommodityCode are allowed-->
                    <!--SpendingPool and CommodityCode codes need to exist-->
                    <Classification domain="SpendingPool" code="4000">Name of SpendingPool
                    </Classification>

                </Commodity>

                <Commodity>
                    <Classification domain="CommodityCode" code="4010">Name of CommodityCode
                    </Classification>
                </Commodity>

                <!--OPTIONAL: Multiple PaymentInformation element allowed-->
                <!--Contains payment information for the supplier-->
                <PaymentInformation>
                    <!--REQUIRED: Multiple PaymentMethodRemittanceInformation elements allowed-->
                    <!--Contains payment remittance information for the supplier, including payment methods and payment method partners-->
                    <!--preferredPaymentMethod should be referencing the PaymentMethod type if present-->
                    <PaymentMethodRemittanceInformation preferredPaymentMethod="other">
                        <!--role must have value "payee" for setting bank account number-->
                        <Contact role="payee">
                            <Name xml:lang="en">AccountName</Name>
                            <PostalAddress>
                                <Street></Street>
                                <City>AccountCity</City>
                                <Country isoCountryCode=""></Country>
                            </PostalAddress>
                            <!--Possible values for domain: ibanID, accountID, bankAccountID, bankGAccountID, ibanGAccountID and bankForeignAccountID-->
                            <IdReference domain="ibanID" identifier="AccountNumber"/>
                            <!--OPTIONAL: A swift code can also be set for a bank account with extra IdReference-->
                            <IdReference domain="swiftID" identifier="SwiftCode"/>
                            <!--OPTIONAL: A code can be set for a bank account-->
                            <IdReference domain="bankNationalID" identifier="Code value"/>
                        </Contact>

                    </PaymentMethodRemittanceInformation>
                </PaymentInformation>

                <!--OPTIONAL: Multiple supplier groups are allowed-->
                <Extrinsic name="ProactisSupplierGroup">Name of SupplierGroup</Extrinsic>

                <!--OPTIONAL: Email address where orders need to be sent to-->
                <!-- When updating a supplier the existing value will be cleared if the element/value is not provided,-->
                <!-- while the ProactisOrderLocale is provided. If both values are missing the existing value won't be changed-->
                <Extrinsic name="ProactisOrderEmail">[email protected]</Extrinsic>

                <!--OPTIONAL: Should the Order PDF NOT be attached to the order email? If the ProactisOrderEmailDoNotAttachPDF Extrinsic is not specified, the default value is set to false-->
                <!--Possible values: true and false-->
                <Extrinsic name="ProactisOrderEmailDoNotAttachPDF">true</Extrinsic>

                <!--OPTIONAL: Should the Order XML NOT be attached to the order email? If the OrderEmailDoNotAttachXML Extrinsic is not specified, the default value is set to false-->
                <!--Possible values: true and false-->
                <Extrinsic name="ProactisOrderEmailDoNotAttachXML">true</Extrinsic>

                <!--OPTIONAL: The order locale of the Supplier-->
                <!-- When updating a supplier the existing value will be cleared if the element/value is not provided,-->
                <!-- while the ProactisOrderEmail is provided. If both values are missing the existing value won't be changed-->
                <Extrinsic name="ProactisOrderLocale">en_US</Extrinsic>

                <!--OPTIONAL: The max number of days in which a payment needs to be finished-->
                <Extrinsic name="ProactisPaymentTerm">12</Extrinsic>

                <!--OPTIONAL: The discount for payments in percentage-->
                <Extrinsic name="ProactisPaymentDiscount">10.00</Extrinsic>

                <!--OPTIONAL: The base currency of the Supplier-->
                <Extrinsic name="ProactisBaseCurrency">USD</Extrinsic>

                <!--OPTIONAL: The invoice matching type of the Supplier. If the ProactisInvoiceMatchingMethod Extrinsic is not specified, the default value for invoice matching is set to 3Way-->
                <!--Possible values: 3Way and 2Way-->
                <Extrinsic name="ProactisInvoiceMatchingMethod">3Way</Extrinsic>

                <!--OPTIONAL: The default VAT code of the Supplier-->
                <Extrinsic name="ProactisDefaultVat">1</Extrinsic>

                <!--OPTIONAL: Is Value Added Tax applied? If the ProactisApplyValueAddedTax Extrinsic is not specified, the default value is set to the organization default-->
                <!--Possible values: true and false-->
                <Extrinsic name="ProactisApplyValueAddedTax">false</Extrinsic>

                <!--OPTIONAL: The default DeliveryTerms of the Supplier-->
                <Extrinsic name="ProactisDeliveryTerms">EX Works (incoterms 2010)</Extrinsic>

                <!--OPTIONAL: Is the Supplier active? If the ProactisOnlineFlag Extrinsic is not specified, the default value is true-->
                <!--Possible values: true and false-->
                <Extrinsic name="ProactisOnlineFlag">true</Extrinsic>

                <!--OPTIONAL: The status of the Supplier-->
                <!--Possible values: empty, Preferred, Alternative, Strategic, Excellent, Prospect, No Preference, Not-Accepted and Not-Creditable-->
                <Extrinsic name="ProactisStatusOfVendor">Preferred</Extrinsic>

                <!--OPTIONAL: "Present Legality of Company" of the Supplier-->
                <Extrinsic name="ProactisCompanyLegality">BV</Extrinsic>

                <!--OPTIONAL: "Is the Supplier owned by S2C? If the ProactisS2CSupplier Extrinsic is not specified, the default value is false-->
                <!--Possible values: true and false-->
                <Extrinsic name="ProactisS2CSupplier">false</Extrinsic>

                 <!--OPTIONAL: Invoice payment method-->
                <!--Possible values: Cash, Bank, Giro, Incasso and Acceptgiro-->
                <Extrinsic name="ProactisPaymentMethod">Bank</Extrinsic>

                <!--OPTIONAL: The default Payment Terms of the Supplier-->
                <Extrinsic name="ProactisPaymentTerms">To be paid within 14 days</Extrinsic>

                <!--OPTIONAL: The default cost account-->
                <Extrinsic name="ProactisDefaultCostAccount">CA123456</Extrinsic>

            </Organization>
        </OrganizationChangeMessage>
    </Message>
</cXML>

Contents