Version: 1.7.3

Update

Use this endpoint to update the information on existing NC-3 forms that are already created for a specific payer.

Note:

You cannot update a return once it has been transmitted.

PUTStateFilings/G7WH/Update

Run in Postman

Request Body

Field	Type	Description
SubmissionId	Guid	Unique identifier created by TaxBandits for each submission. Not required when you are creating a return.
StateWHRecords	Object[]	Object to create Form G-7M and G-7Q
SequenceId	String	A unique number given by an inbound application to identify failed records. Size Range: ..10
ReturnHeader	Object	Identifies the supporting details of G-7M and G-7Q
Qtr	String	The quarter for which Form G-7 M or Form G-7Q needs to be filed. Allowed values "Q1", "Q2", "Q3","Q4"
TaxYr	String	The tax year for which Form G-7M and G-7Q need to be filed. Allowed values "2025"
BusinessId	Guid	Optional Use the unique Business ID (Generated by TaxBandits), you received in the response of the Business CREATE Endpoint. If you have 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.
Business	Object	The details of the business you’re filing for.
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"
PayerRef	string	Optional An unique identifier for each payer completing their information.This identifier can be used in future references of the payer in the API. * Size Range: ..50
TradeNm	String	Optional Name under which the business operates. Size Range: ..75
IsDefaultBusiness	Boolean
IsEIN	Boolean	When true, identifies the business with an EIN.
EINorSSN	String	When IsEIN is true, use Employer Identification Number (EIN). Size Range: 9-11
Email	String	Email address of the business. Size Range: ..100
ContactNm	string	Optional Name of the person who can be contacted by the State *Size Range: ..27
Phone	string	Contact number of the business with area code 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	Type of business. Size Range: ..4 Allowed values "ESTE", "PART", "CORP", "EORG", "SPRO"
SigningAuthority	object	Details of the person who is authorized to sign the return.
Name	string	Name of the signing authority. Size Range: ..35
Phone	string	Phone number of the signing authority. Size Range: 10
BusinessMemberType	string	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	Identifies the kind of employer. Allowed values "FEDERALGOVT", "STATEORLOCAL501C", "NONGOVT501C", "STATEORLOCALNON501C", "NONEAPPLY"
KindOfPayer	string	Identifies the kind of payer. Allowed values "REGULAR941", "REGULAR944", "AGRICULTURAL943", "HOUSEHOLD", "MILITARY", "MEDICAREQUALGOVEM", "RAILROADFORMCT1"
IsBusinessTerminated	Boolean	When true, identifies the business as terminated.
Form1042SDetails	object	Chapter 3 and chapter 4 status code details of the busienss. Mandatory for 1042-S and optional for 1099 and 94X series
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	Address of the Employer/Payer (street address or post office box of that locality) Size Range: ..46
Address2	string	Optional Suite or apartment number of the Employer/Payer. Size Range: ..46
City	string	City where the Employer/Payer is based out of Size Range: ..50
State	string	Name of the state where the Employer/Payer is based out of 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	Zip Code the State where the Employer/Payer is based out of. Size Range: 5..10
ForeignAddress	object	if IsForeign is true, pass foreign address of the business.
Address1	string	Address of the Employer/Payer (street address or post office box of that locality) Size Range: ..50
Address2	string	Optional Suite or apartment number of the Employer/Payer. Size Range: ..50
City	string	City where the Employer/Payer is based out of Size Range: ..50
ProvinceOrStateNm	string	Name of the province or state where the Employer/Payer is based out of. Size Range: ..50
Country	string	Country of the Employer/Payer. 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	Postal Code the State where the Employer/Payer is based out of Size Range: ..16
ACADetails	object	Contains specific field information for ACA forms
FirstName	string	First Name of the contact person. Size Range: 50
MiddleName	string	Optional Middle initials of the contact person. Size Range: 15
LastName	string	Last name of the contact person. Size Range: 50
Suffix	string	Optional Name suffix of the contact person. Refer static values. Size Range: 3 Allowed values "JR", "SR", "II", "III", "IV", "V", "VI", "VII"
Phone	string	Phone number of the government entity's contact person. Size Range: 10
IsGovernmentalUnit	boolean	When true, identifies that the business is a part of or related to the Governmental Unit
ReturnData	Object	Identifies the Form G7M data
FormG7M	object	Information of Form G7-M, Quarterly Return for Monthly Payer Worksheet
DepositSchedule	string	Deposit Schedule of the Payer Allowed values :"SEMI_WEEKLY","MONTHLY"
WHIdNum	String	Georgia withholding ID number. Size Range: ..9
Month1Tax	Object	Object to identify month 1 tax details
TaxWH	Number	Total Georgia income tax withheld for the month 1 Size Range: 0-99999999.99
WHAdjustments	Object	Gets Withholding Tax Adjustments details
AddlnTax	Number	Additional Tax Adjustment for Month 1 Size Range: 0-99999999.99
OverPayment	Number	Overpayment Adjustment for Month 1 Size Range: 0-99999999.99
CreditCode1	String	Variable Best Credit One for Month 1 Allowed values :"ADDTAXCRD", "CLNNRGCRD","ENTPR1CRD", "ENTPR2CRD", "FACJOBCRD", " FACPRPCRD", "FLMTAXCRD","HDQTRSCRD", "JOBTAXCRD", "OVRPYMCRD","QLJOBSCRD", "RSCHTXCRD"
CreditAmt1	Number	Variable Best Credit One Amount for Month 1 Size Range: 0-99999999.99
CreditCode2	String	Variable Best Credit Two for Month 1 Allowed values :"ADDTAXCRD", "CLNNRGCRD","ENTPR1CRD", "ENTPR2CRD", "FACJOBCRD", " FACPRPCRD", "FLMTAXCRD","HDQTRSCRD", "JOBTAXCRD", "OVRPYMCRD","QLJOBSCRD", "RSCHTXCRD"
CreditAmt2	Number	Variable Best Credit Two Amount for Month 1 Size Range: 0-99999999.99
TaxAdj	Number	Total Tax Adjustments for Month 1 Size Range: 0-99999999.99
TaxDue	Number	Total Tax Due for Month 1 Size Range: 0-99999999.99
TaxPaid	Number	Total Tax Paid for Month 1 Size Range: 0-99999999.99
Month2Tax	Object	Object to identify month 2 tax details
TaxWH	Number	Total Georgia income tax withheld for the month 2 Size Range: 0-99999999.99
WHAdjustments	Object	Gets Withholding Tax Adjustments details
AddlnTax	Number	Additional Tax Adjustment for Month 2 Size Range: 0-99999999.99
OverPayment	Number	Overpayment Adjustment for Month 2 Size Range: 0-99999999.99
CreditCode2	String	Variable Best Credit One for Month 2 Allowed values :"ADDTAXCRD", "CLNNRGCRD","ENTPR1CRD", "ENTPR2CRD", "FACJOBCRD", " FACPRPCRD", "FLMTAXCRD","HDQTRSCRD", "JOBTAXCRD", "OVRPYMCRD","QLJOBSCRD", "RSCHTXCRD"
CreditAmt1	Number	Variable Best Credit One Amount for Month 2 Size Range: 0-99999999.99
CreditCode2	String	Variable Best Credit Two for Month 2 Allowed values :"ADDTAXCRD", "CLNNRGCRD","ENTPR1CRD", "ENTPR2CRD", "FACJOBCRD", " FACPRPCRD", "FLMTAXCRD","HDQTRSCRD", "JOBTAXCRD", "OVRPYMCRD","QLJOBSCRD", "RSCHTXCRD"
CreditAmt2	Number	Variable Best Credit Two Amount for Month 2 Size Range: 0-99999999.99
TaxAdj	Number	Total Tax Adjustments for Month 2 Size Range: 0-99999999.99
TaxDue	Number	Total Tax Due for Month 2 Size Range: 0-99999999.99
TaxPaid	Number	Total Tax Paid for Month 2 Size Range: 0-99999999.99
Month3Tax	Object	Object to identify month 3 tax details
TaxWH	Number	Total Georgia income tax withheld for the month 3 Size Range: 0-99999999.99
WHAdjustments	Object	Gets Withholding Tax Adjustments details
AddlnTax	Number	Additional Tax Adjustment for Month 3 Size Range: 0-99999999.99
OverPayment	Number	Overpayment Adjustment for Month 3 Size Range: 0-99999999.99
CreditCode1	String	Variable Best Credit One for Month 3 Allowed values :"ADDTAXCRD", "CLNNRGCRD","ENTPR1CRD", "ENTPR2CRD", "FACJOBCRD", " FACPRPCRD", "FLMTAXCRD","HDQTRSCRD", "JOBTAXCRD", "OVRPYMCRD","QLJOBSCRD", "RSCHTXCRD"
CreditAmt1	Number	Variable Best Credit One Amount for Month 3 Size Range: 0-99999999.99
CreditCode2	String	Variable Best Credit Two for Month 3 Allowed values :"ADDTAXCRD", "CLNNRGCRD","ENTPR1CRD", "ENTPR2CRD", "FACJOBCRD", " FACPRPCRD", "FLMTAXCRD","HDQTRSCRD", "JOBTAXCRD", "OVRPYMCRD","QLJOBSCRD", "RSCHTXCRD"
CreditAmt2	Number	Variable Best Credit Two Amount for Month 3 Size Range: 0-99999999.99
TaxAdj	Number	Total Tax Adjustments for Month 3 Size Range: 0-99999999.99
TaxDue	Number	Total Tax Due for Month 3 Size Range: 0-99999999.99
TaxPaid	Number	Total Tax Paid for Month 3 Size Range: 0-99999999.99
SemiWeeklyDepositor	Object	Object to identify the semi weekly deposit schedule details
Month1TaxLiab	Object []	Object to identify the tax liability details for the first month of the quarter
Day	String	Tax Liability pay day of first month of the quarter. Allowed values "1", "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"
Amt	Number	Tax liability amount of the pay day. Size Range: 0-99999999.99
Month1TotTaxLiab	Number	Total tax required to be withheld for first month of quarter Size Range: 0-99999999.99
Month2TaxLiab	Object []	Object to identify the tax liability details for the second month of the quarter
Day	String	Tax Liability pay day of second month of the quarter. Allowed values "1", "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"
Amt	Number	Tax liability amount of the pay day. Size Range: 0-99999999.99
Month2TotTaxLiab	Number	Total tax required to be withheld for second month of quarter Size Range: 0-99999999.99
Month3TaxLiab	Object []	Object to identify the tax liability details for the second month of the quarter
Day	String	Tax Liability pay day of second month of the quarter. Allowed values "1", "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"
Amt	Number	Tax liability amount of the pay day Size Range: 0-99999999.99
Month3TotTaxLiab	Number	Total tax required to be withheld for second month of quarter Size Range: 0-99999999.99
TotQtrTaxLiabAmt	Number	Total tax required to be withheld for all the months of the quarter Size Range: 0-99999999.99
QuarterlyTot	Number	Total withheld of the quarter Size Range: 0-99999999.99
TotQtrTaxDue	Number	Total tax due for the quarter Size Range: 0-99999999.99
TotQtrTaxPaid	Number	Total tax paid for the quarter Size Range: 0-99999999.99
AdjDesc	string	Explanation for the adjustments given quarter Size Range:..115
FormG7Q	object	Information of Form G7-Q, Quarterly Return for Quarterly Payer Worksheet
WHIdNum	String	Georgia withholding ID number. Size Range: ..9
TaxWH	Number	Total Georgia income tax withheld for the quarter Size Range: 0-99999999.99
TaxAdj	Number	Total Tax Adjustments for the quarter Size Range: 0-99999999.99
TaxDue	Number	Total Tax Due for the quarter Size Range: 0-99999999.99
TaxPaid	Number	Total Tax Paid for the quarter Size Range: 0-99999999.99
AdjDesc	string	Explanation for the adjustments given quarter Size Range:..99

