Appendix: Appendix A: Input and Response Interfaces

This appendix lists the input and response interface data for all business services that are included in this reference guide.

The input interface tables also specify which fields or classes are required when performing a specific action. If a field or class is required, a Y is entered in the table under the specified action column for that field or class. These actions are included in the table:

• Add (Column heading A in the tables.)

• Change (Column heading C in the tables.)

• Delete or Cancel (Column heading D/C in the tables.)

• Inquire (Column heading I in the tables.)

Note. If a class is specified as a required class, typically, you can use one or more of the fields included in that class to satisfy the requirement. For example, if an Entity class is marked as a required class, you can typically use either the entityId, entityLongId, or entityTaxId field to satisfy the requirement.

See Also

Reviewing Input and Response Interfaces

Accounts Payable

This section lists these interface tables:

• getVoucher: Input Interface

• getVoucher: Response Interface

• processVoucher: Input Interface

• processVoucher: Response Interface

getVoucher: Input Interface

This table lists the input interface information for the getVoucher web service operation:

getVoucher: Response Interface

The getVoucher web service operation returns the ShowVoucher message as the response interface. These tables list the response interface information for the getVoucher web service operation:

processVoucher: Input Interface

These tables lists the input interface information for the processVoucher web service operation:

processVoucher: Response Interface

The procesVoucher web service operation returns the ConfirmProcessVoucher message as the response interface. This table lists the response interface information for the processVoucher web service operation:

Address Book

This section lists these interface tables:

• getAddressBook: Input Interface

• getAddressBook: Response Interface

• processAddressBook: Input Interface

• processAddressBook: Response Interface

• getContact: Input Interface

• getContact: Response Interface

• processContact: Input Interface

• processContact: Response Interface

getAddressBook: Input Interface

These tables list the input interface information for the getAddressBook web service operation:

getAddressBook: Response Interface

The getAddressBook web service operation returns the ShowAddressBook message as the response interface. These tables list the response interface information for the getAddressBook web service operation:

processAddressBook: Input Interface

These tables list the input interface information for the processAddressBook web service operation:

processAddressBook: Response Interface

These tables list the response interface information for the processAddressBook web service operation:

getContact: Input Interface

These tables list the input interface information for the getContact web service operation:

getContact: Response Interface

The getContact web service operation uses the ShowContact message as the response. These tables list the response interface information for the getContact web service operation:

processContact: Input Interface

These tables list the input interface information for the processContact web service operation:

processContact: Response Interface

The processContact web service operation uses the ConfirmProcessContact message as the response. These tables list the response interface information for the processContact web service operation:

Capital Assets

This section lists these interface tables:

• createCapitalAssetConditionBasedAlert: Input Interface

• createCapitalAssetConditionBasedAlert: Response Interface

• getCapitalAssetConditionBasedAlert: Input Interface

• getCapitalAssetConditionBasedAlert: Response Interface

createCapitalAssetConditionBasedAlert: Input Interface

These tables list the input interface information for the createCapitalAssetConditionBasedAlert web service operation:

createCapitalAssetConditionBasedAlert: Response Interface

The createCapitalAssetConditionBasedAlert web service operation uses the ConfirmCapitalAssetConditionBasedAlert message as the response. This table lists the response interface information for the createCapitalAssetConditionBasedAlert web service operation:

getCapitalAssetConditionBasedAlert: Input Interface

These tables list the input interface information for the getCapitalAssetConditionBasedAlert web service operation:

getCapitalAssetConditionBasedAlert: Response Interface

The getCapitalAssetConditionBasedAlert web service operation uses the ShowCapitalAssetConditionBasedAlert message as the response. These tables list the response interface information for the getCapitalAssetConditionBasedAlert web service operation:

Customer

This section lists these interface tables:

• getCustomer: Input Interface

• getCustomer: Response Interface

• getCustomerCreditInformation: Input Interface

• getCustomerCreditInformation: Response Interface

• processCustomer: Input Interface

• processCustomer: Response Interface

getCustomer: Input Interface

These tables list the input interface information for the getCustomer web service operation:

