Page Comparison

Element / Attribute

Data Type

Req'd?

Description

Example

<pdp_file>

Req

xmlns

String

Req

Always:xmlns="http://www.kuali.org/kfs/pdp/payment"

xmlns:xsi

String

Req

Always:xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

xsi:schemaLocation

String

Req

Always:xsi:schemaLocation="http://www.kuali.org/kfs/pdp/payment http://localhost:8080/kuali-dev/static/xsd/pdp/payment.xsd"

version

Always:version="1.0"

<header>

<chart>

StringMin Len: 2Max Len: 2

Req

Chart of accounts code. First part of the PDP Customer Profile

IR

<unit>

StringMin Len: 1Max Len: 4

Req

This is a four character description of the unit. Second part of the PDP Customer Profile.

SBS

<sub_unit>

[UCIKFS:A-Z]{1,4}

Req

Four digit code that describes the source of the PDP file. The last part of the PDP Customer Profile.

ACCT

<creation_date>

String

Req

Date file is created. Format is yyyy-mm-ddThh:mm:ss (Please notice the T separating the Date and Time)

2013-01-10T09:00:00

</header>

Req

<group>

Req

The <group> element combines payments to a single vendor or payee. Each <group> element will contain one or more <detail> elements (described below) to provide information about individual payments.

<payee_name>

StringMin Len: 1Max Len: 40

Req

Name of the vendor or individual for which the payment is intended.

ABC CLEARNING SERVICES

<payee_id>

StringMin Len: 0Max Len: 25

Opt

This is the Vendor Number that exists in KFS.  This would also be the Student ID for students.

12345678

<id_type>

[UCIKFS:A-Z]

Req

This will equal "V" for vendor number. This will equal "D" for students.  For Plus Loan checks mailed to parents send "P".

V

<payee_own_cd>

String[UCIKFS:A-Z][UCIKFS:A-Z]

Opt

This would be similar to Individual or Sole Proprietor. Use CF as the value.

CF

<customer_institution_identifier>

StringMin Len: 0Max Len: 30

Opt

Unit defined. For example, the customer number the vendor associates with our account.

TEST

<address_id>

Numeric Len: 1Max Len: 10

Opt

Unique address id assigned to each vendor address by the system

1022

E - Exempt (sales tax is assumed to be included, or not to be charged)

U - Used Tax (calculate use tax)

<address1>

StringMin Len: 1Max Len: 45

Req

Address to which payment is to be sent. There may be up to four address lines. Do not include city, state, or zip code.

CUSTOMER PAYMENT CENTER

<address2>

StringMin Len: 0Max Len: 45

Opt

Address to which payment is to be sent. There may be up to four address lines. Do not include city, state, or zip code.

PO BOX 1234

<city>

StringMin Len: 0Max Len: 45

Opt

City to which payment is to be sent.

Irvine

<state>

StringMin Len: 0Max Len: 30

Opt

State to which payment is to be sent.

CA

<zip>

StringMin Len: 0Max Len: 20

Opt

Zipcode to which payment is to be sent.

92697-4600

<country>

StringMin Len: 0Max Len: 30

Opt

Country to which payment is to be sent.

USA

<campus_address_ind>

[UCIKFS:Y,N]

Opt

Y – Payee address is on-campus.
N – Payee address is off-campus.

N

<payment_date>

String

Req

Date payment is due or the check produced. Format is yyyy-mm-dd.  This would normally be the due date.

2011-04-09

<attachment_ind>

[UCIKFS:Y,N]

Opt

Y – Indicates that an attachment has been mailed or faxed
N – No attachment

N

<special_handling_ind>

[UCIKFS:Y,N]

Opt

Y – Indicates special handling is required. Use this to indicate Pick Up check.
N – No special handling required.

N

<taxable_ind>

[UCIKFS:Y,N]

Opt

Y – Taxable expense (Y for 1042S)
N – Tax-exempt expense

<nra_ind>

[UCIKFS:Y,N]

Opt

Y – Vendor is non-resident alien
N – Vendor is US citizen

If you set up a customer with the NRA Check Indicator checked and that customer uploads a payment with the nra_ind set to "Y" then that payment will load into PDP in "Held for Tax" status. Payments in this status won't get pulled in when a format process is run. The idea is that you'd want someone to review this for tax issues before you make the disbursement.  If it is ok they would remove the hold. If it's not they would probably cancel the payment.
 
