Version: 1.7.3

Update

PUT Form5498SA/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 IsStateFiling IsOnlineAccess IsScheduleFiling & ScheduleFiling service details
SubmissionId	string	Unique identifier created by TaxBandits for each submission. Not required when you are creating a return.
TaxYear	string	Tax year of Form 5498 SA to be filed.. Allowed values: "2023"
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/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 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
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
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/5498 SA and mandatory for 94X series Size Range: 4 Allowed values "ESTE", "PART", "CORP", "EORG", "SPRO" For the description of the Allowed Values , click here
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: ..35
Address2	string	Optional Employer/Payer's suite or apartment Size Range: ..35
City	string	Employer/Payer's city Size Range: ..27
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: ..35
Address2	string	Optional Employer/Payer's suite or apartment Size Range: ..35
City	string	Employer/Payer's city Size Range: ..27
ProvinceOrStateNm	string	Employer/Payer's province or state name Size Range: ..30
Country	string	Employer/Payer's country Size Range: 2 Allowed values "CA", "MX", "AF", "AX", "XI", "AL", "AG", "AQ", "AN", "AO", "AV", "AY", "AC", "AR", "AM", "AA", "XA", "AT", "AS", "AU", "AJ", "XZ", "BF", "BA", "FQ", "BG", "BB", "BS", "BO", "BE", "BH", "BN", "BD", "BT", "BL", "BK", "BC", "BV", "BR", "IO", "VI", "BX", "BU", "UV", "BM", "BY", "CB", "CM", "XY", "CV", "CJ", "CT", "CD", "XC", "CI", "CH", "KT", "IP", "CK", "CO", "CN", "CF", "CG", "CW", "CR", "VP", "CS", "IV", "HR", "CU", "CY", "EZ", "DA", "DX", "DJ", "DO", "DR", "TT", "EC", "EG", "ES", "UK", "EK", "ER", "EN", "ET", "EU", "FK", "FO", "FM", "FJ", "FI", "FR", "FG", "FP", "FS", "GB", "GA", "GZ", "GG", "GM", "GH", "GI", "GO", "GR", "GL", "GJ", "GP", "GQ", "GT", "GK", "GV", "PU", "GY", "HA", "HM", "HO", "HK", "HQ", "HU", "IC", "IN", "ID", "IR", "IZ", "EI", "IS", "IT", "JM", "JN", "JA", "DQ", "JE", "JQ", "JO", "JU", "KZ", "KE", "KQ", "KR", "KN", "KS", "KU", "KG", "LA", "LG", "LE", "LT", "LI", "LY", "LS", "LH", "LU", "MC", "MK", "MA", "MI", "MY", "MV", "ML", "MT", "IM", "RM", "MB", "MR", "MP", "MF", "MQ", "MD", "MN", "MG", "MJ", "MH", "MO", "MZ", "XM", "WA", "NR", "BQ", "NP", "NL", "NT", "NC", "NZ", "NU", "NG", "NI", "NE", "NF", "XN", "CQ", "NO", "MU", "OC", "PK", "LQ", "PS", "PM", "PP", "PF", "PA", "PE", "RP", "PC", "PL", "PO", "RQ", "QA", "RE", "RO", "RS", "RW", "WS", "SM", "TP", "SA", "XS", "SG", "RI", "SE", "SL", "SN", "XR", "LO", "SI", "BP", "SO", "SF", "SX", "SP", "PG", "CE", "SH", "SC", "ST", "SB", "VC", "SU", "NS", "SV", "WZ", "SW", "SZ", "SY", "TW", "TI", "TZ", "TH", "TO", "TL", "TN", "TD", "XT", "TE", "TS", "TU", "TX", "TK", "TV", "UG", "UP", "AE", "UY", "UZ", "NH", "VT", "VE", "VM", "VQ", "WQ", "XW", "WF", "WE", "WI", "YM", "YI", "ZA", "ZI"
PostalCd	string	Employer/Payer's postal code.
ReturnData	object[]	Contains information about the recipient details and Form 5498 SA details.
RecordId	string	Unique Identifier of the Record. Mention the Form 5498 SA return's Record ID that you want to update. If you do not provide the Record ID, then a new record will be added to the submission.
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
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. 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
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: ..35
Address2	string	Optional Recipient's suite or apartment Size Range: ..35
City	string	Recipient's city Size Range: ..27
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: ..35
Address2	string	Optional Recipient's suite or apartment Size Range: ..35
City	string	Recipient's city. Size Range: ..27
ProvinceOrStateNm	string	Recipient's Province or State Name. Size Range: ..30
Country	string	Recipient's country code. Refer Static values. Size Range: 2 Allowed values "CA", "MX", "AF", "AX", "XI", "AL", "AG", "AQ", "AN", "AO", "AV", "AY", "AC", "AR", "AM", "AA", "XA", "AT", "AS", "AU", "AJ", "XZ", "BF", "BA", "FQ", "BG", "BB", "BS", "BO", "BE", "BH", "BN", "BD", "BT", "BL", "BK", "BC", "BV", "BR", "IO", "VI", "BX", "BU", "UV", "BM", "BY", "CB", "CM", "XY", "CV", "CJ", "CT", "CD", "XC", "CI", "CH", "KT", "IP", "CK", "CO", "CN", "CF", "CG", "CW", "CR", "VP", "CS", "IV", "HR", "CU", "CY", "EZ", "DA", "DX", "DJ", "DO", "DR", "TT", "EC", "EG", "ES", "UK", "EK", "ER", "EN", "ET", "EU", "FK", "FO", "FM", "FJ", "FI", "FR", "FG", "FP", "FS", "GB", "GA", "GZ", "GG", "GM", "GH", "GI", "GO", "GR", "GL", "GJ", "GP", "GQ", "GT", "GK", "GV", "PU", "GY", "HA", "HM", "HO", "HK", "HQ", "HU", "IC", "IN", "ID", "IR", "IZ", "EI", "IS", "IT", "JM", "JN", "JA", "DQ", "JE", "JQ", "JO", "JU", "KZ", "KE", "KQ", "KR", "KN", "KS", "KU", "KG", "LA", "LG", "LE", "LT", "LI", "LY", "LS", "LH", "LU", "MC", "MK", "MA", "MI", "MY", "MV", "ML", "MT", "IM", "RM", "MB", "MR", "MP", "MF", "MQ", "MD", "MN", "MG", "MJ", "MH", "MO", "MZ", "XM", "WA", "NR", "BQ", "NP", "NL", "NT", "NC", "NZ", "NU", "NG", "NI", "NE", "NF", "XN", "CQ", "NO", "MU", "OC", "PK", "LQ", "PS", "PM", "PP", "PF", "PA", "PE", "RP", "PC", "PL", "PO", "RQ", "QA", "RE", "RO", "RS", "RW", "WS", "SM", "TP", "SA", "XS", "SG", "RI", "SE", "SL", "SN", "XR", "LO", "SI", "BP", "SO", "SF", "SX", "SP", "PG", "CE", "SH", "SC", "ST", "SB", "VC", "SU", "NS", "SV", "WZ", "SW", "SZ", "SY", "TW", "TI", "TZ", "TH", "TO", "TL", "TN", "TD", "XT", "TE", "TS", "TU", "TX", "TK", "TV", "UG", "UP", "AE", "UY", "UZ", "NH", "VT", "VE", "VM", "VQ", "WQ", "XW", "WF", "WE", "WI", "YM", "YI", "ZA", "ZI"
PostalCd	string	Recipient's Postal Code.
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: 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 2023 and through April 15, 2024, for 2023. Size Range: 0-9999999999.99
B2TotalContrib	number	Form 5498SA Box2. Gets the total HSA or Archer MSA contributions made in 2023. Size Range: 0-9999999999.99
B3TotalHSAorMSAIn2024	number	Form 5498SA Box3. Gets the total HSA or Archer MSA contributions made in 2024 for 2023. Size Range: 0-9999999999.99
B4RolloverContrib	number	Form 5498SA Box4. Gets rollover contributions to the HSA or Archer MSA received by you during 2023. Size Range: 0-9999999999.99
B5FMV	number	Form 5498SA Box5. Gets the FMV of the account on December 31, 2023. 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

