Package BANINST1.fb_jv

Package BANINST1.fb_jv_detail

Common Business interface for the Journal Voucher Detail API (JV_DETAIL).

Each record is identified by document number, submission number and sequence number combination.
Fiscal Year and Period are derived from 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 Journal Voucher 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 Journal Voucher sequence is governed by the context under which the API is called. The default is FGAJVCD.

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

Program units

f_api_version	Returns the API version number.
f_get_int_constant	Returns the value of an integer constant.
f_entity_to_row	Accept jv_detail_rec and return fgbjvcd rowtype
f_exists	Checks if a record exists.
f_isequal	Compares two records for equality.
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_get_max_seq	Returns the maximum sequence number for the Journal Voucher.
f_valid_distribution	Validates that all records have a distribution percent.
f_sum_trans_amt	Calculates total of all JV detail sequences.
p_create	Creates a journal voucher detail record.
p_delete	Deletes a record.
p_delete_all	Deletes all records of a journal voucher.
p_lock	Locks a record.
p_update	Updates a record.
p_update_internal	Internal updates.

Types

jv_detail_rec	Business Entity record type
jv_detail_ref	Entity cursor variable type
jv_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(9) := 'JVDETAIL';

Business Entity Name.

M_BASE_TABLE_NAME

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

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.

jv_detail_rec

TYPE jv_detail_rec IS RECORD (
  r_doc_num                 fgbjvcd.fgbjvcd_doc_num%TYPE,
  r_submission_number       fgbjvcd.fgbjvcd_submission_number%TYPE,
  r_seq_num                 fgbjvcd.fgbjvcd_seq_num%TYPE,
  r_user_id                 fgbjvcd.fgbjvcd_user_id%TYPE,
  r_rucl_code               fgbjvcd.fgbjvcd_rucl_code%TYPE,
  r_trans_amt               fgbjvcd.fgbjvcd_trans_amt%TYPE,
  r_trans_desc              fgbjvcd.fgbjvcd_trans_desc%TYPE,
  r_dr_cr_ind               fgbjvcd.fgbjvcd_dr_cr_ind%TYPE,
  r_fsyr_code               fgbjvcd.fgbjvcd_fsyr_code%TYPE,
  r_acci_code               fgbjvcd.fgbjvcd_acci_code%TYPE,
  r_coas_code               fgbjvcd.fgbjvcd_coas_code%TYPE,
  r_fund_code               fgbjvcd.fgbjvcd_fund_code%TYPE,
  r_orgn_code               fgbjvcd.fgbjvcd_orgn_code%TYPE,
  r_acct_code               fgbjvcd.fgbjvcd_acct_code%TYPE,
  r_prog_code               fgbjvcd.fgbjvcd_prog_code%TYPE,
  r_actv_code               fgbjvcd.fgbjvcd_actv_code%TYPE,
  r_locn_code               fgbjvcd.fgbjvcd_locn_code%TYPE,
  r_bank_code               fgbjvcd.fgbjvcd_bank_code%TYPE,
  r_doc_ref_num             fgbjvcd.fgbjvcd_doc_ref_num%TYPE,
  r_vendor_pidm             fgbjvcd.fgbjvcd_vendor_pidm%TYPE,
  r_encb_num                fgbjvcd.fgbjvcd_encb_num%TYPE,
  r_encd_item_num           fgbjvcd.fgbjvcd_encd_item_num%TYPE,
  r_encd_seq_num            fgbjvcd.fgbjvcd_encd_seq_num%TYPE,
  r_encb_type               fgbjvcd.fgbjvcd_encb_type%TYPE,
  r_bud_dispn               fgbjvcd.fgbjvcd_bud_dispn%TYPE,
  r_bud_id                  fgbjvcd.fgbjvcd_bud_id%TYPE,
  r_cmt_type                fgbjvcd.fgbjvcd_cmt_type%TYPE,
  r_cmt_pct                 fgbjvcd.fgbjvcd_cmt_pct%TYPE,
  r_dep_num                 fgbjvcd.fgbjvcd_dep_num%TYPE,
  r_encb_action_ind         fgbjvcd.fgbjvcd_encb_action_ind%TYPE,
  r_prjd_code               fgbjvcd.fgbjvcd_prjd_code%TYPE,
  r_acct_code_cash          fgbjvcd.fgbjvcd_acct_code_cash%TYPE,
  r_dist_pct                fgbjvcd.fgbjvcd_dist_pct%TYPE,
  r_posting_period          fgbjvcd.fgbjvcd_posting_period%TYPE,
  r_budget_period           fgbjvcd.fgbjvcd_budget_period%TYPE,
  r_accrual_ind             fgbjvcd.fgbjvcd_accrual_ind%TYPE,
  r_status_ind              fgbjvcd.fgbjvcd_status_ind%TYPE,
  r_abal_override           fgbjvcd.fgbjvcd_abal_override%TYPE,
  r_post_bavl               fgbjvcd.fgbjvcd_post_bavl%TYPE,
  r_appr_ind                fgbjvcd.fgbjvcd_appr_ind%TYPE,
  r_curr_code               fgbjvcd.fgbjvcd_curr_code%TYPE,
  r_converted_amt           fgbjvcd.fgbjvcd_converted_amt%TYPE,
  r_fund_code_pool          fgbjvcd.fgbjvcd_fund_code_pool%TYPE,
  r_coas_code_pool          fgbjvcd.fgbjvcd_coas_code_pool%TYPE,
  r_gift_date               fgbjvcd.fgbjvcd_gift_date%TYPE,
  r_emc_units               fgbjvcd.fgbjvcd_emc_units%TYPE,
  r_data_origin             fgbjvcd.fgbjvcd_data_origin%TYPE,
  r_create_source           fgbjvcd.fgbjvcd_create_source%TYPE,
  r_internal_record_id      gb_common.internal_record_id_type);

