Version: 1.7.1

GetbyRecordIds

This endpoint can be used to get the information from the 1099-PATR Form created against the particular record. You will be able to pull the data from multiple records created under different submissions.

The response will include the Business information, Recipient details, and 1099-PATR Form data.

POST Form1099PATR/GetbyRecordIds

Request Body

Field	Type	Description
RecordIds	object[]	Contains the object of RecordId
RecordId	Guid	The unique identifier of the record. Provide the RecordId for which you need to obtain the information

Request Params

{
    "RecordIds": [
        {
            "RecordId": "ebecbab9-dc9d-4af1-972b-bd2b3b334803"
        }
    ]
}

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-PATR returns.
SubmissionManifest	object	SubmissionManifest provides brief information about a particular submission on the whole. It contains information like Submission ID Tax Year IRSFilingType 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-PATR 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: FIRE: Traditional platform,IRS will take 2 to 4 days to provide the accepted or rejected status. IRIS: The IRS's new platform for 1099 returns,IRS will provide the accepted or rejected status within 6hrs. Click here for more information about IRIS system. If no value is specified,Taxbandits will default to "FIRE". Allowed values "FIRE","IRIS"
IsFederalFiling	Boolean	Federal Filing for the return will be enabled when the value is True. Form 1099-PATR will be sent directly to the IRS.
IsStateFiling	Boolean	State Filing for the return will be enabled when the value is True. Form 1099-NEC 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-PATR 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-PATR copies from the portal.
IsScheduleFiling	Boolean	When true, schedule filing services will be provided for Form 1099-PATR 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 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"
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-PATR 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-PATR 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: ..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-PATR 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
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-PATR 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-PATR 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	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-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
Fax	string	Optional Recipient's Fax number. Size Range: 10
Phone	string	Optional Recipient's Phone Number. Size Range: 15
PATRFormData	object	Recipient's Form 1099-PATR information.
B1PatronageDiv	number	Bring in the patron's share of total patronage dividends paid in cash. Size Range: 0-9999999999.99
B2NonPatronageDist	number	For farmer's cooperatives exempt from tax under section 521 only, bring in the patron's share of the total amount paid in cash. Size Range: 0-9999999999.99
B3PerUnitAllocations	number	Bring in the patron's share of the total per-unit retain allocations paid in cash. Size Range: 0-9999999999.99
B4FedTaxWH	number	Bring in backup withholding on patronage payments. Size Range: 0-9999999999.99
B5RedmNonQualNotices	number	Bring in the amount of redeemed nonqualified written notices of allocation that were paid as a patronage dividend and the amount of redeemed nonqualified per-unit retain certificates that were paid as a per-unit retain allocation. Size Range: 0-9999999999.99
B6Sec199AgDeduction	number	For specified agricultural and horticultural cooperatives only, bring in the patron's share of the amount. Size Range: 0-9999999999.99
B7QualPymtsSec199Ab7	number	For specified agricultural and horticultural cooperatives only, bring in the qualified payments paid to the patron. Size Range: 0-9999999999.99
B8Sec199AaQualItems	number	Bring in amounts reported to the patrons that are qualified items of income, gain, deduction, or loss from qualified trades or businesses that are not a specified service trade or business (SSTB) for purposes of section 199A. Size Range: 0-9999999999.99
B9Sec199AaSSTBItems	number	Bring in amounts reported to the patrons that are qualified items from otherwise qualified trades or businesses that are an SSTB for purposes of section 199A. Size Range: 0-9999999999.99
B10InvestmentCredit	number	Bring in the patron's share of total investment credit. Size Range: 0-9999999999.99
B11WorkOpporCredit	number	Bring in the patron's share of total work opportunity credit. Size Range: 0-9999999999.99
B12OtherCreditsAndDeductions	number	Bring in the type and amount of each of the credits and deductions. Size Range: 0-9999999999.99
B13IsSpecifiedCoop	Boolean	When true, identifies reporting information as a specified agricultural or horticultural cooperative.
AccountNum	string	Account number of Payer having multiple accounts for a recipient for whom more than one Form 1099-PATR 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.
Is2ndTINnot	Boolean	When true, identifies a Payer who is notified by the IRS twice within 3 calendar years for providing an incorrect TIN and does not want the IRS to send any more notices.
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

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

