Create a reconciliation context

curl --request POST \
  --url https://matcher.sandbox.lerian.net/v1/contexts \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "interval": "daily",
  "name": "Bank Reconciliation Q1",
  "type": "1:1",
  "agedBreakCalendar": "BR_ANBIMA",
  "agedBreakThresholdDays": 30,
  "autoMatchOnUpload": false,
  "feeNormalization": "NET",
  "feeToleranceAbs": "0.01",
  "feeTolerancePct": "0.5",
  "rules": [
    {
      "config": {},
      "priority": 1,
      "type": "EXACT"
    }
  ],
  "signConvention": "SAME",
  "sources": [
    {
      "name": "Primary Bank Account",
      "side": "LEFT",
      "type": "BANK",
      "config": {
        "camt053": {},
        "dialect": {},
        "duplicate_key": [],
        "fail_on_error_rate_percent": 50
      },
      "mapping": {}
    }
  ]
}
'

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://matcher.sandbox.lerian.net/v1/contexts"

	payload := strings.NewReader("{\n  \"interval\": \"daily\",\n  \"name\": \"Bank Reconciliation Q1\",\n  \"type\": \"1:1\",\n  \"agedBreakCalendar\": \"BR_ANBIMA\",\n  \"agedBreakThresholdDays\": 30,\n  \"autoMatchOnUpload\": false,\n  \"feeNormalization\": \"NET\",\n  \"feeToleranceAbs\": \"0.01\",\n  \"feeTolerancePct\": \"0.5\",\n  \"rules\": [\n    {\n      \"config\": {},\n      \"priority\": 1,\n      \"type\": \"EXACT\"\n    }\n  ],\n  \"signConvention\": \"SAME\",\n  \"sources\": [\n    {\n      \"name\": \"Primary Bank Account\",\n      \"side\": \"LEFT\",\n      \"type\": \"BANK\",\n      \"config\": {\n        \"camt053\": {},\n        \"dialect\": {},\n        \"duplicate_key\": [],\n        \"fail_on_error_rate_percent\": 50\n      },\n      \"mapping\": {}\n    }\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    interval: 'daily',
    name: 'Bank Reconciliation Q1',
    type: '1:1',
    agedBreakCalendar: 'BR_ANBIMA',
    agedBreakThresholdDays: 30,
    autoMatchOnUpload: false,
    feeNormalization: 'NET',
    feeToleranceAbs: '0.01',
    feeTolerancePct: '0.5',
    rules: [{config: {}, priority: 1, type: 'EXACT'}],
    signConvention: 'SAME',
    sources: [
      {
        name: 'Primary Bank Account',
        side: 'LEFT',
        type: 'BANK',
        config: {camt053: {}, dialect: {}, duplicate_key: [], fail_on_error_rate_percent: 50},
        mapping: {}
      }
    ]
  })
};

