Archive Matched Transactions (Transaction Matching)

Archives matched transactions, including support and adjustment details, that are equal to or older than a specified age. The matched transactions are stored in an archive file.

REST Resource

POST       /arm/rest/{api_version}/jobs

Required Roles

Service Administrator or Profiles and Reconciliations - Manage

Request

Supported Media Types: application/json

Parameters

The following table summarizes the client request specific to this job.

Table 17-67 ARCHIVE MATCHED TRANSACTIONS

Name	Description	Type	Required
api_version	Version of the API you are working with: v1	Path	Yes
jobName	The name of a job, archivetransactions	Payload	Yes
reconTypeId	The TextID of the match type from which matched transactions must be archived	Payload	Yes
age	Matched transactions older than or equal to this value will be archived	Payload	Yes
filterOperator	Filter to identify the accounts Valid values are EQUALS, NOT_EQUALS, STARTS_WITH, ENDS_WITH, CONTAINS, NOT_CONTAINS	Payload	No
filterValue	The Account IDs for the filter operation	Payload	No
logFileName	The name of the log file If a file name is not provided, the log file is named Archive_Transactions_<reconTypeId>_<Job_id>.log.	Payload	No
fileName	The name of the archive zip file If a file name is not provided, the archive file is named Archive_Transactions_<reconTypeId>_<Job_id>.zip.	Payload	No

Example of request body

{
 "jobName": "archivetransactions",
 "parameters": {
   "reconTypeId": "Pos2Processor",
   "age": 120,
   "logFileName" : "Archive_Transactions_IC120XXXX.log",
   "fileName" : "Archived_Transactions_IC120XXXX.zip",
   "filterOperator": "EQUALS",
   "filterValue": [
     "201-1234",
     "202-1234"
     ]
  }
}

Response

Supported Media Types: application/json

Example of Response Body

The following is an example of the response body in JSON format.

{
    "type": "TM",
    "items": null,
    "error": null,
    "link": null,
    "status": -1,
    "details": null,
    "links": [
        {
            "href": "https://<SERVICE_NAME>-<TENANT_NAME>.<SERVICE_TYPE>.<dcX>.oraclecloud.com/arm/rest/v1/jobs/100000003846005",
            "action": "GET",
            "rel": "self",
            "data": null
        }
    ]
}

To get the status of the archive matched transactions job and view its details, see Retrieve Job Status (Transaction Matching).