Skip to main content
PATCH
/
reconciliations
/
{id}
Update a reconciliation
curl --request PATCH \
  --url https://api.endclose.com/v1/reconciliations/{id} \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "name": "<string>",
  "side_a_stream_ids": [
    "<string>"
  ],
  "side_b_stream_ids": [
    "<string>"
  ]
}
'
{
  "name": "<string>",
  "id": 123,
  "run_type": "continuous",
  "side_a_streams": [
    {
      "key": "<string>",
      "name": "<string>",
      "id": 123,
      "description": "<string>",
      "type": "<string>"
    }
  ],
  "side_b_streams": [
    {
      "key": "<string>",
      "name": "<string>",
      "id": 123,
      "description": "<string>",
      "type": "<string>"
    }
  ],
  "created_at": "2023-11-07T05:31:56Z",
  "current_run": {
    "id": 123,
    "total_records": 123,
    "processed_records": 123,
    "matched_records": 123,
    "rule_summary": {},
    "progress": 123,
    "started_at": "2023-11-07T05:31:56Z",
    "completed_at": "2023-11-07T05:31:56Z"
  },
  "last_run": {
    "id": 123,
    "total_records": 123,
    "processed_records": 123,
    "matched_records": 123,
    "rule_summary": {},
    "progress": 123,
    "started_at": "2023-11-07T05:31:56Z",
    "completed_at": "2023-11-07T05:31:56Z"
  }
}

Authorizations

​
X-API-KEY
string
header
required

Path Parameters

​
id
string
required

Body

application/json
​
name
string
​
run_type
enum<string>
Available options:
continuous,
batch
​
side_a_stream_ids
string[]
​
side_b_stream_ids
string[]

Response

Reconciliation updated

​
name
string
required

Human readable name for the reconciliation

​
id
integer
​
run_type
enum<string>
default:continuous
Available options:
continuous,
batch
​
side_a_streams
object[]

Data streams on side A of the reconciliation

​
side_b_streams
object[]

Data streams on side B of the reconciliation

​
created_at
string<date-time>
​
current_run
object

The currently pending or running batch run, if any

​
last_run
object

The most recent completed or failed batch run, if any