integration methodology document - · pdf fileintegration methodology document: ... example...

Integration Methodology Document:

Point of Sale Integration with the Oracle Small Business Suite

Rev: FINAL 2.2 Date: NOVEMBER 11, 2001

Purpose This document provides information regarding smbXML based integration between the Oracle Small Business Suite(OSBS) and third-party Point of Sale(POS) applications. This document presents several models of how third-party POS applications may be integrated with the Oracle Small Business Suite for the benefit of users of both systems.

of 17

POS INTEGRATION

Contents PURPOSE ..............................................................................................................................................................................1

CONTENTS...........................................................................................................................................................................2

OVERVIEW..........................................................................................................................................................................3

GETTING CONNECTED ..................................................................................................................................................4 ACCOUNT MAPPING WITH SINGLE SIGNON........................................................................................................................5 SINGLE SIGNON ...................................................................................................................................................................6 REVERSE SINGLE SIGNON ...................................................................................................................................................6

SETUP AND SYNCHRONIZATION...............................................................................................................................6 DEFAULT SETUP ..................................................................................................................................................................6 ITEM LIST SYNCHRONIZATION............................................................................................................................................7 CUSTOMER LIST SYNCHRONIZATION .................................................................................................................................7

DATA EXCHANGE.............................................................................................................................................................7 ITEM SYNCHRONIZATION ....................................................................................................................................................8 CUSTOMER SYNCHRONIZATION..........................................................................................................................................8 CASH SALES.........................................................................................................................................................................8 INVOICES..............................................................................................................................................................................9 SALES ORDERS ....................................................................................................................................................................9 WORKFLOW SYNCHRONIZATION......................................................................................................................................10

Scenario 1 – OSBS Sales Order is Repository ............................................................................................................10 Scenario 2 – POS System Sales Order is Repository..................................................................................................10 Scenario 3 – Document Transformation .....................................................................................................................11

CREDIT CARD/PAYMENT PROCESSING.............................................................................................................................11 DATA EXCHANGE EXAMPLES..................................................................................................................................11

ITEM LISTS .........................................................................................................................................................................11 CUSTOMER RECORD..........................................................................................................................................................13 TRANSACTIONS..................................................................................................................................................................14

Example Sales Order Import........................................................................................................................................14 Example Cash Sale Import...........................................................................................................................................15 Example Invoice Import ...............................................................................................................................................16

of 17

POS INTEGRATION

Overview The integration of the Oracle Small Business Suite with a POS application extends the mutual functionality of both applications by providing a complete business management solution to users of either application by eliminating double data entry from system to system.

The following diagram presents a high level overview of the various integration points possible between the Oracle Small Business Suite and a POS application.

of 17

POS INTEGRATION

Cus

tom

er a

nd It

em L

ists

Cus

tom

er a

nd It

em L

ists

OSBS POS Integration Data Flow Model

POS ApplicationOracle Small Business Suite

Item List1

5

2

ClosedAuction

ClosedAuction

Sales Order

3Cash Sale

CustomerList

Add. Cust.Data

Recv. Pmt.

Cash Sale

CustomerList

Item List

AdditionalItem Data

Cash Sale Cash Sale

Recv. Pmt.

ClosedAuction

ClosedAuction

Sales Order

6

7

4Invoice Invoice

Recv. Pmt.

8InvoiceInvoice

Recv. Pmt.

Fulfilment ProcessFulfilment Process

Getting Connected Before data can be exchanged between the Oracle Small Business Suite and the third-party POS, the user must have accounts in both applications, and the two accounts must be mapped. The Oracle Small Business Suite uses NetLedger’s proprietary, patent-pending, secure and reliable Single Signon

of 17

POS INTEGRATION

(SSO) technology to accomplish initial account creation (if required) and account mapping. Single Signon is therefore used to accomplish two key goals with respect to POS integration with the Oracle Small Business Suite:

