Version: 1.7.3

Update

Updates the existing Form 1042-S return created in TaxBandits. Use the unique identifiers to refer a particular return. You cannot update a Transmitted return.

PUT Form1042S/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.
TaxYear	string	Tax year of Form 1042-S to be filed. Allowed values: "2022","2023"
IsFederalFiling	Boolean	Federal Filing for the return will be enabled when the value is True. Form 1042-S 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 1042-S 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	If this value is set as true, the Online Access service will be enabled for all the recipients included in the submission. Once the returns are transmitted, an email with a link to the secure TaxBandits portal will be sent to the recipients. The recipients can then provide consent and download Form 1042-S copies from the portal.
IsScheduleFiling	Boolean	When true, schedule filing services will be provided for Form 1042-S 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/2023 or 10-20-2023
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 the response of the Business CREATE Endpoint. If you do not have a Business ID, ignore the field. By giving the Business ID, you do not have to provide all the business information again.
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
BusinessNm	string	Name of the business Size Range: ..75
FirstNm	string	First Name of the Individual Size Range: ..20
MiddleNm	string	Middle Name of the Individual Size Range: ..20
LastNm	string	Last Name of the Individual Size Range: ..20
Suffix	string	Suffix of the Individual Allowed values "Jr", "Sr", "I", "II", "III", "IV", "V", "VI", "VII"
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) Size Range: 9-11
Email	string	Optional Email address of the Business Size Range: ..100
ContactNm	string	Optional Name of the person who can be contacted by the IRS Size Range: ..27
Phone	string	Optional Phone number of the business Size Range: 10
PhoneExtn	string	Optional Extension of the business phone number Size Range: ..5
Fax	string	Optional Fax number of the Business Size Range: 10
BusinessType	string	Optional Type of business. Optional for W-2/1042-S and mandatory for 94X series Size Range: ..4 Allowed values "ESTE", "PART", "CORP", "EORG", "SPRO"
SigningAuthority	object	Optional Details of the person who is authorized to sign the return
Name	string	Optional Name of the signing authority Size Range: ..35
Phone	string	Optional Phone number of the signing authority Size Range: 10
BusinessMemberType	string	Optional Business title of the signing authority Size Range: 5..29 Allowed values "CORPORATESECRETARY", "SECRETARYTREASURER", "PARTNER", "GENERALPARTNER", "LIMITEDPARTNER", "LLCMEMBER", "MANAGINGMEMBER", "MANAGER", "TAXMATTERPARTNER", "PRESIDENT", "VICEPRESIDENT", "CORPORATETREASURER", "TREASURER", "ASSISTANTTREASURER", "CHIEFACCOUNTINGOFFICER", "CHIEFEXECUTIVEOFFICER", "CHIEFFINANCIALOFFICER", "TAXOFFICER", "CHIEFOPERATINGOFFICER", "CORPORATEOFFICER", "EXECUTIVEDIRECTOR", "DIRECTOR", "CHAIRMAN", "EXECUTIVEADMINISTRATOR", "RECEIVER", "PASTOR", "ASSISTANTTORELIGIOUSLEADER", "REVEREND", "PRIEST", "MINISTER", "RABBI", "LEADEROFRELIGIOUSORGANIZATION", "SECRETARY", "DIRECTOROFTAXATION", "DIRECTOROFPERSONNEL", "ADMINISTRATOR", "EXECUTOR", "TRUSTEE", "FIDUCIARY", "OWNER", "SOLEPROPRIETOR", "MEMBER", "SOLEMEMBER"
KindOfEmployer	string	Optional Identifies the kind of employer. Mandatory for W-2 and optional for 1042-S Allowed values "FEDERALGOVT", "STATEORLOCAL501C", "NONGOVT501C", "STATEORLOCALNON501C", "NONEAPPLY"
KindOfPayer	string	Optional Identifies the kind of payer. This field is mandatory in W-2 and optional in 1042-S Allowed values "REGULAR941", "REGULAR944", "AGRICULTURAL943", "HOUSEHOLD", "MILITARY", "MEDICAREQUALGOVEM", "RAILROADFORMCT1"
IsBusinessTerminated	Boolean	When true, identifies the business as terminated.
Form1042SDetails	object	Details of Withholding agent's chapter 3 and chapter 4 status codes
WHAgtCh3Cd	string	Chapter 3 status code of Withholding agent Size Range: 2 Allowed values "05", "06", "07", "08", "09", "10", "11", "12", "13", "14", "15", "16", "17", "18", "19", "20", "21", "22", "23", "24", "25", "26", "27", "28", "29", "30", "31", "32", "35", "36", "37", "38", "39"
WHAgtCh4Cd	string	Chapter 4 status code of Withholding agent Size Range: 2 Allowed values "01", "02", "03", "04", "05", "06", "07", "08", "09", "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"
WHAgtGIIN	string	Optional Withholding agent’s Global Intermediary Identification Number (GIIN) Size Range: ..15
FTIN	string	Optional FTIN of Withholding agent
Country	string	Optional Withholding agent's country Size Range: 2 Allowed values "AF", "AX", "AL", "AG", "AQ", "AN", "AO", "AV", "AY", "AC", "AR", "AM", "AA", "AT", "AS", "AU", "AJ", "BF", "BA", "FQ", "BG", "BB", "BO", "BE", "BH", "BN", "BD", "BT", "BL", "BK", "BC", "BV", "BR", "IO", "VI", "BX", "BU", "UV", "BM", "BY", "CB", "CM", "CA", "CV", "CJ", "CT", "CD", "CI", "CH", "KT", "IP", "CK", "CO", "CN", "CF", "CG", "CW", "CR", "CS", "IV", "HR", "CU", "UC", "CY", "EZ", "DA", "DX", "DJ", "DO", "DR", "TT", "EC", "EG", "ES", "EK", "ER", "EN", "ET", "FK", "FO", "FM", "FJ", "FI", "FR", "FP", "FS", "GB", "GA", "GG", "GM", "GH", "GI", "GR", "GL", "GJ", "GQ", "GT", "GK", "GV", "PU", "GY", "HA", "HM", "VT", "HO", "HK", "HQ", "HU", "IC", "IN", "ID", "IR", "IZ", "EI", "IS", "IT", "JM", "JN", "JA", "DQ", "JE", "JQ", "JO", "KZ", "KE", "KQ", "KR", "KN", "KS", "KV", "KU", "KG", "LA", "LG", "LE", "LT", "LI", "LY", "LS", "LH", "LU", "MC", "MK", "MA", "MI", "MY", "MV", "ML", "MT", "IM", "RM", "MR", "MP", "MX", "MQ", "MD", "MN", "MG", "MJ", "MH", "MO", "MZ", "WA", "NR", "BQ", "NP", "NL", "NC", "NZ", "NU", "NG", "NI", "NE", "NF", "CQ", "NO", "MU", "OC", "PK", "PS", "LQ", "PM", "PP", "PF", "PA", "PE", "RP", "PC", "PL", "PO", "RQ", "QA", "RO", "RS", "RW", "TB", "RN", "WS", "SM", "TP", "SA", "SG", "RI", "SE", "SL", "SN", "NN", "LO", "SI", "BP", "SO", "SF", "SX", "OD", "SP", "PG", "CE", "SH", "SC", "ST", "SB", "VC", "SU", "NS", "SV", "WZ", "SW", "SZ", "SY", "TW", "TI", "TZ", "TH", "TO", "TL", "TN", "TD", "TS", "TU", "TX", "TK", "TV", "UG", "UP", "AE", "UK", "UY", "UZ", "NH", "VE", "VM", "VQ", "WQ", "WF", "WI", "YM", "ZA", "ZI"
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 address or post office box of that locality) Size Range: ..46
Address2	string	Optional Employer/Payer's suite or apartment Size Range: ..46
City	string	Employer/Payer's city Size Range: ..50
State	string	Employer/Payer's state code. Refer Static values. Size Range: 2 Allowed values "AL", "AK", "AZ", "AR", "CA", "CO", "CT", "DE", "DC", "FL", "GA", "HI", "ID", "IL", "IN", "IA", "KS", "KY", "LA", "ME", "MD", "MA", "MI", "MN", "MS", "MO", "MT", "NE", "NV", "NH", "NJ", "NM", "NY", "NC", "ND", "OH", "OK", "OR", "PA", "RI", "SC", "SD", "TN", "TX", "UT", "VT", "VA", "WA", "WV", "WI", "WY", "AS", "FM", "GU", "MH", "MP", "PW", "PR", "VI", "AA", "AE", "AP"
ZipCd	string	Employer/Payer's zip code. Size Range: 5..10
ForeignAddress	object	If IsForeign is true, pass foreign address of the business
Address1	string	Employer/Payer's foreign address (street address or post office box of that locality) Size Range: ..50
Address2	string	Optional Employer/Payer's suite or apartment Size Range: ..50
City	string	Employer/Payer's city Size Range: ..50
ProvinceOrStateNm	string	Employer/Payer's province or state name Size Range: ..50
Country	string	Employer/Payer's country Size Range: 2 Allowed values "AF", "AX", "AL", "AG", "AQ", "AN", "AO", "AV", "AY", "AC", "AR", "AM", "AA", "AT", "AS", "AU", "AJ", "BF", "BA", "FQ", "BG", "BB", "BO", "BE", "BH", "BN", "BD", "BT", "BL", "BK", "BC", "BV", "BR", "IO", "VI", "BX", "BU", "UV", "BM", "BY", "CB", "CM", "CA", "CV", "CJ", "CT", "CD", "CI", "CH", "KT", "IP", "CK", "CO", "CN", "CF", "CG", "CW", "CR", "CS", "IV", "HR", "CU", "UC", "CY", "EZ", "DA", "DX", "DJ", "DO", "DR", "TT", "EC", "EG", "ES", "EK", "ER", "EN", "ET", "FK", "FO", "FM", "FJ", "FI", "FR", "FP", "FS", "GB", "GA", "GG", "GM", "GH", "GI", "GR", "GL", "GJ", "GQ", "GT", "GK", "GV", "PU", "GY", "HA", "HM", "VT", "HO", "HK", "HQ", "HU", "IC", "IN", "ID", "IR", "IZ", "EI", "IS", "IT", "JM", "JN", "JA", "DQ", "JE", "JQ", "JO", "KZ", "KE", "KQ", "KR", "KN", "KS", "KV", "KU", "KG", "LA", "LG", "LE", "LT", "LI", "LY", "LS", "LH", "LU", "MC", "MK", "MA", "MI", "MY", "MV", "ML", "MT", "IM", "RM", "MR", "MP", "MX", "MQ", "MD", "MN", "MG", "MJ", "MH", "MO", "MZ", "WA", "NR", "BQ", "NP", "NL", "NC", "NZ", "NU", "NG", "NI", "NE", "NF", "CQ", "NO", "MU", "OC", "PK", "PS", "LQ", "PM", "PP", "PF", "PA", "PE", "RP", "PC", "PL", "PO", "RQ", "QA", "RO", "RS", "RW", "TB", "RN", "WS", "SM", "TP", "SA", "SG", "RI", "SE", "SL", "SN", "NN", "LO", "SI", "BP", "SO", "SF", "SX", "OD", "SP", "PG", "CE", "SH", "SC", "ST", "SB", "VC", "SU", "NS", "SV", "WZ", "SW", "SZ", "SY", "TW", "TI", "TZ", "TH", "TO", "TL", "TN", "TD", "TS", "TU", "TX", "TK", "TV", "UG", "UP", "AE", "UK", "UY", "UZ", "NH", "VE", "VM", "VQ", "WQ", "WF", "WI", "YM", "ZA", "ZI"
PostalCd	string	Employer/Payer's postal code Size Range: ..16
ReturnData	object[]	Contains information about the recipient details and Form 1042-S details.
SequenceId	string	An 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
Recipient	object	Object to identify the recipient details.
RecipientId	Guid	OptionalAn unique ID generated by TaxBandits after the return is created and will be 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
FirstNm	string	First Name of the Individual Size Range: ..20
MiddleNm	string	Middle Name of the Individual Size Range: ..20
LastNm	string	Last Name of the Individual Size Range: ..20
Suffix	string	Suffix of the Individual Allowed values "Jr", "Sr", "I", "II", "III", "IV", "V", "VI", "VII"
Form1042SDetails	object	Details of recipient's chapter 3 and Chapter 4 status codes
RecCh3Cd	string	Chapter 3 status code of recipient Size Range: 2 Allowed values "05", "06", "07", "08", "09", "10", "11", "12", "13", "14", "15", "16", "17", "18", "19", "20", "21", "22", "23", "24", "25", "26", "27", "28", "29", "30", "31", "32", "35", "36", "37", "38", "39"
RecCh4Cd	string	Chapter 4 status code of recipient Size Range: 2 Allowed values "01", "02", "03", "04", "05", "06", "07", "08", "09", "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"
RecGIIN	string	Optional Recipient’s Global Intermediary Identification Number (GIIN) Size Range: ..15
FTIN	string	Optional FTIN of recipient
LOB	string	Optional Limitation on Benefits (LOB) code of recipient Size Range: 2 Allowed values "02", "03", "04", "05", "06", "07", "08", "09", "10", "11", "12"
DOB	string	Optional Recipient's date of birth . Enter the date in the format: MM/DD/YYYY or MM-DD-YYYY Example: 10/20/2023 or 10-20-2023
Country	string	Optional Recipient's country Size Range: 2 Allowed values "AF", "AX", "AL", "AG", "AQ", "AN", "AO", "AV", "AY", "AC", "AR", "AM", "AA", "AT", "AS", "AU", "AJ", "BF", "BA", "FQ", "BG", "BB", "BO", "BE", "BH", "BN", "BD", "BT", "BL", "BK", "BC", "BV", "BR", "IO", "VI", "BX", "BU", "UV", "BM", "BY", "CB", "CM", "CA", "CV", "CJ", "CT", "CD", "CI", "CH", "KT", "IP", "CK", "CO", "CN", "CF", "CG", "CW", "CR", "CS", "IV", "HR", "CU", "UC", "CY", "EZ", "DA", "DX", "DJ", "DO", "DR", "TT", "EC", "EG", "ES", "EK", "ER", "EN", "ET", "FK", "FO", "FM", "FJ", "FI", "FR", "FP", "FS", "GB", "GA", "GG", "GM", "GH", "GI", "GR", "GL", "GJ", "GQ", "GT", "GK", "GV", "PU", "GY", "HA", "HM", "VT", "HO", "HK", "HQ", "HU", "IC", "IN", "ID", "IR", "IZ", "EI", "IS", "IT", "JM", "JN", "JA", "DQ", "JE", "JQ", "JO", "KZ", "KE", "KQ", "KR", "KN", "KS", "KV", "KU", "KG", "LA", "LG", "LE", "LT", "LI", "LY", "LS", "LH", "LU", "MC", "MK", "MA", "MI", "MY", "MV", "ML", "MT", "IM", "RM", "MR", "MP", "MX", "MQ", "MD", "MN", "MG", "MJ", "MH", "MO", "MZ", "WA", "NR", "BQ", "NP", "NL", "NC", "NZ", "NU", "NG", "NI", "NE", "NF", "CQ", "NO", "MU", "OC", "PK", "PS", "LQ", "PM", "PP", "PF", "PA", "PE", "RP", "PC", "PL", "PO", "RQ", "QA", "RO", "RS", "RW", "TB", "RN", "WS", "SM", "TP", "SA", "SG", "RI", "SE", "SL", "SN", "NN", "LO", "SI", "BP", "SO", "SF", "SX", "OD", "SP", "PG", "CE", "SH", "SC", "ST", "SB", "VC", "SU", "NS", "SV", "WZ", "SW", "SZ", "SY", "TW", "TI", "TZ", "TH", "TO", "TL", "TN", "TD", "TS", "TU", "TX", "TK", "TV", "UG", "UP", "AE", "UK", "UY", "UZ", "NH", "VE", "VM", "VQ", "WQ", "WF", "WI", "YM", "ZA", "ZI"
IsForeign	Boolean	When true, identifies the recipeint address with a foreign address.
USAddress	object	If IsForeign is false, pass US address of the recipient
Address1	string	Recipient's US address (street address or post office box of that locality) Size Range: ..46
Address2	string	Optional Recipient's suite or apartment Size Range: ..46
City	string	Recipient's city Size Range: ..50
State	string	Recipient's state code. Refer Static values. Size Range: 2 Allowed values "AL", "AK", "AZ", "AR", "CA", "CO", "CT", "DE", "DC", "FL", "GA", "HI", "ID", "IL", "IN", "IA", "KS", "KY", "LA", "ME", "MD", "MA", "MI", "MN", "MS", "MO", "MT", "NE", "NV", "NH", "NJ", "NM", "NY", "NC", "ND", "OH", "OK", "OR", "PA", "RI", "SC", "SD", "TN", "TX", "UT", "VT", "VA", "WA", "WV", "WI", "WY", "AS", "FM", "GU", "MH", "MP", "PW", "PR", "VI", "AA", "AE", "AP"
ZipCd	string	Recipient's zip code Size Range: 5..10
ForeignAddress	object	If IsForeign is true, pass foreign address of the recipient
Address1	string	Recipient's foreign address (street address or post office box of that locality) Size Range: ..50
Address2	string	Optional Recipient's suite or apartment Size Range: ..50
City	string	Recipient's city. Size Range: ..50
ProvinceOrStateNm	string	Recipient's Province or State Name. Size Range: ..50
Country	string	Recipient's country code. Refer Static values. Size Range: 2 Allowed values "AF", "AX", "AL", "AG", "AQ", "AN", "AO", "AV", "AY", "AC", "AR", "AM", "AA", "AT", "AS", "AU", "AJ", "BF", "BA", "FQ", "BG", "BB", "BO", "BE", "BH", "BN", "BD", "BT", "BL", "BK", "BC", "BV", "BR", "IO", "VI", "BX", "BU", "UV", "BM", "BY", "CB", "CM", "CA", "CV", "CJ", "CT", "CD", "CI", "CH", "KT", "IP", "CK", "CO", "CN", "CF", "CG", "CW", "CR", "CS", "IV", "HR", "CU", "UC", "CY", "EZ", "DA", "DX", "DJ", "DO", "DR", "TT", "EC", "EG", "ES", "EK", "ER", "EN", "ET", "FK", "FO", "FM", "FJ", "FI", "FR", "FP", "FS", "GB", "GA", "GG", "GM", "GH", "GI", "GR", "GL", "GJ", "GQ", "GT", "GK", "GV", "PU", "GY", "HA", "HM", "VT", "HO", "HK", "HQ", "HU", "IC", "IN", "ID", "IR", "IZ", "EI", "IS", "IT", "JM", "JN", "JA", "DQ", "JE", "JQ", "JO", "KZ", "KE", "KQ", "KR", "KN", "KS", "KV", "KU", "KG", "LA", "LG", "LE", "LT", "LI", "LY", "LS", "LH", "LU", "MC", "MK", "MA", "MI", "MY", "MV", "ML", "MT", "IM", "RM", "MR", "MP", "MX", "MQ", "MD", "MN", "MG", "MJ", "MH", "MO", "MZ", "WA", "NR", "BQ", "NP", "NL", "NC", "NZ", "NU", "NG", "NI", "NE", "NF", "CQ", "NO", "MU", "OC", "PK", "PS", "LQ", "PM", "PP", "PF", "PA", "PE", "RP", "PC", "PL", "PO", "RQ", "QA", "RO", "RS", "RW", "TB", "RN", "WS", "SM", "TP", "SA", "SG", "RI", "SE", "SL", "SN", "NN", "LO", "SI", "BP", "SO", "SF", "SX", "OD", "SP", "PG", "CE", "SH", "SC", "ST", "SB", "VC", "SU", "NS", "SV", "WZ", "SW", "SZ", "SY", "TW", "TI", "TZ", "TH", "TO", "TL", "TN", "TD", "TS", "TU", "TX", "TK", "TV", "UG", "UP", "AE", "UK", "UY", "UZ", "NH", "VE", "VM", "VQ", "WQ", "WF", "WI", "YM", "ZA", "ZI"
PostalCd	string	Recipient's Postal Code Size Range: ..16
Email	string	Optional Recipient's email address. Size Range: 0..100 Note : This email address cannot be the same for two different recipients under the same business.
Fax	string	Optional Recipient's Fax number. Size Range: 10
Phone	string	Optional Recipient's Phone Number. Size Range: 10
Form1042SData	object	Recipient's Form 1042S information.
B1IncomeCd	string	Income code for the type of payment made to recipient Size Range: 2 Allowed values "01", "02", "03", "04", "05", "06", "07", "08", "09", "10", "11", "12", "13", "14", "15", "16", "17", "18", "19", "20", "22", "23", "24", "25", "26", "27", "28", "29", "30", "31", "32", "33", "34", "35", "36", "37", "38", "39", "40", "41", "42", "43", "44", "50", "51", "52", "53", "54", "55", "56", "57", "58"
B2GrossIncome	number	OptionalGross Income paid to the recipient Size Range: 0-9999999999.99
B3IsChapter3	Boolean	When true identifies that the chapter indicator is 3
Ch3Details	object	Chapter 3 information
B3aExemptionCd	string	Exemption code of chapter 3 Allowed values "00","01", "02", "03", "04", "05", "06", "07", "08", "09", "10", "11", "12", "22", "23", "24"
B3bTaxRate	string	Tax rate for the given exemption code Size Range: 2 Allowed values "0", "2", "4", "4.9", "4.95", "5", "7", "8", "10", "12", "12.5", "14", "15", "17.5", "20", "21", "24", "25", "27.5", "28", "30", "37"
B3IsChapter4	Boolean	When true identifies that the chapter indicator is 4
Ch4Details	object	Chapter 4 information
B4aExemptionCd	string	Exemption code of chapter 4 Size Range: 2 Allowed values "00", "13", "14", "15", "16", "17", "18", "19", "20", "21"
B4bTaxRate	string	Tax rate for the given exemption code Allowed values "0", "30"
B5WHAllowance	number	Total Withholding allowance paid to recipient Size Range: 0-9999999999.99
B6NetIncome	number	OptionalNet Income paid to recipient. Size Range: 0-9999999999.99
B7aFedTaxWH	number	OptionalGets the amount of Federal Tax Withheld
B7bIsFedWHNotDep	Boolean	When true identifies that the federal tax withheld was not deposited with the IRS because escrow procedures were applied
B7cIsWHOccInSubYear	Boolean	When true identifies that the withholding occurred in subsequent year with respect to a partnership interest.
B8TaxWHByOtherAgents	number	Optional Gets the actual withheld by the other agent(s) if you are filing 1042-S to report income that has already been subject to withholding by another withholding agent Size Range: 0-9999999999.99
B9OverWHTaxRepaid	number	Optional Overwithheld tax repaid to recipient pursuant to adjustment procedures Size Range: 0-9999999999.99
B10TotalWHCredit	number	Optional Total withholding credit (sum of B7aFedTaxWH, B8TaxWHByOtherAgents and B9OverWHTaxRepaid) Size Range: 0-9999999999.99
B11TaxPaidByWHAgent	number	Optional Total Tax paid by withholding agent Size Range: 0-9999999999.99
B13kRecipientAccNum	string	Optional Account number of recipient Size Range: 4..20
B14PrimaryWHAgentDetails	object	Details of primary withholding agent
NameLine1	string	Name of the primary withholding agent Size Range: 40
NameLine2	string	Optional Name of the primary withholding agent (cont.) Size Range: 40
EIN	string	Gets the EIN (Employer Identification Number) of primary withholding agent Size Range: 9
B15IsProRataReporting	Boolean	When true identifies that the withholding agent is subject to pro-rata basis reporting
B15IntermediaryDetails	object	Details Intermediary or flow-through entity
NameLine1	string	Name of the Intermediary or flow-through entity Size Range: 40
NameLine2	string	Optional Name of the Intermediary or flow-through entity (cont.) Size Range: 40
NameLine3	string	Optional Name of the Intermediary or flow-through entity (cont.) Size Range: 40
EIN	string	Gets the EIN (Employer Identification Number) of Intermediary or flow-through entity Size Range: 9
IsForeign	Boolean	When true, identifies the Intermediary or flow-through entity's address with a foreign address.
USAddress	object	Object to identify the Intermediary or flow-through entity's US address
Address1	string	Intermediary or flow-through entity's US address (street address or post office box of that locality) Size Range: ..46
Address2	string	Optional Intermediary or flow-through entity's suite or apartment Size Range: ..46
City	string	Intermediary or flow-through entity's city Size Range: ..50
State	string	Intermediary or flow-through entity'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	Intermediary or flow-through entity's Zip code. Size Range: 5..10
ForeignAddress	object	Object to identify the Intermediary or flow-through entity's Foreign address
Address1	string	Intermediary or flow-through entity's US address (street address or post office box of that locality) Size Range: ..50
Address2	string	Optional Intermediary or flow-through entity's suite or apartment Size Range: ..50
City	string	Intermediary or flow-through entity's city Size Range: ..50
ProvinceOrStateNm	string	Intermediary or flow-through entity's province or state name Size Range: ..50
Country	string	Intermediary or flow-through entity's country Size Range: 2 Allowed values "AF", "AX", "AL", "AG", "AQ", "AN", "AO", "AV", "AY", "AC", "AR", "AM", "AA", "AT", "AS", "AU", "AJ", "BF", "BA", "FQ", "BG", "BB", "BO", "BE", "BH", "BN", "BD", "BT", "BL", "BK", "BC", "BV", "BR", "IO", "VI", "BX", "BU", "UV", "BM", "BY", "CB", "CM", "CA", "CV", "CJ", "CT", "CD", "CI", "CH", "KT", "IP", "CK", "CO", "CN", "CF", "CG", "CW", "CR", "CS", "IV", "HR", "CU", "UC", "CY", "EZ", "DA", "DX", "DJ", "DO", "DR", "TT", "EC", "EG", "ES", "EK", "ER", "EN", "ET", "FK", "FO", "FM", "FJ", "FI", "FR", "FP", "FS", "GB", "GA", "GG", "GM", "GH", "GI", "GR", "GL", "GJ", "GQ", "GT", "GK", "GV", "PU", "GY", "HA", "HM", "VT", "HO", "HK", "HQ", "HU", "IC", "IN", "ID", "IR", "IZ", "EI", "IS", "IT", "JM", "JN", "JA", "DQ", "JE", "JQ", "JO", "KZ", "KE", "KQ", "KR", "KN", "KS", "KV", "KU", "KG", "LA", "LG", "LE", "LT", "LI", "LY", "LS", "LH", "LU", "MC", "MK", "MA", "MI", "MY", "MV", "ML", "MT", "IM", "RM", "MR", "MP", "MX", "MQ", "MD", "MN", "MG", "MJ", "MH", "MO", "MZ", "WA", "NR", "BQ", "NP", "NL", "NC", "NZ", "NU", "NG", "NI", "NE", "NF", "CQ", "NO", "MU", "OC", "PK", "PS", "LQ", "PM", "PP", "PF", "PA", "PE", "RP", "PC", "PL", "PO", "RQ", "QA", "RO", "RS", "RW", "TB", "RN", "WS", "SM", "TP", "SA", "SG", "RI", "SE", "SL", "SN", "NN", "LO", "SI", "BP", "SO", "SF", "SX", "OD", "SP", "PG", "CE", "SH", "SC", "ST", "SB", "VC", "SU", "NS", "SV", "WZ", "SW", "SZ", "SY", "TW", "TI", "TZ", "TH", "TO", "TL", "TN", "TD", "TS", "TU", "TX", "TK", "TV", "UG", "UP", "AE", "UK", "UY", "UZ", "NH", "VE", "VM", "VQ", "WQ", "WF", "WI", "YM", "ZA", "ZI"
PostalCd	string	Intermediary or flow-through entity's postal code. Size Range: ..16
GIIN	string	Intermediary or flow-through entity's GIIN Size Range: ..15
Ch3Cd	string	Chapter 3 status code of Intermediary or flow-through entity Size Range: 2 Allowed values "05", "06", "07", "08", "09", "10", "11", "12", "13", "14", "15", "16", "17", "18", "19", "20", "21", "22", "23", "24", "25", "26", "27", "28", "29", "30", "31", "32", "35", "36", "37", "38", "39"
Ch4Cd	string	Chapter 4 status code of Intermediary or flow-through entity Size Range: 2 Allowed values "01", "02", "03", "04", "05", "06", "07", "08", "09", "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"
FTIN	string	FTIN of Intermediary or flow-through entity
Country	string	Intermediary or flow-through entity's country code 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"
B16PayerDetails	object	Object to identify the payer details
Name	string	Name of the payer Size Range: ..40
TINType	string	TIN type of the payer. Allowed values "SSN", "EIN", "ITIN", "ATIN", "NA"
TIN	number	Enter the nine-digit taxpayer identification number of the Payer. Size Range: 9
GIIN	string	Gets the payer's GIIN Size Range: 9
Ch3Cd	number	Chapter 3 status code of payer Size Range: 2 Allowed values "05", "06", "07", "08", "09", "10", "11", "12", "13", "14", "15", "16", "17", "18", "19", "20", "21", "22", "23", "24", "25", "26", "27", "28", "29", "30", "31", "32", "35", "36", "37", "38", "39"
Ch4Cd	number	Gets the chapter 4 code of payer Size Range: 2 Allowed values "01", "02", "03", "04", "05", "06", "07", "08", "09", "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"
B17State	object	Contains information about the state income tax withheld for payer
StateCd	string	Gets the State code of payer 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"
StateIdNum	number	Gets the State id number of payer
StateTaxWH	number	Total state income tax withheld Size Range: 0-9999999999.99
UniqueId	number	Unique form identifier number Size Range: ..10

