/
Validation (VALIDATION_API)


Validation (VALIDATION_API)

Owned by IFS Energy & Resources (Deactivated)



/wiki/spaces/QG/pages/24674321

Overview

This API offers the ability to validate a variety of master data as well as some transactional data. It is intended to be used in a form of pre-edit before the actual Batch Edit functionality in Qbyte Financial when importing data into the Qbyte Financial application. All functions and procedures perform data validations and return a Status, Error Code, and Error Message. The name of the API package is VALIDATION_API. It contains a number of edit functions, some of them overloaded with different sets of parameters for additional validation functionality, as well as equivalent procedures for more options when using this API. Default values, if any, on parameters indicate that the parameter is optional and the default value will be inserted into the corresponding column. 

Each function is also available as a procedure. When using the procedure the return status will be returned with the o_return_status parameter. All other functionality is identical between the function and procedure.

The functions is_bank_deposit_locked and is_valid_bank_deposit do not have an equivalent procedure but are included in a single procedure validate_bank_deposit.



Listing of Functions and Procedures

The functions are:



Function Name

Purpose

Function Name

Purpose

is_valid_voucher

Set of edits combined together to validate Organization ID, Source Code, Type, Accounting Period and Currency of the voucher record.  It is used by EXTERNAL_TRANSACTIONS_API.CREATE_VOUCHER() and by EXTERNAL_TRANSACTIONS_API.INSERT_TEMP_INTERFACE_DATA()

is_valid_line_item

Set of edits combined together to validate all the required elements and their combinations on the line item record.  It is used by EXTERNAL_TRANSACTIONS_API.PUT_LINE_ITEM()and by EXTERNAL_TRANSACTIONS_API.INSERT_TEMP_INTERFACE_DATA() 

is_valid_line_item

Set of edits combined together to validate all the required elements and their combinations on the line item record.  It is used by EXTERNAL_TRANSACTIONS_API.PUT_LINE_ITEM()and by EXTERNAL_TRANSACTIONS_API.INSERT_TEMP_INTERFACE_DATA() 

is_valid_line_item

Overloaded version with modified set of edits combined together to validate all the required elements and their combinations on the line item record.  It is used by EXTERNAL_TRANSACTIONS_API.PUT_LINE_ITEM()and by EXTERNAL_TRANSACTIONS_API.INSERT_TEMP_INTERFACE_DATA() 

is_valid_line_item

Overloaded version with modified set of edits combined together to validate all the required elements and their combinations on the line item record.  It is used by EXTERNAL_TRANSACTIONS_API.PUT_LINE_ITEM()and by EXTERNAL_TRANSACTIONS_API.INSERT_TEMP_INTERFACE_DATA() 

is_valid_afe

Validates AFE

is_valid_afe

Validates AFE and checks if it is active for the Accounting Period

is_valid_afe_acct

Validates AFE/Account combination 

is_valid_afe_acct

Validates AFE/Account/Org combination 

is_valid_cc

Validates CC 

is_valid_cc

Validates CC and checks if it is active for the Accounting Period 

is_valid_cc_acct

Validates CC/Account combination 

is_valid_cc_acct

Validates CC/Account/Org combination 

is_valid_afe_cc

Validates AFE/CC combination 

is_valid_org

Validates Organization ID 

does_cc_allow_other_orgs

Validates CC and its Managing Organization ID  and Organization ID 

is_valid_gl_sub_code

Validates GL Sub Code 

is_valid_acct_gl_sub_code

Validates GL Sub Code/Account/Org combination 

is_valid_continuity_code

Validates Continuity Code 

is_valid_continuity_code

Validates Continuity Code/Account/Org combination 

is_valid_major_acct

Validates Major Account 

is_valid_account

Validates Account i.e. Major/Minor combination 

is_valid_account

Validates Account i.e. Major/Minor/Organization combination 

is_valid_account

Validates Account i.e. Major/Minor combination together with Organization and Accounting Period; includes validation using Control Group Security when Subsystem 101 is ACTIVE. 

is_valid_cc_type_org_acct

Validates CC Type, Organization ID and Account combination 

is_valid_afe_cc_doi_link

Validates AFE/CC/DOI combination 

is_valid_accounting_period

Validates Organization and Accounting Period; includes validation using Control Group Security when Subsystem 101 is ACTIVE. 

is_valid_acct_activity_date

Validates Activity Period and Account combination 

is_valid_acct_activity_date

Validates Activity Period/Account/Org combination 

is_valid_address

Validates Address ID and BA ID combination 

is_valid_address

Validates Address ID and BA ID and checks if Address ID is active 

is_valid_ba

Validates BA 

is_valid_ba

Validates BA and checks if active 

is_valid_code

Validates any Code if Code Type is known 

is_valid_date

Validates Date Format 

is_valid_doi_deck

Validates DOI Deck 

is_valid_currency

Validates Currency code 

is_valid_dest_org

Validates Destination Organization ID specified on a line item and checks if Inter-Company Accounts are set with Voucher Organizaiton ID 

is_valid_source_code

Validates Source code 

is_valid_acct_li_vol

Validates Account and Line Item Volume combination 

is_valid_acct_li_vol

Validates Account/Line Item Volume/Org combination 

is_valid_acct_li_vol

Validates Account/Line Item Volume/Org/Entered combination 

is_valid_voucher_type

Validates Voucher Type code 

is_valid_bank_acct

Validates Bank Account ID 

is_valid_invc_control_acct

Validates Control Account and Invoice Number combination 

is_valid_invc_control_acct

Validates Control Account/Invoice Number/Org combination 

is_valid_purchase_order

Validates Purchase Order Number 

is_temp_int_data_balanced

Validates if Voucher data in TEMP_INTERFACE_DATA is balanced 

is_valid_pay_stat_code

Validates Pay Stat Code 

is_valid_priority_code

Validates Priority Code 

is_valid_invc_type_code

Validates Invoice Type Code/Payable or Receivable Code/Account combination 

is_valid_agr_type_code

Validates Agreement Type Code 

is_valid_et_id

Validates ET (Equipment Transaction) ID 

is_valid_misc_income_cat

Validates Miscellaneous Income Category 

is_valid_bank_deposit_num

Validates Bank Deposit Number

is_valid_cash_account

Validates Cash Account i.e. Major/Minor combination is a cash account

is_valid_bank_cash_account

Validates the Bank Cash Account i.e Cash Account and Bank Account ID combination

is_valid_bank_deposit

Validates the Bank Deposit i.e Bank Deposit Number, Bank Account ID & Cash Transaction Date combination. This function does not have a procedure with the same name but is part of the procedure validate_bank_deposit

is_bank_deposit_locked

Validates that the Bank Deposit is locked. This function This function does not have a procedure with the same name but is included in the procedure validate_bank_deposit

get_bank_deposit_cash_tx_id

Gets the Cash Transaction ID belonging to the Bank Deposit Number, Cash Transaction Amount, BA ID, Client Issued Number, Client Issued Date combination





The procedures are:



Procedure Name

Purpose

Procedure Name

Purpose

is_valid_voucher

Set of edits combined together to validate Organization ID, Source Code, Type, Accounting Period and Currency of the voucher record.  It is used by EXTERNAL_TRANSACTIONS_API.CREATE_VOUCHER() and by EXTERNAL_TRANSACTIONS_API.INSERT_TEMP_INTERFACE_DATA() 

is_valid_line_item

Set of edits combined together to validate all the required elements and their combinations on the line item record.  It is used by EXTERNAL_TRANSACTIONS_API.PUT_LINE_ITEM()and by EXTERNAL_TRANSACTIONS_API.INSERT_TEMP_INTERFACE_DATA()

is_valid_line_item

Set of edits combined together to validate all the required elements and their combinations on the line item record.  It is used by EXTERNAL_TRANSACTIONS_API.PUT_LINE_ITEM()and by EXTERNAL_TRANSACTIONS_API.INSERT_TEMP_INTERFACE_DATA() 

is_valid_line_item

Overloaded version with modified set of edits combined together to validate all the required elements and their combinations on the line item record.  It is used by EXTERNAL_TRANSACTIONS_API.PUT_LINE_ITEM()and by EXTERNAL_TRANSACTIONS_API.INSERT_TEMP_INTERFACE_DATA() 

is_valid_line_item

Overloaded version with modified set of edits combined together to validate all the required elements and their combinations on the line item record.  It is used by EXTERNAL_TRANSACTIONS_API.PUT_LINE_ITEM()and by EXTERNAL_TRANSACTIONS_API.INSERT_TEMP_INTERFACE_DATA()

is_valid_afe

Validates AFE 

is_valid_afe

Validates AFE and checks if it is active for the Accounting Period 

is_valid_afe_acct

Validates AFE/Account combination 

is_valid_afe_acct

Validates AFE/Account/Org combination 

is_valid_cc

