Populating the INTFC_BI_HDR Table
This topic provides an overview of the INTFC_BI_HDR table and discusses how to populate it for LINE transactions.
The Billing Interface Bill Header table (INTFC_BI_HDR) contains only LINE transactions. The following six attributes comprise the key to the INTFC_BI_HDR table:
Term |
Definition |
|---|---|
INTFC_ID (interface ID) |
Represents a group or batch of billing activity, that is, a collection of billing activity that may be produced by a billing source system. For example, a system may generate a group or batch each night, while another may produce a group or batch for a certain kind of billing activity. |
INTFC_LINE_NUM (interface line number) |
Represents a bill line charge. For each interface ID (group or batch of billing activity), there may be multiple interface line numbers, one for each bill line charge in the group. |
TRANS_TYPE_BI (transaction type billing) |
Characterizes the type of data being stored. LINE (bill line charge) is the only valid option. For each interface line number associated with an interface ID, there should be only one row of transaction type LINE. |
TRANS_TYPE_BI_SEQ (transaction type billing sequence) |
Zero for LINE transactions. |
HDR_FIELDS_KEY (header fields key) |
Represents subheader information, including VAT, credit card, header level AR distribution, and miscellaneous header information. This field also exists in the INTFC_BI table and is used as a foreign key to the INTFC_BI_HDR table. Source systems populate and maintain this key based on grouping of billing activity. PeopleSoft Billing maintains this field in the Billing Interface History record (INTFC_BI_CMP) as well as in the BI_HDR record. Bill header-related overrides for credit card, VAT, AR, and miscellaneous data records in the INTFC_BI_HDR table are tied to the main Billing Interface table (INTFC_BI) through this field. |
HDR_TRANS_TYPE (header transaction type) |
Options are: VAT: Bill header VAT data. CRC: Bill header credit card data. MSC: Bill header miscellaneous data. HAR: Bill header AR data. |
The following table demonstrates how to populate the INTFC_BI_HDR table for LINE transactions:
|
Field Number |
Field Name |
LINE |
|---|---|---|
|
1 |
INTFC_ID (interface ID) |
Required. Used to group or batch a collection of Billing interface activity. |
|
2 |
INTFC_LINE_NUM (interface line number) |
Required. Each unique interface line number for an interface ID represents a separate bill line charge. |
|
3 |
TRANS_TYPE_BI (transaction type) |
Required. Value must be LINE. |
|
4 |
TRANS_TYPE_BI_SEQ (transaction type sequence) |
Set to 0 (zero). |
|
5 |
HDR_FIELDS_KEY |
Required. |
|
6 |
HDR_TRANS_TYPE |
Depending on the transaction type, enter VAT, CRC, MSC, or HAR. |
|
7 |
PROCESS_INSTANCE |
Leave blank. |
|
8 |
LOAD_STATUS_BI |
Leave blank. |
|
9 |
ERROR_STATUS_BI |
Leave blank. |
|
10 |
BUSINESS_UNIT |
Required. |
|
11 |
INVOICE |
Leave blank. |
|
12 |
BUSINESS_UNIT_GL |
Leave blank. |
|
13 |
BUSINESS_UNIT_TO |
Leave blank. |
|
14 |
TARGET_INVOICE |
Leave blank. |
|
15 |
DST_ID_AR |
Optional. Must be provided in the absence of ACCOUNT. [HAR] |
Fields 16 through 37 describe ChartFields as they are initially delivered in the system. By using ChartField configuration, you can define the ChartFields differently. The behavior described here provides general reference for how ChartFields are handled in this context.
Configurable ChartFields can be fully configurable (identified below by F), partially configurable (identified below by P), or affiliate ChartFields (identified below by A).
Note: If you selected the Customer Supplier Affiliate option (BUS_UNIT_TBL_GL.CUST_VNDR_AFFILIATE = Y) on the General Ledger Definition - Definition page, the system ignores any affiliate values that you provide to the Billing interface tables when creating bills. In this scenario, the system automatically populates affiliate fields by using default values:
Note: VAT-related fields in this table are provided so that feeder systems can pass VAT-related data into the Billing interface. Feeder systems such as PeopleSoft Order Management pass fully-defaulted VAT data. Some other feeder systems may pass less than fully defaulted VAT data. You must run the Billing VAT Defaults process (BIPVAT00) to assign missing default values and to validate the fully defaulted VAT data.
Note: Only credit card data from Order Management is valid since the system uses PS process to store/encrypt information. Authorized or settled credit card information is not accepted from a third party system.
|
Field Number |
Field Name |
LINE |
|
16 |
ACCOUNT (P) |
Required unless appearing by default from DST_ID_AR. Appears by default from DST_ID_AR if DST_ID_AR is provided [HAR] |
|
17 |
ALTACCT (P) |
Optional. Appears by default from DST_ID_AR if DST_ID_AR is provided. It must get a value when Alt Accounting is ON. [HAR] |
|
18 |
DEPTID (department) (P) |
Optional. Appears by default from DST_ID_AR if DST_ID_AR is provided. Must be valid if provided. [HAR] |
|
19 |
OPERATING_UNIT (F) |
Optional. Appears by default from DST_ID_AR if DST_ID_AR is provided. Must be valid if provided. [HAR] |
|
20 |
PRODUCT (F) |
Optional. Appears by default from DST_ID_AR if DST_ID_AR is provided. Must be valid if provided. [HAR] |
|
21 |
FUND_CODE (F) |
Optional. Appears by default from DST_ID_AR if DST_ID_AR is provided. Must be valid if provided. [HAR] |
|
22 |
CLASS_FLD (class field) (F) |
Optional. Appears by default from DST_ID_AR if DST_ID_AR is provided. Must be valid if provided. [HAR] |
|
23 |
PROGRAM_CODE (F) |
Optional. Appears by default from DST_ID_AR if DST_ID_AR is provided. Must be valid if provided. [HAR] |
|
24 |
BUDGET_REF (budget reference) (F) |
Optional. Appears by default from DST_ID_AR if DST_ID_AR is provided. Must be valid if provided. [HAR] |
|
25 |
AFFILIATE (A) |
Optional. Appears by default from DST_ID_AR if DST_ID_AR is provided. Must be valid if provided. [HAR] |
|
26 |
AFFILIATE_INTRA1 (A) |
Optional. Appears by default from DST_ID_AR if DST_ID_AR is provided. Must be valid if provided. [HAR] |
|
27 |
AFFILIATE_INTRA2 (A) |
Optional. Appears by default from DST_ID_AR if DST_ID_AR is provided. Must be valid if provided. [HAR] |
|
28 |
CHARTFIELD1 (F) |
Leave blank. [HAR] |
|
29 |
CHARTFIELD2 (F) |
Leave blank. [HAR] |
|
30 |
CHARTFIELD3 (F) |
Leave blank. [HAR] |
|
31 |
PROJECT_ID (P) |
Optional. Appears by default from DST_ID_AR if DST_ID_AR is provided. Must be valid if provided. [HAR] |
|
32 |
BUSINESS_UNIT_PC |
Optional. Appears by default from DST_ID_AR if DST_ID_AR is provided. Must be valid if provided. [HAR] |
|
33 |
ACTIVITY_ID |
Optional. Appears by default from DST_ID_AR if DST_ID_AR is provided. Must be valid if provided. [HAR] |
|
34 |
RESOURCE_TYPE |
Optional. Appears by default from DST_ID_AR if DST_ID_AR is provided. Must be valid if provided. [HAR] |
|
35 |
RESOURCE_CATEGORY |
Optional. Appears by default from DST_ID_AR if DST_ID_AR is provided. Must be valid if provided. [HAR] |
|
36 |
RESOURCE_SUB_CAT |
Optional. Appears by default from DST_ID_AR if DST_ID_AR is provided. Must be valid if provided. [HAR] |
|
37 |
ANALYSYS_TYPE |
Optional. Appears by default from DST_ID_AR if DST_ID_AR is provided. Must be valid if provided. [HAR] |
|
38 |
STATISTICS_CODE |
Optional. Appears by default from DST_ID_AR if DST_ID_AR is provided. Must be valid if provided. [HAR] |
|
39 |
OPEN_ITEM_KEY |
Required when ChartFields reference an open item. Must correspond to a record on the OPEN_ITEM_GL table. [HAR] |
|
40 |
JRNL_LN_REF |
Optional. If provided, must correspond to a record on the JRNL_LINE table. [HAR] |
|
41 |
BI_PAID_AT_SRC |
Set to one of the following: (when HDR_TRANS_TYPE is MSC).
|
|
42 |
PAID_AMT (paid amount) |
Required when paid reference provided for HDR_TRANS_TYPE is MSC. Report amount of payment or applied deposit. Note: PAID_AMT does not reduce AR distribution. |
|
43 |
PAID_REFERENCE (paid reference) |
Required when PAID_AMT is not zero. (when HDR_TRANS_TYPE is MSC). |
|
44 |
VAT_CALC_GROSS_NET |
Optional. If provided, it must be valid. If not provided, the system populates with a default value obtained through the VAT defaulting process. This applies only to VAT transactions (when HDR_TRANS_TYPE is VAT). |
|
45 |
VAT_DCLRTN_DT |
Required if VAT declaration date source is M (manual) or D (delivery). This applies only to VAT transactions (when HDR_TRANS_TYPE is VAT). |
|
46 |
VAT_DCLRTN_DT_SRC |
Optional. VAT declaration date source. This applies only to VAT transactions (when HDR_TRANS_TYPE is VAT). |
|
47 |
VAT_DCLRTN_POINT (VAT declaration point) |
Optional. If provided, it must be valid. If not provided, the system populates with a default value obtained through the VAT defaulting process. This applies only to VAT transactions (when HDR_TRANS_TYPE is VAT). |
|
48 |
VAT_DST_ACCT_TYPE |
Optional. If provided, it must be valid. If not provided, the system populates with a default value during the invoice finalization process. This applies only to VAT transactions (when HDR_TRANS_TYPE is VAT). |
|
49 |
VAT_EXCPTN_CERTIF |
Optional. If provided, it must be valid. If not provided, the system populates with a default value obtained through the VAT defaulting process. This applies only to VAT transactions (when HDR_TRANS_TYPE is VAT), when VAT exception type is not blank or not N. |
|
50 |
VAT_EXCPTN_TYPE (VAT exception type) |
Optional. If provided, it must be valid. If not provided, the system populates with a default value obtained through the VAT defaulting process. This applies only to VAT transactions (when HDR_TRANS_TYPE is VAT). |
|
51 |
VAT_RECALC_FLG (VAT recalculate at payment flag) |
Optional. If provided, it must be valid. If not provided, the system populates with a default value obtained through the VAT defaulting process. This applies only to VAT transactions (when HDR_TRANS_TYPE is VAT). |
|
52 |
VAT_ROUND_RULE (VAT rounding rule) |
Optional. If provided, it must be valid. If not provided, the system populates with a default value obtained through the VAT defaulting process. This applies only to VAT transactions (when HDR_TRANS_TYPE is VAT). |
|
53 |
VAT_RGSTRN_BUYER |
Optional. If provided, it must be valid. If not provided, the system populates with a default value obtained through the VAT defaulting process. This applies only to VAT transactions (when HDR_TRANS_TYPE is VAT). |
|
54 |
VAT_RGSTRN_SELLER |
Optional. If provided, it must be valid. If not provided, the system populates with a default value obtained through the VAT Defaulting process. This applies only to VAT transactions (when HDR_TRANS_TYPE is VAT). |
|
55 |
PROVINCE |
Leave blank. |
|
56 |
CR_CARD_DIGITS |
Required when HDR_TRANS_TYPE is CRC. |
|
57 |
CR_CARD_EXPMO (credit card expiration month) |
Required when HDR_TRANS_TYPE is CRC. |
|
58 |
CR_CARD_EXPYR (credit card expiration year) |
Required when HDR_TRANS_TYPE is CRC. |
|
59 |
CR_CARD_FNAME (credit card first name) |
Required when HDR_TRANS_TYPE is CRC. |
|
60 |
CR_CARD_LNAME (credit card last name) |
Required when HDR_TRANS_TYPE is CRC. |
|
61 |
CR_CARD_NBR (credit card number) |
Required when HDR_TRANS_TYPE is CRC. |
|
62 |
CR_CARD_TYPE (credit card type) |
Required when HDR_TRANS_TYPE is CRC. |
|
63 |
NAME_EXACT |
Optional. Populates only when HDR_TRANS_TYPE is CRC. |
|
64 |
EXPIRATION_DT (expiration date) |
Required when HDR_TRANS_TYPE is CRC. |
|
65 |
ADDRESS1 (address line 1) |
Required when HDR_TRANS_TYPE is CRC. |
|
66 |
ADDRESS2 (address line 2) |
Optional. Populate only when HDR_TRANS_TYPE is CRC. |
|
67 |
ADDRESS3 (address line 3) |
Optional. Populate only when HDR_TRANS_TYPE is CRC. |
|
68 |
ADDRESS4 (address line 4) |
Optional. Populate only when HDR_TRANS_TYPE is CRC. |
|
69 |
NUM1 (number 1) |
Optional. Populate only when HDR_TRANS_TYPE is CRC. |
|
70 |
NUM2 (number 2) |
Optional. Populate only when HDR_TRANS_TYPE is CRC. |
|
71 |
CITY |
Optional. Populate only when HDR_TRANS_TYPE is CRC. |
|
72 |
COUNTY |
Optional. Populate only when HDR_TRANS_TYPE is CRC. |
|
73 |
STATE |
Optional. Populate only when HDR_TRANS_TYPE is CRC. |
|
74 |
POSTAL |
Required when HDR_TRANS_TYPE is CRC. |
|
75 |
GEO_CODE (tax provider geocode) |
Leave blank. |
|
76 |
COUNTRY |
Optional. Populate only when HDR_TRANS_TYPE is CRC. |
|
77 |
PHONE |
Optional. Populate only when HDR_TRANS_TYPE is CRC. |
|
78 |
EMAILID (email address) |
Optional. Populate only when HDR_TRANS_TYPE is CRC. |
|
79 |
HOUSE_TYPE |
Optional. Populate only when HDR_TRANS_TYPE is CRC. |
|
80 |
ADDR_FIELD1 (address field 1) |
Optional. Populate only when HDR_TRANS_TYPE is CRC. |
|
81 |
ADDR_FIELD2 (address field 2) |
Optional. Populate only when HDR_TRANS_TYPE is CRC. |
|
82 |
ADDR_FIELD3 (address field 3) |
Optional. Populate only when HDR_TRANS_TYPE is CRC. |
|
83 |
IN_CITY_LIMIT |
Optional. Populate only when HDR_TRANS_TYPE is CRC. |
|
84 |
CR_CARD_RQST_ID (credit card request ID) |
Optional. Populate only when HDR_TRANS_TYPE is CRC. |
|
85 |
CR_CARD_AUTH_STAT (credit card authorization status) |
Optional. Populate only when HDR_TRANS_TYPE is CRC. |
|
86 |
CR_CARD_AUTH_CD (credit card authorization code) |
Optional. Populates only when HDR_TRANS_TYPE is CRC. This field is populated by the credit card processing supplier. |
|
87 |
CR_CARD_A_DTTM (credit card authorization code date and time) |
Optional. Populates only when HDR_TRANS_TYPE is CRC. This field is the credit card authorization date and time in characters and is populated by the credit card processing supplier. |
|
88 |
CR_CARD_AUTH_DTTM (credit card authorization code date and time) |
Optional. Populates only when HDR_TRANS_TYPE is CRC. This field is populated by the credit card processing supplier. |
|
89 |
CR_CARD_MSG1 (credit card message 1) |
Optional. Populates only when HDR_TRANS_TYPE is CRC. This field is populated by the credit card processing supplier. |
|
90 |
CR_CARD_MSG2 (credit card message 2) |
Optional. Populates only when HDR_TRANS_TYPE is CRC. This field is populated by the credit card processing supplier. |
|
91 |
CR_CARD_MSG3 (credit card message 3) |
Optional. Populates only when HDR_TRANS_TYPE is CRC. This field is populated by the credit card processing supplier. |
|
92 |
COUNTRY_LOC_BUYER |
Optional. If provided it must be a valid country. If not provided, the system obtains a default value from the customer's bill-to location. This applies only to VAT transactions (when HDR_TRANS_TYPE is VAT), where the physical nature is S (services). |
|
93 |
STATE_LOC_BUYER |
Optional. If provided it must be a valid state associated with the buyer's location country. If not provided, the system obtains a default value from the customer's bill-to location. This applies only to VAT transactions (when HDR_TRANS_TYPE is VAT), when the physical nature is S (services) and the buyer's location country tracks VAT by state or province. |
|
94 |
COUNTRY_LOC_SELLER |
Optional. If provided, it must be a valid country. If not provided, the system obtains the default value from the billing business unit location. This applies only to VAT transactions (when HDR_TRANS_TYPE is VAT) where the physical nature is S (services). |
|
95 |
STATE_LOC_SELLER |
Optional. If provided, it must be a valid state associated with the seller's location country. If not provided, the system obtains the default value from the billing business unit location. This applies only to VAT transactions (when HDR_TRANS_TYPE is VAT) where the physical nature is S (services). Leave blank when the seller's location country does not track VAT by state or province. |
|
96 |
VAT_SVC_SUPPLY_FLG |
Optional. If provided it must be valid. If not provided, the system populates with a default value obtained through the VAT defaulting process. This applies only to VAT transactions (when HDR_TRANS_TYPE is VAT) where the physical nature is S (services). |
|
97 |
VAT_SERVICE_TYPE |
Optional. If provided it must be a valid VAT service type. If not provided, the system populates with a default value obtained through the VAT defaulting process. This applies only to VAT transactions (when HDR_TRANS_TYPE is VAT) where the physical nature is S (services). |
|
98 |
COUNTRY_VAT_PERFRM |
Optional. If provided it must be a valid country. If not provided, the system populates with a default value from the PeopleSoft Billing VAT drivers hierarchy. This applies only to VAT transactions (when HDR_TRANS_TYPE is VAT) where the physical nature is S (services). |
|
99 |
STATE_VAT_PERFRM |
Optional. If provided it must be a valid state associated with the COUNTRY_VAT_PERFRM value. If not provided, the system populates with a default value from the PeopleSoft Billing VAT drivers hierarchy. This applies only to VAT transactions (when HDR_TRANS_TYPE is VAT) where the physical nature is S (services). Leave blank when the COUNTRY_VAT_PERFRM value does not track VAT by state or province. |
|
100 |
COUNTRY_VAT_SUPPLY |
Optional. If provided it must be a valid country. If not provided, the system populates with a default value obtained through the VAT defaulting process. This applies only to VAT transactions (when HDR_TRANS_TYPE is VAT) where the physical nature is S (services). |
|
101 |
STATE_VAT_SUPPLY |
Leave blank. |
|
102 |
VAT_HDR_IND |
Leave blank. |
|
103 |
STATE_VAT_DEFAULT |
Optional. If provided it must be a valid state associated with the VAT reporting country. If not provided, the system populates with a default value obtained through the VAT defaulting process. This applies only to VAT transactions (when HDR_TRANS_TYPE is VAT) where the physical nature is S (services). |
|
104 |
ADD_DTTM |
Required for accurate reporting purposes and for taking advantage of interface workflow function. |
|
105 |
LAST_UPDATE_DTTM |
Leave blank. |
Note: When importing bills with VAT data, to ensure VAT data integrity you must run the VAT Defaulting process after the Billing Interface process.
You do not need to populate a row in INTFC_BI_HDR for every row in INTFC_BI. You need only to populate one row in which INTFC_BI_HDR matches the key of the LINE with MIN(INTFC_ID) and MIN(INTFC_LINE_NUM) in the INTFC_BI table. For example, if the INTFC_BI table is populated for Interface ID 75, for an order as follows:
|
INTFC_LINE_NUM |
TRANS_TYPE_BI |
TRANS_TYPE_BI_SEQ |
ORDER_NO |
HDR_FIELDS_KEY |
|---|---|---|---|---|
|
1 |
LINE |
0 |
WESUS001 |
WESUS001CRC |
|
2 |
LINE |
0 |
WESUS001 |
WESUS001CRC |
|
3 |
LINE |
0 |
WESUS001 |
WESUS001CRC |
|
4 |
LINE |
0 |
WESUS001 |
WESUS001CRC |
The INTFC_BI_HDR table should appear as follows:
|
INTFC_LINE_NUM |
TRANS_TYPE_BI |
TRANS_TYPE_BI_SEQ |
HDR_FIELDS_KEY |
HDR_TRANS_TYPE |
|---|---|---|---|---|
|
1 |
LINE |
0 |
WESUS001 |
CRC |