ENendclose

Retrieve a reconciliation exception

Changed on

Returns the exception with assignees, comments, recent investigation sessions, aggregates for the entire overdue slice, and filtered_aggregates restricted to the supplied filter query parameters. All filter parameters are optional.

get/reconciliation_exceptions/{id}

Request

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

Path parameters

idstring required

Query parameters

amount_mininteger

Include records with signed amount >= amount_min (cents)

amount_maxinteger

Include records with signed amount <= amount_max (cents)

date_fromstring date

Include records with transaction date >= date_from

date_tostring date

Include records with transaction date <= date_to

direction'debit' | 'credit'

Include only debits (amount < 0) or credits (amount > 0)

counterpartystring

Case-insensitive substring match on record description

age_bucket'lt_7d' | '7_30d' | '30_90d' | 'gt_90d'

Convenience age filter on time since overdue_at

Response

Exception retrieved

idstring uuid
reconciliation_idstring uuid required

The reconciliation this exception belongs to

reconciliation_namestring

Name of the parent reconciliation

data_stream_idstring uuid required

The data stream this exception is scoped to

data_stream_namestring

Human-readable name of the scoped data stream

data_stream_keystring

Immutable key of the scoped data stream

titlestring required
descriptionstring nullable
status'open' | 'investigating' | 'dismissed' | 'resolved'
created_atstring date-time
updated_atstring date-time
opened_atstring date-time nullable

When the exception most recently transitioned into an open state. Distinct from created_at so reopening is tracked cleanly.

closed_atstring date-time nullable

When the exception most recently transitioned into a resolved or dismissed state. Cleared on reopen.

decimal_placesinteger

Number of decimal places (2 for USD)

reasonsstring[]

Adjustment reasons already used on this reconciliation, most common first (at most 20). Offered as choices when a reviewer plugs a gap by hand. Only present on the show response.

Changes

  • 159f9ed3dbf4Revision changes
    • breaking

      the response property became nullable for the 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

    • 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

  • e4a47982742aRevision 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