Package tb_receivable

The Common Business interface for the Student and Non-Student Accounts Receivable API (RECEIVABLE).

All parameters are case sensitive; they are validated as provided.
User validation exits are provided for functions CREATE and UPDATE.

Program units

f_api_version	Returns the API version number.
f_exists	Checks to see if a record exists.
f_isequal	Compare two records for equality.
f_max_tran_number	Return maximum receivable transaction number.
f_query_all	Selects all records for the entity.
f_query_by_rowid	Selects one record using rowid.
f_query_cashier	Select all records for a cashiering session.
f_query_one	Selects one record using key.
f_query_one_lock	Selects one record and locks it.
f_sum_balance	Sum the balance column of records meeting parameter criteria.
f_sum_net_amount	Net the original amount (charges less payments) of records meeting parameter criteria.
p_adjust_balance	Add adjustment amount to the existing balance of a record (used to un-apply payment).
p_create	Creates a student or non-student charge or payment.
p_delete	Deletes a record.
p_lock	Locks a record.
p_update	Updates a record.

Types

receivable_rec	Entity record type
receivable_ref	Entity cursor variable type
receivable_key_rec	Key record type
receivable_key_ref	Key cursor variable type
receivable_tab	Entity table type

Constants

M_ENTITY_NAME

Business Entity name

M_ENTITY_NAME

M_ENTITY_NAME    CONSTANT VARCHAR2(10) := 'RECEIVABLE';

Business Entity name

receivable_rec

TYPE receivable_rec IS RECORD (
   r_pidm                    tbraccd.tbraccd_pidm%TYPE,
   r_tran_number             tbraccd.tbraccd_tran_number%TYPE,
   r_term_code               tbraccd.tbraccd_term_code%TYPE,
   r_detail_code             tbraccd.tbraccd_detail_code%TYPE,
   r_user                    tbraccd.tbraccd_user%TYPE,
   r_entry_date              tbraccd.tbraccd_entry_date%TYPE,
   r_amount                  tbraccd.tbraccd_amount%TYPE,
   r_balance                 tbraccd.tbraccd_balance%TYPE,
   r_effective_date          tbraccd.tbraccd_effective_date%TYPE,
   r_bill_date               tbraccd.tbraccd_bill_date%TYPE,
   r_due_date                tbraccd.tbraccd_due_date%TYPE,
   r_desc                    tbraccd.tbraccd_desc%TYPE,
   r_receipt_number          tbraccd.tbraccd_receipt_number%TYPE,
   r_tran_number_paid        tbraccd.tbraccd_tran_number_paid%TYPE,
   r_crossref_pidm           tbraccd.tbraccd_crossref_pidm%TYPE,
   r_crossref_number         tbraccd.tbraccd_crossref_number%TYPE,
   r_crossref_detail_code    tbraccd.tbraccd_crossref_detail_code%TYPE,
   r_srce_code               tbraccd.tbraccd_srce_code%TYPE,
   r_acct_feed_ind           tbraccd.tbraccd_acct_feed_ind%TYPE,
   r_session_number          tbraccd.tbraccd_session_number%TYPE,
   r_cshr_end_date           tbraccd.tbraccd_cshr_end_date%TYPE,
   r_crn                     tbraccd.tbraccd_crn%TYPE,
   r_crossref_srce_code      tbraccd.tbraccd_crossref_srce_code%TYPE,
   r_loc_mdt                 tbraccd.tbraccd_loc_mdt%TYPE,
   r_loc_mdt_seq             tbraccd.tbraccd_loc_mdt_seq%TYPE,
   r_rate                    tbraccd.tbraccd_rate%TYPE,
   r_units                   tbraccd.tbraccd_units%TYPE,
   r_document_number         tbraccd.tbraccd_document_number%TYPE,
   r_trans_date              tbraccd.tbraccd_trans_date%TYPE,
   r_payment_id              tbraccd.tbraccd_payment_id%TYPE,
   r_invoice_number          tbraccd.tbraccd_invoice_number%TYPE,
   r_statement_date          tbraccd.tbraccd_statement_date%TYPE,
   r_inv_number_paid         tbraccd.tbraccd_inv_number_paid%TYPE,
   r_curr_code               tbraccd.tbraccd_curr_code%TYPE,
   r_exchange_diff           tbraccd.tbraccd_exchange_diff%TYPE,
   r_foreign_amount          tbraccd.tbraccd_foreign_amount%TYPE,
   r_late_dcat_code          tbraccd.tbraccd_late_dcat_code%TYPE,
   r_feed_date               tbraccd.tbraccd_feed_date%TYPE,
   r_feed_doc_code           tbraccd.tbraccd_feed_doc_code%TYPE,
   r_atyp_code               tbraccd.tbraccd_atyp_code%TYPE,
   r_atyp_seqno              tbraccd.tbraccd_atyp_seqno%TYPE,
   r_card_type_vr            tbraccd.tbraccd_card_type_vr%TYPE,
   r_card_exp_date_vr        tbraccd.tbraccd_card_exp_date_vr%TYPE,
   r_card_auth_number_vr     tbraccd.tbraccd_card_auth_number_vr%TYPE,
   r_crossref_dcat_code      tbraccd.tbraccd_crossref_dcat_code%TYPE,
   r_orig_chg_ind            tbraccd.tbraccd_orig_chg_ind%TYPE,
   r_ccrd_code               tbraccd.tbraccd_ccrd_code%TYPE,
   r_merchant_id             tbraccd.tbraccd_merchant_id%TYPE,
   r_tax_rept_year           tbraccd.tbraccd_tax_rept_year%TYPE,
   r_tax_rept_box            tbraccd.tbraccd_tax_rept_box%TYPE,
   r_tax_amount              tbraccd.tbraccd_tax_amount%TYPE,
   r_tax_future_ind          tbraccd.tbraccd_tax_future_ind%TYPE,
   r_data_origin             tbraccd.tbraccd_data_origin%TYPE,
   r_create_source           tbraccd.tbraccd_create_source%TYPE,
   r_cpdt_ind                tbraccd.tbraccd_cpdt_ind%TYPE,
   r_aidy_code               tbraccd.tbraccd_aidy_code%TYPE,
   r_stsp_key_sequence       tbraccd.tbraccd_stsp_key_sequence%TYPE,
   r_period                  tbraccd.tbraccd_period%TYPE,
   r_internal_record_id      gb_common.internal_record_id_type);

