List

Lists all Form 1098 correction returns created and transmitted on the account for a particular Submission or Payer. Form 1098 correction returns will be listed based on the filters sent in the Request.

GET Form1098Correction/List   

Request Params

Field	Type	Description
SubmissionId	Guid	This is a Unique Identifier of a Submission. Use this node, if you want to list the 1098 correction records created under a Submission. Ignore this node, if you want to list the records of a particular Payer.
BusinessId	Guid	This is a Unique Identifier of a Payer. Use this node, if you want to list all the 1098 correction records created under the Payer. Ignore this node, if you want to list the records for a Submission.
TINType	string	Mention TIN type and TIN, if you do not have Business ID and want to list all the 1098 correction records created under a Payer. Allowed Values: EIN, SSN
TIN	string	Employer Identification Number or Social Security Number of the Payer is required only when you have not provided the SubmissionId or the BusinessId
TaxYear	string	Enter the specific tax year for the list of 1098 correction Records. If the tax year is not given, all tax year records will be listed.
Page	number	Mention the page number that needs to be listed in the Response. If the value is not given, the page will be defaulted to 1.
PageSize	number	Provide a numerical value to list the total number of Form 1098 correction records in each page. If the value is not given, then the page size will be defaulted to 100. Note: PageSize can be maximum of 100.
EfileStatus	string	Mention Form 1098 correction record status that needs to be listed. If the value is not given, then records with all the statuses will be listed.
FromDate	string	Enter a date from which the Form 1098 correction records need to be listed in MM/DD/YYYY format.
ToDate	string	Enter a date till which the 1098 correction records created are to be listed in MM/DD/YYYY format.

Request Params

"Form1098Correction/List?SubmissionId=9b93d963-7ab8-4967-b766-997fa5d63c20&BusinessId=52fee3c3-3ddf-4b96-814f-2b6e94799483&TINType=EIN&TIN=65-7369200&TaxYear=2023&Page=1&PageSize=10&EfileStatus=Created&FromDate=12-12-2024&ToDate=12-20-2024"

Response Body

Field	Type	Description
StatusCode	number	Returns the HTTP status codes like 200,300 etc.
StatusName	string	Submission Status
StatusMessage	string	Status Details
Form1098Type	string	Denotes the type of 1098 form.
Form1098Records	object[]	It contains the list of 1098 records.
SubmissionId	Guid	Unique Identifier of a Submission
BusinessId	Guid	Unique Identifier of a Payer
BusinessNm	string	Payer's Name
FirstNm	string	First Name of the Individual
MiddleNm	string	Middle Name of the Individual
LastNm	string	Last Name of the Individual
0Suffix	string	Suffix of the Individual
ContactNm	string	Contact Name of the Payer.
TaxYear	string	Tax year of the 1098 correction records.
Recipient	object	Recipient Details
SequenceId	string	Sequence ID of the 1098 correction record provided during CREATE or UPDATE
RecordId	Guid	Unique identifier of the 1098 correction record.
RecipientId	Guid	Unique identifier of the Recipient.
RecipientNm	Boolean	Recipient's Name
FirstNm	string	First Name of the Individual
MiddleNm	string	Middle Name of the Individual
LastNm	string	Last Name of the Individual
Suffix	string	Suffix of the Individual
TIN	string	Recipient's TIN
Status	string	Record Status of Form 1098 correction.
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.
Errors	object[]	Shows error information of state returns of Form 1098 correction
Postal	object	Returns the status and StatusTs of postal mailing service for Form 1098 correction.
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 1098 correction return.
Email	string	Email address for whom the online access to be given.
Info	string	Information about the online access service.
TotalRecords	number	Total records.
TotalPages	number	Total pages.
Page	number	List of records mentioned in the Request
PageSize	number	Total 1098 correction records in the page
Errors	object[]	Show Error Details
Id	string	Returns the validation error id
Name	string	Name of the validation error
Message	string	Validation error details

Response JSON

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

{
    "StatusCode": 200,
    "StatusName": "Ok",
    "StatusMessage": "Successful API call",
    "Form1098Type": "1098CORRECTION",
    "Form1098Records": [
        {
            "SubmissionId": "9b93d963-7ab8-4967-b766-997fa5d63c20",
            "BusinessId": "52fee3c3-3ddf-4b96-814f-2b6e94799483",
            "PayerRef": "Snow123",
            "BusinessNm": "Snowdaze LLC",
            "IsEIN": true,
            "FirstNm": null,
            "LastNm": null,
            "MiddleNm": null,
            "Suffix": null,
            "EINorSSN": "65-7369200",
            "ContactNm": null,
            "TaxYear": "2024",
            "Recipient": {
                "SequenceId": "72305",
                "RecordId": "9ecfd957-cd3b-44a2-a08a-326f36c07bef",
                "RecipientId": "c317648a-f591-4572-ad1c-66ed8e8e9675",
                "RecipientNm": "Dairy Delights LLC Coco Milk",
                "FirstNm": null,
                "LastNm": null,
                "MiddleNm": null,
                "Suffix": null,
                "TINType": "EIN",
                "TIN": "36-3814509",
                "Status": "CREATED",
                "FederalReturn": {
                    "Status": "CREATED",
                    "StatusTs": "2024-12-20 00:30:37 -05:00",
                    "Info": null,
                    "Errors": null
                },
                "Postal": {
                    "Status": "CREATED",
                    "StatusTs": "2024-12-20 00:30:37 -05:00",
                    "Info": null
                },
                "OnlineAccess": {
                    "Status": "NA",
                    "Email": null,
                    "Info": "This Service will be available soon"
                }
            }
        }
    ],
    "Page": 1,
    "TotalRecords": 1,
    "TotalPages": 1,
    "PageSize": 10,
    "Errors": null
}