Business Entity record type

jv_detail_ref

TYPE jv_detail_ref IS REF CURSOR RETURN jv_detail_rec;

Entity cursor variable type

jv_detail_tab

TYPE jv_detail_tab IS TABLE OF jv_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_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 Journal Voucher 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_entity_to_row

Function f_entity_to_row(p_detail_rec jv_detail_rec) RETURN fgbjvcd%ROWTYPE

Accept jv_detail_rec and return fgbjvcd rowtype

Returns

fgbjvcd rowtype

f_exists

Function f_exists(p_doc_num           fgbjvcd.fgbjvcd_doc_num%TYPE,
                  p_submission_number fgbjvcd.fgbjvcd_submission_number%TYPE,
                  p_seq_num           fgbjvcd.fgbjvcd_seq_num%TYPE,
                  p_rowid             gb_common.internal_record_id_type DEFAULT NULL)
  RETURN VARCHAR2

Checks if a record exists.

Parameters

	p_doc_num	The unique identifier of a journal voucher document. VARCHAR2(8) Required Key
	p_submission_number	The submission number associated with the journal voucher document. NUMBER(2) Required Key
	p_seq_num	A one-up sequence number associated with each line of a journal voucher document. NUMBER(4) Required Key
	p_rowid	Database ROWID of the record to be selected. VARCHAR2(18)

Returns

Y if found, otherwise N.

f_isequal

Function f_isequal(rec_one jv_detail_rec, rec_two jv_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 jv_detail_rec Required
	rec_two	The second record to compare. Type jv_detail_rec Required

Returns

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

f_query_all

Function f_query_all(p_doc_num           fgbjvcd.fgbjvcd_doc_num%TYPE,
                     p_submission_number fgbjvcd.fgbjvcd_submission_number%TYPE DEFAULT NULL)
  RETURN jv_detail_ref

Selects all records for the entity.

Parameters

	p_doc_num	The unique identifier of a journal voucher document. VARCHAR2(8) Required Key
	p_submission_number	The submission number associated with the journal voucher document. NUMBER(2) Key

Returns

A cursor variable that will fetch a set of records.

f_query_one

Function f_query_one(p_doc_num           fgbjvcd.fgbjvcd_doc_num%TYPE,
                     p_submission_number fgbjvcd.fgbjvcd_submission_number%TYPE,
                     p_seq_num           fgbjvcd.fgbjvcd_seq_num%TYPE)
  RETURN jv_detail_ref

Selects one record using key.

Parameters

	p_doc_num	The unique identifier of a journal voucher document. VARCHAR2(8) Required Key
	p_submission_number	The submission number associated with the journal voucher document. NUMBER(2) Required Key
	p_seq_num	A one-up sequence number associated with each line of a journal voucher document. 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 jv_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_doc_num           fgbjvcd.fgbjvcd_doc_num%TYPE,
                          p_submission_number fgbjvcd.fgbjvcd_submission_number%TYPE,
                          p_seq_num           fgbjvcd.fgbjvcd_seq_num%TYPE,
                          p_rowid             gb_common.internal_record_id_type DEFAULT NULL)
  RETURN jv_detail_ref

