apicus[1]

65
ORACLE CORPORATION Trading Community Architecture Technical Uses of Customer Interface and TCA-API Author: Fenner Giraldo Creation Date: January 2004 Last Updated: January 2004 Version: 1.0 1

Upload: rishabh-jain

Post on 08-Apr-2015

288 views

Category:

Documents


10 download

TRANSCRIPT

Page 1: apicus[1]

ORACLE CORPORATION Trading Community Architecture Technical Uses of Customer Interface and TCA-API

Author: Fenner Giraldo

Creation Date: January 2004

Last Updated: January 2004

Version: 1.0

1

Page 2: apicus[1]

Contents

Overview..................................................................................................................................3

Some uses of TCA-API and Customer Interface ................................................................4

TCA-API and Customer Interface tables involved ............................................................5

TCA-API and Customer Interface columns involved........................................................9

TCA API............................................................................................................................9 Customer Interface ........................................................................................................41

2

Page 3: apicus[1]

Overview

The purpose of this document is to identify functionalities you can or cannot do using customer interface and TCA APIs

3

Page 4: apicus[1]

Some uses of TCA-API and Customer Interface First, we will to identify the general uses for Customer Interface and TCA-APIs. While Customer Interface uses five tables to insert or update information, the TCA-APIs uses packages that allow insert or update to several tables or to simply format or retrieve information. Remember:

• You CANNOT delete information with customer interface or TCA-APIs. • Customer interface is used to handle account related information. • TCA-APIs are used to handle party and some account related information. • TCA-APIs were created in 11i (HZ-F - 1921951) • TCA-APIs cannot be used on versions previous to 11i (Ex: 10.5, 10.7, 11.0.2, 11.0.3, etc). • TCA-APIs cannot insert/update payment methods information. • TCA-APIs cannot insert/update bank accounts information. • Customer interface can insert payment methods information. • Customer interface can insert bank accounts information.

4

Page 5: apicus[1]

TCA-API and Customer Interface tables involved What are the tables that Customer Interface uses? Customer interface uses the following tables: RA_CUSTOMERS_INTERFACE / RA_CUSTOMERS_INTERFACE_ALL

• The RA_CUSTOMERS_INTERFACE_ALL table is one of the Customer Interface tables that Oracle Receivables uses to import customer, address, customer profiles, and site use information. Receivables uses this customer information to create records in the RA_CUSTOMERS, RA_ADDRESSES_ALL, RA_CUSTOMER_RELATIONSHIPS_ALL, and RA_SITE_USES_ALL tables. Receivables deletes all information from this table after your customer data is successfully imported.

RA_CUSTOMER_PROFILES_INTERFACE / RA_CUSTOMER_PROFILES_INT_ALL

• The RA_CUSTOMER_PROFILES_INT_ALL table is used by the Customer Interface program to store customer profile information in HZ_CUST_PROFILE_CLASSES. If you enter a new customer, you must either pass a customer profile class that already exists in Oracle Receivables, or pass customer profile values. Values in this table are not required if you are not entering a new customer or assigning customer profile information to customer addresses.

RA_CONTACT_PHONES_INTERFACE / RA_CONTACT_PHONES_INT_ALL

• The RA_CONTACT_PHONES_INT_ALL table is one of the Customer Interface tables that Oracle Receivables uses to import contact and telephone information for your customers’ addresses and Business purposes. Receivables uses this customer information to create records in the RA_CONTACTS and RA_PHONES tables.

RA_CUSTOMER_BANKS_INTERFACE / RA_CUSTOMER_BANKS_INT_ALL

• The RA_CUSTOMER_BANKS_INT_ALL table is used by the Customer Interface program to store customer bank account information. For example, Oracle Receivables might use this table to store information about a Bank of America branch, located in Sunnyvale, California, that is used by a customer to pay invoices.

RA_CUST_PAY_METHOD_INTERFACE / RA_CUST_PAY_METHOD_INT_ALL

• The RA_CUST_PAY_METHOD_INT_ALL table contains customer interface data for payment methods. Each row represents a payment method that is assigned to a customer.

The five interface tables do not allow insert and update of every column in each table mentioned above. The TCA-APIs are very useful to alleviate this problem. They allow the insert and update of many more columns. But the TCA_APIs do not allow any insert or update to the payment methods or bank accounts tables information.

5

Page 6: apicus[1]

The following table shows the object tables that TCA-APIs use:

API TABLE Create Organization API HZ_PARTIES,

HZ_ORGANIZATION_PROFILES, HZ_ORIG_SYS_REFERENCES

Create Person API HZ_PARTIES, HZ_PERSON_PROFILES, HZ_ORIG_SYS_REFERENCES

Create Group API HZ_PARTIES, HZ_ORIG_SYS_REFERENCES Create Credit Ratings API HZ_CREDIT_RATINGS Create Org Contact API HZ_ORG_CONTACTS,

HZ_RELATIONSHIPS, HZ_ORIG_SYS_REFERENCES

Create Org Contact Role API HZ_ORG_CONTACT_ROLES, HZ_ORIG_SYS_REFERENCES

Create Person Language API HZ_PERSON_LANGUAGE Create Citizenship API HZ_CITIZENSHIP Create Education API HZ_EDUCATION Create Employment History API HZ_EMPLOYMENT_HISTORY Create Work Classes API HZ_WORK_CLASS Create Person Interest API HZ_PERSON_INTEREST Create Financial Report API HZ_FINANCIAL_REPORTS Create Financial Number API HZ_FINANCIAL_NUMBERS Create Location API HZ_LOCATIONS,

HZ_ORIG_SYS_REFERENCES Create Party Site API HZ_PARTY_SITES,

HZ_ORIG_SYS_REFERENCES Create Party Site Use API HZ_PARTY_SITE_USES Create Contact Point API HZ_CONTACT_POINTS,

HZ_ORIG_SYS_REFERENCES Create Relationship Type API HZ_RELATIONSHIP_TYPES Create Relationship API HZ_RELATIONSHIPS Create Class Category API HZ_CLASS_CATEGORIES Create Class Code Relation API HZ_CLASS_CODE_RELATIONS Create Code Assignment API HZ_CODE_ASSIGNMENTS Create Class Category Use API HZ_CLASS_CATEGORY_USES Create Contact Preference API HZ_CONTACT_PREFERENCES Create Customer Account API (Person or Organization)