Request JSON

Sample 1
Sample 2

Create a Form 1042S return for the specific Business and include recipient and income information and update the Recipient / Form Details with RecipientId and RecordId

{
    "SubmissionManifest": {
        "SubmissionId": "f12a60f7-8857-4843-9ab0-dc6cc6ea1ae8",
        "TaxYear": "2022",
        "IsFederalFiling": true,
        "IsPostal": true,
        "IsOnlineAccess": true,
        "IsScheduleFiling": false,
        "ScheduleFiling": null
    },
    "ReturnHeader": {
        "Business": {
            "BusinessId": "5f71019e-27d6-4f36-a116-5ae28361f537",
            "BusinessNm": "Snowdaze LLC",
            "FirstNm": null,
            "MiddleNm": null,
            "LastNm": null,
            "Suffix": null,
            "TradeNm": "Iceberg Icecreams",
            "IsEIN": true,
            "EINorSSN": "66-7908757",
            "Email": "james@sample.com",
            "ContactNm": "James",
            "Phone": "9934567890",
            "PhoneExtn": "12345",
            "Fax": "6934567890",
            "BusinessType": "ESTE",
            "SigningAuthority": {
                "Name": "James",
                "Phone": "9934567890",
                "BusinessMemberType": "ADMINISTRATOR"
            },
            "KindOfEmployer": "FederalGovt",
            "KindOfPayer": "REGULAR941",
            "IsBusinessTerminated": true,
            "Form1042SDetails": {
                "WHAgtCh3Cd": "11",
                "WHAgtCh4Cd": "16",
                "WHAgtGIIN": "123456.78901.LE.333",
                "FTIN": "12345",
                "Country": "AL"
            },
            "IsForeign": false,
            "USAddress": {
                "Address1": "15 Park Avenue",
                "Address2": "Louis St",
                "City": "Seattle",
                "State": "WA",
                "ZipCd": "98944"
            },
            "ForeignAddress": null
        }
    },
    "ReturnData": [
        {
            "RecordId": "f5d950e3-a69a-4c33-b82a-80de7edcfa54",
            "SequenceId": "1",
            "IsOnlineAccess": true,
            "IsPostal": true,
            "Recipient": {
                "RecipientId": "94126fda-a688-4dac-a4aa-4dfd412795a5",
                "TINType": "SSN",
                "TIN": "633091233",
                "FirstPayeeNm": null,
                "SecondPayeeNm": null,
                "FirstNm": "Nelson",
                "MiddleNm": "K",
                "LastNm": "Willsom",
                "Suffix": "VI",
                "Form1042SDetails": {
                    "RecCh3Cd": "08",
                    "RecCh4Cd": "10",
                    "RecGIIN": "456445.56789.LE.444",
                    "FTIN": "32032",
                    "LOB": "02",
                    "DOB": "12-12-2024",
                    "Country": "CT"
                },
                "IsForeign": false,
                "USAddress": {
                    "Address1": "1605 Kinsey Rd",
                    "Address2": "Main St",
                    "City": "Dothan",
                    "State": "AL",
                    "ZipCd": "36303"
                },
                "ForeignAddress": null,
                "Email": "nelson@sample.com",
                "Fax": "9934567890",
                "Phone": "8834567890"
            },
            "Form1042SData": {
                "B1IncomeCd": "16",
                "B2GrossIncome": 1000,
                "B3IsChapter3": true,
                "Ch3Details": {
                    "B3aExemptionCd": "00",
                    "B3bTaxRate": "30"
                },
                "B3IsChapter4": false,
                "Ch4Details": {
                    "B4aExemptionCd": null,
                    "B4bTaxRate": null
                },
                "B5WHAllowance": 10,
                "B6NetIncome": 10,
                "B7aFedTaxWH": 100,
                "B7bIsFedWHNotDep": true,
                "B7cIsWHOccInSubYear": true,
                "B8TaxWHByOtherAgents": 10,
                "B9OverWHTaxRepaid": 10,
                "B10TotalWHCredit": 120,
                "B11TaxPaidByWHAgent": 120,
                "B13kRecipientAccNum": "32323213213",
                "B14PrimaryWHAgentDetails": {
                    "NameLine1": "Michalin",
                    "NameLine2": "C",
                    "EIN": "463456789"
                },
                "B15IsProRataReporting": true,
                "B15IntermediaryDetails": {
                    "NameLine1": "Nick",
                    "NameLine2": "T",
                    "NameLine3": "shawn",
                    "EIN": "534567890",
                    "IsForeign": false,
                    "USAddress": {
                        "Address1": "1751 Kinsey Rd",
                        "Address2": "Main St",
                        "City": "Dothan",
                        "State": "AL",
                        "ZipCd": "36303"
                    },
                    "ForeignAddress": null,
                    "GIIN": "231342.09876.LE.223",
                    "Ch3Cd": "21",
                    "Ch4Cd": "23",
                    "FTIN": "123213",
                    "Country": "US"
                },
                "B16PayerDetails": {
                    "Name": "smith",
                    "TINType": "EIN",
                    "TIN": "567897654",
                    "GIIN": "123213.87354.LE.665",
                    "Ch3Cd": "20",
                    "Ch4Cd": "20"
                },
                "B17State": {
                    "StateCd": "WV",
                    "StateIdNum": "99999999",
                    "StateTaxWH": "10"
                },
                "UniqueId": "1113499067"

            }
        }
    ]
}

