Get
This method will return the completed transactions of a particular submission or Payer.
The response will have the information such as the Transaction details, PayerRef, Recipient Information, etc.
Key Points:
- If you want to get the details of a particular Submission, provide the SubmissionId in the Get method. Response will provide the entire transaction based on the particular submission.
- Provide parameters other than SubmissionId to get a list of transactions for a specific Payer or Payer/Recipient combination.
GET Form1099Transactions
Request Body
| Field | Type | Description |
|---|---|---|
| SubmissionId | Guid | Unique identifier of a submission. |
| BusinessId | Guid | Unique identifier of a business. |
| PayerRef | String | Unique identifier of a business. Set by the client. |
| RecipientId | Guid | Unique identifier of a recipient. |
| PayeeRef | String | Unique identifier of a recipient. Set by the client. |
| TaxYear | String | Taxyear for which you want the transactions to be listed. In the format yyyy. |
| Page | Int | Page number that needs to be listed in the Response. If the value is not given, then the page will be defaulted to 1. |
| TxnFromDate | String | Lists the transaction records between the date range. |
| TxnToDate | String | Lists the transaction records between the date range. |
Response Body
| Field | Type | Description |
|---|---|---|
| Form1099TxnDetails | Object[] | Transaction Details. |
| SubmissionId | Guid | Unique identifier of a submission. |
| TxnData | object[] | Collection of all the transactions from payers to recipients. |
| Business | object | Payer Information. |
| PayerRef | String | Unique identifier of the payer. Set by the client. |
| BusinessId | Guid | TaxBandits Unique Business Identifier. |
| TINType | String | TIN Type of the business. Allowed values: "SSN", "EIN" |
| TIN | String | Taxpayer Identification Number. Size Range: 9-11 |
| Recipients | object[] | Recipient Information. |
| PayeeRef | String | Unique identifier of the recipient. Set by the client. |
| RecipientId | Guid | Unique identifier of the recipient. |
| TINType | String | TIN Type of the recipient. Allowed values: "SSN", "EIN" |
| TIN | String | Taxpayer Identification Number. Size Range: 9-11 |
| Txns | object[] | Collection of Transactions. |
| SequenceID | String | Optional The SequenceId will act as a unique identifier for the transaction. TaxBandits will throw an error when there is an API request with a SequenceId that was previously sent. The SequenceId is an optional node.It can be used to eliminate any chance of duplicate transaction submission. Size Range: ..50 |
| TxnDate | String | Date of transaction. |
| TxnAmt | String | Transaction Amount. |
| WHAmt | String | Optional Amount withheld. |
| Page | Int | Requested Page Number. |
| TotalRecords | Int | Total number of records returned in the response. |
| TotalPages | Int | Total pages available for the business. |
| PageSize | Int | Requested Page Size. |
| Errors | object | Shows error information. |
Request 1: Get the details of a particular submission using SubmissionId.
Form1099Transactions?SubmissionId=7f54c788-5673-4cc2-afc2-d5933b54bc37
Response 1: The response will include all relevant information for the given SubmissionId.
{
"Form1099TxnDetails": [
{
"SubmissionId": "7f54c788-5673-4cc2-afc2-d5933b54bc37",
"TxnData": [
{
"Business": {
"PayerRef": "Be8523",
"BusinessId": "50e6e084-6c22-47a4-8a4e-018fd34eab42",
"TINType": "EIN",
"TIN": "64-3857839"
},
"Recipients": [
{
"PayeeRef": "Pe123",
"RecipientId": "43931da4-ccec-4054-81b5-7ca7249f3891",
"TINType": "SSN",
"TIN": "764-74-3823",
"Txns": [
{
"SequenceId": "1",
"TxnDate": "09/04/2022",
"TxnAmt": 178.25,
"WHAmt": 49.92
},
{
"SequenceId": "2",
"TxnDate": "08/03/2022",
"TxnAmt": 108.26,
"WHAmt": 28.91
},
{
"SequenceId": "3",
"TxnDate": "02/03/2022",
"TxnAmt": 138.26,
"WHAmt": 35.44
}
]
}
]
}
]
}
],
"Page": 1,
"TotalRecords": 1,
"TotalPages": 1,
"PageSize": 100,
"Errors": null
}
Request 2: To list all the available transactions under a specific payer and tax year.
Form1099Transactions?BusinessId=7289099A-E20F-4271-AB29-06865CECCB03&TaxYear=2022&Page=1&PageSize=10&TxnFromDate=01/01/2022&TxnToDate=12/30/2022"
Response 2: It returns the transaction details based on the given specific Payer and tax year.
{
"Form1099TxnDetails": [
{
"SubmissionId": "17E1EFA1-37B8-4ACE-89E9-877FE749B64E",
"TxnData": [
{
"Business": {
"PayerRef": "B001",
"BusinessId": "7289099A-E20F-4271-AB29-06865CECCB03",
"TINType": "EIN",
"TIN": "12-3123123"
},
"Recipients": [
{
"PayeeRef": "R001",
"RecipientId": "4191EA42-CBDF-411F-A515-AC48ADB63D78",
"Txns": [
{
"SequenceId": null,
"TxnDate": "12/11/2022",
"TxnAmt": "358.25",
"WHAmt": null
},
{
"SequenceId": null,
"TxnDate": "06/18/2022",
"TxnAmt": "358.25",
"WHAmt": null
},
{
"SequenceId": null,
"TxnDate": "03/07/2022",
"TxnAmt": "358.25",
"WHAmt": null
}
]
},
{
"PayeeRef": null,
"RecipientId": "4789EA42-CBDF-411F-A515-AC48ADB63D78",
"Txns": [
{
"SequenceId": null,
"TxnDate": "12/11/2022",
"TxnAmt": "358.25",
"WHAmt": null
},
{
"SequenceId": null,
"TxnDate": "08/23/2022",
"TxnAmt": "358.25",
"WHAmt": null
},
{
"SequenceId": null,
"TxnDate": "06/19/2022",
"TxnAmt": "358.25",
"WHAmt": null
}
]
}
]
},
{
"Business": {
"PayerRef": "F223432423",
"BusinessId": "4579099A-E20F-4271-AB29-06865CECCB03",
"TINType": "EIN",
"TIN": "78-3123365"
},
"Recipients": [
{
"PayeeRef": "R0123",
"RecipientId": "6591EA42-CBDF-411F-A515-AC48ADB6FH26",
"Txns": [
{
"SequenceId": null,
"TxnDate": "12/11/2022",
"TxnAmt": "427.6",
"WHAmt": null
},
{
"SequenceId": null,
"TxnDate": "03/19/2022",
"TxnAmt": "358.25",
"WHAmt": null
},
{
"SequenceId": null,
"TxnDate": "07/01/2022",
"TxnAmt": "358.25",
"WHAmt": null
}
]
}
]
}
]
},
{
"SubmissionId": "26E1EFA1-37B8-4ACE-89E9-877FE749B66G",
"TxnData": [
{
"Business": {
"PayerRef": null,
"BusinessId": "7289099A-E20F-4271-AB29-06865CECCB03",
"TINType": "EIN",
"TIN": "12-3123123"
},
"Recipients": [
{
"PayeeRef": null,
"RecipientId": "4191EA42-CBDF-411F-A515-AC48ADB63D78",
"Txns": [
{
"SequenceId": null,
"TxnDate": "12/11/2022",
"TxnAmt": "358.25",
"WHAmt": null
},
{
"SequenceId": null,
"TxnDate": "06/18/2022",
"TxnAmt": "358.25",
"WHAmt": null
},
{
"SequenceId": null,
"TxnDate": "03/07/2022",
"TxnAmt": "358.25",
"WHAmt": null
}
]
},
{
"PayeeRef": "R002",
"RecipientId": "4789EA42-CBDF-411F-A515-AC48ADB63D78",
"Txns": [
{
"SequenceId": null,
"TxnDate": "12/11/2022",
"TxnAmt": "358.25",
"WHAmt": null
},
{
"SequenceId": null,
"TxnDate": "08/23/2022",
"TxnAmt": "358.25",
"WHAmt": null
},
{
"SequenceId": null,
"TxnDate": "06/19/2022",
"TxnAmt": "358.25",
"WHAmt": null
}
]
}
]
},
{
"Business": {
"PayerRef": "F223432423",
"BusinessId": "4579099A-E20F-4271-AB29-06865CECCB03",
"TINType": "EIN",
"TIN": "78-3123365"
},
"Recipients": [
{
"PayeeRef": null,
"RecipientId": "6591EA42-CBDF-411F-A515-AC48ADB6FH26",
"Txns": [
{
"SequenceId": null,
"TxnDate": "12/11/2022",
"TxnAmt": "427.6",
"WHAmt": null
},
{
"SequenceId": null,
"TxnDate": "03/19/2022",
"TxnAmt": "358.25",
"WHAmt": null
},
{
"SequenceId": null,
"TxnDate": "07/01/2022",
"TxnAmt": "358.25",
"WHAmt": null
}
]
}
]
}
]
}
],
"Page": 1,
"TotalRecords": 2,
"TotalPages": 1,
"PageSize": 10,
"Errors": null
}
Request 3: To Get the transactions for a particular payer and recipient for a given tax year.
Form1099Transactions?BusinessId=7289099A-E20F-4271-AB29-06865CECCB03&recipientId=4191EA42-CBDF-411F-A515-AC48ADB63D78&TaxYear=2022&Page=1&PageSize=10&TxnFromDate=01/01/2022&TxnToDate=12/30/2022
Response 3: For the provided tax year, the response will offer all information connected to the specific payer and recipient.
{
"Form1099TxnDetails": [
{
"SubmissionId": "17E1EFA1-37B8-4ACE-89E9-877FE749B64E",
"TxnData": [
{
"Business": {
"PayerRef": "B001",
"BusinessId": "7289099A-E20F-4271-AB29-06865CECCB03",
"TINType": "EIN",
"TIN": "12-3123123"
},
"Recipients": [
{
"PayeeRef": "R001",
"RecipientId": "4191EA42-CBDF-411F-A515-AC48ADB63D78",
"Txns": [
{
"SequenceId": null,
"TxnDate": "12/11/2022",
"TxnAmt": "358.25",
"WHAmt": null
},
{
"SequenceId": null,
"TxnDate": "06/18/2022",
"TxnAmt": "358.25",
"WHAmt": null
},
{
"SequenceId": null,
"TxnDate": "03/07/2022",
"TxnAmt": "358.25",
"WHAmt": null
}
]
},
]
}
]
}
]
}
],
"Page": 1,
"TotalRecords": 2,
"TotalPages": 1,
"PageSize": 10,
"Errors": null
}