1. establishes the account mapping between the Oracle Small Business Suite and the POS partner’s application

2. allows the user to move seamlessly from the POS application into the user’s Oracle Small Business Suite

Once the accounts are mapped, a small amount of user setup is required before live data exchange can commence.

ACCOUNT MAPPING WITH SINGLE SIGNON Here is a brief overview of account mapping between the Oracle Small Business Suite and the POS partner’s application using SSO technology. Complete information on NetLedger’s Single Signon technology can be found in the Single Signon Developer’s Guide.

Account mapping is a one to one relationship between the user’s account in the partner application and the OSBS. The process flow below assumes that this is the initial hand-off of the end user from the partner site to the OSBS.

SSO account mapping works as follows:

• user authenticates at the partner site • a Single Signon link to the OSBS is then made available within the secure area of the partner site • the user clicks the SSO link on the partner site and is redirected, under SSL, to the OSBS Single

Signon landing page (1 below)

AuthenticatedPartner Site

OSB Single SignonLanding Page

Initial Browser Redirect

XML Request for Signup Data

XML Response with Signup Data

XML Confirmation of Signup

XML Acknowledgement of Confirmation

1

3

5

4

2

• the OSBS Single Signon landing page allows the user to log into an existing account or sign up for

a new account 1. users with an existing account will log in using their e-mail and password

• the user’s OSBS account info is noted and a Partner Mapping Table (PMT) entry is made linking the user’s two accounts

• an XML confirmation of signup is sent to the partner’s servers (4 above) • the partner acknowledges the confirmation with an XML response (5 above)

o users without an OSBS account may create a new account • the OSBS Single Signon Servers will request signup data detailing the user’s

name, address, phone, etc. (2 above)

of 17

POS INTEGRATION

• if the partner responds to the signup data request within fourteen seconds (3 above), the user will be presented with a pre-populated OSBS signup page; otherwise, the user will be presented with a blank OSBS signup page and registration will continue

• the user’s OSBS account info is noted and a Partner Mapping Table (PMT) entry is made linking the user’s two accounts

• an XML confirmation of signup is sent to the partner’s servers (4 above) • the partner acknowledges the confirmation with an XML response (5 above)

SINGLE SIGNON Assuming that Single Signon account mapping has occurred, as described above, users may move freely from the POS application into the Oracle Small Business Suite.

• user authenticates at POS application site • user selects Oracle Small Business Suite link from POS application site • user is re-directed to Oracle Small Business Suite and is automatically logged in to their previously

integrated account without prompting for account or password

REVERSE SINGLE SIGNON Assuming that the POS application was deployed as a Web application, Reverse Single Signon would allow a Oracle Small Business Suite user to move freely from their OSBS into the integrated POS application. Reverse Single Signon will be made available in the future to key strategic partners.

Assuming that Reverse Single Signon account mapping has occurred, as described above, users may move freely from their OSBS into their POS application.

• user authenticates at Oracle Small Business Suite site • user selects POS application link from their OSBS • user is re-directed to their POS application and is automatically logged in to their previously

integrated account without prompting for account or password

Setup and Synchronization Now that the accounts are mapped, a small amount of setup is required before live data exchange can commence.

DEFAULT SETUP The synchronization of item lists will require preferences to be set in the Oracle Small Business Suite for default chart of accounts selections. Some example settings are:

Setup > Set Up XML Import • Item Income Account • Assets Account • Cost of Goods Sold Account • Store Tax Item

of 17

POS INTEGRATION

• Cash Sales Account • Custom Form

ITEM LIST SYNCHRONIZATION The transmission of item information from the POS to the Oracle Small Business Suite appears as reference 1 in the OSBS POS Integration Data Flow Model diagram from the Overview section above.