Create a Form 1042S return for the specific Business and include recipient and income information and create the new Recipient / Form Details without RecipientId and RecordId

{
    "SubmissionManifest": {
        "SubmissionId": "f12a60f7-8857-4843-9ab0-dc6cc6ea1ae8",
        "TaxYear": "2022",
        "IsFederalFiling": true,
        "IsPostal": true,
        "IsOnlineAccess": true,
        "IsScheduleFiling": false,
        "ScheduleFiling": null
    },
    "ReturnHeader": {
        "Business": {
            "BusinessId": null,
            "BusinessNm": "Snowdaze LLC",
            "FirstNm": null,
            "MiddleNm": null,
            "LastNm": null,
            "Suffix": null,
            "TradeNm": "Iceberg Icecreams",
            "IsEIN": true,
            "EINorSSN": "66-7908757",
            "Email": "james@sample.com",
            "ContactNm": "James",
            "Phone": "9934567890",
            "PhoneExtn": "12345",
            "Fax": "6934567890",
            "BusinessType": "ESTE",
            "SigningAuthority": {
                "Name": "James",
                "Phone": "9934567890",
                "BusinessMemberType": "ADMINISTRATOR"
            },
            "KindOfEmployer": "FederalGovt",
            "KindOfPayer": "REGULAR941",
            "IsBusinessTerminated": true,
            "Form1042SDetails": {
                "WHAgtCh3Cd": "11",
                "WHAgtCh4Cd": "16",
                "WHAgtGIIN": "123456.78901.LE.333",
                "FTIN": "12345",
                "Country": "AL"
            },
            "IsForeign": false,
            "USAddress": {
                "Address1": "15 Park Avenue",
                "Address2": "Louis St",
                "City": "Seattle",
                "State": "WA",
                "ZipCd": "98944"
            },
            "ForeignAddress": null
        }
    },
    "ReturnData": [
        {
            "RecordId": null,
            "SequenceId": "1",
            "IsOnlineAccess": true,
            "IsPostal": true,
            "Recipient": {
                "RecipientId": null,
                "TINType": "SSN",
                "TIN": "633091233",
                "FirstPayeeNm": null,
                "SecondPayeeNm": null,
                "FirstNm": "Nelson",
                "MiddleNm": "K",
                "LastNm": "Willsom",
                "Suffix": "VI",
                "Form1042SDetails": {
                    "RecCh3Cd": "08",
                    "RecCh4Cd": "10",
                    "RecGIIN": "456445.56789.LE.444",
                    "FTIN": "32032",
                    "LOB": "02",
                    "DOB": "12-12-2024",
                    "Country": "CT"
                },
                "IsForeign": false,
                "USAddress": {
                    "Address1": "1605 Kinsey Road",
                    "Address2": "Main St",
                    "City": "Dothan",
                    "State": "AL",
                    "ZipCd": "36303"
                },
                "ForeignAddress": null,
                "Email": "nelson@sample.com",
                "Fax": "9934567890",
                "Phone": "8834567890"
            },
            "Form1042SData": {
                "B1IncomeCd": "16",
                "B2GrossIncome": 1000,
                "B3IsChapter3": true,
                "Ch3Details": {
                    "B3aExemptionCd": "00",
                    "B3bTaxRate": "30"
                },
                "B3IsChapter4": false,
                "Ch4Details": {
                    "B4aExemptionCd": null,
                    "B4bTaxRate": null
                },
                "B5WHAllowance": 10,
                "B6NetIncome": 10,
                "B7aFedTaxWH": 100,
                "B7bIsFedWHNotDep": true,
                "B7cIsWHOccInSubYear": true,
                "B8TaxWHByOtherAgents": 10,
                "B9OverWHTaxRepaid": 10,
                "B10TotalWHCredit": 120,
                "B11TaxPaidByWHAgent": 120,
                "B13kRecipientAccNum": "32323213213",
                "B14PrimaryWHAgentDetails": {
                    "NameLine1": "Michalin",
                    "NameLine2": "C",
                    "EIN": "463456789"
                },
                "B15IsProRataReporting": true,
                "B15IntermediaryDetails": {
                    "NameLine1": "Nick",
                    "NameLine2": "T",
                    "NameLine3": "shawn",
                    "EIN": "534567890",
                    "IsForeign": false,
                    "USAddress": {
                        "Address1": "1751 Kinsey Rd",
                        "Address2": "Main St",
                        "City": "Dothan",
                        "State": "AL",
                        "ZipCd": "36303"
                    },
                    "ForeignAddress": null,
                    "GIIN": "231342.09876.LE.223",
                    "Ch3Cd": "21",
                    "Ch4Cd": "23",
                    "FTIN": "123213",
                    "Country": "US"
                },
                "B16PayerDetails": {
                    "Name": "smith",
                    "TINType": "EIN",
                    "TIN": "567897654",
                    "GIIN": "123213.87354.LE.665",
                    "Ch3Cd": "20",
                    "Ch4Cd": "20"
                },
                "B17State": {
                    "StateCd": "WV",
                    "StateIdNum": "99999999",
                    "StateTaxWH": "10"
                },
                "UniqueId": "1113499067"

            }
        }
    ]
}

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.
FormType	string	Denotes the type of 1042 form.
Form1042SRecords	object	Pulls Form 1042-S records with Success and Error statuses
SuccessRecords	object[]	It will show the detailed information about the success status of Form 1042-S 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 1042-S return is created.
RecipientId	Guid	A unique identifier generated by TaxBandits for a Recipient when a 1042-S 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 1042-S is filed. Size Range: 4..20 Note: If the account number on the return you file is the same as any previously filed return, TaxBandits will append 3 random numbers at the end of the account number.
UniqueId	string	Unique 1042-S form identifier number Size Range: ..10
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.
StateReturns	object[]	Returns collection of state returns information
StateCd	string	Returns the state code of the state for which the return is filed.
Status	string	Returns the record status of the state return.
StatusTs	string	Date and time of the return created.
Info	string	Returns the information about the state for which we are not supporting state filing.
Errors	object[]	Shows error information in state returns of Form 1042-S.
Id	string	Returns the validation error Id.
Name	string	Name of the validation error.
Message	string	Description of the validation error.
Postal	object	Returns the status and StatusTs of postal mailing service for Form 1042-S.
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 1042-S return.
Email	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 1042-S 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

