Version: 1.7.0

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

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: ..75
FirstNm	string	First Name of the Individual Size Range: ..20
MiddleNm	string	Middle Name of the Individual Size Range: ..20
LastNm	string	Last Name of the Individual Size Range: ..20
Suffix	string	Suffix of the Individual Allowed values "Jr", "Sr", "I", "II", "III", "IV", "V", "VI", "VII"
PayerRef	string	Optional An unique identifier for each payer completing their information. This identifier can be used in future references of the payer in the API. Size Range: ..50
TradeNm	string	Optional Name under which the business operates Size Range: ..75
IsEIN	Boolean	When true, 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-11
Email	string	Optional Email address of the Business Size Range: ..100
ContactNm	string	Optional Name of the person who can be contacted by the IRS. Size Range: ..27
Phone	string	Optional Phone number of the business Size Range: 10
PhoneExtn	string	Optional Extension of the business phone number Size Range: ..5
Fax	string	Optional Fax number of the Business Size Range: 10
BusinessType	string	Optional Type of business. Optional for W-2/1099 and mandatory for 94X series Size Range: 4 Allowed values "ESTE", "PART", "CORP", "EORG", "SPRO" For the description of the Allowed Values , click here
SigningAuthority	object	Optional Details of the person who is authorized to sign the return
Name	string	Optional Name of the signing authority Size Range: ..35
Phone	string	Optional Phone number of the signing authority Size Range: 10
BusinessMemberType	string	Optional Business title of the signing authority Size Range: 5..29 Allowed values "CORPORATESECRETARY", "SECRETARYTREASURER", "PARTNER", "GENERALPARTNER", "LIMITEDPARTNER", "LLCMEMBER", "MANAGINGMEMBER", "MANAGER", "TAXMATTERPARTNER", "PRESIDENT", "VICEPRESIDENT", "CORPORATETREASURER", "TREASURER", "ASSISTANTTREASURER", "CHIEFACCOUNTINGOFFICER", "CHIEFEXECUTIVEOFFICER", "CHIEFFINANCIALOFFICER", "TAXOFFICER", "CHIEFOPERATINGOFFICER", "CORPORATEOFFICER", "EXECUTIVEDIRECTOR", "DIRECTOR", "CHAIRMAN", "EXECUTIVEADMINISTRATOR", "RECEIVER", "PASTOR", "ASSISTANTTORELIGIOUSLEADER", "REVEREND", "PRIEST", "MINISTER", "RABBI", "LEADEROFRELIGIOUSORGANIZATION", "SECRETARY", "DIRECTOROFTAXATION", "DIRECTOROFPERSONNEL", "ADMINISTRATOR", "EXECUTOR", "TRUSTEE", "FIDUCIARY", "OWNER", "SOLEPROPRIETOR", "MEMBER", "SOLEMEMBER"
KindOfEmployer	string	Optional Identifies the kind of employer. Mandatory for W-2 and optional for 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: ..46
Address2	string	Optional Employer/Payer's suite or apartment Size Range: ..46
City	string	Employer/Payer's city Size Range: ..46
State	string	Employer/Payer's state code. Refer Static values. Size Range: 2 Allowed values "AL", "AK", "AZ", "AR", "CA", "CO", "CT", "DE", "DC", "FL", "GA", "HI", "ID", "IL", "IN", "IA", "KS", "KY", "LA", "ME", "MD", "MA", "MI", "MN", "MS", "MO", "MT", "NE", "NV", "NH", "NJ", "NM", "NY", "NC", "ND", "OH", "OK", "OR", "PA", "RI", "SC", "SD", "TN", "TX", "UT", "VT", "VA", "WA", "WV", "WI", "WY", "AS", "FM", "GU", "MH", "MP", "PW", "PR", "VI", "AA", "AE", "AP"
ZipCd	string	Employer/Payer's zip code Size Range: 5..10
ForeignAddress	object	If IsForeign is true, pass foreign address of the business
Address1	string	Employer/Payer's foreign address (street address or post office box of that locality) Size Range: ..50
Address2	string	Optional Employer/Payer's suite or apartment Size Range: ..50
City	string	Employer/Payer's city Size Range: ..50
ProvinceOrStateNm	string	Employer/Payer's province or state name Size Range: ..50
Country	string	Employer/Payer's country Size Range: 2 Allowed values "AF", "AX", "AL", "AG", "AQ", "AN", "AO", "AV", "AY", "AC", "AR", "AM", "AA", "AT", "AS", "AU", "AJ", "BF", "BA", "FQ", "BG", "BB", "BO", "BE", "BH", "BN", "BD", "BT", "BL", "BK", "BC", "BV", "BR", "IO", "VI", "BX", "BU", "UV", "BM", "BY", "CB", "CM", "CA", "CV", "CJ", "CT", "CD", "CI", "CH", "KT", "IP", "CK", "CO", "CN", "CF", "CG", "CW", "CR", "CS", "IV", "HR", "CU", "UC", "CY", "EZ", "DA", "DX", "DJ", "DO", "DR", "TT", "EC", "EG", "ES", "EK", "ER", "EN", "ET", "FK", "FO", "FM", "FJ", "FI", "FR", "FP", "FS", "GB", "GA", "GG", "GM", "GH", "GI", "GR", "GL", "GJ", "GQ", "GT", "GK", "GV", "PU", "GY", "HA", "HM", "VT", "HO", "HK", "HQ", "HU", "IC", "IN", "ID", "IR", "IZ", "EI", "IS", "IT", "JM", "JN", "JA", "DQ", "JE", "JQ", "JO", "KZ", "KE", "KQ", "KR", "KN", "KS", "KV", "KU", "KG", "LA", "LG", "LE", "LT", "LI", "LY", "LS", "LH", "LU", "MC", "MK", "MA", "MI", "MY", "MV", "ML", "MT", "IM", "RM", "MR", "MP", "MX", "MQ", "MD", "MN", "MG", "MJ", "MH", "MO", "MZ", "WA", "NR", "BQ", "NP", "NL", "NC", "NZ", "NU", "NG", "NI", "NE", "NF", "CQ", "NO", "MU", "OC", "PK", "PS", "LQ", "PM", "PP", "PF", "PA", "PE", "RP", "PC", "PL", "PO", "RQ", "QA", "RO", "RS", "RW", "TB", "RN", "WS", "SM", "TP", "SA", "SG", "RI", "SE", "SL", "SN", "NN", "LO", "SI", "BP", "SO", "SF", "SX", "OD", "SP", "PG", "CE", "SH", "SC", "ST", "SB", "VC", "SU", "NS", "SV", "WZ", "SW", "SZ", "SY", "TW", "TI", "TZ", "TH", "TO", "TL", "TN", "TD", "TS", "TU", "TX", "TK", "TV", "UG", "UP", "AE", "UK", "UY", "UZ", "NH", "VE", "VM", "VQ", "WQ", "WF", "WI", "YM", "ZA", "ZI"
PostalCd	string	Employer/Payer's postal code Size Range: ..16
ReturnData	object[]	Contains information about the recipient details and Form 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	OptionalUnique 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	OptionalA unique ID generated by TaxBandits after the return is created and will be returned in the Response. You can use this id for your future reference to Update.
TINType	string	Specify the TIN type of the recipient. Note: If the recipient doesn't have a TIN, enter the TIN type as 'NA' and input 'null' in the TIN field. Allowed values "SSN", "EIN", "ITIN", "ATIN", "NA"
TIN	string	Enter the nine-digit taxpayer identification number of the Recipient (SSN, ITIN, ATIN, or EIN). Size Range: 9-11
FirstPayeeNm	string	Enter the name of the recipient (preferably last name first for an Individual). If more space is required for the name, use the Second Payee Name Field. Size Range: 40
SecondPayeeNm	string	Optional If there are multiple recipients (for example, partners, joint owners, or spouses), use this field for those names not associated with the TIN or if not enough space was provided in the First Payee Name, continue the name in this field. Size Range: 40
FirstNm	string	First Name of the Individual Size Range: ..20
MiddleNm	string	Middle Name of the Individual Size Range: ..20
LastNm	string	Last Name of the Individual Size Range: ..20
Suffix	string	Suffix of the Individual Allowed values "Jr", "Sr", "I", "II", "III", "IV", "V", "VI", "VII"
IsForeign	Boolean	When true, it identifies the recipient's address with a foreign address.
USAddress	object	If IsForeign is false, pass US address of the recipient
Address1	string	Recipient's US address (street address or post office box of that locality) Size Range: ..46
Address2	string	Optional Recipient's suite or apartment Size Range: ..46
City	string	Recipient's city Size Range: ..50
State	string	Recipient's state code. Refer Static values. Size Range: 2 Allowed values "AL", "AK", "AZ", "AR", "CA", "CO", "CT", "DE", "DC", "FL", "GA", "HI", "ID", "IL", "IN", "IA", "KS", "KY", "LA", "ME", "MD", "MA", "MI", "MN", "MS", "MO", "MT", "NE", "NV", "NH", "NJ", "NM", "NY", "NC", "ND", "OH", "OK", "OR", "PA", "RI", "SC", "SD", "TN", "TX", "UT", "VT", "VA", "WA", "WV", "WI", "WY", "AS", "FM", "GU", "MH", "MP", "PW", "PR", "VI", "AA", "AE", "AP"
ZipCd	string	Recipient's zip code Size Range: 5..10
ForeignAddress	object	If IsForeign is true, pass foreign address of the recipient
Address1	string	Recipient's foreign address (street address or post office box of that locality) Size Range: ..50
Address2	string	Optional Recipient's suite or apartment Size Range: ..50
City	string	Recipient's city. Size Range: ..50
ProvinceOrStateNm	string	Recipient's Province or State Name. Size Range: ..50
Country	string	Recipient's country code. Refer Static values. Size Range: 2 Allowed values "AF", "AX", "AL", "AG", "AQ", "AN", "AO", "AV", "AY", "AC", "AR", "AM", "AA", "AT", "AS", "AU", "AJ", "BF", "BA", "FQ", "BG", "BB", "BO", "BE", "BH", "BN", "BD", "BT", "BL", "BK", "BC", "BV", "BR", "IO", "VI", "BX", "BU", "UV", "BM", "BY", "CB", "CM", "CA", "CV", "CJ", "CT", "CD", "CI", "CH", "KT", "IP", "CK", "CO", "CN", "CF", "CG", "CW", "CR", "CS", "IV", "HR", "CU", "UC", "CY", "EZ", "DA", "DX", "DJ", "DO", "DR", "TT", "EC", "EG", "ES", "EK", "ER", "EN", "ET", "FK", "FO", "FM", "FJ", "FI", "FR", "FP", "FS", "GB", "GA", "GG", "GM", "GH", "GI", "GR", "GL", "GJ", "GQ", "GT", "GK", "GV", "PU", "GY", "HA", "HM", "VT", "HO", "HK", "HQ", "HU", "IC", "IN", "ID", "IR", "IZ", "EI", "IS", "IT", "JM", "JN", "JA", "DQ", "JE", "JQ", "JO", "KZ", "KE", "KQ", "KR", "KN", "KS", "KV", "KU", "KG", "LA", "LG", "LE", "LT", "LI", "LY", "LS", "LH", "LU", "MC", "MK", "MA", "MI", "MY", "MV", "ML", "MT", "IM", "RM", "MR", "MP", "MX", "MQ", "MD", "MN", "MG", "MJ", "MH", "MO", "MZ", "WA", "NR", "BQ", "NP", "NL", "NC", "NZ", "NU", "NG", "NI", "NE", "NF", "CQ", "NO", "MU", "OC", "PK", "PS", "LQ", "PM", "PP", "PF", "PA", "PE", "RP", "PC", "PL", "PO", "RQ", "QA", "RO", "RS", "RW", "TB", "RN", "WS", "SM", "TP", "SA", "SG", "RI", "SE", "SL", "SN", "NN", "LO", "SI", "BP", "SO", "SF", "SX", "OD", "SP", "PG", "CE", "SH", "SC", "ST", "SB", "VC", "SU", "NS", "SV", "WZ", "SW", "SZ", "SY", "TW", "TI", "TZ", "TH", "TO", "TL", "TN", "TD", "TS", "TU", "TX", "TK", "TV", "UG", "UP", "AE", "UK", "UY", "UZ", "NH", "VE", "VM", "VQ", "WQ", "WF", "WI", "YM", "ZA", "ZI"
PostalCd	string	Recipient's Postal Code Size Range: ..16
Email	string	Optional Recipient's email address. Size Range: 0..100 Note : This email address cannot be the same for two different recipients under the same business.
Fax	string	Optional Recipient's Fax number. Size Range: 10
Phone	string	Optional Recipient's Phone Number. Size Range: 15
DIVFormData	object	Recipient's Form 1099-DIV information.
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
B2bUnRecapSecGain	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
B3NonDivDist	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 Note : Box 4 should be less than 40% of box 1a.
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	string	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
B9CashLiquiDist	number	Get cash distributed as part of a liquidation. Size Range: 0-9999999999.99
B10NonCashLiquiDist	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