Selects one record and locks it.

Parameters

	p_doc_num	The unique identifier of a journal voucher document. VARCHAR2(8) Required Key
	p_submission_number	The submission number associated with the journal voucher document. NUMBER(2) Required Key
	p_seq_num	A one-up sequence number associated with each line of a journal voucher document. 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_get_max_seq

Function f_get_max_seq(p_doc_num FGBJVCD.FGBJVCD_DOC_NUM%TYPE,
                       p_sub_num FGBJVCD.FGBJVCD_SUBMISSION_NUMBER%TYPE)
  RETURN NUMBER

Returns the maximum sequence number for the Journal Voucher.

Parameters

	p_doc_num	The unique identifier of a journal voucher document. VARCHAR2(8) Required Key
	p_submission_number	The submission associated with the journal voucher document. NUMBER(2) Required Key

Returns

The maximum sequence number.

f_valid_distribution

Function f_valid_distribution(p_doc_num           fgbjvcd.fgbjvcd_doc_num%TYPE,
                              p_submission_number fgbjvcd.fgbjvcd_submission_number%TYPE)
  RETURN VARCHAR2

Validates that all records have a distribution percent.

Parameters

	p_doc_num	The unique identifier of a journal voucher document. VARCHAR2(8) Required Key
	p_submission_number	The submission associated with the journal voucher document. NUMBER(2) 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

f_sum_trans_amt

Function f_sum_trans_amt(p_doc_num           fgbjvcd.fgbjvcd_doc_num%TYPE,
                         p_submission_number fgbjvcd.fgbjvcd_submission_number%TYPE)
  RETURN VARCHAR2

Calculates total of all JV detail sequences.

Parameters

	p_doc_num	The unique identifier of a journal voucher document. VARCHAR2(8) Required Key
	p_submission_number	The submission associated with the journal voucher document. NUMBER(2) Required Key

Returns

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

p_create