Response JSON

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

{
    "StatusCode": 200,
    "StatusName": "Ok",
    "StatusMessage": "Successful API call",
    "SubmissionId": "f12a60f7-8857-4843-9ab0-dc6cc6ea1ae8",
    "BusinessId": "5f71019e-27d6-4f36-a116-5ae28361f537",
    "PayerRef": null,
    "FormType": "Form1042S",
    "Form1042SRecords": {
        "SuccessRecords": [
            {
                "SequenceId": "1",
                "RecordId": "85251276-9c42-4f9c-afaa-b81afd0f3738",
                "RecipientId": "94126fda-a688-4dac-a4aa-4dfd412795a5",
                "AccountNum": "32323213213",
                "UniqueId": "1113499067",
                "FederalReturn": {
                    "Status": "CREATED",
                    "StatusTs": "2024-06-05 06:38:58 -04:00",
                    "Info": null,
                    "Errors": null
                },
                "StateReturns": null,
                "Postal": {
                    "Status": "CREATED",
                    "StatusTs": "2024-06-05 06:38:58 -04:00",
                    "Info": null
                },
                "OnlineAccess": {
                    "Status": "CREATED",
                    "Email": "nelson@sample.com",
                    "Info": null
                },
                "ScheduleFiling": null
            }
        ],
        "ErrorRecords": null
    },
    "Errors": null
}

