Org journal settings
Create or update organisation journal settings
Create or update the organisation-level journal defaults.
PUT
/
org-journal-settings
Create or update organisation journal settings
curl --request PUT \
--url https://api.sandbox.flowpayroll.ai/v1/journal/org-journal-settings \
--header 'Content-Type: application/json' \
--header 'X-Auth-Token: <api-key>' \
--header 'X-Org-Id: <api-key>' \
--data '
{
"pdfOptions": {
"orientation": "<string>",
"brandingTitle": "<string>",
"dateFormat": "<string>",
"narrationTemplate": "<string>",
"columns": [
"<string>"
],
"includeTotalsRow": true,
"referenceFormat": "<string>",
"columnHeaders": {},
"grouped": true,
"trackingTransfersAccountCode": "<string>",
"accountNames": {}
},
"csvOptions": {
"dateFormat": "<string>",
"signedAmount": true,
"columns": [
"<string>"
],
"includeTotalsRow": true,
"referenceFormat": "<string>",
"columnHeaders": {},
"trackingTransfersAccountCode": "<string>",
"accountNames": {},
"xeroDepartmentInDescription": true,
"unsplitLabel": "<string>"
},
"csvPresetKey": "<string>",
"pdfPresetKey": "<string>"
}
'import requests
url = "https://api.sandbox.flowpayroll.ai/v1/journal/org-journal-settings"
payload = {
"pdfOptions": {
"orientation": "<string>",
"brandingTitle": "<string>",
"dateFormat": "<string>",
"narrationTemplate": "<string>",
"columns": ["<string>"],
"includeTotalsRow": True,
"referenceFormat": "<string>",
"columnHeaders": {},
"grouped": True,
"trackingTransfersAccountCode": "<string>",
"accountNames": {}
},
"csvOptions": {
"dateFormat": "<string>",
"signedAmount": True,
"columns": ["<string>"],
"includeTotalsRow": True,
"referenceFormat": "<string>",
"columnHeaders": {},
"trackingTransfersAccountCode": "<string>",
"accountNames": {},
"xeroDepartmentInDescription": True,
"unsplitLabel": "<string>"
},
"csvPresetKey": "<string>",
"pdfPresetKey": "<string>"
}
headers = {
"X-Auth-Token": "<api-key>",
"X-Org-Id": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {
'X-Auth-Token': '<api-key>',
'X-Org-Id': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
pdfOptions: {
orientation: '<string>',
brandingTitle: '<string>',
dateFormat: '<string>',
narrationTemplate: '<string>',
columns: ['<string>'],
includeTotalsRow: true,
referenceFormat: '<string>',
columnHeaders: {},
grouped: true,
trackingTransfersAccountCode: '<string>',
accountNames: {}
},
csvOptions: {
dateFormat: '<string>',
signedAmount: true,
columns: ['<string>'],
includeTotalsRow: true,
referenceFormat: '<string>',
columnHeaders: {},
trackingTransfersAccountCode: '<string>',
accountNames: {},
xeroDepartmentInDescription: true,
unsplitLabel: '<string>'
},
csvPresetKey: '<string>',
pdfPresetKey: '<string>'
})
};
fetch('https://api.sandbox.flowpayroll.ai/v1/journal/org-journal-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://api.sandbox.flowpayroll.ai/v1/journal/org-journal-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([
'pdfOptions' => [
'orientation' => '<string>',
'brandingTitle' => '<string>',
'dateFormat' => '<string>',
'narrationTemplate' => '<string>',
'columns' => [
'<string>'
],
'includeTotalsRow' => true,
'referenceFormat' => '<string>',
'columnHeaders' => [
],
'grouped' => true,
'trackingTransfersAccountCode' => '<string>',
'accountNames' => [
]
],
'csvOptions' => [
'dateFormat' => '<string>',
'signedAmount' => true,
'columns' => [
'<string>'
],
'includeTotalsRow' => true,
'referenceFormat' => '<string>',
'columnHeaders' => [
],
'trackingTransfersAccountCode' => '<string>',
'accountNames' => [
],
'xeroDepartmentInDescription' => true,
'unsplitLabel' => '<string>'
],
'csvPresetKey' => '<string>',
'pdfPresetKey' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Auth-Token: <api-key>",
"X-Org-Id: <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.sandbox.flowpayroll.ai/v1/journal/org-journal-settings"
payload := strings.NewReader("{\n \"pdfOptions\": {\n \"orientation\": \"<string>\",\n \"brandingTitle\": \"<string>\",\n \"dateFormat\": \"<string>\",\n \"narrationTemplate\": \"<string>\",\n \"columns\": [\n \"<string>\"\n ],\n \"includeTotalsRow\": true,\n \"referenceFormat\": \"<string>\",\n \"columnHeaders\": {},\n \"grouped\": true,\n \"trackingTransfersAccountCode\": \"<string>\",\n \"accountNames\": {}\n },\n \"csvOptions\": {\n \"dateFormat\": \"<string>\",\n \"signedAmount\": true,\n \"columns\": [\n \"<string>\"\n ],\n \"includeTotalsRow\": true,\n \"referenceFormat\": \"<string>\",\n \"columnHeaders\": {},\n \"trackingTransfersAccountCode\": \"<string>\",\n \"accountNames\": {},\n \"xeroDepartmentInDescription\": true,\n \"unsplitLabel\": \"<string>\"\n },\n \"csvPresetKey\": \"<string>\",\n \"pdfPresetKey\": \"<string>\"\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("X-Auth-Token", "<api-key>")
req.Header.Add("X-Org-Id", "<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://api.sandbox.flowpayroll.ai/v1/journal/org-journal-settings")
.header("X-Auth-Token", "<api-key>")
.header("X-Org-Id", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"pdfOptions\": {\n \"orientation\": \"<string>\",\n \"brandingTitle\": \"<string>\",\n \"dateFormat\": \"<string>\",\n \"narrationTemplate\": \"<string>\",\n \"columns\": [\n \"<string>\"\n ],\n \"includeTotalsRow\": true,\n \"referenceFormat\": \"<string>\",\n \"columnHeaders\": {},\n \"grouped\": true,\n \"trackingTransfersAccountCode\": \"<string>\",\n \"accountNames\": {}\n },\n \"csvOptions\": {\n \"dateFormat\": \"<string>\",\n \"signedAmount\": true,\n \"columns\": [\n \"<string>\"\n ],\n \"includeTotalsRow\": true,\n \"referenceFormat\": \"<string>\",\n \"columnHeaders\": {},\n \"trackingTransfersAccountCode\": \"<string>\",\n \"accountNames\": {},\n \"xeroDepartmentInDescription\": true,\n \"unsplitLabel\": \"<string>\"\n },\n \"csvPresetKey\": \"<string>\",\n \"pdfPresetKey\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sandbox.flowpayroll.ai/v1/journal/org-journal-settings")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["X-Auth-Token"] = '<api-key>'
request["X-Org-Id"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"pdfOptions\": {\n \"orientation\": \"<string>\",\n \"brandingTitle\": \"<string>\",\n \"dateFormat\": \"<string>\",\n \"narrationTemplate\": \"<string>\",\n \"columns\": [\n \"<string>\"\n ],\n \"includeTotalsRow\": true,\n \"referenceFormat\": \"<string>\",\n \"columnHeaders\": {},\n \"grouped\": true,\n \"trackingTransfersAccountCode\": \"<string>\",\n \"accountNames\": {}\n },\n \"csvOptions\": {\n \"dateFormat\": \"<string>\",\n \"signedAmount\": true,\n \"columns\": [\n \"<string>\"\n ],\n \"includeTotalsRow\": true,\n \"referenceFormat\": \"<string>\",\n \"columnHeaders\": {},\n \"trackingTransfersAccountCode\": \"<string>\",\n \"accountNames\": {},\n \"xeroDepartmentInDescription\": true,\n \"unsplitLabel\": \"<string>\"\n },\n \"csvPresetKey\": \"<string>\",\n \"pdfPresetKey\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"message": {
"text": "<string>",
"token": "<string>",
"tokenArguments": [
{
"name": "<string>",
"value": null
}
]
},
"content": {
"data": {
"organisationId": "<string>",
"pdfOptions": {
"orientation": "<string>",
"brandingTitle": "<string>",
"dateFormat": "<string>",
"narrationTemplate": "<string>",
"columns": [
"<string>"
],
"includeTotalsRow": true,
"referenceFormat": "<string>",
"columnHeaders": {},
"grouped": true,
"trackingTransfersAccountCode": "<string>",
"accountNames": {}
},
"csvOptions": {
"dateFormat": "<string>",
"signedAmount": true,
"columns": [
"<string>"
],
"includeTotalsRow": true,
"referenceFormat": "<string>",
"columnHeaders": {},
"trackingTransfersAccountCode": "<string>",
"accountNames": {},
"xeroDepartmentInDescription": true,
"unsplitLabel": "<string>"
},
"createdBy": "<string>",
"createdDate": "<string>",
"updatedBy": "<string>",
"updatedDate": "<string>",
"csvPresetKey": "<string>",
"pdfPresetKey": "<string>"
},
"metadata": {
"dateFormat": "<string>",
"dateTimeFormat": "<string>",
"paginationToken": "<string>"
}
},
"validationIssues": [
{
"field": "<string>",
"reason": "<string>",
"reasonToken": "<string>",
"reasonTokenArguments": [
{
"name": "<string>",
"value": null
}
]
}
]
}{
"message": {
"text": "<string>",
"token": "<string>",
"tokenArguments": [
{
"name": "<string>",
"value": null
}
]
},
"content": {
"data": null,
"metadata": {
"dateFormat": "<string>",
"dateTimeFormat": "<string>",
"paginationToken": "<string>"
}
},
"validationIssues": [
{
"field": "<string>",
"reason": "<string>",
"reasonToken": "<string>",
"reasonTokenArguments": [
{
"name": "<string>",
"value": null
}
]
}
]
}Authorizations
FlowPayroll JWT (raw token, no Bearer prefix)
Organisation to scope the request to. Required when the principal can access more than one organisation; optional for single-organisation principals (the authorizer resolves it automatically).
Body
application/json
Was this page helpful?
⌘I
Create or update organisation journal settings
curl --request PUT \
--url https://api.sandbox.flowpayroll.ai/v1/journal/org-journal-settings \
--header 'Content-Type: application/json' \
--header 'X-Auth-Token: <api-key>' \
--header 'X-Org-Id: <api-key>' \
--data '
{
"pdfOptions": {
"orientation": "<string>",
"brandingTitle": "<string>",
"dateFormat": "<string>",
"narrationTemplate": "<string>",
"columns": [
"<string>"
],
"includeTotalsRow": true,
"referenceFormat": "<string>",
"columnHeaders": {},
"grouped": true,
"trackingTransfersAccountCode": "<string>",
"accountNames": {}
},
"csvOptions": {
"dateFormat": "<string>",
"signedAmount": true,
"columns": [
"<string>"
],
"includeTotalsRow": true,
"referenceFormat": "<string>",
"columnHeaders": {},
"trackingTransfersAccountCode": "<string>",
"accountNames": {},
"xeroDepartmentInDescription": true,
"unsplitLabel": "<string>"
},
"csvPresetKey": "<string>",
"pdfPresetKey": "<string>"
}
'import requests
url = "https://api.sandbox.flowpayroll.ai/v1/journal/org-journal-settings"
payload = {
"pdfOptions": {
"orientation": "<string>",
"brandingTitle": "<string>",
"dateFormat": "<string>",
"narrationTemplate": "<string>",
"columns": ["<string>"],
"includeTotalsRow": True,
"referenceFormat": "<string>",
"columnHeaders": {},
"grouped": True,
"trackingTransfersAccountCode": "<string>",
"accountNames": {}
},
"csvOptions": {
"dateFormat": "<string>",
"signedAmount": True,
"columns": ["<string>"],
"includeTotalsRow": True,
"referenceFormat": "<string>",
"columnHeaders": {},
"trackingTransfersAccountCode": "<string>",
"accountNames": {},
"xeroDepartmentInDescription": True,
"unsplitLabel": "<string>"
},
"csvPresetKey": "<string>",
"pdfPresetKey": "<string>"
}
headers = {
"X-Auth-Token": "<api-key>",
"X-Org-Id": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {
'X-Auth-Token': '<api-key>',
'X-Org-Id': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
pdfOptions: {
orientation: '<string>',
brandingTitle: '<string>',
dateFormat: '<string>',
narrationTemplate: '<string>',
columns: ['<string>'],
includeTotalsRow: true,
referenceFormat: '<string>',
columnHeaders: {},
grouped: true,
trackingTransfersAccountCode: '<string>',
accountNames: {}
},
csvOptions: {
dateFormat: '<string>',
signedAmount: true,
columns: ['<string>'],
includeTotalsRow: true,
referenceFormat: '<string>',
columnHeaders: {},
trackingTransfersAccountCode: '<string>',
accountNames: {},
xeroDepartmentInDescription: true,
unsplitLabel: '<string>'
},
csvPresetKey: '<string>',
pdfPresetKey: '<string>'
})
};
fetch('https://api.sandbox.flowpayroll.ai/v1/journal/org-journal-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://api.sandbox.flowpayroll.ai/v1/journal/org-journal-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([
'pdfOptions' => [
'orientation' => '<string>',
'brandingTitle' => '<string>',
'dateFormat' => '<string>',
'narrationTemplate' => '<string>',
'columns' => [
'<string>'
],
'includeTotalsRow' => true,
'referenceFormat' => '<string>',
'columnHeaders' => [
],
'grouped' => true,
'trackingTransfersAccountCode' => '<string>',
'accountNames' => [
]
],
'csvOptions' => [
'dateFormat' => '<string>',
'signedAmount' => true,
'columns' => [
'<string>'
],
'includeTotalsRow' => true,
'referenceFormat' => '<string>',
'columnHeaders' => [
],
'trackingTransfersAccountCode' => '<string>',
'accountNames' => [
],
'xeroDepartmentInDescription' => true,
'unsplitLabel' => '<string>'
],
'csvPresetKey' => '<string>',
'pdfPresetKey' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Auth-Token: <api-key>",
"X-Org-Id: <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.sandbox.flowpayroll.ai/v1/journal/org-journal-settings"
payload := strings.NewReader("{\n \"pdfOptions\": {\n \"orientation\": \"<string>\",\n \"brandingTitle\": \"<string>\",\n \"dateFormat\": \"<string>\",\n \"narrationTemplate\": \"<string>\",\n \"columns\": [\n \"<string>\"\n ],\n \"includeTotalsRow\": true,\n \"referenceFormat\": \"<string>\",\n \"columnHeaders\": {},\n \"grouped\": true,\n \"trackingTransfersAccountCode\": \"<string>\",\n \"accountNames\": {}\n },\n \"csvOptions\": {\n \"dateFormat\": \"<string>\",\n \"signedAmount\": true,\n \"columns\": [\n \"<string>\"\n ],\n \"includeTotalsRow\": true,\n \"referenceFormat\": \"<string>\",\n \"columnHeaders\": {},\n \"trackingTransfersAccountCode\": \"<string>\",\n \"accountNames\": {},\n \"xeroDepartmentInDescription\": true,\n \"unsplitLabel\": \"<string>\"\n },\n \"csvPresetKey\": \"<string>\",\n \"pdfPresetKey\": \"<string>\"\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("X-Auth-Token", "<api-key>")
req.Header.Add("X-Org-Id", "<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://api.sandbox.flowpayroll.ai/v1/journal/org-journal-settings")
.header("X-Auth-Token", "<api-key>")
.header("X-Org-Id", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"pdfOptions\": {\n \"orientation\": \"<string>\",\n \"brandingTitle\": \"<string>\",\n \"dateFormat\": \"<string>\",\n \"narrationTemplate\": \"<string>\",\n \"columns\": [\n \"<string>\"\n ],\n \"includeTotalsRow\": true,\n \"referenceFormat\": \"<string>\",\n \"columnHeaders\": {},\n \"grouped\": true,\n \"trackingTransfersAccountCode\": \"<string>\",\n \"accountNames\": {}\n },\n \"csvOptions\": {\n \"dateFormat\": \"<string>\",\n \"signedAmount\": true,\n \"columns\": [\n \"<string>\"\n ],\n \"includeTotalsRow\": true,\n \"referenceFormat\": \"<string>\",\n \"columnHeaders\": {},\n \"trackingTransfersAccountCode\": \"<string>\",\n \"accountNames\": {},\n \"xeroDepartmentInDescription\": true,\n \"unsplitLabel\": \"<string>\"\n },\n \"csvPresetKey\": \"<string>\",\n \"pdfPresetKey\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sandbox.flowpayroll.ai/v1/journal/org-journal-settings")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["X-Auth-Token"] = '<api-key>'
request["X-Org-Id"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"pdfOptions\": {\n \"orientation\": \"<string>\",\n \"brandingTitle\": \"<string>\",\n \"dateFormat\": \"<string>\",\n \"narrationTemplate\": \"<string>\",\n \"columns\": [\n \"<string>\"\n ],\n \"includeTotalsRow\": true,\n \"referenceFormat\": \"<string>\",\n \"columnHeaders\": {},\n \"grouped\": true,\n \"trackingTransfersAccountCode\": \"<string>\",\n \"accountNames\": {}\n },\n \"csvOptions\": {\n \"dateFormat\": \"<string>\",\n \"signedAmount\": true,\n \"columns\": [\n \"<string>\"\n ],\n \"includeTotalsRow\": true,\n \"referenceFormat\": \"<string>\",\n \"columnHeaders\": {},\n \"trackingTransfersAccountCode\": \"<string>\",\n \"accountNames\": {},\n \"xeroDepartmentInDescription\": true,\n \"unsplitLabel\": \"<string>\"\n },\n \"csvPresetKey\": \"<string>\",\n \"pdfPresetKey\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"message": {
"text": "<string>",
"token": "<string>",
"tokenArguments": [
{
"name": "<string>",
"value": null
}
]
},
"content": {
"data": {
"organisationId": "<string>",
"pdfOptions": {
"orientation": "<string>",
"brandingTitle": "<string>",
"dateFormat": "<string>",
"narrationTemplate": "<string>",
"columns": [
"<string>"
],
"includeTotalsRow": true,
"referenceFormat": "<string>",
"columnHeaders": {},
"grouped": true,
"trackingTransfersAccountCode": "<string>",
"accountNames": {}
},
"csvOptions": {
"dateFormat": "<string>",
"signedAmount": true,
"columns": [
"<string>"
],
"includeTotalsRow": true,
"referenceFormat": "<string>",
"columnHeaders": {},
"trackingTransfersAccountCode": "<string>",
"accountNames": {},
"xeroDepartmentInDescription": true,
"unsplitLabel": "<string>"
},
"createdBy": "<string>",
"createdDate": "<string>",
"updatedBy": "<string>",
"updatedDate": "<string>",
"csvPresetKey": "<string>",
"pdfPresetKey": "<string>"
},
"metadata": {
"dateFormat": "<string>",
"dateTimeFormat": "<string>",
"paginationToken": "<string>"
}
},
"validationIssues": [
{
"field": "<string>",
"reason": "<string>",
"reasonToken": "<string>",
"reasonTokenArguments": [
{
"name": "<string>",
"value": null
}
]
}
]
}{
"message": {
"text": "<string>",
"token": "<string>",
"tokenArguments": [
{
"name": "<string>",
"value": null
}
]
},
"content": {
"data": null,
"metadata": {
"dateFormat": "<string>",
"dateTimeFormat": "<string>",
"paginationToken": "<string>"
}
},
"validationIssues": [
{
"field": "<string>",
"reason": "<string>",
"reasonToken": "<string>",
"reasonTokenArguments": [
{
"name": "<string>",
"value": null
}
]
}
]
}