Skip to content

Organization Settings — Proposed Guide

Planned API — Reference Only

Organization Settings: Organization settings would establish defaults such as reporting currency and locale. Defaults are not a replacement for explicit…

Overview

Organization settings would establish defaults such as reporting currency and locale. Defaults are not a replacement for explicit values stored on financial records.

Key concepts

Represent setting versions and distinguish configurable choices from fixed service behavior. Validate currency and locale values.

Implementation considerations

Changing a default must not mutate approved expenses or completed exports. No setting here enables payments or an integration.

Proposed API behavior

PATCH /v1/organizations/{organization_id}/settings 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.

Proposed path parameters
NameTypeDescription
organization_idrequiredstringStable fictional organization reference; not a secret and not evidence that a resource exists.
Illustrative request fields
NameTypeDescription
currencystringUppercase ISO 4217 currency code. Determine its minor-unit exponent before monetary conversion.
localestringExample presentation preference; it does not alter stored monetary semantics.
versionintegerIllustrative resource revision for detecting stale updates; no live concurrency contract is published.

Static example requests

Proposed, non-executing request examples
# Proposed request text only; this reserved host is not a live API.
curl -X PATCH 'https://api.remizen.example/v1/organizations/org_example_123/settings' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  --data '{
  "currency": "USD",
  "locale": "en-US",
  "version": 1
}'

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": {
    "organization_id": "org_example_123",
    "currency": "USD",
    "locale": "en-US",
    "version": 1,
    "id": "organizations_example_123"
  },
  "meta": {
    "request_id": "req_example_123",
    "reference_only": true
  }
}

Illustrative error case

Review this failure case in context: Changing a default must not mutate approved expenses or completed exports. No setting here enables payments or an integration.

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

Proposed data types

Illustrative field dictionary
NameTypeDescription
organization_idstringStable fictional organization reference; not a secret and not evidence that a resource exists.
currencystringUppercase ISO 4217 currency code. Determine its minor-unit exponent before monetary conversion.
localestringExample presentation preference; it does not alter stored monetary semantics.
versionintegerIllustrative resource revision for detecting stale updates; no live concurrency contract is published.