HZ_CUST_ACCOUNTS, HZ_CUSTOMER_PROFILES, HZ_ORIG_SYS_REFERENCES, HZ_PARTIES, HZ_ORGANIZATION_PROFILES, HZ_PERSON_PROFILES

Create Customer Account Relationship API HZ_CUST_ACCT_RELATE Create Customer Account Site API HZ_CUST_ACCT_SITES,

HZ_ORIG_SYS_REFERENCES Create Customer Account Site Use API HZ_CUST_SITE_USES,

HZ_ORIG_SYS_REFERENCES Create Customer Profile API HZ_CUSTOMER_PROFILES Create Customer Profile Amount API HZ_CUST_PROFILE_AMTS Create Customer Account Role API HZ_CUST_ACCOUNT_ROLES,

HZ_ORIG_SYS_REFERENCES Create Role Responsibility API HZ_ROLE_RESPONSIBILITY Create Source System Reference API HZ_ORIG_SYS_MAPPING Create Location Assignment API HZ_LOC_ASSIGNMENTS

6

Page 7: apicus[1]

In addition, here are some API’s to retrieve and format information. The following table shows these:

API ACTION Phone Number Parsing API To parse a raw phone number into the country

code, area code and subscriber number based on the setup of country and user phone preferences.

Number Formatting API To format a phone number for display, based on the appropriate country phone format and the user’s preferences.

Name Formatting API To format the name of a person using a particular format (Style Format).

Address Formatting API To format an address using a particular format (Style Format).

General Data Formatting API To format any type of information from any data source.

Top Parent Check API To check whether an entity is top parent, or root, in a hierarchy or not.

Parent Child Relationship Check API To check whether two entities have a parent-child relationship in a hierarchy.

Get Parent Nodes API To retrieve the parent nodes of a child in a hierarchy.

Get Child Nodes API To retrieve the child nodes of a parent in a hierarchy.

Get Top Parent Nodes API To retrieve the top parent nodes in a hierarchy. Note that not all the columns on any table previously mentioned can be accessed by the TCA-APIs. Some of the columns which can have data inserted via the TCA-APIs are not updatable. For example: CREATE PARTY SITE USE API uses these fields: PARTY_SITE_USE_ID COMMENTS PARTY_SITE_ID SITE_USE_TYPE PRIMARY_PER_TYPE STATUS CREATED_BY_MODULE APPLICATION_ID

7

Page 8: apicus[1]

While HZ_PARTY_SITE_USES table has these columns: PARTY_SITE_USE_ID BEGIN_DATE COMMENTS END_DATE PARTY_SITE_ID LAST_UPDATE_DATE REQUEST_ID LAST_UPDATED_BY PROGRAM_APPLICATION_ID CREATION_DATE PROGRAM_ID CREATED_BY PROGRAM_UPDATE_DATE LAST_UPDATE_LOGIN WH_UPDATE_DATE SITE_USE_TYPE PRIMARY_PER_TYPE STATUS OBJECT_VERSION_NUMBER CREATED_BY_MODULE APPLICATION_ID In this case:

• The REQUEST_ID is a column that is on the HZ_PARTY_SITE_USES table but that column cannot be used on Create Party Site Use API.

• PARTY_SITE_ID field is not updatable.

8

Page 9: apicus[1]

TCA-API and Customer Interface columns involved

Instead of mentioning the new or obsolete functionalities, let’s review the columns that can be inserted or updated using the TCA-APIs and Customer interface. You can only use columns that appear on this list. The use of any additional column would be an enhancement request.

As a note, this information was taken from an instance with HZ-L (3036401) + HZ CONSOLIDATED ROLLUP PATCH 12.01 (3209839).

9

Page 10: apicus[1]

TCA API

Customer Account API

The following table lists information about the fields you can use on the Create Customer Account API

CustAccount Record Fields cust_account_id account_number attribute_category attribute1 attribute2 attribute3 attribute4 attribute5 attribute6 attribute7 attribute8 attribute9 attribute10 attribute11 attribute12 attribute13 attribute14 attribute15 attribute16 attribute17 attribute18 attribute19 attribute20 global_attribute_category global_attribute1 global_attribute2 global_attribute3 global_attribute4 global_attribute5 global_attribute6 global_attribute7 global_attribute8 global_attribute9 global_attribute10 global_attribute11 global_attribute12 global_attribute13 global_attribute14 global_attribute15 global_attribute16

10

Page 11: apicus[1]

global_attribute17 global_attribute18 global_attribute19 global_attribute20 orig_system_reference orig_system status customer_type customer_class_code primary_salesrep_id sales_channel_code order_type_id price_list_id tax_code fob_point freight_term ship_via warehouse_id tax_header_level_flag tax_rounding_rule coterminate_day_month primary_specialist_id secondary_specialist_id account_liable_flag current_balance account_established_date account_termination_date account_activation_date department held_bill_expiration_date hold_bill_flag realtime_rate_flag acct_life_cycle_status account_name deposit_refund_method dormant_account_flag npa_number suspension_date source_code comments dates_negative_tolerance dates_positive_tolerance date_type_preference over_shipment_tolerance under_shipment_tolerance over_return_tolerance under_return_tolerance item_cross_ref_pref ship_sets_include_lines_flag arrivalsets_include_lines_flag sched_date_push_flag invoice_quantity_rule status_update_date autopay_flag

11

Page 12: apicus[1]

notify_flag last_batch_id selling_party_id created_by_module application_id

12

Page 13: apicus[1]

Organization API

The following table lists information about the fields you can use on the Create Organization API.

