Criar um contexto de conciliação

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

import requests

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

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

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

print(response.text)

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

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

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://matcher.sandbox.lerian.net/v1/contexts",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => 'Bank Reconciliation Q1',
    'type' => '1:1',
    'interval' => 'daily',
    'feeToleranceAbs' => '0.01',
    'feeTolerancePct' => '0.5',
    'feeNormalization' => 'NET',
    'autoMatchOnUpload' => false,
    'sources' => [
        [
                'name' => 'Primary Bank Account',
                'type' => 'BANK',
                'side' => 'LEFT',
                'config' => [
                                
                ],
                'mapping' => [
                                
                ]
        ]
    ],
    'rules' => [
        [
                'priority' => 1,
                'type' => 'EXACT',
                'config' => [
                                
                ]
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

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

	payload := strings.NewReader("{\n  \"name\": \"Bank Reconciliation Q1\",\n  \"type\": \"1:1\",\n  \"interval\": \"daily\",\n  \"feeToleranceAbs\": \"0.01\",\n  \"feeTolerancePct\": \"0.5\",\n  \"feeNormalization\": \"NET\",\n  \"autoMatchOnUpload\": false,\n  \"sources\": [\n    {\n      \"name\": \"Primary Bank Account\",\n      \"type\": \"BANK\",\n      \"side\": \"LEFT\",\n      \"config\": {},\n      \"mapping\": {}\n    }\n  ],\n  \"rules\": [\n    {\n      \"priority\": 1,\n      \"type\": \"EXACT\",\n      \"config\": {}\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))

}

HttpResponse<String> response = Unirest.post("https://matcher.sandbox.lerian.net/v1/contexts")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"Bank Reconciliation Q1\",\n  \"type\": \"1:1\",\n  \"interval\": \"daily\",\n  \"feeToleranceAbs\": \"0.01\",\n  \"feeTolerancePct\": \"0.5\",\n  \"feeNormalization\": \"NET\",\n  \"autoMatchOnUpload\": false,\n  \"sources\": [\n    {\n      \"name\": \"Primary Bank Account\",\n      \"type\": \"BANK\",\n      \"side\": \"LEFT\",\n      \"config\": {},\n      \"mapping\": {}\n    }\n  ],\n  \"rules\": [\n    {\n      \"priority\": 1,\n      \"type\": \"EXACT\",\n      \"config\": {}\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

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

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"Bank Reconciliation Q1\",\n  \"type\": \"1:1\",\n  \"interval\": \"daily\",\n  \"feeToleranceAbs\": \"0.01\",\n  \"feeTolerancePct\": \"0.5\",\n  \"feeNormalization\": \"NET\",\n  \"autoMatchOnUpload\": false,\n  \"sources\": [\n    {\n      \"name\": \"Primary Bank Account\",\n      \"type\": \"BANK\",\n      \"side\": \"LEFT\",\n      \"config\": {},\n      \"mapping\": {}\n    }\n  ],\n  \"rules\": [\n    {\n      \"priority\": 1,\n      \"type\": \"EXACT\",\n      \"config\": {}\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "id": "019c96a0-10a0-72d2-9fb0-2b7de8093182",
  "tenantId": "019c96a0-0a98-7287-9a31-786e0809c769",
  "name": "Bank Reconciliation Q1",
  "type": "1:1",
  "interval": "daily",
  "status": "ACTIVE",
  "feeToleranceAbs": "0.50",
  "feeTolerancePct": "0.01",
  "feeNormalization": "NET",
  "autoMatchOnUpload": false,
  "createdAt": "2025-01-15T10:30:00.000Z",
  "updatedAt": "2025-01-15T10:30:00.000Z"
}

{
  "code": "MTCH-0001",
  "title": "Bad Request",
  "message": "context not found",
  "error": "<string>",
  "details": {}
}

{
  "code": "MTCH-0001",
  "title": "Bad Request",
  "message": "context not found",
  "error": "<string>",
  "details": {}
}

{
  "code": "MTCH-0001",
  "title": "Bad Request",
  "message": "context not found",
  "error": "<string>",
  "details": {}
}

{
  "code": "MTCH-0001",
  "title": "Bad Request",
  "message": "context not found",
  "error": "<string>",
  "details": {}
}

{
  "code": "MTCH-0002",
  "title": "Internal Server Error",
  "message": "internal server error"
}

POST

contexts

Criar um contexto de conciliação

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

import requests

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

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

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

print(response.text)

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

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

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://matcher.sandbox.lerian.net/v1/contexts",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => 'Bank Reconciliation Q1',
    'type' => '1:1',
    'interval' => 'daily',
    'feeToleranceAbs' => '0.01',
    'feeTolerancePct' => '0.5',
    'feeNormalization' => 'NET',
    'autoMatchOnUpload' => false,
    'sources' => [
        [
                'name' => 'Primary Bank Account',
                'type' => 'BANK',
                'side' => 'LEFT',
                'config' => [
                                
                ],
                'mapping' => [
                                
                ]
        ]
    ],
    'rules' => [
        [
                'priority' => 1,
                'type' => 'EXACT',
                'config' => [
                                
                ]
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

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

	payload := strings.NewReader("{\n  \"name\": \"Bank Reconciliation Q1\",\n  \"type\": \"1:1\",\n  \"interval\": \"daily\",\n  \"feeToleranceAbs\": \"0.01\",\n  \"feeTolerancePct\": \"0.5\",\n  \"feeNormalization\": \"NET\",\n  \"autoMatchOnUpload\": false,\n  \"sources\": [\n    {\n      \"name\": \"Primary Bank Account\",\n      \"type\": \"BANK\",\n      \"side\": \"LEFT\",\n      \"config\": {},\n      \"mapping\": {}\n    }\n  ],\n  \"rules\": [\n    {\n      \"priority\": 1,\n      \"type\": \"EXACT\",\n      \"config\": {}\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))

}

HttpResponse<String> response = Unirest.post("https://matcher.sandbox.lerian.net/v1/contexts")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"Bank Reconciliation Q1\",\n  \"type\": \"1:1\",\n  \"interval\": \"daily\",\n  \"feeToleranceAbs\": \"0.01\",\n  \"feeTolerancePct\": \"0.5\",\n  \"feeNormalization\": \"NET\",\n  \"autoMatchOnUpload\": false,\n  \"sources\": [\n    {\n      \"name\": \"Primary Bank Account\",\n      \"type\": \"BANK\",\n      \"side\": \"LEFT\",\n      \"config\": {},\n      \"mapping\": {}\n    }\n  ],\n  \"rules\": [\n    {\n      \"priority\": 1,\n      \"type\": \"EXACT\",\n      \"config\": {}\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

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

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"Bank Reconciliation Q1\",\n  \"type\": \"1:1\",\n  \"interval\": \"daily\",\n  \"feeToleranceAbs\": \"0.01\",\n  \"feeTolerancePct\": \"0.5\",\n  \"feeNormalization\": \"NET\",\n  \"autoMatchOnUpload\": false,\n  \"sources\": [\n    {\n      \"name\": \"Primary Bank Account\",\n      \"type\": \"BANK\",\n      \"side\": \"LEFT\",\n      \"config\": {},\n      \"mapping\": {}\n    }\n  ],\n  \"rules\": [\n    {\n      \"priority\": 1,\n      \"type\": \"EXACT\",\n      \"config\": {}\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "id": "019c96a0-10a0-72d2-9fb0-2b7de8093182",
  "tenantId": "019c96a0-0a98-7287-9a31-786e0809c769",
  "name": "Bank Reconciliation Q1",
  "type": "1:1",
  "interval": "daily",
  "status": "ACTIVE",
  "feeToleranceAbs": "0.50",
  "feeTolerancePct": "0.01",
  "feeNormalization": "NET",
  "autoMatchOnUpload": false,
  "createdAt": "2025-01-15T10:30:00.000Z",
  "updatedAt": "2025-01-15T10:30:00.000Z"
}

{
  "code": "MTCH-0001",
  "title": "Bad Request",
  "message": "context not found",
  "error": "<string>",
  "details": {}
}

{
  "code": "MTCH-0001",
  "title": "Bad Request",
  "message": "context not found",
  "error": "<string>",
  "details": {}
}

{
  "code": "MTCH-0001",
  "title": "Bad Request",
  "message": "context not found",
  "error": "<string>",
  "details": {}
}

{
  "code": "MTCH-0001",
  "title": "Bad Request",
  "message": "context not found",
  "error": "<string>",
  "details": {}
}

{
  "code": "MTCH-0002",
  "title": "Internal Server Error",
  "message": "internal server error"
}

Autorizações

Authorization

string

header

obrigatório

Autenticação por Bearer token (formato: "Bearer {token}")

Cabeçalhos

X-Request-Id

string

A unique identifier for tracing the request across services.

X-Idempotency-Key

string

Chave de idempotência opcional para novas tentativas seguras. Também aceita Idempotency-Key como nome alternativo do cabeçalho. Se a mesma chave for enviada novamente e a requisição original já tiver sido processada, a resposta em cache é retornada com X-Idempotency-Replayed: true.

Consulte Novas tentativas e idempotência para mais detalhes.

Corpo

application/json

Payload de criação do contexto

name

string

obrigatório

Required string length: 1 - 100

Exemplo:

"Bank Reconciliation Q1"

type

enum<string>

obrigatório

Topologia de conciliação (cardinalidade entre fontes)

Opções disponíveis:

1:1,

1:N,

N:M

Exemplo:

"1:1"

interval

string

obrigatório

Required string length: 1 - 100

Exemplo:

"daily"

feeToleranceAbs

string

Valor absoluto de tolerância de tarifa

Exemplo:

"0.01"

feeTolerancePct

string

Tolerância de tarifa percentual

Exemplo:

"0.5"

feeNormalization

enum<string>

Modo de normalização de tarifas

Opções disponíveis:

NET,

GROSS

Exemplo:

"NET"

autoMatchOnUpload

boolean

Se a conciliação deve ser disparada automaticamente após o upload de arquivo

Exemplo:

false

sources

object[]

Lista opcional de fontes a criar junto com o contexto

Maximum array length: 10

Show child attributes

rules

object[]

Lista opcional de regras de conciliação a criar junto com o contexto

Maximum array length: 50

Show child attributes

Resposta

Contexto criado com sucesso.

A resposta inclui o cabeçalho X-Idempotency-Replayed.

Se o valor for false, a requisição acabou de ser processada. Se o valor for true, a resposta é uma reprodução de uma requisição processada anteriormente.

Consulte Retentativas e idempotência para mais detalhes.

Contexto de configuração para regras de conciliação

string

Identificador único do contexto

Exemplo:

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

tenantId

string

ID do tenant ao qual este contexto pertence

Exemplo:

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

name

string

Nome do contexto de conciliação

Exemplo:

"Bank Reconciliation Q1"

type

enum<string>

Tipo de topologia de conciliação

Opções disponíveis:

1:1,

1:N,

N:M

Exemplo:

"1:1"

interval

string

Intervalo de execução

Exemplo:

"daily"

status

enum<string>

Status atual do contexto

Opções disponíveis:

DRAFT,

ACTIVE,

PAUSED,

ARCHIVED

Exemplo:

"ACTIVE"

feeToleranceAbs

string

Valor absoluto de tolerância de tarifa

Exemplo:

"0.50"

feeTolerancePct

string

Tolerância de tarifa percentual

Exemplo:

"0.01"

feeNormalization

enum<string>

Modo de normalização de tarifas

Opções disponíveis:

NET,

GROSS

Exemplo:

"NET"

autoMatchOnUpload

boolean

Se a conciliação é disparada automaticamente após o upload de arquivo

Exemplo:

false

createdAt

string

Timestamp de criação no formato RFC3339

Exemplo:

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

updatedAt

string

Timestamp da última atualização no formato RFC3339

Exemplo:

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

Listar contextos de conciliação

Obter um contexto de conciliação

⌘I

Primeiros passos

API de Contextos de Configuração

API de Regras de Matching

API de Fontes de Dados

API de Mapeamento de Campos

API de Tabelas de Tarifas

API de Configuração de Regras de Tarifas

API de Agendamentos

Fluxo de exceções

Ações em massa

Comentários

Credenciais de callback

API de Disputas

API de Jobs de Exportação

API de Governança

Jobs de ingestão

Layouts e formatos

Revisões de extração

Extração de documentos

Execuções de matching

Matching manual e ajustes

Candidatos e itens em aberto

Sugestões de regras

Painel e métricas

Relatórios

Exportações

Status da descoberta

Conexões de descoberta

Extrações

Conexões de agregadores

Webhooks de agregadores

Tratamento de erros

Criar um contexto de conciliação

Autorizações

Cabeçalhos

Corpo

Resposta