ENendclose

Create a reconciliation exception

Changed on

Create an exception for a reconciliation and data stream. Only one open or investigating exception can exist per (data stream, reconciliation) pair at a time. title defaults to "{data_stream_name} — overdue records", and status defaults to open. The system automatically creates exceptions via its overdue sweeper — use this endpoint when you want to open one manually.

post/reconciliation_exceptions

Request

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

Headers

Idempotency-Keystring

Optional. Send the same key when retrying a write you are not sure landed: the first response is returned again (with Idempotent-Replayed: true) instead of writing twice. A key used for a different request is refused with 422; one whose first request is still running gets 409. A refused or failed request does not use up its key. Keys are per environment and kept for 7 days.

Request body

reconciliation_idstring required

Reconciliation the exception belongs to

data_stream_idstring required

Data stream the exception is scoped to. Must belong to the reconciliation.

titlestring
descriptionstring
status'open' | 'investigating' | 'dismissed' | 'resolved'

Response

Exception created

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

    • info

      added the new optional header request parameter Idempotency-Key

  • 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