Organization Record Fields organization_name duns_number_c enquiry_duns ceo_name ceo_title principal_name principal_title legal_status control_yr employees_total hq_branch_ind branch_flag oob_ind line_of_business cong_dist_code sic_code import_ind export_ind labor_surplus_ind debarment_ind minority_owned_ind minority_owned_type woman_owned_ind disadv_8a_ind small_bus_ind rent_own_ind debarments_count debarments_date failure_score failure_score_natnl_percentile failure_score_override_code failure_score_commentary global_failure_score db_rating credit_score credit_score_commentary paydex_score paydex_three_months_ago paydex_norm best_time_contact_begin best_time_contact_end organization_name_phonetic tax_reference gsa_indicator_flag jgzz_fiscal_code analysis_fy

13

Page 14: apicus[1]

fiscal_yearend_month curr_fy_potential_revenue next_fy_potential_revenue year_established mission_statement organization_type business_scope corporation_class known_as known_as2 known_as3 known_as4 known_as5 local_bus_iden_type local_bus_identifier pref_functional_currency registration_type total_employees_text total_employees_ind total_emp_est_ind total_emp_min_ind parent_sub_ind incorp_year sic_code_type public_private_ownership_flag internal_flag local_activity_code_type local_activity_code emp_at_primary_adr emp_at_primary_adr_text emp_at_primary_adr_est_ind emp_at_primary_adr_min_ind high_credit avg_high_credit total_payments credit_score_class credit_score_natl_percentile credit_score_incd_default credit_score_age credit_score_date credit_score_commentary2 credit_score_commentary3 credit_score_commentary4 credit_score_commentary5 credit_score_commentary6 credit_score_commentary7 credit_score_commentary8 credit_score_commentary9 credit_score_commentary10 failure_score_class failure_score_incd_default failure_score_age failure_score_date failure_score_commentary2

14

Page 15: apicus[1]

failure_score_commentary3 failure_score_commentary4 failure_score_commentary5 failure_score_commentary6 failure_score_commentary7 failure_score_commentary8 failure_score_commentary9 failure_score_commentary10 maximum_credit_recommendation maximum_credit_currency_code displayed_duns_party_id content_source_type content_source_number attribute_category attribute1 attribute2 attribute3 attribute4 attribute5 attribute6 attribute7 attribute8 attribute9 attribute10 attribute11 attribute12 attribute13 attribute14 attribute15 attribute16 attribute17 attribute18 attribute19 attribute20 created_by_module application_id do_not_confuse_with actual_content_source party_rec

15

Page 16: apicus[1]

Party Record For Oraganization and Person API

The following table lists information about the fields you can use on the Create Organization API and Create Person API for the Party record.

Party Record Fields party_id party_number validated_flag orig_system_reference orig_system status category_code salutation attribute_category attribute1 attribute2 attribute3 attribute4 attribute5 attribute6 attribute7 attribute8 attribute9 attribute10 attribute11 attribute12 attribute13 attribute14 attribute15 attribute16 attribute17 attribute18 attribute19 attribute20 attribute21 attribute22 attribute23 attribute24

16

Page 17: apicus[1]

Customer Account Site Use API

The following table lists information about the fields you can use on the Customer Account Site Use API.

Cust Site Use Record Fields site_use_id cust_acct_site_id site_use_code primary_flag status location bill_to_site_use_id orig_system_reference orig_system sic_code payment_term_id gsa_indicator ship_via fob_point order_type_id price_list_id freight_term warehouse_id territory_id attribute_category attribute1 attribute2 attribute3 attribute4 attribute5 attribute6 attribute7 attribute8 attribute9 attribute10 tax_reference sort_priority tax_code attribute11 attribute12 attribute13 attribute14 attribute15 attribute16 attribute17 attribute18 attribute19 attribute20 attribute21 attribute22

17

Page 18: apicus[1]

attribute23 attribute24 attribute25 demand_class_code tax_header_level_flag tax_rounding_rule global_attribute1 global_attribute2 global_attribute3 global_attribute4 global_attribute5 global_attribute6 global_attribute7 global_attribute8 global_attribute9 global_attribute10 global_attribute11 global_attribute12 global_attribute13 global_attribute14 global_attribute15 global_attribute16 global_attribute17 global_attribute18 global_attribute19 global_attribute20 global_attribute_category primary_salesrep_id finchrg_receivables_trx_id dates_negative_tolerance dates_positive_tolerance date_type_preference over_shipment_tolerance under_shipment_tolerance item_cross_ref_pref over_return_tolerance under_return_tolerance ship_sets_include_lines_flag arrivalsets_include_lines_flag sched_date_push_flag invoice_quantity_rule gl_id_rec gl_id_rev gl_id_tax gl_id_freight gl_id_clearing gl_id_unbilled gl_id_unearned gl_id_unpaid_rec gl_id_remittance gl_id_factor tax_classification created_by_module application_id

18

Page 19: apicus[1]

Credit Rating API

The following table lists information about the fields you can use on the Create Credit Ratings API.

Credit Rating Record Fields credit_rating_id description party_id rating rated_as_of_date rating_organization comments det_history_ind fincl_embt_ind criminal_proceeding_ind claims_ind secured_flng_ind fincl_lgl_event_ind disaster_ind oprg_spec_evnt_ind other_spec_evnt_ind status avg_high_credit credit_score credit_score_age credit_score_class credit_score_commentary credit_score_commentary2 credit_score_commentary3 credit_score_commentary4 credit_score_commentary5 credit_score_commentary6 credit_score_commentary7 credit_score_commentary8 credit_score_commentary9 credit_score_commentary10 credit_score_date credit_score_incd_default credit_score_natl_percentile failure_score failure_score_age failure_score_class failure_score_commentary failure_score_commentary2 failure_score_commentary3 failure_score_commentary4 failure_score_commentary5 failure_score_commentary6 failure_score_commentary7 failure_score_commentary8

19

Page 20: apicus[1]