Entity record type

receivable_ref

TYPE receivable_ref IS REF CURSOR RETURN receivable_rec;

Entity cursor variable type

receivable_key_rec

TYPE receivable_key_rec IS RECORD (
   r_pidm                    tbraccd.tbraccd_pidm%TYPE,
   r_tran_number             tbraccd.tbraccd_tran_number%TYPE,
   r_internal_record_id      gb_common.internal_record_id_type );

Key record type

receivable_key_ref

TYPE receivable_key_ref IS REF CURSOR RETURN receivable_key_rec;

Key cursor variable type

receivable_tab

TYPE receivable_tab IS TABLE OF receivable_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_exists

Function f_exists(p_pidm        tbraccd.tbraccd_pidm%TYPE,
                  p_tran_number tbraccd.tbraccd_tran_number%TYPE,
                  p_rowid       VARCHAR2 DEFAULT NULL) RETURN VARCHAR2

Checks to see if a record exists.

Parameters

	p_pidm	Internal Identification Number of the person or non-person account, valid in SPRIDEN. NUMBER(8) Required Key
	p_tran_number	Transaction number (one-up within entity) of the transaction. NUMBER(8) Required Key
	p_rowid	Database rowid of record to select. VARCHAR2(18)

Returns

Y if found, otherwise N.

f_isequal

Function f_isequal(rec_one receivable_rec, rec_two receivable_rec)
  RETURN VARCHAR2

Compare 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 receivable_rec Required
	rec_two	The second record to compare. Type receivable_rec Required

Returns

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

f_max_tran_number

Function f_max_tran_number(p_pidm tbraccd.tbraccd_pidm%TYPE)
  RETURN tbraccd.tbraccd_tran_number%TYPE

Return maximum receivable transaction number.

Parameters

p_pidm

Internal Identification Number of the person or non-person account, valid in SPRIDEN. NUMBER(8) Required Key

Returns

Maximum transaction number that exists on the account

f_query_all

Function f_query_all(p_pidm           tbraccd.tbraccd_pidm%TYPE,
                     p_term_code      tbraccd.tbraccd_term_code%TYPE DEFAULT NULL,
                     p_detail_code    tbraccd.tbraccd_detail_code%TYPE DEFAULT NULL,
                     p_dcat_code      tbbdetc.tbbdetc_dcat_code%TYPE DEFAULT NULL,
                     p_bill_date      tbraccd.tbraccd_bill_date%TYPE DEFAULT NULL,
                     p_srce_code      tbraccd.tbraccd_srce_code%TYPE DEFAULT NULL,
                     p_invoice_number tbraccd.tbraccd_invoice_number%TYPE DEFAULT NULL,
                     p_feed_doc_code  tbraccd.tbraccd_feed_doc_code%TYPE DEFAULT NULL,
                     p_tax_rept_year  tbraccd.tbraccd_tax_rept_year%TYPE DEFAULT NULL)
  RETURN receivable_ref

Selects all records for the entity.
Note that parameters other than pidm default to NULL and are ignored if not populated.
AND is used when multiple criteria are given.
Wildcard (%) may be used with term and detail code.

Parameters

	p_pidm	Internal Identification Number of the person or non-person account, valid in SPRIDEN. NUMBER(8) Required Key
	p_term_code	Term associated with the transaction. Wildcard is allowed, all if null. VARCHAR2(6)
	p_detail_code	Detail code associated with the transaction. Wildcard is allowed, all if null. VARCHAR2(4)
	p_dcat_code	Category code associated with the Detail Code. Matched if given, or all. VARCHAR2(3)
	p_bill_date	Date that the transaction is billed. Matched if given, or all. DATE
	p_srce_code	Source of the transaction when created on the account. Matched if given, or all. VARCHAR2(1)
	p_invoice_number	Invoice Number identifies a group of charges invoiced via one statement. Matched if given, or all. VARCHAR2(8)
	p_feed_doc_code	Document code used to feed this transaction to the finance system. Matched if given, or all. VARCHAR2(8)
	p_tax_rept_year	Tax Year in which the transaction was reported on form 1098-T. Matched if given, or all. NUMBER(4)

