Skip to main content
Version: 1.7.3

Update

Updates the existing Form 1098-E return created in TaxBandits. Use the unique identifiers to refer a particular return. You cannot update a Transmitted return.

PUT Form1098E/Update  
Run in Postman

Request Body

FieldTypeDescription
SubmissionManifestobjectSubmissionManifest provides brief information about a particular submission on the whole.

It contains information like
  • Submission ID
  • Tax Year
  • IsPostal
  • IsFederalFiling
  • IsOnlineAccess
  • IsScheduleFiling & ScheduleFiling service details
    SubmissionIdGuidUnique identifier created by TaxBandits for each submission. Not required when you are creating a return.
    TaxYearstringTax year of Form 1098 E to be filed.
Allowed values: "2023"
    IsFederalFilingBooleanFederal Filing for the return will be enabled when the value is True. Form 1098 E will be sent directly to the IRS.
    IsPostalBooleanPostal Order will be created when the value is set as True.

Once the return is Transmitted, Form 1098 E Recipient copies will be postal mailed to the recipient's address via USPS.

Note: Postal Orders for Foreign Address will not be created.
    IsOnlineAccessBooleanOnline Access will be enabled when the value is set as True.

Once the return is Transmitted, an email with the link to the secure TaxBandits portal will be sent to the Recipient. The recipient can provide consent and download Form 1098 E Recipient copies from the portal.
    IsScheduleFilingBooleanWhen true, schedule filing services will be provided for Form 1098 E returns under this submission.
    ScheduleFilingobjectContains preferred date to submit the returns to the IRS. Required only when "IsScheduleFiling" is True .
        EfileDatestringDate of Schedule Filing. Enter the date in the format: MM/DD/YYYY or MM-DD-YYYY Example: 10/20/2023 or 10-20-2023
ReturnHeaderobjectContains information about the Business details.
    BusinessobjectObject to identify the Business Details.
        BusinessIdGuidOptional Use the unique Business ID (Generated by TaxBandits), you received in the response of the Business CREATE Endpoint. If you do not have a Business ID, ignore the field. By giving the Business ID, you do not have to provide all the business information again.
        PayerRefstringOptional An unique identifier for each payer completing their information. This identifier can be used in future references of the payer in the API.
Size Range: ..50
        BusinessNmstringName of the business
Size Range: ..75
        FirstNmstringFirst Name of the Individual
Size Range: ..20
        MiddleNmstringMiddle Name of the Individual
Size Range: ..20
        LastNmstringLast Name of the Individual
Size Range: ..20
        SuffixstringSuffix of the Individual
Allowed values

"Jr", "Sr", "I", "II", "III", "IV", "V", "VI", "VII"

        TradeNmstringOptional Name under which the business operates
Size Range: ..75
        IsEINBooleanWhen true, identifies the business with an EIN.
        EINorSSNstringWhen IsEIN is true, use Employer Identification Number (EIN). When IsEIN is false, use Social Security Number (SSN)
Size Range: 9
        EmailstringOptional Email address of the Business
Size Range: ..100
        ContactNmstringOptional Name of the person who can be contacted by the IRS.
Size Range: ..27
        PhonestringOptional Phone number of the business
Size Range: 10
        PhoneExtnstringOptional Extension of the business phone number
Size Range: ..5
        FaxstringOptional Fax number of the Business
Size Range: 10
        BusinessTypestringOptional Type of business. Optional for W-2/1098 E and mandatory for 94X series
Size Range: 4
Allowed values

"ESTE", "PART", "CORP", "EORG", "SPRO"

        SigningAuthorityobjectOptional Details of the person who is authorized to sign the return
            NamestringOptional Name of the signing authority
Size Range: ..35
            PhonestringOptional Phone number of the signing authority
Size Range: 10
            BusinessMemberTypestringOptional Business title of the signing authority
Size Range: 5..29
Allowed values

"CORPORATESECRETARY", "SECRETARYTREASURER", "PARTNER", "GENERALPARTNER", "LIMITEDPARTNER", "LLCMEMBER", "MANAGINGMEMBER", "MANAGER", "TAXMATTERPARTNER", "PRESIDENT", "VICEPRESIDENT", "CORPORATETREASURER", "TREASURER", "ASSISTANTTREASURER", "CHIEFACCOUNTINGOFFICER", "CHIEFEXECUTIVEOFFICER", "CHIEFFINANCIALOFFICER", "TAXOFFICER", "CHIEFOPERATINGOFFICER", "CORPORATEOFFICER", "EXECUTIVEDIRECTOR", "DIRECTOR", "CHAIRMAN", "EXECUTIVEADMINISTRATOR", "RECEIVER", "PASTOR", "ASSISTANTTORELIGIOUSLEADER", "REVEREND", "PRIEST", "MINISTER", "RABBI", "LEADEROFRELIGIOUSORGANIZATION", "SECRETARY", "DIRECTOROFTAXATION", "DIRECTOROFPERSONNEL", "ADMINISTRATOR", "EXECUTOR", "TRUSTEE", "FIDUCIARY", "OWNER", "SOLEPROPRIETOR", "MEMBER", "SOLEMEMBER"

        KindOfEmployerstringOptional Identifies the kind of employer. Mandatory for W-2 and optional for 1098 E
