Package BANINST1.fb_encumbrance

Package BANINST1.fb_encumbrance_detail

Common Business interface for the General Encumbrance Detail API (ENCUMBRANCE_DETAIL).

Each record is identified by document number, item number, and sequence number combination.
Fiscal Year and Period are derived from the Transaction Date.
Based on the Status Indicator entered, some validations are bypassed in p_create and p_update so that a record in progress may be saved if it is known to have errors or insufficient funds (see details in parameter documentation below). Full validation must be completed before a General Encumbrance can be Completed and Posted.
Other optional parameters may also have editing to enforce common Banner Finance business rules.

If rule class security is enabled, authority to create or update a General Encumbrance sequence is governed by the context under which the API is called. The default is FGAENCB.

Context Name	Context Value	Purpose
CURR_FORM	Form name	The current form name is used in validating rule class security, to ensure that the user is authorized to access the rule group from the calling form.

Program units

f_api_version	Returns the API version number.
f_entity_to_row	Accept encumbrance_detail_rec and return fgbencd rowtype.
f_exists	Checks if a record exists.
f_exists_item	Checks if a specific item number exists at least once.
f_get_int_constant	Returns the value of an integer constant.
f_get_max_seq	Returns last sequence number used.
f_isequal	Compares two records for equality.
f_net_trans_amt	Calculates net total of all encumbrance detail sequences.
f_query_all	Selects all records for the entity.
f_query_one	Selects one record using key.
f_query_by_rowid	Selects one record using ROWID.
f_query_one_lock	Selects one record and locks it.
f_valid_distribution	Validates that all records have a distribution percent.
p_create	Creates a record.
p_delete	Deletes a record.
p_delete_all	Deletes all records for a document.
p_lock	Locks a record.
p_update	Updates a record.
p_update_internal	Internal updates.

Types

encumbrance_detail_rec	Business Entity record type
encumbrance_detail_ref	Entity cursor variable type
encumbrance_detail_tab	Entity table type

Constants

M_ENTITY_NAME	Business Entity Name
M_BASE_TABLE_NAME	Base table name
DIST_PCT_DECIMALS	The number of decimal places for the Distribution Percent.
DIST_PCT_INTEGERS	The number of places to the left of the decimal point for the Distribution Percent.
TRANS_AMT_INTEGERS	The number of places to the left of the decimal point for the Transaction Amount.
TRANS_AMT_DECIMALS	The number of decimal places for the Transaction Amount.

M_ENTITY_NAME

M_ENTITY_NAME        CONSTANT VARCHAR2(18) := 'ENCUMBRANCE_DETAIL';

Business Entity Name

M_BASE_TABLE_NAME

M_BASE_TABLE_NAME    CONSTANT VARCHAR2(7) := 'FGBENCD';

Base table name

DIST_PCT_DECIMALS

DIST_PCT_DECIMALS       CONSTANT INTEGER :=  3 ;

The number of decimal places for the Distribution Percent.

DIST_PCT_INTEGERS

DIST_PCT_INTEGERS       CONSTANT INTEGER :=  3 ;

The number of places to the left of the decimal point for the Distribution Percent.

TRANS_AMT_INTEGERS

TRANS_AMT_INTEGERS      CONSTANT INTEGER := 15 ;

The number of places to the left of the decimal point for the Transaction Amount.

TRANS_AMT_DECIMALS

TRANS_AMT_DECIMALS      CONSTANT INTEGER :=  2 ;

The number of decimal places for the Transaction Amount.

encumbrance_detail_rec