Returns

A cursor variable that will fetch the set of records.

f_query_by_rowid

Function f_query_by_rowid(p_rowid VARCHAR2) RETURN receivable_ref

Selects one record using rowid.

Parameters

p_rowid

Database rowid of record to select. VARCHAR2(18) Required

Returns

A cursor variable that will fetch exactly one record.

f_query_cashier

Function f_query_cashier(p_user           tbraccd.tbraccd_user%TYPE,
                         p_session_number tbraccd.tbraccd_session_number%TYPE,
                         p_cshr_end_date  tbraccd.tbraccd_cshr_end_date%TYPE DEFAULT NULL)
  RETURN receivable_ref

Select all records for a cashiering session.

Parameters

	p_user	User ID of the cashier of the session. VARCHAR2(30) Required
	p_session_number	Cashier session number (0 = current session). NUMBER(5) Required
	p_cshr_end_date	End date and time of the cashiering session. DATE

Returns

A cursor variable that will fetch the set of records by cashier session.

f_query_one

Function f_query_one(p_pidm        tbraccd.tbraccd_pidm%TYPE,
                     p_tran_number tbraccd.tbraccd_tran_number%TYPE)
  RETURN receivable_ref

Selects one record using key.

Parameters

	p_pidm	Internal Identification Number of the person or non-person account, valid in SPRIDEN. NUMBER(8) Required Key
	p_tran_number	Transaction number (one-up within entity) of the transaction. NUMBER(8) Required Key

Returns

A cursor variable that will fetch exactly one record.

f_query_one_lock

Function f_query_one_lock(p_pidm        tbraccd.tbraccd_pidm%TYPE,
                          p_tran_number tbraccd.tbraccd_tran_number%TYPE,
                          p_rowid       VARCHAR2 DEFAULT NULL)
  RETURN receivable_ref

Selects one record and locks it.

Parameters

	p_pidm	Internal Identification Number of the person or non-person account, valid in SPRIDEN. NUMBER(8) Required Key
	p_tran_number	Transaction number (one-up within entity) of the transaction. NUMBER(8) Required Key
	p_rowid	Database rowid of record to select. VARCHAR2(18)

Returns

A cursor variable for one record, locking the record.

f_sum_balance

Function f_sum_balance(p_pidm             tbraccd.tbraccd_pidm%TYPE,
                       p_tran_number      tbraccd.tbraccd_tran_number%TYPE DEFAULT NULL,
                       p_term_code        tbraccd.tbraccd_term_code%TYPE DEFAULT NULL,
                       p_detail_code      tbraccd.tbraccd_detail_code%TYPE DEFAULT NULL,
                       p_dcat_code        tbbdetc.tbbdetc_dcat_code%TYPE DEFAULT NULL,
                       p_bill_date        tbraccd.tbraccd_bill_date%TYPE DEFAULT NULL,
                       p_srce_code        tbraccd.tbraccd_srce_code%TYPE DEFAULT NULL,
                       p_tran_number_paid tbraccd.tbraccd_tran_number_paid%TYPE DEFAULT NULL,
                       p_invoice_number   tbraccd.tbraccd_invoice_number%TYPE DEFAULT NULL,
                       p_inv_number_paid  tbraccd.tbraccd_inv_number_paid%TYPE DEFAULT NULL)
  RETURN NUMBER

Sum the balance column of records meeting parameter criteria.
Note that parameters other than pidm default to NULL and are ignored if not populated.
AND is used when multiple criteria are given.
Wildcard (%) may be used with term and detail code.

This function will return a null when no records match the parameters provided.

Parameters

	p_pidm	Internal Identification Number of the person or non-person account, valid in SPRIDEN. NUMBER(8) Required Key
	p_tran_number	Transaction number. Matched if given, or all. NUMBER(8)
	p_term_code	Term associated with the transaction. Wildcard is allowed, all if null. VARCHAR2(6)
	p_detail_code	Detail code associated with the transaction. Wildcard is allowed, all if null. VARCHAR2(4)
	p_dcat_code	Category code associated with the Detail Code. Matched if given, or all. VARCHAR2(3)
	p_bill_date	Date that the transaction is billed. Matched if given, or all. DATE
	p_srce_code	Source of the transaction when created on the account.Matched if given, or all. VARCHAR2(1)
	p_tran_number_paid	Transaction number paid. Matched if given, or all. NUMBER(8)
	p_invoice_number	Invoice number. Matched if given, or all. VARCHAR2(8)
	p_inv_number_paid	Transaction number paid. Matched if given, or all. VARCHAR2(8)

Returns

Sum of the Balance column, or null if no records match parameters.

f_sum_net_amount

