Articles

Modèles pour les articles et catégories d’articles dans l’API Henrri Connect.

Attributs: - ItemCategoryRequest: Représente une requête de catégorie d’article. - ItemCategoryType: Représente un type de catégorie d’article. - ItemCategory: Représente une catégorie d’article. - Item: Représente un article.

class henrri_connect.models.items.ItemCategoryRequest(**data)

Bases : CamelModel

Représente une requête de catégorie d’article dans l’API Henrri Connect.

page

Index de la page de la requête (entre 1 et 2 147 483 647, defaut 1).

Type:

int

limit

Nombre d’articles par page (entre 1 et 100, défaut 50).

Type:

int

search

Chaine de recherche.

Type:

str

sort_by

Champ de tri.

Type:

str

sort_order

Ordre de tri (Ascending ou Descending).

Type:

str

min_id

Identifiant minimal de l’article (entre 1 et 2 147 483 647).

Type:

int

from_date

Date de début.

Type:

str

to_date

Date de fin.

Type:

str

page: int

limit: int

search: str

sort_by: str | None

sort_order: str | None

min_id: int | None

from_date: str | None

to_date: str | None

model_config: ClassVar[ConfigDict] = {'alias_generator': <function to_camel>, 'populate_by_name': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class henrri_connect.models.items.ItemCategoryType(**data)

Bases : CamelModel

Représente un type de catégorie d’article dans l’API Henrri Connect.

Attributs: - id: Identifiant unique du type de catégorie d’article. - label: Libellé du type de catégorie d’article. - item_category_content_kind: Type de contenu de la catégorie d’article. - item_category_kind: Type de catégorie d’article.

id: int | None

label: str | None

item_category_content_kind: str

item_category_kind: str

model_config: ClassVar[ConfigDict] = {'alias_generator': <function to_camel>, 'populate_by_name': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class henrri_connect.models.items.ItemCategory(**data)

Bases : CamelModel

Représente une catégorie d’article dans l’API Henrri Connect.

Attributs: - id: Identifiant unique de la catégorie d’article. - type: Type de la catégorie d’article. - label: Libellé de la catégorie d’article. - margin_percent: Pourcentage de marge de la catégorie d’article. - hourly_rate: Tarif horaire de la catégorie d’article. - vat: Taux de TVA de la catégorie d’article. - is_added_to_revenue: Indique si les articles de la cat. sont ajoutés au chiffre d’affaires. - is_default: Indique si la catégorie d’article est la catégorie par défaut. - is_deleted: Indique si la catégorie d’article est supprimée. - item_category_kind: Type de la catégorie d’article (service, produit, ou fourniture).

id: int | None

type: ItemCategoryType | None

label: str | None

margin_percent: float

hourly_rate: float

vat: float

is_added_to_revenue: bool

is_default: bool

is_deleted: bool

item_category_kind: str

model_config: ClassVar[ConfigDict] = {'alias_generator': <function to_camel>, 'populate_by_name': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class henrri_connect.models.items.Item(**data)

Bases : CamelModel

Représente un article dans l’API Henrri Connect.

Attributs: - id: Identifiant unique de l’article. - reference: Référence de l’article. - description: Description de l’article. - is_tax_included: Indique si la taxe est incluse dans le prix. - selling_price_without_tax: Prix de vente hors taxe de l’article. - selling_price_with_tax: Prix de vente TTC de l’article. - purchase_price: Prix d’achat de l’article. - vat_percent: Taux de TVA de l’article. - is_a_group: Indique si l’article est un groupe d’articles. - item_category: Catégorie de l’article (si applicable). - item_category_id: Identifiant de la catégorie de l’article (si applicable). - unit_id: Identifiant de l’unité de l’article (si applicable). - parent_item_id: Id d’article parent si l’article est un élément d’un grp d’articles (si applicable). - creation_date: Date de création de l’article. - links: Liste de liens associés à l’article (si applicable).

id: int | None

reference: str | None

description: str | None

is_tax_included: bool

selling_price_without_tax: float | None

selling_price_with_tax: float | None

purchase_price: float

vat_percent: float

is_a_group: bool

item_category: ItemCategory | None

item_category_id: int | None

unit_id: int | None

parent_item_id: int | None

creation_date: str

links: list[Link] | None

model_config: ClassVar[ConfigDict] = {'alias_generator': <function to_camel>, 'populate_by_name': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class henrri_connect.models.items.ItemsQuery(**data)

Bases : CamelModel

Représente une requête de catégorie d’article dans l’API Henrri Connect.

Attributs: - page (int) : Index de la page de la requête (entre 1 et 2 147 483 647, defaut 1). - limit (int) : Nombre d’articles par page (entre 1 et 100, défaut 50). - search (str) : Chaine de recherche. - sort_by (str) : Champ de tri. - sort_order (SortOrder) : Ordre de tri (Ascending ou Descending). - min_id (int) : Identifiant minimal de l’article (entre 1 et 2 147 483 647). - from_date (str) : Date de début. - to_date (str) : Date de fin.

page: int

limit: int

search: str | None

sort_by: str | None

sort_order: SortOrder | None

min_id: int

from_date: str

to_date: str

model_config: ClassVar[ConfigDict] = {'alias_generator': <function to_camel>, 'populate_by_name': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].