Oracle E-Business Suite – TCA API’s
Technical Overview
This section is broken down into four (4) components and will help find the right APIs for your need, to ensure you select the right one and receive the desired result.
- White Papers/Reference Documents
- TCA API Procedures
- TCA API Programs
- Tables Update
| Tabs | Description |
|---|---|
| White Papers/Reference Documents | This section will list out any white papers and reference documents available that relate to TCA APIs. |
| TCA API Procedures | This section will direct to a note that will list out all the TCA API packages and thier procedures. |
| Tables Updated | This section will list out the tables accessed by the TCA API process along side the API being processed. |
| TCA API Programs | This section will list out the file names with the package and descrtion of what is carried out when using a specif TCA API. |
White Papers
This section will list out all known white papers relating to TCA APIs. Simply click on the link to the desired document listed below.
A White Paper on Creating Customers Using Customer Interface (RACUST) Versus TCA API (Doc Id 201242.1)
Using Tca Apis Including ExampleDocument (Doc Id 201243.1)
Technical Uses of Customer Interface And Tca-Apidocument (Doc Id 269121.1)
Oracle Trading Community Architecture Api User Notes, March 2003 (Doc Id 228445.1)
Oracle Trading Community Architecture Api User Notes, April 2002 (HTML) (Doc Id 164025.1)
Oracle Trading Community Architecture Api User Notes, April 2002 (PDF) (Doc Id 210494.1)
Oracle Trading Community Architecture Api User Notes, August 2002 (HTML) (Doc Id 209866.1)
Oracle Trading Community Architecture Api User Notes, August 2002 (PDF) (Doc Id 207444.1)
TCA API Procedures
The TCA API Procedure tab will take a look all the packages and what procedures are called for those API scripts developed for this note.
Click on the following link: Oracle Trading Community: List of TCA APIs Packages With Procedures (Doc Id 1637819.1)Please note there are more procedures available that can be found in the Oracle Trading Community Architecture Technical Implementation
TCA API Programs
This section will list the file names and the packages used when the TCA API is run. It also provides a small description of what the program does.
The TCA APIs Procedures above provides a breakdown of the procedures available for these programs.
| Entity | File Name | Package Defined | Description |
|---|---|---|---|
| Party – Organization | ARH2PASB.pls ARH2PASS.pls | HZ_PARTY_V2PUB | Package contains public API for person, organization and group. |
| Party Site/Party Site Use | ARH2PSSB.pls ARH2PSSS.pls | HZ_PARTY_SITE_V2PUB | Package has create and update procedures for all party site related tables. |
| Location | ARH2LOSB.pls ARH2LOSS.pls | HZ_LOCATION_V2PUB | Package contains public API for locations. |
| Party Contact(Organization Contact) and Contact Role | ARH2PCSS.pls ARH2PCSB.pls | HZ_PARTY_CONTACT_V2PUB | Package has create and update procedures for contact and contact role. |
| Credit Ratings | ARH2PRSS.pls ARH2PRSB.pls | HZ_PARTY_INFO_V2PUB | This package contains public API for credit ratings. |
| Contact Point | ARH2CPSB.pls ARH2CPSB.pls | HZ_CONTACT_POINT_V2PUB | This package contains public API for contact points. |
| Customer Account/Customer Account Relationship | ARH2CASB.pls ARH2CASS.pls | HZ_CUST_ACCOUNT_V2PUB | Package for creating/updating customer accounts and related entities e.g. customer account relationship. |
| Customer Account Site/Customer Account Site Use | ARH2CSSB.pls ARH2CSSS.pls | HZ_CUST_ACCOUNT_SITE_V2PUB | Package contains public API for customer account sites and site uses. |
| Customer Profiles / Customer Account Site Use Profile / Customer Account Site use Profile Amount | ARH2CFSB.pls ARH2CFSS.pls | HZ_CUSTOMER_PROFILE_V2PUB | Package contains public API for customer profiles and customer profile amounts. |
| Customer Account Site Role (Contact) / Customer Account Site Role Responsibility | ARH2CRSS.pls ARH2CRSB.pls | HZ_CUST_ACCOUNT_ROLE_V2PUB | This package contains public API for customer account roles and role * responsibilities. |
| Relationship between two parties | ARH2RESS.pls / ARH2RESB.pls | HZ_RELATIONSHIP_V2PUB | This Package has create and update procedures for relationships |
| Parties and Customer Accounts | ARH2RTSS.pls / ARH2RTSB.pls | HZ_RELATIONSHIP_TYPE_V2PUB | This Package has create and update procedures for relationship types |
| Parties and Customer Accounts | ARH2CLSS.pls / ARH2CLSB.pls | HZ_CLASSIFICATION_V2PUB | This package contains public API for class categories, class code relationships, class code assignments and class category uses. |
Tables Updated
This section will list all the tables updated when running the TCA APIs.
| Process | API | Table |
|---|---|---|
| Create/Update Organization TCA API | HZ_PARTY_V2PUB.create_organization HZ_PARTY_V2PUB.update_organization HZ_PARTY_V2PUB.get_organization_rec HZ_PARTY_V2PUB.get_party_rec | HZ_PARTIES, HZ_ORGANIZATION_PROFILES, HZ_ORIG_SYS_REFERENCES |
| Create/Update Person TCA API | HZ_PARTY_V2PUB.create_person HZ_PARTY_V2PUB.update_person | HZ_PARTIES, HZ_ORGANIZATION_PROFILES, HZ_ORIG_SYS_REFERENCES |
| Create Group TCA API | HZ_PARTY_V2PUB.create_group HZ_PARTY_V2PUB.update_group HZ_PARTY_V2PUB.get_group_rec | HZ_PARTIES, HZ_ORIG_SYS_REFERENCES |
| Create Credit Ratings TCA API | HZ_PARTY_INFO_V2PUB.create_credit_rating HZ_PARTY_INFO_V2PUB.update_credit_rating HZ_PARTY_INFO_V2PUB.get_credit_rating_rec | HZ_CREDIT_RATINGS |
| Create Org Contact TCA API | HZ_PARTY_CONTACT_V2PUB.create_org_contact | HZ_ORG_CONTACTS HZ_ORIG_SYS_REFERENCES (Optional – HZ_RELATIONSHIPS HZ_PARTIES) |
| Create Org Contact Role TCA API | HZ_PARTY_CONTACT_V2PUB.create_org_contact_role | HZ_ORG_CONTACT_ROLES, HZ_ORIG_SYS_REFERENCES |
| Create Location TCA API | HZ_LOCATION_V2PUB.create_location HZ_LOCATION_V2PUB.update_location HZ_LOCATION_V2PUB.get_location_rec | HZ_LOCATIONS, HZ_ORIG_SYS_REFERENCES |
| Create Location Assignment TCA API | HZ_TAX_ASSIGNMENT_V2PUB.create_loc_assignment HZ_TAX_ASSIGNMENT_V2PUB.update_loc_assignment | HZ_LOC_ASSIGNMENTS |
| Create Party Site TCA API | HZ_PARTY_SITE_V2PUB.create_party_site HZ_PARTY_SITE_V2PUB.update_party_site | HZ_PARTY_SITES, HZ_ORIG_SYS_REFERENCES |
| Create Party Site Use TCA API | HZ_PARTY_SITE_V2PUB.create_party_site_use HZ_PARTY_SITE_V2PUB.update_party_site_use HZ_PARTY_SITE_V2PUB.get_party_site_rec | HZ_PARTY_SITE_USES |
| Create Contact Point TCA API | HZ_CONTACT_POINT_V2PUB | HZ_CONTACT_POINTS, HZ_ORIG_SYS_REFERENCES |
| Create Relationship Type TCA API | HZ_RELATIONSHIP_TYPE_V2PUB.create_relationship_type HZ_RELATIONSHIP_TYPE_V2PUB.update_relationship_type | HZ_RELATIONSHIP_TYPES |
| Create Relationship TCA API | HZ_RELATIONSHIP_V2PUB.create_relationshipHZ_RELATIONSHIP_V2PUB.update _relationship | HZ_RELATIONSHIPS |
| Create Class Category TCA API | HZ_CLASSIFICATION_V2PUB.create_class_category HZ_CLASSIFICATION_V2PUB.update_class_category HZ_CLASSIFICATION_V2PUB.get_class_category_rec | HZ_CLASS_CATEGORIES |
| Create Class Category Use TCA API | HZ_CLASSIFICATION_V2PUB.create_class_category_use HZ_CLASSIFICATION_V2PUB.update_class_category_use HZ_CLASSIFICATION_V2PUB.get_class_category_use_rec | HZ_CLASS_CATEGORY_USES |
| Create Class Code Relation TCA API | HZ_CLASSIFICATION_V2PUB.create_class_code_relation HZ_CLASSIFICATION_V2PUB.update_class_code_relation HZ_CLASSIFICATION_V2PUB.get_class_code_relation_rec | HZ_CLASS_CODE_RELATIONS |
| Create Code Assignment TCA API | HZ_CLASSIFICATION_V2PUB.create_code_assignment HZ_CLASSIFICATION_V2PUB. update_code_assignment HZ_CLASSIFICATION_V2PUB.get_code_assignment_rec | HZ_CODE_ASSIGNMENTS |
| Create Customer Account Relationship TCA API | HZ_CUST_ACCOUNT_V2PUB.create_cust_acct_relate HZ_CUST_ACCOUNT_V2PUB.update_cust_acct_relate HZ_CUST_ACCOUNT_V2PUB.get_cust_acct_relate_rec | HZ_CUST_ACCT_RELATE |
| Create Customer Account Site Use TCA API | HZ_CUST_ACCOUNT_SITE_V2PUB.create_cust_site_use HZ_CUST_ACCOUNT_SITE_V2PUB.update_cust_site_use HZ_CUST_ACCOUNT_SITE_V2PUB.get_cust_site_use_rec | HZ_CUST_SITE_USES, HZ_ORIG_SYS_REFERENCES |
| Create Customer Profile TCA API | HZ_CUSTOMER_PROFILE_V2PUB.create_customer_profile HZ_CUSTOMER_PROFILE_V2PUB.update_customer_profile HZ_CUSTOMER_PROFILE_V2PUB.get_customer_profile_rec | HZ_CUSTOMER_PROFILES |
| Create Customer Profile Amount TCA API | HZ_CUSTOMER_PROFILE_V2PUB.create_cust_profile_amt HZ_CUSTOMER_PROFILE_V2PUB.update_cust_profile_amt HZ_CUSTOMER_PROFILE_V2PUB.get_cust_profile_amt_rec | HZ_CUST_PROFILE_AMTS |
| Create Customer Account Role TCA API | HZ_CUST_ACCOUNT_ROLE_V2PUB.create_cust_account_role HZ_CUST_ACCOUNT_ROLE_V2PUB.update_cust_account_role HZ_CUST_ACCOUNT_ROLE_V2PUB.get_cust_account_role_rec | HZ_CUST_ACCOUNT_ROLES, HZ_ORIG_SYS_REFERENCES |
| Create Role Responsibility TCA API | HZ_CUST_ACCOUNT_ROLE_V2PUB.create_role_responsibility HZ_CUST_ACCOUNT_ROLE_V2PUB.update_role_responsibility HZ_CUST_ACCOUNT_ROLE_V2PUB.get_role_responsibility_rec | HZ_ROLE_RESPONSIBILITY |
| Create Source System Reference TCA API | HZ_ORIG_SYSTEM_REF_PUB.create_orig_system_reference HZ_ORIG_SYSTEM_REF_PUB.update_orig_system_reference HZ_ORIG_SYSTEM_REF_PUB.get_orig_sys_reference_rec | HZ_ORIG_SYS |