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 Payment Service
 
Send Accounts Payable Payment Service
This service is in the WmOAFIN1227 package and has the following fully-qualified service name: payables1227.fromOA.APPayment:sendAPPayment.
This service retrieves new or changed confirmed 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, because 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 INSERT or UPDATE.
Database Scripts
This service uses the following database scripts:
Database Script
Description
wm_install_from_appayment.sql
Runs all the scripts listed below, except the uninstall script.
wm_from_ap_payment_vw.sql
Creates all required view components for AP Payments outbound transactions:
*WM_AP_CHECKS_VW
*WM_AP_INVOICE_PAYMENTS_VW
*WM_AP_CHECKS_QRY_VW
wm_from_ap_payment_trg.sql
Creates the following required trigger component:
WM_AP_PAYMENTS_IU_TRG
wm_disable_from_appayment.sql
Disables the triggers installed by wm_from_appayment_trg.sql.
wm_enable_from_appayment.sql
Re-enables the triggers installed by wm_from_appayment_trg.sql.
wm_drop_from_appayment.sql
Uninstalls all components created by wm_install_from_appayment.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:
*getAPPaymentTxn1227.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 sendAPPayment 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 indicates that another instance of this service is already in process. The service exits and waits for next scheduled execution.
*If lockTxnCtrl returns true, the service is ready to execute. It locks and updates the APPayment row in the control table e so that it changes the status to INPROCESS to prevent any other APPayment service from executing.
*getAPPaymentTxn service queries the Oracle Applications database for any APPayment Transaction 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 must 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 logs 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 table.
*If the Debug Mode is TRUE, it updates the records in the WM_TRACKCHANGES table and sets the PROCESSED_FLAG is set to Y. This ensures that it does not pick up the same sets of records during next polling interval. The updateTrackChanges service updates the PROCESSED_FLAG in the WM_TRACKCHANGES table to Y and sets PROCESSED_DATE to sysdate so that same information is not picked up again during next polling instance.
*If the Debug Mode is FALSE, then it deletes the records in the WM_TRACKCHANGES table. The purgeTrackChanges service purges the records from the WM_TRACKCHANGES table.
*Loop against each document. Based on the Transfer Status, insertTransferERRInfo inserts a new record in the WM_TRACKCHANGES table so that it picks up the same document 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 occurring in the above steps. The 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
This service uses the following business structure:
*1.0 AP_CHECKS
*1.1 AP_INVOICE_PAYMENTS
1.0 AP_CHECKS
Document Field
Oracle Applications Table/View/Package Name
Column Name
Description
WEB_
TRANSACTION_
ID
DOCUMENT_
TYPE
Use the value AP_PAYMENT.
DOCUMENT_
STATUS
Valid values are UPDATE, INSERT, and QUERY.
CHECK_ID
AP_CHECKS_ALL
CHECK_ID
Unique payment identifier.
ORGANIZATION_
NAME
HR_ALL_
ORGANIZATION_
UNITS_TL
NAME
CHECK_
NUMBER
AP_CHECKS_ALL
CHECK_
NUMBER
Payment number.
CURRENCY_
CODE
AP_CHECKS_ALL
CURRENCY_
CODE
AMOUNT
AP_CHECKS_ALL
AMOUNT
CHECK_DATE
AP_CHECKS_ALL
CHECK_DATE
Payment date.
BATCH_NAME
AP_CHECKS_ALL
CHECKRUN_
NAME
CHECK_
VOUCHER_
NUM
AP_CHECKS_ALL
CHECK_
VOUCHER_
NUM
CHECK_
STATUS
AP_LOOKUP_
CODES
DISPLAYED_
FIELD
CLEARED_
AMOUNT
AP_CHECKS_ALL
CLEARED_
AMOUNT
CLEARED_
BASE_
AMOUNT
AP_CHECKS_ALL
CLEARED_
BASE_AP_
AMOUNT
CLEARED_
DATE
AP_CHECKS_ALL
CLEARED_
DATE
CLEARED_
EXCHANGE_
DATE
AP_CHECKS_ALL
CLEARED_
EXCHANGE_
DATE
CLEARED_
EXCHANGE_
RATE
AP_CHECKS_ALL
CLEARED_
EXCHANGE_
RATE
CLEARED_
EXCHANGE_
RATE_TYPE
AP_CHECKS_ALL
CLEARED_
EXCHANGE_
RATE_TYPE
VOID_DATE
AP_CHECKS_ALL
VOID_DATE
MATURITY_
EXCHANGE_
DATE
AP_CHECKS_ALL
MATURITY_
EXCHANGE_
DATE
Date maturity exchange rate is effective. Usually the maturity date for the payment.
MATURITY_
EXCHANGE_
RATE_TYPE
AP_CHECKS_ALL
MATURITY_
EXCHANGE_
RATE_TYPE
Exchange rate type at future dated payment maturity time. For foreign currency payment only.
MATURITY_
EXCHANGE_
RATE
AP_CHECKS_ALL
MATURITY_
EXCHANGE_
RATE
Exchange rate at future dated payment maturity time. For foreign currency payment only.
MATURITY_
USER_RATE_
TYPE
GL_DAILY_
CONVERSION_
TYPES
USER_
CONVERSION_
TYPE
Exchange rate value entered by user.
VENDOR_
NAME
AP_CHECKS_ALL
VENDOR_
NAME
Supplier name.
VENDOR_
ADDRESS_
LINE1
AP_SUPPLIER_
SITES_ALL
ADDRESS_LINE1
Supplier address.
VENDOR_
ADDRESS_
LINE2
AP_SUPPLIER_
SITES_ALL
ADDRESS_LINE2
VENDOR_
ADDRESS_
LINE3
AP_SUPPLIER_
SITES_ALL
ADDRESS_LINE3
VENDOR_CITY
AP_SUPPLIER_
SITES_ALL
CITY
VENDOR_
COUNTY
AP_SUPPLIER_
SITES_ALL
COUNTY
VENDOR_
STATE
AP_SUPPLIER_
SITES_ALL
STATE
VENDOR_
ZIP
AP_SUPPLIER_
SITES_ALL
ZIP
VENDOR_
COUNTRY
AP_SUPPLIER_
SITES_ALL
COUNTRY
BANK_NAME
AP_BANK_
BRANCHES
BANK_NAME
CURRENT_
BANK_
ACCOUNT_
NAME
AP_BANK_
ACCOUNTS_
ALL
BANK_
ACCOUNT_
NAME
BANK_
CURRENCY_
CODE
AP_BANK_
ACCOUNTS_
ALL
CURRENCY_
CODE
CHECK_
STOCK_
NAME
AP_CHECK_
STOCKS_ALL
NAME
PAYMENT_
TYPE
AP_LOOKUP_
CODES
DISPLAYED_
FIELD
PAYMENT_
METHOD
AP_LOOKUP_
CODES
DISPLAYED_
FIELD
BANK_
ACCOUNT_
NAME
AP_CHECKS_ALL
BANK_
ACCOUNT_
NAME
BANK_
ACCOUNT_
NUM
AP_CHECKS_ALL
BANK_
ACCOUNT_
NUM
Payment’s bank account number.
BANK_
ACCOUNT_
TYPE
AP_CHECKS_ALL
BANK_
ACCOUNT_
TYPE
BANK_NUM
AP_CHECKS_ALL
BANK_NUM
Payment’s bank number.
BASE_AMOUNT
AP_CHECKS_ALL
BASE_AMOUNT
PAYMENT_
ADDRESS_
STYLE
AP_CHECKS_ALL
ADDRESS_STYLE
Payment’s address.
PAYMENT_
ADDRESS_
LINE1
AP_CHECKS_ALL
ADDRESS_LINE1
PAYMENT_
ADDRESS_
LINE2
AP_CHECKS_ALL
ADDRESS_LINE2
PAYMENT_
ADDRESS_
LINE3
AP_CHECKS_ALL
ADDRESS_LINE3
PAYMENT_
ADDRESS_
LINE4
AP_CHECKS_ALL
ADDRESS_LINE4
PAYMENT_CITY
AP_CHECKS_ALL
CITY
PAYMENT_COUNTY
AP_CHECKS_ALL
COUNTY
PAYMENT_STATE
AP_CHECKS_ALL
STATE
PAYMENT_ZIP
AP_CHECKS_ALL
ZIP
PAYMENT_COUNTRY
AP_CHECKS_ALL
COUNTRY
DOC_
SEQUENCE_
NAME
FND_
DOCUMENT_
SEQUENCES
NAME
Payment document sequence name.
DOC_
CATEGORY_
NAME
FND_DOC_
SEQUENCE_
CATEGORIES
NAME
Payment document category name.
EXCHANGE_
DATE
AP_CHECKS_ALL
EXCHANGE_
DATE
Date exchange rate is effective, which is usually the accounting date of the transaction.
EXCHANGE_
RATE
AP_CHECKS_ALL
EXCHANGE_
RATE
Exchange rate for foreign currency payment.
EXCHANGE_
RATE_TYPE
AP_CHECKS_ALL
EXCHANGE_
RATE_TYPE
Exchange rate for foreign currency payment.
FUTURE_
PAY_DUE_
DATE
AP_CHECKS_ALL
FUTURE_
PAY_DUE_
DATE
Negotiable date for future dated payment.
RELEASED_
DATE
AP_CHECKS_ALL
RELEASED_
DATE
Date and time user released stop payment.
RELEASED_
BY
AP_CHECKS_ALL
RELEASED_
BY
Name of person who released the payment.
STOPPED_DATE
AP_CHECKS_ALL
STOPPED_DATE
Date and time user released the stop payment.
STOPPED_BY
AP_CHECKS_ALL
STOPPED_BY
Name of person who stopped the payment.
TREASURY_
PAY_DATE
AP_CHECKS_ALL
TREASURY_
PAY_DATE
Date payment processed through internal clearing organization.
TREASURY_
PAY_NUMBER
AP_CHECKS_ALL
TREASURY_
PAY_NUMBER
Number assigned to payment processed through internal clearing organization.
USSGL_
TRANSACTION_
CODE
AP_CHECKS_ALL
USSGL_
TRANSACTION_
CODE
Transaction code for creating US Standard General Ledger journal entries.
USSGL_TRX_
CODE_CONTEXT
AP_CHECKS_ALL
USSGL_TRX_
CODE_CONTEXT
USSGL Transaction Code Descriptive flexfield context column.
SET_OF_
BOOKS_NAME
GL_SETS_OF_BOOKS
NAME
Name of GL set of books.
CHECK_
FORMAT_NAME
AP_CHECK_
FORMATS
NAME
TERRITORY_
SHORT_NAME
FND_
TERRITORIES_
VL
TERRITORY_
SHORT_NAME
USER_RATE_
TYPE
GL_DAILY_
CONVERSION_
TYPES
USER_
CONVERSION_
TYPE
Rate type entered by user.
POSITIVE_
PAY_STATUS_
CODE
AP_CHECKS_ALL
POSITIVE_
PAY_STATUS_
CODE
Set by and used by Positive Pay Report to select records.
TRANSFER_
PRIORITY
AP_CHECKS_ALL
TRANSFER_
PRIORITY
EXTERNAL_
BANK_ACCOUNT_
NAME
AP_BANK_
ACCOUNTS_ALL
BANK_
ACCOUNT_
NAME
STAMP_DUTY_
AMT
AP_CHECKS_ALL
STAMP_DUTY_
AMT
Stamp duty amount.
STAMP_DUTY_
BASE_AMT
AP_CHECKS_ALL
STAMP_DUTY_
BASE_AMT
Stamp duty base amount.
FUTURE_
DATED_PAYMENT_
FLAG
AP_CHECKS_ALL
FUTURE_PAY_
DUE_DATE
Indicates whether payment has a future date.
DESCRIPTION
AP_CHECKS_ALL
DESCRIPTION
ANTICIPATED_
VALUE_DATE
AP_CHECKS_ALL
ANTICIPATED_
VALUE_DATE
Used by Cash Management.
ACTUAL_
VALUE_DATE
AP_CHECKS_ALL
ACTUAL_
VALUE_DATE
Used by Cash Management.
OBSOLETE_FLAG
FND_
TERRITORIES_
VL
OBSOLETE_FLAG
Indicates whether a territory is obsolete.
1.1 AP_INVOICE_PAYMENTS
Document Field
Oracle Applications Table/View Name
Column Name
Description
CHECK_ID
AP_INVOICE_
PAYMENTS_
ALL
CHECK_ID
Unique payment identifier.
INVOICE_NUM
AP_INVOICES_
ALL
INVOICE_NUM
Payment invoice number.
AMOUNT
AP_INVOICE_
PAYMENTS_
ALL
AMOUNT
Payment invoiced amount.
ACCOUNTING_
DATE
AP_INVOICE_
PAYMENTS_
ALL
ACCOUNTING_
DATE
DESCRIPTION
AP_INVOICES_ALL
DESCRIPTION
CHECK_DATE
AP_CHECKS_ALL
CHECK_DATE
Payment date.
INVOICE_DATE
AP_INVOICES_ALL
INVOICE_DATE
ACCRUAL_
POSTED_
FLAG
AP_INVOICE_
PAYMENTS_
ALL
ACCRUAL_
POSTED_
FLAG
ACCTS_PAY_
ACCOUNT_
NUMBER
GL_CODE_
COMBINATIONS_
KFV
CONCATENATED_
SEGMENTS
Indicates whether the payment has been accounted in accrual set of books.
ASSETS_
ADDITION_
FLAG
AP_INVOICE_
PAYMENTS_
ALL
ASSETS_
ADDITION_
FLAG
Indicates whether discounts on invoice payment have been transferred into Oracle Assets.
ASSET_
ACCOUNT_
NUMBER
GL_CODE_
COMBINATIONS_
KFV
CONCATENATED_
SEGMENTS
Account number for assets.
BANK_
ACCOUNT_
NUM
AP_INVOICE_
PAYMENTS_
ALL
BANK_
ACCOUNT_
NUM
Bank account number.
BANK_
ACCOUNT_
TYPE
AP_INVOICE_
PAYMENTS_
ALL
BANK_
ACCOUNT_
TYPE
BANK_NUM
AP_INVOICE_
PAYMENTS_
ALL
BANK_NUM
Bank number.
CASH_
POSTED_
FLAG
AP_INVOICE_
PAYMENTS_
ALL
CASH_
POSTED_
FLAG
DISCOUNT_
LOST
AP_INVOICE_
PAYMENTS_
ALL
DISCOUNT_
LOST
Amount of discount lost.
DISCOUNT_
TAKEN
AP_INVOICE_
PAYMENTS_
ALL
DISCOUNT_
TAKEN
Amount of discount taken.
EXCHANGE_
DATE
AP_INVOICE_
PAYMENTS_
ALL
EXCHANGE_
DATE
Date for which exchange rate is obtained from daily rates table.
EXCHANGE_
RATE
AP_INVOICE_
PAYMENTS_
ALL
EXCHANGE_
RATE
Exchange rate for a foreign currency payment.
EXCHANGE_
RATE_TYPE
AP_INVOICE_
PAYMENTS_
ALL
EXCHANGE_
RATE_TYPE
Exchange rate type for a foreign currency payment.
GAIN_
ACCOUNT_
NUMBER
GL_CODE_
COMBINATIONS_
KFV
CONCATENATED_
SEGMENTS
Account to which realized exchange rate gains are posted.
INVOICE_
BASE_
AMOUNT
AP_INVOICE_
PAYMENTS_
ALL
Payment amount in functional currency at invoice’s exchange rate. Only used for foreign currency invoice payments.
LOSS_
ACCOUNT_
NUMBER
GL_CODE_
COMBINATIONS_
KFV
CONCATENATED_
SEGMENTS
Account to which realized exchange rate losses are posted.
PAYMENT_
BASE_
AMOUNT
AP_INVOICE_
PAYMENTS_
ALL
PAYMENT_
BASE_
AMOUNT
Payment amount at payment’s exchange rate. Only used for foreign currency invoice payments.
PAYMENT_NUM
AP_INVOICE_
PAYMENTS_
ALL
PAYMENT_NUM
Payment number.
PERIOD_NAME
AP_INVOICE_
PAYMENTS_
ALL
PERIOD_NAME
POSTED_FLAG
AP_INVOICE_
PAYMENTS_
ALL
POSTED_FLAG
Indicates whether the payment has been accounted.
SET_OF_BOOKS_
NAME
GL_SETS_OF_
BOOKS
NAME
INVOICE_
PAYMENT_
TYPE
AP_INVOICE_
PAYMENTS_
ALL
INVOICE_
PAYMENT_
TYPE
Creation method of a payment, used by Positive Pay feature (Single or Batch).
OTHER_
INVOICE_
NUM
AP_INVOICES_ALL
OTHER_
INVOICE_
NUM
Related invoice number.
CHECK_NUMBER
AP_CHECKS_ALL
CHECK_NUMBER
CHECK_AMOUNT
AP_CHECKS_ALL
AMOUNT
CHECK_TYPE
AP_LOOKUP_
CODES
DISPLAYED_
FIELD
CHECK_STATUS
AP_LOOKUP_
CODES
DISPLAYED_
FIELD
PAYMENT_
TYPE
AP_LOOKUP_
CODES
DISPLAYED_
FIELD
INVOICE_
AMOUNT
AP_INVOICES_ALL
INVOICE_
AMOUNT
AMOUNT_PAID
AP_INVOICES_ALL
AMOUNT_PAID
EXTERNAL_
BANK_ACCOUNT_
NUMBER
AP_BANK_
ACCOUNTS_
ALL
BANK_ACCOUNT_
NUM
APS_EXTRNL_
BANK_ACCOUNT_
NUMBER
AP_BANK_
ACCOUNTS_
ALL
BANK_ACCOUNT_
NUM