Validates CC 

is_valid_cc

Validates CC and checks if it is active for the Accounting Period 

is_valid_cc_acct

Validates CC/Account combination 

is_valid_cc_acct

Validates CC/Account/Org combination 

is_valid_afe_cc

Validates AFE/CC combination 

is_valid_org

Validates Organization ID 

does_cc_allow_other_orgs

Validates CC and its Managing Organization ID  and Organization ID 

is_valid_gl_sub_code

Validates GL Sub Code 

is_valid_acct_gl_sub_code

Validates GL Sub Code/Account/Org combination 

is_valid_continuity_code

Validates Continuity Code 

is_valid_continuity_code

Validates Continuity Code/Account/Org combination 

is_valid_major_acct

Validates Major Account 

is_valid_account

Validates Account i.e. Major/Minor combination 

is_valid_account

Validates Account i.e. Major/Minor/Organization combination 

is_valid_account

Validates Account i.e. Major/Minor combination together with Organization and Accounting Period; includes validation using Control Group Security when Subsystem 101 is ACTIVE. 

is_valid_cc_type_org_acct

Validates CC Type, Organization ID and Account combination 

is_valid_afe_cc_doi_link

Validates AFE/CC/DOI combination 

is_valid_accounting_period

Validates Organization and Accounting Period; includes validation using Control Group Security when Subsystem 101 is ACTIVE. 

is_valid_acct_activity_date

Validates Activity Period and Account combination 

is_valid_acct_activity_date

Validates Activity Period/Account/Org combination 

is_valid_address

Validates Address ID and BA ID combination

is_valid_address

Validates Address ID and BA ID and checks if Address ID is active 

is_valid_ba

Validates BA 

is_valid_ba

Validates BA and checks if active 

is_valid_code

Validates any Code if Code Type is known 

is_valid_date

Validates Date Format

is_valid_doi_deck

Validates DOI Deck 

is_valid_currency

Validates Currency code 

is_valid_dest_org

Validates Destination Organization ID specified on a line item and checks if Inter-Company Accounts are set with Voucher Organizaiton ID 

is_valid_source_code

Validates Source code 

is_valid_acct_li_vol

Validates Account and Line Item Volume combination 

is_valid_acct_li_vol

Validates Account/Line Item Volume/Org combination 

is_valid_acct_li_vol

Validates Account/Line Item Volume/Org/Entered combination 

is_valid_voucher_type

Validates Voucher Type code 

is_valid_bank_acct

Validates Bank Account ID 

is_valid_invc_control_acct

Validates Control Account and Invoice Number combination 

is_valid_invc_control_acct

Validates Control Account/Invoice Number/Org combination 

is_valid_purchase_order

Validates Purchase Order Number 

is_temp_int_data_balanced

Validates if Voucher data in TEMP_INTERFACE_DATA is balanced 

is_valid_pay_stat_code

Validates Pay Stat Code 

is_valid_priority_code

Validates Priority Code 

is_valid_invc_type_code

Validates Invoice Type Code/Payable or Receivable Code/Account combination 

is_valid_agr_type_code

Validates Agreement Type Code 

is_valid_et_id

Validates ET (Equipment Transaction) ID 

is_valid_misc_income_cat

Validates Miscellaneous Income Category

is_valid_bank_deposit_num

Validates Bank Deposit Number

is_valid_cash_account

Validates Cash Account i.e. Major/Minor combination is a cash account

is_valid_bank_cash_account

Validates the Bank Cash Account i.e Cash Account and Bank Account ID combination

validate_bank_deposit

Combines two functions to validate a bank deposit:

 is_valid_bank_deposit - Validates the Bank Deposit i.e Bank Deposit Number, Bank Account ID & Cash Transaction Date combination

is_bank_deposit_locked - Validates that the Bank Deposit is locked

get_bank_deposit_cash_tx_id

Gets the Cash Transaction ID belonging to the Bank Deposit Number, Cash Transaction Amount, BA ID, Client Issued Number, Client Issued Date combination





validation_api.IS_VALID_VOUCHER()

  • Function returns VARCHAR2 (‘TRUE’/’FALSE’) to indicate a successful/unsuccessful action.

  • Available as both a function and a procedure.



Parameter

In/Out

Type

Default Value

Parameter

In/Out

Type

Default Value

i_org_id       

IN

NUMBER(4) 



i_acct_per_date         

IN

DATE 



i_src_code

IN

VARCHAR2(6) 



i_voucher_type_code                   

IN

VARCHAR2(6) 



i_curr_code          

IN

VARCHAR2(3)



o_return_status

*procedure only

OUT

VARCHAR2

Possible values:

  • ‘TRUE’

  • ‘FALSE’

o_return_code

OUT

NUMBER

Possible values:

  • 0 – Success

  • -20001 – Handled Application Error

  • -20000 – Generic Error

o_return_message

OUT

VARCHAR2

Insert ‘Successful’ or ‘Failure’ or error message 





validation_api.IS_VALID_LINE_ITEM()

  • Function returns VARCHAR2 (‘TRUE’/’FALSE’) to indicate a successful/unsuccessful action.

  • Available as both a function and a procedure.



Parameter

In/Out

Type

Default Value

Parameter

In/Out

Type

Default Value

i_major_acct

IN

VARCHAR2(4) 



i_minor_acct

IN

VARCHAR2(4) 



i_cc_num

IN

VARCHAR2(10) 



i_afe_num

IN

VARCHAR2(10) 



i_actvy_per_date

IN

DATE 



i_amount

IN

NUMBER(14,2) 



i_li_vol

IN

NUMBER(12,2) 



i_govern_agr_id

IN

NUMBER(10) 



i_govern_agr_type_code

IN

VARCHAR2(2) 



i_dest_org_id

IN

NUMBER(4) 



i_li_rem

IN

VARCHAR2(72) 



i_gl_sub_code

IN

VARCHAR2(6) 



i_ba_id

IN

NUMBER(6) 



i_invc_num

IN

VARCHAR2(20) 



i_invc_date

IN

DATE 



i_payable_or_receivable_code

IN

VARCHAR2(1) 



i_due_date

IN

DATE 



i_alternate_address_id

IN

NUMBER(6) 



i_separate_cheque_flag

IN

VARCHAR2(1) 



i_invc_rem

IN

VARCHAR2(120) 



i_purchase_order_num

IN

VARCHAR2(20) 



i_bank_acct_id

IN

NUMBER(4) 



i_cash_tx_ba_id

IN

NUMBER(10) 



i_cheque_no

IN

NUMBER(10) 



i_cheque_date         

IN

DATE 



i_cheque_amt

IN

NUMBER(14,2) 



i_medium_code                   

IN

VARCHAR2(1) 



i_bank_deposit_item_cash_tx_id          

IN

NUMBER(10) 



i_pay_stat_code

IN

VARCHAR2(1) 



i_priority_code

IN

VARCHAR2(1) 



i_sent_to

IN

VARCHAR2(30) 



i_invc_type_code

IN

VARCHAR2(3) 



i_invc_afe_num

IN

VARCHAR2(10) 



i_invc_cc_num

IN

VARCHAR2(10) 



i_discount_achieved

IN

VARCHAR2(1) 



i_src_agr_id

IN

NUMBER(10) 



i_src_agr_type_code

IN

VARCHAR2(2) 



i_et_id

IN

NUMBER(10) 



i_warehouse_handling_flag

IN

VARCHAR2(1) 



i_misc_income_category

IN

VARCHAR2(30) 



i_continuity_code

IN

VARCHAR2(6) 



i_li_as_entered_vol

IN

NUMBER(12,2)



o_return_status

*procedure only

OUT

VARCHAR2

Possible values:

  • ‘TRUE’

  • ‘FALSE’ 

o_return_code

OUT

NUMBER

Possible values:

  • 0 – Success

  • -20001 – Handled Application Error

  • -20000 – Generic Error 

o_return_message

OUT

VARCHAR2

Insert ‘Successful’ or ‘Failure’ or error message





validation_api.IS_VALID_LINE_ITEM()

  • Function returns VARCHAR2 (‘TRUE’/’FALSE’) to indicate a successful/unsuccessful action.

  • Available as both a function and a procedure.



Parameter

In/Out

Type

Default Value

Parameter

In/Out

Type

Default Value

i_major_acct

IN

VARCHAR2(4) 



i_minor_acct

IN

VARCHAR2(4) 



i_cc_num

IN

VARCHAR2(10) 



i_afe_num

IN

VARCHAR2(10) 



i_actvy_per_date

IN

DATE 



i_amount

IN

NUMBER(14,2)



i_li_vol

IN

NUMBER(12,2) 



i_govern_agr_id

IN

NUMBER(10) 



i_govern_agr_type_code

IN

VARCHAR2(2) 



i_dest_org_id

IN

NUMBER(4) 



