Create a reconciliation story

Create a story and attach a chain of reconciliations. The first link must use role origin and have no shared_data_stream_id; subsequent links must use role continuation and specify the shared data stream linking them to the previous reconciliation.

POST /reconciliation_stories

Create a reconciliation story

cURL

curl --request POST \
  --url https://api.endclose.com/v1/reconciliation_stories \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "name": "<string>",
  "links": [
    {
      "reconciliation_id": "<string>",
      "position": 123,
      "role": "origin",
      "shared_data_stream_id": "<string>"
    }
  ]
}
'

201

{
  "name": "<string>",
  "id": 123,
  "created_at": "2023-11-07T05:31:56Z",
  "links": [
    {
      "position": 123,
      "reconciliation_id": 123,
      "id": 123,
      "reconciliation_name": "<string>",
      "shared_data_stream_id": 123,
      "shared_data_stream_name": "<string>",
      "side_a_streams": [
        {
          "id": 123,
          "name": "<string>"
        }
      ],
      "side_b_streams": [
        {
          "id": 123,
          "name": "<string>"
        }
      ]
    }
  ]
}

Authorizations

X-API-KEY · string · header · required

Body

application/json

name · string · required

links · object[]

Show child attributes

Response

201

application/json

Story created

A reconciliation story groups related reconciliations into an ordered chain so end-to-end flow can be tracked. Each link points to a reconciliation; non-origin links must specify the data stream that connects them to the previous reconciliation in the chain.

name · string · required

Human readable name for the story

id · integer

created_at · string<date-time>

links · object[]

Ordered list of reconciliations participating in the story

Show child attributes