Skip to main content
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 
Run in Postman

Request Body

FieldTypeDescription
RecordIdsobject[]Contains the object of RecordId
RecordIdGuidThe 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

FieldTypeDescription
StatusCodenumberReturns the HTTP status codes like 200,300 etc.
StatusNamestringName of the status code
StatusMessagestringDetailed status message
Form1099RecordsobjectContains information about Form 1099-PATR returns.
SubmissionManifestobjectSubmissionManifest 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
    SubmissionIdGuidUnique Identifier created by TaxBandits for each submission. Not required when you are creating a return.
    TaxYearstringTax year of Form 1099-PATR to be filed..
Allowed values: "2022","2023"
    IsFederalFilingBooleanFederal Filing for the return will be enabled when the value is True. Form 1099-PATR will be sent directly to the IRS.
    IsStateFilingBooleanState 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.
    IsPostalBooleanIf this value is set as true, the Postal Mailing service will be opted for all the recipients included in the submission.

Once the returns are transmitted, the 1099-PATR form copies will be mailed to the recipient's address via USPS.

Note: Postal Orders for Foreign Address will not be created.
    IsOnlineAccessBooleanIf this value is set as true, the Online Access service will be enabled for all the recipients included in the submission.

Once the returns are transmitted, an email with a link to the secure TaxBandits portal will be sent to the recipients. The recipients can then provide consent and download Form 1099-PATR copies from the portal.
    IsScheduleFilingBooleanWhen true, schedule filing services will be provided for Form 1099-PATR returns under this submission.
    ScheduleFilingobjectContains preferred date to submit the returns to the IRS. Required only when "IsScheduleFiling" is True .
        EfileDatestringDate of Schedule Filing. Enter the date in the format: MM/DD/YYYY or MM-DD-YYYY Example: 10/20/2023 or 10-20-2023
ReturnHeaderobjectContains information about the Business details.
    BusinessobjectObject to identify the Business Details.
        BusinessIdGuidOptional Use the unique Business ID (Generated by TaxBandits) you received in response to the Business CREATE Endpoint. By giving the Business ID, you do not have to provide all the business information again. If you do not have a Business ID, ignore the field.
        BusinessNmstringName of the business
Size Range: ..80
        FirstNmstringFirst Name of the Individual
Size Range: ..20
        MiddleNmstringMiddle Name of the Individual
Size Range: ..20
        LastNmstringLast Name of the Individual
Size Range: ..20
        SuffixstringSuffix of the Individual
Size Range: ..20
        PayerRefstringOptional An unique identifier for each payer completing their information. This identifier can be used in future references of the payer in the API.
Size Range: ..50
        TradeNmstringOptional Name under which the business operates
Size Range: ..80
        IsEINBooleanWhen true, identify that the business TIN is an EIN.
        EINorSSNstringWhen IsEIN is true, use Employer Identification Number (EIN). When IsEIN is false, use Social Security Number (SSN)
Size Range: 9-11
        EmailstringOptional Email address of the Business
Size Range: ..100
        ContactNmstringOptional Name of the person who can be contacted by the IRS.
Size Range: ..27
        PhonestringOptional Phone number of the business
Size Range: 10
        PhoneExtnstringOptional Extension of the business phone number
Size Range: ..5
        FaxstringOptional Fax number of the Business
Size Range: 10
        BusinessTypestringOptional Type of business. Optional for W-2/1099 and mandatory for 94X series
Size Range: 4
Allowed values

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

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

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

        KindOfEmployerstringOptional Identifies the kind of employer. Mandatory for W-2 and optional for 1099-PATR and 94X series
Allowed values

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

        KindOfPayerstringOptional 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"

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

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

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

            PostalCdstringEmployer/Payer's postal code
Size Range: ..16
ReturnDataobject[]Contains information about the recipient details and Form 1099-PATR details.
    SequenceIdstringA unique reference ID for the submission that can be used to identify a particular record. The Sequence ID will be returned in the Response for your reference.
Size Range: 50
    IsPostalBooleanIf this value is set as true, the Postal Mailing service will be opted for the recipient included in the record.

Once the return is transmitted, the 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.
    IsOnlineAccessBooleanIf this value is set as true, the Online Access service will be enabled for the recipient included in the record.

Once the return is transmitted, an email with a link to the secure TaxBandits portal will be sent to the recipient. The recipient can then provide consent and download Form 1099-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.
    IsForcedBooleanWhen 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.
    RecordIdGuidUnique identifier of a record. Not required when you are creating a return.
    RecipientobjectObject to identify the recipient details.
        RecipientIdGuidTaxBandits 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.
        TINTypestringSpecify the TIN type of the recipient.
Allowed values

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

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

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

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

            PostalCdstringRecipient's Postal Code
Size Range: ..16
        EmailstringOptional Recipient's email address.
Size Range: 0..100
        FaxstringOptional Recipient's Fax number.
Size Range: 10
        PhonestringOptional Recipient's Phone Number.
Size Range: 15
    PATRFormDataobjectRecipient's Form 1099-PATR information.
        B1PatronageDivnumberBring in the patron's share of total patronage dividends paid in cash.
Size Range: 0-9999999999.99
        B2NonPatronageDistnumberFor 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
        B3PerUnitAllocationsnumberBring in the patron's share of the total per-unit retain allocations paid in cash.
Size Range: 0-9999999999.99
        B4FedTaxWHnumberBring in backup withholding on patronage payments.
Size Range: 0-9999999999.99
        B5RedmNonQualNoticesnumberBring 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
        B6Sec199AgDeductionnumberFor specified agricultural and horticultural cooperatives only, bring in the patron's share of the amount.
Size Range: 0-9999999999.99
        B7QualPymtsSec199Ab7numberFor specified agricultural and horticultural cooperatives only, bring in the qualified payments paid to the patron.
Size Range: 0-9999999999.99
        B8Sec199AaQualItemsnumberBring 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
        B9Sec199AaSSTBItemsnumberBring 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
        B10InvestmentCreditnumberBring in the patron's share of total investment credit.
Size Range: 0-9999999999.99
        B11WorkOpporCreditnumberBring in the patron's share of total work opportunity credit.
Size Range: 0-9999999999.99
        B12OtherCreditsAndDeductionsnumberBring in the type and amount of each of the credits and deductions.
Size Range: 0-9999999999.99
        B13IsSpecifiedCoopBooleanWhen true, identifies reporting information as a specified agricultural or horticultural cooperative.
        AccountNumstringAccount 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.
        Is2ndTINnotBooleanWhen 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.
Errorsobject[]Shows detailed error information
    IdstringReturns the validation error Id
    NamestringName of the validation error
    MessagestringDescription 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": "2023",
"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
}