Procedure p_create(p_doc_num           fgbjvcd.fgbjvcd_doc_num%TYPE,
                   p_submission_number fgbjvcd.fgbjvcd_submission_number%TYPE DEFAULT 0,
                   p_seq_num           fgbjvcd.fgbjvcd_seq_num%TYPE DEFAULT NULL,
                   p_user_id           fgbjvcd.fgbjvcd_user_id%TYPE DEFAULT gb_common.f_sct_user,
                   p_rucl_code         fgbjvcd.fgbjvcd_rucl_code%TYPE,
                   p_trans_amt         fgbjvcd.fgbjvcd_trans_amt%TYPE DEFAULT NULL,
                   p_trans_desc        fgbjvcd.fgbjvcd_trans_desc%TYPE DEFAULT NULL,
                   p_dr_cr_ind         fgbjvcd.fgbjvcd_dr_cr_ind%TYPE DEFAULT NULL,
                   p_fsyr_code         fgbjvcd.fgbjvcd_fsyr_code%TYPE DEFAULT NULL,
                   p_acci_code         fgbjvcd.fgbjvcd_acci_code%TYPE DEFAULT NULL,
                   p_coas_code         fgbjvcd.fgbjvcd_coas_code%TYPE DEFAULT NULL,
                   p_fund_code         fgbjvcd.fgbjvcd_fund_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_orgn_code         fgbjvcd.fgbjvcd_orgn_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_acct_code         fgbjvcd.fgbjvcd_acct_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_prog_code         fgbjvcd.fgbjvcd_prog_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_actv_code         fgbjvcd.fgbjvcd_actv_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_locn_code         fgbjvcd.fgbjvcd_locn_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_bank_code         fgbjvcd.fgbjvcd_bank_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_doc_ref_num       fgbjvcd.fgbjvcd_doc_ref_num%TYPE DEFAULT NULL,
                   p_vendor_pidm       fgbjvcd.fgbjvcd_vendor_pidm%TYPE DEFAULT NULL,
                   p_encb_num          fgbjvcd.fgbjvcd_encb_num%TYPE DEFAULT NULL,
                   p_encd_item_num     fgbjvcd.fgbjvcd_encd_item_num%TYPE DEFAULT NULL,
                   p_encd_seq_num      fgbjvcd.fgbjvcd_encd_seq_num%TYPE DEFAULT NULL,
                   p_encb_type         fgbjvcd.fgbjvcd_encb_type%TYPE DEFAULT NULL,
                   p_bud_dispn         fgbjvcd.fgbjvcd_bud_dispn%TYPE DEFAULT NULL,
                   p_bud_id            fgbjvcd.fgbjvcd_bud_id%TYPE DEFAULT NULL,
                   p_cmt_type          fgbjvcd.fgbjvcd_cmt_type%TYPE DEFAULT NULL,
                   p_cmt_pct           fgbjvcd.fgbjvcd_cmt_pct%TYPE DEFAULT NULL,
                   p_dep_num           fgbjvcd.fgbjvcd_dep_num%TYPE DEFAULT NULL,
                   p_encb_action_ind   fgbjvcd.fgbjvcd_encb_action_ind%TYPE DEFAULT NULL,
                   p_prjd_code         fgbjvcd.fgbjvcd_prjd_code%TYPE DEFAULT NULL,
                   p_acct_code_cash    fgbjvcd.fgbjvcd_acct_code_cash%TYPE DEFAULT NULL,
                   p_dist_pct          fgbjvcd.fgbjvcd_dist_pct%TYPE DEFAULT NULL,
                   p_posting_period    fgbjvcd.fgbjvcd_posting_period%TYPE DEFAULT NULL,
                   p_budget_period     fgbjvcd.fgbjvcd_budget_period%TYPE DEFAULT NULL,
                   p_accrual_ind       fgbjvcd.fgbjvcd_accrual_ind%TYPE DEFAULT NULL,
                   p_status_in_out     IN OUT fgbjvcd.fgbjvcd_status_ind%TYPE,
                   p_abal_override     fgbjvcd.fgbjvcd_abal_override%TYPE DEFAULT NULL,
                   p_appr_ind          fgbjvcd.fgbjvcd_appr_ind%TYPE DEFAULT NULL,
                   p_curr_code         fgbjvcd.fgbjvcd_curr_code%TYPE DEFAULT NULL,
                   p_converted_amt     fgbjvcd.fgbjvcd_converted_amt%TYPE DEFAULT NULL,
                   p_gift_date         fgbjvcd.fgbjvcd_gift_date%TYPE DEFAULT NULL,
                   p_emc_units         fgbjvcd.fgbjvcd_emc_units%TYPE DEFAULT NULL,
                   p_data_origin       fgbjvcd.fgbjvcd_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 journal voucher detail record.

Document Number, Sequence Number, Rule Code, Transaction Description and Chart of Accounts are required.
Submission Number will default to 0, and User ID to the log-on user.
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). Bank Code may default from the Fund.
Amount is required except where it may be calculated using Distribution Percent.
The Debit/Credit Indicator is required except where it may be defaulted by a rule class edit code.

Parameters

p_doc_num

The unique identifier of a journal voucher document. VARCHAR2(8) Required Key

p_submission_number

The submission number associated with the journal voucher document. All journals are created with a submission number of 0, including the base entry of a recurring (automatic) JV. Each iteration of the recurring JV increments the submission number by 1. NUMBER(2) Key

p_seq_num

A one-up sequence number associated with each line of a journal voucher document. NUMBER(4) Required Key

p_user_id

The identification code of the user who last updated the journal voucher sequence. VARCHAR2(30) Required

p_rucl_code

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

p_trans_amt

The currency amount of the journal voucher sequence. NUMBER(17,2)

p_trans_desc

The reason or purpose for the journal voucher sequence. VARCHAR2(35)

p_dr_cr_ind

The sign associated with the journal voucher sequence. VARCHAR2(1). Depending on the the rule class used, values may be:

	D	Debit
	C	Credit
	+	Increase
	-	Decrease

p_fsyr_code

The Fiscal Year code (as defined in table FTVFSYR) to be used when posting the transaction to the ledgers. VARCHAR2(2)

p_acci_code

The Index code (as defined in table FTVACCI) that may be entered to default various accounting elements. VARCHAR2(6)

p_coas_code

The Chart of Accounts code (as defined in table FTVCOAS) referenced by the journal voucher sequence. VARCHAR2(1)

p_fund_code

The Fund code (as defined in table FTVFUND) referenced by the journal voucher sequence. VARCHAR2(6)

p_orgn_code