Function f_sum_net_amount(p_pidm            tbraccd.tbraccd_pidm%TYPE,
                          p_term_code       tbraccd.tbraccd_term_code%TYPE DEFAULT NULL,
                          p_detail_code     tbraccd.tbraccd_detail_code%TYPE DEFAULT NULL,
                          p_dcat_code       tbbdetc.tbbdetc_dcat_code%TYPE DEFAULT NULL,
                          p_bill_date       tbraccd.tbraccd_bill_date%TYPE DEFAULT NULL,
                          p_srce_code       tbraccd.tbraccd_srce_code%TYPE DEFAULT NULL,
                          p_invoice_number  tbraccd.tbraccd_invoice_number%TYPE DEFAULT NULL,
                          p_inv_number_paid tbraccd.tbraccd_inv_number_paid%TYPE DEFAULT NULL,
                          p_as_of_date      tbraccd.tbraccd_effective_date%TYPE DEFAULT NULL)
  RETURN NUMBER

Net the original amount (charges less payments) of records meeting parameter criteria.
Note that parameters other than pidm default to NULL and are ignored if not populated AND is used when multiple criteria are given.
Wildcard (%) may be used with term and detail code.
If As Of Date is populated, records with Effective Date <= the date are summed.

This function will return a null when no records match the parameters provided.

Parameters

	p_pidm	Internal Identification Number of the person or non-person account, valid in SPRIDEN. NUMBER(8) Required Key
	p_term_code	Term associated with the transaction. Wildcard is allowed, all if null. VARCHAR2(6)
	p_detail_code	Detail code associated with the transaction. Wildcard is allowed, all if null. VARCHAR2(4)
	p_dcat_code	Category code associated with the Detail Code. Matched if given, or all. VARCHAR2(3)
	p_bill_date	Date that the transaction is billed. Matched if given, or all. DATE
	p_srce_code	Source of the transaction when created on the account. Matched if given, or all. VARCHAR2(1)
	p_invoice_number	Invoice number. Matched if given, or all. VARCHAR2(8)
	p_inv_number_paid	Transaction number paid. Matched if given, or all. VARCHAR2(8)
	p_as_of_date	As of effective date used to calculate net amount. DATE

Returns

Net of charges less payments of the Amount column, or null if no records match parameters.

p_adjust_balance

Procedure p_adjust_balance(p_pidm          tbraccd.tbraccd_pidm%TYPE,
                           p_tran_number   tbraccd.tbraccd_tran_number%TYPE,
                           p_adjust_amount tbraccd.tbraccd_balance%TYPE)

Add adjustment amount to the existing balance of a record (used to un-apply payment).
Enabled only for un-application of payments, and should not be used for other purposes.

Parameters

	p_pidm	Internal Identification Number of the person or non-person account, valid in SPRIDEN. NUMBER(8) Required Key
	p_tran_number	Transaction number (one-up within entity) of the transaction. NUMBER(8) Required Key
	p_adjust_amount	Amount to add to balance to increase (decrease) outstanding receivable. NUMBER(12,2) Required.

p_create