i_li_rem

IN

VARCHAR2(72) 



i_gl_sub_code

IN

VARCHAR2(6) 



i_ba_id

IN

NUMBER(6) 



i_invc_num

IN

VARCHAR2(20) 



i_invc_date

IN

DATE 



i_payable_or_receivable_code

IN

VARCHAR2(1) 



i_due_date

IN

DATE 



i_alternate_address_id

IN

NUMBER(6) 



i_separate_cheque_flag

IN

VARCHAR2(1) 



i_invc_rem

IN

VARCHAR2(120) 



i_purchase_order_num

IN

VARCHAR2(20) 



i_bank_acct_id

IN

NUMBER(4) 



i_cash_tx_ba_id

IN

NUMBER(10) 



i_cheque_no

IN

NUMBER(10) 



i_cheque_date         

IN

DATE 



i_cheque_amt

IN

NUMBER(14,2) 



i_medium_code                   

IN

VARCHAR2(1) 



i_bank_deposit_item_cash_tx_id          

IN

NUMBER(10) 



i_pay_stat_code

IN

VARCHAR2(1) 



i_priority_code

IN

VARCHAR2(1) 



i_sent_to

IN

VARCHAR2(30) 



i_invc_type_code

IN

VARCHAR2(3) 



i_invc_afe_num

IN

VARCHAR2(10) 



i_invc_cc_num

IN

VARCHAR2(10) 



i_discount_achieved

IN

VARCHAR2(1) 



i_src_agr_id

IN

NUMBER(10) 



i_src_agr_type_code

IN

VARCHAR2(2) 



i_et_id

IN

NUMBER(10) 



i_warehouse_handling_flag

IN

VARCHAR2(1) 



i_misc_income_category

IN

VARCHAR2(30) 



i_continuity_code

IN

VARCHAR2(6) 



o_return_status

 *procedure only

OUT

VARCHAR2

Possible values:

  • ‘TRUE’

  • ‘FALSE’

o_return_code

OUT

NUMBER

Possible values:

  • 0 – Success

  • -20001 – Handled Application Error

  • -20000 – Generic Error

o_return_message

OUT

VARCHAR2

Insert ‘Successful’ or ‘Failure’ or error message





validation_api.IS_VALID_LINE_ITEM()

  • Function returns VARCHAR2 (‘TRUE’/’FALSE’) to indicate a successful/unsuccessful action.

  • Available as both a function and a procedure. 



Parameter

In/Out

Type

Default Value

Parameter

In/Out

Type

Default Value

i_major_acct

IN

VARCHAR2(4)



i_minor_acct

IN

VARCHAR2(4)



i_cc_num

IN

VARCHAR2(10)



i_afe_num

IN

VARCHAR2(10)



i_actvy_per_date

IN

DATE



i_amount

IN

NUMBER(14,2)



i_li_vol

IN

NUMBER(12,2)



i_govern_agr_id

IN

NUMBER(10)



i_govern_agr_type_code

IN

VARCHAR2(2)



i_dest_org_id

IN

NUMBER(4)



i_li_rem

IN

VARCHAR2(72)



i_gl_sub_code

IN

VARCHAR2(6)



i_ba_id

IN

NUMBER(6)



i_invc_num

IN

VARCHAR2(20)



i_invc_date

IN

DATE



i_due_date

IN

DATE



i_alternate_address_id

IN

NUMBER(6)



i_separate_cheque_flag

IN

VARCHAR2(1)



i_invc_rem

IN

VARCHAR2(120)



i_purchase_order_num

IN

VARCHAR2(20)



i_bank_acct_id

IN

NUMBER(4)



i_cash_tx_ba_id

IN

NUMBER(10)



i_cheque_no

IN

NUMBER(10)



i_cheque_date         

IN

DATE



i_cheque_amt

IN

NUMBER(14,2)



i_medium_code                   

IN

VARCHAR2(1)



i_bank_deposit_item_cash_tx_id          

IN

NUMBER(10)



o_return_status

*procedure only

OUT

VARCHAR2

Possible values:

  • ‘TRUE’

  • ‘FALSE’ 

o_return_code

OUT

NUMBER

Possible values:

  • 0 – Success

  • -20001 – Handled Application Error

  • -20000 – Generic Error 

o_return_message

OUT

VARCHAR2

Insert ‘Successful’ or ‘Failure’ or error message





validation_api.IS_VALID_LINE_ITEM()

  • Function returns VARCHAR2 (‘TRUE’/’FALSE’) to indicate a successful/unsuccessful action.

  • Available as both a function and a procedure.



Parameter

In/Out

Type

Default Value

Parameter

In/Out

Type

Default Value

i_major_acct

IN

VARCHAR2(4) 



i_minor_acct

IN

VARCHAR2(4) 



i_cc_num

IN

VARCHAR2(10) 



i_afe_num

IN

VARCHAR2(10) 



i_actvy_per_date

IN

DATE 



i_amount

IN

NUMBER(14,2) 



i_li_vol

IN

NUMBER(12,2) 



i_govern_agr_id

IN

NUMBER(10) 



i_govern_agr_type_code

IN

VARCHAR2(2) 



i_dest_org_id

IN

NUMBER(4) 



i_li_rem

IN

VARCHAR2(72) 



i_gl_sub_code

IN

VARCHAR2(6) 



i_ba_id

IN

NUMBER(6) 



i_invc_num

IN

VARCHAR2(20) 



i_invc_date

IN

DATE 



i_due_date

IN

DATE 



i_alternate_address_id

IN

NUMBER(6) 



i_separate_cheque_flag

IN

VARCHAR2(1) 



i_invc_rem

IN

VARCHAR2(120) 



i_purchase_order_num

IN

VARCHAR2(20) 



i_bank_acct_id

IN

NUMBER(4) 



i_cash_tx_ba_id

IN

NUMBER(10) 



i_medium_code                   

IN

VARCHAR2(1) 



i_bank_deposit_item_cash_tx_id          

IN

NUMBER(10)



o_return_status

*procedure only

OUT

VARCHAR2

Possible values:

  • ‘TRUE’

  • ‘FALSE’

o_return_code

OUT

NUMBER

Possible values:

  • 0 – Success

  • -20001 – Handled Application Error

  • -20000 – Generic Error

o_return_message

OUT

VARCHAR2

Insert ‘Successful’ or ‘Failure’ or error message





validation_api.IS_VALID_AFE()

  • Function returns VARCHAR2 (‘TRUE’/’FALSE’) to indicate a successful/unsuccessful action.

  • Available as both a function and a procedure. 



Parameter

In/Out

Type

Default Value

Parameter

In/Out

Type

Default Value

i_afe_num

IN

VARCHAR2(10)



o_return_status



*procedure only

OUT

VARCHAR2

Possible values:

‘TRUE’

‘FALSE’

o_return_code

OUT

NUMBER

Possible values:

  • 0 – Success

  • -20001 – Handled Application Error

  • -20000 – Generic Error 

o_return_message

OUT

VARCHAR2

Insert ‘Successful’ or ‘Failure’ or error message 





validation_api.IS_VALID_AFE()

  • Function returns VARCHAR2 (‘TRUE’/’FALSE’) to indicate a successful/unsuccessful action.

  • Available as both a function and a procedure.

  • Checks if AFE is valid and terminated. 



Parameter

In/Out

Type

Default Value

Parameter

In/Out

Type

Default Value

i_afe_num

IN

VARCHAR2(10) 



i_acct_per_date

IN

DATE



o_return_status

*procedure only

OUT

VARCHAR2

Possible values:

  • ‘TRUE’

  • ‘FALSE’

o_return_code

OUT

NUMBER

Possible values:

  • 0 – Success

  • -20001 – Handled Application Error

  • -20000 – Generic Error 

o_return_message

OUT

VARCHAR2

Insert ‘Successful’ or ‘Failure’ or error message 





validation_api.IS_VALID_AFE_ACCT()

  • Function returns VARCHAR2 (‘TRUE’/’FALSE’) to indicate a successful/unsuccessful action.

  • Available as both a function and a procedure.



Parameter

In/Out

Type

Default Value

Parameter

In/Out

Type

Default Value

i_afe_num

IN

VARCHAR2(10) 



i_major_acct

IN

VARCHAR2(4) 



i_minor_acct

IN

VARCHAR2(4)



o_return_status

*procedure only

OUT

VARCHAR2

Possible values:

  • ‘TRUE’

  • ‘FALSE’ 

o_return_code

OUT

NUMBER

Possible values:

  • 0 – Success

  • -20001 – Handled Application Error

  • -20000 – Generic Error 

o_return_message

OUT

VARCHAR2

Insert ‘Successful’ or ‘Failure’ or error message

o_return_code

OUT

NUMBER

Possible values:

  • 0 – Success

  • -20001 – Handled Application Error

  • -20000 – Generic Error

