Additional Detail Information of Schema Elements

Return Elements

SUTFiling Attributes

  1. usage - Use "Prod" for production. Use "Test" to indicate a test file.
  2. purpose - This attribute is optional. If not used, original is assumed.
    • Original - Indicates original return.
    • Replace - Replaces the original return (and any previous amended returns) entirely.
  3. finalReturn - This attribute is optional. Use it only to indicate this is a final return and that no more returns will be filed for this entity.
  4. defaultCurrency - Optional. Use "USD" for US Dollars.

FilerID - Wisconsin Tax Number (WTN) -- This is the number issued by our integrated tax system. It is 15 digits and must be entered as 15 numbers without spaces or dashes. This number will start with 456.

Name -- This is the name of the entity for whom the return is being filed. It is the name associated with the tax account number.

Filing Period -- PeriodStart is the first day of the period covered by the return. Period end is the last day of the period covered by the return (Note: Period covered is determined by the filing frequency as assigned by DOR). DueDate is the date the return is due, generally the 20th or the last day of the month following the close of the filing period, or the next business day if that date falls on a weekend or state holiday. (Note: Earlier filing may be necessary for EFT payments to be timely.)

Dates -- Dates in XML are always ccyy-mm-dd, so January 31, 2010 is 2010-01-31.

SUTReturn Attributes -- See the Form ST-12 instructions for additional information on specific elements under SUTReturn.

  1. Type - Name of the equivalent paper return.
  2. Activity - Use this attribute to indicate if there was any activity to report for the period covered.
  3. Version - Version number of the return layout for XML. Changes to the paper return sufficient to cause changes in the XML schema will increment this version number.

County Detail -- This group of elements can be repeated for as many counties as necessary. The sum of all counties is reported in CountyTotal.

County -- This is the county name. It comes from a case sensitive enumerated list and must match exactly. The enumerated list is located in the schema.

County Total -- County Total is the sum of all values of the county detail elements.

Remittance - Effective Entry Date -- This element is optional. This is the date you would like the funds to be transferred from your account to WDOR's account. If you leave this blank and transmit your return before 3:00 PM CST, the funds will transfer on the next bank business day. If you transmit your return after the 3:00 PM cutoff, the funds will transfer on the second bank business day. If you enter a date in the future, WDOR will warehouse your payment until the designated date. Dates in the past will be treated the same as blank dates.

Preparer/Contact -- At least one name and phone number are required with each return and preparer type attribute. Use the preparer type attribute to indicate whether the return is originated by a paid preparer or directly by the taxpayer. The name, phone number, and other contact information, is desired, for the preparer of the return. Use the Contact element for a second contact. If the Contact element is used, DOR will use that information as the first point of contact.

Sender ID -- An ID created by the sender that identifies the sender. It is especially useful for a software vendor, tax practitioner or other concentrators that prepare or send return data for customers.

Filing Key -- Key used for electronic communications and error processing. This key will be returned in the confirmation/reject email acknowledgement. It is especially useful for a software vendor, tax practitioner or other concentrators that prepare or send return data for customers. This could be an internal customer identification number used by a tax practitioner.

File Creation Time Stamp -- Insert the date and time that you create the file. This timestamp will be included in the acknowledgement to help identify a specific return. This may be helpful if you submit multiple returns in one transmission.

Note: The format of the timestamp is ccyy-mm-ddThh:mm:ss-hh:00 where the final -hh:00 is the offset from GMT (the value for CDT is - 05:00, that is 5 hours behind GMT).

Software ID -- This is a unique 8-digit number created by a software vendor to identify the vendor and/or version of software package used to produce the XML instance document.

AckAddress -- This is the email address where acknowledgements will be sent.

Optional/Blank/Zero Elements or Values -- If an element is listed as optional and you have nothing to report for that element, you may omit the element or show the element with no value. However, string elements differ from decimal elements. Numeric or decimal elements need to show 0 (zero) to validate. String elements may be blank, have no space between begin and end tags or use a shorthand tag (e.g.<element0>).

Remittance - Routing Transit Number -- This is the number that identifies your bank. It can be found on the bottom of your check.

Remittance - Bank Account Number -- This is your bank account number from which you want the payment made. It can also be found on the bottom of your check.

Remittance - Amount Type -- This is a code that indicates the type of bank account you are making the payment from, "1" = checking, "2" = savings.

Acknowledgment Elements

Jurisdiction – This is the jurisdiction issuing the acknowledgement. It should always be Wisconsin Department of Revenue.

Response Timestamp – The date and time the acknowledgement is issued.

Response Code – This is a 3-digit code. See Pub 129 for complete listing of codes.

NoReply – This acknowledgement is auto generated. Any reply may go to an unmonitored email account. See our web page for contact information, including email addresses.

Response text – This is a description of the status of your return.

Filer ID -– This is the ID used on the return that is being acknowledged.

Period End Date – The period end date from the return being acknowledged.

Sender ID – The Sender ID used in the return that is returned in the acknowledgement.

Filing Key – The filing key used in the return that is returned in the acknowledgement.

File Creation Timestamp – The File Creation Timestamp used in the return that is returned in the acknowledgement.

Success – If the return was accepted, you will see a Success element.

ACD Debit Status – Indicates whether an ACH debit payment was included with the return.

Effective Date – This is the effective entry date of the payment (i.e., the day you want the funds to settle in DOR's account). This field is optional. If you do not supply a date, DOR will withdraw the funds the following business day.

Confirmation Number – This is a unique number that identifies your submission. You should record this number and keep it with your records.

ErrorList – This element contains a list of one or more errors.

Error – A container for the error details.

XPath – This optional element may list the XPath (the exact location) of the error in your XML document.

ErrorCategory – This will always be "Wisconsin Schemas".

ErrorMessage – This will be the error message.

RuleNumber – Will usually be "001" for validation errors.

Severity – This will usually be "Reject". Other acceptable values are "Alert" and "Reject and "Stop".

March 8, 2012