Collector XML Upload Format
In addition to the standard formatting rules that apply to all batch upload file formats, keep the following points in mind about the XML Collector format:
• The file must begin with the standard XML version line such as:
<?xml version="1.0" encoding="UTF-8"?>
• The root (first) tag for collector files must be the <batch> tag, and the file must contain only one <batch></batch> tag. This tag also contains attributes that identify the schema the document adheres to, such as:
<batch xmlns=http://www.kuali.org/kfs/gl/collector
xmlns:xsi=http://www.w3.org/2001/XMLSchema-instance
xsi:schemaLocation="http://www.kuali.org/kfs/gl/collector https://test.kuali.org/kuali-reg/static/xsd/gl/collector.xsd" >
• Following the batch tag must be the <header> tag. This section gives general information about the set of records being transmitted. Like the batch tag, the file must contain only one <header></header> tag. Within the header tag are other tags that identify pieces of header information.
• Next comes a <glEntry> tag. This tag contains other tags that represent the fields of the origin entry table. Each <glEntry></glEntry> tag represents one row in the origin entry table.
• Following the gl entry tag is an optional <detail> tag. This tag contains other tags that represent fields of the inter-departmental billing table. Each <detail></detail> tag represents one row in this table.
• The sequence of <glEntry> and <detail> tags can repeat one or many times. Since the <detail> tag is optional in each sequence, there can be many <glEntry> tags back to back.
• The final tag required for a collector batch file is the <trailer> tag. This contains tags for reconciliation of the file. The file must contain only one <trailer></trailer> tag.
GL XML Collector format
|
Name |
Type |
Max Size |
Required? |
Special Formatting |
|
Header | ||||
|
<chartOfAccountsCode> |
Characters |
2 |
Yes |
|
|
<organizationCode> |
Characters |
4 |
Yes |
|
|
<transmissionDate> |
Date |
|
Yes |
YYYY-MM-DD format |
|
<batchSequenceNumber> |
Integer |
|
Yes |
|
|
<personUserId> |
Characters |
8 |
Yes |
|
|
<emailAddress> |
Characters |
70 |
Yes |
|
|
<campusCode> |
Characters |
2 |
Yes |
|
|
<phoneNumber> |
Characters |
20 |
Yes |
|
|
<mailingAddress> |
Characters |
30 |
Yes |
|
|
<departmentName> |
Characters |
30 |
Yes |
|
|
GL Entry | ||||
|
<universityFiscalYear> |
Integer |
4 |
No |
|
|
<chartOfAccountsCode> |
Characters |
2 |
Yes |
|
|
<accountNumber> |
Characters |
7 |
Yes |
|
|
<subAccountNumber> |
Characters |
5 |
No |
|
|
<objectCode> |
Characters |
4 |
Yes |
|
|
<subObjectCode> |
Characters |
3 |
No |
|
|
<balanceTypeCode> |
Characters |
2 |
Yes |
|
|
<objectTypeCode> |
Characters |
2 |
No |
|
|
<universityFiscalAccountingPeriod> |
Characters |
2 |
No |
|
|
<documentTypeCode> |
Characters |
4 |
Yes |
|
|
<originationCode> |
Characters |
2 |
Yes |
|
|
<documentNumber> |
Characters |
14 |
Yes |
|
|
<transactionEntrySequenceId> |
Integer |
5 |
No |
|
|
<transactionLedgerEntryDescription> |
Characters |
40 |
Yes |
|
|
<transactionLedgerEntryAmount> |
Decimal |
|
Yes |
Money Format (2 decimal places) |
|
<debitOrCreditCode> |
Characters |
1 |
Yes |
|
|
<transactionDate> |
Date |
|
Yes |
YYYY-MM-DD Format |
|
<organizationDocumentNumber> |
Characters |
10 |
No |
|
|
<projectCode> |
Characters |
10 |
No |
|
|
<organizationReferenceId> |
Characters |
8 |
No |
|
|
<referenceDocumentTypeCode> |
Characters |
4 |
No |
|
|
<referenceOriginationCode> |
Characters |
2 |
No |
|
|
<referenceDocumentNumber> |
Characters |
14 |
No |
|
|
<documentReversalDate> |
Date |
|
No |
YYYY-MM-DD Format |
|
<encumbranceUpdateCode> |
Characters |
1 |
No |
Valid values are “R” and “D” |
|
Detail | ||||
|
<universityFiscalAccountingPeriod> |
Characters |
2 |
Yes |
|
|
<universityFiscalYear> |
Integer |
4 |
Yes |
|
|
<createDate> |
Date |
|
No |
YYYY-MM-DD Format |
|
<chartOfAccountsCode> |
Characters |
2 |
Yes |
|
|
<accountNumber> |
Characters |
7 |
Yes |
|
|
<subAccountNumber> |
Characters |
5 |
No |
|
|
<objectCode> |
Characters |
4 |
Yes |
|
|
<subObjectCode> |
Characters |
3 |
No |
|
|
<collectorDetailSequenceNumber> |
Integer |
2 |
Yes |
|
|
<originationCode> |
Characters |
2 |
Yes |
|
|
<documentTypeCode> |
Characters |
4 |
Yes |
|
|
<documentNumber> |
Characters |
14 |
Yes |
|
|
<amount> |
Decimal |
|
Yes |
Money format (2 decimal places) |
|
<detailText> |
Characters |
120 |
Yes |
|
|
<createDate> |
Date |
|
Yes |
YYYY-MM-DD Format |
|
<balanceTypeCode> |
Characters |
2 |
Yes |
|
|
<objectTypeCode> |
Characters |
2 |
No |
|
|
Trailer | ||||
|
<totalRecords> |
Integer |
|
Yes |
|
|
<totalAmount> |
Decimal |
|
Yes |
Money format (2 decimal places) |
Enterprise Feed
Upload