o_return_message

OUT

VARCHAR2

Insert ‘Successful’ or ‘Failure’ or error message 





validation_api.IS_VALID_AFE_ACCT()

  • Function returns VARCHAR2 (‘TRUE’/’FALSE’) to indicate a successful/unsuccessful action.

  • Available as both a function and a procedure. 



Parameter

In/Out

Type

Default Value

Parameter

In/Out

Type

Default Value

i_afe_num

IN

VARCHAR2(10) 



i_major_acct

IN

VARCHAR2(4) 



i_minor_acct

IN

VARCHAR2(4) 



i_org_id

IN

NUMBER(4) 

i_org_id

o_return_status

*procedure only

OUT

VARCHAR2

Possible values:

‘TRUE’

‘FALSE’





validation_api.IS_VALID_CC()

  • Function returns VARCHAR2 (‘TRUE’/’FALSE’) to indicate a successful/unsuccessful action.

  • Available as both a function and a procedure.



Parameter

In/Out

Type

Default Value

Parameter

In/Out

Type

Default Value

i_cc_num

IN

VARCHAR2(10)



o_return_status 

*procedure only

OUT

VARCHAR2

Possible values:

  • ‘TRUE’

  • ‘FALSE’

o_return_code

OUT

NUMBER

Possible values:

  • 0 – Success

  • -20001 – Handled Application Error

  • -20000 – Generic Error 

o_return_message

OUT

VARCHAR2

Insert ‘Successful’ or ‘Failure’ or error message 





validation_api.IS_VALID_CC()

  • Function returns VARCHAR2(‘TRUE’/’FALSE’) to indicate a successful/unsuccessful action.

  • Available as both a function and a procedure.



Parameter

In/Out

Type

Default Value

Parameter

In/Out

Type

Default Value

i_cc_num

IN

VARCHAR2(10)



i_acct_per_date

IN

DATE



o_return_status 

*procedure only

OUT

VARCHAR2

Possible values:

  • ‘TRUE’

  • ‘FALSE’ 

o_return_code

OUT

NUMBER

Possible values:

  • 0 – Success

  • -20001 – Handled Application Error

  • -20000 – Generic Error 

o_return_message

OUT

VARCHAR2

Insert ‘Successful’ or ‘Failure’ or error message





validation_api.IS_VALID_CC_ACCT()

  • Function returns VARCHAR2 (‘TRUE’/’FALSE’) to indicate a successful/unsuccessful action.

  • Available as both a function and a procedure.



Parameter

In/Out

Type

Default Value

Parameter

In/Out

Type

Default Value

i_cc_num

IN

VARCHAR2(10) 



i_major_acct

IN

VARCHAR2(4) 



i_minor_acct

IN

VARCHAR2(4)



o_return_status

*procedure only

OUT

VARCHAR2

Possible values:

  • ‘TRUE’

  • ‘FALSE’

o_return_code

OUT

NUMBER

Possible values:

  • 0 – Success

  • -20001 – Handled Application Error

  • -20000 – Generic Error 

o_return_message

OUT

VARCHAR2

Insert ‘Successful’ or ‘Failure’ or error message 





validation_api.IS_VALID_CC_ACCT()

  • Function returns VARCHAR2 (‘TRUE’/’FALSE’) to indicate a successful/unsuccessful action.

  • Available as both a function and a procedure.



Parameter

In/Out

Type

Default Value

Parameter

In/Out

Type

Default Value

i_cc_num

IN

VARCHAR2(10) 



i_major_acct

IN

VARCHAR2(4) 



i_minor_acct

IN

VARCHAR2(4) 



i_org_id

IN

NUMBER(4)



o_return_status

 *procedure only

OUT

VARCHAR2

Possible values:

  • ‘TRUE’

  • ‘FALSE’ 

o_return_code

OUT

NUMBER

Possible values:

  • 0 – Success

  • -20001 – Handled Application Error

  • -20000 – Generic Error 

o_return_message

OUT

VARCHAR2

Insert ‘Successful’ or ‘Failure’ or error message





validation_api.IS_VALID_AFE_CC()

  • Function returns VARCHAR2 (‘TRUE’/’FALSE’) to indicate a successful/unsuccessful action.

  • Available as both a function and a procedure.



Parameter

In/Out

Type

Default Value

Parameter

In/Out

Type

Default Value

i_afe_num

IN

VARCHAR2(10)



i_cc_num

IN

VARCHAR2(10)



o_return_statu

*procedure only

OUT

VARCHAR2

Possible values:

  • ‘TRUE’

  • ‘FALSE’

o_return_code

OUT

NUMBER

Possible values:

  • 0 – Success

  • -20001 – Handled Application Error

  • -20000 – Generic Error

o_return_message

OUT

VARCHAR2

Insert ‘Successful’ or ‘Failure’ or error message





validation_api.IS_VALID_ORG()

  • Function returns VARCHAR2 (‘TRUE’/’FALSE’) to indicate a successful/unsuccessful action.

  • Available as both a function and a procedure.



Parameter

In/Out

Type

Default Value

Parameter

In/Out

Type

Default Value

i_org_id

IN

NUMBER(4)



o_return_status

*procedure only

OUT

VARCHAR2

Possible values:

  • ‘TRUE’

  • ‘FALSE’

o_return_code

OUT

NUMBER

Possible values:

  • 0 – Success

  • -20001 – Handled Application Error

  • -20000 – Generic Error

o_return_message

OUT

VARCHAR2

Insert ‘Successful’ or ‘Failure’ or error message





validation_api.DOES_CC_ALLOW_OTHER_ORGS()

  • Function returns VARCHAR2 (‘TRUE’/’FALSE’) to indicate a successful/unsuccessful action.

  • Available as both a function and a procedure.



Parameter

In/Out

Type

Default Value

Parameter

In/Out

Type

Default Value

i_cc_num

IN

VARCHAR2(10)



i_org_id

IN

NUMBER(4)



o_return_status



*procedure only

OUT

VARCHAR2

Possible values:

  • ‘TRUE’

  • ‘FALSE’

o_return_code

OUT

NUMBER

Possible values:

  • 0 – Success

  • -20001 – Handled Application Error

  • -20000 – Generic Error

o_return_message

OUT

VARCHAR2

Insert ‘Successful’ or ‘Failure’ or error message





validation_api.IS_VALID_GL_SUB_CODE()

  • Function returns VARCHAR2 (‘TRUE’/’FALSE’) to indicate a successful/unsuccessful action.

  • Available as both a function and a procedure.



Parameter

In/Out

Type

Default Value

Parameter

In/Out

Type

Default Value

i_gl_sub_code

IN

VARCHAR2(6)



o_return_status

*procedure only

OUT

VARCHAR2

Possible values:

  • ‘TRUE’

  • ‘FALSE’

o_return_code

OUT

NUMBER

Possible values:

  • 0 – Success

  • -20001 – Handled Application Error

  • -20000 – Generic Error

o_return_message

OUT

VARCHAR2

Insert ‘Successful’ or ‘Failure’ or error message





validation_api.IS_VALID_ACCT_GL_SUB_CODE()

  • Function returns VARCHAR2 (‘TRUE’/’FALSE’) to indicate a successful/unsuccessful action.

  • Available as both a function and a procedure.



Parameter

In/Out

Type

Default Value

Parameter

In/Out

Type

Default Value

i_gl_sub_code

IN

VARCHAR2(6)



I_major_acct

IN

VARCHAR2(4)



i_minor_acct

IN

VARCHAR2(4)



i_org_id

IN

NUMBER(4)



o_return_status

*procedure only

OUT

VARCHAR2

Possible values:

  • ‘TRUE’

  • ‘FALSE’

o_return_code

OUT

NUMBER

Possible values:

  • 0 – Success

  • -20001 – Handled Application Error

  • -20000 – Generic Error

o_return_message

OUT

VARCHAR2

Insert ‘Successful’ or ‘Failure’ or error message





validation_api.IS_VALID_CONTINUITY_CODE()

  • Function returns VARCHAR2 (‘TRUE’/’FALSE’) to indicate a successful/unsuccessful action.

  • Available as both a function and a procedure.



Parameter

In/Out

Type

Default Value

Parameter

In/Out

Type

Default Value

i_continuity_code

IN

VARCHAR2(4)



o_return_status

*procedure only

OUT

VARCHAR2

Possible values:

  • ‘TRUE’

  • ‘FALSE’

o_return_code

OUT

NUMBER

Possible values:

  • 0 – Success

  • -20001 – Handled Application Error

  • -20000 – Generic Error

o_return_message

OUT

VARCHAR2

Insert ‘Successful’ or ‘Failure’ or error message





validation_api.IS_VALID_CONTINUITY_CODE()

  • Function returns VARCHAR2 (‘TRUE’/’FALSE’) to indicate a successful/unsuccessful action.

  • Available as both a function and a procedure.