Item list synchronization assures that transactions that subsequently make reference to particular items will not fail due to missing references. Additionally, the POS application may not have all the item fields that are available in, and used by, the Oracle Small Business Suite (for example: shipping weight). Importing items prior to initiating data exchange allows time to manually adjust/add item data to the records in the Oracle Small Business Suite. In this manner, the first cash sales/sales orders/invoices that are imported will properly decrement inventory on hand, etc.

• user authenticates at POS application site • user selects ‘Export Items to Oracle Small Business Suite’ option • the POS application generates smbXML Item List document and transmits to OSBS XML server • user selects Oracle Small Business Suite SSO link from POS application site • user is re-directed to Oracle Small Business Suite and is automatically logged in to their previously

integrated account • user navigates to the Lists tab and selects Items • user confirms items imported from POS application

CUSTOMER LIST SYNCHRONIZATION The transmission of customer information from the POS to the Oracle Small Business Suite appears as reference 2 in the OSBS POS Integration Data Flow Model diagram from the Overview section above.

Customer list synchronization assures that transactions that subsequently make reference to particular customers will not fail due to missing references. Customer data may be brought over at the time of the transaction import, or may be synchronized once initially, and then updated on the fly as new customer records are created.

Additionally, there are several Customer Relationship Management(CRM)/Sales Force Automation(SFA) features in the Oracle Small Business Suite that rely heavily upon the existence of customer records. Bringing over your customer list is the first step in taking advantage of these fully integrated, robust features.

• user authenticates at POS application site • user selects ‘Export Customers to Oracle Small Business Suite’ option • the POS application generates smbXML Item List document and transmits to OSBS XML server • user selects Oracle Small Business Suite SSO link from POS application site • user is re-directed to Oracle Small Business Suite and is automatically logged in to their previously

integrated account • user navigates to the Lists tab and selects Customers • user confirms customers imported from the POS application

Data Exchange All data exchange between the Oracle Small Business Suite and the POS application will occur using smbXML documents transmitted over a 128-bit Secure Socket Layer (SSL) connection.

of 17

POS INTEGRATION

Detailed information regarding server to server data exchange with the Oracle Small Business Suite can be found in NetLedger’s Server to Server Developer’s Guide. Detailed information regarding smbXML and associated DTDs and sample documents can be found on the Oracle Small Business Suite portal under Technical Documentation in the Developer Program.

Depending on the native features and functionality provided by the POS application, varying levels of integration with the Oracle Small Business Suite are possible using the smbXML interface. Following are several scenarios describing possible user experiences for different levels of integration. It is noted here, and below as appropriate, that some of the integration functionality is forward looking, and is presented in order to demonstrate capabilities that could be implemented in phases, as they become available.

ITEM SYNCHRONIZATION Synchronization of item information from the POS to the Oracle Small Business Suite appears as reference 1 in the OSBS POS Integration Data Flow Model diagram from the Overview section above.

Item synchronization was first presented in the Setup and Synchronization section and is a recommended task before data exchange. However, item synchronization is also a task that will most likely be undertaken throughout the integration lifecycle.

CUSTOMER SYNCHRONIZATION Synchronization of customer information from the POS to the Oracle Small Business Suite appears as reference 2 in the OSBS POS Integration Data Flow Model diagram from the Overview section above.

Customer synchronization was first presented in the Setup and Synchronization section and is a recommended task before data exchange. However, customer synchronization is also a task that will most likely be undertaken throughout the integration lifecycle.

CASH SALES

Cash sale data exchange appears as reference 3 in the OSBS POS Integration Data Flow Model diagram from the Overview section above.

This transaction will be used where the Point of Sale application is used to manage the order fulfillment process and payment capture simultaneously (e.g. a retail store cash transaction, or as the final step in a sales order process that took place in the POS application). In this scenario, Oracle Small Business Suite acts as a data repository once the Point of Sale order has been fulfilled and charged.