Request JSON

Sample 1
Sample 2

Created a Form 1099-DIV return for the specific Business, including recipient and income information. Now, update the Recipient/Form Details with RecipientId and RecordId.

{
  "SubmissionManifest": {
    "SubmissionId": "c03feb88-d8a1-4080-8bc6-4e6adec1bba5",
    "TaxYear": "2021",
    "IsFederalFiling": true,
    "IsPostal": true,
    "IsOnlineAccess": true,
    "IsScheduleFiling": false,
    "ScheduleFiling": null
  },
  "ReturnHeader": {
    "Business": {
      "BusinessId": "8d177248-992e-4ca5-ba9e-1a5a8a93db56",
      "BusinessNm": "Snowdaze LLC",
      "FirstNm": null,
      "MiddleNm": null,
      "LastNm": null,
      "Suffix": null,
      "PayerRef": "Snow123",
      "TradeNm": "Iceberg Icecreams",
      "IsEIN": true,
      "EINorSSN": "71-3787159",
      "Email": "james@sample.com",
      "ContactNm": null,
      "Phone": "6634567890",
      "PhoneExtn": "12345",
      "Fax": "6634567890",
      "BusinessType": "ESTE",
      "SigningAuthority": null,
      "KindOfEmployer": "FederalGovt",
      "KindOfPayer": "REGULAR941",
      "IsBusinessTerminated": true,
      "IsForeign": false,
      "USAddress": {
        "Address1": "3576 AIRPORT WAY",
        "Address2": "UNIT 9",
        "City": "FAIRBANKS",
        "State": "AK",
        "ZipCd": "99709"
      },
      "ForeignAddress": null
    }
  },
  "ReturnData": [
    {
      "SequenceId": "1",
      "IsPostal": true,
      "IsOnlineAccess": true,
      "RecordId": "488b1c7e-d244-4d6a-8491-65ae2209a99f",
      "Recipient": {
        "RecipientId": "472079fb-2dcf-4228-8548-73656ddafc30",
        "TINType": "EIN",
        "TIN": "36-3814579",
        "FirstPayeeNm": "Dairy Delights LLC",
        "SecondPayeeNm": "Coco Milk",
        "FirstNm": null,
        "MiddleNm": null,
        "LastNm": null,
        "Suffix": null,
        "IsForeign": true,
        "USAddress": null,
        "ForeignAddress": {
          "Address1": "120 Bremner Blvd",
          "Address2": "Suite 800",
          "City": "Toronto",
          "ProvinceOrStateNm": "Ontario",
          "Country": "CA",
          "PostalCd": "4168682600"
        },
        "Email": "shawn@sample.com",
        "Fax": "6834567890",
        "Phone": "7634567890"
      },
      "DIVFormData": {
        "B1aTotOrdiDiv": 400,
        "B1bQualiDiv": 200,
        "B2aTotCapGain": 2227,
        "B2bUnRecapSecGain": 41.55,
        "B2cSec1202Gain": 42.55,
        "B2dCollGain": 48.55,
        "B2eSec897OrdiDiv": 50.55,
        "B2fSec897CapGain": 3.55,
        "B3NonDivDist": 43.55,
        "B4FedIncTaxWH": 44.55,
        "B5Sec199ADiv": 45.55,
        "B6InvestExp": 46.55,
        "B7ForeignTaxPaid": 70.55,
        "B8ForeignCountryOrUsPoss": "canada",
        "B9CashLiquiDist": 80.55,
        "B10NonCashLiquiDist": 90.55,
        "B11IsFATCA": true,
        "B12ExemptIntDiv": 40748.55,
        "B13SpeciPrivActiBondIntDiv": 23740.5,
        "Is2ndTINnot": true,
        "AccountNum": "20123130000009000001",
        "States": [
          {
            "StateCd": "PA",
            "StateIdNum": "99999999",
            "StateWH": 15
          },
          {
            "StateCd": "AZ",
            "StateIdNum": "99-9999999",
            "StateWH": 17
          }
        ]
      }
    }
  ]
}

