Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -113,9 +113,11 @@ def sync_detailed(
) -> Response[ErrorResponse | OperationEnvelopeEntityTaxonomyResponse]:
"""Link Entity to Taxonomy

Link the graph's entity to a taxonomy. Idempotent — returns existing linkage if it already exists.
CoA blocks auto-link at create time; use this only to switch the primary CoA or link a reporting
extension / custom ontology explicitly.
Link an entity to a taxonomy. Idempotent — returns the existing linkage if it already exists. CoA
blocks auto-link at create time; use this to switch an entity's primary chart of accounts. Only the
`chart_of_accounts` basis changes behavior: a `reporting`, `mapping` or `schedule` link records the
association and nothing reads it. Statements render from the entity's reporting style (change-
reporting-style), and custom statement rows come from a reporting extension of that style.

**Idempotency**: supply an `Idempotency-Key` header to make safe retries; replays within 24 hours
return the same envelope. Reusing the key with a different body returns HTTP 409 Conflict.
Expand All @@ -126,14 +128,12 @@ def sync_detailed(
body (LinkEntityTaxonomyRequest): Link an entity to a taxonomy (creates the
ENTITY_HAS_TAXONOMY edge).

This is how a graph declares "this entity reports under this taxonomy."
For `chart_of_accounts` taxonomies, this tells the platform which CoA
the entity uses. For reporting taxonomies, which standard (us-gaap,
ifrs). Idempotent — re-linking returns the existing edge unchanged.

CoA blocks auto-link at create time; use this to switch the primary
CoA, link a reporting extension, or attach a custom ontology
explicitly.
A `chart_of_accounts` link tells the platform which chart the entity
keeps its books in; CoA blocks auto-link at create time, so use this to
switch the primary one. The other bases record the association and
nothing reads them: statements render from the entity's reporting style,
whatever taxonomy is linked. Idempotent — re-linking returns the
existing edge unchanged.

Raises:
errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
Expand Down Expand Up @@ -165,9 +165,11 @@ def sync(
) -> ErrorResponse | OperationEnvelopeEntityTaxonomyResponse | None:
"""Link Entity to Taxonomy

Link the graph's entity to a taxonomy. Idempotent — returns existing linkage if it already exists.
CoA blocks auto-link at create time; use this only to switch the primary CoA or link a reporting
extension / custom ontology explicitly.
Link an entity to a taxonomy. Idempotent — returns the existing linkage if it already exists. CoA
blocks auto-link at create time; use this to switch an entity's primary chart of accounts. Only the
`chart_of_accounts` basis changes behavior: a `reporting`, `mapping` or `schedule` link records the
association and nothing reads it. Statements render from the entity's reporting style (change-
reporting-style), and custom statement rows come from a reporting extension of that style.

