Subsidiaries — Proposed Guide

Planned API — Reference Only

Subsidiaries: Subsidiaries represent legal or operational entities within an organization. They can carry reporting currency and accounting context…

Overview

Subsidiaries represent legal or operational entities within an organization. They can carry reporting currency and accounting context without being separate user identities.

Key concepts

Keep an entity identifier distinct from a display name and country label. Accounting mappings should reference the identifier.

Implementation considerations

A parent organization grant should not automatically expose every subsidiary. Access scope and entity-specific policies require explicit design.

Proposed API behavior

GET /v1/subsidiaries 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
Name	Type	Description
subsidiary_id	string	Stable fictional subsidiary reference; not a secret and not evidence that a resource exists.

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/subsidiaries?subsidiary_id=sub_example_123' \
  -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": [
    {
      "organization_id": "org_example_123",
      "country": "US",
      "currency": "USD",
      "id": "subsidiaries_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: A parent organization grant should not automatically expose every subsidiary. Access scope and entity-specific policies require explicit design.

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

Proposed data types

Illustrative field dictionary
Name	Type	Description
organization_id	string	Stable fictional organization reference; not a secret and not evidence that a resource exists.
subsidiary_id	string	Stable fictional subsidiary reference; not a secret and not evidence that a resource exists.
country	string	Illustrative country code; it does not establish regional product availability.
currency	string	Uppercase ISO 4217 currency code. Determine its minor-unit exponent before monetary conversion.

Organization Structure

Users & Organizations

Create Subsidiary