XML Format Examples (All Parameters)

Appendix: XML Format Examples (All Parameters)

The appendix provides XML code examples for specific formats for:

Inbound sales order.
Outbound customer request and response.

Inbound Sales Order XML Format (All Parameters)

This section provides example code for an inbound sales order. This sample code shows the XML format with all of the parameters.

"<?xml version='1.0'?>
<jdeRequest type='callmethod' user='userid' pwd='password' 
environment='environment' role='*ALL'>
<callMethod name='GetLocalComputerId' app='NetCommerce' runOnError='no'>
<params>
<param name='szMachineKey'id='2'></param> 
<params>
   <callMethod>
<callMethod name='F4211FSBeginDoc' app='NetCommerce' runOnError='no'>
<params>
   <param name='mnCMJobNumber' id='j1'></param>
 <param name='cCMDocAction'>A</param>
 <param name='cCMProcessEdits'>1</param>         ( 1 = Full)
 <param name='szCMComputerID' idref='c2'></param>  
 <param name='cCMErrorConditions'>value</param>  (1=Warnings, 2=Errors)
 <param name='cCMUpdateWriteToWF'>value</param>  (1=wf,2=cache)
 <param name='szCMProgramID'>value</param>
 <param name='szCMVersion'>value</param>
 <param name='szOrderCo'<value</param>
 <param name='mnOrderNo'>value</param>
 <param name='szOrderType'>value</param>         (If blank def Proc Opt)
 <param name='szBusinessUnit'>value</param>      (If blank def Proc Opt)
 <param name='szOriginalOrderCo'>value</param>   (used copy/blanket function)
 <param name='szOriginalOrderNo'>value</param>   (used copy/blanket function)
 <param name='szOriginalOrderType'>value</param> (used copy/blanket function)
 <param name='mnAddressNumber'>value</param>     (Required if ship to = 0)
 <param name='mnShipToNo'>value</param>          (Required if sold to = 0)
 <param name='jdRequestedDate'>value</param>
 <param name='jdOrderDate'>value</param>
 <param name='jdPromisedDate'>value</param>
 <param name='jdCancelDate'>value</param>
 <param name='szReference'>value</param>
 <param name='szDeliveryInstructions1'>value</param>
 <param name='szDeliveryInstructions2'>value</param>
 <param name='szPrintMesg'>value</param>
 <param name='szPaymentTerm'>value</param>
 <param name='cPaymentInstrument'>value</param>
 <param name='szAdjustmentSchedule'>value</param>
 <param name='mnTradeDiscount'>value</param>
 <param name='szTaxExplanationCode'>value</param>
 <param name='szTaxArea'>value</param>
 <param name='szCertificate'>value</param>
 <param name='cAssociatedText'>value</param>
 <param name='szHoldOrdersCode'>value</param>
 <param name='cPricePickListYN'>value</param>
 <param name='mnInvoiceCopies'>value</param>
 <param name='mnBuyerNumber'>value</param>
 <param name='mnCarrier'>value</param>
 <param name='szRouteCode'>value</param>
 <param name='szStopCode'>value</param>
 <param name='szZoneNumber'>value</param>
 <param name='szFreightHandlingCode'>value</param>
 <param name='cApplyFreightYN'>value</param>
 <param name='mnCommissionCode1'>value</param>
 <param name='mnCommissionRate1'>value</param>
 <param name='mnCommissionCode2'>value</param>
 <param name='mnCommissionRate2'>value</param>
 <param name='szWeightDisplayUOM'>value</param>
 <param name='szVolumeDisplayUOM'>value</param>
 <param name='szAuthorizationNo'>value</param>
 <param name='szCreditBankAcctNo'>value</param>
 <param name='jdCreditBankExpiredDate'>value</param>
 <param name='cMode'>value</param>
 <param name='szCurrencyCode'>value</param>
 <param name='mnExchangeRate'>value</param>
 <param name='szOrderedBy'>value</param>
 <param name='szOrderTakenBy'>value</param>
 <param name='szUserReservedCode'>value</param>
 <param name='jdUserReservedDate'>value</param>
 <param name='mnUserReservedAmnt'>value</param>
 <param name='mnUserReservedNo'>value</param>
 <param name='szUserReservedRef'>value</param>
 <param name='jdDateUpdated'>value</param>
 <param name='szUserID'>value</param>
 <param name='szWKBaseCurrency'>value</param>
 <param name='cWKAdvancedPricingYN'>value</param>
 <param name='szWKCreditMesg'>value</param>
 <param name='szWKTempCreditMesg'>value</param>
 <param name='cWKInvalidSalesOrderNo'>value</param> 
 <param name='cWKSourceOfData'>blank</param>  (Required, blank = parms )
 <param name='cWKProcMode'>blank</param>      (blank = reg order)
 <param name='mnWKSuppressProcess'>0</param>  (0 = def, 2=P/O)
 <param name='mnSODDocNo'>value</param>
 <param name='szSODDocType'>value</param>
 <param name='szSODOrderCo'>value</param>
 <param name='mnTriangulationRateFrom'>value</param>
 <param name='mnTriangulationRateTo'>value</param>
 <param name='cCurrencyConversionMethod'>value</param>
 <param name='cRetrieveOrderNo'>value</param> 
 <param name='szPricingGroup'>value</param>
 <param name='cCommitInvInED'>value</param>
 <param name='cSpotRateAllowed'>value</param>
 <param name='cGenericChar2_EV02'>value</param>   
 <param name='szGenericString1_DL01'>value</param>
 <param name='szGenericString2_DL02'>value</param>
 <param name='mnGenericMathNumeric1_MATH01'>value</param> 
 <param name='mnGenericMathNumeric2_MATH02'>value</param>  
 <param name='szLongAddressNumberShipto'>value</param>  
 <param name='szLongAddressNumber'>value</param>
 <param name='mnProcessID'>value</param>
 <param name='mnTransactionID'>value</param>
