Autres modèles

Enums

Module contenant les énumérations utilisées dans les modèles de données.

Attributs - CustomerType: Type de client pour les clients dans l’API Henrri Connect. - SortOrder: Ordre de tri pour les listes d’articles et de catégories d’articles. - DocumentKind: Type de document pour les documents commerciaux. - DocumentState: État d’un document commercial. - DocumentLineKind: Type de ligne pour les lignes de document commercial. - UnitKind: Type d’unité pour les unités de mesure. - CompanyIdentifierType: Type d’identifiant pour les entreprises. - ItemCategoryKind: Type de catégorie d’articles. - ItemCategoryContentKind: Type de contenu pour les catégories d’articles.

class henrri_connect.models.base.enums.CustomerType(*values)

Bases : str, Enum

Type de client pour les clients dans l’API Henrri Connect.

Attributs - INDIVIDUAL: Client individuel. - COMPANY: Client entreprise.

INDIVIDUAL = 'individual'

COMPANY = 'professional'

class henrri_connect.models.base.enums.SortOrder(*values)

Bases : str, Enum

Ordre de tri pour les listes d’articles et de catégories d’articles.

Attributs - ASCENDING: Tri ascendant. - DESCENDING: Tri descendant.

ASCENDING = 'Ascending'

DESCENDING = 'Descending'

class henrri_connect.models.base.enums.DocumentKind(*values)

Bases : str, Enum

Type de document pour les documents commerciaux.

Attributs - INVOICE: Facture. - CREDIT_NOTE: Avoir. - DELIVERY_NOTE: Bon de livraison. - QUOTATION: Devis. - WORK_ORDER: Bon de commande. - PROGRESS_INVOICE: Facture de progression. - ORDER: Commande. - AMENDMENT: Avenant. - MISCELLANEOUS: Divers. - SUMMARY: Sommaire. - DEPOSIT_INVOICE: Facture de caution. - DEPOSIT_RECEIPT: Recueil de caution.

INVOICE = 'Invoice'

CREDIT_NOTE = 'CreditNote'

DELIVERY_NOTE = 'DeliveryNote'

QUOTATION = 'Quotation'

WORK_ORDER = 'WorkOrder'

PROGRESS_INVOICE = 'ProgressInvoice'

ORDER = 'Order'

AMENDMENT = 'Amendment'

MISCELLANEOUS = 'Miscellaneous'

SUMMARY = 'Summary'

DEPOSIT_INVOICE = 'DepositInvoice'

DEPOSIT_RECEIPT = 'DepositReceipt'

class henrri_connect.models.base.enums.DocumentState(*values)

Bases : str, Enum

État d’un document commercial.

Attributs - FINALIZED: Finalisé. - PENDING: En attente.

FINALIZED = 'Finalized'

PENDING = 'Pending'

class henrri_connect.models.base.enums.DocumentLineKind(*values)

Bases : str, Enum

Type de ligne pour les lignes de document commercial.

Attributs - NONE: Aucun. - ITEM: Article. - TOTAL: Total. - SUBTOTAL: Sous-total. - TEXT: Texte. - GROUP: Groupe d’articles. - ADJUSTMENT: Ajustement de groupe d’articles. - LINE_BREAK: Saut de ligne. - HORIZONTAL_TRAIT: Trait horizontal.

NONE = 'None'

ITEM = 'Item'

TOTAL = 'Total'

SUBTOTAL = 'Subtotal'

TEXT = 'Text'

GROUP = 'Group'

ADJUSTMENT = 'Adjustment'

LINE_BREAK = 'LineBreak'

HORIZONTAL_TRAIT = 'HorizontalTrait'

class henrri_connect.models.base.enums.UnitKind(*values)

Bases : str, Enum

Type d’unité pour les unités de mesure.

Attributs - HOURLY: Horaire. - METER: Mètre. - CENTIMETER: Centimètre. - SQUARE_CENTIMETER: Centimètre carré. - CUBIC_CENTIMETER: Centimètre cube. - DECIMETER: Décimètre. - SQUARE_METER: Mètre carré. - CUBIC_METER: Mètre cube. - MILLIMETER: Millimètre. - SQUARE_MILLIMETER: Millimètre carré. - CUBIC_MILLIMETER: Millimètre cube. - KILOGRAM: Kilogramme. - GRAM: Gramme. - METRIC_TON: Tonne métrique. - SPECIFIC: Spécifique. - FLAT_RATE: Forfait. - LINEAR_METER: Mètre linéaire. - UNIT: Unité. - CUSTOM: Personnalisé.

HOURLY = 'Hourly'

METER = 'Meter'

CENTIMETER = 'Centimeter'

SQUARE_CENTIMETER = 'SquareCentimeter'

CUBIC_CENTIMETER = 'CubicCentimeter'

DECIMETER = 'Decimeter'

SQUARE_METER = 'SquareMeter'

CUBIC_METER = 'CubicMeter'

MILLIMETER = 'Millimeter'

SQUARE_MILLIMETER = 'SquareMillimeter'

CUBIC_MILLIMETER = 'CubicMillimeter'

KILOGRAM = 'Kilogram'

GRAM = 'Gram'

METRIC_TON = 'MetricTon'