Procedure p_create(p_pidm                 tbraccd.tbraccd_pidm%TYPE,
                   p_term_code            tbraccd.tbraccd_term_code%TYPE,
                   p_detail_code          tbraccd.tbraccd_detail_code%TYPE,
                   p_user                 tbraccd.tbraccd_user%TYPE,
                   p_entry_date           tbraccd.tbraccd_entry_date%TYPE DEFAULT SYSDATE,
                   p_amount               tbraccd.tbraccd_amount%TYPE DEFAULT NULL,
                   p_effective_date       tbraccd.tbraccd_effective_date%TYPE,
                   p_bill_date            tbraccd.tbraccd_bill_date%TYPE DEFAULT NULL,
                   p_due_date             tbraccd.tbraccd_due_date%TYPE DEFAULT NULL,
                   p_desc                 tbraccd.tbraccd_desc%TYPE DEFAULT NULL,
                   p_receipt_number       tbraccd.tbraccd_receipt_number%TYPE DEFAULT NULL,
                   p_tran_number_paid     tbraccd.tbraccd_tran_number_paid%TYPE DEFAULT NULL,
                   p_crossref_pidm        tbraccd.tbraccd_crossref_pidm%TYPE DEFAULT NULL,
                   p_crossref_number      tbraccd.tbraccd_crossref_number%TYPE DEFAULT NULL,
                   p_crossref_detail_code tbraccd.tbraccd_crossref_detail_code%TYPE DEFAULT NULL,
                   p_srce_code            tbraccd.tbraccd_srce_code%TYPE DEFAULT 'T',
                   p_acct_feed_ind        tbraccd.tbraccd_acct_feed_ind%TYPE DEFAULT 'Y',
                   p_session_number       tbraccd.tbraccd_session_number%TYPE DEFAULT 0,
                   p_cshr_end_date        tbraccd.tbraccd_cshr_end_date%TYPE DEFAULT NULL,
                   p_crn                  tbraccd.tbraccd_crn%TYPE DEFAULT NULL,
                   p_crossref_srce_code   tbraccd.tbraccd_crossref_srce_code%TYPE DEFAULT NULL,
                   p_loc_mdt              tbraccd.tbraccd_loc_mdt%TYPE DEFAULT NULL,
                   p_loc_mdt_seq          tbraccd.tbraccd_loc_mdt_seq%TYPE DEFAULT NULL,
                   p_rate                 tbraccd.tbraccd_rate%TYPE DEFAULT NULL,
                   p_units                tbraccd.tbraccd_units%TYPE DEFAULT NULL,
                   p_document_number      tbraccd.tbraccd_document_number%TYPE DEFAULT NULL,
                   p_trans_date           tbraccd.tbraccd_trans_date%TYPE DEFAULT NULL,
                   p_payment_id           tbraccd.tbraccd_payment_id%TYPE DEFAULT NULL,
                   p_invoice_number       tbraccd.tbraccd_invoice_number%TYPE DEFAULT NULL,
                   p_statement_date       tbraccd.tbraccd_statement_date%TYPE DEFAULT NULL,
                   p_inv_number_paid      tbraccd.tbraccd_inv_number_paid%TYPE DEFAULT NULL,
                   p_curr_code            tbraccd.tbraccd_curr_code%TYPE DEFAULT NULL,
                   p_exchange_diff        tbraccd.tbraccd_exchange_diff%TYPE DEFAULT NULL,
                   p_foreign_amount       tbraccd.tbraccd_foreign_amount%TYPE DEFAULT NULL,
                   p_late_dcat_code       tbraccd.tbraccd_late_dcat_code%TYPE DEFAULT NULL,
                   p_atyp_code            tbraccd.tbraccd_atyp_code%TYPE DEFAULT NULL,
                   p_atyp_seqno           tbraccd.tbraccd_atyp_seqno%TYPE DEFAULT NULL,
                   p_card_type_vr         tbraccd.tbraccd_card_type_vr%TYPE DEFAULT NULL,
                   p_card_exp_date_vr     tbraccd.tbraccd_card_exp_date_vr%TYPE DEFAULT NULL,
                   p_card_auth_number_vr  tbraccd.tbraccd_card_auth_number_vr%TYPE DEFAULT NULL,
                   p_crossref_dcat_code   tbraccd.tbraccd_crossref_dcat_code%TYPE DEFAULT NULL,
                   p_orig_chg_ind         tbraccd.tbraccd_orig_chg_ind%TYPE DEFAULT NULL,
                   p_ccrd_code            tbraccd.tbraccd_ccrd_code%TYPE DEFAULT NULL,
                   p_merchant_id          tbraccd.tbraccd_merchant_id%TYPE DEFAULT NULL,
                   p_data_origin          tbraccd.tbraccd_data_origin%TYPE DEFAULT NULL,
                   p_cpdt_ind             tbraccd.tbraccd_cpdt_ind%TYPE DEFAULT NULL,
                   p_override_hold        VARCHAR2 DEFAULT 'N',
                   p_aidy_code            tbraccd.tbraccd_aidy_code%TYPE DEFAULT NULL,
                   p_stsp_key_sequence    tbraccd.tbraccd_stsp_key_sequence%TYPE DEFAULT NULL,
                   p_period               tbraccd.tbraccd_period%TYPE DEFAULT NULL,
                   p_tran_number_out      OUT tbraccd.tbraccd_tran_number%TYPE,
                   p_rowid_out            OUT VARCHAR2)

Creates a student or non-student charge or payment.
Student transactions are identified by a Term Code which is valid in the Term Code validation table STVTERM. Non-student transactions are identified by a Term Code of ARTERM.

Required fields are PIDM, Term Code, Detail Code, User (cashier), and Effective Date.
The Transaction Number is determined by the API and returned as an OUT parameter.
Amount is required except where it may be calculated using -
   Currency Code and Foreign Amount
   Units times Rate (non-student transactions only)
   If one of these data pairs and Amount are both populated, then the calculation must yield the Amount provided.
   The Balance is set based on the Amount and the type of Detail Code used.

Bill and Due Date must both be populated or both null; Due date must be greater than or equal to Bill Date.
Description will default from the Detail Code if not provided.
Source code will default to T (user entered transaction).
Accounting Feed will default to Y.
Session Number will default to 0 (current session). Any other value requires Cashier End Date, and the combination must be valid in the Cashier Session table TBBCSHR.
Address data (atyp_code and atyp_seqno valid in address table STVADDR) is required for non-student transactions, and not allowed on student transactions. If both are left null, an attempt will be made to default from the Customer Profile (TBBCPRF).
Receipt Number is never generated by the API, it must be determined in advance and provided as a parameter.
Currency Code and Foreign Amount are both null or both provided; see additional information regarding these values and the Exchange Difference with documentation for p_curr_conv_exch in TB_RECEIVABLE_RULES.
Cross Reference data (identified as _crossref_ ) are used in processing Third Party Contracts, Exemptions, and Deposits, and should not be populated for other purposes.
Credit Card data should be pre-validated.
Other optional parameters may also have editing to enforce Accounts Receivable business rules.

Many aspects of the creation of a Receivable record are governed by the Context under which the API is called. Two which may be used to interface data from external systems for Package Name TB_RECEIVABLE are:

Context Name Context Value Purpose

ENABLE_SOURCE Any valid Source Code (TTVSRCE). Overrides the Transaction Entry Allowed indicator for "System Maintained" Source Codes.

