R12 Oracle Receivables API User Notes - PDF format

456 Pages·2006·1.07 MB·English

Oracle® Receivables
Reference Guide
Release 12
Part No. B31213-01
December 2006
Oracle Receivables Reference Guide, Release 12
Part No. B31213-01
Copyright © 1988, 2006, Oracle. All rights reserved.
Primary Author:     Charles Ahern, Stephen R. Damiani, Melanie Heisler, Essan Ni Jirman, Shivranjini
Krishnamurthy, Robert MacIsaac, Kristin Penaskovic, Vijay Tiwary
The Programs (which include both the software and documentation) contain proprietary information; they
are provided under a license agreement containing restrictions on use and disclosure and are also protected
by copyright, patent, and other intellectual and industrial property laws. Reverse engineering, disassembly, or
decompilation of the Programs, except to the extent required to obtain interoperability with other
independently created software or as specified by law, is prohibited.
The information contained in this document is subject to change without notice. If you find any problems in
the documentation, please report them to us in writing. This document is not warranted to be error-free.
Except as may be expressly permitted in your license agreement for these Programs, no part of these
Programs may be reproduced or transmitted in any form or by any means, electronic or mechanical, for any
purpose.
If the Programs are delivered to the United States Government or anyone licensing or using the Programs on
behalf of the United States Government, the following notice is applicable:
U.S. GOVERNMENT RIGHTS
Programs, software, databases, and related documentation and technical data delivered to U.S. Government
customers are "commercial computer software" or "commercial technical data" pursuant to the applicable
Federal Acquisition Regulation and agency-specific supplemental regulations. As such, use, duplication,
disclosure, modification, and adaptation of the Programs, including documentation and technical data, shall
be subject to the licensing restrictions set forth in the applicable Oracle license agreement, and, to the extent
applicable, the additional rights set forth in FAR 52.227-19, Commercial Computer Software--Restricted
Rights (June 1987). Oracle Corporation, 500 Oracle Parkway, Redwood City, CA 94065.
The Programs are not intended for use in any nuclear, aviation, mass transit, medical, or other inherently
dangerous applications. It shall be the licensee's responsibility to take all appropriate fail-safe, backup,
redundancy and other measures to ensure the safe use of such applications if the Programs are used for such
purposes, and we disclaim liability for any damages caused by such use of the Programs.
The Programs may provide links to Web sites and access to content, products, and services from third parties.
Oracle is not responsible for the availability of, or any content provided on, third-party Web sites. You bear all
risks associated with the use of such content. If you choose to purchase any products or services from a third
party, the relationship is directly between you and the third party. Oracle is not responsible for: (a) the quality
of third-party products or services; or (b) fulfilling any of the terms of the agreement with the third party,
including delivery of products or services and warranty obligations related to purchased products or services.
Oracle is not responsible for any loss or damage of any sort that you may incur from dealing with any third
party.
Oracle, JD Edwards, PeopleSoft, and Siebel are registered trademarks of Oracle Corporation and/or its
affiliates. Other names may be trademarks of their respective owners.
Contents
Send Us Your Comments
Preface
1 Using Oracle Receivables APIs
MajorFeatures...........................................................................................................................1-1
SolutionOutline........................................................................................................................1-3
2 Adjustment API User Notes
Overview................................................................................................................................... 2-1
APIUsage.................................................................................................................................. 2-1
Ar_Adjust_pub.Create_Adjustment....................................................................................2-3
Ar_Adjust_pub.Approve_Adjustment.............................................................................. 2-12
Ar_Adjust_pub.Modify_Adjustment.................................................................................2-17
Ar_Adjust_pub.Reverse_Adjustment................................................................................2-22
Messages..................................................................................................................................2-24
3 Credit Memo Approval and Creation API User Notes
Overview................................................................................................................................... 3-1
APIUsage.................................................................................................................................. 3-2
AR_CREDIT_MEMO_API_PUB.Create_Request................................................................3-2
AR_CREDIT_MEMO_API_PUB.Get_Request_Status..........................................................3-9
Messages..................................................................................................................................3-12
4 Credit Memo Application API User Notes
Overview................................................................................................................................... 4-1
    iii