Response Body

Field	Type	Description
SubmissionId	Guid	Unique identifier of a submission
SuccessRecords	object[]	It will show the detailed information about the success status of Form G-7M/G-7Q Records
SequenceId	string	Returns the unique reference ID for the submission that can be used toidentify a particular record
BusinessId	Guid	Unique identifier of a Business
PayerRef	string	Unique identifier of the payer
RecordId	Guid	An unique identifier generated by TaxBandits when a G-7M/G-7Q return iscreated
FormType	string	Denotes the type of withholding form (Form G-7M / Form G-7Q).
Status	string	Returns the record status of return.
StatusTs	string	Date and time of the return created.
Info	string	Returns the information about the return
Errors	object[]	Shows error information of state returns of Form G-7M/G-7Q
Id	string	Returns the validation error Id.
Name	string	Name of the validation error.
Message	string	Description of the validation error.
ErrorRecords	object[]	It will show the detailed information about the error status of Form G-7M or Form G-7Q Records.
SequenceId	string	An unique reference ID for the submission that can be used to identify aparticular record. The Sequence ID will be returned in the Response foryour reference.
RecordId	Guid	Unique identifier of a record
Errors	object[]	Shows detailed error information
Id	string	Returns the validation error Id
Name	string	Name of the validation error
Message	string	Description of the validation error
Errors	object[]	Shows detailed error information.
Id	string	Returns the validation error Id.
Name	string	Name of the validation error.
Message	string	Description of the validation error.