**Idempotency**: supply an `Idempotency-Key` header to make safe retries; replays within 24 hours
return the same envelope. Reusing the key with a different body returns HTTP 409 Conflict.
Expand All @@ -178,14 +180,12 @@ def sync(
body (LinkEntityTaxonomyRequest): Link an entity to a taxonomy (creates the
ENTITY_HAS_TAXONOMY edge).

This is how a graph declares "this entity reports under this taxonomy."
For `chart_of_accounts` taxonomies, this tells the platform which CoA
the entity uses. For reporting taxonomies, which standard (us-gaap,
ifrs). Idempotent — re-linking returns the existing edge unchanged.

CoA blocks auto-link at create time; use this to switch the primary
CoA, link a reporting extension, or attach a custom ontology
explicitly.
A `chart_of_accounts` link tells the platform which chart the entity
keeps its books in; CoA blocks auto-link at create time, so use this to
switch the primary one. The other bases record the association and
nothing reads them: statements render from the entity's reporting style,
whatever taxonomy is linked. Idempotent — re-linking returns the
existing edge unchanged.

Raises:
errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
Expand All @@ -212,9 +212,11 @@ async def asyncio_detailed(
) -> Response[ErrorResponse | OperationEnvelopeEntityTaxonomyResponse]:
"""Link Entity to Taxonomy

Link the graph's entity to a taxonomy. Idempotent — returns existing linkage if it already exists.
CoA blocks auto-link at create time; use this only to switch the primary CoA or link a reporting
extension / custom ontology explicitly.
Link an entity to a taxonomy. Idempotent — returns the existing linkage if it already exists. CoA
blocks auto-link at create time; use this to switch an entity's primary chart of accounts. Only the
`chart_of_accounts` basis changes behavior: a `reporting`, `mapping` or `schedule` link records the
association and nothing reads it. Statements render from the entity's reporting style (change-
reporting-style), and custom statement rows come from a reporting extension of that style.

**Idempotency**: supply an `Idempotency-Key` header to make safe retries; replays within 24 hours
return the same envelope. Reusing the key with a different body returns HTTP 409 Conflict.
Expand All @@ -225,14 +227,12 @@ async def asyncio_detailed(
body (LinkEntityTaxonomyRequest): Link an entity to a taxonomy (creates the
ENTITY_HAS_TAXONOMY edge).

This is how a graph declares "this entity reports under this taxonomy."
For `chart_of_accounts` taxonomies, this tells the platform which CoA
the entity uses. For reporting taxonomies, which standard (us-gaap,
ifrs). Idempotent — re-linking returns the existing edge unchanged.

CoA blocks auto-link at create time; use this to switch the primary
CoA, link a reporting extension, or attach a custom ontology
explicitly.
A `chart_of_accounts` link tells the platform which chart the entity
keeps its books in; CoA blocks auto-link at create time, so use this to
switch the primary one. The other bases record the association and
nothing reads them: statements render from the entity's reporting style,
whatever taxonomy is linked. Idempotent — re-linking returns the
existing edge unchanged.

Raises:
errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
Expand Down Expand Up @@ -262,9 +262,11 @@ async def asyncio(
) -> ErrorResponse | OperationEnvelopeEntityTaxonomyResponse | None:
"""Link Entity to Taxonomy

Link the graph's entity to a taxonomy. Idempotent — returns existing linkage if it already exists.
CoA blocks auto-link at create time; use this only to switch the primary CoA or link a reporting
extension / custom ontology explicitly.
Link an entity to a taxonomy. Idempotent — returns the existing linkage if it already exists. CoA
blocks auto-link at create time; use this to switch an entity's primary chart of accounts. Only the
`chart_of_accounts` basis changes behavior: a `reporting`, `mapping` or `schedule` link records the
association and nothing reads it. Statements render from the entity's reporting style (change-
reporting-style), and custom statement rows come from a reporting extension of that style.

