Skip to main content
POST
Force match an exception

Autorizaciones

Authorization
string
header
requerido

Bearer token authentication (format: "Bearer {token}")

Encabezados

X-Request-Id
string

A unique identifier for tracing the request across services.

X-Idempotency-Key
string

Optional idempotency key for safe retries. Also accepts Idempotency-Key as an alternative header name. If the same key is sent again and the original request was already processed, the cached response is returned with X-Idempotency-Replayed: true.

See Retries and idempotency for details.

Parámetros de ruta

exceptionId
string
requerido

Exception ID

Cuerpo

application/json

Force match payload

Force match request payload

notes
string
requerido

Additional notes explaining the force match decision

Maximum string length: 1000
Ejemplo:

"Approved by finance team after manual review"

overrideReason
string
requerido

Reason for overriding the normal matching process

Maximum string length: 255
Ejemplo:

"BUSINESS_DECISION"

Respuesta

Indicates that the request was successful and the response contains the expected data.

The response includes the X-Idempotency-Replayed header.

If the value is false, the request was just processed. If the value is true, the response is a replay of a previously processed request.

See Retries and idempotency for more details.

Exception details

assignedTo
string

User the exception is assigned to

Ejemplo:

"user@example.com"

createdAt
string

Creation timestamp in RFC3339 format

Ejemplo:

"2025-01-15T10:30:00.000Z"

dueAt
string

Due date for resolution in RFC3339 format

Ejemplo:

"2025-01-20T10:30:00.000Z"

externalIssueId
string

External issue ID in the external system

Ejemplo:

"RECON-1234"

externalSystem
string

External system where exception was dispatched

Ejemplo:

"JIRA"

id
string

Unique identifier for the exception

Ejemplo:

"019c96a0-10d2-7134-ba5f-664142ee7052"

reason
string

Reason the exception was raised

Ejemplo:

"Amount mismatch detected"

resolutionNotes
string

Resolution notes when resolved

Ejemplo:

"Resolved via force match"

resolutionReason
string

Reason for the resolution

Ejemplo:

"BUSINESS_DECISION"

resolutionType
enum<string>

Type of resolution applied

Opciones disponibles:
FORCE_MATCH,
ADJUST_ENTRY
Ejemplo:

"FORCE_MATCH"

severity
enum<string>

Severity level

Opciones disponibles:
LOW,
MEDIUM,
HIGH,
CRITICAL
Ejemplo:

"HIGH"

status
enum<string>

Current status

Opciones disponibles:
OPEN,
ASSIGNED,
PENDING_RESOLUTION,
RESOLVED
Ejemplo:

"OPEN"

transactionId
string

Transaction ID this exception is for

Ejemplo:

"019c96a0-10ce-75fc-a273-dc799079a99c"

updatedAt
string

Last update timestamp in RFC3339 format

Ejemplo:

"2025-01-15T10:30:00.000Z"