Multi-status Response - You'll get the below response when multiple statuses are included.

{
    "StatusCode": 300,
    "StatusName": "MultiStatus",
    "StatusMessage": "Multiple statuses are available for the request",
    "SubmissionId": "f12a60f7-8857-4843-9ab0-dc6cc6ea1ae8",
    "BusinessId": "5f71019e-27d6-4f36-a116-5ae28361f537",
    "PayerRef": null,
    "FormType": "Form1042S",
    "Form1042SRecords": {
        "SuccessRecords": [
            {
                "SequenceId": "1",
                "RecordId": "f5d950e3-a69a-4c33-b82a-80de7edcfa54",
                "RecipientId": "94126fda-a688-4dac-a4aa-4dfd412795a5",
                "AccountNum": "32323213213",
                "UniqueId": "1113499067",
                "FederalReturn": {
                    "Status": "CREATED",
                    "StatusTs": "2024-06-05 06:42:51 -04:00",
                    "Info": null,
                    "Errors": null
                },
                "StateReturns": null,
                "Postal": {
                    "Status": "CREATED",
                    "StatusTs": "2024-06-05 06:42:51 -04:00",
                    "Info": null
                },
                "OnlineAccess": {
                    "Status": "CREATED",
                    "Email": "nelson@sample.com",
                    "Info": null
                },
                "ScheduleFiling": null
            }
        ],
        "ErrorRecords": [
            {
                "SequenceId": "2",
                "RecordId": null,
                "Errors": [
                    {
                        "Id": "RECPT-0041",
                        "Name": "Recipient.USAddress.Address1[1]",
                        "Message": "Recipient Address1 is required"
                    }
                ]
            }
        ]
    },
    "Errors": [
        {
            "Id": "F00-100155",
            "Name": "Error Records",
            "Message": "Some of the records are errored. Please read the Error Records for more details."
        }
    ]
}