Parameter

In/Out

Type

Default Value

Parameter

In/Out

Type

Default Value

i_continuity_code

IN

VARCHAR2(4)



i_major_acct

IN

VARCHAR2(4)



i_minor_acct

IN

VARCHAR2(4)



i_org_id

IN

NUMBER(4)



o_return_status

*procedure only

OUT

VARCHAR2

Possible values:

  • ‘TRUE’

  • ‘FALSE’

o_return_code

OUT

NUMBER

Possible values:

  • 0 – Success

  • -20001 – Handled Application Error

  • -20000 – Generic Error

o_return_message

OUT

VARCHAR2

Insert ‘Successful’ or ‘Failure’ or error message





validation_api.IS_VALID_MAJOR_ACCT()

  • Function returns VARCHAR2 (‘TRUE’/’FALSE’) to indicate a successful/unsuccessful action.

  • Available as both a function and a procedure.



Parameter

In/Out

Type

Default Value

Parameter

In/Out

Type

Default Value

i_major_acct

IN

VARCHAR2(4)



o_return_status

*procedure only

OUT

VARCHAR2

Possible values:

  • ‘TRUE’

  • ‘FALSE’

o_return_code

OUT

NUMBER

Possible values:

  • 0 – Success

  • -20001 – Handled Application Error

  • -20000 – Generic Error

o_return_message

OUT

VARCHAR2

Insert ‘Successful’ or ‘Failure’ or error message





validation_api.IS_VALID_ACCOUNT()

  • Function returns VARCHAR2 (‘TRUE’/’FALSE’) to indicate a successful/unsuccessful action.

  • Available as both a function and a procedure.



Parameter

In/Out

Type

Default Value

Parameter

In/Out

Type

Default Value

i_major_acct

IN

VARCHAR2(4) 



i_minor_acct

IN

VARCHAR2(4)



o_return_status

 *procedure only

OUT

VARCHAR2

Possible values:

  • ‘TRUE’

  • ‘FALSE’ 

o_return_code

OUT

NUMBER

Possible values:

  • 0 – Success

  • -20001 – Handled Application Error

  • -20000 – Generic Error 

o_return_message

OUT

VARCHAR2

Insert ‘Successful’ or ‘Failure’ or error message





validation_api.IS_VALID_ACCOUNT()

  • Function returns VARCHAR2 (‘TRUE’/’FALSE’) to indicate a successful/unsuccessful action.

  • Available as both a function and a procedure.



Parameter

In/Out

Type

Default Value

Parameter

In/Out

Type

Default Value

i_major_acct

IN

VARCHAR2(4) 



i_minor_acct

IN

VARCHAR2(4) 



i_org_id

IN

NUMBER(4)



o_return_status 

*procedure only

OUT

VARCHAR2

Possible values:

  • ‘TRUE’

  • ‘FALSE’

o_return_code

OUT

NUMBER

Possible values:

  • 0 – Success

  • -20001 – Handled Application Error

  • -20000 – Generic Error 

o_return_message

OUT

VARCHAR2

Insert ‘Successful’ or ‘Failure’ or error message 





validation_api.IS_VALID_ACCOUNT()

  • Function returns VARCHAR2 (‘TRUE’/’FALSE’) to indicate a successful/unsuccessful action.

  • Available as both a function and a procedure.



Parameter

In/Out

Type

Default Value

Parameter

In/Out

Type

Default Value

i_major_acct

IN

VARCHAR2(4)



i_minor_acct

IN

VARCHAR2(4)



i_org_id

IN

NUMBER(4)



o_return_status

*procedure only

OUT

VARCHAR2

Possible values:

  • ‘TRUE’

  • ‘FALSE’

o_return_code

OUT

NUMBER

Possible values:

  • 0 – Success

  • -20001 – Handled Application Error

  • -20000 – Generic Error 

o_return_message

OUT

VARCHAR2

Insert ‘Successful’ or ‘Failure’ or error message 





validation_api.IS_VALID_ACCOUNT()

  • Function returns VARCHAR2 (‘TRUE’/’FALSE’) to indicate a successful/unsuccessful action.

  • Available as both a function and a procedure.



Parameter

In/Out

Type

Default Value

Parameter

In/Out

Type

Default Value

i_major_acct

IN

VARCHAR2(4)



i_minor_acct

IN

VARCHAR2(4)



i_org_id

IN

NUMBER(4)



i_acct_per_date

IN

DATE



o_return_status

*procedure only

OUT

VARCHAR2

Possible values:

  • ‘TRUE’

  • ‘FALSE’

o_return_code

OUT

NUMBER

Possible values:

  • 0 – Success

  • -20001 – Handled Application Error

  • -20000 – Generic Error

o_return_message

OUT

VARCHAR2

Insert ‘Successful’ or ‘Failure’ or error message





validation_api.IS_VALID_CC_TYPE_ORG_ACCT()

  • Function returns VARCHAR2 (‘TRUE’/’FALSE’) to indicate a successful/unsuccessful action.

  • Available as both a function and a procedure. 



Parameter

In/Out

Type

Default Value

Parameter

In/Out

Type

Default Value

i_cc_num

IN

VARCHAR2(10)



i_major_acct

IN

VARCHAR2(4)



i_minor_acct

IN

VARCHAR2(4)



i_org_id

IN

NUMBER(4)



o_return_status

*procedure only

OUT

VARCHAR2

Possible values:

  • ‘TRUE’

  • ‘FALSE’

o_return_code

OUT

NUMBER

Possible values:

  • 0 – Success

  • -20001 – Handled Application Error

  • -20000 – Generic Error

o_return_message

OUT

VARCHAR2

Insert ‘Successful’ or ‘Failure’ or error message





validation_api.IS_VALID_AFE_CC_DOI_LINK()

  • Function returns VARCHAR2 (‘TRUE’/’FALSE’) to indicate a successful/unsuccessful action.

  • Available as both a function and a procedure.



Parameter

In/Out

Type

Default Value

Parameter

In/Out

Type

Default Value

i_doi_id

IN

NUMBER(10)



i_afe_num

IN

VARCHAR2(10)



i_cc_num

IN

VARCHAR2(10)



o_return_status

*procedure only

OUT

VARCHAR2

Possible values:

  • ‘TRUE’

  • ‘FALSE’

o_return_code

OUT

NUMBER

Possible values:

  • 0 – Success

  • -20001 – Handled Application Error

  • -20000 – Generic Error

o_return_message

OUT

VARCHAR2

Insert ‘Successful’ or ‘Failure’ or error message





validation_api.IS_VALID_ACCOUNTING_PERIOD()

  • Function returns VARCHAR2 (‘TRUE’/’FALSE’) to indicate a successful/unsuccessful action.

  • Available as both a function and a procedure.



Parameter

In/Out

Type

Default Value

Parameter

In/Out

Type

Default Value

i_org_id

IN

NUMBER(4)



i_acct_per_date

IN

DATE



o_return_status

*procedure only

OUT

VARCHAR2

Possible values:

  • ‘TRUE’

  • ‘FALSE’ 

o_return_code

OUT

NUMBER

Possible values:

  • 0 – Success

  • -20001 – Handled Application Error

  • -20000 – Generic Error 

o_return_message

OUT

VARCHAR2

Insert ‘Successful’ or ‘Failure’ or error message





validation_api.IS_VALID_ACCT_ACTIVITY_DATE()

  • Function returns VARCHAR2 (‘TRUE’/’FALSE’) to indicate a successful/unsuccessful action.

  • Available as both a function and a procedure.



Parameter

In/Out

Type

Default Value

Parameter

In/Out

Type

Default Value

i_actvy_per_date

IN

DATE



i_major_acct

IN

VARCHAR2(4)



i_minor_acct

IN

VARCHAR2(4)



o_return_status

*procedure only

OUT

VARCHAR2

Possible values:

  • ‘TRUE’

  • ‘FALSE’

o_return_code

OUT

NUMBER

Possible values:

  • 0 – Success

  • -20001 – Handled Application Error

  • -20000 – Generic Error

o_return_message

OUT

VARCHAR2

Insert ‘Successful’ or ‘Failure’ or error message





validation_api.IS_VALID_ACCT_ACTIVITY_DATE()

  • Function returns VARCHAR2 (‘TRUE’/’FALSE’) to indicate a successful/unsuccessful action.

  • Available as both a function and a procedure.



Parameter

In/Out

Type

Default Value

Parameter

In/Out

Type

Default Value

i_actvy_per_date

IN

DATE



i_major_acct

IN

VARCHAR2(4)



i_minor_acct

IN

VARCHAR2(4)



i_org_id

IN

NUMBER(4)



o_return_status

*procedure only

OUT

VARCHAR2

Possible values:

  • ‘TRUE’

  • ‘FALSE’