TYPE encumbrance_detail_rec IS RECORD (
  r_num                     fgbencd.fgbencd_num%TYPE,
  r_item                    fgbencd.fgbencd_item%TYPE,
  r_seq_num                 fgbencd.fgbencd_seq_num%TYPE,
  r_user_id                 fgbencd.fgbencd_user_id%TYPE,
  r_rucl_code               fgbencd.fgbencd_rucl_code%TYPE,
  r_fsyr_code               fgbencd.fgbencd_fsyr_code%TYPE,
  r_coas_code               fgbencd.fgbencd_coas_code%TYPE,
  r_acci_code               fgbencd.fgbencd_acci_code%TYPE,
  r_fund_code               fgbencd.fgbencd_fund_code%TYPE,
  r_orgn_code               fgbencd.fgbencd_orgn_code%TYPE,
  r_acct_code               fgbencd.fgbencd_acct_code%TYPE,
  r_prog_code               fgbencd.fgbencd_prog_code%TYPE,
  r_actv_code               fgbencd.fgbencd_actv_code%TYPE,
  r_locn_code               fgbencd.fgbencd_locn_code%TYPE,
  r_posting_period          fgbencd.fgbencd_posting_period%TYPE,
  r_status_ind              fgbencd.fgbencd_status_ind%TYPE,
  r_prjd_code               fgbencd.fgbencd_prjd_code%TYPE,
  r_pend_amt                fgbencd.fgbencd_pend_amt%TYPE,
  r_dist_pct                fgbencd.fgbencd_dist_pct%TYPE,
  r_opal_field_code         fgbencd.fgbencd_opal_field_code%TYPE,
  r_status                  fgbencd.fgbencd_status%TYPE,
  r_abal_override           fgbencd.fgbencd_abal_override%TYPE,
  r_post_bavl               fgbencd.fgbencd_post_bavl%TYPE,
  r_appr_ind                fgbencd.fgbencd_appr_ind%TYPE,
  r_cmt_type                fgbencd.fgbencd_cmt_type%TYPE,
  r_cmt_pct                 fgbencd.fgbencd_cmt_pct%TYPE,
  r_create_date             fgbencd.fgbencd_create_date%TYPE,
  r_create_user             fgbencd.fgbencd_create_user%TYPE,
  r_data_origin             fgbencd.fgbencd_data_origin%TYPE,
  r_create_source           fgbencd.fgbencd_create_source%TYPE,
  r_internal_record_id      gb_common.internal_record_id_type);

Business Entity record type

encumbrance_detail_ref

TYPE encumbrance_detail_ref IS REF CURSOR RETURN encumbrance_detail_rec;

Entity cursor variable type

encumbrance_detail_tab

TYPE encumbrance_detail_tab IS TABLE OF encumbrance_detail_rec INDEX BY BINARY_INTEGER;

Entity table type

f_api_version

Function f_api_version RETURN PLS_INTEGER

Returns the API version number.

Returns

Version of the API signature. Changes only when the signature changes.

f_entity_to_row

Function f_entity_to_row(p_detail_rec encumbrance_detail_rec)
  RETURN fgbencd%ROWTYPE

Accept encumbrance_detail_rec and return fgbencd rowtype.

Returns

fgbencd rowtype

f_exists

Function f_exists(p_num     fgbencd.fgbencd_num%TYPE,
                  p_item    fgbencd.fgbencd_item%TYPE,
                  p_seq_num fgbencd.fgbencd_seq_num%TYPE,
                  p_rowid   gb_common.internal_record_id_type DEFAULT NULL)
  RETURN VARCHAR2

Checks if a record exists.

Parameters

	p_num	The unique identifier of an Encumbrance document. VARCHAR2(8) Required Key
	p_item	The reference number which associates an accounting record to a related item. NUMBER(4) Required Key
	p_seq_num	The system-generated unique number associated with the Item Number of the accounting record. NUMBER(4) Required Key
	p_rowid	Database ROWID of the record to be selected. VARCHAR2(18)

Returns

Y if found, otherwise N.

f_exists_item

Function f_exists_item(p_num  fgbencd.fgbencd_num%TYPE,
                       p_item fgbencd.fgbencd_item%TYPE) RETURN VARCHAR2

Checks if a specific item number exists at least once.

Parameters

	p_num	The unique identifier of an Encumbrance document. VARCHAR2(8) Required Key
	p_item	The reference number which associates an accounting record to a related item. NUMBER(4) Required Key

Returns

Y if found, otherwise N.

f_get_int_constant

Function f_get_int_constant(p_name_in VARCHAR2) RETURN INTEGER

Returns the value of an integer constant.

The value assigned to the constant named is returned, and used to obtain the size of the integer and decimal components of the General Encumbrance Detail Transaction Amount and Distribution Percent.

Parameters

p_name_in

The name of the Constant for which the current value is requested. VARCHAR2 Required

f_get_max_seq

Function f_get_max_seq(p_num  FGBENCD.FGBENCD_NUM%TYPE,
                       p_item FGBENCD.FGBENCD_ITEM%TYPE) RETURN NUMBER

Returns last sequence number used.

