List reconcilable records for a record

Returns the records that can be reconciled against the given record (candidates for a match),
paginated and with amount_to_be_reconciled / exhausted computed. Supports filtering via
query parameters and sorting; when sorting by reference_date, NULL dates are sorted last.

Pagination note

For performance, the total count is capped at the maximum page size: the Content-Range
/ X-Total-Count headers report at most the cap (they read as "K+" once the cap is hit), and
the exact total is intentionally not computed for this endpoint. Requesting a window whose
end exceeds the cap (e.g. a large non-zero _start) is rejected with 416.

Note: the parent record is looked up with find_by (not find_by!), so an unknown
record_id does not return a 404; the subsequent call on a nil record currently raises
and the endpoint responds with a 500 (server error). This is a known server-side bug.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
uuid
required

The id of the reconciliation record.

Query Params
integer
≥ 0

If all the transactions where in an array, this would represent the index of the first item returned in the response

integer
≥ 0

If all the transactions where in an array, this would represent the index of the last item returned in the response

string
enum

The order method, which can be ascending or descending

Allowed:
string

The field used to sort, the example illustrates a response that would be sorted by the creation date

Headers
uuid
required

UUID of the company on whose behalf the request is made. Required for every Accounting endpoint.
See The company-id header for details on how to obtain
a value for this header and the error responses to expect when it is missing or invalid.

Responses

401

Unauthorized

416

Requested window exceeds the reconcilable count cap

500

Server error. An unknown record_id is looked up with find_by (not find_by!), so the
subsequent call on the nil record raises instead of returning a 404. This is a known
server-side bug.

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json