o_return_code

OUT

NUMBER

Possible values:

  • 0 – Success

  • -20001 – Handled Application Error

  • -20000 – Generic Error

o_return_message

OUT

VARCHAR2

Insert ‘Successful’ or ‘Failure’ or error message





validation_api.IS_VALID_ADDRESS()

  • Function returns VARCHAR2 (‘TRUE’/’FALSE’) to indicate a successful/unsuccessful action.

  • Available as both a function and a procedure.

  • Validates an address and BA combination against FA_BA_ADDRESS_PROPERTIES and BA_ADDRESSES.



Parameter

In/Out

Type

Default Value

Parameter

In/Out

Type

Default Value

i_address_id

IN

NUMBER(10)



i_ba_id

IN

NUMBER(10) 



o_return_status



*procedure only

OUT

VARCHAR2

Possible values:

  • ‘TRUE’

  • ‘FALSE’ 

o_return_code

OUT

NUMBER

Possible values:

  • 0 – Success

  • -20001 – Handled Application Error

  • -20000 – Generic Error 

o_return_message

OUT

VARCHAR2

Insert ‘Successful’ or ‘Failure’ or error message 





validation_api.IS_VALID_ADDRESS()

  • Function returns VARCHAR2 (‘TRUE’/’FALSE’) to indicate a successful/unsuccessful action.

  • Available as both a function and a procedure.

  • Validates an address and BA combination against FA_BA_ADDRESS_PROPERTIES and BA_ADDRESSES.



Parameter

In/Out

Type

Default Value

Parameter

In/Out

Type

Default Value

i_address_id

IN

NUMBER(10) 



i_ba_id

IN

NUMBER(10) 



i_acct_per_date

IN

DATE



o_return_status

*procedure only

OUT

VARCHAR2

Possible values:

  • ‘TRUE’

  • ‘FALSE’

o_return_code

OUT

NUMBER

Possible values:

  • 0 – Success

  • -20001 – Handled Application Error

  • -20000 – Generic Error

o_return_message

OUT

VARCHAR2

Insert ‘Successful’ or ‘Failure’ or error message





validation_api.IS_VALID_BA()

  • Function returns VARCHAR2 (‘TRUE’/’FALSE’) to indicate a successful/unsuccessful action.

  • Available as both a function and a procedure.

  • Validates BA against  BUSINESS_ASSOCIATES and FA_BA_PROPERTIES.

  • Checks BUSINESS_ASSOCIATES.INACTIVE_DATE.





Parameter

In/Out

Type

Default Value

Parameter

In/Out

Type

Default Value

i_ba_id

IN

NUMBER(10) 



i_acct_per_date

IN

DATE



o_return_status

*procedure only

OUT

VARCHAR2

Possible values:

  • ‘TRUE’

  • ‘FALSE’

o_return_code

OUT

NUMBER

Possible values:

  • 0 – Success

  • -20001 – Handled Application Error

  • -20000 – Generic Error

o_return_message

OUT

VARCHAR2

Insert ‘Successful’ or ‘Failure’ or error message





validation_api.IS_VALID_BA()

  • Function returns VARCHAR2 (‘TRUE’/’FALSE’) to indicate a successful/unsuccessful action.

  • Available as both a function and a procedure.

  • Validates BA against BUSINESS_ASSOCIATES.



Parameter

In/Out

Type

Default Value

Parameter

In/Out

Type

Default Value

i_ba_id

IN

NUMBER(10)



o_return_status

*procedure only

OUT

VARCHAR2

Possible values:

  • ‘TRUE’

  • ‘FALSE’

o_return_code

OUT

NUMBER

Possible values:

  • 0 – Success

  • -20001 – Handled Application Error

  • -20000 – Generic Error

o_return_message

OUT

VARCHAR2

Insert ‘Successful’ or ‘Failure’ or error message





validation_api.IS_VALID_CODE()

  • Function returns VARCHAR2 (‘TRUE’/’FALSE’) to indicate a successful/unsuccessful action.

  • Available as both a function and a procedure.



Parameter

In/Out

Type

Default Value

Parameter

In/Out

Type

Default Value

i_code_type_code

IN

VARCHAR2(20)



i_code

IN

VARCHAR2(6)



o_return_status

*procedure only

OUT

VARCHAR2

Possible values:

  • ‘TRUE’

  • ‘FALSE’

o_return_code

OUT

NUMBER

Possible values:

  • 0 – Success

  • -20001 – Handled Application Error

  • -20000 – Generic Error

o_return_message

OUT

VARCHAR2

Insert ‘Successful’ or ‘Failure’ or error message





validation_api.IS_VALID_DATE()

  • Function returns VARCHAR2 (‘TRUE’/’FALSE’) to indicate a successful/unsuccessful action.

  • Available as both a function and a procedure.

  • Validates if specified date string matches the specified format.



Parameter

In/Out

Type

Default Value

Parameter

In/Out

Type

Default Value

i_format

IN

VARCHAR2



i_date

IN

VARCHAR2



o_return_status



*procedure only

OUT

VARCHAR2

Possible values:

  • ‘TRUE’

  • ‘FALSE’

o_return_code

OUT

NUMBER

Possible values:

  • 0 – Success

  • -20001 – Handled Application Error

  • -20000 – Generic Error

o_return_message

OUT

VARCHAR2

Insert ‘Successful’ or ‘Failure’ or error message





validation_api.IS_VALID_DOI_DECK()

  • Function returns VARCHAR2 (‘TRUE’/’FALSE’) to indicate a successful/unsuccessful action.

  • Available as both a function and a procedure.



Parameter

In/Out

Type

Default Value

Parameter

In/Out

Type

Default Value

i_deck_id

IN

NUMBER(10)



o_return_status



*procedure only

OUT

VARCHAR2

Possible values:

  • ‘TRUE’

  • ‘FALSE’

o_return_code

OUT

NUMBER

Possible values:

  • 0 – Success

  • -20001 – Handled Application Error

  • -20000 – Generic Error

o_return_message

OUT

VARCHAR2

Insert ‘Successful’ or ‘Failure’ or error message





validation_api.IS_VALID_CURRENCY()

  • Function returns VARCHAR2 (‘TRUE’/’FALSE’) to indicate a successful/unsuccessful action.

  • Available as both a function and a procedure.



Parameter

In/Out

Type

Default Value

Parameter

In/Out

Type

Default Value

i_code

IN

VARCHAR2(6)





o_return_status

*procedure only

OUT

VARCHAR2

Possible values:

  • ‘TRUE’

  • ‘FALSE’

o_return_code

OUT

NUMBER

Possible values:

  • 0 – Success

  • -20001 – Handled Application Error

  • -20000 – Generic Error

o_return_message

OUT

VARCHAR2

Insert ‘Successful’ or ‘Failure’ or error message





validation_api.IS_VALID_DEST_ORG()

  • Function returns VARCHAR2 (‘TRUE’/’FALSE’) to indicate a successful/unsuccessful action.

  • Available as both a function and a procedure.



Parameter

In/Out

Type

Default Value

Parameter

In/Out

Type

Default Value

i_org_id

IN

NUMBER(4) 



i_dest_org_id

IN

NUMBER(4)



o_return_status



*procedure only

OUT

VARCHAR2

Possible values:

  • ‘TRUE’

  • ‘FALSE’ 

o_return_code

OUT

NUMBER

Possible values:

  • 0 – Success

  • -20001 – Handled Application Error

  • -20000 – Generic Error 

o_return_message

OUT

VARCHAR2

Insert ‘Successful’ or ‘Failure’ or error message





validation_api.IS_VALID_SOURCE_CODE()

  • Function returns VARCHAR2 (‘TRUE’/’FALSE’) to indicate a successful/unsuccessful action.

  • Available as both a function and a procedure.



Parameter

In/Out

Type

Default Value

Parameter

In/Out

Type

Default Value

i_src_code

IN

VARCHAR2(6)



o_return_status

*procedure only

OUT

VARCHAR2

Possible values:

  • ‘TRUE’

  • ‘FALSE’

o_return_code

OUT

NUMBER

Possible values:

  • 0 – Success

  • -20001 – Handled Application Error

  • -20000 – Generic Error

o_return_message

OUT

VARCHAR2

Insert ‘Successful’ or ‘Failure’ or error message





validation_api.IS_VALID_ACCT_LI_VOL()

  • Function returns VARCHAR2 (‘TRUE’/’FALSE’) to indicate a successful/unsuccessful action.

  • Available as both a function and a procedure.



Parameter

In/Out

Type

Default Value

Parameter

In/Out

Type

Default Value

i_major_acct

IN

VARCHAR2(4)



i_minor_acct

IN

VARCHAR2(4)



i_li_vol

IN

NUMBER(12,2)



o_return_status

*procedure only

OUT

VARCHAR2

