Endpoints
Create Entry Correction
Create or update a correction for an entry.
Supports two correction modes:
- Full replacement: Provide the complete corrected object in the
datafield. - Path-based patches: Provide a list of field-level patches, each with a JSON Pointer
pathand the newvalue.
You can also include notes to describe the reason for the correction.
POST
/
v3
/
entries
/
{entry_id}
/
correction
Create Entry Correction
curl --request POST \
--url https://api.matil.ai/v3/entries/{entry_id}/correction \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"title": "Full replacement",
"value": {
"data": {
"invoice_number": "INV-002",
"items": [
{
"desc": "Item 1",
"price": 100
}
],
"total": 100
},
"notes": "Fixed invoice number"
}
}
'import requests
url = "https://api.matil.ai/v3/entries/{entry_id}/correction"
payload = {
"title": "Full replacement",
"value": {
"data": {
"invoice_number": "INV-002",
"items": [
{
"desc": "Item 1",
"price": 100
}
],
"total": 100
},
"notes": "Fixed invoice number"
}
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
title: 'Full replacement',
value: {
data: {invoice_number: 'INV-002', items: [{desc: 'Item 1', price: 100}], total: 100},
notes: 'Fixed invoice number'
}
})
};
fetch('https://api.matil.ai/v3/entries/{entry_id}/correction', 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://api.matil.ai/v3/entries/{entry_id}/correction",
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([
'title' => 'Full replacement',
'value' => [
'data' => [
'invoice_number' => 'INV-002',
'items' => [
[
'desc' => 'Item 1',
'price' => 100
]
],
'total' => 100
],
'notes' => 'Fixed invoice number'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$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://api.matil.ai/v3/entries/{entry_id}/correction"
payload := strings.NewReader("{\n \"title\": \"Full replacement\",\n \"value\": {\n \"data\": {\n \"invoice_number\": \"INV-002\",\n \"items\": [\n {\n \"desc\": \"Item 1\",\n \"price\": 100\n }\n ],\n \"total\": 100\n },\n \"notes\": \"Fixed invoice number\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
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://api.matil.ai/v3/entries/{entry_id}/correction")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"title\": \"Full replacement\",\n \"value\": {\n \"data\": {\n \"invoice_number\": \"INV-002\",\n \"items\": [\n {\n \"desc\": \"Item 1\",\n \"price\": 100\n }\n ],\n \"total\": 100\n },\n \"notes\": \"Fixed invoice number\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.matil.ai/v3/entries/{entry_id}/correction")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"title\": \"Full replacement\",\n \"value\": {\n \"data\": {\n \"invoice_number\": \"INV-002\",\n \"items\": [\n {\n \"desc\": \"Item 1\",\n \"price\": 100\n }\n ],\n \"total\": 100\n },\n \"notes\": \"Fixed invoice number\"\n }\n}"
response = http.request(request)
puts response.read_body{
"entry_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"patches_applied": 123
}{
"error": "AUTHENTICATION_REQUIRED",
"message": "Authentication required. Provide a valid x-api-key header.",
"details": null
}{
"error": "ENTRY_NOT_FOUND",
"message": "Entry not found.",
"details": null
}{
"error": "VALIDATION_ERROR",
"message": "Provide either data or patches (at least one must be non-empty).",
"details": null
}Autorizaciones
Parámetros de ruta
Cuerpo
application/json
Schema for creating a correction.
Supports two correction modes:
- Full replacement: Provide complete corrected object in
data - Path-based patches: Provide list of field patches in
patches
Both can be used together: data provides the base, patches applies updates on top.
¿Esta página le ayudó?
⌘I
Create Entry Correction
curl --request POST \
--url https://api.matil.ai/v3/entries/{entry_id}/correction \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"title": "Full replacement",
"value": {
"data": {
"invoice_number": "INV-002",
"items": [
{
"desc": "Item 1",
"price": 100
}
],
"total": 100
},
"notes": "Fixed invoice number"
}
}
'import requests
url = "https://api.matil.ai/v3/entries/{entry_id}/correction"
payload = {
"title": "Full replacement",
"value": {
"data": {
"invoice_number": "INV-002",
"items": [
{
"desc": "Item 1",
"price": 100
}
],
"total": 100
},
"notes": "Fixed invoice number"
}
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
title: 'Full replacement',
value: {
data: {invoice_number: 'INV-002', items: [{desc: 'Item 1', price: 100}], total: 100},
notes: 'Fixed invoice number'
}
})
};
fetch('https://api.matil.ai/v3/entries/{entry_id}/correction', 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://api.matil.ai/v3/entries/{entry_id}/correction",
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([
'title' => 'Full replacement',
'value' => [
'data' => [
'invoice_number' => 'INV-002',
'items' => [
[
'desc' => 'Item 1',
'price' => 100
]
],
'total' => 100
],
'notes' => 'Fixed invoice number'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$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://api.matil.ai/v3/entries/{entry_id}/correction"
payload := strings.NewReader("{\n \"title\": \"Full replacement\",\n \"value\": {\n \"data\": {\n \"invoice_number\": \"INV-002\",\n \"items\": [\n {\n \"desc\": \"Item 1\",\n \"price\": 100\n }\n ],\n \"total\": 100\n },\n \"notes\": \"Fixed invoice number\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
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://api.matil.ai/v3/entries/{entry_id}/correction")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"title\": \"Full replacement\",\n \"value\": {\n \"data\": {\n \"invoice_number\": \"INV-002\",\n \"items\": [\n {\n \"desc\": \"Item 1\",\n \"price\": 100\n }\n ],\n \"total\": 100\n },\n \"notes\": \"Fixed invoice number\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.matil.ai/v3/entries/{entry_id}/correction")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"title\": \"Full replacement\",\n \"value\": {\n \"data\": {\n \"invoice_number\": \"INV-002\",\n \"items\": [\n {\n \"desc\": \"Item 1\",\n \"price\": 100\n }\n ],\n \"total\": 100\n },\n \"notes\": \"Fixed invoice number\"\n }\n}"
response = http.request(request)
puts response.read_body{
"entry_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"patches_applied": 123
}{
"error": "AUTHENTICATION_REQUIRED",
"message": "Authentication required. Provide a valid x-api-key header.",
"details": null
}{
"error": "ENTRY_NOT_FOUND",
"message": "Entry not found.",
"details": null
}{
"error": "VALIDATION_ERROR",
"message": "Provide either data or patches (at least one must be non-empty).",
"details": null
}