failure_score_commentary9 failure_score_commentary10 failure_score_date failure_score_incd_default failure_score_natnl_percentile failure_score_override_code global_failure_score debarment_ind debarments_count debarments_date high_credit maximum_credit_currency_code maximum_credit_rcmd paydex_norm paydex_score paydex_three_months_ago credit_score_override_code cr_scr_clas_expl low_rng_delq_scr high_rng_delq_scr delq_pmt_rng_prcnt delq_pmt_pctg_for_all_firms num_trade_experiences paydex_firm_days paydex_firm_comment paydex_industry_days paydex_industry_comment paydex_comment suit_ind lien_ind judgement_ind bankruptcy_ind no_trade_ind prnt_hq_bkcy_ind num_prnt_bkcy_filing prnt_bkcy_filg_type prnt_bkcy_filg_chapter prnt_bkcy_filg_date num_prnt_bkcy_convs prnt_bkcy_conv_date prnt_bkcy_chapter_conv slow_trade_expl negv_pmt_expl pub_rec_expl business_discontinued spcl_event_comment num_spcl_event spcl_event_update_date spcl_evnt_txt actual_content_source

20

Page 21: apicus[1]

Customer Profile API

The following table lists information about the fields you can use on the Create Customer Profile API.

Customer Profile Record Fields cust_account_profile_id cust_account_id status collector_id credit_analyst_id credit_checking next_credit_review_date tolerance discount_terms dunning_letters interest_charges send_statements credit_balance_statements credit_hold profile_class_id site_use_id credit_rating risk_code standard_terms override_terms dunning_letter_set_id interest_period_days payment_grace_days discount_grace_days statement_cycle_id account_status percent_collectable autocash_hierarchy_id attribute_category attribute1 attribute2 attribute3 attribute4 attribute5 attribute6 attribute7 attribute8 attribute9 attribute10 attribute11 attribute12 attribute13 attribute14 attribute15 auto_rec_incl_disputed_flag

21

Page 22: apicus[1]

tax_printing_option charge_on_finance_charge_flag grouping_rule_id clearing_days jgzz_attribute_category jgzz_attribute1 jgzz_attribute2 jgzz_attribute3 jgzz_attribute4 jgzz_attribute5 jgzz_attribute6 jgzz_attribute7 jgzz_attribute8 jgzz_attribute9 jgzz_attribute10 jgzz_attribute11 jgzz_attribute12 jgzz_attribute13 jgzz_attribute14 jgzz_attribute15 global_attribute1 global_attribute2 global_attribute3 global_attribute4 global_attribute5 global_attribute6 global_attribute7 global_attribute8 global_attribute9 global_attribute10 global_attribute11 global_attribute12 global_attribute13 global_attribute14 global_attribute15 global_attribute16 global_attribute17 global_attribute18 global_attribute19 global_attribute20 global_attribute_category cons_inv_flag cons_inv_type autocash_hierarchy_id_for_adr lockbox_matching_option created_by_module application_id review_cycle last_credit_review_date party_id credit_classification

22

Page 23: apicus[1]

Customer Profile Amount API

The following table lists information about the fields you can use on the Create Customer Profile Amount API.

Cust Profile Amt Record Fields cust_acct_profile_amt_id cust_account_profile_id currency_code trx_credit_limit overall_credit_limit min_dunning_amount min_dunning_invoice_amount max_interest_charge min_statement_amount auto_rec_min_receipt_amount interest_rate attribute_category attribute1 attribute2 attribute3 attribute4 attribute5 attribute6 attribute7 attribute8 attribute9 attribute10 attribute11 attribute12 attribute13 attribute14 attribute15 min_fc_balance_amount min_fc_invoice_amount cust_account_id site_use_id expiration_date jgzz_attribute_category jgzz_attribute1 jgzz_attribute2 jgzz_attribute3 jgzz_attribute4 jgzz_attribute5 jgzz_attribute6 jgzz_attribute7 jgzz_attribute8 jgzz_attribute9 jgzz_attribute10 jgzz_attribute11 jgzz_attribute12

23

Page 24: apicus[1]

jgzz_attribute13 jgzz_attribute14 jgzz_attribute15 global_attribute1 global_attribute2 global_attribute3 global_attribute4 global_attribute5 global_attribute6 global_attribute7 global_attribute8 global_attribute9 global_attribute10 global_attribute11 global_attribute12 global_attribute13 global_attribute14 global_attribute15 global_attribute16 global_attribute17 global_attribute18 global_attribute19 global_attribute20 global_attribute_category created_by_module application_id

24

Page 25: apicus[1]

Relationship API

The following table lists information about the fields you can use on the Create Relationship API.

Relationship Record Fields relationship_id subject_id subject_type subject_table_name object_id object_type object_table_name relationship_code relationship_type comments start_date end_date status content_source_type attribute_category attribute1 attribute2 attribute3 attribute4 attribute5 attribute6 attribute7 attribute8 attribute9 attribute10 attribute11 attribute12 attribute13 attribute14 attribute15 attribute16 attribute17 attribute18 attribute19 attribute20 created_by_module application_id party_rec additional_information1 additional_information2 additional_information3 additional_information4 additional_information5 additional_information6 additional_information7 additional_information8

25

Page 26: apicus[1]

additional_information9 additional_information10 additional_information11 additional_information12 additional_information13 additional_information14 additional_information15 additional_information16 additional_information17 additional_information18 additional_information19 additional_information20 additional_information21 additional_information22 additional_information23 additional_information24 additional_information25 additional_information26 additional_information27 additional_information28 additional_information29 additional_information30 percentage_ownership actual_content_source

26

Page 27: apicus[1]

Person API

The following table lists information about the fields you can use on the Create Person API.

Person Record Fields person_pre_name_adjunct person_first_name person_middle_name person_last_name person_name_suffix person_title person_academic_title person_previous_last_name person_initials known_as known_as2 known_as3 known_as4 known_as5 person_name_phonetic person_first_name_phonetic person_last_name_phonetic middle_name_phonetic tax_reference jgzz_fiscal_code person_iden_type person_identifier date_of_birth deceased_ind place_of_birth date_of_death gender declared_ethnicity marital_status marital_status_effective_date personal_income head_of_household_flag household_income household_size rent_own_ind last_known_gps content_source_type internal_flag attribute_category attribute1 attribute2 attribute3 attribute4 attribute5 attribute6 attribute7

27

Page 28: apicus[1]

attribute8 attribute9 attribute10 attribute11 attribute12 attribute13 attribute14 attribute15 attribute16 attribute17 attribute18 attribute19 attribute20 created_by_module application_id actual_content_source party_rec

28

Page 29: apicus[1]

