Skip to main content
Version: 1.7.0

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
Run in Postman

Request Params

FieldTypeDescription
SubmissionIdGuidUnique identifier of a submission.
BusinessIdGuidUnique identifier of a business.
PayerRefStringUnique identifier of a business. Set by the client.
RecipientIdGuidUnique identifier of a recipient.
PayeeRefStringUnique identifier of a recipient. Set by the client.
TaxYearStringTaxyear for which you want the transactions to be listed. In the format yyyy.
PageIntPage number that needs to be listed in the Response. If the value is not given, then the page will be defaulted to 1.
FromDateStringLists the transaction records between the date range.
ToDateStringLists the transaction records between the date range.

Request Params

Get the details of a particular submission using SubmissionId.

Form1099Transactions?SubmissionId=7f54c788-5673-4cc2-afc2-d5933b54bc37

Response Body

FieldTypeDescription
Form1099TxnDetailsObject[]Transaction Details.
SubmissionIdGuidUnique identifier of a submission.
    TxnDataobject[]Collection of all the transactions from payers to recipients.
        BusinessobjectPayer Information.
            PayerRefStringUnique identifier of the payer. Set by the client.
            BusinessIdGuidTaxBandits Unique Business Identifier.
            TINTypeStringTIN Type of the business.
Allowed values: "SSN", "EIN"
            TINStringTaxpayer Identification Number.
Size Range: 9-11
        Recipientsobject[]Recipient Information.
            PayeeRefStringUnique identifier of the recipient. Set by the client.
            RecipientIdGuidUnique identifier of the recipient.
            TINTypeStringTIN Type of the recipient.
Allowed values: "SSN", "EIN"
            TINStringTaxpayer Identification Number.
Size Range: 9-11
            Txnsobject[]Collection of Transactions.
            SequenceIDStringOptional 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
                TxnDateStringDate of transaction.
                TxnAmtStringTransaction Amount.
                WHAmtStringOptional Amount withheld.
PageIntRequested Page Number.
TotalRecordsIntTotal number of records returned in the response.
TotalPagesIntTotal pages available for the business.
PageSizeIntRequested Page Size.
ErrorsobjectShows error information.

Response JSON

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/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
}