</params>
<onError abort='yes'>\
 <callMethod name='F4211ClearWorkFile' app='NetCommerce' runOnError='yes'>
  <params>
  <param name='mnJobNo' idref='j1'></param>
  <param name='szComputerID' idref='c2'></param>
  <param name='mnFromLineNo'>value</param>
  <param name='mnThruLineNo'>value</param>
  <param name='cClearHeaderWF'>value</param>
  <param name='cClearDetailWF'>value</param>
  <param name='szProgramID'>value</param>
  <param name='mnWKRelatedOrderProcess'>value</param>
  <param name='szCMVersion'>value</param>
  <param name='cGenericChar1_EV01'>value</param>
  <param name='szGenericString1_DL01'>value</param>
  <param name='mnSODRelatedJobNumber'>value</param>
  <param name='mnProcessID' >value</param>
  <param name='mnTransactionID'>value</param>
  </params>
 </callMethod>
</onError>
</callMethod>
<callMethod name='F4211FSEditLine'app='NetCommerce' runOnError='yes'> (each line)
 <params>
  <param name='mnCMJobNo' idref='j1'></param>
  <param name='cCMLineAction'>value</param>
  <param name='cCMProcessEdits'>value</param>
  <param name='cCMWriteToWFFlag'>value</param>
  <param name='cCMRecdWrittenToWF'>value</param>
  <param name='szCMComputerID' idref='c2'></param>
  <param name='cCMErrorConditions'>value</param>
  <param name='szOrderCo'>value</param>
  <param name='mnOrderNo'>value</param>
  <param name='szOrderType'>value</param>
  <param name='mnLineNo'>value</param>
  <param name='szBusinessUnit'>value</param>
  <param name='mnShipToNo'>value</param>
  <param name='jdRequestedDate'>value</param>
  <param name='jdPromisedDate'>value</param>
  <param name='jdCancelDate'>value</param>
  <param name='jdPromisedDlvryDate'>value</param>
  <param name='szItemNo'>value</param>
  <param name='szLocation'>value</param>
  <param name='szLotNo'>value</param>
  <param name='szDescription1'>value</param>
  <param name='szDescription2'>value</param>
  <param name='szLineType'>value</param>
  <param name='szLastStatus'>value</param>
  <param name='szNextStatus'>value</param>
  <param name='mnQtyOrdered'>value</param>
  <param name='mnQtyShipped'>value</param>
  <param name='mnQtyBackordered'>value</param>
  <param name='mnQtyCanceled'>value</param>
  <param name='mnExtendedPrice'>value</param>
  <param name='mnExtendedCost'>value</param>
  <param name='szPrintMesg'>value</param>
  <param name='cPaymentInstrument'>value</param>
  <param name='szAdjustmentSchedule'>value</param>
  <param name='cSalesTaxableYN'>value</param>
  <param name='cAssociatedText'>value</param>
  <param name='szTransactionUOM'>value</param>
  <param name='szPricingUOM'>value</param>
  <param name='mnItemWeight'>value</param>
  <param name='szWeightUOM'>value</param>
  <param name='mnForeignUnitPrice'>value</param>
  <param name='mnForeignExtPrice'>value</param>
  <param name='mnForeignUnitCost'>value</param>
  <param name='mnForeignExtCost'>value</param>
  <param name='szPricingCategoryLevel'>value</param>
  <param name='mnDiscountFactor'>value</param>
  <param name='mnCMLineNo'>value</param>
  <param name='szCMProgramID'>value</param>
  <param name='szCMVersion'>value</param>
  <param name='mnSupplierNo'>value</param>
  <param name='szRelatedKitItemNo'>value</param>
  <param name='mnKitMasterLineNo'>value</param>
  <param name='mnComponentLineNo'>value</param>
  <param name='mnRelatedKitComponent'>value</param>
  <param name='mnNoOfCpntPerParent'>value</param>
  <param name='cOverridePrice'>value</param>
  <param name='cOverrideCost'>value</param>
  <param name='szUserID'>value</param>
  <param name='jdDateUpdated'>value</param>
  <param name='mnWKOrderTotal'>value</param>
  <param name='mnWKForeignOrderTotal'>value</param>
  <param name='mnWKTotalCost'>value</param>
  <param name='mnWKForeignTotalCost'>value</param>
  <param name='cWKProcessingType'>value</param>
  <param name='cWKSourceOfData'>value</param>
  <param name='cWKCheckAvailability'>value</param>
  <param name='mnLastLineNoAssigned'>value</param>
  <param name='cStockingType'>value</param>
  <param name='szOriginalOrderKeyCo'>value</param>
  <param name='szOriginalOrderNo'>value</param>
  <param name='szOriginalOrderType'>value</param>
  <param name='mnOriginalOrderLineNo'>value</param>
  <param name='cParentItmMethdOfPriceCalcn'>value</param>
  <param name='szLandedCost'>value</param>
  <param name='mnWKSuppressProcess'>value</param>
  <param name='mnShortItemNo'>value</param>
  <param name='mnWKRelatedOrderProcess'>value</param>
  <param name='mnSODLineNo'>value</param>
  <param name='mnPriceAdjRevLevel'>value</param>
  <param name='szSalesOrderFlags'>value</param>
  <param name='mnSODDocNo'>value</param>
  <param name='szSODDocType'>value</param>
  <param name='szSODOrderCo'>value</param>
  <param name='szTransferOrderToBranch'>value</param>
  <param name='mnDomesticDetachedAdj'>value</param>
  <param name='mnForeignDetachedAdj'>value</param>
  <param name='mnSODWFLineNo'>value</param>
  <param name='szGeneric2CharString'>value</param>
  <param name='mnTOEPOExchangeRate'>value</param>
  <param name='szTOEPOCurrencyCode'>value</param>
  <param name='mnDRPKeyId'>value</param>
  <param name='mnSoldToCust'>value</param>
  <param name='szF4201BranchPlant'>value</param>
  <param name='szSoldToCurrencyCode'>value</param>
  <param name='cConsolidationFlag'>value</param>
  <param name='jdPriceEffectiveDate'>value</param>
  <param name='mnWOWFLineNo'>value</param>
  <param name='mnLineNoIncrement'>value</param>
  <param name='mnParentWFLineNo'>value</param>
  <param name='cStatusInWarehouse'>value</param>
  <param name='cBypassCommitments'>value</param>
  <param name='szProductSource'>value</param>
  <param name='szProductSourceType'>value</param>
  <param name='mnSequenceNumber'>value</param>
  <param name='szAgreementNumber'>value</param>
  <param name='mnAgreementSupplement'>value</param>
  <param name='mnAgreementsFound'>value</param>
  <param name='szModeOfTransport'>value</param>
  <param name='szDutyStatus'>value</param>
  <param name='szLineofBusiness'>value</param>
  <param name='jdPromisedShip'>value</param>
  <param name='szEndUse'>value</param>
  <param name='mnTOEPOExchangeRate'>value</param>
  <param name='szPriceCode1'>value</param>
  <param name='szPriceCode2'>value</param>
  <param name='szPriceCode3'>value</param>
  <param name='szItemFlashMessage'>value</param>
  <param name='szCompanyKeyRelated'>value</param>
  <param name='szRelatedPoSoNumber'>value</param>
  <param name='szRelatedOrderType'>value</param>
  <param name='mnRelatedPoSoLineNo'>value</param>
  <param name='cGenericChar3'>value</param>     
  <param name='mnProfitMargin'>value</param>     
  <param name='mnQuantityAvailable'>value</param>     
  <param name='cRequestScheduleFlag'>value</param>     
  <param name='cOrderProcessType'>value</param>     
  <param name='cGenericChar2'>value</param>     
  <param name='mnSODRelatedJobNumber'>value</param>     
  <param name='szGenericString'>value</param>     
  <param name='mnCarrier'>value</param>     
  <param name='szGenericString2_DL02'>value</param>     
  <param name='mnGenericMathNumeric1_MATH01'>value</param>     
  <param name='mnGenericMathNumeric2_MATH02'>value</param>     
  <param name='mnItemVolume_ITVL'>value</param>     
  <param name='szVolumeUOM_VLUM'>value</param>     
  <param name='szRevenueBusinessUnit'>value</param>     
  <param name='szCustomerPO_VR01'>value</param>     
  <param name='szReference2Vendor_VR02'>value</param>     
  <param name='mnProcessID'>value</param>     
  <param name='mnTransactionID'>value</param>     
 </params>
  <onError abort='no'>\
 </onError>
