Documents

Modèles Pydantic v2 pour les documents dans l’API Henrri Connect.

Attributs: - DocumentType: Représente un type de document dans l’API Henrri Connect. - DocumentLabelElement: Représente un élément d’étiquette de document dans l’API Henrri Connect. - DocumentLabel: Représente une étiquette de document dans l’API Henrri Connect. - DocumentLineType: Représente un type de ligne de document dans l’API Henrri Connect. - DocumentLine: Représente une ligne de document dans l’API Henrri Connect. - DocumentLineMoveQueryParameters: Représente les paramètres de requête pour déplacer une ligne de document dans l’API Henrri Connect.

class henrri_connect.models.document.DocumentType(**data)

Bases : CamelModel

Représente un type de document dans l’API Henrri Connect.

Attributs: - id: Identifiant unique du type de document. - label: Libellé du type de document. - short_label: Libellé court du type de document. - document_kind: Type de document. - is_accounting: Indique si le type de document est comptable.

id: int | None

label: str | None

short_label: str | None

document_kind: str

is_accounting: bool

is_managed: bool

is_mandatory: bool

is_visible: 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.document.DocumentLabelElement(**data)

Bases : CamelModel

Représente un élément d’étiquette de document dans l’API Henrri Connect.

Attributs: - id: Identifiant unique de l’élément d’étiquette. - model_element_id: Id de l’élément de modèle auquel appartient l’élément d’étiquette. - label: Libellé de l’élément d’étiquette. - value: Valeur de l’élément d’étiquette. - element_type: Type de l’élément d’étiquette. - is_main_element: Indique si l’élément d’étiquette est l’élément principal de l’étiquette. - size: Taille de l’élément d’étiquette. - index: Index de l’élément d’étiquette dans l’étiquette. - links: Liste de liens associés à l’élément d’étiquette (si applicable).

id: int | None

model_element_id: int | None

label: str | None

value: str | None

element_type: str | None

is_main_element: bool

size: int | None

index: int | None

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.document.DocumentLabel(**data)

Bases : CamelModel

Représente une étiquette de document dans l’API Henrri Connect.

Attributs: - id: Identifiant unique de l’étiquette de document. - model_id: Id du modèle auquel appartient l’étiquette de document. - document_id: Id du document auquel appartient l’étiquette de document. - label: Libellé de l’étiquette de document. - elements: Liste d’éléments d’étiquette de doc associés à l’étiquette de doc (si applicable). - links: Liste de liens associés à l’étiquette de document (si applicable).

id: int | None

model_id: int | None

document_id: int | None

label: str | None

elements: list[DocumentLabelElement] | None

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.document.Document(**data)

Bases : CamelModel

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

Attributs: - id: Identifiant unique du document. - identity: Identité du document. - finalized: Indique si le document est finalisé. - type: Type du document. - document_type_id: Identifiant du type de document. - document_type: Type de document (si applicable). - title: Titre du document. - subtitle: Sous-titre du document (si applicable). - price_before_tax: Prix total avant taxe du document. - tax_amount: Montant total de la taxe du document. - price_after_tax: Prix total après taxe du document. - due_label: Libellé de l’échéance du document (si applicable). - last_modification_date: Date de dernière modification du document. - date: Date du document. - validated: Indique si le document est validé. - validation_date: Date de validation du document (si applicable). - validation_firstname: Prénom de la personne ayant validé le document (si applicable). - validation_lastname: Nom de la personne ayant validé le document (si applicable). - validation_email: E-mail de la personne ayant validé le document (si applicable). - validation_ip: IP de la personne ayant validé le document (si applicable). - lines: Liste de lignes de document associées au document (si applicable). - customer_id: Identifiant du client associé au document (si applicable). - customer: Client associé au document (si applicable). - customer_address: Adresse du client associée au document (si applicable). - user_can_validate: Indique si l’utilisateur peut valider le document. - footer_text: Texte de pied de page du document (si applicable). - bank_account_label: Libellé du compte bancaire associé au document (si applicable). - label_id: Identifiant de l’étiquette de document associée au document (si applicable). - links: Liste de liens associés au document (si applicable).