Location API

The following table lists information about the fields you can use on the Create Location API.

Location Record Fields location_id orig_system_reference orig_system country address1 address2 address3 address4 city postal_code state province county address_key address_style validated_flag address_lines_phonetic po_box_number house_number street_suffix street street_number floor suite postal_plus4_code position location_directions address_effective_date address_expiration_date clli_code language short_description description geometry loc_hierarchy_id sales_tax_geocode sales_tax_inside_city_limits fa_location_id content_source_type attribute_category attribute1 attribute2 attribute3 attribute4 attribute5 attribute6

29

Page 30: apicus[1]

attribute7 attribute8 attribute9 attribute10 attribute11 attribute12 attribute13 attribute14 attribute15 attribute16 attribute17 attribute18 attribute19 attribute20 timezone_id created_by_module application_id

30

Page 31: apicus[1]

Customer Account Site API

The following table lists information about the fields you can use on the Create Customer Account Site API.

Cust Acct Site Record Fields cust_acct_site_id cust_account_id party_site_id attribute_category attribute1 attribute2 attribute3 attribute4 attribute5 attribute6 attribute7 attribute8 attribute9 attribute10 attribute11 attribute12 attribute13 attribute14 attribute15 attribute16 attribute17 attribute18 attribute19 attribute20 global_attribute_category global_attribute1 global_attribute2 global_attribute3 global_attribute4 global_attribute5 global_attribute6 global_attribute7 global_attribute8 global_attribute9 global_attribute10 global_attribute11 global_attribute12 global_attribute13 global_attribute14 global_attribute15 global_attribute16 global_attribute17 global_attribute18 global_attribute19 global_attribute20

31

Page 32: apicus[1]

orig_system_reference orig_system status customer_category_code language key_account_flag tp_header_id ece_tp_location_code primary_specialist_id secondary_specialist_id territory_id territory translated_customer_name created_by_module application_id

32

Page 33: apicus[1]

Customer Account Role API

The following table lists information about the fields you can use on the Create Customer Account Role API.

Cust Account Role Record Fields cust_account_role_id party_id cust_account_id cust_acct_site_id primary_flag role_type source_code attribute_category attribute1 attribute2 attribute3 attribute4 attribute5 attribute6 attribute7 attribute8 attribute9 attribute10 attribute11 attribute12 attribute13 attribute14 attribute15 attribute16 attribute17 attribute18 attribute19 attribute20 attribute21 attribute22 attribute23 attribute24 orig_system_reference orig_system attribute25 status created_by_module application_id

33

Page 34: apicus[1]

Org Contact API

The following table lists information about the fields you can use on the Create Org Contact API.

Org Contact Record Fields org_contact_id comments contact_number department_code department title job_title decision_maker_flag job_title_code reference_use_flag rank party_site_id orig_system_reference orig_system attribute_category attribute1 attribute2 attribute3 attribute4 attribute5 attribute6 attribute7 attribute8 attribute9 attribute10 attribute11 attribute12 attribute13 attribute14 attribute15 attribute16 attribute17 attribute18 attribute19 attribute20 attribute21 attribute22 attribute23 attribute24 created_by_module application_id party_rel_rec_type

34

Page 35: apicus[1]

Source System Reference API

The following table lists information about the fields you can use on the Create Source System Reference API.

Orig Sys Reference Record Fields orig_system_ref_id orig_system orig_system_reference owner_table_name owner_table_id status start_date_active end_date_active reason_code old_orig_system_refernce created_by_module application_id attribute_category attribute1 attribute2 attribute3 attribute4 attribute5 attribute6 attribute7 attribute8 attribute9 attribute10 attribute11 attribute12 attribute13 attribute14 attribute15 attribute16 attribute17 attribute18 attribute19 attribute20

35

Page 36: apicus[1]

Party Site API

The following table lists information about the fields you can use on the Create party Site API.

Party Site Record Fields party_site_id party_id location_id party_site_number orig_system_reference orig_system mailstop identifying_address_flag status party_site_name attribute_category attribute1 attribute2 attribute3 attribute4 attribute5 attribute6 attribute7 attribute8 attribute9 attribute10 attribute11 attribute12 attribute13 attribute14 attribute15 attribute16 attribute17 attribute18 attribute19 attribute20 language addressee created_by_module application_id

36

Page 37: apicus[1]

Customer Account RelationshipAPI

The following table lists information about the fields you can use on the Create Customer Account Relationship API.

Cust Acct Relate Record Fields cust_account_id related_cust_account_id relationship_type comments attribute_category attribute1 attribute2 attribute3 attribute4

attribute6 attribute7 attribute8 attribute9 attribute10 customer_reciprocal_flag status attribute11 attribute12 attribute13 attribute14 attribute15 bill_to_flag ship_to_flag created_by_module application_id

attribute5

37

Page 38: apicus[1]

Employment History API

The following table lists information about the fields you can use on the Create Employment History API.

Employment History Record Fields employment_history_id party_id begin_date end_date employment_type_code employed_as_title_code employed_as_title employed_by_name_company employed_by_party_id employed_by_division_name supervisor_name branch military_rank served station responsibility weekly_work_hours reason_for_leaving faculty_position_ind tenure_code fraction_of_tenure comments status created_by_module

38

Page 39: apicus[1]

Financial Report API

The following table lists information about the fields you can use on the Create Financial Report API.

Financial Report Record Fields financial_report_id party_id type_of_financial_report document_reference date_report_issued issued_period report_start_date report_end_date actual_content_source requiring_authority audit_ind consolidated_ind estimated_ind fiscal_ind forecast_ind opening_ind proforma_ind qualified_ind restated_ind signed_by_principals_ind trial_balance_ind unbalanced_ind status created_by_module

39

Page 40: apicus[1]

Contact Preference API

The following table lists information about the fields you can use on the Create Contact Preference API.

Contact Preference Record Fields contact_preference_id contact_level_table contact_level_table_id contact_type preference_code preference_topic_type preference_topic_type_id preference_topic_type_code preference_start_date preference_end_date preference_start_time_hr preference_end_time_hr preference_start_time_mi preference_end_time_mi max_no_of_interactions max_no_of_interact_uom_code requested_by reason_code status created_by_module application_id