This is one of the easiest ways of getting sales and related accounting data into the Oracle Small Business Suite. The advantage of cash sale import is that it is simple. For each sale made in the POS system, post fulfillment and charge, a cash sale record is immediately created in the Oracle Small Business Suite. At the time the cash sale is created in the Oracle Small Business Suite, the customer and inventory level records are created/updated for the sale as necessary.

The drawback of this implementation is that it does not take advantage of the Oracle Small Business Suite’s integrated CRM, SFA, order processing and fulfillment capabilities. The user has managed the charge and fulfillment processes entirely from within the POS application.

• user performs fulfillment process and payment capture at Point of Sale application • upon completion of payment capture in Point of Sale application, cash sale information will be

transmitted to Oracle Small Business Suite 1. cash sale will be used for orders that are paid for by cash, check or credit card

of 17

POS INTEGRATION

2. payment information will be included in the Cash Sale transaction 3. Oracle Small Business Suite will perform the appropriate accounting entries and update

inventory count, cost of goods sold and income accounts as appropriate • user logs in to the Oracle Small Business Suite • user uses the Oracle Small Business Suite financial, COGS, inventory, etc. reports to monitor and

report on the health of their business

INVOICES

Invoice data exchange appears as reference 4 in the OSBS POS Integration Data Flow Model diagram from the Overview section above.

This transaction will be used where the Point of Sale application is used to manage the order fulfillment process, however payment capture will be managed in the Oracle Small Business Suite (e.g. a retail store transaction involving a repeat customer on terms). In this scenario, Oracle Small Business Suite acts as a data repository and A/R processing system once the Point of Sale order has been fulfilled.

The advantage of invoice import is that it is simple, but allows a POS system to leverage the A/R processes supported by the Oracle Small Business Suite. For each sale made on terms in the POS system, an invoice is immediately created in the Oracle Small Business Suite. At the time the invoice is created in the Oracle Small Business Suite, the customer and inventory level records are created/updated for the sale as necessary.

The drawback of this implementation is that it only partially takes advantage of the Oracle Small Business Suite – it does not take advantage of the integrated CRM, SFA, order processing and fulfillment capabilities.

• user performs fulfillment process for transaction on terms at Point of Sale application • upon recording fulfillment in the Point of Sale application, invoice information will be transmitted to

Oracle Small Business Suite 1. invoice will be used for orders that are on terms 2. Oracle Small Business Suite will perform the appropriate accounting entries and update

inventory count, cost of goods sold and income accounts as appropriate • user logs in to the Oracle Small Business Suite • user uses the Oracle Small Business Suite A/R processes to bill for and receive payments for

goods and services captured at the POS application • user uses the Oracle Small Business Suite financial, COGS, inventory, etc. reports to monitor and

report on the health of their business

SALES ORDERS

Sales order data exchange appears as reference 5 in the OSBS POS Integration Data Flow Model diagram from the Overview section above.

The Oracle Small Business Suite is updated with information about the POS order immediately upon its receipt by the POS application. At the time the sales order is created in the Oracle Small Business Suite, a customer record is created/updated for the sale. The user will manage the fulfillment process entirely from within the Oracle Small Business Suite.

The advantage of importing sales orders is that it allows the user to take full advantage of the integrated CRM, SFA, order processing and fulfillment capabilities of the Oracle Small Business Suite.

A current limitation of sales order import is that sales orders may not be queried or updated by the POS system once transmitted. This means that if the POS system supports invoices, it will not be able to

of 17

POS INTEGRATION

automatically stay in sync with the invoice in the Oracle Small Business Suite. Providing query and update capabilities for sales orders is on the smbXML roadmap and is a high priority, thus, a second phase implementation would be to allow the POS application to be able to perform queries in order to receive periodic updates of status (if required).

• user captures sale at POS application • immediately, sales order information will be transmitted to Oracle Small Business Suite

1. payment information may be included in the sales order transaction • user logs in to the Oracle Small Business Suite • user clicks ‘X Sales Orders to Approve/Process’ reminder from home page • user approves sales order • user prints picketing ticket • user processes sales order and charges credit card (if appropriate) • user prints packing slip