SYSTEM_TRAN TRUE Process transactions generated from existing data and rules, such as Fee Assessment or Financial Aid Disbursement. Bypasses Hold and User Profile Security checking. Enables use of inactive Detail Codes and any valid Source Code. Enables Effective Date other than SYSDATE for Payments, and prior Effective Date for Charges. Sets the Original Charge Indicator without regard to existing Title IV withdrawal records.

Parameters

p_pidm

Internal Identification Number of the person or non-person account, valid in SPRIDEN. NUMBER(8) Required Key

p_term_code

Term associated with the transaction. For student transactions valid in STVTERM, or ARTERM for non-student transactions. VARCHAR2(6) Required

p_detail_code

Detail code associated with the transaction, valid in TBBDETC. VARCHAR2(4) Required

p_user

User ID of the cashier who created the transaction. VARCHAR2(30) Required

p_entry_date

Entry date and time of the transaction, when initially created. DATE Required

p_amount

Amount of the transaction. NUMBER(12,2) Required

p_effective_date

Effective date of the transaction used to calculate amount due, determine placement on the bill, and control feed to finance system based on Accounts Receivable System Control setting. DATE Required

p_bill_date

Date that the transaction is billed. DATE

p_due_date

Due date set when the transaction is billed. DATE

p_desc

Free-Form description associated with the transaction. Default value comes from the Detail Code description (TBBDETC). VARCHAR2(30)

p_receipt_number

Receipt number associated with the transaction. NUMBER(8)

p_tran_number_paid

Transaction Number Paid is used in application of payment to force this transaction to liquidate a specific transaction on the account. NUMBER(8)

p_crossref_pidm

Cross Reference internal identification number for third party transactions. For the third party account, refers to the associated student. For the student account, refers to the third party, valid in SPRIDEN. NUMBER(8)

p_crossref_number

Cross Reference Number. NUMBER(8) Used for

	1)	Third party transactions (contract number when source code is C)
	2)	Exemption credits (exemption number when source code is E)
	3)	Deposits released (deposit transaction number when source code is D)

p_crossref_detail_code

Cross Reference Detail Code for contract or exemption credits calculated based on detail code rules, valid in TBBDETC. VARCHAR2(4)

p_srce_code

Source of the transaction when created on the account, including registration, housing, deposit, user entered, and so on. The default value is user entered transaction (T), valid in TTVSRCE. VARCHAR2(1) Required

p_acct_feed_ind

Accounting Feed Indicator. VARCHAR2(1)

	Y	Feed transaction (default)
	F	Transaction fed
	N	Do not feed transaction

p_session_number

Cashier session number in which this transaction was posted (0 = current session is default). NUMBER(5)

p_cshr_end_date

End date and time of the cashiering session for this transaction. DATE

p_crn

Course Reference Number (CRN) of the course which generated the charge, when Track by CRN is used in Fee Assessment. VARCHAR2(5)

p_crossref_srce_code

Cross Reference Source for contract or exemption credits, valid in TTVSRCE. VARCHAR2(1)

p_loc_mdt

Location Management Type. VARCHAR2(1)

	M	Monthly charges
	T	Term-based charges
	D	Daily charges

p_loc_mdt_seq

Location Management sequence in which monthly charges were added. Used in subsequent processing to calculate adjustments. NUMBER(2)

p_rate

A per-unit rate used to calculate the amount. Optional for non-student transactions; not allowed for student transactions. NUMBER(12,6)

p_units

Number of Units is multiplied by the specified Rate to calculate the amount. Optional for non-student transactions; not allowed for student transactions. NUMBER(12,6)

p_document_number

Document number that references a source document for the transaction. VARCHAR2(8)

p_trans_date

Transaction date used by the finance system to control posting to the ledgers. DATE

p_payment_id

Free-Form information identifying a payment; often used to record check or credit card number. VARCHAR2(20)

p_invoice_number

Invoice Number identifies a group of charges invoiced via one statement. VARCHAR2(8)

p_statement_date

The date a statement was generated. DATE

p_inv_number_paid

Invoice Number Paid is used in application of payment to force a payment to liquidate a specific group of charges. VARCHAR2(8)

p_curr_code

Foreign currency code used when creating a payment, valid in GTVCURR and GURCURR. VARCHAR2(4)

p_exchange_diff

Exchange difference between a foreign currency amount as of the date entered and the value

	1)	as of the bill date when processed with Invoice Number Paid or
	2)	as of the charge transaction date when processed with Transaction Number Paid. NUMBER(12,2)

p_foreign_amount

Amount of the transaction stated in foreign currency. NUMBER(12,2)

p_late_dcat_code

Category of the late charge detail code, valid in TTVDCAT. VARCHAR2(3)

p_atyp_code

In combination with ATYP_SEQNO, the address where the bill for this transaction will be sent. Required for non-student transactions; not allowed for student transactions. Valid in STVATYP. VARCHAR2(2)

p_atyp_seqno

In combination with ATYP_CODE, the address where the bill for this transaction will be sent. Required for non-student transactions; not allowed for student transactions. Combination valid and active in SPRADDR. NUMBER(2)

p_card_type_vr

Credit Card Type used for Voice Response messages, valid in TTVCCRD. VARCHAR2(1)

p_card_exp_date_vr

Credit card expiration date supplied at time of credit card payment. DATE

p_card_auth_number_vr

