Data Field Details
Use the values in the following table to create your custom API.
|
Line Nbr |
Column Name |
Type |
MSSQL Length |
Precision |
Scale |
Comments |
Gift Session Sample Data |
Pledge Session Sample Data |
|---|---|---|---|---|---|---|---|---|
|
1 |
BUSINESS_UNIT |
Char KEY |
5 |
Not Applicable (NA) |
Not Applicable (NA) |
This is the business unit for the session. |
PSUNV |
PSUNV |
|
2 |
SEQ_NBR |
decimal KEY |
15 |
15 |
0 |
A unique, consecutive number that identifies a row of data to be processed in the AVPGPLOA process. |
1 |
2 |
|
3 |
AV_SESS_TYPE |
char KEY |
2 |
NA |
NA |
The type of session to be created. Valid values are: G = Gift session PL = Pledge session. Note: Gift sessions can handle only outright gifts with no links to an existing pledge. Pledge sessions only process new pledges. Pledge payments should not be entered through this process, but must be entered through the online process to ensure update of the pledge records and pledge schedules. |
G |
PL |
|
4 |
EMPLID |
char |
11 |
NA |
NA |
The ID number of the person who is making the gift or pledge. Note: If this field is entered, the EXT_ORG_ID field (Line 5) must be blank. |
AV0027 |
Leave blank |
|
5 |
EXT_ORG_ID |
char |
11 |
NA |
NA |
The ID number of the organization who is making the gift or pledge. Note: If this field is entered, the EMPLID field (Line 4) must be blank. |
Leave blank |
AV1019 |
|
6 |
GIFT_AMT |
decimal |
15 |
13 |
2 |
The monetary amount of the gift or pledge. |
1000.00 |
12000.00 |
|
7 |
GIFT_TYPE |
char |
6 |
NA |
NA |
For Gift Session (AV_SESS_TYPE = 'G'), enter 'GIFT' only. No other gift types are valid. Otherwise, leave blank. |
GIFT |
Leave blank |
|
8 |
PLEDGE_GIFT_NO |
char |
11 |
NA |
NA |
This field exists for future development and is not used in the current process. |
NA |
NA |
|
9 |
FISCAL_YEAR |
smallint |
24 |
5 |
0 |
The financial year during which the gift or pledge is to be counted. |
2003 |
2003 |
|
10 |
GIFT_DT |
PSDATE |
10 |
NA |
NA |
The date of record for the gift or pledge. |
01-01-2003 |
01-01-2003 |
|
11 |
TENDER_TYPE |
char |
6 |
NA |
NA |
The payment method for the gift. Must be a valid value from the AV_TENDER_TBL. Note: The tender type must be valid for the session business unit. A tender type is valid only if it is current and has a setID that correlates to the corresponding set control value for record group AV02_GIFT for BUSINESS_UNIT (Line1). |
CHK |
Leave blank |
|
12 |
CURRENCY_CD |
char |
3 |
NA |
NA |
The type of money being used to pay the gift, for example U.S. Dollars or Euros. Note: Pledges are always entered in the base currency of the institution. |
USD |
Leave blank |
|
13 |
CHECK_NO |
char |
10 |
NA |
NA |
For Gift Session (AV_SESS_TYPE = 'G'), the number of the donor's check if the tender is a check. Note: If a check number is entered, the credit card fields (Lines 14-17) must be blank since a gift has only one tender type. |
Leave blank |
Leave blank |
|
Important! The following four fields are inactive. DO NOT USE as they are replaced with new Active Fields for credit card referenced below. |
||||||||
|
14 |
CREDIT_CARD_NO Inactive field |
char |
20 |
NA |
NA |
Do not use. Note: This field is not secured and can be queried using a database query tool. Also, this field should be empty if CHECK_NO (Line13) has data. |
Do not use |
Do not use |
|
15 |
CREDIT_CARD_HOLDER Inactive field |
char |
30 |
NA |
NA |
Do not use. Note: This field is not secured and can be queried using a database query tool. Also, this field should be empty if CHECK_NO (Line13) has data. |
Do not use |
Do not use |
|
16 |
CREDIT_CARD_TYPE Inactive field |
char |
2 |
NA |
NA |
Do not use. Note: This field is not secured and can be queried using a database query tool. Also, this field should be empty if CHECK_NO (Line13) has data. |
Do not use |
Do not use |
|
17 |
CREDIT_CARD_EXP_DT Inactive field |
PSDATE |
8 |
NA |
NA |
Do not use. Note: This field is not secured and can be queried using a database query tool. Also, this field should be empty if CHECK_NO (Line13) has data. |
Do not use |
Do not use |
|
18 |
TENDER_TYPE_NOTE |
char |
50 |
NA |
NA |
Short comment related to the gift tender. |
NA |
Leave blank |
|
19 |
CAE_GIFT_TYPE |
char |
1 |
NA |
NA |
Used only when AV_SESS_TYPE (line 3) = 'G'. Must be the CAE Type for the GIFT_TYPE (Line 7). Delivered value = 'G'. |
G |
Leave blank |
|
20 |
PLDG_EFFDT |
PSDATE |
10 |
NA |
NA |
The date that the pledge is considered active. Can be in the future. |
Leave blank |
01-15-2003 |
|
21 |
PLEDGE_DT |
PSDATE |
10 |
NA |
NA |
The date that the first pledge payment is expected. The date must be on or after the PLDG_EFFDT (Line 20). |
Leave blank |
02-01-2003 |
|
22 |
FULF_DT |
PSDATE |
10 |
NA |
NA |
The date on which the entire commitment amount for a pledge is expected to be fulfilled. |
Leave blank |
12-31-2003 |
|
23 |
PLEDGE_PMT_RCVD |
decimal |
15 |
13 |
2 |
This field exists for future development and is not used in the current process. |
NA |
NA |
|
24 |
LAST_PMT_DT |
PSDATE |
10 |
NA |
NA |
This field exists for future development and is not used in the current process. |
NA |
NA |
|
25 |
CP_PLEDGE_NO |
char |
11 |
NA |
NA |
This field exists for future development and is not used in the current process. |
NA |
NA |
|
26 |
FEED_FLG |
char |
1 |
NA |
NA |
Only used when AV_SESS_TYPE (Line 3) = 'PL'. Indicates whether a pledge should be sent to the GL Interface to be tracked as an account receivable. |
Leave blank |
Y |
|
27 |
FEED GIFT_FLG |
char |
1 |
NA |
NA |
Only used when AV_SESS_TYPE (Line 3) = 'G'. Indicates whether a gift should be sent to the GL Interface to be tracked in the general ledger. |
NA |
NA |
|
28 |
AV_PLDG_STATUS |
char |
1 |
NA |
NA |
This field exists for future development and is not used in the current process. |
NA |
NA |
|
29 |
PLEDGE_PG_TYPE |
char |
2 |
NA |
NA |
This field exists for future development and is not used in the current process. |
NA |
NA |
|
30 |
RCG_EMPLID1 |
char |
11 |
NA |
NA |
The following four fields identify up to four persons who are to receive credit for the gift or pledge. The EMPLID (Line 4) is not required to be one of these four IDs if he/she is not receiving direct credit for the gift (for example a third-party agent representing these RCG_EMPLIDs would not be entered). Note: If an entry has data in this field, it cannot have an entry in its corresponding RCG_EXT_ORG_ID field, that is if RCG_EMPLID1 (Line 29) has a value, RCG_EXT_ORG_ID1 (line 33) cannot and vice versa. |
AV0027 |
NA |
|
31 |
RCG_EMPLID2 |
char |
11 |
NA |
NA |
AV0026 |
AV0023 |
NA |
|
32 |
RCG_EMPLID3 |
char |
11 |
NA |
NA |
AV0025 |
NA |
NA |
|
33 |
RCG_EMPLID4 |
char |
11 |
NA |
NA |
AV0024 |
NA |
NA |
|
34 |
RCG_EXT_ORG_ID1 |
char |
11 |
NA |
NA |
These four fields identify up to four organizations that are to receive credit for the gift or pledge. The EXT_ORG_ID (Line 5) is not required to be one of these four IDs if it is not receiving direct credit for the gift (for example a third-party agent representing these RCG_EXT_ORG_IDs would not be entered). Note: If an entry has data in this field, it cannot have an entry in its corresponding RCG_EMPLID field, that is if RCG_EXT_ORG_ID (Line 33) has a value, RCG_EMPL_ID1 (Line 29) cannot and vice versa. |
NA |
AV1019 |
|
35 |
RCG_EXT_ORG_ID2 |
char |
11 |
NA |
NA |
NA |
NA |
NA |
|
36 |
RCG_EXT_ORG_ID3 |
char |
11 |
NA |
NA |
NA |
NA |
NA |
|
37 |
RCG_EXT_ORG_ID4 |
char |
11 |
NA |
NA |
NA |
NA |
NA |
|
38 |
RECOGNITION_TYPE1 |
char |
1 |
NA |
NA |
The type of credit (recognition) that the donor in RCG_EMPLID1 (Line 29) or RCG_EXT_ORG_ID1 (Line 33) is receiving for the gift or pledge. Must have a valid value from the AV_RCG_TYPE_TBL and the total of all Recognition Types 1-4 (Lines 37-40) that are given a value of 'H" for hard credit must equal 100 percent of the GIFT_AMT (Line 6). |
H |
H |
|
39 |
RECOGNITION_TYPE2 |
char |
1 |
NA |
NA |
The type of credit (recognition) that the donor in RCG_EMPLID2 (Line 30) or RCG_EXT_ORG_ID2 (Line 34) is receiving for the gift or pledge. Must have a valid value from the AV_RCG_TYPE_TBL and the total of all Recognition Types 1-4 (Lines 37-40) that are given a value of 'H" for hard credit must equal 100 percent of the GIFT_AMT (Line 6). |
H |
S |
|
40 |
RECOGNITION_TYPE3 |
char |
1 |
NA |
NA |
The type of credit (recognition) that the donor in RCG_EMPLID3 (Line 31) or RCG_EXT_ORG_ID3 (Line 35) is receiving for the gift or pledge. Must have a valid value from the AV_RCG_TYPE_TBL and the total of all Recognition Types 1-4 (Lines 37-40) that are given a value of 'H" for hard credit must equal 100 percent of the GIFT_AMT (Line 6). |
S |
NA |
|
41 |
RECOGNITION_TYPE4 |
char |
1 |
NA |
NA |
The type of credit (recognition) that the donor RCG_EMPLID4 (Line 32) or RCG_EXT_ORG_ID4 (Line 36) is receiving for the gift or pledge. Must have a valid value from the AV_RCG_TYPE_TBL and the total of all RECOGNITION_TYPEs 1-4 (Lines 37-40) that are given a value of 'H" for hard credit must equal 100 percent of the GIFT_AMT (Line 6). |
S |
NA |
|
42 |
RCG_PCT_AMT1 |
decimal |
15 |
15 |
2 |
The amount of the gift that is to be recognized as coming from each of the Recognition IDs (Lines 29-36). The sum of the amounts entered in these four fields must equal the total gift amount (Line 6) for all IDs receiving recognition types equal to 'H' (hard credit). Soft credit (any that are not equal to 'H') can total any amount up to the gift amount (Line 6). |
500.00 |
12000.00 |
|
43 |
RCG_PCT_AMT2 |
decimal |
15 |
15 |
2 |
500.00 |
12000.00 |
NA |
|
44 |
RCG_PCT_AMT3 |
decimal |
15 |
15 |
2 |
1000.00 |
NA |
NA |
|
45 |
RCG_PCT_AMT4 |
decimal |
15 |
15 |
2 |
1000.00 |
NA |
NA |
|
46 |
ANONYMOUS_FLG1 |
char |
1 |
NA |
NA |
Enter 'Y" if the donor in RCG_EMPLID1 (Line 29) or RCG_EXT_ORG_ID1 (Line 33) desires no public acknowledgement of the gift or pledge. |
NA |
Y |
|
47 |
ANONYMOUS_FLG2 |
char |
1 |
NA |
NA |
Enter 'Y" if the donor in RCG_EMPLID2 (Line 30) or RCG_EXT_ORG_ID2 (Line 34) desires no public acknowledgement of the gift or pledge. |
NA |
NA |
|
48 |
ANONYMOUS_FLG3 |
char |
1 |
NA |
NA |
Enter 'Y" if the donor in RCG_EMPLID3 (Line 31) or RCG_EXT_ORG_ID3 (Line 35) desires no public acknowledgement of the gift or pledge. |
NA |
NA |
|
49 |
ANONYMOUS_FLG4 |
char |
1 |
NA |
NA |
Enter 'Y" if the donor in RCG_EMPLID4 (Line 32) or RCG_EXT_ORG_ID4 (Line 36) desires no public acknowledgement of the gift or pledge. |
NA |
NA |
|
50 |
DESIGNATION1 |
char |
11 |
NA |
NA |
The account or fund code to which the donor is giving the gift or making the pledge. A gift or pledge can be split across 1-4 accounts when processed through AVPGPLOA. Note: A designation is valid only if it is current and has a setID that correlates to the corresponding set control value for record group AV02_GIFT for AV_DES_BU 1-4 (Lines 53-56). |
MEDBLDG |
MEDBLDG |
|
51 |
DESIGNATION2 |
char |
11 |
NA |
NA |
LIBRARY |
NA |
NA |
|
52 |
DESIGNATION3 |
char |
11 |
NA |
NA |
NA |
NA |
NA |
|
53 |
DESIGNATION4 |
char |
11 |
NA |
NA |
NA |
NA |
NA |
|
54 |
AV_DES_BU1 |
char |
5 |
NA |
NA |
The business unit that owns DESIGNATION1. |
MEDBU |
MEDBU |
|
55 |
AV_DES_BU2 |
char |
5 |
NA |
NA |
The business unit that owns DESIGNATION2. |
PSUNV |
NA |
|
56 |
AV_DES_BU3 |
char |
5 |
NA |
NA |
The business unit that owns DESIGNATION3. |
NA |
NA |
|
57 |
AV_DES_BU4 |
char |
5 |
NA |
NA |
The business unit that owns DESIGNATION4. |
NA |
NA |
|
58 |
INTV_CD1 |
char |
10 |
NA |
NA |
The campaign that generated the gift or pledge to DESIGNATION1 (Line 49). |
CMPGN2003 |
CMPGN2003 |
|
59 |
INTV_CD2 |
char |
10 |
NA |
NA |
The campaign that generated the gift or pledge to DESIGNATION2 (Line 50). |
CMPGN2003 |
NA |
|
60 |
INTV_CD3 |
char |
10 |
NA |
NA |
The campaign that generated the gift or pledge to DESIGNATION3 (Line 51). |
NA |
NA |
|
61 |
INTV_CD4 |
char |
10 |
NA |
NA |
The campaign that generated the gift or pledge to DESIGNATION4 (Line 52). |
NA |
NA |
|
62 |
DES_PCT_AMT1 |
decimal |
15 |
15 |
2 |
The amount of the gift that is being distributed to each designation (Lines 49-52) The total of the amounts entered in these four fields must equal the total gift amount (Line 6). |
500 |
12000 |
|
63 |
DES_PCT_AMT2 |
decimal |
15 |
15 |
2 |
500 |
NA |
NA |
|
64 |
DES_PCT_AMT3 |
decimal |
15 |
15 |
2 |
NA |
NA |
NA |
|
65 |
DES_PCT_AMT4 |
decimal |
15 |
15 |
2 |
NA |
NA |
NA |
|
66 |
MOTIVATION_CD1 |
char |
9 |
NA |
NA |
The appeal that generated the gift or pledge given to DESIGNATION1 (Line 49). Note: An appeal is valid only if it is current and has a setID that correlates to the corresponding set control value for record group AV02_GIFT for AV_DES_BU 1-4 (Lines 53-56). |
MEDICINE |
MEDICINE |
|
67 |
MOTIVATION_CD2 |
char |
9 |
NA |
NA |
The appeal that generated the gift or pledge given to DESIGNATION2 (Line 50). Note: An appeal is valid only if it is current and has a setID that correlates to the corresponding set control value for record group AV02_GIFT for AV_DES_BU 1-4 (Lines 53-56). |
LIBRARY |
NA |
|
68 |
MOTIVATION_CD3 |
char |
9 |
NA |
NA |
The appeal that generated the gift or pledge given to DESIGNATION3 (Line 51). Note: An appeal is valid only if it is current and has a setID that correlates to the corresponding set control value for record group AV02_GIFT for AV_DES_BU 1-4 (Lines 53-56). |
NA |
NA |
|
69 |
MOTIVATION_CD4 |
char |
9 |
NA |
NA |
The appeal that generated the gift or pledge given to DESIGNATION4 (Line 52). Note: An appeal is valid only if it is current and has a setID that correlates to the corresponding set control value for record group AV02_GIFT for AV_DES_BU 1-4 (Lines 53-56). |
NA |
NA |
|
70 |
CHARITABLE_AMT1 |
decimal |
15 |
15 |
2 |
The amount of the gift to DESIGNATION 1-4 (Lines 49-52) that is considered charitable for tax purposes. This can be different than the GIFT_AMT, but a value must be entered here even if it is equal to the GIFT_AMT. The total of the amounts entered in these four fields cannot exceed the total gift amount (Line 6). |
500 |
12000 |
|
71 |
CHARITABLE_AMT2 |
decimal |
15 |
15 |
2 |
500 |
NA |
NA |
|
72 |
CHARITABLE_AMT3 |
decimal |
15 |
15 |
2 |
NA |
NA |
NA |
|
73 |
CHARITABLE_AMT4 |
decimal |
15 |
15 |
2 |
NA |
NA |
NA |
|
74 |
DESCR254 |
char |
254 |
NA |
NA |
PROCESS GENERATED − Do not enter any values. Suspense Reason created by AVPGPLOA. |
Leave blank |
NA |
|
75 |
COMPLETE_FLAG |
char |
1 |
NA |
NA |
PROCESS GENERATED − Do not enter any values. Indicates if session has been processed by AVPGPLOA. |
Leave blank |
NA |
|
76 |
GP_LOAD_STATUS |
char |
1 |
NA |
NA |
PROCESS GENERATED − Do not enter any values. Indicates whether the gift or pledge was processed or suspended by AVPGPLOA. |
Leave blank |
NA |
|
77 |
SESSION_NO |
char |
11 |
NA |
NA |
PROCESS GENERATED − Do not enter any values. Session Number created by AVPGPLOA. |
Leave blank |
NA |
|
78 |
GIFT_NO |
char |
11 |
NA |
NA |
PROCESS GENERATED − Do not enter any values. Gift Number created by AVPGPLOA. |
Leave blank |
NA |
|
79 |
CR_CARD_EXPMO |
char |
2 |
NA |
NA |
The month of the year in which the credit card will expire. Must be entered in the format required by the database platform. |
09 |
Leave blank |
|
80 |
CR_CARD_EXPYR |
char |
4 |
NA |
NA |
The year in which the credit card is no longer valid. Must be entered in the format required by the database platform. |
2007 |
Leave blank |
|
81 |
CR_CARD_TYPE |
char |
2 |
NA |
NA |
The type of credit card being used to charge the gift. Must be a valid value from the AV_CR_CARD_TYPE record. Sample values include:
|
VI |
Leave blank |
|
82 |
AV_CR_CARD_NBR |
char |
44 |
NA |
NA |
The credit card number to which the donor is charging the gift. |
4111111111111111 |
Leave blank |