getCustomer: Response Interface

The getCustomer web service operation uses the ShowCustomer message as the response. These tables list the response interface information for the getCustomer web service operation:

getCustomerCreditInformation: Input Interface

This table lists the input interface information for the getCustomerCreditInformation web service operation:

getCustomerCreditInformation: Response Interface

The getCustomerCreditInformation web service operation uses the ShowCustomerCreditInformation message as the response. This table lists the response interface information for the getCustomerCreditInformation web service operation:

processCustomer: Input Interface

These tables list the input interface information for the processCustomer web service operation:

processCustomer: Response Interface

The processCustomer web service operation uses the ConfirmProcessCustomer message as the response. This table lists the response interface information for the processCustomer web service operation:

Customer Service

This section lists these interface tables:

• getServiceOrder: Input Interface

• getServiceOrder: Response Interface

• processServiceOrder: Input Interface

• processServiceOrder: Response Interface

• getCommitmentDateTime: Input Interface

• getCommitmentDateTime: Response Interface

getServiceOrder: Input Interface

These tables list the input interface information for the getServiceOrder web service operation:

getServiceOrder: Response Interface

The getServiceOrder web service operation uses the ShowServiceOrder message as the response. These tables list the response interface information for the getServiceOrder web service operation:

processServiceOrder: Input Interface

These tables list the input interface information for the processServiceOrder web service operation:

processServiceOrder: Response Interface

The processServiceOrder web service operation uses the ConfirmServiceOrder message as the response. These tables list the response interface information for the processServiceOrder web service operation:

getCommitmentDateTime: Input Interface

This table lists the input interface information for the getCommitmentDateTime web service operation:

getCommitmentDateTime: Response Interface

The getCommitmentDateTime web service operation uses the ShowCommitmentDateTime message as the response. This table lists the response interface information for the getCommitmentDateTime web service operation:

Equipment

This section lists these interface tables:

• equipmentProcessor: Input Interface

• equipmentProcessor: Response Interface

• equipmenetQueryProcessor: Input Interface

• equipmentQueryProcessor: Response Interface

equipmentProcessor: Input Interface

These tables list the input interface information for the equipmentProcessor web service operation:

equipmentProcessor: Response Interface

The equipmentProcessor web service operation uses the ConfirmEquipment message as the response. This table lists the response interface information for the equipmentProcessor web service operation:

equipmentQueryProcessor: Input Interface

These tables list the input interface information for the equipmentQueryProcessor web service operation:

equipmentQueryProcessor: Response Interface

The equipmentQueryProcessor web service operation uses the ShowEquipment message as the response. These tables list the response interface information for the equipmentQueryProcessor web service operation:

Financial Compliance

This section lists these interface tables:

• getAPProcessingOptions: Input Interface

• getAPProcessingOptions: Response Interface

• getWriterOffProcessingOptions: Input Interface

• getWriterOffProcessingOptions: Response Interface

• getAgingCompanyConstants: Input Interface

• getAgingCompanyConstants: Response Interface

• getCustomerCreditLimits: Input Interface

• getCustomerCreditLimits: Response Interface

• getGeneralConstants: Input Interface

• getGeneralConstants: Response Interface

• getJournalGeneralConstants: Input Interface

• getJournalGeneralConstants: Response Interface

• getPolicyEditRules: Input Interface

• getPolicyEditRules: Response Interface

• getPurhcasingToleranceRules: Input Interface

• getPurhcasingToleranceRules: Response Interface

• getSecurityWorkbench: Input Interface

• getSecurityWorkbench: Response Interface

getAPProcessingOptions: Input Interface

This table lists the input interface information for the getAPProcessingOptions web service operation:

getAPProcessingOptions: Response Interface

The getAPProcessingOptions web service operation uses the ShowAPProcessingOptions message as the response. This table lists the response interface information for the getAPProcessingOptions web service operation:

getWriterOffProcessingOptions: Input Interface

This table lists the input interface information for the getWriterOffProcessingOptions web service operation:

getWriterOffProcessingOptions: Response Interface

