Skip to content

Journal Entries — Proposed Guide

Planned API — Reference Only

Journal Entries: A journal-draft proposal would group balanced debit and credit lines derived from authorized source records. Creating a draft is not…

Overview

A journal-draft proposal would group balanced debit and credit lines derived from authorized source records. Creating a draft is not posting it to a ledger.

Key concepts

Use explicit accounts, entity, currency and period. Compare total debits and credits in the same monetary unit.

Implementation considerations

Reject unbalanced drafts and undefined mappings. The example contains fictional accounting data and performs no posting or financial transaction.

Proposed API behavior

POST /v1/accounting/journal-drafts is an illustrative design for this topic. Path and field names may change before implementation. Access would require an authorized organization context and operation-specific permission; no public API or authorization grant is available here.

Illustrative request fields
NameTypeDescription
subsidiary_idstringStable fictional subsidiary reference; not a secret and not evidence that a resource exists.
accounting_period_idstringStable fictional accounting period reference; not a secret and not evidence that a resource exists.
currencystringUppercase ISO 4217 currency code. Determine its minor-unit exponent before monetary conversion.
debit_minorintegerIllustrative debit amount in currency minor units; a journal draft must balance against its credit lines.
credit_minorintegerIllustrative credit amount in currency minor units, in the same currency as the matching debit.

Static example requests

Proposed, non-executing request examples
# Proposed request text only; this reserved host is not a live API.
curl -X POST 'https://api.remizen.example/v1/accounting/journal-drafts' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  --data '{
  "subsidiary_id": "sub_example_123",
  "accounting_period_id": "accounting_period_example_123",
  "currency": "USD",
  "debit_minor": 12550,
  "credit_minor": 12550
}'

Fictional response example

201 (proposed example)Static response fixture

Fictional documentation data only. No request was sent, record created, review performed, payment initiated or provider connection activated.

JSON
{
  "data": {
    "accounting_period_id": "accounting_period_example_123",
    "currency": "USD",
    "debit_minor": 12550,
    "credit_minor": 12550,
    "id": "accounting_example_123",
    "organization_id": "org_example_123"
  },
  "meta": {
    "request_id": "req_example_123",
    "reference_only": true
  }
}

Illustrative error case

Review this failure case in context: Reject unbalanced drafts and undefined mappings. The example contains fictional accounting data and performs no posting or financial transaction.

422 (illustrative; final error contracts are undecided)Proposed error fixture

Synthetic diagnostic example. Human-readable messages must not be used as stable programmatic contracts.

JSON
{
  "error": {
    "code": "validation_error",
    "message": "The proposed journal entries operation requires review of its input or authorization.",
    "request_id": "req_example_123"
  }
}

Proposed data types

Illustrative field dictionary
NameTypeDescription
subsidiary_idstringStable fictional subsidiary reference; not a secret and not evidence that a resource exists.
accounting_period_idstringStable fictional accounting period reference; not a secret and not evidence that a resource exists.
currencystringUppercase ISO 4217 currency code. Determine its minor-unit exponent before monetary conversion.
debit_minorintegerIllustrative debit amount in currency minor units; a journal draft must balance against its credit lines.
credit_minorintegerIllustrative credit amount in currency minor units, in the same currency as the matching debit.