**Idempotency**: supply an `Idempotency-Key` header to make safe retries; replays within 24 hours
return the same envelope. Reusing the key with a different body returns HTTP 409 Conflict.
Expand All @@ -275,14 +277,12 @@ async def asyncio(
body (LinkEntityTaxonomyRequest): Link an entity to a taxonomy (creates the
ENTITY_HAS_TAXONOMY edge).

This is how a graph declares "this entity reports under this taxonomy."
For `chart_of_accounts` taxonomies, this tells the platform which CoA
the entity uses. For reporting taxonomies, which standard (us-gaap,
ifrs). Idempotent — re-linking returns the existing edge unchanged.

CoA blocks auto-link at create time; use this to switch the primary
CoA, link a reporting extension, or attach a custom ontology
explicitly.
A `chart_of_accounts` link tells the platform which chart the entity
keeps its books in; CoA blocks auto-link at create time, so use this to
switch the primary one. The other bases record the association and
nothing reads them: statements render from the entity's reporting style,
whatever taxonomy is linked. Idempotent — re-linking returns the
existing edge unchanged.

Raises:
errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
Expand Down
19 changes: 9 additions & 10 deletions robosystems_client/models/link_entity_taxonomy_request.py
Original file line number Diff line number Diff line change
Expand Up @@ -16,21 +16,20 @@
class LinkEntityTaxonomyRequest:
"""Link an entity to a taxonomy (creates the ENTITY_HAS_TAXONOMY edge).

This is how a graph declares "this entity reports under this taxonomy."
For `chart_of_accounts` taxonomies, this tells the platform which CoA
the entity uses. For reporting taxonomies, which standard (us-gaap,
ifrs). Idempotent — re-linking returns the existing edge unchanged.

CoA blocks auto-link at create time; use this to switch the primary
CoA, link a reporting extension, or attach a custom ontology
explicitly.
A `chart_of_accounts` link tells the platform which chart the entity
keeps its books in; CoA blocks auto-link at create time, so use this to
switch the primary one. The other bases record the association and
nothing reads them: statements render from the entity's reporting style,
whatever taxonomy is linked. Idempotent — re-linking returns the
existing edge unchanged.

Attributes:
taxonomy_id (str): The taxonomy to link to.
entity_id (None | str | Unset): The entity to link, by id. Omit for the group parent.
basis (LinkEntityTaxonomyRequestBasis | Unset): Linkage role: `chart_of_accounts` (the entity's CoA),
`reporting` (reporting standard like us-gaap), `mapping` (CoA→reporting rollup), `schedule` (schedule
structure). Default: LinkEntityTaxonomyRequestBasis.CHART_OF_ACCOUNTS.
`reporting` (a reporting standard), `mapping` (CoA→reporting rollup), `schedule` (schedule structure). Only
`chart_of_accounts` is read; the others are recorded and do not change how statements render. Default:
LinkEntityTaxonomyRequestBasis.CHART_OF_ACCOUNTS.
is_primary (bool | Unset): Mark this as the primary linkage for the basis. False allows secondary attachments
(e.g. parallel reporting standards). Default: True.
adoption_context (None | str | Unset): Why the entity is reporting under this taxonomy (e.g. 'voluntary',
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,9 @@ class PreviewConsolidationEntriesResponse:
notes (list[str] | Unset): Anything the engine left out, and why.
closed (bool | Unset): True when the consolidation entity has closed the month: its entries are as posted, and
nothing is recomputed. Default: False.
incomplete (bool | Unset): True when the engine left an entry out — a member's books it cannot read, an account
the consolidation entity lacks; `notes` says which. The group close waits on it whatever the residuals. Default:
False.
drafted_entry_ids (list[str] | Unset): The month's drafts propose-consolidation-entries wrote, waiting for the
consolidation entity's close to post them.
"""
Expand All @@ -51,6 +54,7 @@ class PreviewConsolidationEntriesResponse:
reconciling_items: list[ConsolidationReconcilingItem] | Unset = UNSET
notes: list[str] | Unset = UNSET
closed: bool | Unset = False
incomplete: bool | Unset = False
drafted_entry_ids: list[str] | Unset = UNSET
additional_properties: dict[str, Any] = _attrs_field(init=False, factory=dict)

Expand Down Expand Up @@ -92,6 +96,8 @@ def to_dict(self) -> dict[str, Any]:

closed = self.closed

incomplete = self.incomplete

drafted_entry_ids: list[str] | Unset = UNSET
if not isinstance(self.drafted_entry_ids, Unset):
drafted_entry_ids = self.drafted_entry_ids
Expand All @@ -117,6 +123,8 @@ def to_dict(self) -> dict[str, Any]:
field_dict["notes"] = notes
if closed is not UNSET:
field_dict["closed"] = closed
if incomplete is not UNSET:
field_dict["incomplete"] = incomplete
if drafted_entry_ids is not UNSET:
field_dict["drafted_entry_ids"] = drafted_entry_ids

Expand Down Expand Up @@ -172,6 +180,8 @@ def from_dict(cls: type[T], src_dict: Mapping[str, Any]) -> T:

closed = d.pop("closed", UNSET)

incomplete = d.pop("incomplete", UNSET)

drafted_entry_ids = cast(list[str], d.pop("drafted_entry_ids", UNSET))

preview_consolidation_entries_response = cls(
Expand All @@ -185,6 +195,7 @@ def from_dict(cls: type[T], src_dict: Mapping[str, Any]) -> T:
reconciling_items=reconciling_items,
notes=notes,
closed=closed,
incomplete=incomplete,
drafted_entry_ids=drafted_entry_ids,
)

Expand Down
Loading