Process X - Populate Payment Event Upload Staging

Process X refers to the mechanism used by your organization to populate the payment event upload staging table.

Payment Event Upload Staging Table

You must create a payment event upload staging record for each payment distribution detail to be uploaded into the system. The name of this table is CI_PEVT_DTL_ST. The following table describes each column on this table.

Column Name

Length

Req'd

Data Type

Comments

EXT_SOURCE_ID

30

Y

A/N

This must correspond with an external source ID on one of the defined tender sources. Refer to Setting Up Tender Sources for more information.

EXT_TRANSMIT_ID

30

Y

A/N

This is the unique identifier of the transmission from the external source. This must be a unique value for each transmission from the source.

PEVT_DTL_SEQ

12

Y

N

Unique identifier of the detail record within the transmission. The C1-PEPL1 process uses this field to organize the parallel threads.

PEVT_STG_ST_FLG

4

Y

A/N

This must be set to 10 (10 is the lookup value that corresponds with the Incomplete state)

DST_RULE_CD

12

Y

A/N

This must be a valid distribution rule. The distribution rule contains the set of algorithms designed to process the staging detail.

DST_RULE_VALUE

254

Y

A/N

This must be a valid value for the characteristic type defined on the distribution rule.

CURRENCY_CD

3

Y

A/N

This must be a valid currency code (this would be USD for United States dollars).

TENDER_AMT

13.2

Y

N

The amount tendered (i.e., the payment amount).

ACCOUNTING_DT

10

Y

Date

This is the payment date that should be used for accounting purposes. This should correspond with an open accounting period.

TENDER_TYPE_CD

4

Y

A/N

This must be a valid tender type. Refer to Setting Up Tender Types for more information.

CHECK_NBR

10

N

A/N

This is the check number on the payment.

MICR_ID

30

N

A/N

This is the MICR ID associated with the payment tender.

CUST_ID

15

N

A/N

This field may be used to record taxpayer information.

NAME1

30

N

A/N

This field may be used to capture additional payment tender information.

EXT_REFERENCE_ID

30

N

A/N

This field may be used to capture external information associated with the payment tender.

MATCH_TYPE_CD

8

N

A/N

See the description of the MATCH_VALUE field below. Refer to Payments And Match Events for more information about the significance of this field.

MATCH_VALUE

30

N

A/N

MATCH_VALUE and MATCH_TYPE_CD are used in conjunction to indicate that the distribution of the payment should be restricted in some way (i.e., the standard payment distribution algorithm should not be used). MATCH_TYPE_CD indicates how the payment should be distributed (e.g., only distribute to a specific obligation), MATCH_VALUE contains the ID of the restriction (e.g., the obligation ID).

If MATCH_TYPE_CD is specified, it must reference a valid Match Type.

TNDR_CTL_ID

10

N

A/N

Leave this column blank. It will be assigned by the system when it creates a tender control record.

ACCT_ID

10

N

A/N

This is the tender account. If left blank, the C1-PEPL1 process will populate this field by calling the Determine Tender Account algorithm defined on the distribution rule.

Note that this Account ID is not necessarily unique as multiple staging details can reference the same tender account.

PAY_EVENT_ID

12

N

A/N

Leave this column blank. It will be assigned by the system when it creates a payment event record.

PEVT_PROCESS_ID

10

N

A/N

If left blank, the C1-PEPL1 process will set this field equal to the Tender Account ID.

This field is used for grouping staging records and for organizing parallel threads (in the C1-PEPL2 process). Therefore, it is strongly encouraged that it bears a relationship to the tender account ID.

APAY_SRC_CD

12

N

A/N

This must be a valid auto pay source code.

EXT_ACCT_ID

50

N

A/N

This is the taxpayer's account number at the financial institution

EXPIRE_DT

10

N

Date

This field is only needed if the Tender Type indicates that an expiration date is necessary (e.g., for a credit card payment)

ENTITY_NAME

64

N

A/N

This is the taxpayer's name in the financial institution's system