Saltar al contenido principal
POST
Crear un contexto de conciliación

Autorizaciones

Authorization
string
header
requerido

Autenticación con token Bearer (formato: "Bearer {token}")

Encabezados

X-Request-Id
string

A unique identifier for tracing the request across services.

X-Idempotency-Key
string

Clave de idempotencia opcional para reintentos seguros. También acepta Idempotency-Key como nombre de encabezado alternativo. Si se envía la misma clave nuevamente y la solicitud original ya fue procesada, se devuelve la respuesta en caché con X-Idempotency-Replayed: true.

Consulte Reintentos e idempotencia para más detalles.

Cuerpo

application/json

Cuerpo de creación del contexto

name
string
requerido
Required string length: 1 - 100
Ejemplo:

"Bank Reconciliation Q1"

type
enum<string>
requerido

Topología de conciliación (cardinalidad entre fuentes)

Opciones disponibles:
1:1,
1:N,
N:M
Ejemplo:

"1:1"

interval
string
requerido
Required string length: 1 - 100
Ejemplo:

"daily"

feeToleranceAbs
string

Monto de tolerancia de tarifa absoluta

Ejemplo:

"0.01"

feeTolerancePct
string

Tolerancia de tarifa en porcentaje

Ejemplo:

"0.5"

feeNormalization
enum<string>

Modo de normalización de tarifas

Opciones disponibles:
NET,
GROSS
Ejemplo:

"NET"

autoMatchOnUpload
boolean

Si se activa la conciliación automáticamente tras la carga de archivos

Ejemplo:

false

sources
object[]

Lista opcional de fuentes para crear en línea con el contexto

Maximum array length: 10
rules
object[]

Lista opcional de reglas de conciliación para crear en línea con el contexto

Maximum array length: 50

Respuesta

Contexto creado correctamente.

La respuesta incluye el encabezado X-Idempotency-Replayed.

Si el valor es false, la solicitud acaba de ser procesada. Si el valor es true, la respuesta es una reproducción de una solicitud procesada anteriormente.

Consulte Reintentos e idempotencia para más detalles.

Contexto de configuración para reglas de conciliación

id
string

Identificador único del contexto

Ejemplo:

"019c96a0-10a0-72d2-9fb0-2b7de8093182"

tenantId
string

ID del tenant al que pertenece este contexto

Ejemplo:

"019c96a0-0a98-7287-9a31-786e0809c769"

name
string

Nombre del contexto de conciliación

Ejemplo:

"Bank Reconciliation Q1"

type
enum<string>

Tipo de topología de conciliación

Opciones disponibles:
1:1,
1:N,
N:M
Ejemplo:

"1:1"

interval
string

Intervalo de ejecución

Ejemplo:

"daily"

status
enum<string>

Estado actual del contexto

Opciones disponibles:
DRAFT,
ACTIVE,
PAUSED,
ARCHIVED
Ejemplo:

"ACTIVE"

feeToleranceAbs
string

Monto de tolerancia de tarifa absoluta

Ejemplo:

"0.50"

feeTolerancePct
string

Tolerancia de tarifa en porcentaje

Ejemplo:

"0.01"

feeNormalization
enum<string>

Modo de normalización de tarifas

Opciones disponibles:
NET,
GROSS
Ejemplo:

"NET"

autoMatchOnUpload
boolean

Si la conciliación se activa automáticamente tras la carga de archivos

Ejemplo:

false

createdAt
string

Marca de tiempo de creación en formato RFC3339

Ejemplo:

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

updatedAt
string

Marca de tiempo de última actualización en formato RFC3339

Ejemplo:

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