</callMethod>
<callMethod name='F4211FSEndDoc' app='NetCommerce' runOnError='no'>
 <params>
  <param name='mnCMJobNo' idref='j1'></param>
  <param name='mnSalesOrderNo'>value</param>
  <param name='szCMComputerID' idref='2'></param>
  <param name='cCMErrorCondition'>value</param>
  <param name='szOrderType'>value</param>
  <param name='szKeyCompany'>value</param>
  <param name='mnOrderTotal'>value</param>
  <param name='mnForeignOrderTotal'>value</param>
  <param name='szBaseCurrencyCode'>value</param>
  <param name='szProgramID'>value</param>
  <param name='szWorkstationID'>value</param>
  <param name='szCMProgramID'>value</param>
  <param name='szCMVersion'>value</param>
  <param name='mnTimeOfDay'>value</param>
  <param name='mnTotalCost'>value</param>
  <param name='mnForeignTotalCost'>value</param>
  <param name='cSuppressRlvBlnktFlag'>value</param>
  <param name='cWKSkipProcOptions'>value</param>  (Skip Proc Opt, 1="Yes")
  <param name='mnWKRelatedOrderProcess'>value</param>
  <param name='cCMUseWorkFiles'>value</param>(Req,Work File="1", Cache ="2")
  <param name='mnEDIDocNo'>value</param>
  <param name='szEDIKeyCo'>value</param>
  <param name='szEDIDocType'>value</param>
  <param name='cCMProcessEdits'>value</param>  
  <param name='cGenericChar2'>value</param>
  <param name='mnSODRelatedJobNumber'>value</param>
  <param name='cGenericChar1_EV01'>value</param>
  <param name='mnGenericMathNumeric2_MATH02'>value</param>
  <param name='szGenericString1_DL01'>value</param>
  <param name='szGenericString2_DL02'>value</param>
  <param name='mnProcessID'>value</param>
  <param name='mnTransactionID'>value</param>
 <params/>
 <onError abort='no'>\
  <callMethod name='F4211ClearWorkFile' app='NetCommerce' runOnError='yes'>
   <params>
    <param name='mnJobNo' idref='j1'></param>
    <param name='szComputerID' idref='2'></param>
    <param name='mnFromLineNo'>value</param>
    <param name='mnThruLineNo'>value</param>
    <param name='cClearHeaderWF'>value</param>
    <param name='cClearDetailWF'>value</param>
    <param name='szProgramID'>value</param>
    <param name='mnWKRelatedOrderProcess'>value</param>
    <param name='szCMVersion'>value</param>
    <param name='cGenericChar1_EV01'>value</param>
    <param name='szGenericString1_DL01'>value</param>
    <param name='mnSODRelatedJobNumber'>value</param>
    <param name='mnProcessID'>value</param>
    <param name='mnTransactionID'>value</param>
   </params>
  </callMethod>
 </onError>