The Organization code (as defined in table FTVORGN) referenced by the journal voucher sequence. VARCHAR2(6)

p_acct_code

The Account code (as defined in table FTVACCT) referenced by the journal voucher sequence. VARCHAR2(6)

p_prog_code

The Program code (as defined in table FTVPROG) referenced by the journal voucher sequence. VARCHAR2(6)

p_actv_code

The Activity code (as defined in table FTVACTV) referenced by the journal voucher sequence. VARCHAR2(6)

p_locn_code

The Location code (as defined in table FTVLOCN) referenced by the journal voucher sequence. VARCHAR2(6)

p_bank_code

The Bank code (as defined in table GXVBANK) referenced by the journal voucher sequence. This value may default from the Fund code. VARCHAR2(2)

p_doc_ref_num

Reference number to a source document for the journal voucher sequence. VARCHAR2(8)

p_vendor_pidm

The personal identification master record (PIDM) associated with the vendor referenced on the journal voucher sequence. NUMBER(8)

p_encb_num

The encumbrance number, if the journal voucher sequence references an existing encumbrance, such as a liquidation or an adjustment entry. VARCHAR2(8)

p_encd_item_num

The encumbrance item number, if the journal voucher sequence references an existing encumbrance. NUMBER(4)

p_encd_seq_num

The sequence number associated with an encumbrance item number. NUMBER(4)

p_encb_type

The type of encumbrance referenced by the journal voucher sequence. VARCHAR2(1).

	L	Labor
	R	Requisition
	P	Purchase Order
	M	Memo
	E	General Encumbrances

p_bud_dispn

The budget disposition carried forward on the rolled encumbrance. VARCHAR2(1).

	U	Unrestricted
	R	Restricted
	N	No Action

p_bud_id

The Budget ID, if this journal is updating the ledgers as well as budget development. For example, this column will be populated if a journal is created using the Budget Maintenance Form (FBABDMN). VARCHAR2(6)

p_cmt_type

The commitment value associated with an encumbrance that has been rolled from a prior fiscal year. VARCHAR2(1).

	U	Uncommitted
	C	Committed

p_cmt_pct

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

p_dep_num

A user-valued deposit number assigned to the journal voucher sequence. VARCHAR2(8)

p_encb_action_ind

Indicates the action to be taken on the encumbrance number, item, and sequence number specified on the journal voucher sequence. VARCHAR2(1).

	T	Total
	P	Partial
	A	Adjustment
	NULL	If the journal voucher sequence does not contain a reference to an encumbrance

p_prjd_code

The Project code (as defined in table FTVPROJ) referenced by the journal voucher sequence. VARCHAR2(8)

p_acct_code_cash

The cash account for the bank code referenced by the journal voucher sequence. VARCHAR2(6)

p_dist_pct

The percentage of the transaction amount assigned to the journal voucher sequence. If a percentage is entered, the system calculates the amount; otherwise, an amount must be entered. NUMBER(6,3)

p_posting_period

The fiscal period (as defined in table FTVFSPD) to be used when posting the transaction to the ledgers. VARCHAR2(2)

p_budget_period

The budget period affected by the journal voucher sequence. The budget period is required for budget-related transactions such as original or temporary budget entries or adjustments. VARCHAR2(2)

p_accrual_ind

Accrual Period posting indicator. VARCHAR2(1)

	Y	When used with a Rule Class with Process Code(s) that have Accrual Impact P (Prior), generates transactions in both the current and prior fiscal years.
	NULL	No impact to the prior year accrual period.

p_status_in_out

Status of the journal voucher sequence. VARCHAR2(1).

	NULL	Perform all edits - if no error encountered, save record with a Status of P (Postable)
	P	(Postable) Perform all edits
	N	(Non-sufficient Funds) Perform data value edits, but by-pass Available Balance checking
	E	(Error in record) Perform only minimal edits for mandatory values

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. VARCHAR2(1).

	Y	The journal voucher sequence has received final approval
	N	The journal voucher sequence is not approved
	NULL	The journal voucher sequence is not approved

p_curr_code

The currency (as defined in table GTVCURR) to be used for the processing of the journal voucher. VARCHAR2(4)

p_converted_amt

Base currency amount derived by applying the currency code exchange rate to the transaction amount. NUMBER(17,2)

p_gift_date

The legal date of the gift (that is, the valuation date for IRS purposes). This is the date used to determine the purchase price per unit in the Unitization process (FNPUNTZ) in Endowment Management. DATE