Request JSON

Sample 1

Update return for the first three quarters of the tax year

{
  "SubmissionId": "019c74e6-d423-756b-a7ad-bc05010f8146",
  "StateWHRecords": [
      {
          "Sequence": "001",
          "ReturnHeader": {
              "Qtr": "Q4",
              "TaxYr": "2025",
              "Business": {
                  "BusinessId": "b4246c90-4f0d-4f15-9d8c-de738af3f9c6",
                  "BusinessNm": "Snowdaze LLC",
                  "PayerRef": "snowdaze1123",
                  "FirstNm": null,
                  "MiddleNm": null,
                  "LastNm": null,
                  "Suffix": null,
                  "TradeNm": "Iceberg Icecreams",
                  "IsEIN": true,
                  "EINorSSN": "23-2349119",
                  "Email": "james@sample.com",
                  "ContactNm": "James Smith",
                  "Phone": "(653) 456-7890",
                  "PhoneExtn": "123",
                  "Fax": "(983) 456-7890",
                  "BusinessType": "ESTE",
                  "SigningAuthority": {
                      "Name": "James Smith",
                      "Phone": "(993) 456-7890",
                      "BusinessMemberType": "ADMINISTRATOR"
                  },
                  "KindOfEmployer": "FEDERALGOVT",
                  "KindOfPayer": "REGULAR941",
                  "IsBusinessTerminated": false,
                  "IsForeign": false,
                  "USAddress": {
                      "Address1": "3576 AIRPORT WAY",
                      "Address2": "UNIT 9",
                      "City": "FAIRBANKS",
                      "State": "AK",
                      "ZipCd": "99709"
                  },
                  "ForeignAddress": null,
                  "ACADetails": null
              }
          },
          "ReturnData": {
              "RecordId": "019c74e6-d6e2-70cf-a02e-1afff7b0612b",
              "FormG7Q": {
                  "WHIdNum": "1232321-AB",
                "TaxWH": 1000,
                  "TaxAdj": 600,
                  "TaxDue": 1600,
                  "TaxPaid": 900,
                  "AdjDesc": "Due to tax"
              },
              "FormG7M": null
          }
      }
  ]
}

