Create
This endpoint is used to create Form 1098-T in TaxBandits. You can create multiple 1098-T forms in a single request for the same Payer (Maximum 250).
While creating the form, you can opt for Postal Mailing and/or Online Access either against a submission (or) against particular records.
In response, a SubmissionId is created, which is further used as a reference for all other methods of Form 1098-T API
POST Form1098T/Create
Request Body
Field | Type | Description |
---|---|---|
SubmissionManifest | object | SubmissionManifest provides brief information about a particular submission on the whole. It contains information like
|
TaxYear | string | Tax year of Form 1098-T to be filed. Allowed values: "2023","2024" |
IsFederalFiling | Boolean | Federal Filing for the return will be enabled when the value is True. Form 1098-T will be sent directly to the IRS. |
IsPostal | Boolean | Postal Order will be created when the value is set as True. Once the return is Transmitted, Form 1098-T Recipient copies will be postal mailed to the recipient's address via USPS. Note: Postal Orders for Foreign Address will not be created. |
IsOnlineAccess | Boolean | Online Access will be enabled when the value is set as True. Once the returns are transmitted, an email with a link to the secure TaxBandits portal will be sent to the recipients. The recipients can provide consent and download Form 1098-T Recipient copies from the portal. |
IsScheduleFiling | Boolean | When true, schedule filing services will be provided for Form 1098-T returns under this submission. |
ScheduleFiling | object | Contains preferred date to submit the returns to the IRS. Required only when "IsScheduleFiling" is True . |
EfileDate | string | Date of Schedule Filing. Enter the date in the format: MM/DD/YYYY or MM-DD-YYYY Example: 10/20/2023 or 10-20-2023 |
ReturnHeader | object | Contains information about the Business details. |
Business | object | Object to identify the Business Details. |
BusinessId | Guid | Optional 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. |
PayerRef | string | Optional 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 |
BusinessNm | string | Name of the business Size Range: ..75 |
FirstNm | string | First Name of the Individual Size Range: ..20 |
MiddleNm | string | Middle Name of the Individual Size Range: ..20 |
LastNm | string | Last Name of the Individual Size Range: ..20 |
Suffix | string | Suffix of the IndividualAllowed values"Jr", "Sr", "I", "II", "III", "IV", "V", "VI", "VII" |
TradeNm | string | Optional Name under which the business operates Size Range: ..75 |
IsEIN | Boolean | When true, identifies the business with an EIN. |
EINorSSN | string | When IsEIN is true, use Employer Identification Number (EIN). When IsEIN is false, use Social Security Number (SSN) Size Range: 9 |
string | Optional Email address of the Business Size Range: ..100 | |
ContactNm | string | Optional Name of the person who can be contacted by the IRS Size Range: ..27 |
Phone | string | Optional Phone number of the business Size Range: 10 |
PhoneExtn | string | Optional Extension of the business phone number Size Range: ..5 |
Fax | string | Optional Fax number of the Business Size Range: 10 |
BusinessType | string | Optional Type of business. Optional for w-2/1098-T and mandatory for 94X series Size Range: ..4 Allowed values"ESTE", "PART", "CORP", "EORG", "SPRO" |
SigningAuthority | object | Optional Details of the person who is authorized to sign the return |
Name | string | Optional Name of the signing authority Size Range: ..35 |
Phone | string | Optional Phone number of the signing authority Size Range: 10 |
BusinessMemberType | string | Optional 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" |
KindOfEmployer | string | Optional Identifies the kind of employer. Mandatory for W-2 and optional for 1098-TAllowed values"FEDERALGOVT", "STATEORLOCAL501C", "NONGOVT501C", "STATEORLOCALNON501C", "NONEAPPLY" |
KindOfPayer | string | Optional Identifies the kind of payer. This field is mandatory in W-2 and optional in 1098-TAllowed values"REGULAR941", "REGULAR944", "AGRICULTURAL943", "HOUSEHOLD", "MILITARY", "MEDICAREQUALGOVEM", "RAILROADFORMCT1" |
IsBusinessTerminated | Boolean | When true, identifies the business as terminated. |
IsForeign | Boolean | When true, identifies the business address with a foreign address. |
USAddress | object | If IsForeign is false, pass US address of the business |
Address1 | string | Employer/Payer's US address (street address or post office box of that locality) Size Range: ..46 |
Address2 | string | Optional Employer/Payer's suite or apartment Size Range: ..46 |
City | string | Employer/Payer's city Size Range: ..50 |
State | string | Employer/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" |
ZipCd | string | Employer/Payer's zip code. Size Range: 5..10 |
ForeignAddress | object | If IsForeign is true, pass foreign address of the business |
Address1 | string | Employer/Payer's foreign address (street address or post office box of that locality) Size Range: ..50 |
Address2 | string | Optional Employer/Payer's suite or apartment Size Range: ..50 |
City | string | Employer/Payer's city Size Range: ..50 |
ProvinceOrStateNm | string | Employer/Payer's province or state name Size Range: ..50 |
Country | string | Employer/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" |
PostalCd | string | Employer/Payer's postal code. Size Range: ..16 |
ReturnData | object[] | Contains information about the recipient details and Form 1098-T details. |
SequenceId | string | An 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 |
Recipient | object | Object to identify the recipient details. |
RecipientId | Guid | OptionalAn 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. |
TINType | string | Specify 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" |
TIN | string | Enter the nine-digit taxpayer identification number of the Recipient (SSN, ITIN, ATIN, or EIN). Size Range: 9 |
FirstPayeeNm | string | Enter 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 |
SecondPayeeNm | string | Optional 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 |
FirstNm | string | First Name of the Individual Size Range: ..20 |
MiddleNm | string | Middle Name of the Individual Size Range: ..20 |
LastNm | string | Last Name of the Individual Size Range: ..20 |
Suffix | string | Suffix of the IndividualAllowed values"Jr", "Sr", "I", "II", "III", "IV", "V", "VI", "VII" |
IsForeign | Boolean | When true, identifies the recipient address with a foreign address. |
USAddress | object | If IsForeign is false, pass US address of the recipient |
Address1 | string | Recipient's US address (street address or post office box of that locality) Size Range: ..46 |
Address2 | string | Optional Recipient's suite or apartment Size Range: ..46 |
City | string | Recipient's city Size Range: ..50 |
State | string | Recipient'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" |
ZipCd | string | Recipient's zip code Size Range: 5..10 |
ForeignAddress | object | If IsForeign is true, pass foreign address of the recipient |
Address1 | string | Recipient's foreign address (street address or post office box of that locality) Size Range: ..50 |
Address2 | string | Optional Recipient's suite or apartment Size Range: ..50 |
City | string | Recipient's city. Size Range: ..50 |
ProvinceOrStateNm | string | Recipient's Province or State Name. Size Range: ..50 |
Country | string | Recipient'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" |
PostalCd | string | Recipient's Postal Code. Size Range: ..16 |
string | Optional Recipient's email address. Size Range: 0..100 Note : This email address cannot be the same for two different recipients under the same business. | |
Fax | string | Optional Recipient's Fax number. Size Range: 10 |
Phone | string | Optional Recipient's Phone Number. Size Range: 10 |
Form1098TData | object | Recipient's Form 1098-T information. |
IsSolicit | Boolean | When True , Identifies that the recipient’s TIN is solicited |
B1PymtRec | number | Total Payments Received from recipient for Qualified Tuition and Related Expenses including scholarships or grants reported in B5SchOrGrnts Size Range: 0-999999999.99 |
B4AdjPriorYr | number | Optional Total adjustments (reimbursements or refunds) made on of qualified tuition and related expenses to the recipient for a Prior Year Size Range: 0-999999999.99 |
B5SchOrGrnts | number | Optional Total amount on Scholarships or Grants Note: B5SchOrGrnts should be greater than B1PymtRec. Size Range: 0-999999999.99 |
B6AdjSchOrGrnts | number | Optional Total adjustments (reductions) reported on Scholarships or Grants for a Prior Year Size Range: 0-999999999.99 |
B7IsPymtRecSub | Boolean | When True , Identifies that the B1PymtRec includes amounts for an academic period beginning January – March of subsequent tax year |
B8IsHalfTmStdnt | Boolean | When true, Identifies that recipient was at least a half-time student during any academic period that began in the tax year |
B9IsGradStdnt | Boolean | When true, Identifies that recipient is a graduate student |
B10InsReimb | number | If you are an insurer, Provide total amount on reimbursements or refunds of qualified tuition and related expenses that you made to the recipient Size Range: 0-999999999.99 |
AccountNum | string | Account number of lender having multiple accounts for a recipient for whom more than one Form 1098-T 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
- Sample 1
- Sample 2
- Sample 3
- Sample 4
Create a Form 1098-T return with both Business and Recipient TIN as EIN
{
"SubmissionManifest": {
"TaxYear": "2024",
"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-3787160",
"Email": "james@sample.com",
"ContactNm": "James Smith",
"Phone": "6634567890",
"PhoneExtn": "12345",
"Fax": "6634567890",
"BusinessType": "ESTE",
"SigningAuthority": {
"Name": "James Smith",
"Phone": "9634567890",
"BusinessMemberType": "ADMINISTRATOR"
},
"KindOfEmployer": "FederalGovt",
"KindOfPayer": "REGULAR941",
"IsBusinessTerminated": true,
"IsForeign": false,
"USAddress": {
"Address1": "1805 AIRPORT WAY",
"Address2": "UNIT 9",
"City": "FAIRBANKS",
"State": "AK",
"ZipCd": "99709"
},
"ForeignAddress": null
}
},
"ReturnData": [
{
"SequenceId": "1",
"IsPostal": true,
"IsOnlineAccess": true,
"IsForced": true,
"Recipient": {
"RecipientId": null,
"TINType": "EIN",
"TIN": "36-3814566",
"FirstPayeeNm": "Dairy Delights LLC",
"SecondPayeeNm": "Coco Milk",
"FirstNm": null,
"MiddleNm": null,
"LastNm": null,
"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"
},
"Form1098TData": {
"IsSolicit": true,
"B1PymtRec": 2000,
"B4AdjPriorYr": 300,
"B5SchOrGrnts": 100.50,
"B6AdjSchOrGrnts": 20.60,
"B7IsPymtRecSub": false,
"B8IsHalfTmStdnt": false,
"B9IsGradStdnt": false,
"B10InsReimb": 0,
"AccountNum": "ABC001"
}
}
]
}
Create a Form 1098-T return with both Business and Recipient TIN as SSN
{
"SubmissionManifest": {
"TaxYear": "2024",
"IsFederalFiling": true,
"IsPostal": true,
"IsOnlineAccess": true,
"IsScheduleFiling": false,
"ScheduleFiling": null
},
"ReturnHeader": {
"Business": {
"BusinessId": null,
"BusinessNm": null,
"FirstNm": "James",
"MiddleNm": "Steven",
"LastNm": "Smith",
"Suffix": "Sr",
"PayerRef": "Snow123",
"TradeNm": "Iceberg Icecreams",
"IsEIN": false,
"EINorSSN": "713-78-7161",
"Email": "james@sample.com",
"ContactNm": "James Smith",
"Phone": "6634567890",
"PhoneExtn": "12345",
"Fax": "6634567890",
"BusinessType": "ESTE",
"SigningAuthority": {
"Name": "James Smith",
"Phone": "9634567890",
"BusinessMemberType": "ADMINISTRATOR"
},
"KindOfEmployer": "FederalGovt",
"KindOfPayer": "REGULAR941",
"IsBusinessTerminated": true,
"IsForeign": false,
"USAddress": {
"Address1": "1806 AIRPORT WAY",
"Address2": "UNIT 9",
"City": "FAIRBANKS",
"State": "AK",
"ZipCd": "99709"
},
"ForeignAddress": null
}
},
"ReturnData": [
{
"SequenceId": "1",
"IsPostal": true,
"IsOnlineAccess": true,
"IsForced": true,
"Recipient": {
"RecipientId": null,
"TINType": "SSN",
"TIN": "363-81-4567",
"FirstPayeeNm": null,
"SecondPayeeNm": null,
"FirstNm": "Shawn",
"MiddleNm": "Mathew",
"LastNm": "Willams",
"Suffix": "Sr",
"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"
},
"Form1098TData": {
"IsSolicit": true,
"B1PymtRec": 2000,
"B4AdjPriorYr": 300,
"B5SchOrGrnts": 100.50,
"B6AdjSchOrGrnts": 20.60,
"B7IsPymtRecSub": false,
"B8IsHalfTmStdnt": false,
"B9IsGradStdnt": false,
"B10InsReimb": 0,
"AccountNum": "ABC001"
}
},
{
"SequenceId": "2",
"IsPostal": true,
"IsOnlineAccess": true,
"IsForced": true,
"Recipient": {
"RecipientId": null,
"TINType": "EIN",
"TIN": "36-3814569",
"FirstPayeeNm": "Dairy Delights LLC",
"SecondPayeeNm": "Coco Milk",
"FirstNm": null,
"MiddleNm": null,
"LastNm": null,
"Suffix": null,
"IsForeign": true,
"USAddress": null,
"ForeignAddress": {
"Address1": "126 Bremner Blvd",
"Address2": "Suite 800",
"City": "Toronto",
"ProvinceOrStateNm": "Ontario",
"Country": "CA",
"PostalCd": "4168682600"
},
"Email": "shawn@sample.com",
"Fax": "6834567890",
"Phone": "7634567890"
},
"Form1098TData": {
"IsSolicit": true,
"B1PymtRec": 3000,
"B4AdjPriorYr": 300,
"B5SchOrGrnts": 100.50,
"B6AdjSchOrGrnts": 20.60,
"B7IsPymtRecSub": false,
"B8IsHalfTmStdnt": false,
"B9IsGradStdnt": false,
"B10InsReimb": 0,
"AccountNum": "ABC001"
}
}
]
}
Create a Form 1098-T return with IsForced (in ReturnData) set as ‘True’ so that a new return can be filed with a duplicate amount in BOX 1.
{
"SubmissionManifest": {
"TaxYear": "2024",
"IsFederalFiling": true,
"IsPostal": true,
"IsOnlineAccess": true,
"IsScheduleFiling": false,
"ScheduleFiling": null
},
"ReturnHeader": {
"Business": {
"BusinessId": null,
"BusinessNm": null,
"FirstNm": "James",
"MiddleNm": "Steven",
"LastNm": "Smith",
"Suffix": "Sr",
"PayerRef": "Snow123",
"TradeNm": "Iceberg Icecreams",
"IsEIN": false,
"EINorSSN": "713-78-7161",
"Email": "james@sample.com",
"ContactNm": "James Smith",
"Phone": "6634567890",
"PhoneExtn": "12345",
"Fax": "6634567890",
"BusinessType": "ESTE",
"SigningAuthority": {
"Name": "James Smith",
"Phone": "9634567890",
"BusinessMemberType": "ADMINISTRATOR"
},
"KindOfEmployer": "FederalGovt",
"KindOfPayer": "REGULAR941",
"IsBusinessTerminated": true,
"IsForeign": false,
"USAddress": {
"Address1": "1806 AIRPORT WAY",
"Address2": "UNIT 9",
"City": "FAIRBANKS",
"State": "AK",
"ZipCd": "99709"
},
"ForeignAddress": null
}
},
"ReturnData": [
{
"SequenceId": "1",
"IsPostal": true,
"IsOnlineAccess": true,
"IsForced": true,
"Recipient": {
"RecipientId": null,
"TINType": "SSN",
"TIN": "363-81-4567",
"FirstPayeeNm": null,
"SecondPayeeNm": null,
"FirstNm": "Shawn",
"MiddleNm": "Mathew",
"LastNm": "Willams",
"Suffix": "Sr",
"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"
},
"Form1098TData": {
"IsSolicit": true,
"B1PymtRec": 2000,
"B4AdjPriorYr": 300,
"B5SchOrGrnts": 100.50,
"B6AdjSchOrGrnts": 20.60,
"B7IsPymtRecSub": false,
"B8IsHalfTmStdnt": false,
"B9IsGradStdnt": false,
"B10InsReimb": 0,
"AccountNum": "ABC001"
}
},
{
"SequenceId": "2",
"IsPostal": true,
"IsOnlineAccess": true,
"IsForced": true,
"Recipient": {
"RecipientId": null,
"TINType": "EIN",
"TIN": "36-3814569",
"FirstPayeeNm": "Dairy Delights LLC",
"SecondPayeeNm": "Coco Milk",
"FirstNm": null,
"MiddleNm": null,
"LastNm": null,
"Suffix": null,
"IsForeign": true,
"USAddress": null,
"ForeignAddress": {
"Address1": "126 Bremner Blvd",
"Address2": "Suite 800",
"City": "Toronto",
"ProvinceOrStateNm": "Ontario",
"Country": "CA",
"PostalCd": "4168682600"
},
"Email": "shawn@sample.com",
"Fax": "6834567890",
"Phone": "7634567890"
},
"Form1098TData": {
"IsSolicit": true,
"B1PymtRec": 3000,
"B4AdjPriorYr": 300,
"B5SchOrGrnts": 100.50,
"B6AdjSchOrGrnts": 20.60,
"B7IsPymtRecSub": false,
"B8IsHalfTmStdnt": false,
"B9IsGradStdnt": false,
"B10InsReimb": 0,
"AccountNum": "ABC001"
}
}
]
}
Create a Form 1098T return with BusinessId and RecipientId
{
"SubmissionManifest": {
"SubmissionId": null,
"TaxYear": "2024",
"IsFederalFiling": true,
"IsPostal": true,
"IsOnlineAccess": true,
"IsScheduleFiling": false,
"ScheduleFiling": null
},
"ReturnHeader": {
"Business": {
"BusinessId": "ea19fd3d-0182-4460-9d96-16134b395313"
}
},
"ReturnData": [
{
"SequenceId": "1",
"RecordId": null,
"IsPostal": true,
"IsOnlineAccess": true,
"IsForced": true,
"Recipient": {
"RecipientId": "561266df-899a-45d5-a2e3-bbc868564614"
},
"Form1098TData": {
"IsSolicit": true,
"B1PymtRec": 2000,
"B4AdjPriorYr": 300,
"B5SchOrGrnts": 100.50,
"B6AdjSchOrGrnts": 20.60,
"B7IsPymtRecSub": false,
"B8IsHalfTmStdnt": false,
"B9IsGradStdnt": false,
"B10InsReimb": 0,
"AccountNum": "ABC001"
}
}
]
}
Response Body
Field | Type | Description |
---|---|---|
StatusCode | number | Returns the HTTP status codes like 200,300 etc. |
StatusName | string | Name of the status code |
StatusMessage | string | Detailed status message |
SubmissionId | Guid | Unique identifier of a submission |
BusinessId | Guid | Unique identifier of a Business. |
PayerRef | string | 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 |
Form1098Type | string | Denotes the type of 1098 form. |
Form1098TRecords | object | Pulls Form 1098-T records with Success and Error statuses |
SuccessRecords | object[] | It will show detailed information about the success status of Form 1098-T Records |
SequenceId | string | A 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. |
RecordId | Guid | A unique identifier generated by TaxBandits when a 1098-T return is created. |
RecipientId | Guid | A unique identifier generated by TaxBandits for a Recipient when a 1098-T return is created. You can use this id for your future reference to Update. |
AccountNum | string | Account number of Payer having multiple accounts for a recipient for whom more than one Form 1098-T 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. |
FederalReturn | object | Returns the record status and StatusTs of federal return. |
Status | string | Returns the record status. |
StatusTs | string | Returns date and time of return created. |
Info | string | Returns information about the Federal Filing service. |
Postal | object | Returns the status and StatusTs of postal mailing service for Form 1098. |
Status | string | Returns the status of postal order. |
StatusTs | string | Returns the date and time of the postal order created. |
Info | string | Returns the information about Postal mailing service. |
OnlineAccess | object | Returns the Email address for whom the online access to be given and Status of online access. |
Status | string | Returns status of online access for Form 1098-T return. |
string | Email address for whom the online access to be given. | |
Info | string | Information about the online access service. |
ScheduleFiling | object | Returns the date of the schedule filing. |
ScheduledOn | string | Date of the schedule filing to know when the return to be filed to the IRS. |
Info | string | Information about Schedule Filing service. |
ErrorRecords | object[] | It will show the detailed information about the error status of Form 1098-T Records. |
Errors | object[] | Shows detailed error information |
Response JSON
- 200
- 300
- 400
- 401
Success Response - This is a sample response for successful API requests.
{
"StatusCode": 200,
"StatusName": "Ok",
"StatusMessage": "Successful API call",
"SubmissionId": "24f2c987-c29d-477b-b310-5efba59e85f8",
"BusinessId": "ea19fd3d-0182-4460-9d96-16134b395313",
"PayerRef": "Snow123",
"Form1098Type": "1098T",
"Form1098TRecords": {
"SuccessRecords": [
{
"SequenceId": "1",
"RecordId": "ee964087-af7d-45ba-b254-fd2040206384",
"RecipientId": "e9647e56-55e6-48cb-8cd4-6c243a7848ad",
"AccountNum": "ABC001543",
"FederalReturn": {
"Status": "CREATED",
"StatusTs": "2024-06-27 03:34:09 -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 has foreign address"
},
"OnlineAccess": {
"Status": "CREATED",
"Email": "shawn@sample.com",
"Info": null
},
"ScheduleFiling": null
}
],
"ErrorRecords": null
},
"Errors": null
}
Multi-status Response - You'll get the below response when multiple statuses are included.
{
"StatusCode": 300,
"StatusName": "MultiStatus",
"StatusMessage": "Multiple statuses are available for the request",
"SubmissionId": "bbaf1ae1-3bbe-4aaf-8170-3953bb2a0c33",
"BusinessId": "ea19fd3d-0182-4460-9d96-16134b395313",
"PayerRef": "Snow123",
"Form1098Type": "1098T",
"Form1098TRecords": {
"SuccessRecords": [
{
"SequenceId": "1",
"RecordId": "3341f6d4-1244-419c-ab90-06b576dad13e",
"RecipientId": "561266df-899a-45d5-a2e3-bbc868564614",
"AccountNum": "ABC001268",
"FederalReturn": {
"Status": "CREATED",
"StatusTs": "2024-06-27 05:20:43 -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 has foreign address"
},
"OnlineAccess": {
"Status": "CREATED",
"Email": "shawn@sample.com",
"Info": null
},
"ScheduleFiling": null
}
],
"ErrorRecords": [
{
"SequenceId": "2",
"RecordId": null,
"Errors": [
{
"Id": "F34-100014",
"Name": "Form1098TData.B1PymtRec",
"Message": "Possible Duplicate. Another return has been created for the same recipient with the same amount."
}
]
}
]
},
"Errors": [
{
"Id": "F00-100155",
"Name": "Error Records",
"Message": "Some of the records are errored. Please read the Error Records for more details."
}
]
}
Bad Request Response - You'll get the below response when your API requests contain any validation errors.
{
"StatusCode": 400,
"StatusName": "BadRequest",
"StatusMessage": "Validation error has occurred",
"SubmissionId": null,
"BusinessId": "ea19fd3d-0182-4460-9d96-16134b395313",
"PayerRef": "Snow123",
"Form1098Type": "1098T",
"Form1098TRecords": {
"SuccessRecords": null,
"ErrorRecords": [
{
"SequenceId": "2",
"RecordId": null,
"Errors": [
{
"Id": "F34-100014",
"Name": "Form1098TData.B1PymtRec",
"Message": "Possible Duplicate. Another return has been created for the same recipient with the same amount."
}
]
}
]
},
"Errors": null
}
Unauthorized Response - You'll get the below response when your API requests don't contain valid authentication credentials.
{
"StatusCode": 401,
"StatusName": "Unauthorized",
"StatusMessage": "Invalid authorization credentials",
"Errors": [
{
"Id": "AUTH-100018",
"Name": "Authorization",
"Message": "JWT EXPIRED"
}
]
}