Created a Form 1099-DIV return for the specific Business, including recipient and income information. Now, create a new Recipient/Form without RecipientId and RecordId.

{
  "SubmissionManifest": {
    "SubmissionId": "c03feb88-d8a1-4080-8bc6-4e6adec1bba5",
    "TaxYear": "2021",
    "IsFederalFiling": true,
    "IsPostal": true,
    "IsOnlineAccess": true,
    "IsScheduleFiling": false,
    "ScheduleFiling": null
  },
  "ReturnHeader": {
    "Business": {
      "BusinessId": null,
      "BusinessNm": "Snowdaze LLC",
      "FirstNm": null,
      "MiddleNm": null,
      "LastNm": null,
      "Suffix": null,
      "PayerRef": "Snow123",
      "TradeNm": "Iceberg Icecreams",
      "IsEIN": true,
      "EINorSSN": "71-3787159",
      "Email": "james@sample.com",
      "ContactNm": null,
      "Phone": "6634567890",
      "PhoneExtn": "12345",
      "Fax": "6634567890",
      "BusinessType": "ESTE",
      "SigningAuthority": null,
      "KindOfEmployer": "FederalGovt",
      "KindOfPayer": "REGULAR941",
      "IsBusinessTerminated": true,
      "IsForeign": false,
      "USAddress": {
        "Address1": "3576 AIRPORT WAY",
        "Address2": "UNIT 9",
        "City": "FAIRBANKS",
        "State": "AK",
        "ZipCd": "99709"
      },
      "ForeignAddress": null
    }
  },
  "ReturnData": [
    {
      "SequenceId": "1",
      "IsPostal": true,
      "IsOnlineAccess": true,
      "RecordId": null,
      "Recipient": {
        "RecipientId": null,
        "TINType": "EIN",
        "TIN": "36-3814579",
        "FirstPayeeNm": "Dairy Delights LLC",
        "SecondPayeeNm": "Coco Milk",
        "FirstNm": null,
        "MiddleNm": null,
        "LastNm": null,
        "Suffix": null,
        "IsForeign": true,
        "USAddress": null,
        "ForeignAddress": {
          "Address1": "120 Bremner Blvd",
          "Address2": "Suite 800",
          "City": "Toronto",
          "ProvinceOrStateNm": "Ontario",
          "Country": "CA",
          "PostalCd": "4168682600"
        },
        "Email": "shawn@sample.com",
        "Fax": "6834567890",
        "Phone": "7634567890"
      },
        "DIVFormData": {
            "B1aTotOrdiDiv": 400.00,
            "B1bQualiDiv": 200.00,
            "B2aTotCapGain": 2227.00,
            "B2bUnRecapSecGain": 41.55,
            "B2cSec1202Gain": 42.55,
            "B2dCollGain": 48.55,
            "B2eSec897OrdiDiv": 50.55,
            "B2fSec897CapGain": 3.55,
            "B3NonDivDist": 43.55,
            "B4FedIncTaxWH": 44.55,
            "B5Sec199ADiv": 45.55,
            "B6InvestExp": 46.55,
            "B7ForeignTaxPaid": 70.55,
            "B8ForeignCountryOrUsPoss": "canada",
            "B9CashLiquiDist": 80.55,
            "B10NonCashLiquiDist": 90.55,
            "B11IsFATCA": true,
            "B12ExemptIntDiv": 40748.55,
            "B13SpeciPrivActiBondIntDiv": 23740.5,
            "Is2ndTINnot": true,
            "AccountNum": "20123130000009000001",
            "States": [
                {
                    "StateCd": "PA",
                    "StateIdNum": "99999999",
                    "StateWH": 15
                },
                {
                    "StateCd": "AZ",
                    "StateIdNum": "99-9999999",
                    "StateWH": 17
                }
            ]
           }
       }
   ]
}

