Skip to main content
Version: 1.7.3

Update

PUT Form1099SA/Update
Run in Postman

Request Body

FieldTypeDescription
SubmissionManifestobjectSubmissionManifest provides the 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.
    SubmissionIdstringUnique identifier created by TaxBandits for each submission. Not required when you are creating a return.
    TaxYearstringTax year of Form 1099SA to be filed.
Allowed values: "2023"
    IsFederalFilingBooleanFederal Filing for the return will be enabled when the value is True. Form 1099SA will be sent directly to the IRS.
    IsStateFilingBooleanState Filing for the return will be enabled when the value is True. Form 1099SA will be directly filed with the respective recipient states.
Note: State filing support for Form 1099-SA will not be offered .
    IsPostalBooleanIf 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 1099SA form copies will be mailed to the recipient's address via USPS.

Note: Postal Orders for Foreign Address will not be created.
    IsOnlineAccessBooleanIf 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 1099SA copies from the portal.
    IsScheduleFilingBooleanWhen true, schedule filing services will be provided for Form 1099SA returns under this submission.
    ScheduleFilingobjectContains preferred date to submit the returns to IRS. It is required only when "IsScheduleFiling" is set as True.
        EfileDatestringDate of Schedule Filing. Enter the date in the format: MM/DD/YYYY or MM-DD-YYYY Example: 10/20/2023 or 10-20-2023
ReturnHeaderobjectContains information about the Business details.
    BusinessobjectObject to identify the Business Details.
        BusinessIdGuidOptional Use the unique Business Id (Generated by TaxBandits) you received in 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.
        BusinessNmstringName of the business.
Size Range: ..75
        PayerRefstringOptional An unique identifier for each payer completing their information. This identifier can be used in future references of the payer in the API.
Size Range: ..50
        TradeNmstringOptional Name under which the business operates.
Size Range: ..75
        IsEINBooleanWhen true, identifies the business with an EIN.
        EINorSSNstringWhen IsEIN is true, use Employer Identification Number (EIN). When IsEIN is false, use Social Security Number (SSN).
Size Range: 9-11
        EmailstringOptional Email address of the Business.
Size Range: ..100
        ContactNmstringOptional Name of the person who can be contacted by the IRS.
Size Range: ..27
        PhonestringOptional Phone number of the business.
Size Range: 10
        PhoneExtnstringOptional Extension of the business phone number.
Size Range: ..5
        FaxstringOptional Fax number of the Business.
Size Range: 10
        BusinessTypestringOptional Type of business. Optional for W-2/1099SA and mandatory for 94X series
Size Range: 4
Allowed values

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

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

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

        KindOfEmployerstringOptional Identifies the kind of employer. Mandatory for W-2 and optional for Form 1099SA.
Allowed values

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

        KindOfPayerstringOptional Identifies the kind of payer. This field is mandatory in W-2 and optional in Form 1099SA.
Allowed values

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

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

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

            ZipCdstringEmployer/Payer's zip code
Size Range: 5..10
        ForeignAddressobjectIf IsForeign is true, pass foreign address of the business.
            Address1stringEmployer/Payer's foreign address (street address or post office box of that locality)
Size Range: ..35
            Address2stringOptional Employer/Payer's suite or apartment.
Size Range: ..35
            CitystringEmployer/Payer's city.
Size Range: ..27
            ProvinceOrStateNmstringEmployer/Payer's province or state name.
Size Range: ..30
            CountrystringEmployer/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"

            PostalCdstringEmployer/Payer's postal code.
ReturnDataobject[]Contains information about the recipient details and Form 1099 SA details.
    SequenceIdstringAn unique reference ID for the submission that can be used to identify a particular record. The Sequence ID will be returned in the Response for your reference.
Size Range: 50
    IsPostalBooleanIf 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 1099 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.
    IsOnlineAccessBooleanIf 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 1099 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.
    RecipientobjectObject to identify the recipient details.
        RecipientIdGuidOptional An unique ID generated by TaxBandits after the return is created and will be returned in the Response. You can use this id for your future reference to update.
        TINTypestringSpecify the TIN type of the recipient.
Allowed values

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

        TINstringEnter the nine-digit taxpayer identification number of the Recipient. (SSN, ITIN, ATIN, or EIN).
