Execute a Job in Account Reconciliation
Use this resource to execute a job by providing the job name and type.
The job is expected to be defined in Account Reconciliation with all the required parameters saved with the job definition. For some job types, the parameters can be either provided or overwritten at runtime.
Reconciliation Compliance Supported Job Types:
-
CREATE_RECONCILIATIONS
-
SET_PERIOD_STATUS
-
IMPORT_PREMAPPED_TRANSACTIONS
-
IMPORT_PREMAPPED_PROFILES
-
IMPORT_RATES
-
IMPORT_BALANCES
-
MONITOR_RECONCILIATIONS
-
IMPORT_PREMAPPED_BALANCES
Transaction Matching Supported Job Types:
- IMPORTTMPREMAPPEDTRANSACTIONS
- RUNAUTOMATCH
This topic describes general information for executing a job. Details for each job type are described in separate topics for individual jobs.
REST Resource
POST /armARCS/rest/{api_version}/jobs
Required Roles
Service Administrator, Power User, User, Viewer
Users with Power User, User, and Viewer predefined roles may require additional application roles.
Request
Supported Media Types: application/json
Parameters
This table summarizes the request parameters that are generic to all jobs. The following tables describe parameters specific to individual rules.
Table 17-5 Parameters
Name | Description | Type | Required | Default |
---|---|---|---|---|
api_version |
Version of the API you are developing with | Path | Yes | None |
Example URL
https://<BASE-URL>/armARCS/rest/v1/jobs
Response
Supported Media Types: application/json
Parameters
This table summarizes the response parameters that are generic to all jobs. The following tables describe parameters specific to individual rules.
Table 17-6 Parameters
Name | Description |
---|---|
jobName |
The name of the job, such as Create Reconciliations |
period Note: For monitor_reconciliations, the parameter is |
The name of period, such as July2016 |
filter Note: For monitor_reconciliations, the parameter is |
The name of filter, such as MyFilter |