Allowed values

"FEDERALGOVT", "STATEORLOCAL501C", "NONGOVT501C", "STATEORLOCALNON501C", "NONEAPPLY"

        KindOfPayerstringOptional Identifies the kind of payer. This field is mandatory in W-2 and optional in 1098 E
Allowed values

"REGULAR941", "REGULAR944", "AGRICULTURAL943", "HOUSEHOLD", "MILITARY", "MEDICAREQUALGOVEM", "RAILROADFORMCT1"

        IsBusinessTerminatedBooleanWhen true, identifies the business as terminated.
        IsForeignBooleanWhen true, identifies the business address with a foreign address.
        USAddressobjectIf IsForeign is false, pass US address of the business
            Address1stringEmployer/Payer's US address (street or post office box of that locality)
Size Range: ..46
            Address2stringOptional Employer/Payer's suite or apartment
Size Range: ..46
            CitystringEmployer/Payer's city
Size Range: ..50
            StatestringEmployer/Payer's state code. Refer Static values.
Size Range: 2
Allowed values

"AL", "AK", "AZ", "AR", "CA", "CO", "CT", "DE", "DC", "FL", "GA", "HI", "ID", "IL", "IN", "IA", "KS", "KY", "LA", "ME", "MD", "MA", "MI", "MN", "MS", "MO", "MT", "NE", "NV", "NH", "NJ", "NM", "NY", "NC", "ND", "OH", "OK", "OR", "PA", "RI", "SC", "SD", "TN", "TX", "UT", "VT", "VA", "WA", "WV", "WI", "WY", "AS", "FM", "GU", "MH", "MP", "PW", "PR", "VI", "AA", "AE", "AP"

            ZipCdstringEmployer/Payer's zip code
Size Range: 5..10
        ForeignAddressobjectIf IsForeign is true, pass foreign address of the business
            Address1stringEmployer/Payer's foreign address (street address or post office box of that locality)
Size Range: ..50
            Address2stringOptional Employer/Payer's suite or apartment
Size Range: ..50
            CitystringEmployer/Payer's city
Size Range: ..50
            ProvinceOrStateNmstringEmployer/Payer's province or state name
Size Range: ..50
            CountrystringEmployer/Payer's country
Size Range: 2
Allowed values

"AF", "AX", "AL", "AG", "AQ", "AN", "AO", "AV", "AY", "AC", "AR", "AM", "AA", "AT", "AS", "AU", "AJ", "BF", "BA", "FQ", "BG", "BB", "BO", "BE", "BH", "BN", "BD", "BT", "BL", "BK", "BC", "BV", "BR", "IO", "VI", "BX", "BU", "UV", "BM", "BY", "CB", "CM", "CA", "CV", "CJ", "CT", "CD", "CI", "CH", "KT", "IP", "CK", "CO", "CN", "CF", "CG", "CW", "CR", "CS", "IV", "HR", "CU", "UC", "CY", "EZ", "DA", "DX", "DJ", "DO", "DR", "TT", "EC", "EG", "ES", "EK", "ER", "EN", "ET", "FK", "FO", "FM", "FJ", "FI", "FR", "FP", "FS", "GB", "GA", "GG", "GM", "GH", "GI", "GR", "GL", "GJ", "GQ", "GT", "GK", "GV", "PU", "GY", "HA", "HM", "VT", "HO", "HK", "HQ", "HU", "IC", "IN", "ID", "IR", "IZ", "EI", "IS", "IT", "JM", "JN", "JA", "DQ", "JE", "JQ", "JO", "KZ", "KE", "KQ", "KR", "KN", "KS", "KV", "KU", "KG", "LA", "LG", "LE", "LT", "LI", "LY", "LS", "LH", "LU", "MC", "MK", "MA", "MI", "MY", "MV", "ML", "MT", "IM", "RM", "MR", "MP", "MX", "MQ", "MD", "MN", "MG", "MJ", "MH", "MO", "MZ", "WA", "NR", "BQ", "NP", "NL", "NC", "NZ", "NU", "NG", "NI", "NE", "NF", "CQ", "NO", "MU", "OC", "PK", "PS", "LQ", "PM", "PP", "PF", "PA", "PE", "RP", "PC", "PL", "PO", "RQ", "QA", "RO", "RS", "RW", "TB", "RN", "WS", "SM", "TP", "SA", "SG", "RI", "SE", "SL", "SN", "NN", "LO", "SI", "BP", "SO", "SF", "SX", "OD", "SP", "PG", "CE", "SH", "SC", "ST", "SB", "VC", "SU", "NS", "SV", "WZ", "SW", "SZ", "SY", "TW", "TI", "TZ", "TH", "TO", "TL", "TN", "TD", "TS", "TU", "TX", "TK", "TV", "UG", "UP", "AE", "UK", "UY", "UZ", "NH", "VE", "VM", "VQ", "WQ", "WF", "WI", "YM", "ZA", "ZI"

            PostalCdstringEmployer/Payer's postal code
