> For the complete documentation index, see [llms.txt](https://geosquare-1.gitbook.io/geosquare-docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://geosquare-1.gitbook.io/geosquare-docs/option-civilities.md).

# Option Civilities

## List civilities

> Retrieve list of civilities with filtering and pagination support. Civility. \
> \
>  Configuration des types d'options disponibles dans K3. Cette structure définit les mappings entre les URLs d'accès aux options et leurs modèles correspondants.\
> \
> \*\*Structure :\*\*\
> \- \*\*Clé\*\* : URL du endpoint (ex: \`civilities\`, \`action\_types\`, \`product\_brands\`)\
> \- \*\*Valeur\*\* : Nom de la classe du modèle (ex: \`K3::Contact::Options::Civility\`)\
> \
> \*\*Liste complète des options disponibles :\*\*\
> \
> \*\*K3::Core - Options générales :\*\*\
> \- \`tva\` → K3::Compta::Options::Tva\
> \- \`currencies\` → K3::Compta::Options::Currency\
> \- \`code\_comptable\_types\` → K3::Compta::Options::CodeComptableType\
> \- \`notices\` → K3::Options::Notice\
> \- \`message\_status\` → K3::Options::MessageStatus\
> \- \`missing\_part\_intervenants\` → K3::Options::MissingPartIntervenant\
> \- \`skills\` → K3::Options::Skill\
> \- \`missing\_part\_types\` → K3::Options::MissingPartType\
> \- \`journal\_types\` → K3::Options::JournalType\
> \- \`tests\` → K3::Options::Test\
> \
> \*\*K3::Contact - Gestion des contacts :\*\*\
> \- \`civilities\` → K3::Contact::Options::Civility\
> \- \`type\_contacts\` → K3::Contact::Options::TypeContact\
> \- \`sources\` → K3::Contact::Options::Source\
> \- \`legal\_forms\` → K3::Contact::Options::LegalForm\
> \- \`sectors\` → K3::Contact::Options::Sector\
> \- \`terms\` → K3::Contact::Options::Term\
> \- \`term\_days\` → K3::Contact::Options::TermDay\
> \- \`payment\_types\` → K3::Contact::Options::PaymentType\
> \- \`payment\_modes\` → K3::Contact::Options::PaymentMode\
> \- \`functions\` → K3::Contact::Options::Function\
> \- \`billing\_types\` → K3::Contact::Options::BillingType\
> \
> \*\*K3::Crm - CRM :\*\*\
> \- \`action\_statuses\` → K3::Crm::Options::ActionStatus\
> \- \`action\_conclusions\` → K3::Crm::Options::ActionConclusion\
> \- \`action\_types\` → K3::Crm::Options::ActionType\
> \- \`exchange\_statuses\` → K3::Crm::Options::ExchangeStatus\
> \- \`exchange\_types\` → K3::Crm::Options::ExchangeType\
> \- \`exchange\_locations\` → K3::Crm::Options::ExchangeLocation\
> \- \`opportunity\_steps\` → K3::Crm::Options::OpportunityStep\
> \- \`opportunity\_origins\` → K3::Crm::Options::OpportunityOrigin\
> \- \`opportunity\_failures\` → K3::Crm::Options::OpportunityFailure\
> \
> \*\*K3::Application - Application :\*\*\
> \- \`equipment\_stat\_targets\` → K3::Application::Options::EquipmentStatTarget\
> \
> \*\*K3::Erp - Gestion de projets et interventions :\*\*\
> \- \`task\_types\` → K3::Erp::Options::TaskType\
> \- \`task\_locations\` → K3::Erp::Options::TaskLocation\
> \- \`task\_statuses\` → K3::Erp::Options::TaskStatus\
> \- \`ticket\_types\` → K3::Erp::Options::TicketType\
> \- \`ticket\_statuses\` → K3::Erp::Options::TicketStatus\
> \- \`ticket\_domains\` → K3::Erp::Options::TicketDomain\
> \- \`ticket\_origins\` → K3::Erp::Options::TicketOrigin\
> \- \`event\_types\` → K3::Erp::Options::EventType\
> \- \`event\_locations\` → K3::Erp::Options::EventLocation\
> \- \`event\_statuses\` → K3::Erp::Options::EventStatus\
> \- \`project\_statuses\` → K3::Erp::Options::ProjectStatus\
> \- \`project\_types\` → K3::Erp::Options::ProjectType\
> \- \`project\_default\_milestones\` → K3::Erp::Options::ProjectDefaultMilestone\
> \- \`contract\_types\` → K3::Erp::Options::ContractType\
> \- \`contract\_statuses\` → K3::Erp::Options::ContractStatus\
> \- \`intervention\_types\` → K3::Erp::Options::InterventionType\
> \- \`intervention\_statuses\` → K3::Erp::Options::InterventionStatus\
> \- \`intervention\_step\_statuses\` → K3::Erp::Options::InterventionStepStatus\
> \- \`priorities\` → K3::Erp::Options::Priority\
> \- \`project\_priorities\` → K3::Erp::Options::ProjectPriority\
> \- \`project\_categories\` → K3::Erp::Options::ProjectCategory\
> \- \`resource\_skills\` → K3::Erp::Options::ResourceSkill\
> \- \`resource\_types\` → K3::Erp::Options::ResourceType\
> \- \`resource\_event\_locations\` → K3::Erp::Options::ResourceEventLocation\
> \- \`resource\_event\_statuses\` → K3::Erp::Options::ResourceEventStatus\
> \- \`resource\_event\_categories\` → K3::Erp::Options::ResourceEventCategory\
> \- \`equipment\_statuses\` → K3::Erp::Options::EquipmentStatus\
> \- \`prestation\_types\` → K3::Erp::Options::PrestationType\
> \- \`competencies\` → K3::Erp::Competency\
> \
> \*\*K3::Product - Produits et catalogues :\*\*\
> \- \`product\_unities\` → K3::Product::Options::ProductUnit\
> \- \`product\_brands\` → K3::Product::Options::ProductBrand\
> \- \`product\_families\` → K3::Product::Options::ProductFamily\
> \- \`product\_shelves\` → K3::Product::Options::ProductShelf\
> \- \`product\_categories\` → K3::Product::Options::ProductCategory\
> \- \`product\_cost\_categories\` → K3::Product::Options::CostCategory\
> \- \`product\_cost\_types\` → K3::Product::Options::CostType\
> \
> \*\*K3::Sale - Ventes et facturation :\*\*\
> \- \`document\_reference\_formats\` → K3::Sale::Options::DocumentReferenceFormat\
> \- \`document\_row\_types\` → K3::Sale::Options::DocumentRowType\
> \- \`document\_text\_row\_types\` → K3::Sale::Options::DocumentTextRowType\
> \- \`quote\_statuses\` → K3::Sale::Options::QuoteStatus\
> \- \`invoice\_statuses\` → K3::Sale::Options::InvoiceStatus\
> \- \`payment\_statuses\` → K3::Sale::Options::PaymentStatus\
> \- \`order\_statuses\` → K3::Sale::Options::OrderStatus\
> \- \`customer\_order\_statuses\` → K3::Sale::Options::CustomerOrderStatus\
> \- \`supplier\_delivery\_statuses\` → K3::Sale::Options::SupplierDeliveryStatus\
> \- \`delivery\_statuses\` → K3::Sale::Options::DeliveryStatus\
> \- \`quote\_cancel\_explanations\` → K3::Sale::Options::QuoteCancelExplanation\
> \- \`document\_note\` → K3::Sale::Options::DocumentNote\
> \- \`reminder\_types\` → K3::Sale::Options::ReminderType\
> \- \`reminder\_gravities\` → K3::Sale::Options::ReminderGravity\
> \- \`folder\_status\` → K3::Sale::Options::FolderStatus\
> \- \`return\_voucher\_statuses\` → K3::Sale::Options::ReturnVoucherStatus\
> \- \`transfer\_voucher\_statuses\` → K3::Sale::Options::TransferVoucherStatus\
> \- \`activity\_types\` → K3::Sale::Options::ActivityType\
> \- \`delivery\_progressions\` → K3::Sale::Options::DeliveryProgression\
> \- \`debt\_statuses\` → K3::Sale::Options::DebtStatus\
> \- \`offer\_template\_types\` → K3::Sale::Options::OfferTemplateType\
> \
> \*\*K3::Stock - Gestion de stock :\*\*\
> \- \`change\_types\` → K3::Stock::Options::ChangeType\
> \- \`expense\_row\_categories\` → K3::Stock::Options::ExpenseRowCategory\
> \- \`expense\_statuses\` → K3::Stock::Options::ExpenseStatus\ <br>

```json
{"openapi":"3.1.1","info":{"title":"K3 Core API V1","version":"v1"},"servers":[{"url":"https://api.geosquare.fr/","description":"Environnement de production"}],"security":[{"bearer_auth":[]}],"components":{"securitySchemes":{"bearer_auth":{"type":"http","scheme":"bearer"}},"schemas":{"option_list":{"type":"object","properties":{"models":{"type":"array","items":{"$ref":"#/components/schemas/option_list_item"}},"total_count":{"type":"integer","description":"Total number of items"}},"required":["models","total_count"]},"option_list_item":{"type":"object","properties":{"option_label":{"type":["string","null"],"description":"Option label"},"option_id":{"type":["integer","string","null"],"description":"Option id"},"id":{"type":["integer","null"],"description":"Id"},"model_name":{"type":["string","null"],"description":"Model name"},"app_id":{"type":["integer","string","null"],"description":"App id"},"module":{"type":["string","null"],"description":"Module"},"module_human_name":{"type":["string","null"],"description":"Module human name"},"model_class_name":{"type":["string","null"],"description":"Model class name"},"inactivated_at":{"type":["string","null"],"description":"Inactivated at"},"deleted_at":{"type":["string","null"],"description":"Deleted at"},"value":{"type":["string","null"],"description":"Value"},"key":{"type":["string","null"],"description":"Key"},"code":{"type":"null","description":"Code"},"default":{"type":["null","boolean"]},"is_readonly":{"type":"null","description":"Is readonly"},"open":{"type":["boolean","null"],"description":"Open"},"accept":{"type":["boolean","null"],"description":"Accept"},"sort":{"type":["integer","null"],"description":"Sort"},"secondary_code":{"type":"null","description":"Secondary code"},"code_compta":{"type":"null","description":"Code compta"},"code_compta_achat":{"type":"null","description":"Code compta achat"},"account_allocation_id":{"type":["integer","string","null"],"description":"Account allocation id"},"parent_id":{"type":["integer","string","null"],"description":"Parent id"},"account_allocation":{"type":"null","description":"Account allocation"},"parent":{"type":"null","description":"Parent"},"children":{"type":["array","null"],"items":{"type":"object"}}},"required":["option_label","model_name","app_id","module","module_human_name","model_class_name"],"additionalProperties":true}}},"paths":{"/options/civilities":{"get":{"summary":"List civilities","tags":["Option - Civilities"],"description":"Retrieve list of civilities with filtering and pagination support. Civility. \n\n Configuration des types d'options disponibles dans K3. Cette structure définit les mappings entre les URLs d'accès aux options et leurs modèles correspondants.\n\n**Structure :**\n- **Clé** : URL du endpoint (ex: `civilities`, `action_types`, `product_brands`)\n- **Valeur** : Nom de la classe du modèle (ex: `K3::Contact::Options::Civility`)\n\n**Liste complète des options disponibles :**\n\n**K3::Core - Options générales :**\n- `tva` → K3::Compta::Options::Tva\n- `currencies` → K3::Compta::Options::Currency\n- `code_comptable_types` → K3::Compta::Options::CodeComptableType\n- `notices` → K3::Options::Notice\n- `message_status` → K3::Options::MessageStatus\n- `missing_part_intervenants` → K3::Options::MissingPartIntervenant\n- `skills` → K3::Options::Skill\n- `missing_part_types` → K3::Options::MissingPartType\n- `journal_types` → K3::Options::JournalType\n- `tests` → K3::Options::Test\n\n**K3::Contact - Gestion des contacts :**\n- `civilities` → K3::Contact::Options::Civility\n- `type_contacts` → K3::Contact::Options::TypeContact\n- `sources` → K3::Contact::Options::Source\n- `legal_forms` → K3::Contact::Options::LegalForm\n- `sectors` → K3::Contact::Options::Sector\n- `terms` → K3::Contact::Options::Term\n- `term_days` → K3::Contact::Options::TermDay\n- `payment_types` → K3::Contact::Options::PaymentType\n- `payment_modes` → K3::Contact::Options::PaymentMode\n- `functions` → K3::Contact::Options::Function\n- `billing_types` → K3::Contact::Options::BillingType\n\n**K3::Crm - CRM :**\n- `action_statuses` → K3::Crm::Options::ActionStatus\n- `action_conclusions` → K3::Crm::Options::ActionConclusion\n- `action_types` → K3::Crm::Options::ActionType\n- `exchange_statuses` → K3::Crm::Options::ExchangeStatus\n- `exchange_types` → K3::Crm::Options::ExchangeType\n- `exchange_locations` → K3::Crm::Options::ExchangeLocation\n- `opportunity_steps` → K3::Crm::Options::OpportunityStep\n- `opportunity_origins` → K3::Crm::Options::OpportunityOrigin\n- `opportunity_failures` → K3::Crm::Options::OpportunityFailure\n\n**K3::Application - Application :**\n- `equipment_stat_targets` → K3::Application::Options::EquipmentStatTarget\n\n**K3::Erp - Gestion de projets et interventions :**\n- `task_types` → K3::Erp::Options::TaskType\n- `task_locations` → K3::Erp::Options::TaskLocation\n- `task_statuses` → K3::Erp::Options::TaskStatus\n- `ticket_types` → K3::Erp::Options::TicketType\n- `ticket_statuses` → K3::Erp::Options::TicketStatus\n- `ticket_domains` → K3::Erp::Options::TicketDomain\n- `ticket_origins` → K3::Erp::Options::TicketOrigin\n- `event_types` → K3::Erp::Options::EventType\n- `event_locations` → K3::Erp::Options::EventLocation\n- `event_statuses` → K3::Erp::Options::EventStatus\n- `project_statuses` → K3::Erp::Options::ProjectStatus\n- `project_types` → K3::Erp::Options::ProjectType\n- `project_default_milestones` → K3::Erp::Options::ProjectDefaultMilestone\n- `contract_types` → K3::Erp::Options::ContractType\n- `contract_statuses` → K3::Erp::Options::ContractStatus\n- `intervention_types` → K3::Erp::Options::InterventionType\n- `intervention_statuses` → K3::Erp::Options::InterventionStatus\n- `intervention_step_statuses` → K3::Erp::Options::InterventionStepStatus\n- `priorities` → K3::Erp::Options::Priority\n- `project_priorities` → K3::Erp::Options::ProjectPriority\n- `project_categories` → K3::Erp::Options::ProjectCategory\n- `resource_skills` → K3::Erp::Options::ResourceSkill\n- `resource_types` → K3::Erp::Options::ResourceType\n- `resource_event_locations` → K3::Erp::Options::ResourceEventLocation\n- `resource_event_statuses` → K3::Erp::Options::ResourceEventStatus\n- `resource_event_categories` → K3::Erp::Options::ResourceEventCategory\n- `equipment_statuses` → K3::Erp::Options::EquipmentStatus\n- `prestation_types` → K3::Erp::Options::PrestationType\n- `competencies` → K3::Erp::Competency\n\n**K3::Product - Produits et catalogues :**\n- `product_unities` → K3::Product::Options::ProductUnit\n- `product_brands` → K3::Product::Options::ProductBrand\n- `product_families` → K3::Product::Options::ProductFamily\n- `product_shelves` → K3::Product::Options::ProductShelf\n- `product_categories` → K3::Product::Options::ProductCategory\n- `product_cost_categories` → K3::Product::Options::CostCategory\n- `product_cost_types` → K3::Product::Options::CostType\n\n**K3::Sale - Ventes et facturation :**\n- `document_reference_formats` → K3::Sale::Options::DocumentReferenceFormat\n- `document_row_types` → K3::Sale::Options::DocumentRowType\n- `document_text_row_types` → K3::Sale::Options::DocumentTextRowType\n- `quote_statuses` → K3::Sale::Options::QuoteStatus\n- `invoice_statuses` → K3::Sale::Options::InvoiceStatus\n- `payment_statuses` → K3::Sale::Options::PaymentStatus\n- `order_statuses` → K3::Sale::Options::OrderStatus\n- `customer_order_statuses` → K3::Sale::Options::CustomerOrderStatus\n- `supplier_delivery_statuses` → K3::Sale::Options::SupplierDeliveryStatus\n- `delivery_statuses` → K3::Sale::Options::DeliveryStatus\n- `quote_cancel_explanations` → K3::Sale::Options::QuoteCancelExplanation\n- `document_note` → K3::Sale::Options::DocumentNote\n- `reminder_types` → K3::Sale::Options::ReminderType\n- `reminder_gravities` → K3::Sale::Options::ReminderGravity\n- `folder_status` → K3::Sale::Options::FolderStatus\n- `return_voucher_statuses` → K3::Sale::Options::ReturnVoucherStatus\n- `transfer_voucher_statuses` → K3::Sale::Options::TransferVoucherStatus\n- `activity_types` → K3::Sale::Options::ActivityType\n- `delivery_progressions` → K3::Sale::Options::DeliveryProgression\n- `debt_statuses` → K3::Sale::Options::DebtStatus\n- `offer_template_types` → K3::Sale::Options::OfferTemplateType\n\n**K3::Stock - Gestion de stock :**\n- `change_types` → K3::Stock::Options::ChangeType\n- `expense_row_categories` → K3::Stock::Options::ExpenseRowCategory\n- `expense_statuses` → K3::Stock::Options::ExpenseStatus\n\n","parameters":[{"name":"search","in":"query","required":false,"description":"Tableau des différents attributs de recherche","schema":{"type":"object","properties":{"type":{"type":"string","description":"Type"},"value":{"type":"string","description":"Value"},"default":{"type":"boolean","description":"Default"},"code":{"type":"string","description":"Code"},"icon":{"type":"string","description":"Icon"},"sort":{"type":"integer","description":"Sort"},"created_by_id":{"type":"integer","description":"Created by id"},"updated_by_id":{"type":"integer","description":"Updated by id"},"inactivated_at":{"type":"string","description":"Inactivated at"},"is_readonly":{"type":"boolean","description":"Is readonly"},"open":{"type":"boolean","description":"Open"},"accept":{"type":"boolean","description":"Accept"},"secondary_code":{"type":"string","description":"Secondary code"},"module":{"type":"string","description":"Module"},"account_allocation_id":{"type":"integer","description":"Account allocation id"},"parent_id":{"type":"integer","description":"Parent id"},"key":{"type":"string","description":"Key"},"code_compta":{"type":"string","description":"Code compta"}},"additionalProperties":false}},{"name":"sort","in":"query","required":false,"description":"Tableau des différents attributs","schema":{"type":"object","properties":{"type":{"type":"string","description":"type DESC NULLS LAST(Descendant) ou type (Ascendant)"},"value":{"type":"string","description":"value DESC NULLS LAST(Descendant) ou value (Ascendant)"},"default":{"type":"string","description":"default DESC NULLS LAST(Descendant) ou default (Ascendant)"},"code":{"type":"string","description":"code DESC NULLS LAST(Descendant) ou code (Ascendant)"},"icon":{"type":"string","description":"icon DESC NULLS LAST(Descendant) ou icon (Ascendant)"},"sort":{"type":"string","description":"sort DESC NULLS LAST(Descendant) ou sort (Ascendant)"},"created_by_id":{"type":"string","description":"created_by_id DESC NULLS LAST(Descendant) ou created_by_id (Ascendant)"},"updated_by_id":{"type":"string","description":"updated_by_id DESC NULLS LAST(Descendant) ou updated_by_id (Ascendant)"},"inactivated_at":{"type":"string","description":"inactivated_at DESC NULLS LAST(Descendant) ou inactivated_at (Ascendant)"},"is_readonly":{"type":"string","description":"is_readonly DESC NULLS LAST(Descendant) ou is_readonly (Ascendant)"},"open":{"type":"string","description":"open DESC NULLS LAST(Descendant) ou open (Ascendant)"},"accept":{"type":"string","description":"accept DESC NULLS LAST(Descendant) ou accept (Ascendant)"},"secondary_code":{"type":"string","description":"secondary_code DESC NULLS LAST(Descendant) ou secondary_code (Ascendant)"},"module":{"type":"string","description":"module DESC NULLS LAST(Descendant) ou module (Ascendant)"},"account_allocation_id":{"type":"string","description":"account_allocation_id DESC NULLS LAST(Descendant) ou account_allocation_id (Ascendant)"},"parent_id":{"type":"string","description":"parent_id DESC NULLS LAST(Descendant) ou parent_id (Ascendant)"},"key":{"type":"string","description":"key DESC NULLS LAST(Descendant) ou key (Ascendant)"},"code_compta":{"type":"string","description":"code_compta DESC NULLS LAST(Descendant) ou code_compta (Ascendant)"},"default_sort":{"type":"string","description":"default_sort DESC NULLS LAST(Descendant) ou default_sort (Ascendant)"}},"additionalProperties":false}},{"name":"page","in":"query","required":false,"description":"Page number for pagination","schema":{"type":"integer"}},{"name":"per_page","in":"query","required":false,"description":"Number of items per page (-1 for all items/options mode)","schema":{"type":"integer"}},{"name":"scope","in":"query","required":false,"description":"Filter scope to apply","schema":{"type":"string"}},{"name":"tag","in":"query","required":false,"description":"Filter by tag name","schema":{"type":"string"}},{"name":"with_deleted","in":"query","required":false,"description":"Include soft-deleted items (1 to include, 0 or omit to exclude)","schema":{"type":"integer"}},{"name":"only_deleted","in":"query","required":false,"description":"Show only soft-deleted items (1 for only deleted)","schema":{"type":"integer"}},{"name":"with_inactivated","in":"query","required":false,"description":"Include inactivated items (1 to include)","schema":{"type":"integer"}},{"name":"only_inactivated","in":"query","required":false,"description":"Show only inactivated items (1 for only inactivated)","schema":{"type":"integer"}},{"name":"force_sort","in":"query","required":false,"description":"Force sorting even when custom search is used","schema":{"type":"string"}},{"name":"group_ids","in":"query","required":false,"description":"Comma-separated group IDs to filter by","schema":{"type":"string"}},{"name":"json_format","in":"query","required":false,"description":"Custom serialization format","schema":{"type":"string"}}],"responses":{"200":{"description":"List retrieved successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/option_list"}}}},"401":{"description":"Unauthorized - Invalid token"}}}}}}
```

## Create civility

> Create a new Option civility. Civility

```json
{"openapi":"3.1.1","info":{"title":"K3 Core API V1","version":"v1"},"servers":[{"url":"https://api.geosquare.fr/","description":"Environnement de production"}],"security":[{"bearer_auth":[]}],"components":{"securitySchemes":{"bearer_auth":{"type":"http","scheme":"bearer"}},"schemas":{"option_detail":{"type":"object","properties":{"option_label":{"type":["string","null"],"description":"Option label"},"option_id":{"type":["integer","string","null"],"description":"Option id"},"id":{"type":["integer","null"],"description":"Id"},"model_name":{"type":["string","null"],"description":"Model name"},"app_id":{"type":["integer","string","null"],"description":"App id"},"module":{"type":["string","null"],"description":"Module"},"module_human_name":{"type":["string","null"],"description":"Module human name"},"model_class_name":{"type":["string","null"],"description":"Model class name"},"inactivated_at":{"type":["string","null"],"description":"Inactivated at"},"deleted_at":{"type":["string","null"],"description":"Deleted at"},"created_at":{"type":["string","null"],"description":"Created at"},"updated_at":{"type":["string","null"],"description":"Updated at"},"tag_names":{"type":["array","null"],"items":{"type":"object"}},"created_by_id":{"type":["integer","string","null"],"description":"Created by id"},"created_by":{"type":["string","null"],"description":"Created by"},"updated_by_id":{"type":["integer","string","null"],"description":"Updated by id"},"updated_by":{"type":["string","null"],"description":"Updated by"},"value":{"type":["string","null"],"description":"Value"},"key":{"type":["string","null"],"description":"Key"},"code":{"type":["string","null"],"description":"Code"},"default":{"type":["null","boolean"]},"is_readonly":{"type":"null","description":"Is readonly"},"open":{"type":["boolean","null"],"description":"Open"},"accept":{"type":["boolean","null"],"description":"Accept"},"sort":{"type":["integer","null"],"description":"Sort"},"secondary_code":{"type":["string","null"],"description":"Secondary code"},"code_compta":{"type":["string","null"],"description":"Code compta"},"code_compta_achat":{"type":["string","null"],"description":"Code compta achat"},"account_allocation_id":{"type":["integer","string","null"],"description":"Account allocation id"},"parent_id":{"type":["integer","string","null"],"description":"Parent id"},"account_allocation":{"type":"null","description":"Account allocation"},"parent":{"type":"null","description":"Parent"},"children":{"type":["array","null"],"items":{"type":"object"}}},"required":["option_label","model_name","app_id","module","module_human_name","model_class_name","tag_names"],"additionalProperties":true},"option_params":{"type":"object","properties":{"civilities":{"type":"object","properties":{"value":{"type":["string","null"],"description":"Value"},"key":{"type":["string","null"],"description":"Key"},"code":{"type":["string","null"],"description":"Code"},"secondary_code":{"type":["string","null"],"description":"Secondary code"},"default":{"type":["boolean","null"],"description":"Default"},"open":{"type":["boolean","null"],"description":"Open"},"accept":{"type":["boolean","null"],"description":"Accept"},"parent_id":{"type":["integer","null"],"description":"Parent id"},"account_allocation_id":{"type":["integer","null"],"description":"Account allocation id"}},"required":[]}},"required":["civilities"]}}},"paths":{"/options/civilities":{"post":{"summary":"Create civility","tags":["Option - Civilities"],"description":"Create a new Option civility. Civility","parameters":[],"responses":{"200":{"description":"Created successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/option_detail"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/option_params"}}}}}}}}
```

## New civility form data

> Get form data for creating new civility

```json
{"openapi":"3.1.1","info":{"title":"K3 Core API V1","version":"v1"},"servers":[{"url":"https://api.geosquare.fr/","description":"Environnement de production"}],"security":[{"bearer_auth":[]}],"components":{"securitySchemes":{"bearer_auth":{"type":"http","scheme":"bearer"}},"schemas":{"option_detail":{"type":"object","properties":{"option_label":{"type":["string","null"],"description":"Option label"},"option_id":{"type":["integer","string","null"],"description":"Option id"},"id":{"type":["integer","null"],"description":"Id"},"model_name":{"type":["string","null"],"description":"Model name"},"app_id":{"type":["integer","string","null"],"description":"App id"},"module":{"type":["string","null"],"description":"Module"},"module_human_name":{"type":["string","null"],"description":"Module human name"},"model_class_name":{"type":["string","null"],"description":"Model class name"},"inactivated_at":{"type":["string","null"],"description":"Inactivated at"},"deleted_at":{"type":["string","null"],"description":"Deleted at"},"created_at":{"type":["string","null"],"description":"Created at"},"updated_at":{"type":["string","null"],"description":"Updated at"},"tag_names":{"type":["array","null"],"items":{"type":"object"}},"created_by_id":{"type":["integer","string","null"],"description":"Created by id"},"created_by":{"type":["string","null"],"description":"Created by"},"updated_by_id":{"type":["integer","string","null"],"description":"Updated by id"},"updated_by":{"type":["string","null"],"description":"Updated by"},"value":{"type":["string","null"],"description":"Value"},"key":{"type":["string","null"],"description":"Key"},"code":{"type":["string","null"],"description":"Code"},"default":{"type":["null","boolean"]},"is_readonly":{"type":"null","description":"Is readonly"},"open":{"type":["boolean","null"],"description":"Open"},"accept":{"type":["boolean","null"],"description":"Accept"},"sort":{"type":["integer","null"],"description":"Sort"},"secondary_code":{"type":["string","null"],"description":"Secondary code"},"code_compta":{"type":["string","null"],"description":"Code compta"},"code_compta_achat":{"type":["string","null"],"description":"Code compta achat"},"account_allocation_id":{"type":["integer","string","null"],"description":"Account allocation id"},"parent_id":{"type":["integer","string","null"],"description":"Parent id"},"account_allocation":{"type":"null","description":"Account allocation"},"parent":{"type":"null","description":"Parent"},"children":{"type":["array","null"],"items":{"type":"object"}}},"required":["option_label","model_name","app_id","module","module_human_name","model_class_name","tag_names"],"additionalProperties":true}}},"paths":{"/options/civilities/new":{"get":{"summary":"New civility form data","tags":["Option - Civilities"],"description":"Get form data for creating new civility","responses":{"200":{"description":"Form data retrieved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/option_detail"}}}}}}}}}
```

## Show civility

> Get a specific civility by ID

```json
{"openapi":"3.1.1","info":{"title":"K3 Core API V1","version":"v1"},"servers":[{"url":"https://api.geosquare.fr/","description":"Environnement de production"}],"security":[{"bearer_auth":[]}],"components":{"securitySchemes":{"bearer_auth":{"type":"http","scheme":"bearer"}},"schemas":{"option_detail":{"type":"object","properties":{"option_label":{"type":["string","null"],"description":"Option label"},"option_id":{"type":["integer","string","null"],"description":"Option id"},"id":{"type":["integer","null"],"description":"Id"},"model_name":{"type":["string","null"],"description":"Model name"},"app_id":{"type":["integer","string","null"],"description":"App id"},"module":{"type":["string","null"],"description":"Module"},"module_human_name":{"type":["string","null"],"description":"Module human name"},"model_class_name":{"type":["string","null"],"description":"Model class name"},"inactivated_at":{"type":["string","null"],"description":"Inactivated at"},"deleted_at":{"type":["string","null"],"description":"Deleted at"},"created_at":{"type":["string","null"],"description":"Created at"},"updated_at":{"type":["string","null"],"description":"Updated at"},"tag_names":{"type":["array","null"],"items":{"type":"object"}},"created_by_id":{"type":["integer","string","null"],"description":"Created by id"},"created_by":{"type":["string","null"],"description":"Created by"},"updated_by_id":{"type":["integer","string","null"],"description":"Updated by id"},"updated_by":{"type":["string","null"],"description":"Updated by"},"value":{"type":["string","null"],"description":"Value"},"key":{"type":["string","null"],"description":"Key"},"code":{"type":["string","null"],"description":"Code"},"default":{"type":["null","boolean"]},"is_readonly":{"type":"null","description":"Is readonly"},"open":{"type":["boolean","null"],"description":"Open"},"accept":{"type":["boolean","null"],"description":"Accept"},"sort":{"type":["integer","null"],"description":"Sort"},"secondary_code":{"type":["string","null"],"description":"Secondary code"},"code_compta":{"type":["string","null"],"description":"Code compta"},"code_compta_achat":{"type":["string","null"],"description":"Code compta achat"},"account_allocation_id":{"type":["integer","string","null"],"description":"Account allocation id"},"parent_id":{"type":["integer","string","null"],"description":"Parent id"},"account_allocation":{"type":"null","description":"Account allocation"},"parent":{"type":"null","description":"Parent"},"children":{"type":["array","null"],"items":{"type":"object"}}},"required":["option_label","model_name","app_id","module","module_human_name","model_class_name","tag_names"],"additionalProperties":true}}},"paths":{"/options/civilities/{id}":{"get":{"summary":"Show civility","tags":["Option - Civilities"],"description":"Get a specific civility by ID","responses":{"200":{"description":"Civility details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/option_detail"}}}},"404":{"description":"Civility not found"}}}}}}
```

## Delete civility

> Delete a civility (soft delete)

```json
{"openapi":"3.1.1","info":{"title":"K3 Core API V1","version":"v1"},"servers":[{"url":"https://api.geosquare.fr/","description":"Environnement de production"}],"security":[{"bearer_auth":[]}],"components":{"securitySchemes":{"bearer_auth":{"type":"http","scheme":"bearer"}},"schemas":{"delete_response":{"type":"object","properties":{}}}},"paths":{"/options/civilities/{id}":{"delete":{"summary":"Delete civility","tags":["Option - Civilities"],"description":"Delete a civility (soft delete)","responses":{"200":{"description":"Deleted successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/delete_response"}}}}}}}}}
```

## Update civility

> Update an existing civility

```json
{"openapi":"3.1.1","info":{"title":"K3 Core API V1","version":"v1"},"servers":[{"url":"https://api.geosquare.fr/","description":"Environnement de production"}],"security":[{"bearer_auth":[]}],"components":{"securitySchemes":{"bearer_auth":{"type":"http","scheme":"bearer"}},"schemas":{"option_detail":{"type":"object","properties":{"option_label":{"type":["string","null"],"description":"Option label"},"option_id":{"type":["integer","string","null"],"description":"Option id"},"id":{"type":["integer","null"],"description":"Id"},"model_name":{"type":["string","null"],"description":"Model name"},"app_id":{"type":["integer","string","null"],"description":"App id"},"module":{"type":["string","null"],"description":"Module"},"module_human_name":{"type":["string","null"],"description":"Module human name"},"model_class_name":{"type":["string","null"],"description":"Model class name"},"inactivated_at":{"type":["string","null"],"description":"Inactivated at"},"deleted_at":{"type":["string","null"],"description":"Deleted at"},"created_at":{"type":["string","null"],"description":"Created at"},"updated_at":{"type":["string","null"],"description":"Updated at"},"tag_names":{"type":["array","null"],"items":{"type":"object"}},"created_by_id":{"type":["integer","string","null"],"description":"Created by id"},"created_by":{"type":["string","null"],"description":"Created by"},"updated_by_id":{"type":["integer","string","null"],"description":"Updated by id"},"updated_by":{"type":["string","null"],"description":"Updated by"},"value":{"type":["string","null"],"description":"Value"},"key":{"type":["string","null"],"description":"Key"},"code":{"type":["string","null"],"description":"Code"},"default":{"type":["null","boolean"]},"is_readonly":{"type":"null","description":"Is readonly"},"open":{"type":["boolean","null"],"description":"Open"},"accept":{"type":["boolean","null"],"description":"Accept"},"sort":{"type":["integer","null"],"description":"Sort"},"secondary_code":{"type":["string","null"],"description":"Secondary code"},"code_compta":{"type":["string","null"],"description":"Code compta"},"code_compta_achat":{"type":["string","null"],"description":"Code compta achat"},"account_allocation_id":{"type":["integer","string","null"],"description":"Account allocation id"},"parent_id":{"type":["integer","string","null"],"description":"Parent id"},"account_allocation":{"type":"null","description":"Account allocation"},"parent":{"type":"null","description":"Parent"},"children":{"type":["array","null"],"items":{"type":"object"}}},"required":["option_label","model_name","app_id","module","module_human_name","model_class_name","tag_names"],"additionalProperties":true},"option_params":{"type":"object","properties":{"civilities":{"type":"object","properties":{"value":{"type":["string","null"],"description":"Value"},"key":{"type":["string","null"],"description":"Key"},"code":{"type":["string","null"],"description":"Code"},"secondary_code":{"type":["string","null"],"description":"Secondary code"},"default":{"type":["boolean","null"],"description":"Default"},"open":{"type":["boolean","null"],"description":"Open"},"accept":{"type":["boolean","null"],"description":"Accept"},"parent_id":{"type":["integer","null"],"description":"Parent id"},"account_allocation_id":{"type":["integer","null"],"description":"Account allocation id"}},"required":[]}},"required":["civilities"]}}},"paths":{"/options/civilities/{id}":{"patch":{"summary":"Update civility","tags":["Option - Civilities"],"description":"Update an existing civility","parameters":[],"responses":{"200":{"description":"Updated successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/option_detail"}}}},"404":{"description":"Civility not found"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/option_params"}}}}}}}}
```

## POST /options/civilities/{id}/active

> Mark civility as active

```json
{"openapi":"3.1.1","info":{"title":"K3 Core API V1","version":"v1"},"servers":[{"url":"https://api.geosquare.fr/","description":"Environnement de production"}],"security":[{"bearer_auth":[]}],"components":{"securitySchemes":{"bearer_auth":{"type":"http","scheme":"bearer"}},"schemas":{"option_detail":{"type":"object","properties":{"option_label":{"type":["string","null"],"description":"Option label"},"option_id":{"type":["integer","string","null"],"description":"Option id"},"id":{"type":["integer","null"],"description":"Id"},"model_name":{"type":["string","null"],"description":"Model name"},"app_id":{"type":["integer","string","null"],"description":"App id"},"module":{"type":["string","null"],"description":"Module"},"module_human_name":{"type":["string","null"],"description":"Module human name"},"model_class_name":{"type":["string","null"],"description":"Model class name"},"inactivated_at":{"type":["string","null"],"description":"Inactivated at"},"deleted_at":{"type":["string","null"],"description":"Deleted at"},"created_at":{"type":["string","null"],"description":"Created at"},"updated_at":{"type":["string","null"],"description":"Updated at"},"tag_names":{"type":["array","null"],"items":{"type":"object"}},"created_by_id":{"type":["integer","string","null"],"description":"Created by id"},"created_by":{"type":["string","null"],"description":"Created by"},"updated_by_id":{"type":["integer","string","null"],"description":"Updated by id"},"updated_by":{"type":["string","null"],"description":"Updated by"},"value":{"type":["string","null"],"description":"Value"},"key":{"type":["string","null"],"description":"Key"},"code":{"type":["string","null"],"description":"Code"},"default":{"type":["null","boolean"]},"is_readonly":{"type":"null","description":"Is readonly"},"open":{"type":["boolean","null"],"description":"Open"},"accept":{"type":["boolean","null"],"description":"Accept"},"sort":{"type":["integer","null"],"description":"Sort"},"secondary_code":{"type":["string","null"],"description":"Secondary code"},"code_compta":{"type":["string","null"],"description":"Code compta"},"code_compta_achat":{"type":["string","null"],"description":"Code compta achat"},"account_allocation_id":{"type":["integer","string","null"],"description":"Account allocation id"},"parent_id":{"type":["integer","string","null"],"description":"Parent id"},"account_allocation":{"type":"null","description":"Account allocation"},"parent":{"type":"null","description":"Parent"},"children":{"type":["array","null"],"items":{"type":"object"}}},"required":["option_label","model_name","app_id","module","module_human_name","model_class_name","tag_names"],"additionalProperties":true}}},"paths":{"/options/civilities/{id}/active":{"post":{"summary":"Mark civility as active","tags":["Option - Civilities"],"responses":{"200":{"description":"Marked as active","content":{"application/json":{"schema":{"$ref":"#/components/schemas/option_detail"}}}}}}}}}
```

## POST /options/civilities/{id}/inactive

> Mark civility as inactive

```json
{"openapi":"3.1.1","info":{"title":"K3 Core API V1","version":"v1"},"servers":[{"url":"https://api.geosquare.fr/","description":"Environnement de production"}],"security":[{"bearer_auth":[]}],"components":{"securitySchemes":{"bearer_auth":{"type":"http","scheme":"bearer"}},"schemas":{"option_detail":{"type":"object","properties":{"option_label":{"type":["string","null"],"description":"Option label"},"option_id":{"type":["integer","string","null"],"description":"Option id"},"id":{"type":["integer","null"],"description":"Id"},"model_name":{"type":["string","null"],"description":"Model name"},"app_id":{"type":["integer","string","null"],"description":"App id"},"module":{"type":["string","null"],"description":"Module"},"module_human_name":{"type":["string","null"],"description":"Module human name"},"model_class_name":{"type":["string","null"],"description":"Model class name"},"inactivated_at":{"type":["string","null"],"description":"Inactivated at"},"deleted_at":{"type":["string","null"],"description":"Deleted at"},"created_at":{"type":["string","null"],"description":"Created at"},"updated_at":{"type":["string","null"],"description":"Updated at"},"tag_names":{"type":["array","null"],"items":{"type":"object"}},"created_by_id":{"type":["integer","string","null"],"description":"Created by id"},"created_by":{"type":["string","null"],"description":"Created by"},"updated_by_id":{"type":["integer","string","null"],"description":"Updated by id"},"updated_by":{"type":["string","null"],"description":"Updated by"},"value":{"type":["string","null"],"description":"Value"},"key":{"type":["string","null"],"description":"Key"},"code":{"type":["string","null"],"description":"Code"},"default":{"type":["null","boolean"]},"is_readonly":{"type":"null","description":"Is readonly"},"open":{"type":["boolean","null"],"description":"Open"},"accept":{"type":["boolean","null"],"description":"Accept"},"sort":{"type":["integer","null"],"description":"Sort"},"secondary_code":{"type":["string","null"],"description":"Secondary code"},"code_compta":{"type":["string","null"],"description":"Code compta"},"code_compta_achat":{"type":["string","null"],"description":"Code compta achat"},"account_allocation_id":{"type":["integer","string","null"],"description":"Account allocation id"},"parent_id":{"type":["integer","string","null"],"description":"Parent id"},"account_allocation":{"type":"null","description":"Account allocation"},"parent":{"type":"null","description":"Parent"},"children":{"type":["array","null"],"items":{"type":"object"}}},"required":["option_label","model_name","app_id","module","module_human_name","model_class_name","tag_names"],"additionalProperties":true}}},"paths":{"/options/civilities/{id}/inactive":{"post":{"summary":"Mark civility as inactive","tags":["Option - Civilities"],"responses":{"200":{"description":"Marked as inactive","content":{"application/json":{"schema":{"$ref":"#/components/schemas/option_detail"}}}}}}}}}
```

## POST /options/civilities/{id}/undelete

> Undelete civility

```json
{"openapi":"3.1.1","info":{"title":"K3 Core API V1","version":"v1"},"servers":[{"url":"https://api.geosquare.fr/","description":"Environnement de production"}],"security":[{"bearer_auth":[]}],"components":{"securitySchemes":{"bearer_auth":{"type":"http","scheme":"bearer"}},"schemas":{"option_detail":{"type":"object","properties":{"option_label":{"type":["string","null"],"description":"Option label"},"option_id":{"type":["integer","string","null"],"description":"Option id"},"id":{"type":["integer","null"],"description":"Id"},"model_name":{"type":["string","null"],"description":"Model name"},"app_id":{"type":["integer","string","null"],"description":"App id"},"module":{"type":["string","null"],"description":"Module"},"module_human_name":{"type":["string","null"],"description":"Module human name"},"model_class_name":{"type":["string","null"],"description":"Model class name"},"inactivated_at":{"type":["string","null"],"description":"Inactivated at"},"deleted_at":{"type":["string","null"],"description":"Deleted at"},"created_at":{"type":["string","null"],"description":"Created at"},"updated_at":{"type":["string","null"],"description":"Updated at"},"tag_names":{"type":["array","null"],"items":{"type":"object"}},"created_by_id":{"type":["integer","string","null"],"description":"Created by id"},"created_by":{"type":["string","null"],"description":"Created by"},"updated_by_id":{"type":["integer","string","null"],"description":"Updated by id"},"updated_by":{"type":["string","null"],"description":"Updated by"},"value":{"type":["string","null"],"description":"Value"},"key":{"type":["string","null"],"description":"Key"},"code":{"type":["string","null"],"description":"Code"},"default":{"type":["null","boolean"]},"is_readonly":{"type":"null","description":"Is readonly"},"open":{"type":["boolean","null"],"description":"Open"},"accept":{"type":["boolean","null"],"description":"Accept"},"sort":{"type":["integer","null"],"description":"Sort"},"secondary_code":{"type":["string","null"],"description":"Secondary code"},"code_compta":{"type":["string","null"],"description":"Code compta"},"code_compta_achat":{"type":["string","null"],"description":"Code compta achat"},"account_allocation_id":{"type":["integer","string","null"],"description":"Account allocation id"},"parent_id":{"type":["integer","string","null"],"description":"Parent id"},"account_allocation":{"type":"null","description":"Account allocation"},"parent":{"type":"null","description":"Parent"},"children":{"type":["array","null"],"items":{"type":"object"}}},"required":["option_label","model_name","app_id","module","module_human_name","model_class_name","tag_names"],"additionalProperties":true}}},"paths":{"/options/civilities/{id}/undelete":{"post":{"summary":"Undelete civility","tags":["Option - Civilities"],"responses":{"200":{"description":"Undeleted successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/option_detail"}}}}}}}}}
```

## Copy civility

> Get copy of civility for duplication

```json
{"openapi":"3.1.1","info":{"title":"K3 Core API V1","version":"v1"},"servers":[{"url":"https://api.geosquare.fr/","description":"Environnement de production"}],"security":[{"bearer_auth":[]}],"components":{"securitySchemes":{"bearer_auth":{"type":"http","scheme":"bearer"}},"schemas":{"option_detail":{"type":"object","properties":{"option_label":{"type":["string","null"],"description":"Option label"},"option_id":{"type":["integer","string","null"],"description":"Option id"},"id":{"type":["integer","null"],"description":"Id"},"model_name":{"type":["string","null"],"description":"Model name"},"app_id":{"type":["integer","string","null"],"description":"App id"},"module":{"type":["string","null"],"description":"Module"},"module_human_name":{"type":["string","null"],"description":"Module human name"},"model_class_name":{"type":["string","null"],"description":"Model class name"},"inactivated_at":{"type":["string","null"],"description":"Inactivated at"},"deleted_at":{"type":["string","null"],"description":"Deleted at"},"created_at":{"type":["string","null"],"description":"Created at"},"updated_at":{"type":["string","null"],"description":"Updated at"},"tag_names":{"type":["array","null"],"items":{"type":"object"}},"created_by_id":{"type":["integer","string","null"],"description":"Created by id"},"created_by":{"type":["string","null"],"description":"Created by"},"updated_by_id":{"type":["integer","string","null"],"description":"Updated by id"},"updated_by":{"type":["string","null"],"description":"Updated by"},"value":{"type":["string","null"],"description":"Value"},"key":{"type":["string","null"],"description":"Key"},"code":{"type":["string","null"],"description":"Code"},"default":{"type":["null","boolean"]},"is_readonly":{"type":"null","description":"Is readonly"},"open":{"type":["boolean","null"],"description":"Open"},"accept":{"type":["boolean","null"],"description":"Accept"},"sort":{"type":["integer","null"],"description":"Sort"},"secondary_code":{"type":["string","null"],"description":"Secondary code"},"code_compta":{"type":["string","null"],"description":"Code compta"},"code_compta_achat":{"type":["string","null"],"description":"Code compta achat"},"account_allocation_id":{"type":["integer","string","null"],"description":"Account allocation id"},"parent_id":{"type":["integer","string","null"],"description":"Parent id"},"account_allocation":{"type":"null","description":"Account allocation"},"parent":{"type":"null","description":"Parent"},"children":{"type":["array","null"],"items":{"type":"object"}}},"required":["option_label","model_name","app_id","module","module_human_name","model_class_name","tag_names"],"additionalProperties":true}}},"paths":{"/options/civilities/{id}/copy":{"get":{"summary":"Copy civility","tags":["Option - Civilities"],"description":"Get copy of civility for duplication","responses":{"200":{"description":"Copy data retrieved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/option_detail"}}}}}}}}}
```

## Get civilities IDs

> Get list of civilities IDs

```json
{"openapi":"3.1.1","info":{"title":"K3 Core API V1","version":"v1"},"servers":[{"url":"https://api.geosquare.fr/","description":"Environnement de production"}],"security":[{"bearer_auth":[]}],"components":{"securitySchemes":{"bearer_auth":{"type":"http","scheme":"bearer"}},"schemas":{"ids_response":{"type":"object","properties":{"ids":{"type":"array","items":{"type":"integer"}}},"required":["ids"]}}},"paths":{"/options/civilities/ids":{"get":{"summary":"Get civilities IDs","tags":["Option - Civilities"],"description":"Get list of civilities IDs","parameters":[{"name":"search","in":"query","required":false,"description":"Tableau des différents attributs de recherche","schema":{"type":"object","properties":{"type":{"type":"string","description":"Type"},"value":{"type":"string","description":"Value"},"default":{"type":"boolean","description":"Default"},"code":{"type":"string","description":"Code"},"icon":{"type":"string","description":"Icon"},"sort":{"type":"integer","description":"Sort"},"created_by_id":{"type":"integer","description":"Created by id"},"updated_by_id":{"type":"integer","description":"Updated by id"},"inactivated_at":{"type":"string","description":"Inactivated at"},"is_readonly":{"type":"boolean","description":"Is readonly"},"open":{"type":"boolean","description":"Open"},"accept":{"type":"boolean","description":"Accept"},"secondary_code":{"type":"string","description":"Secondary code"},"module":{"type":"string","description":"Module"},"account_allocation_id":{"type":"integer","description":"Account allocation id"},"parent_id":{"type":"integer","description":"Parent id"},"key":{"type":"string","description":"Key"},"code_compta":{"type":"string","description":"Code compta"}},"additionalProperties":false}},{"name":"sort","in":"query","required":false,"description":"Tableau des différents attributs","schema":{"type":"object","properties":{"type":{"type":"string","description":"type DESC NULLS LAST(Descendant) ou type (Ascendant)"},"value":{"type":"string","description":"value DESC NULLS LAST(Descendant) ou value (Ascendant)"},"default":{"type":"string","description":"default DESC NULLS LAST(Descendant) ou default (Ascendant)"},"code":{"type":"string","description":"code DESC NULLS LAST(Descendant) ou code (Ascendant)"},"icon":{"type":"string","description":"icon DESC NULLS LAST(Descendant) ou icon (Ascendant)"},"sort":{"type":"string","description":"sort DESC NULLS LAST(Descendant) ou sort (Ascendant)"},"created_by_id":{"type":"string","description":"created_by_id DESC NULLS LAST(Descendant) ou created_by_id (Ascendant)"},"updated_by_id":{"type":"string","description":"updated_by_id DESC NULLS LAST(Descendant) ou updated_by_id (Ascendant)"},"inactivated_at":{"type":"string","description":"inactivated_at DESC NULLS LAST(Descendant) ou inactivated_at (Ascendant)"},"is_readonly":{"type":"string","description":"is_readonly DESC NULLS LAST(Descendant) ou is_readonly (Ascendant)"},"open":{"type":"string","description":"open DESC NULLS LAST(Descendant) ou open (Ascendant)"},"accept":{"type":"string","description":"accept DESC NULLS LAST(Descendant) ou accept (Ascendant)"},"secondary_code":{"type":"string","description":"secondary_code DESC NULLS LAST(Descendant) ou secondary_code (Ascendant)"},"module":{"type":"string","description":"module DESC NULLS LAST(Descendant) ou module (Ascendant)"},"account_allocation_id":{"type":"string","description":"account_allocation_id DESC NULLS LAST(Descendant) ou account_allocation_id (Ascendant)"},"parent_id":{"type":"string","description":"parent_id DESC NULLS LAST(Descendant) ou parent_id (Ascendant)"},"key":{"type":"string","description":"key DESC NULLS LAST(Descendant) ou key (Ascendant)"},"code_compta":{"type":"string","description":"code_compta DESC NULLS LAST(Descendant) ou code_compta (Ascendant)"},"default_sort":{"type":"string","description":"default_sort DESC NULLS LAST(Descendant) ou default_sort (Ascendant)"}},"additionalProperties":false}},{"name":"page","in":"query","required":false,"description":"Page number for pagination","schema":{"type":"integer"}},{"name":"per_page","in":"query","required":false,"description":"Number of items per page (-1 for all items/options mode)","schema":{"type":"integer"}},{"name":"scope","in":"query","required":false,"description":"Filter scope to apply","schema":{"type":"string"}},{"name":"tag","in":"query","required":false,"description":"Filter by tag name","schema":{"type":"string"}},{"name":"with_deleted","in":"query","required":false,"description":"Include soft-deleted items (1 to include, 0 or omit to exclude)","schema":{"type":"integer"}},{"name":"only_deleted","in":"query","required":false,"description":"Show only soft-deleted items (1 for only deleted)","schema":{"type":"integer"}},{"name":"with_inactivated","in":"query","required":false,"description":"Include inactivated items (1 to include)","schema":{"type":"integer"}},{"name":"only_inactivated","in":"query","required":false,"description":"Show only inactivated items (1 for only inactivated)","schema":{"type":"integer"}},{"name":"force_sort","in":"query","required":false,"description":"Force sorting even when custom search is used","schema":{"type":"string"}},{"name":"group_ids","in":"query","required":false,"description":"Comma-separated group IDs to filter by","schema":{"type":"string"}},{"name":"json_format","in":"query","required":false,"description":"Custom serialization format","schema":{"type":"string"}}],"responses":{"200":{"description":"IDs retrieved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ids_response"}}}}}}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://geosquare-1.gitbook.io/geosquare-docs/option-civilities.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.