Using the QuickBooks Retrieve activity

Use the QuickBooks Retrieve activity to retrieve objects in the QuickBooks instance.

Use this task to retrieve objects in the QuickBooks instance. The call to this activity is a synchronous call where the input data is sent to the activity for processing and the response is sent back to the orchestration.

  1. In an active orchestration, open the Activities tab and expand the QuickBooks folder contents.
  2. Drag the Retrieve activity icon onto the orchestration. The QuickBooks Retrieve Object Checklist is displayed.
  3. In the Checklist, click Pick Endpoint.
  4. Click Browse and use the Project Explorer dialog box to select the relevant QuickBooks endpoint.
  5. In the Checklist, click Configure.
  6. Click Browse to select the object type. The Browse QuickBooks window is displayed.
  7. Select the Map Inputs in the Checklist. The XML Schemas generated from the selected object of the Retrieve Objects activity are displayed as nodes under the request input parameter in the To Activity panel.

Retrieve supports 2 types of input methods. They are: 1) RetrieveAll 2) RetrieveById

RetrieveAll supports pagination (i.e. ‘limit’ and ‘offset’). If user provides values for both the methods, then RetrieveById takes preference.

  1. Retrieve a map between the orchestration variables and the input parameter of the activity.
Note: Values must be provided at run time for any mandatory elements of the input structure. A value can be provided by specifying a default value for element or by linking the element with an input node. During run time if no value is provided for a mandatory element, the activity throws an exception, which is reported by the Web Management Console. If a value is not provided at run time for an optional input parameter, no exception is thrown during run time.
  1. Select the Map Outputs in the Checklist. The XML Schema generated to hold the response of the activity is displayed as nodes under the response output parameter in the From Activity panel.
  2. Retrieve a map between the output parameters and orchestration variables.

You have configured the QuickBooks Retrieve Objects activity.




Feedback | Notices


Timestamp icon Last updated: Tuesday, 27 September 2016


https://www.ibm.com/support/knowledgecenter/en/SS3LC4_7.5.3/com.ibm.wci.doc/QuickBooks_using_the_quickbooks_retrieve_.html