Credit card authorization number received when transaction was processed. VARCHAR2(12)

p_crossref_dcat_code

Cross Reference Category Code for contract or exemption credits calculated based on category code rules, valid in TTVDCAT. VARCHAR2(3)

p_orig_chg_ind

Indicates that the transaction is to be considered as an original charge for the Title IV recalculation process, as opposed to subsequent adjustments due to withdrawal. Valid values are Y (original) or null. VARCHAR2(1)

p_ccrd_code

Code identifying Credit Card Type used in authorizations via gateway, valid in GTVCCRD. VARCHAR2(10)

p_merchant_id

Merchant ID associated with the Process Name Code, Credit Card Type Code, and System Code. The Merchant ID is included in the credit card payment request transmitted to the vendor handling credit card payments. VARCHAR2(20)

p_data_origin

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

p_cpdt_ind

Indicates that contract payment detail is used for application of a payment to contract charges. VARCHAR2(1)

	Y	Contract payment detail by student used for application of payments
	NULL	No additional contract payment detail (default)

p_override_hold

Parameter to override Accounts Receivable hold. VARCHAR2(1)

	N	Check for AR hold (default)
	Y	Bypass hold checking

p_aidy_code

The aid year associated with the Financial Aid disbursement. VARCHAR2(4)

p_stsp_key_sequence

Key sequence of the study path for the course registration. NUMBER(2)

p_period

The enrollment period code for Financial Aid disbursement. VARCHAR2(15)

p_tran_number_out

Returns transaction number assigned for detail transaction on the account. NUMBER(8) Required

p_rowid_out

Database rowid of record created. VARCHAR2(18) Required

p_delete

Procedure p_delete(p_pidm        tbraccd.tbraccd_pidm%TYPE,
                   p_tran_number tbraccd.tbraccd_tran_number%TYPE,
                   p_rowid       VARCHAR2 DEFAULT NULL)

Deletes a record.
Delete is enabled for Purge processing only, and should not be called for other purposes.

Parameters

	p_pidm	Internal Identification Number of the person or non-person account, valid in SPRIDEN. NUMBER(8) Required Key
	p_tran_number	Transaction number (one-up within entity) of the transaction. NUMBER(8) Required Key
	p_rowid	Database rowid of record to delete. VARCHAR2(18)

p_lock

Procedure p_lock(p_pidm        tbraccd.tbraccd_pidm%TYPE,
                 p_tran_number tbraccd.tbraccd_tran_number%TYPE,
                 p_rowid_inout IN OUT VARCHAR2)

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_pidm	Internal Identification Number of the person or non-person account, valid in SPRIDEN. NUMBER(8) Required Key
	p_tran_number	Transaction number (one-up within entity) of the transaction. NUMBER(8) Required Key
	p_rowid_inout	Database rowid of record to lock. VARCHAR2(18) Required

p_update

Procedure p_update(p_pidm              tbraccd.tbraccd_pidm%TYPE,
                   p_tran_number       tbraccd.tbraccd_tran_number%TYPE,
                   p_balance           tbraccd.tbraccd_balance%TYPE DEFAULT dml_common.f_unspecified_number,
                   p_effective_date    tbraccd.tbraccd_effective_date%TYPE DEFAULT dml_common.f_unspecified_date,
                   p_bill_date         tbraccd.tbraccd_bill_date%TYPE DEFAULT dml_common.f_unspecified_date,
                   p_due_date          tbraccd.tbraccd_due_date%TYPE DEFAULT dml_common.f_unspecified_date,
                   p_desc              tbraccd.tbraccd_desc%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_tran_number_paid  tbraccd.tbraccd_tran_number_paid%TYPE DEFAULT dml_common.f_unspecified_number,
                   p_acct_feed_ind     tbraccd.tbraccd_acct_feed_ind%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_session_number    tbraccd.tbraccd_session_number%TYPE DEFAULT dml_common.f_unspecified_number,
                   p_cshr_end_date     tbraccd.tbraccd_cshr_end_date%TYPE DEFAULT dml_common.f_unspecified_date,
                   p_document_number   tbraccd.tbraccd_document_number%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_trans_date        tbraccd.tbraccd_trans_date%TYPE DEFAULT dml_common.f_unspecified_date,
                   p_payment_id        tbraccd.tbraccd_payment_id%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_invoice_number    tbraccd.tbraccd_invoice_number%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_statement_date    tbraccd.tbraccd_statement_date%TYPE DEFAULT dml_common.f_unspecified_date,
                   p_inv_number_paid   tbraccd.tbraccd_inv_number_paid%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_feed_date         tbraccd.tbraccd_feed_date%TYPE DEFAULT dml_common.f_unspecified_date,
                   p_feed_doc_code     tbraccd.tbraccd_feed_doc_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_atyp_code         tbraccd.tbraccd_atyp_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_atyp_seqno        tbraccd.tbraccd_atyp_seqno%TYPE DEFAULT dml_common.f_unspecified_number,
                   p_orig_chg_ind      tbraccd.tbraccd_orig_chg_ind%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_tax_rept_year     tbraccd.tbraccd_tax_rept_year%TYPE DEFAULT dml_common.f_unspecified_number,
                   p_tax_rept_box      tbraccd.tbraccd_tax_rept_box%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_tax_amount        tbraccd.tbraccd_tax_amount%TYPE DEFAULT dml_common.f_unspecified_number,
                   p_tax_future_ind    tbraccd.tbraccd_tax_future_ind%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_data_origin       tbraccd.tbraccd_data_origin%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_cpdt_ind          tbraccd.tbraccd_cpdt_ind%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_rowid             VARCHAR2 DEFAULT NULL,
                   p_aidy_code         tbraccd.tbraccd_aidy_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_stsp_key_sequence tbraccd.tbraccd_stsp_key_sequence%TYPE DEFAULT dml_common.f_unspecified_number,
                   p_period            tbraccd.tbraccd_period%TYPE DEFAULT dml_common.f_unspecified_string)