Parameters

	p_num	The unique identifier of an Encumbrance document. VARCHAR2(8) Required Key
	p_item	The reference number which associates an accounting record to a related item. NUMBER(4) Required Key

Returns

current highest value of sequence number

f_isequal

Function f_isequal(rec_one encumbrance_detail_rec,
                   rec_two encumbrance_detail_rec) RETURN VARCHAR2

Compares two records for equality.
Tests each field of rec_one against the corresponding field of rec_two. Two null values are considered equal.

Parameters

	rec_one	The first record to compare. Type encumbrance_detail_rec Required
	rec_two	The second record to compare. Type encumbrance_detail_rec Required

Returns

Y if all values in records are equal, otherwise N. Nulls match Nulls.

f_net_trans_amt

Function f_net_trans_amt(p_num fgbencd.fgbencd_num%TYPE) RETURN NUMBER

Calculates net total of all encumbrance detail sequences.

Parameters

p_num

The unique identifier of a General Encumbrance document. VARCHAR2(8) Required Key

Returns

Net total amount of all detail, or NULL if there are no detail records.

f_query_all

Function f_query_all(p_num     fgbencd.fgbencd_num%TYPE,
                     p_item    fgbencd.fgbencd_item%TYPE DEFAULT NULL,
                     p_seq_num fgbencd.fgbencd_seq_num%TYPE DEFAULT NULL)
  RETURN encumbrance_detail_ref

Selects all records for the entity.

Parameters

	p_num	The unique identifier of an Encumbrance document. VARCHAR2(8) Required Key
	p_item	The reference number which associates an accounting record to a related item. NUMBER(4)
	p_seq_num	The system-generated unique number associated with the Item Number of the accounting record. NUMBER(4)

Returns

A cursor variable that will fetch a set of records.

f_query_one

Function f_query_one(p_num     fgbencd.fgbencd_num%TYPE,
                     p_item    fgbencd.fgbencd_item%TYPE,
                     p_seq_num fgbencd.fgbencd_seq_num%TYPE)
  RETURN encumbrance_detail_ref

Selects one record using key.

Parameters

	p_num	The unique identifier of an Encumbrance document. VARCHAR2(8) Required Key
	p_item	The reference number which associates an accounting record to a related item. NUMBER(4) Required Key
	p_seq_num	The system-generated unique number associated with the Item Number of the accounting record. NUMBER(4) Required Key

Returns

A cursor variable that will fetch exactly one record.

f_query_by_rowid

Function f_query_by_rowid(p_rowid gb_common.internal_record_id_type)
  RETURN encumbrance_detail_ref

Selects one record using ROWID.

Parameters

p_rowid

Database ROWID of the record to be selected. VARCHAR2(18) Required

Returns

A cursor variable that will fetch exactly one record.

f_query_one_lock

Function f_query_one_lock(p_num     fgbencd.fgbencd_num%TYPE,
                          p_item    fgbencd.fgbencd_item%TYPE,
                          p_seq_num fgbencd.fgbencd_seq_num%TYPE,
                          p_rowid   gb_common.internal_record_id_type DEFAULT NULL)
  RETURN encumbrance_detail_ref

Selects one record and locks it.

Parameters

	p_num	The unique identifier of an Encumbrance document. VARCHAR2(8) Required Key
	p_item	The reference number which associates an accounting record to a related item. NUMBER(4) Required Key
	p_seq_num	The system-generated unique number associated with the Item Number of the accounting record. NUMBER(4) Required Key
	p_rowid	Database ROWID of the record to be selected. VARCHAR2(18)

Returns

A cursor variable for one record, locking the record.

f_valid_distribution

Function f_valid_distribution(p_num fgbencd.fgbencd_num%TYPE)
  RETURN VARCHAR2

Validates that all records have a distribution percent.

Parameters

p_num

The unique identifier of a general encumbrance document. VARCHAR2(8) Required Key

Returns

Indication that:

	Y	Detail records exist and all have a distribution percent.
	N	Detail records exist, but not all have a distribution percent.
	I	There are no detail records.

p_create