Response Body

Field	Type	Description
StatusCode	number	Returns the HTTP status codes like 200,300 etc.
StatusName	string	Name of the status code
StatusMessage	string	Detailed status message
SubmissionId	Guid	Unique identifier of a submission
BusinessId	Guid	Unique identifier of a Business.
PayerRef	string	Optional An unique identifier for each payer completing their information. This identifier can be used in future references of the payer in the API. Size Range: ..50
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

Response JSON

Success Response - This is a sample response for successful API requests.

{
    "StatusCode": 200,
    "StatusName": "Ok",
    "StatusMessage": "Successful API call",
    "SubmissionId": "b8da099b-71c6-43bd-9932-94044458a68e",
    "BusinessId": "cb514f7f-073a-4742-8382-636766c1240f",
    "PayerRef": "Snow123",
    "Form1099Type": "DIV",
    "Form1099Records": {
        "SuccessRecords": [
            {
                "SequenceId": "1",
                "RecordId": "70130e8a-a7e8-4fbe-90ac-fb5886c629ea",
                "RecipientId": "ac52566d-d78a-494f-b62a-8444523258d7",
                "AccountNum": "20211520040564092653",
                "FederalReturn": {
                    "Status": "CREATED",
                    "StatusTs": "2024-05-31 06:18:54 -04:00",
                    "Info": null,
                    "Errors": null
                },
                "StateReturns": [
                    {
                        "StateCd": "WV",
                        "Status": "CREATED",
                        "StatusTs": "2024-05-31 06:19:42 -04:00",
                        "Info": null,
                        "Errors": null
                    }
                ],
                "Postal": {
                    "Status": "NOTCREATED",
                    "StatusTs": null,
                    "Info": "Postal Alert cannot be opted for the return, when the recipient (or) business address has foreign address"
                },
                "OnlineAccess": {
                    "Status": "CREATED",
                    "Email": "shawn@sample.com",
                    "Info": null
                },
                "ScheduleFiling": {
                    "ScheduledOn": null,
                    "Info": "This Service will be available soon"
                }
            }
        ],
        "ErrorRecords": null
    },
    "Errors": null
}