p_emc_units

The number of units purchased by this transaction, regardless of the dollar amount. If this is populated, the Unitization process (FNPUNTZ) uses the units provided by the journal voucher sequence, rather than calculating the number of units. NUMBER

p_data_origin

Source system that last created or 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 journal voucher 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_doc_num           fgbjvcd.fgbjvcd_doc_num%TYPE,
                   p_submission_number fgbjvcd.fgbjvcd_submission_number%TYPE,
                   p_seq_num           fgbjvcd.fgbjvcd_seq_num%TYPE,
                   p_rowid             gb_common.internal_record_id_type DEFAULT NULL)

Deletes a record.

Parameters

	p_doc_num	The unique identifier of a journal voucher document. VARCHAR2(8) Required Key
	p_submission_number	The submission number associated with the journal voucher document. NUMBER(2) Key
	p_seq_num	A one-up sequence number associated with each line of a journal voucher document. NUMBER(4) Required Key
	p_rowid	Database ROWID of the record to be deleted. VARCHAR2(18)

p_delete_all

Procedure p_delete_all(p_doc_num           fgbjvcd.fgbjvcd_doc_num%TYPE,
                       p_submission_number fgbjvcd.fgbjvcd_submission_number%TYPE DEFAULT NULL)

Deletes all records of a journal voucher.

Parameters

	p_doc_num	The unique identifier of a journal voucher document. VARCHAR2(8) Required Key
	p_submission_number	The submission number associated with the journal voucher document. NUMBER(2) Key

p_lock

