ENendclose

Read the review of an exception

Changed on

Returns the exception's findings with each line's derived status, filtered and paged. Lines sort to_look_at first, then looks_right, then done; within a status, newest record date first. sort puts a column in front of that order.

get/reconciliation_exceptions/{id}/review

Request

  • Base URL
    https://api.endclose.com/v1
  • Auth
    API key in header X-API-KEY

Path parameters

idstring required

Query parameters

status'all' | 'to_look_at' | 'looks_right' | 'done'
qstring

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

categorystring[]

Only lines whose finding is in one of these categories (exact match). Repeat the parameter for several.

sort'date' | 'description' | 'category' | 'amount' | 'other_amount' | 'difference' | 'quantity' | 'other_quantity' | 'quantity_difference' | 'status'

Column to sort by. Amounts sort on magnitude; difference and quantity_difference on the signed gap; lines with nothing in the column come last. Unknown values keep the review order.

dir'asc' | 'desc'
pageinteger
per_pageinteger

Response

A page of the review

pageinteger
per_pageinteger
totalinteger

Rows matching the current status, category and q filters.

sidesobject

{ a: { data_stream_id, name }, b: { data_stream_id, name } }

row_side'a' | 'b'

Which side the exception's lines are on.

pending_notesinteger

Overdue lines of this exception that have no finding yet.

notes_state'writing' | 'failed' | 'off' | 'idle'

Why pending_notes lines have no finding. writing: a row_review session is queued or running. failed: the latest row_review session failed or died mid-run. off: End Close's row review isn't enabled for this account (this wins over any earlier run), so only findings you post through PUT /reconciliation_exceptions/{id}/findings appear. idle: no run is in flight.

Changes

  • f1074e68bb01Revision changes
    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ///// to the response with the status

  • 159f9ed3dbf4Revision changes
    • breaking

      the /////////// response's property type changed from integer to string, and format from no format to uuid for status

    • breaking

      the //////// response's property type changed from integer to string, and format from no format to uuid for status

    • breaking

      the ////////// response's property type changed from integer to string, and format from no format to uuid for status

    • breaking

      the ////////// response's property type changed from integer to string, and format from no format to uuid for status

    • breaking

      the //////// response's property type changed from integer to string, and format from no format to uuid for status