The getWriterOffProcessingOptions web service operation uses the ShowWriteOffProcessingOptions message as the response. This table lists the response interface information for the getWriterOffProcessingOptions web service operation:

getAgingCompanyConstants: Input Interface

This table lists the input interface information for the getAgingCompanyConstants web service operation:

getAgingCompanyConstants: Response Interface

The getAgingCompanyConstants web service operation uses the ShowAgingCompanyConstants message as the response. This table lists the response interface information for the getAgingCompanyConstants web service operation:

getCustomerCreditLimits: Input Interface

This table lists the input interface information for the getCustomerCreditLimits web service operation:

getCustomerCreditLimits: Response Interface

The getCustomerCreditLimits web service operation uses the ShowCustomerCreditLimits message as the response. This table lists the response interface information for the getCustomerCreditLimits web service operation:

getGeneralConstants: Input Interface

This table lists the input interface information for the getGeneralConstants web service operation:

getGeneralConstants: Response Interface

The getGeneralConstants web service operation uses the ShowGeneralConstants message as the response. This table lists the response interface information for the getGeneralConstants web service operation:

getJournalGeneralConstants: Input Interface

This table lists the input interface information for the getJournalGeneralConstants web service operation:

getJournalGeneralConstants: Response Interface

The getJournalGeneralConstants web service operation uses the ShowGeneralJournalConstants message as the response. This table lists the response interface information for the getJournalGeneralConstants web service operation:

getPolicyEditRules: Input Interface

This table lists the input interface information for the getPolicyEditRules web service operation:

getPolicyEditRules: Response Interface

The getPolicyEditRules web service operation uses the ShowPolicyEditRules message as the response. This table lists the response interface information for the getPolicyEditRules web service operation:

getPurchasingToleranceRules: Input Interface

This table lists the input interface information for the getPurchasingToleranceRules web service operation:

getPurchasingToleranceRules: Response Interface

The getPurchasingToleranceRules web service operation uses the ShowPurchasingToleranceRules message as the response. This table lists the response interface information for the getPurchasingToleranceRules web service operation:

getSecurityWorkbench: Input Interface

This table lists the input interface information for the getSecurityWorkbench web service operation:

getSecurityWorkbench: Response Interface

The getSecurityWorkbench web service operation uses the ShowSecurityWorkbench message as the response. This table lists the response interface information for the getSecurityWorkbench web service operation:

Financials

This section lists these interface tables:

• getGLAccount: Input Interface

• getGLAccount: Response Interface

• insertBatchJournalEntry: Input Interface

• insertBatchJournalEntry: Response Interface

getGLAccount: Input Interface

These tables list the input interface information for the getGLAccount web service operation:

getGLAccount: Response Interface

The getGLAccount web service operation uses the ShowGLAccount message as the response. These tables list the response interface information for the getGLAccount web service operation:

insertBatchJournalEntry: Input Interface

These tables list the input interface information for the insertBatchJournalEntry web service operation:

insertBatchJournalEntry: Response Interface

The insertBatchJournalEntry web service operation uses the ConfirmInsertBatchJournalEntry message as the response. This table lists the response interface information for the insertBatchJournalEntry web service operation:

Fixed Assets

This section lists these interface tables:

• getFixedAsset: Input Interface

• getFixedAsset: Response Interface

getFixedAsset: Input Interface

These tables list the input interface information for the getFixedAsset web service operation:

getFixedAsset: Response Interface

The getFixedAsset web service operation uses the ShowFixedAsset message as the response. These tables list the response interface information for the getFixedAsset web service operation:

Foundation Environment

This section lists these interface tables:

• getUserDefinedCode: Input Interface

• getUserDefinedCode: Response Interface

getUserDefinedCode: Input Interface

This table lists the input interface information for the getUserDefinedCode web service operation:

getUserDefinedCode: Response Interface

The getUserDefinedCode web service operation uses the ShowUserDefinedCode message as the response. This table lists the response interface information for the getUserDefinedCode web service operation:

Inventory

This section lists these interface tables:

• processSupplierCatalogPrice: Input Interface

• processSupplierCatalogPrice: Response Interface

• processInventoryItem: Input Interface

• processInventoryItem: Response Interface

• getBranchPlantItem: Input Interface

• getBranchPlantItem: Response Interface

• getSupplierCatalogPrice: Input Interface

• getSupplierCatalogPrice: Response Interface

• getItemAvailability: Input Interface

• getItemAvailability: Response Interface

• insertInventoryItemStaging: Input Interface

• insertInventoryItemStaging: Response Interface

processSupplierCatalogPrice: Input Interface

This table lists the input interface information for the processSupplierCatalogPrice web service operation:

processSupplierCatalogPrice: Response Interface

The processSupplierCatalogPrice web service operation uses the ConfirmProcessSupplierCatalogPrice message as the response. This table lists the response interface information for the processSupplierCatalogPrice web service operation:

processInventoryItem: Input Interface

This table lists the input interface information for the processInventoryItem web service operation:

processInventoryItem: Response Interface

The processInventoryItem web service operation uses the ConfirmProcessInventoryItem message as the response. These tables list the response interface information for the processInventoryItem web service operation:

getBranchPlantItem: Input Interface

These tables list the input interface information for the getBranchPlantItem web service operation:

getBranchPlantItem: Response Interface

The getBranchPlantItem web service operation uses the ShowBranchPlantItem message as the response. These tables list the response interface information for the getBranchPlantItem web service operation:

getSupplierCatalogPrice: Input Interface

This table lists the input interface information for the getSupplierCatalogPrice web service operation:

getSupplierCatalogPrice: Response Interface

The getSupplierCatalogPrice web service operation uses the ShowSupplierCatalogPrice message as the response. :This table lists the response interface information for the getSupplierCatalogPrice web service operation:

getItemAvailability: Input Interface

This table lists the input interface information for the getItemAvailability web service operation:

getItemAvailability: Response Interface

The getItemAvailability web service operation uses the ShowItemAvailability message as the response. This table lists the response interface information for the getItemAvailability web service operation:

insertInventoryItemStaging: Input Interface

This table lists the input interface information for the insertInventoryItemStaging web service operation:

insertInventoryItemStaging: Response Interface

The insertInventoryItemStaging web service operation uses the ConfirmInsertInvetoryItemStaging message as the response. This table lists the response interface information for the insertInventoryItemStaging web service operation:

Procurement

This section lists these interface tables:

• processPurchaseOrder: Input Interface

• processPurchaseOrder: Response Interface

• processPurchaseOrderAcknowledge: Input Interface

• processPurchaseOrderAcknowledge: Response Interface

• getPurchaseOrder: Input Interface

• getPurchaseOrder: Response Interface

processPurchaseOrder: Input Interface

These tables list the input interface information for the processPurchaseOrder web service operation:

processPurchaseOrder: Response Interface

The processPurchaseOrder web service operation uses the ConfirmPurchaseOrder message as the response. This table lists the response interface information for the processPurchaseOrder web service operation:

processPurchaseOrderAcknowledge: Input Interface

These tables list the input interface information for the processPurchaseOrderAcknowledge web service operation:

processPurchaseOrderAcknowledge: Response Interface

The processPurchaseOrderAcknowledge web service operation uses the ConfirmPurchaseOrderAcknowledge message as the response. This table lists the response interface information for the processPurchaseOrderAcknowledge web service operation:

getPurchaseOrder: Input Interface

These tables list the input interface information for the getPurchaseOrder web service operation:

getPurchaseOrder: Response Interface

ThegetPurchaseOrder web service operation uses the ShowPurchaseOrder message as the response. These tables list the response interface information for the getPurchaseOrder web service operation:

Purchase Order Receipt

This section lists these interface tables:

• processPurchaseOrderReceipt: Input Interface

• processPurchaseOrderReceipt: Response Interface

processPurchaseOrderReceipt: Input Interface

These tables list the input interface information for the processPurchaseOrderReceipt web service operation:

processPurchaseOrderReceipt: Response Interface