Procedure p_lock(p_doc_num           fgbjvcd.fgbjvcd_doc_num%TYPE,
                 p_submission_number fgbjvcd.fgbjvcd_submission_number%TYPE,
                 p_seq_num           fgbjvcd.fgbjvcd_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_doc_num	The unique identifier of a journal voucher document. VARCHAR2(8) Required Key
	p_submission_number	The submission number associated with the journal voucher document. All journals are created with a submission number of 0, including the base entry of a recurring (automatic) JV. Each iteration of the recurring JV increments the submission number by 1. NUMBER(2) Key
	p_seq_num	A one-up sequence number associated with each line of a journal voucher document. NUMBER(4) Required Key
	p_rowid_inout	Database ROWID of the record to be locked. VARCHAR2(18) Required

p_update

Procedure p_update(p_doc_num           fgbjvcd.fgbjvcd_doc_num%TYPE,
                   p_submission_number fgbjvcd.fgbjvcd_submission_number%TYPE,
                   p_seq_num           fgbjvcd.fgbjvcd_seq_num%TYPE,
                   p_user_id           fgbjvcd.fgbjvcd_user_id%TYPE DEFAULT gb_common.f_sct_user,
                   p_rucl_code         fgbjvcd.fgbjvcd_rucl_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_trans_amt         fgbjvcd.fgbjvcd_trans_amt%TYPE DEFAULT dml_common.f_unspecified_number,
                   p_trans_desc        fgbjvcd.fgbjvcd_trans_desc%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_dr_cr_ind         fgbjvcd.fgbjvcd_dr_cr_ind%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_fsyr_code         fgbjvcd.fgbjvcd_fsyr_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_acci_code         fgbjvcd.fgbjvcd_acci_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_coas_code         fgbjvcd.fgbjvcd_coas_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_fund_code         fgbjvcd.fgbjvcd_fund_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_orgn_code         fgbjvcd.fgbjvcd_orgn_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_acct_code         fgbjvcd.fgbjvcd_acct_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_prog_code         fgbjvcd.fgbjvcd_prog_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_actv_code         fgbjvcd.fgbjvcd_actv_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_locn_code         fgbjvcd.fgbjvcd_locn_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_bank_code         fgbjvcd.fgbjvcd_bank_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_doc_ref_num       fgbjvcd.fgbjvcd_doc_ref_num%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_vendor_pidm       fgbjvcd.fgbjvcd_vendor_pidm%TYPE DEFAULT dml_common.f_unspecified_number,
                   p_encb_num          fgbjvcd.fgbjvcd_encb_num%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_encd_item_num     fgbjvcd.fgbjvcd_encd_item_num%TYPE DEFAULT dml_common.f_unspecified_number,
                   p_encd_seq_num      fgbjvcd.fgbjvcd_encd_seq_num%TYPE DEFAULT dml_common.f_unspecified_number,
                   p_encb_type         fgbjvcd.fgbjvcd_encb_type%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_bud_dispn         fgbjvcd.fgbjvcd_bud_dispn%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_bud_id            fgbjvcd.fgbjvcd_bud_id%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_cmt_type          fgbjvcd.fgbjvcd_cmt_type%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_cmt_pct           fgbjvcd.fgbjvcd_cmt_pct%TYPE DEFAULT dml_common.f_unspecified_number,
                   p_dep_num           fgbjvcd.fgbjvcd_dep_num%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_encb_action_ind   fgbjvcd.fgbjvcd_encb_action_ind%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_prjd_code         fgbjvcd.fgbjvcd_prjd_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_acct_code_cash    fgbjvcd.fgbjvcd_acct_code_cash%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_dist_pct          fgbjvcd.fgbjvcd_dist_pct%TYPE DEFAULT dml_common.f_unspecified_number,
                   p_posting_period    fgbjvcd.fgbjvcd_posting_period%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_budget_period     fgbjvcd.fgbjvcd_budget_period%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_accrual_ind       fgbjvcd.fgbjvcd_accrual_ind%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_status_in_out     IN OUT fgbjvcd.fgbjvcd_status_ind%TYPE,
                   p_abal_override     fgbjvcd.fgbjvcd_abal_override%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_appr_ind          fgbjvcd.fgbjvcd_appr_ind%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_curr_code         fgbjvcd.fgbjvcd_curr_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_converted_amt     fgbjvcd.fgbjvcd_converted_amt%TYPE DEFAULT dml_common.f_unspecified_number,
                   p_gift_date         fgbjvcd.fgbjvcd_gift_date%TYPE DEFAULT dml_common.f_unspecified_date,
                   p_emc_units         fgbjvcd.fgbjvcd_emc_units%TYPE DEFAULT dml_common.f_unspecified_number,
                   p_data_origin       fgbjvcd.fgbjvcd_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, Submission Number and Sequence Number or Row Id required.

Parameters

p_doc_num

The unique identifier of a journal voucher document. VARCHAR2(8) Required Key

p_submission_number

The submission number associated with the journal voucher document. NUMBER(2) Key

p_seq_num

A one-up sequence number associated with each line of a journal voucher document. NUMBER(4) Required Key

p_user_id

The identification code of the user who last updated the journal voucher document. VARCHAR2(30) Required

p_rucl_code

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

p_trans_amt

The currency amount of the journal voucher sequence. NUMBER(17,2)

p_trans_desc

The reason or purpose for the journal voucher sequence. VARCHAR2(35)

p_dr_cr_ind

The sign associated with the journal voucher sequence. VARCHAR2(1). Depending on the the rule class used, values may be:

	D	Debit
	C	Credit
	+	Increase
	-	Decrease

p_fsyr_code

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

p_acci_code

The Index code (as defined in table FTVACCI) that may be entered to default various accounting elements. VARCHAR2(6)

p_coas_code

The Chart of Accounts code (as defined in table FTVCOAS) referenced by the journal voucher sequence. VARCHAR2(1)

p_fund_code

The Fund code (as defined in table FTVFUND) referenced by the journal voucher sequence. VARCHAR2(6)

p_orgn_code

The Organization code (as defined in table FTVORGN) referenced by the journal voucher sequence. VARCHAR2(6)

p_acct_code

The Account code (as defined in table FTVACCT) referenced by the journal voucher sequence. VARCHAR2(6)

p_prog_code

The Program code (as defined in table FTVPROG) referenced by the journal voucher sequence. VARCHAR2(6)

p_actv_code

The Activity code (as defined in table FTVACTV) referenced by the journal voucher sequence. VARCHAR2(6)

p_locn_code

The Location code (as defined in table FTVLOCN) referenced by the journal voucher sequence. VARCHAR2(6)

p_bank_code

The Bank code (as defined in table GXVBANK) referenced by the journal voucher sequence. VARCHAR2(2)

p_doc_ref_num

Reference number to a source document for the journal voucher sequence. VARCHAR2(8)

p_vendor_pidm

The personal identification master record (PIDM) associated with the vendor referenced on the journal voucher sequence. NUMBER(8)

p_encb_num

The encumbrance number, if the journal voucher sequence references an existing encumbrance, such as a liquidation or an adjustment entry. VARCHAR2(8)

p_encd_item_num

The encumbrance item number, if the journal voucher sequence references an existing encumbrance. NUMBER(4)

p_encd_seq_num

The sequence number associated with an encumbrance item number. NUMBER(4)

p_encb_type

The type of encumbrance referenced by the journal voucher sequence. VARCHAR2(1).

	L	Labor
	R	Requisition
	P	Purchase Order
	M	Memo
	E	General Encumbrances

p_bud_dispn

The budget disposition carried forward on the rolled encumbrance. VARCHAR2(1).

	U	Unrestricted
	R	Restricted
	N	No Action

p_bud_id

p_cmt_type

The commitment value associated with an encumbrance that has been rolled from a prior fiscal year. VARCHAR2(1).

	U	Uncommitted
	C	Committed

p_cmt_pct

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

p_dep_num

A user-valued deposit number assigned to the journal voucher sequence. VARCHAR2(8)

p_encb_action_ind

Indicates the action to be taken on the encumbrance number, item, and sequence number specified on the journal voucher sequence. Valid values are "T" (Total), "P" (Partial) or "A" (Adjustment). VARCHAR2(1).

	T	Total
	P	Partial
	A	Adjustment
	NULL	If the journal voucher sequence does not contain a reference to an encumbrance

p_prjd_code

The Project code (as defined in table FTVPROJ) referenced by the journal voucher sequence. VARCHAR2(8)

p_acct_code_cash

The cash account for the bank code referenced by the journal voucher sequence. VARCHAR2(6)

p_dist_pct

The percentage of the transaction amount assigned to the journal voucher sequence. If a percentage is entered, the system calculates the amount; otherwise, an amount must be entered. NUMBER(6,3)

p_posting_period

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

p_budget_period

The budget period affected by the journal voucher sequence. The budget period is required for budget-related transactions such as original or temporary budget entries or adjustments. VARCHAR2(2)

p_accrual_ind

Accrual Period posting indicator. VARCHAR2(1)

	Y	When used with a Rule Class with Process Code(s) that have Accrual Impact P (Prior), generates transactions in both the current and prior fiscal years.
	NULL	No impact to the prior year accrual period.

p_status_in_out

Status of the journal voucher sequence. VARCHAR2(1).

	NULL	Perform all edits - if no error encountered, save record with a Status of P (Postable)
	P	(Postable) Perform all edits
	N	(Non-sufficient Funds) Perform data value edits, but by-pass Available Balance checking
	E	(Error in record) Perform only minimal edits for mandatory values

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. VARCHAR2(1).

	Y	The journal voucher sequence has received final approval
	N	The journal voucher sequence is not approved
	NULL	The journal voucher sequence is not approved

p_curr_code

The currency (as defined in table GTVCURR) to be used for the processing of the journal voucher. VARCHAR2(4)

p_converted_amt

Base currency amount derived by applying the currency code exchange rate to the transaction amount. NUMBER(17,2)

p_gift_date

p_emc_units

p_data_origin

Source system that last created or 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 journal voucher 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

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

p_update_internal

Procedure p_update_internal(p_doc_num           fgbjvcd.fgbjvcd_doc_num%TYPE,
                            p_submission_number fgbjvcd.fgbjvcd_submission_number%TYPE,
                            p_seq_num           fgbjvcd.fgbjvcd_seq_num%TYPE DEFAULT NULL,
                            p_appr_ind          fgbjvcd.fgbjvcd_appr_ind%TYPE DEFAULT NULL,
                            p_abal_override     fgbjvcd.fgbjvcd_abal_override%TYPE DEFAULT NULL,
                            p_status_ind        fgbjvcd.fgbjvcd_status_ind%TYPE DEFAULT NULL)

Internal updates.

Note that fp_journal_voucher.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_doc_num

The unique identifier of a journal voucher document. VARCHAR2(8) Required Key

p_submission_number

The submission number associated with the journal voucher document. NUMBER(2) Required Key

p_seq_num

A one-up sequence number associated with each line of a journal voucher document. NUMBER(4) Key

p_appr_ind

Indicates if the document has been approved. VARCHAR2(1)

	Y	Approved
	N	Not approved

p_abal_override

Available Balance override. VARCHAR2(1)

	Y	Override non-sufficient funds
	N	Enforce available balance validation

p_status_ind

Status Indicator. VARCHAR2(1)

	P	Postable
	N	Non-sufficient funds
	E	Error in record