Procedure p_create(p_num               fgbencd.fgbencd_num%TYPE,
                   p_item              fgbencd.fgbencd_item%TYPE DEFAULT 0,
                   p_seq_num           fgbencd.fgbencd_seq_num%TYPE DEFAULT NULL,
                   p_user_id           fgbencd.fgbencd_user_id%TYPE DEFAULT gb_common.f_sct_user,
                   p_rucl_code         fgbencd.fgbencd_rucl_code%TYPE,
                   p_fsyr_code         fgbencd.fgbencd_fsyr_code%TYPE DEFAULT NULL,
                   p_coas_code         fgbencd.fgbencd_coas_code%TYPE,
                   p_acci_code         fgbencd.fgbencd_acci_code%TYPE DEFAULT NULL,
                   p_fund_code         fgbencd.fgbencd_fund_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_orgn_code         fgbencd.fgbencd_orgn_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_acct_code         fgbencd.fgbencd_acct_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_prog_code         fgbencd.fgbencd_prog_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_actv_code         fgbencd.fgbencd_actv_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_locn_code         fgbencd.fgbencd_locn_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_posting_period    fgbencd.fgbencd_posting_period%TYPE DEFAULT NULL,
                   p_status_ind_in_out IN OUT fgbencd.fgbencd_status_ind%TYPE,
                   p_prjd_code         fgbencd.fgbencd_prjd_code%TYPE DEFAULT NULL,
                   p_pend_amt          fgbencd.fgbencd_pend_amt%TYPE DEFAULT NULL,
                   p_dist_pct          fgbencd.fgbencd_dist_pct%TYPE DEFAULT NULL,
                   p_opal_field_code   fgbencd.fgbencd_opal_field_code%TYPE DEFAULT NULL,
                   p_status            fgbencd.fgbencd_status%TYPE DEFAULT 'O',
                   p_abal_override     fgbencd.fgbencd_abal_override%TYPE DEFAULT NULL,
                   p_appr_ind          fgbencd.fgbencd_appr_ind%TYPE DEFAULT NULL,
                   p_cmt_type          fgbencd.fgbencd_cmt_type%TYPE DEFAULT 'U',
                   p_cmt_pct           fgbencd.fgbencd_cmt_pct%TYPE DEFAULT NULL,
                   p_data_origin       fgbencd.fgbencd_data_origin%TYPE DEFAULT NULL,
                   p_warning_out       OUT gb_common_strings.err_type,
                   p_abal_severity_out OUT VARCHAR2,
                   p_rowid_out         OUT gb_common.internal_record_id_type)

Creates a record.

Document Number, Sequence Number, Rule Code, and Chart of Accounts are required.
Item Number will default to 0, and User ID to the log-on user. Item should be 0 for a General Encumbrance, although the Payroll and Travel modules may use other values.
If not specified, accounting elements may default from the Index code, Fund or Organization defaults, or user defined values in the Rule Class Edit table (FTVEDIT).
Amount is required except where it may be calculated using Distribution Percent.

Parameters

p_num

The unique identifier of an Encumbrance document. VARCHAR2(8) Required Key

p_item

The reference number which associates an accounting record to a related item. If 0, applies to all items (Document Level Accounting). If not 0, applies to the item of that number (Commodity Level Accounting). NUMBER(4)

p_seq_num

The system-generated or user-entered unique number associated with the Item Number of the accounting record. NUMBER(4) Required Key

p_user_id

The unique identification code of the user who created or last updated the record. VARCHAR2(30) Required

p_rucl_code

The user-entered rule class (as defined in table FTVRUCL) for the encumbrance sequence. VARCHAR2(4) Required

p_fsyr_code

The fiscal year code (as defined in table FTVFSYR) that is derived from the transaction date on the encumbrance. The encumbrance transactions will post to the ledgers in this fiscal year. VARCHAR2(2)

p_coas_code

The primary identification code for any chart of accounts that uniquely identifies that chart from any other in a multiple chart environment. VARCHAR2(1) Required

p_acci_code

The user-defined value representing a summarization of any combination of user-defined FOAPAL elements. VARCHAR2(6)

p_fund_code

Identifies the fund code that appears on a transaction. VARCHAR2(6)

p_orgn_code

Identifies the organization code that appears on a transaction. VARCHAR2(6)

p_acct_code

The user-defined value representing an account. VARCHAR2(6)

p_prog_code

The user-defined value for the program classification structure code or a subset of that structure as defined by the National Council of Higher Education Management Systems. VARCHAR2(6)

p_actv_code

The activity that is primarily associated with this organization. VARCHAR2(6)

p_locn_code