Updates a record.
All parameters which are not specified retain the value from the existing record. No defaulting occurs during update.

PIDM and Transaction Number, or ROWID required.
Most updates to the record will be made by system processes.
End user updates might include changes to -
    Description
    Transaction Number Paid or Invoice Number Paid (if other applications do not exist)
    Address of non-student transaction (no defaulting occurs on update)
    Payment ID or Document Number
    Original Charge Indicator

Parameters

p_pidm

Internal Identification Number of the person or non-person account, valid in SPRIDEN. NUMBER(8) Required Key

p_tran_number

Transaction number (one-up within entity) of the transaction. NUMBER(8) Required Key

p_balance

Balance remaining for the transaction, as adjusted by the application of payment process. A negative balance is a credit on the account; a positive balance is a charge. NUMBER(12,2)

p_effective_date

Effective date of the transaction used to calculate amount due, determine placement on the bill, and control feed to finance system based on Accounts Receivable System Control setting. DATE

p_bill_date

Date that the transaction is billed. DATE

p_due_date

Due date set when the transaction is billed. DATE

p_desc

Free-Form description associated with the transaction. Default value comes from the Detail Code description (TBBDETC). VARCHAR2(30)

p_tran_number_paid

Transaction Number Paid is used in application of payment to force this transaction to liquidate a specific transaction on the account. NUMBER(8)

p_acct_feed_ind

Accounting Feed Indicator. VARCHAR2(1)

	Y	Feed transaction
	F	Transaction fed
	N	Do not feed transaction

p_session_number

Cashier session number in which this transaction was posted (0 = current session). NUMBER(5)

p_cshr_end_date

End date and time of the cashiering session for this transaction. DATE

p_document_number

Document number that references a source document for the transaction. VARCHAR2(8)

p_trans_date

Transaction date used by the finance system to control posting to the ledgers. DATE

p_payment_id

Free-Form information identifying a payment; often used to record check or credit card number. VARCHAR2(20)

p_invoice_number

Invoice Number identifies a group of charges invoiced via one statement. VARCHAR2(8)

p_statement_date

The date a statement was generated. DATE

p_inv_number_paid

Invoice Number Paid is used in application of payment to force a payment to liquidate a specific group of charges. VARCHAR2(8)

p_feed_date

Date this transaction was fed to the finance system. DATE

p_feed_doc_code

Document code used to feed this transaction to the finance system. VARCHAR2(8)

p_atyp_code

p_atyp_seqno

p_orig_chg_ind

p_tax_rept_year

Tax Year in which the transaction was reported on form 1098-T. NUMBER(4)

p_tax_rept_box

Tax Report Box in which the transaction was reported on form 1098-T. VARCHAR2(2)

	CB	Qualified Charges Billed
	AC	Adjustments to Prior Charges
	SG	Scholarship or Grant
	AS	Adjustments to Scholarship or Grant

p_tax_amount

Tax Amount as reported on form 1098-T. Sign relates pay type to report box, and may be pro-rated based on allocation rules. NUMBER(12,2)

p_tax_future_ind

Tax Report Future Indicator is valued with Y if the transaction was reported on form 1098-T as a term beginning in a future tax year, or null. VARCHAR2(1)

p_data_origin

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

p_cpdt_ind

Indicates that contract payment detail is used for application of a payment to contract charges. VARCHAR2(1)

	Y	Contract payment detail by student used for application of payments
	NULL	No additional contract payment detail (default)

p_rowid

Database rowid of record to update. VARCHAR2(18)

p_aidy_code

The aid year associated with the Financial Aid disbursement. VARCHAR2(4)

p_stsp_key_sequence

Key sequence of the study path for the course registration. NUMBER(2)

p_period

The enrollment period code for Financial Aid disbursement. VARCHAR2(15)

Context Name	Context Value	Purpose
ENABLE_SOURCE	Any valid Source Code (TTVSRCE).	Overrides the Transaction Entry Allowed indicator for "System Maintained" Source Codes.
SYSTEM_TRAN	TRUE	Process transactions generated from existing data and rules, such as Fee Assessment or Financial Aid Disbursement. Bypasses Hold and User Profile Security checking. Enables use of inactive Detail Codes and any valid Source Code. Enables Effective Date other than SYSDATE for Payments, and prior Effective Date for Charges. Sets the Original Charge Indicator without regard to existing Title IV withdrawal records.