Skip to content

Accounting Periods — Proposed Guide

Planned API — Reference Only

Accounting Periods: An accounting period defines the date interval and closing state used for recognition and reporting. An expense incurred date can…

Overview

An accounting period defines the date interval and closing state used for recognition and reporting. An expense incurred date can differ from its posting period.

Key concepts

Use period identifiers, start and end dates, and a documented closed state. Keep entity-specific calendars separate.

Implementation considerations

Closed-period corrections require approved adjustment handling. Do not reopen a period or change historical recognition from a general metadata update.

Proposed API behavior

GET /v1/accounting/periods 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 query parameters
NameTypeDescription
start_datestring (date)Synthetic calendar date in YYYY-MM-DD form; period inclusivity must be defined by the future contract.
end_datestring (date)Synthetic calendar date in YYYY-MM-DD form; period inclusivity must be defined by the future contract.
statusstringProposed lifecycle value. Its meaning depends on the resource and must not be inferred from HTTP success.

Static example requests

Proposed, non-executing request examples
# Proposed request text only; this reserved host is not a live API.
curl -X GET 'https://api.remizen.example/v1/accounting/periods?start_date=2026-01-15&end_date=2026-01-31&status=draft' \
  -H 'Authorization: Bearer YOUR_API_KEY'

Fictional response example

200 (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",
      "id": "accounting_example_123",
      "organization_id": "org_example_123"
    }
  ],
  "pagination": {
    "has_more": false,
    "next_cursor": null
  },
  "meta": {
    "request_id": "req_example_123",
    "reference_only": true
  }
}

Illustrative error case

Review this failure case in context: Closed-period corrections require approved adjustment handling. Do not reopen a period or change historical recognition from a general metadata update.

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 accounting periods operation requires review of its input or authorization.",
    "request_id": "req_example_123"
  }
}

Proposed data types

Illustrative field dictionary
NameTypeDescription
accounting_period_idstringStable fictional accounting period reference; not a secret and not evidence that a resource exists.
start_datestring (date)Synthetic calendar date in YYYY-MM-DD form; period inclusivity must be defined by the future contract.
end_datestring (date)Synthetic calendar date in YYYY-MM-DD form; period inclusivity must be defined by the future contract.
statusstringProposed lifecycle value. Its meaning depends on the resource and must not be inferred from HTTP success.