id: int | None

identity: str | None

finalized: bool

type: str | None

document_type_id: int

document_type: DocumentType | None

title: str | None

subtitle: str | None

price_before_tax: float

tax_amount: float

price_after_tax: float

due_label: str | None

last_modification_date: str | None

date: str | None

validated: bool

validation_date: str | None

validation_firstname: str | None

validation_lastname: str | None

validation_email: str | None

validation_ip: str | None

lines: list[DocumentLine] | None

customer_id: int

customer: Customer | None

customer_address: Address | None

user_can_validate: bool

footer_text: str | None

bank_account_label: str | None

label_id: int | None

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.document.DocumentQuery(**data)

Bases : CamelModel

Représente une requête de document dans l’API Henrri Connect.

Attributs: - finalized (bool) : Indique si le document est finalisé. - document_types (list[DocumentKind]) :: Type du document. - state (Optional[DocumentState]) : Etat du document. - page (int) : Numéro de page (de 1 à 2 147 483 647, défaut 1). - limit (int) : Nombre de documents par page (de 1 à 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 minimum. - from_date (str) : Date de debut. - to_date (str) : Date de fin.

finalized: bool

document_types: list[DocumentKind] | None

state: DocumentState | None

page: int

limit: int

search: str | None

sort_by: str | None

sort_order: SortOrder | 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.document.ValidateDocumentRequest(**data)

Bases : CamelModel

Représente une requête de validation de document dans l’API Henrri Connect.

Attributs: - email: Adresse e-mail de la personne validant le document. - first_name: Prénom de la personne validant le document. - last_name: Nom de la personne validant le document. - validation_date: Date de validation du document. - time_offset: Décalage horaire par rapport à UTC. - ip: Adresse IP de la personne validant le document.

email: str

first_name: str

last_name: str

validation_date: str

time_offset: int

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

Modèles document pour l’API Henrri Connect.

Attributs: - DocumentType: Représente un type de document dans l’API Henrri Connect. - DocumentLabelElement: Représente un élément d’étiquette de document dans l’API Henrri Connect. - DocumentLabel: Représente une étiquette de document dans l’API Henrri Connect. - DocumentLineType: Représente un type de ligne de document dans l’API Henrri Connect. - DocumentLine: Représente une ligne de document dans l’API Henrri Connect. - DocumentLineMoveQueryParameters: Représente les paramètres de requête pour déplacer une ligne de document dans l’API Henrri Connect.

class henrri_connect.models.document_line.DocumentLineType(**data)

Bases : CamelModel

Représente un type de ligne de document dans l’API Henrri Connect.

Attributs: - id: Identifiant unique du type de ligne de document. - label: Libellé du type de ligne de document. - type: Type de ligne de document.

id: int | None

label: str | None

type: 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.document_line.DocumentLine(**data)

Bases : CamelModel

Représente une ligne de document dans l’API Henrri Connect.

type_id peut être récupéré par un GET sur /documentlinetypes ou avec henrry_connect.<client>.document_line_types.list_document_line_types

Attributs: - id: Identifiant unique de la ligne de document. - document_id: Identifiant du document auquel appartient la ligne. - reference: Référence de la ligne de document. - description: Description de la ligne de document. - selling_price_without_tax: Prix de vente sans taxe de la ligne de document. - purchasing_price_without_tax: Prix d’achat sans taxe de la ligne de document. - vat_percent: Pourcentage de TVA appliqué à la ligne de document. - quantity: Quantité de l’article dans la ligne de document. - is_tax_included: Indique si les prix incluent la taxe. - total_without_tax: Total sans taxe pour la ligne de document. - total_with_tax: Total avec taxe pour la ligne de document. - are_elements_of_group_shown: Indique si les éléments du groupe sont affichés. - line_number: Numéro de la ligne dans le document. - is_a_group: Indique si la ligne est un groupe d’articles. - does_group_own_different_vat: Indique si le groupe a une TVA différente pour ses éléments. - is_member_of_a_group: Indique si la ligne est membre d’un groupe d’articles. - is_adjustment_of_group: Indique si la ligne est un ajustement d’un groupe d’articles. - type_id: Identifiant du type de ligne de document. - type: Type de ligne de document (si applicable). - group_id: Identifiant du groupe d’articles auquel appartient la ligne (si applicable). - item_id: Identifiant de l’article associé à la ligne (si applicable). - item: Article associé à la ligne (si applicable). - links: Liste de liens associés à la ligne de document (si applicable).

id: int | None

document_id: int | None

reference: str | None

description: str | None

selling_price_without_tax: float | None

purchasing_price_without_tax: float

vat_percent: float | None

quantity: float

is_tax_included: bool

total_without_tax: float | None

total_with_tax: float | None

are_elements_of_group_shown: bool

line_number: int | None

is_a_group: bool

does_group_own_different_vat: bool

is_member_of_a_group: bool

is_adjustment_of_group: bool

type_id: int

type: DocumentLineType | None

group_id: int | None

item_id: int | None

item: Item | None

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.document_line.DecorativeDocumentLine(**data)

Bases : DocumentLine

Représente une ligne de document decoratif dans l’API Henrri Connect.

Attributs: - type_id: Identifiant du type de ligne de document.

document_id: int | None

reference: str | None

description: str | None

selling_price_without_tax: float | None

purchasing_price_without_tax: float

vat_percent: float | None

quantity: float

is_tax_included: bool

total_without_tax: float | None

total_with_tax: float | None

are_elements_of_group_shown: bool

line_number: int | None

is_a_group: bool

does_group_own_different_vat: bool

is_member_of_a_group: bool

is_adjustment_of_group: bool

type_id: int

type: DocumentLineType | None

group_id: int | None

item_id: int | None

item: Item | None

links: list[Link] | None

horizontal_line()

Créer une ligne horizontale dans le document.

Renvoie:

La ligne horizontale crée.

Type renvoyé:

DocumentLine

empty_line()

Créer une ligne vide dans le document.

Renvoie:

La ligne vide crée.

Type renvoyé:

DocumentLine

subtotal_line()

Créer une ligne de sous-total dans le document.

Renvoie:

La ligne de sous-total crée.

Type renvoyé:

DocumentLine

total_line()

Créer une ligne de total dans le document.

Renvoie:

La ligne de total crée.

Type renvoyé:

DocumentLine

textual_line(text)

Créer une ligne de texte dans le document.

Renvoie:

La ligne de texte crée.

Type renvoyé:

DocumentLine

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.document_line.DocumentLineMoveQueryParameters(**data)

Bases : CamelModel

Représente les paramètres de requête pour déplacer une ligne de document dans l’API Henrri Connect.

Attributs: - to: Identifiant de la ligne de document vers laquelle déplacer la ligne.

to: 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.document_line.DocumentLineListQueryParameters(**data)

Bases : CamelModel

Représente les paramètres de requête pour obtenir une liste de lignes de document dans l’API Henrri Connect.

Attributs: - document_id: Identifiant du document auquel appartient la ligne.

page: int

limit: int

search: str | None

sort_by: str | None

sort_order: SortOrder | None

minId: int

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

to_date: str

Modèles Pydantic représentant les entités de PDF dans l’API Henrri.

Attributs: - PdfUrlResponse: Représente la réponse de l’API Henrri Connect pour une URL de PDF.

class henrri_connect.models.pdf.PdfUrlResponse(**data)

Bases : CamelModel

Représente la réponse de l’API Henrri Connect pour une URL de PDF.

Attributs: - download_url: URL de téléchargement du PDF. - expires_at: Date d’expiration de l’URL de téléchargement du PDF. - file_name: Nom du fichier PDF (si applicable).

download_url: str | None

expires_at: str | None

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