Multi-status Response - You'll get the below response when multiple statuses are included.

{
    "StatusCode": 300,
    "StatusName": "MultiStatus",
    "StatusMessage": "Multiple statuses are available for the request",
    "SubmissionId": "b8da099b-71c6-43bd-9932-94044458a68e",
    "BusinessId": "cb514f7f-073a-4742-8382-636766c1240f",
    "PayerRef": "Snow123",
    "Form1099Type": "DIV",
    "Form1099Records": {
        "SuccessRecords": [
            {
                "SequenceId": "2",
                "RecordId": "70130e8a-a7e8-4fbe-90ac-fb5886c629ea",
                "RecipientId": "ac52566d-d78a-494f-b62a-8444523258d7",
                "AccountNum": "20211520040564004590",
                "FederalReturn": {
                    "Status": "CREATED",
                    "StatusTs": "2024-05-31 06:26:17 -04:00",
                    "Info": null,
                    "Errors": null
                },
                "StateReturns": [
                    {
                        "StateCd": "WV",
                        "Status": "CREATED",
                        "StatusTs": "2024-05-31 06:27:05 -04:00",
                        "Info": null,
                        "Errors": null
                    }
                ],
                "Postal": {
                    "Status": "NOTCREATED",
                    "StatusTs": null,
                    "Info": "Postal Alert cannot be opted for the return, when the recipient (or) business address has foreign address"
                },
                "OnlineAccess": {
                    "Status": "CREATED",
                    "Email": "shawn@sample.com",
                    "Info": null
                },
                "ScheduleFiling": {
                    "ScheduledOn": null,
                    "Info": "This Service will be available soon"
                }
            }
        ],
        "ErrorRecords": [
            {
                "SequenceId": "1",
                "RecordId": null,
                "Errors": [
                    {
                        "Id": "F68-100329",
                        "Name": "DIVFormData.[B1aTotOrdiDiv]",
                        "Message": "Possible Duplicate. Another return has been created for the same recipient with the same amount."
                    }
                ]
            }
        ]
    },
    "Errors": [
        {
            "Id": "F00-100155",
            "Name": "Error Records",
            "Message": "Some of the records are errored. Please read the Error Records for more details."
        }
    ]
}