SPECIFIC = 'Specific'

FLAT_RATE = 'FlatRate'

LINEAR_METER = 'LinearMeter'

UNIT = 'Unit'

CUSTOM = 'Custom'

class henrri_connect.models.base.enums.CompanyIdentifierType(*values)

Bases : str, Enum

Type d’identifiant pour les entreprises.

Attributs - SIRET: SIRET. - BCE: BCE. - UNKNOWN: Inconnu.

SIRET = 'Siret'

BCE = 'Bce'

UNKNOWN = 'Unknown'

class henrri_connect.models.base.enums.ItemCategoryKind(*values)

Bases : str, Enum

Type de catégorie d’articles.

Attributs - SERVICE: Service. - PRODUCT: Produit. - MIXED: Mixte.

SERVICE = 'Service'

PRODUCT = 'Product'

MIXED = 'Mixed'

class henrri_connect.models.base.enums.ItemCategoryContentKind(*values)

Bases : str, Enum

Type de contenu pour les catégories d’articles.

Attributs - SUPPLY: Approvisionnement. - FLAT_SERVICE: Service forfaitaire. - HOURLY_SERVICE: Service horaire. - MIXED: Mixte. - SUBCONTRACTING: Sous-traitance. - MACHINE_TIME: Temps machine. - SPECIAL_SALE: Vente spéciale. - USED_VEHICLE: Véhicule d’occasion.

SUPPLY = 'Supply'

FLAT_SERVICE = 'FlatService'

HOURLY_SERVICE = 'HourlyService'

MIXED = 'Mixed'

SUBCONTRACTING = 'Subcontracting'

MACHINE_TIME = 'MachineTime'

SPECIAL_SALE = 'SpecialSale'

USED_VEHICLE = 'UsedVehicle'

Réponses

Modèles de base pour les réponses de l’API Henrri Connect.

Attributs: - Cell: Représente une cellule de total dans une réponse paginée. - ElementDisplay: Représente les informations d’affichage pour un élément dans une réponse paginée. - PagedListResponse: Réponse paginée générique. - ListResponse: Réponse liste générique.

class henrri_connect.models.base.responses.Cell(**data)

Bases : CamelModel

Représente une cellule de total dans une réponse paginée.

Attributs - name: Nom de la cellule. - value: Valeur de la cellule. - type: Type de la cellule. - is_amount: Indique si la cellule représente un montant. - show_alert: Indique si une alerte doit être affichée pour cette cellule. - links: Liste de liens associés à la cellule (si applicable).

name: str | None

value: str | None

type: str | None

is_amount: bool

show_alert: bool

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.base.responses.ElementDisplay(**data)

Bases : CamelModel

Représente les informations d’affichage pour un élément dans une réponse paginée.

Attributs - id: Identifiant de l’élément. - title: Titre de l’élément. - index: Index de l’élément. - width: Largeur de l’élément.

id: int | None

title: str | None

index: int

width: int

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.base.responses.PagedListResponse(**data)

Bases : CamelModel, Generic[T]

Réponse paginée générique.

Attributs - elements: Liste d’éléments de la page. - totals: Liste de cellules de total pour la page (si applicable). - display: Liste d’informations d’affichage pour les éléments de la page (si applicable). - meta: Métadonnées de la réponse paginée (si applicable).

elements: list[T] | None

totals: list[Cell] | None

display: list[ElementDisplay] | None

meta: MetaPagedListResponse | 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.base.responses.ListResponse(**data)

Bases : CamelModel, Generic[T]

Réponse liste générique.

Attributs - elements: Liste d’éléments. - meta: Métadonnées de la réponse liste (si applicable).

elements: list[T] | None

meta: MetaListResponse | 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].

Autres

Modèles de base Pydantic v2 pour l’API Henrri.

Attributs: - CamelModel: Modèle de base avec conversion automatique camelCase ↔ snake_case. - Link: Représente un lien hypertexte. - MetaPagedListResponse: Représente les métadonnées d’une réponse de liste paginée. - MetaListResponse: Représente les métadonnées d’une réponse de liste.

class henrri_connect.models.base.models.CamelModel(**data)

Bases : BaseModel

Modèle de base avec conversion automatique camelCase ↔ snake_case.

Attributs - model_config: Configuration du modèle pour activer la conversion automatique des noms de champs.

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.base.models.Link(**data)

Bases : CamelModel

Représente un lien hypertexte.

Attributs - href: URL du lien. - rel: Relation du lien. - method: Méthode HTTP du lien. - label: Libellé du lien.

href: str | None

rel: str | None

method: str | None

label: 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.base.models.MetaPagedListResponse(**data)

Bases : CamelModel

Représente les métadonnées d’une réponse de liste paginée.

Attributs - page: Numéro de la page. - limit: Nombre d’éléments par page. - total_count: Nombre total d’éléments. - total_pages: Nombre total de pages. - has_next: Indique si une page suivante existe.

page: int

limit: int

total_count: int

total_pages: int

has_next: bool

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.base.models.MetaListResponse(**data)

Bases : CamelModel

Représente les métadonnées d’une réponse de liste.

Attributs - total_count: Nombre total d’éléments.

total_count: int

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].