Get

Gets information of 945 returns by Submission Id.

GET Form945/Get 

Request Params

Field	Type	Description
SubmissionId	Guid	Unique identifier of a submission

Request Params

"Form945/Get?submissionId=f2fee2f8-74bf-4e1d-9239-399e76929475"

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
Form945Records	object[]	Employer's Form 945 information.
RecordId	Guid	Unique identifier of a record
ReturnHeader	object	Identifies the supporting details of Form 945
ReturnType	string	Type of the return to be filed.
TaxYr	string	Tax year for which Form 945 needs to be filed.
Business	object	Business Details
BusinessNm	string	Name of the business
TradeNm	string	Optional Name under which the business operates
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).
Email	string	Email address of the Business
ContactNm	string	Name of the person who can be contacted by the IRS
Phone	string	Contact number of the business with area code
PhoneExtn	string	Optional Extension of the business phone number
Fax	string	Optional Fax number of the Business
BusinessType	string	Type of business. Optional for W-2/1099 and mandatory for 94X series.
SigningAuthority	object	Details of the person who is authorized to sign the return.
Name	string	Name of the signing authority.
Phone	string	Phone number of the signing authority.
BusinessMemberType	string	Business title of the signing authority.
KindOfEmployer	string	Identifies the kind of employer. Mandatory for W-2 and optional for 1099-MISC and 94X series.
KindOfPayer	string	Identifies the kind of payer. This field is mandatory in W-2 and optional in 1099-MISC and 94X series.
IsBusinessTerminated	Boolean	When true, identifies the business as terminated.
IsForeign	Boolean	When true, identifies the business address with a foreign address.
USAddress	object	If IsForeign is false, pass US address of the business
Address1	string	Employer/Payer's US address (street address or post office box of that locality)
Address2	string	Optional Employer/Payer's suite or apartment
City	string	Employer/Payer's city
State	string	State code of the employer/payer. Refer Static values.
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)
Address2	string	Optional Employer/Payer's suite or apartment.
City	string	Employer/Payer's city.
ProvinceOrStateNm	string	Employer/Payer's province or state name.
Country	string	Employer/Payer country code. Refer Static values.
PostalCd	string	Employer/Payer's postal code
IsThirdPartyDesignee	Boolean	When true, your third-party designee is allowed to discuss the return with the IRS
ThirdPartyDesignee	object	Third Party Designee Details
Name	string	Third Party Designee's name.
Phone	string	Third Party Designee's phone number.
PIN	string	A 5 digit PIN (Should not contain all zeroes) used when communicating to the IRS.
SignatureDetails	object	Identifies the signature type used in Form 945
SignatureType	string	Type of signature used to sign Form 945
OnlineSignaturePIN	object	A 10-digit signature PIN to become an IRS authorized signer.
PIN	string	Sign using a 10 digit PIN received from the IRS.
ReportingAgentPIN	object	A 5-digit number assigned by the IRS
PIN	string	Sign using a 5 digit PIN received from the IRS.
Form8453EMP	object	An alternate option to sign the return using Form 8453 EMP when there is no PIN.
AttachmentNm	string	Name of the Form 8453EMP attachment
Attachment	byte[]	Byte array of Form-8453 pdf.
AttachmentFileType	string	Type of the file Attachment
SignedDate	DateTime	Date and time on which the Form 8453-EMP was signed
BusinessStatusDetails	object	Identifies the status of the Business
IsBusinessClosed	Boolean	When true, identifies the business as terminated or stopped paying wages
BusinessClosedDetails	object	Identifies the Record Keeper details and date on which the Business was closed
Name	string	Name of the Record Keeper
FinalDateWagesPaid	DateTime	Final date on which the business last paid the wages
IsForeign	Boolean	When true, identifies if the business has 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	State code of the employer/payer. 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 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	Employer/Payer's postal code. Size Range: ..16
ReturnData	object	Identifies the Form 945 data
Form945	object	Form 945, Employer's Federal Tax Return
IsAddDiffFromPriorYear	Boolean	When true, identifies that the business address is different from prior year.
FedIncomeTaxWHAmt	number	Enter the total federal income tax withheld from pensions, annuities, IRAs, gambling winnings, etc. Size Range: 0-99999999999999.99
BackUpWHAmt	number	Enter the total backup withholding amount Size Range: 0-99999999999999.99
TotTax	number	Gets the total taxes withheld amount Size Range: 0-99999999999999.99
TotTaxDepositAmt	number	Gets the Total deposits for tax year, including overpayment applied from a prior year and overpayment applied from Form 945-X. Size Range: 0-99999999999999.99
BalanceDueAmt	number	Gets the difference amount of the balance due if line 3 is more than line 4. Size Range: 0-99999999999999.99
OverpaidAmt	number	Gets the difference overpayment amount if line 4 is more than line 3. Size Range: 0-99999999999999.99
OverPaymentRecoveryType	string	Gets the overpayment recovery type, whether to have the IRS refund the excess amount or apply it to next return. Check only one box on line 6. Allowed values "REFUND", "APPLYTORETURN"
IRSPaymentType	string	EFW, EFTPS, Check or Money Order Allowed values "EFW", "EFTPS", "CHECK_OR_MO"
IRSPayment	object	Identifies the details of Electronic Funds Withdrawal (EFW) if paying the balance due along with the return
BankRoutingNum	string	Bank Routing Number of EFW payment Size Range: 9
AccountType	string	Account Type of EFW payment Allowed values "CHECKING", "SAVING"
BankAccountNum	string	Bank Account Number of EFW payment Size Range: ..17
Phone	string	Phone of EFW payment Size Range: 10
DepositScheduleType	object	Identifies the Employer's deposit schedule and tax liability for the quarter
DepositorType	string	Type of Deposit Schedule. Values like Monthly or Semi Weekly Allowed values "MINTAXLIABILITY", "MONTHLY", "SEMIWEEKLY"
MonthlyDepositor	object	Line 7 Monthly Schedule Depositor details.
JanTaxLiability	number	Tax Liability for January. Size Range:0-99999999999999.99
FebTaxLiability	number	Tax Liability for Febraury. Size Range:0-99999999999999.99
MarTaxLiability	number	Tax Liability for March. Size Range:0-99999999999999.99
AprTaxLiability	number	Tax Liability for April. Size Range:0-99999999999999.99
MayTaxLiability	number	Tax Liability for May. Size Range:0-99999999999999.99
JunTaxLiability	number	Tax Liability for June. Size Range:0-99999999999999.99
JulTaxLiability	number	Tax Liability for July. Size Range:0-99999999999999.99
AugTaxLiability	number	Tax Liability for August. Size Range:0-99999999999999.99
SepTaxLiability	number	Tax Liability for September. Size Range:0-99999999999999.99
OctTaxLiability	number	Tax Liability for October. Size Range:0-99999999999999.99
NovTaxLiability	number	Tax Liability for November. Size Range:0-99999999999999.99
DecTaxLiability	number	Tax Liability for December. Size Range:0-99999999999999.99
SemiWeeklyDepositor	object	SemiWeekly Depositor details.
Form945AJanMonthAmt	object[]	Tax Liability for January in Form 945 A.
Day	string	Tax Liability Day of Jan month. 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 Jan month. Size Range: 0-99999999999999.99
Form945AJanMonthTotAmt	number	Total Tax Liability for January in Form 945 A. Size Range: 0-99999999999999.99
Form945AFebMonthAmt	object[]	Tax Liability for February in Form 945 A.
Day	string	Tax Liability Day of Feb month. 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 Feb month. Size Range: 0-99999999999999.99
Form945AFebMonthTotAmt	number	Total Tax Liability for February in Form 945 A. Size Range: 0-99999999999999.99
Form945AMarMonthAmt	object[]	Tax Liability for March in Form 945 A.
Day	string	Tax Liability Day of Mar month. 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 Mar month. Size Range: 0-99999999999999.99
Form945AJMarMonthTotAmt	number	Total Tax Liability for March in Form 945 A. Size Range: 0-99999999999999.99
Form945AAprMonthAmt	object[]	Tax Liability for April in Form 945 A.
Day	string	Tax Liability Day of Apr month. 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 Apr month. Size Range: 0-99999999999999.99
Form945AAprMonthTotAmt	number	Total Tax Liability for April in Form 945 A. Size Range: 0-99999999999999.99
Form945AMayMonthAmt	object[]	Tax Liability for May in Form 945 A.
Day	string	Tax Liability Day of May month. 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 May month. Size Range: 0-99999999999999.99
Form945AMayMonthTotAmt	number	Total Tax Liability for May in Form 945 A. Size Range: 0-99999999999999.99
Form945AJunMonthAmt	object[]	Tax Liability for June in Form 945 A.
Day	string	Tax Liability Day of Jun month. 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 Jun month. Size Range: 0-99999999999999.99
Form945AJunMonthTotAmt	number	Total Tax Liability for June in Form 945 A. Size Range: 0-99999999999999.99
Form945AJulMonthAmt	object[]	Tax Liability for July in Form 945 A.
Day	string	Tax Liability Day of Jul month. 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 Jul month. Size Range: 0-99999999999999.99
Form945AJulMonthTotAmt	number	Total Tax Liability for July in Form 945 A. Size Range: 0-99999999999999.99
Form945AAugMonthAmt	object[]	Tax Liability for August in Form 945 A.
Day	string	Tax Liability Day of Aug month. 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 Aug month. Size Range: 0-99999999999999.99
Form945AAugMonthTotAmt	number	Total Tax Liability for August in Form 945 A. Size Range: 0-99999999999999.99
Form945ASepMonthAmt	object[]	Tax Liability for September in Form 945 A.
Day	string	Tax Liability Day of Sep month. 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 Day of Sep month. Size Range: 0-99999999999999.99
Form945ASepMonthTotAmt	number	Total Tax Liability for September in Form 945 A. Size Range: 0-99999999999999.99
Form945AOctMonthAmt	object[]	Tax Liability for October in Form 945 A.
Day	string	Tax Liability Day of Oct month. 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 Oct month. Size Range: 0-99999999999999.99
Form945AOctMonthTotAmt	number	Total Tax Liability for October in Form 945 A. Size Range: 0-99999999999999.99
Form945ANovMonthAmt	object[]	Tax Liability for November in Form 945 A.
Day	string	Tax Liability Day of Nov month. 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 Nov month. Size Range: 0-99999999999999.99
Form945ANovMonthTotAmt	number	Total Tax Liability for November in Form 945 A. Size Range: 0-99999999999999.99
Form945ADecMonthAmt	object[]	Tax Liability for December in Form 945 A.
Day	string	Tax Liability Day of Dec month. 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 Dec month. Size Range: 0-99999999999999.99
Form945ADecMonthTotAmt	number	Total Tax Liability for December in Form 945 A. Size Range: 0-99999999999999.99
TotalTaxLiabilityWholeYearAmt	number	Total tax liability amount Size Range: 0-99999999999999.99

