Difference between revisions of "Fishbowl API"

From Fishbowl
Jump to navigation Jump to search
Line 1: Line 1:
 
Just as Fishbowl integrates with QuickBooks, we allow developers to integrate their own software with Fishbowl. The Fishbowl API allows users to log in from third-party applications. These applications can run certain procedures when connected to the Fishbowl Server. This provides developers with the connection they need to customize applications to meet your business's specific needs. The API also has the responsibility to validate and process the requests that are sent to it from third-party integrated applications and send the response back.
 
Just as Fishbowl integrates with QuickBooks, we allow developers to integrate their own software with Fishbowl. The Fishbowl API allows users to log in from third-party applications. These applications can run certain procedures when connected to the Fishbowl Server. This provides developers with the connection they need to customize applications to meet your business's specific needs. The API also has the responsibility to validate and process the requests that are sent to it from third-party integrated applications and send the response back.
  
The Fishbowl API provides integration with the data and objects stored on the Fishbowl Server. When scoping out a potential application, it would be beneficial to view the [http://www.fishbowlinventory.com/developer-network/tools/ developer tools] and the documentation below to verify that the data and requests you need are accessible through the API. All of the documentation and examples were obtained by using the demo Fishbowl database and the [[Fishbowl Developer Hook]]. When connecting to the Fishbowl API you will need to create a socket connection to the port and maintain that connection for the life of the API session. We do have some very basic [http://www.fishbowlinventory.com/developer-network/tools/ sample code] available to demonstrate how to make a connection in Java and C#.
+
The Fishbowl API provides integration with the data and objects stored on the Fishbowl Server. When scoping out a potential application, it would be beneficial to view the [http://www.fishbowlinventory.com/developer-network/tools/ developer tools] and the documentation below to verify that the data and requests you need are accessible through the API. All of the documentation and examples were obtained by using the demo Fishbowl database and the [[Fishbowl Developer Hook]].
 
+
When connecting to the Fishbowl API you will need to create a socket connection to the port. We do have some very basic [http://www.fishbowlinventory.com/developer-network/tools/ sample code] available to demonstrate how to make a connection in Java and C#.
When dealing with updating inventory Fishbowl '''MUST''' be the master record or you will have inaccurate inventory and accounting numbers.
 
 
 
= Objects {{top}} =
 
 
 
{| class="prettytable"
 
|-
 
! Object
 
! Syntax
 
! Description
 
|-
 
| {{l|Account}}
 
| Account
 
| Contains information on accounts in the database
 
|-
 
| {{l|Address}}
 
| Address
 
| An object containing information about an address.
 
|-
 
| {{l|Carton}}
 
| Carton
 
| Stores information about a carton.
 
|-
 
| {{l|Carrier}}
 
| Carrier
 
| This object just contains the carrier's name.
 
|-
 
| {{l|Contacts}}
 
| Contacts
 
| Object that contains {{l|Contact Information}}.
 
|-
 
| {{l|Contact Information}}
 
| ContactInformation
 
| Contains information about a contact.
 
|-
 
| {{l|Credit Card}}
 
| CreditCard
 
| Contains information about a credit card
 
|-
 
| {{l|Customer}}
 
| Customer
 
| Contains Customer information.
 
|-
 
| {{l|Custom Field}}
 
| CustomField
 
| Stores the details about a Fishbowl custom field.
 
|-
 
| {{l|Custom List}}
 
| CustomList
 
| A list of Custom Items.
 
|-
 
| {{l|Custom List Item}}
 
| CustomListItem
 
| Stores Custom Items.
 
|-
 
| {{l|Discount}}
 
| Discount
 
| Stores discount information.
 
|-
 
| {{l|Location}}
 
| Location
 
| Represents a Location.
 
|-
 
| {{l|Location Group}}
 
| LocationGroup
 
| Compacts Location Group name and ID into one object.
 
|-
 
| {{l|Memo}}
 
| Memo
 
| Stores additional notes on requests and objects.
 
|-
 
| {{l|Order History}}
 
| OrderHistory
 
| This is a storage object for Order History.
 
|-
 
| {{l|Parameter}}
 
| Parameter
 
| Contains name and value module parameters.
 
|-
 
| {{l|Part}}
 
| Part
 
| Stores information about a part.
 
|-
 
| {{l|Payment}}
 
| Payment
 
| Contains payment information.
 
|-
 
| {{l|Pick}}
 
| Pick
 
| Stores all the information associated with a pick.
 
|-
 
| {{l|Pick Item}}
 
| PickItem
 
| Stores information about items that are involved in a pick.
 
|-
 
| {{l|Product}}
 
| Product
 
| Contains information about a Product
 
|-
 
| {{l|Purchase Order}}
 
| PurchaseOrder
 
| Object used to store data concerning a Purchase Order.
 
|-
 
| {{l|Receipt}}
 
| Receipt
 
| Contains receipt information.
 
|-
 
| {{l|Report}}
 
| Report
 
| Contains report information.
 
|-
 
| {{l|Report Tree}}
 
| ReportTree
 
| Contains report tree information.
 
|-
 
| {{l|Sales Order}}
 
| SalesOrder
 
| Stores sales order information.
 
|-
 
| {{l|Sales Order Item}}
 
| SalesOrderItem
 
| Stores sales order item information.
 
|-
 
| {{l|Shipping}}
 
| Shipping
 
| Contains the details about a shipment.
 
|-
 
| {{l|Tag}}
 
| Tag
 
| A number that helps describe a location.
 
|-
 
| {{l|Tax Rate}}
 
| TaxRate
 
| Stores tax rate information.
 
|-
 
| {{l|Tracking}}
 
| Tracking
 
| This simply contains the TrackingItem objects.
 
|-
 
| {{l|Tracking Item}}
 
| TrackingItem
 
| This object contains the information being tracked.
 
|-
 
| {{l|UOM}}
 
| UOM
 
| Contains Unit of Measure details.
 
|-
 
| {{l|UOM Conversion}}
 
| UOMConversion
 
| Stores conversion information for a Unit of Measure.
 
|-
 
| {{l|User}}
 
| User
 
| User details.
 
|-
 
| {{l|Vendor}}
 
| Vendor
 
| Contains all the vendor information and details.
 
|-
 
| {{l|Vendor Part Number}}
 
| VendorPartNumber
 
| Object that contains the Vendor Part Number.
 
|-
 
| {{l|Work Order}}
 
| WO
 
| Contains all the work order information and details.
 
|-
 
| {{l|Work Order Item}}
 
| WOItem
 
| Stores information about an item found in a work order.
 
|}
 
  
 
= Requests {{top}} =
 
= Requests {{top}} =
Line 181: Line 11:
 
! Syntax
 
! Syntax
 
! Brief Description
 
! Brief Description
|-
 
| {{l|Add Inventory}}
 
| AddInventoryRq
 
| Adds initial inventory of a part.
 
|-
 
| {{l|Add Memo}}
 
| AddMemoRq
 
| Adds a memo to the specified object.
 
|-
 
| {{l|Add SO Item}}
 
| AddSOItemRq
 
| Adds an item to an SO.
 
|-
 
| {{l|Add WO Item}}
 
| AddWorkOrderItemRq
 
| Adds an item to an existing open WO.
 
|-
 
| {{l|Build BOM}}
 
| BuildBomRq
 
| Create an MO for a specific BOM.
 
|-
 
| {{l|Calculate SO}}
 
| CalculateSORq
 
| Returns a potential order summary (unsaved)
 
|-
 
| {{l|Carrier List}}
 
| CarrierListRq
 
| Returns the shipping carriers stored in the database
 
|-
 
| {{l|Close Short SO}}
 
| CloseShortSORq
 
| This request is used to close short a sales order
 
|-
 
| {{l|Customer Get}}
 
| CustomerGetRq
 
| Returns the information for a specific customer
 
|-
 
| {{l|Customer List}}
 
| CustomerListRq
 
| Returns every customers information
 
|-
 
| {{l|Customer Name List}}
 
| CustomerNameListRq
 
| Returns the names of all customers
 
|-
 
| {{l|Cycle Count}}
 
| CycleCountRq
 
| Used to correct inventory amounts.
 
|-
 
| {{l|Email Report}}
 
| EmailReportRq
 
| Emails a report to a given email address
 
|-
 
| {{l|Export List}}
 
| ExportListRq
 
| Returns a list of available exports
 
|-
 
| {{l|Export}}
 
| ExportRq
 
| Returns export data of specified export type
 
 
|-
 
|-
 
| {{l|Execute Query}}
 
| {{l|Execute Query}}
 
| ExecuteQueryRq
 
| ExecuteQueryRq
 
| Returns results of sql query in csv format
 
| Returns results of sql query in csv format
|-
 
| {{l|Get Account Balance}}
 
| GetAccountBalanceRq
 
| Returns QuickBooks value for the specified account.
 
|-
 
| {{l|Get Account List}}
 
| GetAccountListRq
 
| Returns a list of all QuickBooks accounts
 
|-
 
| {{l|Get Part List}}
 
| GetPartListRq
 
| Returns a list of Parts based on the search parameters.
 
|-
 
| {{l|Get Pick}}
 
| GetPickRq
 
| Return the information on a specified pick
 
|-
 
| {{l|Get PO List}}
 
| GetPOListRq
 
| Returns all PO from a given location
 
|-
 
| {{l|Get Receipt}}
 
| GetReceiptRq
 
| Returns receipt information.
 
|-
 
| {{l|Get Ship List}}
 
| GetShipListRq
 
| Request a list of Shipments.
 
|-
 
| {{l|Get Shipment}}
 
| GetShipmentRq
 
| Returns the shipment details about a specified shipment.
 
|-
 
| {{l|Get Ship Now List}}
 
| GetShipNowListRq
 
| Requests a list of Shipments ready to ship.
 
|-
 
| {{l|Get SO List}}
 
| GetSOListRq
 
| Returns a list of SOs based on the search parameters.
 
|-
 
| {{l|Get Total Inventory}}
 
| GetTotalInventoryRq
 
| Returns the number of an item at a specific location.
 
|-
 
| {{l|Import List}}
 
| ImportListRq
 
| Returns a list of your import options.
 
 
|-
 
|-
 
| {{l|Import}}
 
| {{l|Import}}
Line 301: Line 23:
 
| ImportHeaderRq
 
| ImportHeaderRq
 
| Returns a list of import header for a specific import.
 
| Returns a list of import header for a specific import.
|-
 
| {{l|Inventory Quantity}}
 
| InvQtyRq
 
| Returns details and quantity of a specified part or list of parts.
 
|-
 
| {{l|Issue SO}}
 
| IssueSORq
 
| Issues an SO.
 
|-
 
| {{l|Light Part List}}
 
| LightPartListRq
 
| Returns a simple list of parts.
 
|-
 
| {{l|Load SO}}
 
| LoadSORq
 
| Returns information on a Sales Order.
 
|-
 
| {{l|Location Group}}
 
| LocationGroupRq
 
| Returns a list of the location groups.
 
|-
 
| {{l|Location List}}
 
| LocationListRq
 
| Returns a list of locations and their details.
 
|-
 
| {{l|Location Query}}
 
| LocationQueryRq
 
| Returns information on a location.
 
 
|-
 
|-
 
| {{l|Login}}
 
| {{l|Login}}
 
| LoginRq
 
| LoginRq
| Logins a user in or out of Fishbowl.
+
| Logs a user in to Fishbowl.
|-
 
| {{l|Make Payment}}
 
| MakePaymentRq
 
| Makes a payment on the specified order.
 
|-
 
| {{l|Move}}
 
| MoveRq
 
| Moves items from one specified location to another.
 
|-
 
| {{l|Part Cost}}
 
| PartCostRq
 
| Obtains the average cost.
 
|-
 
| {{l|Part Get}}
 
| PartGetRq
 
| Returns details about a part.
 
|-
 
| {{l|Part Query}}
 
| PartQueryRq
 
| Also returns details about a part.
 
|-
 
| {{l|Pick Query}}
 
| PickQueryRq
 
| Returns all picks specified.
 
|-
 
| {{l|Print Report}}
 
| PrintReportRq
 
| Prints the default report for the specified module.
 
|-
 
| {{l|Product Get}}
 
| ProductGetRq
 
| Requests detailed information about the product.
 
|-
 
| {{l|Product Price}}
 
| ProductPriceRq
 
| Request the best price for a given product.
 
|-
 
| {{l|Quick Ship}}
 
| QuickShipRq
 
| Will do an automatic pick, pack, and ship on a SO.
 
|-
 
| {{l|Receiving List}}
 
| ReceivingListRq
 
| Returns information about orders in the receiving module.
 
|-
 
| {{l|Save Discount}}
 
| SaveDiscountRq
 
| Saves and updates discounts.
 
|-
 
| {{l|Save Image}}
 
| SaveImageRq
 
| Saves an image to the associated object.
 
|-
 
| {{l|Save Pick}}
 
| SavePickRq
 
| Enables the fulfillment and adjustments to picks.
 
|-
 
| {{l|Save Receipt}}
 
| SaveReceiptRq
 
| Updates receipt stored data.
 
|-
 
| {{l|Save Report}}
 
| SaveReportRq
 
| Save the report data.
 
|-
 
| {{l|Save Shipment}}
 
| SaveShipmentRq
 
| Save the shipment data.
 
|-
 
| {{l|Save UPC}}
 
| SaveUPCRq
 
| Request permits the change of a product UPC.
 
 
|-
 
|-
| {{l|Set Def Part Loc}}
+
| {{l|Logout}}
| SetDefPartLocRq
+
| LogoutRq
| Enables you to change the default location of a part.
+
| Logs a user out of Fishbowl.
|-
 
| {{l|Save Tax Rate}}
 
| SaveTaxRateRq
 
| Saves and updates tax rates.
 
|-
 
| {{l|Ship}}
 
| ShipRq
 
| Ships an order
 
|-
 
| {{l|UOM}}
 
| UOMRq
 
| Requests a list of UOMs.
 
|-
 
| {{l|Vendor Get}}
 
| VendorGetRq
 
| Retrieves a vendor object.
 
|-
 
| {{l|Vendor List}}
 
| VendorListRq
 
| Requests a list of all vendors.
 
|-
 
| {{l|Vendor Name List}}
 
| VendorNameListRq
 
| Requests a list of all vendor names.
 
|-
 
| {{l|Void SO}}
 
| VoidSORq
 
| This request is used to void sales orders
 
 
|}
 
|}
  
Line 444: Line 38:
 
# A description
 
# A description
 
# The generic syntax
 
# The generic syntax
# An example using the EXAMPLE.FDB database included with Fishbowl
+
# An example using the demo database included with Fishbowl
 
 
Within the syntax section, formats accepted within the object are specified in {{r|red text}}. Any occurrences of the letters {{r|DB}} refer to a value used as a variable within the database. For instance <OrderTypeID>{{r|DB int}}</OrderTypeID> expects one of following numbers: 1, 10, 20, 30 or 40. Each number specifies an order type. 1 being none, 10 a purchase order and so on. The values and their significance can be found by accessing your [[Data#Database_tables|database tables]]. Other indicators within the syntax include {{r|int}}, {{r|string}}, {{r|boolean}}, {{r|double}}, and {{r|date/time}}. These are all typical coding data types aside from {{r|date/time}}. Below is the format and an example for inputting {{r|date/time}}.
 
*''year''-''month''-''day''T''hours'':''minutes'':''seconds''
 
*2019-08-17T15:43:51
 
 
 
 
 
 
 
 
 
<span style="font-size:200%;">'''OBJECTS'''</span>
 
 
 
{{Object|Account}}
 
'''Description:''' Contains information relevant to one of the financial accounts in the Fishbowl database.
 
 
 
'''Syntax:'''
 
<Account>
 
<Name>{{r|string}}</Name>
 
<AccountingID>{{r|string}}</AccountingID>
 
<AccountType>{{r|int}}</AccountType>
 
<Balance>{{r|string}}</Balance>
 
</Account>
 
 
 
'''Example:'''
 
<Account>
 
<Name>Cost Variance</Name>
 
<AccountingID>8000001B-1310422643</AccountingID>
 
<AccountType>12</AccountType>
 
<Balance>0</Balance>
 
</Account>
 
 
 
 
 
{{Object|Address}}
 
'''Description:''' An object containing information about an address. There are no fields that are essential for the use of an address object. Use only those fields that you need.
 
 
 
'''Syntax:'''
 
<Address>
 
<ID>{{r|int}}</ID>
 
<Temp-Account>
 
<ID>{{r|int}}</ID>
 
<Type>{{r|DB int}}</Type>
 
</Temp-Account>
 
<Name>{{r|string}}</Name>
 
<Attn>{{r|string}}</Attn>
 
<Street>{{r|string}}</Street>
 
<City>{{r|string}}</City>
 
<Zip>{{r|string}}</Zip>
 
<LocationGroupID>{{r|int}}</LocationGroupID>
 
<Default>{{r|boolean}}</Default>
 
<Residential>{{r|boolean}}</Residential>
 
<Type>{{r|DB string}}</Type>
 
<State>
 
<ID>{{r|DB int}}</ID>
 
{{n|Code}}{{r|string}}{{n|/Code}}
 
<Name>{{r|string}}</Name>
 
<CountryID>{{r|DB int}}</CountryID>
 
</State>
 
<Country>
 
<ID>{{r|DB int}}</ID>
 
<Name>{{r|string}}</Name>
 
{{n|Code}}{{r|string}}{{n|/Code}}
 
</Country>
 
<AddressInformationList>
 
<AddressInformation>
 
<ID>{{r|int}}</ID>
 
<Name>{{r|string}}</Name>
 
<Data>{{r|string}}</Data>
 
<Default>{{r|boolean}}</Default>
 
<Type>{{r|string}}</Type>
 
</AddressInformation>
 
</AddressInformationList>
 
</Address>
 
 
 
'''Example:'''
 
<Address>
 
<Temp-Account>
 
<Type>10</Type>
 
</Temp-Account>
 
<Name>Main Office</Name>
 
<Attn>Attn</Attn>
 
<Street>123 Neverland dr.</Street>
 
<City>Murray</City>
 
<Zip>84121</Zip>
 
<Default>true</Default>
 
<Residential>false</Residential>
 
<Type>Main Office</Type>
 
<State>
 
<Name>Utah</Name>
 
{{n|Code}}UT{{n|/Code}}
 
<CountryID>2</CountryID>
 
</State>
 
<Country>
 
<Name>United States</Name>
 
{{n|Code}}US{{n|/Code}}
 
</Country>
 
<AddressInformationList>
 
<AddressInformation>
 
<Name>Main Office</Name>
 
<Data>Address Data</Data>
 
<Default>true</Default>
 
<Type>Home</Type>
 
</AddressInformation>
 
</AddressInformationList>
 
</Address>
 
 
 
 
 
{{Object|Carton}}
 
'''Description:''' Stores information about a carton.
 
 
 
'''Syntax:'''
 
<Carton>
 
<ID>{{r|int}}</ID>
 
<ShipID>{{r|int}}</ShipID>
 
<CartonNum>{{r|int}}</CartonNum>
 
<TrackingNum />
 
<FreightWeight>{{r|int}}</FreightWeight>
 
<FreightAmount>{{r|int}}</FreightAmount>
 
<ShippingItems>
 
<ShippingItem>
 
<ShipItemID>{{r|int}}</ShipItemID>
 
<ProductNumber>{{r|string}}</ProductNumber>
 
<ProductDescription>{{r|string}}</ProductDescription>
 
<QtyShipped>{{r|int}}</QtyShipped>
 
<UOM>{{r|{{l|UOM}} object}}</UOM>
 
<Cost>{{r|int}}</Cost>
 
<SKU />
 
<UPC />
 
<OrderItemID>{{r|int}}</OrderItemID>
 
<OrderLineItem>{{r|int}}</OrderLineItem>
 
<CartonName>{{r|string}}</CartonName>
 
<CartonID>{{r|int}}</CartonID>
 
<TagNum>{{r|int}}</TagNum>
 
<Weight>{{r|int}}</Weight>
 
<WeightUOM>
 
<UOM>{{r|{{l|UOM}} object}}</UOM>
 
</WeightUOM>
 
<DisplayWeight>{{r|int}}</DisplayWeight>
 
<DisplayWeightUOM>
 
<UOM>{{r|{{l|UOM}} object}}</UOM>
 
</DisplayWeightUOM>
 
<Tracking />
 
</ShippingItem>
 
</ShippingItems>
 
</Carton>
 
 
 
'''Example:'''
 
<Carton>
 
<ID>64</ID>
 
<ShipID>63</ShipID>
 
<CartonNum>1</CartonNum>
 
<TrackingNum />
 
<FreightWeight>1.2</FreightWeight>
 
<FreightAmount>0</FreightAmount>
 
<ShippingItems>
 
<ShippingItem>
 
<ShipItemID>169</ShipItemID>
 
<ProductNumber>B201</ProductNumber>
 
<ProductDescription>Heavy Duty Brake Cables</ProductDescription>
 
<QtyShipped>1</QtyShipped>
 
<UOM>
 
<UOMID>1</UOMID>
 
<Name>Each</Name>
 
{{n|Code}}ea{{n|/Code}}
 
<Integral>true</Integral>
 
<Active>true</Active>
 
<Type>Count</Type>
 
<UOMConversions>
 
<UOMConversion>
 
<MainUOMID>1</MainUOMID>
 
<ToUOMID>17</ToUOMID>
 
<ToUOMCode>pr</ToUOMCode>
 
<ConversionMultiply>1.0</ConversionMultiply>
 
<ConversionFactor>2.0</ConversionFactor>
 
<ToUOMIsIntegral>false</ToUOMIsIntegral>
 
</UOMConversion>
 
<UOMConversion>
 
<MainUOMID>1</MainUOMID>
 
<ToUOMID>18</ToUOMID>
 
<ToUOMCode>pk</ToUOMCode>
 
<ConversionMultiply>1.0</ConversionMultiply>
 
<ConversionFactor>20.0</ConversionFactor>
 
<ToUOMIsIntegral>false</ToUOMIsIntegral>
 
</UOMConversion>
 
</UOMConversions>
 
</UOM>
 
<Cost>0</Cost>
 
<SKU />
 
<UPC />
 
<OrderItemID>160</OrderItemID>
 
<OrderLineItem>1</OrderLineItem>
 
<CartonName>1</CartonName>
 
<CartonID>64</CartonID>
 
<TagNum>694</TagNum>
 
<Weight>1.2</Weight>
 
<WeightUOM>
 
<UOM>
 
<UOMID>3</UOMID>
 
<Name>Pound</Name>
 
{{n|Code}}lbs{{n|/Code}}
 
<Integral>false</Integral>
 
<Active>true</Active>
 
<Type>Weight</Type>
 
<UOMConversions>
 
<UOMConversion>
 
<MainUOMID>3</MainUOMID>
 
<ToUOMID>8</ToUOMID>
 
<ToUOMCode>kg</ToUOMCode>
 
<ConversionMultiply>1.0</ConversionMultiply>
 
<ConversionFactor>2.2046000957489014</ConversionFactor>
 
<ToUOMIsIntegral>false</ToUOMIsIntegral>
 
</UOMConversion>
 
</UOMConversions>
 
</UOM>
 
</WeightUOM>
 
<DisplayWeight>1.2</DisplayWeight>
 
<DisplayWeightUOM>
 
<UOM>
 
<UOMID>3</UOMID>
 
<Name>Pound</Name>
 
{{n|Code}}lbs{{n|/Code}}
 
<Integral>false</Integral>
 
<Active>true</Active>
 
<Type>Weight</Type>
 
<UOMConversions>
 
<UOMConversion>
 
<MainUOMID>3</MainUOMID>
 
<ToUOMID>8</ToUOMID>
 
<ToUOMCode>kg</ToUOMCode>
 
<ConversionMultiply>1.0</ConversionMultiply>
 
<ConversionFactor>2.2046000957489014</ConversionFactor>
 
<ToUOMIsIntegral>false</ToUOMIsIntegral>
 
</UOMConversion>
 
</UOMConversions>
 
</UOM>
 
</DisplayWeightUOM>
 
<Tracking />
 
</ShippingItem>
 
</ShippingItems>
 
</Carton>
 
 
 
 
 
{{Object|Carrier}}
 
'''Description:''' This object just contains the carrier's name.
 
 
 
'''Syntax:'''
 
<Carrier>
 
<Name>{{r|string}}</Name>
 
</Carrier>
 
 
 
'''Example:'''
 
<Carrier>
 
<Name>Will Call</Name>
 
</Carrier>
 
 
 
 
 
{{Object|Contacts}}
 
'''Description:''' Contains {{l|Contact Information}}.
 
 
 
'''Syntax:'''
 
<Contacts>{{r|{{l|Contact Information}} object}}</Contacts>
 
 
 
'''Example:'''
 
<Contacts>
 
<ContactInformation>
 
<ContactName>Josh Anderson</ContactName>
 
<Type>Web</Type>
 
<Data><nowiki>http://www.joshanderson.com</nowiki></Data>
 
</ContactInformation>
 
</Contacts>
 
 
 
 
 
{{Object|Contact Information}}
 
'''Description:''' Stores a detail about a contact.There are no fields that are essential for the use of a Contact Information object. Use only those fields that you need.
 
 
 
'''Syntax:'''
 
<ContactInformation>
 
<ContactName>{{r|string}}</ContactName>
 
<ContactID>{{r|int}}</ContactID>
 
<Type>{{r|int}}</Type>
 
<Data>{{r|string}}</Data>
 
<Default>{{r|boolean}}</Default>
 
</ContactInformation>
 
 
 
'''Example:'''
 
<ContactInformation>
 
<ContactName>Josh Anderson</ContactName>
 
<Type>Web</Type>
 
<Data><nowiki>http://www.joshanderson.com</nowiki></Data>
 
</ContactInformation>
 
 
 
 
 
{{Object|Credit Card}}
 
'''Description:''' Stores credit card information to be used in a credit card payment.
 
 
 
'''Syntax:'''
 
<CreditCard>
 
<CardNumber>{{r|string}}</CardNumber>
 
<CardExpMonth>{{r|int}}</CardExpMonth>
 
<CardExpYear>{{r|int}}</CardExpYear>
 
<SecurityCode>{{r|string}}</SecurityCode>
 
<NameOnCard>{{r|string}}</NameOnCard>
 
<CardAddress>{{r|string}}</CardAddress>
 
<CardZipCode>{{r|string}}</CardZipCode>
 
<CardCountryCode>{{r|string}}</CardCountryCode>
 
</CreditCard>
 
 
 
'''Example:'''
 
<CreditCard>
 
<CardNumber>411111111111111</CardNumber>
 
<CardExpMonth>02</CardExpMonth>
 
<CardExpYear>19</CardExpYear>
 
<SecurityCode>523</SecurityCode>
 
<NameOnCard>John Doe</NameOnCard>
 
<CardAddress>123 S Riverdale Road</CardAddress>
 
<CardZipCode>84172</CardZipCode>
 
<CardCountryCode>US</CardCountryCode>
 
</CreditCard>
 
 
 
 
 
{{Object|Customer}}
 
'''Description:''' Stores the details about a Customer. You must include the JobDepth field. There are no other fields that are essential for the use of a Customer object. Use only those fields that you need.
 
 
 
'''Updated:''' 2013.0
 
 
 
'''Syntax:'''
 
<Customer>
 
<CustomerID>{{r|int}}</CustomerID>
 
<AccountID>{{r|int}}</AccountID>
 
<Status>{{r|string}} (Normal, Preferred, Hold Sales, Hold Shipment or Hold All)</Status>
 
<DefPaymentTerms>{{r|string}}</DefPaymentTerms>
 
<DefShipTerms>{{r|string}}</DefShipTerms>
 
<TaxRate>{{r|string}}</TaxRate>
 
<Name>{{r|string}}</Name>
 
<Number>{{r|string}}</Number>
 
<DateCreated>{{r|date/time}}</DateCreated>
 
<DateLastModified>{{r|date/time}}</DateLastModified>
 
<LastChangedUser>{{r|string}}</LastChangedUser>
 
<CreditLimit>{{r|price}}</CreditLimit>
 
<TaxExempt>{{r|boolean}}</TaxExempt>
 
<TaxExemptNumber>{{r|string}}</TaxExemptNumber>
 
<Note>{{r|string}}</Note>
 
<ActiveFlag>{{r|boolean}}</ActiveFlag>
 
<AccountingID>{{r|string}}</AccountingID>
 
<CurrencyName>{{r|DB string}}</CurrencyName>
 
<CurrencyRate>{{r|double}}</CurrencyRate>
 
<DefaultSalesman>{{r|DB String}}</DefaultSalesman>
 
<DefaultCarrier>{{r|DB String}}</DefaultCarrier>
 
<DefaultShipService>{{r|DB String}}</DefaultShipService>
 
<JobDepth>{{r|int}}</JobDepth>
 
<QuickBooksClassName>{{r|DB String}}</QuickBooksClassName>
 
<ParentID>{{r|int}}</ParentID>
 
<PipelineAccount>{{r|int}}</PipelineAccount>
 
<URL>{{r|string}}</URL>
 
<Addresses>{{r|{{l|Address}} objects}}</Addresses>
 
<CustomFields>
 
<CustomField>{{r|{{l|Custom Field}} object}}</CustomField>
 
</CustomFields>
 
</Customer>
 
 
 
'''Example:'''
 
<Customer>
 
<Status>Normal</Status>
 
<DefPaymentTerms>COD</DefPaymentTerms>
 
<DefShipTerms>Prepaid</DefShipTerms>
 
<TaxRate>None</TaxRate>
 
<Name>Sam Ball</Name>
 
<CreditLimit>1000000.00</CreditLimit>
 
<TaxExempt>true</TaxExempt>
 
<TaxExemptNumber>12345</TaxExemptNumber>
 
<Note>Hello World</Note>
 
<ActiveFlag>true</ActiveFlag>
 
<DefaultSalesman>jen</DefaultSalesman>
 
<DefaultCarrier>USPS</DefaultCarrier>
 
<JobDepth>1</JobDepth>
 
<Addresses>
 
<Address>
 
<Temp-Account>
 
<Type>10</Type>
 
</Temp-Account>
 
<Name>Main Office</Name>
 
<Attn>Attention</Attn>
 
<Street>123 Neverland dr.</Street>
 
<City>Murray</City>
 
<Zip>84121</Zip>
 
<Default>true</Default>
 
<Residential>false</Residential>
 
<Type>Main Office</Type>
 
<State>
 
<Name>Utah</Name>
 
{{n|Code}}UT{{n|/Code}}
 
<CountryID>2</CountryID>
 
</State>
 
<Country>
 
<Name>United States</Name>
 
{{n|Code}}US{{n|/Code}}
 
</Country>
 
<AddressInformationList>
 
<AddressInformation>
 
<Name>Main Office</Name>
 
<Data>Address Data</Data>
 
<Default>true</Default>
 
<Type>Home</Type>
 
</AddressInformation>
 
</AddressInformationList>
 
</Address>
 
</Addresses>
 
<CustomFields>
 
<CustomField>
 
<Type>CFT_TEXT</Type>
 
<Name>Custom1</Name>
 
<Info>Custom Data</Info>
 
</CustomField>
 
</CustomFields>
 
</Customer>
 
 
 
 
 
{{Object|Custom Field}}
 
'''Description:''' Stores the details about a Fishbowl custom field.
 
 
 
'''Syntax:'''
 
<CustomField>
 
<ID>{{r|int}}</ID>
 
<Type>{{r|string}}</Type>
 
<Name>{{r|string}}</Name>
 
<Description>{{r|string}}</Description>
 
<SortOrder>{{r|int}}</SortOrder>
 
<Info>{{r|string}}</Info>
 
<RequiredFlag>{{r|boolean}}</RequiredFlag>
 
<ActiveFlag>{{r|boolean}}</ActiveFlag>
 
<CustomList>{{r|{{l|Custom List}} objects}}</CustomList>
 
</CustomField>
 
 
 
 
 
{{Object|Custom List}}
 
'''Description:''' A list of Custom Items.
 
 
 
'''Syntax:'''
 
<CustomList>
 
<ID>{{r|int}}</ID>
 
<Name>{{r|string}}</Name>
 
<Description>{{r|string}}</Description>
 
<CustomListItems>{{r|{{l|Custom List Item}} objects}}</CustomListItems>
 
</CustomList>
 
 
 
 
 
{{Object|Custom List Item}}
 
'''Description:''' Stores Custom Items.
 
 
 
'''Syntax:'''
 
<CustomListItem>
 
<ID>{{r|int}}</ID>
 
<Name>{{r|string}}</Name>
 
<Description>{{r|string}}</Description>
 
</CustomListItem>
 
 
 
 
 
{{Object|Discount}}
 
'''Description:''' Stores Discount information.
 
 
 
'''Syntax:'''
 
<Discount>
 
<ID>{{r|int}}</ID>
 
<Name>{{r|string}}</Name>
 
<Description>{{r|string}}</Description>
 
<Type>{{r|string}}</Type>
 
<TypeID>{{r|int}}</TypeID>
 
<Percentage>{{r|double}}</Percentage>
 
<Amount>{{r|double}}</Amount>
 
<TaxableFlag>{{r|boolean}}</TaxableFlag>
 
</Discount>
 
 
 
 
 
{{Object|Location}}
 
'''Description:''' Represents a Location.
 
 
 
'''Syntax:'''
 
<Location>
 
<LocationID>{{r|int}}</LocationID>
 
<TypeID>{{r|int}}</TypeID>
 
<ParentID>{{r|int}}</ParentID>
 
<Name>{{r|string}}</Name>
 
<Description>{{r|string}}</Description>
 
<CountedAsAvailable>{{r|boolean}}</CountedAsAvailable>
 
<Default>{{r|boolean}}</Default>
 
<Active>{{r|boolean}}</Active>
 
<Pickable>{{r|boolean}}</Pickable>
 
<Receivable>{{r|boolean}}</Receivable>
 
<LocationGroupID>{{r|int}}</LocationGroupID>
 
<LocationGroupName>{{r|string}}</LocationGroupName>
 
<EnforceTracking>{{r|boolean}}</EnforceTracking>
 
<SortOrder>{{r|int}}</SortOrder>
 
</Location>
 
 
 
'''Example:'''
 
<Location>
 
<LocationID>0</LocationID>
 
<TypeID>0</TypeID>
 
<Name />
 
<Description />
 
<CountedAsAvailable>true</CountedAsAvailable>
 
<Active>true</Active>
 
<Pickable>true</Pickable>
 
<Receivable>true</Receivable>
 
<LocationGroupID>0</LocationGroupID>
 
<LocationGroupName />
 
<TagID>-1</TagID>
 
<TagNumber>-1</TagNumber>
 
</Location>
 
 
 
 
 
{{Object|Location Group}}
 
'''Description:''' Used to compact a Location Group name and ID into one object.
 
 
 
'''Syntax:'''
 
<LocationGroup>
 
<LocationGroupID>{{r|int}}</LocationGroupID>
 
<LocationGroupName>{{r|string}} (REQUIRED)</LocationGroupName>
 
<UsersDefaultLG>{{r|boolean}}</UsersDefaultLG>
 
</LocationGroup>
 
 
 
:'''OR'''
 
<LocationGroup>{{r|string}}</LocationGroup>
 
 
 
'''Example:'''
 
<LocationGroup>
 
<LocationGroupID>1</LocationGroupID>
 
<LocationGroupName>SLC</LocationGroupName>
 
<DefaultQBClassID>2</DefaultQBClassID>
 
</LocationGroup>
 
 
 
:'''OR'''
 
<LocationGroup>SLC</LocationGroup>
 
 
 
 
 
{{Object|Memo}}
 
'''Description:''' Stores additional notes on requests and objects.
 
 
 
'''Syntax:'''
 
<Memo>
 
<ID>{{r|int}}</ID>
 
<Memo>{{r|string}}</Memo>
 
<UserName>{{r|string}}</UserName>
 
<DateCreated>{{r|date/time}}</DateCreated>
 
</Memo>
 
 
 
 
 
{{Object|Order History}}
 
'''Description:''' This is a storage object for Order History
 
 
 
'''Syntax:'''
 
<OrderHistory>
 
<ID>{{r|int}}</ID>
 
<UserName>{{r|string}}</UserName>
 
<DateCreated>{{r|date/time}}</DateCreated>
 
<Comment>{{r|string}}</Comment>
 
<TableID>{{r|int}}</TableID>
 
<RecordID>{{r|int}}</RecordID>
 
</OrderHistory>
 
 
 
'''Example:'''
 
<OrderHistory>
 
<ID>314</ID>
 
<UserName>admin</UserName>
 
<DateCreated>2019-08-08T11:15:16</DateCreated>
 
<Comment>Receipt Created</Comment>
 
<TableID>-2001398668</TableID>
 
<RecordID>91</RecordID>
 
</OrderHistory>
 
 
 
 
 
{{Object|Parameter}}
 
'''Description:''' Contains name and value module parameters.
 
 
 
'''Syntax:'''
 
<Parameter>
 
<Name>{{r|string}}</Name>
 
<Value>{{r|string}}</Value>
 
</Parameter>
 
 
 
'''Example:'''
 
<ReportParam>
 
<Name>shipID</Name>
 
<Value>33</Value>
 
</ReportParam>
 
 
 
 
 
{{Object|Part}}
 
'''Description:''' Stores information about a part.
 
 
 
'''Syntax:'''
 
<Part>
 
<PartID>{{r|int}}</PartID>
 
<PartClassID>{{r|int}}</PartClassID>
 
<TypeID>{{r|int}}</TypeID>
 
<UOM>{{r|int}}</UOM>
 
<Num>{{r|string}}</Num>
 
<Description>{{r|string}}</Description>
 
<Manufacturer>{{r|string}}</Manufacturer>
 
<Details>{{r|string}}</Details>
 
<ABCCode />
 
<TagLabel>{{r|string}}</TagLabel>
 
<StandardCost>{{r|string}}</StandardCost>
 
<HasBOM>{{r|boolean}}</HasBOM>
 
<Configurable>{{r|boolean}}</Configurable>
 
<ActiveFlag>{{r|boolean}}</ActiveFlag>
 
<SerializedFlag>{{r|boolean}}</SerializedFlag>
 
<TrackingFlag>{{r|boolean}}</TrackingFlag>
 
<UsedFlag>{{r|boolean}}</UsedFlag>
 
<Weight>{{r|quantity}}</Weight>
 
<WeightUOMID>{{r|quantity}}</WeightUOMID>
 
<Width>{{r|quantity}}</Width>
 
<Height>{{r|quantity}}</Height>
 
<Len>{{r|quantity}}</Len>
 
<SizeUOMID>{{r|int}}</SizeUOMID>
 
<UPC />
 
<PartTrackingList>
 
<PartTracking />
 
</PartTrackingList>
 
<VendorPartNums>{{r|string}}</VendorPartNums>
 
<Image>{{r|string}}</Image>
 
</Part>
 
 
 
'''Example:'''
 
<Part>
 
<PartID>60</PartID>
 
<PartClassID>0</PartClassID>
 
<TypeID>10</TypeID>
 
<UOM>
 
<UOMID>1</UOMID>
 
<Name>Each</Name>
 
{{n|Code}}ea{{n|/Code}}
 
<Integral>true</Integral>
 
<Active>true</Active>
 
<Type>Count</Type>
 
<UOMConversions>
 
<UOMConversion>
 
<MainUOMID>1</MainUOMID>
 
<ToUOMID>17</ToUOMID>
 
<ToUOMCode>pr</ToUOMCode>
 
<ConversionMultiply>1.0</ConversionMultiply>
 
<ConversionFactor>2.0</ConversionFactor>
 
<ToUOMIsIntegral>false</ToUOMIsIntegral>
 
</UOMConversion>
 
<UOMConversion>
 
<MainUOMID>1</MainUOMID>
 
<ToUOMID>18</ToUOMID>
 
<ToUOMCode>pk</ToUOMCode>
 
<ConversionMultiply>1.0</ConversionMultiply>
 
<ConversionFactor>20.0</ConversionFactor>
 
<ToUOMIsIntegral>false</ToUOMIsIntegral>
 
</UOMConversion>
 
</UOMConversions>
 
</UOM>
 
<Num>BB2005</Num>
 
<Description>Custom Value Bike</Description>
 
<Details />
 
<StandardCost>0</StandardCost>
 
<HasBOM>false</HasBOM>
 
<Configurable>true</Configurable>
 
<ActiveFlag>true</ActiveFlag>
 
<SerializedFlag>true</SerializedFlag>
 
<TrackingFlag>true</TrackingFlag>
 
<Weight>0</Weight>
 
<WeightUOM>
 
<UOM>
 
<UOMID>3</UOMID>
 
<Name>Pound</Name>
 
{{n|Code}}lbs{{n|/Code}}
 
<Integral>false</Integral>
 
<Active>true</Active>
 
<Type>Weight</Type>
 
<UOMConversions>
 
<UOMConversion>
 
<MainUOMID>3</MainUOMID>
 
<ToUOMID>8</ToUOMID>
 
<ToUOMCode>kg</ToUOMCode>
 
<ConversionMultiply>1.0</ConversionMultiply>
 
<ConversionFactor>2.2046000957489014</ConversionFactor>
 
<ToUOMIsIntegral>false</ToUOMIsIntegral>
 
</UOMConversion>
 
</UOMConversions>
 
</UOM>
 
</WeightUOM>
 
<Width>0</Width>
 
<Height>0</Height>
 
<Len>0</Len>
 
<SizeUOM>
 
<UOM>
 
<UOMID>2</UOMID>
 
<Name>Foot</Name>
 
{{n|Code}}ft{{n|/Code}}
 
<Integral>false</Integral>
 
<Active>true</Active>
 
<Type>Length</Type>
 
<UOMConversions>
 
<UOMConversion>
 
<MainUOMID>2</MainUOMID>
 
<ToUOMID>7</ToUOMID>
 
<ToUOMCode>in</ToUOMCode>
 
<ConversionMultiply>12.0</ConversionMultiply>
 
<ConversionFactor>1.0</ConversionFactor>
 
<ToUOMIsIntegral>false</ToUOMIsIntegral>
 
</UOMConversion>
 
<UOMConversion>
 
<MainUOMID>2</MainUOMID>
 
<ToUOMID>9</ToUOMID>
 
<ToUOMCode>m</ToUOMCode>
 
<ConversionMultiply>1.0</ConversionMultiply>
 
<ConversionFactor>3.2808001041412354</ConversionFactor>
 
<ToUOMIsIntegral>false</ToUOMIsIntegral>
 
</UOMConversion>
 
</UOMConversions>
 
</UOM>
 
</SizeUOM>
 
<UPC />
 
<PartTrackingList>
 
<PartTracking>
 
<PartTrackingID>4</PartTrackingID>
 
<Name>Serial Number</Name>
 
{{n|Abbr}}SN(s){{n|/Abbr}}
 
<Description />
 
<SortOrder>4</SortOrder>
 
<TrackingTypeID>40</TrackingTypeID>
 
<Active>true</Active>
 
<Primary>true</Primary>
 
</PartTracking>
 
</PartTrackingList>
 
</Part>
 
 
 
 
 
{{Object|Payment}}
 
'''Description:''' Contains payment information.
 
 
 
'''Syntax:'''
 
<Payment>
 
<Amount>{{r|double}}</Amount>
 
<SalesOrderNumber>{{r|string}}</SalesOrderNumber>
 
<CurrencyRate>{{r|double}}</CurrencyRate>
 
<PaymentDate>{{r|date/time}}</PaymentDate>
 
<PaymentMethod>{{r|DB sting}}</PaymentMethod>
 
<Reference>{{r|string}}</Reference>
 
<Confirmation>{{r|string}}</Confirmation>
 
<ExpirationDate>{{r|date/time}}</ExpirationDate>
 
<DepositAccountName>{{r|string}}</DepositAccountName>
 
<TransactionID>{{r|string}}</TransactionID>
 
<AuthorizationCode>{{r|string}}</AuthorizationCode>
 
<MerchantAccount>{{r|string}}</MerchantAccount>
 
<MiscCreditCard>{{r|string}}</MiscCreditCard>
 
<CreditCard>{{r|{{l|Credit Card}} object}}</CreditCard>
 
</Payment>
 
 
 
'''Example:'''
 
<Payment>
 
<Amount>50</Amount>
 
<SalesOrderNumber>50032</SalesOrderNumber>
 
<CurrencyRate>5.2</CurrencyRate>
 
<PaymentDate>2019-08-26T00:12:34</PaymentDate>
 
<PaymentMethod>Cash</PaymentMethod>
 
</Payment>
 
 
 
 
 
{{Object|Pick}}
 
'''Description:''' Stores all the information associated with a pick.
 
 
 
'''Syntax:'''
 
<Pick>
 
<PickID>{{r|int}}</PickID>
 
<Number>{{r|string}}</Number>
 
<Type>{{r|DB string}}</Type>
 
<TypeID>{{r|DB int}}</TypeID>
 
<Status>{{r|DB string}}</Status>
 
<StatusID>{{r|DB int}}</StatusID>
 
<Priority>{{r|DB string}}</Priority>
 
<PriorityID>{{r|DB int}}</PriorityID>
 
<LocationGroupID>{{r|DB int}}</LocationGroupID>
 
<DateLastModified>{{r|date/time}}</DateLastModified>
 
<DateScheduled>{{r|date/time}}</DateScheduled>
 
<DateCreated>{{r|date/time}}</DateCreated>
 
<DateStarted>{{r|date/time}}</DateStarted>
 
<DateFinished>{{r|date/time}}</DateFinished>
 
<UserName>{{r|DB string}}</UserName>
 
<PickOrders>
 
<PickOrder>
 
<OrderType>{{r|DB string}}</OrderType>
 
<OrderTypeID>{{r|DB int}}</OrderTypeID>
 
<OrderNum>{{r|string}}</OrderNum>
 
<OrderID>{{r|int}}</OrderID>
 
<OrderTo>{{r|DB string}}</OrderTo>
 
<Note />
 
</PickOrder>
 
</PickOrders>
 
<PickItems>
 
<PickItem>{{r|{{l|Pick Item}} Object}}</PickItem>
 
</PickItems>
 
</Pick>
 
<Pick>
 
<PickID>1</PickID>
 
<Number>S50007</Number>
 
<Type>Pick</Type>
 
<TypeID>10</TypeID>
 
<Status>Finished</Status>
 
<StatusID>40</StatusID>
 
<Priority>3-Normal</Priority>
 
<PriorityID>30</PriorityID>
 
<LocationGroupID>1</LocationGroupID>
 
<DateLastModified>2019-02-03T09:41:31</DateLastModified>
 
<DateScheduled>2019-11-11T00:00:00</DateScheduled>
 
<DateCreated>2019-02-07T16:13:31</DateCreated>
 
<DateStarted>2019-02-03T09:37:13</DateStarted>
 
<DateFinished>2019-02-03T09:37:13</DateFinished>
 
<UserName>admin</UserName>
 
<PickOrders>
 
<PickOrder>
 
<OrderType>SO</OrderType>
 
<OrderTypeID>20</OrderTypeID>
 
<OrderNum>50007</OrderNum>
 
<OrderID>7</OrderID>
 
<OrderTo>Mountaineer Bikes</OrderTo>
 
<Note />
 
</PickOrder>
 
</PickOrders>
 
<PickItems>
 
<PickItem>
 
<PickItemID>179</PickItemID>
 
<Status>40</Status>
 
<Part>
 
<PartID>39</PartID>
 
<PartClassID>0</PartClassID>
 
<TypeID>10</TypeID>
 
<UOM>
 
<UOMID>1</UOMID>
 
<Name>Each</Name>
 
{{n|Code}}ea{{n|/Code}}
 
<Integral>true</Integral>
 
<Active>true</Active>
 
<Type>Count</Type>
 
<UOMConversions>
 
<UOMConversion>
 
<MainUOMID>1</MainUOMID>
 
<ToUOMID>17</ToUOMID>
 
<ToUOMCode>pr</ToUOMCode>
 
<ConversionMultiply>1.0</ConversionMultiply>
 
<ConversionFactor>2.0</ConversionFactor>
 
<ToUOMIsIntegral>false</ToUOMIsIntegral>
 
</UOMConversion>
 
<UOMConversion>
 
<MainUOMID>1</MainUOMID>
 
<ToUOMID>18</ToUOMID>
 
<ToUOMCode>pk</ToUOMCode>
 
<ConversionMultiply>1.0</ConversionMultiply>
 
<ConversionFactor>20.0</ConversionFactor>
 
<ToUOMIsIntegral>false</ToUOMIsIntegral>
 
</UOMConversion>
 
</UOMConversions>
 
</UOM>
 
<Num>PB3002</Num>
 
<Description>Protein Boost Power Bar</Description>
 
<Details />
 
<StandardCost>0</StandardCost>
 
<HasBOM>false</HasBOM>
 
<Configurable>false</Configurable>
 
<ActiveFlag>true</ActiveFlag>
 
<SerializedFlag>false</SerializedFlag>
 
<TrackingFlag>true</TrackingFlag>
 
<Weight>2</Weight>
 
<WeightUOM>
 
<UOM>
 
<UOMID>3</UOMID>
 
<Name>Pound</Name>
 
{{n|Code}}lbs{{n|/Code}}
 
<Integral>false</Integral>
 
<Active>true</Active>
 
<Type>Weight</Type>
 
<UOMConversions>
 
<UOMConversion>
 
<MainUOMID>3</MainUOMID>
 
<ToUOMID>8</ToUOMID>
 
<ToUOMCode>kg</ToUOMCode>
 
<ConversionMultiply>1.0</ConversionMultiply>
 
<ConversionFactor>2.2046000957489014</ConversionFactor>
 
<ToUOMIsIntegral>false</ToUOMIsIntegral>
 
</UOMConversion>
 
</UOMConversions>
 
</UOM>
 
</WeightUOM>
 
<Width>0</Width>
 
<Height>0</Height>
 
<Len>0</Len>
 
<SizeUOM>
 
<UOM>
 
<UOMID>2</UOMID>
 
<Name>Foot</Name>
 
{{n|Code}}ft{{n|/Code}}
 
<Integral>false</Integral>
 
<Active>true</Active>
 
<Type>Length</Type>
 
<UOMConversions>
 
<UOMConversion>
 
<MainUOMID>2</MainUOMID>
 
<ToUOMID>7</ToUOMID>
 
<ToUOMCode>in</ToUOMCode>
 
<ConversionMultiply>12.0</ConversionMultiply>
 
<ConversionFactor>1.0</ConversionFactor>
 
<ToUOMIsIntegral>false</ToUOMIsIntegral>
 
</UOMConversion>
 
<UOMConversion>
 
<MainUOMID>2</MainUOMID>
 
<ToUOMID>9</ToUOMID>
 
<ToUOMCode>m</ToUOMCode>
 
<ConversionMultiply>1.0</ConversionMultiply>
 
<ConversionFactor>3.2808001041412354</ConversionFactor>
 
<ToUOMIsIntegral>false</ToUOMIsIntegral>
 
</UOMConversion>
 
</UOMConversions>
 
</UOM>
 
</SizeUOM>
 
<UPC />
 
<PartTrackingList>
 
<PartTracking>
 
<PartTrackingID>3</PartTrackingID>
 
<Name>Expiration Date</Name>
 
{{n|Abbr}}ExpDate{{n|/Abbr}}
 
<Description />
 
<SortOrder>3</SortOrder>
 
<TrackingTypeID>30</TrackingTypeID>
 
<Active>true</Active>
 
</PartTracking>
 
</PartTrackingList>
 
<VendorPartNums>
 
<VendorPartNumber>
 
<Number>EZ-300-PB</Number>
 
</VendorPartNumber>
 
<VendorPartNumber>
 
<Number>PB3002</Number>
 
</VendorPartNumber>
 
</VendorPartNums>
 
</Part>
 
<Tag>
 
<TagID>0</TagID>
 
<Num>0</Num>
 
<PartNum />
 
<Location>
 
<LocationID>0</LocationID>
 
<TypeID>0</TypeID>
 
<Name />
 
<Description />
 
<CountedAsAvailable>true</CountedAsAvailable>
 
<Active>true</Active>
 
<Pickable>true</Pickable>
 
<Receivable>true</Receivable>
 
<LocationGroupID>0</LocationGroupID>
 
<LocationGroupName />
 
<TagID>-1</TagID>
 
<TagNumber>-1</TagNumber>
 
</Location>
 
<Quantity>0</Quantity>
 
<QuantityCommitted>0</QuantityCommitted>
 
<WONum>N/A</WONum>
 
<DateCreated>2019-08-17T15:43:51</DateCreated>
 
<Tracking />
 
<TypeID>30</TypeID>
 
<AccountID>1</AccountID>
 
</Tag>
 
<Quantity>4</Quantity>
 
<UOM>
 
<UOMID>1</UOMID>
 
<Name>Each</Name>
 
{{n|Code}}ea{{n|/Code}}
 
<Integral>true</Integral>
 
<Active>true</Active>
 
<Type>Count</Type>
 
<UOMConversions>
 
<UOMConversion>
 
<MainUOMID>1</MainUOMID>
 
<ToUOMID>17</ToUOMID>
 
<ToUOMCode>pr</ToUOMCode>
 
<ConversionMultiply>1.0</ConversionMultiply>
 
<ConversionFactor>2.0</ConversionFactor>
 
<ToUOMIsIntegral>false</ToUOMIsIntegral>
 
</UOMConversion>
 
<UOMConversion>
 
<MainUOMID>1</MainUOMID>
 
<ToUOMID>18</ToUOMID>
 
<ToUOMCode>pk</ToUOMCode>
 
<ConversionMultiply>1.0</ConversionMultiply>
 
<ConversionFactor>20.0</ConversionFactor>
 
<ToUOMIsIntegral>false</ToUOMIsIntegral>
 
</UOMConversion>
 
</UOMConversions>
 
</UOM>
 
<Tracking>
 
<TrackingItem>
 
<PartTracking>
 
<PartTrackingID>3</PartTrackingID>
 
<Name>Expiration Date</Name>
 
{{n|Abbr}}ExpDate{{n|/Abbr}}
 
<Description />
 
<SortOrder>3</SortOrder>
 
<TrackingTypeID>30</TrackingTypeID>
 
<Active>true</Active>
 
</PartTracking>
 
<TrackingValue>2019-12-08T00:00:00</TrackingValue>
 
</TrackingItem>
 
</Tracking>
 
<DestinationTag>
 
<Tag>
 
<TagID>376</TagID>
 
<Num>363</Num>
 
<PartNum />
 
<Location>
 
<LocationID>2</LocationID>
 
<TypeID>20</TypeID>
 
<Name>Shipping</Name>
 
<Description>The place where items are packaged and shipped.</Description>
 
<CountedAsAvailable>true</CountedAsAvailable>
 
<Default>true</Default>
 
<Active>true</Active>
 
<Pickable>true</Pickable>
 
<Receivable>true</Receivable>
 
<LocationGroupID>1</LocationGroupID>
 
<LocationGroupName>SLC</LocationGroupName>
 
<SortOrder>10006</SortOrder>
 
<TagID>376</TagID>
 
<TagNumber>363</TagNumber>
 
</Location>
 
<Quantity>0</Quantity>
 
<QuantityCommitted>0</QuantityCommitted>
 
<WONum>N/A</WONum>
 
<DateCreated>2019-08-31T08:16:10</DateCreated>
 
<Tracking />
 
<TypeID>10</TypeID>
 
<AccountID>1</AccountID>
 
</Tag>
 
</DestinationTag>
 
<OrderType>SO</OrderType>
 
<OrderTypeID>20</OrderTypeID>
 
<OrderNum>50007</OrderNum>
 
<OrderID>7</OrderID>
 
<SoItemId>12</SoItemId>
 
<SlotNumber>1</SlotNumber>
 
<Note />
 
<Location>
 
<LocationID>7</LocationID>
 
<TypeID>10</TypeID>
 
<Name>Stock 200</Name>
 
<Description>A location within the Stockroom</Description>
 
<CountedAsAvailable>true</CountedAsAvailable>
 
<Active>true</Active>
 
<Pickable>true</Pickable>
 
<Receivable>true</Receivable>
 
<LocationGroupID>1</LocationGroupID>
 
<LocationGroupName>SLC</LocationGroupName>
 
<SortOrder>10011</SortOrder>
 
<TagID>381</TagID>
 
<TagNumber>368</TagNumber>
 
</Location>
 
<PickItemType>10</PickItemType>
 
</PickItem>
 
</PickItems>
 
</Pick>
 
 
 
 
 
{{Object|Pick Item}}
 
'''Description:''' Stores information about items that are involved in a pick.
 
 
 
'''Syntax:'''
 
<PickItem>
 
<PickItemID>{{r|int}}</PickItemID>
 
<Status>{{r|DB int}}</Status>
 
<Part>{{r|{{l|Part}} object}}</Part>
 
<Tag>{{r|{{l|Tag}} object}}</Tag>
 
<Quantity>{{r|int}}</Quantity>
 
<UOM>{{r|{{l|UOM}} object}}</UOM>
 
<Tracking>{{r|{{l|Tracking}} object}}</Tracking>
 
<DestinationTag>
 
<Tag>{{r|{{l|Tag}} object}}</Tag>
 
</DestinationTag>
 
<OrderType>{{r|DB string}}</OrderType>
 
<OrderTypeID>{{r|DB int}}</OrderTypeID>
 
<OrderNum>{{r|DB string}}</OrderNum>
 
<OrderID>{{r|DB int}}</OrderID>
 
<SoItemId>{{r|DB int}}</SoItemId>
 
<PoItemId>{{r|DB int}}</PoItemId>
 
<XoItemId>{{r|DB int}}</XoItemId>
 
<WoItemId>{{r|DB int}}</WoItemId>
 
<SlotNumber>{{r|int}}</SlotNumber>
 
<Note>{{r|string}}</Note>
 
<Location>{{r|{{l|Location}} object}}</Location>
 
<PickItemType>{{r|DB int}}</PickItemType>
 
</PickItem>
 
 
 
'''Example:'''
 
<PickItem>
 
<PickItemID>179</PickItemID>
 
<Status>40</Status>
 
<Part>
 
<PartID>39</PartID>
 
<PartClassID>0</PartClassID>
 
<TypeID>10</TypeID>
 
<UOM>
 
<UOMID>1</UOMID>
 
<Name>Each</Name>
 
{{n|Code}}ea{{n|/Code}}
 
<Integral>true</Integral>
 
<Active>true</Active>
 
<Type>Count</Type>
 
<UOMConversions>
 
<UOMConversion>
 
<MainUOMID>1</MainUOMID>
 
<ToUOMID>17</ToUOMID>
 
<ToUOMCode>pr</ToUOMCode>
 
<ConversionMultiply>1.0</ConversionMultiply>
 
<ConversionFactor>2.0</ConversionFactor>
 
<ToUOMIsIntegral>false</ToUOMIsIntegral>
 
</UOMConversion>
 
<UOMConversion>
 
<MainUOMID>1</MainUOMID>
 
<ToUOMID>18</ToUOMID>
 
<ToUOMCode>pk</ToUOMCode>
 
<ConversionMultiply>1.0</ConversionMultiply>
 
<ConversionFactor>20.0</ConversionFactor>
 
<ToUOMIsIntegral>false</ToUOMIsIntegral>
 
</UOMConversion>
 
</UOMConversions>
 
</UOM>
 
<Num>PB3002</Num>
 
<Description>Protein Boost Power Bar</Description>
 
<Details />
 
<StandardCost>0</StandardCost>
 
<HasBOM>false</HasBOM>
 
<Configurable>false</Configurable>
 
<ActiveFlag>true</ActiveFlag>
 
<SerializedFlag>false</SerializedFlag>
 
<TrackingFlag>true</TrackingFlag>
 
<Weight>2</Weight>
 
<WeightUOM>
 
<UOM>
 
<UOMID>3</UOMID>
 
<Name>Pound</Name>
 
{{n|Code}}lbs{{n|/Code}}
 
<Integral>false</Integral>
 
<Active>true</Active>
 
<Type>Weight</Type>
 
<UOMConversions>
 
<UOMConversion>
 
<MainUOMID>3</MainUOMID>
 
<ToUOMID>8</ToUOMID>
 
<ToUOMCode>kg</ToUOMCode>
 
<ConversionMultiply>1.0</ConversionMultiply>
 
<ConversionFactor>2.2046000957489014</ConversionFactor>
 
<ToUOMIsIntegral>false</ToUOMIsIntegral>
 
</UOMConversion>
 
</UOMConversions>
 
</UOM>
 
</WeightUOM>
 
<Width>0</Width>
 
<Height>0</Height>
 
<Len>0</Len>
 
<SizeUOM>
 
<UOM>
 
<UOMID>2</UOMID>
 
<Name>Foot</Name>
 
{{n|Code}}ft{{n|/Code}}
 
<Integral>false</Integral>
 
<Active>true</Active>
 
<Type>Length</Type>
 
<UOMConversions>
 
<UOMConversion>
 
<MainUOMID>2</MainUOMID>
 
<ToUOMID>7</ToUOMID>
 
<ToUOMCode>in</ToUOMCode>
 
<ConversionMultiply>12.0</ConversionMultiply>
 
<ConversionFactor>1.0</ConversionFactor>
 
<ToUOMIsIntegral>false</ToUOMIsIntegral>
 
</UOMConversion>
 
<UOMConversion>
 
<MainUOMID>2</MainUOMID>
 
<ToUOMID>9</ToUOMID>
 
<ToUOMCode>m</ToUOMCode>
 
<ConversionMultiply>1.0</ConversionMultiply>
 
<ConversionFactor>3.2808001041412354</ConversionFactor>
 
<ToUOMIsIntegral>false</ToUOMIsIntegral>
 
</UOMConversion>
 
</UOMConversions>
 
</UOM>
 
</SizeUOM>
 
<UPC />
 
<PartTrackingList>
 
<PartTracking>
 
<PartTrackingID>3</PartTrackingID>
 
<Name>Expiration Date</Name>
 
{{n|Abbr}}ExpDate{{n|/Abbr}}
 
<Description />
 
<SortOrder>3</SortOrder>
 
<TrackingTypeID>30</TrackingTypeID>
 
<Active>true</Active>
 
</PartTracking>
 
</PartTrackingList>
 
<VendorPartNums>
 
<VendorPartNumber>
 
<Number>EZ-300-PB</Number>
 
</VendorPartNumber>
 
<VendorPartNumber>
 
<Number>PB3002</Number>
 
</VendorPartNumber>
 
</VendorPartNums>
 
</Part>
 
<Tag>
 
<TagID>0</TagID>
 
<Num>0</Num>
 
<PartNum />
 
<Location>
 
<LocationID>0</LocationID>
 
<TypeID>0</TypeID>
 
<Name />
 
<Description />
 
<CountedAsAvailable>true</CountedAsAvailable>
 
<Active>true</Active>
 
<Pickable>true</Pickable>
 
<Receivable>true</Receivable>
 
<LocationGroupID>0</LocationGroupID>
 
<LocationGroupName />
 
<TagID>-1</TagID>
 
<TagNumber>-1</TagNumber>
 
</Location>
 
<Quantity>0</Quantity>
 
<QuantityCommitted>0</QuantityCommitted>
 
<WONum>N/A</WONum>
 
<DateCreated>2019-08-17T15:43:51</DateCreated>
 
<Tracking />
 
<TypeID>30</TypeID>
 
<AccountID>1</AccountID>
 
</Tag>
 
<Quantity>4</Quantity>
 
<UOM>
 
<UOMID>1</UOMID>
 
<Name>Each</Name>
 
{{n|Code}}ea{{n|/Code}}
 
<Integral>true</Integral>
 
<Active>true</Active>
 
<Type>Count</Type>
 
<UOMConversions>
 
<UOMConversion>
 
<MainUOMID>1</MainUOMID>
 
<ToUOMID>17</ToUOMID>
 
<ToUOMCode>pr</ToUOMCode>
 
<ConversionMultiply>1.0</ConversionMultiply>
 
<ConversionFactor>2.0</ConversionFactor>
 
<ToUOMIsIntegral>false</ToUOMIsIntegral>
 
</UOMConversion>
 
<UOMConversion>
 
<MainUOMID>1</MainUOMID>
 
<ToUOMID>18</ToUOMID>
 
<ToUOMCode>pk</ToUOMCode>
 
<ConversionMultiply>1.0</ConversionMultiply>
 
<ConversionFactor>20.0</ConversionFactor>
 
<ToUOMIsIntegral>false</ToUOMIsIntegral>
 
</UOMConversion>
 
</UOMConversions>
 
</UOM>
 
<Tracking>
 
<TrackingItem>
 
<PartTracking>
 
<PartTrackingID>3</PartTrackingID>
 
<Name>Expiration Date</Name>
 
{{n|Abbr}}ExpDate{{n|/Abbr}}
 
<Description />
 
<SortOrder>3</SortOrder>
 
<TrackingTypeID>30</TrackingTypeID>
 
<Active>true</Active>
 
</PartTracking>
 
<TrackingValue>2019-12-08T00:00:00</TrackingValue>
 
</TrackingItem>
 
</Tracking>
 
<DestinationTag>
 
<Tag>
 
<TagID>376</TagID>
 
<Num>363</Num>
 
<PartNum />
 
<Location>
 
<LocationID>2</LocationID>
 
<TypeID>20</TypeID>
 
<Name>Shipping</Name>
 
<Description>The place where items are packaged and shipped.</Description>
 
<CountedAsAvailable>true</CountedAsAvailable>
 
<Default>true</Default>
 
<Active>true</Active>
 
<Pickable>true</Pickable>
 
<Receivable>true</Receivable>
 
<LocationGroupID>1</LocationGroupID>
 
<LocationGroupName>SLC</LocationGroupName>
 
<SortOrder>10006</SortOrder>
 
<TagID>376</TagID>
 
<TagNumber>363</TagNumber>
 
</Location>
 
<Quantity>0</Quantity>
 
<QuantityCommitted>0</QuantityCommitted>
 
<WONum>N/A</WONum>
 
<DateCreated>2019-08-31T08:16:10</DateCreated>
 
<Tracking />
 
<TypeID>10</TypeID>
 
<AccountID>1</AccountID>
 
</Tag>
 
</DestinationTag>
 
<OrderType>SO</OrderType>
 
<OrderTypeID>20</OrderTypeID>
 
<OrderNum>50007</OrderNum>
 
<OrderID>7</OrderID>
 
<SoItemId>12</SoItemId>
 
<SlotNumber>1</SlotNumber>
 
<Note />
 
<Location>
 
<LocationID>7</LocationID>
 
<TypeID>10</TypeID>
 
<Name>Stock 200</Name>
 
<Description>A location within the Stockroom</Description>
 
<CountedAsAvailable>true</CountedAsAvailable>
 
<Active>true</Active>
 
<Pickable>true</Pickable>
 
<Receivable>true</Receivable>
 
<LocationGroupID>1</LocationGroupID>
 
<LocationGroupName>SLC</LocationGroupName>
 
<SortOrder>10011</SortOrder>
 
<TagID>381</TagID>
 
<TagNumber>368</TagNumber>
 
</Location>
 
<PickItemType>10</PickItemType>
 
</PickItem>
 
 
 
 
 
{{Object|Product}}
 
'''Description:''' Contains information about a Product
 
 
 
'''Syntax:'''
 
<Product>
 
<ID>{{r|DB int}}</ID>
 
<PartID>{{r|DB int}}</PartID>
 
<Part>{{r|{{l|Part}} object}}</Part>
 
<Num>{{r|DB string}}</Num>
 
<Description>{{r|string}}</Description>
 
<Details />
 
<UPC />
 
<SKU />
 
<Price>{{r|price}}</Price>
 
<UOM>{{r|{{l|UOM}} object}}</UOM>
 
<DefaultSOItemType>{{r|DB string}} (See DB table SOITEMTYPE for options)</DefaultSOItemType>
 
<DisplayType />
 
<URL />
 
<Weight>{{r|int}}</Weight>
 
<WeightUOMID>{{r|DB int}} (See UOM table)</WeightUOMID>
 
<Width>{{r|int}}</Width>
 
<Height>{{r|int}}</Height>
 
<Len>{{r|int}}</Len>
 
<SizeUOMID>{{r|DB int}} (See UOM table)</SizeUOMID>
 
<AccountingID />
 
<AccountingHash />
 
<SellableInOtherUOMFlag>{{r|boolean}}</SellableInOtherUOMFlag>
 
<ActiveFlag>{{r|boolean}}</ActiveFlag>
 
<TaxableFlag>{{r|boolean}}</TaxableFlag>
 
<UsePriceFlag>{{r|boolean}}</UsePriceFlag>
 
<KitFlag>{{r|boolean}}</KitFlag>
 
<ShowSOComboFlag>{{r|boolean}}</ShowSOComboFlag>
 
<Image>{{r|encoded image string}}</Image>
 
</Product>
 
 
 
'''Example:'''
 
<Product>
 
<ID>52</ID>
 
<PartID>60</PartID>
 
<Part>
 
<PartID>60</PartID>
 
<PartClassID>0</PartClassID>
 
<TypeID>10</TypeID>
 
<UOM>
 
<UOMID>1</UOMID>
 
<Name>Each</Name>
 
{{n|Code}}ea{{n|/Code}}
 
<Integral>true</Integral>
 
<Active>true</Active>
 
<Type>Count</Type>
 
<UOMConversions>
 
<UOMConversion>
 
<MainUOMID>1</MainUOMID>
 
<ToUOMID>17</ToUOMID>
 
<ToUOMCode>pr</ToUOMCode>
 
<ConversionMultiply>1.0</ConversionMultiply>
 
<ConversionFactor>2.0</ConversionFactor>
 
<ToUOMIsIntegral>false</ToUOMIsIntegral>
 
</UOMConversion>
 
<UOMConversion>
 
<MainUOMID>1</MainUOMID>
 
<ToUOMID>18</ToUOMID>
 
<ToUOMCode>pk</ToUOMCode>
 
<ConversionMultiply>1.0</ConversionMultiply>
 
<ConversionFactor>20.0</ConversionFactor>
 
<ToUOMIsIntegral>false</ToUOMIsIntegral>
 
</UOMConversion>
 
</UOMConversions>
 
</UOM>
 
<Num>BB2005</Num>
 
<Description>Custom Value Bike</Description>
 
<Details />
 
<StandardCost>0</StandardCost>
 
<HasBOM>false</HasBOM>
 
<Configurable>true</Configurable>
 
<ActiveFlag>true</ActiveFlag>
 
<SerializedFlag>true</SerializedFlag>
 
<TrackingFlag>true</TrackingFlag>
 
<Weight>0</Weight>
 
<WeightUOM>
 
<UOM>
 
<UOMID>3</UOMID>
 
<Name>Pound</Name>
 
{{n|Code}}lbs{{n|/Code}}
 
<Integral>false</Integral>
 
<Active>true</Active>
 
<Type>Weight</Type>
 
<UOMConversions>
 
<UOMConversion>
 
<MainUOMID>3</MainUOMID>
 
<ToUOMID>8</ToUOMID>
 
<ToUOMCode>kg</ToUOMCode>
 
<ConversionMultiply>1.0</ConversionMultiply>
 
<ConversionFactor>2.2046000957489014</ConversionFactor>
 
<ToUOMIsIntegral>false</ToUOMIsIntegral>
 
</UOMConversion>
 
</UOMConversions>
 
</UOM>
 
</WeightUOM>
 
<Width>0</Width>
 
<Height>0</Height>
 
<Len>0</Len>
 
<SizeUOM>
 
<UOM>
 
<UOMID>2</UOMID>
 
<Name>Foot</Name>
 
{{n|Code}}ft{{n|/Code}}
 
<Integral>false</Integral>
 
<Active>true</Active>
 
<Type>Length</Type>
 
<UOMConversions>
 
<UOMConversion>
 
<MainUOMID>2</MainUOMID>
 
<ToUOMID>7</ToUOMID>
 
<ToUOMCode>in</ToUOMCode>
 
<ConversionMultiply>12.0</ConversionMultiply>
 
<ConversionFactor>1.0</ConversionFactor>
 
<ToUOMIsIntegral>false</ToUOMIsIntegral>
 
</UOMConversion>
 
<UOMConversion>
 
<MainUOMID>2</MainUOMID>
 
<ToUOMID>9</ToUOMID>
 
<ToUOMCode>m</ToUOMCode>
 
<ConversionMultiply>1.0</ConversionMultiply>
 
<ConversionFactor>3.2808001041412354</ConversionFactor>
 
<ToUOMIsIntegral>false</ToUOMIsIntegral>
 
</UOMConversion>
 
</UOMConversions>
 
</UOM>
 
</SizeUOM>
 
<UPC />
 
<PartTrackingList>
 
<PartTracking>
 
<PartTrackingID>4</PartTrackingID>
 
<Name>Serial Number</Name>
 
{{n|Abbr}}SN(s){{n|/Abbr}}
 
<Description />
 
<SortOrder>4</SortOrder>
 
<TrackingTypeID>40</TrackingTypeID>
 
<Active>true</Active>
 
<Primary>true</Primary>
 
</PartTracking>
 
</PartTrackingList>
 
</Part>
 
<Num>BB2005</Num>
 
<Description>Custom Value Bike</Description>
 
<Details />
 
<UPC />
 
<SKU />
 
<Price>250</Price>
 
<UOM>
 
<UOMID>1</UOMID>
 
<Name>Each</Name>
 
{{n|Code}}ea{{n|/Code}}
 
<Integral>true</Integral>
 
<Active>true</Active>
 
<Type>Count</Type>
 
<UOMConversions>
 
<UOMConversion>
 
<MainUOMID>1</MainUOMID>
 
<ToUOMID>17</ToUOMID>
 
<ToUOMCode>pr</ToUOMCode>
 
<ConversionMultiply>1.0</ConversionMultiply>
 
<ConversionFactor>2.0</ConversionFactor>
 
<ToUOMIsIntegral>false</ToUOMIsIntegral>
 
</UOMConversion>
 
<UOMConversion>
 
<MainUOMID>1</MainUOMID>
 
<ToUOMID>18</ToUOMID>
 
<ToUOMCode>pk</ToUOMCode>
 
<ConversionMultiply>1.0</ConversionMultiply>
 
<ConversionFactor>20.0</ConversionFactor>
 
<ToUOMIsIntegral>false</ToUOMIsIntegral>
 
</UOMConversion>
 
</UOMConversions>
 
</UOM>
 
<DefaultSOItemType>Sale</DefaultSOItemType>
 
<DisplayType>SHOW_ALL</DisplayType>
 
<URL />
 
<Weight>0</Weight>
 
<WeightUOMID>3</WeightUOMID>
 
<Width>0</Width>
 
<Height>0</Height>
 
<Len>0</Len>
 
<SizeUOMID>2</SizeUOMID>
 
<AccountingID />
 
<AccountingHash />
 
<SellableInOtherUOMFlag>true</SellableInOtherUOMFlag>
 
<ActiveFlag>true</ActiveFlag>
 
<TaxableFlag>true</TaxableFlag>
 
<UsePriceFlag>true</UsePriceFlag>
 
<KitFlag>false</KitFlag>
 
<ShowSOComboFlag>true</ShowSOComboFlag>
 
<Image>[B@12b6f63</Image>
 
</Product>
 
 
 
 
 
{{Object|Purchase Order}}
 
'''Description:''' Object used to store data concerning a Purchase Order.
 
 
 
'''Updated:''' 2013.0
 
 
 
'''Syntax:'''
 
<PurchaseOrder>
 
<ID>{{r|int}}</ID>
 
<Note>{{r|string}}</Note>
 
<CreatedDate>{{r|date/time}}</CreatedDate>
 
<FirstShipDate>{{r|date/time}}</FirstShipDate>
 
<Number>{{r|PO Number}}</Number>
 
<Status>{{r|ID}} (10 - Entered, 20 - Picking, 30 - Partial, 40 - Picked, 50 - Fulfilled, 60 – Closed Short, 70 - Void, 45 - Shipped)</Status>
 
<Buyer>{{r|string}}</Buyer>
 
<RemitTo>
 
<Name>{{r|string}}</Name>
 
<AddressField>{{r|string}}</AddressField>
 
<City>{{r|string}}</City>
 
<Zip>{{r|string}}</Zip>
 
<Country>{{r|string}}</Country>
 
<State>{{r|string}}</State>
 
</RemitTo>
 
<Ship>
 
<Name>{{r|string}}</Name>
 
<AddressField>{{r|string}}</AddressField>
 
<City>{{r|string}}</City>
 
<Zip>{{r|string}}</Zip>
 
<Country>{{r|string}}</Country>
 
<State>{{r|string}}</State>
 
</Ship>
 
<DeliverTo />
 
<ShippingCost>{{r|price}}</ShippingCost>
 
<ShippingTerms>{{r|int}}</ShippingTerms>
 
<PaymentTerms>{{r|string}}</PaymentTerms>
 
<FOB>{{r|string}}</FOB>
 
<VendorContact />
 
<VendorName>{{r|string}}</VendorName>
 
<VendorSONum />
 
<QuickBooksClassName>{{r|string}}</QuickBooksClassName>
 
<LocationGroup>{{r|string}}</LocationGroup>
 
<Carrier>{{r|string}}</Carrier>
 
<CurrencyRate>{{r|double}}</CurrencyRate>
 
<CurrencyName>{{r|DB string}}</CurrencyName>
 
<CostIsHomeCurrency>{{r|boolean}}</CostIsHomeCurrency>
 
<Items>
 
<PurchaseOrderItem>
 
<PartNumber>{{r|string}}</PartNumber>
 
<ID>{{r|int}}</ID>
 
<Description>{{r|string}}</Description>
 
<Quantity>{{r|int}}</Quantity>
 
<QuantityFulfilled>{{r|int}}</QuantityFulfilled>
 
<QuantityPicked>{{r|int}}</QuantityPicked>
 
<UOMCode>{{r|string}}</UOMCode>
 
<VendorPartNum>{{r|string}}</VendorPartNum>
 
<ItemType>{{r|int}}</ItemType>
 
<Status>{{r|int}}</Status>
 
<Note />
 
<UnitCost>{{r|price}}</UnitCost>
 
<QuickBooksClassName>{{r|string}}</QuickBooksClassName>
 
<RevisionLevel />
 
<ScheduledFulfillmentDate>{{r|date/time}}</ScheduledFulfillmentDate>
 
</PurchaseOrderItem>
 
</Items>
 
</PurchaseOrder>
 
 
 
'''Example:'''
 
<PurchaseOrder>
 
<ID>-1</ID>
 
<Note>Originating Sales Order #50047Originating Notes</Note>
 
<CreatedDate>2019-05-18T14:03:32</CreatedDate>
 
<FirstShipDate>2019-05-18T14:03:32</FirstShipDate>
 
<Number>10070</Number>
 
<Status>10</Status>
 
<Buyer>admin</Buyer>
 
<RemitTo>
 
<Name>Mike's Bikes</Name>
 
<AddressField>2245 South 3000 East</AddressField>
 
<City>Salt Lake City</City>
 
<Zip />
 
<Country>US</Country>
 
<State>Utah</State>
 
</RemitTo>
 
<Ship>
 
<Name>Bicycles Unlimited</Name>
 
<AddressField>300 W North Temple</AddressField>
 
<City />
 
<Zip>84103</Zip>
 
<Country>US</Country>
 
<State>Utah</State>
 
</Ship>
 
<DeliverTo />
 
<ShippingCost>0</ShippingCost>
 
<ShippingTerms>10</ShippingTerms>
 
<PaymentTerms>COD</PaymentTerms>
 
<FOB>Origin</FOB>
 
<VendorContact />
 
<VendorName>Mike's Bikes</VendorName>
 
<VendorSONum />
 
<QuickBooksClassName>Salt Lake City</QuickBooksClassName>
 
<LocationGroup>SLC</LocationGroup>
 
<Carrier>Will Call</Carrier>
 
<PurchaseOrderItem>
 
<PartNumber>BB2001</PartNumber>
 
<ID>105</ID>
 
<Description>Mountain Bike</Description>
 
<Quantity>1</Quantity>
 
<QuantityFulfilled>0</QuantityFulfilled>
 
<QuantityPicked>0</QuantityPicked>
 
<UOMCode>ea</UOMCode>
 
<VendorPartNum>BB2001</VendorPartNum>
 
<ItemType>10</ItemType>
 
<Status>10</Status>
 
<Note />
 
<UnitCost>450</UnitCost>
 
<QuickBooksClassName>Salt Lake City</QuickBooksClassName>
 
<RevisionLevel />
 
<ScheduledFulfillmentDate>2019-05-18T14:03:32</ScheduledFulfillmentDate>
 
</PurchaseOrderItem>
 
</PurchaseOrder>
 
 
 
 
 
{{Object|Receipt}}
 
'''Description:''' Contains receipt information.
 
 
 
'''Syntax:'''
 
<Receipt>
 
<ID>{{r|int}}</ID>
 
<StatusID>{{r|DB int}}</StatusID>
 
<TypeID>{{r|DB int}}</TypeID>
 
<OrderTypeID>{{r|DB int}}</OrderTypeID>
 
<SOID>{{r|int}}</SOID>
 
<POID>{{r|int}}</POID>
 
<XOID>{{r|int}}</XOID>
 
<UserID>{{r|int}}</UserID>
 
<LocationGroupID>{{r|DB int}}</LocationGroupID>
 
<ReceiptItems>
 
<ReceiveItem>
 
<ID>{{r|int}}</ID>
 
<ItemNum>{{r|DB string}}</ItemNum>
 
<Description>{{r|string}}</Description>
 
<LineNum>{{r|int}}</LineNum>
 
<ItemStatus>{{r|DB int}}</ItemStatus>
 
<ItemType>{{r|DB int}}</ItemType>
 
<DateLastModified>{{r|date/time}}</DateLastModified>
 
<OrderNum>{{r|string}}</OrderNum>
 
<OrderType>{{r|DB int}}</OrderType>
 
<SoItemId>{{r|int}}</SoItemId>
 
<PoItemId>{{r|int}}</PoItemId>
 
<XoItemId>{{r|int}}</XoItemId>
 
<OrderItemType>{{r|DB int}}</OrderItemType>
 
<ReceiptID>{{r|int}}</ReceiptID>
 
<Quantity>{{r|int}}</Quantity>
 
<UOMName>{{r|DB string}}</UOMName>
 
<UOMID>{{r|DB int}}</UOMID>
 
<SuggestedLocationID>{{r|int}}</SuggestedLocationID>
 
<OriginalUnitCost>{{r|int}}</OriginalUnitCost>
 
<BilledUnitCost>{{r|int}}</BilledUnitCost>
 
<LandedUnitCost>{{r|int}}</LandedUnitCost>
 
<DeliverTo />
 
<CarrierID>{{r|DB int}}</CarrierID>
 
<PartTypeID>{{r|DB int}}</PartTypeID>
 
<TrackingNum />
 
<PackageCount>{{r|int}}</PackageCount>
 
<DateScheduled>{{r|date/time}}</DateScheduled>
 
<ReceivedReceipts>
 
<ReceivedReceipt>
 
<ItemType>{{r|DB int}}</ItemType>
 
<Quantity>{{r|int}}</Quantity>
 
<Reason />
 
<LocationID>{{r|DB int}}</LocationID>
 
<Tracking />
 
</ReceivedReceipt>
 
</ReceivedReceipts>
 
<LinkedOrders />
 
<Part>{{r|{{l|Part}} object}}</Part>
 
</ReceiveItem>
 
</ReceiptItems>
 
</Receipt>
 
 
 
'''Example:'''
 
<Receipt>
 
<ID>92</ID>
 
<StatusID>10</StatusID>
 
<TypeID>20</TypeID>
 
<OrderTypeID>20</OrderTypeID>
 
<SOID>66</SOID>
 
<UserID>1</UserID>
 
<LocationGroupID>1</LocationGroupID>
 
<ReceiptItems>
 
<ReceiveItem>
 
<ID>350</ID>
 
<ItemNum>BTY100-Core</ItemNum>
 
<Description>Battery Pack</Description>
 
<LineNum>2</LineNum>
 
<ItemStatus>10</ItemStatus>
 
<ItemType>1</ItemType>
 
<DateLastModified>2019-08-09T11:05:45</DateLastModified>
 
<OrderNum>500100</OrderNum>
 
<OrderType>20</OrderType>
 
<SoItemId>162</SoItemId>
 
<OrderItemType>20</OrderItemType>
 
<ReceiptID>92</ReceiptID>
 
<Quantity>1</Quantity>
 
<UOMName>Each</UOMName>
 
<UOMID>1</UOMID>
 
<SuggestedLocationID>3</SuggestedLocationID>
 
<OriginalUnitCost>-95</OriginalUnitCost>
 
<BilledUnitCost>-95</BilledUnitCost>
 
<LandedUnitCost>-95</LandedUnitCost>
 
<DeliverTo />
 
<CarrierID>1</CarrierID>
 
<PartTypeID>10</PartTypeID>
 
<TrackingNum />
 
<PackageCount>1</PackageCount>
 
<DateScheduled>2019-08-29T00:00:00</DateScheduled>
 
<ReceivedReceipts>
 
<ReceivedReceipt>
 
<ItemType>1</ItemType>
 
<Quantity>1</Quantity>
 
<Reason />
 
<LocationID>3</LocationID>
 
<Tracking />
 
</ReceivedReceipt>
 
</ReceivedReceipts>
 
<LinkedOrders />
 
<Part>
 
<PartID>74</PartID>
 
<PartClassID>0</PartClassID>
 
<TypeID>10</TypeID>
 
<UOM>
 
<UOMID>1</UOMID>
 
<Name>Each</Name>
 
{{n|Code}}ea{{n|/Code}}
 
<Integral>true</Integral>
 
<Active>true</Active>
 
<Type>Count</Type>
 
<UOMConversions>
 
<UOMConversion>
 
<MainUOMID>1</MainUOMID>
 
<ToUOMID>17</ToUOMID>
 
<ToUOMCode>pr</ToUOMCode>
 
<ConversionMultiply>1.0</ConversionMultiply>
 
<ConversionFactor>2.0</ConversionFactor>
 
<ToUOMIsIntegral>false</ToUOMIsIntegral>
 
</UOMConversion>
 
<UOMConversion>
 
<MainUOMID>1</MainUOMID>
 
<ToUOMID>18</ToUOMID>
 
<ToUOMCode>pk</ToUOMCode>
 
<ConversionMultiply>1.0</ConversionMultiply>
 
<ConversionFactor>20.0</ConversionFactor>
 
<ToUOMIsIntegral>false</ToUOMIsIntegral>
 
</UOMConversion>
 
</UOMConversions>
 
</UOM>
 
<Num>BTY100</Num>
 
<Description>Battery Pack</Description>
 
<Details />
 
<StandardCost>0</StandardCost>
 
<HasBOM>false</HasBOM>
 
<Configurable>false</Configurable>
 
<ActiveFlag>true</ActiveFlag>
 
<SerializedFlag>false</SerializedFlag>
 
<TrackingFlag>false</TrackingFlag>
 
<Weight>0</Weight>
 
<WeightUOM>
 
<UOM>
 
<UOMID>3</UOMID>
 
<Name>Pound</Name>
 
{{n|Code}}lbs{{n|/Code}}
 
<Integral>false</Integral>
 
<Active>true</Active>
 
<Type>Weight</Type>
 
<UOMConversions>
 
<UOMConversion>
 
<MainUOMID>3</MainUOMID>
 
<ToUOMID>8</ToUOMID>
 
<ToUOMCode>kg</ToUOMCode>
 
<ConversionMultiply>1.0</ConversionMultiply>
 
<ConversionFactor>2.2046000957489014</ConversionFactor>
 
<ToUOMIsIntegral>false</ToUOMIsIntegral>
 
</UOMConversion>
 
</UOMConversions>
 
</UOM>
 
</WeightUOM>
 
<Width>0</Width>
 
<Height>0</Height>
 
<Len>0</Len>
 
<SizeUOM>
 
<UOM>
 
<UOMID>2</UOMID>
 
<Name>Foot</Name>
 
{{n|Code}}ft{{n|/Code}}
 
<Integral>false</Integral>
 
<Active>true</Active>
 
<Type>Length</Type>
 
<UOMConversions>
 
<UOMConversion>
 
<MainUOMID>2</MainUOMID>
 
<ToUOMID>7</ToUOMID>
 
<ToUOMCode>in</ToUOMCode>
 
<ConversionMultiply>12.0</ConversionMultiply>
 
<ConversionFactor>1.0</ConversionFactor>
 
<ToUOMIsIntegral>false</ToUOMIsIntegral>
 
</UOMConversion>
 
<UOMConversion>
 
<MainUOMID>2</MainUOMID>
 
<ToUOMID>9</ToUOMID>
 
<ToUOMCode>m</ToUOMCode>
 
<ConversionMultiply>1.0</ConversionMultiply>
 
<ConversionFactor>3.2808001041412354</ConversionFactor>
 
<ToUOMIsIntegral>false</ToUOMIsIntegral>
 
</UOMConversion>
 
</UOMConversions>
 
</UOM>
 
</SizeUOM>
 
<UPC />
 
<VendorPartNums>
 
<VendorPartNumber>
 
<Number>BTY100</Number>
 
</VendorPartNumber>
 
</VendorPartNums>
 
</Part>
 
</ReceiveItem>
 
</ReceiptItems>
 
</Receipt>
 
 
 
 
 
{{Object|Report}}
 
'''Description:''' Contains the details about a report.
 
 
 
'''Syntax:'''
 
<Report>
 
<ID>{{r|DB int}}</ID>
 
<Name>{{r|string}}</Name>
 
<Path>{{r|string}}</Path>
 
<ReportTreeID>{{r|DB int}}</ReportTreeID>
 
<Description>{{r|string}}</Description>
 
<ActiveFlag>{{r|boolean}}</ActiveFlag>
 
<ReadOnly>{{r|boolean}}</ReadOnly>
 
<CreatedDate>{{r|date/time}}</CreatedDate>
 
<DateLastModified>{{r|date/time}}</DateLastModified>
 
<UserID>{{r|DB int}}</UserID>
 
</Report>
 
 
 
'''Example:'''
 
<Report>
 
<ID>164</ID>
 
<Name>New Report</Name>
 
<Path>../reports/Custom/NewReport.jasper</Path>
 
<ReportTreeID>19</ReportTreeID>
 
<Description>Description of the report</Description>
 
<ActiveFlag>true</ActiveFlag>
 
<ReadOnly>false</ReadOnly>
 
<UserID>1</UserID>
 
</Report>
 
 
 
 
 
{{Object|Report Tree}}
 
'''Description:''' Contains the details about a report tree.
 
 
 
'''Syntax:'''
 
<ReportTree>
 
<ID>{{r|DB int}}</ID>
 
<Name>{{r|string}}</Name>
 
<ParentID>{{r|DB int}}</ParentID>
 
<ReadOnly>{{r|boolean}}</ReadOnly>
 
<UserID>{{r|DB int}}</UserID>
 
</ReportTree>
 
 
 
'''Example:'''
 
<ReportTree>
 
<ID>1</ID>
 
<Name>Company</Name>
 
<ParentID>-1</ParentID>
 
<ReadOnly>true</ReadOnly>
 
<UserID>1</UserID>
 
</ReportTree>
 
 
 
 
 
{{Object|Sales Order}}
 
'''Description:''' Stores sales order information.
 
 
 
'''Updated:''' 2013.1
 
 
 
'''Syntax:'''
 
<SalesOrder>
 
<ID>{{r|int}}</ID>
 
<Note>{{r|string}}</Note>
 
<TotalPrice>{{r|double}}</TotalPrice>
 
<TotalTax>{{r|double}}</TotalTax>
 
<PaymentTotal>{{r|double}}</PaymentTotal>
 
<ItemTotal>{{r|double}}</ItemTotal>
 
<Salesman>{{r|string}}</Salesman>
 
<Number>{{r|string}}</Number>
 
<Status>{{r|DB int}}</Status>
 
<Carrier>{{r|DB string}}</Carrier>
 
<FirstShipDate>{{r|date/time}}</FirstShipDate>
 
<CreatedDate>{{r|date/time}}</CreatedDate>
 
<IssuedDate>{{r|date/time}}</IssuedDate>
 
<TaxRatePercentage>{{r|double}}</TaxRatePercentage>
 
<TaxRateName>{{r|string}}</TaxRateName>
 
<ShippingCost>{{r|double}}</ShippingCost>
 
<ShippingTerms>{{r|DB string}}</ShippingTerms>
 
<PaymentTerms>{{r|DB string}}</PaymentTerms>
 
<CustomerContact>{{r|string}}</CustomerContact>
 
<CustomerName>{{r|string}}</CustomerName>
 
<CustomerID>{{r|int}}</CustomerID>
 
<FOB>{{r|DB string}}</FOB>
 
<QuickBooksClassName>{{r|DB string}}</QuickBooksClassName>
 
<LocationGroup>{{r|DB string}}</LocationGroup>
 
<PriorityId>{{r|DB int}}</PriorityId>
 
<CurrencyRate>{{r|double}}</CurrencyRate>
 
<CurrencyName>{{r|DB string}}</CurrencyName>
 
<PriceIsInHomeCurrency>{{r|boolean}}</PriceIsInHomeCurrency>
 
<BillTo>
 
<Name>{{r|string}}</Name>
 
<AddressField>{{r|string}}</AddressField>
 
<City>{{r|string}}</City>
 
<Zip>{{r|string}}</Zip>
 
<Country>{{r|string}}</Country>
 
<State>{{r|string}}</State>
 
</BillTo>
 
<Ship>
 
<Name>{{r|string}}</Name>
 
<AddressField>{{r|string}}</AddressField>
 
<City>{{r|string}}</City>
 
<Zip>{{r|string}}</Zip>
 
<Country>{{r|string}}</Country>
 
<State>{{r|string}}</State>
 
</Ship>
 
<IssueFlag>{{r|boolean}}</IssueFlag>
 
<VendorPO>{{r|string}}</VendorPO>
 
<CustomerPO>{{r|string}}</CustomerPO>
 
<UPSServiceID>{{r|DB int}}</UPSServiceID>
 
<TotalIncludesTax>{{r|boolean}}</TotalIncludesTax>
 
<TypeID>{{r|DB int}}</TypeID>
 
<URL>{{r|string}}</URL>
 
<Cost>{{r|double}}</Cost>
 
<DateCompleted>{{r|date/time}}</DateCompleted>
 
<DateLastModified>{{r|date/time}}</DateLastModified>
 
<DateRevision>{{r|date/time}}</DateRevision>
 
<RegisterID>{{r|int}}</RegisterID>
 
<ResidentialFlag>{{r|boolean}}</ResidentialFlag>
 
<SalesmanInitials>{{r|string}}</SalesmanInitials>
 
<CustomFields>{{r|{{l|Custom Field}} objects}}</CustomFields>
 
<Memos>{{r|{{l|Memo}} objects}}</Memos>
 
<Items>
 
<SalesOrderItem>{{r|{{l|Sales Order Item}} objects}}</SalesOrderItem>
 
</Items>
 
</SalesOrder>
 
 
 
'''Example:'''
 
<SalesOrder>
 
<Salesman>admin</Salesman>
 
<Number>500100</Number>
 
<Status>20</Status>
 
<Carrier>Will Call</Carrier>
 
<FirstShipDate>2019-08-29T00:00:00</FirstShipDate>
 
<CreatedDate>2019-08-29T00:00:00</CreatedDate>
 
<IssuedDate>2019-08-29T16:48:56</IssuedDate>
 
<TaxRatePercentage>0.0625</TaxRatePercentage>
 
<TaxRateName>Utah</TaxRateName>
 
<ShippingTerms>Prepaid &amp;amp; Billed</ShippingTerms>
 
<PaymentTerms>COD</PaymentTerms>
 
<CustomerContact>Beach Bike</CustomerContact>
 
<CustomerName>Beach Bike</CustomerName>
 
<FOB>Origin</FOB>
 
<QuickBooksClassName>Salt Lake City</QuickBooksClassName>
 
<LocationGroup>SLC</LocationGroup>
 
<PriorityId>30</PriorityId>
 
<BillTo>
 
<Name>Beach Bike</Name>
 
<AddressField>555 Suntan Ave.</AddressField>
 
<City>Santa Barbara</City>
 
<Zip>93101</Zip>
 
</BillTo>
 
<Ship>
 
<Name>Beach Bike</Name>
 
<AddressField>555 Suntan Ave.</AddressField>
 
<Zip>93101</Zip>
 
<Country>US</Country>
 
<State>California</State>
 
</Ship>
 
<Items>
 
<SalesOrderItem>
 
<ID>-1</ID>
 
<ProductNumber>BTY100</ProductNumber>
 
<SOID>93</SOID>
 
<Description>Battery Pack</Description>
 
<Taxable>true</Taxable>
 
<Quantity>1</Quantity>
 
<ProductPrice>95.00</ProductPrice>
 
<TotalPrice>95.00</TotalPrice>
 
<UOMCode>ea</UOMCode>
 
<ItemType>10</ItemType>
 
<Status>10</Status>
 
<QuickBooksClassName>Salt Lake City</QuickBooksClassName>
 
<LineNumber>1</LineNumber>
 
</SalesOrderItem>
 
</Items>
 
</SalesOrder>
 
 
 
 
 
{{Object|Sales Order Item}}
 
'''Description:''' Stores sales order item information.
 
 
 
'''Syntax:'''
 
<SalesOrderItem>
 
<ID>{{r|int}}</ID>
 
<ProductNumber>{{r|string}}</ProductNumber>
 
<SOID>{{r|int}}</SOID>
 
<Description>{{r|string}}</Description>
 
<CustomerPartNum>{{r|string}}</CustomerPartNum>
 
<Taxable>{{r|boolean}}</Taxable>
 
<Quantity>{{r|int}}</Quantity>
 
<ProductPrice>{{r|int}}</ProductPrice>
 
<TotalPrice>{{r|int}}</TotalPrice>
 
<UOMCode>{{r|DB string}}</UOMCode>
 
<ItemType>{{r|DB int}}</ItemType>
 
<Status>{{r|DB int}}</Status>
 
<QuickBooksClassName>{{r|DB string}}</QuickBooksClassName>
 
<LineNumber>{{r|int}}</LineNumber>
 
<KitItemFlag>{{r|boolean}}</KitItemFlag>
 
<ShowItemFlag>{{r|boolean}}</ShowItemFlag>
 
<AdjustmentAmount>{{r|double}}</AdjustmentAmount>
 
<AdjustPercentage>{{r|int}}</AdjustPercentage>
 
<DateLastFulfillment>{{r|date/time}}</DateLastFulfillment>
 
<DateLastModified>{{r|date/time}}</DateLastModified>
 
<DateScheduledFulfillment>{{r|date/time}}</DateScheduledFulfillment>
 
<ExchangeSOLineItem>{{r|int}}</ExchangeSOLineItem>
 
<ItemAdjustID>{{r|DB int}}</ItemAdjustID>
 
<QtyFulfilled>{{r|int}}</QtyFulfilled>
 
<QtyPicked>{{r|int}}</QtyPicked>
 
<RevisionLevel>{{r|int}}</RevisionLevel>
 
<TotalCost>{{r|double}}</TotalCost>
 
<TaxableFlag>{{r|boolean}}</TaxableFlag>
 
</SalesOrderItem>
 
 
 
'''Example:'''
 
<SalesOrderItem>
 
<ID>-1</ID>
 
<ProductNumber>BTY100-Core</ProductNumber>
 
<SOID>94</SOID>
 
<Description>Battery Pack</Description>
 
<Taxable>true</Taxable>
 
<Quantity>1</Quantity>
 
<ProductPrice>-95.00</ProductPrice>
 
<TotalPrice>-95.00</TotalPrice>
 
<UOMCode>ea</UOMCode>
 
<ItemType>20</ItemType>
 
<Status>10</Status>
 
<QuickBooksClassName>Salt Lake City</QuickBooksClassName>
 
<LineNumber>2</LineNumber>
 
<KitItemFlag>false</KitItemFlag>
 
<ShowItemFlag>false</ShowItemFlag>
 
<AdjustmentAmount>2.99</AdjustmentAmount>
 
<AdjustPercentage>13</AdjustPercentage>
 
<CustomerPartNum>12345</CustomerPartNum>
 
<DateLastFulfillment>2010-05-18 14 02 21</DateLastFulfillment>
 
<DateLastModified>2010-05-18 14 02 21</DateLastModified>
 
<DateScheduledFulfillment>2010-05-18 14 02 21</DateScheduledFulfillment>
 
<ExchangeSOLineItem>1</ExchangeSOLineItem>
 
<ItemAdjustID>1</ItemAdjustID>
 
<QtyFulfilled>12</QtyFulfilled>
 
<QtyPicked>14</QtyPicked>
 
<RevisionLevel>3</RevisionLevel>
 
<TotalCost>2999.01</TotalCost>
 
<TaxableFlag>true</TaxableFlag>
 
</SalesOrderItem>
 
 
 
 
 
{{Object|Shipping}}
 
'''Description:''' Contains the details about a shipment.
 
 
 
'''Syntax:'''
 
<Shipping>
 
<ID>{{r|DB int}}</ID>
 
<OrderNumber>{{r|DB int}}</OrderNumber>
 
<OrderType>{{r|DB string}}</OrderType>
 
<CreatedDate>{{r|date/time}}</CreatedDate>
 
<DateLastModified>{{r|date/time}}</DateLastModified>
 
<Carrier>{{r|DB string}}</Carrier>
 
<Status>{{r|DB int}}</Status>
 
<FOB>Origin</FOB>
 
<Note />
 
<CartonCount>{{r|int}}</CartonCount>
 
<Address>{{r|{{l|Address}} object}}</Address>
 
<Cartons>
 
<Carton>{{r|{{l|Carton}} object}}</Carton>
 
</Cartons>
 
</Shipping>
 
 
 
'''Example:'''
 
<Shipping>
 
<ID>33</ID>
 
<OrderNumber>50039</OrderNumber>
 
<OrderType>SO</OrderType>
 
<CreatedDate>2019-02-03T10:36:23</CreatedDate>
 
<DateLastModified>2019-02-03T10:36:23</DateLastModified>
 
<Carrier>Will Call</Carrier>
 
<Status>10</Status>
 
<FOB>Origin</FOB>
 
<Note />
 
<CartonCount>1</CartonCount>
 
<Address>
 
<ID>178</ID>
 
<Attn>Michelle Morris</Attn>
 
<Street>1688 North 1500 West</Street>
 
<City>Island Park</City>
 
<Zip>83429</Zip>
 
<Default>false</Default>
 
<Residential>false</Residential>
 
<Type>Main Office</Type>
 
<State>
 
<ID>15</ID>
 
<Name>Idaho</Name>
 
{{n|Code}}ID{{n|/Code}}
 
<CountryID>2</CountryID>
 
</State>
 
<Country>
 
<ID>2</ID>
 
<Name>UNITED STATES</Name>
 
{{n|Code}}US{{n|/Code}}
 
</Country>
 
</Address>
 
<Cartons>
 
<Carton>
 
<ID>34</ID>
 
<ShipID>33</ShipID>
 
<CartonNum>1</CartonNum>
 
<TrackingNum>514917460800010</TrackingNum>
 
<FreightWeight>18</FreightWeight>
 
<FreightAmount>11.3</FreightAmount>
 
<ShippingItems>
 
<ShippingItem>
 
<ShipItemID>89</ShipItemID>
 
<ProductNumber>SP001</ProductNumber>
 
<ProductDescription>Replacement Spokes</ProductDescription>
 
<QtyShipped>100</QtyShipped>
 
<UOM>
 
<UOMID>1</UOMID>
 
<Name>Each</Name>
 
{{n|Code}}ea{{n|/Code}}
 
<Integral>true</Integral>
 
<Active>true</Active>
 
<Type>Count</Type>
 
<UOMConversions>
 
<UOMConversion>
 
<MainUOMID>1</MainUOMID>
 
<ToUOMID>17</ToUOMID>
 
<ToUOMCode>pr</ToUOMCode>
 
<ConversionMultiply>1.0</ConversionMultiply>
 
<ConversionFactor>2.0</ConversionFactor>
 
<ToUOMIsIntegral>false</ToUOMIsIntegral>
 
</UOMConversion>
 
<UOMConversion>
 
<MainUOMID>1</MainUOMID>
 
<ToUOMID>18</ToUOMID>
 
<ToUOMCode>pk</ToUOMCode>
 
<ConversionMultiply>1.0</ConversionMultiply>
 
<ConversionFactor>20.0</ConversionFactor>
 
<ToUOMIsIntegral>false</ToUOMIsIntegral>
 
</UOMConversion>
 
</UOMConversions>
 
</UOM>
 
<Cost>0</Cost>
 
<SKU />
 
<UPC />
 
<SoItemId>116</SoItemId>
 
<OrderLineItem>1</OrderLineItem>
 
<CartonName>1</CartonName>
 
<CartonID>34</CartonID>
 
<Weight>0</Weight>
 
<WeightUOM>
 
<UOM>
 
<UOMID>3</UOMID>
 
<Name>Pound</Name>
 
{{n|Code}}lbs{{n|/Code}}
 
<Integral>false</Integral>
 
<Active>true</Active>
 
<Type>Weight</Type>
 
<UOMConversions>
 
<UOMConversion>
 
<MainUOMID>3</MainUOMID>
 
<ToUOMID>8</ToUOMID>
 
<ToUOMCode>kg</ToUOMCode>
 
<ConversionMultiply>1.0</ConversionMultiply>
 
<ConversionFactor>2.2046000957489014</ConversionFactor>
 
<ToUOMIsIntegral>false</ToUOMIsIntegral>
 
</UOMConversion>
 
</UOMConversions>
 
</UOM>
 
</WeightUOM>
 
<DisplayWeight>0</DisplayWeight>
 
<DisplayWeightUOM>
 
<UOM>
 
<UOMID>3</UOMID>
 
<Name>Pound</Name>
 
{{n|Code}}lbs{{n|/Code}}
 
<Integral>false</Integral>
 
<Active>true</Active>
 
<Type>Weight</Type>
 
<UOMConversions>
 
<UOMConversion>
 
<MainUOMID>3</MainUOMID>
 
<ToUOMID>8</ToUOMID>
 
<ToUOMCode>kg</ToUOMCode>
 
<ConversionMultiply>1.0</ConversionMultiply>
 
<ConversionFactor>2.2046000957489014</ConversionFactor>
 
<ToUOMIsIntegral>false</ToUOMIsIntegral>
 
</UOMConversion>
 
</UOMConversions>
 
</UOM>
 
</DisplayWeightUOM>
 
<Tracking />
 
</ShippingItem>
 
</ShippingItems>
 
</Carton>
 
</Cartons>
 
</Shipping>
 
 
 
 
 
{{Object|Tag}}
 
'''Description:''' A number that helps describe a location.
 
 
 
'''Syntax:'''
 
<Tag>
 
<TagID>{{r|int}}</TagID>
 
<Num>{{r|int}}</Num>
 
<PartNum />
 
<Location>{{r|{{l|Location}} object}}</Location>
 
<Quantity>{{r|int}}</Quantity>
 
<QuantityCommitted>{{r|int}}</QuantityCommitted>
 
<WONum>{{r|DB string}}</WONum>
 
<DateCreated>{{r|date/time}}</DateCreated>
 
<Tracking />
 
<TypeID>{{r|DB int}}</TypeID>
 
<AccountID>{{r|DB int}}</AccountID>
 
</Tag>
 
 
 
'''Example:'''
 
<Tag>
 
<TagID>376</TagID>
 
<Num>363</Num>
 
<PartNum />
 
<Location>
 
<LocationID>2</LocationID>
 
<TypeID>20</TypeID>
 
<Name>Shipping</Name>
 
<Description>The place where items are packaged and shipped.</Description>
 
<CountedAsAvailable>true</CountedAsAvailable>
 
<Default>true</Default>
 
<Active>true</Active>
 
<Pickable>true</Pickable>
 
<Receivable>true</Receivable>
 
<LocationGroupID>1</LocationGroupID>
 
<LocationGroupName>SLC</LocationGroupName>
 
<SortOrder>10006</SortOrder>
 
<TagID>376</TagID>
 
<TagNumber>363</TagNumber>
 
</Location>
 
<Quantity>0</Quantity>
 
<QuantityCommitted>0</QuantityCommitted>
 
<WONum>N/A</WONum>
 
<DateCreated>2019-08-31T08:16:10</DateCreated>
 
<Tracking />
 
<TypeID>10</TypeID>
 
<AccountID>1</AccountID>
 
</Tag>
 
 
 
 
 
{{Object|Tax Rate}}
 
'''Description:''' Stores tax rate information.
 
 
 
'''Syntax:'''
 
<TaxRate>
 
<ID>{{r|int}}</ID>
 
<Name>{{r|string}}</Name>
 
<Description>{{r|string}}</Description>
 
<Rate>{{r|double}}</Rate>
 
<TypeID>{{r|DB int}}</TypeID>
 
<VendorID>{{r|DB int}}</VendorID>
 
<DefaultFlag>{{r|boolean}}</DefaultFlag>
 
<ActiveFlag>{{r|boolean}}</ActiveFlag>
 
</TaxRate>
 
 
 
'''Example:'''
 
<TaxRate>
 
<ID>2</ID>
 
<Name>Tax</Name>
 
<Description />
 
<Rate>.05</Rate>
 
<TypeID>10</TypeID>
 
<VendorID>6</VendorID>
 
<DefaultFlag>true</DefaultFlag>
 
<ActiveFlag>true</ActiveFlag>
 
</TaxRate>
 
 
 
 
 
{{Object|Tracking}}
 
'''Description:''' This simply contains the TrackingItem objects which contain the information being tracked.
 
 
 
'''Syntax:'''
 
<Tracking>{{r|{{l|Tracking Item}} object}}</Tracking>
 
 
 
'''Example:'''
 
<Tracking>
 
<TrackingItem>
 
<PartTracking>
 
<PartTrackingID>3</PartTrackingID>
 
<Name>Expiration Date</Name>
 
{{n|Abbr}}ExpDate{{n|/Abbr}}
 
<Description />
 
<SortOrder>3</SortOrder>
 
<TrackingTypeID>30</TrackingTypeID>
 
<Active>true</Active>
 
</PartTracking>
 
<TrackingValue>2019-12-08T00:00:00</TrackingValue>
 
</TrackingItem>
 
</Tracking>
 
 
 
 
 
{{Object|Tracking Item}}
 
'''Description:''' This object contains the information being tracked.
 
 
 
'''Syntax:'''
 
<TrackingItem>
 
<PartTracking>
 
<PartTrackingID>{{r|int}}</PartTrackingID>
 
<Name>{{r|string}}</Name>
 
{{n|Abbr}}{{r|string}}{{n|/Abbr}}
 
<Description />
 
<SortOrder>{{r|int}}</SortOrder>
 
<TrackingTypeID>{{r|DB int}}</TrackingTypeID>
 
<Active>{{r|boolean}}</Active>
 
</PartTracking>
 
<TrackingValue>{{r|int / double / string / date}}</TrackingValue>
 
</TrackingItem>
 
 
 
'''Example:'''
 
<TrackingItem>
 
<PartTracking>
 
<PartTrackingID>3</PartTrackingID>
 
<Name>Expiration Date</Name>
 
{{n|Abbr}}ExpDate{{n|/Abbr}}
 
<Description />
 
<SortOrder>3</SortOrder>
 
<TrackingTypeID>30</TrackingTypeID>
 
<Active>true</Active>
 
</PartTracking>
 
<TrackingValue>2019-12-08T00:00:00</TrackingValue>
 
</TrackingItem>
 
 
 
 
 
{{Object|UOM}}
 
'''Description:''' Contains Unit of Measure details.
 
 
 
'''Syntax:'''
 
<UOM>
 
<UOMID>{{r|DB int}}</UOMID>
 
<Name>{{r|string}}</Name>
 
{{n|Code}}{{r|DB string}}{{n|/Code}}
 
<Integral>{{r|boolean}}</Integral>
 
<Active>{{r|boolean}}</Active>
 
<Type>{{r|DB string}}</Type>
 
<UOMConversions>
 
<UOMConversion>{{r|{{l|UOM Conversion}} object}}</UOMConversion>
 
</UOMConversions>
 
</UOM>
 
 
 
'''Example:'''
 
<UOM>
 
<UOMID>1</UOMID>
 
<Name>Each</Name>
 
{{n|Code}}ea{{n|/Code}}
 
<Integral>true</Integral>
 
<Active>true</Active>
 
<Type>Count</Type>
 
<UOMConversions>
 
<UOMConversion>
 
<MainUOMID>1</MainUOMID>
 
<ToUOMID>17</ToUOMID>
 
<ToUOMCode>pr</ToUOMCode>
 
<ConversionMultiply>1.0</ConversionMultiply>
 
<ConversionFactor>2.0</ConversionFactor>
 
<ToUOMIsIntegral>false</ToUOMIsIntegral>
 
</UOMConversion>
 
<UOMConversion>
 
<MainUOMID>1</MainUOMID>
 
<ToUOMID>18</ToUOMID>
 
<ToUOMCode>pk</ToUOMCode>
 
<ConversionMultiply>1.0</ConversionMultiply>
 
<ConversionFactor>20.0</ConversionFactor>
 
<ToUOMIsIntegral>false</ToUOMIsIntegral>
 
</UOMConversion>
 
</UOMConversions>
 
</UOM>
 
 
 
 
 
{{Object|UOM Conversion}}
 
'''Description:''' Stores conversion information for a Unit of Measure.
 
 
 
'''Syntax:'''
 
<UOMConversion>
 
<MainUOMID>{{r|DB int}}</MainUOMID>
 
<ToUOMID>{{r|DB int}}</ToUOMID>
 
<ToUOMCode>{{r|DB string}}</ToUOMCode>
 
<ConversionMultiply>{{r|double}}</ConversionMultiply>
 
<ConversionFactor>{{r|double}}</ConversionFactor>
 
<ToUOMIsIntegral>{{r|boolean}}</ToUOMIsIntegral>
 
</UOMConversion>
 
 
 
'''Example:'''
 
<UOMConversion>
 
<MainUOMID>1</MainUOMID>
 
<ToUOMID>17</ToUOMID>
 
<ToUOMCode>pr</ToUOMCode>
 
<ConversionMultiply>1.0</ConversionMultiply>
 
<ConversionFactor>2.0</ConversionFactor>
 
<ToUOMIsIntegral>false</ToUOMIsIntegral>
 
</UOMConversion>
 
 
 
 
 
{{Object|User}}
 
'''Description:''' User details.
 
 
 
'''Syntax:'''
 
<User>
 
<ID>{{r|int}}</ID>
 
<UserName>{{r|string}}</UserName>
 
<FirstName>{{r|string}}</FirstName>
 
<LastName>{{r|string}}</LastName>
 
<Initials>{{r|string}}</Initials>
 
<Active>{{r|boolean}}</Active>
 
</User>
 
 
 
'''Example:'''
 
<User>
 
<ID>1</ID>
 
<UserName>admin</UserName>
 
<FirstName>Administrator</FirstName>
 
<LastName>Administrator</LastName>
 
<Initials>ADM</Initials>
 
<Active>true</Active>
 
</User>
 
 
 
 
 
{{Object|Vendor}}
 
'''Description:''' Contains all the vendor information and details.
 
 
 
'''Syntax:'''
 
<Vendor>
 
<VendorID>{{r|int}}</VendorID>
 
<AccountID>{{r|int}}</AccountID>
 
<Status>{{r|string}}</Status>
 
<DefPaymentTerms>{{r|string}}</DefPaymentTerms>
 
<DefShipTerms>{{r|string}}</DefShipTerms>
 
<TaxRate>{{r|string}}</TaxRate>
 
<Name>{{r|string}}</Name>
 
<Number>{{r|string}}</Number>
 
<DateCreated>{{r|date/time}}</DateCreated>
 
<DateModified>{{r|date/time}}</DateModified>
 
<LastChangedUser>{{r|string}}</LastChangedUser>
 
<CreditLimit>{{r|price}}</CreditLimit>
 
<Note>{{r|string}}</Note>
 
<AysUserID>{{r|int}}</AysUserID>
 
<ActiveFlag>{{r|boolean}}</ActiveFlag>
 
<AccountingID>{{r|string}}</AccountingID>
 
<AccountingHash>{{r|string}}</AccountingHash>
 
<CurrencyName>{{r|DB string}}</CurrencyName>
 
<CurrencyRate>{{r|double}}</CurrencyRate>
 
<LeadTime>{{r|int}}</LeadTime>
 
<Addresses>{{r|{{l|Address}} objects}}</Addresses>
 
<CustomFields>{{r|{{l|Custom Field}} objects}}</CustomFields>
 
</Vendor>
 
 
 
'''Example:'''
 
<Vendor>
 
<VendorID>8</VendorID>
 
<AccountID>206</AccountID>
 
<Status>Normal</Status>
 
<DefPaymentTerms>COD</DefPaymentTerms>
 
<DefShipTerms>Prepaid &amp;amp; Billed</DefShipTerms>
 
<Name>A&amp;amp;B Distribution</Name>
 
<Number>5</Number>
 
<DateCreated>2019-02-07T14:31:34</DateCreated>
 
<DateModified>2019-03-09T13:41:06</DateModified>
 
<LastChangedUser>admin</LastChangedUser>
 
<CreditLimit>0</CreditLimit>
 
<Note />
 
<ActiveFlag>true</ActiveFlag>
 
<AccountingID>67265</AccountingID>
 
<AccountingHash>12345</AccountingHash>
 
<Addresses />
 
</Vendor>
 
 
 
 
 
{{Object|Vendor Part Number}}
 
'''Description:''' Contains the number that a vendor uses to refer to a part that you may reference differently. A value is required in order to create a valid object.
 
 
 
'''Syntax:'''
 
<VendorPartNumber>
 
<Number>{{r|string}}</Number>
 
</VendorPartNumber>
 
 
 
'''Example:'''
 
<VendorPartNumber>
 
<Number>B16-76876</Number>
 
</VendorPartNumber>
 
 
 
 
 
{{Object|Work Order}}
 
'''Description:''' Contains all the work order information and details.
 
 
 
'''Syntax:'''
 
<WO>
 
<ID>{{r|int}}</ID>
 
<Num>{{r|string}}</Num>
 
<Type>{{r|DB String}}</Type>
 
<TypeID>{{r|DB int}}</TypeID>
 
<MOItemID>{{r|DB int}}</MOItemID>
 
<WOItems>
 
<WOItem>{{r|{{l|Work Order Item}} object}}</WOItem>
 
</WOItems>
 
<Cost>{{r|int}}</Cost>
 
<Location>
 
<Location>{{r|{{l|Location}} object}}</Location>
 
</Location>
 
<LocationGroup>{{r|{{l|Location Group}} object}}</LocationGroup>
 
<Note />
 
<StatusID>{{r|DB int}}</StatusID>
 
<QBClass>{{r|DB string}}</QBClass>
 
<QBClassID>{{r|DB int}}</QBClassID>
 
<QtyOrdered>{{r|int}}</QtyOrdered>
 
<QtyTarget>{{r|int}}</QtyTarget>
 
<DateCreated>{{r|date/time}}</DateCreated>
 
<DateFinished>{{r|date/time}}</DateFinished>
 
<DateLastModified>{{r|date/time}}</DateLastModified>
 
<DateScheduled>{{r|date/time}}</DateScheduled>
 
<DateStarted>{{r|date/time}}</DateStarted>
 
<User>{{r|{{l|User}} object}}</User>
 
</WO>
 
 
 
'''Example:'''
 
<WO>
 
<ID>1</ID>
 
<Num>1 001</Num>
 
<Type>Manufacture</Type>
 
<TypeID>6</TypeID>
 
<MOItemID>1</MOItemID>
 
<WOItems>
 
<WOItem>
 
<ID>1</ID>
 
<MOItemID>2</MOItemID>
 
<TypeID>10</TypeID>
 
<Part>
 
<PartID>36</PartID>
 
<PartClassID>0</PartClassID>
 
<TypeID>10</TypeID>
 
<UOM>
 
<UOMID>1</UOMID>
 
<Name>Each</Name>
 
{{n|Code}}ea{{n|/Code}}
 
<Integral>true</Integral>
 
<Active>true</Active>
 
<Type>Count</Type>
 
<UOMConversions>
 
<UOMConversion>
 
<MainUOMID>1</MainUOMID>
 
<ToUOMID>17</ToUOMID>
 
<ToUOMCode>pr</ToUOMCode>
 
<ConversionMultiply>1.0</ConversionMultiply>
 
<ConversionFactor>2.0</ConversionFactor>
 
<ToUOMIsIntegral>false</ToUOMIsIntegral>
 
</UOMConversion>
 
<UOMConversion>
 
<MainUOMID>1</MainUOMID>
 
<ToUOMID>18</ToUOMID>
 
<ToUOMCode>pk</ToUOMCode>
 
<ConversionMultiply>1.0</ConversionMultiply>
 
<ConversionFactor>20.0</ConversionFactor>
 
<ToUOMIsIntegral>false</ToUOMIsIntegral>
 
</UOMConversion>
 
</UOMConversions>
 
</UOM>
 
<Num>BB2002</Num>
 
<Description>Comfort Bike</Description>
 
<Details />
 
<StandardCost>0</StandardCost>
 
<HasBOM>false</HasBOM>
 
<Configurable>false</Configurable>
 
<ActiveFlag>true</ActiveFlag>
 
<SerializedFlag>true</SerializedFlag>
 
<TrackingFlag>true</TrackingFlag>
 
<Weight>20</Weight>
 
<WeightUOM>
 
<UOM>
 
<UOMID>3</UOMID>
 
<Name>Pound</Name>
 
{{n|Code}}lbs{{n|/Code}}
 
<Integral>false</Integral>
 
<Active>true</Active>
 
<Type>Weight</Type>
 
<UOMConversions>
 
<UOMConversion>
 
<MainUOMID>3</MainUOMID>
 
<ToUOMID>8</ToUOMID>
 
<ToUOMCode>kg</ToUOMCode>
 
<ConversionMultiply>1.0</ConversionMultiply>
 
<ConversionFactor>2.2046000957489014</ConversionFactor>
 
<ToUOMIsIntegral>false</ToUOMIsIntegral>
 
</UOMConversion>
 
</UOMConversions>
 
</UOM>
 
</WeightUOM>
 
<Width>0</Width>
 
<Height>0</Height>
 
<Len>0</Len>
 
<SizeUOM>
 
<UOM>
 
<UOMID>2</UOMID>
 
<Name>Foot</Name>
 
{{n|Code}}ft{{n|/Code}}
 
<Integral>false</Integral>
 
<Active>true</Active>
 
<Type>Length</Type>
 
<UOMConversions>
 
<UOMConversion>
 
<MainUOMID>2</MainUOMID>
 
<ToUOMID>7</ToUOMID>
 
<ToUOMCode>in</ToUOMCode>
 
<ConversionMultiply>12.0</ConversionMultiply>
 
<ConversionFactor>1.0</ConversionFactor>
 
<ToUOMIsIntegral>false</ToUOMIsIntegral>
 
</UOMConversion>
 
<UOMConversion>
 
<MainUOMID>2</MainUOMID>
 
<ToUOMID>9</ToUOMID>
 
<ToUOMCode>m</ToUOMCode>
 
<ConversionMultiply>1.0</ConversionMultiply>
 
<ConversionFactor>3.2808001041412354</ConversionFactor>
 
<ToUOMIsIntegral>false</ToUOMIsIntegral>
 
</UOMConversion>
 
</UOMConversions>
 
</UOM>
 
</SizeUOM>
 
<UPC />
 
<PartTrackingList>
 
<PartTracking>
 
<PartTrackingID>4</PartTrackingID>
 
<Name>Serial Number</Name>
 
{{n|Abbr}}SN(s){{n|/Abbr}}
 
<Description />
 
<SortOrder>4</SortOrder>
 
<TrackingTypeID>40</TrackingTypeID>
 
<Active>true</Active>
 
<Primary>true</Primary>
 
</PartTracking>
 
</PartTrackingList>
 
<VendorPartNums>
 
<VendorPartNumber>
 
<Number>BB2002</Number>
 
</VendorPartNumber>
 
<VendorPartNumber>
 
<Number>BB2002</Number>
 
</VendorPartNumber>
 
</VendorPartNums>
 
</Part>
 
<Description>Create BB2002</Description>
 
<Cost>$0.00</Cost>
 
<DateScheduled>2019-11-04T00:00:00</DateScheduled>
 
<InstructionNote />
 
<InstructionURL />
 
<QtyScrapped>0</QtyScrapped>
 
<QtyToFulfill>1</QtyToFulfill>
 
<QtyUsed>1</QtyUsed>
 
<DestLocation>
 
<Location>
 
<LocationID>10</LocationID>
 
<TypeID>70</TypeID>
 
<Name>Store Front</Name>
 
<Description>Point of Sale location</Description>
 
<CountedAsAvailable>true</CountedAsAvailable>
 
<Default>true</Default>
 
<Active>true</Active>
 
<Pickable>true</Pickable>
 
<Receivable>true</Receivable>
 
<LocationGroupID>1</LocationGroupID>
 
<LocationGroupName>SLC</LocationGroupName>
 
<SortOrder>10013</SortOrder>
 
<TagID>384</TagID>
 
<TagNumber>371</TagNumber>
 
</Location>
 
</DestLocation>
 
<UOM>
 
<UOMID>1</UOMID>
 
<Name>Each</Name>
 
{{n|Code}}ea{{n|/Code}}
 
<Integral>true</Integral>
 
<Active>true</Active>
 
<Type>Count</Type>
 
<UOMConversions>
 
<UOMConversion>
 
<MainUOMID>1</MainUOMID>
 
<ToUOMID>17</ToUOMID>
 
<ToUOMCode>pr</ToUOMCode>
 
<ConversionMultiply>1.0</ConversionMultiply>
 
<ConversionFactor>2.0</ConversionFactor>
 
<ToUOMIsIntegral>false</ToUOMIsIntegral>
 
</UOMConversion>
 
<UOMConversion>
 
<MainUOMID>1</MainUOMID>
 
<ToUOMID>18</ToUOMID>
 
<ToUOMCode>pk</ToUOMCode>
 
<ConversionMultiply>1.0</ConversionMultiply>
 
<ConversionFactor>20.0</ConversionFactor>
 
<ToUOMIsIntegral>false</ToUOMIsIntegral>
 
</UOMConversion>
 
</UOMConversions>
 
</UOM>
 
<Tracking />
 
<SortID>1</SortID>
 
</WOItem>
 
</WOItems>
 
<Cost>0</Cost>
 
<Location>
 
<Location>
 
<LocationID>9</LocationID>
 
<TypeID>80</TypeID>
 
<Name>Manufacturing</Name>
 
<Description>The place where things are Manufactured</Description>
 
<CountedAsAvailable>true</CountedAsAvailable>
 
<Default>true</Default>
 
<Active>true</Active>
 
<Pickable>true</Pickable>
 
<Receivable>true</Receivable>
 
<LocationGroupID>1</LocationGroupID>
 
<LocationGroupName>SLC</LocationGroupName>
 
<SortOrder>10004</SortOrder>
 
<TagID>383</TagID>
 
<TagNumber>370</TagNumber>
 
</Location>
 
</Location>
 
<LocationGroup>
 
<LocationGroup>
 
<LocationGroupID>1</LocationGroupID>
 
<LocationGroupName>SLC</LocationGroupName>
 
<DefaultQBClassID>2</DefaultQBClassID>
 
</LocationGroup>
 
</LocationGroup>
 
<Note />
 
<StatusID>40</StatusID>
 
<QBClass>None</QBClass>
 
<QBClassID>1</QBClassID>
 
<QtyOrdered>1</QtyOrdered>
 
<QtyTarget>1</QtyTarget>
 
<DateCreated>2019-11-04T16:59:40</DateCreated>
 
<DateFinished>2019-11-04T17:01:07</DateFinished>
 
<DateLastModified>2019-11-04T17:01:07</DateLastModified>
 
<DateScheduled>2019-11-04T00:00:00</DateScheduled>
 
<DateStarted>2019-11-04T16:59:40</DateStarted>
 
<User>
 
<User>
 
<ID>1</ID>
 
<UserName>admin</UserName>
 
<FirstName>Administrator</FirstName>
 
<LastName>Administrator</LastName>
 
<Initials>ADM</Initials>
 
<Active>true</Active>
 
</User>
 
</User>
 
</WO>
 
 
 
 
 
{{Object|Work Order Item}}
 
'''Description:''' Stores information about an item found in a work order.
 
 
 
'''Syntax:'''
 
<WOItem>
 
<ID>{{r|int}}</ID>
 
<MOItemID>{{r|DB int}}</MOItemID>
 
<TypeID>{{r|DB int}}</TypeID>
 
<Part>{{r|{{l|Part}} object}}</Part>
 
<Description>{{r|string}}</Description>
 
<Cost>{{r|string}}</Cost>
 
<DateScheduled>2019-11-04T00:00:00</DateScheduled>
 
<InstructionNote />
 
<InstructionURL />
 
<QtyScrapped>{{r|int}}</QtyScrapped>
 
<QtyToFulfill>{{r|int}}</QtyToFulfill>
 
<QtyUsed>{{r|int}}</QtyUsed>
 
<DestLocation>
 
<Location>{{r|{{l|Location}} object}}</Location>
 
</DestLocation>
 
<UOM>{{r|{{l|UOM}} object}}</UOM>
 
<Tracking />
 
<SortID>{{r|int}}</SortID>
 
</WOItem>
 
 
 
'''Example:'''
 
<WOItem>
 
<ID>1</ID>
 
<MOItemID>2</MOItemID>
 
<TypeID>10</TypeID>
 
<Part>
 
<PartID>36</PartID>
 
<PartClassID>0</PartClassID>
 
<TypeID>10</TypeID>
 
<UOM>
 
<UOMID>1</UOMID>
 
<Name>Each</Name>
 
{{n|Code}}ea{{n|/Code}}
 
<Integral>true</Integral>
 
<Active>true</Active>
 
<Type>Count</Type>
 
<UOMConversions>
 
<UOMConversion>
 
<MainUOMID>1</MainUOMID>
 
<ToUOMID>17</ToUOMID>
 
<ToUOMCode>pr</ToUOMCode>
 
<ConversionMultiply>1.0</ConversionMultiply>
 
<ConversionFactor>2.0</ConversionFactor>
 
<ToUOMIsIntegral>false</ToUOMIsIntegral>
 
</UOMConversion>
 
<UOMConversion>
 
<MainUOMID>1</MainUOMID>
 
<ToUOMID>18</ToUOMID>
 
<ToUOMCode>pk</ToUOMCode>
 
<ConversionMultiply>1.0</ConversionMultiply>
 
<ConversionFactor>20.0</ConversionFactor>
 
<ToUOMIsIntegral>false</ToUOMIsIntegral>
 
</UOMConversion>
 
</UOMConversions>
 
</UOM>
 
<Num>BB2002</Num>
 
<Description>Comfort Bike</Description>
 
<Details />
 
<StandardCost>0</StandardCost>
 
<HasBOM>false</HasBOM>
 
<Configurable>false</Configurable>
 
<ActiveFlag>true</ActiveFlag>
 
<SerializedFlag>true</SerializedFlag>
 
<TrackingFlag>true</TrackingFlag>
 
<Weight>20</Weight>
 
<WeightUOM>
 
<UOM>
 
<UOMID>3</UOMID>
 
<Name>Pound</Name>
 
{{n|Code}}lbs{{n|/Code}}
 
<Integral>false</Integral>
 
<Active>true</Active>
 
<Type>Weight</Type>
 
<UOMConversions>
 
<UOMConversion>
 
<MainUOMID>3</MainUOMID>
 
<ToUOMID>8</ToUOMID>
 
<ToUOMCode>kg</ToUOMCode>
 
<ConversionMultiply>1.0</ConversionMultiply>
 
<ConversionFactor>2.2046000957489014</ConversionFactor>
 
<ToUOMIsIntegral>false</ToUOMIsIntegral>
 
</UOMConversion>
 
</UOMConversions>
 
</UOM>
 
</WeightUOM>
 
<Width>0</Width>
 
<Height>0</Height>
 
<Len>0</Len>
 
<SizeUOM>
 
<UOM>
 
<UOMID>2</UOMID>
 
<Name>Foot</Name>
 
{{n|Code}}ft{{n|/Code}}
 
<Integral>false</Integral>
 
<Active>true</Active>
 
<Type>Length</Type>
 
<UOMConversions>
 
<UOMConversion>
 
<MainUOMID>2</MainUOMID>
 
<ToUOMID>7</ToUOMID>
 
<ToUOMCode>in</ToUOMCode>
 
<ConversionMultiply>12.0</ConversionMultiply>
 
<ConversionFactor>1.0</ConversionFactor>
 
<ToUOMIsIntegral>false</ToUOMIsIntegral>
 
</UOMConversion>
 
<UOMConversion>
 
<MainUOMID>2</MainUOMID>
 
<ToUOMID>9</ToUOMID>
 
<ToUOMCode>m</ToUOMCode>
 
<ConversionMultiply>1.0</ConversionMultiply>
 
<ConversionFactor>3.2808001041412354</ConversionFactor>
 
<ToUOMIsIntegral>false</ToUOMIsIntegral>
 
</UOMConversion>
 
</UOMConversions>
 
</UOM>
 
</SizeUOM>
 
<UPC />
 
<PartTrackingList>
 
<PartTracking>
 
<PartTrackingID>4</PartTrackingID>
 
<Name>Serial Number</Name>
 
{{n|Abbr}}SN(s){{n|/Abbr}}
 
<Description />
 
<SortOrder>4</SortOrder>
 
<TrackingTypeID>40</TrackingTypeID>
 
<Active>true</Active>
 
<Primary>true</Primary>
 
</PartTracking>
 
</PartTrackingList>
 
<VendorPartNums>
 
<VendorPartNumber>
 
<Number>BB2002</Number>
 
</VendorPartNumber>
 
<VendorPartNumber>
 
<Number>BB2002</Number>
 
</VendorPartNumber>
 
</VendorPartNums>
 
</Part>
 
<Description>Create BB2002</Description>
 
<Cost>$0.00</Cost>
 
<DateScheduled>2019-11-04T00:00:00</DateScheduled>
 
<InstructionNote />
 
<InstructionURL />
 
<QtyScrapped>0</QtyScrapped>
 
<QtyToFulfill>1</QtyToFulfill>
 
<QtyUsed>1</QtyUsed>
 
<DestLocation>
 
<Location>
 
<LocationID>10</LocationID>
 
<TypeID>70</TypeID>
 
<Name>Store Front</Name>
 
<Description>Point of Sale location</Description>
 
<CountedAsAvailable>true</CountedAsAvailable>
 
<Default>true</Default>
 
<Active>true</Active>
 
<Pickable>true</Pickable>
 
<Receivable>true</Receivable>
 
<LocationGroupID>1</LocationGroupID>
 
<LocationGroupName>SLC</LocationGroupName>
 
<SortOrder>10013</SortOrder>
 
<TagID>384</TagID>
 
<TagNumber>371</TagNumber>
 
</Location>
 
</DestLocation>
 
<UOM>
 
<UOMID>1</UOMID>
 
<Name>Each</Name>
 
{{n|Code}}ea{{n|/Code}}
 
<Integral>true</Integral>
 
<Active>true</Active>
 
<Type>Count</Type>
 
<UOMConversions>
 
<UOMConversion>
 
<MainUOMID>1</MainUOMID>
 
<ToUOMID>17</ToUOMID>
 
<ToUOMCode>pr</ToUOMCode>
 
<ConversionMultiply>1.0</ConversionMultiply>
 
<ConversionFactor>2.0</ConversionFactor>
 
<ToUOMIsIntegral>false</ToUOMIsIntegral>
 
</UOMConversion>
 
<UOMConversion>
 
<MainUOMID>1</MainUOMID>
 
<ToUOMID>18</ToUOMID>
 
<ToUOMCode>pk</ToUOMCode>
 
<ConversionMultiply>1.0</ConversionMultiply>
 
<ConversionFactor>20.0</ConversionFactor>
 
<ToUOMIsIntegral>false</ToUOMIsIntegral>
 
</UOMConversion>
 
</UOMConversions>
 
</UOM>
 
<Tracking />
 
<SortID>1</SortID>
 
</WOItem>
 
 
 
 
 
 
 
 
 
<span style="font-size:200%;">'''REQUESTS'''</span>
 
 
 
{{Request|Add Inventory}}
 
'''Description:''' Adds initial inventory of a part.
 
 
 
'''Added''': 2011.4
 
 
 
'''Syntax:'''
 
<AddInventoryRq>
 
<PartNum>{{r|string}}</PartNum>
 
<Quantity>{{r|int}}</Quantity>
 
<UOMID>{{r|int}}</UOMID>
 
<Cost>{{r|price}}</Cost>
 
<Note>{{r|string}}</Note>
 
<Tracking>{{r|{{l|Tracking}} object}}</Tracking>
 
<LocationTagNum>{{r|int}}</LocationTagNum>
 
<TagNum>{{r|int}}</TagNum>
 
</AddInventoryRq>
 
 
 
'''Example:'''
 
<FbiXml>
 
<Ticket>
 
<Key>0YTKh8o41LXLgnLgbqvdAQ==</Key>
 
</Ticket>
 
<FbiMsgsRq>
 
<AddInventoryRq>
 
<PartNum>B201</PartNum>
 
<Quantity>5</Quantity>
 
<UOMID>1</UOMID>
 
<Cost>25.00</Cost>
 
<Note>Initial inventory for B201</Note>
 
<LocationTagNum>106</LocationTagNum>
 
<TagNum>0</TagNum>
 
</AddInventoryRq>
 
</FbiMsgsRq>
 
</FbiXml>
 
 
 
 
 
{{Request|Add Memo}}
 
'''Description:''' Adds a memo to the specified object.
 
 
 
'''Added''': 2014.0
 
 
 
'''Syntax:'''
 
<AddMemoRq>
 
<ItemType>{{r|Part, Product, Customer, Vendor, SO, PO, TO, MO, RMA, BOM}}</ItemType>
 
<PartNum>{{r|string}}</PartNum>
 
<ProductNum>{{r|string}}</ProductNum>
 
<OrderNum>{{r|string}}</OrderNum>
 
<CustomerNum>{{r|string}}</CustomerNum>
 
<VendorNum>{{r|string}}</VendorNum>
 
<Memo>{{r|{{l|Memo}} object}}</Memo>
 
</AddMemoRq>
 
 
 
'''Example:'''
 
<FbiXml>
 
<Ticket>
 
<Key>0YTKh8o41LXLgnLgbqvdAQ==</Key>
 
</Ticket>
 
<FbiMsgsRq>
 
<AddMemoRq>
 
<ItemType>Part</ItemType>
 
<PartNum>B201</PartNum>
 
<Memo>
 
<Memo>This is a test</Memo>
 
<UserName>admin</UserName>
 
</Memo>
 
</AddMemoRq>
 
</FbiMsgsRq>
 
</FbiXml>
 
 
 
 
 
{{Request|Add SO Item}}
 
'''Description:''' Adds an item to a Sales Order.
 
 
 
'''Added''': 2012.3
 
 
 
'''Syntax:'''
 
<AddSOItemRq>
 
<OrderNum>{{r|string}}</OrderNum>
 
<SalesOrderItem>{{r|{{l|Sales Order Item}} object}}</SalesOrderItem>
 
</AddSOItemRq>
 
 
 
'''Example:'''
 
<FbiXml>
 
<Ticket>
 
<Key>0YTKh8o41LXLgnLgbqvdAQ==</Key>
 
</Ticket>
 
<FbiMsgsRq>
 
<AddSOItemRq>
 
<OrderNum>50050</OrderNum>
 
<SalesOrderItem>
 
<ID>-1</ID>
 
<ProductNumber>BTY100-Core</ProductNumber>
 
<SOID>94</SOID>
 
<Description>Battery Pack</Description>
 
<Taxable>true</Taxable>
 
<Quantity>1</Quantity>
 
<ProductPrice>-95.00</ProductPrice>
 
<TotalPrice>-95.00</TotalPrice>
 
<UOMCode>ea</UOMCode>
 
<ItemType>20</ItemType>
 
<Status>10</Status>
 
<QuickBooksClassName>Salt Lake City</QuickBooksClassName>
 
</SalesOrderItem>
 
</AddSOItemRq>
 
</FbiMsgsRq>
 
</FbiXml>
 
 
 
 
 
{{Request|Add WO Item}}
 
'''Description:''' Add an item to an existing open WO.
 
 
 
'''Added''': 2015.2
 
 
 
'''Syntax:'''
 
<AddWorkOrderItemRq>
 
<OrderNum>{{r|string}}</OrderNum>
 
<TypeId>{{r|DB int}}</TypeId>
 
<Description>{{r|string}}</Description>
 
<PartNum>{{r|string}}</PartNum>
 
<Quantity>{{r|int}}</Quantity>
 
<UOMCode>{{r|string}}</UOMCode>
 
<Cost>{{r|Money}}</Cost>
 
</AddWorkOrderItemRq>
 
 
 
'''Example:'''
 
<FbiXml>
 
<Ticket>
 
<Key>0YTKh8o41LXLgnLgbqvdAQ==</Key>
 
</Ticket>
 
<FbiMsgsRq>
 
<AddWorkOrderItemRq>
 
<OrderNum>502 001</OrderNum>
 
<Description>This will create a note item.</Description>
 
</AddWorkOrderItemRq>
 
</FbiMsgsRq>
 
</FbiXml>
 
 
 
 
 
{{Request|Build BOM}}
 
'''Description:''' Adjust the inventory in a tag.
 
 
 
'''Added''': 2016.3
 
 
 
'''Syntax:'''
 
<BuildBomRq>
 
<BomNumber>{{r|string}}</BomNumber>
 
<Quantity>{{r|int}}</Quantity>
 
<DateScheduled>{{r|Date}}</DateScheduled>
 
</BuildBomRq>
 
 
 
'''Example:'''
 
<FbiXml>
 
<Ticket>
 
<Key>0YTKh8o41LXLgnLgbqvdAQ==</Key>
 
</Ticket>
 
<FbiMsgsRq>
 
<BuildBomRq>
 
<BomNumber>BB2001</BomNumber>
 
<Quantity>1</Quantity>
 
<DateScheduled>2015-12-28 00 00 00</DateScheduled>
 
</BuildBomRq>
 
</FbiMsgsRq>
 
</FbiXml>
 
 
 
 
 
{{Request|Calculate SO}}
 
'''Description:''' This generates a shipping order that is completely fictitious. You would use this request to calculate the cost etc. If you want to actually process this order you need to use the Save.
 
 
 
'''Syntax:'''
 
<CalculateSORq>
 
<SalesOrder>{{r|{{l|Sales Order}} object}}</SalesOrder>
 
</CalculateSORq>
 
 
 
'''Example:'''
 
<FbiXml>
 
<Ticket>
 
<Key>0YTKh8o41LXLgnLgbqvdAQ==</Key>
 
</Ticket>
 
<FbiMsgsRq>
 
<CalculateSORq>
 
<SalesOrder>
 
<Salesman>admin</Salesman>
 
<Number>500100</Number>
 
<Status>20</Status>
 
<Carrier>Will Call</Carrier>
 
<FirstShipDate>2019-08-29T00:00:00</FirstShipDate>
 
<CreatedDate>2019-08-29T00:00:00</CreatedDate>
 
<IssuedDate>2019-08-29T16:48:56</IssuedDate>
 
<TaxRatePercentage>0.0625</TaxRatePercentage>
 
<TaxRateName>Utah</TaxRateName>
 
<ShippingTerms>Prepaid &amp;amp; Billed</ShippingTerms>
 
<PaymentTerms>COD</PaymentTerms>
 
<CustomerContact>Beach Bike</CustomerContact>
 
<CustomerName>Beach Bike</CustomerName>
 
<FOB>Origin</FOB>
 
<QuickBooksClassName>Salt Lake City</QuickBooksClassName>
 
<LocationGroup>SLC</LocationGroup>
 
<BillTo>
 
<Name>Beach Bike</Name>
 
<AddressField>555 Suntan Ave.</AddressField>
 
<City>Santa Barbara</City>
 
<Zip>93101</Zip>
 
</BillTo>
 
<Ship>
 
<Name>Beach Bike</Name>
 
<AddressField>555 Suntan Ave.</AddressField>
 
<Zip>93101</Zip>
 
<Country>US</Country>
 
<State>California</State>
 
</Ship>
 
<SalesOrderItem>
 
<ID>-1</ID>
 
<ProductNumber>BTY100</ProductNumber>
 
<SOID>93</SOID>
 
<Description>Battery Pack</Description>
 
<Taxable>true</Taxable>
 
<Quantity>1</Quantity>
 
<ProductPrice>95.00</ProductPrice>
 
<TotalPrice>95.00</TotalPrice>
 
<UOMCode>ea</UOMCode>
 
<ItemType>10</ItemType>
 
<Status>10</Status>
 
<QuickBooksClassName>Salt Lake City</QuickBooksClassName>
 
<LineNumber>1</LineNumber>
 
</SalesOrderItem>
 
<SalesOrderItem>
 
<ID>-1</ID>
 
<ProductNumber>BTY100-Core</ProductNumber>
 
<SOID>94</SOID>
 
<Description>Battery Pack</Description>
 
<Taxable>true</Taxable>
 
<Quantity>1</Quantity>
 
<ProductPrice>-95.00</ProductPrice>
 
<TotalPrice>-95.00</TotalPrice>
 
<UOMCode>ea</UOMCode>
 
<ItemType>20</ItemType>
 
<Status>10</Status>
 
<QuickBooksClassName>Salt Lake City</QuickBooksClassName>
 
<LineNumber>2</LineNumber>
 
</SalesOrderItem>
 
</SalesOrder>
 
</CalculateSORq>
 
</FbiMsgsRq>
 
</FbiXml>
 
 
 
 
 
{{Request|Carrier List}}
 
'''Description:''' Returns the names of every {{l|Carrier}} in your database.
 
 
 
'''Syntax:'''
 
<CarrierListRq />
 
 
 
'''Example:'''
 
<FbiXml>
 
<Ticket>
 
<Key>u6fGkTFmq8iM/b2SkaLkcg==</Key>
 
</Ticket>
 
<FbiMsgsRq>
 
<CarrierListRq />
 
</FbiMsgsRq>
 
</FbiXml>
 
 
 
 
 
{{Request|Close Short SO}}
 
'''Description:''' This request is used to close short a sales order
 
 
 
'''Syntax:'''
 
<CloseShortSORq>{{r|SO Number}}</CloseShortSORq>
 
 
 
'''Example:'''
 
<FbiXml>
 
<Ticket>
 
<Key>XDYDr8TtbhGgZ+jg+XJQMQ==</Key>
 
</Ticket>
 
<FbiMsgsRq>
 
<CloseShortSORq>
 
<SONumber>50069</SONumber>
 
</CloseShortSORq>
 
</FbiMsgsRq>
 
</FbiXml>
 
 
 
 
 
{{Request|Customer Get}}
 
'''Description:''' This returns a {{l|Customer}} object from your database with all the data associated with that customer ''Note When currency rate is 0 then customer is using the default currency rate ''
 
 
 
'''Syntax:'''
 
<CustomerGetRq>
 
<Name>{{r|{{l|Customer}} Name}}</Name>
 
</CustomerGetRq>
 
 
 
'''Example:'''
 
<FbiXml>
 
<Ticket>
 
<Key>u6fGkTFmq8iM/b2SkaLkcg==</Key>
 
</Ticket>
 
<FbiMsgsRq>
 
<CustomerGetRq>
 
<Name>Nancy Bluer</Name>
 
</CustomerGetRq>
 
</FbiMsgsRq>
 
</FbiXml>
 
 
 
 
 
{{Request|Customer List}}
 
'''Description:''' Returns a list of every {{l|Customer}} in your database with their details.
 
 
 
'''Syntax:'''
 
<CustomerListRq />
 
 
 
'''Example:'''
 
<FbiXml>
 
<Ticket>
 
<Key>OvJtHiwEwgv8d3RWClN1SA==</Key>
 
</Ticket>
 
<FbiMsgsRq>
 
<CustomerListRq />
 
</FbiMsgsRq>
 
</FbiXml>
 
 
 
 
 
{{Request|Customer Name List}}
 
'''Description:''' Returns a list of the names of all the customers in your database.
 
 
 
'''Syntax:'''
 
<CustomerNameListRq />
 
 
 
'''Example:'''
 
<FbiXml>
 
<Ticket>
 
<Key>OvJtHiwEwgv8d3RWClN1SA==</Key>
 
</Ticket>
 
<FbiMsgsRq>
 
<CustomerNameListRq />
 
</FbiMsgsRq>
 
</FbiXml>
 
 
 
 
 
{{Request|Cycle Count}}
 
'''Description:''' Used to correct inventory amounts. Including Tracking information in optional.
 
 
 
'''Syntax:'''
 
<CycleCountRq>
 
<PartNum>{{r|DB int}}</PartNum>
 
<Quantity>{{r|int}}</Quantity>
 
<LocationID>{{r|DB int}}</LocationID>
 
<Tracking>{{r|string}}</Tracking>
 
</CycleCountRq>
 
 
 
'''Example:'''
 
<FbiXml>
 
<Ticket>
 
<Key>xYUGqgHGL/biRP94cZvFGQ==</Key>
 
</Ticket>
 
<FbiMsgsRq>
 
<CycleCountRq>
 
<PartNum>B200</PartNum>
 
<Quantity>10</Quantity>
 
<LocationID>1</LocationID>
 
</CycleCountRq>
 
</FbiMsgsRq>
 
</FbiXml>
 
 
 
 
 
{{Request|Email Report}}
 
'''Description:''' Emails a report to a given email address (Date ranges cannot be specified)
 
 
 
'''Added''': 2015.3
 
 
 
'''Syntax:'''
 
<EmailReportRq>
 
<ReportName>{{r|string}}</ReportName>
 
<ReportTree>{{r|string}}</ReportTree>
 
<Email>{{r|string}}</Email>
 
<ParameterList>
 
<ReportParam>
 
<Name>{{r|string}}</Name>
 
<Value>{{r|string}}</Value>
 
</ReportParam>
 
</ParameterList>
 
</EmailReportRq>
 
 
 
'''Example:'''
 
<FbiXml>
 
<Ticket>
 
<Key>0YTKh8o41LXLgnLgbqvdAQ==</Key>
 
</Ticket>
 
<FbiMsgsRq>
 
<EmailReportRq>
 
<ReportName>Sales Order Summary</ReportName>
 
<ReportTree>Sales Order</ReportTree>
 
<Email>user@email.com</Email>
 
<ParameterList>
 
<ReportParam>
 
<Name>soNum</Name>
 
<Value>50055</Value>
 
</ReportParam>
 
</ParameterList>
 
</EmailReportRq>
 
</FbiMsgsRq>
 
</FbiXml>
 
 
 
 
 
{{Request|Export List}}
 
'''Description:''' Returns all available export options
 
 
 
'''Syntax:'''
 
<ExportListRq />
 
 
 
'''Example:'''
 
<FbiXml>
 
<Ticket>
 
<Key>0YTKh8o41LXLgnLgbqvdAQ==</Key>
 
</Ticket>
 
<FbiMsgsRq>
 
<ExportListRq />
 
</FbiMsgsRq>
 
</FbiXml>
 
 
 
 
 
{{Request|Export}}
 
'''Description:''' Returns export data of specified export type
 
 
 
'''Syntax:'''
 
<ExportRq>
 
<Type>{{r|DB string}}</Type>
 
</ExportRq>
 
 
 
'''Example:'''
 
<ExportRq>
 
<Type>ExportPartCost</Type>
 
</ExportRq>
 
 
 
  
 
{{Request|Execute Query}}
 
{{Request|Execute Query}}
'''Description:''' Returns results of sql query in csv format. Two options are available. A query that has been saved in the Fishbowl Client data module can be executed using<Name> or a query can be placed directly in the call using<Query>.
+
'''Description:''' Returns results of sql query in csv format. Two options are available. A query that has been saved in the Fishbowl Client data module can be executed using Name or a query can be placed directly in the call using Query.
 
 
'''Added''': 2015.0
 
'''Syntax:'''
 
<ExecuteQueryRq>
 
<Name>{{r|DB string}}</Name>(optional)
 
<Query>{{r|DB string}}</Query>(optional)
 
</ExecuteQueryRq>
 
 
 
'''Example:'''
 
<ExecuteQueryRq>
 
<Name>PartList</Name>
 
</ExecuteQueryRq>
 
<ExecuteQueryRq>
 
<Query>SELECT part.num AS partNumber, part.description AS partDescription FROM part</Query>
 
</ExecuteQueryRq>
 
 
 
 
 
{{Request|Get Account List}}
 
'''Description:''' Returns a list of all QuickBooks accounts complete with IDs, types, and balances.
 
 
 
'''Syntax:'''
 
<GetAccountListRq />
 
 
 
'''Example:'''
 
<FbiXml>
 
<Ticket>
 
<Key>/uPlNnEb/k5BGSbo/r6Ffw==</Key>
 
</Ticket>
 
<FbiMsgsRq>
 
<GetAccountListRq />
 
</FbiMsgsRq>
 
</FbiXml>
 
 
 
 
 
{{Request|Get Part List}}
 
'''Description:''' This request will return the information on a specified pick.
 
  
 
'''Syntax:'''
 
'''Syntax:'''
<GetPartListRq>
+
<source>
<PartNum>{{r|DB string}}</PartNum>
+
{
<PartDesc>{{r|string}}</PartDesc>
+
"ExecuteQueryRq": {
<PartDetails>{{r|string}}</PartDetails>
+
"Query": "",
<PartUPC>{{r|string}}</PartUPC>
+
"Name": ""
<PartType>{{r|DB string}}</PartType>
+
}
<ABCCode>{{r|string}}</ABCCode>
+
}
<VendorName>{{r|DB string}}</VendorName>
+
</source>
<VendorNum>{{r|string}}</VendorNum>
 
<ProductNum>{{r|DB string}}</ProductNum>
 
<ProductDesc>{{r|string}}</ProductDesc>
 
<ActiveFlag>{{r|boolean}}</ActiveFlag>
 
<ShowActive>{{r|boolean}}</ShowActive>
 
<ShowInactive>{{r|boolean}}</ShowInactive>
 
<HasBOM>{{r|boolean}}</HasBOM>
 
<Configurable>{{r|boolean}}</Configurable>
 
</GetPartListRq>
 
  
 
'''Example:'''
 
'''Example:'''
<FbiXml>
+
<source>
<Ticket>
+
{
<Key>d8Deicn6ifSV1WZeXPhQ0g==</Key>
+
"FbiJson": {
</Ticket>
+
"Ticket": {
<FbiMsgsRq>
+
"Key": "xTypHT/pZXZy6Re+H66kSA=="
<GetPartListRq>
+
},
<PartNum>B201</PartNum>
+
"FbiMsgsRq": {
</GetPartListRq>
+
"ExecuteQueryRq": {
</FbiMsgsRq>
+
"Name": "PartList"
</FbiXml>
+
}
 
+
}
 
+
}
{{Request|Get Pick}}
+
}
'''Description:''' This request will return the information on a specified pick.
+
</source>
 
+
or
'''Syntax:'''
+
<source>
<GetPickRq>
+
{
<PickNum>{{r|DB string}}</PickNum>
+
"FbiJson": {
</GetPickRq>
+
"Ticket": {
 
+
"Key": "xTypHT/pZXZy6Re+H66kSA=="
'''Example:'''
+
},
<FbiXml>
+
"FbiMsgsRq": {
<Ticket>
+
"ExecuteQueryRq": {
<Key>d8Deicn6ifSV1WZeXPhQ0g==</Key>
+
"Query": "SELECT part.num AS partNumber, part.description AS partDescription FROM part"
</Ticket>
+
}
<FbiMsgsRq>
+
}
<GetPickRq>
+
}
<PickNum>S50023-11</PickNum>
+
}
</GetPickRq>
+
</source>
</FbiMsgsRq>
 
</FbiXml>
 
 
 
 
 
{{Request|Get PO List}}
 
'''Description:''' Returns all purchase order queued in the specified location.
 
 
 
'''Syntax:'''
 
<GetPOListRq>
 
<LocationGroup>{{r|DB string}}</LocationGroup>
 
</GetPOListRq>
 
 
 
'''Example:'''
 
<FbiXml>
 
<Ticket>
 
<Key>d8Deicn6ifSV1WZeXPhQ0g==</Key>
 
</Ticket>
 
<FbiMsgsRq>
 
<GetPOListRq>
 
<LocationGroup>SLC</LocationGroup>
 
</GetPOListRq>
 
</FbiMsgsRq>
 
</FbiXml>
 
 
 
 
 
{{Request|Get Receipt}}
 
'''Description:''' Returns receipt information.
 
 
 
'''Syntax:'''
 
<GetReceiptRq>
 
<OrderNumber>{{r|DB string}}</OrderNumber>
 
<OrderType>{{r|DB int}}</OrderType>
 
<LocationGroup>{{r|DB int}}</LocationGroup>
 
</GetReceiptRq>
 
 
 
'''Example:'''
 
<FbiXml>
 
<Ticket>
 
<Key>OLFQRciNcS6JMqQkrfA4eA==</Key>
 
</Ticket>
 
<FbiMsgsRq>
 
<GetReceiptRq>
 
<OrderNumber>500100</OrderNumber>
 
<OrderType>20</OrderType>
 
<LocationGroup>1</LocationGroup>
 
</GetReceiptRq>
 
</FbiMsgsRq>
 
</FbiXml>
 
 
 
 
 
{{Request|Get Ship List}}
 
'''Description:''' Request a list of Shipments. This includes all those that have been shipped. Be sure to include more specifics on what you want to see. Note You cannot use Order Number in conjunction with Order Type and Carrier. Order Number returns the history of the use of that number, see Example 2. Also, to merit a response you must include the RecordCount field.
 
 
 
'''Syntax:'''
 
<GetShipListRq>
 
<StartRecord>{{r|int}}</StartRecord>
 
<RecordCount>{{r|int}}</RecordCount>
 
<OrderNumber>{{r|int}}</OrderNumber>
 
<OrderTypeID>{{r|DB int}}</OrderTypeID>
 
<LocationGroup>{{r|DB int}}</LocationGroup>
 
<Carrier>{{r|DB int}}</Carrier>
 
</GetShipListRq>
 
 
 
'''Example:'''
 
<FbiXml>
 
<Ticket>
 
<Key>W8uX4j/CyagQZEJ0d1vhfQ==</Key>
 
</Ticket>
 
<FbiMsgsRq>
 
<GetShipListRq>
 
<StartRecord>0</StartRecord>
 
<RecordCount>10</RecordCount>
 
<OrderTypeID>20</OrderTypeID>
 
<StatusID>20</StatusID>
 
<LocationGroup>1</LocationGroup>
 
<Carrier>20</Carrier>
 
</GetShipListRq>
 
</FbiMsgsRq>
 
</FbiXml>
 
 
 
 
 
{{Request|Get Shipment}}
 
'''Description:''' Returns the shipment details about a specified shipment.
 
 
 
'''Syntax:'''
 
<GetShipmentRq>
 
<ShipmentID>{{r|int}}</ShipmentID>
 
<ShipmentNum>{{r|string}}</ShipmentNum>
 
</GetShipmentRq>
 
 
 
'''Example:'''
 
<FbiXml>
 
<Ticket>
 
<Key>Gd/rItkGcV0IwiCcbZpPjg==</Key>
 
</Ticket>
 
<FbiMsgsRq>
 
<GetShipmentRq>
 
<ShipmentNum>S50039</ShipmentNum>
 
</GetShipmentRq>
 
</FbiMsgsRq>
 
</FbiXml>
 
 
 
 
 
{{Request|Get Ship Now List}}
 
'''Description:''' Returns a list of orders that are packed and ready to ship.
 
 
 
'''Syntax:'''
 
<GetShipNowListRq>
 
<LocationGroup>{{r|string}}</LocationGroup>
 
<Carrier>
 
<Name>{{r|string}}</Name>
 
</Carrier>
 
</GetShipNowListRq>
 
 
 
'''Example:'''
 
<FbiXml>
 
<Ticket>
 
<Key>9AYmwzkh9SPd1LPNTbO6lA==</Key>
 
</Ticket>
 
<FbiMsgsRq>
 
<GetShipNowListRq>
 
<LocationGroup>SLC</LocationGroup>
 
<Carrier>
 
<Name>UPS</Name>
 
</Carrier>
 
</GetShipNowListRq>
 
</FbiMsgsRq>
 
</FbiXml>
 
 
 
 
 
{{Request|Get SO List}}
 
'''Description:''' Returns a detailed list of SOs (Sales Orders) based on the search parameters.  
 
 
 
'''Updated:''' 2015.4
 
 
 
'''Syntax:'''
 
<GetSOListRq>
 
<SONum>{{r|string}}</SONum>
 
<LocationGroup>{{r|DB int}}</LocationGroup>
 
<Status>{{r|string}}</Status>
 
<CustomerPO>{{r|string}}</CustomerPO>
 
<CustomerName>{{r|string}}</CustomerName>
 
<AccountNumber>{{r|string}}</AccountNumber>
 
<BillTo>{{r|string}}</BillTo>
 
<ShipTo>{{r|string}}</ShipTo>
 
<ProductNum>{{r|string}}</ProductNum>
 
<ProductDesc>{{r|string}}</ProductDesc>
 
<ProductDetails>{{r|string}}</ProductDetails>
 
<Salesman>{{r|string}}</Salesman>
 
<Type>{{r|string}}</Type>
 
<DateIssuedBegin>{{r|date}}</DateIssuedBegin>
 
<DateIssuedEnd>{{r|date}}</DateIssuedEnd>
 
<DateCreatedBegin>{{r|date}}</DateCreatedBegin>
 
<DateCreatedEnd>{{r|date}}</DateCreatedEnd>
 
<DateLasteModifiedBegin>{{r|date}}</DateLasteModifiedBegin>
 
<DateLasteModifiedEnd>{{r|date}}</DateLasteModifiedEnd>
 
<DateScheduledBegin>{{r|date}}</DateScheduledBegin>
 
<DateScheduledEnd>{{r|date}}</DateScheduledEnd>
 
<DateCompletedBegin>{{r|date}}</DateCompletedBegin>
 
<DateCompletedEnd>{{r|date}}</DateCompletedEnd>
 
</GetSOListRq>
 
 
 
'''Example:'''
 
<FbiXml>
 
<Ticket>
 
<Key>/uPlNnEb/k5BGSbo/r6Ffw==</Key>
 
</Ticket>
 
<FbiMsgsRq>
 
<GetSOListRq>
 
<LocationGroup>SLC</LocationGroup>
 
</GetSOListRq>
 
</FbiMsgsRq>
 
</FbiXml>
 
 
 
 
 
{{Request|Get Total Inventory}}
 
'''Description:''' Returns the total number of the inquired item at a specific location.
 
 
 
'''Syntax:'''
 
<GetTotalInventoryRq>
 
<PartNumber>{{r|string}}</PartNumber>
 
<LocationGroup>{{r|DB string}}</LocationGroup>
 
</GetTotalInventoryRq>
 
 
 
'''Example:'''
 
<FbiXml>
 
<Ticket>
 
<Key>/uPlNnEb/k5BGSbo/r6Ffw==</Key>
 
</Ticket>
 
<FbiMsgsRq>
 
<GetTotalInventoryRq>
 
<PartNumber>B201</PartNumber>
 
<LocationGroup>SLC</LocationGroup>
 
</GetTotalInventoryRq>
 
</FbiMsgsRq>
 
</FbiXml>
 
 
 
 
 
{{Request|Import List}}
 
'''Description:''' This request returns a list of your import options.
 
 
 
'''Syntax:'''
 
<ImportListRq />
 
 
 
'''Example:'''
 
<FbiXml>
 
<Ticket>
 
<Key>Y6MheCoxKQv7n6jLiuwd3w==</Key>
 
</Ticket>
 
<FbiMsgsRq>
 
<ImportListRq />
 
</FbiMsgsRq>
 
</FbiXml>
 
 
 
  
 
{{Request|Import}}
 
{{Request|Import}}
'''Description:''' This request allows you to import data. The example uses the import to edit/add a vendor. Data columns can be blank, but each data column must be represented in the request. '''It is best practice to always include the header rows when importing data.'''
+
'''Description:''' This request allows you to run any of the [[CSV#List_of_imports_and_exports|CSV imports]]. The type is formatted as "ImportCsvName" with no spaces. Data columns can be blank, but each data column must be represented in the request.
 +
The example uses the import to edit/add a vendor. '''It is best practice to always include the header rows when importing data.'''
  
 
'''Syntax:'''
 
'''Syntax:'''
<ImportRq>
+
<source>
<Type>{{r|DB string}}</Type>
+
{
<Rows>
+
"ImportRq": {
<Row>{{r|Data for each column required by the type}}</Row>
+
"Type": "",
</Rows>
+
"Rows": [{
</ImportRq>
+
"Row": ""
 +
},
 +
{
 +
"Row": ""
 +
}]
 +
}
 +
}
 +
</source>
  
 
'''Example:'''
 
'''Example:'''
<FbiXml>
+
<source>
<Ticket>
+
{
<Key>Y6MheCoxKQv7n6jLiuwd3w==</Key>
+
"FbiJson": {
</Ticket>
+
"Ticket": {
<FbiMsgsRq>
+
"Key": "xTypHT/pZXZy6Re+H66kSA=="
<ImportRq>
+
},
<Type>ImportVendors</Type>
+
"FbiMsgsRq": {
<Rows>
+
"ImportRq": {
<Row>"Monroe Bike Company","Williams Bike Company - 210","Williams Bike Company","50","true","Wall st.","New York","NY","21004","UNITED STATES","212-321-5643",,,,,,,,,,,,,</Row>
+
"Type": "ImportVendors",
</Rows>
+
"Rows": [{
</ImportRq>
+
"Row": "\"Name\",\"AddressName\",\"AddressContact\",\"AddressType\",\"IsDefault\",\"Address\",\"City\",\"State\",\"Zip\",\"Country\",\"Main\",\"Home\",\"Work\",\"Mobile\",\"Fax\",\"Email\",\"Pager\",\"Web\",\"Other\",\"DefaultTerms\",\"DefaultShippingTerms\",\"Status\",\"AlertNotes\",\"URL\",\"DefaultCarrier\",\"MinOrderAmount\",\"Active\",\"AccountNumber\",\"CurrencyName\",\"CurrencyRate\",\"CF-Custom1\",\"CF-Custom2\",\"CF-Custom3\",\"CF-Custom4\""
</FbiMsgsRq>
+
},
</FbiXml>
+
{
 
+
"Row": "\"Monroe Bike Company\",\"Williams Bike Company - 210\",\"Williams Bike Company\",\"50\",\"true\",\"Wall st.\",\"New York\",\"NY\",\"21004\",\"UNITED STATES\",\"212-321-5643\",,,,,,,,,,,,,"
 +
}]
 +
}
 +
}
 +
}
 +
}
 +
</source>
  
 
{{Request|Import Headers}}
 
{{Request|Import Headers}}
'''Description:''' This request allows you to get the headers of an import. The example retrieves the import headers of the Add Inventory import.
+
'''Description:''' This request allows you to get the headers of an import. The type is formatted as "ImportCsvName" with no spaces.
 
+
The example retrieves the import headers of the Add Inventory import.
'''Added''': 2016.8
 
 
 
'''Syntax:'''
 
<ImportHeaderRq>
 
<Type>ImportAddInventory</Type>
 
</ImportHeaderRq>
 
 
 
'''Example:'''
 
<FbiXml>
 
<Ticket>
 
<Key>CrD15pPzJdK7Ca5R+Xk0aw==</Key>
 
</Ticket>
 
<FbiMsgsRq>
 
<ImportHeaderRq>
 
<Type>ImportAddInventory</Type>
 
</ImportHeaderRq>
 
</FbiMsgsRq>
 
</FbiXml>
 
 
 
 
 
{{Request|Inventory Quantity}}
 
'''Description:''' Returns details and quantity of a specified {{l|Part}} or list of parts modified within the given date range.
 
 
 
'''Syntax:'''
 
<InvQtyRq>
 
<PartNum>{{r|DB string}}</PartNum>
 
<LastModifiedFrom>{{r|Date}}</LastModifiedFrom>
 
<LastModifiedTo>{{r|Date}}</LastModifiedTo>
 
</InvQtyRq>
 
 
 
'''Example:'''
 
<FbiXml>
 
<Ticket>
 
<Key>uao3oeo67SpU+v5M9JiYFg==</Key>
 
</Ticket>
 
<FbiMsgsRq>
 
<InvQtyRq>
 
<PartNum />
 
<LastModifiedFrom>2019-02-03T10:04:27</LastModifiedFrom>
 
<LastModifiedTo>2019-02-03T10:04:27</LastModifiedTo>
 
</InvQtyRq>
 
</FbiMsgsRq>
 
</FbiXml>
 
 
 
 
 
{{Request|Issue SO}}
 
'''Description:''' Will issue a SalesOrder.
 
  
 
'''Syntax:'''
 
'''Syntax:'''
<IssueSORq>
+
<source>
<SONumber>{{r|string}}</SONumber>
+
{
</IssueSORq>
+
"ImportHeaderRq": {
 +
"Type": ""
 +
}
 +
}
 +
</source>
  
 
'''Example:'''
 
'''Example:'''
<FbiXml>
+
<source>
<Ticket>
+
{
<Key>d6LnuZwr+M/oMNAxxNlNUA==</Key>
+
"FbiJson": {
</Ticket>
+
"Ticket": {
<FbiMsgsRq>
+
"Key": "xTypHT/pZXZy6Re+H66kSA=="
<IssueSORq>
+
},
<SONumber>50067</SONumber>
+
"FbiMsgsRq": {
</IssueSORq>
+
"ImportHeaderRq": {
</FbiMsgsRq>
+
"Type": "ImportAddInventory"
</FbiXml>
+
}
 
+
}
 
+
}
{{Request|Light Part List}}
+
}
'''Description:''' Returns a simple list of parts.
+
</source>
 
 
'''Syntax:'''
 
<LightPartListRq />
 
 
 
'''Example:'''
 
<FbiXml>
 
<Ticket>
 
<Key>uao3oeo67SpU+v5M9JiYFg==</Key>
 
</Ticket>
 
<FbiMsgsRq>
 
<LightPartListRq />
 
</FbiMsgsRq>
 
</FbiXml>
 
 
 
 
 
{{Request|Load SO}}
 
'''Description:''' This will return information about the specified sales order.
 
 
 
'''Syntax:'''
 
<LoadSORq>
 
<Number>{{r|string}}</Number>
 
</LoadSORq>
 
 
 
'''Example:'''
 
<FbiXml>
 
<Ticket>
 
<Key>Y6MheCoxKQv7n6jLiuwd3w==</Key>
 
</Ticket>
 
<FbiMsgsRq>
 
<LoadSORq>
 
<Number>50024</Number>
 
</LoadSORq>
 
</FbiMsgsRq>
 
</FbiXml>
 
 
 
 
 
{{Request|Location List}}
 
'''Description:''' Returns a list of locations and their details.
 
 
 
'''Syntax:'''
 
<LocationListRq />
 
 
 
'''Example:'''
 
<FbiXml>
 
<Ticket>
 
<Key>uao3oeo67SpU+v5M9JiYFg==</Key>
 
</Ticket>
 
<FbiMsgsRq>
 
<LocationListRq />
 
</FbiMsgsRq>
 
</FbiXml>
 
 
 
 
 
{{Request|Location Query}}
 
'''Description:''' Returns information on a {{l|Location}}.
 
 
 
'''Syntax:'''
 
<LocationQueryRq>
 
<LocationID>{{r|DB int}}</LocationID>
 
<TagNum>{{r|int}}</TagNum>
 
</LocationQueryRq>
 
 
 
'''Example:'''
 
<FbiXml>
 
<Ticket>
 
<Key>Y6MheCoxKQv7n6jLiuwd3w==</Key>
 
</Ticket>
 
<FbiMsgsRq>
 
<LocationQueryRq>
 
<LocationID>10</LocationID>
 
</LocationQueryRq>
 
</FbiMsgsRq>
 
</FbiXml>
 
 
 
  
 
{{Request|Login}}
 
{{Request|Login}}
'''Description:''' Logs a user in or out of Fishbowl. If the login request contains a ticket it will log the user out. The IAID and the IAName must be unique per Fishbowl server.
+
'''Description:''' Logs a user in to Fishbowl. The IAID can be any randomly generated integer value as long as the IAID and the IAName are unique per Fishbowl server.
The algorithm required to encrypt the password is Base64.encode(MD5.hash(password))  
+
The algorithm required to encrypt the password is Base64.encode(MD5.hash(password))
  
 
'''Syntax:'''
 
'''Syntax:'''
<LoginRq>
+
<source>
<IAID>{{r|int}}</IAID>
+
{
<IAName>{{r|string}}</IAName>
+
"LoginRq": {
<IADescription>{{r|string}}</IADescription>
+
"IAID": 111111,
<Username>{{r|string}}</Username>
+
"IADescription": "",
<UserPassword>{{r|encrypted string}}</UserPassword>
+
"UserName": "",
</LoginRq>
+
"IAName": "",
 +
"UserPassword": ""
 +
}
 +
}
 +
</source>
  
 
'''Example:'''
 
'''Example:'''
<FbiXml>
+
<source>
<Ticket>
+
{
<Key />
+
"FbiJson": {
</Ticket>
+
"Ticket": {
<FbiMsgsRq>
+
"Key": ""
<LoginRq>
+
},
<IAID>1234</IAID>
+
"FbiMsgsRq": {
<IAName>Fishbowl Developer Hook</IAName>
+
"LoginRq": {
<IADescription>Fishbowl Developer Hook an API test application for Fishbowl Inventory</IADescription>
+
"IAID": 1234,
<UserName>admin</UserName>
+
"IADescription": "Fishbowl Developer Hook an API test application for Fishbowl Inventory",
<UserPassword>ISMvKXpXpadDiUoOSoAfww==</UserPassword>
+
"UserName": "admin",
</LoginRq>
+
"IAName": "Fishbowl Developer Hook",
</FbiMsgsRq>
+
"UserPassword": "ISMvKXpXpadDiUoOSoAfww=="
</FbiXml>
+
}
 +
}
 +
}
 +
}
 +
</source>
  
 
+
{{Request|Logout}}
{{Request|Make Payment}}
+
'''Description:''' Logs a user out of Fishbowl.
'''Description:''' Makes a payment on the specified order.
 
 
 
'''Updated:''' 2012.3
 
  
 
'''Syntax:'''
 
'''Syntax:'''
<MakePaymentRq>
+
<source>
<Payment>{{r|{{l|Payment}} object}}</Payment>
+
{
</MakePaymentRq>
+
"LogoutRq": {}
 +
}
 +
</source>
  
 
'''Example:'''
 
'''Example:'''
<FbiXml>
+
<source>
<Ticket>
+
{
<Key>eCWMhC5n/E48OP7307qmZg==</Key>
+
"FbiJson": {
</Ticket>
+
"Ticket": {
<FbiMsgsRq>
+
"Key": "xTypHT/pZXZy6Re+H66kSA=="
<MakePaymentRq>
+
},
<Payment>
+
"FbiMsgsRq": {
<Amount>99.99</Amount>
+
"LogoutRq": {}
<SalesOrderNumber>50047</SalesOrderNumber>
+
}
<PaymentDate>2019-01-12T01:12:34</PaymentDate>
+
}
<PaymentMethod>VISA</PaymentMethod>
+
}
<Confirmation>987</Confirmation>
+
</source>
<TransactionID>456</TransactionID>
 
<AuthorizationCode>321</AuthorizationCode>
 
<MerchantAccount>1234567</MerchantAccount>
 
<CreditCard>
 
<CardNumber>4111111111111111</CardNumber>
 
<CardExpMonth>02</CardExpMonth>
 
<CardExpYear>2019</CardExpYear>
 
<SecurityCode>523</SecurityCode>
 
<NameOnCard>John Doe</NameOnCard>
 
<CardAddress>123 S Riverdale Road</CardAddress>
 
<CardZipCode>84172</CardZipCode>
 
<CardCountryCode>US</CardCountryCode>
 
</CreditCard>
 
</Payment>
 
</MakePaymentRq>
 
</FbiMsgsRq>
 
</FbiXml>
 
 
 
 
 
{{Request|Move}}
 
'''Description:''' Moves items from one specified location to another.
 
 
 
'''Syntax:'''
 
<MoveRq>
 
<SourceLocation>
 
<Location>{{r|{{l|Location}} object}}</Location>
 
</SourceLocation>
 
<Part>{{r|{{l|Part}} object}}</Part>
 
<Quantity>{{r|int}}</Quantity>
 
<Note>{{r|string}}</Note>
 
<Tracking>{{r|{{l|Tracking}} object}}</Tracking>
 
<DestinationLocation>
 
<Location>{{r|{{l|Location}} object}}</Location>
 
</DestinationLocation>
 
</MoveRq>
 
 
 
'''Example:'''
 
<FbiXml>
 
<Ticket>
 
<Key>uao3oeo67SpU+v5M9JiYFg==</Key>
 
</Ticket>
 
<FbiMsgsRq>
 
<MoveRq>
 
<SourceLocation>
 
<Location>
 
<LocationID>1</LocationID>
 
<TypeID>10</TypeID>
 
<Name>Stock 100</Name>
 
<LocationGroupID>1</LocationGroupID>
 
<TagID>1</TagID>
 
<TagNumber>1</TagNumber>
 
</Location>
 
</SourceLocation>
 
<Part>
 
<PartID>68</PartID>
 
<PartClassID>0</PartClassID>
 
<TypeID>10</TypeID>
 
<UOM>
 
<UOMID>1</UOMID>
 
<Name>Each</Name>
 
{{n|Code}}ea{{n|/Code}}
 
<Integral>true</Integral>
 
<Active>true</Active>
 
<Type>Count</Type>
 
<UOMConversions>
 
<UOMConversion>
 
<MainUOMID>1</MainUOMID>
 
<ToUOMID>17</ToUOMID>
 
<ToUOMCode>pr</ToUOMCode>
 
<ConversionMultiply>1.0</ConversionMultiply>
 
<ConversionFactor>2.0</ConversionFactor>
 
<ToUOMIsIntegral>false</ToUOMIsIntegral>
 
</UOMConversion>
 
<UOMConversion>
 
<MainUOMID>1</MainUOMID>
 
<ToUOMID>18</ToUOMID>
 
<ToUOMCode>pk</ToUOMCode>
 
<ConversionMultiply>1.0</ConversionMultiply>
 
<ConversionFactor>20.0</ConversionFactor>
 
<ToUOMIsIntegral>false</ToUOMIsIntegral>
 
</UOMConversion>
 
</UOMConversions>
 
</UOM>
 
<Num>B200</Num>
 
<Description>Discount Brake Cables</Description>
 
<Details />
 
<StandardCost>0</StandardCost>
 
<HasBOM>false</HasBOM>
 
<Configurable>false</Configurable>
 
<ActiveFlag>true</ActiveFlag>
 
<SerializedFlag>false</SerializedFlag>
 
<TrackingFlag>false</TrackingFlag>
 
<Weight>0.01</Weight>
 
<WeightUOM>
 
<UOM>
 
<UOMID>3</UOMID>
 
<Name>Pound</Name>
 
{{n|Code}}lbs{{n|/Code}}
 
<Integral>false</Integral>
 
<Active>true</Active>
 
<Type>Weight</Type>
 
<UOMConversions>
 
<UOMConversion>
 
<MainUOMID>3</MainUOMID>
 
<ToUOMID>8</ToUOMID>
 
<ToUOMCode>kg</ToUOMCode>
 
<ConversionMultiply>1.0</ConversionMultiply>
 
<ConversionFactor>2.2046000957489014</ConversionFactor>
 
<ToUOMIsIntegral>false</ToUOMIsIntegral>
 
</UOMConversion>
 
</UOMConversions>
 
</UOM>
 
</WeightUOM>
 
<Width>0</Width>
 
<Height>0</Height>
 
<Len>0</Len>
 
<SizeUOM>
 
<UOM>
 
<UOMID>2</UOMID>
 
<Name>Foot</Name>
 
{{n|Code}}ft{{n|/Code}}
 
<Integral>false</Integral>
 
<Active>true</Active>
 
<Type>Length</Type>
 
<UOMConversions>
 
<UOMConversion>
 
<MainUOMID>2</MainUOMID>
 
<ToUOMID>7</ToUOMID>
 
<ToUOMCode>in</ToUOMCode>
 
<ConversionMultiply>12.0</ConversionMultiply>
 
<ConversionFactor>1.0</ConversionFactor>
 
<ToUOMIsIntegral>false</ToUOMIsIntegral>
 
</UOMConversion>
 
<UOMConversion>
 
<MainUOMID>2</MainUOMID>
 
<ToUOMID>9</ToUOMID>
 
<ToUOMCode>m</ToUOMCode>
 
<ConversionMultiply>1.0</ConversionMultiply>
 
<ConversionFactor>3.2808001041412354</ConversionFactor>
 
<ToUOMIsIntegral>false</ToUOMIsIntegral>
 
</UOMConversion>
 
</UOMConversions>
 
</UOM>
 
</SizeUOM>
 
<UPC />
 
<VendorPartNums>
 
<VendorPartNumber>
 
<Number>B200</Number>
 
</VendorPartNumber>
 
<VendorPartNumber>
 
<Number>B200</Number>
 
</VendorPartNumber>
 
<VendorPartNumber>
 
<Number>B200</Number>
 
</VendorPartNumber>
 
</VendorPartNums>
 
</Part>
 
<Quantity>1</Quantity>
 
<DestinationLocation>
 
<Location>
 
<LocationID>2</LocationID>
 
<TypeID>20</TypeID>
 
<Name>Shipping</Name>
 
<LocationGroupID>1</LocationGroupID>
 
<TagID>1</TagID>
 
<TagNumber>1</TagNumber>
 
</Location>
 
</DestinationLocation>
 
</MoveRq>
 
</FbiMsgsRq>
 
</FbiXml>
 
 
 
 
 
{{Request|Part Cost}}
 
'''Description:''' Use this request to obtain the average cost at which you've previously bought this {{l|Part}}.
 
 
 
'''Syntax:'''
 
<PartCostRq>
 
<PartNum>{{r|string}}</PartNum>
 
</PartCostRq>
 
 
 
'''Example:'''
 
<FbiXml>
 
<Ticket>
 
<Key>HQZzIeyCYndxauMpHaCdlg==</Key>
 
</Ticket>
 
<FbiMsgsRq>
 
<PartCostRq>
 
<PartNum>B203</PartNum>
 
</PartCostRq>
 
</FbiMsgsRq>
 
</FbiXml>
 
 
 
 
 
{{Request|Part Get}}
 
'''Description:''' Returns all the information pertaining to a specified {{l|Part}} at your default location.
 
 
 
'''Syntax:'''
 
<PartGetRq>
 
<Number>{{r|string}}</Number>
 
<GetImage>{{r|boolean}}</GetImage>
 
</PartGetRq>
 
 
 
'''Example:'''
 
<FbiXml>
 
<Ticket>
 
<Key>HQZzIeyCYndxauMpHaCdlg==</Key>
 
</Ticket>
 
<FbiMsgsRq>
 
<PartGetRq>
 
<Number>P702</Number>
 
<GetImage>true</GetImage>
 
</PartGetRq>
 
</FbiMsgsRq>
 
</FbiXml>
 
 
 
 
 
{{Request|Part Query}}
 
'''Description:''' Like Part Get, Part Query Returns all the information pertaining to a specified {{l|Part}}. However, you can also specify location.
 
 
 
'''Syntax:'''
 
<PartQueryRq>
 
<PartNum>{{r|int}}</PartNum>
 
<LocationGroup>{{r|string}}</LocationGroup>
 
</PartQueryRq>
 
 
 
'''Example:'''
 
<FbiXml>
 
<Ticket>
 
<Key>HQZzIeyCYndxauMpHaCdlg==</Key>
 
</Ticket>
 
<FbiMsgsRq>
 
<PartQueryRq>
 
<PartNum>C501</PartNum>
 
</PartQueryRq>
 
</FbiMsgsRq>
 
</FbiXml>
 
 
 
 
 
{{Request|Pick Query}}
 
'''Description:''' This request will return all the picks that you specify. You can refine your results by its place in the index (StartIndex in conjunction with RecordCount), pick number, order number, pick type, status, priority, the first date to include, last date to include, whether or not it's fulfillable, or by its location group. The starting index defines at what point the records you want returned will start, default is 0. Record count is how may records you want returned.
 
 
 
'''Syntax:'''
 
<PickQueryRq>
 
<StartIndex>{{r|int}}</StartIndex>
 
<RecordCount>{{r|int}}</RecordCount>
 
<PickNum>{{r|string}}</PickNum>
 
<OrderNum>{{r|string}}</OrderNum>
 
<PickType>{{r|DB string}}</PickType>
 
<Status>{{r|DB string}}</Status>
 
<Priority>{{r|DB string}}</Priority>
 
<StartDate>{{r|date/time}}</StartDate>
 
<EndDate>{{r|date/time}}</EndDate>
 
<Fulfillable>{{r|boolean}}</Fulfillable>
 
<LocationGroup>{{r|DB string}}</LocationGroup>
 
</PickQueryRq>
 
 
 
'''Example:'''
 
<FbiXml>
 
<Ticket>
 
<Key>7BMmjKPWuPx7ySskCJflEQ==</Key>
 
</Ticket>
 
<FbiMsgsRq>
 
<PickQueryRq>
 
<StartIndex>0</StartIndex>
 
<RecordCount>10</RecordCount>
 
<Fulfillable>true</Fulfillable>
 
<LocationGroup>SLC</LocationGroup>
 
</PickQueryRq>
 
</FbiMsgsRq>
 
</FbiXml>
 
 
 
 
 
{{Request|Print Report}}
 
'''Description:''' Prints the default report for the specified module.
 
 
 
'''Syntax:'''
 
<PrintReportRq>
 
<ModuleName>Shipping</ModuleName>
 
<ParameterList>
 
<ReportParam>
 
<Name>shipID</Name>
 
<Value>33</Value>
 
</ReportParam>
 
</ParameterList>
 
</PrintReportRq>
 
 
 
'''Example:'''
 
<FbiXml>
 
<Ticket>
 
<Key>MI5XXDRs64vxgyxsCR5pBg==</Key>
 
</Ticket>
 
<FbiMsgsRq>
 
<PrintReportRq>
 
<ModuleName>Shipping</ModuleName>
 
<ParameterList>
 
<ReportParam>
 
<Name>shipID</Name>
 
<Value>33</Value>
 
</ReportParam>
 
</ParameterList>
 
</PrintReportRq>
 
</FbiMsgsRq>
 
</FbiXml>
 
 
 
 
 
{{Request|Product Get}}
 
'''Description:''' Requests detailed information about the product. This includes the product's underlying part, the product's base UOM and its tracking information. GetImage is a flag indicating if the image should be included.
 
 
 
'''Syntax:'''
 
<ProductGetRq>
 
<Number>{{r|string}}</Number>
 
<GetImage>{{r|boolean}}</GetImage>
 
</ProductGetRq>
 
 
 
'''Example:'''
 
<FbiXml>
 
<Ticket>
 
<Key>reFgQIMJEWGkqvSPuyjxhA==</Key>
 
</Ticket>
 
<FbiMsgsRq>
 
<ProductGetRq>
 
<Number>B200</Number>
 
</ProductGetRq>
 
</FbiMsgsRq>
 
</FbiXml>
 
 
 
 
 
{{Request|Product Price}}
 
'''Description:''' Request the best price for a given product.
 
 
 
'''Added''': 2015.2
 
 
 
'''Syntax:'''
 
<ProductPriceRq>
 
<ProductNumber>{{r|string}}</ProductNumber>
 
<CustomerName>{{r|string}}</CustomerName>
 
<Quantity>{{r|int}}</Quantity>
 
<Date>{{r|date}}</Date>
 
</ProductPriceRq>
 
 
 
'''Example:'''
 
<FbiXml>
 
<Ticket>
 
<Key>reFgQIMJEWGkqvSPuyjxhA==</Key>
 
</Ticket>
 
<FbiMsgsRq>
 
<ProductPriceRq>
 
<ProductNumber>B201</ProductNumber>
 
<CustomerName>Andrea Akers</CustomerName>
 
</ProductPriceRq>
 
</FbiMsgsRq>
 
</FbiXml>
 
 
 
 
 
{{Request|Quick Ship}}
 
'''Description:''' Will do an automatic pick, pack, and ship on a Sales Order that has already been issued (Work Orders tied to the SO must be fulfilled also). Fishbowl automatically picks the best tracking available. FulfillServiceItems indicates if the service items on the SO should be fulfilled during ship.
 
 
 
'''Updated:''' 16.11
 
 
 
'''Syntax:'''
 
<QuickShipRq>
 
<SONumber>{{r|string}}</SONumber>
 
<FulfillServiceItems>{{r|boolean}}</FulfillServiceItems>
 
<LocationGroup>{{r|string}}</LocationGroup>
 
<ErrorIfNotFulfilled>{{r|boolean}}</ErrorIfNotFulfilled>
 
<ShipDate>{{r|date}}</ShipDate>
 
</QuickShipRq>
 
 
 
'''Example:'''
 
<FbiXml>
 
<Ticket>
 
<Key>d6LnuZwr+M/oMNAxxNlNUA==</Key>
 
</Ticket>
 
<FbiMsgsRq>
 
<QuickShipRq>
 
<SONumber>50067</SONumber>
 
<FulfillServiceItems>true</FulfillServiceItems>
 
<LocationGroup>SLC</LocationGroup>
 
</QuickShipRq>
 
</FbiMsgsRq>
 
</FbiXml>
 
 
 
 
 
{{Request|Receiving List}}
 
'''Description:''' Returns information about orders in the receiving module. You can narrow your search by filling in as many of the controls as you wish. It will return all orders that contain the specified details. Note To get a response the order number specified must be a receiving order!
 
 
 
'''Syntax:'''
 
<ReceivingListRq>
 
<OrderNumber>{{r|string}}</OrderNumber>
 
<OrderType>{{r|DB int}}</OrderType>
 
<ReceiptStatus>{{r|DB int}}</ReceiptStatus>
 
<StartRecord>{{r|int}}</StartRecord>
 
<RecordCount>{{r|int}}</RecordCount>
 
<DateIssuedBegin>{{r|date/time}}</DateIssuedBegin>
 
<DateIssuedEnd>{{r|date/time}}</DateIssuedEnd>
 
<DateFulfilledBegin>{{r|date/time}}</DateFulfilledBegin>
 
<DateFulfilledEnd>{{r|date/time}}</DateFulfilledEnd>
 
<DateReceivedBegin>{{r|date/time}}</DateReceivedBegin>
 
<DateReceivedEnd>{{r|date/time}}</DateReceivedEnd>
 
<DateReconciledBegin>{{r|date/time}}</DateReconciledBegin>
 
<DateReconciledEnd>{{r|date/time}}</DateReconciledEnd>
 
<PartNum>{{r|string}}</PartNum>
 
<PartDesc>{{r|string}}</PartDesc>
 
<LocationGroupID>{{r|DB int}}</LocationGroupID>
 
<RMANum>{{r|string}}</RMANum>
 
<VendorName>{{r|string}}</VendorName>
 
</ReceivingListRq>
 
 
 
'''Example:'''
 
<FbiXml>
 
<Ticket>
 
<Key>j4sC1/ADj6Dm9fanP26Gng==</Key>
 
</Ticket>
 
<FbiMsgsRq>
 
<ReceivingListRq>
 
<OrderNumber>50</OrderNumber>
 
<OrderType>20</OrderType>
 
<ReceiptStatus>10</ReceiptStatus>
 
<StartRecord>1</StartRecord>
 
<RecordCount>10</RecordCount>
 
</ReceivingListRq>
 
</FbiMsgsRq>
 
</FbiXml>
 
 
 
 
 
{{Request|Save Discount}}
 
'''Description:''' Saves and updates discounts
 
 
 
'''Syntax:'''
 
<SaveDiscountRq>
 
<Discount>{{r|{{l|Discount}} object}}</Discount>
 
</SaveDiscountRq>
 
 
 
'''Example:'''
 
<SaveDiscountRq>
 
<Discount>
 
<ID>9</ID>
 
<Type>Amount</Type>
 
<TypeID>10</TypeID>
 
<Name>Happy</Name>
 
<Description />
 
<Percentage>.1</Percentage>
 
<Amount>10</Amount>
 
<TaxableFlag>true</TaxableFlag>
 
</Discount>
 
</SaveDiscountRq>
 
 
 
 
 
{{Request|Save Image}}
 
'''Description:''' Saves an image to the associated object.
 
 
 
'''Added''': 2016.3
 
 
 
'''Syntax:'''
 
<SaveImageRq>
 
<Type>{{r|string}}</Type>
 
<Number>{{r|string}}</Number>
 
<Image>{{r|string}}</Image>
 
<UpdateAssociations>{{r|boolean}}</UpdateAssociations>
 
</SaveImageRq>
 
 
 
'''Example:'''
 
<SaveImageRq>
 
<Type>Part</Type>
 
<Number>B201</Number>
 
<Image>/9j/4AAQSkZJRgABAgAAAQABAAD/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0a
 
HBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIy
 
MjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wAARCADwAUADASIA
 
AhEBAxEB/8QAHwAAAQUBAQEBAQEAAAAAAAAAAAECAwQFBgcICQoL/8QAtRAAAgEDAwIEAwUFBAQA
 
AAF9AQIDAAQRBRIhMUEGE1FhByJxFDKBkaEII0KxwRVS0fAkM2JyggkKFhcYGRolJicoKSo0NTY3
 
ODk6Q0RFRkdISUpTVFVWV1hZWmNkZWZnaGlqc3R1dnd4eXqDhIWGh4iJipKTlJWWl5iZmqKjpKWm
 
p6ipqrKztLW2t7i5usLDxMXGx8jJytLT1NXW19jZ2uHi4+Tl5ufo6erx8vP09fb3+Pn6/8QAHwEA
 
AwEBAQEBAQEBAQAAAAAAAAECAwQFBgcICQoL/8QAtREAAgECBAQDBAcFBAQAAQJ3AAECAxEEBSEx
 
BhJBUQdhcRMiMoEIFEKRobHBCSMzUvAVYnLRChYkNOEl8RcYGRomJygpKjU2Nzg5OkNERUZHSElK
 
U1RVVldYWVpjZGVmZ2hpanN0dXZ3eHl6goOEhYaHiImKkpOUlZaXmJmaoqOkpaanqKmqsrO0tba3
 
uLm6wsPExcbHyMnK0tPU1dbX2Nna4uPk5ebn6Onq8vP09fb3+Pn6/9oADAMBAAIRAxEAPwCHw/o+
 
hXPhzTZZNI06WRrSIyO1shYtsGSTjk5rT/sDw91/sLTf/AVP8K5Cylt9K8L6bbxPM819FG+yN9uC 
 
+t2T3E6PFB5qbpdzKcdj9MUmzphhnNXTOuHh/w/8A9ALTf/ARP8KVfD3h8/8AMC0z</Image>
 
</SaveImageRq>
 
 
 
 
 
{{Request|Save Pick}}
 
'''Description:''' This request enables you to make changes to and fulfill picks.
 
 
 
'''Syntax:'''
 
<SavePickRq>
 
<Pick>{{r|{{l|Pick}} object}}</Pick>
 
</SavePickRq>
 
 
 
'''Example:'''
 
<FbiXml>
 
<Ticket>
 
<Key>KKQItzUffGARU4ip0qMoew==</Key>
 
</Ticket>
 
<FbiMsgsRq>
 
<SavePickRq>
 
<Pick>
 
<PickID>1</PickID>
 
<Number>S50007</Number>
 
<Type>Pick</Type>
 
<TypeID>10</TypeID>
 
<Status>Finished</Status>
 
<StatusID>40</StatusID>
 
<Priority>3-Normal</Priority>
 
<PriorityID>30</PriorityID>
 
<LocationGroupID>1</LocationGroupID>
 
<DateLastModified>2019-02-03T09:41:31</DateLastModified>
 
<DateScheduled>2019-11-11T00:00:00</DateScheduled>
 
<DateCreated>2019-02-07T16:13:31</DateCreated>
 
<DateStarted>2019-02-03T09:37:13</DateStarted>
 
<DateFinished>2019-02-03T09:37:13</DateFinished>
 
<UserName>admin</UserName>
 
<PickOrders>
 
<PickOrder>
 
<OrderType>SO</OrderType>
 
<OrderTypeID>20</OrderTypeID>
 
<OrderNum>50007</OrderNum>
 
<OrderID>7</OrderID>
 
<OrderTo>Mountaineer Bikes</OrderTo>
 
<Note />
 
</PickOrder>
 
</PickOrders>
 
<PickItems>
 
<PickItem>
 
<PickItemID>179</PickItemID>
 
<Status>40</Status>
 
<Part>
 
<PartID>39</PartID>
 
<PartClassID>0</PartClassID>
 
<TypeID>10</TypeID>
 
<UOM>
 
<UOMID>1</UOMID>
 
<Name>Each</Name>
 
{{n|Code}}ea{{n|/Code}}
 
<Integral>true</Integral>
 
<Active>true</Active>
 
<Type>Count</Type>
 
<UOMConversions>
 
<UOMConversion>
 
<MainUOMID>1</MainUOMID>
 
<ToUOMID>17</ToUOMID>
 
<ToUOMCode>pr</ToUOMCode>
 
<ConversionMultiply>1.0</ConversionMultiply>
 
<ConversionFactor>2.0</ConversionFactor>
 
<ToUOMIsIntegral>false</ToUOMIsIntegral>
 
</UOMConversion>
 
<UOMConversion>
 
<MainUOMID>1</MainUOMID>
 
<ToUOMID>18</ToUOMID>
 
<ToUOMCode>pk</ToUOMCode>
 
<ConversionMultiply>1.0</ConversionMultiply>
 
<ConversionFactor>20.0</ConversionFactor>
 
<ToUOMIsIntegral>false</ToUOMIsIntegral>
 
</UOMConversion>
 
</UOMConversions>
 
</UOM>
 
<Num>PB3002</Num>
 
<Description>Protein Boost Power Bar</Description>
 
<Details />
 
<StandardCost>0</StandardCost>
 
<HasBOM>false</HasBOM>
 
<Configurable>false</Configurable>
 
<ActiveFlag>true</ActiveFlag>
 
<SerializedFlag>false</SerializedFlag>
 
<TrackingFlag>true</TrackingFlag>
 
<Weight>2</Weight>
 
<WeightUOM>
 
<UOM>
 
<UOMID>3</UOMID>
 
<Name>Pound</Name>
 
{{n|Code}}lbs{{n|/Code}}
 
<Integral>false</Integral>
 
<Active>true</Active>
 
<Type>Weight</Type>
 
<UOMConversions>
 
<UOMConversion>
 
<MainUOMID>3</MainUOMID>
 
<ToUOMID>8</ToUOMID>
 
<ToUOMCode>kg</ToUOMCode>
 
<ConversionMultiply>1.0</ConversionMultiply>
 
<ConversionFactor>2.2046000957489014</ConversionFactor>
 
<ToUOMIsIntegral>false</ToUOMIsIntegral>
 
</UOMConversion>
 
</UOMConversions>
 
</UOM>
 
</WeightUOM>
 
<Width>0</Width>
 
<Height>0</Height>
 
<Len>0</Len>
 
<SizeUOM>
 
<UOM>
 
<UOMID>2</UOMID>
 
<Name>Foot</Name>
 
{{n|Code}}ft{{n|/Code}}
 
<Integral>false</Integral>
 
<Active>true</Active>
 
<Type>Length</Type>
 
<UOMConversions>
 
<UOMConversion>
 
<MainUOMID>2</MainUOMID>
 
<ToUOMID>7</ToUOMID>
 
<ToUOMCode>in</ToUOMCode>
 
<ConversionMultiply>12.0</ConversionMultiply>
 
<ConversionFactor>1.0</ConversionFactor>
 
<ToUOMIsIntegral>false</ToUOMIsIntegral>
 
</UOMConversion>
 
<UOMConversion>
 
<MainUOMID>2</MainUOMID>
 
<ToUOMID>9</ToUOMID>
 
<ToUOMCode>m</ToUOMCode>
 
<ConversionMultiply>1.0</ConversionMultiply>
 
<ConversionFactor>3.2808001041412354</ConversionFactor>
 
<ToUOMIsIntegral>false</ToUOMIsIntegral>
 
</UOMConversion>
 
</UOMConversions>
 
</UOM>
 
</SizeUOM>
 
<UPC />
 
<PartTrackingList>
 
<PartTracking>
 
<PartTrackingID>3</PartTrackingID>
 
<Name>Expiration Date</Name>
 
{{n|Abbr}}ExpDate{{n|/Abbr}}
 
<Description />
 
<SortOrder>3</SortOrder>
 
<TrackingTypeID>30</TrackingTypeID>
 
<Active>true</Active>
 
</PartTracking>
 
</PartTrackingList>
 
<VendorPartNums>
 
<VendorPartNumber>
 
<Number>EZ-300-PB</Number>
 
</VendorPartNumber>
 
<VendorPartNumber>
 
<Number>PB3002</Number>
 
</VendorPartNumber>
 
</VendorPartNums>
 
</Part>
 
<Tag>
 
<TagID>0</TagID>
 
<Num>0</Num>
 
<PartNum />
 
<Location>
 
<LocationID>0</LocationID>
 
<TypeID>0</TypeID>
 
<Name />
 
<Description />
 
<CountedAsAvailable>true</CountedAsAvailable>
 
<Active>true</Active>
 
<Pickable>true</Pickable>
 
<Receivable>true</Receivable>
 
<LocationGroupID>0</LocationGroupID>
 
<LocationGroupName />
 
<TagID>-1</TagID>
 
<TagNumber>-1</TagNumber>
 
</Location>
 
<Quantity>0</Quantity>
 
<QuantityCommitted>0</QuantityCommitted>
 
<WONum>N/A</WONum>
 
<DateCreated>2019-08-17T15:43:51</DateCreated>
 
<Tracking />
 
<TypeID>30</TypeID>
 
<AccountID>1</AccountID>
 
</Tag>
 
<Quantity>4</Quantity>
 
<UOM>
 
<UOMID>1</UOMID>
 
<Name>Each</Name>
 
{{n|Code}}ea{{n|/Code}}
 
<Integral>true</Integral>
 
<Active>true</Active>
 
<Type>Count</Type>
 
<UOMConversions>
 
<UOMConversion>
 
<MainUOMID>1</MainUOMID>
 
<ToUOMID>17</ToUOMID>
 
<ToUOMCode>pr</ToUOMCode>
 
<ConversionMultiply>1.0</ConversionMultiply>
 
<ConversionFactor>2.0</ConversionFactor>
 
<ToUOMIsIntegral>false</ToUOMIsIntegral>
 
</UOMConversion>
 
<UOMConversion>
 
<MainUOMID>1</MainUOMID>
 
<ToUOMID>18</ToUOMID>
 
<ToUOMCode>pk</ToUOMCode>
 
<ConversionMultiply>1.0</ConversionMultiply>
 
<ConversionFactor>20.0</ConversionFactor>
 
<ToUOMIsIntegral>false</ToUOMIsIntegral>
 
</UOMConversion>
 
</UOMConversions>
 
</UOM>
 
<Tracking>
 
<TrackingItem>
 
<PartTracking>
 
<PartTrackingID>3</PartTrackingID>
 
<Name>Expiration Date</Name>
 
{{n|Abbr}}ExpDate{{n|/Abbr}}
 
<Description />
 
<SortOrder>3</SortOrder>
 
<TrackingTypeID>30</TrackingTypeID>
 
<Active>true</Active>
 
</PartTracking>
 
<TrackingValue>2019-12-08T00:00:00</TrackingValue>
 
</TrackingItem>
 
</Tracking>
 
<DestinationTag>
 
<Tag>
 
<TagID>376</TagID>
 
<Num>363</Num>
 
<PartNum />
 
<Location>
 
<LocationID>2</LocationID>
 
<TypeID>20</TypeID>
 
<Name>Shipping</Name>
 
<Description>The place where items are packaged and shipped.</Description>
 
<CountedAsAvailable>true</CountedAsAvailable>
 
<Default>true</Default>
 
<Active>true</Active>
 
<Pickable>true</Pickable>
 
<Receivable>true</Receivable>
 
<LocationGroupID>1</LocationGroupID>
 
<LocationGroupName>SLC</LocationGroupName>
 
<SortOrder>10006</SortOrder>
 
<TagID>376</TagID>
 
<TagNumber>363</TagNumber>
 
</Location>
 
<Quantity>0</Quantity>
 
<QuantityCommitted>0</QuantityCommitted>
 
<WONum>N/A</WONum>
 
<DateCreated>2019-08-31T08:16:10</DateCreated>
 
<Tracking />
 
<TypeID>10</TypeID>
 
<AccountID>1</AccountID>
 
</Tag>
 
</DestinationTag>
 
<OrderType>SO</OrderType>
 
<OrderTypeID>20</OrderTypeID>
 
<OrderNum>50007</OrderNum>
 
<OrderID>7</OrderID>
 
<SoItemId>12</SoItemId>
 
<SlotNumber>1</SlotNumber>
 
<Note />
 
<Location>
 
<LocationID>7</LocationID>
 
<TypeID>10</TypeID>
 
<Name>Stock 200</Name>
 
<Description>A location within the Stockroom</Description>
 
<CountedAsAvailable>true</CountedAsAvailable>
 
<Active>true</Active>
 
<Pickable>true</Pickable>
 
<Receivable>true</Receivable>
 
<LocationGroupID>1</LocationGroupID>
 
<LocationGroupName>SLC</LocationGroupName>
 
<SortOrder>10011</SortOrder>
 
<TagID>381</TagID>
 
<TagNumber>368</TagNumber>
 
</Location>
 
<PickItemType>10</PickItemType>
 
</PickItem>
 
</PickItems>
 
</Pick>
 
</SavePickRq>
 
</FbiMsgsRq>
 
</FbiXml>
 
 
 
 
 
{{Request|Save Receipt}}
 
'''Description:''' Updates receipt stored data.
 
 
 
'''Syntax:'''
 
<SaveReceiptRq>
 
<Receipt>{{r|{{l|Receipt}} object}}</Receipt>
 
</SaveReceiptRq>
 
 
 
'''Example:'''
 
<FbiXml>
 
<Ticket>
 
<Key>pC0u9VSOZ/J6mc9WpsBUvQ==</Key>
 
</Ticket>
 
<FbiMsgsRq>
 
<SaveReceiptRq>
 
<Receipt>
 
<ID>92</ID>
 
<StatusID>10</StatusID>
 
<TypeID>20</TypeID>
 
<OrderTypeID>20</OrderTypeID>
 
<POID>66</POID>
 
<UserID>1</UserID>
 
<LocationGroupID>1</LocationGroupID>
 
<ReceiptItems>
 
<ReceiveItem>
 
<ID>350</ID>
 
<ItemNum>BTY100-Core</ItemNum>
 
<Description>Battery Pack</Description>
 
<LineNum>2</LineNum>
 
<ItemStatus>10</ItemStatus>
 
<ItemType>1</ItemType>
 
<DateLastModified>2019-08-09T11:05:45</DateLastModified>
 
<OrderNum>500100</OrderNum>
 
<OrderType>20</OrderType>
 
<PoItemId>162</PoItemId>
 
<OrderItemType>20</OrderItemType>
 
<ReceiptID>92</ReceiptID>
 
<Quantity>1</Quantity>
 
<UOMName>Each</UOMName>
 
<UOMID>1</UOMID>
 
<SuggestedLocationID>3</SuggestedLocationID>
 
<OriginalUnitCost>-95</OriginalUnitCost>
 
<BilledUnitCost>-95</BilledUnitCost>
 
<LandedUnitCost>-95</LandedUnitCost>
 
<DeliverTo />
 
<CarrierID>1</CarrierID>
 
<PartTypeID>10</PartTypeID>
 
<TrackingNum />
 
<PackageCount>1</PackageCount>
 
<DateScheduled>2019-08-29T00:00:00</DateScheduled>
 
<ReceivedReceipts>
 
<ReceivedReceipt>
 
<ItemType>1</ItemType>
 
<Quantity>1</Quantity>
 
<Reason />
 
<LocationID>3</LocationID>
 
<Tracking />
 
</ReceivedReceipt>
 
</ReceivedReceipts>
 
<LinkedOrders />
 
<Part>
 
<PartID>74</PartID>
 
<PartClassID>0</PartClassID>
 
<TypeID>10</TypeID>
 
<UOM>
 
<UOMID>1</UOMID>
 
<Name>Each</Name>
 
{{n|Code}}ea{{n|/Code}}
 
<Integral>true</Integral>
 
<Active>true</Active>
 
<Type>Count</Type>
 
<UOMConversions>
 
<UOMConversion>
 
<MainUOMID>1</MainUOMID>
 
<ToUOMID>17</ToUOMID>
 
<ToUOMCode>pr</ToUOMCode>
 
<ConversionMultiply>1.0</ConversionMultiply>
 
<ConversionFactor>2.0</ConversionFactor>
 
<ToUOMIsIntegral>false</ToUOMIsIntegral>
 
</UOMConversion>
 
<UOMConversion>
 
<MainUOMID>1</MainUOMID>
 
<ToUOMID>18</ToUOMID>
 
<ToUOMCode>pk</ToUOMCode>
 
<ConversionMultiply>1.0</ConversionMultiply>
 
<ConversionFactor>20.0</ConversionFactor>
 
<ToUOMIsIntegral>false</ToUOMIsIntegral>
 
</UOMConversion>
 
</UOMConversions>
 
</UOM>
 
<Num>BTY100</Num>
 
<Description>Battery Pack</Description>
 
<Details />
 
<StandardCost>0</StandardCost>
 
<HasBOM>false</HasBOM>
 
<Configurable>false</Configurable>
 
<ActiveFlag>true</ActiveFlag>
 
<SerializedFlag>false</SerializedFlag>
 
<TrackingFlag>false</TrackingFlag>
 
<Weight>0</Weight>
 
<WeightUOM>
 
<UOM>
 
<UOMID>3</UOMID>
 
<Name>Pound</Name>
 
{{n|Code}}lbs{{n|/Code}}
 
<Integral>false</Integral>
 
<Active>true</Active>
 
<Type>Weight</Type>
 
<UOMConversions>
 
<UOMConversion>
 
<MainUOMID>3</MainUOMID>
 
<ToUOMID>8</ToUOMID>
 
<ToUOMCode>kg</ToUOMCode>
 
<ConversionMultiply>1.0</ConversionMultiply>
 
<ConversionFactor>2.2046000957489014</ConversionFactor>
 
<ToUOMIsIntegral>false</ToUOMIsIntegral>
 
</UOMConversion>
 
</UOMConversions>
 
</UOM>
 
</WeightUOM>
 
<Width>0</Width>
 
<Height>0</Height>
 
<Len>0</Len>
 
<SizeUOM>
 
<UOM>
 
<UOMID>2</UOMID>
 
<Name>Foot</Name>
 
{{n|Code}}ft{{n|/Code}}
 
<Integral>false</Integral>
 
<Active>true</Active>
 
<Type>Length</Type>
 
<UOMConversions>
 
<UOMConversion>
 
<MainUOMID>2</MainUOMID>
 
<ToUOMID>7</ToUOMID>
 
<ToUOMCode>in</ToUOMCode>
 
<ConversionMultiply>12.0</ConversionMultiply>
 
<ConversionFactor>1.0</ConversionFactor>
 
<ToUOMIsIntegral>false</ToUOMIsIntegral>
 
</UOMConversion>
 
<UOMConversion>
 
<MainUOMID>2</MainUOMID>
 
<ToUOMID>9</ToUOMID>
 
<ToUOMCode>m</ToUOMCode>
 
<ConversionMultiply>1.0</ConversionMultiply>
 
<ConversionFactor>3.2808001041412354</ConversionFactor>
 
<ToUOMIsIntegral>false</ToUOMIsIntegral>
 
</UOMConversion>
 
</UOMConversions>
 
</UOM>
 
</SizeUOM>
 
<UPC />
 
<VendorPartNums>
 
<VendorPartNumber>
 
<Number>BTY100</Number>
 
</VendorPartNumber>
 
</VendorPartNums>
 
</Part>
 
</ReceiveItem>
 
</ReceiptItems>
 
</Receipt>
 
</SaveReceiptRq>
 
</FbiMsgsRq>
 
</FbiXml>
 
 
 
 
 
{{Request|Save Report}}
 
'''Description:''' Saves the report data. (Must restart client to view changes)
 
 
 
'''Syntax:'''
 
<SaveReportRq>
 
<ReportTree>{{r|DB String}}</ReportTree>
 
<Report>{{r|{{l|Report}} object}}</Report>
 
</SaveReportRq>
 
 
 
'''Example:'''
 
<FbiXml>
 
<Ticket>
 
<Key>JZnsx8dDsgKM9FaLAJj9cA==</Key>
 
</Ticket>
 
<FbiMsgsRq>
 
<SaveReportRq>
 
<ReportTree>Company</ReportTree>
 
<Report>
 
<ID>-1</ID>
 
<Name>Test Report</Name>
 
<Path>../reports/Labels/LocationTag.jasper</Path>
 
<Description>This is a test report</Description>
 
</Report>
 
</SaveReportRq>
 
</FbiMsgsRq>