40

Page 41: apicus[1]

Relationship Type API

The following table lists information about the fields you can use on the Create Relationship Type API.

Relationship Type Record Fields relationship_type_id relationship_type forward_rel_code backward_rel_code direction_code hierarchical_flag create_party_flag allow_relate_to_self_flag allow_circular_relationships subject_type object_type status created_by_module application_id multiple_parent_allowed incl_unrelated_entities forward_role backward_role

41

Page 42: apicus[1]

Education API

The following table lists information about the fields you can use on the Create Education API.

Education Record Fields education_id party_id course_major degree_received start_date_attended last_date_attended school_attended_name school_party_id school_party_id type_of_school status created_by_module

Org Contact Role API

The following table lists information about the fields you can use on the Create Org Contact Role API.

Org Contact Role Record Fields org_contact_role_id role_type primary_flag org_contact_id orig_system_reference orig_system role_level primary_contact_per_role_type status created_by_module application_id

Person Language API

The following table lists information about the fields you can use on the Create Person Language API.

Person Language Record Fields language_use_reference_id language_name party_id native_language primary_language_indicator

42

Page 43: apicus[1]

reads_level speaks_level writes_level spoken_comprehension_level status created_by_module application_id

Code Assignment API

The following table lists information about the fields you can use on the Create Code Assignment API.

Code Assignment Record Fields code_assignment_id owner_table_name owner_table_id owner_table_key_1 owner_table_key_2 owner_table_key_3 owner_table_key_4 owner_table_key_5 class_category class_code primary_flag content_source_type CONTENT_SOURCE_TYPE, start_date_active end_date_active status created_by_module application_id rank

43

Page 44: apicus[1]

Role Responsibility API

The following table lists information about the fields you can use on the Create Role Responsibility API.

Role Responsibility Record Fields responsibility_id cust_account_role_id responsibility_type primary_flag attribute_category attribute1 attribute2 attribute3 attribute4 attribute5 attribute6 attribute7 attribute8 attribute9 attribute10 attribute11 attribute12 attribute13 attribute14 attribute15 orig_system_reference created_by_module application_id

44

Page 45: apicus[1]

Person Interest PI

The following table lists information about the fields you can use on the Create Person Interest API.

Person Interest Record Fields person_interest_id level_of_interest party_id level_of_participation interest_type_code comments sport_indicator sub_interest_type_code interest_name team since status created_by_module

Citizenship API

The following table lists information about the fields you can use on the Create Citizenship API.

Citizenship Record Fields citizenship_id party_id birth_or_selected country_code date_recognized date_disowned end_date document_type document_reference status created_by_module

45

Page 46: apicus[1]

Financial Number API

The following table lists information about the fields you can use on the Create Financial Number API.

Financial Number Record Fields financial_number_id financial_report_id financial_number financial_number_name financial_units_applied financial_number_currency projected_actual_flag status created_by_module

Work Class API

The following table lists information about the fields you can use on the Work Class API.

Work Class Record Fields work_class_id level_of_experience work_class_name employment_history_id status created_by_module

Class Code Relation API

The following table lists information about the fields you can use on Create Class Code Relation API.

Class Code Relation Record Fields class_category class_code sub_class_code start_date_active end_date_active created_by_module application_id

46

Page 47: apicus[1]

Class Category API

The following table lists information about the fields you can use on the Create Class Category API.

Class Category Record Fields class_category allow_multi_parent_flag allow_multi_assign_flag allow_leaf_node_only_flag created_by_module application_id delimiter

Party Site UseAPI

The following table lists information about the fields you can use on the Create Party Site Use API.

Party Site Use Record Fields party_site_use_id comments site_use_type party_site_id primary_per_type status created_by_module application_id

47

Page 48: apicus[1]

Class Category API

The following table lists information about the fields you can use on the Create Class Category Use API.

Class Category Use Record Fields class_category Owner_table column_name additional_where_clause created_by_module application_id

Group API

The following table lists information about the fields you can use on the Create Group API.

Group Record Fields group_name group_type created_by_module application_id party_rec

48

Page 49: apicus[1]

Contact Point API

The following table lists information about the fields you can use on the Create Contact Point API.

Contact Point Record Fields contact_point_id contact_point_type status owner_table_name owner_table_id primary_flag orig_system_reference orig_system content_source_type attribute_category attribute1 attribute2 attribute3 attribute4 attribute5 attribute6 attribute7 attribute8 attribute9 attribute10 attribute11 attribute12 attribute13 attribute14 attribute15 attribute16 attribute17 attribute18 attribute19 attribute20 contact_point_purpose primary_by_purpose created_by_module application_id actual_content_source

49

Page 50: apicus[1]

EDI Record for Contact Point API

The following table lists information about the fields you can use on the Contact Point API for EDI record.

EDI Record Fields edi_transaction_handlin edi_id_number edi_payment_method edi_payment_format edi_remittance_method edi_remittance_instruction edi_tp_header_id edi_ece_tp_location_code

Phone Record for Contact Point API

The following table lists information about the fields you can use on the Contact Point API for Phone record.

Phone Record Fields phone_calling_calendar last_contact_dt_time timezone_id phone_area_code phone_country_code phone_number phone_extension phone_line_type raw_phone_number

50

Page 51: apicus[1]

EFT Record for Contact Point API

The following table lists information about the fields you can use on the Contact Point API for EFT Record.

EFT Record Fields eft_transmission_program_id eft_printing_program_id eft_user_number eft_swift_code

Telex Record for Contact Point API

The following table lists information about the fields you can use on the Contact Point API for Telex Record.

Telex Record Fields telex_number

Email Record for Contact Point API

The following table lists information about the fields you can use on the Contact Point API for Email Record.

Email Record Fields email_format email_address

Web Record for Contact Point API

The following table lists information about the fields you can use on the Contact Point API for Web Record.

Web Record Fields web_type url

51

Page 52: apicus[1]

Customer Interface

RA_CUSTOMERS_INTERFACE_ALL Table

The following table lists information about the fields you can use on ra_customers_interface_all table.

