Lignes de document

Sous-client pour les endpoints /v1/document-lines.

Classes: - SyncDocumentLinesClient : Accès synchrone aux endpoints lignes de documents. - AsyncDocumentLinesClient : Accès asynchrone aux endpoints lignes de documents.

Notes: Utiliser de préférence les objets suivants pour acceder aux endpoints: - henrri_connect.SyncHenrriClient - henrri_connect.AsyncHenrriClient

class henrri_connect.document_lines.AsyncDocumentLinesClient(client)

Bases : object

Accès asynchrone aux lignes de document.

Arguments - client : Objet henrri_connect.AsyncHenrriClient.

Methods - list_document_lines : Liste les lignes d’un document. - add : Ajoute une ligne à un document. - get : Récupère une ligne de document par son identifiant. - modify : Modifie une ligne de document par son identifiant. - delete : Supprime une ligne de document par son identifiant. - move : Déplace une ligne vers une position donnée.

async list_document_lines(document_id, query_params=None)

Liste les lignes d’un document.

Arguments - document_id (int) : Identifiant du document (min 1 et max 2 147 483 647). - query_params (DocumentLineListQueryParameters, optional) : Paramètres de requête.

Returns - ListResponse[DocumentLine] : Liste de lignes de document.

Type renvoyé:

ListResponse[DocumentLine]

async add(document_id, line)

Ajoute une ligne à un document.

Arguments - document_id : Identifiant du document. - line : Ligne de document.

Returns - DocumentLine : Ligne de document ajoutée.

Type renvoyé:

DocumentLine

async get(document_id, line_id)

Récupère une ligne de document par son identifiant.

Arguments - document_id : Identifiant du document. - line_id : Identifiant de la ligne de document.

Returns - DocumentLine : Ligne de document.

Type renvoyé:

DocumentLine

async modify(document_id, line_id, line)

Met à jour une ligne de document.

Arguments - document_id : Identifiant du document. - line_id : Identifiant de la ligne de document. - line : Ligne de document.

Returns - DocumentLine : Ligne de document modifiée.

Type renvoyé:

DocumentLine

async delete(document_id, line_id)

Supprime une ligne de document.

Arguments - document_id : Identifiant du document. - line_id : Identifiant de la ligne de document.

Returns - None

Type renvoyé:

None

async move(document_id, line_id, to)

Déplace une ligne vers une position donnée.

Arguments - document_id : Identifiant du document. - line_id : Identifiant de la ligne de document. - to : Position de destination.

Returns - None

Type renvoyé:

None

class henrri_connect.document_lines.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.document_lines.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

class henrri_connect.document_lines.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].

class henrri_connect.document_lines.SyncDocumentLinesClient(client)

Bases : object

Accès synchrone aux lignes de document.

Arguments - client : Objet henrri_connect.SyncHenrriClient.

Methods - list_document_lines : Liste les lignes d’un document. - add : Ajoute une ligne à un document. - get : Récupère une ligne de document par son identifiant. - modify : Met à jour une ligne de document. - delete : Supprime une ligne de document. - move : Déplace une ligne vers une position donnée.

list_document_lines(document_id, query_params=None)

Liste les lignes d’un document.

Arguments - document_id (int) : Identifiant du document (min 1 et max 2 147 483 647). - query_params (DocumentLineListQueryParameters, optional) : Paramètres de requête.

Returns - ListResponse[DocumentLine] : Liste de lignes de document.

Type renvoyé:

ListResponse[DocumentLine]

add(document_id, line)

Ajoute une ligne à un document.

Arguments - document_id : Identifiant du document. - line : Ligne de document.

Returns - DocumentLine : Ligne de document ajoutée.

Type renvoyé:

DocumentLine

get(document_id, line_id)

Récupère une ligne de document par son identifiant.

Arguments - document_id : Identifiant du document. - line_id : Identifiant de la ligne de document.

Returns - DocumentLine : Ligne de document.

Type renvoyé:

DocumentLine

modify(document_id, line_id, line)

Met à jour une ligne de document.

Arguments - document_id : Identifiant du document. - line_id : Identifiant de la ligne de document. - line : Ligne de document.

Returns - DocumentLine : Ligne de document modifiée.

Type renvoyé:

DocumentLine

delete(document_id, line_id)

Supprime une ligne de document.

Arguments - document_id : Identifiant du document. - line_id : Identifiant de la ligne de document.

Returns - None

Type renvoyé:

None

move(document_id, line_id, to)

Déplace une ligne vers une position donnée.

Arguments - document_id : Identifiant du document. - line_id : Identifiant de la ligne de document. - to : Position de destination.

Returns - None

Type renvoyé:

None