WORKFLOW SYNCHRONIZATION

Workflow data exchange appears as reference 6 in the OSBS POS Integration Data Flow Model diagram from the Overview section above.

Workflow synchronization relies upon the ability to update transactions in the Oracle Small Business Suite via smbXML requests. Currently, the ability to update transactions is not implemented. However, transaction update is expected to be available soon, and therefore this section is presented in order to demonstrate future phases of integration.

Scenario 1 – OSBS Sales Order is Repository

In this scenario, the Oracle Small Business Suite acts as a repository, with the active sales order processing taking place in the POS system. The Oracle Small Business Suite is updated with information about the POS order immediately and receives continuous updates during its workflow lifecycle in the POS application.

• user works with sales order in POS application – modify/update status • upon submission of each change the POS application transmits updated sales order information to

the Oracle Small Business Suite • the Oracle Small Business Suite updates its copy of the sales order to reflect the new

information/status

Scenario 2 – POS System Sales Order is Repository

In this scenario, the POS application acts as a repository, with the active sales order processing taking place in the Oracle Small Business Suite. The POS system queries status information about the sales order in the Oracle Small Business Suite and uses the updates to either keep a copy in the POS application in sync with that of the Oracle Small Business Suite, or to simply provide status from within the POS system.

• user works with sales order in the Oracle Small Business Suite – modify/update status • the POS application requests updates from the Oracle Small Business Suite on the sales order • the POS system updates its copy of the sales order to reflect the new information/status, or simply

provides status from within the POS system

of 17

POS INTEGRATION

Scenario 3 – Document Transformation

Sales Orders in the Oracle Small Business Suite are records which eventually generate either a cash sale or an invoice. Document transformation data exchange appears as references 7 and 8 in the OSBS POS Integration Data Flow Model diagram from the Overview section above.

There are several possible branches in this scenario. As this is the most forward looking part of this document, it is thus the most difficult to talk about precisely. Some possibilities are listed below.

1. if the OSBS is acting as a repository, as in Scenario 1 above, the POS system could cause the Oracle Small Business Suite to generate a cash sale or invoice for a sales order that had previously been transmitted from the POS system

2. if the POS system is acting as the repository, as in Scenario 2 above, the POS system could query the Oracle Small Business Suite to discover that the sales order has generated a cash sale or invoice for a sales order that had previously been transmitted from the POS system

CREDIT CARD/PAYMENT PROCESSING Credit card processing data exchange is relevant in a number of places in the OSBS POS Integration Data Flow Model diagram from the Overview section above. The key points to understand are:

• where the user is using the POS application to process payments for their orders, but is using the Oracle Small Business Suite to manage the fulfillment process, they will login to the POS application and manually perform the payment capture process once the order has been fulfilled in the Oracle Small Business Suite

• a planned enhancement to the smbXML specification would allow for the querying of the status of orders fulfilled in the Oracle Small Business Suite, which would then allow the POS application to automatically initiate a charge for shipped goods – assuming the user’s merchant processing was to be accomplished through the POS application

Data Exchange Examples

ITEM LISTS Item lists are the starting point for data-exchange between the two applications. Below is an example of the type of data that would be imported into the Oracle Small Business Suite from the POS application, as discussed in the Getting Connected section.

Example Item List Import:

<?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE smbxml PUBLIC "-//SMBXML//DTD SMBXML 2.50//EN" "<put local path here>/smb_2_50.dtd"> <smbxml> <request handle="add1"> <addOrUpdate> <inventoryItem handle="item1"> <name>sku85269</name> <displayName>Widgets</displayName> <isOnline>true</isOnline> <purchaseDescription>Widgets</purchaseDescription> <cost>15.00</cost> <cogsAccountRef> <name>Cost of Goods Sold</name> </cogsAccountRef> <vendorHandle handle="vend1"/> <salesDescription>Quality Widgets</salesDescription> <incomeAccountRef>