Size Range: ..16
ReturnDataobject[]Contains information about the recipient details and Form 1098 E details.
    SequenceIdstringAn unique reference ID for the submission that can be used to identify a particular record. The Sequence ID will be returned in the Response for your reference.
Size Range: 50
    Recipientobject[]Object to identify the recipient details.
        RecipientIdGuidOptional An unique ID generated by TaxBandits after the return is created and will be returned in the Response. You can use this id for your future reference to update.
        TINTypestringSpecify the TIN type of the recipient.

Note: If the recipient doesn't have a TIN, enter the TIN type as 'NA' and input 'null' in the TIN field.
Allowed values

"SSN", "EIN", "ITIN", "ATIN", "NA"

        TINstringEnter the nine-digit taxpayer identification number of the Recipient (SSN, ITIN, ATIN, or EIN).
Size Range: 9
        FirstPayeeNmstringEnter the name of the recipient (preferably last name first for an Individual). If more space is required for the name, use the Second Payee Name Field.
Size Range: 40
        SecondPayeeNmstringOptional If there are multiple recipients (for example, partners, joint owners, or spouses), use this field for those names not associated with the TIN or if not enough space was provided in the First Payee Name, continue the name in this field.
Size Range: 40
        FirstNmstringFirst Name of the Individual
Size Range: ..20
        MiddleNmstringMiddle Name of the Individual
Size Range: ..20
        LastNmstringLast Name of the Individual
Size Range: ..20
        SuffixstringSuffix of the Individual
Allowed values

"Jr", "Sr", "I", "II", "III", "IV", "V", "VI", "VII"

        IsForeignBooleanWhen true, it identifies the recipient's address with a foreign address.
        USAddressobjectIf IsForeign is false, pass US address of the recipient
            Address1stringRecipient's US address (street address or post office box of that locality)
Size Range: ..46
            Address2stringOptional Recipient's suite or apartment
Size Range: ..46
            CitystringRecipient's city
Size Range: ..50
            StatestringRecipient's state code. Refer Static values.
Size Range: 2
Allowed values

"AL", "AK", "AZ", "AR", "CA", "CO", "CT", "DE", "DC", "FL", "GA", "HI", "ID", "IL", "IN", "IA", "KS", "KY", "LA", "ME", "MD", "MA", "MI", "MN", "MS", "MO", "MT", "NE", "NV", "NH", "NJ", "NM", "NY", "NC", "ND", "OH", "OK", "OR", "PA", "RI", "SC", "SD", "TN", "TX", "UT", "VT", "VA", "WA", "WV", "WI", "WY", "AS", "FM", "GU", "MH", "MP", "PW", "PR", "VI", "AA", "AE", "AP"

            ZipCdstringRecipient's zip code
Size Range: 5..10
        ForeignAddressobjectIf IsForeign is true, pass foreign address of the recipient
            Address1stringRecipient's foreign address (street address or post office box of that locality)
Size Range: ..50
            Address2stringOptional Recipient's suite or apartment
Size Range: ..50
            CitystringRecipient's city.
Size Range: ..50
            ProvinceOrStateNmstringRecipient's Province or State Name.
Size Range: ..50
            CountrystringRecipient's country code. Refer Static values.
Size Range: 2
Allowed values

