getItemDescription()

LineItemDescription getItemDescription(int company, string itemCode)

This method returns details of an item description for the given company and item code.

Parameters

company: Format: integer; Purpose: Specifies the identification number of the company for which to retrieve the item description.
itemCode: Format: string; Purpose: Specifies the identification code of the item description.

Results

This method returns a LineItemDescription XML document that contains the properties on the item description.

There are no messages defined by this method.

Example: A returned LineItemDescription XML document

This example shows a LineItemDescription XML document.

<LineItemDescription xmlns="http://xml.inomial.com/smile/2.xsd">
  <Company>1</Company>
  <ItemCode>misc1234</ItemCode>
  <Name>Example Company Pty Ltd: Professional services</Name>
  <UnitSize>1</UnitSize>
  <ChargeGst>true</ChargeGst>
  <Rate formatted="$0.50" currency="AUD">0.50000</Rate>
  <ReportingCategory>
    <Company>1</Company>
    <ReportingCode>exampleps</ReportingCode>
    <Name>Example Company Pty Ltd: Professional services division</Name>
    <Id>10</Id>
  </ReportingCategory>
  <Currency>AUD</Currency>
</LineItemDescription>

Faults

NoSuchItemException

This fault is returned when the company and itemCode does not exist.

Java client syntax

java -cp build/smilewsv2-client.jar [options]
 com.inomial.smile.client.v2.examples.GetItemDescription company
 itemCode

company: Purpose: Specifies the identification number of the company for which to retrieve the item description.
itemCode: Purpose: Specifies the identification code of the item description.

Note: For more information about the Java client and the options it accepts, see Java client syntax.