APIUsage.................................................................................................................................. 4-1
ar_cm_application_pub.activity_application.......................................................................4-2
ar_cm_application_pub.activity_unapplication.................................................................4-11
Messages..................................................................................................................................4-15
5 Deposit API User Notes
Overview................................................................................................................................... 5-1
APIUsage.................................................................................................................................. 5-1
AR_DEPOSIT_API_PUB.Create_deposit.............................................................................5-2
AR_DEPOSIT_API_PUB.insert_non_rev_salescredit........................................................ 5-27
Messages..................................................................................................................................5-32
6 Invoice Creation API User Notes
Overview................................................................................................................................... 6-1
APIUsage.................................................................................................................................. 6-2
AR_INVOICE_API_PUB......................................................................................................6-2
7 Prepayments API User Notes
Overview................................................................................................................................... 7-1
APIUsage.................................................................................................................................. 7-2
AR_PREPAYMENTS_PUB.Create_Prepayment..................................................................7-2
AR_PREPAYMENTS_PUB.Get_Installment........................................................................7-9
Messages..................................................................................................................................7-11
8 Receipt API User Notes
Overview................................................................................................................................... 8-1
APIUsage.................................................................................................................................. 8-2
Ar_receipt_api_pub.Create_cash.........................................................................................8-3
Ar_receipt_api_pub.Apply................................................................................................8-21
Ar_receipt_api_pub.Create_and_apply.............................................................................8-35
Ar_receipt_api_pub.Unapply............................................................................................ 8-55
Ar_receipt_api_pub.Apply_on_account............................................................................8-61
Ar_receipt_api_pub.Unapply_on_account........................................................................8-66
Ar_receipt_api_pub.Reverse..............................................................................................8-70
Ar_receipt_api_pub.activity_application...........................................................................8-75
Ar_receipt_api_pub.activity_unapplication.......................................................................8-82
Ar_receipt_api_pub.Create_misc.......................................................................................8-86
Ar_receipt_api_pub.apply_other_account.......................................................................8-100
Ar_receipt_api_pub.unapply_other_account...................................................................8-107
iv
Ar_receipt_api_pub.apply_open_receipt.........................................................................8-111
Ar_receipt_api_pub.unapply_open_receipt.....................................................................8-117
Ar_receipt_api_pub.Create_apply_on_acc...................................................................... 8-120
Messages................................................................................................................................8-136
9 Revenue Adjustment API User Notes
Overview................................................................................................................................... 9-1
APIUsage.................................................................................................................................. 9-2
AR_RevenueAdjust_PUB.Unearn_Revenue........................................................................9-2
AR_RevenueAdjust_PUB.Earn_Revenue...........................................................................9-16
AR_RevenueAdjust_PUB.Transfer_Sales_Credits.............................................................9-18
AR_RevenueAdjust_PUB.Add_Non_Revenue_Sales_Credits...........................................9-23
Messages..................................................................................................................................9-27
A Predefined Setup for Oracle Subledger Accounting
DatathatOracleReceivablesPredefinesforOracleSubledgerAccounting..........................A-1
B Oracle Receivables Table and Column Descriptions
AutoInvoiceTableandColumnDescriptions.........................................................................B-1
LockboxTableandColumnDescriptions..............................................................................B-62
ReceiptandQuickCashTables..........................................................................................B-62
LockboxInterfaceTableandColumnDescriptions...........................................................B-63
C Seeded Match Rules
SeededSearchMatchRules......................................................................................................C-1
SAMPLE:BASICSEARCHRULE.......................................................................................C-2
SAMPLE:ADVANCEDSEARCHRULE............................................................................C-4
D XML Transactions
XMLReceivablesDocumentsMapping...................................................................................D-1
ProcessInvoiceXMLMessageMap....................................................................................D-1
ConfirmBODMessageMap................................................................................................D-5
TransactionLimitations.......................................................................................................D-6
Index
    v