Response JSON

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

{
    "StatusCode": 200,
    "StatusName": "Ok",
    "StatusMessage": "Successful API call",
    "SubmissionId": "2f430962-2278-4a3c-8310-02298004a375",
    "Form945Records": [
        {
            "RecordId": "ba073cc7-ca7e-4518-a932-16a06d89450b",
            "ReturnHeader": {
                "ReturnType": "Form945",
                "TaxYr": "2022",
                "Business": {
                    "BusinessId": "2846e02d-dceb-4dd2-9039-a53a8bd2ee35",
                    "BusinessNm": "Snowdaze LLC",
                    "TradeNm": null,
                    "IsEIN": true,
                    "EINorSSN": "123456789",
                    "Email": "sample@bodeem.com",
                    "ContactNm": "Rhonda Charles",
                    "Phone": "1234567890",
                    "PhoneExtn": null,
                    "Fax": "(123) 456-7890",
                    "BusinessType": "CORP",
                    "SigningAuthority": {
                        "Name": "Rhonda Charles",
                        "Phone": "1234567890",
                        "BusinessMemberType": "PRESIDENT"
                    },
                    "KindOfEmployer": null,
                    "KindOfPayer": null,
                    "IsBusinessTerminated": false,
                    "IsForeign": false,
                    "USAddress": {
                        "Address1": "123 Kinsley Rd",
                        "Address2": "Main St",
                        "City": "Seattle",
                        "State": "WA",
                        "ZipCd": "98944"
                    },
                    "ForeignAddress": {
                        "Address1": null,
                        "Address2": null,
                        "City": null,
                        "ProvinceOrStateNm": null,
                        "Country": null,
                        "PostalCd": null
                    }
                },
                "IsThirdPartyDesignee": false,
                "ThirdPartyDesignee": null,
                "SignatureDetails": {
                    "SignatureType": "ONLINE_SIGN_PIN",
                    "OnlineSignaturePIN": {
                        "PIN": "1234567899"
                    },
                    "ReportingAgentPIN": null,
                    "Form8453EMP": null
                },
                "BusinessStatusDetails": {
                    "IsBusinessClosed": false,
                    "BusinessClosedDetails": null,
                }
            },
            "ReturnData": {
                "Form945": {
                    "FedIncomeTaxWHAmt": 1000,
                    "BackUpWHAmt": 1000,
                    "TotTax": 2000,
                    "TotTaxDepositAmt": 400,
                    "BalanceDueAmt": 100.00,
                    "OverpaidAmt": 18000.00,
                    "OverPaymentRecoveryType": "REFUND"
                },
                "IRSPaymentType": null,
                "IRSPayment": null,
                "FinalPayRoll": null,
                "DepositScheduleType": {
                    "DepositorType": "MINTAXLIABILITY",
                    "MonthlyDepositor": null,
                    "SemiWeeklyDepositor": null,
                    "TotalTaxLiabilityWholeYearAmt": 3000.00
                }
            },
            "ReturnNumber": "6U000582013126-4"
        }
    ],
    "Errors": null
}