Get ledger - Hyperline

GET

accounting

ledgers

{id}

Get ledger

curl --request GET \
  --url https://api.hyperline.co/v1/accounting/ledgers/{id} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.hyperline.co/v1/accounting/ledgers/{id}', 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.hyperline.co/v1/accounting/ledgers/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.hyperline.co/v1/accounting/ledgers/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.hyperline.co/v1/accounting/ledgers/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "id": "<string>",
  "name": "<string>",
  "code": "<string>",
  "description": "<string>",
  "type": "IFRS",
  "invoicing_entity_id": "<string>",
  "currency": "EUR",
  "fiscal_year_end_month": 12,
  "entry_number_pattern": "<string>",
  "next_entry_number": 123,
  "is_primary": true,
  "is_inactive": true,
  "closed_through_date": "2026-09-30",
  "created_at": "2023-12-25",
  "updated_at": "2023-12-25"
}

{
  "message": "<string>"
}

Authorizations

Authorization

string

header

required

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

Path Parameters

string

required

Query Parameters

invoicing_entity_id

string

Require the ledger to belong to this invoicing entity.

Response

string

required

Unique ledger identifier.

name

string

required

Display name of the ledger.

code

string | null

required

Accounting code of the ledger.

description

string | null

required

Optional ledger description.

type

enum<string>

required

Type of ledger.

Available options:

IFRS,

US_GAAP,

FR_GAAP,

UK_GAAP,

LOCAL_GAAP,

MANAGEMENT,

CONSOLIDATION,

AUDIT_ADJUSTMENT

invoicing_entity_id

string

required

Owning invoicing entity identifier.

currency

enum<string>

required

ISO 4217 ledger currency.

Available options:

EUR,

AED,

AFN,

XCD,

ALL,

AMD,

AOA,

ARS,

USD,

AUD,

AWG,

AZN,

BAM,

BBD,

BDT,

BGN,

BHD,

BIF,

XOF,

BMD,

BND,

BOB,

BRL,

BSD,

BTN,

NOK,

BWP,

BYR,

BZD,

CAD,

CDF,

XAF,

CHF,

NZD,

CLP,

CNY,

COP,

CRC,

CUP,

CVE,

ANG,

CZK,

DJF,

DKK,

DOP,

DZD,

EGP,

MAD,

ERN,

ETB,

FJD,

FKP,

GBP,

GEL,

GHS,

GIP,

GMD,

GNF,

GTQ,

GYD,

HKD,

HNL,

HRK,

HTG,

HUF,

IDR,

ILS,

INR,

IQD,

IRR,

ISK,

JMD,

JOD,

JPY,

KES,

KGS,

KHR,

KMF,

KPW,

KRW,

KWD,

KYD,

KZT,

LAK,

LBP,

LKR,

LRD,

LSL,

LYD,

MDL,

MGA,

MKD,

MMK,

MNT,

MOP,

MRO,

MUR,

MVR,

MWK,

MXN,

MYR,

MZN,

NAD,

XPF,

NGN,

NIO,

NPR,

OMR,

PAB,

PEN,

PGK,

PHP,

PKR,

PLN,

PYG,

QAR,

RON,

RSD,

RUB,

RWF,

SAR,

SBD,

SCR,

SDG,

SEK,

SGD,

SHP,

SLL,

SOS,

SRD,

SSP,

STD,

SYP,

SZL,

THB,

TJS,

TMT,

TND,

TOP,

TRY,

TTD,

TWD,

TZS,

UAH,

UGX,

UYU,

UZS,

VEF,

VND,

VUV,

WST,

YER,

ZAR,

ZMW,

ZWL

Example:

"EUR"

fiscal_year_end_month

integer

required

Last month of the ledger's fiscal year, from 1 (January) to 12 (December). Reports split profit between past fiscal years and the current one from it.

Required range: 1 <= x <= 12

Example:

12

entry_number_pattern

string

required

Pattern used to number journal entries.

next_entry_number

number

required

Next journal-entry sequence number.

is_primary

boolean | null

required

Whether this is the entity's primary ledger.

is_inactive

boolean | null

required

Whether the ledger is inactive.

closed_through_date

string<date> | null

required

Last day of the last closed month, formatted YYYY-MM-DD. No entry can be dated on or before the end of that day in the invoicing entity timezone. Null when no month is closed.

Example:

"2026-09-30"

created_at

string<date> | null

required

Timestamp when the ledger was created.

updated_at

string<date> | null

required

Timestamp when the ledger was last updated.

⌘I

Get ledger

curl --request GET \
  --url https://api.hyperline.co/v1/accounting/ledgers/{id} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.hyperline.co/v1/accounting/ledgers/{id}', 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.hyperline.co/v1/accounting/ledgers/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.hyperline.co/v1/accounting/ledgers/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.hyperline.co/v1/accounting/ledgers/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "id": "<string>",
  "name": "<string>",
  "code": "<string>",
  "description": "<string>",
  "type": "IFRS",
  "invoicing_entity_id": "<string>",
  "currency": "EUR",
  "fiscal_year_end_month": 12,
  "entry_number_pattern": "<string>",
  "next_entry_number": 123,
  "is_primary": true,
  "is_inactive": true,
  "closed_through_date": "2026-09-30",
  "created_at": "2023-12-25",
  "updated_at": "2023-12-25"
}

{
  "message": "<string>"
}