Send Us Your Comments
Oracle Receivables Reference Guide, Release 12
Part No. B31213-01
Oracle welcomes customers' comments and suggestions on the quality and usefulness of this document.
Your feedback is important, and helps us to best meet your needs as a user of our products. For example:
• Are the implementation steps correct and complete?
• Did you understand the context of the procedures?
• Did you find any errors in the information?
• Does the structure of the information help you with your tasks?
• Do you need different information or graphics? If so, where, and in what format?
• Are the examples correct? Do you need more examples?
If you find any errors or have any other suggestions for improvement, then please tell us your name, the
name of the company who has licensed our products, the title and part number of the documentation and
the chapter, section, and page number (if available).
Note: Before sending us your comments, you might like to check that you have the latest version of the
document and if any concerns are already addressed. To do this, access the new Applications Release
Online Documentation CD available on Oracle MetaLink and www.oracle.com. It contains the most
current Documentation Library plus all documents revised or released recently.
Send your comments to us using the electronic mail address: [email protected]
Please give your name, address, electronic mail address, and telephone number (optional).
If you need assistance with Oracle software, then please contact your support representative or Oracle
Support Services.
If you require training or instruction in using Oracle software, then please contact your Oracle local office
and inquire about our Oracle University offerings. A list of Oracle offices is available on our Web site at
www.oracle.com.
    vii

Preface
Intended Audience
Welcome to Release 12 of the Oracle Receivables Reference Guide.
This guide assumes you have a working knowledge of the following:
• The principles and customary practices of your business area.
• Computer desktop application usage and terminology
If you have never used Oracle Applications, we suggest you attend one or more of the
Oracle Applications training classes available through Oracle University.
See Related Information Sources on page x for more Oracle Applications product
information.
TTY Access to Oracle Support Services
Oracle provides dedicated Text Telephone (TTY) access to Oracle Support Services
within the United States of America 24 hours a day, seven days a week. For TTY
support, call 800.446.2398.
Documentation Accessibility
Our goal is to make Oracle products, services, and supporting documentation
accessible, with good usability, to the disabled community. To that end, our
documentation includes features that make information available to users of assistive
technology. This documentation is available in HTML format, and contains markup to
facilitate access by the disabled community. Accessibility standards will continue to
evolve over time, and Oracle is actively engaged with other market-leading technology
vendors to address technical obstacles so that our documentation can be accessible to all
of our customers. For more information, visit the Oracle Accessibility Program Web site
    ix
at http://www.oracle.com/accessibility/ .
Accessibility of Code Examples in Documentation
Screen readers may not always correctly read the code examples in this document. The
conventions for writing code require that closing braces should appear on an otherwise
empty line; however, some screen readers may not always read a line of text that
consists solely of a bracket or brace.
Accessibility of Links to External Web Sites in Documentation
This documentation may contain links to Web sites of other companies or organizations
that Oracle does not own or control. Oracle neither evaluates nor makes any
representations regarding the accessibility of these Web sites.
Structure
1  Using Oracle Receivables APIs
2  Adjustment API User Notes
3  Credit Memo Approval and Creation API User Notes
4  Credit Memo Application API User Notes
5  Deposit API User Notes
6  Invoice Creation API User Notes
7  Prepayments API User Notes
8  Receipt API User Notes
9  Revenue Adjustment API User Notes
A  Predefined Setup for Oracle Subledger Accounting
B  Oracle Receivables Table and Column Descriptions
C  Seeded Match Rules
D  XML Transactions
Related Information Sources
This document is included on the Oracle Applications Document Library, which is
supplied in the Release 12 DVD Pack. You can download soft-copy documentation as
PDF files from the Oracle Technology Network at http://otn.oracle.com/documentation,
or you can purchase hard-copy documentation from the Oracle Store at
http://oraclestore.oracle.com. The Oracle E-Business Suite Documentation Library
Release 12 contains the latest information, including any documents that have changed
significantly between releases. If substantial changes to this book are necessary, a
revised version will be made available on the online documentation CD on Oracle
MetaLink.
If this guide refers you to other Oracle Applications documentation, use only the
Release 12 versions of those guides.
For a full list of documentation resources for Oracle Applications Release 12, see Oracle
Applications Documentation Resources, Release 12, OracleMetaLink Document
x