Size Range: 9-11
        FirstPayeeNmstringEnter the name of the recipient (preferably last name first for an Individual). If more space is required for the name, use the Second Payee Name Field.
Size Range: 40
        SecondPayeeNmstringOptional If there are multiple recipients (for example, partners, joint owners, or spouses), use this field for those names not associated with the TIN or if not enough space was provided in the First Payee Name, continue the name in this field.
Size Range: 40
        IsForeignBooleanWhen true, it identifies the recipient's address with a foreign address.
        USAddressobjectIf IsForeign is false, pass US address of the recipient
            Address1stringRecipient's US address (street address or post office box of that locality)
Size Range: ..35
            Address2stringOptional Recipient's suite or apartment
Size Range: ..35
            CitystringRecipient's city
Size Range: ..27
            StatestringRecipient's state code. Refer Static values.
Size Range: 2
Allowed values

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

            ZipCdstringRecipient's zip code
Size Range: 5..10
        ForeignAddressobjectIf IsForeign is true, pass foreign address of the recipient
            Address1stringRecipient's foreign address (street address or post office box of that locality)
Size Range: ..35
            Address2stringOptional Recipient's suite or apartment
Size Range: ..35
            CitystringRecipient's city.
Size Range: ..27
            ProvinceOrStateNmstringRecipient's Province or State Name.
Size Range: ..30
            CountrystringRecipient'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"

            PostalCdstringRecipient's Postal Code.
        EmailstringOptional Recipient's email address.
Size Range: 0..100
Note : This email address cannot be the same for two different recipients under the same business.
        FaxstringOptional Recipient's Fax number.
Size Range: 10
        PhonestringOptional Recipient's Phone Number.
Size Range: 15
    SAFormDataobjectRecipient's Form 1099SA information.
        B1GrossDistributionnumberGets the recipient's total amount of the distribution.This amount may have been a direct payment to the medical service provider or distributed to the recipient.
Size Range: 0-9999999999.99
        B2EarningsOnExcessContnumberGets the earnings on any excess contributions that recipients withdrew from an HSA or Archer MSA by the due date of your income tax return.
Size Range: 0-9999999999.99
        B3DistributionCodenumberGets the type of distribution.
Allowed values

"NORMAL_DIST", "EXCESS_CONTRIB", "DISABILITY","DEATH_DIST","PROHIBITED_TXN","DEATH_DIST_NONSPOUSE"

        B4FMVOnDateOfDeathnumberGets the FMV of the recipient's account on the date of death.
Size Range: 0-9999999999.99
        B5AccTypestringRecipient's account type.
Allowed values

"HSA", "Archer_MSA", "MA_MSA"

        AccountNumstringGets account number of Payer having multiple accounts for a recipient for whom more than one Form 1099SA is filed.
Size Range: 4..20

Request JSON

{
"SubmissionManiFest": {
"SubmissionId": "f2de97de-c8de-45d5-bc60-9728b4a35abe",
"TaxYear": "2023",
"IsFederalFiling": true,
"IsPostal": true,
"IsOnlineAccess": true,
"IsStateFiling": true,
"IsScheduleFiling": true,
"ScheduleFiling": {
"EfileDate": "12/26/2024"
}
},
"ReturnHeader": {
"Business": {
"BusinessId": "04485bd3-713a-4dac-b460-4e9b3fd65473",
"BusinessNm": "ABC 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": "f7b408fb-6e2a-443e-9214-ee0101f00ed6",
"SequenceId": "001",
"IsPostal": true,
"IsOnlineAccess": true,
"Recipient": {
"RecipientId": "9dccfc65-e8ec-47e7-a220-3660df1959b7",
"TINType": "EIN",
"TIN": "245614512",
"FirstPayeeNm": "Alex",
"SecondPayeeNm": "Davis",
"IsForeign": false,
"USAddress": {
"Address1": "1751 Kinsey Rd",
"Address2": "Main St",
"City": "Dothan",
"State": "AL",
"ZipCd": "36303"
},
"ForeignAddress": {
"Address1": "22 St",
"Address2": "Clair Ave E",
"City": "Toronto",
"ProvinceOrStateNm": "Ontario",
"Country": "CA",
"PostalCd": "M1R 0E9"
},
"Email": "sample12@bodeem.com",
"Fax": "1234567890",
"Phone": "1234567890"
},
"SAFormData": {
"B1GrossDistribution": 9032789320.98,
"B2EarningsOnExcessCont": 5320472309.32,
"B3DistributionCode": "EXCESS_CONTRIB",
"B4FMVOnDateOfDeath": 3867423946.39,
"B5AccType": "MA_MSA",
"AccountNum": "32964"
}
}
]
}

