Create
POST Form5498SA/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 5498 SA to be filed.. Allowed values: "2023","2024" |
IsFederalFiling | Boolean | Federal Filing for the return will be enabled when the value is True. Form 5498 SA will be sent directly to the IRS. |
IsStateFiling | Boolean | State Filing for the return will be enabled when the value is True. Form 5498 SA will be directly filed with the respective recipient states. Note: State Filing will not be created for the states that do not require State filing. |
IsPostal | Boolean | If this value is set as true, the Postal Mailing service will be opted for all the recipients included in the submission. Once the returns are transmitted, the Form 5498 SA form copies will be mailed to the recipient's address via USPS. Note: Postal Orders for Foreign Address will not be created. |
IsOnlineAccess | Boolean | If this value is set as true, the Online Access service will be enabled for all the recipients included in the submission. 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 5498 SA copies from the portal. |
IsScheduleFiling | Boolean | When true, schedule filing services will be provided for Form 5498 SA returns under this submission. |
ScheduleFiling | object | Contains preferred date to submit the returns to IRS. It is required only when "IsScheduleFiling" is set as True. |
EfileDate | string | Date of Schedule Filing. Enter the date in the format: MM/DD/YYYY or MM-DD-YYYY Example: 10/20/2024 or 10-20-2024 |
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 response to the Business CREATE Endpoint. By giving the Business Id, you do not have to provide all the business information again. If you do not have a Business Id, ignore the field. |
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" |
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 |
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-11 |
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/5498 SA 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 Form 5498 SA.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 Form 5498 SA.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 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 5498 SA details. |
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. Size Range: 50 |
IsPostal | Boolean | If this value is set as true, the Postal Mailing service will be opted for the recipient included in the record. Once the return is transmitted, the Form 5498 SA copy will be mailed to the recipient's address via USPS. Postal Orders for Foreign Address will not be created. Note: To enable this, you must have set the IsPostal value as True under the submission. You can set this value as False for the other records for which you don’t want this service. |
IsOnlineAccess | Boolean | If this value is set as true, the Online Access service will be enabled for the recipient included in the record. Once the return is transmitted, an email with a link to the secure TaxBandits portal will be sent to the recipient. The recipient can then provide consent and download Form 5498 SA copy from the portal. Note: To enable this, you must have set the IsOnlineAccess value as True under the submission. You can set this value as False for the other records for which you don’t want this service. |
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-11 |
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, it identifies the recipient's 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: 15 |
Form5498SAData | object | Recipient's Form 5498SA information. |
B1MSAContrib | number | Form 5498SA Box1. Gets employee's or self-employed person's regular contributions to the Archer MSA made in tax year. Size Range: 0-9999999999.99 |
B2TotalContrib | number | Form 5498SA Box2. Gets the total HSA or Archer MSA contributions made in tax year. Size Range: 0-9999999999.99 |
B3TotalHSAorMSAIn2024 | number | Form 5498SA Box3. Gets the total HSA or Archer MSA contributions made in the following year for the specified tax year. Size Range: 0-9999999999.99 |
B4RolloverContrib | number | Form 5498SA Box4. Gets rollover contributions to the HSA or Archer MSA received during the tax year. Size Range: 0-9999999999.99 |
B5FMV | number | Form 5498SA Box5. Gets the FMV of the account as of December 31 for the specified tax year. Size Range: 0-9999999999.99 |
B6AccType | string | Form 5498SA Box6. Recipient's account type.Allowed values"HSA", "Archer_MSA", "MA_MSA" |
AccountNum | string | Gets account number of Payer having multiple accounts for a recipient for whom more than one Form 5498SA is filed. Size Range: 4..20 |
Request JSON
- Sample 1
- Sample 2
- Sample 3
Create a Form 5498SA return for the specific Business and include recipient and income information.
{
"SubmissionManifest": {
"SubmissionId": null,
"TaxYear": "2024",
"IsFederalFiling": true,
"IsStateFiling": 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": "RN123",
"TradeNm": "Iceberg Icecreams",
"IsEIN": true,
"EINorSSN": "62-2269245",
"Email": "chandler@sample.com",
"ContactNm": "Chandler White",
"Phone": "1234567890",
"PhoneExtn": "12345",
"Fax": "1234567890",
"BusinessType": "ESTE",
"SigningAuthority": {
"Name": "Chandler White",
"Phone": "1234567890",
"BusinessMemberType": "ADMINISTRATOR"
},
"KindOfEmployer": "FederalGovt",
"KindOfPayer": "REGULAR941",
"IsBusinessTerminated": true,
"IsForeign": false,
"USAddress": {
"Address1": "1751 Kinsey Rd",
"Address2": "Main St",
"City": "Dothan",
"State": "AL",
"ZipCd": "36303"
},
"ForeignAddress": {
"Address1": null,
"Address2": null,
"City": null,
"ProvinceOrStateNm": null,
"Country": null,
"PostalCd": null
}
}
},
"ReturnData": [
{
"SequenceId": "1",
"IsPostal": true,
"IsOnlineAccess": true,
"IsForced": false,
"Recipient": {
"RecipientId": null,
"TINType": "EIN",
"TIN": "563817572",
"FirstPayeeNm": "Stephen",
"SecondPayeeNm": "Davis",
"FirstNm": null,
"MiddleNm": null,
"LastNm": null,
"Suffix": null,
"IsForeign": false,
"USAddress": {
"Address1": "1751 Kinsey Rd",
"Address2": "Main St",
"City": "Dothan",
"State": "AL",
"ZipCd": "36303"
},
"ForeignAddress": {
"Address1": null,
"Address2": null,
"City": null,
"ProvinceOrStateNm": null,
"Country": null,
"PostalCd": null
},
"Email": "mark@sample.com",
"Fax": "1234567890",
"Phone": "1234567890"
},
"Form5498SAData": {
"B1MSAContrib": 7000,
"B2TotalContrib": 0,
"B3TotalHSAorMSAIn2024": 0,
"B4RolloverContrib": 0,
"B5FMV": 880,
"B6AccType": "HSA",
"AccountNum": "2023REC01"
}
}
]
}
Create a Form 5498SA return with multiple recipients/forms.
{
"SubmissionManifest": {
"SubmissionId": null,
"TaxYear": "2024",
"IsFederalFiling": true,
"IsStateFiling": true,
"IsPostal": true,
"IsOnlineAccess": true,
"IsScheduleFiling": false,
"ScheduleFiling": null
},
"ReturnHeader": {
"Business": {
"BusinessId": null,
"BusinessNm": null,
"PayerRef": "RN123",
"TradeNm": "Iceberg Icecreams",
"FirstNm": "Mark",
"MiddleNm": "Freek",
"LastNm": "Linda",
"Suffix": "Sr",
"IsEIN": false,
"EINorSSN": "62-2239245",
"Email": "chandler@sample.com",
"ContactNm": "Chandler White",
"Phone": "1234567890",
"PhoneExtn": "12345",
"Fax": "1234567890",
"BusinessType": "ESTE",
"SigningAuthority": {
"Name": "Chandler White",
"Phone": "1234567890",
"BusinessMemberType": "ADMINISTRATOR"
},
"KindOfEmployer": "FederalGovt",
"KindOfPayer": "REGULAR941",
"IsBusinessTerminated": true,
"IsForeign": false,
"USAddress": {
"Address1": "1751 Kinsey Rd",
"Address2": "Main St",
"City": "Dothan",
"State": "AL",
"ZipCd": "36303"
},
"ForeignAddress": {
"Address1": null,
"Address2": null,
"City": null,
"ProvinceOrStateNm": null,
"Country": null,
"PostalCd": null
}
}
},
"ReturnData": [
{
"SequenceId": "3",
"IsPostal": true,
"IsOnlineAccess": true,
"IsForced": true,
"Recipient": {
"RecipientId": null,
"TINType": "SSN",
"TIN": "563817572",
"FirstPayeeNm": null,
"SecondPayeeNm": null,
"FirstNm": "Mark",
"MiddleNm": "Freek",
"LastNm": "Linda",
"Suffix": "Sr",
"IsForeign": false,
"USAddress": {
"Address1": "1751 Kinsey Rd",
"Address2": "Main St",
"City": "Dothan",
"State": "AL",
"ZipCd": "36303"
},
"ForeignAddress": {
"Address1": null,
"Address2": null,
"City": null,
"ProvinceOrStateNm": null,
"Country": null,
"PostalCd": null
},
"Email": "mark+1@sample.com",
"Fax": "1234567890",
"Phone": "1234567890"
},
"Form5498SAData": {
"B1MSAContrib": 7000,
"B2TotalContrib": 0,
"B3TotalHSAorMSAIn2024": 0,
"B4RolloverContrib": 0,
"B5FMV": 880,
"B6AccType": "HSA",
"AccountNum": "2023REC01"
}
},
{
"SequenceId": "4",
"IsPostal": true,
"IsOnlineAccess": true,
"IsForced": true,
"Recipient": {
"RecipientId": null,
"TINType": "SSN",
"TIN": "56813372",
"FirstPayeeNm": "David",
"SecondPayeeNm": "Halon",
"FirstNm": "Mark",
"MiddleNm": "Freek",
"LastNm": "Linda",
"Suffix": "Sr",
"IsForeign": false,
"USAddress": {
"Address1": "1751 Kinsey Rd",
"Address2": "Main St",
"City": "Dothan",
"State": "AL",
"ZipCd": "36303"
},
"ForeignAddress": {
"Address1": null,
"Address2": null,
"City": null,
"ProvinceOrStateNm": null,
"Country": null,
"PostalCd": null
},
"Email": "mark@sample.com",
"Fax": "1234567890",
"Phone": "1234567890"
},
"Form5498SAData": {
"B1MSAContrib": 7000,
"B2TotalContrib": 0,
"B3TotalHSAorMSAIn2024": 0,
"B4RolloverContrib": 0,
"B5FMV": 880,
"B6AccType": "HSA",
"AccountNum": "2023REC01"
}
}
]
}
Create a Form 5498SA return with BusinessId and RecipientId.
{
"SubmissionManifest": {
"SubmissionId": null,
"TaxYear": "2024",
"IsFederalFiling": true,
"IsStateFiling": true,
"IsPostal": true,
"IsOnlineAccess": true,
"IsScheduleFiling": false,
"ScheduleFiling": null
},
"ReturnHeader": {
"Business": {
"BusinessId": "ba6b566f-a19a-40f0-99f2-6cba22325b9f"
}
},
"ReturnData": [
{
"SequenceId": "1",
"IsPostal": true,
"IsOnlineAccess": true,
"IsForced": true,
"Recipient": {
"RecipientId": "090dd6a8-c47a-4141-87aa-e0b77653f75f"
},
"Form5498SAData": {
"B1MSAContrib": 7000,
"B2TotalContrib": 0,
"B3TotalHSAorMSAIn2024": 0,
"B4RolloverContrib": 0,
"B5FMV": 880,
"B6AccType": "HSA",
"AccountNum": "2023REC01"
}
}
]
}
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. |
Form5498 SA Type | string | Denotes the type of 5498 SA. |
Form5498 SARecords | object | Pulls Form 5498 SA records with Success and Error statuses |
SuccessRecords | object[] | It will show detailed information about the success status of Form 5498 SA Records |
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. |
RecordId | Guid | An unique identifier generated by TaxBandits when a 5498 SA return is created. |
RecipientId | Guid | An unique identifier generated by TaxBandits for a Recipient when a 5498 SA return is created. You can use this id for your future reference to Update. |
AccountNum | string | Returns account number of Payer having multiple accounts for a recipient for whom more than one Form 5498SA is filed. Size Range: 4..20 |
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 detailed error information. |
Postal | object | Returns the status and StatusTs of postal mailing service for Form 5498 SA. |
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 5498 SA 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 5498 SA Records. |
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. |
RecordId | Guid | Unique identifier of a record |
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 |
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
- 200
- 300
- 400
- 401
Success Response - This is a sample response for successful API requests.
{
"StatusCode": 200,
"StatusName": "Ok",
"StatusMessage": "Successful API call",
"SubmissionId": "f808f471-053d-4777-b8f7-a52a8c4f49ea",
"BusinessId": "f87e6f65-b036-4cad-9c20-a03200d9a1c7",
"PayerRef": "RN123",
"Form5498Type": "5498SA",
"Form5498SARecords": {
"SuccessRecords": [
{
"SequenceId": "1",
"RecordId": "f474e884-8db6-4eaa-95ba-522bf5ae2c1f",
"RecipientId": "9b0beedf-c980-404b-9c33-1007f5ff943c",
"AccountNum": "2023REC01",
"FederalReturn": {
"Status": "CREATED",
"StatusTs": "2024-07-02 03:38:31 -04:00",
"Info": null,
"Errors": null
},
"Postal": {
"Status": "CREATED",
"StatusTs": "2024-07-02 03:39:23 -04:00",
"Info": null
},
"OnlineAccess": {
"Status": "CREATED",
"Email": "mark@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": "ea30033a-ff1e-41e9-a832-05099be14acb",
"BusinessId": "f87e6f65-b036-4cad-9c20-a03200d9a1c7",
"PayerRef": "RN123",
"Form5498Type": "5498SA",
"Form5498SARecords": {
"SuccessRecords": [
{
"SequenceId": "3",
"RecordId": "502d4b3e-4140-48aa-95f4-a067dc9409c1",
"RecipientId": "2332dc2f-a2c0-484e-8fc4-434ff753b5b8",
"AccountNum": "2023REC01",
"FederalReturn": {
"Status": "CREATED",
"StatusTs": "2024-07-02 03:34:19 -04:00",
"Info": null,
"Errors": null
},
"Postal": {
"Status": "CREATED",
"StatusTs": "2024-07-02 03:35:10 -04:00",
"Info": null
},
"OnlineAccess": {
"Status": "CREATED",
"Email": "mark+1@sample.com",
"Info": null
},
"ScheduleFiling": null
}
],
"ErrorRecords": [
{
"SequenceId": "4",
"RecordId": null,
"Errors": [
{
"Id": "RECPT-0008",
"Name": "Recipient.TIN[1]",
"Message": "TIN must have 9 digits."
}
]
}
]
},
"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": "f87e6f65-b036-4cad-9c20-a03200d9a1c7",
"PayerRef": "RN123",
"Form5498Type": "5498SA",
"Form5498SARecords": {
"SuccessRecords": null,
"ErrorRecords": [
{
"SequenceId": "1",
"RecordId": null,
"Errors": [
{
"Id": "F37-100007",
"Name": "Form5498SAData.B6AccType",
"Message": "Invalid AccType."
}
]
}
]
},
"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"
}
]
}