{
  "SubmissionManifest": {
    "SubmissionId": "e88e7f1d-7ae5-43b6-99f6-38d85664035a",
    "TaxYear": "2023",
    "IsFederalFiling": true,
    "IsStateFiling": true,
    "IsPostal": true,
    "IsOnlineAccess": true,
    "IsScheduleFiling": true,
    "ScheduleFiling": {
      "EfileDate": "11/12/2023"
    }
  },
  "ReturnHeader": {
    "Business": {
      "BusinessId": "c21df64f-9a6d-4e21-ac67-723aacf1ba48",
      "BusinessNm": "Snowdaze LLC",
      "PayerRef": "Pe123",
      "TradeNm": "Kodak",
      "IsEIN": true,
      "EINorSSN": "62-7369245",
      "Email": "sample@bodeem.com",
      "ContactNm": "John",
      "Phone": "1234567890",
      "PhoneExtn": "12345",
      "Fax": "1234567890",
      "BusinessType": "ESTE",
      "SigningAuthority": {
        "Name": "John",
        "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": [
    {
      "RecordId": "63f0aaf2-7b35-487d-a003-0be8b522ef47",
      "SequenceId": "1",
      "IsPostal": true,
      "IsOnlineAccess": true,
      "Recipient": {
        "RecipientId": "775acc48-7492-487b-8edc-6c4d9877136f",
        "TINType": "EIN",
        "TIN": "393817572",
        "FirstPayeeNm": "Mark",
        "SecondPayeeNm": "Davis",
        "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": "sample@bodeem.com",
        "Fax": "1234567890",
        "Phone": "1234567890"
      },
            "Form5498SAData": {
                "B1MSAContrib": 2586.78,
                "B2TotalContrib": 5532.62,
                "B3TotalHSAorMSAIn2024": 1256.23,
                "B4RolloverContrib": 425.63,
                "B5FMV": 880.63,
                "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.
Form5498SAType	string	Denotes the type of 5498 SA form.
Form5498SARecords	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	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	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 information about the Federal Filing 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.
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 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

{
    "StatusCode": 200,
    "StatusName": "Ok",
    "StatusMessage": "Successful API call",
    "SubmissionId": "02cb3594-5bc9-4e61-8d2b-1a8117139915",
    "BusinessId": "e922521d-33d9-4f17-96d5-21e8c3e0d1ce",
    "PayerRef": "Pe123",
    "Form5498Type": "5498SA",
    "Form5498SARecords": {
        "SuccessRecords": [
            {
                "SequenceId": "1",
                "RecordId": "42cdc7bd-c5e8-47ed-88d8-a3e810df84e3",
                "RecipientId": "a5d4f4f5-e1e3-4462-911a-cfe7546e5d84",
                "AccountNum": "2023REC01",
                "FederalReturn": {
                    "Status": "CREATED",
                    "StatusTs": "2023-10-30 05:49:31 -04:00",
                    "Info": null,
                    "Errors": null
                },
                "Postal": {
                    "Status": "CREATED",
                    "StatusTs": "2023-10-30 05:50:29 -04:00",
                    "Info": null
                },
                "OnlineAccess": {
                    "Status": "CREATED",
                    "Email": "sample@bodeem.com",
                    "Info": null
                },
                "ScheduleFiling": null
            }
        ],
        "ErrorRecords": null
    },
    "Errors": null
}

W-9 Automation

1099 Automation

TIN Matching

ACA Automation

94x Automation

W-2 Automation

Gig Software

Payroll Software

Affiliate Software

HOA Software

Reselling Platform

HCM Providers

Request Body

Request JSON

Response Body

Response JSON