Response Body

FieldTypeDescription
StatusCodenumberReturns the HTTP status codes like 200,300 etc.
StatusNamestringName of the status code
StatusMessagestringDetailed status message
SubmissionIdGuidUnique identifier of a submission
BusinessIdGuidUnique identifier of a Business.
PayerRefstringUnique identifier of the payer.
Form1099SATypestringDenotes the type of 1099SA form.
Form1099SARecordsobjectPulls Form 1099SA records with Success and Error statuses
    SuccessRecordsobject[]It will show detailed information about the success status of Form 1099 SA Records
        SequenceIdstringA 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.
        RecordIdGuidAn unique identifier generated by TaxBandits when a 1099SA return is created.
        RecipientIdGuidAn unique identifier generated by TaxBandits for a Recipient when a 1099SA return is created. You can use this id for your future reference to Update.
        AccountNumstringReturns account number of Payer having multiple accounts for a recipient for whom more than one Form 1099SA is filed.
Size Range: 4..20
        FederalReturnobjectReturns the record status and StatusTs of federal return.
            StatusstringReturns the record status.
            StatusTsstringReturns date and time of return created.
            InfostringReturns information about the Federal Filing service.
            Errorsobject[]Shows detailed error information
        PostalobjectReturns the status and StatusTs of postal mailing service for Form 1099 SA.
            StatusstringReturns the status of postal order.
            StatusTsstringReturns the date and time of the postal order created.
            InfostringReturns information about the Federal Filing service.
        OnlineAccessobjectReturns the Email address for whom the online access to be given and Status of online access.
            StatusstringReturns status of online access for Form 1099 SA return.
            EmailstringEmail address for whom the online access to be given.
            InfostringInformation about the online access service.
        ScheduleFilingobjectReturns the date of the schedule filing.
            ScheduledOnstringDate of the schedule filing to know when the return to be filed to the IRS.
            InfostringInformation about Schedule Filing service.
    ErrorRecordsobject[]It will show the detailed information about the error status of Form 1099 SA Records.
        SequenceIdstringAn unique reference ID for the submission that can be used to identify a particular record. The Sequence ID will be returned in the Response for your reference.
        RecordIdGuidUnique identifier of a record
        Errorsobject[]Shows detailed error information
            IdstringReturns the validation error Id
            NamestringName of the validation error
            MessagestringDescription of the validation error
Errorsobject[]Shows detailed error information
    IdstringReturns the validation error Id
    NamestringName of the validation error
    MessagestringDescription of the validation error

Response JSON

{
"StatusCode": 200,
"StatusName": "Ok",
"StatusMessage": "Successful API call",
"SubmissionId": "f2de97de-c8de-45d5-bc60-9728b4a35abe",
"BusinessId": "04485bd3-713a-4dac-b460-4e9b3fd65473",
"PayerRef": "PAY123",
"Form1099Type": "SA",
"Form1099Records": {
"SuccessRecords": [
{
"SequenceId": "001",
"RecordId": "f7b408fb-6e2a-443e-9214-ee0101f00ed6",
"RecipientId": "2eb001c6-161c-4428-b795-c8b75b7efeea",
"AccountNum": "32964",
"FederalReturn": {
"Status": "CREATED",
"StatusTs": "2024-01-11 00:15:57 -05:00",
"Info": null,
"Errors": null
},
"Postal": {
"Status": "CREATED",
"StatusTs": "2024-01-11 00:15:58 -05:00",
"Info": null
},
"OnlineAccess": {
"Status": "CREATED",
"Email": "sample12@bodeem.com",
"Info": null
},
"ScheduleFiling": {
"ScheduledOn": null,
"Info": "This Service will be available soon"
}
}
],
"ErrorRecords": null
},
"Errors": null
}