"AF", "AX", "AL", "AG", "AQ", "AN", "AO", "AV", "AY", "AC", "AR", "AM", "AA", "AT", "AS", "AU", "AJ", "BF", "BA", "FQ", "BG", "BB", "BO", "BE", "BH", "BN", "BD", "BT", "BL", "BK", "BC", "BV", "BR", "IO", "VI", "BX", "BU", "UV", "BM", "BY", "CB", "CM", "CA", "CV", "CJ", "CT", "CD", "CI", "CH", "KT", "IP", "CK", "CO", "CN", "CF", "CG", "CW", "CR", "CS", "IV", "HR", "CU", "UC", "CY", "EZ", "DA", "DX", "DJ", "DO", "DR", "TT", "EC", "EG", "ES", "EK", "ER", "EN", "ET", "FK", "FO", "FM", "FJ", "FI", "FR", "FP", "FS", "GB", "GA", "GG", "GM", "GH", "GI", "GR", "GL", "GJ", "GQ", "GT", "GK", "GV", "PU", "GY", "HA", "HM", "VT", "HO", "HK", "HQ", "HU", "IC", "IN", "ID", "IR", "IZ", "EI", "IS", "IT", "JM", "JN", "JA", "DQ", "JE", "JQ", "JO", "KZ", "KE", "KQ", "KR", "KN", "KS", "KV", "KU", "KG", "LA", "LG", "LE", "LT", "LI", "LY", "LS", "LH", "LU", "MC", "MK", "MA", "MI", "MY", "MV", "ML", "MT", "IM", "RM", "MR", "MP", "MX", "MQ", "MD", "MN", "MG", "MJ", "MH", "MO", "MZ", "WA", "NR", "BQ", "NP", "NL", "NC", "NZ", "NU", "NG", "NI", "NE", "NF", "CQ", "NO", "MU", "OC", "PK", "PS", "LQ", "PM", "PP", "PF", "PA", "PE", "RP", "PC", "PL", "PO", "RQ", "QA", "RO", "RS", "RW", "TB", "RN", "WS", "SM", "TP", "SA", "SG", "RI", "SE", "SL", "SN", "NN", "LO", "SI", "BP", "SO", "SF", "SX", "OD", "SP", "PG", "CE", "SH", "SC", "ST", "SB", "VC", "SU", "NS", "SV", "WZ", "SW", "SZ", "SY", "TW", "TI", "TZ", "TH", "TO", "TL", "TN", "TD", "TS", "TU", "TX", "TK", "TV", "UG", "UP", "AE", "UK", "UY", "UZ", "NH", "VE", "VM", "VQ", "WQ", "WF", "WI", "YM", "ZA", "ZI"

            PostalCdstringRecipient's Postal Code
Size Range: ..16
        EmailstringOptional Recipient's email address.
Size Range: 0..100
Note : This email address cannot be the same for two different recipients under the same business.
        FaxstringOptional Recipient's Fax number.
Size Range: 10
        PhonestringOptional Recipient's Phone Number.
Size Range: 10
    Form1098EDataobjectRecipient's Form 1098 E information
        B1IntRecNumberInterest received on a recipient loan(s)
Size Range: 0-9999999999.99
        IsLnOrFeesNotRptdBooleanwhen true, identifies that the loan origination fees or capitalized interest are not reported in B1IntRec for loans made before September 1, 2004
        AccountNumstringAccount number of lender having multiple accounts for a recipient for whom more than one Form 1098 E is filed.
Size Range: 4..20
Note: If the account number on the return you file is the same as any previously filed return, TaxBandits will append 3 random numbers at the end of the account number.

Request JSON

Created a Form 1098-E return for the specific Business, including recipient and income information. Now, update the Recipient/Form Details with RecipientId and RecordId.