Possible values:

  • ‘TRUE’

  • ‘FALSE’

o_return_code

OUT

NUMBER

Possible values:

  • 0 – Success

  • -20001 – Handled Application Error

  • -20000 – Generic Error

o_return_message

OUT

VARCHAR2

Insert ‘Successful’ or ‘Failure’ or error message





validation_api.IS_VALID_ACCT_LI_VOL()

  • Function returns VARCHAR2 (‘TRUE’/’FALSE’) to indicate a successful/unsuccessful action.

  • Available as both a function and a procedure.



Parameter

In/Out

Type

Default Value

Parameter

In/Out

Type

Default Value

i_major_acct

IN

VARCHAR2(4)



i_minor_acct

IN

VARCHAR2(4)



i_li_vol

IN

NUMBER(12,2)



i_org_id

IN

NUMBER(4)



o_return_status



*procedure only

OUT

VARCHAR2

Possible values:

  • ‘TRUE’

  • ‘FALSE’

o_return_code

OUT

NUMBER

Possible values:

  • 0 – Success

  • -20001 – Handled Application Error

  • -20000 – Generic Error

o_return_message

OUT

VARCHAR2

Insert ‘Successful’ or ‘Failure’ or error message





validation_api.IS_VALID_ACCT_LI_VOL()

  • Function returns VARCHAR2 (‘TRUE’/’FALSE’) to indicate a successful/unsuccessful action.

  • Available as both a function and a procedure.



Parameter

In/Out

Type

Default Value

Parameter

In/Out

Type

Default Value

i_major_acct

IN

VARCHAR2(4) 



i_minor_acct

IN

VARCHAR2(4) 



i_li_vol

IN

NUMBER(12,2) 



i_org_id

IN

NUMBER(4)



I_li_as_entered_vol

IN

NUMBER(12,2)



o_return_status

*procedure only

OUT

VARCHAR2

Possible values:

  • ‘TRUE’

  • ‘FALSE’

o_return_code

OUT

NUMBER

Possible values:

  • 0 – Success

  • -20001 – Handled Application Error

  • -20000 – Generic Error

o_return_message

OUT

VARCHAR2

Insert ‘Successful’ or ‘Failure’ or error message





validation_api.IS_VALID_VOUCHER_TYPE()

  • Function returns VARCHAR2 (‘TRUE’/’FALSE’) to indicate a successful/unsuccessful action.

  • Available as both a function and a procedure.



Parameter

In/Out

Type

Default Value

Parameter

In/Out

Type

Default Value

i_voucher_type

IN

VARCHAR2(6)



o_return_status 

*procedure only

OUT

VARCHAR2

Possible values:

  • ‘TRUE’

  • ‘FALSE’

o_return_code

OUT

NUMBER

Possible values:

  • 0 – Success

  • -20001 – Handled Application Error

  • -20000 – Generic Error

o_return_message

OUT

VARCHAR2

Insert ‘Successful’ or ‘Failure’ or error message





validation_api.IS_VALID_BANK_ACCT()

  • Function returns VARCHAR2 (‘TRUE’/’FALSE’) to indicate a successful/unsuccessful action.

  • Available as both a function and a procedure.



Parameter

In/Out

Type

Default Value

Parameter

In/Out

Type

Default Value

i_bank_acct_id

IN

NUMBER(4)



o_return_status

*procedure only

OUT

VARCHAR2

Possible values:

  • ‘TRUE’

  • ‘FALSE’

o_return_code

OUT

NUMBER

Possible values:

  • 0 – Success

  • -20001 – Handled Application Error

  • -20000 – Generic Error

o_return_message

OUT

VARCHAR2

Insert ‘Successful’ or ‘Failure’ or error message





validation_api.IS_VALID_INVC_CONTROL_ACCT()

  • Function returns VARCHAR2 (‘TRUE’/’FALSE’) to indicate a successful/unsuccessful action.

  • Available as both a function and a procedure.



Parameter

In/Out

Type

Default Value

Parameter

In/Out

Type

Default Value

i_major_acct

IN

VARCHAR2(4) 



i_minor_acct

IN

VARCHAR2(4) 



i_invc_num

IN

VARCHAR2(20)



o_return_status

*procedure only

OUT

VARCHAR2

Possible values:

  • ‘TRUE’

  • ‘FALSE’

o_return_code

OUT

NUMBER

Possible values:

  • 0 – Success

  • -20001 – Handled Application Error

  • -20000 – Generic Error

o_return_message

OUT

VARCHAR2

Insert ‘Successful’ or ‘Failure’ or error message





validation_api.IS_VALID_INVC_CONTROL_ACCT()

  • Function returns VARCHAR2 (‘TRUE’/’FALSE’) to indicate a successful/unsuccessful action.

  • Available as both a function and a procedure.



Parameter

In/Out

Type

Default Value

Parameter

In/Out

Type

Default Value

i_major_acct

IN

VARCHAR2(4) 



i_minor_acct

IN

VARCHAR2(4) 



i_invc_num

IN

VARCHAR2(20) 



i_org_id

IN

NUMBER(4)



o_return_status

*procedure only

OUT

VARCHAR2

Possible values:

  • ‘TRUE’

  • ‘FALSE’ 

o_return_code

OUT

NUMBER

Possible values:

  • 0 – Success

  • -20001 – Handled Application Error

  • -20000 – Generic Error 

o_return_message

OUT

VARCHAR2

Insert ‘Successful’ or ‘Failure’ or error message



 

validation_api.IS_VALID_PURCHASE_ORDER()

  • Function returns VARCHAR2 (‘TRUE’/’FALSE’) to indicate a successful/unsuccessful action.

  • Available as both a function and a procedure.



Parameter

In/Out

Type

Default Value

Parameter

In/Out

Type

Default Value

i_po_num

IN

VARCHAR2(20)



o_return_status

*procedure only

OUT

VARCHAR2

Possible values:

  • ‘TRUE’

  • ‘FALSE’

o_return_code

OUT

NUMBER

Possible values:

  • 0 – Success

  • -20001 – Handled Application Error

  • -20000 – Generic Error

o_return_message

OUT

VARCHAR2

Insert ‘Successful’ or ‘Failure’ or error message





validation_api.IS_TEMP_INT_DATA_BALANCED()

  • Function returns VARCHAR2 (‘TRUE’/’FALSE’) to indicate a successful/unsuccessful action.

  • Available as both a function and a procedure.



Parameter

In/Out

Type

Default Value

Parameter

In/Out

Type

Default Value

i_report_id

IN

NUMBER(10)



i_voucher_num

IN

NUMBER(5)



o_return_status

*procedure only

OUT

VARCHAR2

Possible values:

  • ‘TRUE’

  • ‘FALSE’

o_return_code

OUT

NUMBER

Possible values:

  • 0 – Success

  • -20001 – Handled Application Error

  • -20000 – Generic Error

o_return_message

OUT

VARCHAR2

Insert ‘Successful’ or ‘Failure’ or error message





validation_api.IS_VALID_PAY_STAT_CODE()

  • Function returns VARCHAR2 (‘TRUE’/’FALSE’) to indicate a successful/unsuccessful action.

  • Available as both a function and a procedure.



Parameter

In/Out

Type

Default Value

Parameter

In/Out

Type

Default Value

i_pay_stat_code

IN

VARCHAR2(1)



o_return_status



*procedure only

OUT

VARCHAR2

Possible values:

  • ‘TRUE’

  • ‘FALSE’

o_return_code

OUT

NUMBER

Possible values:

  • 0 – Success

  • -20001 – Handled Application Error

  • -20000 – Generic Error

o_return_message

OUT

VARCHAR2

Insert ‘Successful’ or ‘Failure’ or error message





validation_api.IS_VALID_PRIORITY_CODE()

  • Function returns VARCHAR2 (‘TRUE’/’FALSE’) to indicate a successful/unsuccessful action.

  • Available as both a function and a procedure.



Parameter

In/Out

Type

Default Value

Parameter

In/Out

Type

Default Value

i_priority_code

IN

VARCHAR2(1)





o_return_status

*procedure only

OUT

VARCHAR2

Possible values:

  • ‘TRUE’

  • ‘FALSE’

o_return_code

OUT

NUMBER

Possible values:

  • 0 – Success

  • -20001 – Handled Application Error

  • -20000 – Generic Error

o_return_message

OUT

VARCHAR2

Insert ‘Successful’ or ‘Failure’ or error message





validation_api.IS_VALID_INVC_TYPE_CODE()

  • Function returns VARCHAR2 (‘TRUE’/’FALSE’) to indicate a successful/unsuccessful action.

  • Available as both a function and a procedure.



Parameter

In/Out

Type

Default Value

Parameter

In/Out

Type

Default Value

i_invc_type_code

IN

NUMBER(10) 



i_payable_or_receivable_code

IN

VARCHAR2(1) 



