| 1 |
charge_credit_id |
Required |
Unique ID for the charge (should remain stable over time). Use the database primary key if available. |
PS_ACCOUNT_SF.EMPLID • PS_ITEM_SF.ITEM_TERM • PS_ITEM_SF.ITEM_NBR, joined with - |
TBRACCD.TBRACCD_PIDM • TBRACCD.TBRACCD_TRAN_NUMBER, joined with -; anticipated aid rows: RPRATRM.RPRATRM_PIDM • RPRATRM.RPRATRM_AIDY_CODE • RFRBASE.RFRBASE_DETAIL_CODE (or RPRATRM.RPRATRM_FUND_CODE when blank) • RPRATRM.RPRATRM_PERIOD, joined with -; memo rows: TBRMEMO.TBRMEMO_PIDM • TBRMEMO.TBRMEMO_TRAN_NUMBER, joined with -M- |
CHARGECREDIT.CHARGECREDITNUMBER |
|
| 2 |
student_id |
Required |
SIS student identifier mapped to the students file. |
PS_ACCOUNT_SF.EMPLID |
SPRIDEN.SPRIDEN_ID (current record, SPRIDEN_CHANGE_IND is null) |
CHARGECREDIT.PEOPLE_ORG_CODE_ID |
Links to student. |
| 3 |
academic_year |
Required |
Map to the academic calendar file row the charge is associated with. |
PS_TERM_TBL.TERM_BEGIN_DT (year only) |
STVTERM.STVTERM_START_DATE (year only) |
CHARGECREDIT.ACADEMIC_YEAR |
Payments will be posted back to appropriate year/term/session. |
| 4 |
academic_term |
Required |
Map to the academic calendar file row the charge is associated with. |
PS_ACCOUNT_SF.ACCOUNT_TERM, or PS_ITEM_SF.ITEM_TERM when blank |
TBRACCD.TBRACCD_TERM_CODE; anticipated aid rows: RPRATRM.RPRATRM_PERIOD; memo rows: TBRMEMO.TBRMEMO_TERM_CODE |
CHARGECREDIT.ACADEMIC_TERM |
Payments will be posted back to appropriate year/term/session. |
| 5 |
academic_session |
|
Map to the academic calendar file row the charge is associated with. |
|
|
CHARGECREDIT.ACADEMIC_SESSION |
Payments will be posted back to appropriate year/term/session. |
| 6 |
code |
Required |
Internal or institutional code for the charge (e.g., "TUIT-UG") |
PS_ITEM_SF.ITEM_TYPE; anticipated aid rows: constant ANTICAID |
TBRACCD.TBRACCD_DETAIL_CODE; anticipated aid rows: RFRBASE.RFRBASE_DETAIL_CODE, or RPRATRM.RPRATRM_FUND_CODE when blank; memo rows: TBRMEMO.TBRMEMO_DETAIL_CODE |
CHARGECREDIT.CHARGE_CREDIT_CODE |
|
| 7 |
code_med_desc |
|
Short label tied to the charge code (e.g., "UG Tuition", "Fin Aid") |
|
|
CODE_CHARGECREDIT.MEDIUM_DESC |
|
| 8 |
code_long_desc |
|
Long label tied to the charge code (e.g., "Undergraduate Tuition", "Financial Aid") |
|
TBBDETC.TBBDETC_DESC; anticipated aid rows: TBBDETC.TBBDETC_DESC, or RFRBASE.RFRBASE_FUND_TITLE when blank |
CODE_CHARGECREDIT.LONG_DESC |
|
| 9 |
type |
Required |
Highest-level classification of the charge, like R for cash receipt or C for charge. |
PS_ITEM_SF.ITEM_TYPE_CD; anticipated aid rows: constant ANTICAID |
TBBDETC.TBBDETC_TYPE_IND; anticipated aid rows: TBBDETC.TBBDETC_TYPE_IND, or constant P when blank |
CHARGECREDIT.CHARGE_CREDIT_TYPE |
|
| 10 |
amount |
Required |
Monetary value of the charge (positive or negative) |
PS_ITEM_SF.ITEM_AMT; anticipated aid rows: PS_ANTC_AID_TERM.NET_AWARD_AMT |
TBRACCD.TBRACCD_AMOUNT; anticipated aid rows: RPRATRM.RPRATRM_AUTHORIZE_AMT + RPRATRM.RPRATRM_MEMO_AMT; memo rows: TBRMEMO.TBRMEMO_AMOUNT |
CHARGECREDIT.AMOUNT |
Sign can optionally be flipped per-term. Some SIS's represent payments as positive, some as negative. |
| 11 |
paid_amount |
|
Reserved for future use. |
|
|
CHARGECREDIT.PAID_AMOUNT |
|
| 12 |
balance_amount |
|
Reserved for future use. |
|
TBRACCD.TBRACCD_BALANCE |
CHARGECREDIT.BALANCE_AMOUNT |
|
| 13 |
note |
|
Any note entered on the specific charge. Rare; not show to students. Useful for troubleshooting. |
|
|
CHARGECREDIT.NOTE |
|
| 14 |
is_prebill |
|
Y/N indicating that the charge is not yet real. Don't use for aid unless it's in your pending transaction table. |
|
|
CHARGECREDIT.PREBILL_FLAG |
If Y, automatically hidden from students. |
| 15 |
is_eligible_fin_aid |
|
Reserved for future use. |
|
|
CHARGECREDIT.FIN_AID_ELIGIBLE |
|
| 16 |
is_eligible_refund |
|
Reserved for future use. |
|
|
CHARGECREDIT.REFUND_ELIGIBLE |
|
| 17 |
batch_number |
|
Batch number the charge is part of, if applicable. |
|
|
CHARGECREDIT.BATCH |
|
| 18 |
is_printed_stmt |
|
Y/N whether the charge has been printed on a statement |
|
|
CHARGECREDIT.PRINTED_ON_STMT |
|
| 19 |
first_stmt_date |
|
Date of the first statement on which charge was printed. |
|
|
CHARGECREDIT.FIRST_STMT_DATE |
|
| 20 |
due_date |
|
Reserved for future use. |
|
TBRACCD.TBRACCD_DUE_DATE |
CHARGECREDIT.DUE_DATE |
|
| 21 |
description |
Required |
Individualized description of the charge line (e.g., "Full Time Tuition Spring ADJUSTED") |
PS_ITEM_TYPE_TBL.DESCR; anticipated aid rows: constant ANTICIPATEDAID |
TBRACCD.TBRACCD_DESC, or TBBDETC.TBBDETC_DESC when blank; anticipated aid rows: TBBDETC.TBBDETC_DESC, or RFRBASE.RFRBASE_FUND_TITLE when blank; memo rows: TBRMEMO.TBRMEMO_DESC, or TBBDETC.TBBDETC_DESC when blank |
CHARGECREDIT.CRG_CRD_DESC |
|
| 22 |
entry_date |
Required |
Nominal date of the charge that will be shown to students. |
PS_ITEM_SF.LAST_ACTIVITY_DATE; anticipated aid rows: SYSDATE |
TBRACCD.TBRACCD_ENTRY_DATE; anticipated aid rows: RPRAWRD.RPRAWRD_ACCEPT_DATE; memo rows: TBRMEMO.TBRMEMO_ENTRY_DATE |
CHARGECREDIT.ENTRY_DATE |
|
| 23 |
is_anticipated |
Required |
Y/N Indicates anticipated (not yet disbursed) aid. |
Constant N; anticipated aid rows: Y |
Constant N; anticipated aid and memo rows: Y |
CHARGECREDIT.ANTICIPATED_FLAG |
By default, undisbursed aid will not reduce the balance in other terms. |
| 24 |
scheduled_disbursed_date |
|
When the aid will be disbursed. Only applies to aid rows. |
|
|
CHARGECREDIT.SCHED_DISB_DATE |
|
| 25 |
is_assessed |
|
Y/N whether charge was created by rules (vs manually entered) |
|
|
CHARGECREDIT.ASSESSED_FLAG |
|
| 26 |
is_voided |
|
Y/N whether the charge has been voided. |
|
|
CHARGECREDIT.VOID_FLAG |
If Y, automatically hidden from students. |
| 27 |
is_posted |
|
Y/N whether the charge has been posted to the G/L |
|
|
CHARGECREDIT.POSTED_FLAG |
|
| 28 |
stmt_type |
|
Statement type on which the charge was printed |
|
|
CHARGECREDIT.STATEMENT_TYPE |
|
| 29 |
summary_type |
Required |
Classification of the charge by purpose (e.g., "TUITION, HOUSING, FA") if the SIS offers it. Alternately, a classification more granular than type. Useful for configuring bill presentation. |
PS_ITEM_SF.FEE_CD |
TBBDETC.TBBDETC_DCAT_CODE |
CHARGECREDIT.SUMMARY_TYPE |
|
| 30 |
summary_type_med_desc |
|
summary_type short label (e.g., "Student Charges, Financial Aid"). Not user-facing, but useful for configuring billing. |
|
TTVDCAT.TTVDCAT_DESC |
CODE_SUMMARYTYPE.MEDIUM_DESC |
|
| 31 |
summary_type_long_desc |
|
summary_type long label (e.g., "Student Charges, Financial Aid"). Not user-facing, but useful for configuring billing. |
|
|
CODE_SUMMARYTYPE.LONG_DESC |
|
| 32 |
receipt_number |
|
Unused |
|
|
CHARGECREDIT.RECEIPT_NUMBER |
|
| 33 |
has_details |
|
Unused |
|
|
CHARGECREDIT.DETAIL_FLAG |
|
| 34 |
created_at |
|
Creation timestamp (audit trail, not nominal) |
|
|
CHARGECREDIT.CREATE_DATE + CHARGECREDIT.CREATE_TIME |
|
| 35 |
modified_at |
|
Modification timestamp (audit trail, not nominal) |
|
|
CHARGECREDIT.REVISION_DATE + CHARGECREDIT.REVISION_TIME |
|
| 36 |
true_academic_year |
|
Map to the academic calendar file row the charge is associated with. |
|
STVTERM.STVTERM_ACYR_CODE |
CHARGECREDIT.TRUE_ACADEMIC_YEAR |
Payments will be posted back to appropriate year/term/session. |
| 37 |
beginning_balance_flag |
|
Whether this charge represents a forward balance. |
|
|
CHARGECREDIT.BEGINNING_BAL_FLAG |
If Y, automatically hidden from students. |
| 38 |
is_reversed |
|
Y/N the transaction has had a reversal entered |
|
|
CHARGECREDIT.REVERSED |
|
| 39 |
reversed_number |
|
The charge_credit_id of the reversing entry |
|
|
CHARGECREDIT.REVERSED_NUMBER |
|
| 40 |
is_pay_plan |
|
Unused |
|
|
CHARGECREDIT.PAYPLAN_FLAG |
|
| 41 |
source_code |
|
Which process or office created the charge/credit, such as Banner's TTVSRCE. |
|
TBRACCD.TBRACCD_SRCE_CODE; memo rows: TBRMEMO.TBRMEMO_SRCE_CODE |
CASHRECEIPT.OFFICE |
|
| 42 |
cash_receipt_payment_type |
|
Unused |
|
|
|
|
| 43 |
cash_receipt_note |
|
Unused |
|
|
|
|
| 44 |
cash_receipt_description |
|
Unused |
|
|
|
|
| 45 |
cash_receipt_payment_plan_applied |
|
Unused |
|
|
|
|
| 46 |
cash_receipt_voided_date |
|
Unused |
|
|
|
|
| 47 |
cash_receipt_posted_date |
|
Unused |
|
|
|
|
| 48 |
cash_receipt_created_at |
|
Unused |
|
|
|
|
| 49 |
cash_receipt_modified_at |
|
Unused |
|
|
|
|
| 50 |
academic_session_start_date |
|
Unused |
|
|
|
|
| 51 |
academic_session_end_date |
|
Unused |
|
|
|
|
| 52 |
current_balance |
|
Student's overall balance. Used for integrity checking. All charges across rows for the student should sum to this number. Evaluated after flipping signs by type, where applicable. |
|
|
PEOPLEORGBALANCE.BALANCE_AMOUNT |
|
| 53 |
academic_term_balance |
|
Unused |
|
|
|
|
| 54 |
academic_session_balance |
|
Unused |
|
|
|
|
| 55 |
tuition_plan |
|
Extra field that can indicate special circumstances like a discounted tuition rate. |
|
|
STUDENTFINANCIAL.TUITION_PLAN |
|
| 56 |
tuition_plan_term |
|
Extra field that can indicate special circumstances like a discounted tuition rate. |
|
|
|
|
| 57 |
ar_type |
|
Accounts-receivable type the charge belongs to. Leave blank if your SIS does not use AR types. |
|
|
|
Payments can optionally be posted back to appropriate AR Type. |