This chapter covers the following topics:
PL/SQL Package Name: HZ_PERSON_INFO_V2PUB
Java Class Name: HzPersonInfoV2Pub
TYPE person_language_rec_type IS RECORD( language_use_reference_id NUMBER, language_name VARCHAR2(4), party_id NUMBER, native_language VARCHAR2(1), primary_language_indicator VARCHAR2(1), reads_level VARCHAR2(30), speaks_level VARCHAR2(30), writes_level VARCHAR2(30), spoken_comprehension_level VARCHAR2(30), status VARCHAR2(1), created_by_module VARCHAR2(150), application_id NUMBER )
TYPE citizenship_rec_type IS RECORD( citizenship_id NUMBER, party_id NUMBER, birth_or_selected VARCHAR2(30), country_code VARCHAR2(2), date_recognized DATE, date_disowned DATE, end_date DATE, document_type VARCHAR2(30), document_reference VARCHAR2(60), status VARCHAR2(1), created_by_module VARCHAR2(150) );
TYPE education_rec_type IS RECORD( education_id NUMBER, party_id NUMBER, course_major VARCHAR2(60), degree_received VARCHAR2(60), start_date_attended DATE, last_date_attended DATE, school_attended_name VARCHAR2(60), school_party_id NUMBER school_party_id NUMBER, type_of_school VARCHAR2(60), status VARCHAR2(1), created_by_module VARCHAR2(150) );
TYPE employment_history_rec_type IS RECORD( employment_history_id NUMBER, party_id NUMBER, begin_date DATE, end_date DATE, employment_type_code VARCHAR2(30), employed_as_title_code VARCHAR2(30), employed_as_title VARCHAR2(60), employed_by_name_company VARCHAR2(60), employed_by_party_id NUMBER, employed_by_division_name VARCHAR2(60), supervisor_name VARCHAR2(60), branch VARCHAR2(80), military_rank VARCHAR2(240), served VARCHAR2(240), station VARCHAR2(240), responsibility VARCHAR2(240), weekly_work_hours NUMBER, reason_for_leaving VARCHAR2(240), faculty_position_ind VARCHAR2(30), tenure_code VARCHAR2(30), fraction_of_tenure NUMBER, comments VARCHAR2(2000), status VARCHAR2(1), created_by_module VARCHAR2(150), );
TYPE work_class_rec_type IS RECORD( work_class_id NUMBER, level_of_experience VARCHAR2(60), work_class_name VARCHAR2(240), employment_history_id NUMBER, status VARCHAR2(1), created_by_module VARCHAR2(150) );
TYPE person_interest_rec_type IS RECORD( person_interest_id NUMBER, level_of_interest VARCHAR2(30), party_id NUMBER, level_of_participation VARCHAR2(30), interest_type_code VARCHAR2(30), comments VARCHAR2(240), sport_indicator VARCHAR2(1), sub_interest_type_code VARCHAR2(30), interest_name VARCHAR2(240), team VARCHAR2(240), since DATE, status VARCHAR2(1), created_by_module VARCHAR2(150) );
public static class PersonLanguageRec { public BigDecimal language_use_reference_id; public String language_name; public BigDecimal party_id; public String native_language; public String primary_language_indicator; public String reads_level; public String speaks_level; public String writes_level; public String status; public String created_by_module; public BigDecimal application_id; publicPersonLanguageRec(); public PersonLanguageRec(boolean_RosettaUseGMISSValues); }
This routine is used to create Language for a party. The API creates a record in the HZ_PERSON_LANGUAGE table. The party must be created before you can create its language. You can create multiple language records for a party with different language names. The API allows to mark only one language record as primary language and only one language record as native language for a given party.
PROCEDURE create_person_language( p_init_msg_list IN VARCHAR2:= FND_API.G_FALSE, p_person_language_rec IN PERSON_LANGUAGE_REC_TYPE, x_language_use_reference_id OUT NUMBER, x_return_status OUT VARCHAR2, x_msg_count OUT NUMBER, x_msg_data OUT VARCHAR2 )
public static void createPersonLanguage( OracleConnection_connection, String p_init_msg_list, PersonLanguageRec p_person_language_rec, BigDecimal [ ] x_language_use_reference_id, String [ ] x_return_status, BigDecimal [ ] x_msg_count, String [ ] x_msg_data ) throws SQLException;
The following table lists information about the parameters in the Create Person Language API. The table includes the parameter names, the type of each parameter, the data type of each parameter, the necessity of the parameter, and other information about the parameter such as validation, defaults, and other comments.
Parameter Name | Type | Data Type | Required | Validation, Default, Comment |
---|---|---|---|---|
language_use_reference_id | IN | NUMBER | No | Validation: Unique if passed in, else generated from sequence |
language_name | IN | VARCHAR2 | Yes | Validation:
|
party_id | IN | NUMBER | Yes | Validation:
|
native_language | IN | VARCHAR2 | No | |
primary_language_indicator | IN | VARCHAR2 | No | |
reads_level | IN | VARCHAR2 | No | |
speaks_level | IN | VARCHAR2 | No | |
writes_level | IN | VARCHAR2 | No | |
spoken_comprehension_level | Validation: Validated against the HZ_LANGUAGE_PROFICIENCY lookup type. | |||
status | IN | VARCHAR2 | No | Validation: Validated against AR lookup type REGISTRY_STATUS Default: A |
created_by_module | IN | VARCHAR2 | Yes | Validation: Mandatory attribute. Validated against AR lookup type HZ_CREATED_BY_MODULE. |
application_id | IN | NUMBER | No | Comment: Text to indicate application from which creation of record is initiated |
x_language_use_reference_id | OUT | NUMBER | Comment: Return language_use_reference_id of the record created |
There can be only one record for a given party and language.
A party can have only one native language.
A party can have only one primary language, which should be an active language.
This routine is used to update Language for a party. The API updates a record in the HZ_PERSON_LANGUAGE table. You cannot update the language name, but you can change other attributes of the language record.
PROCEDURE update_person_language( p_init_msg_list IN VARCHAR2:= FND_API.G_FALSE, p_person_language_rec IN PERSON_LANGUAGE_REC_TYPE, p_object_version_number IN OUT NUMBER, x_return_status OUT VARCHAR2, x_msg_count OUT NUMBER, x_msg_data OUT VARCHAR2 )
public static void updatePersonLanguage( OracleConnection_connection, String p_init_msg_list, PersonLanguageRec p_person_language_rec, BigDecimal [ ] p_object_version_number, String [ ] x_return_status, BigDecimal [ ] x_msg_count, String [ ] x_msg_data ) throws SQLException;
The following table lists information about the parameters in the Update Person Language API. The table includes the parameter names, the type of each parameter, the data type of each parameter, the necessity of the parameter, and other information about the parameter such as validation, defaults, and other comments.
Parameter Name | Type | Data Type | Required | Validation, Default, Comment |
---|---|---|---|---|
language_use_reference_id | IN | NUMBER | Yes | Validation: Valid language_use_reference_id should be passed in Comment: Pass the language_use_reference_id from hz_person_language table |
language_name | IN | VARCHAR2 | No | Validation: Not updateable |
party_id | IN | NUMBER | No | Validation: Not updateable |
native_language | IN | VARCHAR2 | No | Validation: Validated against AR lookup type YES/NO |
primary_language_indicator | IN | VARCHAR2 | No | Validation: Validated against AR lookup type YES/NO |
reads_level | IN | VARCHAR2 | No | |
speaks_level | IN | VARCHAR2 | No | |
writes_level | IN | VARCHAR2 | No | |
status | IN | VARCHAR2 | No | Validation:
|
created_by_module | IN | VARCHAR2 | No | Validation: Non updateable if value exists, else validated against AR lookup type HZ_CREATED_BY_MODULE. |
application_id | IN | NUMBER | No | Validation: Non updateable if value exists. |
p_object_version_number | IN OUT |
NUMBER | Yes | Validation:
Comment:
|
There can be only one record for a given party and language.
A party can have only one native language.
A party can have only one primary language, which should be an active language.
PROCEDURE create_citizenship( p_init_msg_list IN VARCHAR2 := FND_API.G_FALSE, p_citizenship_rec IN CITIZENSHIP_REC_TYPE, x_citizenship_id OUT NOCOPY NUMBER, x_return_status OUT NOCOPY VARCHAR2, x_msg_count OUT NOCOPY NUMBER, x_msg_data OUT NOCOPY VARCHAR2 );
The following table lists information about the parameters in the Create Citizenship API. The table includes the parameter names, the type of each parameter, the data type of each parameter, the necessity of the parameter, and other information about the parameter such as validation, defaults, and other comments.
Parameter Name | Type | Data Type | Required | Validation, Default, Comments |
---|---|---|---|---|
citizenship_id | IN | NUMBER | No | Validation: Unique if passed in, else generated from sequence. Not updateable. |
party_id | IN | NUMBER | Yes | Validation: Must exist in HZ_PARTIES. Party_id must represent a Person party. |
birth_or_selected_ind | IN | VARCHAR2 | No | Validation: Validated against the HZ_CITIZENSHIP_ACQUISITION lookup type. |
country_code | IN | VARCHAR2 | Yes | Validation: Must exist in FND_TERRITORIES |
date_recognized | IN | DATE | No | |
date_disowned | IN | DATE | No | |
end_date | IN | DATE | No | |
document_type | IN | VARCHAR2 | No | |
document_reference | IN | VARCHAR2 | No | |
status | IN | VARCHAR2 | No | Validation: validated against AR lookup type REGISTRY_STATUS. |
created_by_module | IN | VARCHAR2 | Yes | Validation: Mandatory attribute. Validated against AR lookup type HZ_CREATED_BY_MODULE. |
PROCEDURE update_citizenship( p_init_msg_list IN VARCHAR2 := FND_API.G_FALSE, p_citizenship_rec IN CITIZENSHIP_REC_TYPE, p_object_version_number IN OUT NOCOPY NUMBER, x_return_status OUT NOCOPY VARCHAR2, x_msg_count OUT NOCOPY NUMBER, x_msg_data OUT NOCOPY VARCHAR2 );
The following table lists information about the parameters in the Update Citizenship API. The table includes the parameter names, the type of each parameter, the data type of each parameter, the necessity of the parameter, and other information about the parameter such as validation, defaults, and other comments.
Parameter Name | Type | Data Type | Required | Validation, Default, Comments |
---|---|---|---|---|
citizenship_id | IN | NUMBER | Yes | Validation: Unique if passed in, else generated from sequence.Not updateable. |
party_id | IN | NUMBER | Yes | Validation: Must exist in HZ_PARTIES. Party_id must represent a Person party. |
p_object_version_number | IN OUT | NUMBER | Yes | |
birth_or_selected_ind | IN | VARCHAR2 | No | Validation: validated against AR lookup type HZ_CITIZENSHIP_ACQUISITION |
country_code | IN | VARCHAR2 | Yes | Validation: Must exist in FND_TERRITORIES |
date_recognized | IN | DATE | No | |
date_disowned | IN | DATE | No | |
end_date | IN | DATE | No | |
document_type | IN | VARCHAR2 | No | |
document_reference | IN | VARCHAR2 | No | |
status | IN | VARCHAR2 | No | Validation: validated against AR lookup type REGISTRY_STATUS. |
created_by_module | IN | VARCHAR2 | Yes | Validation: Non updateable if value exists, else validated against AR lookup type HZ_CREATED_BY_MODULE. |
PROCEDURE create_education( p_init_msg_list IN VARCHAR2 := FND_API.G_FALSE, p_education_rec IN EDUCATION_REC_TYPE, x_education_id OUT NOCOPY NUMBER, x_return_status OUT NOCOPY VARCHAR2, x_msg_count OUT NOCOPY NUMBER, x_msg_data OUT NOCOPY VARCHAR2 );
The following table lists information about the parameters in the Create Education API. The table includes the parameter names, the type of each parameter, the data type of each parameter, the necessity of the parameter, and other information about the parameter such as validation, defaults, and other comments.
Parameter Name | Type | Data Type | Required | Validation, Default, Comments |
---|---|---|---|---|
education_id | IN | NUMBER | No | Validation: Unique if passed in, else generated from sequence.Not updateable. |
party_id | IN | NUMBER | Yes | Validation: Must exist in HZ_PARTIES. Party_id must represent a Person party. |
course_major | IN | VARCHAR2 | No | |
degree_received | IN | VARCHAR2 | No | |
start_date_attended | IN | DATE | No | |
last_date_attended | IN | DATE | No | Validation: If both start_date_attended and last_date_attended are passed, then last_date_attended must be greater than or equal to start_date_attended. |
school_attended_name | IN | VARCHAR2 | No | Validation: If school_party_id is passed, then school_attended_name should not be passed. Comments: This field captures the school name in situations where there is no Party that represents the school. If the school_party_id is known, then that party name will be denormalized in the school_attended_name field. |
school_party_id | IN | VARCHAR2 | No | Validation: Must exist in the HZ_PARTIES table. |
type_of_school | IN | VARCHAR2 | No | Validation: If the value is modified, then the value is validated against the HZ_TYPE_OF_SCHOOL lookup type. |
Status | IN | VARCHAR2 | No | Validation: Validated against the REGISTRY_STATUS lookup type. |
created_by_module | IN | VARCHAR2 | Yes | Validation: Mandatory attribute. Validated against AR lookup type HZ_CREATED_BY_MODULE. |
PROCEDURE update_education( p_init_msg_list IN VARCHAR2 := FND_API.G_FALSE, p_education_rec IN EDUCATION_REC_TYPE, p_object_version_number IN OUT NOCOPY NUMBER, x_return_status OUT NOCOPY VARCHAR2, x_msg_count OUT NOCOPY NUMBER, x_msg_data OUT NOCOPY VARCHAR2 );
The following table lists information about the parameters in the Update Education API. The table includes the parameter names, the type of each parameter, the data type of each parameter, the necessity of the parameter, and other information about the parameter such as validation, defaults, and other comments.
Parameter Name | Type | Data Type | Required | Validation, Default, Comments |
---|---|---|---|---|
education_id | IN | NUMBER | Yes | Validation: Unique if passed in, else generated from sequence. Not updateable. |
party_id | IN | NUMBER | No | Validation: If passed it must exist in HZ_PARTIES and represent a Person party. |
course_major | IN | VARCHAR2 | No | |
degree_received | IN | VARCHAR2 | No | |
start_date_attended | IN | DATE | No | |
last_date_attended | IN | DATE | No | Validation: If both start_date_attended and last_date_attended are passed, then last_date_attended must be greater than or equal to start_date_attended. |
school_attended_name | IN | VARCHAR2 | No | Validation: If school_party_id is passed, then school_attended_name should not be passed. Comments: This field captures the school name in situations where there is no Party that represents the school. If the school_party_id is known, then that party name will be denormalized in the school_attended_name field. |
school_party_id | IN | VARCHAR2 | No | Validation: Must exist in the HZ_PARTIES table. |
type_of_school | IN | VARCHAR2 | No | |
status | IN | VARCHAR2 | No | Validation: validated against AR lookup type REGISTRY_STATUS. |
created_by_module | IN | VARCHAR2 | Yes | Validation: Non updateable if value exists, else validated against AR lookup type HZ_CREATED_BY_MODULE. |
PROCEDURE create_employment_history( p_init_msg_list IN VARCHAR2 := FND_API.G_FALSE, p_employment_history_rec IN EMPLOYMENT_HISTORY_REC_TYPE, x_employment_history_id OUT NOCOPY NUMBER, x_return_status OUT NOCOPY VARCHAR2, x_msg_count OUT NOCOPY NUMBER, x_msg_data OUT NOCOPY VARCHAR2 );
The following table lists information about the parameters in the Create Employment History API. The table includes the parameter names, the type of each parameter, the data type of each parameter, the necessity of the parameter, and other information about the parameter such as validation, defaults, and other comments.
Parameter Name | Type | Data Type | Required | Validation, Default, Comments |
---|---|---|---|---|
employment_history_id | IN | NUMBER | No | Validation: Unique if passed in, else generated from sequence.Not updateable. |
party_id | IN | NUMBER | Yes | Validation: Must exist in HZ_PARTIES. Party_id must represent a Person party. |
begin_date | IN | DATE | No | |
end_date | IN | DATE | No | Validation: If both begin_date and end_date are passed, then end_date must be greater than or equal to begin_date |
employment_type_code | IN | VARCHAR2 | No | Validation: Validated against the HZ_EMPLOYMENT_TYPE lookup type |
employed_as_title_code | IN | VARCHAR2 | No | Validation: Validated against the RESPONSIBILITY lookup type . |
employed_as_title | IN | VARCHAR2 | No | Validation: if employed_as_title_code is supplied, then employed_as_title must be null. |
employed_by_name_company | IN | VARCHAR2 | No | Validation: If employed_by_party_id is passed, then employed_by_name_company should not be passed. Comments: This field captures the employer name in situations where there is no Party that represents the employer. If the employed_by_party_id is known, then that party name will be denormalized in the employed_by_name_company field. |
employed_by_party_id | IN | NUMBER | No | Validation: Must exist in the HZ_PARTIES table. |
employed_by_division_name | IN | VARCHAR2 | No | |
supervisor_name | IN | VARCHAR2 | No | |
Branch | IN | VARCHAR2 | No | |
military_rank | IN | VARCHAR2 | No | |
Served | IN | VARCHAR2 | No | |
Station | IN | VARCHAR2 | No | |
weekly_work_hours | IN | NUMBER | No | Validation: If passed, then must be greater than zero and less than or equal to 168. |
reason_for_leaving | IN | VARCHAR2 | No | |
faculty_position_ind | IN | VARCHAR2 | Yes | Default: N Validation: validated against AR lookup type YES/NO. |
tenure_code | IN | VARCHAR2 | No | Validation: Must only be passed if FACULTY_POSITION_IND = 'Y', must be null otherwise. Validated against AR lookup type HZ_TENURE_CODE |
fraction_of_tenure | IN | NUMBER | No | Validation: Must only be passed if FACULTY_POSITION_IND = 'Y', must be null otherwise. If passed, must be between 0 and 100 inclusive. |
comments | IN | VARCHAR2 | No | |
status | IN | VARCHAR2 | No | Validation: validated against AR lookup type REGISTRY_STATUS. |
created_by_module | IN | VARCHAR2 | Yes | Validation: Mandatory attribute. Validated against AR lookup type HZ_CREATED_BY_MODULE. |
PROCEDURE update_employment_history( p_init_msg_list IN VARCHAR2 := FND_API.G_FALSE, p_employment_history_rec IN EMPLOYMENT_HISTORY_REC_TYPE, p_object_version_number IN OUT NOCOPY NUMBER, x_return_status OUT NOCOPY VARCHAR2, x_msg_count OUT NOCOPY NUMBER, x_msg_data OUT NOCOPY VARCHAR2 );
The following table lists information about the parameters in the Update Employment History API. The table includes the parameter names, the type of each parameter, the data type of each parameter, the necessity of the parameter, and other information about the parameter such as validation, defaults, and other comments.
Parameter Name | Type | Data Type | Required | Validation, Default, Comments |
---|---|---|---|---|
employment_history_id | IN | NUMBER | Yes | Validation: From hz_employment_history. Not updateable. |
party_id | IN | NUMBER | Yes | Validation: Must exist in HZ_PARTIES. Party_id must represent a Person party. |
begin_date | IN | DATE | No | |
end_date | IN | DATE | No | Validation: If both begin_date and end_date are passed, then end_date must be greater than or equal to begin_date |
employment_type_code | IN | VARCHAR2 | No | Validation: validated against AR lookup type HZ_EMPLOYMENT_TYPE |
employed_as_title_code | IN | VARCHAR2 | No | Validation: validated against AR lookup type RESPONSIBILITY. |
employed_as_title | IN | VARCHAR2 | No | Validation: if employed_as_title_code is supplied, then employed_as_title must be null. |
employed_by_name_company | IN | VARCHAR2 | No | Validation: If employed_by_party_id is passed, then employed_by_name_company should not be passed. Comments: This field captures the employer name in situations where there is no Party that represents the employer. If the employed_by_party_id is known, then that party name will be denormalized in the employed_by_name_company field. |
employed_by_party_id | IN | NUMBER | No | Validation: Must exist in HZ_PARTIES. |
employed_by_division_name | IN | VARCHAR2 | No | |
supervisor_name | IN | VARCHAR2 | No | |
Branch | IN | VARCHAR2 | No | |
military_rank | IN | VARCHAR2 | No | |
Served | IN | VARCHAR2 | No | |
Station | IN | VARCHAR2 | No | |
weekly_work_hours | IN | NUMBER | No | Validation: If passed, then must be greater than zero and less than or equal to 168. |
reason_for_leaving | IN | VARCHAR2 | No | |
faculty_position_ind | IN | VARCHAR2 | Yes | Default: N\ Validation: validated against AR lookup type YES/NO. |
tenure_code | IN | VARCHAR2 | No | Validation: Must only be passed if FACULTY_POSITION_IND = Y, must be null otherwise. Validated against AR lookup type HZ_TENURE_CODE |
fraction_of_tenure | IN | NUMBER | No | Validation: Must only be passed if FACULTY_POSITION_IND = Y, must be null otherwise. If passed, must be between 0 and 100 inclusive. |
Comments | IN | VARCHAR2 | No | |
Status | IN | VARCHAR2 | No | Validation: validated against AR lookup type REGISTRY_STATUS. |
created_by_module | IN | VARCHAR2 | Yes | Validation: Non updateable if value exists, else validated against AR lookup type HZ_CREATED_BY_MODULE. |
PROCEDURE create_work_class( p_init_msg_list IN VARCHAR2 := FND_API.G_FALSE, p_work_class_rec IN WORK_CLASS_REC_TYPE, x_work_class_id OUT NOCOPY NUMBER, x_return_status OUT NOCOPY VARCHAR2, x_msg_count OUT NOCOPY NUMBER, x_msg_data OUT NOCOPY VARCHAR2 );
The following table lists information about the parameters in the Create Work Classes API. The table includes the parameter names, the type of each parameter, the data type of each parameter, the necessity of the parameter, and other information about the parameter such as validation, defaults, and other comments.
Parameter Name | Type | Data Type | Required | Validation, Default, Comments |
---|---|---|---|---|
work_class_id | IN | NUMBER | Yes | Validation: Unique if passed in, else generated from sequence. Not updateable. |
level_of_experience | IN | VARCHAR2 | No | |
work_class_name | IN | VARCHAR2 | Yes | |
employment_history_id | IN | NUMBER | Yes | Validation: Must exist in the HZ_EMPLOYMENT_HISTORY table. Not updateable. |
reason_for_leaving | IN | VARCHAR2 | No | |
status | IN | VARCHAR2 | No | Validation: validated against AR lookup type REGISTRY_STATUS. |
created_by_module | IN | VARCHAR2 | Yes | Validation: Mandatory attribute. Validated against AR lookup type HZ_CREATED_BY_MODULE. |
PROCEDURE update_work_class( p_init_msg_list IN VARCHAR2 := FND_API.G_FALSE, p_work_class_rec IN WORK_CLASS_REC_TYPE, p_object_version_number IN OUT NOCOPY NUMBER, x_return_status OUT NOCOPY VARCHAR2, x_msg_count OUT NOCOPY NUMBER, x_msg_data OUT NOCOPY VARCHAR2 );
The following table lists information about the parameters in the Update Work Classes API. The table includes the parameter names, the type of each parameter, the data type of each parameter, the necessity of the parameter, and other information about the parameter such as validation, defaults, and other comments.
Parameter Name | Type | Data Type | Required | Validation, Default, Comments |
---|---|---|---|---|
work_class_id | IN | NUMBER | Yes | Validation: Unique if passed in, else generated from sequence.Not updateable. |
level_of_experience | IN | VARCHAR2 | No | |
work_class_name | IN | VARCHAR2 | Yes | |
employment_history_id | IN | NUMBER | Yes | Validation: Must exist in HZ_EMPLOYMENT_HISTORY.Not updateable. |
reason_for_leaving | IN | VARCHAR2 | No | |
Status | IN | VARCHAR2 | No | Validation: validated against AR lookup type REGISTRY_STATUS. |
created_by_module | IN | VARCHAR2 | Yes | Validation: Non updateable if value exists, else validated against AR lookup type HZ_CREATED_BY_MODULE. |
PROCEDURE create_person_interest( p_init_msg_list IN VARCHAR2 := FND_API.G_FALSE, p_person_interest_rec IN PERSON_INTEREST_REC_TYPE, x_person_interest_id OUT NOCOPY NUMBER, x_return_status OUT NOCOPY VARCHAR2, x_msg_count OUT NOCOPY NUMBER, x_msg_data OUT NOCOPY VARCHAR2 );
The following table lists information about the parameters in the Create Person Interest API. The table includes the parameter names, the type of each parameter, the data type of each parameter, the necessity of the parameter, and other information about the parameter such as validation, defaults, and other comments.
Parameter Name | Type | Data Type | Required | Validation, Default, Comments |
---|---|---|---|---|
person_interest_id | IN | NUMBER | No | Validation: Unique if passed in, else generated from sequence. Not updateable. |
level_of_interest | IN | VARCHAR2 | No | |
party_id | IN | NUMBER | Yes | Validation: Must exist in HZ_PARTIES. |
level_of_participation | IN | VARCHAR2 | No | |
interest_type_code | IN | VARCHAR2 | No | |
comments | IN | VARCHAR2 | No | |
sport_indicator | IN | VARCHAR2 | No | Validation: validated against AR lookup type YES/NO. |
sub_interest_type_code | IN | VARCHAR2 | No | |
interest_name | IN | VARCHAR2 | Yes | Validation: Mandatory attribute. |
team | IN | VARCHAR2 | No | |
since | IN | DATE | No | |
status | IN | VARCHAR2 | No | Validation: validated against AR lookup type REGISTRY_STATUS. |
created_by_module | IN | VARCHAR2 | Yes | Validation: Mandatory attribute. Validated against AR lookup type HZ_CREATED_BY_MODULE. |
PROCEDURE update_person_interest( p_init_msg_list IN VARCHAR2 := FND_API.G_FALSE, p_person_interest_rec IN PERSON_INTEREST_REC_TYPE, p_object_version_number IN OUT NOCOPY NUMBER, x_return_status OUT NOCOPY VARCHAR2, x_msg_count OUT NOCOPY NUMBER, x_msg_data OUT NOCOPY VARCHAR2 );
The following table lists information about the parameters in the Update Person Interest API. The table includes the parameter names, the type of each parameter, the data type of each parameter, the necessity of the parameter, and other information about the parameter such as validation, defaults, and other comments.
Parameter Name | Type | Data Type | Required | Validation, Default, Comments |
---|---|---|---|---|
person_interest_id | IN | NUMBER | No | Validation: From hz_person_interests. Not updateable. |
level_of_interest | IN | VARCHAR2 | No | |
party_id | IN | NUMBER | Yes | Validation: Not updateable. |
level_of_participation | IN | VARCHAR2 | No | |
interest_type_code | IN | VARCHAR2 | No | |
comments | IN | VARCHAR2 | No | |
sport_indicator | IN | VARCHAR2 | No | Validation: validated against AR lookup type YES/NO. |
sub_interest_type_code | IN | VARCHAR2 | No | |
interest_name | IN | VARCHAR2 | Yes | Validation: Mandatory attribute. |
team | IN | VARCHAR2 | No | |
since | IN | DATE | No | |
status | IN | VARCHAR2 | No | Validation: validated against AR lookup type REGISTRY_STATUS. |
created_by_module | IN | VARCHAR2 | Yes | Validation: Non updateable if value exists, else validated against AR lookup type HZ_CREATED_BY_MODULE. |
created_by_module | IN | VARCHAR2 | Yes | Validation: Mandatory attribute. Validated against AR lookup type HZ_CREATED_BY_MODULE. |
PL/SQL Package Name: HZ_ORGANIZATION_INFO_V2PUB
TYPE financial_report_rec_type IS RECORD( financial_report_id NUMBER, party_id NUMBER, type_of_financial_report VARCHAR2(60), document_reference VARCHAR2(150), date_report_issued DATE, issued_period VARCHAR2(60), report_start_date DATE, report_end_date DATE, actual_content_source VARCHAR2(30), requiring_authority VARCHAR2(60), audit_ind VARCHAR2(30), consolidated_ind VARCHAR2(30), estimated_ind VARCHAR2(30), fiscal_ind VARCHAR2(30), forecast_ind VARCHAR2(30), opening_ind VARCHAR2(30), proforma_ind VARCHAR2(30), qualified_ind VARCHAR2(30), restated_ind VARCHAR2(30), signed_by_principals_ind VARCHAR2(30), trial_balance_ind VARCHAR2(30), unbalanced_ind VARCHAR2(30), status VARCHAR2(30), created_by_module VARCHAR2(150) );
TYPE financial_number_rec_type IS RECORD( financial_number_id NUMBER, financial_report_id NUMBER, financial_number NUMBER, financial_number_name VARCHAR2(60), financial_units_applied NUMBER, financial_number_currency VARCHAR2(240), projected_actual_flag VARCHAR2(1), status VARCHAR2(1), created_by_module VARCHAR2(150) );
PROCEDURE create_financial_report( p_init_msg_list IN VARCHAR2 := FND_API.G_FALSE, p_financial_report_rec IN FINANCIAL_REPORT_REC_TYPE, x_financial_report_id OUT NOCOPY NUMBER, x_return_status OUT NOCOPY VARCHAR2, x_msg_count OUT NOCOPY NUMBER, x_msg_data OUT NOCOPY VARCHAR2 )
The following table lists information about the parameters in the Create Financial Report API. The table includes the parameter names, the type of each parameter, the data type of each parameter, the necessity of the parameter, and other information about the parameter such as validation, defaults, and other comments.
Parameter Name | Type | Data Type | Required | Validation, Default, Comments |
---|---|---|---|---|
financial_report_id | IN | NUMBER | No | Validation: Unique if passed in, else generated from sequence. Not updateable. |
party_id | IN | NUMBER | Yes | Validation: Must exist in the HZ_PARTIES table. Party_id must represent an Organization party. |
type_of_financial_report | IN | VARCHAR2 | No | |
document_reference | IN | VARCHAR2 | No | |
issued_period | IN | VARCHAR2 | No | Validation: Either issued_period or report_start_date must be provided, but not both. |
report_start_date | IN | DATE | No | Validation: Either issued_period or report_start_date must be provided, but not both. If report_start_date is provided, then it must be less than or equal to report_end_date. |
report_end_date | IN | DATE | No | Validation: Must be provided if report_start_date is provided, otherwise must be null. If provided, then it must be greater than or equal to report_start_date. |
requiring_authority | IN | VARCHAR2 | No | |
actual_content_source | IN | VARCHAR2 | Yes | Validation: Foreign key to HZ_ORIG_SYSTEMS_B.orig_system with sst_flag value of Y. |
audit_ind | IN | VARCHAR2 | No | Validation: Validated against AR lookup type YES/NO. |
consolidated_ind | IN | VARCHAR2 | No | Validation: Validated against AR lookup type YES/NO. |
estimated_ind | IN | VARCHAR2 | No | Validation: Validated against AR lookup type YES/NO. |
fiscal_ind | IN | VARCHAR2 | No | Validation: Validated against AR lookup type YES/NO. |
forecast_ind | IN | VARCHAR2 | No | Validation: Validated against AR lookup type YES/NO. |
opening_ind | IN | VARCHAR2 | No | Validation: Validated against AR lookup type YES/NO. |
proforma_ind | IN | VARCHAR2 | No | Validation: Validated against AR lookup type YES/NO. |
qualified_ind | IN | VARCHAR2 | No | Validation: Validated against AR lookup type YES/NO. |
restated_ind | IN | VARCHAR2 | No | Validation: Validated against AR lookup type YES/NO. |
signed_by_principals_ind | IN | VARCHAR2 | No | Validation: Validated against AR lookup type YES/NO. |
trial_balance_ind | IN | VARCHAR2 | No | Validation: Validated against AR lookup type YES/NO. |
unbalanced_ind | IN | VARCHAR2 | No | Validation: Validated against AR lookup type YES/NO. |
consolidated_ind | IN | VARCHAR2 | No | Validation: Validated against AR lookup type YES/NO. |
status | IN | VARCHAR2 | No | Validation: Validated against AR lookup type REGISTRY_STATUS. |
created_by_module | IN | VARCHAR2 | Yes | Validation: Mandatory attribute. Validated against AR lookup type HZ_CREATED_BY_MODULE. |
The following combination of columns must be unique: party_id, financial_report_type, document_reference, date_report_issued, (issued_period or report_start_date and report_end_date) and actual_content_source. Note that issued_period and report_start_date + report_end_date are mutually exclusive.
PROCEDURE update_financial_report( p_init_msg_list IN VARCHAR2 := FND_API.G_FALSE, p_financial_report_rec IN FINANCIAL_REPORT_REC_TYPE, p_object_version_number IN OUT NOCOPY NUMBER, x_return_status OUT NOCOPY VARCHAR2, x_msg_count OUT NOCOPY NUMBER, x_msg_data OUT NOCOPY VARCHAR2 );
The following table lists information about the parameters in the Update Financial Report API. The table includes the parameter names, the type of each parameter, the data type of each parameter, the necessity of the parameter, and other information about the parameter such as validation, defaults, and other comments.
Parameter Name | Type | Data Type | Required | Validation, Default, Comments |
---|---|---|---|---|
financial_report_id | IN | NUMBER | Yes | Validation: Not updateable. |
party_id | IN | NUMBER | Yes | Validation: Must exist in the HZ_PARTIES table. Party_id must represent an Organization party. |
type_of_financial_report | IN | VARCHAR2 | No | |
document_reference | IN | VARCHAR2 | No | Validation: Not updateable. |
issued_period | IN | VARCHAR2 | No | Validation: Either issued_period or report_start_date must be provided (not both). |
report_start_date | IN | DATE | No | Validation: Either issued_period or report_start_date must be provided, but not both. If report_start_date is provided, then it must be less than or equal to report_end_date. |
report_end_date | IN | DATE | No | Validation: Must be provided if report_start_date is provided, otherwise must be null. If provided, then it must be greater than or equal to report_start_date. |
requiring_authority | IN | VARCHAR2 | No | |
actual_content_source | IN | VARCHAR2 | Yes | Validation: Foreign key to HZ_ORIG_SYSTEMS_B.orig_system with sst_flag value of Y. |
audit_ind | IN | VARCHAR2 | No | Validation: Validated against AR lookup type YES/NO. |
consolidated_ind | IN | VARCHAR2 | No | Validation: Validated against AR lookup type YES/NO. |
estimated_ind | IN | VARCHAR2 | No | Validation: Validated against AR lookup type YES/NO. |
fiscal_ind | IN | VARCHAR2 | No | Validation: Validated against AR lookup type YES/NO. |
forecast_ind | IN | VARCHAR2 | No | Validation: Validated against AR lookup type YES/NO. |
opening_ind | IN | VARCHAR2 | No | Validation: Validated against AR lookup type YES/NO. |
proforma_ind | IN | VARCHAR2 | No | Validation: Validated against AR lookup type YES/NO. |
qualified_ind | IN | VARCHAR2 | No | Validation: Validated against AR lookup type YES/NO. |
restated_ind | IN | VARCHAR2 | No | Validation: Validated against AR lookup type YES/NO. |
signed_by_principals_ind | IN | VARCHAR2 | No | Validation: Validated against AR lookup type YES/NO. |
trial_balance_ind | IN | VARCHAR2 | No | Validation: Validated against AR lookup type YES/NO. |
unbalanced_ind | IN | VARCHAR2 | No | Validation: Validated against AR lookup type YES/NO. |
consolidated_ind | IN | VARCHAR2 | No | Validation: Validated against AR lookup type YES/NO. |
status | IN | VARCHAR2 | No | Validation: Validated against AR lookup type REGISTRY_STATUS. |
created_by_module | IN | VARCHAR2 | No | Validation: Non updateable if value exists, else validated against AR lookup type HZ_CREATED_BY_MODULE. |
The following combination of columns must be unique: party_id, financial_report_type, document_reference, date_report_issued, (issued_period or report_start_date and report_end_date) and actual_content_source. Note that issued_period and report_start_date + report_end_date are mutually exclusive.
PROCEDURE create_financial_number( p_init_msg_list IN VARCHAR2 := FND_API.G_FALSE, p_financial_number_rec IN FINANCIAL_NUMBER_REC_TYPE, x_financial_number_id OUT NOCOPY NUMBER, x_return_status OUT NOCOPY VARCHAR2, x_msg_count OUT NOCOPY NUMBER, x_msg_data OUT NOCOPY VARCHAR2 );
The following table lists information about the parameters in the Create Financial Number API. The table includes the parameter names, the type of each parameter, the data type of each parameter, the necessity of the parameter, and other information about the parameter such as validation, defaults, and other comments.
Parameter Name | Type | Data Type | Required | Validation, Default, Comments |
---|---|---|---|---|
financial_number_id | IN | NUMBER | No | Validation: Unique if passed in, else generated from sequence.Not updateable. |
financial_report_id | IN | NUMBER | Yes | Validation: Must exist in HZ_FINANCIAL_REPORTS. Non-updateable. |
financial_number | IN | VARCHAR2 | No | |
financial_number_name | IN | VARCHAR2 | No | Validation: Must be a valid lookup under FIN_NUM_NAME lookup type. |
financial_units_applied | IN | NUMBER | No | |
financial_number_currency | IN | VARCHAR2 | No | |
projected_actual_flag | IN | VARCHAR2 | No | |
status | IN | VARCHAR2 | Yes | Validation: validated against AR lookup type REGISTRY_STATUS |
created_by_module | IN | VARCHAR2 | Yes | Validation: Mandatory attribute. Validated against AR lookup type HZ_CREATED_BY_MODULE. |
The following combination of columns must be unique: financial_report_id and financial_number_name.
PROCEDURE update_financial_number( p_init_msg_list IN VARCHAR2 := FND_API.G_FALSE, p_financial_number_rec IN FINANCIAL_NUMBER_REC_TYPE, p_object_version_number IN OUT NOCOPY NUMBER, x_return_status OUT NOCOPY VARCHAR2, x_msg_count OUT NOCOPY NUMBER, x_msg_data OUT NOCOPY VARCHAR2 );
The following table lists information about the parameters in the Update Financial Number API. The table includes the parameter names, the type of each parameter, the data type of each parameter, the necessity of the parameter, and other information about the parameter such as validation, defaults, and other comments.
Parameter Name | Type | Data Type | Required | Validation, Default, Comments |
---|---|---|---|---|
financial_number_id | IN | NUMBER | Yes | Validation: Not updateable. |
financial_report_id | IN | NUMBER | Yes | Validation: Must exist in the HZ_FINANCIAL_REPORTS table. Non-updateable. |
financial_number | IN | VARCHAR2 | No | |
financial_number_name | IN | VARCHAR2 | No | Validation: Must be a valid lookup under FIN_NUM_NAME lookup type. |
financial_units_applied | IN | NUMBER | No | |
financial_number_currency | IN | VARCHAR2 | No | |
projected_actual_flag | IN | VARCHAR2 | No | |
status | IN | VARCHAR2 | Yes | Validation: validated against AR lookup type REGISTRY_STATUS |
created_by_module | IN | VARCHAR2 | Yes | Validation: Non updateable if value exists, else validated against AR lookup type HZ_CREATED_BY_MODULE. |
The following combination of columns must be unique: financial_report_id and financial_number_name.
PL/SQL Package Name: HZ_LOCATION_V2PUB
Java Class Name: HzLocationV2Pub
PL/SQL Constant:
G_MISS_CONTENT_COURCE_TYPE CONSTANT VARCHAR2(30):=USER_ENTERED; HZ_GEOMETRY_DEFAULT CONSTANT MDSYS.SDO_GEOMETRY := MDSYS.SDO_GEOMETRY(FND_API.G_MISS_NUM, FND_API.G_MISS_NUM, NULL, NULL, NULL)
TYPE location_rec_type IS RECORD( location_id NUMBER, orig_system_reference VARCHAR2(240), orig_system VARCHAR2(30), country VARCHAR2(60), address1 VARCHAR2(240), address2 VARCHAR2(240), address3 VARCHAR2(240), address4 VARCHAR2(240), city VARCHAR2(60), postal_code VARCHAR2(60), state VARCHAR2(60), province VARCHAR2(60), county VARCHAR2(60), address_key VARCHAR2(500), address_style VARCHAR2(30), validated_flag VARCHAR2(1), address_lines_phonetic VARCHAR2(560), po_box_number VARCHAR2(50), house_number VARCHAR2(50), street_suffix VARCHAR2(50), street VARCHAR2(50), street_number VARCHAR2(50), floor VARCHAR2(50), suite VARCHAR2(50), postal_plus4_code VARCHAR2(10), position VARCHAR2(50), delivery_point_code VARCHAR2(50), location_directions VARCHAR2(640), address_effective_date DATE, address_expiration_date DATE, clli_code VARCHAR2(60), language VARCHAR2(4), short_description VARCHAR2(240), description VARCHAR2(2000), geometry MDSYS.SDO_GEOMETRY:= hz_geometry_default, loc_hierarchy_id NUMBER, sales_tax_geocode VARCHAR2(30), sales_tax_inside_city_limits VARCHAR2(30), fa_location_id NUMBER, content_source_type VARCHAR2(30):= G_MISS_CONTENT_SOURCE_TYPE, attribute_category VARCHAR2(30), attribute1 VARCHAR2(150), attribute2 VARCHAR2(150), attribute3 VARCHAR2(150), attribute4 VARCHAR2(150), attribute5 VARCHAR2(150), attribute6 VARCHAR2(150), attribute7 VARCHAR2(150), attribute8 VARCHAR2(150), attribute9 VARCHAR2(150), attribute10 VARCHAR2(150), attribute11 VARCHAR2(150), attribute12 VARCHAR2(150), attribute13 VARCHAR2(150), attribute14 VARCHAR2(150), attribute15 VARCHAR2(150), attribute16 VARCHAR2(150), attribute17 VARCHAR2(150), attribute18 VARCHAR2(150), attribute19 VARCHAR2(150), attribute20 VARCHAR2(150), timezone_id NUMBER, created_by_module VARCHAR2(150), application_id NUMBER )
public static class LocationRec { public BigDecimal location_id; public String orig_system_reference; public String orig_system; public String country; public String address1; public String address2; public String address3; public String address4; public String city; public String postal_code; public String state; public String province; public String county; public String address_key; public String address_style; public String validated_flag; public String address_lines_phonetic; public String po_box_number; public String house_number; public String street_suffix; public String street; public String street_number; public String floor; public String suite; public String postal_plus4_code; public String position; public String delivery_point_code; public String location_directions; public java.sql.Timestamp address_effective_date; public java.sql.Timestamp address_expiration_date; public String clli_code; public String language; public String short_description; public String description; public BigDecimal loc_hierarchy_id; public String sales_tax_geocode; public String sales_tax_inside_city_limits; public BigDecimal fa_location_id; public String content_source_type; public String attribute_category; public String attribute1; public String attribute2; public String attribute3; public String attribute4; public String attribute5; public String attribute6; public String attribute7; public String attribute8; public String attribute9; public String attribute10; public String attribute11; public String attribute12; public String attribute13; public String attribute14; public String attribute15; public String attribute16; public String attribute17; public String attribute18; public String attribute19; public String attribute20; public BigDecimal timezone_id; public String actual_content_source; public String created_by_module; public BigDecimal application_id; public LocationRec(); public LocationRec(boolean __RosettaUseGMISSValues); }
Note: Java Wrapper/API currently does not support the geometry column in HZ_LOCATIONS table.
This routine is used to create an Address Location. The API creates a record in the HZ_LOCATIONS table. The API also creates a record in the HZ_LOCATIONS_PROFILES table. That record stores address-specific information about the location. The location created by this API is just a physical location and can be used to create party site or customer account site. If orig_system is passed in, the API also creates a record in the HZ_ORIG_SYS_REFERENCES table to store the mapping between the source system reference and the TCA primary key. If timezone_id is not passed in, the API generates a time zone value based on the address components and time zone setup. However, if the user passes in the time zone the API keeps the time zone value that the user chose.
PROCEDURE create_location ( p_init_msg_list IN VARCHAR2:= FND_API.G_FALSE, p_location_rec IN LOCATION_REC_TYPE, x_location_id OUT NUMBER, x_return_status OUT VARCHAR2, x_msg_count OUT NUMBER, x_msg_data OUT VARCHAR2 )
public static void createLocation( OracleConnection_connection, String p_init_msg_list, LocationRec p_location_rec, BigDecimal [ ] x_location_id, String [ ] x_return_status, BigDecimal [ ] x_msg_count, String [ ] x_msg_data ) throws SQLException;
The following table lists information about the parameters in the Create Location API. The table includes the parameter names, the type of each parameter, the data type of each parameter, the necessity of the parameter, and other information about the parameter such as validation, defaults, and other comments.
Parameter Name | Type | Data Type | Required | Validation, Default, Comment |
---|---|---|---|---|
location_id | IN | NUMBER | No | Validation: Unique if passed in, else generated from sequence |
orig_system_reference | IN | VARCHAR2 | No | Default: location_id Validation: If orig_system is passed in, then orig_system_reference is required. |
orig_system | IN | VARCHAR2 | No | Validation: Foreign key to HZ_ORIG_SYSTEMS_B.orig_system. |
country | IN | VARCHAR2 | Yes | Validation:
|
address1 | IN | VARCHAR2 | Yes | Validation: Mandatory attribute |
address2 | IN | VARCHAR2 | No | |
address3 | IN | VARCHAR2 | No | |
address4 | IN | VARCHAR2 | No | |
city | IN | VARCHAR2 | No | |
postal_code | IN | VARCHAR2 | No | |
state | IN | VARCHAR2 | No | |
province | IN | VARCHAR2 | No | |
county | IN | VARCHAR2 | No | |
address_key | IN | VARCHAR2 | No | |
address_style | IN | VARCHAR2 | No | |
validated_flag | IN | VARCHAR2 | No | |
address_lines_phonetic | IN | VARCHAR2 | No | |
po_box_number | IN | VARCHAR2 | No | Comment: This parameter is no longer used. |
house_number | IN | VARCHAR2 | No | Comment: This parameter is no longer used. |
street_suffix | IN | VARCHAR2 | No | Comment: This parameter is no longer used. |
street | IN | VARCHAR2 | No | Comment: This parameter is no longer used. |
street_number | IN | VARCHAR2 | No | Comment: This parameter is no longer used. |
floor | IN | VARCHAR2 | No | Comment: This parameter is no longer used. |
suite | IN | VARCHAR2 | No | Comment: This parameter is no longer used. |
postal_plus4_code | IN | VARCHAR2 | No | |
position | IN | VARCHAR2 | No | |
delivery_point_code | IN | VARCHAR2 | No | |
location_directions | IN | VARCHAR2 | No | |
address_effective_date | IN | DATE | No | |
address_expiration_date | IN | DATE | No | |
clli_code | IN | VARCHAR2 | No | |
language | IN | VARCHAR2 | No | Validation: Foreign key to fnd_languages.language_code (installed) |
short_description | IN | VARCHAR2 | No | |
description | IN | VARCHAR2 | No | |
geometry | IN | OBJECT | No | |
loc_hierarchy_id | IN | NUMBER | No | |
sales_tax_geocode | IN | VARCHAR2 | No | |
sales_tax_inside_city_limits | IN | VARCHAR2 | No | |
fa_location_id | IN | NUMBER | No | |
content_source_type | IN | VARCHAR2 | No | Comment: This parameter is no longer used. Use actual_content_source. Validation: Foreign key to HZ_ORIG_SYSTEMS_B.orig_system with sst_flag value of Y. Default: USER_ENTERED |
attribute_category | IN | VARCHAR2 | No | |
attribute1 | IN | VARCHAR2 | No | |
attribute2 | IN | VARCHAR2 | No | |
attribute3 | IN | VARCHAR2 | No | |
attribute4 | IN | VARCHAR2 | No | |
attribute5 | IN | VARCHAR2 | No | |
attribute6 | IN | VARCHAR2 | No | |
attribute7 | IN | VARCHAR2 | No | |
attribute8 | IN | VARCHAR2 | No | |
attribute9 | IN | VARCHAR2 | No | |
attribute10 | IN | VARCHAR2 | No | |
attribute11 | IN | VARCHAR2 | No | |
attribute12 | IN | VARCHAR2 | No | |
attribute13 | IN | VARCHAR2 | No | |
attribute14 | IN | VARCHAR2 | No | |
attribute15 | IN | VARCHAR2 | No | |
attribute16 | IN | VARCHAR2 | No | |
attribute17 | IN | VARCHAR2 | No | |
attribute18 | IN | VARCHAR2 | No | |
attribute19 | IN | VARCHAR2 | No | |
attribute20 | IN | VARCHAR2 | No | |
timezone_id | IN | NUMBER | No | Validation: Foreign key to hz_timezones.timezone_id |
created_by_module | IN | VARCHAR2 | Yes | Validation: Mandatory attribute. Validated against AR lookup type HZ_CREATED_BY_MODULE. |
application_id | IN | NUMBER | No | Comment: Text to indicate application from which creation of record is initiated |
actual_content_source | IN | VARCHAR2 | No | Validation : Foreign key to HZ_ORIG_SYSTEMS_B.orig_system with sst_flag value of Y. Default : 'USER_ENTERED' |
x_location_id | OUT | NUMBER | No | Comment; Return location_id of the record created |
This routine is used to update an Address Location. The API updates a record in the HZ_LOCATIONS table. The API also creates or updates a record in the HZ_LOCATIONS_PROFILES table. Whether to create or update a location profile record depends on the value of the HZ:Maintain Location History and HZ: Allow to Update Standardized Address profile options.
If the primary key is not passed in, get the primary key from the HZ_ORIG_SYS_REFERENCES table based on orig_system and orig_system_reference if they are not null and unique. If timezone_id is not passed in, the API generates a time zone value based on the changes of the address components and time zone setup even if a time zone already exists in the database. However, if the user passes in the time zone the API keeps the time zone value that the user chose.
The loc_assignment records for this location are also updated.
PROCEDURE update_location ( p_init_msg_list IN VARCHAR2:=FND_API.G_FALSE, p_location_rec IN LOCATION_REC_TYPE, p_object_version_number IN OUT NUMBER, x_return_status OUT VARCHAR2, x_msg_count OUT NUMBER, x_msg_data OUT VARCHAR2 )
public static void updateLocation( OracleConnection_connection, String p_init_msg_list, LocationRec p_location_rec, BigDecimal [ ] p_object_version_number, String [ ] x_return_status, BigDecimal [ ] x_msg_count, String [ ] x_msg_data ) throws SQLException;
The following table lists information about the parameters in the Update Location API. The table includes the parameter names, the type of each parameter, the data type of each parameter, the necessity of the parameter, and other information about the parameter such as validation, defaults, and other comments.
Parameter Name | Type | Data Type | Required | Validation, Default, Comment |
---|---|---|---|---|
location_id | IN | NUMBER | Yes | Validation: Valid location_id should be passed in. |
orig_system_reference | IN | VARCHAR2 | No | Validation: Non updateable, but if a primary key is not passed in, you can pass in any ORIG_SYSTEM and ORIG_SYSTEM_REFERENCE that exists in the HZ_ORIG_SYS_REFERENCE table and unique validation is bypassed. The ORIG_SYSTEM_REFERENCE does not change, but persists in the table. |
orig_system | IN | VARCHAR2 | No | Validation: Foreign key to HZ_ORIG_SYSTEMS_B.orig_system. |
country | IN | VARCHAR2 | No | Validation: Foreign key to fnd_territories.territory_code |
address1 | IN | VARCHAR2 | No | Validation: Cannot be set to null during update |
address2 | IN | VARCHAR2 | No | |
address3 | IN | VARCHAR2 | No | |
address4 | IN | VARCHAR2 | No | |
city | IN | VARCHAR2 | No | |
postal_code | IN | VARCHAR2 | No | |
state | IN | VARCHAR2 | No | |
province | IN | VARCHAR2 | No | |
county | IN | VARCHAR2 | No | |
address_key | IN | VARCHAR2 | No | |
address_style | IN | VARCHAR2 | No | |
validated_flag | IN | VARCHAR2 | No | |
address_lines_phonetic | IN | VARCHAR2 | No | |
po_box_number | IN | VARCHAR2 | No | Comment: This parameter is no longer used. |
house_number | IN | VARCHAR2 | No | Comment: This parameter is no longer used. |
street_suffix | IN | VARCHAR2 | No | Comment: This parameter is no longer used. |
street | IN | VARCHAR2 | No | Comment: This parameter is no longer used. |
street_number | IN | VARCHAR2 | No | Comment: This parameter is no longer used. |
floor | IN | VARCHAR2 | No | Comment: This parameter is no longer used. |
suite | IN | VARCHAR2 | No | Comment: This parameter is no longer used. |
postal_plus4_code | IN | VARCHAR2 | No | |
position | IN | VARCHAR2 | No | |
delivery_point_code | IN | VARCHAR2 | No | |
location_directions | IN | VARCHAR2 | No | |
address_effective_date | IN | DATE | No | |
address_expiration_date | IN | DATE | No | |
clli_code | IN | VARCHAR2 | No | |
language | IN | VARCHAR2 | No | Validation: Foreign key to fnd_languages.language_code (installed) |
short_description | IN | VARCHAR2 | No | |
description | IN | VARCHAR2 | No | |
geometry | IN | OBJECT | No | |
loc_hierarchy_id | IN | NUMBER | No | |
sales_tax_geocode | IN | VARCHAR2 | No | |
sales_tax_inside_city_limits | IN | VARCHAR2 | No | |
fa_location_id | IN | NUMBER | No | |
content_source_type | IN | VARCHAR2 | No | Comment: This parameter is no longer used. Use actual_content_source. Validation: Not updateable |
attribute_category | IN | VARCHAR2 | No | |
attribute1 | IN | VARCHAR2 | No | |
attribute2 | IN | VARCHAR2 | No | |
attribute3 | IN | VARCHAR2 | No | |
attribute4 | IN | VARCHAR2 | No | |
attribute5 | IN | VARCHAR2 | No | |
attribute6 | IN | VARCHAR2 | No | |
attribute7 | IN | VARCHAR2 | No | |
attribute8 | IN | VARCHAR2 | No | |
attribute9 | IN | VARCHAR2 | No | |
attribute10 | IN | VARCHAR2 | No | |
attribute11 | IN | VARCHAR2 | No | |
attribute12 | IN | VARCHAR2 | No | |
attribute13 | IN | VARCHAR2 | No | |
attribute14 | IN | VARCHAR2 | No | |
attribute15 | IN | VARCHAR2 | No | |
attribute16 | IN | VARCHAR2 | No | |
attribute17 | IN | VARCHAR2 | No | |
attribute18 | IN | VARCHAR2 | No | |
attribute19 | IN | VARCHAR2 | No | |
attribute20 | IN | VARCHAR2 | No | |
timezone_id | IN | NUMBER | No | Validation: Foreign key to hz_timezones.timezone_id |
created_by_module | IN | VARCHAR2 | No | Validation: Non updateable if value exists, else validated against AR lookup type HZ_CREATED_BY_MODULE. |
application_id | IN | NUMBER | No | Validation: Not updateable if value exists |
actual_content_source | IN | VARCHAR2 | No | Validation: Cannot be updated. |
p_object_version_number | IN/OUT | NUMBER | Yes | Validation:
Comment:
|
PL/SQL Package Name: HZ_PARTY_SITE_V2PUB
Java Class Name: HzPartySiteV2Pub
TYPE party_site_rec_type IS RECORD( party_site_id NUMBER, party_id NUMBER, location_id NUMBER, party_site_number VARCHAR2(30), orig_system_reference VARCHAR2(240), orig_system VARCHAR2(30), mailstop VARCHAR2(60), identifying_address_flag VARCHAR2(1), status VARCHAR2(1), party_site_name VARCHAR2(240), attribute_category VARCHAR2(30), attribute1 VARCHAR2(150), attribute2 VARCHAR2(150), attribute3 VARCHAR2(150), attribute4 VARCHAR2(150), attribute5 VARCHAR2(150), attribute6 VARCHAR2(150), attribute7 VARCHAR2(150), attribute8 VARCHAR2(150), attribute9 VARCHAR2(150), attribute10 VARCHAR2(150), attribute11 VARCHAR2(150), attribute12 VARCHAR2(150), attribute13 VARCHAR2(150), attribute14 VARCHAR2(150), attribute15 VARCHAR2(150), attribute16 VARCHAR2(150), attribute17 VARCHAR2(150), attribute18 VARCHAR2(150), attribute19 VARCHAR2(150), attribute20 VARCHAR2(150), language VARCHAR2(4), addressee VARCHAR2(150), created_by_module VARCHAR2(150), application_id NUMBER global_location_number VARCHAR2(40) duns_number_c VARCHAR2(30) )
TYPE party_site_use_rec_type IS RECORD party_site_use_id NUMBER, comments VARCHAR2(240), site_use_type VARCHAR2(30), party_site_id NUMBER, primary_per_type VARCHAR2(1), status VARCHAR2(1), created_by_module VARCHAR2(150), application_id NUMBER )
public static class PartySiteRec { public BigDecimal party_site_id; public BigDecimal party_id; public BigDecimal location_id; public String party_site_number; public String orig_system_reference; public String orig_system; public String mailstop; public String identifying_address_flag; public String status; public String party_site_name; public String attribute_category; public String attribute1; public String attribute2; public String attribute3; public String attribute4; public String attribute5; public String attribute6; public String attribute7; public String attribute8; public String attribute9; public String attribute10; public String attribute11; public String attribute12; public String attribute13; public String attribute14; public String attribute15; public String attribute16; public String attribute17; public String attribute18; public String attribute19; public String attribute20; public String language; public String addressee; public String created_by_module; public BigDecimal application_id; public String global_location_number; public String duns_number_c; public PartySiteRec(); public PartySiteRec(boolean __RosettaUseGMISSValues); }
public static class PartySiteUseRec { public BigDecimal party_site_use_id; public String comments; public String site_use_type; public BigDecimal party_site_id; public String primary_per_type; public String status; public String created_by_module; public BigDecimal application_id;
public PartySiteUseRec(); public PartySiteUseRec(boolean __RosettaUseGMISSValues); }
This routine is used to create a Party Site for a party. Party Site relates an existing party from the HZ_PARTIES table with an address location from the HZ_LOCATIONS table. The API creates a record in the HZ_PARTY_SITES table. You can create multiple party sites with multiple locations and mark one of those party sites as identifying for that party. The identifying party site address components are denormalized into the HZ_PARTIES table. If orig_system is passed in, the API also creates a record in the HZ_ORIG_SYS_REFERENCES table to store the mapping between the source system reference and the TCA primary key.
PROCEDURE create_party_site ( p_init_msg_list IN VARCHAR2:= FND_API.G_FALSE, p_party_site_rec IN PARTY_SITE_REC_TYPE, x_party_site_id OUT NUMBER, x_party_site_number OUT VARCHAR2, x_return_status OUT VARCHAR2, x_msg_count OUT NUMBER, x_msg_data OUT VARCHAR2 )
public static void createPartySite( OracleConnection_connection, String p_init_msg_list, PartySiteRec p_party_site_rec, BigDecimal [ ] x_party_site_id, String [ ] x_party_site_number, String [ ] x_return_status, BigDecimal [ ] x_msg_count, String [ ] x_msg_data ) throws SQLException;
The following table lists information about the parameters in the Create Party Site API. The table includes the parameter names, the type of each parameter, the data type of each parameter, the necessity of the parameter, and other information about the parameter such as validation, defaults, and other comments.
Parameter Name | Type | Data Type | Required | Validation, Default, Comment |
---|---|---|---|---|
party_site_id | IN | NUMBER | No | Validation: Unique if passed in, else generated from sequence |
party_id | IN | NUMBER | Yes | Validation:
|
location_id | IN | NUMBER | Yes | Validation:
|
party_site_number | IN | VARCHAR2 | Yes/No | Validation:
|
orig_system_reference | IN | VARCHAR2 | No | Default: party_site_id Validation: If orig_system is passed in, then orig_system_reference is required. |
orig_system | IN | VARCHAR2 | No | Validation: Foreign key to HZ_ORIG_SYSTEMS_B.orig_system. |
mailstop | IN | VARCHAR2 | No | |
identifying_address_flag | IN | VARCHAR2 | No | Validation: Validated against AR lookup type YES/NO |
status | IN | VARCHAR2 | No | Validation: Validated against AR lookup type REGISTRY STATUS |
party_site_name | IN | VARCHAR2 | No | |
attribute_category | IN | VARCHAR2 | No | |
attribute1 | IN | VARCHAR2 | No | |
attribute2 | IN | VARCHAR2 | No | |
attribute3 | IN | VARCHAR2 | No | |
attribute4 | IN | VARCHAR2 | No | |
attribute5 | IN | VARCHAR2 | No | |
attribute6 | IN | VARCHAR2 | No | |
attribute7 | IN | VARCHAR2 | No | |
attribute8 | IN | VARCHAR2 | No | |
attribute9 | IN | VARCHAR2 | No | |
attribute10 | IN | VARCHAR2 | No | |
attribute11 | IN | VARCHAR2 | No | |
attribute12 | IN | VARCHAR2 | No | |
attribute13 | IN | VARCHAR2 | No | |
attribute14 | IN | VARCHAR2 | No | |
attribute15 | IN | VARCHAR2 | No | |
attribute16 | IN | VARCHAR2 | No | |
attribute17 | IN | VARCHAR2 | No | |
attribute18 | IN | VARCHAR2 | No | |
attribute19 | IN | VARCHAR2 | No | |
attribute20 | IN | VARCHAR2 | No | |
language | IN | VARCHAR2 | No | Comment: This parameter is no longer used. Use hz_locations.language instead. |
addressee | IN | VARCHAR2 | No | |
created_by_module | IN | VARCHAR2 | Yes | Validation: Mandatory attribute. Validated against AR lookup type HZ_CREATED_BY_MODULE. |
application_id | IN | NUMBER | No | Comment: Text to indicate application from which creation of record is initiated. |
global_location_number | IN | VARCHAR2 | No | Validation:
|
duns_number_c | IN | VARCHAR2 | No | Comment: For internal use only. |
x_party_site_id | IN | NUMBER | No | Comment: party_site_id of the party site record created |
x_party_site_number | IN | NUMBER | No | Comment: party_site_number of the party site record created |
A party can have only one location defined as the Identifying Address.
The API automatically sets the identifying_address_flag to Y for the first active party site created for a given party, even if you pass N for the attribute value. You cannot change the identifying_address_flag from Y to N. Instead, you must choose a different active party site and set that party site as the identifying address. Choosing a new identifying address causes the status of the old identifying address to change to non-identifying.
Moreover, when you activate a party site, if this is the first active party site for a party, the API sets this party site as the identifying address. If you inactivate a party site that is the identifying address, the API changes its status to non-identifying address, finds the first active party site from the existing party sites, and then makes that one as identifying address. If the API cannot find any active party site, the party has no identifying address. You cannot set an inactive party site as the identifying address.
The API denormalizes location components such as address1, city, and country only from the identifying party sites to HZ_PARTIES.
This routine is used to update a Party Site. The API updates a record in the HZ_PARTY_SITES table. You cannot set the identifying address flag to 'N' to unmark the party site as identifying, rather you should set another site as identifying which makes any other party site for that party as non identifying. The identifying party site address components are denormalized into the HZ_PARTIES table.
If the primary key is not passed in, get the primary key from the HZ_ORIG_SYS_REFERENCES table based on orig_system and orig_system_reference if they are not null and unique.
If you update the status of a party site from Active to Inactive, then the party site uses and customer account sites associated with this party site are inactivated. The customer account site uses that belong to the associated customer account sites are also inactivated.
If you update the status of a party site from Inactive to Active, then the associated customer account sites to this party site are also updated and made active.
PROCEDURE update_party_site ( p_init_msg_list IN VARCHAR2:= FND_API.G_FALSE, p_party_site_rec IN PARTY_SITE_REC_TYPE, p_object_version_number IN OUT NUMBER, x_return_status OUT VARCHAR2, x_msg_count OUT NUMBER, x_msg_data OUT VARCHAR2
public static void updatePartySite( OracleConnection_connection, String p_init_msg_list, PartySiteRec p_party_site_rec, BigDecimal [ ] p_object_version_number, String [ ] x_return_status, BigDecimal [ ] x_msg_count, String [ ] x_msg_data ) throws SQLException;
The following table lists information about the parameters in the Update Party Site API. The table includes the parameter names, the type of each parameter, the data type of each parameter, the necessity of the parameter, and other information about the parameter such as validation, defaults, and other comments.
Parameter Name | Type | Data Type | Required | Validation, Default, Comment |
---|---|---|---|---|
party_site_id | IN | NUMBER | Yes | Validation: Valid party_site_id from HZ_PARTY_SITE_USES table Comment: Pass the party_site_id from HZ_PARTY_SITES table |
party_id | IN | NUMBER | No | Validation: Not updateable |
location_id | IN | NUMBER | No | Validation: Not updateable |
party_site_number | IN | VARCHAR2 | No | Validation: Not updateable |
orig_system_reference | IN | VARCHAR2 | No | Validation: Non updateable, but if a primary key is not passed in, you can pass in any ORIG_SYSTEM and ORIG_SYSTEM_REFERENCE that exists in the HZ_ORIG_SYS_REFERENCE table and unique validation is bypassed. The ORIG_SYSTEM_REFERENCE does not change, but persists in the table. |
orig_system | IN | VARCHAR2 | No | Validation: Foreign key to HZ_ORIG_SYSTEMS_B.orig_system with sst_flag value of Y. |
mailstop | IN | VARCHAR2 | No | |
identifying_address_flag | IN | VARCHAR2 | No | Validation: Validated against AR lookup type YES/NO |
status | IN | VARCHAR2 | No | Validation:
|
party_site_name | IN | VARCHAR2 | No | |
attribute_category | IN | VARCHAR2 | No | |
attribute1 | IN | VARCHAR2 | No | |
attribute2 | IN | VARCHAR2 | No | |
attribute3 | IN | VARCHAR2 | No | |
attribute4 | IN | VARCHAR2 | No | |
attribute5 | IN | VARCHAR2 | No | |
attribute6 | IN | VARCHAR2 | No | |
attribute7 | IN | VARCHAR2 | No | |
attribute8 | IN | VARCHAR2 | No | |
attribute9 | IN | VARCHAR2 | No | |
attribute10 | IN | VARCHAR2 | No | |
attribute11 | IN | VARCHAR2 | No | |
attribute12 | IN | VARCHAR2 | No | |
attribute13 | IN | VARCHAR2 | No | |
attribute14 | IN | VARCHAR2 | No | |
attribute15 | IN | VARCHAR2 | No | |
attribute16 | IN | VARCHAR2 | No | |
attribute17 | IN | VARCHAR2 | No | |
attribute18 | IN | VARCHAR2 | No | |
attribute19 | IN | VARCHAR2 | No | |
attribute20 | IN | VARCHAR2 | No | |
language | IN | VARCHAR2 | No | Comment: This parameter is no longer used. Use hz_locations.language instead. |
addressee | IN | VARCHAR2 | No | |
created_by_module | IN | VARCHAR2 | Yes | Validation: Non updateable if value exists, else validated against AR lookup type HZ_CREATED_BY_MODULE. |
application_id | IN | NUMBER | No | Validation: Not updateable if value exists |
global_location_number | IN | VARCHAR2 | No | Validation:
|
duns_number_c | IN | VARCHAR2 | No | Comment: For internal use only. |
p_object_version_number | IN OUT |
NUMBER | Yes | Validation:
Comment:
|
A party can have only one location defined as the Identifying Party Site.
This routine is used to create a Party Site Use for a Party Site. The API creates a record in the HZ_PARTY_SITE_USES table. Party site use defines a business purpose for a party site such as 'BILL_TO', 'SHIP_TO' etc. You can create a party site use for a party site that is already present in the HZ_PARTY_SITES table.
The first active party site use that you create is identified as the primary party site use. The primary party site use cannot be inactive.
PROCEDURE create_party_site_use ( p_init_msg_list IN VARCHAR2:= FND_API.G_FALSE, p_party_site_use_rec IN PARTY_SITE_USE_REC_TYPE, x_party_site_use_id OUT NUMBER, x_return_status OUT VARCHAR2, x_msg_count OUT NUMBER, x_msg_data OUT VARCHAR2)
public static void createPartySiteUse( OracleConnection_connection, String p_init_msg_list, PartySiteUseRec p_party_site_use_rec, BigDecimal [ ] x_party_site_use_id, String [ ] x_return_status, BigDecimal [ ] x_msg_count, String [ ] x_msg_data ) throws SQLException;
The following table lists information about the parameters in the Create Party Site Use API. The table includes the parameter names, the type of each parameter, the data type of each parameter, the necessity of the parameter, and other information about the parameter such as validation, defaults, and other comments.
Parameter Name | Type | Data Type | Required | Validation, Default, Comment |
---|---|---|---|---|
party_site_use_id | IN | NUMBER | No | Validation: Unique if passed in, else generated from sequence |
comments | IN | VARCHAR2 | No | |
site_use_type | IN | VARCHAR2 | Yes | Validation:
|
party_site_id | IN | NUMBER | Yes | Validation:
|
primary_per_type | IN | VARCHAR2 | No | Validation: Validated against AR lookup type YES/NO. If the status is set to Inactive (I), then this value cannot be set to Yes (Y). |
status | IN | VARCHAR2 | No | Validation: Validated against AR lookup type REGISTRY_STATUS |
created_by_module | IN | VARCHAR2 | Yes | Validation: Mandatory attribute. Validated against AR lookup type HZ_CREATED_BY_MODULE. |
application_id | IN | NUMBER | No | Comment: Text to indicate application from which creation of record is initiated |
x_party_site_use_id | OUT | NUMBER | No | Comment: Return Party Site Use ID of the party site use created |
The combination of party_site_id and site_use_type must be unique.
This routine is used to update a Party Site Use. The API updates a record in the HZ_PARTY_SITE_USES table.
If the primary site use for a particular site use type (primary_per_type value is Y) is set as inactive, then the earliest created active site use for the same site use type is set as primary. If a site use is activated and this becomes the only active site use for that site use type, then it is set as primary.
PROCEDURE update_party_site_use ( p_init_msg_list IN VARCHAR2:= FND_API.G_FALSE, p_party_site_use_rec IN PARTY_SITE_USE_REC_TYPE, p_object_version_number IN OUT NUMBER, x_return_status OUT VARCHAR2, x_msg_count OUT NUMBER, x_msg_data OUT VARCHAR2
public static void updatePartySiteUse( OracleConnection_connection, String p_init_msg_list, PartySiteUseRec p_party_site_use_rec, BigDecimal [ ] p_object_version_number, String [ ] x_return_status, BigDecimal [ ] x_msg_count, String [ ] x_msg_data ) throws SQLException;
The following table lists information about the parameters in the Update Party Site Use API. The table includes the parameter names, the type of each parameter, the data type of each parameter, the necessity of the parameter, and other information about the parameter such as validation, defaults, and other comments.
Parameter Name | Type | Data Type | Required | Validation, Default, Comment |
---|---|---|---|---|
party_site_use_id | IN | NUMBER | Yes | Validation: Valid party_site_use_id from HZ_PARTY_SITE_USES table Comment: Pass the party_site_use_id from HZ_PARTY_SITE_USES record |
comments | IN | VARCHAR2 | No | |
site_use_type | IN | VARCHAR2 | No | Validation: Not updateable |
party_site_id | IN | NUMBER | No | Validation: Not updateable |
primary_per_type | IN | VARCHAR2 | No | Validation: Validated against AR lookup type YES/NO |
status | IN | VARCHAR2 | No | Validation:
|
created_by_module | IN | VARCHAR2 | No | Validation: Non updateable if value exists, else validated against AR lookup type HZ_CREATED_BY_MODULE. |
application_id | IN | NUMBER | No | Validation: Not updateable if value exists |
p_object_version_number | IN OUT |
NUMBER | Yes | Validation:
Comment:
|