Create Journal

curl --request POST \
  --url https://api.fidly.be/journals \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "code": "<string>",
  "category": "<string>",
  "is_default": false,
  "active": true,
  "start_number": 123,
  "numbering_format": "{code}-{year4}-{seq:5}",
  "sequence_scope": "never",
  "bank_account_id": "<string>"
}
'

import requests

url = "https://api.fidly.be/journals"

payload = {
    "name": "<string>",
    "code": "<string>",
    "category": "<string>",
    "is_default": False,
    "active": True,
    "start_number": 123,
    "numbering_format": "{code}-{year4}-{seq:5}",
    "sequence_scope": "never",
    "bank_account_id": "<string>"
}
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: '<string>',
    code: '<string>',
    category: '<string>',
    is_default: false,
    active: true,
    start_number: 123,
    numbering_format: '{code}-{year4}-{seq:5}',
    sequence_scope: 'never',
    bank_account_id: '<string>'
  })
};

fetch('https://api.fidly.be/journals', 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.fidly.be/journals",
  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' => '<string>',
    'code' => '<string>',
    'category' => '<string>',
    'is_default' => false,
    'active' => true,
    'start_number' => 123,
    'numbering_format' => '{code}-{year4}-{seq:5}',
    'sequence_scope' => 'never',
    'bank_account_id' => '<string>'
  ]),
  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.fidly.be/journals"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"code\": \"<string>\",\n  \"category\": \"<string>\",\n  \"is_default\": false,\n  \"active\": true,\n  \"start_number\": 123,\n  \"numbering_format\": \"{code}-{year4}-{seq:5}\",\n  \"sequence_scope\": \"never\",\n  \"bank_account_id\": \"<string>\"\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://api.fidly.be/journals")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"code\": \"<string>\",\n  \"category\": \"<string>\",\n  \"is_default\": false,\n  \"active\": true,\n  \"start_number\": 123,\n  \"numbering_format\": \"{code}-{year4}-{seq:5}\",\n  \"sequence_scope\": \"never\",\n  \"bank_account_id\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.fidly.be/journals")

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\": \"<string>\",\n  \"code\": \"<string>\",\n  \"category\": \"<string>\",\n  \"is_default\": false,\n  \"active\": true,\n  \"start_number\": 123,\n  \"numbering_format\": \"{code}-{year4}-{seq:5}\",\n  \"sequence_scope\": \"never\",\n  \"bank_account_id\": \"<string>\"\n}"

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

{
  "id": "<string>",
  "name": "<string>",
  "code": "<string>",
  "category": "<string>",
  "is_default": true,
  "active": true,
  "start_number": 123,
  "numbering_format": "<string>",
  "sequence_scope": "<string>",
  "bank_account_id": "<string>"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

journals

Create Journal

Create an accounting journal of the company.

code, category and sequence_scope are fixed at creation and cannot be changed later. Setting is_default demotes the previous default journal of the same category. A journal created as the default must be active (422 default_journal_required otherwise): it is the journal documents of its category are booked in when none is specified.

In sandbox mode the body is validated exactly as in live mode but nothing is stored, so the returned id is not resolvable.

POST

journals

Create Journal

curl --request POST \
  --url https://api.fidly.be/journals \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "code": "<string>",
  "category": "<string>",
  "is_default": false,
  "active": true,
  "start_number": 123,
  "numbering_format": "{code}-{year4}-{seq:5}",
  "sequence_scope": "never",
  "bank_account_id": "<string>"
}
'

import requests

url = "https://api.fidly.be/journals"

payload = {
    "name": "<string>",
    "code": "<string>",
    "category": "<string>",
    "is_default": False,
    "active": True,
    "start_number": 123,
    "numbering_format": "{code}-{year4}-{seq:5}",
    "sequence_scope": "never",
    "bank_account_id": "<string>"
}
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: '<string>',
    code: '<string>',
    category: '<string>',
    is_default: false,
    active: true,
    start_number: 123,
    numbering_format: '{code}-{year4}-{seq:5}',
    sequence_scope: 'never',
    bank_account_id: '<string>'
  })
};

fetch('https://api.fidly.be/journals', 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.fidly.be/journals",
  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' => '<string>',
    'code' => '<string>',
    'category' => '<string>',
    'is_default' => false,
    'active' => true,
    'start_number' => 123,
    'numbering_format' => '{code}-{year4}-{seq:5}',
    'sequence_scope' => 'never',
    'bank_account_id' => '<string>'
  ]),
  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.fidly.be/journals"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"code\": \"<string>\",\n  \"category\": \"<string>\",\n  \"is_default\": false,\n  \"active\": true,\n  \"start_number\": 123,\n  \"numbering_format\": \"{code}-{year4}-{seq:5}\",\n  \"sequence_scope\": \"never\",\n  \"bank_account_id\": \"<string>\"\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://api.fidly.be/journals")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"code\": \"<string>\",\n  \"category\": \"<string>\",\n  \"is_default\": false,\n  \"active\": true,\n  \"start_number\": 123,\n  \"numbering_format\": \"{code}-{year4}-{seq:5}\",\n  \"sequence_scope\": \"never\",\n  \"bank_account_id\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.fidly.be/journals")

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\": \"<string>\",\n  \"code\": \"<string>\",\n  \"category\": \"<string>\",\n  \"is_default\": false,\n  \"active\": true,\n  \"start_number\": 123,\n  \"numbering_format\": \"{code}-{year4}-{seq:5}\",\n  \"sequence_scope\": \"never\",\n  \"bank_account_id\": \"<string>\"\n}"

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

{
  "id": "<string>",
  "name": "<string>",
  "code": "<string>",
  "category": "<string>",
  "is_default": true,
  "active": true,
  "start_number": 123,
  "numbering_format": "<string>",
  "sequence_scope": "<string>",
  "bank_account_id": "<string>"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

A journal to create. name, code and category identify it; everything else has a default. code and category cannot be changed afterwards (they drive the numbering and the kind of document the journal holds), so choose them carefully here.

name

string

required

Name of the journal.

Required string length: 1 - 255

code

string

required

Short code, used as a prefix in the numbering. Must be unique within the company (case-insensitive): two journals sharing it would number two documents alike. Not editable afterwards.

Required string length: 1 - 45

Response

Successful Response

An accounting journal of the company, identified by an opaque id.

A journal groups documents of one kind and drives their numbering. bank_account_id only carries a value on the journals it applies to, and is null elsewhere.

string

required

Opaque unique identifier of the journal.

name

string | null

required

Name of the journal.

code

string | null

required

Short code of the journal, used as a prefix in the numbering.

auth

documents

relations

delivery locations

bank accounts

journals

brandings

reference

health

Create Journal

Authorizations

Body

Response