# Form1099PATR
# Create
Creates Form 1099-PATR returns in TaxBandits. You can send multiple 1099-PATR forms in a single request for the same Payer. In response, a SubmissionId is created which is further used as a reference for all other methods of Form 1099 PATR API.
POST Form1099PATR/Create
Request Body
Field | Type | Description |
---|---|---|
SubmissionManifest | object | SubmissionManifest provides the brief information about a particular submission on the whole. It contains information like Submission ID, Tax Year, IsPostal, IsFederalFiling, 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: "2021" |
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. |
IsPostal | Boolean | Postal Order will be created when the value is set as True. Once the return is Transmitted, Form 1099-PATR 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-PATR Recipient 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/2021 or 10-20-2021 |
ReturnHeader | object | Contains information about the Business details. |
Business | object | Object to identify the Business Details. |
BusinessId | Guid | Optional Use the unique Business ID (Generated by TaxBandits) you received in response to the Business CREATE Endpoint. By giving the Business ID, you do not have to provide all the business information again. If you do not have a Business ID, ignore the field. |
BusinessNm | string | Name of the business Size Range: ..80 |
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 operatesSize Range: ..80 |
IsEIN | Boolean | When true, identify that the business TIN is an EIN. |
EINorSSN | string | When IsEIN is true, use Employer Identification Number (EIN). When IsEIN is false, use Social Security Number (SSN) Size Range: 9 |
string | Email address of the Business Size Range: ..40 | |
ContactNm | string | Optional Name of the person who can be contacted by the IRS.Size Range: ..27 |
Phone | string | Phone number of the business Size Range: 10 |
PhoneExtn | string | Optional Extension of the business phone numberSize Range: ..5 |
Fax | string | Optional Fax number of the BusinessSize Range: 10 |
BusinessType | string | Optional Type of business. Optional for W-2/1099 and mandatory for 94X seriesSize 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 authoritySize Range: ..35 |
Phone | string | Optional Phone number of the signing authoritySize Range: 10 |
BusinessMemberType | string | Optional Business title of the signing authoritySize 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 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-PATR 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: ..35 |
Address2 | string | Optional Employer/Payer's suite or apartmentSize Range: ..35 |
City | string | Employer/Payer's city Size Range: ..27 |
State | string | Employer/Payer's state code. Refer Static values. Size Range: 2 Allowed values: "AL", "AK", "AZ", "AR", "CA", "CO", "CT", "DE", "DC", "FL", "GA", "HI", "ID", "IL", "IN", "IA", "KS", "KY", "LA", "ME", "MD", "MA", "MI", "MN", "MS", "MO", "MT", "NE", "NV", "NH", "NJ", "NM", "NY", "NC", "ND", "OH", "OK", "OR", "PA", "RI", "SC", "SD", "TN", "TX", "UT", "VT", "VA", "WA", "WV", "WI", "WY", "AS", "FM", "GU", "MH", "MP", "PW", "PR", "VI", "AA", "AE", "AP" |
ZipCd | string | Employer/Payer's zip code Size Range: 9 |
ForeignAddress | object | If IsForeign is true, pass foreign address of the business |
Address1 | string | Employer/Payer's foreign address (street address or post office box of that locality) Size Range: ..35 |
Address2 | string | Optional Employer/Payer's suite or apartmentSize Range: ..35 |
City | string | Employer/Payer's city Size Range: ..27 |
ProvinceOrStateNm | string | Employer/Payer's province or state name Size Range: ..30 |
Country | string | Employer/Payer's country Size Range: 2 Allowed values: "US", "CA", "MX", "AF", "AX", "XI", "AL", "AG", "AQ", "AN", "AO", "AV", "AY", "AC", "AR", "AM", "AA", "XA", "AT", "AS", "AU", "AJ", "XZ", "BF", "BA", "FQ", "BG", "BB", "BS", "BO", "BE", "BH", "BN", "BD", "BT", "BL", "BK", "BC", "BV", "BR", "IO", "VI", "BX", "BU", "UV", "BM", "BY", "CB", "CM", "XY", "CV", "CJ", "CT", "CD", "XC", "CI", "CH", "KT", "IP", "CK", "CO", "CN", "CF", "CG", "CW", "CR", "VP", "CS", "IV", "HR", "CU", "CY", "EZ", "DA", "DX", "DJ", "DO", "DR", "TT", "EC", "EG", "ES", "UK", "EK", "ER", "EN", "ET", "EU", "FK", "FO", "FM", "FJ", "FI", "FR", "FG", "FP", "FS", "GB", "GA", "GZ", "GG", "GM", "GH", "GI", "GO", "GR", "GL", "GJ", "GP", "GQ", "GT", "GK", "GV", "PU", "GY", "HA", "HM", "HO", "HK", "HQ", "HU", "IC", "IN", "ID", "IR", "IZ", "EI", "IS", "IT", "JM", "JN", "JA", "DQ", "JE", "JQ", "JO", "JU", "KZ", "KE", "KQ", "KR", "KN", "KS", "KU", "KG", "LA", "LG", "LE", "LT", "LI", "LY", "LS", "LH", "LU", "MC", "MK", "MA", "MI", "MY", "MV", "ML", "MT", "IM", "RM", "MB", "MR", "MP", "MF", "MQ", "MD", "MN", "MG", "MJ", "MH", "MO", "MZ", "XM", "WA", "NR", "BQ", "NP", "NL", "NT", "NC", "NZ", "NU", "NG", "NI", "NE", "NF", "XN", "CQ", "NO", "MU", "OC", "PK", "LQ", "PS", "PM", "PP", "PF", "PA", "PE", "RP", "PC", "PL", "PO", "RQ", "QA", "RE", "RO", "RS", "RW", "WS", "SM", "TP", "SA", "XS", "SG", "RI", "SE", "SL", "SN", "XR", "LO", "SI", "BP", "SO", "SF", "SX", "SP", "PG", "CE", "SH", "SC", "ST", "SB", "VC", "SU", "NS", "SV", "WZ", "SW", "SZ", "SY", "TW", "TI", "TZ", "TH", "TO", "TL", "TN", "TD", "XT", "TE", "TS", "TU", "TX", "TK", "TV", "UG", "UP", "AE", "UY", "UZ", "NH", "VT", "VE", "VM", "VQ", "WQ", "XW", "WF", "WE", "WI", "YM", "YI", "ZA", "ZI" |
PostalCd | string | Employer/Payer's postal code Size Range: 9 |
ReturnData | object[] | Contains information about the recipient details and Form 1099 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 |
RecordId | Guid | Unique identifier of a record. Not required when you are creating a return. |
Recipient | object | Object to identify the recipient details. |
RecipientId | Guid | TaxBandits generates a unique ID for each recipient after the return is created and returned in the Response. You can use this id for your future reference to update. |
TINType | string | Specify the TIN type of the recipient. Allowed values: "SSN", "EIN", "ITIN", "ATIN", "NA" |
TIN | string | Enter the nine-digit taxpayer identification number of the Recipient (SSN, ITIN, ATIN, or EIN). Size Range: 9 |
FirstPayeeNm | string | Enter the name of the recipient (preferably last name first for an Individual). If more space is required for the name, use the Second Payee Name Field. Size Range: 40 |
SecondPayeeNm | string | Optional If there are multiple recipients (for example, partners, joint owners, or spouses), use this field for those names not associated with the TIN or if not enough space was provided in the First Payee Name, continue the name in this field.Size Range: 40 |
IsForeign | Boolean | When true, it identifies the recipient's address with a foreign address. |
USAddress | object | If IsForeign is false, pass US address of the recipient |
Address1 | string | Recipient's US address (street address or post office box of that locality) Size Range: ..35 |
Address2 | string | Optional Recipient's suite or apartmentSize Range: ..35 |
City | string | Recipient's city Size Range: ..27 |
State | string | Recipient's state code. Refer Static values. Size Range: 2 Allowed values: "AL", "AK", "AZ", "AR", "CA", "CO", "CT", "DE", "DC", "FL", "GA", "HI", "ID", "IL", "IN", "IA", "KS", "KY", "LA", "ME", "MD", "MA", "MI", "MN", "MS", "MO", "MT", "NE", "NV", "NH", "NJ", "NM", "NY", "NC", "ND", "OH", "OK", "OR", "PA", "RI", "SC", "SD", "TN", "TX", "UT", "VT", "VA", "WA", "WV", "WI", "WY", "AS", "FM", "GU", "MH", "MP", "PW", "PR", "VI", "AA", "AE", "AP" |
ZipCd | string | Recipient's zip code Size Range: 9 |
ForeignAddress | object | If IsForeign is true, pass foreign address of the recipient |
Address1 | string | Recipient's foreign address (street address or post office box of that locality) Size Range: ..35 |
Address2 | string | Optional Recipient's suite or apartmentSize Range: ..35 |
City | string | Recipient's city. Size Range: ..27 |
ProvinceOrStateNm | string | Recipient's Province or State Name. Size Range: ..30 |
Country | string | Recipient's country code. Refer Static values. Size Range: 2 Allowed values: "US", "CA", "MX", "AF", "AX", "XI", "AL", "AG", "AQ", "AN", "AO", "AV", "AY", "AC", "AR", "AM", "AA", "XA", "AT", "AS", "AU", "AJ", "XZ", "BF", "BA", "FQ", "BG", "BB", "BS", "BO", "BE", "BH", "BN", "BD", "BT", "BL", "BK", "BC", "BV", "BR", "IO", "VI", "BX", "BU", "UV", "BM", "BY", "CB", "CM", "XY", "CV", "CJ", "CT", "CD", "XC", "CI", "CH", "KT", "IP", "CK", "CO", "CN", "CF", "CG", "CW", "CR", "VP", "CS", "IV", "HR", "CU", "CY", "EZ", "DA", "DX", "DJ", "DO", "DR", "TT", "EC", "EG", "ES", "UK", "EK", "ER", "EN", "ET", "EU", "FK", "FO", "FM", "FJ", "FI", "FR", "FG", "FP", "FS", "GB", "GA", "GZ", "GG", "GM", "GH", "GI", "GO", "GR", "GL", "GJ", "GP", "GQ", "GT", "GK", "GV", "PU", "GY", "HA", "HM", "HO", "HK", "HQ", "HU", "IC", "IN", "ID", "IR", "IZ", "EI", "IS", "IT", "JM", "JN", "JA", "DQ", "JE", "JQ", "JO", "JU", "KZ", "KE", "KQ", "KR", "KN", "KS", "KU", "KG", "LA", "LG", "LE", "LT", "LI", "LY", "LS", "LH", "LU", "MC", "MK", "MA", "MI", "MY", "MV", "ML", "MT", "IM", "RM", "MB", "MR", "MP", "MF", "MQ", "MD", "MN", "MG", "MJ", "MH", "MO", "MZ", "XM", "WA", "NR", "BQ", "NP", "NL", "NT", "NC", "NZ", "NU", "NG", "NI", "NE", "NF", "XN", "CQ", "NO", "MU", "OC", "PK", "LQ", "PS", "PM", "PP", "PF", "PA", "PE", "RP", "PC", "PL", "PO", "RQ", "QA", "RE", "RO", "RS", "RW", "WS", "SM", "TP", "SA", "XS", "SG", "RI", "SE", "SL", "SN", "XR", "LO", "SI", "BP", "SO", "SF", "SX", "SP", "PG", "CE", "SH", "SC", "ST", "SB", "VC", "SU", "NS", "SV", "WZ", "SW", "SZ", "SY", "TW", "TI", "TZ", "TH", "TO", "TL", "TN", "TD", "XT", "TE", "TS", "TU", "TX", "TK", "TV", "UG", "UP", "AE", "UY", "UZ", "NH", "VT", "VE", "VM", "VQ", "WQ", "XW", "WF", "WE", "WI", "YM", "YI", "ZA", "ZI" |
PostalCd | string | Recipient's Postal Code Size Range: 9 |
string | Recipient's email address. Size Range: 0..40 | |
Fax | string | Optional Recipient's Fax number.Size Range: 10 |
Phone | string | Recipient's Phone Number. Size Range: 15 |
PATRFormData | object | Object to create 1099-PATR. |
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 |
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. |
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 PATR records with Success and Error statuses |
SuccessRecords | object[] | It will show detailed information about the success status of Form 1099 PATR 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-PATR return is created. |
RecipientId | Guid | A Unique identifier generated by TaxBandits for a Recipient when a 1099-PATR 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-PATR 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. |
Postal | object | Returns the status and StatusTs of postal mailing service for Form 1099 PATR. |
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 PATR 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 PATR Records. |
SequenceId | string | A unique reference ID for the submission that can be used to identify a particular record. The Sequence ID will be returned in the Response for your reference. |
RecordId | Guid | Unique identifier of a record |
Errors | object[] | Shows detailed error information |
Id | string | Returns the validation error Id |
Name | string | Name of the validation error |
Message | string | Description of the validation error |
Errors | object[] | Shows detailed error information |
Id | string | Returns the validation error Id |
Name | string | Name of the validation error |
Message | string | Description of the validation error |
Request JSON
{
"SubmissionManifest": {
"SubmissionId": null,
"TaxYear": "2021",
"IsFederalFiling": true,
"IsPostal": true,
"IsOnlineAccess": true,
"IsScheduleFiling": true,
"ScheduleFiling": {
"EfileDate": "12/12/2022"
}
},
"ReturnHeader": {
"Business": {
"BusinessId": null,
"PayerRef": "AB101",
"BusinessNm": "Eastman Kodak Com",
"TradeNm": "Kodak Corporates",
"IsEIN": true,
"EINorSSN": "62-7369245",
"Email": "john@gmail.com",
"ContactNm": "John",
"Phone": "1234567890",
"PhoneExtn": "12345",
"Fax": "1234567890",
"BusinessType": "ESTE",
"SigningAuthority": {
"Name": "John",
"Phone": "1234567890",
"BusinessMemberType": "ADMINISTRATOR"
},
"KindOfEmployer": "FederalGovt",
"KindOfPayer": "REGULAR941",
"IsBusinessTerminated": true,
"IsForeign": false,
"USAddress": {
"Address1": "1751 Kinsey Rd",
"Address2": "Main St",
"City": "Dothan",
"State": "AL",
"ZipCd": "36303"
},
"ForeignAddress": {
"Address1": null,
"Address2": null,
"City": null,
"ProvinceOrStateNm": null,
"Country": null,
"PostalCd": null
}
}
},
"ReturnData": [
{
"RecordId": null,
"SequenceId": "1",
"Recipient": {
"RecipientId": null,
"TINType": "EIN",
"TIN": "393817572",
"FirstPayeeNm": "Mark",
"SecondPayeeNm": "Davis",
"IsForeign": false,
"USAddress": {
"Address1": "1751 Kinsey Rd",
"Address2": "Main St",
"City": "Dothan",
"State": "AL",
"ZipCd": "36303"
},
"ForeignAddress": {
"Address1": null,
"Address2": null,
"City": null,
"ProvinceOrStateNm": null,
"Country": null,
"PostalCd": null
},
"Email": "john@gmail.com",
"Fax": "1234567890",
"Phone": "1234567890"
},
"PATRFormData": {
"B1PatronageDiv": 1000.56,
"B2NonPatronageDist": 1000.91,
"B3PerUnitAllocations": 500.49,
"B4FedTaxWH": 408.55,
"B5RedmNonQualNotices": 600.21,
"B6Sec199AgDeduction": 70.40,
"B7QualPymtsSec199Ab7": 800.90,
"B8Sec199AaQualItems": 1000.31,
"B9Sec199AaSSTBItems": 280,
"B10InvestmentCredit": 790.22,
"B11WorkOpporCredit": 150,
"B12OtherCreditsAndDeductions": 500.50,
"B13IsSpecifiedCoop": true,
"Is2ndTINnot": true,
"AccountNum": "20123130000009000001"
}
}
]
}
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
Response JSON
{
"StatusCode": 200,
"StatusName": "Ok",
"StatusMessage": "Successful API call",
"SubmissionId": "48f07d71-9afb-4150-aea7-6822a3374cfc",
"BusinessId": "68a1bb3b-fda4-42ee-a5f3-ce33de3d7538",
"PayerRef": "AB101",
"Form1099Type": "PATR",
"Form1099Records": {
"SuccessRecords": [
{
"SequenceId": "1",
"RecordId": "aa98cb08-adfb-4557-af41-17dbf314f47f",
"RecipientId": "ba7e67f0-400c-4a90-9f56-4039beaa68d2",
"AccountNum": "20123130000009000001",
"FederalReturn": {
"Status": "CREATED",
"StatusTs": "2022-05-06 07:39:30 -04:00",
"Info": null
},
"Postal": {
"Status": "CREATED",
"StatusTs": "2022-05-06 07:39:30 -04:00",
"Info": null
},
"OnlineAccess": {
"Status": "NA",
"Email": null,
"Info": "This service will be available soon"
},
"ScheduleFiling": {
"ScheduledOn": null,
"Info": "This Service will be available soon"
}
}
],
"ErrorRecords": null
},
"Errors": null
}
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
# Delete
Deletes Form 1099-PATR return created in TaxBandits. Transmitted forms cannot be deleted.
DELETE Form1099PATR/Delete
Request Body
Field | Type | Description |
---|---|---|
SubmissionId | Guid | Unique identifier of a submission |
RecordIds | guid[] | An unique identifier generated by TaxBandits when a 1099-PATR return is created. Mention the 1099-PATR return's Record ID that you want to delete. |
Response Body
Field | Type | Description |
---|---|---|
StatusCode | number | Returns the HTTP status codes like 200,300 etc. |
StatusName | string | Name of the status code |
StatusMessage | string | Detailed status message |
SubmissionId | Guid | Unique identifier of a submission |
Form1099Records | object | Pulls the Form 1099 PATR records with Success and Error statuses |
SuccessRecords | object[] | It will show the detailed information about the success status of Form 1099 PATR Records |
SequenceId | string | A unique number is given by an inbound application to identify failed records |
RecordId | Guid | Unique identifier of a record |
Status | string | Returns the status of the records. |
StatusTs | string | Date and time of return deleted. |
ErrorRecords | object[] | It will show the detailed information about the error status of Form 1099 PATR Records. |
SequenceId | string | A unique number given by an inbound application to identify failed records |
RecordId | Guid | Unique identifier of a record |
Errors | object[] | Shows detailed error information |
Id | string | Returns the validation error code |
Name | string | Name of the validation error |
Message | string | Description of the validation error |
Errors | object[] | Shows detailed error information |
Id | string | Returns the validation error code |
Name | string | Name of the validation error |
Message | string | Description of the validation error |
Request JSON
Form1099PATR/Delete?SubmissionId=48f07d71-9afb-4150-aea7-6822a3374cfc&RecordIds=aa98cb08-adfb-4557-af41-17dbf314f47f
Response JSON
{
"StatusCode": 200,
"StatusName": "Ok",
"StatusMessage": "Successful API call",
"SubmissionId": "48f07d71-9afb-4150-aea7-6822a3374cfc",
"Form1099Records": {
"SuccessRecords": [
{
"SequenceId": "1",
"RecordId": "aa98cb08-adfb-4557-af41-17dbf314f47f",
"Status": "DELETED",
"StatusTs": "2022-05-06 08:35:07 -04:00"
}
],
"ErrorRecords": null
},
"Errors": null
}
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
# Get
Retrieves the Form 1099-PATR return information based on the Submission Id and RecordIds given in the request.
GET Form1099PATR/Get
Request Body
Field | Type | Description |
---|---|---|
SubmissionId | Guid | A unique identifier generated by TaxBandits when a 1099-PATR return is created. Mention the Form 1099-PATR return's Submission ID that you want to get. |
RecordIds | Guid[] | A unique identifier generated by TaxBandits when a 1099-PATR return is created. Mention the Form 1099-PATR return's Record ID that you want to get. |
Response Body
Field | Type | Description |
---|---|---|
StatusCode | number | Returns the HTTP status codes like 200,300 etc. |
StatusName | string | Name of the status code |
StatusMessage | string | Detailed status message |
Form1099Records | object | Contains information about Form 1099 PATR returns. |
SubmissionManifest | object | SubmissionManifest provides the brief information about a particular submission on the whole. It contains information like Submission ID, Tax Year, IsPostal, IsFederalFiling, 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: "2021" |
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. |
IsPostal | Boolean | Postal Order will be created when the value is set as True. Once the return is Transmitted, Form 1099-PATR 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-PATR Recipient 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/2021 or 10-20-2021 |
ReturnHeader | object | Contains information about the Business details. |
Business | object | Object to identify the Business Details. |
BusinessId | Guid | Optional Use the unique Business ID (Generated by TaxBandits) you received in response to the Business CREATE Endpoint. By giving the Business ID, you do not have to provide all the business information again. If you do not have a Business ID, ignore the field. |
BusinessNm | string | Name of the business Size Range: ..80 |
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 operatesSize Range: ..80 |
IsEIN | Boolean | When true, identify that the business TIN is an EIN. |
EINorSSN | string | When IsEIN is true, use Employer Identification Number (EIN). When IsEIN is false, use Social Security Number (SSN) Size Range: 9 |
string | Email address of the Business Size Range: ..40 | |
ContactNm | string | Optional Name of the person who can be contacted by the IRS.Size Range: ..27 |
Phone | string | Phone number of the business Size Range: 10 |
PhoneExtn | string | Optional Extension of the business phone numberSize Range: ..5 |
Fax | string | Optional Fax number of the BusinessSize Range: 10 |
BusinessType | string | Optional Type of business. Optional for W-2/1099 and mandatory for 94X seriesSize 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 authoritySize Range: ..35 |
Phone | string | Optional Phone number of the signing authoritySize Range: 10 |
BusinessMemberType | string | Optional Business title of the signing authoritySize 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 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-PATR 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: ..35 |
Address2 | string | Optional Employer/Payer's suite or apartmentSize Range: ..35 |
City | string | Employer/Payer's city Size Range: ..27 |
State | string | Employer/Payer's state code. Refer Static values. Size Range: 2 Allowed values: "AL", "AK", "AZ", "AR", "CA", "CO", "CT", "DE", "DC", "FL", "GA", "HI", "ID", "IL", "IN", "IA", "KS", "KY", "LA", "ME", "MD", "MA", "MI", "MN", "MS", "MO", "MT", "NE", "NV", "NH", "NJ", "NM", "NY", "NC", "ND", "OH", "OK", "OR", "PA", "RI", "SC", "SD", "TN", "TX", "UT", "VT", "VA", "WA", "WV", "WI", "WY", "AS", "FM", "GU", "MH", "MP", "PW", "PR", "VI", "AA", "AE", "AP" |
ZipCd | string | Employer/Payer's zip code Size Range: 9 |
ForeignAddress | object | If IsForeign is true, pass foreign address of the business |
Address1 | string | Employer/Payer's foreign address (street address or post office box of that locality) Size Range: ..35 |
Address2 | string | Optional Employer/Payer's suite or apartmentSize Range: ..35 |
City | string | Employer/Payer's city Size Range: ..27 |
ProvinceOrStateNm | string | Employer/Payer's province or state name Size Range: ..30 |
Country | string | Employer/Payer's country Size Range: 2 Allowed values: "US", "CA", "MX", "AF", "AX", "XI", "AL", "AG", "AQ", "AN", "AO", "AV", "AY", "AC", "AR", "AM", "AA", "XA", "AT", "AS", "AU", "AJ", "XZ", "BF", "BA", "FQ", "BG", "BB", "BS", "BO", "BE", "BH", "BN", "BD", "BT", "BL", "BK", "BC", "BV", "BR", "IO", "VI", "BX", "BU", "UV", "BM", "BY", "CB", "CM", "XY", "CV", "CJ", "CT", "CD", "XC", "CI", "CH", "KT", "IP", "CK", "CO", "CN", "CF", "CG", "CW", "CR", "VP", "CS", "IV", "HR", "CU", "CY", "EZ", "DA", "DX", "DJ", "DO", "DR", "TT", "EC", "EG", "ES", "UK", "EK", "ER", "EN", "ET", "EU", "FK", "FO", "FM", "FJ", "FI", "FR", "FG", "FP", "FS", "GB", "GA", "GZ", "GG", "GM", "GH", "GI", "GO", "GR", "GL", "GJ", "GP", "GQ", "GT", "GK", "GV", "PU", "GY", "HA", "HM", "HO", "HK", "HQ", "HU", "IC", "IN", "ID", "IR", "IZ", "EI", "IS", "IT", "JM", "JN", "JA", "DQ", "JE", "JQ", "JO", "JU", "KZ", "KE", "KQ", "KR", "KN", "KS", "KU", "KG", "LA", "LG", "LE", "LT", "LI", "LY", "LS", "LH", "LU", "MC", "MK", "MA", "MI", "MY", "MV", "ML", "MT", "IM", "RM", "MB", "MR", "MP", "MF", "MQ", "MD", "MN", "MG", "MJ", "MH", "MO", "MZ", "XM", "WA", "NR", "BQ", "NP", "NL", "NT", "NC", "NZ", "NU", "NG", "NI", "NE", "NF", "XN", "CQ", "NO", "MU", "OC", "PK", "LQ", "PS", "PM", "PP", "PF", "PA", "PE", "RP", "PC", "PL", "PO", "RQ", "QA", "RE", "RO", "RS", "RW", "WS", "SM", "TP", "SA", "XS", "SG", "RI", "SE", "SL", "SN", "XR", "LO", "SI", "BP", "SO", "SF", "SX", "SP", "PG", "CE", "SH", "SC", "ST", "SB", "VC", "SU", "NS", "SV", "WZ", "SW", "SZ", "SY", "TW", "TI", "TZ", "TH", "TO", "TL", "TN", "TD", "XT", "TE", "TS", "TU", "TX", "TK", "TV", "UG", "UP", "AE", "UY", "UZ", "NH", "VT", "VE", "VM", "VQ", "WQ", "XW", "WF", "WE", "WI", "YM", "YI", "ZA", "ZI" |
PostalCd | string | Employer/Payer's postal code Size Range: 9 |
ReturnData | object[] | Contains information about the recipient details and Form 1099 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 |
RecordId | Guid | Unique identifier of a record. Not required when you are creating a return. |
Recipient | object | Object to identify the recipient details. |
RecipientId | Guid | TaxBandits generates a unique ID for each recipient after the return is created and returned in the Response. You can use this id for your future reference to update. |
TINType | string | Specify the TIN type of the recipient. Allowed values: "SSN", "EIN", "ITIN", "ATIN", "NA" |
TIN | string | Enter the nine-digit taxpayer identification number of the Recipient (SSN, ITIN, ATIN, or EIN). Size Range: 9 |
FirstPayeeNm | string | Enter the name of the recipient (preferably last name first for an Individual). If more space is required for the name, use the Second Payee Name Field. Size Range: 40 |
SecondPayeeNm | string | Optional If there are multiple recipients (for example, partners, joint owners, or spouses), use this field for those names not associated with the TIN or if not enough space was provided in the First Payee Name, continue the name in this field.Size Range: 40 |
IsForeign | Boolean | When true, it identifies the recipient's address with a foreign address. |
USAddress | object | If IsForeign is false, pass US address of the recipient |
Address1 | string | Recipient's US address (street address or post office box of that locality) Size Range: ..35 |
Address2 | string | Optional Recipient's suite or apartmentSize Range: ..35 |
City | string | Recipient's city Size Range: ..27 |
State | string | Recipient's state code. Refer Static values. Size Range: 2 Allowed values: "AL", "AK", "AZ", "AR", "CA", "CO", "CT", "DE", "DC", "FL", "GA", "HI", "ID", "IL", "IN", "IA", "KS", "KY", "LA", "ME", "MD", "MA", "MI", "MN", "MS", "MO", "MT", "NE", "NV", "NH", "NJ", "NM", "NY", "NC", "ND", "OH", "OK", "OR", "PA", "RI", "SC", "SD", "TN", "TX", "UT", "VT", "VA", "WA", "WV", "WI", "WY", "AS", "FM", "GU", "MH", "MP", "PW", "PR", "VI", "AA", "AE", "AP" |
ZipCd | string | Recipient's zip code Size Range: 9 |
ForeignAddress | object | If IsForeign is true, pass foreign address of the recipient |
Address1 | string | Recipient's foreign address (street address or post office box of that locality) Size Range: ..35 |
Address2 | string | Optional Recipient's suite or apartmentSize Range: ..35 |
City | string | Recipient's city. Size Range: ..27 |
ProvinceOrStateNm | string | Recipient's Province or State Name. Size Range: ..30 |
Country | string | Recipient's country code. Refer Static values. Size Range: 2 Allowed values: "US", "CA", "MX", "AF", "AX", "XI", "AL", "AG", "AQ", "AN", "AO", "AV", "AY", "AC", "AR", "AM", "AA", "XA", "AT", "AS", "AU", "AJ", "XZ", "BF", "BA", "FQ", "BG", "BB", "BS", "BO", "BE", "BH", "BN", "BD", "BT", "BL", "BK", "BC", "BV", "BR", "IO", "VI", "BX", "BU", "UV", "BM", "BY", "CB", "CM", "XY", "CV", "CJ", "CT", "CD", "XC", "CI", "CH", "KT", "IP", "CK", "CO", "CN", "CF", "CG", "CW", "CR", "VP", "CS", "IV", "HR", "CU", "CY", "EZ", "DA", "DX", "DJ", "DO", "DR", "TT", "EC", "EG", "ES", "UK", "EK", "ER", "EN", "ET", "EU", "FK", "FO", "FM", "FJ", "FI", "FR", "FG", "FP", "FS", "GB", "GA", "GZ", "GG", "GM", "GH", "GI", "GO", "GR", "GL", "GJ", "GP", "GQ", "GT", "GK", "GV", "PU", "GY", "HA", "HM", "HO", "HK", "HQ", "HU", "IC", "IN", "ID", "IR", "IZ", "EI", "IS", "IT", "JM", "JN", "JA", "DQ", "JE", "JQ", "JO", "JU", "KZ", "KE", "KQ", "KR", "KN", "KS", "KU", "KG", "LA", "LG", "LE", "LT", "LI", "LY", "LS", "LH", "LU", "MC", "MK", "MA", "MI", "MY", "MV", "ML", "MT", "IM", "RM", "MB", "MR", "MP", "MF", "MQ", "MD", "MN", "MG", "MJ", "MH", "MO", "MZ", "XM", "WA", "NR", "BQ", "NP", "NL", "NT", "NC", "NZ", "NU", "NG", "NI", "NE", "NF", "XN", "CQ", "NO", "MU", "OC", "PK", "LQ", "PS", "PM", "PP", "PF", "PA", "PE", "RP", "PC", "PL", "PO", "RQ", "QA", "RE", "RO", "RS", "RW", "WS", "SM", "TP", "SA", "XS", "SG", "RI", "SE", "SL", "SN", "XR", "LO", "SI", "BP", "SO", "SF", "SX", "SP", "PG", "CE", "SH", "SC", "ST", "SB", "VC", "SU", "NS", "SV", "WZ", "SW", "SZ", "SY", "TW", "TI", "TZ", "TH", "TO", "TL", "TN", "TD", "XT", "TE", "TS", "TU", "TX", "TK", "TV", "UG", "UP", "AE", "UY", "UZ", "NH", "VT", "VE", "VM", "VQ", "WQ", "XW", "WF", "WE", "WI", "YM", "YI", "ZA", "ZI" |
PostalCd | string | Recipient's Postal Code Size Range: 9 |
string | Recipient's email address. Size Range: 0..40 | |
Fax | string | Optional Recipient's Fax number.Size Range: 10 |
Phone | string | Recipient's Phone Number. Size Range: 15 |
PATRFormData | object | Object to create 1099-PATR. |
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 |
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 |
Request JSON
Form1099PATR/Get?SubmissionId=48f07d71-9afb-4150-aea7-6822a3374cfc&RecordIds=aa98cb08-adfb-4557-af41-17dbf314f47f
Response JSON
{
"StatusCode": 200,
"StatusName": "Ok",
"StatusMessage": "Successful API call",
"Form1099Records": {
"SubmissionManifest": {
"SubmissionId": "48f07d71-9afb-4150-aea7-6822a3374cfc",
"TaxYear": "2021",
"IsFederalFiling": true,
"IsPostal": true,
"IsOnlineAccess": true,
"IsScheduleFiling": true,
"ScheduleFiling": {
"EfileDate": "12/12/2022"
}
},
"ReturnHeader": {
"Business": {
"BusinessId": "68a1bb3b-fda4-42ee-a5f3-ce33de3d7538",
"PayerRef": "AB101",
"BusinessNm": "Eastman Kodak Com",
"TradeNm": "Kodak Corporates",
"IsEIN": true,
"EINorSSN": "62-7369245",
"Email": "john@gmail.com",
"ContactNm": "John",
"Phone": "(123) 456-7890",
"PhoneExtn": "12345",
"Fax": "(123) 456-7890",
"BusinessType": "ESTE",
"SigningAuthority": {
"Name": "John",
"Phone": "(123) 456-7890",
"BusinessMemberType": "ADMINISTRATOR"
},
"KindOfEmployer": "FEDERALGOVT",
"KindOfPayer": "REGULAR941",
"IsBusinessTerminated": true,
"IsForeign": false,
"USAddress": {
"Address1": "1751 Kinsey Rd",
"Address2": "Main St",
"City": "Dothan",
"State": "AL",
"ZipCd": "36303"
},
"ForeignAddress": null,
"IsGovernmentalUnit": false
}
},
"ReturnData": [
{
"RecordId": "aa98cb08-adfb-4557-af41-17dbf314f47f",
"SequenceId": "1",
"Recipient": {
"RecipientId": "ba7e67f0-400c-4a90-9f56-4039beaa68d2",
"TINType": "EIN",
"TIN": "39-3817572",
"FirstPayeeNm": "Mark",
"SecondPayeeNm": "Davis",
"IsForeign": false,
"USAddress": {
"Address1": "1751 Kinsey Rd",
"Address2": "Main St",
"City": "Dothan",
"State": "AL",
"ZipCd": "36303"
},
"ForeignAddress": null,
"Email": "john@gmail.com",
"Fax": "(123) 456-7890",
"Phone": "(123) 456-7890"
},
"PATRFormData": {
"B1PatronageDiv": 1000.56,
"B2NonPatronageDist": 1000.91,
"B3PerUnitAllocations": 500.49,
"B4FedTaxWH": 408.55,
"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": "20123130000009000001",
"Is2ndTINnot": true
}
}
]
},
"Errors": null
}
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
# GetPDF
Retrieves Form 1099 PATR PDFs. The link for PDFs download will be sent via Webhook after successful API call.
GET Form1099PATR/GetPDF
Request Body
Field | Type | Description |
---|---|---|
SubmissionId | Guid | Unique identifier of a submission |
RecordIds | Guid[] | Optional Unique identifier of a records. |
TINMaskType | string | Optional Choose the masking type of your Recipient's TIN on the 1099-PATR PDF. MASKED - The Recipient's TIN will be masked in the PDF. Only the last 4 digits of the TIN can be read.UNMASKED - The Recipient's TIN will not be masked in the PDF. To protect the PII information of the Recipient, the PDF with Unmasked TIN is password protected. Use the Recipient's TIN (password) to open the protected file.BOTH - Two PDFs will be delivered for each Recipient. One with Masked TIN and the other with Unmasked TIN. The PDF with Unmasked TIN will be password protected.Allowed values: "MASKED", "UNMASKED", "BOTH" |
Response Body
Field | Type | Description |
---|---|---|
StatusCode | number | Returns the HTTP status codes like 200,300 etc. |
StatusName | string | Name of the status code |
StatusMessage | string | Detailed status message |
SubmissionId | Guid | Unique identifier of a submission |
Form1099RRecords | object[] | Collection of Form 1099-PATR records for which the PDF will be successfully delivered |
RecordId | guid | Unique identifier of a record |
Message | string | Provides additional information regarding the PDF delivery. |
Errors | object[] | Shows detailed error information |
Id | string | Returns the validation error code |
Name | string | Name of the validation error |
Message | string | Description of the validation error |
Type | string | Type of validation error |
Request JSON
Form1099PATR/GetPdf?SubmissionId=48f07d71-9afb-4150-aea7-6822a3374cfc&RecordIds=55f703fc-4456-4ca6-ab5a-004cf714a95f&TINMaskType=UNMASKED
Response JSON
{
"StatusCode": 200,
"StatusName": "Ok",
"StatusMessage": "Successful API call",
"SubmissionId": "48f07d71-9afb-4150-aea7-6822a3374cfc",
"Form1099PatrRecords": [
{
"RecordId": "55f703fc-4456-4ca6-ab5a-004cf714a95f",
"Message": "We've successfully received your request to generate PDF. You will be notified with the URL to download the PDF."
}
],
"Errors": null
}
2
3
4
5
6
7
8
9
10
11
12
13
# List
Lists all Form 1099-PATR returns in TaxBandits that have been created and transmitted for a particular SubmissionId or BusinessId. Based on the filters supplied in the request, the results will be listed. If you provide a BusinessId, for example, all returns created under that BusinessId will be listed.
GET Form1099PATR/List
Request Body
Field | Type | Description |
---|---|---|
SubmissionId | Guid | Unique identifier of a submission |
BusinessId | Guid | Unique identifier of a business |
TINType | string | List the 1099 PATR records based on the given TINType and TIN. |
TIN | string | List the 1099 PATR records based on the given TIN. |
TaxYear | string | List the 1099 PATR records based on the given taxyear. |
Page | number | Pulls the records listed in the page selected |
PageSize | number | Number of 1099 PATR records to be listed in each page. |
EfileStatus | string | List the 1099 PATR records based on the status ("CREATED, UNDERPROCESS, SENTTOAGENCY, TRANSMITTED, ACCEPTED, REJECTED") |
FromDate | string | Enter a date from which the Form 1099-PATR records need to be listed. |
ToDate | string | Enter a date till which the 1099-PATR records created are to be listed. |
Response Body
Field | Type | Description |
---|---|---|
StatusCode | number | Returns the HTTP status codes like 200,300 etc. |
StatusName | string | Name of the status code |
StatusMessage | string | Detailed status message |
Form1099Type | string | Denotes the type of 1099 form. |
Form1099Records | object[] | Returns detailed information of the Form 1099 R records. |
SubmissionId | Guid | Unique identifier of a submission |
BusinessId | Guid | Unique identifier of a business |
PayerRef | string | Unique identifier of the payer. |
BusinessNm | string | Name of the business |
IsEIN | Boolean | When true, identifies the business with an EIN. |
EINorSSN | string | When IsEIN is true, use Employer Identification Number (EIN). When IsEIN is false, use Social Security Number (SSN) |
ContactNm | string | Contact Name of the Business. |
TaxYear | string | Tax year of 1099 PATR to be filed. |
Recipient | object | Details of the Recipient. |
SequenceId | string | A unique reference ID for the submission that can be used to identify a particular record. The Sequence ID will be returned in the Response for your reference. |
RecordId | Guid | A unique identifier generated by TaxBandits when a 1099-PATR return is created. |
RecipientId | Guid | A unique identifier generated by TaxBandits for a Recipient when a 1099-PATR return is created. You can use this id for your future reference to Update. |
RecipientNm | Boolean | Name of Recipient. |
TINType | string | TIN type of the Recipient. |
TIN | string | TIN of the Recipient. |
Status | string | The status of Form 1099 PATR. |
TotalRecords | number | Total number of records. |
TotalPages | number | Total number of pages. |
Page | number | Pulls the records listed in the page selected |
PageSize | number | Number of 1099 PATR records to be listed in each page. |
Errors | object[] | Shows detailed error information |
Id | string | Returns the validation error id |
Name | string | Name of the validation error |
Message | string | Description of the validation error |
Request JSON
"Form1099PATR/List?SubmissionId=48f07d71-9afb-4150-aea7-6822a3374cfc&BusinessId=cfa1f87c-046d-47a6-b69d-3b17ec006c27&TINType=SSN&TIN=043313330&TaxYear=2021&Page=1&PageSize=10&EfileStatus=ALL&FromDate=11-01-2021&ToDate=11-30-2021"
Response JSON
{
"StatusCode": 200,
"StatusName": "Ok",
"StatusMessage": "Successful API call",
"Form1099Type": "PATR",
"Form1099Records": [
{
"SubmissionId": "48f07d71-9afb-4150-aea7-6822a3374cfc",
"BusinessId": "cfa1f87c-046d-47a6-b69d-3b17ec006c27",
"PayerRef": "AB101",
"BusinessNm": "Eastman Kodak Com",
"IsEIN": false,
"EINorSSN": "043313330",
"ContactNm": "John",
"TaxYear": "2021",
"Recipient": {
"SequenceId": "1",
"RecordId": "aa98cb08-adfb-4557-af41-17dbf314f47f",
"RecipientId": "ba7e67f0-400c-4a90-9f56-4039beaa68d2",
"RecipientNm": "Mark Davis",
"TINType": "EIN",
"TIN": "39-3817572",
"Status": "CREATED"
}
}
],
"Page": 1,
"TotalRecords": 1,
"TotalPages": 1,
"PageSize": 100,
"Errors": null
}
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
# RequestDraftPdfUrl
This API request will return the Draft PDF of the forms that are not transmitted yet for review purpose. The draft PDF will have copy A of the form with For Review Only watermark text.
Note: You can only retrieve PDF of a single record/form using this method.
How does it works?
Call the [POST] Form1099PATR/RequestDraftPdfUrl endpoint. You will need to supply the following parameters:
Access Token in the header as Bearer Token (Generated using TaxBandits OAuth authentication API)
Request Parameters: Specify the RecordId for the form you need the Draft PDF form. If you do not have the RecordId, then you request the PDF using the following parameters
- Business Reference - Use the business reference PayerRef or BusinessId or TIN.
- Recipient Reference - Use the recipient reference PayeeRef or RecipientId or TIN.
- Tax Year - Tax year of the form you are requesting the PDF.
POST Form1099PATR/RequestDraftPdfUrl
Request Body
Field | Type | Description |
---|---|---|
RecordId | Guid | Optional Specify the RecordId of the return |
TINMaskType | string | Optional TIN Mask type on the TIN printed on the PDFAllowed values: "MASKED", "UNMASKED" |
TaxYear | string | Optional Tax Year of the return. Specify only if you do not have the RecordId |
Business | object | Optional Collects the Business identifier TIN or TBS Business Id or PayerRef. This object information is required only if you do not have the RecordId |
BusinessId | Guid | Optional TaxBandits Unique Business Identifier. This ID is generated by TaxBandits after you create a business in your account using the Business endpoint. |
PayerRef | string | Optional Unique payer identifier assigned by the client.Size Range: 1 to 50 |
TINType | string | Optional TIN type of the Business TIN. Use this as an alternative for BusinessId or PayerRef.Allowed values: "SSN,EIN" |
TIN | string | Optional Taxpayer Identification Number. Use this as an alternative for BusinessId or PayerRef.Size Range: 9 to 11 |
Recipient | object | Optional Collects the recipient's unique identifier. This object information is required only if you do not have the RecordId |
PayeeRef | string | Optional An unique identifier for each recipient set by the client.Size Range: 1 to 50 |
RecipientId | Guid | Optional Unique Recipient Identifier generated by TaxBandits |
TINType | string | Optional TIN type of the Recipient’s TIN. Use this as an alternative for RecipientId or PayeeRef.Allowed values: "SSN,EIN" |
TIN | string | Optional Taxpayer Identification Number. Use this as an alternative for RecipientId or PayeeRef. |
Response Body
Field | Type | Description |
---|---|---|
RecordId | Guid | Unique identifier of the record |
RecipientId | Guid | Unique Recipient Identifier generated by TaxBandits |
PayeeRef | string | An unique identifier for each recipient set by the client. |
DraftPdfUrl | string | URL of the Draft PDF |
Errors | object[] | Shows detailed error information |
Id | string | Returns the validation error code |
Name | string | Name of the validation error |
Message | string | Description of the validation error |
Request JSON 1: With just the RecordId
{
"TaxYear": null,
"RecordId": "7dc8bea4-97b1-42fd-adf4-ac8537abbeb1",
"Business": null,
"Recipient": null
}
2
3
4
5
6
Response JSON 1
{
"RecordId": "7dc8bea4-97b1-42fd-adf4-ac8537abbeb1",
"RecipientId": "48e386a9-7e24-4780-966e-dc5835d0f4b0",
"PayeeRef": null,
"DraftPdfUrl": "https://expressirsforms.s3.us-east-1.amazonaws.com/pdfs/7dbfa93b-1b4e-4870-a875-b3636d875522/1e9ed204-870f-4b61-acac-6c3ecf11abf6/1099/898502/d/copy_draft_1up_4527963308.pdf",
"Error": null
}
2
3
4
5
6
7
Request JSON 2: With No RecordId
{
"TaxYear": "2021",
"RecordId": null,
"Business": {
"BusinessId": "94B6214D-8DCA-490C-8FC3-602840B439B5",
"PayerRef": null,
"TINType": null,
"TIN": null
},
"Recipient": {
"RecipientId": "6DDFFB5A-565F-402D-8602-7ECD917CEC04",
"PayeeRef": null,
"TINType": null,
"TIN": null
}
}
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
Response JSON 2
{
"RecordId": "cf0a188b-6661-4b57-b04b-ba9ead52a16e",
"RecipientId": "6DDFFB5A-565F-402D-8602-7ECD917CEC04",
"PayeeRef": null,
"DraftPdfUrl":"https://expressirsforms.s3.us-east-1.amazonaws.com/pdfs/7dbfa93b-1b4e-4870-a875-b3636d875522/1e9ed204-870f-4b61-acac-6c3ecf11abf6/1099/898502/d/copy_draft_1up_4527963308.pdf",
"Error": null
}
2
3
4
5
6
7
# RequestPdfURLs
This method can be used to retrieve PDFs for single or multiple recipients. The PDF URL will be returned in the response only if it is already generated by us. You can use the SubmissionId or RecordIds to request the pdf URLs.
Note: The PDF URL will be returned in response only after the return is transmitted in the API. This method will not work for Inprogress returns.
POST Form1099PATR/RequestPdfURLs
Request Body
Field | Type | Description |
---|---|---|
SubmissionId | Guid | Optional Unique identifier of an API submission. Use this node to request the PDFs under a particular submission. If you are going to request the PDFs using the RecordIds, you can leave the SubmissionId blank or null. |
RecordIds | object[] | Contains the list of RecordIds for which you are requesting the pdf URLs |
RecordId | Guid | Unique identifier of the return. |
Customization | object | Contains PDF customizations |
TINMaskType | string | Optional Mention whether you want the TIN to be masked in the PDF. If masked, only the last digits of the SSN will be visible and the rest of the digits will be crossed (xxx-xx-1234).Allowed values: "MASKED", "UNMASKED", "BOTH" |
Response Body
Field | Type | Description |
---|---|---|
SubmissionId | Guid | Unique identifier of a submission. |
Form1099PATRRecords | object | Contains success and error records of the requested RecordIds. |
SuccessRecords | object[] | Contains the successful records with pdf urls if the forms are generated. |
RecordId | Guid | Unique identifier of the return. |
Status | string | Status of the PDF in TaxBandits. Success - The PDF is generated and you can download it. |
Files | object | Contains multiple copies of a particular return. |
CopyB | object | Copy B: Report this income on your federal tax return. If this form shows federal income tax withheld in box 4, attach this copy to your return. |
Unmasked | string | Link to download the Unmasked copy |
Masked | string | Link to download the Masked copy |
CopyC | object | Copy C: For Recipient's Records |
Unmasked | string | Link to download the Unmasked copy |
Masked | string | Link to download the Masked copy |
ErrorRecords | object[] | Contains the error records |
RecordId | Guid | Unique identifier of the return. |
Status | string | Status of the error record.
|
Message | string | Description of each statuses |
Errors | object[] | Lists the errors in the API call |
Id | string | Returns the error Id. |
Name | string | Name of the validation error |
Message | string | Description of the validation error |
Sample Request JSON 1
{
"SubmissionId": "dc888e87-ecf4-4d64-a13b-61458cb86763",
"RecordIds": [
{
"RecordId": "868fb473-ea8d-4d9c-8c89-cfc13ed173c6"
}
],
"Customization": {
"TINMaskType": "Masked"
}
}
2
3
4
5
6
7
8
9
10
11
Sample Response JSON 1
{
"SubmissionId": "fba1a7e0-3d87-4ee9-9af7-4d69dd5e809e",
"Form1099PatrRecords": {
"SuccessRecords": [
{
"RecordId": "4e07bd11-f401-46fc-9bb9-7e704c3039e6",
"Status": "Success",
"Files": {
"CopyB": {
"Unmasked": null,
"Masked": "https://expressirsforms.s3.us-east-1.amazonaws.com/pdfs/7dbfa93b-1b4e-4870-a875-b3636d875522/1e9ed204-870f-4b61-acac-6c3ecf11abf6/1099/e802edcd-b3e5-4862-a130-2f0e97e874d5/m/copyb_1up_1832865058.pdf"
},
"CopyC": {
"Unmasked": null,
"Masked": "https://expressirsforms.s3.us-east-1.amazonaws.com/pdfs/7dbfa93b-1b4e-4870-a875-b3636d875522/1e9ed204-870f-4b61-acac-6c3ecf11abf6/1099/e802edcd-b3e5-4862-a130-2f0e97e874d5/m/copyc_1up_4909817891.pdf"
}
}
}
],
"ErrorRecords": null
},
"Errors": null
}
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
Sample Request JSON 2
{
"SubmissionId": "a863c015-91f1-4128-84fc-bb38922b80f9",
"RecordIds": [
{
"RecordId": "c4446e74-ee11-43e4-b9db-a7e870714267"
},
{
"RecordId": "f11413f7-3fe3-4d55-9e87-66b687bc404e"
}
],
"Customization": {
"TINMaskType": "Masked"
}
}
2
3
4
5
6
7
8
9
10
11
12
13
14
Sample Response JSON 2
{
"SubmissionId": null,
"Form1099PATRRecords": {
"SuccessRecords": null,
"ErrorRecords": [
{
"RecordId": "c4446e74-ee11-43e4-b9db-a7e870714267",
"Status": "PDF_Not_Generated",
"Message": "Your PDF request is prioritized in the queue.Please try again after sometime"
},
{
"RecordId": "f11413f7-3fe3-4d55-9e87-66b687bc404e",
"Status": "Not Transmitted",
"Message": "Given RecordId is not transmitted"
}
]
},
"Errors": null
}
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
Sample Request JSON 3
{
"RecordIds": [
{
"RecordId": "c4446e74-ee11-43e4-b9db-a7e870714267"
},
{
"RecordId": "f11413f7-3fe3-4d55-9e87-66b687bc404e"
}
]
}
2
3
4
5
6
7
8
9
10
11
Sample Response JSON 3
{
"SubmissionId": null,
"Form1099PATRRecords": {
"SuccessRecords": null,
"ErrorRecords": [
{
"RecordId": "c4446e74-ee11-43e4-b9db-a7e870714267",
"Status": "PDF_Not_Generated",
"Message": "Your PDF request is prioritized in the queue.Please try again after sometime"
},
{
"RecordId": "f11413f7-3fe3-4d55-9e87-66b687bc404e",
"Status": "Not Transmitted",
"Message": "Given RecordId is not transmitted"
}
]
},
"Errors": null
}
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
# Status
This method will return the current status of Form 1099 for a particular submission or for a particular employee.
Federal Return Statuses:
Created: Form 1099 has been created and not yet transmitted by the user.
Transmitted: Form 1099 has been transmitted by the user.
Order Received: Form 1099 order is received and waiting in our efile queue.
Under Process: Our efile system is processing the Form 1099 which will be sent to the IRS soon.
Sent to Agency: Form 1099 has been sent to the SSA and we are waiting for the result from IRS.
Accepted: Form 1099 is accepted by the IRS.
Rejected: Form 1099 is rejected by the IRS due to some errors. Please correct the errors and retransmit them.
Postal Mailing Statuses:
Not Created: Postal Mailing is not opted for the return. IsPostalMailing in the submission manifest must be set as TRUE to enable postal mailing. Postal Mailing cannot be created for recipients with Foreign addresses.
Created: Postal Mailing service is opted for the return and it will be sent as soon as the form is transmitted.
Order Received: Postal Mailing order has been received and the mails will be sent out soon.
Order Sent: Postal Mailing order has been sent and the recipient will receive the copy soon.
GET Form1099PATR/Status
Request Body
Field | Type | Description |
---|---|---|
SubmissionId | Guid | Unique identifier of a submission |
RecordIds | Guid[] | Number of record Ids to get status. |
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 PATR records with Success and Error statuses |
SuccessRecords | object[] | It will show detailed information about the success status of Form 1099 PATR 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-PATR return is created. |
RecipientId | Guid | A Unique identifier generated by TaxBandits for a Recipient when a 1099-PATR return is created. You can use this id for your future reference to Update. |
FederalReturn | object | Returns the record status and StatusTs of federal return. |
Status | string | Returns the record status. |
StatusTs | string | Returns date and time of return created. |
Info | string | Returns information about the Federal Filing service. |
Postal | object | Returns the status and StatusTs of postal mailing service for Form 1099 PATR. |
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 PATR 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 PATR Records. |
SequenceId | string | A unique reference ID for the submission that can be used to identify a particular record. The Sequence ID will be returned in the Response for your reference. |
RecordId | Guid | Unique identifier of a record |
Errors | object[] | Shows detailed error information |
Id | string | Returns the validation error Id |
Name | string | Name of the validation error |
Message | string | Description of the validation error |
Errors | object[] | Shows detailed error information |
Id | string | Returns the validation error Id |
Name | string | Name of the validation error |
Message | string | Description of the validation error |
Request JSON
Form1099PATR/Status?SubmissionId=48f07d71-9afb-4150-aea7-6822a3374cfc&RecordIds=aa98cb08-adfb-4557-af41-17dbf314f47f
Response JSON
{
"StatusCode": 200,
"StatusName": "Ok",
"StatusMessage": "Successful API call",
"SubmissionId": "48f07d71-9afb-4150-aea7-6822a3374cfc",
"BusinessId": "68a1bb3b-fda4-42ee-a5f3-ce33de3d7538",
"PayerRef": "AB101",
"Form1099Type": "PATR",
"Form1099Records": {
"SuccessRecords": [
{
"SequenceId": "1",
"RecordId": "aa98cb08-adfb-4557-af41-17dbf314f47f",
"RecipientId": "ba7e67f0-400c-4a90-9f56-4039beaa68d2",
"FederalReturn": {
"Status": "CREATED",
"StatusTs": "2022-05-06 07:56:59 -04:00",
"Info": null
},
"Postal": {
"Status": "CREATED",
"StatusTs": "2022-05-06 07:56:58 -04:00",
"Info": null
},
"OnlineAccess": {
"Status": "NA",
"Email": null,
"Info": "This service will be available soon"
},
"ScheduleFiling": {
"ScheduledOn": null,
"Info": "This service will be available soon"
}
}
],
"ErrorRecords": null
},
"Errors": null
}
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
# Transmit
Transmits the Form 1099-PATR return to the IRS. You can Transmit a return successfully only if there are no validation errors in the return.
POST Form1099PATR/Transmit
Request Body
Field | Type | Description |
---|---|---|
SubmissionId | guid | A unique identifier generated by TaxBandits when a 1099-PATR return is created. Mention the 1099-PATR return's Submission ID that you want to transmit. |
RecordIds | Guid[] | A unique identifier generated by TaxBandits when a 1099-PATR return is created. Mention the 1099-PATR return's Record ID that you want to transmit. |
Response Body
Field | Type | Description |
---|---|---|
StatusCode | number | Returns the HTTP status codes like 200,300 etc. |
StatusName | string | Name of the status code |
StatusMessage | string | Detailed status message |
SubmissionId | Guid | Unique identifier of a submission |
Form1099Records | object | Pulls the Form 1099 PATR records with Success and Error statuses |
SuccessRecords | object[] | It will show the detailed information about the success status of Form 1099 PATR Records |
SequenceId | string | A unique reference ID for the submission that can be used to identify a particular record. The Sequence ID will be returned in the Response for your reference. |
RecordId | Guid | Unique identifier of a record |
Status | string | Returns the status of the records. |
StatusTs | string | Date and Time of the Return Transmission |
ErrorRecords | object[] | It will show the detailed information about the error status of Form 1099 PATR Records. |
SequenceId | string | A unique reference ID for the submission that can be used to identify a particular record. The Sequence ID will be returned in the Response for your reference. |
RecordId | Guid | Unique identifier of a record |
Errors | object[] | Shows detailed error information |
Id | string | Returns the validation error Id |
Name | string | Name of the validation error |
Message | string | Description of the validation error |
Errors | object[] | Shows detailed error information |
Id | string | Returns the validation error Id |
Name | string | Name of the validation error |
Message | string | Description of the validation error |
Request JSON
{
"SubmissionId": "48f07d71-9afb-4150-aea7-6822a3374cfc",
"RecordIds": [
"aa98cb08-adfb-4557-af41-17dbf314f47f"
]
}
2
3
4
5
6
Response JSON
{
"StatusCode": 200,
"StatusName": "Ok",
"StatusMessage": "Successful API call",
"SubmissionId": "48f07d71-9afb-4150-aea7-6822a3374cfc",
"Form1099Records": {
"SuccessRecords": [
{
"SequenceId": "1",
"RecordId": "aa98cb08-adfb-4557-af41-17dbf314f47f",
"Status": "Transmitted",
"StatusTs": "2022-05-06 08:27:26 -04:00"
}
],
"ErrorRecords": null
},
"Errors": null
}
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
# Update
You can make changes to an existing Form 1099-PATR return in TaxBandits. Use the unique identifiers like SubmissionId, Tax year, etc to refer to a specific return to update the existing data. A Transmitted return cannot be modified.
PUT Form1099PATR/Update
Request Body
Field | Type | Description |
---|---|---|
SubmissionManifest | object | SubmissionManifest provides the brief information about a particular submission on the whole. It contains information like Submission ID, Tax Year, IsPostal, IsFederalFiling, 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: "2021" |
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. |
IsPostal | Boolean | Postal Order will be created when the value is set as True. Once the return is Transmitted, Form 1099-PATR 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-PATR Recipient 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/2021 or 10-20-2021 |
ReturnHeader | object | Contains information about the Business details. |
Business | object | Object to identify the Business Details. |
BusinessId | Guid | Optional Use the unique Business ID (Generated by TaxBandits) you received in response to the Business CREATE Endpoint. By giving the Business ID, you do not have to provide all the business information again. If you do not have a Business ID, ignore the field. |
BusinessNm | string | Name of the business Size Range: ..80 |
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 operatesSize Range: ..80 |
IsEIN | Boolean | When true, identify that the business TIN is an EIN. |
EINorSSN | string | When IsEIN is true, use Employer Identification Number (EIN). When IsEIN is false, use Social Security Number (SSN) Size Range: 9 |
string | Email address of the Business Size Range: ..40 | |
ContactNm | string | Optional Name of the person who can be contacted by the IRS.Size Range: ..27 |
Phone | string | Phone number of the business Size Range: 10 |
PhoneExtn | string | Optional Extension of the business phone numberSize Range: ..5 |
Fax | string | Optional Fax number of the BusinessSize Range: 10 |
BusinessType | string | Optional Type of business. Optional for W-2/1099 and mandatory for 94X seriesSize 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 authoritySize Range: ..35 |
Phone | string | Optional Phone number of the signing authoritySize Range: 10 |
BusinessMemberType | string | Optional Business title of the signing authoritySize 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 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-PATR 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: ..35 |
Address2 | string | Optional Employer/Payer's suite or apartmentSize Range: ..35 |
City | string | Employer/Payer's city Size Range: ..27 |
State | string | Employer/Payer's state code. Refer Static values. Size Range: 2 Allowed values: "AL", "AK", "AZ", "AR", "CA", "CO", "CT", "DE", "DC", "FL", "GA", "HI", "ID", "IL", "IN", "IA", "KS", "KY", "LA", "ME", "MD", "MA", "MI", "MN", "MS", "MO", "MT", "NE", "NV", "NH", "NJ", "NM", "NY", "NC", "ND", "OH", "OK", "OR", "PA", "RI", "SC", "SD", "TN", "TX", "UT", "VT", "VA", "WA", "WV", "WI", "WY", "AS", "FM", "GU", "MH", "MP", "PW", "PR", "VI", "AA", "AE", "AP" |
ZipCd | string | Employer/Payer's zip code Size Range: 9 |
ForeignAddress | object | If IsForeign is true, pass foreign address of the business |
Address1 | string | Employer/Payer's foreign address (street address or post office box of that locality) Size Range: ..35 |
Address2 | string | Optional Employer/Payer's suite or apartmentSize Range: ..35 |
City | string | Employer/Payer's city Size Range: ..27 |
ProvinceOrStateNm | string | Employer/Payer's province or state name Size Range: ..30 |
Country | string | Employer/Payer's country Size Range: 2 Allowed values: "US", "CA", "MX", "AF", "AX", "XI", "AL", "AG", "AQ", "AN", "AO", "AV", "AY", "AC", "AR", "AM", "AA", "XA", "AT", "AS", "AU", "AJ", "XZ", "BF", "BA", "FQ", "BG", "BB", "BS", "BO", "BE", "BH", "BN", "BD", "BT", "BL", "BK", "BC", "BV", "BR", "IO", "VI", "BX", "BU", "UV", "BM", "BY", "CB", "CM", "XY", "CV", "CJ", "CT", "CD", "XC", "CI", "CH", "KT", "IP", "CK", "CO", "CN", "CF", "CG", "CW", "CR", "VP", "CS", "IV", "HR", "CU", "CY", "EZ", "DA", "DX", "DJ", "DO", "DR", "TT", "EC", "EG", "ES", "UK", "EK", "ER", "EN", "ET", "EU", "FK", "FO", "FM", "FJ", "FI", "FR", "FG", "FP", "FS", "GB", "GA", "GZ", "GG", "GM", "GH", "GI", "GO", "GR", "GL", "GJ", "GP", "GQ", "GT", "GK", "GV", "PU", "GY", "HA", "HM", "HO", "HK", "HQ", "HU", "IC", "IN", "ID", "IR", "IZ", "EI", "IS", "IT", "JM", "JN", "JA", "DQ", "JE", "JQ", "JO", "JU", "KZ", "KE", "KQ", "KR", "KN", "KS", "KU", "KG", "LA", "LG", "LE", "LT", "LI", "LY", "LS", "LH", "LU", "MC", "MK", "MA", "MI", "MY", "MV", "ML", "MT", "IM", "RM", "MB", "MR", "MP", "MF", "MQ", "MD", "MN", "MG", "MJ", "MH", "MO", "MZ", "XM", "WA", "NR", "BQ", "NP", "NL", "NT", "NC", "NZ", "NU", "NG", "NI", "NE", "NF", "XN", "CQ", "NO", "MU", "OC", "PK", "LQ", "PS", "PM", "PP", "PF", "PA", "PE", "RP", "PC", "PL", "PO", "RQ", "QA", "RE", "RO", "RS", "RW", "WS", "SM", "TP", "SA", "XS", "SG", "RI", "SE", "SL", "SN", "XR", "LO", "SI", "BP", "SO", "SF", "SX", "SP", "PG", "CE", "SH", "SC", "ST", "SB", "VC", "SU", "NS", "SV", "WZ", "SW", "SZ", "SY", "TW", "TI", "TZ", "TH", "TO", "TL", "TN", "TD", "XT", "TE", "TS", "TU", "TX", "TK", "TV", "UG", "UP", "AE", "UY", "UZ", "NH", "VT", "VE", "VM", "VQ", "WQ", "XW", "WF", "WE", "WI", "YM", "YI", "ZA", "ZI" |
PostalCd | string | Employer/Payer's postal code Size Range: 9 |
ReturnData | object[] | Contains information about the recipient details and Form 1099 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 |
RecordId | Guid | Unique identifier of a record. Not required when you are creating a return. |
Recipient | object | Object to identify the recipient details. |
RecipientId | Guid | TaxBandits generates a unique ID for each recipient after the return is created and returned in the Response. You can use this id for your future reference to update. |
TINType | string | Specify the TIN type of the recipient. Allowed values: "SSN", "EIN", "ITIN", "ATIN", "NA" |
TIN | string | Enter the nine-digit taxpayer identification number of the Recipient (SSN, ITIN, ATIN, or EIN). Size Range: 9 |
FirstPayeeNm | string | Enter the name of the recipient (preferably last name first for an Individual). If more space is required for the name, use the Second Payee Name Field. Size Range: 40 |
SecondPayeeNm | string | Optional If there are multiple recipients (for example, partners, joint owners, or spouses), use this field for those names not associated with the TIN or if not enough space was provided in the First Payee Name, continue the name in this field.Size Range: 40 |
IsForeign | Boolean | When true, it identifies the recipient's address with a foreign address. |
USAddress | object | If IsForeign is false, pass US address of the recipient |
Address1 | string | Recipient's US address (street address or post office box of that locality) Size Range: ..35 |
Address2 | string | Optional Recipient's suite or apartmentSize Range: ..35 |
City | string | Recipient's city Size Range: ..27 |
State | string | Recipient's state code. Refer Static values. Size Range: 2 Allowed values: "AL", "AK", "AZ", "AR", "CA", "CO", "CT", "DE", "DC", "FL", "GA", "HI", "ID", "IL", "IN", "IA", "KS", "KY", "LA", "ME", "MD", "MA", "MI", "MN", "MS", "MO", "MT", "NE", "NV", "NH", "NJ", "NM", "NY", "NC", "ND", "OH", "OK", "OR", "PA", "RI", "SC", "SD", "TN", "TX", "UT", "VT", "VA", "WA", "WV", "WI", "WY", "AS", "FM", "GU", "MH", "MP", "PW", "PR", "VI", "AA", "AE", "AP" |
ZipCd | string | Recipient's zip code Size Range: 9 |
ForeignAddress | object | If IsForeign is true, pass foreign address of the recipient |
Address1 | string | Recipient's foreign address (street address or post office box of that locality) Size Range: ..35 |
Address2 | string | Optional Recipient's suite or apartmentSize Range: ..35 |
City | string | Recipient's city. Size Range: ..27 |
ProvinceOrStateNm | string | Recipient's Province or State Name. Size Range: ..30 |
Country | string | Recipient's country code. Refer Static values. Size Range: 2 Allowed values: "US", "CA", "MX", "AF", "AX", "XI", "AL", "AG", "AQ", "AN", "AO", "AV", "AY", "AC", "AR", "AM", "AA", "XA", "AT", "AS", "AU", "AJ", "XZ", "BF", "BA", "FQ", "BG", "BB", "BS", "BO", "BE", "BH", "BN", "BD", "BT", "BL", "BK", "BC", "BV", "BR", "IO", "VI", "BX", "BU", "UV", "BM", "BY", "CB", "CM", "XY", "CV", "CJ", "CT", "CD", "XC", "CI", "CH", "KT", "IP", "CK", "CO", "CN", "CF", "CG", "CW", "CR", "VP", "CS", "IV", "HR", "CU", "CY", "EZ", "DA", "DX", "DJ", "DO", "DR", "TT", "EC", "EG", "ES", "UK", "EK", "ER", "EN", "ET", "EU", "FK", "FO", "FM", "FJ", "FI", "FR", "FG", "FP", "FS", "GB", "GA", "GZ", "GG", "GM", "GH", "GI", "GO", "GR", "GL", "GJ", "GP", "GQ", "GT", "GK", "GV", "PU", "GY", "HA", "HM", "HO", "HK", "HQ", "HU", "IC", "IN", "ID", "IR", "IZ", "EI", "IS", "IT", "JM", "JN", "JA", "DQ", "JE", "JQ", "JO", "JU", "KZ", "KE", "KQ", "KR", "KN", "KS", "KU", "KG", "LA", "LG", "LE", "LT", "LI", "LY", "LS", "LH", "LU", "MC", "MK", "MA", "MI", "MY", "MV", "ML", "MT", "IM", "RM", "MB", "MR", "MP", "MF", "MQ", "MD", "MN", "MG", "MJ", "MH", "MO", "MZ", "XM", "WA", "NR", "BQ", "NP", "NL", "NT", "NC", "NZ", "NU", "NG", "NI", "NE", "NF", "XN", "CQ", "NO", "MU", "OC", "PK", "LQ", "PS", "PM", "PP", "PF", "PA", "PE", "RP", "PC", "PL", "PO", "RQ", "QA", "RE", "RO", "RS", "RW", "WS", "SM", "TP", "SA", "XS", "SG", "RI", "SE", "SL", "SN", "XR", "LO", "SI", "BP", "SO", "SF", "SX", "SP", "PG", "CE", "SH", "SC", "ST", "SB", "VC", "SU", "NS", "SV", "WZ", "SW", "SZ", "SY", "TW", "TI", "TZ", "TH", "TO", "TL", "TN", "TD", "XT", "TE", "TS", "TU", "TX", "TK", "TV", "UG", "UP", "AE", "UY", "UZ", "NH", "VT", "VE", "VM", "VQ", "WQ", "XW", "WF", "WE", "WI", "YM", "YI", "ZA", "ZI" |
PostalCd | string | Recipient's Postal Code Size Range: 9 |
string | Recipient's email address. Size Range: 0..40 | |
Fax | string | Optional Recipient's Fax number.Size Range: 10 |
Phone | string | Recipient's Phone Number. Size Range: 15 |
PATRFormData | object | Object to create 1099-PATR. |
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 |
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. |
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 PATR records with Success and Error statuses |
SuccessRecords | object[] | It will show detailed information about the success status of Form 1099 PATR 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-PATR return is created. |
RecipientId | Guid | A Unique identifier generated by TaxBandits for a Recipient when a 1099-PATR 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-PATR 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. |
Postal | object | Returns the status and StatusTs of postal mailing service for Form 1099 PATR. |
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 PATR 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 PATR Records. |
SequenceId | string | A unique reference ID for the submission that can be used to identify a particular record. The Sequence ID will be returned in the Response for your reference. |
RecordId | Guid | Unique identifier of a record |
Errors | object[] | Shows detailed error information |
Id | string | Returns the validation error Id |
Name | string | Name of the validation error |
Message | string | Description of the validation error |
Errors | object[] | Shows detailed error information |
Id | string | Returns the validation error Id |
Name | string | Name of the validation error |
Message | string | Description of the validation error |
Request JSON
{
"SubmissionManifest": {
"SubmissionId": "48f07d71-9afb-4150-aea7-6822a3374cfc",
"TaxYear": "2021",
"IsFederalFiling": true,
"IsStateFiling": true,
"IsPostal": true,
"IsOnlineAccess": true,
"IsScheduleFiling": true,
"ScheduleFiling": {
"EfileDate": "12/30/2022"
}
},
"ReturnHeader": {
"Business": {
"BusinessId": "68a1bb3b-fda4-42ee-a5f3-ce33de3d7538",
"PayerRef": "AB101",
"BusinessNm": "Eastman Kodak Com",
"TradeNm": "Kodak Corporates",
"IsEIN": true,
"EINorSSN": "62-7369245",
"Email": "john@gmail.com",
"ContactNm": "John",
"Phone": "1234567890",
"PhoneExtn": "12345",
"Fax": "1234567890",
"BusinessType": "ESTE",
"SigningAuthority": {
"Name": "John",
"Phone": "1234567890",
"BusinessMemberType": "ADMINISTRATOR"
},
"KindOfEmployer": "FederalGovt",
"KindOfPayer": "REGULAR941",
"IsBusinessTerminated": true,
"IsForeign": false,
"USAddress": {
"Address1": "1751 Kinsey Rd",
"Address2": "Main St",
"City": "Dothan",
"State": "AL",
"ZipCd": "36303"
},
"ForeignAddress": {
"Address1": null,
"Address2": null,
"City": null,
"ProvinceOrStateNm": null,
"Country": null,
"PostalCd": null
}
}
},
"ReturnData": [
{
"RecordId": "aa98cb08-adfb-4557-af41-17dbf314f47f",
"SequenceId": "1",
"Recipient": {
"RecipientId": "ba7e67f0-400c-4a90-9f56-4039beaa68d2",
"TINType": "EIN",
"TIN": "393817572",
"FirstPayeeNm": "Mark",
"SecondPayeeNm": "Davis",
"IsForeign": false,
"USAddress": {
"Address1": "1751 Kinsey Rd",
"Address2": "Main St",
"City": "Dothan",
"State": "AL",
"ZipCd": "36303"
},
"ForeignAddress": {
"Address1": null,
"Address2": null,
"City": null,
"ProvinceOrStateNm": null,
"Country": null,
"PostalCd": null
},
"Email": "john@gmail.com",
"Fax": "1234567890",
"Phone": "1234567890"
},
"PATRFormData": {
"B1PatronageDiv": 1000.56,
"B2NonPatronageDist": 1000.91,
"B3PerUnitAllocations": 500.49,
"B4FedTaxWH": 408.55,
"B5RedmNonQualNotices": 600.21,
"B6Sec199AgDeduction": 70.40,
"B7QualPymtsSec199Ab7": 800.90,
"B8Sec199AaQualItems": 1000.31,
"B9Sec199AaSSTBItems": 280,
"B10InvestmentCredit": 790.22,
"B11WorkOpporCredit": 150,
"B12OtherCreditsAndDeductions": 500.50,
"B13IsSpecifiedCoop": true,
"Is2ndTINnot": true,
"AccountNum": "20123130000009000001"
}
}
]
}
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
Response JSON
{
"StatusCode": 200,
"StatusName": "Ok",
"StatusMessage": "Successful API call",
"SubmissionId": "48f07d71-9afb-4150-aea7-6822a3374cfc",
"BusinessId": "68a1bb3b-fda4-42ee-a5f3-ce33de3d7538",
"PayerRef": "AB101",
"Form1099Type": "PATR",
"Form1099Records": {
"SuccessRecords": [
{
"SequenceId": "1",
"RecordId": "aa98cb08-adfb-4557-af41-17dbf314f47f",
"RecipientId": "ba7e67f0-400c-4a90-9f56-4039beaa68d2",
"AccountNum": "20123130000009000001",
"FederalReturn": {
"Status": "CREATED",
"StatusTs": "2022-05-06 07:56:59 -04:00",
"Info": null
},
"Postal": {
"Status": "CREATED",
"StatusTs": "2022-05-06 07:56:59 -04:00",
"Info": null
},
"OnlineAccess": {
"Status": "NA",
"Email": null,
"Info": "This service will be available soon"
},
"ScheduleFiling": {
"ScheduledOn": null,
"Info": "This Service will be available soon"
}
}
],
"ErrorRecords": null
},
"Errors": null
}
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
# Validate
Executes business and data validation checks for the 1099 PATR returns already created in API. Use the Submission ID and Record IDs of the return to validate.
GET Form1099PATR/Validate
Request Body
Field | Type | Description |
---|---|---|
SubmissionId | Guid | Unique identifier of a submission |
RecordIds | Guid[] | Unique identifier generated by TaxBandits when a 1099-PATR return is created. Mention the 1099-PATR return's Record ID that you want to Validate. |
Response Body
Field | Type | Description |
---|---|---|
StatusCode | number | Returns the HTTP status codes like 200,300 etc. |
StatusName | string | Name of the status code |
StatusMessage | string | Detailed status message |
SubmissionId | Guid | Unique identifier of a submission |
Form1099Records | object | Pulls the Form 1099 PATR records with Success and Error statuses |
SuccessRecords | object[] | It will show the detailed information about the success status of Form 1099 Records |
SequenceId | string | A unique reference ID for the submission that can be used to identify a particular record. The Sequence ID will be returned in the Response for your reference. |
RecordId | Guid | Record ID of the returns that were successfully validated. |
Status | string | Returns the status of the records. |
StatusTs | string | Date and time of return created. |
ErrorRecords | object[] | It will show the detailed information about the error status of Form 1099 Records. |
SequenceId | string | A unique reference ID for the submission that can be used to identify a particular record. The Sequence ID will be returned in the Response for your reference. |
RecordId | Guid | Unique identifier of a record |
Errors | object[] | Shows detailed error information |
Id | string | Returns the validation error id |
Name | string | Name of the validation error |
Message | string | Description of the validation error |
Errors | object[] | Shows detailed error information |
Id | string | Returns the validation error id |
Name | string | Name of the validation error |
Message | string | Description of the validation error |
Request JSON
Form1099PATR/Validate?SubmissionId=48f07d71-9afb-4150-aea7-6822a3374cfc&RecordIds=aa98cb08-adfb-4557-af41-17dbf314f47f
Response JSON
{
"StatusCode": 200,
"StatusName": "Ok",
"StatusMessage": "Successful API call",
"SubmissionId": "48f07d71-9afb-4150-aea7-6822a3374cfc",
"Form1099Records": {
"SuccessRecords": [
{
"SequenceId": "1",
"RecordId": "aa98cb08-adfb-4557-af41-17dbf314f47f",
"Status": "CREATED",
"StatusTs": "2022-05-06 08:37:09 -04:00"
}
],
"ErrorRecords": null
},
"Errors": null
}
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
# ValidateForm
The ValidateForm method checks the request's 1099-PATR Forms to IRS business standards and field specifications. It will verify the IRS-mandated checks and assist in avoiding PATR form errors. It will validate the form without generating any TaxBandits returns.
POST Form1099PATR/ValidateForm
Request Body
Field | Type | Description |
---|---|---|
SubmissionManifest | object | SubmissionManifest provides the brief information about a particular submission on the whole. It contains information like Submission ID, Tax Year, IsPostal, IsFederalFiling, 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: "2021" |
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. |
IsPostal | Boolean | Postal Order will be created when the value is set as True. Once the return is Transmitted, Form 1099-PATR 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-PATR Recipient 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/2021 or 10-20-2021 |
ReturnHeader | object | Contains information about the Business details. |
Business | object | Object to identify the Business Details. |
BusinessId | Guid | Optional Use the unique Business ID (Generated by TaxBandits) you received in response to the Business CREATE Endpoint. By giving the Business ID, you do not have to provide all the business information again. If you do not have a Business ID, ignore the field. |
BusinessNm | string | Name of the business Size Range: ..80 |
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 operatesSize Range: ..80 |
IsEIN | Boolean | When true, identify that the business TIN is an EIN. |
EINorSSN | string | When IsEIN is true, use Employer Identification Number (EIN). When IsEIN is false, use Social Security Number (SSN) Size Range: 9 |
string | Email address of the Business Size Range: ..40 | |
ContactNm | string | Optional Name of the person who can be contacted by the IRS.Size Range: ..27 |
Phone | string | Phone number of the business Size Range: 10 |
PhoneExtn | string | Optional Extension of the business phone numberSize Range: ..5 |
Fax | string | Optional Fax number of the BusinessSize Range: 10 |
BusinessType | string | Optional Type of business. Optional for W-2/1099 and mandatory for 94X seriesSize 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 authoritySize Range: ..35 |
Phone | string | Optional Phone number of the signing authoritySize Range: 10 |
BusinessMemberType | string | Optional Business title of the signing authoritySize 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 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-PATR 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: ..35 |
Address2 | string | Optional Employer/Payer's suite or apartmentSize Range: ..35 |
City | string | Employer/Payer's city Size Range: ..27 |
State | string | Employer/Payer's state code. Refer Static values. Size Range: 2 Allowed values: "AL", "AK", "AZ", "AR", "CA", "CO", "CT", "DE", "DC", "FL", "GA", "HI", "ID", "IL", "IN", "IA", "KS", "KY", "LA", "ME", "MD", "MA", "MI", "MN", "MS", "MO", "MT", "NE", "NV", "NH", "NJ", "NM", "NY", "NC", "ND", "OH", "OK", "OR", "PA", "RI", "SC", "SD", "TN", "TX", "UT", "VT", "VA", "WA", "WV", "WI", "WY", "AS", "FM", "GU", "MH", "MP", "PW", "PR", "VI", "AA", "AE", "AP" |
ZipCd | string | Employer/Payer's zip code Size Range: 9 |
ForeignAddress | object | If IsForeign is true, pass foreign address of the business |
Address1 | string | Employer/Payer's foreign address (street address or post office box of that locality) Size Range: ..35 |
Address2 | string | Optional Employer/Payer's suite or apartmentSize Range: ..35 |
City | string | Employer/Payer's city Size Range: ..27 |
ProvinceOrStateNm | string | Employer/Payer's province or state name Size Range: ..30 |
Country | string | Employer/Payer's country Size Range: 2 Allowed values: "US", "CA", "MX", "AF", "AX", "XI", "AL", "AG", "AQ", "AN", "AO", "AV", "AY", "AC", "AR", "AM", "AA", "XA", "AT", "AS", "AU", "AJ", "XZ", "BF", "BA", "FQ", "BG", "BB", "BS", "BO", "BE", "BH", "BN", "BD", "BT", "BL", "BK", "BC", "BV", "BR", "IO", "VI", "BX", "BU", "UV", "BM", "BY", "CB", "CM", "XY", "CV", "CJ", "CT", "CD", "XC", "CI", "CH", "KT", "IP", "CK", "CO", "CN", "CF", "CG", "CW", "CR", "VP", "CS", "IV", "HR", "CU", "CY", "EZ", "DA", "DX", "DJ", "DO", "DR", "TT", "EC", "EG", "ES", "UK", "EK", "ER", "EN", "ET", "EU", "FK", "FO", "FM", "FJ", "FI", "FR", "FG", "FP", "FS", "GB", "GA", "GZ", "GG", "GM", "GH", "GI", "GO", "GR", "GL", "GJ", "GP", "GQ", "GT", "GK", "GV", "PU", "GY", "HA", "HM", "HO", "HK", "HQ", "HU", "IC", "IN", "ID", "IR", "IZ", "EI", "IS", "IT", "JM", "JN", "JA", "DQ", "JE", "JQ", "JO", "JU", "KZ", "KE", "KQ", "KR", "KN", "KS", "KU", "KG", "LA", "LG", "LE", "LT", "LI", "LY", "LS", "LH", "LU", "MC", "MK", "MA", "MI", "MY", "MV", "ML", "MT", "IM", "RM", "MB", "MR", "MP", "MF", "MQ", "MD", "MN", "MG", "MJ", "MH", "MO", "MZ", "XM", "WA", "NR", "BQ", "NP", "NL", "NT", "NC", "NZ", "NU", "NG", "NI", "NE", "NF", "XN", "CQ", "NO", "MU", "OC", "PK", "LQ", "PS", "PM", "PP", "PF", "PA", "PE", "RP", "PC", "PL", "PO", "RQ", "QA", "RE", "RO", "RS", "RW", "WS", "SM", "TP", "SA", "XS", "SG", "RI", "SE", "SL", "SN", "XR", "LO", "SI", "BP", "SO", "SF", "SX", "SP", "PG", "CE", "SH", "SC", "ST", "SB", "VC", "SU", "NS", "SV", "WZ", "SW", "SZ", "SY", "TW", "TI", "TZ", "TH", "TO", "TL", "TN", "TD", "XT", "TE", "TS", "TU", "TX", "TK", "TV", "UG", "UP", "AE", "UY", "UZ", "NH", "VT", "VE", "VM", "VQ", "WQ", "XW", "WF", "WE", "WI", "YM", "YI", "ZA", "ZI" |
PostalCd | string | Employer/Payer's postal code Size Range: 9 |
ReturnData | object[] | Contains information about the recipient details and Form 1099 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 |
RecordId | Guid | Unique identifier of a record. Not required when you are creating a return. |
Recipient | object | Object to identify the recipient details. |
RecipientId | Guid | TaxBandits generates a unique ID for each recipient after the return is created and returned in the Response. You can use this id for your future reference to update. |
TINType | string | Specify the TIN type of the recipient. Allowed values: "SSN", "EIN", "ITIN", "ATIN", "NA" |
TIN | string | Enter the nine-digit taxpayer identification number of the Recipient (SSN, ITIN, ATIN, or EIN). Size Range: 9 |
FirstPayeeNm | string | Enter the name of the recipient (preferably last name first for an Individual). If more space is required for the name, use the Second Payee Name Field. Size Range: 40 |
SecondPayeeNm | string | Optional If there are multiple recipients (for example, partners, joint owners, or spouses), use this field for those names not associated with the TIN or if not enough space was provided in the First Payee Name, continue the name in this field.Size Range: 40 |
IsForeign | Boolean | When true, it identifies the recipient's address with a foreign address. |
USAddress | object | If IsForeign is false, pass US address of the recipient |
Address1 | string | Recipient's US address (street address or post office box of that locality) Size Range: ..35 |
Address2 | string | Optional Recipient's suite or apartmentSize Range: ..35 |
City | string | Recipient's city Size Range: ..27 |
State | string | Recipient's state code. Refer Static values. Size Range: 2 Allowed values: "AL", "AK", "AZ", "AR", "CA", "CO", "CT", "DE", "DC", "FL", "GA", "HI", "ID", "IL", "IN", "IA", "KS", "KY", "LA", "ME", "MD", "MA", "MI", "MN", "MS", "MO", "MT", "NE", "NV", "NH", "NJ", "NM", "NY", "NC", "ND", "OH", "OK", "OR", "PA", "RI", "SC", "SD", "TN", "TX", "UT", "VT", "VA", "WA", "WV", "WI", "WY", "AS", "FM", "GU", "MH", "MP", "PW", "PR", "VI", "AA", "AE", "AP" |
ZipCd | string | Recipient's zip code Size Range: 9 |
ForeignAddress | object | If IsForeign is true, pass foreign address of the recipient |
Address1 | string | Recipient's foreign address (street address or post office box of that locality) Size Range: ..35 |
Address2 | string | Optional Recipient's suite or apartmentSize Range: ..35 |
City | string | Recipient's city. Size Range: ..27 |
ProvinceOrStateNm | string | Recipient's Province or State Name. Size Range: ..30 |
Country | string | Recipient's country code. Refer Static values. Size Range: 2 Allowed values: "US", "CA", "MX", "AF", "AX", "XI", "AL", "AG", "AQ", "AN", "AO", "AV", "AY", "AC", "AR", "AM", "AA", "XA", "AT", "AS", "AU", "AJ", "XZ", "BF", "BA", "FQ", "BG", "BB", "BS", "BO", "BE", "BH", "BN", "BD", "BT", "BL", "BK", "BC", "BV", "BR", "IO", "VI", "BX", "BU", "UV", "BM", "BY", "CB", "CM", "XY", "CV", "CJ", "CT", "CD", "XC", "CI", "CH", "KT", "IP", "CK", "CO", "CN", "CF", "CG", "CW", "CR", "VP", "CS", "IV", "HR", "CU", "CY", "EZ", "DA", "DX", "DJ", "DO", "DR", "TT", "EC", "EG", "ES", "UK", "EK", "ER", "EN", "ET", "EU", "FK", "FO", "FM", "FJ", "FI", "FR", "FG", "FP", "FS", "GB", "GA", "GZ", "GG", "GM", "GH", "GI", "GO", "GR", "GL", "GJ", "GP", "GQ", "GT", "GK", "GV", "PU", "GY", "HA", "HM", "HO", "HK", "HQ", "HU", "IC", "IN", "ID", "IR", "IZ", "EI", "IS", "IT", "JM", "JN", "JA", "DQ", "JE", "JQ", "JO", "JU", "KZ", "KE", "KQ", "KR", "KN", "KS", "KU", "KG", "LA", "LG", "LE", "LT", "LI", "LY", "LS", "LH", "LU", "MC", "MK", "MA", "MI", "MY", "MV", "ML", "MT", "IM", "RM", "MB", "MR", "MP", "MF", "MQ", "MD", "MN", "MG", "MJ", "MH", "MO", "MZ", "XM", "WA", "NR", "BQ", "NP", "NL", "NT", "NC", "NZ", "NU", "NG", "NI", "NE", "NF", "XN", "CQ", "NO", "MU", "OC", "PK", "LQ", "PS", "PM", "PP", "PF", "PA", "PE", "RP", "PC", "PL", "PO", "RQ", "QA", "RE", "RO", "RS", "RW", "WS", "SM", "TP", "SA", "XS", "SG", "RI", "SE", "SL", "SN", "XR", "LO", "SI", "BP", "SO", "SF", "SX", "SP", "PG", "CE", "SH", "SC", "ST", "SB", "VC", "SU", "NS", "SV", "WZ", "SW", "SZ", "SY", "TW", "TI", "TZ", "TH", "TO", "TL", "TN", "TD", "XT", "TE", "TS", "TU", "TX", "TK", "TV", "UG", "UP", "AE", "UY", "UZ", "NH", "VT", "VE", "VM", "VQ", "WQ", "XW", "WF", "WE", "WI", "YM", "YI", "ZA", "ZI" |
PostalCd | string | Recipient's Postal Code Size Range: 9 |
string | Recipient's email address. Size Range: 0..40 | |
Fax | string | Optional Recipient's Fax number.Size Range: 10 |
Phone | string | Recipient's Phone Number. Size Range: 15 |
PATRFormData | object | Object to create 1099-PATR. |
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 |
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. |
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 |
ErrorRecords | object[] | It will show the detailed information about the error status of Form 1099 PATR Records. |
SequenceId | string | A unique reference ID for the submission that can be used to identify a particular record. The Sequence ID will be returned in the Response for your reference. |
RecordId | Guid | Unique identifier of a record |
Errors | object[] | Shows detailed error information |
Id | string | Returns the validation error Id |
Name | string | Name of the validation error |
Message | string | Description of the validation error |
Errors | object[] | Shows detailed error information |
Id | string | Returns the validation error code |
Name | string | Name of the validation error |
Message | string | Description of the validation error |
Request JSON
{
"SubmissionManifest": {
"SubmissionId": null,
"TaxYear": "2021",
"IsFederalFiling": true,
"IsPostal": true,
"IsOnlineAccess": true,
"IsScheduleFiling": true,
"ScheduleFiling": {
"EfileDate": "12/12/2022"
}
},
"ReturnHeader": {
"Business": {
"BusinessId": null,
"PayerRef": "AB101",
"BusinessNm": "Eastman Kodak Com",
"TradeNm": "Kodak Corporates",
"IsEIN": true,
"EINorSSN": "62-7369245",
"Email": "john@gmail.com",
"ContactNm": "John",
"Phone": "1234567890",
"PhoneExtn": "12345",
"Fax": "1234567890",
"BusinessType": "ESTE",
"SigningAuthority": {
"Name": "John",
"Phone": "1234567890",
"BusinessMemberType": "ADMINISTRATOR"
},
"KindOfEmployer": "FederalGovt",
"KindOfPayer": "REGULAR941",
"IsBusinessTerminated": true,
"IsForeign": false,
"USAddress": {
"Address1": "1751 Kinsey Rd",
"Address2": "Main St",
"City": "Dothan",
"State": "AL",
"ZipCd": "36303"
},
"ForeignAddress": {
"Address1": null,
"Address2": null,
"City": null,
"ProvinceOrStateNm": null,
"Country": null,
"PostalCd": null
}
}
},
"ReturnData": [
{
"RecordId": null,
"SequenceId": "1",
"Recipient": {
"RecipientId": null,
"TINType": "EIN",
"TIN": "393817572",
"FirstPayeeNm": "Mark",
"SecondPayeeNm": "Davis",
"IsForeign": false,
"USAddress": {
"Address1": "1751 Kinsey Rd",
"Address2": "Main St",
"City": "Dothan",
"State": "AL",
"ZipCd": "36303"
},
"ForeignAddress": {
"Address1": null,
"Address2": null,
"City": null,
"ProvinceOrStateNm": null,
"Country": null,
"PostalCd": null
},
"Email": "john@gmail.com",
"Fax": "1234567890",
"Phone": "1234567890"
},
"PATRFormData": {
"B1PatronageDiv": 1000.56,
"B2NonPatronageDist": 1000.91,
"B3PerUnitAllocations": 500.49,
"B4FedTaxWH": 408.55,
"B5RedmNonQualNotices": 600.21,
"B6Sec199AgDeduction": 70.40,
"B7QualPymtsSec199Ab7": 800.90,
"B8Sec199AaQualItems": 1000.31,
"B9Sec199AaSSTBItems": 280,
"B10InvestmentCredit": 790.22,
"B11WorkOpporCredit": 150,
"B12OtherCreditsAndDeductions": 500.50,
"B13IsSpecifiedCoop": true,
"Is2ndTINnot": true,
"AccountNum": "20123130000009000001"
}
}
]
}
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
Response JSON
{
"StatusCode": 200,
"StatusName": "Ok",
"StatusMessage": "Successful API call",
"ErrorRecords": null,
"Errors": null
}
2
3
4
5
6
7