Bad Request Response - You'll get the below response when your API requests contain any validation errors.

{
    "StatusCode": 400,
    "StatusName": "BadRequest",
    "StatusMessage": "Validation error has occurred",
    "SubmissionId": "b8da099b-71c6-43bd-9932-94044458a68e",
    "BusinessId": "cb514f7f-073a-4742-8382-636766c1240f",
    "PayerRef": "Snow123",
    "Form1099Type": "DIV",
    "Form1099Records": null,
    "Errors": [
        {
            "Id": "F68-100053",
            "Name": "ReturnData.SequenceId",
            "Message": "Duplicate sequence id exist. The sequence Id [1] is repeated more than once."
        }
    ]
}

Unauthorized Response - You'll get the below response when your API requests don't contain valid authentication credentials.

{
    "StatusCode": 401,
    "StatusName": "Unauthorized",
    "StatusMessage": "Invalid authorization credentials",
    "Errors": [
        {
            "Id": "AUTH-100018",
            "Name": "Authorization",
            "Message": "JWT EXPIRED"
        }
    ]
}

W-9 Automation

BOIR Automation

TIN Matching

1099 Automation

941/940 Automation

W-2 Automation

ACA Automation

Supported Forms

Gig Software

Payroll Software

Affiliate Software

HOA Software

Reselling Platform

HCM Providers

Property Management

Supported Forms

Request Body

Request JSON

Response Body

Response JSON