TaxBandits API

# Form1099DIV

# Create

Creates Form 1099-DIV returns in TaxBandits. You can send multiple 1099-DIV forms in a single request for the same Payer. In response, a SubmissionId is created which is further used as a reference for all other methods of Form 1099 DIV API.

POST Form1099DIV/Create
1

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 Guid Unique identifier created by TaxBandits for each submission. Not required when you are creating a return.
    TaxYear string Tax year of Form 1099 DIV to be filed..
Allowed values: "2021"
    IsFederalFiling Boolean Federal Filing for the return will be enabled when the value is True. Form 1099-DIV will be sent directly to the IRS.
    IsStateFiling Boolean State Filing for the return will be enabled when the value is True. Form 1099-DIV 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 Postal Order will be created when the value is set as True. Once the return is Transmitted, Form 1099-DIV Recipient copies will be postal mailed to the recipient's address via USPS. Note: Postal Order for Foreign address will not be created.
    IsOnlineAccess Boolean Online Access will be enabled when the value is set as True. Once the return is Transmitted, an email with the link to the secure TaxBandits portal will be sent to the Recipient. The recipient can provide consent and download Form 1099-DIV Recipient copies from the portal.
    IsScheduleFiling Boolean When true, schedule filing services will be provided for Form 1099 DIV 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/2021 or 10-20-2021
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: ..80
        TradeNm string Optional Name under which the business operates
Size Range: ..80
        IsEIN Boolean When true, identify that the business TIN is 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 Email address of the Business
Size Range: ..40
        ContactNm string Optional Name of the person who can be contacted by the IRS.
Size Range: ..27
        Phone string 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/1099 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 1099-DIV and 94X series
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 1099-DIV and 94X series
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: 9
        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: "US", "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
Size Range: 9
ReturnData object[] Contains information about the recipient details and Form 1099 DIV 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
    RecordId Guid Unique identifier of a record. Not required when you are creating a return.
    Recipient object Object to identify the recipient details.
        RecipientId Guid TaxBandits generates a unique ID for each recipient after the return is created and 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
        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: 9
        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: "US", "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
Size Range: 9
        Email string Recipient's email address.
Size Range: 0..40
        Fax string Optional Recipient's Fax number.
Size Range: 10
        Phone string Recipient's Phone Number.
Size Range: 15
    DIVFormData object Object to create 1099-DIV.
        B1aTotOrdiDiv number Gets dividends, including dividends from money market funds, net short-term capital gains from mutual funds, and other distributions on stock.
Size Range: 0-9999999999.99
        B1bQualiDiv number Gets the portion of the dividends in box 1a that qualifies for the reduced capital gains rates.
Size Range: 0-9999999999.99
        B2aTotCapGain number Get total capital gain distributions (long-term). Include all amounts shown in boxes 2b, 2c, 2d, and 2f.
Size Range: 0-9999999999.99
        B2bUnRecapSec1250Gain number Get any amount included in box 2a that is an unrecaptured section 1250 gain from certain depreciable real property.
Size Range: 0-9999999999.99
        B2cSec1202Gain number Get any amount included in box 2a that is a section 1202 gain from certain qualified small business stock.
Size Range: 0-9999999999.99
        B2dCollGain number Get any amount included in box 2a that is a 28% rate gain from sales or exchanges of collectibles.
Size Range: 0-9999999999.99
        B2eSec897OrdiDiv number Get any amount included in box 1a that is section 897 gain from dispositions of USRPI.
Size Range: 0-9999999999.99
        B2fSec897CapGain number Get any amount included in box 2a that is section 897 gain from dispositions of USRPI.
Size Range: 0-9999999999.99
        B3NonDivDistri number Get nondividend distributions, if determinable.
Size Range: 0-9999999999.99
        B4FedIncTaxWH number Get the backup withholding, for the payments reported in box1, box 2 and box 8 of this form.
Size Range: 0-9999999999.99
        B5Sec199ADiv number Get the qualified REIT dividends paid by a REIT or section 199A dividends paid by a RIC to the recipient.
Size Range: 0-9999999999.99
        B6InvestExp number Get the recipient's pro rata share of certain amounts deductible by a nonpublicly offered RIC in computing its taxable income.
Size Range: 0-9999999999.99
        B7ForeignTaxPaid number Get foreign tax paid on dividends and other distributions on stock.
Size Range: 0-9999999999.99
        B8ForeignCountryOrUsPoss number Get the name of the foreign country or U.S. possession for which the foreign tax was paid and reported in box 7.
Size Range: 40
        B9CashLiquiDistri number Get cash distributed as part of a liquidation.
Size Range: 0-9999999999.99
        B10NonCashLiquiDistri number Get noncash distributions made as part of a liquidation. Show the fair market value as of the date of distribution.
Size Range: 0-9999999999.99
        B11ExemptIntDiv number Get exempt-interest dividends from a mutual fund or other RIC. Include specified private activity bond interest dividends in box 12 and in the total for box 11.
Size Range: 0-9999999999.99
        B12SpeciPrivActiBondIntDiv number Get exempt-interest dividends paid by a RIC on specified private activity bonds to the extent that the dividends are attributable to interest on the bonds received by the RIC minus an allocable share of the expenses.
Size Range: 0-9999999999.99
        IsFATCA Boolean When true, identifies a U.S. payer reporting on Form(s) 1099 (including reporting payments on this Form 1099-Div) to satisfy their foreign financial asset reporting requirement with respect to a U.S. account.
        AccountNum string Account number of Payer having multiple accounts for a recipient for whom more than one Form 1099-Div is filed.
Size Range: 4..20
        Is2ndTINnot Boolean When true, identifies a Payer who is notified by the IRS twice within 3 calendar years for providing an incorrect TIN and do not want the IRS to send any more notices.
        States object[] Contains list of state returns information.
            StateCd string State Code.
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"
            StateIdNum string Identification Number of State.
Size Range: ..20
            StateWH number Income tax amount withheld for State.
Size Range: 0-9999999999.99

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.
Form1099Type string Denotes the type of 1099 form.
Form1099Records object Pulls Form 1099-Div records with Success and Error statuses
    SuccessRecords object[] It will show detailed information about the success status of Form 1099-Div 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 1099-Div return is created.
        RecipientId Guid A unique identifier generated by TaxBandits for a Recipient when a 1099-Div return is created. You can use this id for your future reference to Update.
        AccountNum string Account number of Payer having multiple accounts for a recipient for whom more than one Form 1099-Div 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.
        StateReturns object[] Returns collection of state returns information
            StateCd string Returns the state code of the state for which the return is filed.
            Status string Returns the record status of the state return.
            StatusTs string Date and time of the return created.
            Info string Returns the information about the state for which we are not supporting state filing.
            Errors object[] Shows error information in state returns of Form 1099-DIV
                Id string Returns the validation error Id.
                Name string Name of the validation error.
                Message string Description of the validation error.
        Postal object Returns the status and StatusTs of postal mailing service for Form 1099 DIV.
            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 1099 DIV 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 1099 DIV 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 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

Request JSON