The physical location of the institutions financial manager. For example, Vice President, Finance, Suite 10 Adams Hall, Main Campus. VARCHAR2(6)

p_posting_period

The fiscal period (as defined in table FTVFSPD) that is derived from the transaction date on the encumbrance. The encumbrance transactions will post to the ledgers in this fiscal period of the fiscal year. VARCHAR2(2)

p_status_ind_in_out

The current status of the encumbrance sequence. VARCHAR2(1)

	P	Postable
	N	Non-sufficient funds
	E	Error in record

p_prjd_code

If the encumbrance is related to a project (work order) from cost accounting, enter the project code. VARCHAR2(8)

p_pend_amt

The dollar amount of the encumbrance to be posted with the accounting distribution. After posting this amount becomes null. NUMBER(17,2)

p_dist_pct

The percentage of the total encumbrance to be assigned to this accounting distribution. If a percentage is entered, the system calculates the amount; otherwise, an amount must be entered. NUMBER(6,3)

p_opal_field_code

Operating ledger field code, maintained by the Posting process. VARCHAR2(2)

	NULL	New General Encumbrance, not yet posted - to be used when creating a new record.
	04	Encumbrance, including General Encumbrance and Purchase Order.
	05	Reservation, including Requisition.

p_status

Status of the encumbrance sequence. VARCHAR2(1)

	C	Closed
	O	Open - to be used when creating a new record (default)

p_abal_override

This indicator permits users, who are provided authorization on the User Profile Maintenance form (FOMPROF), to bypass a non-sufficient funds condition. VARCHAR2(1) Required

	Y	Override non-sufficient funds
	N	Enforce available balance validation

p_appr_ind

Indicates if the document has been approved. If "Y", the encumbrance sequence has received final approval. VARCHAR2(1)

	Y	Approved
	N	Not approved
	NULL	Not approved

p_cmt_type

The commitment type of the encumbrance sequence. VARCHAR2(1)

	U	Uncommitted (default)
	C	Committed

p_cmt_pct

The percent of budget carried forward on the rolled encumbrance. NUMBER(6,3)

p_data_origin

Source system that created or last updated the data. VARCHAR2(30)

p_warning_out

Returns the message from available balance checking. VARCHAR2(4000) Required

p_abal_severity_out

Returns severity level from available balance checking. VARCHAR2(1) Required

	Y	Sufficient funds are available
	N	Funds are not available, and encumbrance sequence may not be set to P (ready to post)
	W	Funds are not available (informational warning)
	E	Validation or other errors encountered while checking available balance

p_rowid_out

Database ROWID of the record to be created. VARCHAR2(18) Required

p_delete

Procedure p_delete(p_num     fgbencd.fgbencd_num%TYPE,
                   p_item    fgbencd.fgbencd_item%TYPE,
                   p_seq_num fgbencd.fgbencd_seq_num%TYPE,
                   p_rowid   gb_common.internal_record_id_type DEFAULT NULL)

Deletes a record.

Parameters

	p_num	The unique identifier of an Encumbrance document. VARCHAR2(8) Required Key
	p_item	The reference number which associates an accounting record to a related item. NUMBER(4) Required Key
	p_seq_num	The system-generated unique number associated with the Item Number of the accounting record. NUMBER(4) Required Key
	p_rowid	Database ROWID of the record to be deleted. VARCHAR2(18)

p_delete_all

Procedure p_delete_all(p_num fgbencd.fgbencd_num%TYPE)

Deletes all records for a document.

Parameters

p_num

The unique identifier of an Encumbrance document. VARCHAR2(8) Required Key

p_lock

Procedure p_lock(p_num         fgbencd.fgbencd_num%TYPE,
                 p_item        fgbencd.fgbencd_item%TYPE,
                 p_seq_num     fgbencd.fgbencd_seq_num%TYPE,
                 p_rowid_inout IN OUT gb_common.internal_record_id_type)

Locks a record.

If ROWID is not passed in, the record is located using the key values and the ROWID of the locked row is passed in p_rowid_inout

Parameters

	p_num	The unique identifier of an Encumbrance document. VARCHAR2(8) Required Key
	p_item	The reference number which associates an accounting record to a related item. NUMBER(4) Required Key
	p_seq_num	The system-generated unique number associated with the Item Number of the accounting record. NUMBER(4) Required Key
	p_rowid_inout	Database ROWID of the record to be locked. VARCHAR2(18) Required

