API reference

Accounting API Reference

OpenAPI 3.1, authentication, webhooks, and MCP. Post a first journal in the sandbox, then browse the live spec.

First journal in five minutes

Three steps from zero to a balanced journal in the sandbox ledger. No billing, no sales call.

  1. 01

    Get sandbox credentials

    Self-serve signup. Your workspace issues a client_id and client_secret — exchange them for an access token (OAuth 2.0).

  2. 02

    Post a balanced journal

    Debits must equal credits or the API rejects the entry before it reaches the ledger.

  3. 03

    Read it back

    The journal is live in the general ledger, trial balance, and reports immediately.

Want the five-minute walkthrough with a copy-paste curl? Open the five-minute guide

Want the twenty-minute loop with invoices and payments? Build embedded accounting in 20 minutes

Write authentication: API-credential writes also send x-data-signature. App Connect writes use x-partner-domain instead. See the complete contract.

POST /v1/accounting/journals
export PAPREL_API_BASE="https://api-sandbox.paprel.com"
export ACCESS_TOKEN="..."

curl "$PAPREL_API_BASE/v1/accounting/journals" \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer $ACCESS_TOKEN' \
  --header 'x-data-signature: $DATA_SIGNATURE' \
  --data '{
    "currency": "USD",
    "date": "2026-06-11",
    "description": "Initial journal",
    "lines": [
      { "account_code": "1010", "debit": "100.00", "credit": null },
      { "account_code": "4000", "debit": null, "credit": "100.00" }
    ],
    "posted": true,
    "reference": "INIT-001"
  }'
Response
{
  "data": {
    "journal": {
      "id": "journal_...",
      "identifier": "JRN-2026-0001",
      "currency": "USD",
      "is_posted": true,
      "is_locked": false
    }
  }
}
Environment
Sandbox

api-sandbox.paprel.com

API version
v1.1.0

Current contract

OpenAPI
3.1.0

JSON download

Authentication
OAuth 2.0

Tenant-scoped bearer tokens

The full API surface

260 operations across the accounting lifecycle

One OpenAPI 3.1 spec (v1.1.0) covers the ledger, receivables, payables, and the platform controls around them. Use the spec to generate SDKs in any language, browse the interactive reference below, or jump to what you need.

See how these surfaces connect to payments, banks, email, and AI agents on the integrations page.

Loading API specification

OpenAPI 3.1 — large spec, this can take a few seconds.

Evaluate in sandbox

Post a journal before you commit a design

Self-serve keys, no billing. The five-minute guide is the shortest proof; the OpenAPI spec on this page is the contract.

Architecture review? Talk to the team