fetch('https://matcher.sandbox.lerian.net/v1/contexts', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://matcher.sandbox.lerian.net/v1/contexts"

payload = {
    "interval": "daily",
    "name": "Bank Reconciliation Q1",
    "type": "1:1",
    "agedBreakCalendar": "BR_ANBIMA",
    "agedBreakThresholdDays": 30,
    "autoMatchOnUpload": False,
    "feeNormalization": "NET",
    "feeToleranceAbs": "0.01",
    "feeTolerancePct": "0.5",
    "rules": [
        {
            "config": {},
            "priority": 1,
            "type": "EXACT"
        }
    ],
    "signConvention": "SAME",
    "sources": [
        {
            "name": "Primary Bank Account",
            "side": "LEFT",
            "type": "BANK",
            "config": {
                "camt053": {},
                "dialect": {},
                "duplicate_key": [],
                "fail_on_error_rate_percent": 50
            },
            "mapping": {}
        }
    ]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "autoMatchOnUpload": false,
  "createdAt": "2025-01-15T10:30:00Z",
  "feeToleranceAbs": "0.50",
  "feeTolerancePct": "0.01",
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "interval": "daily",
  "name": "Bank Reconciliation Q1",
  "signConvention": "SAME",
  "status": "ACTIVE",
  "tenantId": "550e8400-e29b-41d4-a716-446655440000",
  "type": "1:1",
  "updatedAt": "2025-01-15T10:30:00Z",
  "agedBreakCalendar": "BR_ANBIMA",
  "agedBreakThresholdDays": 30,
  "feeNormalization": "NET"
}

POST

contexts

Create a reconciliation context

curl --request POST \
  --url https://matcher.sandbox.lerian.net/v1/contexts \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "interval": "daily",
  "name": "Bank Reconciliation Q1",
  "type": "1:1",
  "agedBreakCalendar": "BR_ANBIMA",
  "agedBreakThresholdDays": 30,
  "autoMatchOnUpload": false,
  "feeNormalization": "NET",
  "feeToleranceAbs": "0.01",
  "feeTolerancePct": "0.5",
  "rules": [
    {
      "config": {},
      "priority": 1,
      "type": "EXACT"
    }
  ],
  "signConvention": "SAME",
  "sources": [
    {
      "name": "Primary Bank Account",
      "side": "LEFT",
      "type": "BANK",
      "config": {
        "camt053": {},
        "dialect": {},
        "duplicate_key": [],
        "fail_on_error_rate_percent": 50
      },
      "mapping": {}
    }
  ]
}
'

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://matcher.sandbox.lerian.net/v1/contexts"

	payload := strings.NewReader("{\n  \"interval\": \"daily\",\n  \"name\": \"Bank Reconciliation Q1\",\n  \"type\": \"1:1\",\n  \"agedBreakCalendar\": \"BR_ANBIMA\",\n  \"agedBreakThresholdDays\": 30,\n  \"autoMatchOnUpload\": false,\n  \"feeNormalization\": \"NET\",\n  \"feeToleranceAbs\": \"0.01\",\n  \"feeTolerancePct\": \"0.5\",\n  \"rules\": [\n    {\n      \"config\": {},\n      \"priority\": 1,\n      \"type\": \"EXACT\"\n    }\n  ],\n  \"signConvention\": \"SAME\",\n  \"sources\": [\n    {\n      \"name\": \"Primary Bank Account\",\n      \"side\": \"LEFT\",\n      \"type\": \"BANK\",\n      \"config\": {\n        \"camt053\": {},\n        \"dialect\": {},\n        \"duplicate_key\": [],\n        \"fail_on_error_rate_percent\": 50\n      },\n      \"mapping\": {}\n    }\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    interval: 'daily',
    name: 'Bank Reconciliation Q1',
    type: '1:1',
    agedBreakCalendar: 'BR_ANBIMA',
    agedBreakThresholdDays: 30,
    autoMatchOnUpload: false,
    feeNormalization: 'NET',
    feeToleranceAbs: '0.01',
    feeTolerancePct: '0.5',
    rules: [{config: {}, priority: 1, type: 'EXACT'}],
    signConvention: 'SAME',
    sources: [
      {
        name: 'Primary Bank Account',
        side: 'LEFT',
        type: 'BANK',
        config: {camt053: {}, dialect: {}, duplicate_key: [], fail_on_error_rate_percent: 50},
        mapping: {}
      }
    ]
  })
};