Bad Request Response - You'll get the below response when your API requests contain any validation errors.

{
    "StatusCode": 400,
    "StatusName": "BadRequest",
    "StatusMessage": "Validation error has occurred",
    "SubmissionId": "f12a60f7-8857-4843-9ab0-dc6cc6ea1ae8",
    "BusinessId": "5f71019e-27d6-4f36-a116-5ae28361f537",
    "PayerRef": null,
    "FormType": "Form1042S",
    "Form1042SRecords": {
        "SuccessRecords": null,
        "ErrorRecords": [
            {
                "SequenceId": "1",
                "RecordId": "f5d950e3-a69a-4c33-b82a-80de7edcfa54",
                "Errors": [
                    {
                        "Id": "F100-10109",
                        "Name": "Form1042SData.B3aExemptionCd",
                        "Message": "Box 3a, Exemption code should be 00 when Box 3b is greater than 0.00%"
                    }
                ]
            }
        ]
    },
    "Errors": null
}

W-9 Automation

BOIR Automation

TIN Matching

1099 Automation

941/940 Automation

W-2 Automation

ACA Automation

Supported Forms

Gig Software

Payroll Software

Affiliate Software

HOA Software

Reselling Platform

HCM Providers

Property Management

Supported Forms

Request Body

Request JSON

Response Body

Response JSON