GET api/{context}/partner/TransactionHistory/{text}

parameters:   ?page={page}&pageSize={pageSize}&startDate={startDate}&endDate={endDate}

Retrieve a Partner's transaction history (using their ID).

Request Information

ParameterDescriptionAdditional information
text
The ID of the partner for look-up.

Define this parameter in the request URI.

page
Optional page number.  If not included, page 1 will be returned.

Define this parameter in the request URI.

pageSize
Optional page size, limit of 100.  If not included, the default page size will be 25.

Define this parameter in the request URI.

startDate
Optional start date filter.

Define this parameter in the request URI.

endDate
Optional end date filter.

Define this parameter in the request URI.

Special Field Notes

Field NameNotes
NextPageLink
Contains the full URL necessary to retrieve the next page of records.
PageCount
The number of pages contained in the result set, based on the PageSize passed in the API request.
PreviousPageLink
Contains the full URL necessary to retrieve the previous page of records.
TotalCount
The total number of records contained in the result set.

Response Information

Response body formats

application/json, text/json

Sample:
{
  "NextPageLink": "sample string 1",
  "PreviousPageLink": "sample string 2",
  "PageCount": 3,
  "TotalCount": 4,
  "Transactions": [
    {
      "TransactionType": "sample string 1",
      "TransactionDate": "2020-08-04T11:54:18.2133417-06:00",
      "TransactionAmount": 3.0,
      "AppealCode": "sample string 4",
      "DateRecorded": "2020-08-04T11:54:18.2133417-06:00",
      "RecordedBy": "sample string 6",
      "InvoiceNumber": 1,
      "Acknowledgements": [
        {
          "AppealID": "sample string 1",
          "AppealName": "sample string 2",
          "Responded": true,
          "ResponseDate": "2020-08-04T11:54:18.2133417-06:00",
          "ResponseType": "sample string 3"
        },
        {
          "AppealID": "sample string 1",
          "AppealName": "sample string 2",
          "Responded": true,
          "ResponseDate": "2020-08-04T11:54:18.2133417-06:00",
          "ResponseType": "sample string 3"
        },
        {
          "AppealID": "sample string 1",
          "AppealName": "sample string 2",
          "Responded": true,
          "ResponseDate": "2020-08-04T11:54:18.2133417-06:00",
          "ResponseType": "sample string 3"
        }
      ]
    },
    {
      "TransactionType": "sample string 1",
      "TransactionDate": "2020-08-04T11:54:18.2133417-06:00",
      "TransactionAmount": 3.0,
      "AppealCode": "sample string 4",
      "DateRecorded": "2020-08-04T11:54:18.2133417-06:00",
      "RecordedBy": "sample string 6",
      "InvoiceNumber": 1,
      "Acknowledgements": [
        {
          "AppealID": "sample string 1",
          "AppealName": "sample string 2",
          "Responded": true,
          "ResponseDate": "2020-08-04T11:54:18.2133417-06:00",
          "ResponseType": "sample string 3"
        },
        {
          "AppealID": "sample string 1",
          "AppealName": "sample string 2",
          "Responded": true,
          "ResponseDate": "2020-08-04T11:54:18.2133417-06:00",
          "ResponseType": "sample string 3"
        },
        {
          "AppealID": "sample string 1",
          "AppealName": "sample string 2",
          "Responded": true,
          "ResponseDate": "2020-08-04T11:54:18.2133417-06:00",
          "ResponseType": "sample string 3"
        }
      ]
    },
    {
      "TransactionType": "sample string 1",
      "TransactionDate": "2020-08-04T11:54:18.2133417-06:00",
      "TransactionAmount": 3.0,
      "AppealCode": "sample string 4",
      "DateRecorded": "2020-08-04T11:54:18.2133417-06:00",
      "RecordedBy": "sample string 6",
      "InvoiceNumber": 1,
      "Acknowledgements": [
        {
          "AppealID": "sample string 1",
          "AppealName": "sample string 2",
          "Responded": true,
          "ResponseDate": "2020-08-04T11:54:18.2133417-06:00",
          "ResponseType": "sample string 3"
        },
        {
          "AppealID": "sample string 1",
          "AppealName": "sample string 2",
          "Responded": true,
          "ResponseDate": "2020-08-04T11:54:18.2133417-06:00",
          "ResponseType": "sample string 3"
        },
        {
          "AppealID": "sample string 1",
          "AppealName": "sample string 2",
          "Responded": true,
          "ResponseDate": "2020-08-04T11:54:18.2133417-06:00",
          "ResponseType": "sample string 3"
        }
      ]
    }
  ]
}

application/xml, text/xml

Sample:
<TransactionHistoryModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BDS.Web.WebApi.Models">
  <NextPageLink>sample string 1</NextPageLink>
  <PageCount>3</PageCount>
  <PreviousPageLink>sample string 2</PreviousPageLink>
  <TotalCount>4</TotalCount>
</TransactionHistoryModel>