Revenus

Sous-client pour les endpoints /v1/revenues.

Classes: - henrri_connect.revenues.synchro.SyncRevenuesClient : Accès synchrone aux endpoints revenus. - henrri_connect.revenues.asynchro.AsyncRevenuesClient : Accès asynchrone aux endpoints revenus.

Notes: - Utiliser de préférence l’objet henrri_connect.SyncHenrriClient pour acceder aux endpoints. - Utiliser de préférence l’objet henrri_connect.AsyncHenrriClient pour acceder aux endpoints.

class henrri_connect.revenues.AsyncRevenuesClient(client)

Bases : object

Accès asynchrone aux statistiques de revenus.

Parameters: - client (AsyncHenrriClient) : Client HTTP.

Methods: - get_annual(self, year: int) : Récupère les statistiques de revenus annuelles. - get_monthly(self, year: int) : Récupère les statistiques de revenus mensuelles pour une année.

async get_annual(year)

Récupère les statistiques de revenus annuelles.

Arguments: - year (int) : Année de recherche.

Returns: - RevenueStatistics : Statistiques de revenus annuelles.

Type renvoyé:

RevenueStatistics

async get_monthly(year)

Récupère les statistiques de revenus mensuelles pour une année.

Arguments: - year (int) : Année de recherche.

Returns: - list[MonthlyRevenueStatistics] : Statistiques de revenus mensuelles.

Type renvoyé:

list[MonthlyRevenueStatistics]

class henrri_connect.revenues.MonthlyRevenueStatistics(**data)

Bases : CamelModel

Représente les statistiques de revenus mensuels dans l’API Henrri Connect.

Attributs: - month: Mois des statistiques. - year: Année des statistiques. - total_services_revenue: Revenu total des services. - total_products_revenue: Revenu total des produits. - total_products_margin: Marge totale sur les produits. - total_service_hours: Nombre total d’heures de service.

month: int

year: int

total_services_revenue: float

total_products_revenue: float

total_products_margin: float

total_service_hours: float

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.revenues.RevenueStatistics(**data)

Bases : CamelModel

Représente les statistiques de revenus dans l’API Henrri Connect.

Attributs: - year: Année des statistiques. - total_services_revenue: Revenu total des services. - total_products_revenue: Revenu total des produits. - total_products_margin: Marge totale sur les produits. - total_service_hours: Nombre total d’heures de service.

year: int

total_services_revenue: float

total_products_revenue: float

total_products_margin: float

total_service_hours: float

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.revenues.SyncRevenuesClient(client)

Bases : object

Accès synchrone aux statistiques de revenus.

Parameters: - client (SyncHenrriClient) : Client HTTP.

Methods: - get_annual(self, year: int) : Récupère les statistiques de revenus annuelles. - get_monthly(self, year: int) : Récupère les statistiques de revenus mensuelles pour une année.

get_annual(year)

Récupère les statistiques de revenus annuelles.

Arguments: - year (int) : Année de recherche.

Returns: - RevenueStatistics : Statistiques de revenus annuelles.

Type renvoyé:

RevenueStatistics

get_monthly(year)

Récupère les statistiques de revenus mensuelles pour une année.

Arguments: - year (int) : Année de recherche.

Returns: - list[MonthlyRevenueStatistics] : Statistiques de revenus mensuelles.

Type renvoyé:

list[MonthlyRevenueStatistics]