{
    "StatusCode": 200,
    "StatusName": "Ok",
    "StatusMessage": "Successful API call",
    "Form1099Records": [
        {
            "SubmissionManifest": {
                "SubmissionId": "9a0ce8c8-db47-41f1-9f01-03af2d3597a2",
                "TaxYear": "2024",
                "IRSFilingType":"IRIS",
                "IsFederalFiling": true,
                "IsPostal": true,
                "IsOnlineAccess": true,
                "IsScheduleFiling": false,
                "ScheduleFiling": null
            },
            "ReturnHeader": {
                "Business": {
                    "BusinessId": "429b14fa-24c0-4d59-ae6c-7cd6d98ed879",
                    "PayerRef": "Snow123",
                    "BusinessNm": "Snowdaze LLC",
                    "TradeNm": "Iceberg Icecreams",
       "FirstNm": null,
                      "MiddleNm": null,
                      "LastNm": null,
                      "Suffix": null,
                    "IsEIN": true,
                    "EINorSSN": "91-3787159",
                    "Email": "chandler@sample.com",
                    "ContactNm": "John",
                    "Phone": "(663) 456-7890",
                    "PhoneExtn": "12345",
                    "Fax": "(663) 456-7890",
                    "BusinessType": "ESTE",
                    "SigningAuthority": {
                        "Name": "Chandler White",
                        "Phone": "(963) 456-7890",
                        "BusinessMemberType": "ADMINISTRATOR"
                    },
                    "KindOfEmployer": "FEDERALGOVT",
                    "KindOfPayer": "REGULAR941",
                    "IsBusinessTerminated": true,
                    "IsForeign": false,
                    "USAddress": {
                        "Address1": "Avenue Nord ",
                        "Address2": "Avenue Nord ",
                        "City": "Avenue Nord ",
                        "State": "AK",
                        "ZipCd": "99709"
                    },
                    "ForeignAddress": null,
                    "ACADetails": null
                }
            },
            "ReturnData": [
                {
                    "RecordId": "911535ae-da07-41a5-b70f-78967e741f51",
                    "SequenceId": "1",
                    "IsPostal": false,
                    "IsOnlineAccess": true,
                    "IsForced": true,
                    "Recipient": {
                        "RecipientId": "646fba68-ffc8-406a-98bb-77f1d2f3e630",
                        "TINType": "EIN",
                        "TIN": "36-3814279",
                        "FirstPayeeNm": "Smith",
                        "SecondPayeeNm": "Joe",
                          "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": "mark@sample.com",
                        "Fax": "(683) 456-7890",
                        "Phone": "(763) 456-7890"
                    },
                    "PATRFormData": {
                        "B1PatronageDiv": 1000.56,
                        "B2NonPatronageDist": 1000.91,
                        "B3PerUnitAllocations": 500.49,
                        "B4FedTaxWH": 1240.86,
                        "B5RedmNonQualNotices": 600.21,
                        "B6Sec199AgDeduction": 70.40,
                        "B7QualPymtsSec199Ab7": 800.90,
                        "B8Sec199AaQualItems": 1000.31,
                        "B9Sec199AaSSTBItems": 280.00,
                        "B10InvestmentCredit": 790.22,
                        "B11WorkOpporCredit": 150.00,
                        "B12OtherCreditsAndDeductions": 500.50,
                        "B13IsSpecifiedCoop": true,
                        "AccountNum": "20231830021215079291",
                        "Is2ndTINnot": true
                    }
                }
            ]
        }
    ],
    "Errors": null
}

W-9 Automation

BOI Automation New

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 Params

Response Body

Response JSON