# Contact
# Create
Creates contact with a unique Contact ID. The Contact ID can be further used for other Endpoints to refer the particular contact. The contact can be a Filer or Recipient. The Contact created as a Filer can be further used when filing 94x (Employer), W-2 (Employer), ACA (Employer) and 1099 (Payer) forms. The Contact created as a Recipient can be further used when filing W-2(Employee), ACA (Employee), and 1099 (Recipient) forms.
POST Contact/Create
Request Body
Field | Type | Description |
---|---|---|
ContactCount | number | Number of contacts. Size Range: ..3 Allowed values: 1 250 |
Contacts | object[] | Send all the contact's information under this object. Each contact created will have an unique Contact ID. |
ContactManifest | object | Specify the contact type and sequence number under the manifest. |
SequenceNum | string | Use sequence number as a reference to differentiate multiple contacts created under a request. Size Range: ..10 |
ContactId | Guid | A unique ID created by TaxBandits. Not required, when you re creating a contact. |
ContactType | string | Specify the type of contact. Specify Filer, if you are going to further use the contact for filing 94x, W-2, ACA forms as an Employer and 1099 forms as a Payer. Specify Recipient if you are going to further use the contact for filing W-2, ACA forms as an Employee and 1099 forms as a Recipient. Size Range: 5..9 Allowed values: "FILER", "RECIPIENT" |
FilerContactId | Guid | The Filer Contact Id is required, only if you are creating a Recipient. The Filer Contact Id or Contact ID is generated by TaxBandits when a Contact (Filer) is created. Specify the Filer Contact Id the Recipient/Employee is linked to. |
UpdateInProgressReturns | Boolean | When true identifies that contact changes should be applied to Inprogress returns. |
Filer | object | Add values specific to the Form types you are going to file for the Contact. Required only if the selected contact type is Filer. |
Name | string | Name of the Filer. Size Range: ..40 |
NameCont | string | Continuation of the Filer name. Size Range: ..40 |
TINType | string | Type of Taxpayer Identification Number of Filer. Size Range: 3 Allowed values: "SSN", "EIN" |
TIN | string | Filer TIN. Size Range: 9 |
IsBusinessTerminated | boolean | When true, identifies that the business is closed. |
W2Specific | object | Create W2 efile details. |
TypeOfPayer | string | Type of payer. Allowed values: "REGULAR941", "REGULAR944", "AGRICULTURAL943", "HOUSEHOLD", "MILITARY", "MEDICAREQUALGOVEM", "RAILROADFORMCT1" |
TypeOfEmployer | string | Type of employer. Allowed values: "FEDERALGOVT", "STATEORLOCAL501C", "NONGOVT501C", "STATEORLOCALNON501C", "NONEAPPLY" |
Form94xSpecific | object | Create 94x efile details. |
TradeNm | string | Doing Filer As name. Size Range: ..35 |
BusinessType | string | Type of Business. Size Range: ..4 Allowed values: "ESTE", "PART", "CORP", "EORG", "SPRO" |
Signatory | object | Details of the person who is authorized to sign the return. |
Name | string | Name of the signing authority. Size Range: ..80 |
Title | string | Title of the signing authority. Size Range: 5..29 Allowed values: "CORPORATESECRETARY", "SECRETARYTREASURER", "PARTNER", "GENERALPARTNER", "LIMITEDPARTNER", "LLCMEMBER", "MANAGINGMEMBER", "MANAGER", "TAXMATTERPARTNER", "PRESIDENT", "VICEPRESIDENT", "CORPORATETREASURER", "TREASURER", "ASSISTANTTREASURER", "CHIEFACCOUNTINGOFFICER", "CHIEFEXECUTIVEOFFICER", "CHIEFFINANCIALOFFICER", "TAXOFFICER", "CHIEFOPERATINGOFFICER", "CORPORATEOFFICER", "EXECUTIVEDIRECTOR", "DIRECTOR", "CHAIRMAN", "EXECUTIVEADMINISTRATOR", "RECEIVER", "PASTOR", "ASSISTANTTORELIGIOUSLEADER", "REVEREND", "PRIEST", "MINISTER", "RABBI", "LEADEROFRELIGIOUSORGANIZATION", "SECRETARY", "DIRECTOROFTAXATION", "DIRECTOROFPERSONNEL", "ADMINISTRATOR", "EXECUTOR", "TRUSTEE", "FIDUCIARY", "OWNER", "SOLEPROPRIETOR", "MEMBER", "SOLEMEMBER" |
Phone | string | Phone number of the signing authority. Size Range: ..10 |
ACASpecific | Object | Create ACA efile details. |
FilerType | string | Specify the Filer Type. Filer Type should be Employer for Form 1094C/1095C filing. Allowed values: "Employer", "Insurer" |
IsGovernmentalUnit | boolean | When true identifies that it is a government entity. |
ContactName | object | Create contact name for ACA forms. |
PersonFirstNm | string | First name of the Contact person. Size Range: 50 |
PersonMiddleNm | string | Middle name of the Contact person. Size Range: 15 |
PersonLastNm | string | Last name of the Contact person Size Range: 50 |
SuffixNm | string | Suffix of the Contact person. Size Range: 3 |
SigningAuthority | object | Details of the person who is authorized to sign the return. |
Name | string | Name of the signing authority. Size Range: ..80 |
Title | string | Title of the signing authority. Size Range: 5..29 Allowed values: "CORPORATESECRETARY", "SECRETARYTREASURER", "PARTNER", "GENERALPARTNER", "LIMITEDPARTNER", "LLCMEMBER", "MANAGINGMEMBER", "MANAGER", "TAXMATTERPARTNER", "PRESIDENT", "VICEPRESIDENT", "CORPORATETREASURER", "TREASURER", "ASSISTANTTREASURER", "CHIEFACCOUNTINGOFFICER", "CHIEFEXECUTIVEOFFICER", "CHIEFFINANCIALOFFICER", "TAXOFFICER", "CHIEFOPERATINGOFFICER", "CORPORATEOFFICER", "EXECUTIVEDIRECTOR", "DIRECTOR", "CHAIRMAN", "EXECUTIVEADMINISTRATOR", "RECEIVER", "PASTOR", "ASSISTANTTORELIGIOUSLEADER", "REVEREND", "PRIEST", "MINISTER", "RABBI", "LEADEROFRELIGIOUSORGANIZATION", "SECRETARY", "DIRECTOROFTAXATION", "DIRECTOROFPERSONNEL", "ADMINISTRATOR", "EXECUTOR", "TRUSTEE", "FIDUCIARY", "OWNER", "SOLEPROPRIETOR", "MEMBER", "SOLEMEMBER" |
ContactInfo | object | Create contact info of Filer with unique contact Id. |
ContactNm | string | Name of the Contact person. Size Range: 27 |
Phone | string | Phone number of the Contact person Size Range: 10 |
PhoneExtn | string | Phone number extension of the Contact person Size Range: 5 |
string | Email address of the Contact person Size Range: 40 | |
Fax | string | Fax number of the Contact person. Size Range: 10 |
Recipient | object | Add values specific to the Form types you are going to file for the Contact. Required only if the selected contact type is Recipient. |
TINType | string | Type of Taxpayer Identification Number of Recipient. Size Range: 3..4 Allowed values: "SSN", "EIN", "ATIN", "ITIN", "NA" |
TIN | string | Recipient's TIN. Size Range: 9 |
EmployeeName | object | Create Form W2 and ACA efile details. |
FirstNm | string | First name of the Recipient. Size Range: 15 |
MiddleNm | string | Middle name of the Recipient. Size Range: 15 |
LastNm | string | Last name of the Recipient. Size Range: 20 |
Suffix | string | Suffix of the Recipient. Size Range: 3 |
ACASpecific | Object | Create ACA efile details of Recipient. |
DOB | string | Recipient's date of birth. Size Range: 10 |
OriginOfHealthCoverage | string | Indicates the type of coverage. Size Range: 1 Allowed values: "B", "C", "D", "E", "F" |
Form1099Specific | Object | Create 1099 efile details of Recipient. |
Name | string | Name of the Recipient. Size Range: 40 |
Name2 | string | Continuation of the Recipient name. Size Range: 40 |
RecipientContactInfo | object | Add values specific to the Form types you are going to file for the Contact. Required only if the selected contact type is Recipient. |
Phone | string | Phone number of the Contact person Size Range: 10 |
string | Email address of the Contact person Size Range: 40 | |
Fax | string | Fax number of the Contact person. Size Range: 10 |
IsForeign | boolean | When true identifies that the Filer has a foreign address. |
USAddress | object | if IsForeign is false, pass US address of the Filer. |
Address1 | string | Filer/Recipient's US address (street address or post office box of that locality). Size Range: 40 |
Address2 | string | Filer/Recipient's suite or apartment. Size Range: 40 |
City | string | Filer/Recipient's city. Size Range: 40 |
State | string | Filer/Recipient's state, 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 | Filer/Recipient's zip code Size Range: ..10 |
ForeignAddress | object | if IsForeign is true, pass foreign address of the Filer. |
Address1 | string | Filer/Recipient's Foreign address (street address or post office box of that locality). Size Range: 40 |
Address2 | string | Filer/Recipient's Foreign suite or apartment. Size Range: 40 |
City | string | Filer/Recipient's city. Size Range: 30 |
ProvinceOrStateNm | string | Filer/Recipient's province or state name. Size Range: 30 |
Country | string | Filer/Recipient'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 | Filer/Recipient's postal code. Size Range: 15 |
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 description of th Status code. |
SuccessRecords | object | It will show the detailed information about the success status of contact Information Returns. |
Contacts | object[] | It will show the detailed information about the success status of contact Information Records. |
SequenceNum | string | Use sequence number as a reference to differentiate multiple contacts created under a request. |
ContactId | Guid | A unique ID created by TaxBandits. Not required, when you re creating a contact. |
Status | string | Returns the status of the records. |
StatusTS | string | Date and time of the contact created. |
ErrorRecords | object[] | It will show the detailed information about the error status of contact Information Records. |
SequenceNum | string | Use sequence number as a reference to differentiate multiple contacts created under a request. |
Contacts | object[] | Shows detailed error information of contact records. |
Id | string | Returns the validation error code. |
Name | string | Name of the validation error. |
Message | string | Description of the validation error. |
Request JSON
{
"ContactCount": "2",
"Contacts": [
{
"ContactManifest": {
"SequenceNum": "Con-0001",
"ContactId": "00000000-0000-0000-0000-000000000000",
"ContactType": "Filer",
"FilerContactId": "00000000-0000-0000-0000-000000000000",
"UpdateInProgressReturns": true
},
"Filer": {
"Name": "Fomby Trucking",
"NameCont": "LLC",
"TINType": "EIN",
"TIN": "003587734",
"IsBusinessTerminated":false,
"W2Specific": {
"TypeOfPayer": null,
"TypeOfEmployer": null
},
"Form94xSpecific": {
"TradeNm": null,
"BusinessType": "CORP",
"Signatory": {
"Name": "John",
"Title": "PRESIDENT",
"Phone": "2654784954"
}
},
"ACASpecific": {
"FilerType": "Employer",
"IsGovernmentalUnit": true,
"ContactName": {
"PersonFirstNm": "John",
"PersonMiddleNm": "F",
"PersonLastNm": "Kennedy",
"SuffixNm": "Sr"
},
"SigningAuthority": {
"Name": "John",
"Title": "TRUSTEE"
}
},
"ContactInfo": {
"ContactNm": "Jammy",
"Phone": "9655990058",
"PhoneExtn": "0141",
"Email": "john@gmail.com",
"Fax": "5487845874"
}
},
"Recipient": null,
"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
}
},
{
"ContactManifest": {
"SequenceNum": "Con-0002",
"ContactId": "00000000-0000-0000-0000-000000000000",
"ContactType": "Recipient",
"FilerContactId": "5bebe6ca-2344-4215-97f4-3e88cd1bd582",
"UpdateInProgressReturns": false
},
"Filer": null,
"Recipient": {
"TINType": "EIN",
"TIN": "458475478",
"EmployeeName": {
"FirstNm": "John",
"MiddleNm": "F",
"LastNm": "Kennedy",
"Suffix": "Jr"
},
"ACASpecific": {
"DOB": "07-20-2020",
"OriginOfHealthCoverage": "B"
},
"Form1099Specific": {
"Name": "King",
"Name2": "Loius"
},
"RecipientContactInfo": {
"Phone": "9655990058",
"Email": "john@gmail.com",
"Fax": "5487845874"
}
},
"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
}
}
]
}
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
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
Response JSON
{
"StatusCode": 200,
"StatusName": "Ok",
"StatusMessage": "Successful API call",
"SuccessRecords": {
"Contacts": [
{
"SequenceNum": "Con-0001",
"ContactId": "7844539a-59a7-4c57-9013-ede0f86dfaae",
"Status": "CREATED",
"StatusTS": "2020-08-12 13:25:27 +05:30"
},
{
"SequenceNum": "Con-0002",
"ContactId": "a27571f3-d961-4690-8b05-fd0aaeaef96e",
"Status": "CREATED",
"StatusTS": "2020-08-12 13:25:27 +05:30"
}
]
},
"ErrorRecords": null
}
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
# Delete
Delete contact records using Contact Id and Contact Type. If you have already created returns for the contact, you cannot delete the contact.
DELETE Contact/Delete
Request Body
Field | Type | Description |
---|---|---|
ContactId | guid | A unique ID created by TaxBandits. Not required, when you re creating a contact. |
ContactType | string | Type of contact. Size Range: 5..9 Allowed values: "FILER", "RECIPIENT" |
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 description of th Status code. |
SuccessRecord | object | It will show the detailed information about the success status contact information record. |
ContactId | Guid | A unique ID created by TaxBandits. Not required, when you re creating a contact. |
Status | string | Returns the status of the record. |
StatusTS | string | Date and time of the contact deleted. |
ErrorRecord | object | It will show the detailed information about the error status of contact Information Record. |
Errors | object[] | Shows detailed error information of contact records. |
Id | string | Returns the validation error code. |
Name | string | Name of the validation error. |
Message | string | Description of the validation error. |
Request JSON
Contact/Delete?ContactID=2906a6ab-cc63-459e-b96d-bd46c4165cfb&ContactType=FILER
Response JSON
{
"StatusCode": 200,
"StatusName": "Ok",
"StatusMessage": "Successful API call",
"SuccessRecord": {
"ContactID": "0496482c-64b6-47f0-875b-469b28e90055",
"ContactType":"FILER",
"Status": "DELETED",
"StatusTs": "2019-08-06 03:59:28 -04:00"
},
"ErrorRecord": null
}
2
3
4
5
6
7
8
9
10
11
12
# Get
Gets Contact information by Contact Id and Contact Type.
GET Contact/Get
Request Body
Field | Type | Description |
---|---|---|
ContactId | Guid | A unique ID created by TaxBandits. Not required, when you're creating a contact. |
TINType | string | Type of Taxpayer Identification Number of Filer/Recipient. Size Range: 4 Allowed values: "SSN", "EIN", "ATIN", "ITIN", "NA" |
TIN | string | Taxpayer Identification Number of Filer/Recipient. Size Range: 9 |
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 description of th Status code. |
ContactId | Guid | A unique ID created by TaxBandits. Not required, when you're creating a contact. |
Contacts | object | Gets all the contact's information under this object. Each contact will have an unique Contact Id. |
ContactManifest | object | Specify the contact type and sequence number under the manifest. |
SequenceNum | string | Use sequence number as a reference to differentiate multiple contacts created under a request. Size Range: ..10 |
ContactId | Guid | A unique ID created by TaxBandits. Not required, when you re creating a contact. |
ContactType | string | Specify the type of contact. Specify Filer, if you are going to further use the contact for filing 94x, W-2, ACA forms as an Employer and 1099 forms as a Payer. Specify Recipient if you are going to further use the contact for filing W-2, ACA forms as an Employee and 1099 forms as a Recipient. Size Range: 5..9 Allowed values: "FILER", "RECIPIENT" |
FilerContactId | Guid | The Filer Contact Id is required, only if you are creating a Recipient. The Filer Contact Id or Contact ID is generated by TaxBandits when a Contact (Filer) is created. Specify the Filer Contact Id the Recipient/Employee is linked to. |
UpdateInProgressReturns | Boolean | When true identifies that contact changes should be applied to Inprogress returns. |
Filer | object | Get values specific to the Form types you are going to file for the Contact. Required only if the selected contact type is Filer. |
Name | string | Name of the Filer. Size Range: ..40 |
NameCont | string | Continuation of the Filer name. Size Range: ..40 |
TINType | string | Type of Taxpayer Identification Number of Filer. Size Range: 3 Allowed values: "SSN", "EIN" |
TIN | string | Filer TIN. Size Range: 9 |
IsBusinessTerminated | boolean | When true, identifies that the business is closed. |
W2Specific | object | Gets W2 efile details. |
TypeOfPayer | string | Type of payer. Allowed values: "REGULAR941", "REGULAR944", "AGRICULTURAL943", "HOUSEHOLD", "MILITARY", "MEDICAREQUALGOVEM", "RAILROADFORMCT1" |
TypeOfEmployer | string | Type of employer. Allowed values: "FEDERALGOVT", "STATEORLOCAL501C", "NONGOVT501C", "STATEORLOCALNON501C", "NONEAPPLY" |
Form94xSpecific | object | Gets 94x efile details. |
TradeNm | string | Doing Filer As name. Size Range: ..35 |
BusinessType | string | Type of Business. Size Range: ..4 Allowed values: "ESTE", "PART", "CORP", "EORG", "SPRO" |
Signatory | object | Details of the person who is authorized to sign the return. |
Name | string | Name of the signing authority. Size Range: ..80 |
Title | string | Title of the signing authority. Size Range: 5..29 Allowed values: "CORPORATESECRETARY", "SECRETARYTREASURER", "PARTNER", "GENERALPARTNER", "LIMITEDPARTNER", "LLCMEMBER", "MANAGINGMEMBER", "MANAGER", "TAXMATTERPARTNER", "PRESIDENT", "VICEPRESIDENT", "CORPORATETREASURER", "TREASURER", "ASSISTANTTREASURER", "CHIEFACCOUNTINGOFFICER", "CHIEFEXECUTIVEOFFICER", "CHIEFFINANCIALOFFICER", "TAXOFFICER", "CHIEFOPERATINGOFFICER", "CORPORATEOFFICER", "EXECUTIVEDIRECTOR", "DIRECTOR", "CHAIRMAN", "EXECUTIVEADMINISTRATOR", "RECEIVER", "PASTOR", "ASSISTANTTORELIGIOUSLEADER", "REVEREND", "PRIEST", "MINISTER", "RABBI", "LEADEROFRELIGIOUSORGANIZATION", "SECRETARY", "DIRECTOROFTAXATION", "DIRECTOROFPERSONNEL", "ADMINISTRATOR", "EXECUTOR", "TRUSTEE", "FIDUCIARY", "OWNER", "SOLEPROPRIETOR", "MEMBER", "SOLEMEMBER" |
Phone | string | Phone number of the signing authority. Size Range: ..10 |
ACASpecific | Object | Gets ACA efile details. |
FilerType | string | Specify the Filer Type. Filer Type should be Employer for Form 1094C/1095C filing. Allowed values: "Employer", "Insurer" |
IsGovernmentalUnit | boolean | When true identifies that it is a government entity. |
ContactName | object | Gets contact name for ACA forms. |
PersonFirstNm | string | First name of the Contact person. Size Range: 50 |
PersonMiddleNm | string | Middle name of the Contact person. Size Range: 15 |
PersonLastNm | string | Last name of the Contact person Size Range: 50 |
SuffixNm | string | Suffix of the Contact person. Size Range: 3 |
Signatory | object | Details of the person who is authorized to sign the return. |
Name | string | Name of the signing authority. Size Range: ..80 |
Title | string | Title of the signing authority. Size Range: 5..29 Allowed values: "CORPORATESECRETARY", "SECRETARYTREASURER", "PARTNER", "GENERALPARTNER", "LIMITEDPARTNER", "LLCMEMBER", "MANAGINGMEMBER", "MANAGER", "TAXMATTERPARTNER", "PRESIDENT", "VICEPRESIDENT", "CORPORATETREASURER", "TREASURER", "ASSISTANTTREASURER", "CHIEFACCOUNTINGOFFICER", "CHIEFEXECUTIVEOFFICER", "CHIEFFINANCIALOFFICER", "TAXOFFICER", "CHIEFOPERATINGOFFICER", "CORPORATEOFFICER", "EXECUTIVEDIRECTOR", "DIRECTOR", "CHAIRMAN", "EXECUTIVEADMINISTRATOR", "RECEIVER", "PASTOR", "ASSISTANTTORELIGIOUSLEADER", "REVEREND", "PRIEST", "MINISTER", "RABBI", "LEADEROFRELIGIOUSORGANIZATION", "SECRETARY", "DIRECTOROFTAXATION", "DIRECTOROFPERSONNEL", "ADMINISTRATOR", "EXECUTOR", "TRUSTEE", "FIDUCIARY", "OWNER", "SOLEPROPRIETOR", "MEMBER", "SOLEMEMBER" |
ContactInfo | object | Gets contact info of Filer with unique contact Id. |
ContactNm | string | Name of the Contact person. Size Range: 27 |
Phone | string | Phone number of the Contact person Size Range: 10 |
PhoneExtn | string | Phone number extension of the Contact person Size Range: 5 |
string | Email address of the Contact person Size Range: 40 | |
Fax | string | Fax number of the Contact person. Size Range: 10 |
Recipient | object | Gets values specific to the Form types you are going to file for the Contact. Required only if the selected contact type is Recipient. |
TINType | string | Type of Taxpayer Identification Number of Recipient. Size Range: 3..4 Allowed values: "SSN", "EIN", "ATIN", "ITIN", "NA" |
TIN | string | Recipient's TIN. Size Range: 9 |
EmployeeName | object | Create Form W2 and ACA efile details. |
FirstNm | string | First name of the Recipient. Size Range: 15 |
MiddleNm | string | Middle name of the Recipient. Size Range: 15 |
LastNm | string | Last name of the Recipient. Size Range: 20 |
Suffix | string | Suffix of the Recipient. Size Range: 3 |
ACASpecific | Object | Gets ACA efile details of Recipient. |
DOB | string | Recipient's date of birth. Size Range: 10 |
OriginOfHealthCoverage | string | Indicates the type of coverage. Size Range: 1 Allowed values: "B", "C", "D", "E", "F" |
Form1099Specific | Object | Gets 1099 efile details of Recipient. |
Name | string | Name of the Recipient. Size Range: 40 |
Name2 | string | Continuation of the Recipient name. Size Range: 40 |
RecipientContactInfo | object | Gets Recipient contact info with a unique contact ID. |
Phone | string | Phone number of the Contact person Size Range: 10 |
string | Email address of the Contact person Size Range: 40 | |
Fax | string | Fax number of the Contact person. Size Range: 10 |
IsForeign | boolean | When true identifies that the Filer/Recipeint has a foreign address. |
USAddress | object | if IsForeign is false, pass US address of the Filer/Recipeint. |
Address1 | string | Filer/Recipient's US address (street address or post office box of that locality). Size Range: 40 |
Address2 | string | Filer/Recipient's suite or apartment. Size Range: 40 |
City | string | Filer/Recipient's city. Size Range: 40 |
State | string | Filer/Recipient's state, 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 | Filer/Recipient's zip code Size Range: ..10 |
ForeignAddress | object | if IsForeign is true, pass foreign address of the Filer. |
Address1 | string | Filer/Recipient's Foreign address (street address or post office box of that locality). Size Range: 40 |
Address2 | string | Filer/Recipient's Foreign suite or apartment. Size Range: 40 |
City | string | Filer/Recipient's city. Size Range: 30 |
ProvinceOrStateNm | string | Filer/Recipient's province or state name. Size Range: 30 |
Country | string | Filer/Recipient'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 | Filer/Recipient's postal code. Size Range: 15 |
Errors | object[] | Shows detailed error information |
Code | 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
"Contact/Get?ContactId=7844539a-59a7-4c57-9013-ede0f86dfaae&TINType=EIN&TIN=12-0457186"
Response JSON
{
"StatusCode": 200,
"StatusName": "Ok",
"StatusMessage": "Successful API call",
"ContactId": "7844539a-59a7-4c57-9013-ede0f86dfaae",
"Contacts": {
"ContactManifest": null,
"Filer": {
"Name": "Fun",
"NameCont": "John",
"TINType": "EIN",
"TIN": "468475478",
"IsBusinessTerminated":false,
"W2Specific": {
"TypeOfPayer": null,
"TypeOfEmployer": null
},
"Form94xSpecific": {
"TradeNm": null,
"BusinessType": "CORP",
"Signatory": {
"Name": "Sunil",
"Title": "PRESIDENT",
"Phone": "2654784954"
}
},
"ACASpecific": {
"FilerType": "Employer",
"IsGovernmentalUnit": true,
"ContactName": {
"PersonFirstNm": "John",
"PersonMiddleNm": "F",
"PersonLastNm": "Sr",
"SuffixNm": null
},
"SigningAuthority": {
"Name": "Sunil",
"Title": "TRUSTEE"
}
},
"ContactInfo": {
"ContactNm": "Jammy",
"Phone": "9655990058",
"PhoneExtn": "0141",
"Email": "john@gmail.com",
"Fax": "5487845874"
}
},
"Recipient": null,
"IsForeign": false,
"USAddress": {
"Address1": "1751 Kinsey Rd",
"Address2": "Main St",
"City": "Dothan",
"State": "AL",
"ZipCd": "36303"
},
"ForeignAddress": 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
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
# List
Lists contact information records created for a date range.
GET Contact/List
Request Body
Field | Type | Description |
---|---|---|
ContactType | string | Type of contact. Size Range: 5..9 Allowed values: "FILER", "RECIPIENT" |
Page | number | Pulls the page number of the page selected |
PageSize | number | Number of contact information records to be listed in each page |
filerContactId | Guid | The Contact Id of the Filer. |
FromDate | DateTime | List contact information records created from |
ToDate | DateTime | List contact information records created up to |
DateType | string | List contact information records by cerated timestamp or updated timestamp. Allowed values: "CREATEDTS", "UPDATEDTS" |
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 description of the Status code. |
Contacts | object[] | Returns detailed information of the contact information records. |
TINType | string | Type of Taxpayer Identification Number. |
TIN | string | Recipient's TIN. Size Range: 10 |
ContactId | guid | A unique ID created by TaxBandits. Not required, when you re creating a contact. |
FilerContactId | guid | The Filer Contact Id is required, only if you are creating a Recipient. The Filer Contact Id or Contact ID is generated by TaxBandits when a Contact (Filer) is created. Specify the Filer Contact Id the Recipient/Employee is linked to. |
ContactType | string | Type of contact. |
TotalRecords | number | Total number of records. |
TotalPages | number | Total number of pages. |
Page | number | Pulls the page number of the page selected. |
PageSize | number | Number of contact information records to be listed in each page. |
Errors | object[] | Shows detailed error information of contact records. |
Id | string | Returns the validation error Id. |
Name | string | Name of the validation error. |
Message | string | Description of the validation error. |
Request JSON
"Contact/List?ContactType=FILER&Page=1&PageSize=10&filerContactId=47d61ddf-7e9a-441b-846c-ed5b375fc966&FromDate=08/01/2019&ToDate=08/02/2019&&DateType="CREATEDTS""
Response JSON
{
"StatusCode": 200,
"StatusName": "Ok",
"StatusMessage": "Successful API call",
"Contacts": [
{
"TINType":"EIN",
"TIN":"15-4870351"
"ContactID": "17e1efa1-37b8-4ace-89e9-877fe749b64e",
"FilerContactID": "47d61ddf-7e9a-441b-846c-ed5b375fc966",
"ContactType": "FILER",
}
],
"Page": 1,
"TotalRecords": 1,
"TotalPages": 1,
"PageSize": 10,
"Errors": null
}
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
# Update
Updates contact with a unique Contact ID. The Contact ID can be further used for other Endpoints to refer the particular contact. The contact can be a Filer or Recipient. The Contact updated as a Filer can be further used when filing 94x (Employer), W-2 (Employer), ACA (Employer) and 1099 (Payer) forms. The Contact updated as a Recipient can be further used when filing W-2(Employee), ACA (Employee), and 1099 (Recipient) forms.
PUT Contact/Update
Request Body
Field | Type | Description |
---|---|---|
ContactCount | number | Number of contacts. Size Range: ..3 Allowed values: 1 250 |
Contacts | object[] | Send all the contact's information under this object. Each contact created will have an unique Contact ID. |
ContactManifest | object | Specify the contact type and sequence number under the manifest. |
SequenceNum | string | Use sequence number as a reference to differentiate multiple contacts created under a request. Size Range: ..10 |
ContactId | Guid | A unique ID created by TaxBandits. Not required, when you re creating a contact. |
ContactType | string | Specify the type of contact. Specify Filer, if you are going to further use the contact for filing 94x, W-2, ACA forms as an Employer and 1099 forms as a Payer. Specify Recipient if you are going to further use the contact for filing W-2, ACA forms as an Employee and 1099 forms as a Recipient. Size Range: 5..9 Allowed values: "FILER", "RECIPIENT" |
FilerContactId | Guid | The Filer Contact Id is required, only if you are creating a Recipient. The Filer Contact Id or Contact ID is generated by TaxBandits when a Contact (Filer) is created. Specify the Filer Contact Id the Recipient/Employee is linked to. |
UpdateInProgressReturns | Boolean | When true identifies that contact changes should be applied to Inprogress returns. |
Filer | object | Update values specific to the Form types you are going to file for the Contact. Required only if the selected contact type is Filer. |
Name | string | Name of the Filer. Size Range: ..40 |
NameCont | string | Continuation of the Filer name. Size Range: ..40 |
TINType | string | Type of Taxpayer Identification Number of Filer. Size Range: 3 Allowed values: "SSN", "EIN" |
TIN | string | Filer TIN. Size Range: 9 |
IsBusinessTerminated | boolean | When true, identifies that the business is closed. |
W2Specific | object | Update W2 efile details. |
TypeOfPayer | string | Type of payer. Allowed values: "REGULAR941", "REGULAR944", "AGRICULTURAL943", "HOUSEHOLD", "MILITARY", "MEDICAREQUALGOVEM", "RAILROADFORMCT1" |
TypeOfEmployer | string | Type of employer. Allowed values: "FEDERALGOVT", "STATEORLOCAL501C", "NONGOVT501C", "STATEORLOCALNON501C", "NONEAPPLY" |
Form94xSpecific | object | Update 94x efile details. |
TradeNm | string | Doing Filer As name. Size Range: ..35 |
BusinessType | string | Type of Business. Size Range: ..4 Allowed values: "ESTE", "PART", "CORP", "EORG", "SPRO" |
Signatory | object | Details of the person who is authorized to sign the return. |
Name | string | Name of the signing authority. Size Range: ..80 |
Title | string | Title of the signing authority. Size Range: 5..29 Allowed values: "CORPORATESECRETARY", "SECRETARYTREASURER", "PARTNER", "GENERALPARTNER", "LIMITEDPARTNER", "LLCMEMBER", "MANAGINGMEMBER", "MANAGER", "TAXMATTERPARTNER", "PRESIDENT", "VICEPRESIDENT", "CORPORATETREASURER", "TREASURER", "ASSISTANTTREASURER", "CHIEFACCOUNTINGOFFICER", "CHIEFEXECUTIVEOFFICER", "CHIEFFINANCIALOFFICER", "TAXOFFICER", "CHIEFOPERATINGOFFICER", "CORPORATEOFFICER", "EXECUTIVEDIRECTOR", "DIRECTOR", "CHAIRMAN", "EXECUTIVEADMINISTRATOR", "RECEIVER", "PASTOR", "ASSISTANTTORELIGIOUSLEADER", "REVEREND", "PRIEST", "MINISTER", "RABBI", "LEADEROFRELIGIOUSORGANIZATION", "SECRETARY", "DIRECTOROFTAXATION", "DIRECTOROFPERSONNEL", "ADMINISTRATOR", "EXECUTOR", "TRUSTEE", "FIDUCIARY", "OWNER", "SOLEPROPRIETOR", "MEMBER", "SOLEMEMBER" |
Phone | string | Phone number of the signing authority. Size Range: ..10 |
ACASpecific | object | Update ACA efile details. |
FilerType | string | Specify the Filer Type. Filer Type should be Employer for Form 1094C/1095C filing. Allowed values: "Employer", "Insurer" |
IsGovernmentalUnit | boolean | When true identifies that it is a government entity. |
ContactName | object | Update contact name for ACA forms. |
PersonFirstNm | string | First name of the Contact person. Size Range: 50 |
PersonMiddleNm | string | Middle name of the Contact person. Size Range: 15 |
PersonLastNm | string | Last name of the Contact person Size Range: 50 |
SuffixNm | string | Suffix of the Contact person. Size Range: 3 |
Signatory | object | Details of the person who is authorized to sign the return. |
Name | string | Name of the signing authority. Size Range: ..80 |
Title | string | Title of the signing authority. Size Range: 5..29 Allowed values: "CORPORATESECRETARY", "SECRETARYTREASURER", "PARTNER", "GENERALPARTNER", "LIMITEDPARTNER", "LLCMEMBER", "MANAGINGMEMBER", "MANAGER", "TAXMATTERPARTNER", "PRESIDENT", "VICEPRESIDENT", "CORPORATETREASURER", "TREASURER", "ASSISTANTTREASURER", "CHIEFACCOUNTINGOFFICER", "CHIEFEXECUTIVEOFFICER", "CHIEFFINANCIALOFFICER", "TAXOFFICER", "CHIEFOPERATINGOFFICER", "CORPORATEOFFICER", "EXECUTIVEDIRECTOR", "DIRECTOR", "CHAIRMAN", "EXECUTIVEADMINISTRATOR", "RECEIVER", "PASTOR", "ASSISTANTTORELIGIOUSLEADER", "REVEREND", "PRIEST", "MINISTER", "RABBI", "LEADEROFRELIGIOUSORGANIZATION", "SECRETARY", "DIRECTOROFTAXATION", "DIRECTOROFPERSONNEL", "ADMINISTRATOR", "EXECUTOR", "TRUSTEE", "FIDUCIARY", "OWNER", "SOLEPROPRIETOR", "MEMBER", "SOLEMEMBER" |
ContactInfo | object | Update contact info of Filer with unique contact Id. |
ContactNm | string | Name of the Contact person. Size Range: 27 |
Phone | string | Phone number of the Contact person Size Range: 10 |
PhoneExtn | string | Phone number extension of the Contact person Size Range: 5 |
string | Email address of the Contact person Size Range: 40 | |
Fax | string | Fax number of the Contact person. Size Range: 10 |
Recipient | object | Update values specific to the Form types you are going to file for the Contact. Required only if the selected contact type is Recipient. |
TINType | string | Type of Taxpayer Identification Number of Recipient. Size Range: 3..4 Allowed values: "SSN", "EIN", "ATIN", "ITIN", "NA" |
TIN | string | Recipient's TIN. Size Range: 9 |
EmployeeName | object | Update Form W2 and ACA efile details. |
FirstNm | string | First name of the Recipient. Size Range: 15 |
MiddleNm | string | Middle name of the Recipient. Size Range: 15 |
LastNm | string | Last name of the Recipient. Size Range: 20 |
Suffix | string | Suffix of the Recipient. Size Range: 3 |
ACASpecific | Object | Update ACA efile details of Recipient. |
DOB | string | Recipient's date of birth. Size Range: 10 |
OriginOfHealthCoverage | string | Indicates the type of coverage. Size Range: 1 Allowed values: "B", "C", "D", "E", "F" |
Form1099Specific | Object | Update 1099 efile details of Recipient. |
Name | string | Name of the Recipient. Size Range: 40 |
Name2 | string | Continuation of the Recipient name. Size Range: 40 |
RecipientContactInfo | object | Update Recipient contact info with a unique contact ID. |
Phone | string | Phone number of the Contact person Size Range: 10 |
string | Email address of the Contact person Size Range: 40 | |
Fax | string | Fax number of the Contact person. Size Range: 10 |
IsForeign | boolean | When true identifies that the Filer/Recipeint has a foreign address. |
USAddress | object | if IsForeign is false, pass US address of the Filer/Recipeint. |
Address1 | string | Filer/Recipient's US address (street address or post office box of that locality). Size Range: 40 |
Address2 | string | Filer/Recipient's suite or apartment. Size Range: 40 |
City | string | Filer/Recipient's city. Size Range: 40 |
State | string | Filer/Recipient's state 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 | Filer/Recipient's zip code Size Range: ..10 |
ForeignAddress | object | if IsForeign is true, pass foreign address of the Filer. |
Address1 | string | Filer/Recipient's Foreign address (street address or post office box of that locality). Size Range: 40 |
Address2 | string | Filer/Recipient's Foreign suite or apartment. Size Range: 40 |
City | string | Filer/Recipient's city. Size Range: 30 |
ProvinceOrStateNm | string | Filer/Recipient's province or state name. Size Range: 30 |
Country | string | Filer/Recipient'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 | Filer/Recipient's postal code. Size Range: 15 |
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 description of th Status code. |
SuccessRecords | object | It will show the detailed information about the success status of contact Information Records. |
Contacts | object[] | It will show the detailed information about the success status of contact Information Records. |
SequenceNum | string | Use sequence number as a reference to differentiate multiple contacts created under a request. |
ContactId | Guid | A unique ID created by TaxBandits. Not required, when you re creating a contact. |
Status | string | Returns the status of the records. |
StatusTS | string | Date and time of the contact updated. |
ErrorRecords | object[] | It will show the detailed information about the error status of contact Information Records. |
SequenceNum | string | Use sequence number as a reference to differentiate multiple contacts created under a request. |
Contacts | object[] | Shows detailed error information of contact records. |
Id | string | Returns the validation error code. |
Name | string | Name of the validation error. |
Message | string | Description of the validation error. |
Request JSON
{
"ContactCount": "2",
"Contacts": [
{
"ContactManifest": {
"SequenceNum": "Con-0001",
"ContactId": "7844539a-59a7-4c57-9013-ede0f86dfaae",
"ContactType": "Filer",
"FilerContactId": "00000000-0000-0000-0000-000000000000",
"UpdateInProgressReturns": true
},
"Filer": {
"Name": "Fomby Trucking",
"NameCont": "LLC",
"TINType": "EIN",
"TIN": "003587734",
"IsBusinessTerminated":false,
"W2Specific": {
"TypeOfPayer": null,
"TypeOfEmployer": null
},
"Form94xSpecific": {
"TradeNm": null,
"BusinessType": "CORP",
"Signatory": {
"Name": "John",
"Title": "PRESIDENT",
"Phone": "2654784954"
}
},
"ACASpecific": {
"FilerType": "Employer",
"IsGovernmentalUnit": true,
"ContactName": {
"PersonFirstNm": "John",
"PersonMiddleNm": "F",
"PersonLastNm": "Kennedy",
"SuffixNm": "Sr"
},
"SigningAuthority": {
"Name": "John",
"Title": "TRUSTEE"
}
},
"ContactInfo": {
"ContactNm": "Jammy",
"Phone": "9655990058",
"PhoneExtn": "0141",
"Email": "john@gmail.com",
"Fax": "5487845874"
}
},
"Recipient": null,
"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
}
},
{
"ContactManifest": {
"SequenceNum": "Con-0002",
"ContactId": "ca287121-2fb6-466f-910f-0bce6145e2ce",
"ContactType": "Recipient",
"FilerContactId": "5bebe6ca-2344-4215-97f4-3e88cd1bd582",
"UpdateInProgressReturns": false
},
"Filer": null,
"Recipient": {
"TINType": "EIN",
"TIN": "458475478",
"EmployeeName": {
"FirstNm": "John",
"MiddleNm": "F",
"LastNm": "Kennedy",
"Suffix": "Jr"
},
"ACASpecific": {
"DOB": "07-20-2020",
"OriginOfHealthCoverage": "B"
},
"Form1099Specific": {
"Name": "King",
"Name2": "Loius"
},
"RecipientContactInfo": {
"Phone": "9655990058",
"Email": "john@gmail.com",
"Fax": "5487845874"
}
},
"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
}
}
]
}
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
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
Response JSON
{
"StatusCode": 200,
"StatusName": "Ok",
"StatusMessage": "Successful API call",
"SuccessRecords": {
"Contacts": [
{
"SequenceNum": "Con-0001",
"ContactId": "7844539a-59a7-4c57-9013-ede0f86dfaae",
"Status": "UPDATED",
"StatusTS": "2020-08-12 13:44:57 +05:30"
},
{
"SequenceNum": "Con-0002",
"ContactId": "ca287121-2fb6-466f-910f-0bce6145e2ce",
"Status": "UPDATED",
"StatusTS": "2020-08-12 13:45:54 +05:30"
}
]
},
"ErrorRecords": null
}
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22