of 17

POS INTEGRATION

<name>Sales</name> </incomeAccountRef> <salesPrice1>30.00</salesPrice1> <salesPrice2>29.99</salesPrice2> <salesPrice3>32.50</salesPrice3> <salesPrice4>25.00</salesPrice4> <onlinePrice>27.50</onlinePrice> <assetAccountRef> <name>Inventory</name> </assetAccountRef> <quantityOnHand>10</quantityOnHand> <totalValue>150.00</totalValue> <reorderPoint>4</reorderPoint> <weight>1.5</weight> <weightUnitRef> <name>lb</name> </weightUnitRef> <isTaxable>true</isTaxable> <isInactive>false</isInactive> <storeDisplayName>Quality Widgets</storeDisplayName> <storeCategoryList> <storeCategoryRef> <name>Gadgets</name> </storeCategoryRef> </storeCategoryList> <storeDescription>Quality Widgets</storeDescription> <storeDisplayThumbnailRef> <name>widg.jpg</name> </storeDisplayThumbnailRef> <storeDetailedDescription>Quality Widgets</storeDetailedDescription> <storeDisplayImageRef> <name>widg.gif</name> </storeDisplayImageRef> <onSpecial>true</onSpecial> <specialsDescription>Quality Widgets</specialsDescription> <isFeatured>false</isFeatured> <featuredDescription>Quality Widgets</featuredDescription> </inventoryItem> </addOrUpdate> </request> </smbxml>

Alternatively, the POS application may perform a query in a specific Oracle Small Business Suite that will return the item list information for that account.

Example Item List Query:

<?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE smbxml PUBLIC "-//SMBXML//DTD SMBXML 2.50//EN" "<put local path here>/smb_2_50.dtd"> <smbxml> <request handle="querynoninvt"> <listQuery> <listType>nonInventoryItem</listType> </listQuery> </request> <request handle="queryinvt"> <listQuery> <listType>inventoryItem</listType> <constraints> <isInactive>false</isInactive> </constraints> </listQuery> </request> </smbxml>

of 17

POS INTEGRATION

Example Response to Item List Query:

<?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE smbxml PUBLIC "-//SMBXML//DTD SMBXML 2.50//EN" "<put local path here>/smb_2_50.dtd"> <smbxml> <response requestHandle="queryinvt" requestType="listQuery"> <inventoryItem handle="item1"> <name>sku85269</name> <displayName>Widgets</displayName> <isOnline>T</isOnline> <purchaseDescription>Widgets</purchaseDescription> <cost>15</cost> <cogsAccountRef> <name>Cost of Goods Sold</name> </cogsAccountRef> <vendorHandle handle="vend1"/> <salesDescription>Quality Widgets</salesDescription> <incomeAccountRef> <name>Sales</name> </incomeAccountRef> <assetAccountRef> <name>Inventory</name> </assetAccountRef> <quantityOnHand>10</quantityOnHand> <totalValue>150</totalValue> <reorderPoint>4</reorderPoint> <weight>1.5</weight> <weightUnitRef> <name>lb</name> </weightUnitRef> <isTaxable>T</isTaxable> <isInactive>F</isInactive> <storeDisplayName>Quality Widgets</storeDisplayName> <storeDescription>Quality Widgets</storeDescription> <storeDetailedDescription>Quality Widgets</storeDetailedDescription> <onSpecial>T</onSpecial> <specialsDescription>Quality Widgets</specialsDescription> <isFeatured>F</isFeatured> </inventoryItem> </response> </smbxml>

CUSTOMER RECORD Customer information will be transmitted, to the Oracle Small Business Suite, in the same smbXML document as the sale transaction (see below).

The POS will send an <addOrUpdate> request in the smbXML document with the customer record details. The customer record will subsequently be referenced by the sales transaction.

