Preview transaction field mapping
curl --request POST \
--url https://api.synci.io/api/v2/finance/accounts/{accountId}/mapping-preview \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"map_fields": {},
"limit": 10,
"page": 1
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({map_fields: {}, limit: 10, page: 1})
};
fetch('https://api.synci.io/api/v2/finance/accounts/{accountId}/mapping-preview', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.synci.io/api/v2/finance/accounts/{accountId}/mapping-preview"
payload = {
"map_fields": {},
"limit": 10,
"page": 1
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.synci.io/api/v2/finance/accounts/{accountId}/mapping-preview",
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([
'map_fields' => [
],
'limit' => 10,
'page' => 1
]),
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://api.synci.io/api/v2/finance/accounts/{accountId}/mapping-preview"
payload := strings.NewReader("{\n \"map_fields\": {},\n \"limit\": 10,\n \"page\": 1\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))
}{
"data": {
"transactions": [
{
"id": 123,
"amount": "<string>",
"currency": "<string>",
"booked": true,
"booking_date": "<unknown>",
"value_date": "<unknown>",
"mapped_fields": {
"payee": "<unknown>",
"description": "<unknown>",
"date": "<unknown>"
},
"fields": {}
}
],
"map_fields": {
"payee": [
"<string>"
],
"description": [
"<string>"
],
"date": [
"<string>"
]
},
"meta": {
"current_page": 123,
"per_page": 123,
"total": 123,
"last_page": 123
}
}
}{
"message": "<string>"
}{
"message": "<string>"
}{
"message": "<string>"
}{
"message": "<string>",
"errors": {}
}Preview transaction field mapping
Shows how the account’s most recent transactions read under a map_fields configuration, without
saving it. Each field given is tried in place of the account’s saved chain; a field left out keeps
the saved one, so an empty body previews the current mapping. Alongside the mapped payee,
description and date, every raw field the chains may name is returned with the value it holds on
that transaction, so a client can show where a mapped value came from. Overrides a rule has stored
on a transaction apply here as they do everywhere else.
POST
/
finance
/
accounts
/
{accountId}
/
mapping-preview
Preview transaction field mapping
curl --request POST \
--url https://api.synci.io/api/v2/finance/accounts/{accountId}/mapping-preview \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"map_fields": {},
"limit": 10,
"page": 1
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({map_fields: {}, limit: 10, page: 1})
};
fetch('https://api.synci.io/api/v2/finance/accounts/{accountId}/mapping-preview', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.synci.io/api/v2/finance/accounts/{accountId}/mapping-preview"
payload = {
"map_fields": {},
"limit": 10,
"page": 1
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.synci.io/api/v2/finance/accounts/{accountId}/mapping-preview",
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([
'map_fields' => [
],
'limit' => 10,
'page' => 1
]),
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://api.synci.io/api/v2/finance/accounts/{accountId}/mapping-preview"
payload := strings.NewReader("{\n \"map_fields\": {},\n \"limit\": 10,\n \"page\": 1\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))
}{
"data": {
"transactions": [
{
"id": 123,
"amount": "<string>",
"currency": "<string>",
"booked": true,
"booking_date": "<unknown>",
"value_date": "<unknown>",
"mapped_fields": {
"payee": "<unknown>",
"description": "<unknown>",
"date": "<unknown>"
},
"fields": {}
}
],
"map_fields": {
"payee": [
"<string>"
],
"description": [
"<string>"
],
"date": [
"<string>"
]
},
"meta": {
"current_page": 123,
"per_page": 123,
"total": 123,
"last_page": 123
}
}
}{
"message": "<string>"
}{
"message": "<string>"
}{
"message": "<string>"
}{
"message": "<string>",
"errors": {}
}Authorizations
oauth2http
The access token received from the authorization server in the OAuth 2.0 flow.
Path Parameters
The financial account ID
Body
application/json
Response
Show child attributes
Show child attributes