API Reference

1
const headers = {
2
  Authorization: "Bearer your-api-token",
3
  "X-Company-ID": "your-company-id",
4
  "Content-Type": "application/json",
5
};

1
import { useAccounts } from "@openledger/accounting-react";
2
3
function AccountList() {
4
  const {
5
    accounts,
6
    isLoading,
7
    error,
8
    fetchAccounts,
9
    createAccount,
10
    updateAccount,
11
  } = useAccounts({
12
    type: "asset",
13
    includeBalance: true,
14
  });
15
16
  // Use the accounts data and methods
17
}

1
import { useTransactions } from "@openledger/accounting-react";
2
3
function TransactionList() {
4
  const {
5
    transactions,
6
    isLoading,
7
    error,
8
    fetchTransactions,
9
    createTransaction,
10
    updateTransaction,
11
  } = useTransactions({
12
    accountId: "acc_123",
13
    dateRange: {
14
      start: "2024-01-01",
15
      end: "2024-12-31",
16
    },
17
  });
18
19
  // Use the transactions data and methods
20
}

1
import { useReports } from "@openledger/accounting-react";
2
3
function FinancialReports() {
4
  const {
5
    balanceSheet,
6
    incomeStatement,
7
    isLoading,
8
    error,
9
    generateBalanceSheet,
10
    generateIncomeStatement,
11
  } = useReports({
12
    asOf: "2024-12-31",
13
    currency: "USD",
14
  });
15
16
  // Use the reports data and methods
17
}

1
interface Account {
2
  id: string;
3
  name: string;
4
  type: AccountType;
5
  balance: string;
6
  currency: string;
7
  parent_id: string | null;
8
  created_at: string;
9
  updated_at: string;
10
}
11
12
type AccountType = "asset" | "liability" | "equity" | "revenue" | "expense";
13
14
interface AccountCreateParams {
15
  name: string;
16
  type: AccountType;
17
  currency: string;
18
  parent_id?: string;
19
}

1
interface Transaction {
2
  id: string;
3
  date: string;
4
  description: string;
5
  currency: string;
6
  status: TransactionStatus;
7
  entries: TransactionEntry[];
8
  metadata?: Record<string, any>;
9
  created_at: string;
10
  updated_at: string;
11
}
12
13
interface TransactionEntry {
14
  account_id: string;
15
  amount: string;
16
  type: "debit" | "credit";
17
  description?: string;
18
}
19
20
type TransactionStatus = "draft" | "posted" | "pending" | "void";

1
interface BalanceSheet {
2
  as_of: string;
3
  currency: string;
4
  assets: AccountBalance[];
5
  liabilities: AccountBalance[];
6
  equity: AccountBalance[];
7
  total_assets: string;
8
  total_liabilities: string;
9
  total_equity: string;
10
}
11
12
interface IncomeStatement {
13
  from_date: string;
14
  to_date: string;
15
  currency: string;
16
  revenue: AccountBalance[];
17
  expenses: AccountBalance[];
18
  net_income: string;
19
}
20
21
interface AccountBalance {
22
  account_id: string;
23
  name: string;
24
  balance: string;
25
  children?: AccountBalance[];
26
}