Example Customer Record Import:

<?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE smbxml PUBLIC "-//SMBXML//DTD SMBXML 2.50//EN" "<put local path here>/smb_2_50.dtd"> <smbxml> <request handle="addcust1"> <addOrUpdate> <customer handle="JD1"> <name>John Doe</name> <company>John Doe</company> <categoryRef> <name>Referral</name>

of 17

POS INTEGRATION

</categoryRef> <salesRepHandle handle="SS"/> <contactHandle handle="jd"/> <email>[email protected]</email> <isEmailHTML>true</isEmailHTML> <phone>415-555-1212</phone> <fax>415-555-1313</fax> <altPhone>415-555-1000</altPhone> <altContactHandle handle="ac"/> <notes>good customer</notes> <line1>123 Main Street</line1> <line2>Suite A</line2> <city>Any Town</city> <state>CA</state> <zipCode>94444</zipCode> <country>USA</country> <billAddress>123 MainStreet Suite A AnyTown CA 94444</billAddress> <shipAddress>same as bill address</shipAddress> <accountNumber>1598745</accountNumber> <termsRef> <name>Net 30</name> </termsRef> <creditLimit>1000</creditLimit> <resaleNumber>97-9652145</resaleNumber> <priceLevelRef> <name>Sales Price 1</name> </priceLevelRef> <isTaxable>true</isTaxable> <taxItemHandle handle="ca"/> <isInactive>false</isInactive> </customer> </addOrUpdate> </request> </smbxml>

TRANSACTIONS Depending on the depth of the integration being deployed and/or the agreed upon integration points, the POS application might transmit one or more transaction types to the Oracle Small Business Suite.

The appropriate transaction types are:

• Sales Order – Cash Sale • Sales Order – Invoice • Cash Sale • Invoice

Upon receiving an order, the POS application can send an <add> transaction request to the Oracle Small Business Suite with details of the order transaction (and any additional payment or shipping information as required).

The smbXML document that is transmitted in this scenario will include both sales and customer information. Optionally, it could also include item information if the ordered item has been created in the POS application in the first instance and not yet synchronized with the Oracle Small Business Suite.

Example Sales Order Import <?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE smbxml PUBLIC "-//SMBXML//DTD SMBXML 2.50//EN" "<put local path here>/smb_2_50.dtd">

of 17

POS INTEGRATION

<smbxml> <request handle="so1"> <add> <salesOrder handle="tran1"> <customFormRef>Sales Order - Invoice</customFormRef> <tranId>100</tranId> <customerHandle handle="JD1"/> <postDate>09/06/2001</postDate> <toBePrinted>true</toBePrinted> <toBeEmailed>true</toBeEmailed> <email>[email protected]</email> <toBeFaxed>true</toBeFaxed> <fax>415-555-1313</fax> <memo>Deliver to back door</memo> <billAddress>123 Main Street Suite A AnyTown CA 94444</billAddress> <shipAddress>same as bill address</shipAddress> <checkPayment> <checkNumber>1055</checkNumber> </checkPayment> <shipMethodRef> <name>Truck</name> </shipMethodRef> <shipDate>09/07/2001</shipDate> <customerMessageRef> <name>Thank you for your business</name> </customerMessageRef> <salesRepHandle handle="SS"/> <termsRef> <name>Net 30</name> </termsRef> <departmentRef> <name>Widget Sales</name> </departmentRef> <classRef> <name>new business</name> </classRef> <isTaxable>true</isTaxable> <itemList> <itemLine> <itemHandle handle="tem1"/> <quantity>100</quantity> <salesPrice>30.00</salesPrice> <description>Quality Widget</description> <isTaxable>True</isTaxable> <priceLevelRef> <name>Sales Price 1</name> </priceLevelRef> </itemLine> </itemList> </salesOrder> </add> </request> </smbxml>