{
   "SubmissionManifest": {
       "TaxYear": "2021",
       "IsFederalFiling": true,
       "IsStateFiling": true,
       "IsPostal": true,
       "IsOnlineAccess": true,
       "IsScheduleFiling": true,
       "ScheduleFiling": {
           "EfileDate": "12/25/2021"
       }
   },
   "ReturnHeader": {
      "Business": {
          "BusinessId": null,
          "BusinessNm": "Brian LLC",
          "TradeNm": "Brian LLC",
          "IsEIN": true,
          "EINorSSN": "409908158",
          "Email": "john@gmail.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": null,
           "SequenceId": "1",
           "Recipient": {
               "RecipientId": null,
               "TINType": "SSN",
               "TIN": "223014579",
               "FirstPayeeNm": "Mark",
               "SecondPayeeNm": "Stephie",
               "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": "john@gmail.com",
               "Fax": "1234567890",
               "Phone": "1234567890"
           },
           "DIVFormData": {
               "B1aTotOrdiDiv": 400.00,
               "B1bQualiDiv": 200.00,
               "B2aTotCapGain": 2227.00,
               "B2bUnRecapSecGain": 41.55,
               "B2cSec1202Gain": 42.55,
               "B2dCollGain": 48.55,
               "B2eSect897OrdiDiv": 50.55,
               "B2fSect897CapGain": 3.55,
               "B3NonDivDistri": 43.55,
               "B4FedIncTaxWH": 44.55,
               "B5Sec199ADiv": 45.55,
               "B6InvestExp": 46.55,
               "B7ForeginTaxPaid": 70.55,
               "B8ForeginCntryOrUsPoss": "yes",
               "B9CashLiquiDis": 80.55,
               "B10NonCashLiquiDis": 90.55,
               "B11ExemptInvstDiv": 410.55,
               "B12SpeciPrivActiBondInvstDiv": 420.5,
               "IsFATCA": true,
               "Is2ndTINnot": true,
               "AccountNum": "20123130000009000001",
               "States": [
                   {
                       "StateCd": "PA",
                       "StateIdNum": "99999999",
                       "StateWH": 15
                   },
                   {
                       "StateCd": "AZ",
                       "StateIdNum": "99-9999999",
                       "StateWH": 17
                   }
               ]
           }
       }
   ]
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119

Response JSON

{
   "StatusCode": 200,
   "StatusName": "Ok",
   "StatusMessage": "Successful API call",
   "SubmissionId": "4d77ce45-1584-45a9-a775-75513f9d3ea5",
   "BusinessId": "642ac4d4-a137-46d7-88d1-1fda1f539b33",
   "Form1099Type": "DIV",
   "Form1099Records": {
       "SuccessRecords": [
           {
               "SequenceId": "1",
               "RecordId": "d03e1ebb-4f86-4767-b980-723559369e24",
               "RecipientId": "36964329-a1be-4588-9cdd-7fd41de3cccb",
               "AccountNum": "20123130000009000001",
               "FederalReturn": {
                   "Status": "CREATED",
                   "StatusTs": "2021-11-25 05:20:32 -05:00",
                   "Info": null
               },
               "StateReturns": [
                   {
                       "StateCd": "PA",
                       "Status": "NA",
                       "StatusTs": null,
                       "Info": "This service will be available soon",
                       "Errors": null
                   },
                   {
                       "StateCd": "AZ",
                       "Status": "NA",
                       "StatusTs": null,
                       "Info": "This service will be available soon",
                       "Errors": null
                   }
               ],
               "Postal": {
                   "Status": "CREATED",
                   "StatusTs": "2021-11-25 05:20:32 -05:00",
                   "Info": null
               },
               "OnlineAccess": {
                   "Status": "CREATED",
                   "Email": "john@gmail.com",
                   "Info": null
                },
               "ScheduleFiling": {
                   "ScheduledOn": null,
                   "Info": "This Service will be available soon"
               }
           }
       ],
       "ErrorRecords": null
   },
   "Errors": null
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55

# Delete

Deletes Form 1099-DIV return created in TaxBandits. Transmitted forms cannot be deleted.

DELETE Form1099DIV/Delete
1

Request Body

Field Type Description
SubmissionId Guid Unique identifier of a submission
RecordIds guid[] An unique identifier generated by TaxBandits when a 1099-DIV return is created. Mention the 1099-DIV return's Record ID that you want to delete.

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
Form1099Records object Pulls the Form 1099-DIV records with Success and Error statuses
    SuccessRecords object[] It will show the detailed information about the success status of Form 1099-DIV Records
        SequenceId string A unique number is given by an inbound application to identify failed records
        RecordId Guid Unique identifier of a record
        Status string Returns the status of the records.
        StatusTs string Date and time of return deleted.
    ErrorRecords object[] It will show the detailed information about the error status of Form 1099-DIV Records.
        SequenceId string A unique number given by an inbound application to identify failed records
        RecordId Guid Unique identifier of a record
        Errors object[] Shows detailed error information
            Id string Returns the validation error code
            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 code
    Name string Name of the validation error
    Message string Description of the validation error

Request JSON

Form1099DIV/Delete?SubmissionId=b39b8d96-2a87-4b1e-8555-e93eaf4f8b3f&RecordIds=c53fb555-edf4-4d82-9d6d-53212468a282
1

Response JSON

{
   "StatusCode": 200,
   "StatusName": "Ok",
   "StatusMessage": "Successful API call",
   "SubmissionId": "b39b8d96-2a87-4b1e-8555-e93eaf4f8b3f",
   "Form1099Records": {
       "SuccessRecords": [
           {
               "SequenceId": "1",
               "RecordId": "c53fb555-edf4-4d82-9d6d-53212468a282",
               "Status": "DELETED",
               "StatusTs": "2021-11-25 06:04:36 -05:00",
               "StateReturns": null
           }
       ],
       "ErrorRecords": null
   },
   "Errors": null
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19

# Get

Retrieves the Form 1099-DIV return information based on the Submission Id and RecordIds given in the request.

GET Form1099DIV/Get
1

Request Body

Field Type Description
SubmissionId Guid A unique identifier generated by TaxBandits when a 1099-DIV return is created. Mention the Form 1099-DIV return's Submission Id that you want to get.
RecordIds Guid[] A unique identifier generated by TaxBandits when a 1099-DIV return is created. Mention the Form 1099-DIV return's Record Id that you want to get.

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
Form1099Records object Contains information about Form 1099-DIV returns.
SubmissionManifest object SubmissionManifest 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.
    SubmissionId Guid Unique identifier created by TaxBandits for each submission. Not required when you are creating a return.
    TaxYear string Tax year of Form 1099-DIV to be filed.
Allowed values: "2021"
    IsFederalFiling Boolean Federal Filing for the return will be enabled when the value is True. The Form 1099-DIV will be sent directly to the IRS.
    IsStateFiling Boolean State Filing for the return will be enabled when the value is True. Form 1099-DIV forms 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 Postal Order will be created when the value is set as True. Once the return is Transmitted, Form 1099-DIV 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 return is Transmitted, an email with the link to the secure TaxBandits portal will be sent to the Recipient. The recipient can provide consent and download Form 1099-DIV Recipient copies from the portal.
    IsScheduleFiling Boolean When true, schedule filing services will be provided for Form 1099-DIV 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/2021 or 10-20-2021
ReturnHeader object Contains information about the Business details.
    Business object Object to identify the Business Details.
        BusinessId Guid Returns the unique Business ID for the Business. It can be used in future to refer the same business.
        BusinessNm string Name of the business
Size Range: ..80
        TradeNm string Optional Name under which the business operates
Size Range: ..80
        IsEIN Boolean When true, identifies the business with an EIN.
        EINorSSN string Returns the Employer Identification Number of Business
Size Range: 9
        Email string Email address of the Business
Size Range: ..40
        ContactNm string Optional Name of the person who can be contacted by the IRS
Size Range: ..27
        Phone string 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/1099 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", "TAX MATTERPARTNER", "PRESIDENT", "VICEPRESIDENT", "CORPORATETREASURER", "TREASURER", "ASSISTANTTREASURER", "CHIEFACCOUNTINGOFFICER", "CHIEFEX ECUTIVEOFFICER", "CHIEFFINANCIALOFFICER", "TAXOFFICER", "CHIEFOPERATINGOFFICER", "CORPORATEOFFICER", "EXECUTIVEDIRECTOR", "DIRECTOR", "CH AIRMAN", "EXECUTIVEADMINISTRATOR", "RECEIVER", "PASTOR", "ASSISTANTTORELIGIOUSLEADER", "REVEREND", "PRIEST", "MINISTER", "RABBI", "LEADEROF RELIGIOUSORGANIZATION", "SECRETARY", "DIRECTOROFTAXATION", "DIRECTOROFPERSONNEL", "ADMINISTRATOR", "EXECUTOR", "TRUSTEE", "FIDUCIARY", "OW NER", "SOLEPROPRIETOR", "MEMBER", "SOLEMEMBER"
        KindOfEmployer string Optional Identifies the kind of employer. Mandatory for W-2 and optional for Form 1099-DIV and 94X series
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 1099-DIV and 94X series
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: ..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: 9
        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: "US", "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.
Size Range: 9
ReturnData object[] Contains information about the recipient details and Form 1099-DIV details.
    RecordId Guid Unique identifier of a record. Not required when you are creating a return.
    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.
    Recipient object Object to identify the recipient details.
        RecipientId Guid An unique identifier generated by TaxBandits for a Recipient when a 1099-DIV return is created. 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", "N/A"
        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.
        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.
        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: ..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: 9
        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: "US", "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
Size Range: 9
        Email string Recipient's email address.
Size Range: 0..40
        Fax string Optional Recipient's Fax number.
Size Range: 10
        Phone string Recipient's Phone Number.
Size Range: 10
    DIVFormData object Object to create 1099-DIV.
        B1aTotOrdiDiv number Gets dividends, including dividends from money market funds, net short-term capital gains from mutual funds, and other distributions on stock.
Size Range: 0-9999999999.99
        B1bQualiDiv number Gets the portion of the dividends in box 1a that qualifies for the reduced capital gains rates.
Size Range: 0-9999999999.99
        B2aTotCapGain number Get total capital gain distributions (long-term). Include all amounts shown in boxes 2b, 2c, 2d, and 2f.
Size Range: 0-9999999999.99
        B2bUnRecapSec1250Gain number Get any amount included in box 2a that is an unrecaptured section 1250 gain from certain depreciable real property.
Size Range: 0-9999999999.99
        B2cSec1202Gain number Get any amount included in box 2a that is a section 1202 gain from certain qualified small business stock.
Size Range: 0-9999999999.99
        B2dCollGain number Get any amount included in box 2a that is a 28% rate gain from sales or exchanges of collectibles.
Size Range: 0-9999999999.99
        B2eSec897OrdiDiv number Get any amount included in box 1a that is section 897 gain from dispositions of USRPI.
Size Range: 0-9999999999.99
        B2fSec897CapGain number Get any amount included in box 2a that is section 897 gain from dispositions of USRPI.
Size Range: 0-9999999999.99
        B3NonDivDistri number Get nondividend distributions, if determinable.
Size Range: 0-9999999999.99
        B4FedIncTaxWH number Get the backup withholding, for the payments reported in box1, box 2 and box 8 of this form.
Size Range: 0-9999999999.99
        B5Sec199ADiv number Get the qualified REIT dividends paid by a REIT or section 199A dividends paid by a RIC to the recipient.
Size Range: 0-9999999999.99
        B6InvestExp number Get the recipient's pro rata share of certain amounts deductible by a nonpublicly offered RIC in computing its taxable income.
Size Range: 0-9999999999.99
        B7ForeignTaxPaid number Get foreign tax paid on dividends and other distributions on stock.
Size Range: 0-9999999999.99
        B8ForeignCountryOrUsPoss number Get the name of the foreign country or U.S. possession for which the foreign tax was paid and reported in box 7.
Size Range: 40
        B9CashLiquiDistri number Get cash distributed as part of a liquidation.
Size Range: 0-9999999999.99
        B10NonCashLiquiDistri number Get noncash distributions made as part of a liquidation. Show the fair market value as of the date of distribution.
Size Range: 0-9999999999.99
        B11ExemptIntDiv number Get exempt-interest dividends from a mutual fund or other RIC. Include specified private activity bond interest dividends in box 12 and in the total for box 11.
Size Range: 0-9999999999.99
        B12SpeciPrivActiBondIntDiv number Get exempt-interest dividends paid by a RIC on specified private activity bonds to the extent that the dividends are attributable to interest on the bonds received by the RIC minus an allocable share of the expenses.
Size Range: 0-9999999999.99
        IsFATCA Boolean When true, identifies a U.S. payer reporting on Form(s) 1099 (including reporting payments on this Form 1099-Div) to satisfy their foreign financial asset reporting requirement with respect to a U.S. account.
        AccountNum string Account number of Payer having multiple accounts for a recipient for whom more than one Form 1099-Div is filed.
Size Range: 4..20
        Is2ndTINnot Boolean When true, identifies a Payer who is notified by the IRS twice within 3 calendar years for providing an incorrect TIN and do not want the IRS to send any more notices.
        States object[] Contains list of state returns information.
            StateCd string State Code.
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", "M O", "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"
            StateIdNum string Identification Number of State.
Size Range: ..20
            StateWH number Income tax amount withheld for State.
Size Range: 0-9999999999.99
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

Request JSON

Form1099DIV/Get?SubmissionId=4d77ce45-1584-45a9-a775-75513f9d3ea5&RecordIds=d03e1ebb-4f86-4767-b980-723559369e24
1

Response JSON

{
   "StatusCode": 200,
   "StatusName": "Ok",
   "StatusMessage": "Successful API call",
   "Form1099Records": {
       "SubmissionManifest": {
           "SubmissionId": "4d77ce45-1584-45a9-a775-75513f9d3ea5",
           "TaxYear": "2021",
           "IsFederalFiling": true,
           "IsStateFiling": true,
           "IsPostal": true,
           "IsOnlineAccess": true,
           "IsScheduleFiling": true,
           "ScheduleFiling": {
               "EfileDate": "12/25/2021"
           }
       },
       "ReturnHeader": {
           "Business": {
               "BusinessId": "642ac4d4-a137-46d7-88d1-1fda1f539b33",
               "PayerRef": null,
               "BusinessNm": "Brian LLC",
               "TradeNm": "Brian LLC",
               "IsEIN": true,
               "EINorSSN": "40-9908158",
               "Email": "john@gmail.com",
               "ContactNm": "John",
               "Phone": "(123) 456-7890",
               "PhoneExtn": "12345",
               "Fax": "(123) 456-7890",
               "BusinessType": "ESTE",
               "SigningAuthority": {
                   "Name": "John",
                   "Phone": "(123) 456-7890",
                   "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": null,
               "IsGovernmentalUnit": false
           }
       },
       "ReturnData": [
           {
               "RecordId": "d03e1ebb-4f86-4767-b980-723559369e24",
               "SequenceId": "1",
               "Recipient": {
                   "RecipientId": "36964329-a1be-4588-9cdd-7fd41de3cccb",
                   "TINType": "SSN",
                   "TIN": "223-01-4579",
                   "FirstPayeeNm": "Mark",
                   "SecondPayeeNm": "Stephie",
                   "IsForeign": false,
                   "USAddress": {
                       "Address1": "1751 Kinsey Rd",
                       "Address2": "Main St",
                       "City": "Dothan",
                       "State": "AL",
                       "ZipCd": "36303"
                   },
                   "ForeignAddress": null,
                   "Email": "john@gmail.com",
                   "Fax": "(123) 456-7890",
                   "Phone": "(123) 456-7890"
               },
               "DIVFormData": {
                   "B1aTotOrdiDiv": 400.00,
                   "B1bQualiDiv": 200.00,
                   "B2aTotCapGain": 2227.00,
                   "B2bUnRecapSecGain": 41.55,
                   "B2cSec1202Gain": 42.55,
                   "B2dCollGain": 48.55,
                   "B2eSect897OrdiDiv": 50.55,
                   "B2fSect897CapGain": 3.55,
                   "B3NonDivDistri": 43.55,
                   "B4FedIncTaxWH": 44.55,
                   "B5Sec199ADiv": 45.55,
                   "B6InvestExp": 46.55,
                   "B7ForeginTaxPaid": 70.55,
                   "B8ForeginCntryOrUsPoss": "yes",
                   "B9CashLiquiDis": 80.55,
                   "B10NonCashLiquiDis": 90.55,
                   "B11ExemptInvstDiv": 410.55,
                   "B12SpeciPrivActiBondInvstDiv": 420.50,
                   "IsFATCA": true,
                   "AccountNum": "20123130000009000001",
                   "Is2ndTINnot": true,
                   "States": [
                       {
                           "StateCd": "PA",
                           "StateIdNum": "99999999",
                           "StateWH": 15.00
                       },
                       {
                           "StateCd": "AZ",
                           "StateIdNum": "99-9999999",
                           "StateWH": 17.00
                       }
                   ]
               }
           }
       ]
   },
   "Errors": null
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114

# GetPDF

Retrieves Form 1099-DIV PDFs. The link for PDFs download will be sent via Webhook after successful API call.

GET Form1099DIV/GetPDF
1

Request Body

Field Type Description
SubmissionId Guid Unique identifier of a submission
RecordIds Guid[] Optional Unique identifier of a records.
TINMaskType string Optional Choose the masking type of your Recipient's TIN on the 1099-DIV PDF. MASKED - The Recipient's TIN will be masked in the PDF. Only the last 4 digits of the TIN can beread.UNMASKED - The Recipient's TIN will not be masked in the PDF. To protect the PII information of the Recipient, thePDF with Unmasked TIN is password protected. Use the Recipient's TIN (password) to open the protected file.BOTH - TwoPDFs will be delivered for each Recipient.One with Masked TIN and the other with Unmasked TIN. The PDF with Unmasked TINwill be password protected.
Allowed values: "MASKED", "UNMASKED", "BOTH"

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
Form1099DivRecords object[] Collection of Form 1099-DIV records for which the PDF will be successfull delivered
    RecordId guid Unique identifier of a record
    Message string Provides additional information regarding the PDF delivery.
Errors object[] Shows detailed error information
    Id string Returns the validation error code
    Name string Name of the validation error
    Message string Description of the validation error
    Type string Type of validation error

Request JSON

Form1099DIV/Getpdf?SubmissionId=4d77ce45-1584-45a9-a775-75513f9d3ea5&RecordIds=d03e1ebb-4f86-4767-b980-723559369e24
1

**Response JSON **

{
   "StatusCode": 200,
   "StatusName": "Ok",
   "StatusMessage": "Successful API call",
   "SubmissionId": "4d77ce45-1584-45a9-a775-75513f9d3ea5",
   "Form1099DivRecords": [
       {
           "RecordId": "d03e1ebb-4f86-4767-b980-723559369e24",
           "Message": "We've successfully received your request to generate PDF. You will be notified with the URL to download the PDF."
       }
   ],
   "Errors": null
}
1
2
3
4
5
6
7
8
9
10
11
12
13

# List

Lists all Form 1099-DIV returns created and transmitted on the account for a particular Submission or Payer. Form 1099-DIV returns will be listed based on the filters sent in the Request.

GET Form1099DIV/List
1

Request Body

Field Type Description
SubmissionId Guid Unique identifier of a submission
BusinessId Guid Unique identifier of a business
TINType string List the 1099-DIV records based on the given TINType and TIN.
TIN string List the 1099-DIV records based on the given TIN.
TaxYear string List the 1099-DIV records based on the given taxyear.
Page number Pulls the records listed in the page selected
PageSize number Number of 1099-DIV records to be listed in each page.
EfileStatus string List the 1099-DIV records based on the status ("CREATED, UNDERPROCESS, SENTTOAGENCY, TRANSMITTED, ACCEPTED, REJECTED")
FromDate string Enter a date from which the Form 1099-DIV records need to be listed.
ToDate string Enter a date till which the 1099-DIV records created are to be listed.

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
Form1099Type string Denotes the type of 1099 form.
Form1099Records object[] Returns detailed information of the Form 1099-DIV records.
    SubmissionId Guid Unique identifier of a submission
    BusinessId Guid Unique identifier of a business
    BusinessNm string Name of the business
    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)
    ContactNm string Contact Name of the Business.
    TaxYear string Tax year of 1099-DIV to be filed.
    Recipient object Details of the Recipient.
        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 1099-DIV return is created.
        RecipientId Guid A unique identifier generated by TaxBandits for a Recipient when a 1099-DIV return is created. You can use this id for your future reference to Update.
        RecipientNm Boolean Name of Recipient.
        TINType string TIN type of the Recipient.
        TIN string TIN of the Recipient.
        Status string The status of Form 1099-DIV.
TotalRecords number Total number of records.
TotalPages number Total number of pages.
Page number Pulls the records listed in the page selected
PageSize number Number of 1099-DIV records to be listed in each page.
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

Request JSON

"Form1099DIV/List?SubmissionId=4d77ce45-1584-45a9-a775-75513f9d3ea5&TINType=EIN&TIN=409908158&TaxYear=2021&Page=1&PageSize=1"
1

Response JSON

{
    "StatusCode": 200,
    "StatusName": "Ok",
    "StatusMessage": "Successful API call",
    "Form1099Type": "DIV",
    "Form1099Records": [
        {
            "SubmissionId": "4d77ce45-1584-45a9-a775-75513f9d3ea5",
            "BusinessId": "642ac4d4-a137-46d7-88d1-1fda1f539b33",
            "PayerRef": null,
            "BusinessNm": "Brian LLC",
            "IsEIN": true,
            "EINorSSN": "40-9908158",
            "ContactNm": "John",
            "TaxYear": "2021",
            "Recipient": {
                "SequenceId": "1",
                "RecordId": "d03e1ebb-4f86-4767-b980-723559369e24",
                "RecipientId": "36964329-a1be-4588-9cdd-7fd41de3cccb",
                "RecipientNm": "Mark Stephie",
                "TINType": "SSN",
                "TIN": "223-01-4579",
                "Status": "CREATED"
            }
        }
    ],
    "TotalRecords": 1,
    "TotalPages": 1,
    "Page": 1,
    "PageSize": 1,
    "Errors": null
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32

# RequestDraftPdfUrl

This API request will return the Draft PDF of the forms that are not transmitted yet for review purpose. The draft PDF will have copy A of the form with For Review Only watermark text.

Note: You can only retrieve PDF of a single record/form using this method.

How does it works?

  1. Call the [POST] Form1099DIV/RequestDraftPdfUrl endpoint. You will need to supply the following parameters:

    • Access Token in the header as Bearer Token (Generated using TaxBandits OAuth authentication API)

    • Request Parameters: Specify the RecordId for the form you need the Draft PDF form. If you do not have the RecordId, then you request the PDF using the following parameters

      • Business Reference - Use the business reference PayerRef or BusinessId or TIN.
      • Recipient Reference - Use the recipient reference PayeeRef or RecipientId or TIN.
      • Tax Year - Tax year of the form you are requesting the PDF. 

POST Form1099DIV/RequestDraftPdfUrl
1

Request Body

Field Type Description
RecordId Guid Optional Specify the RecordId of the return
TINMaskType string Optional TIN Mask type on the TIN printed on the PDF
Allowed values: "MASKED", "UNMASKED"
TaxYear string Optional Tax Year of the return. Specify only if you do not have the RecordId
Business object Optional Collects the Business identifier TIN or TBS Business Id or PayerRef. This object information is required only if you do not have the RecordId
    BusinessId Guid Optional TaxBandits Unique Business Identifier. This ID is generated by TaxBandits after you create a business in your account using the Business endpoint.
    PayerRef string Optional Unique payer identifier assigned by the client.
Size Range: 1 to 50
    TINType string Optional TIN type of the Business TIN. Use this as an alternative for BusinessId or PayerRef.
Allowed values: "SSN,EIN"
    TIN string Optional Taxpayer Identification Number. Use this as an alternative for BusinessId or PayerRef.
Size Range: 9 to 11
Recipient object Optional Collects the recipient's unique identifier. This object information is required only if you do not have the RecordId
    PayeeRef string Optional An unique identifier for each recipient set by the client.
Size Range: 1 to 50
    RecipientId Guid Optional Unique Recipient Identifier generated by TaxBandits
    TINType string Optional TIN type of the Recipient's TIN. Use this as an alternative for RecipientId or PayeeRef.
Allowed values: "SSN,EIN"
    TIN string Optional Taxpayer Identification Number. Use this as an alternative for RecipientId or PayeeRef.

Response Body

Field Type Description
RecordId Guid Unique identifier of the record
RecipientId Guid Unique Recipient Identifier generated by TaxBandits
PayeeRef string An unique identifier for each recipient set by the client.
DraftPdfUrl string URL of the Draft PDF
Errors object[] Shows detailed error information
    Id string Returns the validation error code
    Name string Name of the validation error
    Message string Description of the validation error

Request JSON 1: With just the RecordId

{
  "TaxYear": null,
  "RecordId": "cf0a188b-6661-4b57-b04b-ba9ead52a16e",
  "Business": null,
  "Recipient": null
}
1
2
3
4
5
6

Response JSON 1

{
  "RecordId": "cf0a188b-6661-4b57-b04b-ba9ead52a16e",
  "RecipientId": "bd2221f7-4be6-4cc7-813c-6346e23b9f63",
  "PayeeRef": null,
  "DraftPdfUrl":"https://expressirsforms.s3.us-east-1.amazonaws.com/pdfs/a570efbd-740f-4ae2-bfe7-26356cd85148/3e99f728-e9d4-4d88-99b6-e00638da7a5b/1099/221556/d/copy_tbs_wm_1up_221556.pdf",
  "Error": null
}
1
2
3
4
5
6
7

Request JSON 2: With No RecordId

{
 "TaxYear": "2021",
 "RecordId": null,
 "Business": {
   "BusinessId": "94B6214D-8DCA-490C-8FC3-602840B439B5",
   "PayerRef": null,
   "TINType": null,
   "TIN": null
 },
 "Recipient": {
   "RecipientId": "6DDFFB5A-565F-402D-8602-7ECD917CEC04",
   "PayeeRef": null,
   "TINType": null,
   "TIN": null
 }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

Response JSON 2

{
  "RecordId": "cf0a188b-6661-4b57-b04b-ba9ead52a16e",
  "RecipientId": "6DDFFB5A-565F-402D-8602-7ECD917CEC04",
  "PayeeRef": null,
  "DraftPdfUrl":"https://expressirsforms.s3.us-east-1.amazonaws.com/pdfs/a570efbd-740f-4ae2-bfe7-26356cd85148/3e99f728-e9d4-4d88-99b6-e00638da7a5b/1099/221556/d/copy_tbs_wm_1up_221556.pdf",
  "Error": null
}
1
2
3
4
5
6
7

# RequestPdfURLs

This method can be used to retrieve PDFs for single or multiple recipients. The PDF URL will be returned in the response only if it is already generated by us. You can use the SubmissionId or RecordIds to request the pdf URLs.

Note: The PDF URL will be returned in response only after the return is transmitted in the API. This method will not work for Inprogress returns.

POST Form1099DIV/RequestPdfURLs
1

Request Body

Field Type Description
SubmissionId Guid Optional Unique identifier of an API submission. Use this node to request the PDFs under a particular submission. If you are going to request the PDFs using the RecordIds, you can leave the SubmissionId blank or null.
RecordIds object[] Contains the list of RecordIds for which you are requesting the pdf URLs
    RecordId Guid Unique identifier of the return.
Customization object Contains PDF customizations
    TINMaskType string Optional Mention whether you want the TIN to be masked in the PDF. If masked, only the last digits of the SSN will be visible and the rest of the digits will be crossed (xxx-xx-1234).
Allowed values: "MASKED", "UNMASKED", "BOTH"

Response Body

Field Type Description
SubmissionId Guid Unique identifier of a submission.
Form1099DivRecords object Contains success and error records of the requested RecordIds.
    SuccessRecords object[] Contains the successful records with pdf urls if the forms are generated.
        RecordId Guid Unique identifier of the return.
        Status string Status of the PDF in TaxBandits.
Success - The PDF is generated and you can download it.
        Files object Contains multiple copies of a particular return.
            Copy1 object Copy 1: For State Tax Department
                Unmasked string Link to download the Unmasked copy
                Masked string Link to download the Masked copy
            Copy2 object Copy 2: To be filed with recipients state income tax return, when required.
                Unmasked string Link to download the Unmasked copy
                Masked string Link to download the Masked copy
            CopyB object Copy B: For Recipient
                Unmasked string Link to download the Unmasked copy
                Masked string Link to download the Masked copy
            CopyC object Copy C: For Payer
                Unmasked string Link to download the Unmasked copy
                Masked string Link to download the Masked copy
    ErrorRecords object[] Contains the error records
        RecordId Guid Unique identifier of the return.
        Status string Status of the error record.
  • PDF_Not_Generated - PDF is yet to be generated. You will have to wait and send a new API request to get the PDF.
  • Not Transmitted - The return is not transmitted yet.
  • Invalid RecordId - Given record id is invalid
        Message string Description of each statuses
Errors object[] Lists the errors in the API call
    Id string Returns the error Id.
    Name string Name of the validation error
    Message string Description of the validation error

Sample Request JSON 1

{
  "SubmissionId": "81b77217-fb5a-4315-b76e-bbb805676a38",
  "RecordIds": [
    {
      "RecordId": "ea13cc94-d25f-4c2f-aef2-a97b3eb59cf1"
    }
  ],
  "Customization": {
    "TINMaskType": "Masked"
  }
}
1
2
3
4
5
6
7
8
9
10
11

Sample Response JSON 1

{
   "SubmissionId": "e32eb5b3-2e41-4716-8ab8-9fb8f637eeb4",
   "Form1099DivRecords": {
       "SuccessRecords": [
           {
               "RecordId": "ce6a8a23-efe2-4824-bb1c-4a085e81e9ba",
               "Status": "Success",
               "Files": {
                   "Copy1": {
                       "Unmasked": null,
                       "Masked": "https://expressirsforms.s3.us-east-1.amazonaws.com/pdfs/769e7c15b887-4d64a50f-444ab16f50d0/40a69386-34d4-4f9b-a999-e8325c5e3d2b/1099/9719a567-74b8-4796-b08e-0e389dd05aa6/m/copy1_1up_2404486860.pdf"
                   },
                   "Copy2": {
                       "Unmasked": null,
                       "Masked": "https://expressirsforms.s3.us-east-1.amazonaws.com/pdfs/769e7c15b887-4d64a50f-444ab16f50d0/40a69386-34d4-4f9b-a999-e8325c5e3d2b/1099/9719a567-74b8-4796-b08e-0e389dd05aa6/m/copy2_1up_9709990552.pdf"
                   },
                   "CopyB": {
                       "Unmasked": null,
                       "Masked": "https://expressirsforms.s3.us-east-1.amazonaws.com/pdfs/769e7c15b887-4d64a50f-444ab16f50d0/40a69386-34d4-4f9b-a999-e8325c5e3d2b/1099/9719a567-74b8-4796-b08e-0e389dd05aa6/m/copyb_1up_552335217.pdf"
                   },
                   "CopyC": {
                       "Unmasked": null,
                       "Masked": "https://expressirsforms.s3.us-east-1.amazonaws.com/pdfs/769e7c15b887-4d64a50f-444ab16f50d0/40a69386-34d4-4f9b-a999-e8325c5e3d2b/1099/9719a567-74b8-4796-b08e-0e389dd05aa6/m/copyc_1up_9957067731.pdf"
                   }
               }
           }
       ],
       "ErrorRecords": null
   },
   "Errors": null
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31

Sample Request JSON 2

{
 "SubmissionId": "a863c015-91f1-4128-84fc-bb38922b80f9",
 "RecordIds": [
   {
     "RecordId": "c4446e74-ee11-43e4-b9db-a7e870714267"
   },
   {
     "RecordId": "f11413f7-3fe3-4d55-9e87-66b687bc404e"
   }
 ],
 "Customization": {
   "TINMaskType": "Masked"
 }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14

Sample Response JSON 2

{
   "SubmissionId": null,
   "Form1099DivRecords": {
       "SuccessRecords": null,
       "ErrorRecords": [
           {
               "RecordId": "c4446e74-ee11-43e4-b9db-a7e870714267",
               "Status": "PDF_Not_Generated",
               "Message": "Your PDF request is prioritized in the queue.Please try again after sometime"
           },
           {
               "RecordId": "f11413f7-3fe3-4d55-9e87-66b687bc404e",
               "Status": "Not Transmitted",
               "Message": "Given RecordId is not transmitted"
           }
       ]
   },
   "Errors": null
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19

Sample Request JSON 3

{
   "RecordIds": [
   {
     "RecordId": "c4446e74-ee11-43e4-b9db-a7e870714267"
   },
   {
     "RecordId": "f11413f7-3fe3-4d55-9e87-66b687bc404e"
   }
 ]

}
1
2
3
4
5
6
7
8
9
10
11

Sample Response JSON 3

{
   "SubmissionId": null,
   "Form1099DivRecords": {
       "SuccessRecords": null,
       "ErrorRecords": [
           {
               "RecordId": "c4446e74-ee11-43e4-b9db-a7e870714267",
               "Status": "PDF_Not_Generated",
               "Message": "Your PDF request is prioritized in the queue.Please try again after sometime"
           },
           {
               "RecordId": "f11413f7-3fe3-4d55-9e87-66b687bc404e",
               "Status": "Not Transmitted",
               "Message": "Given RecordId is not transmitted"
           }
       ]
   },
   "Errors": null
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19

# Status

This method will return the current status of Form 1099 for a particular submission or for a particular employee.

Federal Return Statuses:

  • Created: Form 1099 has been created and not yet transmitted by the user.

  • Transmitted: Form 1099 has been transmitted by the user.

  • Order Received: Form 1099 order is received and waiting in our efile queue.

  • Under Process: Our efile system is processing the Form 1099 which will be sent to the IRS soon.

  • Sent to Agency: Form 1099 has been sent to the SSA and we are waiting for the result from IRS.

  • Accepted: Form 1099 is accepted by the IRS.

  • Rejected: Form 1099 is rejected by the IRS due to some errors. Please correct the errors and retransmit them.

State Return Statuses:

  • Not Created: State filing is not opted for the return. IsStateFiling in the submission manifest must be set as TRUE to enable state filing.

  • Created: Form 1099 state return has been created and not yet transmitted by the user.

  • Transmitted: Form 1099 state return has been transmitted by the user.

  • Order Received: State order is received and waiting in our efile queue.

  • Under Process: Our efile system is processing the Form 1099 for the state which will be sent to the state DOR soon.

  • Sent to Agency: Form 1099 State return has been sent to the DOR and we are waiting for the result.

  • Accepted: Form 1099 state return is accepted by the DOR.

  • Rejected: Form 1099 state return is rejected by the DOR due to some errors. Please correct the errors and retransmit them.

Postal Mailing Statuses:

  • Not Created: Postal Mailing is not opted for the return. IsPostalMailing in the submission manifest must be set as TRUE to enable postal mailing. Postal Mailing cannot be created for recipients with Foreign addresses.

  • Created: Postal Mailing service is opted for the return and it will be sent as soon as the form is transmitted.

  • Order Received: Postal Mailing order has been received and the mails will be sent out soon.

  • Order Sent: Postal Mailing order has been sent and the recipient will receive the copy soon.

Online Access Statuses:

  • Not Created: Online Access service is not opted for the return. IsOnlineAccess in the submission manifest must be set as TRUE to enable Online Access.Email Address is required to create Online Access.

  • Created: Online Access service is opted for the return and the email with a secure link to download their forms will be sent to the recipients as soon as the form is transmitted.

  • Order Received: Online Access order has been received and the email will be sent to the recipient soon.

  • Email Sent: Online Access email with a secure link to download the form has been sent to the recipient and the recipient is yet to view the form.

  • Viewed Form: Recipient has successfully viewed the form.

  • Downloaded Form: Recipient has successfully viewed and downloaded the form.

GET Form1099DIV/Status
1

Request Body

Field Type Description
SubmissionId Guid Unique identifier of a submission
RecordIds Guid[] List of record Ids to get the status of Form 1099-DIV.

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.
Form1099Type string Denotes the type of 1099 form.
Form1099Records object Pulls Form 1099-DIV records with Success and Error statuses
    SuccessRecords object[] It will show the detailed information about the success status of Form 1099-DIV 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 1099-DIV return is created.
        RecipientId Guid A unique identifier generated by TaxBandits for a Recipient when a 1099-DIV 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.
        StateReturns object[] Returns collection of state returns information
            StateCd string Returns the state code of the state which the return filed.
            Status string Returns the record status of the state return.
            StatusTs string Date and time of the return created.
            Info string Returns the information about the state for which we are not state filing.
            Errors object[] Shows error information of state returns of Form 1099-DIV
                Id string Returns the validation error Id.
                Name string Name of the validation error.
                Message string Description of the validation error.
        Postal object Returns the status and StatusTs of postal mailing service for Form 1099-DIV.
            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 1099-DIV 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 1099-DIV 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

Request JSON

Form1099DIV/Status?SubmissionId=94419089-f9fe-4390-b622-ee06f7682754&RecordIds=aabf8859-c07a-4ea1-bdc5-0088cf037f03
1

Response JSON

{
 "StatusCode": 200,
 "StatusName": "Ok",
 "StatusMessage": "Successful API call",
 "SubmissionId": "4d77ce45-1584-45a9-a775-75513f9d3ea5",
 "BusinessId": "642ac4d4-a137-46d7-88d1-1fda1f539b33",
 "Form1099Type": "DIV",
 "Form1099Records": {
   "SuccessRecords": [
     {
       "SequenceId": "1",
       "RecordId": "d03e1ebb-4f86-4767-b980-723559369e24",
       "RecipientId": "36964329-a1be-4588-9cdd-7fd41de3cccb",
       "FederalReturn": {
         "Status": "CREATED",
         "StatusTs": "2021-11-25 05:26:27 -05:00",
         "Info": null
       },
       "StateReturns": [
         {
           "StateCd": "PA",
           "Status": "NA",
           "StatusTs": null,
           "Info": "This service will be available soon",
           "Errors": null
         },
         {
           "StateCd": "AZ",
           "Status": "NA",
           "StatusTs": null,
           "Info": "This service will be available soon",
           "Errors": null
         }
       ],
       "Postal": {
         "Status": "CREATED",
         "StatusTs": "2021-11-25 05:26:26 -05:00",
         "Info": null
       },
       "OnlineAccess": {
          "Status": "CREATED",
          "Email": "john@gmail.com",
           "Info": null
       },
       "ScheduleFiling": {
         "ScheduledOn": null,
         "Info": "This service will be available soon"
       }
     }
   ],
   "ErrorRecords": null
 },
 "Errors": null
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54

# Transmit

Transmits the Form 1099-DIV return to the IRS. You can Transmit a return successfully only if there are no validation errors in the return.

POST Form1099DIV/Transmit
1

Request Body

Field Type Description
SubmissionId guid A unique identifier generated by TaxBandits when a 1099-DIV return is created. Mention the 1099-DIV return's Submission ID that you want to transmit.
RecordIds Guid[] A unique identifier generated by TaxBandits when a 1099-DIV return is created. Mention the 1099-DIV return's Record ID that you want to transmit.

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
Form1099Records object Pulls the Form 1099-DIV records with Success and Error statuses
    SuccessRecords object[] It will show the detailed information about the success status of Form 1099-DIV 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 Unique identifier of a record
        Status string Returns the status of the records.
        StatusTs string Date and Time of the Return Transmission
    ErrorRecords object[] It will show the detailed information about the error status of Form 1099-DIV 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 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

Request JSON

{
  "SubmissionId": "4d77ce45-1584-45a9-a775-75513f9d3ea5",
  "RecordIds": [
    "d03e1ebb-4f86-4767-b980-723559369e24"
  ]
}
1
2
3
4
5
6

Response JSON

{
    "StatusCode": 200,
    "StatusName": "Ok",
    "StatusMessage": "Successful API call",
    "SubmissionId": "4d77ce45-1584-45a9-a775-75513f9d3ea5",
    "Form1099Records": {
        "SuccessRecords": [
            {
                "SequenceId": "1",
                "RecordId": "d03e1ebb-4f86-4767-b980-723559369e24",
                "Status": "Transmitted",
                "StatusTs": "2021-11-25 06:00:14 -05:00",
                "StateReturns": null
            }
        ],
        "ErrorRecords": null
    },
    "Errors": null
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19

# Update

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

PUT Form1099Div/Update
1

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 Guid Unique identifier created by TaxBandits for each submission. Not required when you are creating a return.
    TaxYear string Tax year of Form 1099-DIV to be filed..
Allowed values: "2021"
    IsFederalFiling Boolean Federal Filing for the return will be enabled when the value is True. Form 1099-DIV will be sent directly to the IRS.
    IsStateFiling Boolean State Filing for the return will be enabled when the value is True. Form 1099-DIV 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 Postal Order will be created when the value is set as True. Once the return is Transmitted, Form 1099-DIV 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 return is Transmitted, an email with the link to the secure TaxBandits portal will be sent to the Recipient. The recipient can provide consent and download Form 1099-DIV Recipient copies from the portal.
    IsScheduleFiling Boolean When true, schedule filing services will be provided for Form 1099-DIV 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/2021 or 10-20-2021
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: ..80
        TradeNm string Optional Name under which the business operates
Size Range: ..80
        IsEIN Boolean When true, identify that the business TIN is 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 Email address of the Business
Size Range: ..40
        ContactNm string Optional Name of the person who can be contacted by the IRS.
Size Range: ..27
        Phone string 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/1099 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 1099-DIV and 94X series
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 1099-DIV and 94X series
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: 9
        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: "US", "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
Size Range: 9
ReturnData object[] Contains information about the recipient details and Form 1099-DIV 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
    RecordId Guid Unique Identifier of the Record. Mention the Form 1099-DIV 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.
    Recipient object Object to identify the recipient details.
        RecipientId Guid A 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
        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: 9
        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: "US", "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
Size Range: 9
        Email string Recipient's email address.
Size Range: 0..40
        Fax string Optional Recipient's Fax number.
Size Range: 10
        Phone string Recipient's Phone Number.
Size Range: 15
    DIVFormData object Object to create 1099-DIV.
        B1aTotOrdiDiv number Gets dividends, including dividends from money market funds, net short-term capital gains from mutual funds, and other distributions on stock.
Size Range: 0-9999999999.99
        B1bQualiDiv number Gets the portion of the dividends in box 1a that qualifies for the reduced capital gains rates.
Size Range: 0-9999999999.99
        B2aTotCapGain number Get total capital gain distributions (long-term). Include all amounts shown in boxes 2b, 2c, 2d, and 2f.
Size Range: 0-9999999999.99
        B2bUnRecapSec1250Gain number Get any amount included in box 2a that is an unrecaptured section 1250 gain from certain depreciable real property.
Size Range: 0-9999999999.99
        B2cSec1202Gain number Get any amount included in box 2a that is a section 1202 gain from certain qualified small business stock.
Size Range: 0-9999999999.99
        B2dCollGain number Get any amount included in box 2a that is a 28% rate gain from sales or exchanges of collectibles.
Size Range: 0-9999999999.99
        B2eSec897OrdiDiv number Get any amount included in box 1a that is section 897 gain from dispositions of USRPI.
Size Range: 0-9999999999.99
        B2fSec897CapGain number Get any amount included in box 2a that is section 897 gain from dispositions of USRPI.
Size Range: 0-9999999999.99
        B3NonDivDistri number Get nondividend distributions, if determinable.
Size Range: 0-9999999999.99
        B4FedIncTaxWH number Get the backup withholding, for the payments reported in box1, box 2 and box 8 of this form.
Size Range: 0-9999999999.99
        B5Sec199ADiv number Get the qualified REIT dividends paid by a REIT or section 199A dividends paid by a RIC to the recipient.
Size Range: 0-9999999999.99
        B6InvestExp number Get the recipient's pro rata share of certain amounts deductible by a nonpublicly offered RIC in computing its taxable income.
Size Range: 0-9999999999.99
        B7ForeignTaxPaid number Get foreign tax paid on dividends and other distributions on stock.
Size Range: 0-9999999999.99
        B8ForeignCountryOrUsPoss number Get the name of the foreign country or U.S. possession for which the foreign tax was paid and reported in box 7.
Size Range: 40
        B9CashLiquiDistri number Get cash distributed as part of a liquidation.
Size Range: 0-9999999999.99
        B10NonCashLiquiDistri number Get noncash distributions made as part of a liquidation. Show the fair market value as of the date of distribution.
Size Range: 0-9999999999.99
        B11ExemptIntDiv number Get exempt-interest dividends from a mutual fund or other RIC. Include specified private activity bond interest dividends in box 12 and in the total for box 11.
Size Range: 0-9999999999.99
        B12SpeciPrivActiBondIntDiv number Get exempt-interest dividends paid by a RIC on specified private activity bonds to the extent that the dividends are attributable to interest on the bonds received by the RIC minus an allocable share of the expenses.
Size Range: 0-9999999999.99
        IsFATCA Boolean When true, identifies a U.S. payer reporting on Form(s) 1099 (including reporting payments on this Form 1099-Div) to satisfy their foreign financial asset reporting requirement with respect to a U.S. account.
        AccountNum string Account number of Payer having multiple accounts for a recipient for whom more than one Form 1099-Div is filed.
Size Range: 4..20
        Is2ndTINnot Boolean When true, identifies a Payer who is notified by the IRS twice within 3 calendar years for providing an incorrect TIN and do not want the IRS to send any more notices.
        States object[] Contains list of state returns information.
            StateCd string State Code.
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"
            StateIdNum string Identification Number of State.
Size Range: ..20
            StateWH number Income tax amount withheld for State.
Size Range: 0-9999999999.99

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.
Form1099Type string Denotes the type of 1099 form.
Form1099Records object Pulls Form 1099-DIV records with Success and Error statuses
    SuccessRecords object[] It will show detailed information about the success status of Form 1099-DIV 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 1099-DIV return is created.
        RecipientId Guid A unique identifier generated by TaxBandits for a Recipient when a 1099-DIV return is created. You can use this id for your future reference to Update.
        AccountNum string Account number of Payer having multiple accounts for a recipient for whom more than one Form 1099-Div 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.
        StateReturns object[] Returns collection of state returns information
            StateCd string Returns the state code of the state for which the return is filed.
            Status string Returns the record status of the state return.
            StatusTs string Date and time of the return created.
            Info string Returns the information about the state for which we are not supporting state filing.
            Errors object[] Shows error information in state returns of Form 1099-DIV
                Id string Returns the validation error Id.
                Name string Name of the validation error.
                Message string Description of the validation error.
        Postal object Returns the status and StatusTs of postal mailing service for Form 1099-DIV.
            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 1099-DIV 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 1099 Records.
        RecordId Guid Unique identifier of a record
        SequenceId string A unique number given by an inbound application to identify failed records
        RejectedBy string Returns the information of who rejected the return.
        Errors object[] Shows detailed error information
            Code string Returns the validation error code
            Name string Name of the validation error
            Message string Description of the validation error
            Type string Type of validation error
Errors object[] Shows detailed error information
    Code string Returns the validation error code
    Name string Name of the validation error
    Message string Description of the validation error
    Type string Type of validation error

Request JSON

{
   "SubmissionManifest": {
       "SubmissionId": "4d77ce45-1584-45a9-a775-75513f9d3ea5",
       "TaxYear": "2021",
       "IsFederalFiling": true,
       "IsStateFiling": true,
       "IsPostal": true,
       "IsOnlineAccess": true,
       "IsScheduleFiling": true,
       "ScheduleFiling": {
           "EfileDate": "12/25/2021"
       }
   },
   "ReturnHeader": {
      "Business": {
          "BusinessId": "642ac4d4-a137-46d7-88d1-1fda1f539b33",
          "BusinessNm": "Brian LLC",
          "TradeNm": "Brian LLC",
          "IsEIN": true,
          "EINorSSN": "409908158",
          "Email": "john@gmail.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": "d03e1ebb-4f86-4767-b980-723559369e24",
           "SequenceId": "1",
           "Recipient": {
               "RecipientId": "36964329-a1be-4588-9cdd-7fd41de3cccb",
               "TINType": "SSN",
               "TIN": "223014579",
               "FirstPayeeNm": "Mark",
               "SecondPayeeNm": "Stephie",
               "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": "john@gmail.com",
               "Fax": "1234567890",
               "Phone": "1234567890"
           },
           "DIVFormData": {
               "B1aTotOrdiDiv": 400.00,
               "B1bQualiDiv": 200.00,
               "B2aTotCapGain": 2227.00,
               "B2bUnRecapSecGain": 41.55,
               "B2cSec1202Gain": 42.55,
               "B2dCollGain": 48.55,
               "B2eSect897OrdiDiv": 50.55,
               "B2fSect897CapGain": 3.55,
               "B3NonDivDistri": 43.55,
               "B4FedIncTaxWH": 44.55,
               "B5Sec199ADiv": 45.55,
               "B6InvestExp": 46.55,
               "B7ForeginTaxPaid": 70.55,
               "B8ForeginCntryOrUsPoss": "yes",
               "B9CashLiquiDis": 80.55,
               "B10NonCashLiquiDis": 90.55,
               "B11ExemptInvstDiv": 410.55,
               "B12SpeciPrivActiBondInvstDiv": 420.5,
               "IsFATCA": true,
               "Is2ndTINnot": true,
               "AccountNum": "20123130000009000001",
               "States": [
                   {
                       "StateCd": "PA",
                       "StateIdNum": "99999999",
                       "StateWH": 15
                   },
                   {
                       "StateCd": "AZ",
                       "StateIdNum": "99-9999999",
                       "StateWH": 17
                   }
               ]
           }
       }
   ]
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120

Response JSON

{
   "StatusCode": 200,
   "StatusName": "Ok",
   "StatusMessage": "Successful API call",
   "SubmissionId": "4d77ce45-1584-45a9-a775-75513f9d3ea5",
   "BusinessId": "642ac4d4-a137-46d7-88d1-1fda1f539b33",
   "Form1099Type": "DIV",
   "Form1099Records": {
       "SuccessRecords": [
           {
               "SequenceId": "1",
               "RecordId": "d03e1ebb-4f86-4767-b980-723559369e24",
               "RecipientId": "36964329-a1be-4588-9cdd-7fd41de3cccb",
               "AccountNum": "20123130000009000001",
               "FederalReturn": {
                   "Status": "CREATED",
                   "StatusTs": "2021-11-25 05:26:27 -05:00",
                   "Info": null
               },
               "StateReturns": [
                   {
                       "StateCd": "PA",
                       "Status": "NA",
                       "StatusTs": null,
                       "Info": "This service will be available soon",
                       "Errors": null
                   },
                   {
                       "StateCd": "AZ",
                       "Status": "NA",
                       "StatusTs": null,
                       "Info": "This service will be available soon",
                       "Errors": null
                   }
               ],
               "Postal": {
                   "Status": "CREATED",
                   "StatusTs": "2021-11-25 05:26:27 -05:00",
                   "Info": null
               },
               "OnlineAccess": {
                   "Status": "CREATED",
                   "Email": "john@gmail.com",
                   "Info": null
               },
               "ScheduleFiling": {
                   "ScheduledOn": null,
                   "Info": "This Service will be available soon"
               }
           }
       ],
       "ErrorRecords": null
   },
   "Errors": null
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55

# Validate

Executes business and data validation checks for the 1099-DIV returns already created in API. Use the Submission ID and Record IDs of the return to validate.

GET Form1099DIV/Validate
1

Request Body

Field Type Description
SubmissionId Guid Unique identifier of a submission
RecordIds Guid[] unique identifier generated by TaxBandits when a 1099-DIV return is created. Mention the 1099-DIV return's Record ID that you want to Validate.

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
Form1099Records object Pulls the Form 1099-DIV records with Success and Error statuses
    SuccessRecords object[] It will show the detailed information about the success status of Form 1099 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 Record ID of the returns that were successfully validated.
        Status string Returns the status of the records.
        StatusTs string Date and time of return created.
    ErrorRecords object[] It will show the detailed information about the error status of Form 1099 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 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

Request JSON

Form1099DIV/Validate?SubmissionId=4d77ce45-1584-45a9-a775-75513f9d3ea5&RecordIds=d03e1ebb-4f86-4767-b980-723559369e24
1

Response JSON

{
   "StatusCode": 200,
   "StatusName": "Ok",
   "StatusMessage": "Successful API call",
   "SubmissionId": "4d77ce45-1584-45a9-a775-75513f9d3ea5",
   "Form1099Records": {
       "SuccessRecords": [
           {
               "SequenceId": "1",
               "RecordId": "d03e1ebb-4f86-4767-b980-723559369e24",
               "Status": "CREATED",
               "StatusTs": "2021-11-25 05:26:27 -05:00",
               "StateReturns": null
           }
       ],
       "ErrorRecords": null
   },
   "Errors": null
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19

# ValidateForm

Validates the Forms in the request against IRS Business rules and field specification without creating the returns in TaxBandits.

POST Form1099Div/ValidateForm
1

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 Guid Unique identifier created by TaxBandits for each submission. Not required when you are creating a return.
    TaxYear string Tax year of Form 1099-DIVto be filed..
Allowed values: "2021"
    IsFederalFiling Boolean Federal Filing for the return will be enabled when the value is True. Form 1099-DIV will be sent directly to the IRS.
    IsStateFiling Boolean State Filing for the return will be enabled when the value is True. Form 1099-DIV 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 Postal Order will be created when the value is set as True. Once the return is Transmitted, Form 1099-DIV Recipient copies will be postal mailed to the recipient's address via USPS. Note: Postal Order for Foreign address will not be created.
    IsOnlineAccess Boolean Online Access will be enabled when the value is set as True. Once the return is Transmitted, an email with the link to the secure TaxBandits portal will be sent to the Recipient. The recipient can provide consent and download Form 1099-DIV Recipient copies from the portal.
    IsScheduleFiling Boolean When true, schedule filing services will be provided for Form 1099-DIV 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/2021 or 10-20-2021
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: ..80
        TradeNm string Optional Name under which the business operates
Size Range: ..80
        IsEIN Boolean When true, identify that the business TIN is 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 Email address of the Business
Size Range: ..40
        ContactNm string Optional Name of the person who can be contacted by the IRS.
Size Range: ..27
        Phone string 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/1099 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 1099-DIV and 94X series
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 1099-DIV and 94X series
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: 9
        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: "US", "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
Size Range: 9
ReturnData object[] Contains information about the recipient details and Form 1099-DIV details.
    RecordId Guid Unique identifier of a record. Not required when you are creating a return.
    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
    Recipient object Object to identify the recipient details.
        RecipientId Guid TaxBandits generates a unique ID for each recipient after the return is created and 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
        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: 9
        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: "US", "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
Size Range: 9
        Email string Recipient's email address.
Size Range: 0..40
        Fax string Optional Recipient's Fax number.
Size Range: 10
        Phone string Recipient's Phone Number.
Size Range: 15
    DIVFormData object Object to create 1099-DIV.
        B1aTotOrdiDiv number Gets dividends, including dividends from money market funds, net short-term capital gains from mutual funds, and other distributions on stock.
Size Range: 0-9999999999.99
        B1bQualiDiv number Gets the portion of the dividends in box 1a that qualifies for the reduced capital gains rates.
Size Range: 0-9999999999.99
        B2aTotCapGain number Get total capital gain distributions (long-term). Include all amounts shown in boxes 2b, 2c, 2d, and 2f.
Size Range: 0-9999999999.99
        B2bUnRecapSec1250Gain number Get any amount included in box 2a that is an unrecaptured section 1250 gain from certain depreciable real property.
Size Range: 0-9999999999.99
        B2cSec1202Gain number Get any amount included in box 2a that is a section 1202 gain from certain qualified small business stock.
Size Range: 0-9999999999.99
        B2dCollGain number Get any amount included in box 2a that is a 28% rate gain from sales or exchanges of collectibles.
Size Range: 0-9999999999.99
        B2eSec897OrdiDiv number Get any amount included in box 1a that is section 897 gain from dispositions of USRPI.
Size Range: 0-9999999999.99
        B2fSec897CapGain number Get any amount included in box 2a that is section 897 gain from dispositions of USRPI.
Size Range: 0-9999999999.99
        B3NonDivDistri number Get nondividend distributions, if determinable.
Size Range: 0-9999999999.99
        B4FedIncTaxWH number Get the backup withholding, for the payments reported in box1, box 2 and box 8 of this form.
Size Range: 0-9999999999.99
        B5Sec199ADiv number Get the qualified REIT dividends paid by a REIT or section 199A dividends paid by a RIC to the recipient.
Size Range: 0-9999999999.99
        B6InvestExp number Get the recipient's pro rata share of certain amounts deductible by a nonpublicly offered RIC in computing its taxable income.
Size Range: 0-9999999999.99
        B7ForeignTaxPaid number Get foreign tax paid on dividends and other distributions on stock.
Size Range: 0-9999999999.99
        B8ForeignCountryOrUsPoss number Get the name of the foreign country or U.S. possession for which the foreign tax was paid and reported in box 7.
Size Range: 40
        B9CashLiquiDistri number Get cash distributed as part of a liquidation.
Size Range: 0-9999999999.99
        B10NonCashLiquiDistri number Get noncash distributions made as part of a liquidation. Show the fair market value as of the date of distribution.
Size Range: 0-9999999999.99
        B11ExemptIntDiv number Get exempt-interest dividends from a mutual fund or other RIC. Include specified private activity bond interest dividends in box 12 and in the total for box 11.
Size Range: 0-9999999999.99
        B12SpeciPrivActiBondIntDiv number Get exempt-interest dividends paid by a RIC on specified private activity bonds to the extent that the dividends are attributable to interest on the bonds received by the RIC minus an allocable share of the expenses.
Size Range: 0-9999999999.99
        IsFATCA Boolean When true, identifies a U.S. payer reporting on Form(s) 1099 (including reporting payments on this Form 1099-Div) to satisfy their foreign financial asset reporting requirement with respect to a U.S. account.
        AccountNum string Account number of Payer having multiple accounts for a recipient for whom more than one Form 1099-Div is filed.
Size Range: 4..20
        Is2ndTINnot Boolean When true, identifies a Payer who is notified by the IRS twice within 3 calendar years for providing an incorrect TIN and do not want the IRS to send any more notices.
        States object[] Contains list of state returns information.
            StateCd string State Code.
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"
            StateIdNum string Identification Number of State.
Size Range: ..20
            StateWH number Income tax amount withheld for State.
Size Range: 0-9999999999.99

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
Errors object[] Shows detailed error information
    Id string Returns the validation error code
    Name string Name of the validation error
    Message string Description of the validation error

Request JSON

{
   "SubmissionManifest": {
       "TaxYear": "2021",
       "IsFederalFiling": true,
       "IsStateFiling": true,
       "IsPostal": true,
       "IsOnlineAccess": true,
       "IsScheduleFiling": true,
       "ScheduleFiling": {
           "EfileDate": "12/25/2021"
       }
   },
   "ReturnHeader": {
      "Business": {
          "BusinessId": null,
          "BusinessNm": "Brian LLC",
          "TradeNm": "Brian LLC",
          "IsEIN": true,
          "EINorSSN": "409908158",
          "Email": "john@gmail.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": null,
           "SequenceId": "1",
           "Recipient": {
               "RecipientId": null,
               "TINType": "SSN",
               "TIN": "223014579",
               "FirstPayeeNm": "Mark",
               "SecondPayeeNm": "Stephie",
               "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": "john@gmail.com",
               "Fax": "1234567890",
               "Phone": "1234567890"
           },
           "DIVFormData": {
               "B1aTotOrdiDiv": 400.00,
               "B1bQualiDiv": 200.00,
               "B2aTotCapGain": 2227.00,
               "B2bUnRecapSecGain": 41.55,
               "B2cSec1202Gain": 42.55,
               "B2dCollGain": 48.55,
               "B2eSect897OrdiDiv": 50.55,
               "B2fSect897CapGain": 3.55,
               "B3NonDivDistri": 43.55,
               "B4FedIncTaxWH": 44.55,
               "B5Sec199ADiv": 45.55,
               "B6InvestExp": 46.55,
               "B7ForeginTaxPaid": 70.55,
               "B8ForeginCntryOrUsPoss": "yes",
               "B9CashLiquiDis": 80.55,
               "B10NonCashLiquiDis": 90.55,
               "B11ExemptInvstDiv": 410.55,
               "B12SpeciPrivActiBondInvstDiv": 420.5,
               "IsFATCA": true,
               "Is2ndTINnot": true,
               "AccountNum": "20123130000009000001",
               "States": [
                   {
                       "StateCd": "PA",
                       "StateIdNum": "99999999",
                       "StateWH": 15
                   },
                   {
                       "StateCd": "AZ",
                       "StateIdNum": "99-9999999",
                       "StateWH": 17
                   }
               ]
           }
       }
   ]
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119

Response JSON

 {
 "StatusCode": 200,
 "StatusName": "Ok",
 "StatusMessage": "Successful API call",
 "Errors": null
}
1
2
3
4
5
6

← Form1099G →