{
"SubmissionManifest": {
"SubmissionId": "265ab596-1110-4e38-8223-1119d07b4054",
"TaxYear": "2023",
"IsFederalFiling": true,
"IsPostal": true,
"IsOnlineAccess": true,
"IsScheduleFiling": false,
"ScheduleFiling": null
},
"ReturnHeader": {
"Business": {
"BusinessId": null,
"BusinessNm": "Snowdaze LLC",
"FirstNm": null,
"MiddleNm": null,
"LastNm": null,
"Suffix": null,
"PayerRef": "Snow123",
"TradeNm": "Iceberg Icecreams",
"IsEIN": true,
"EINorSSN": "71-3787159",
"Email": "james@sample.com",
"ContactNm": null,
"Phone": "6634567890",
"PhoneExtn": "12345",
"Fax": "6634567890",
"BusinessType": "ESTE",
"SigningAuthority": null,
"KindOfEmployer": "FederalGovt",
"KindOfPayer": "REGULAR941",
"IsBusinessTerminated": true,
"IsForeign": false,
"USAddress": {
"Address1": "3576 AIRPORT WAY",
"Address2": "UNIT 9",
"City": "FAIRBANKS",
"State": "AK",
"ZipCd": "99709"
},
"ForeignAddress": null
}
},
"ReturnData": [
{
"SequenceId": "1",
"IsPostal": true,
"IsOnlineAccess": true,
"IsForced": true,
"RecordId": "488b1c7e-d244-4d6a-8491-65ae2209a99f",
"Recipient": {
"RecipientId": "472079fb-2dcf-4228-8548-73656ddafc30",
"TINType": "SSN",
"TIN": "363814579",
"FirstPayeeNm": null,
"SecondPayeeNm": null,
"FirstNm": "Shawn",
"MiddleNm": null,
"LastNm": "Williams",
"Suffix": null,
"IsForeign": true,
"USAddress": null,
"ForeignAddress": {
"Address1": "120 Bremner Blvd",
"Address2": "Suite 800",
"City": "Toronto",
"ProvinceOrStateNm": "Ontario",
"Country": "CA",
"PostalCd": "4168682600"
},
"Email": "shawn@sample.com",
"Fax": "6834567890",
"Phone": "7634567890"
},
"Form1098EData": {
"B1IntRec": 10000,
"IsLnOrFeesNotRptd": true,
"AccountNum": null
}
}
]
}

Response Body

FieldTypeDescription
StatusCodenumberReturns the HTTP status codes like 200,300 etc.
StatusNamestringName of the status code
StatusMessagestringDetailed status message
SubmissionIdGuidUnique identifier of a submission
BusinessIdGuidUnique identifier of a Business.
PayerRefstringUnique identifier of the Payer.
Form1098TypestringDenotes the type of 1098 E form.
Form1098ERecordsobjectPulls the Form 1098 E records with Success and Error statuses
    SuccessRecordsobject[]It will show the detailed information about the success status of Form 1098 E Records
        SequenceIdstringA unique number given by an inbound application to identify failed records
        RecordIdGuidAn unique identifier generated by TaxBandits when a 1098 E return is created.
        RecipientIdGuidAn unique identifier generated by TaxBandits for a Recipient when a 1098 E return is created. You can use this id for your future reference to Update.
        FederalReturnobjectReturns the record status and StatusTs of federal return.
            StatusstringReturns the record status.
            StatusTsstringReturns date and time of return created.
            InfostringReturns information about the Federal Filing service.
            Errorsobject[]Shows error information in state returns of Form 1098 E.
        PostalobjectReturns the status and StatusTs of postal mailing service for Form 1098 E.
            StatusstringReturns the status of postal order.
            StatusTsstringReturns the date and time of the postal order created.
            InfostringReturns the information about Postal mailing service.
        OnlineAccessobjectReturns the Email address for whom the online access to be given and Status of online access.
            StatusstringReturns status of online access for Form 1098 E return.
            EmailstringEmail address for whom the online access to be given.
            InfostringInformation about the online access service.
        ScheduleFilingobjectReturns the date of the schedule filing.
            ScheduledOnstringDate of the schedule filing to know when the return to be filed to the IRS.
            InfostringInformation about Schedule Filing service.
    ErrorRecordsobject[]It will show the detailed information about the error status of Form 1098 E Records.
Errorsobject[]Shows detailed error information
    IdstringReturns the validation error Id
    NamestringName of the validation error
    MessagestringDescription of the validation error

Response JSON

Success Response - This is a sample response for successful API requests.

{
"StatusCode": 200,
"StatusName": "Ok",
"StatusMessage": "Successful API call",
"SubmissionId": "c03feb88-d8a1-4080-8bc6-4e6adec1bba5",
"BusinessId": "8d177248-992e-4ca5-ba9e-1a5a8a93db56",
"PayerRef": "Snow123",
"Form1098Type": "E",
"Form1098ERecords": {
"SuccessRecords": [
{
"SequenceId": "1",
"RecordId": "488b1c7e-d244-4d6a-8491-65ae2209a99f",
"RecipientId": "472079fb-2dcf-4228-8548-73656ddafc30",
"AccountNum": "20231090030132071327",
"FederalReturn": {
"Status": "CREATED",
"StatusTs": "2024-04-18 05:31:03 -04:00",
"Info": null,
"Errors": null
},
"Postal": {
"Status": "NOTCREATED",
"StatusTs": null,
"Info": "Postal Alert cannot be opted for the return, when the recipient (or) business address has foreign address"
},
"OnlineAccess": {
"Status": "CREATED",
"Email": "shawn@sample.com",
"Info": null
},
"ScheduleFiling": null
}
],
"ErrorRecords": null
},
"Errors": null
}