Read the review of an exception

curl --request GET \
  --url https://api.endclose.com/v1/reconciliation_exceptions/{id}/review \
  --header 'X-API-KEY: <api-key>'

const options = {method: 'GET', headers: {'X-API-KEY': '<api-key>'}};

fetch('https://api.endclose.com/v1/reconciliation_exceptions/{id}/review', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.endclose.com/v1/reconciliation_exceptions/{id}/review",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-KEY: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.endclose.com/v1/reconciliation_exceptions/{id}/review"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-KEY", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.endclose.com/v1/reconciliation_exceptions/{id}/review")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-KEY"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "rows": [
    {
      "record": {
        "amount": 123,
        "direction": "credit",
        "date": "2023-12-25",
        "data_stream_key": "<string>",
        "id": 123,
        "currency": "USD",
        "decimal_places": 2,
        "description": "<string>",
        "metadata": {},
        "external_id": "<string>",
        "reconciliation_id": 123,
        "reconciliation_name": "<string>",
        "status": "reconciled",
        "escalated": true,
        "overdue_at": "2023-11-07T05:31:56Z",
        "matched_records": [
          {
            "id": 123,
            "amount": 123,
            "currency": "USD",
            "decimal_places": 2,
            "direction": "credit",
            "description": "<string>",
            "date": "2023-12-25",
            "external_id": "<string>",
            "data_stream_key": "<string>",
            "reconciliation_id": 123,
            "reconciliation_name": "<string>"
          }
        ],
        "days_unreconciled": 123,
        "exception_id": 123
      },
      "finding": {
        "id": "<string>",
        "record_id": "<string>",
        "looks_right": true,
        "note": "<string>",
        "suggestion": {},
        "evidence": [
          {}
        ],
        "precedent": "<string>",
        "other_side": {},
        "category": "<string>",
        "labels": {},
        "source": "api",
        "created_at": "2023-11-07T05:31:56Z"
      },
      "status": "to_look_at",
      "difference_cents": 123,
      "quantity": 123,
      "other_quantity": 123,
      "quantity_difference": 123
    }
  ],
  "counts": {
    "all": 123,
    "to_look_at": 123,
    "looks_right": 123,
    "done": 123
  },
  "categories": [
    {
      "name": "<string>",
      "count": 123
    }
  ],
  "page": 123,
  "per_page": 123,
  "total": 123,
  "sides": {},
  "row_side": "a",
  "pending_notes": 123
}

GET

reconciliation_exceptions

{id}

review

Read the review of an exception

curl --request GET \
  --url https://api.endclose.com/v1/reconciliation_exceptions/{id}/review \
  --header 'X-API-KEY: <api-key>'

const options = {method: 'GET', headers: {'X-API-KEY': '<api-key>'}};

fetch('https://api.endclose.com/v1/reconciliation_exceptions/{id}/review', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.endclose.com/v1/reconciliation_exceptions/{id}/review",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-KEY: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.endclose.com/v1/reconciliation_exceptions/{id}/review"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-KEY", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.endclose.com/v1/reconciliation_exceptions/{id}/review")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-KEY"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "rows": [
    {
      "record": {
        "amount": 123,
        "direction": "credit",
        "date": "2023-12-25",
        "data_stream_key": "<string>",
        "id": 123,
        "currency": "USD",
        "decimal_places": 2,
        "description": "<string>",
        "metadata": {},
        "external_id": "<string>",
        "reconciliation_id": 123,
        "reconciliation_name": "<string>",
        "status": "reconciled",
        "escalated": true,
        "overdue_at": "2023-11-07T05:31:56Z",
        "matched_records": [
          {
            "id": 123,
            "amount": 123,
            "currency": "USD",
            "decimal_places": 2,
            "direction": "credit",
            "description": "<string>",
            "date": "2023-12-25",
            "external_id": "<string>",
            "data_stream_key": "<string>",
            "reconciliation_id": 123,
            "reconciliation_name": "<string>"
          }
        ],
        "days_unreconciled": 123,
        "exception_id": 123
      },
      "finding": {
        "id": "<string>",
        "record_id": "<string>",
        "looks_right": true,
        "note": "<string>",
        "suggestion": {},
        "evidence": [
          {}
        ],
        "precedent": "<string>",
        "other_side": {},
        "category": "<string>",
        "labels": {},
        "source": "api",
        "created_at": "2023-11-07T05:31:56Z"
      },
      "status": "to_look_at",
      "difference_cents": 123,
      "quantity": 123,
      "other_quantity": 123,
      "quantity_difference": 123
    }
  ],
  "counts": {
    "all": 123,
    "to_look_at": 123,
    "looks_right": 123,
    "done": 123
  },
  "categories": [
    {
      "name": "<string>",
      "count": 123
    }
  ],
  "page": 123,
  "per_page": 123,
  "total": 123,
  "sides": {},
  "row_side": "a",
  "pending_notes": 123
}

Authorizations

X-API-KEY

string

header

required

Path Parameters

string

required

Query Parameters

status

enum<string>

default:to_look_at

Available options:

all,

to_look_at,

looks_right,

done

string

Case-insensitive substring match on the record's description, external id, metadata.client_name or metadata.line_num, or the finding's note or category

Response

A page of the review

rows

object[]

Show child attributes

counts

object

Counts of review lines by status. A line is done once its record is matched, looks_right when its finding says so and it is not yet matched, and to_look_at otherwise.

Show child attributes

Resources

Webhooks

Read the review of an exception

Authorizations

Path Parameters

Query Parameters

Response