📘

Протоки документів & перевірки

circulations crm_office 🛡️ RLS Protected

Процесні та API-документації, що випливають з коду.

Fachliche Bestimmung: Процесна документація, отримана з коду, а також документація API.

⚡ Процес роботи (2) 🗄️ Моделі даних & поля (3) 🔌 Початкові точки (UI & API) (23) 🛡️ Регуляторна діяльність

⚡ Процес роботи

Наказу користувача: циркуляційний агент `plan:command_circulation_agent`

Проверене Durable plan (durable_plan), старт: manual_command.

1. circulation_agent

circulation_agent

{"key": "execute_command", "label": "Befehl prüfen, ausführen oder zur Freigabe vorlegen", "adapter": "agent.execute", "agent": "circulation_agent", "condition_fact": null}

Aktionen: circulation_agent

Обхід `status:circulation`

Оглядальна станна машина (обов'язуюча).

1. draft

проект

Статус <unk>проекту <unk> стан машини

2. active

активні

Статус <unk>активний <unk> стан машини обертання.

3. completed

завершено

Статус <unk> завершено<unk> стан машини обертання.

4. rejected

відхилення

Статус <unk> відхилений <unk> стан машини обертання.

5. returned

повернення

Статус <unk>вторнувся <unk> стан машини обертання.

6. cancelled

відменено

Статус <unk> скасований <unk> стан машини

🗄️ Моделі даних & поля

CirculationComments circulation_comments RLS Aktiv

13 Полі / графи

Tabelle circulation_comments

Feldname	Тип даних	Обов'язок	Schlüssel	Професійна значення
`circulation_id`	`UUID`	Ja *	FK ➔ document_circulations.id	Feld circulation_id
`step_id`	`UUID`	Nein	FK ➔ circulation_steps.id	Feld step_id
`document_id`	`UUID`	Ja *	FK ➔ documents.id	Feld document_id
`author_id`	`UUID`	Nein	FK ➔ organization_users.id	Feld author_id
`page`	`INTEGER`	Ja *	-	Feld page
`x`	`FLOAT`	Ja *	-	Feld x
`y`	`FLOAT`	Ja *	-	Feld y
`text`	`TEXT`	Ja *	-	Feld text
`id`	`UUID`	Nein	PK	Feld id
`tenant_id`	`UUID`	Ja *	FK ➔ organizations.id	Feld tenant_id
`created_at`	`DATETIME`	Ja *	-	Feld created_at
`updated_at`	`DATETIME`	Ja *	-	Feld updated_at
`metadata`	`JSONB`	Ja *	-	Feld metadata

CirculationStamps circulation_stamps RLS Aktiv

16 Полі / графи

Tabelle circulation_stamps

Feldname	Тип даних	Обов'язок	Schlüssel	Професійна значення
`circulation_id`	`UUID`	Ja *	FK ➔ document_circulations.id	Feld circulation_id
`step_id`	`UUID`	Nein	FK ➔ circulation_steps.id	Feld step_id
`document_id`	`UUID`	Ja *	FK ➔ documents.id	Feld document_id
`placed_by`	`UUID`	Nein	FK ➔ organization_users.id	Feld placed_by
`page`	`INTEGER`	Ja *	-	Feld page
`x`	`FLOAT`	Ja *	-	Feld x
`y`	`FLOAT`	Ja *	-	Feld y
`width`	`FLOAT`	Ja *	-	Feld width
`height`	`FLOAT`	Ja *	-	Feld height
`text`	`VARCHAR(255)`	Ja *	-	Feld text
`color`	`VARCHAR(7)`	Ja *	-	Feld color
`id`	`UUID`	Nein	PK	Feld id
`tenant_id`	`UUID`	Ja *	FK ➔ organizations.id	Feld tenant_id
`created_at`	`DATETIME`	Ja *	-	Feld created_at
`updated_at`	`DATETIME`	Ja *	-	Feld updated_at
`metadata`	`JSONB`	Ja *	-	Feld metadata

CirculationSteps circulation_steps RLS Aktiv

17 Полі / графи

Tabelle circulation_steps

Feldname	Тип даних	Обов'язок	Schlüssel	Професійна значення
`circulation_id`	`UUID`	Ja *	FK ➔ document_circulations.id	Feld circulation_id
`position`	`INTEGER`	Ja *	-	Feld position
`assignee_id`	`UUID`	Ja *	FK ➔ organization_users.id	Feld assignee_id
`status`	`VARCHAR(48)`	Ja *	-	Feld status
`instructions`	`TEXT`	Nein	-	Feld instructions
`assigned_at`	`DATETIME`	Nein	-	Feld assigned_at
`started_at`	`DATETIME`	Nein	-	Feld started_at
`completed_at`	`DATETIME`	Nein	-	Feld completed_at
`decision`	`VARCHAR(32)`	Nein	-	Feld decision
`notes`	`TEXT`	Nein	-	Feld notes
`due_at`	`DATETIME`	Nein	-	Feld due_at
`decision_comment`	`TEXT`	Nein	-	Feld decision_comment
`id`	`UUID`	Nein	PK	Feld id
`tenant_id`	`UUID`	Ja *	FK ➔ organizations.id	Feld tenant_id
`created_at`	`DATETIME`	Ja *	-	Feld created_at
`updated_at`	`DATETIME`	Ja *	-	Feld updated_at
`metadata`	`JSONB`	Ja *	-	Feld metadata

🔌 Початкові точки (UI & API)

Art	Метод	Останній пункт / шлях	Titel & Zweck	Право на
⚡ REST API	DELETE	`/api/v1/circulations/{circulation_id}/assignees/{step_id}`	remove_assignee Semantic binding: not_evaluated; mutation=True	`circulations`
⚡ REST API	DELETE	`/api/v1/circulations/{circulation_id}/documents/{document_id}`	remove_document Semantic binding: not_evaluated; mutation=True	`circulations`
⚡ REST API	GET	`/api/v1/circulations`	list_circulations Semantic binding: not_evaluated; mutation=False	`circulations`
⚡ REST API	GET	`/api/v1/circulations/{circulation_id}`	get_circulation Semantic binding: not_evaluated; mutation=False	`circulations`
⚡ REST API	GET	`/api/v1/circulations/{circulation_id}/documents/{document_id}/preview`	document_preview Semantic binding: not_evaluated; mutation=False	`circulations`
⚡ REST API	GET	`/api/v1/circulations/{circulation_id}/final-pdf`	download_final_pdf Semantic binding: not_evaluated; mutation=False	`circulations`
⚡ REST API	GET	`/circulations`	circulations_page Semantic binding: not_evaluated; mutation=False	`circulations`
⚡ REST API	GET	`/circulations/new`	circulation_create_page Semantic binding: not_evaluated; mutation=False	`circulations`
⚡ REST API	GET	`/circulations/{circulation_id}`	circulation_detail_page Semantic binding: not_evaluated; mutation=False	`circulations`
⚡ REST API	PATCH	`/api/v1/circulations/{circulation_id}`	update_circulation Semantic binding: not_evaluated; mutation=True	`circulations`
⚡ REST API	PATCH	`/api/v1/circulations/{circulation_id}/assignees/{step_id}`	update_assignee Semantic binding: not_evaluated; mutation=True	`circulations`
⚡ REST API	POST	`/api/v1/circulations`	create_circulation Semantic binding: not_evaluated; mutation=True	`circulations`
⚡ REST API	POST	`/api/v1/circulations/{circulation_id}/assignees`	add_assignee Semantic binding: not_evaluated; mutation=True	`circulations`
⚡ REST API	POST	`/api/v1/circulations/{circulation_id}/begin-review`	begin_review Semantic binding: not_evaluated; mutation=True	`circulations`
⚡ REST API	POST	`/api/v1/circulations/{circulation_id}/cancel`	cancel_circulation Semantic binding: not_evaluated; mutation=True	`circulations`
⚡ REST API	POST	`/api/v1/circulations/{circulation_id}/comments`	add_comment Semantic binding: not_evaluated; mutation=True	`circulations`
⚡ REST API	POST	`/api/v1/circulations/{circulation_id}/complete-step`	complete_step Semantic binding: not_evaluated; mutation=True	`circulations`
⚡ REST API	POST	`/api/v1/circulations/{circulation_id}/documents`	add_document Semantic binding: not_evaluated; mutation=True	`circulations`
⚡ REST API	POST	`/api/v1/circulations/{circulation_id}/return`	return_for_revision Semantic binding: not_evaluated; mutation=True	`circulations`
⚡ REST API	POST	`/api/v1/circulations/{circulation_id}/stamps`	add_stamp Semantic binding: not_evaluated; mutation=True	`circulations`
⚡ REST API	POST	`/api/v1/circulations/{circulation_id}/start`	start_circulation Semantic binding: not_evaluated; mutation=True	`circulations`
⚡ REST API	POST	`/api/v1/circulations/{circulation_id}/steps/reorder`	reorder_steps Semantic binding: not_evaluated; mutation=True	`circulations`
⚡ REST API	POST	`/api/v1/circulations/{circulation_id}/upload`	upload_document Semantic binding: not_evaluated; mutation=True	`circulations`

🛡️ Регуляторна діяльність

Dieses Modul unterliegt folgenden gesetzlichen, regulatorischen und Revisionsstandards:

Простерогідність
Ізоляція клієнта (PostgreSQL RLS)