...
Date | Initial | Description |
---|---|---|
07/03/18 | SW | XML header specification change. Max line is now 5,000 |
07/31/17 | MPS | Changed bank code from NYM2 to NYM5 |
06/08/17 | KT | Included the current AMS payment upload spec for cash based accounting |
05/04/17 | KT | Specified that the Aperek Disbursement Number should be 9 digits long |
04/28/17 | KT | Initial |
...
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 | MC | ||||||||||||||||||||||||||||
<unit> | StringMin Len: 1Max Len: 4 | Req | This is a four character description of the unit. Second part of the PDP Customer Profile. | APRK | ||||||||||||||||||||||||||||
<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. | AP | ||||||||||||||||||||||||||||
<creation_date> | String | Req | Date file is created. Format is yyyy-mm-ddThh:mm:ss (Please notice the T separating the Date and Time) | 2017-07-16T09: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.
Required Attribute: id_type="A" | 12345678 | ||||||||||||||||||||||||||||
<payee_own_cd> | String[UCIKFS:A-Z][UCIKFS:A-Z] | Opt | Fill in one of the applicable ownership types. It will be used for 1099 reporting.
| CP | ||||||||||||||||||||||||||||
<customer_institution_identifier> | StringMin Len: 0Max Len: 30 | Opt | Unit defined. For example, the customer number the vendor associates with our account. Leave blank |
| ||||||||||||||||||||||||||||
<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 | ||||||||||||||||||||||||||||
<payment_date> | String | Req | Date payment is due or the check produced. Format is yyyy-mm-dd. This would normally be the due date. | 2017-07-16 | ||||||||||||||||||||||||||||
<attachment_ind> | [UCIKFS:Y,N] | Opt | Y – Indicates that an attachment has been mailed or faxed | N | ||||||||||||||||||||||||||||
<special_handling_ind> | [UCIKFS:Y,N] | Opt | Y – Indicates special handling is required. Use this to indicate Pick Up check. | N | ||||||||||||||||||||||||||||
<taxable_ind> | [UCIKFS:Y,N] | Opt | Y – Taxable expense (Y for 1099) | Y | ||||||||||||||||||||||||||||
<nra_ind> | [UCIKFS:Y,N] | Opt | Y – Vendor is non-resident alien | N | ||||||||||||||||||||||||||||
<combine_group_ind> | [UCIKFS:Y,N] | Opt | Y – Payment may be combined with other payments to the same vendor | Y | ||||||||||||||||||||||||||||
<bank_code> | StringMin Len: 0Max Len: 4 | Opt | Bank code defined in the KFS for Medical Center. WEL9 for Wells Fargo (check) NYM5 for Mellon Bank (ACH) | WEL9 | ||||||||||||||||||||||||||||
<disbursement_date> | String | Required if <pmt_stat_cd> is EXTR otherwise omit | Disbursement date. | 2017-07-16 | ||||||||||||||||||||||||||||
<disbursement_number> | integer Len: 9 | Required if <pmt_stat_cd> is EXTR otherwise omit | Disbursement number. This could be an ACH number or check number. Note: Aperek disbursement number should be 9 digits. | 123456789 | ||||||||||||||||||||||||||||
<disbursement_type> | String Len: 4 | Required if <pmt_stat_cd> is EXTR otherwise omit | Disbursement Type. CHCK for check, ACH for ACH. | CHCK | ||||||||||||||||||||||||||||
<pmt_stat_cd> | String Len: 4 | Req | Hard code EXTR (extracted) | EXTR | ||||||||||||||||||||||||||||
<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 9999 5,000 details per group (was changed from 2009,999 as of 7/3/2018). |
| ||||||||||||||||||||||||||||
<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. | 2017-07-16 | ||||||||||||||||||||||||||||
<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. | MA | ||||||||||||||||||||||||||||
<fdoc_typ_cd> | StringMin Len: 0Max Len: 4 | Opt | Document type code will be EPAY. | EPAY | ||||||||||||||||||||||||||||
<extension> | Opt | |||||||||||||||||||||||||||||||
<use_tax_type_cd> | [UCIKFS:D,I] | Opt | I - for Invoice Date driven use tax calculation D – for Delivery Date driven use tax calculation | D | ||||||||||||||||||||||||||||
<delivery_date> | String Len: 10 | Opt | To allow medical center to specify which date to calculate use tax (delivery date vs. invoice date) YYYY-MM-DD. Populate this tag only if the use_tax_type_cd is D. | 2007-07-09 | ||||||||||||||||||||||||||||
</extension> | Opt |
| ||||||||||||||||||||||||||||||
<chart_cd> | String Len: 2 | Req | Chart Code. MC for Med Center, IR for School of Medicine | MC | ||||||||||||||||||||||||||||
<account_nbr> | String Len: 7 | Req | Account number. | |||||||||||||||||||||||||||||
<sub_account_nbr> | String Len: 5 | Opt | Sub-account number. | |||||||||||||||||||||||||||||
<object_cd> | StringMin Len: 1Max Len: 4 | Req | Object code | 5000 | ||||||||||||||||||||||||||||
<sub_object_cd> | String Len: 4 | Opt | Sub-object code | — | ||||||||||||||||||||||||||||
<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 |
|
| ||||||||||||||||||||||||||||
<capital_asset_information> | Opt | |||||||||||||||||||||||||||||||
<new_asset> | Opt | |||||||||||||||||||||||||||||||
<asset_type_code> | String Len: 7 | Opt | ||||||||||||||||||||||||||||||
<vendor_number> | String Len: 40 | Opt | ||||||||||||||||||||||||||||||
<asset_manufacturer_name> | String Len: 45 | Opt | ||||||||||||||||||||||||||||||
<asset_manufacturer_model_number> | String Len: 25 | Opt | ||||||||||||||||||||||||||||||
<asset_description> | String Len: 40 | Opt | ||||||||||||||||||||||||||||||
</new_asset> | Opt | |||||||||||||||||||||||||||||||
<asset_info_detail> | Opt | |||||||||||||||||||||||||||||||
<asset_tag_number> | String Len: 8 | Opt | ||||||||||||||||||||||||||||||
<asset_serial_number> | String Len: 25 | Opt | ||||||||||||||||||||||||||||||
<campus_code> | String Len: 2 | Opt | ||||||||||||||||||||||||||||||
<building_code> | String Len: 10 | Opt | ||||||||||||||||||||||||||||||
<building_room_number> | String Len: 8 | Opt | ||||||||||||||||||||||||||||||
<building_sub_room_number> | String Len: 2 | Opt | ||||||||||||||||||||||||||||||
</asset_info_detail> | Opt | |||||||||||||||||||||||||||||||
<existing_asset> | Opt | |||||||||||||||||||||||||||||||
<asset_number> | String Len: 12 | Opt | ||||||||||||||||||||||||||||||
</existing_asset> | Opt | |||||||||||||||||||||||||||||||
</capital_asset_information> | Opt | |||||||||||||||||||||||||||||||
</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 |
|
|
...