Version: 1.7.3

Update

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

PUT Form1098T/Update

Request Body

Field	Type	Description
SubmissionManifest	object	SubmissionManifest 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
SubmissionId	Guid	Unique identifier created by TaxBandits for each submission. Not required when you are creating a return.
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 then provide consent and download Form 1098-T 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 Individual Allowed 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
Email	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-T Allowed 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-T Allowed 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 Individual Allowed 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
Email	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

Create a Form 1098T return for the specific Business and include recipient and income information and update the Recipient / Form Details with RecipientId and RecordId

{
  "SubmissionManifest": {
    "SubmissionId": "4ae9ba52-7811-4fb0-b3d6-fe9f07f0a533",
    "TaxYear": "2024",
    "IsFederalFiling": true,
    "IsPostal": true,
    "IsOnlineAccess": true,
    "IsScheduleFiling": false,
    "ScheduleFiling": null
  },
  "ReturnHeader": {
    "Business": {
      "BusinessId": "ea19fd3d-0182-4460-9d96-16134b395313",
      "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": "1806 AIRPORT WAY",
        "Address2": "UNIT 9",
        "City": "FAIRBANKS",
        "State": "AK",
        "ZipCd": "99709"
      },
      "ForeignAddress": null
    }
  },
  "ReturnData": [
    {
      "SequenceId": "1",
      "RecordId": "b673d260-52b1-45e2-bb0e-dd6b058d2708",
      "IsPostal": true,
      "IsOnlineAccess": true,
      "IsForced": true,
      "Recipient": {
        "RecipientId": "e9647e56-55e6-48cb-8cd4-6c243a7848ad",
        "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 1098T return for the specific Business and include recipient and income information and create the new Recipient / Form Details without RecipientId and RecordId

{
  "SubmissionManifest": {
    "SubmissionId": "4ae9ba52-7811-4fb0-b3d6-fe9f07f0a533",
    "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": "123",
      "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",
      "RecordId": null,
      "IsPostal": true,
      "IsOnlineAccess": true,
      "IsForced": true,
      "Recipient": {
        "RecipientId": null,
        "TINType": "EIN",
        "TIN": "36-3814696",
        "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"
      }
    }
  ]
}

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	Unique identifier of the Payer.
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 the 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.
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.
Errors	object[]	Shows error information in state returns of Form 1098.
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.
Email	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
Id	string	Returns the validation error Id
Name	string	Name of the validation error
Message	string	Description 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": "4ae9ba52-7811-4fb0-b3d6-fe9f07f0a533",
    "BusinessId": "ea19fd3d-0182-4460-9d96-16134b395313",
    "PayerRef": "Snow123",
    "Form1098Type": "T",
    "Form1098TRecords": {
        "SuccessRecords": [
            {
                "SequenceId": "1",
                "RecordId": "b673d260-52b1-45e2-bb0e-dd6b058d2708",
                "RecipientId": "e9647e56-55e6-48cb-8cd4-6c243a7848ad",
                "AccountNum": "ABC001886",
                "FederalReturn": {
                    "Status": "CREATED",
                    "StatusTs": "2024-06-27 05:25:04 -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
}

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": "4ae9ba52-7811-4fb0-b3d6-fe9f07f0a533",
    "BusinessId": "ea19fd3d-0182-4460-9d96-16134b395313",
    "PayerRef": "Snow123",
    "Form1098Type": "T",
    "Form1098TRecords": {
        "SuccessRecords": [
            {
                "SequenceId": "1",
                "RecordId": "b673d260-52b1-45e2-bb0e-dd6b058d2708",
                "RecipientId": "e9647e56-55e6-48cb-8cd4-6c243a7848ad",
                "AccountNum": "ABC001912",
                "FederalReturn": {
                    "Status": "CREATED",
                    "StatusTs": "2024-06-27 05:32:19 -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": [
            {
                "SequenceId": "2",
                "RecordId": null,
                "Errors": [
                    {
                        "Id": "RECPT-0013",
                        "Name": "Recipient.FirstPayeeNm[1]",
                        "Message": "First Payee Name is required."
                    }
                ]
            }
        ]
    },
    "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": "4ae9ba52-7811-4fb0-b3d6-fe9f07f0a533",
    "BusinessId": "ea19fd3d-0182-4460-9d96-16134b395313",
    "PayerRef": "Snow123456",
    "Form1098Type": "T",
    "Form1098TRecords": {
        "SuccessRecords": null,
        "ErrorRecords": [
            {
                "SequenceId": "1",
                "RecordId": null,
                "Errors": [
                    {
                        "Id": "RECPT-0013",
                        "Name": "Recipient.FirstPayeeNm[0]",
                        "Message": "First Payee Name is required."
                    },
                    {
                        "Id": "RECPT-0051",
                        "Name": "Recipient.ForeignAddress.Address1[0]",
                        "Message": "Recipient Address1 is required"
                    }
                ]
            }
        ]
    },
    "Errors": null
}

W-9 Automation

BOIR Automation

TIN Matching

1099 Automation

941/940 Automation

W-2 Automation

ACA Automation

Supported Forms

Gig Software

Payroll Software

Affiliate Software

HOA Software

Reselling Platform

HCM Providers

Property Management

Supported Forms

Request Body

Request JSON

Response Body

Response JSON