Pular para o conteúdo principal
POST
/
v1
/
exceptions
/
{exceptionId}
/
adjust-entry
Ajustar lançamento para uma exceção
curl --request POST \
  --url https://matcher.sandbox.lerian.net/v1/exceptions/{exceptionId}/adjust-entry \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "amount": 150.5,
  "currency": "USD",
  "effectiveAt": "2023-11-07T05:31:56Z",
  "notes": "Correcting processing fee discrepancy",
  "reasonCode": "FEE_ADJUSTMENT"
}
'
{
  "assignedTo": "user@example.com",
  "createdAt": "2025-01-15T10:30:00.000Z",
  "dueAt": "2025-01-20T10:30:00.000Z",
  "externalIssueId": "RECON-1234",
  "externalSystem": "JIRA",
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "reason": "Amount mismatch detected",
  "resolutionNotes": "Resolved via force match",
  "resolutionReason": "BUSINESS_DECISION",
  "resolutionType": "FORCE_MATCH",
  "severity": "HIGH",
  "status": "OPEN",
  "transactionId": "550e8400-e29b-41d4-a716-446655440001",
  "updatedAt": "2025-01-15T10:30:00.000Z"
}

Autorizações

Authorization
string
header
obrigatório

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

Cabeçalhos

X-Request-Id
string

Um identificador único para rastrear a requisição entre serviços.

X-Idempotency-Key
string

Uma chave única para garantir novas tentativas seguras da requisição.

Parâmetros de caminho

exceptionId
string
obrigatório

ID da exceção

Corpo

application/json

Payload de lançamento de ajuste

Payload de requisição de lançamento de ajuste

amount
number
obrigatório

Valor do ajuste

Exemplo:

150.5

currency
string
obrigatório

Código da moeda (ISO 4217)

Exemplo:

"USD"

effectiveAt
string<date-time>
obrigatório

Quando o ajuste entra em vigor

notes
string
obrigatório

Notas adicionais explicando o ajuste

Maximum string length: 1000
Exemplo:

"Correcting processing fee discrepancy"

reasonCode
string
obrigatório

Código do motivo para o ajuste

Maximum string length: 255
Exemplo:

"FEE_ADJUSTMENT"

Resposta

Indica que a requisição foi bem-sucedida e a resposta contém os dados esperados.

Detalhes da exceção

assignedTo
string

Usuário ao qual a exceção está atribuída

Exemplo:

"user@example.com"

createdAt
string

Timestamp de criação no formato RFC3339

Exemplo:

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

dueAt
string

Data limite para resolução no formato RFC3339

Exemplo:

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

externalIssueId
string

ID do issue externo no sistema externo

Exemplo:

"RECON-1234"

externalSystem
string

Sistema externo para onde a exceção foi encaminhada

Exemplo:

"JIRA"

id
string

Identificador único da exceção

Exemplo:

"550e8400-e29b-41d4-a716-446655440000"

reason
string

Motivo pelo qual a exceção foi gerada

Exemplo:

"Amount mismatch detected"

resolutionNotes
string

Notas de resolução quando resolvida

Exemplo:

"Resolved via force match"

resolutionReason
string

Motivo da resolução

Exemplo:

"BUSINESS_DECISION"

resolutionType
enum<string>

Tipo de resolução aplicada

Opções disponíveis:
FORCE_MATCH,
ADJUST_ENTRY
Exemplo:

"FORCE_MATCH"

severity
enum<string>

Nível de severidade

Opções disponíveis:
LOW,
MEDIUM,
HIGH,
CRITICAL
Exemplo:

"HIGH"

status
enum<string>

Status atual

Opções disponíveis:
OPEN,
ASSIGNED,
RESOLVED
Exemplo:

"OPEN"

transactionId
string

ID da transação para a qual esta exceção se refere

Exemplo:

"550e8400-e29b-41d4-a716-446655440001"

updatedAt
string

Timestamp da última atualização no formato RFC3339

Exemplo:

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