p_update

Procedure p_update(p_num               fgbencd.fgbencd_num%TYPE,
                   p_item              fgbencd.fgbencd_item%TYPE,
                   p_seq_num           fgbencd.fgbencd_seq_num%TYPE,
                   p_user_id           fgbencd.fgbencd_user_id%TYPE DEFAULT gb_common.f_sct_user,
                   p_rucl_code         fgbencd.fgbencd_rucl_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_fsyr_code         fgbencd.fgbencd_fsyr_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_coas_code         fgbencd.fgbencd_coas_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_acci_code         fgbencd.fgbencd_acci_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_fund_code         fgbencd.fgbencd_fund_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_orgn_code         fgbencd.fgbencd_orgn_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_acct_code         fgbencd.fgbencd_acct_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_prog_code         fgbencd.fgbencd_prog_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_actv_code         fgbencd.fgbencd_actv_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_locn_code         fgbencd.fgbencd_locn_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_posting_period    fgbencd.fgbencd_posting_period%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_status_ind_in_out IN OUT fgbencd.fgbencd_status_ind%TYPE,
                   p_prjd_code         fgbencd.fgbencd_prjd_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_pend_amt          fgbencd.fgbencd_pend_amt%TYPE DEFAULT dml_common.f_unspecified_number,
                   p_dist_pct          fgbencd.fgbencd_dist_pct%TYPE DEFAULT dml_common.f_unspecified_number,
                   p_opal_field_code   fgbencd.fgbencd_opal_field_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_status            fgbencd.fgbencd_status%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_abal_override     fgbencd.fgbencd_abal_override%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_appr_ind          fgbencd.fgbencd_appr_ind%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_cmt_type          fgbencd.fgbencd_cmt_type%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_cmt_pct           fgbencd.fgbencd_cmt_pct%TYPE DEFAULT dml_common.f_unspecified_number,
                   p_data_origin       fgbencd.fgbencd_data_origin%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_warning_out       OUT gb_common_strings.err_type,
                   p_abal_severity_out OUT VARCHAR2,
                   p_rowid             gb_common.internal_record_id_type DEFAULT NULL)

Updates a record.

All parameters which are not specified retain the value from the existing record.
Document Number, Item Number and Sequence Number or Row Id required.

Parameters

p_num

The unique identifier of an Encumbrance document. VARCHAR2(8) Required Key

p_item

p_seq_num

The system-generated or user-entered unique number associated with the Item Number of the accounting record. NUMBER(4) Required Key

p_user_id

The unique identification code of the user who created or last updated the record. VARCHAR2(30) Required

p_rucl_code

The user-entered rule class (as defined in table FTVRUCL) for the encumbrance sequence. VARCHAR2(4) Required

p_fsyr_code

The fiscal year code (as defined in table FTVFSYR) that is derived from the transaction date on the encumbrance. The encumbrance transactions will post to the ledgers in this fiscal year. VARCHAR2(2)

p_coas_code

The primary identification code for any chart of accounts that uniquely identifies that chart from any other in a multiple chart environment. VARCHAR2(1) Required

p_acci_code

The user-defined value representing a summarization of any combination of user-defined FOAPAL elements. VARCHAR2(6)

p_fund_code

Identifies the fund code that appears on a transaction. VARCHAR2(6)

p_orgn_code

Identifies the organization code that appears on a transaction. VARCHAR2(6)

p_acct_code

The user-defined value representing an account. VARCHAR2(6)

p_prog_code

The user-defined value for the program classification structure code or a subset of that structure as defined by the National Council of Higher Education Management Systems. VARCHAR2(6)

p_actv_code

The activity that is primarily associated with this organization. VARCHAR2(6)

p_locn_code

The physical location of the institutions financial manager. For example, Vice President, Finance, Suite 10 Adams Hall, Main Campus. VARCHAR2(6)

p_posting_period

p_status_ind_in_out

The current status of the encumbrance sequence. VARCHAR2(1)

	P	Postable
	N	Non-sufficient funds
	E	Error in record

p_prjd_code

If the encumbrance is related to a project (work order) from cost accounting, enter the project code. VARCHAR2(8)

p_pend_amt

The dollar amount of the encumbrance to be posted with the accounting distribution. After posting this amount becomes null. NUMBER(17,2)

