Update
PUT Form1099OID/Update
Request Body
Field | Type | Description |
---|---|---|
SubmissionManifest | object | SubmissionManifest provides brief information about a particular submission on the whole. It contains information like
|
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-OID to be filed. Allowed values: "2022","2023","2024" |
IRSFilingType | string | Specify the platform on which you want to file the 1099 return with the IRS:
Allowed values"FIRE","IRIS" |
IsFederalFiling | Boolean | Federal Filing for the return will be enabled when the value is True. Form 1099-OID will be sent directly to the IRS. |
IsStateFiling | Boolean | State Filing for the return will be enabled when the value is True. Form 1099-OID will be directly filed with the respective recipient states. Note: State Filing will not be created for the states that do not require State filing. |
IsPostal | Boolean | If this value is set as true, the Postal Mailing service will be opted for all the recipients included in the submission. Once the returns are transmitted, the 1099-OID form copies will be mailed to the recipient's address via USPS. Note: Postal Orders for Foreign Address will not be created. |
IsOnlineAccess | Boolean | If this value is set as true, the Online Access service will be enabled for all the recipients included in the submission. Once the returns are transmitted, an email with a link to the secure TaxBandits portal will be sent to the recipients. The recipients can then provide consent and download Form 1099-OID copies from the portal. |
IsScheduleFiling | Boolean | When true, schedule filing services will be provided for Form 1099-OID 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/2024 or 10-20-2024 |
ReturnHeader | object | Contains information about the Business details. |
Business | object | Object to identify the Business Details. |
BusinessId | Guid | Optional Use the unique Business ID (Generated by TaxBandits), you received in the response of the Business CREATE Endpoint. If you have do not have a Business ID, ignore the field. By giving the Business ID, you do not have to provide all the business information again. |
BusinessNm | string | Name of the business Size Range: ..75 |
FirstNm | string | First Name of the Individual Size Range: ..20 |
MiddleNm | string | Middle Name of the Individual Size Range: ..20 |
LastNm | string | Last Name of the Individual Size Range: ..20 |
Suffix | string | Suffix of the IndividualAllowed values"Jr", "Sr", "I", "II", "III", "IV", "V", "VI", "VII" |
PayerRef | string | Optional An unique identifier for each payer completing their information. This identifier can be used in future references of the payer in the API. Size Range: ..50 |
TradeNm | string | Optional Name under which the business operates Size Range: ..75 |
IsEIN | Boolean | When true, 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 |
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" |
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-OID and 94X seriesAllowed 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-OID and 94X seriesAllowed values"REGULAR941", "REGULAR944", "AGRICULTURAL943", "HOUSEHOLD", "MILITARY", "MEDICAREQUALGOVEM", "RAILROADFORMCT1" |
IsBusinessTerminated | Boolean | When true, identifies the business as terminated. |
IsForeign | Boolean | When true, identifies the business address with a foreign address. |
USAddress | object | If IsForeign is false, pass US address of the business |
Address1 | string | Employer/Payer's US address (street or post office box of that locality) Size Range: ..46 |
Address2 | string | Optional Employer/Payer's suite or apartment Size Range: ..46 |
City | string | Employer/Payer's city Size Range: ..50 |
State | string | Employer/Payer's state code. Refer Static values. Size Range: 2 Allowed values"AL", "AK", "AZ", "AR", "CA", "CO", "CT", "DE", "DC", "FL", "GA", "HI", "ID", "IL", "IN", "IA", "KS", "KY", "LA", "ME", "MD", "MA", "MI", "MN", "MS", "MO", "MT", "NE", "NV", "NH", "NJ", "NM", "NY", "NC", "ND", "OH", "OK", "OR", "PA", "RI", "SC", "SD", "TN", "TX", "UT", "VT", "VA", "WA", "WV", "WI", "WY", "AS", "FM", "GU", "MH", "MP", "PW", "PR", "VI", "AA", "AE", "AP" |
ZipCd | string | Employer/Payer's zip code Size Range: 5..10 |
ForeignAddress | object | If IsForeign is true, pass foreign address of the business |
Address1 | string | Employer/Payer's foreign address (street address or post office box of that locality) Size Range: ..50 |
Address2 | string | Optional Employer/Payer's suite or apartment Size Range: ..50 |
City | string | Employer/Payer's city Size Range: ..50 |
ProvinceOrStateNm | string | Employer/Payer's province or state name Size Range: ..50 |
Country | string | Employer/Payer's country Size Range: 2 Allowed values"AF", "AX", "AL", "AG", "AQ", "AN", "AO", "AV", "AY", "AC", "AR", "AM", "AA", "AT", "AS", "AU", "AJ", "BF", "BA", "FQ", "BG", "BB", "BO", "BE", "BH", "BN", "BD", "BT", "BL", "BK", "BC", "BV", "BR", "IO", "VI", "BX", "BU", "UV", "BM", "BY", "CB", "CM", "CA", "CV", "CJ", "CT", "CD", "CI", "CH", "KT", "IP", "CK", "CO", "CN", "CF", "CG", "CW", "CR", "CS", "IV", "HR", "CU", "UC", "CY", "EZ", "DA", "DX", "DJ", "DO", "DR", "TT", "EC", "EG", "ES", "EK", "ER", "EN", "ET", "FK", "FO", "FM", "FJ", "FI", "FR", "FP", "FS", "GB", "GA", "GG", "GM", "GH", "GI", "GR", "GL", "GJ", "GQ", "GT", "GK", "GV", "PU", "GY", "HA", "HM", "VT", "HO", "HK", "HQ", "HU", "IC", "IN", "ID", "IR", "IZ", "EI", "IS", "IT", "JM", "JN", "JA", "DQ", "JE", "JQ", "JO", "KZ", "KE", "KQ", "KR", "KN", "KS", "KV", "KU", "KG", "LA", "LG", "LE", "LT", "LI", "LY", "LS", "LH", "LU", "MC", "MK", "MA", "MI", "MY", "MV", "ML", "MT", "IM", "RM", "MR", "MP", "MX", "MQ", "MD", "MN", "MG", "MJ", "MH", "MO", "MZ", "WA", "NR", "BQ", "NP", "NL", "NC", "NZ", "NU", "NG", "NI", "NE", "NF", "CQ", "NO", "MU", "OC", "PK", "PS", "LQ", "PM", "PP", "PF", "PA", "PE", "RP", "PC", "PL", "PO", "RQ", "QA", "RO", "RS", "RW", "TB", "RN", "WS", "SM", "TP", "SA", "SG", "RI", "SE", "SL", "SN", "NN", "LO", "SI", "BP", "SO", "SF", "SX", "OD", "SP", "PG", "CE", "SH", "SC", "ST", "SB", "VC", "SU", "NS", "SV", "WZ", "SW", "SZ", "SY", "TW", "TI", "TZ", "TH", "TO", "TL", "TN", "TD", "TS", "TU", "TX", "TK", "TV", "UG", "UP", "AE", "UK", "UY", "UZ", "NH", "VE", "VM", "VQ", "WQ", "WF", "WI", "YM", "ZA", "ZI" |
PostalCd | string | Employer/Payer's postal code Size Range: ..16 |
ReturnData | object[] | Contains information about the recipient details and Form 1099-OID 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 |
IsPostal | Boolean | If this value is set as true, the Postal Mailing service will be opted for the recipient included in the record. Once the return is transmitted, the 1099-OID copy will be mailed to the recipient's address via USPS. Postal Orders for Foreign Address will not be created. Note: To enable this, you must have set the IsPostal value as True under the submission. You can set this value as False for the other records for which you don’t want this service. |
IsOnlineAccess | Boolean | If this value is set as true, the Online Access service will be enabled for the recipient included in the record. Once the return is transmitted, an email with a link to the secure TaxBandits portal will be sent to the recipient. The recipient can then provide consent and download Form 1099-OID copy from the portal. Note: To enable this, you must have set the IsOnlineAccess value as True under the submission. You can set this value as False for the other records for which you don’t want this service. |
IsForced | Boolean | When TRUE, TaxBandits does not verify for duplicates and will create a new return for the recipient, even it comprises the same amounts as in previously filed returns. For more information on duplicate handling for Form 1099s, please click here. Note: If there are multiple returns filed for the recipient with the same account number, TaxBandits will append 3 random numbers at the end of the account number. |
RecordId | Guid | OptionalUnique identifier of a record. Not required when you are creating a return. |
Recipient | object | Object to identify the recipient details. |
RecipientId | Guid | OptionalTaxBandits 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. Note: If the recipient doesn't have a TIN, enter the TIN type as 'NA' and input 'null' in the TIN field. Allowed values"SSN", "EIN", "ITIN", "ATIN", "NA" |
TIN | string | Enter the nine-digit taxpayer identification number of the Recipient (SSN, ITIN, ATIN, or EIN). Size Range: 9-11 |
FirstPayeeNm | string | Enter the name of the recipient (preferably last name first for an Individual). If more space is required for the name, use the Second Payee Name Field. Size Range: 40 |
SecondPayeeNm | string | Optional If there are multiple recipients (for example, partners, joint owners, or spouses), use this field for those names not associated with the TIN or if not enough space was provided in the First Payee Name, continue the name in this field. Size Range: 40 |
FirstNm | string | First Name of the Individual Size Range: ..20 |
MiddleNm | string | Middle Name of the Individual Size Range: ..20 |
LastNm | string | Last Name of the Individual Size Range: ..20 |
Suffix | string | Suffix of the IndividualAllowed values"Jr", "Sr", "I", "II", "III", "IV", "V", "VI", "VII" |
IsForeign | Boolean | When true, it identifies the recipient's address with a foreign address. |
USAddress | object | If IsForeign is false, pass US address of the recipient |
Address1 | string | Recipient's US address (street address or post office box of that locality) Size Range: ..46 |
Address2 | string | Optional Recipient's suite or apartment Size Range: ..46 |
City | string | Recipient's city Size Range: ..50 |
State | string | Recipient's state code. Refer Static values. Size Range: 2 Allowed values"AL", "AK", "AZ", "AR", "CA", "CO", "CT", "DE", "DC", "FL", "GA", "HI", "ID", "IL", "IN", "IA", "KS", "KY", "LA", "ME", "MD", "MA", "MI", "MN", "MS", "MO", "MT", "NE", "NV", "NH", "NJ", "NM", "NY", "NC", "ND", "OH", "OK", "OR", "PA", "RI", "SC", "SD", "TN", "TX", "UT", "VT", "VA", "WA", "WV", "WI", "WY", "AS", "FM", "GU", "MH", "MP", "PW", "PR", "VI", "AA", "AE", "AP" |
ZipCd | string | Recipient's zip code Size Range: 5..10 |
ForeignAddress | object | If IsForeign is true, pass foreign address of the recipient |
Address1 | string | Recipient's foreign address (street address or post office box of that locality) Size Range: ..50 |
Address2 | string | Optional Recipient's suite or apartment Size Range: ..50 |
City | string | Recipient's city. Size Range: ..50 |
ProvinceOrStateNm | string | Recipient's Province or State Name. Size Range: ..50 |
Country | string | Recipient's country code. Refer Static values. Size Range: 2 Allowed values"AF", "AX", "AL", "AG", "AQ", "AN", "AO", "AV", "AY", "AC", "AR", "AM", "AA", "AT", "AS", "AU", "AJ", "BF", "BA", "FQ", "BG", "BB", "BO", "BE", "BH", "BN", "BD", "BT", "BL", "BK", "BC", "BV", "BR", "IO", "VI", "BX", "BU", "UV", "BM", "BY", "CB", "CM", "CA", "CV", "CJ", "CT", "CD", "CI", "CH", "KT", "IP", "CK", "CO", "CN", "CF", "CG", "CW", "CR", "CS", "IV", "HR", "CU", "UC", "CY", "EZ", "DA", "DX", "DJ", "DO", "DR", "TT", "EC", "EG", "ES", "EK", "ER", "EN", "ET", "FK", "FO", "FM", "FJ", "FI", "FR", "FP", "FS", "GB", "GA", "GG", "GM", "GH", "GI", "GR", "GL", "GJ", "GQ", "GT", "GK", "GV", "PU", "GY", "HA", "HM", "VT", "HO", "HK", "HQ", "HU", "IC", "IN", "ID", "IR", "IZ", "EI", "IS", "IT", "JM", "JN", "JA", "DQ", "JE", "JQ", "JO", "KZ", "KE", "KQ", "KR", "KN", "KS", "KV", "KU", "KG", "LA", "LG", "LE", "LT", "LI", "LY", "LS", "LH", "LU", "MC", "MK", "MA", "MI", "MY", "MV", "ML", "MT", "IM", "RM", "MR", "MP", "MX", "MQ", "MD", "MN", "MG", "MJ", "MH", "MO", "MZ", "WA", "NR", "BQ", "NP", "NL", "NC", "NZ", "NU", "NG", "NI", "NE", "NF", "CQ", "NO", "MU", "OC", "PK", "PS", "LQ", "PM", "PP", "PF", "PA", "PE", "RP", "PC", "PL", "PO", "RQ", "QA", "RO", "RS", "RW", "TB", "RN", "WS", "SM", "TP", "SA", "SG", "RI", "SE", "SL", "SN", "NN", "LO", "SI", "BP", "SO", "SF", "SX", "OD", "SP", "PG", "CE", "SH", "SC", "ST", "SB", "VC", "SU", "NS", "SV", "WZ", "SW", "SZ", "SY", "TW", "TI", "TZ", "TH", "TO", "TL", "TN", "TD", "TS", "TU", "TX", "TK", "TV", "UG", "UP", "AE", "UK", "UY", "UZ", "NH", "VE", "VM", "VQ", "WQ", "WF", "WI", "YM", "ZA", "ZI" |
PostalCd | string | Recipient's Postal Code Size Range: ..16 |
string | Optional Recipient's email address. Size Range: 0..100 Note : This email address cannot be the same for two different recipients under the same business. | |
Fax | string | Optional Recipient's Fax number. Size Range: 10 |
Phone | string | Optional Recipient's Phone Number. Size Range: 15 |
OIDFormData | object | Recipient's Form 1099-OID information. |
B1OID | number | Original Issue Discount - Gets the taxable OID on the obligation for the part of the year it was owned by the record holder. |
B2OtherPeriodicInt | number | Other Periodic Interest - Gets any qualified stated interest paid or credited on this obligation during the year |
B3EarlyWithdrawalPenalty | number | Early withdrawal penalty - Gets the interest or principal forfeited because of an early withdrawal of time deposits, such as an early withdrawal from a CD, that is deductible from gross income by the recipient. |
B4FedTaxWH | number | Federal Tax Withheld - Gets the backup withholding. For example, if a recipient does not furnish its TIN to you in the manner required, you must backup withhold. The applicable interest rate applies to amounts required to be reported in boxes 1, 2, and 8, but is limited to the cash paid on these obligations |
B5MarketDisc | number | Market Discount - For a covered security acquired with market discount and OID, if the taxpayer notified you that a section 1278(b) election was made, enter the amount of market discount that accrued on the debt instrument during the tax year in the amount of $10 or more. |
B6AcqPremium | number | Acquisition Premium - For covered security acquired with acquisition premium, enter the amount of premium amortization for the part of the year the debt instrument was owned by the holder |
B7Description | string | Description - Enter the CUSIP number, if any. If there is no CUSIP number, enter the abbreviation for the stock exchange, the abbreviation for the issuer used by the stock exchange, the coupon rate, and the year of maturity (for example, NYSE XYZ 121/2 25). |
B8OIDOnUSTObligation | number | Original Issue Discount on U.S. Treasury Obligations - Gets the OID on a U.S. Treasury obligation for the part of the year it was owned by the record holder |
B9InvestExp | number | Investment Expenses - For single-class REMICs only |
B10BondPremium | number | Bond Premium - Gets the taxable covered security acquired at a premium, enter the amount of bond premium amortization allocable to the interest paid during the tax year, unless you were notified in writing that the holder did not want to amortize bond premium under section 171. |
B11TaxExemptOID | number | Tax-Exempt OID - Gets the tax-exempt obligation that is a covered security acquired on or after January 1, 2017, enter the OID for the part of the year it was owned by the record holder. |
IsFATCA | Boolean | When true, identifies a U.S. payer reporting on Form(s) 1099 (including reporting payments on this Form 1099-OID) to satisfy their foreign financial asset reporting requirement with respect to a U.S. account. |
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. |
AccountNum | string | Account number of Payer having multiple accounts for a recipient for whom more than one Form 1099-OID is filed. Size Range: 4..20 Note: If the account number on the return you file is the same as any previously filed return, TaxBandits will append 3 random numbers at the end of the account number. |
States | object | Contains list of state returns information. |
StateCd | string | Contains list of state returns information. 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-OID return for the specific Business, including recipient and income information. Now, update the Recipient/Form Details with RecipientId and RecordId.
{
"SubmissionManiFest": {
"SubmissionId": "071efcbf-129b-4dbc-b5ca-7aac58710e79",
"TaxYear": "2024",
"IRSFilingType":"IRIS",
"IsFederalFiling": true,
"IsPostal": true,
"IsOnlineAccess": true,
"IsStateFiling": true,
"IsScheduleFiling": false,
"ScheduleFiling": null
},
"ReturnHeader": {
"Business": {
"BusinessId": "61ab0ade-dbcf-4bc7-b064-9ba12d93c6b2",
"PayerRef": null,
"BusinessNm": null,
"FirstNm": "James",
"LastNm": "Smith",
"MiddleNm": null,
"Suffix": "Sr",
"TradeNm": "Iceberg Icecreams",
"IsEIN": false,
"EINorSSN": "662245106",
"Email": "James@sample.com",
"ContactNm": "James",
"Phone": "9834578960",
"PhoneExtn": "12345",
"Fax": null,
"BusinessType": "ESTE",
"SigningAuthority": {
"Name": "James",
"Phone": "9834578960",
"BusinessMemberType": "ADMINISTRATOR"
},
"KindOfEmployer": "FEDERALGOVT",
"KindOfPayer": "REGULAR941",
"IsBusinessTerminated": true,
"IsForeign": false,
"USAddress": {
"Address1": "1605 Park Avenue",
"Address2": "Louis St",
"City": "Seattle",
"State": "WA",
"ZipCd": "98944"
},
"ForeignAddress": null
}
},
"ReturnData": [
{
"SequenceId": "001",
"RecordId": "3c717994-b847-4f23-acaf-27bf9d9a946e",
"IsPostal": true,
"IsOnlineAccess": true,
"IsForced": true,
"Recipient": {
"RecipientId": "8cae2830-b916-4200-b8ef-f9b271db87a2",
"TINType": "SSN",
"TIN": "622-21-4550",
"FirstPayeeNm": null,
"SecondPayeeNm": null,
"FirstNm": "Shawn",
"LastNm": "Willams",
"MiddleNm": "K",
"Suffix": "Jr",
"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": "2234567890",
"Phone": "9634567890"
},
"OIDFormData": {
"B1OID": 9000,
"B2OtherPeriodicInt": 10000,
"B3EarlyWithdrawalPenalty": 50,
"B4FedTaxWH": 4000,
"B5MarketDisc": 2000,
"B6AcqPremium": 1200,
"B7Description": "To be checked",
"B8OIDOnUSTObligation": 4000,
"B9InvestExp": 1000,
"B10BondPremium": 1000,
"B11TaxExemptOID": 2000,
"IsFATCA": false,
"Is2ndTINnot": false,
"AccountNum": null,
"States": [
{
"StateCd": "WV",
"StateWH": 257.94,
"StateIdNum": "99999999"
},
{
"StateCd": "ID",
"StateWH": 15,
"StateIdNum": "999999999"
}
]
}
}
]
}
Created a Form 1099-OID return for the specific Business, including recipient and income information. Now, create a new Recipient/Form without RecipientId and RecordId.
{
"SubmissionManifest": {
"SubmissionId": "b8da099b-71c6-43bd-9932-94044458a68e",
"TaxYear": "2024",
"IRSFilingType":"IRIS",
"IsFederalFiling": true,
"IsStateFiling": true,
"IsPostal": true,
"IsOnlineAccess": true,
"IsScheduleFiling": true,
"ScheduleFiling": {
"EfileDate": "12/25/2024"
}
},
"ReturnHeader": {
"Business": {
"BusinessId": null,
"BusinessNm": "Snowdaze LLC",
"FirstNm": null,
"LastNm": null,
"MiddleNm": null,
"Suffix": null,
"PayerRef": "Snow123",
"TradeNm": "Iceberg Icecreams",
"IsEIN": true,
"EINorSSN": "65-7369245",
"Email": "james@sample.com",
"ContactNm": null,
"Phone": "1234567890",
"PhoneExtn": "12345",
"Fax": "1234567890",
"BusinessType": "ESTE",
"SigningAuthority": null,
"KindOfEmployer": "FederalGovt",
"KindOfPayer": "REGULAR941",
"IsBusinessTerminated": false,
"IsForeign": false,
"USAddress": {
"Address1": "3576 AIRPORT WAY",
"Address2": "UNIT 9",
"City": "FAIRBANKS",
"State": "AK",
"ZipCd": "99709"
},
"ForeignAddress": null
}
},
"ReturnData": [
{
"SequenceId": "1",
"RecordId": null,
"IsPostal": true,
"IsOnlineAccess": true,
"IsForced": false,
"Recipient": {
"RecipientId": null,
"TINType": "EIN",
"TIN": "39-3817572",
"FirstPayeeNm": "Dairy Delights LLC",
"SecondPayeeNm": null,
"FirstNm": null,
"LastNm": null,
"MiddleNm": 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": "6634567890",
"Phone": "9634567890"
},
"OIDFormData": {
"B1OID": 9000,
"B2OtherPeriodicInt": 10000,
"B3EarlyWithdrawalPenalty": 50,
"B4FedTaxWH": 4000,
"B5MarketDisc": 2000,
"B6AcqPremium": 1200,
"B7Description": "To be checked",
"B8OIDOnUSTObligation": 4000,
"B9InvestExp": 1000,
"B10BondPremium": 1000,
"B11TaxExemptOID": 2000,
"IsFATCA": false,
"Is2ndTINnot": false,
"AccountNum": null,
"States": [
{
"StateCd": "WV",
"StateWH": 257.94,
"StateIdNum": "99999999"
},
{
"StateCd": "ID",
"StateWH": 15,
"StateIdNum": "999999999"
}
]
}
}
]
}
Response Body
Field | Type | Description |
---|---|---|
StatusCode | number | Returns the HTTP status codes like 200,300 etc. |
StatusName | string | Name of the status code |
StatusMessage | string | Detailed status message |
SubmissionId | Guid | Unique identifier of a submission |
BusinessId | Guid | Unique identifier of a Business. |
PayerRef | string | Unique identifier of the payer. |
Form1099Type | string | Denotes the type of 1099 form. |
Form1099Records | object | Pulls Form 1099-OID records with Success and Error statuses |
SuccessRecords | object[] | It will show the detailed information about the success status of Form 1099-OID Records |
SequenceId | string | An unique reference ID for the submission that can be used to identify a particular record. The Sequence ID will be returned in the Response for your reference. |
RecordId | Guid | An unique identifier generated by TaxBandits when a 1099-OID return is created. |
RecipientId | Guid | An unique identifier generated by TaxBandits for a Recipient when a 1099-OID 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-OID is filed. Size Range: 4..20 Note: If the account number on the return you file is the same as any previously filed return, TaxBandits will append 3 random numbers at the end of the account number. |
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-OID. |
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-OID. |
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-OID return. |
string | Email address for whom the online access to be given. | |
Info | string | Information about the online access service. |
ScheduleFiling | object | Returns the date of the schedule filing. |
ScheduledOn | string | Date of the schedule filing to know when the return to be filed to the IRS. |
Info | string | Information about Schedule Filing service. |
ErrorRecords | object[] | It will show the detailed information about the error status of Form 1099-OID Records. |
SequenceId | string | An unique reference ID for the submission that can be used to identify a particular record. The Sequence ID will be returned in the Response for your reference. |
RecordId | Guid | Unique identifier of a record |
Errors | object[] | Shows detailed error information |
Id | string | Returns the validation error Id |
Name | string | Name of the validation error |
Message | string | Description of the validation error |
Errors | object[] | Shows detailed error information |
Id | string | Returns the validation error Id |
Name | string | Name of the validation error |
Message | string | Description of the validation error |
Response JSON
- 200
- 300
- 400
Success Response - This is a sample response for successful API requests.
{
"StatusCode": 200,
"StatusName": "Ok",
"StatusMessage": "Successful API call",
"SubmissionId": "071efcbf-129b-4dbc-b5ca-7aac58710e79",
"BusinessId": "61ab0ade-dbcf-4bc7-b064-9ba12d93c6b2",
"PayerRef": null,
"Form1099Type": "OID",
"Form1099Records": {
"SuccessRecords": [
{
"SequenceId": "001",
"RecordId": "3c717994-b847-4f23-acaf-27bf9d9a946e",
"RecipientId": "8cae2830-b916-4200-b8ef-f9b271db87a2",
"AccountNum": "20241810030132076560",
"FederalReturn": {
"Status": "CREATED",
"StatusTs": "2024-06-29 01:38:48 -04:00",
"Info": null,
"Errors": null
},
"StateReturns": [
{
"StateCd": "WV",
"Status": "NA",
"StatusTs": null,
"Info": "This service will be available soon",
"Errors": null
},
{
"StateCd": "ID",
"Status": "NA",
"StatusTs": null,
"Info": "This service will be available soon",
"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": null
}
],
"ErrorRecords": null
},
"Errors": null
}
Multi-status Response - You'll get the below response when multiple statuses are included.
{
"StatusCode": 300,
"StatusName": "MultiStatus",
"StatusMessage": "Multiple statuses are available for the request",
"SubmissionId": "071efcbf-129b-4dbc-b5ca-7aac58710e79",
"BusinessId": "61ab0ade-dbcf-4bc7-b064-9ba12d93c6b2",
"PayerRef": null,
"Form1099Type": "OID",
"Form1099Records": {
"SuccessRecords": [
{
"SequenceId": "001",
"RecordId": "3c717994-b847-4f23-acaf-27bf9d9a946e",
"RecipientId": "8cae2830-b916-4200-b8ef-f9b271db87a2",
"AccountNum": "20241810030132011628",
"FederalReturn": {
"Status": "CREATED",
"StatusTs": "2024-06-29 01:41:29 -04:00",
"Info": null,
"Errors": null
},
"StateReturns": [
{
"StateCd": "WV",
"Status": "NA",
"StatusTs": null,
"Info": "This service will be available soon",
"Errors": null
},
{
"StateCd": "ID",
"Status": "NA",
"StatusTs": null,
"Info": "This service will be available soon",
"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": null
}
],
"ErrorRecords": [
{
"SequenceId": "002",
"RecordId": null,
"Errors": [
{
"Id": "RECPT-0051",
"Name": "Recipient.ForeignAddress.Address1[1]",
"Message": "Recipient Address1 is required"
}
]
}
]
},
"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": "071efcbf-129b-4dbc-b5ca-7aac58710e79",
"BusinessId": "61ab0ade-dbcf-4bc7-b064-9ba12d93c6b2",
"PayerRef": null,
"Form1099Type": "OID",
"Form1099Records": {
"SuccessRecords": null,
"ErrorRecords": [
{
"SequenceId": "001",
"RecordId": "3c717994-b847-4f23-acaf-27bf9d9a946e",
"Errors": [
{
"Id": null,
"Name": null,
"Message": "This email address is already linked to another employee/recipient"
}
]
}
]
},
"Errors": null
}