</callMethod>
<returnParams version='value' messagetype='messsage name' 
failureDestination='queuename' successDestination='queuename>
  <param name='long description' idref='value'/param>
</returnParams>
<onError>
 <callMethod name='F4211ClearWorkFile' app='NetCommerce' runOnError='yes'>
  <params>
    <param name='mnJobNo' idref='j1'></param>
    <param name='szComputerID' idref='2'></param>
    <param name='mnFromLineNo'>value</param>
    <param name='mnThruLineNo'>value</param>
    <param name='cClearHeaderWF'>value</param>
    <param name='cClearDetailWF'>value</param>
    <param name='szProgramID'>value</param>
    <param name='mnWKRelatedOrderProcess'>value</param>
    <param name='szCMVersion'>value</param>
    <param name='cGenericChar1_EV01'>value</param>
    <param name='szGenericString1_DL01'>value</param>
    <param name='mnProcessID'>value</param>
    <param name='mnTransactionID'>value</param>
  </params>
 </callMethod>
</onError>
</jdeRequest>

Outbound XML Request and Response Format (All Parameters)

This section provides example request and response code that illustrate the outbound XML Format with all of the parameters.

Request

This format returns all columns for the F0101Z2 table:

<?xml version='1.0' ?>
<jdeRequest type='trans' user='user' pwd='password' environment='environment' 
role='*ALL' session='' sessionidle='300'>
  <transaction action='transactionInfo' type='JDEAB'>
            <key>
                <column name='EdiUserId'>value</column>
                <column name='EdiBatchNumber'>value</column>
                <column name='EdiTransactNumber'>value</column>
            </key>
  </transaction>