The processPurchaseOrderReceipt web service operation uses the ConfirmPurchaseOrderReceipt message as the response. This table lists the response interface information for the processPurchaseOrderReceipt web service operation:

Sales Order

This section lists these interface tables:

• processSalesOrder: Input Interface

• processSalesOrder: Response Interface

• processSalesPriceAdjustment: Input Interface

• processSalesPriceAdjustment: Response Interface

• getItemPriceAndAvailability: Input Interface

• getItemPriceAndAvailability: Response Interface

• getCustomerItemPrice: Input Interface

• getCustomerItemPrice: Response Interface

• getSalesOrder: Input Interface

• getSalesOrder: Response Interface

• getItemListPrice: Input Interface

• getItemListPrice: Response Interface

• getSalesOrderPriceHistory: Input Interface

• getSalesOrderPriceHistory: Response Interface

processSalesOrder: Input Interface

These tables list the input interface information for the processSalesOrder web service operation:

processSalesOrder: Response Interface

The processSalesOrder web service operation uses the ConfirmSalesOrder message as the response. These tables list the response interface information for the processSalesOrder web service operation:

processSalesPriceAdjustment: Input Interface

This table lists the input interface information for the processSalesPriceAdjustment web service operation:

processSalesPriceAdjustment: Response Interface

The processSalesPriceAdjustment web service operation uses the ConfirmSalesPriceAdjustment message as the response. This table lists the response interface information for the processSalesPriceAdjustment web service operation:

getItemPriceAndAvailability: Input Interface

This table lists the input interface information for the getItemPriceAndAvailability web service operation:

getItemPriceAndAvailability: Response Interface

The getItemPriceAndAvailability web service operation uses the ShowItemPriceAndAvailability message as the response. This table lists the response interface information for the getItemPriceAndAvailability web service operation:

getCustomerItemPrice: Input Interface

These tables list the input interface information for the getCustomerItemPrice web service operation:

getCustomerItemPrice: Response Interface

The getCustomerItemPrice web service operation uses the ShowCustomerItemPrice message as the response. These tables list the response interface information for the getCustomerItemPrice web service operation:

getSalesOrder: Input Interface

These tables list the input interface information for the getSalesOrder web service operation:

getSalesOrder: Response Interface

The getSalesOrder web service operation uses the ShowSalesOrder message as the response. These tables list the response interface information for the getSalesOrder web service operation:

getItemListPrice: Input Interface

This table lists the input interface information for the getItemListPrice web service operation:

getItemListPrice: Response Interface

The getItemListPrice web service operation uses the ShowItemListPrice message as the response. This table lists the response interface information for the getItemListPrice web service operation:

getSalesOrderPriceHistory: Input Interface

This table lists the input interface information for the getSalesOrderPriceHistory web service operation:

getSalesOrderPriceHistory: Response Interface

The getSalesOrderPriceHistory web service operation uses the ShowSalesOrderPriceHistory message as the response. This table lists the response interface information for the getSalesOrderPriceHistory web service operation:

Supplier

This section lists these interface tables:

• processSupplier: Input Interface

• processSupplier: Response Interface

• getSupplier: Input Interface

• getSupplier: Response Interface

processSupplier: Input Interface

These tables list the input interface information for the processSupplier web service operation:

processSupplier: Response Interface

The processSupplier web service operation uses the ConfirmProcessSupplier message as the response. This table lists the response interface information for the processSupplier web service operation:

getSupplier: Input Interface

These tables lists the input interface information for the getSupplier web service operation:

getSupplier: Response Interface

The getSupplier web service operation uses the ShowSupplier message as the response. This table lists the response interface information for the getSupplier web service operation:

Voucher Match

This section lists these interface tables:

• processVoucherMatch: Input Interface

• processVoucherMatch: Response Interface

processVoucherMatch: Input Interface

These tables list the input interface information for the processVoucherMatch web service operation:

processVoucherMatch: Response Interface

The processVoucherMatch web service operation uses the Confirm VoucherMatch message as the response. This table lists the response interface information for the processVoucherMatch web service operation: