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 of its columns.

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-PEPL0 and C1-PEPL1 processes use this field to organize the parallel threads.

PEVT_​STG_​ST_​FLG

4

Y

A/N

If your implementation uses the C1-PEPL0 process to determine account and distribution rule details, this must be set to C1UP (C1UP is the lookup value that corresponds with the Uploaded state).

If your implementation uses the C1-PEPL1 process as the first stage of the upload, 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. The C1-PEPL0 process will populate this field by calling the Installation — Determine Distribution Rule algorithms.

DST_​RULE_​VALUE

254

Y

A/N

This must be a valid value for the characteristic type defined on the distribution rule. The C1-PEPL0 process will populate this field by calling the Installation — Determine Distribution Rule algorithms.

Note that if the value is a multi-part key, such as revenue period (calendar code + end date) the values should be entered separated by a semi-colon. For example: ANNUAL;2010-12-31

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

40

N

A/N

This is the taxpayer name on the payment.

EXT_​REFERENCE_​ID

30

N

A/N

This field may be used to capture external information associated with the payment tender, such as a reference number that identifies an obligation or bill.

MATCH_​TYPE_​CD

8

N

A/N

See the description of the MATCH_​VALUE field below.

MATCH_​VALUE

30

N

A/N

MATCH_​VALUE and MATCH_​TYPE_​CD are optional. They are available to be used for distribution rule algorithms that rely on this to target the payment in a certain way. If your distribution rule's create payment algorithm doesn't use this information it may be left blank.

If MATCH_​TYPE_​CD is specified, it must reference a valid Match Type.

Note that if your implementation uses classic billing and open item accounting these fields have specific significance. Refer to Payments And Match Events for more information.

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. The C1-PEPL0 process will populate this field by calling the Installation — Determine Distribution Rule algorithms.

If left blank and your implementation does not use process C1-PEPL0, 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-PEPL0 process will set this field equal to the Tender Account ID concatenated with the payment event upload staging record sequence.

If left blank and your implementation does not use process C1-PEPL0, 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

PAY_​DTLS

254

N

A/N

This field may be used to capture free-form text that was supplied with the payment by the payor or financial institution, if applicable

ROUTING_​NBR

50

N

A/N

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

Payment Event Upload Staging Characteristics Table

The payment event upload staging table has a child table for characteristic records. The C1-PEPL0 process will populate this table with details returned by the Installation — Determine Distribution Rule algorithms, if applicable. It is designed to capture additional reference information to be stored with the payment in the system.

The name of this table is CI_​PEVT_​DTL_​ST_​CHAR. The following table describes each of its columns.

Column Name

Length

Req'd

Data Type

Comments

EXT_​SOURCE_​ID

30

Y

A/N

This must correspond with the external source ID of the related payment event upload staging record.

EXT_​TRANSMIT_​ID

30

Y

A/N

This must correspond with the unique transmission identifier of the related payment event upload staging record.

PEVT_​DTL_​SEQ

12

Y

N

This must correspond with the unique sequence number of the related payment event upload staging record.

CHAR_​TYPE_​CD

8

Y

A/N

This must correspond with a characteristic type that is defined as valid for the Payment and Payment Event Upload Staging entities. Refer to Setting Up Characteristic Types & Their Values for more information.

SEQ_​NUM

3

Y

N

This should be set to 10 unless you have multiple values for a given payment event upload staging record and characteristic type.

CHAR_​VAL

16

N

A/N

Populate this field if your characteristic type is predefined.

ADHOC_​CHAR_​VAL

254

N

A/N

Populate this field if your characteristic type is ad-hoc or file location.

CHAR_​VAL_​FK1 - CHAR_​VAL_​FK5

50 each

N

A/N

Populate these fields if your characteristic type is foreign key reference. Up to five columns of 50 bytes each are provided to accommodate compound keys.