Response JSON

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

{
  "StatusCode": "200",
  "StatusName": "Ok",
  "StatusMessage": "Successful API call",
  "SubmissionId": "0199e6d1-cea0-706d-8926-d7dad88478d3",
  "SuccessRecords": [
      {
          "SequenceId": "001",
          "BusinessId": "f88857c3-da9f-4655-976e-914124e53089",
          "PayerRef": null,
          "RecordId": "f88857c3-da9f-4655-976e-914124e53089",
          "FormType": "NC3",
          "Status": "UPDATED",
          "StatusTs": "2026-02-18 23:52:39 -05:00",
          "Info": null,
          "Errors": 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": "019c74e6-d423-756b-a7ad-bc05010f8146",
  "SuccessRecords": [
      {
          "SequenceId": "001",
          "BusinessId": "b4246c90-4f0d-4f15-9d8c-de738af3f9c6",
          "PayerRef": null,
          "RecordId": "019c74e6-d6e2-70cf-a02e-1afff7b0612b",
          "FormType": "G7M",
          "Status": "UPDATED",
          "StatusTs": "2026-02-19 02:56:51 -05:00",
          "Info": null,
          "Errors": null
      }
  ],
  "ErrorRecords": [
      {
          "SequenceId": "002",
          "RecordId": null,
          "Errors": [
              {
                  "Id": "S00-000190",
                  "Name": "Quarter",
                  "Message": "Return already exists for a given quarter and tax year."
              }
          ]
      }
  ],
  "Errors": [
      {
          "Id": "S00-000184",
          "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": null,
  "SuccessRecords": null,
  "ErrorRecords": [
      {
          "SequenceId": "001",
          "RecordId": null,
          "Errors": [
              {
                  "Id": "S00-000190",
                  "Name": "Quarter",
                  "Message": "Return already exists for a given quarter and tax year."
              }
          ]
      }
  ],
  "Errors": null
}

Unauthorized Response - You'll get the below response when your API requests don't contain valid authentication credentials.

{
  "StatusCode": 401,
  "StatusName": "Unauthorized",
  "StatusMessage": "Invalid authorization credentials",
  "Errors": [
      {
          "Id": "AUTH-100018",
          "Name": "Authorization",
          "Message": "JWT EXPIRED"
      }
  ]
}

W-9/W-8 Automation

1099 Automation

TIN Matching

W-2 Automation

941/940 Automation

1098-T Automation

ACA Automation

Extension Automation

Gig Software

Payroll Software

Affiliate Software

HOA Software

Reselling Platform

HCM Providers

Property Management

Supported Forms

Update

Update

Request Body

Response Body

Request JSON​

Response JSON​

Request JSON

Response JSON