Oracle Apps Adapter 6.0 | webMethods Oracle Applications Adapter Documentation | webMethods Oracle Applications Adapter 12.2.7 Predefined Transaction Services Documentation | Financial Predefined Transaction Services | Send Accounts Payable Invoice Service
 
Send Accounts Payable Invoice Service
This service is in the WmOAFIN1227 package and has the following fully-qualified service name: payables1227.fromOA.APInvoice:sendAPInvoice.
This service retrieves new or changed approved invoice records only. You set up Accounts Payable Invoices in Oracle Applications Payables to record invoice-related information.
There is no deletion of payments defined in Oracle Applications; therefore the document status of DELETE does not apply in this case. However, since Oracle Applications does not maintain the Invoice Approval History, the first approval for an invoice cannot be distinguished from subsequent invoices; therefore a business document is created with the document status of UPDATE. The document status of INSERT does not apply.
Database Scripts
This service uses the following database scripts:
Database Script
Description
wm_install_from_apinvoice.sql
Runs all the scripts listed below, except the uninstall script.
wm_from_apinvoice_vw.sql
Creates all required view components for AP Invoice outbound transactions:
*WM_AP_INVOICES_VW
*WM_AP_INVOICES_LINES_VW
*WM_AP_INVOICES_QRY_VW
wm_from_apinvoice_trg.sql
Creates the following trigger component to be used for writing to the WM_TRACKCHANGES table to indicate a new or updated document:
*WM_AP_INVOICE_DIST_IU_TRG
wm_disable_from_apinvoice.sql.
Disables the triggers installed by wm_from_apinvoice_trg.sql.
wm_enable_from_apinvoice.sql
Re-enables the triggers installed by wm_from_apinvoice_trg.sql.
wm_drop_from_apinvoice.sql
Uninstalls all components created by wm_install_from_apinvoice.sql.
For more information about using database scripts, see Database Scripts.
Supporting Transaction Definitions
This service was built from the configured services defined in the following transaction definition:
*getAPInvoiceTxn1227.txp
For information about using the transaction definition files to customize this service, see Transaction Definitions.
Flow Control
The main flow executes as follows:
*specifyDefaultSettings specifies the default parameter settings required for service execution. You should change these settings accordingly.
*lockTxnCtrl determines whether the Send Accounts Payable Invoice service is ready for execution. That is, it determines whether there is no other instance of this service already in process.
*If lockTxnCtrl returns False, it means that another instance of this service is already in process. The service exits and waits for next scheduled execution.
*If lockTxnCtrl returns True, it means that the service is ready to execute. The APInvoice row in the control table is locked and updated so that the status is changed to INPROCESS to prevent another APInvoice service from executing.
*getAPInvoiceTxn queries the Oracle Applications database for any APInvoice Transactions that need to be processed. The number of records returned depends on the parameter value specified in the above map.
*processBizDoc sends the business document to the recipient, such as a trading partner, by looping against each document. You need to customize this step to receive a SUCCESS or an ERROR status of the document transfer along with the Error information. The Transfer Status and any Error Information log against each document.
*Loop against each document. Based on the Debug Mode specified during execution, it either purges or updates the records in the WM_TRACKCHANGES custom table.
*If the Debug Mode is TRUE, the records in the WM_TRACKCHANGES table are updated and the PROCESSED_FLAG is set to Y. This ensures that the same sets of records are not picked up during the next polling interval. The updateTrackChanges service updates the PROCESSED_FLAG in the WM_TRACKCHANGES table to Y and PROCESSED_DATE to sysdate, so that same information is not picked up again during next polling instance.
*If the Debug Mode is FALSE, the records in the WM_TRACKCHANGES table are deleted; purgeTrackChanges service purges the records from the WM_TRACKCHANGES table.
*Loop against each document and based on the Transfer Status, insertTransferERRInfo inserts a new record in the WM_TRACKCHANGES table so that same document can be picked up during the next polling interval.
*unlockTxnCtrl releases the lock on the Custom Control table so that next polling instance of sendVendor service can begin.
*getLastError logs any errors in the above steps.
*unlockTxnCtrl service executes to release the lock on the Custom Control table.
For more details on receive transactions, see Overview of Receive Service Transaction.
Business Document Structure
The service uses the following business document structure:
*1.0 APINVOICE
*1.1 APINVOICE_LINES
1.0 APINVOICE
Document Field
Oracle Applications Table/View/Package Name
Column Name
Description
WEB_
TRANSACTION_
ID
DOCUMENT_TYPE
Value is AP_INVOICES.
DOCUMENT_STATUS
Value is UPDATE or INSERT.
INVOICE_ID
AP_INVOICES_ALL
INVOICE_ID
Unique identifier for an invoice.
INVOICE_NUM
AP_INVOICES_ALL
INVOICE_NUM
Invoice number.
INVOICE_TYPE
AP_INVOICES_ALL
INVOICE_TYPE
The invoice type. Use Standard or Credit Memo.
INVOICE_DATE
AP_INVOICES_ALL
INVOICE_DATE
Invoice date.
PO_NUMBER
AP_INVOICES_PKG.
GET_PO_NUMBER
INVOICE_ID
Purchase order number.
VENDOR_NUMBER
AP_SUPPLIERS
SEGMENT1
Vendor number.
VENDOR_NAME
AP_SUPPLIERS
VENDOR_NAME
Name of vendor
VENDOR_SITE_
ADDRESS_LINE1
AP_SUPPLIER_
SITES_ALL
ADDRESS_LINE1
Address of the vendor site. Derives the Vendor Site ID from the interface table.
VENDOR_SITE_
ADDRESS_LINE2
AP_SUPPLIER_
SITES_ALL
ADDRESS_LINE2
VENDOR_SITE_
ADDRESS_LINE3
AP_SUPPLIER_
SITES_ALL
ADDRESS_LINE3
VENDOR_TOWN_
OR_CITY
AP_SUPPLIER_
SITES_ALL
CITY
VENDOR_COUNTY
AP_SUPPLIER_
SITES_ALL
COUNTY
VENDOR_STATE
AP_SUPPLIER_
SITES_ALL
STATE
VENDOR_
POSTAL_
CODE
AP_SUPPLIER_
SITES_ALL
ZIP
VENDOR_
COUNTRY
AP_SUPPLIER_
SITES_ALL
COUNTRY
INVOICE_
AMOUNT
AP_INVOICES_ALL
INVOICE_
AMOUNT
INVOICE_
CURRENCY_
CODE
AP_INVOICES_ALL
INVOICE_
CURRENCY_
CODE
EXCHANGE_
RATE
AP_INVOICES_ALL
EXCHANGE_
RATE
Exchange Rate for foreign currency invoices.
EXCHANGE_
RATE_TYPE
AP_INVOICES_ALL
EXCHANGE_
RATE_TYPE
Example values: Corporate or User.
TERMS_NAME
AP_INVOICES_ALL
TERMS_NAME
Payment terms name.
EXCHANGE_
RATE_DATE
AP_INVOICES_ALL
EXCHANGE_
RATE_DATE
Date on which the exchange rate will be taken
DESCRIPTION
AP_INVOICES_ALL
DESCRIPTION
Description of invoice.
AWT_GROUP_NAME
AP_AWT_GROUPS
NAME
Withholding tax name.
SOURCE
AP_INVOICES_ALL
SOURCE
Source of the invoice.
PAYMENT_
CROSS_RATE_
TYPE
AP_INVOICES_ALL
PAYMENT_
CROSS_RATE_
TYPE
Cross currency payment rate type.
PAYMENT_
CROSS_RATE_
DATE
AP_INVOICES_ALL
PAYMENT_
CROSS_RATE_
DATE
Cross currency payment rate date.
PAYMENT_
CROSS_RATE
AP_INVOICES_ALL
PAYMENT_
CROSS_RATE
Exchange rate between invoice and payment; usually value is 1 unless they are associated fixed- rate currencies.
PAYMENT_
CURRENCY_
CODE
AP_INVOICES_ALL
PAYMENT_
CURRENCY_
CODE
Cross currency payment currency.
WORKFLOW
Required for inbound transactions only. Use:
*Y for To be Processed.
*S for Processing.
*D for Processed.
*NULL for Not Applicable.
DOC_
CATEGORY_
CODE
AP_INVOICES_ALL
DOC_
CATEGORY_
CODE
Defaults to Standard or Credit depending on the invoice type. You can assign a valid document category that exists in Accounts Payable.
VOUCHER_NUM
AP_INVOICES_ALL
VOUCHER_NUM
PAYMENT_
METHOD_
LOOKUP_CODE
AP_INVOICES_ALL
PAYMENT_
METHOD_
LOOKUP_CODE
Name of payment method.
PAY_GROUP_
LOOKUP_CODE
AP_INVOICES_ALL
PAY_GROUP_
LOOKUP_CODE
Name of pay group.
GOODS_
RECEIVED_
DATE
AP_INVOICES_ALL
GOODS_
RECEIVED_
DATE
Date invoice items received.
INVOICE_
RECEIVED_
DATE
AP_INVOICES_ALL
INVOICE_
RECEIVED_
DATE
Date invoice received.
GL_DATE
AP_INVOICES_ALL
GL_DATE
Accounting date default for invoice distributions.
LIABILITY_
ACCOUNT
GL_CODE_
COMBINATIONS_
KFV
CONCATENATED_
SEGMENTS
The Accounts Code Combination derives the Accounts Payable Liability GL Code Combination ID.
USSGL_
TRANSACTION_
CODE
AP_INVOICES_ALL
USSGL_
TRANSACTION_
CODE
Default transaction code for creating US Standard General Ledger journal entries.
EXCLUSIVE_
PAYMENT
AP_INVOICES_ALL
EXCLUSIVE_
PAYMENT
ORGANIZATION_
NAME
HR_ALL_
ORGANIZATION_
UNITS_TL
NAME
Organization Name derives the ORG_ID from Organizations Definitions.
AMOUNT_
APPLICABLE_
TO_DISCOUNT
AP_INVOICES_ALL
AMOUNT_
APPLICABLE_
TO_DISCOUNT
Amount of invoice applicable to a discount.
PREPAY_NUM
Required for inbound transactions only. The invoice number of an existing, fully paid prepayment to be applied to the imported invoice.
PREPAY_
DIST_NUM
Required for inbound transactions only. The distribution of an existing prepayment. This distribution will be applied to the imported invoice.
PREPAY_
APPLY_
AMOUNT
Required for inbound transactions only. The amount of prepayment that the user wants to apply to the invoice. This amount must be positive.
PREPAY_
GL_DATE
Required for inbound transactions only. The accounting date for the prepayment application. If left null, the invoice GL_DATE is used.
1.1 APINVOICE_LINES
Document Field
Oracle Applications Table/View/ Name
Column Name
Description
INVOICE_ID
AP_INVOICE_
DISTRIBUTIONS_ALL
INVOICE_ID
Unique identifier for an invoice.
LINE_NUMBER
AP_INVOICE_
DISTRIBUTIONS_ALL
LINE_NUMBER
Invoice line number.
LINE_TYPE
AP_INVOICE_
DISTRIBUTIONS_ALL
LINE_TYPE
Type of invoice line. Example values are Item, Freight, Tax, or Miscellaneous.
LINE_GROUP_
NUMBER
AP_INVOICE_
DISTRIBUTIONS_ALL
LINE_GROUP_
NUMBER
Prorates charges across a group of lines.
AMOUNT
AP_INVOICE_
DISTRIBUTIONS_ALL
AMOUNT
Line amount.
ACCOUNTING_
DATE
AP_INVOICE_
DISTRIBUTIONS_ALL
ACCOUNTING_
DATE
DESCRIPTION
AP_INVOICE_
DISTRIBUTIONS_ALL
DESCRIPTION
AMOUNT_
INCLUDES_
TAX_FLAG
AP_INVOICE_
DISTRIBUTIONS_ALL
AMOUNT_
INCLUDES_
TAX_FLAG
Indicates whether the line amount includes tax.
TAX_CODES
AP_TAX_CODES_
ALL
TAX_CODES
Validated against AP_TAX_CODES.NAME.
PRORATE_
ACROSS_
FLAG
Indicates whether to prorate charges across a group of lines. Used for inbound transactions only.
PO_NUMBER
PO_HEADERS_ALL
SEGMENT1
Purchase order number for PO matching.
PO_LINE_NUMBER
PO_LINES_ALL
LINE_NUM
Purchase order line number for PO matching.
PO_SHIPMENT_
NUM
PO_LINE_
LOCATIONS_ALL
SHIPMENT_NUM
Purchase order shipment number for PO matching.
PO_
DISTRIBUTION_
NUM
PO_
DISTRIBUTIONS_
ALL
DISTRIBUTION_
NUM
Purchase order distribution line number for PO matching.
PO_UNIT_OF_
MEASURE
PO_LINES_ALL
UNIT_MEAS_
LOOKUP_CODE
Unit of measure on purchase order line.
ITEM_
DESCRIPTION
MTL_SYSTEM_
ITEMS
DESCRIPTION
QUANTITY_
INVOICED
AP_INVOICE_
DISTRIBUTIONS_
ALL
QUANTITY_
INVOICED
Quantity invoiced against purchase order shipment.
SHIP_TO_LOC_
ADDRESS_LINE_1
HR_LOCATIONS
ADDRESS_LINE1
Derives the Location ID based on the Ship To Location Address.
SHIP_TO_LOC_
ADDRESS_LINE_2
HR_LOCATIONS
ADDRESS_LINE2
SHIP_TO_LOC_
ADDRESS_LINE_3
HR_LOCATIONS
ADDRESS_LINE3
SHIP_TO_LOC_
ADDRESS_TOWN_
OR_CITY
HR_LOCATIONS
TOWN_OR_CITY
SHIP_TO_LOC_
ADDRESS_COUNTY
HR_LOCATIONS
REGION_1
SHIP_TO_LOC_
ADDRESS_STATE
HR_LOCATIONS
REGION_2
SHIP_TO_LOC_
ADDRESS_POSTAL_
CODE
HR_LOCATIONS
POSTAL_CODE
SHIP_TO_LOC_
ADDRESS_
COUNTRY
HR_LOCATIONS
COUNTRY
UNIT_PRICE
AP_INVOICE_
DISTRIBUTIONS_
ALL
UNIT_PRICE
Unit price for purchase order matched invoice items.
DISTRIBUTION_
SET_NAME
Used for inbound transactions only.
DIST_CODE_
CONCATENATED
GL_CODE_
COMBINATIONS_
KFV
CONCATENATED_
SEGMENTS
Account flexfield for account associated with distribution line.
AWT_GROUP_NAME
AP_AWT_GROUPS
NAME
Withholding tax group name.
RELEASE_NUM
PO_HEADERS_ALL
REVISION_NUM
BLANKET Purchase Order Release Number used for PO matching
ACCOUNT_SEG
MENT
Indicates that balancing segment in the account is to be overridden. Used for inbound transactions only.
BALANCING_SEG
MENT
Indicates that balancing segment is to be overridden. Used for inbound transactions only.
COST_CENTER_
SEGMENT
Indicates Cost Center in the account is to be overridden. Used for inbound transactions only.
PROJECT_NAME
PA_PROJECTS_ALL
SEGMENT1
Project name is validated against PA_PROJECTS_ALL.NAME.
TASK
PA_TASKS
TASK_NAME
Project Task Name is validated against PA_TASKS.
EXPENDITURE_
TYPE
AP_INVOICE_
DISTRIBUTIONS_
ALL
EXPENDITURE_
TYPE
Project expenditure type.
EXPENDITURE_
ITEM_DATE
AP_INVOICE_
DISTRIBUTIONS_
ALL
EXPENDITURE_
ITEM_DATE
Project expenditure item date.
EXPENDITURE_
ORGANIZATION_
NAME
HR_ALL_
ORGANIZATION_
UNITS_TL
NAME
Project organization name.
PROJECT_
ACCOUNTING_
CONTEXT
AP_INVOICE_
DISTRIBUTIONS_
ALL
PROJECT_
ACCOUNTING_
CONTEXT
Project accounting context.
PA_
ADDITION_
FLAG
AP_INVOICE_
DISTRIBUTIONS_
ALL
PA_
ADDITION_
FLAG
Whether the invoice is for a project.
PA_QUANTITY
AP_INVOICE_
DISTRIBUTIONS_
ALL
PA_QUANTITY
USSGL_
TRANSACTION_
CODE
AP_INVOICE_
DISTRIBUTIONS_
ALL
USSGL_
TRANSACTION_
CODE
USSGL transaction code for creating US Standard General Ledger journal entries.
STAT_AMOUNT
AP_INVOICE_
DISTRIBUTIONS_
ALL
STAT_AMOUNT
Amount associated with distribution line for measuring statistical quantities.
TYPE_1099
AP_INVOICE_
DISTRIBUTIONS_
ALL
TYPE_1099
INCOME_TAX_
REGION_NAME
AP_INCOME_
TAX_REGIONS
REGION_LONG_
NAME
Reporting region for distribution line for 1099 supplier.
RECEIPT_
NUMBER
RCV_SHIPMENT_
HEADERS
RECEIPT_NUM
Receipt number used for receipt matching.
RECEIPT_
LINE_NUM
RCV_SHIPMENT_
LINES
LINE_NUM
Receipt line number to which an invoice will be matched.
RCV_
TRANSACTION_
ID
AP_INVOICE_
DISTRIBUTIONS_
ALL
RCV_
TRANSACTION_
ID
Transaction identifier from RCV_TRANSACTIONS.
PA_CC_AR_
INVOICE_ID
AP_INVOICE_
DISTRIBUTIONS_
ALL
PA_CC_AR_
INVOICE_
NUMBER
Project accounting invoice
number validated against
AR_CUSTOMER_TRX_ALL.
TRX_NUMBER.
PA_CC_AR_
INVOICE_LINE_
NUMBER
AP_INVOICE_
DISTRIBUTIONS_
ALL
PA_CC_AR_
INVOICE_
NUMBER
Project accounting invoice line number.
PA_
REFERENCE1
AP_INVOICE_
DISTRIBUTIONS_
ALL
PA_
REFERENCE1
PA_
REFERENCE2
AP_INVOICE_
DISTRIBUTIONS_
ALL
PA_
REFERENCE2
PA_CC_
PROCESSED_
CODE
AP_INVOICE_
DISTRIBUTIONS_
ALL
PA_CC_
PROCESSED_
CODE
MATCH_OPTION
PO_LINE_
LOCATIONS_ALL
MATCH_OPTION
The value of the invoice match option on the PO shipment.
PACKING_SLIP
RCV_SHIPMENT_
HEADERS
PACKING_SLIP
TAX_
RECOVERY_
RATE
AP_INVOICE_
DISTRIBUTIONS_
ALL
TAX_
RECOVERY_
RATE
Tax recovery rate to be used in the tax calculation whenever recoverable tax is enabled.
TAX_
RECOVERY_
OVERRIDE_FLAG
AP_INVOICE_
DISTRIBUTIONS_
ALL
TAX_
RECOVERY_
OVERRIDE_
FLAG
TAX_
RECOVERABLE_
FLAG
AP_INVOICE_
DISTRIBUTIONS_
ALL
TAX_
RECOVERABLE
_FLAG
TAX_
OVERRIDE_
FLAG
AP_INVOICE_
DISTRIBUTIONS_ALL
TAX_
OVERRIDE_
FLAG
CREDIT_
CARD_
TRX_ID
AP_INVOICE_
DISTRIBUTIONS_
ALL
CREDIT_
CARD_
TRX_ID
Credit card transaction identifier.
AWARD_
NAME
GMS_AWARDS_
ALL
AWARD_
FULL_
NAME
ASSET_
TRACKING_
FLAG
AP_INVOICE_
DISTRIBUTIONS_
ALL
ASSET_
TRACKING_
FLAG
PRICE_
CORRECTION_
FLAG
AP_INVOICE_
DISTRIBUTIONS_
ALL
PRICE_
CORRECTION_
FLAG
Indicates whether price adjustment was done.