POST public-api/transactions/streamgridrequestarchivecsv

Request older archived and purged transaction history records as a stream of data in a CSV-formatted stream. This is the archive counterpart of streamgridrequestcsv: it returns transaction history that has already been archived or purged out of the live transaction history, not the records that endpoint returns. If the FieldTitles parameter is null then all available fields are exported with default column titles. Important! Without this parameter the order and names of fields may change from version to version. Therefore, to ensure consistent results from one version to the next, make sure you provide this value after you have determined the values you need. If the FieldTitles parameter is not provided the column names returned will be the database column names. This API does not support paging as it is intended to stream all of the data at once. Date and time fields are not converted to local time; they are returned in UTC (Universal Time) using the format yyyy-MM-dd HH:mm:ssZ.

Request Information

URI Parameters

None.

Body Parameters

Request Formats

{
  "_sortCriteria": [],
  "FieldTitles": [
    {
      "Key": "sample string 1",
      "Value": "sample string 2"
    },
    {
      "Key": "sample string 1",
      "Value": "sample string 2"
    }
  ],
  "ClientLocalDateTimeFields": [
    "sample string 1",
    "sample string 2"
  ],
  "DateOnlyFields": [
    "sample string 1",
    "sample string 2"
  ],
  "ExportDateFormat": "sample string 1",
  "ExportDateTimeFormat": "sample string 2",
  "TotalCountFromPriorFetch": 1,
  "AdditionalSkipCount": 3,
  "PageSize": 4,
  "PageNumber": 5,
  "Filter": {
    "$id": "1",
    "field": "sample string 1",
    "operator": "sample string 2",
    "value": {},
    "logic": "sample string 4",
    "filters": []
  },
  "ClientUtcOffset": null,
  "FilterBehavior": 0,
  "IgnoreAttachments": true,
  "IgnoreGeoLocation": true,
  "WorkingSiteIdCsvList": "8"
}

Response Information

Resource Description