Example Cash Sale Import <?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE smbxml PUBLIC "-//SMBXML//DTD SMBXML 2.50//EN" "<put local path here>/smb_2_50.dtd"> <smbxml> <request handle="cs2"> <add> <cashSale handle="tran2"> <customFormRef>Custom Cash Sale 1</customFormRef> <tranId>200</tranId> <customerHandle handle="JD1"/> <postDate>09/06/2001</postDate>

of 17

POS INTEGRATION

<toBePrinted>true</toBePrinted> <toBeEmailed>true</toBeEmailed> <email>[email protected]</email> <toBeFaxed>true</toBeFaxed> <fax>415-555-1313</fax> <memo>Deliver to back door - COD</memo> <billAddress>123 Main Street Suite A AnyTown CA 94444</billAddress> <shipAddress>same as bill address</shipAddress> <depositAccountRef> <name>Checking</name> </depositAccountRef> <creditCardPayment> <ccType>Visa</ccType> <ccNumber>4512652145896321</ccNumber> <ccExpireDate>05/01/2002</ccExpireDate> <ccName>John Doe</ccName> <ccStreet>123 Main Street</ccStreet> <ccZipCode>94444</ccZipCode> <ccApproved>true</ccApproved> </creditCardPayment> <shipMethodRef> <name>UPS</name> </shipMethodRef> <shipDate>09/07/2001</shipDate> <customerMessageRef> <name>Thank you for your business</name> </customerMessageRef> <salesRepHandle handle="SS"/> <departmentRef> <name>Widget Sales</name> </departmentRef> <classRef> <name>new business</name> </classRef> <isTaxable>true</isTaxable> <itemList> <itemLine> <itemHandle handle="tem1"/> <quantity>100</quantity> <salesPrice>30.00</salesPrice> <description>Quality Widget</description> <isTaxable>True</isTaxable> <priceLevelRef> <name>Sales Price 1</name> </priceLevelRef> </itemLine> </itemList> </cashSale> </add> </request> </smbxml>

Example Invoice Import <?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE smbxml PUBLIC "-//SMBXML//DTD SMBXML 2.50//EN" "<put local path here>/smb_2_50.dtd">

<!-- This SMBXML example shows how to add Invoices. There are some references that must exist in your account for these examples to work. Vendor Category: 'Supplies' (Lists> Other Lists> Vendor Category) Expense Account: 'Supplies Expense' (Lists> Accounts) Terms: 'Net 30' (Lists> Other Lists> Terms) Department: 'Sales' (Lists> Departments) Store Categories: 'Breakfast', 'Lunch' (Lists> Store/Site Categories)

of 17

POS INTEGRATION

Shipping Method: 'UPS' (Lists> Shipping Items) Bank Account: 'Checking' (Lists> Accounts)

--> <smbxml>

<request handle="tran3"> <add>

<invoice handle="IN5089"> <customFormRef>Standard Product Invoice</customFormRef> <tranId>5089</tranId> <customerHandle handle="BTS" /> <postDate>04/16/01</postDate> <toBePrinted>true</toBePrinted> <billAddress>Bailey's Training Services 950 E. Algonquin Road

Arlington Heights IL 60005</billAddress> <shipMethodRef>

<name>UPS</name> </shipMethodRef> <shipDate>04/16/01</shipDate> <termsRef>

<name>Net 30</name> </termsRef> <otherRefNum>PO #A52417</otherRefNum> <itemList>

<itemLine> <itemHandle handle="BasicPlus" /> <quantity>1</quantity> <salesPrice>55.25</salesPrice> <description>Coffee, decaf, juice, fruit, pastry,

muffins</description> </itemLine> <itemLine>

<itemHandle handle="Serving" /> <quantity>3</quantity> <salesPrice>20.00</salesPrice> <description>Server</description>

</itemLine> </itemList>

</invoice> </add>

</request> </smbxml>

of 17

integration methodology document - · pdf fileintegration methodology document: ... example...

Documents