Account ledger (transaction history for a GL account)

curl --request GET \
  --url https://api.arcuserp.com/v1/reports/account-ledger \
  --header 'Authorization: Bearer <token>'

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

fetch('https://api.arcuserp.com/v1/reports/account-ledger', 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.arcuserp.com/v1/reports/account-ledger",
  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.arcuserp.com/v1/reports/account-ledger"

	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.arcuserp.com/v1/reports/account-ledger")

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

{
  "account": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "entity_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "account_number": "<string>",
    "name": "<string>",
    "description": "<string>",
    "account_sub_type": "<string>",
    "is_header": true,
    "parent_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "is_system_account": true,
    "system_account_key": "<string>",
    "is_bank_account": true,
    "is_active": true,
    "tax_line_mapping": "<string>",
    "opening_balance": 123,
    "opening_balance_date": "2023-12-25",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  },
  "opening_balance": 123,
  "closing_balance": 123,
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "entry_date": "2023-12-25",
      "description": "<string>",
      "debit": 123,
      "credit": 123,
      "running_balance": 123,
      "journal_entry_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    }
  ]
}

{
  "error": "not_found",
  "code": "not_found",
  "type": "not_found",
  "hint": "The requested order does not exist or does not belong to this entity.",
  "param": "expand[0]",
  "required": "accounts:read",
  "request_id": "req_abc123"
}

{
  "error": "not_found",
  "code": "not_found",
  "type": "not_found",
  "hint": "The requested order does not exist or does not belong to this entity.",
  "param": "expand[0]",
  "required": "accounts:read",
  "request_id": "req_abc123"
}

{
  "error": "not_found",
  "code": "not_found",
  "type": "not_found",
  "hint": "The requested order does not exist or does not belong to this entity.",
  "param": "expand[0]",
  "required": "accounts:read",
  "request_id": "req_abc123"
}

GET

reports

account-ledger

Account ledger (transaction history for a GL account)

curl --request GET \
  --url https://api.arcuserp.com/v1/reports/account-ledger \
  --header 'Authorization: Bearer <token>'

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

fetch('https://api.arcuserp.com/v1/reports/account-ledger', 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.arcuserp.com/v1/reports/account-ledger",
  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.arcuserp.com/v1/reports/account-ledger"

	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.arcuserp.com/v1/reports/account-ledger")

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

{
  "account": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "entity_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "account_number": "<string>",
    "name": "<string>",
    "description": "<string>",
    "account_sub_type": "<string>",
    "is_header": true,
    "parent_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "is_system_account": true,
    "system_account_key": "<string>",
    "is_bank_account": true,
    "is_active": true,
    "tax_line_mapping": "<string>",
    "opening_balance": 123,
    "opening_balance_date": "2023-12-25",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  },
  "opening_balance": 123,
  "closing_balance": 123,
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "entry_date": "2023-12-25",
      "description": "<string>",
      "debit": 123,
      "credit": 123,
      "running_balance": 123,
      "journal_entry_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    }
  ]
}

{
  "error": "not_found",
  "code": "not_found",
  "type": "not_found",
  "hint": "The requested order does not exist or does not belong to this entity.",
  "param": "expand[0]",
  "required": "accounts:read",
  "request_id": "req_abc123"
}

{
  "error": "not_found",
  "code": "not_found",
  "type": "not_found",
  "hint": "The requested order does not exist or does not belong to this entity.",
  "param": "expand[0]",
  "required": "accounts:read",
  "request_id": "req_abc123"
}

{
  "error": "not_found",
  "code": "not_found",
  "type": "not_found",
  "hint": "The requested order does not exist or does not belong to this entity.",
  "param": "expand[0]",
  "required": "accounts:read",
  "request_id": "req_abc123"
}

Authorizations

Authorization

string

header

required

API key issued per entity via Settings > Developers > API Keys. Each key carries scopes (e.g. orders:read, products:write). Bearer token format: Authorization: Bearer ark_live_ent_Test keys use ark_test_ent_. Both are issued per entity via Settings > Developers > API Keys.

Query Parameters

account_id

string<uuid>

required

GL account to retrieve ledger for (required)

from_date

string<date>

to_date

string<date>

period_id

string<uuid>

page

integer

default:1

Required range: x >= 1

per_page

integer

default:50

Required range: 1 <= x <= 100

Response

Account ledger with running balance

account

object

A General Ledger account in the chart of accounts. Header accounts (is_header=true) aggregate child accounts and cannot receive postings (Rule A2 / Rule 21). Leaf accounts (is_header=false, is_active=true) are the only valid targets for journal entry lines. System accounts (is_system_account=true) are provisioned by entity-seed-helpers.mjs and cannot be created or modified via the API.

Show child attributes

opening_balance

number

closing_balance

number

data

object[]

Show child attributes

Cash flow statement Accounts receivable aging report

Overview

All Endpoints

Account ledger (transaction history for a GL account)

Authorizations

Query Parameters

Response