i_major_acct

IN

VARCHAR2(4) 



i_minor_acct

IN

VARCHAR2(4)



o_return_status



*procedure only

OUT

VARCHAR2

Possible values:

  • ‘TRUE’

  • ‘FALSE’

o_return_code

OUT

NUMBER

Possible values:

  • 0 – Success

  • -20001 – Handled Application Error

  • -20000 – Generic Error

o_return_message

OUT

VARCHAR2

Insert ‘Successful’ or ‘Failure’ or error message





validation_api.IS_VALID_AGR_TYPE_CODE()

  • Function returns VARCHAR2 (‘TRUE’/’FALSE’) to indicate a successful/unsuccessful action.

  • Available as both a function and a procedure.



Parameter

In/Out

Type

Default Value

Parameter

In/Out

Type

Default Value

i_agr_type_code

IN

VARCHAR2(2)



o_return_status



*procedure only

OUT

VARCHAR2

Possible values:

  • ‘TRUE’

  • ‘FALSE’

o_return_code

OUT

NUMBER

Possible values:

  • 0 – Success

  • -20001 – Handled Application Error

  • -20000 – Generic Error

o_return_message

OUT

VARCHAR2

Insert ‘Successful’ or ‘Failure’ or error message





validation_api.IS_VALID_ET_ID()

  • Function returns VARCHAR2 (‘TRUE’/’FALSE’) to indicate a successful/unsuccessful action.

  • Available as both a function and a procedure.



Parameter

In/Out

Type

Default Value

Parameter

In/Out

Type

Default Value

i_et_id

IN

NUMBER(10)



o_return_status

*procedure only

OUT

VARCHAR2

Possible values:

  • ‘TRUE’

  • ‘FALSE’

o_return_code

OUT

NUMBER

Possible values:

  • 0 – Success

  • -20001 – Handled Application Error

  • -20000 – Generic Error

o_return_message

OUT

VARCHAR2

Insert ‘Successful’ or ‘Failure’ or error message





validation_api.IS_VALID_MISC_INCOME_CAT()

  • Function returns VARCHAR2 (‘TRUE’/’FALSE’) to indicate a successful/unsuccessful action.

  • Available as both a function and a procedure.



Parameter

In/Out

Type

Default Value

Parameter

In/Out

Type

Default Value

i_misc_income_category

IN

VARCHAR2(30)



o_return_status



*procedure only

OUT

VARCHAR2

Possible values:

  • ‘TRUE’

  • ‘FALSE’

o_return_code

OUT

NUMBER

Possible values:

  • 0 – Success

  • -20001 – Handled Application Error

  • -20000 – Generic Error

o_return_message

OUT

VARCHAR2

Insert ‘Successful’ or ‘Failure’ or error message





validation_api.IS_VALID_BANK_DEPOSIT_NUM()

  • Function returns VARCHAR2 (‘TRUE’/’FALSE’) to indicate a successful/unsuccessful action.

  • Available as both a function and a procedure.



Parameter

In/Out

Type

Default Value

Parameter

In/Out

Type

Default Value

i_deposit_num

IN

NUMBER(10)



o_return_status

*procedure only

OUT

VARCHAR2

Possible values:

  • ‘TRUE’

  • ‘FALSE’

o_return_code

OUT

NUMBER

Possible values:

  • 0 – Success

  • -20001 – Handled Application Error

  • -20000 – Generic Error

o_return_message

OUT

VARCHAR2

Insert ‘Successful’ or ‘Failure’ or error message





validation_api.IS_VALID_CASH_ACCOUNT()

  • Function returns VARCHAR2 (‘TRUE’/’FALSE’) to indicate a successful/unsuccessful action.

  • Available as both a function and a procedure.



Parameter

In/Out

Type

Default Value

Parameter

In/Out

Type

Default Value

i_major_acct

IN

VARCHAR2(4)



I_minor_acct

IN

VARCHAR2(4)



o_return_status

*procedure only

OUT

VARCHAR2

Possible values:

  • ‘TRUE’

  • ‘FALSE’

o_return_code

OUT

NUMBER

Possible values:

  • 0 – Success

  • -20001 – Handled Application Error

  • -20000 – Generic Error

o_return_message

OUT

VARCHAR2

Insert ‘Successful’ or ‘Failure’ or error message





validation_api.IS_VALID_BANK_CASH_ACCOUNT()

  • Function returns VARCHAR2 (‘TRUE’/’FALSE’) to indicate a successful/unsuccessful action.

  • Available as both a function and a procedure.



Parameter

In/Out

Type

Default Value

Parameter

In/Out

Type

Default Value

i_major_acct

IN

VARCHAR2(4)



I_minor_acct

IN

VARCHAR2(4)



i_bank_acct_id

IN

NUMBER(4)



o_return_status



*procedure only

OUT

VARCHAR2

Possible values:

  • ‘TRUE’

  • ‘FALSE’

o_return_code

OUT

NUMBER

Possible values:

  • 0 – Success

  • -20001 – Handled Application Error

  • -20000 – Generic Error

o_return_message

OUT

VARCHAR2

Insert ‘Successful’ or ‘Failure’ or error message





validation_api.IS_VALID_BANK_DEPOSIT()

  • Function returns VARCHAR2 (‘TRUE’/’FALSE’) to indicate a successful/unsuccessful action.

  • Available as a function. Available as a procedure validate_bank_deposit that combines this function with the function is_bank_deposit_locked.



Parameter

In/Out

Type

Default Value

Parameter

In/Out

Type

Default Value

i_deposit_num

IN

NUMBER(10)



i_bank_acct_id

IN

NUMBER(4)



i_cash_tx_date

IN

DATE



o_return_code

OUT

NUMBER

Possible values:

  • 0 – Success

  • -20001 – Handled Application Error

  • -20000 – Generic Error

o_return_message

OUT

VARCHAR2

Insert ‘Successful’ or ‘Failure’ or error message





validation_api.IS_BANK_DEPOSIT_LOCKED()

  • Function returns VARCHAR2 (‘TRUE’/’FALSE’) to indicate a successful/unsuccessful action.

  • Available as a function. Available as a procedure validate_bank_deposit that combines this function with the function is_bank_deposit_locked.



Parameter

In/Out

Type

Default Value

Parameter

In/Out

Type

Default Value

i_deposit_num

IN

NUMBER(10)



o_return_code

OUT

NUMBER

Possible values:

  • 0 – Success

  • -20001 – Handled Application Error

  • -20000 – Generic Error

o_return_message

OUT

VARCHAR2

Insert ‘Successful’ or ‘Failure’ or error message





validation_api.VALIDATE_BANK_DEPOSIT()

  • Procedure returns VARCHAR2 (‘TRUE’/’FALSE’) to indicate a successful/unsuccessful action.

  • Available only as a procedure that combines function is_valid_bank_deposit with is_bank_deposit_locked.



Parameter

In/Out

Type

Default Value

Parameter

In/Out

Type

Default Value

i_deposit_num

IN

NUMBER(10)



i_bank_acct_id

IN

NUMBER(4)



i_cash_tx_date

IN

DATE



o_return_status





OUT

VARCHAR2

Possible values:

  • ‘TRUE’

  • ‘FALSE’

o_return_code

OUT

NUMBER

Possible values:

  • 0 – Success

  • -20001 – Handled Application Error

  • -20000 – Generic Error

o_return_message

OUT

VARCHAR2

Insert ‘Successful’ or ‘Failure’ or error message





validation_api.GET_BANK_DEPOSIT_CASH_TX_ID()

  • Function returns VARCHAR2 (‘TRUE’/’FALSE’) to indicate a successful/unsuccessful action.

  • Available as both a function and a procedure



Parameter

In/Out

Type

Default Value

Parameter

In/Out

Type

Default Value

i_deposit_num

IN

NUMBER(10)



i_cash_tx_amt

IN

NUMBER(14,2)



i_ba_id

IN

NUMBER(6)



i_client_issued_date

IN

DATE



i_client_issued_num

IN

VARCHAR2(10)



o_cash_tx_id

OUT

NUMBER



o_return_status

*procedure only

OUT

VARCHAR2

Possible values:

  • ‘TRUE’

  • ‘FALSE’

o_return_code

OUT

NUMBER

Possible values:

  • 0 – Success

  • -20001 – Handled Application Error

  • -20000 – Generic Error

o_return_message

OUT

VARCHAR2

Insert ‘Successful’ or ‘Failure’ or error message





Special Considerations

  • Individual edits can be used as required. 

  • Edits such as IS_VALID_VOUCHER() and IS_VALID_LINE_ITEM() contain a number of edits bundled together to validate a voucher and/or a line item data and would be useful as pre-edits when importing voucher data into the Qbyte Financial application.







Related content

Copyright© 2024 IFS AB. Copying prohibited. All rights reserved.