RA_CUSTOMERS_INTERFACE_ALL Fields orig_system_customer_ref site_use_code orig_system_address_ref interface_status request_id insert_update_flag validated_flag customer_name customer_number customer_status customer_type orig_system_parent_ref primary_site_use_flag location address1 address2 address3 address4 city state province county postal_code country customer_attribute_category customer_attribute1 customer_attribute2 customer_attribute3 customer_attribute4 customer_attribute5 customer_attribute6 customer_attribute7 customer_attribute8 customer_attribute9 address_attribute_category address_attribute1 address_attribute2 address_attribute3 address_attribute4

52

Page 53: apicus[1]

address_attribute5 address_attribute6 address_attribute7 address_attribute8 address_attribute9 site_use_attribute_category site_use_attribute1 site_use_attribute2 site_use_attribute3 site_use_attribute4 site_use_attribute5 site_use_attribute6 site_use_attribute7 site_use_attribute8 site_use_attribute9 address_key customer_category_code customer_class_code customer_key cust_tax_code cust_tax_exempt_num cust_tax_reference demand_class_code location_ccid cust_ship_via_code site_use_tax_code site_use_tax_exempt_num site_use_tax_reference warning_text customer_attribute10 customer_attribute11 customer_attribute12 customer_attribute13 customer_attribute14 customer_attribute15 address_attribute10 address_attribute11 address_attribute12 address_attribute13 address_attribute14 address_attribute15 site_use_attribute10 site_use_attribute11 site_use_attribute12 site_use_attribute13 site_use_attribute14 site_use_attribute15 site_use_attribute16 site_use_attribute17 site_use_attribute18 site_use_attribute19 site_use_attribute20 site_use_attribute21 site_use_attribute22

53

Page 54: apicus[1]

site_use_attribute23 site_use_attribute24 site_use_attribute25 site_ship_via_code last_updated_by last_update_date created_by creation_date last_update_login message_text bill_to_orig_address_ref jgzz_fiscal_code language global_attribute_category global_attribute1 global_attribute2 global_attribute3 global_attribute4 global_attribute5 global_attribute6 global_attribute7 global_attribute8 global_attribute9 global_attribute10 global_attribute11 global_attribute12 global_attribute13 global_attribute14 global_attribute15 global_attribute16 global_attribute17 global_attribute18 global_attribute19 global_attribute20 url org_id customer_prospect_code customer_name_phonetic address_lines_phonetic translated_customer_name territory gl_id_rec gl_id_rev gl_id_tax gl_id_freight gl_id_clearing gl_id_unbilled gl_id_unearned person_flag person_first_name person_last_name gdf_address_attr_cat gdf_address_attribute1 gdf_address_attribute2

54

Page 55: apicus[1]

gdf_address_attribute3 gdf_address_attribute4 gdf_address_attribute5 gdf_address_attribute6 gdf_address_attribute7 gdf_address_attribute8 gdf_address_attribute9 gdf_address_attribute10 gdf_address_attribute11 gdf_address_attribute12 gdf_address_attribute13 gdf_address_attribute14 gdf_address_attribute15 gdf_address_attribute16 gdf_address_attribute17 gdf_address_attribute18 gdf_address_attribute19 gdf_address_attribute20 gdf_site_use_attr_cat gdf_site_use_attribute1 gdf_site_use_attribute2 gdf_site_use_attribute3 gdf_site_use_attribute4 gdf_site_use_attribute5 gdf_site_use_attribute6 gdf_site_use_attribute7 gdf_site_use_attribute8 gdf_site_use_attribute9 gdf_site_use_attribute10 gdf_site_use_attribute11 gdf_site_use_attribute12 gdf_site_use_attribute13 gdf_site_use_attribute14 gdf_site_use_attribute15 gdf_site_use_attribute16 gdf_site_use_attribute17 gdf_site_use_attribute18 gdf_site_use_attribute19 gdf_site_use_attribute20 gl_id_unpaid_rec gl_id_remittance gl_id_factor orig_system_party_ref party_number party_site_number address_category_code address_attribute16 address_attribute17 address_attribute18 address_attribute19 address_attribute20

55

Page 56: apicus[1]

RA_CUSTOMER_PROFILES_INT_ALL Table

The following table lists information about the fields you can use on ra_customer_profiles_int_all table.

RA_CUSTOMER_PROFILES_INT_ALL Fields

interface_status request_id insert_update_flag validated_flag orig_system_customer_ref orig_system_address_ref customer_profile_class_name collector_name credit_balance_statements credit_checking credit_hold discount_terms dunning_letters interest_charges statements tolerance tax_printing_option account_status autocash_hierarchy_name credit_rating discount_grace_days dunning_letter_set_name interest_period_days override_terms payment_grace_days percent_collectable risk_code standard_term_name statement_cycle_name charge_on_finance_charge_flag grouping_rule_name currency_code auto_rec_min_receipt_amount interest_rate max_interest_charge min_dunning_amount min_dunning_invoice_amount min_fc_balance_amount min_fc_invoice_amount min_statement_amount overall_credit_limit trx_credit_limit attribute_category attribute1

56

Page 57: apicus[1]

attribute10 attribute11 attribute12 attribute13 attribute14 attribute15 attribute2 attribute3 attribute4 attribute5 attribute6 attribute7 attribute8 attribute9 amount_attribute_category amount_attribute1 amount_attribute10 amount_attribute11 amount_attribute12 amount_attribute13 amount_attribute14 amount_attribute15 amount_attribute2 amount_attribute3 amount_attribute4 amount_attribute5 amount_attribute6 amount_attribute7 amount_attribute8 amount_attribute9 last_updated_by last_update_login last_update_date creation_date created_by auto_rec_incl_disputed_flag clearing_days global_attribute_category global_attribute1 global_attribute2 global_attribute3 global_attribute4 global_attribute5 global_attribute6 global_attribute7 global_attribute8 global_attribute9 global_attribute10 global_attribute11 global_attribute12 global_attribute13 global_attribute14 global_attribute15 global_attribute16

57

Page 58: apicus[1]

