Create
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. |
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"
}
}
]
}
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
}