fetch('https://matcher.sandbox.lerian.net/v1/contexts', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://matcher.sandbox.lerian.net/v1/contexts"

payload = {
    "interval": "daily",
    "name": "Bank Reconciliation Q1",
    "type": "1:1",
    "agedBreakCalendar": "BR_ANBIMA",
    "agedBreakThresholdDays": 30,
    "autoMatchOnUpload": False,
    "feeNormalization": "NET",
    "feeToleranceAbs": "0.01",
    "feeTolerancePct": "0.5",
    "rules": [
        {
            "config": {},
            "priority": 1,
            "type": "EXACT"
        }
    ],
    "signConvention": "SAME",
    "sources": [
        {
            "name": "Primary Bank Account",
            "side": "LEFT",
            "type": "BANK",
            "config": {
                "camt053": {},
                "dialect": {},
                "duplicate_key": [],
                "fail_on_error_rate_percent": 50
            },
            "mapping": {}
        }
    ]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "autoMatchOnUpload": false,
  "createdAt": "2025-01-15T10:30:00Z",
  "feeToleranceAbs": "0.50",
  "feeTolerancePct": "0.01",
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "interval": "daily",
  "name": "Bank Reconciliation Q1",
  "signConvention": "SAME",
  "status": "ACTIVE",
  "tenantId": "550e8400-e29b-41d4-a716-446655440000",
  "type": "1:1",
  "updatedAt": "2025-01-15T10:30:00Z",
  "agedBreakCalendar": "BR_ANBIMA",
  "agedBreakThresholdDays": 30,
  "feeNormalization": "NET"
}

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

string

Optional idempotency key for safe retries. Matcher reads the key only from this header, and only when you send one. A request that carries a key only in X-Idempotency-Key or Idempotency-Key is refused with 400 (MTCH-0015), and nothing is processed. If the same key is sent again and the original request was already processed, the stored response is returned with X-Idempotency-Replayed: true. A malformed key returns 400, a key whose first request is still in progress returns 409, and an idempotency storage failure returns 500. These refusals are problem documents.

Cuerpo

application/json

Context creation payload

interval

string

requerido

Execution interval label for the context (e.g. daily, weekly).

Required string length: 1 - 100

Ejemplo:

"daily"

name

string

requerido

Human-readable name of the reconciliation context.

Required string length: 1 - 100

Ejemplo:

"Bank Reconciliation Q1"

type

enum<string>

requerido

Reconciliation topology. 1:1 matches one left transaction to one right transaction; 1:N matches one transaction against many on the other side; N:M matches groups on both sides.

Opciones disponibles:

1:1,

1:N,

N:M

Ejemplo:

"1:1"

agedBreakCalendar

string

Business-day calendar the aging threshold is measured against (e.g. US_FED, BR_ANBIMA). Omit/empty measures the age in raw calendar days.

Ejemplo:

"BR_ANBIMA"

agedBreakThresholdDays

integer<int64>

Open-item aging SLA in business days. An open-item residual older than this surfaces as an AGED_BREAK exception during the match run. Omit to disable aging for the context.

Ejemplo:

30

autoMatchOnUpload

boolean

When true, a match run is triggered automatically after a file upload completes.

Ejemplo:

false

feeNormalization

enum<string>

Fee normalization mode. NET compares amounts after fees are deducted; GROSS compares amounts before fees.

Opciones disponibles:

NET,

GROSS

Ejemplo:

"NET"

feeToleranceAbs

string

Absolute fee tolerance as a decimal string in the context currency.

Ejemplo:

"0.01"

feeTolerancePct

string

Percentage fee tolerance as a decimal string (0.5 means 0.5%).

Ejemplo:

"0.5"

rules

object[] | null

Match rules to create inline with the context.

Maximum array length: 50

Show child attributes

signConvention

enum<string>

How this context's data carries sign. SAME: a payment carries the same sign as what it settles, so a negative amount is a reversal. OPPOSITE: a payment carries the opposite sign of the invoice it settles. Defaults to SAME. In 1:N contexts only payments of the declared sign are allocated to an invoice, and in N:M contexts a short-paid invoice keeps an open balance only when it is positive under SAME, or when the rule's sign mode is opposite under OPPOSITE; any other short payment stays unmatched; a carried open balance settles on a payment of the declared sign or on a reversal from the invoice's own side, and a row from an archived source stays unmatched. It cannot change once the context has carried a partial balance, or while a match run is in progress.

Opciones disponibles:

SAME,

OPPOSITE

Ejemplo:

"SAME"

sources

object[] | null

Sources to create inline with the context.

Maximum array length: 10

Show child attributes

Respuesta

Successfully created context.

autoMatchOnUpload

boolean

requerido

When true, a match run is triggered automatically after a file upload completes.

Ejemplo:

false

createdAt

string

requerido

Creation timestamp in RFC 3339 format.

Ejemplo:

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

feeToleranceAbs

string

requerido

Absolute fee tolerance as a decimal string in the context currency.

Ejemplo:

"0.50"

feeTolerancePct

string

requerido

Percentage fee tolerance as a decimal string (0.01 means 0.01%).

Ejemplo:

"0.01"

string

requerido

Unique identifier of the context.

Ejemplo:

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

interval

string

requerido

Execution interval label for the context (e.g. daily, weekly).

Ejemplo:

"daily"

name

string

requerido

Human-readable name of the reconciliation context.

Ejemplo:

"Bank Reconciliation Q1"

signConvention

enum<string>

requerido

How this context's data carries sign. SAME: a payment carries the same sign as what it settles, so a negative amount is a reversal. OPPOSITE: a payment carries the opposite sign of the invoice it settles. In 1:N contexts only payments of the declared sign are allocated to an invoice, and in N:M contexts a short-paid invoice keeps an open balance only when it is positive under SAME, or when the rule's sign mode is opposite under OPPOSITE; any other short payment stays unmatched; a carried open balance settles on a payment of the declared sign or on a reversal from the invoice's own side, and a row from an archived source stays unmatched. It cannot change once the context has carried a partial balance, or while a match run is in progress.

Opciones disponibles:

SAME,

OPPOSITE

Ejemplo:

"SAME"

status

enum<string>

requerido

Lifecycle status. DRAFT is being configured; ACTIVE runs; PAUSED is suspended; ARCHIVED is retired.

Opciones disponibles:

DRAFT,

ACTIVE,

PAUSED,

ARCHIVED

Ejemplo:

"ACTIVE"

tenantId

string

requerido

Identifier of the tenant that owns the context.

Ejemplo:

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

type

enum<string>

requerido

Reconciliation topology. 1:1 matches one left transaction to one right transaction; 1:N matches one transaction against many on the other side; N:M matches groups on both sides.

Opciones disponibles:

1:1,

1:N,

N:M

Ejemplo:

"1:1"

updatedAt

string

requerido

Last update timestamp in RFC 3339 format.

Ejemplo:

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

agedBreakCalendar

string

Business-day calendar the aging threshold is measured against. Absent/empty means raw calendar days.

Ejemplo:

"BR_ANBIMA"

agedBreakThresholdDays

integer<int64>

Open-item aging SLA in business days. An open-item residual older than this surfaces as an AGED_BREAK exception. Absent when aging is disabled for the context.

Ejemplo:

30

feeNormalization

enum<string>

Fee normalization mode. NET compares amounts after fees are deducted; GROSS compares amounts before fees.

Opciones disponibles:

NET,

GROSS

Ejemplo:

"NET"

Primeros pasos

API de Contextos de Configuración

API de Reglas de Coincidencia

API de Fuentes de Datos

API de Mapeo de Campos

API de Tablas de Tarifas

API de Configuración de Reglas de Tarifas

API de Programaciones

Flujo de excepciones

Acciones masivas

Comentarios

Credenciales de callback

API de Disputas

API de Trabajos de Exportación

API de Gobernanza

Trabajos de ingestión

Diseños y formatos

Revisiones de extracción

Extracción de documentos

Ejecuciones de coincidencia

Coincidencia manual y ajustes

Candidatos y partidas abiertas

Sugerencias de reglas

Panel y métricas

Informes

Exportaciones

Estado del descubrimiento

Conexiones de descubrimiento

Extracciones

Conexiones de agregadores

Webhooks de agregadores

Manejo de errores

Eventos

Create a reconciliation context

Autorizaciones

Encabezados

Cuerpo

Respuesta