Get
This endpoint gets a particular submission and lists transactions for a particular payer or payer/recipient combination
- To Get a particular submission supply the submissionid alone in the request.
- To List the transactions of a particular payer or payer/recipient combination supply the parameters other than SubmissionId.
GET Form1099TransactionsRequest 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. |
| FromDate | String | Lists the transaction records between the date range. |
| ToDate | 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: To Get a particular submission
Form1099Transactions?SubmissionId=7f54c788-5673-4cc2-afc2-d5933b54bc37Response 1
{ "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/2020", "TxnAmt": 178.25, "WHAmt": 49.92 }, { "SequenceId": "2", "TxnDate": "08/03/2020", "TxnAmt": 108.26, "WHAmt": 28.91 }, { "SequenceId": "3", "TxnDate": "02/03/2020", "TxnAmt": 138.26, "WHAmt": 35.44 } ] } ] } ] } ], "Page": 1, "TotalRecords": 1, "TotalPages": 1, "PageSize": 100, "Errors": null}Request 2: To list transactions under a payer and tax year.
Form1099Transactions?BusinessId=7289099A-E20F-4271-AB29-06865CECCB03&TaxYear=2020&Page=1&PageSize=10&TxnFromDate=01/01/2020&TxnToDate=12/30/2020"Response 2
{ "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/2020", "TxnAmt": "358.25", "WHAmt": null }, { "SequenceId": null, "TxnDate": "06/18/2020", "TxnAmt": "358.25", "WHAmt": null }, { "SequenceId": null, "TxnDate": "03/07/2020", "TxnAmt": "358.25", "WHAmt": null } ] }, { "PayeeRef": null, "RecipientId": "4789EA42-CBDF-411F-A515-AC48ADB63D78", "Txns": [ { "SequenceId": null, "TxnDate": "12/11/2020", "TxnAmt": "358.25", "WHAmt": null }, { "SequenceId": null, "TxnDate": "08/23/2020", "TxnAmt": "358.25", "WHAmt": null }, { "SequenceId": null, "TxnDate": "06/19/2020", "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/2020", "TxnAmt": "427.6", "WHAmt": null }, { "SequenceId": null, "TxnDate": "03/19/2020", "TxnAmt": "358.25", "WHAmt": null }, { "SequenceId": null, "TxnDate": "07/01/2020", "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/2020", "TxnAmt": "358.25", "WHAmt": null }, { "SequenceId": null, "TxnDate": "06/18/2020", "TxnAmt": "358.25", "WHAmt": null }, { "SequenceId": null, "TxnDate": "03/07/2020", "TxnAmt": "358.25", "WHAmt": null } ] }, { "PayeeRef": "R002", "RecipientId": "4789EA42-CBDF-411F-A515-AC48ADB63D78", "Txns": [ { "SequenceId": null, "TxnDate": "12/11/2020", "TxnAmt": "358.25", "WHAmt": null }, { "SequenceId": null, "TxnDate": "08/23/2020", "TxnAmt": "358.25", "WHAmt": null }, { "SequenceId": null, "TxnDate": "06/19/2020", "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/2020", "TxnAmt": "427.6", "WHAmt": null }, { "SequenceId": null, "TxnDate": "03/19/2020", "TxnAmt": "358.25", "WHAmt": null }, { "SequenceId": null, "TxnDate": "07/01/2020", "TxnAmt": "358.25", "WHAmt": null } ] } ] } ] } ], "Page": 1, "TotalRecords": 2, "TotalPages": 1, "PageSize": 10, "Errors": null}Request 3: To list transactions under a payer and recipient for a particular tax year.
Form1099Transactions?BusinessId=7289099A-E20F-4271-AB29-06865CECCB03&recipientId=4191EA42-CBDF-411F-A515-AC48ADB63D78&TaxYear=2021&Page=1&PageSize=10&TxnFromDate=01/01/2020&TxnToDate=12/30/2020Response 3
{ "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/2020", "TxnAmt": "358.25", "WHAmt": null }, { "SequenceId": null, "TxnDate": "06/18/2020", "TxnAmt": "358.25", "WHAmt": null }, { "SequenceId": null, "TxnDate": "03/07/2020", "TxnAmt": "358.25", "WHAmt": null } ] }, ] } ] } ] } ], "Page": 1, "TotalRecords": 2, "TotalPages": 1, "PageSize": 10, "Errors": null}