There's currently a bug related to removing the tax hold where the folks who should have that permission don't appear to. This is reported in JIRA as KFSMI-5595.

N

<combine_group_ind>

[UCIKFS:Y,N]

Opt

Y – Payment may be combined with other payments to the same vendor
N – Payment should not be grouped with other payments to the same vendor

Y

<bank_code>

StringMin Len: 0Max Len: 4

Opt

Bank code. Not used anymore, leave blank. It will be ignored by PDP.

integer

Len: 9

String

Len: 4

String

Len: 4

<detail>

Req

Every <group> element must contain at least one <detail> sub-element. The contents of the <detail> element provide information about a single payment to the vendor described in the parent <group> element (described above). Each <detail> element will contain one or more <accounting> elements (described below).  KFS supports up to 200 details per group.

<source_doc_nbr>

[UCIKFS:A-Za-z0-9]{1,14}

Req

This will be an identifying number that can be searched on. Could be used to identify a batch of payments. From KFS, it is the same as the document number. Use this attribute to pass the Image Id if you are using DDM scanning services.

12345

<invoice_nbr>

[UCIKFS:A-Za-z0-9]{1,14}

Opt

The number that identifies the payment. This can be searched on. From KFS, it is the same as the Payment Request Number.

INV1

<po_nbr>

StringMin Len: 1Max Len: 9

Opt

Purchase Order number

12345

<req_nbr>

StringMin Len: 1Max Len: 8

Opt

Requisition number

12345

<org_doc_nbr>

StringMin Len: 1Max Len: 10

Opt

Additional identifying internal number at the header level.

12345

<invoice_date>

String

Opt

Invoice Date. Format is yyyy-mm-dd. It is advisable to send your source document date in this attribute for recording purposes.

2011-04-09

<orig_invoice_amt>

decimal

Opt

Original Invoice Amount

29.77

<net_payment_amt>

decimal

Opt

Net Payment Amount

29.77

<invoice_tot_discount_amt>

decimal

Opt

Invoice total discount amount

0

<invoice_tot_ship_amt>

decimal

Opt

Invoice total shipping amount

0

<invoice_tot_other_debits>

decimal

Opt

Invoice total other debits

0

<invoice_tot_other_credits>

decimal

Opt

Invoice total other credits

0

<fs_origin_cd>

StringMin Len: 0Max Len: 2

Opt

Origin Code specific to the unit, please reference your Origin Code.

SB

<fdoc_typ_cd>

StringMin Len: 0Max Len: 4

Opt

Document type code will be EPAY.

<accounting>

Req

Every <detail> element must contain at least one <accounting> sub-element. Each <accounting> element provides information about a source for the payment in the parent <detail> element. The combined value of the amount fields in the <accounting> sub-elements must equal the <net_payment_amt> value in the parent <detail> element.

<coa_cd>

StringMin Len: 2Max Len: 2

Req

Chart of accounts code.

IR

<account_nbr>

StringMin Len: 1Max Len: 7

Req

Account number

BF10002

<sub_account_nbr>

String

Len: 5

Opt

Sub-account number.
Optional. If omitted, please omit tag as well.

<object_cd>

StringMin Len: 1Max Len: 4

Req

Object code

5000

<sub_object_cd>

String

Len: 4

Opt

Sub-object code
Optional. If omitted, please omit tag as well.

—

<org_ref_id>

StringMin Len: 0Max Len: 10

Opt

Unit-defined reference number used at the transaction level.  Normally carries FS Source.

<project_cd>

String

Len: 10

Opt

Project Code ID.  This attribute is pre-defined in the Project table and it is validated if used.  If you use it make sure it is a valid Project.

133

<amount>

decimal

Req

Amount

100.00

</accounting>

Req

<payment_text>

StringMin Len: 0Max Len: 90

Opt

Each <detail> element may contain multiple <payment_text> sub-elements. The text contained within each <payment_text> element will appear as a single line of text printed on the payment stub remitted to the vendor.

</detail>

Req

String

String

String

String

<asset_description>

String

String

String

String

String

String

String

<asset_number>

String

</group>

Req

<trailer>

Req

<detail_count>

integer

Req

Number of transactions in the file.

<detail_tot_amt>

decimal

Req

Total amount of the payment lines.

</trailer>

Req

</pdp_file>

Req