Save user's settings
curl --request PUT \
--url https://app.herondata.io/api/users/current/settings \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"balance_sheet_categories": {
"current_assets": {},
"current_liabilities": {},
"equity": {},
"fixed_assets": {},
"non_current_liabilities": {},
"other_assets": {}
},
"disable_data_export": true,
"financials_metrics": {},
"industry_naics_enabled": true,
"low_balance_days_threshold": 123,
"pnl_categories": {
"cogs": {},
"income": {},
"operating_expenses": {},
"other_expenses": {},
"other_income": {}
},
"query_reports": [
{
"tab_group": "<string>",
"tabs": [
{
"tab_name": "<string>",
"widgets": [
{
"query_name": "<string>",
"title": "<string>",
"description": "<string>"
}
]
}
]
}
],
"required_revenue_per_month": 123,
"restricted_industries": [
{
"description": "<string>",
"name": "<string>"
}
],
"transactions_review_enabled": true,
"use_new_company_layout": true,
"use_new_end_user_summary_table": true,
"use_new_end_user_table": true
}
'import requests
url = "https://app.herondata.io/api/users/current/settings"
payload = {
"balance_sheet_categories": {
"current_assets": {},
"current_liabilities": {},
"equity": {},
"fixed_assets": {},
"non_current_liabilities": {},
"other_assets": {}
},
"disable_data_export": True,
"financials_metrics": {},
"industry_naics_enabled": True,
"low_balance_days_threshold": 123,
"pnl_categories": {
"cogs": {},
"income": {},
"operating_expenses": {},
"other_expenses": {},
"other_income": {}
},
"query_reports": [
{
"tab_group": "<string>",
"tabs": [
{
"tab_name": "<string>",
"widgets": [
{
"query_name": "<string>",
"title": "<string>",
"description": "<string>"
}
]
}
]
}
],
"required_revenue_per_month": 123,
"restricted_industries": [
{
"description": "<string>",
"name": "<string>"
}
],
"transactions_review_enabled": True,
"use_new_company_layout": True,
"use_new_end_user_summary_table": True,
"use_new_end_user_table": True
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
balance_sheet_categories: {
current_assets: {},
current_liabilities: {},
equity: {},
fixed_assets: {},
non_current_liabilities: {},
other_assets: {}
},
disable_data_export: true,
financials_metrics: {},
industry_naics_enabled: true,
low_balance_days_threshold: 123,
pnl_categories: {
cogs: {},
income: {},
operating_expenses: {},
other_expenses: {},
other_income: {}
},
query_reports: [
{
tab_group: '<string>',
tabs: [
{
tab_name: '<string>',
widgets: [{query_name: '<string>', title: '<string>', description: '<string>'}]
}
]
}
],
required_revenue_per_month: 123,
restricted_industries: [{description: '<string>', name: '<string>'}],
transactions_review_enabled: true,
use_new_company_layout: true,
use_new_end_user_summary_table: true,
use_new_end_user_table: true
})
};
fetch('https://app.herondata.io/api/users/current/settings', 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://app.herondata.io/api/users/current/settings",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'balance_sheet_categories' => [
'current_assets' => [
],
'current_liabilities' => [
],
'equity' => [
],
'fixed_assets' => [
],
'non_current_liabilities' => [
],
'other_assets' => [
]
],
'disable_data_export' => true,
'financials_metrics' => [
],
'industry_naics_enabled' => true,
'low_balance_days_threshold' => 123,
'pnl_categories' => [
'cogs' => [
],
'income' => [
],
'operating_expenses' => [
],
'other_expenses' => [
],
'other_income' => [
]
],
'query_reports' => [
[
'tab_group' => '<string>',
'tabs' => [
[
'tab_name' => '<string>',
'widgets' => [
[
'query_name' => '<string>',
'title' => '<string>',
'description' => '<string>'
]
]
]
]
]
],
'required_revenue_per_month' => 123,
'restricted_industries' => [
[
'description' => '<string>',
'name' => '<string>'
]
],
'transactions_review_enabled' => true,
'use_new_company_layout' => true,
'use_new_end_user_summary_table' => true,
'use_new_end_user_table' => true
]),
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://app.herondata.io/api/users/current/settings"
payload := strings.NewReader("{\n \"balance_sheet_categories\": {\n \"current_assets\": {},\n \"current_liabilities\": {},\n \"equity\": {},\n \"fixed_assets\": {},\n \"non_current_liabilities\": {},\n \"other_assets\": {}\n },\n \"disable_data_export\": true,\n \"financials_metrics\": {},\n \"industry_naics_enabled\": true,\n \"low_balance_days_threshold\": 123,\n \"pnl_categories\": {\n \"cogs\": {},\n \"income\": {},\n \"operating_expenses\": {},\n \"other_expenses\": {},\n \"other_income\": {}\n },\n \"query_reports\": [\n {\n \"tab_group\": \"<string>\",\n \"tabs\": [\n {\n \"tab_name\": \"<string>\",\n \"widgets\": [\n {\n \"query_name\": \"<string>\",\n \"title\": \"<string>\",\n \"description\": \"<string>\"\n }\n ]\n }\n ]\n }\n ],\n \"required_revenue_per_month\": 123,\n \"restricted_industries\": [\n {\n \"description\": \"<string>\",\n \"name\": \"<string>\"\n }\n ],\n \"transactions_review_enabled\": true,\n \"use_new_company_layout\": true,\n \"use_new_end_user_summary_table\": true,\n \"use_new_end_user_table\": true\n}")
req, _ := http.NewRequest("PUT", 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.put("https://app.herondata.io/api/users/current/settings")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"balance_sheet_categories\": {\n \"current_assets\": {},\n \"current_liabilities\": {},\n \"equity\": {},\n \"fixed_assets\": {},\n \"non_current_liabilities\": {},\n \"other_assets\": {}\n },\n \"disable_data_export\": true,\n \"financials_metrics\": {},\n \"industry_naics_enabled\": true,\n \"low_balance_days_threshold\": 123,\n \"pnl_categories\": {\n \"cogs\": {},\n \"income\": {},\n \"operating_expenses\": {},\n \"other_expenses\": {},\n \"other_income\": {}\n },\n \"query_reports\": [\n {\n \"tab_group\": \"<string>\",\n \"tabs\": [\n {\n \"tab_name\": \"<string>\",\n \"widgets\": [\n {\n \"query_name\": \"<string>\",\n \"title\": \"<string>\",\n \"description\": \"<string>\"\n }\n ]\n }\n ]\n }\n ],\n \"required_revenue_per_month\": 123,\n \"restricted_industries\": [\n {\n \"description\": \"<string>\",\n \"name\": \"<string>\"\n }\n ],\n \"transactions_review_enabled\": true,\n \"use_new_company_layout\": true,\n \"use_new_end_user_summary_table\": true,\n \"use_new_end_user_table\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.herondata.io/api/users/current/settings")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"balance_sheet_categories\": {\n \"current_assets\": {},\n \"current_liabilities\": {},\n \"equity\": {},\n \"fixed_assets\": {},\n \"non_current_liabilities\": {},\n \"other_assets\": {}\n },\n \"disable_data_export\": true,\n \"financials_metrics\": {},\n \"industry_naics_enabled\": true,\n \"low_balance_days_threshold\": 123,\n \"pnl_categories\": {\n \"cogs\": {},\n \"income\": {},\n \"operating_expenses\": {},\n \"other_expenses\": {},\n \"other_income\": {}\n },\n \"query_reports\": [\n {\n \"tab_group\": \"<string>\",\n \"tabs\": [\n {\n \"tab_name\": \"<string>\",\n \"widgets\": [\n {\n \"query_name\": \"<string>\",\n \"title\": \"<string>\",\n \"description\": \"<string>\"\n }\n ]\n }\n ]\n }\n ],\n \"required_revenue_per_month\": 123,\n \"restricted_industries\": [\n {\n \"description\": \"<string>\",\n \"name\": \"<string>\"\n }\n ],\n \"transactions_review_enabled\": true,\n \"use_new_company_layout\": true,\n \"use_new_end_user_summary_table\": true,\n \"use_new_end_user_table\": true\n}"
response = http.request(request)
puts response.read_bodyUsers
Save user's settings
PUT
/
api
/
users
/
current
/
settings
Save user's settings
curl --request PUT \
--url https://app.herondata.io/api/users/current/settings \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"balance_sheet_categories": {
"current_assets": {},
"current_liabilities": {},
"equity": {},
"fixed_assets": {},
"non_current_liabilities": {},
"other_assets": {}
},
"disable_data_export": true,
"financials_metrics": {},
"industry_naics_enabled": true,
"low_balance_days_threshold": 123,
"pnl_categories": {
"cogs": {},
"income": {},
"operating_expenses": {},
"other_expenses": {},
"other_income": {}
},
"query_reports": [
{
"tab_group": "<string>",
"tabs": [
{
"tab_name": "<string>",
"widgets": [
{
"query_name": "<string>",
"title": "<string>",
"description": "<string>"
}
]
}
]
}
],
"required_revenue_per_month": 123,
"restricted_industries": [
{
"description": "<string>",
"name": "<string>"
}
],
"transactions_review_enabled": true,
"use_new_company_layout": true,
"use_new_end_user_summary_table": true,
"use_new_end_user_table": true
}
'import requests
url = "https://app.herondata.io/api/users/current/settings"
payload = {
"balance_sheet_categories": {
"current_assets": {},
"current_liabilities": {},
"equity": {},
"fixed_assets": {},
"non_current_liabilities": {},
"other_assets": {}
},
"disable_data_export": True,
"financials_metrics": {},
"industry_naics_enabled": True,
"low_balance_days_threshold": 123,
"pnl_categories": {
"cogs": {},
"income": {},
"operating_expenses": {},
"other_expenses": {},
"other_income": {}
},
"query_reports": [
{
"tab_group": "<string>",
"tabs": [
{
"tab_name": "<string>",
"widgets": [
{
"query_name": "<string>",
"title": "<string>",
"description": "<string>"
}
]
}
]
}
],
"required_revenue_per_month": 123,
"restricted_industries": [
{
"description": "<string>",
"name": "<string>"
}
],
"transactions_review_enabled": True,
"use_new_company_layout": True,
"use_new_end_user_summary_table": True,
"use_new_end_user_table": True
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
balance_sheet_categories: {
current_assets: {},
current_liabilities: {},
equity: {},
fixed_assets: {},
non_current_liabilities: {},
other_assets: {}
},
disable_data_export: true,
financials_metrics: {},
industry_naics_enabled: true,
low_balance_days_threshold: 123,
pnl_categories: {
cogs: {},
income: {},
operating_expenses: {},
other_expenses: {},
other_income: {}
},
query_reports: [
{
tab_group: '<string>',
tabs: [
{
tab_name: '<string>',
widgets: [{query_name: '<string>', title: '<string>', description: '<string>'}]
}
]
}
],
required_revenue_per_month: 123,
restricted_industries: [{description: '<string>', name: '<string>'}],
transactions_review_enabled: true,
use_new_company_layout: true,
use_new_end_user_summary_table: true,
use_new_end_user_table: true
})
};
fetch('https://app.herondata.io/api/users/current/settings', 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://app.herondata.io/api/users/current/settings",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'balance_sheet_categories' => [
'current_assets' => [
],
'current_liabilities' => [
],
'equity' => [
],
'fixed_assets' => [
],
'non_current_liabilities' => [
],
'other_assets' => [
]
],
'disable_data_export' => true,
'financials_metrics' => [
],
'industry_naics_enabled' => true,
'low_balance_days_threshold' => 123,
'pnl_categories' => [
'cogs' => [
],
'income' => [
],
'operating_expenses' => [
],
'other_expenses' => [
],
'other_income' => [
]
],
'query_reports' => [
[
'tab_group' => '<string>',
'tabs' => [
[
'tab_name' => '<string>',
'widgets' => [
[
'query_name' => '<string>',
'title' => '<string>',
'description' => '<string>'
]
]
]
]
]
],
'required_revenue_per_month' => 123,
'restricted_industries' => [
[
'description' => '<string>',
'name' => '<string>'
]
],
'transactions_review_enabled' => true,
'use_new_company_layout' => true,
'use_new_end_user_summary_table' => true,
'use_new_end_user_table' => true
]),
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://app.herondata.io/api/users/current/settings"
payload := strings.NewReader("{\n \"balance_sheet_categories\": {\n \"current_assets\": {},\n \"current_liabilities\": {},\n \"equity\": {},\n \"fixed_assets\": {},\n \"non_current_liabilities\": {},\n \"other_assets\": {}\n },\n \"disable_data_export\": true,\n \"financials_metrics\": {},\n \"industry_naics_enabled\": true,\n \"low_balance_days_threshold\": 123,\n \"pnl_categories\": {\n \"cogs\": {},\n \"income\": {},\n \"operating_expenses\": {},\n \"other_expenses\": {},\n \"other_income\": {}\n },\n \"query_reports\": [\n {\n \"tab_group\": \"<string>\",\n \"tabs\": [\n {\n \"tab_name\": \"<string>\",\n \"widgets\": [\n {\n \"query_name\": \"<string>\",\n \"title\": \"<string>\",\n \"description\": \"<string>\"\n }\n ]\n }\n ]\n }\n ],\n \"required_revenue_per_month\": 123,\n \"restricted_industries\": [\n {\n \"description\": \"<string>\",\n \"name\": \"<string>\"\n }\n ],\n \"transactions_review_enabled\": true,\n \"use_new_company_layout\": true,\n \"use_new_end_user_summary_table\": true,\n \"use_new_end_user_table\": true\n}")
req, _ := http.NewRequest("PUT", 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.put("https://app.herondata.io/api/users/current/settings")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"balance_sheet_categories\": {\n \"current_assets\": {},\n \"current_liabilities\": {},\n \"equity\": {},\n \"fixed_assets\": {},\n \"non_current_liabilities\": {},\n \"other_assets\": {}\n },\n \"disable_data_export\": true,\n \"financials_metrics\": {},\n \"industry_naics_enabled\": true,\n \"low_balance_days_threshold\": 123,\n \"pnl_categories\": {\n \"cogs\": {},\n \"income\": {},\n \"operating_expenses\": {},\n \"other_expenses\": {},\n \"other_income\": {}\n },\n \"query_reports\": [\n {\n \"tab_group\": \"<string>\",\n \"tabs\": [\n {\n \"tab_name\": \"<string>\",\n \"widgets\": [\n {\n \"query_name\": \"<string>\",\n \"title\": \"<string>\",\n \"description\": \"<string>\"\n }\n ]\n }\n ]\n }\n ],\n \"required_revenue_per_month\": 123,\n \"restricted_industries\": [\n {\n \"description\": \"<string>\",\n \"name\": \"<string>\"\n }\n ],\n \"transactions_review_enabled\": true,\n \"use_new_company_layout\": true,\n \"use_new_end_user_summary_table\": true,\n \"use_new_end_user_table\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.herondata.io/api/users/current/settings")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"balance_sheet_categories\": {\n \"current_assets\": {},\n \"current_liabilities\": {},\n \"equity\": {},\n \"fixed_assets\": {},\n \"non_current_liabilities\": {},\n \"other_assets\": {}\n },\n \"disable_data_export\": true,\n \"financials_metrics\": {},\n \"industry_naics_enabled\": true,\n \"low_balance_days_threshold\": 123,\n \"pnl_categories\": {\n \"cogs\": {},\n \"income\": {},\n \"operating_expenses\": {},\n \"other_expenses\": {},\n \"other_income\": {}\n },\n \"query_reports\": [\n {\n \"tab_group\": \"<string>\",\n \"tabs\": [\n {\n \"tab_name\": \"<string>\",\n \"widgets\": [\n {\n \"query_name\": \"<string>\",\n \"title\": \"<string>\",\n \"description\": \"<string>\"\n }\n ]\n }\n ]\n }\n ],\n \"required_revenue_per_month\": 123,\n \"restricted_industries\": [\n {\n \"description\": \"<string>\",\n \"name\": \"<string>\"\n }\n ],\n \"transactions_review_enabled\": true,\n \"use_new_company_layout\": true,\n \"use_new_end_user_summary_table\": true,\n \"use_new_end_user_table\": true\n}"
response = http.request(request)
puts response.read_bodyAuthorizations
Body
application/json
The new settings
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Response
204
OK
Was this page helpful?
⌘I