</jdeRequest>

Response

This sample code shows the response for the request:

<?xml version='1.0' encoding='utf-8' ?>
<jdeResponse type='trans' user='user' session='session'  environment='env'>
  <transaction type='JDEAB' action='transactionInfo'>
       <returnCode code='0'>XML Request OK</returnCode>
      <key>
                <column name='EdiUserId'></column>
                <column name='EdiBatchNumber'></column>
      </key>
      <table name='F0101Z2' type='detail'>
        <column name='EdiUserId'></column>
        <column name='EdiBatchNumber'></column>
        <column name='EdiTransactNumber'></column>
        <column name='EdiLineNumber'></column>
        <column name='EdiDocumentType'></column>
        <column name='TypeTransaction'></column>
        <column name='EdiTranslationFormat'></column>
        <column name='EdiTransmissionDate'></column>
        <column name='DirectionIndicator'></column>
        <column name='EdiDetailLinesProcess'></column>
        <column name='EdiSuccessfullyProcess'></column>
        <column name='TradingPartnerId'></column>
        <column name='TransactionAction'></column>
        <column name='AddressNumber'></column>
        <column name='AlternateAddressKey'></column>
        <column name='TaxId'></column>
        <column name='NameAlpha'></column>
        <column name='DescripCompressed'></column>
        <column name='CostCenter'></column>
        <column name='StandardIndustryCode'></column>
        <column name='LanguagePreference'>< /column>
        <column name='AddressType1'></column>
        <column name='CreditMessage'></column>
        <column name='PersonCorporationCode'></column>
        <column name='AddressType2'></column>
        <column name='AddressType3'></column>
        <column name='AddressType4'></column>
        <column name='AddressTypeReceivables'></column>
        <column name='AddressType5'></column>
        <column name='AddressTypePayables'></column>
        <column name='AddTypeCode4Purch'></column>
        <column name='MiscCode3'></column>
        <column name='AddressTypeEmployee'></column>
        <column name='SubledgerInactiveCode'></column>
        <column name='DateBeginningEffective'></column>
        <column name='AddressNumber1st'></column>
        <column name='AddressNumber2nd'></column>
        <column name='AddressNumber3rd'></column>
        <column name='AddressNumber4th'></column>
        <column name='AddressNumber6th'></column>
        <column name='AddressNumber5th'></column>
        <column name='ReportCodeAddBook001'></column>
        <column name='ReportCodeAddBook002'></column>
        <column name='ReportCodeAddBook003'></column>
        <column name='ReportCodeAddBook004'></column>
        <column name='ReportCodeAddBook005'></column>
        <column name='ReportCodeAddBook006'></column>
        <column name='ReportCodeAddBook007'></column>
        <column name='ReportCodeAddBook008'></column>
        <column name='ReportCodeAddBook009'></column>
        <column name='ReportCodeAddBook010'></column>
        <column name='ReportCodeAddBook011'></column>
        <column name='ReportCodeAddBook012'></column>
        <column name='ReportCodeAddBook013'></column>
        <column name='ReportCodeAddBook014'></column>
        <column name='ReportCodeAddBook015'></column>
        <column name='ReportCodeAddBook016'></column>
        <column name='ReportCodeAddBook017'></column>
        <column name='ReportCodeAddBook018'></column>
        <column name='ReportCodeAddBook019'></column>
        <column name='ReportCodeAddBook020'></column>
        <column name='CategoryCodeAddressBook2'></column>
        <column name='CategoryCodeAddressBk22'></column>
        <column name='CategoryCodeAddressBk23'></column>
        <column name='CategoryCodeAddressBk24'></column>
        <column name='CategoryCodeAddressBk25'></column>
        <column name='CategoryCodeAddressBk26'></column>
        <column name='CategoryCodeAddressBk27'></column>
        <column name='CategoryCodeAddressBk28'></column>
        <column name='CategoryCodeAddressBk29'></column>
        <column name='CategoryCodeAddressBk30'></column>
        <column name='GlBankAccount'></column>
        <column name='TimeScheduledIn'></column>
        <column name='DateScheduledIn'></column>
        <column name='ActionMessageControl'></column>
        <column name='NameRemark'></column>
        <column name='CertificateTaxExempt'></column>
        <column name='TaxId2'></column>
        <column name='Kanjialpha'></column>
        <column name='UserReservedCode'></column>
        <column name='UserReservedDate'></column>
        <column name='UserReservedAmount'></column>
        <column name='UserReservedNumber'></column>
        <column name='UserReservedReference'></column>
        <column name='NameMailing'></column>
        <column name='SecondaryMailingName'></column>
        <column name='AddressLine1'></column>
        <column name='AddressLine2'></column>
        <column name='AddressLine3'></column>
        <column name='AddressLine4'></column>
        <column name='ZipCodePostal'></column>
        <column name='City'></column>
        <column name='Country'></column>
        <column name='State'></column>
        <column name='CountyAddress'></column>
        <column name='PhoneAreaCode1'></column>
        <column name='PhoneNumber'></column>
        <column name='PhoneNumberTyp1'></column>
        <column name='PhoneAreaCode2'></column>
        <column name='PhoneNumber1'></column>
        <column name='PhoneNumberTyp2'></column>
        <column name='TransactionOriginator'></column>
        <column name='UserId'></column>
        <column name='ProgramId'></column>
        <column name='WorkStationId'></column>
        <column name='DateUpdated'></column>
        <column name='TimeOfDay'></column>
        <column name='TimeLastUpdated'></column>
      </table>
  </transaction>
</jdeResponse>