global_attribute17 global_attribute18 global_attribute19 global_attribute20 org_id cons_inv_flag cons_inv_type gdf_cust_prof_attr_cat gdf_cust_prof_attribute1 gdf_cust_prof_attribute2 gdf_cust_prof_attribute3 gdf_cust_prof_attribute4 gdf_cust_prof_attribute5 gdf_cust_prof_attribute6 gdf_cust_prof_attribute7 gdf_cust_prof_attribute8 gdf_cust_prof_attribute9 gdf_cust_prof_attribute10 gdf_cust_prof_attribute11 gdf_cust_prof_attribute12 gdf_cust_prof_attribute13 gdf_cust_prof_attribute14 gdf_cust_prof_attribute15 gdf_cust_prof_attribute16 gdf_cust_prof_attribute17 gdf_cust_prof_attribute18 gdf_cust_prof_attribute19 gdf_cust_prof_attribute20 lockbox_matching_option autocash_hierarchy_name_adr

58

Page 59: apicus[1]

RA_CUSTOMER_BANKS_INT_ALL Table

The following table lists information about the fields you can use on ra_customer_banks_int_all table.

RA_CUSTOMER_BANKS_INT_ALL Fields orig_system_customer_ref orig_system_address_ref request_id interface_status validated_flag bank_account_name primary_flag start_date end_date attribute_category attribute1 attribute2 attribute3 attribute4 attribute5 attribute6 attribute7 attribute8 attribute9 attribute10 attribute11 attribute12 attribute13 attribute14 attribute15 bank_account_num bank_account_currency_code bank_account_inactive_date bank_account_description bank_name bank_branch_name bank_num bank_branch_description bank_branch_address1 bank_branch_address2 bank_branch_address3 bank_branch_city bank_branch_state bank_branch_zip bank_branch_province bank_branch_country bank_branch_area_code bank_branch_phone bank_account_att_category bank_account_attribute1

59

Page 60: apicus[1]

bank_account_attribute10 bank_account_attribute11 bank_account_attribute12 bank_account_attribute13 bank_account_attribute14 bank_account_attribute15 bank_account_attribute2 bank_account_attribute3 bank_account_attribute4 bank_account_attribute5 bank_account_attribute6 bank_account_attribute7 bank_account_attribute8 bank_account_attribute9 bank_branch_att_category bank_branch_attribute1 bank_branch_attribute10 bank_branch_attribute11 bank_branch_attribute12 bank_branch_attribute13 bank_branch_attribute14 bank_branch_attribute15 bank_branch_attribute2 bank_branch_attribute3 bank_branch_attribute4 bank_branch_attribute5 bank_branch_attribute6 bank_branch_attribute7 bank_branch_attribute8 bank_branch_attribute9 last_update_date last_updated_by last_update_login creation_date created_by bank_number bank_branch_address4 bank_branch_county bank_branch_eft_user_number bank_account_check_digits global_attribute_category global_attribute1 global_attribute2 global_attribute3 global_attribute4 global_attribute5 global_attribute6 global_attribute7 global_attribute8 global_attribute9 global_attribute10 global_attribute11 global_attribute12 global_attribute13

60

Page 61: apicus[1]

global_attribute14 global_attribute15 global_attribute16 global_attribute17 global_attribute18 global_attribute19 global_attribute20 org_id

61

Page 62: apicus[1]

RA_CONTACT_PHONES_INT_ALL Table

The following table lists information about the fields you can use on ra_contact_phones_int_all table.

RA_CONTACT_PHONES_INT_ALL Fields orig_system_contact_ref orig_system_telephone_ref orig_system_customer_ref orig_system_address_ref insert_update_flag contact_first_name contact_last_name contact_title contact_job_title telephone telephone_extension telephone_type interface_status request_id telephone_area_code validated_flag contact_attribute1 contact_attribute10 contact_attribute2 contact_attribute3 contact_attribute4 contact_attribute5 contact_attribute6 contact_attribute7 contact_attribute8 contact_attribute9 contact_attribute_category phone_attribute1 phone_attribute10 phone_attribute2 phone_attribute3 phone_attribute4 phone_attribute5 phone_attribute6 phone_attribute7 phone_attribute8 phone_attribute9 phone_attribute_category contact_attribute11 contact_attribute12 contact_attribute13 contact_attribute14 contact_attribute15 phone_attribute11 phone_attribute12

62

Page 63: apicus[1]

phone_attribute13 phone_attribute14 phone_attribute15 last_update_date last_updated_by last_update_login creation_date created_by contact_attribute16 contact_attribute17 contact_attribute18 contact_attribute19 contact_attribute20 contact_attribute21 contact_attribute22 contact_attribute23 contact_attribute24 contact_attribute25 sex_code salutation email_address mail_stop contact_key org_id phone_country_code

63

Page 64: apicus[1]

RA_CUST_PAY_METHOD_INT_ALL Table

The following table lists information about the fields you can use on ra_cust_pay_method_int_all table.

RA_CUST_PAY_METHOD_INT_ALL Fields orig_system_customer_ref payment_method_name primary_flag orig_system_address_ref start_date end_date request_id interface_status validated_flag attribute_category attribute1 attribute2 attribute3 attribute4 attribute5 attribute6 attribute7 attribute8 attribute9 attribute10 attribute11 attribute12 attribute13 attribute14 attribute15 last_update_date last_updated_by created_by creation_date last_update_login org_id

64

Page 65: apicus[1]

65

Copyright © 2004 Oracle Corporation. All rights reserved. Oracle is a registered trademark of Oracle Corporation. Various product and service names referenced herein may be trademarks of Oracle Corporation. All other product and service names mentioned may be trademarks of their respective owners. Disclaimer: This document is provided for information purposes only and the contents hereof are subject to change without notice. Oracle Corporation does not warrant that this document is error-free, nor does it provide any other warranties or conditions, whether expressed orally or implied in law, including implied warranties and conditions of merchantability or fitness for a particular purpose. Oracle Corporation specifically disclaims any liability with respect to this document and no contractual obligations are formed either directly or indirectly by this document. This document may not be reproduced or transmitted in any form or by any means, electronic or mechanical, for any purpose, without the prior written permission of Oracle Corporation.