p_dist_pct

The percentage of the total encumbrance to be assigned to this accounting distribution. If a percentage is entered, the system calculates the amount; otherwise, an amount must be entered. NUMBER(6,3)

p_opal_field_code

Operating ledger field code, maintained by the Posting process. VARCHAR2(2)

	NULL	New General Encumbrance, not yet posted.
	04	Encumbrance, including General Encumbrance and Purchase Order.
	05	Reservation, including Requisition.

p_status.

VARCHAR2(1)

	C	Closed
	O	Open

p_abal_override

This indicator permits users, who are provided authorization on the User Profile Maintenance form (FOMPROF), to bypass a non-sufficient funds condition. VARCHAR2(1)

	Y	Override non-sufficient funds
	N	Enforce available balance validation

p_appr_ind

Indicates if the document has been approved. If "Y", the encumbrance sequence has received final approval. VARCHAR2(1)

	Y	Approved
	N	Not approved
	NULL	Not approved

p_cmt_type

The commitment type of the encumbrance sequence. VARCHAR2(1)

	U	Uncommitted
	C	Committed

p_cmt_pct

The percent of budget carried forward on the rolled encumbrance. NUMBER(6,3)

p_data_origin

Source system that created or last updated the data. VARCHAR2(30)

p_rowid

Database ROWID of the record to be updated. VARCHAR2(18)

p_update_internal

Procedure p_update_internal(p_num             fgbencd.fgbencd_num%TYPE,
                            p_item            fgbencd.fgbencd_item%TYPE DEFAULT NULL,
                            p_seq_num         fgbencd.fgbencd_seq_num%TYPE DEFAULT NULL,
                            p_status_ind      fgbencd.fgbencd_status_ind%TYPE DEFAULT NULL,
                            p_pend_amt        fgbencd.fgbencd_pend_amt%TYPE DEFAULT dml_common.f_unspecified_number,
                            p_opal_field_code fgbencd.fgbencd_opal_field_code%TYPE DEFAULT NULL,
                            p_status          fgbencd.fgbencd_status%TYPE DEFAULT NULL,
                            p_abal_override   fgbencd.fgbencd_abal_override%TYPE DEFAULT NULL,
                            p_appr_ind        fgbencd.fgbencd_appr_ind%TYPE DEFAULT NULL,
                            p_cmt_type        fgbencd.fgbencd_cmt_type%TYPE DEFAULT NULL,
                            p_cmt_pct         fgbencd.fgbencd_cmt_pct%TYPE DEFAULT NULL)

Internal updates.

Note that fp_encumbrance.p_complete should be used to request validation and completion of a document, and that approvals and related Available Balance override changes are processed via user interfaces and not directly in the API.

Parameters

p_num

The unique identifier of an Encumbrance document. VARCHAR2(8) Required Key

p_item

The reference number which associates an accounting record to a related item. NUMBER(4)

p_seq_num

The system-generated or user-entered unique number associated with the Item Number of the accounting record. NUMBER(4)

p_status_ind

The current status of the encumbrance sequence. VARCHAR2(1)

	P	Postable
	N	Non-sufficient funds
	E	Error in record

p_pend_amt

The dollar amount of the encumbrance to be posted with the accounting distribution. After posting this amount becomes null. NUMBER(17,2)

p_opal_field_code

Operating ledger field code, maintained by the Posting process. VARCHAR2(2)

	NULL	New General Encumbrance, not yet posted.
	04	Encumbrance, including General Encumbrance and Purchase Order.
	05	Reservation, including Requisition.

p_status

The status of the encumbrance sequence. VARCHAR2(1)

	C	Closed
	O	Open

p_abal_override

This indicator permits users, who are provided authorization on the User Profile Maintenance form (FOMPROF), to bypass a non-sufficient funds condition. VARCHAR2(1)

	Y	Override non-sufficient funds
	N	Enforce available balance validation

p_appr_ind

Indicates if the document has been approved. If "Y", the encumbrance sequence has received final approval. VARCHAR2(1)

	Y	Approved
	N	Not approved
	NULL	Not approved

p_cmt_type

The commitment type of the encumbrance sequence. VARCHAR2(1)

	U	Uncommitted
	C	Committed

p_cmt_pct

The percent of budget carried forward on the rolled encumbrance. NUMBER(6,3)