API / API Web
Sujet parent: API Web

API Gestion Transport Calculer Coût Transport

Version : ACE 1.1

Edition spéciale ES1

Package : fr.ACE.metier.bc4j.transport.common

GestionTransportCalculerCoutTransport
Schémas d’entrée et de sortie : IN OUT

Cette API permet, pour chaque tarif identifié par l’API GestionTransportrechercherTarifsApplicables, de calculer le coût du transport correspondant.

Tous les éléments nécessaires au calcul d’un coût de transport, y compris le tarif transport à appliquer, doivent être indiqués en entrée de l’API.

Elle fournit en sortie tous les éléments relatifs au coût de transport calculé, ainsi que les éléments ayant permis ce calcul.

Pour en savoir plus sur le calcul du coût de transport, consultez la documentation « Les coûts de transport ».

API imbriquées : GestionEvenementimputerFraisTransport -

Contraintes et limites de fonctionnement (hors périmètre)

RAS.

Paramétrage (PPE)

TYPTRA -

Processus, contrôles et règles de gestion

Etape Description du Processus
Principe

Cette API calcule, sur la base d’un tarif transport identifié de manière univoque, le coût d’un transport d’une certaine quantité d’unités d’oeuvre. Ce coût est décomposé en un prix tarif, qui correspond au prix du transport selon le tarif appliqué, et éventuellement en plusieurs frais annexes (frais de timbre, de contre remboursement…) et en surcoûts.

Le prix tarif peut être majoré ou minoré par un pourcentage optionnel, renseigné uniquement dans les scenarii de simulations.

Tous les prix sont calculés dans la devise du tarif avant d’être convertis dans la devise désirée (généralement la devise de l’événement commercial pour lequel est effectué le calcul du coût de transport).

La base d’unités d’œuvre constitue la base réelle du calcul, c'est-à-dire qu’elle a déjà été arrondie si besoin.
1 Les informations de l’en-tête du tarif sont identifiées.
2 Les informations de l’en-tête de colonne correspondante sont également identifiées.
3 L’API utilise le détail du tarif correspondant à la destination du transport et à la quantité d’unités d’œuvre.
4 Calcul du prix tarif :
  • Si le tarif est de type forfait, le prix du transport est égal au montant du forfait.
  • Si le tarif est de type proportionnel, le prix du transport est égal à la quantité arrondie d’unités d’œuvre divisée par la tranche de tarification, multiplié par le coût d’une tranche.
5 Arrondi du prix tarif : la règle d’arrondi définie sur l’en-tête de colonne est appliquée au prix calculé.
6 Calcul du prix en appliquant le « payant pour », uniquement si tarif proportionnel et unité d’œuvre=’KG’.
  • la tranche du tarif à utiliser est recherchée si une règle de « payant pour » est définie et le prix tarif est calculé à partir de cette tranche (les mêmes règles de calcul sont appliquées pour les modes « forfait » et « proportionnel »).
  • le prix est arrondi en fonction des conditions d’arrondi définies sur la tranche d’unités d’œuvre du « payant pour ».
7 Le prix tarif à conserver, précisé sur l’en-tête, du tarif est choisi parmi les deux prix calculés. en règle générale, il s’agit du prix tarif le plus intéressant.
8 Application du pourcentage de majoration/minoration s’il est renseigné.
9 Calcul des surcoûts et autres frais :
  • Les frais de contre remboursement sont calculés sur la base de la valeur hors taxes des produits à transporter,
  • Les frais de timbre (port payé et port dû),
  • Les surcoûts définis sur l’entête du tarif.
10 Les différents coûts sont convertis dans la devise spécifiée en entrée.
11 Les différentes valeurs calculées sont cumulées pour obtenir le coût total.

Cas d’erreur

Cause Effet
L’un des éléments du tarif n’existe pas (en-tête du tarif, de la colonne, ou détail). Message de type « CLE_INEX : TRPTAE : 1 TRA DANZAS LIL M 20050101 0 » Aucun traitement n’est effectué.

Exemples d’utilisation

Ces exemples sont basés sur le tarif fourni en annexe de cette documentation.

Exemple 1

Ce tarif est défini pour le transporteur DANZAS, au départ du site ‘LIL’ (Lille), en régime ‘M’ (Messagerie), et à partir du 01/01/2004. Il est exprimé en euros.

L’unité d’œuvre est le kilogramme. Le minimum transportable est de 10 KG, ce qui signifie que tout transport inférieur à 10 KG ne pourra pas être valorisé en utilisant ce tarif.

Lorsqu’une règle de « payant pour » est définie sur une colonne, le tarif retenu sera le tarif le plus avantageux pour le client (si le calcul basé sur la colonne du payant pour donne un prix inférieur au calcul basé sur la colonne correspondant à la quantité d’unités d’œuvre à transporter, alors on conservera le prix basé sur le payant pour, sinon l’inverse).

Par défaut, la quantité d’unités d’œuvre est arrondie aux 100 kilogrammes près.

Les frais de contre remboursement sont constitués d’une part fixe de 5 euros et d’une part variable représentant 1% du montant à régler en contre remboursement, par tranches entières de 200 €.

Deux surcoûts sont définis sur ce tarif : un surcoût ‘P’ (Péage) de 23.50 €, et un surcoût ‘F’ (Frais de dossier) de 50.00 €.

RÈGLES D’ARRONDI DE L'UNITE D'ŒUVRE (TRPTAE)  
Champ Description Valeurs
Condition 1 Condition 2
Codsoc Code société 1 1
Typtie Type du tiers transporteur TRA TRA
Sigtie Sigle du tiers transporteur DANZAS DANZAS
Codsit1 Code site de départ du transport LIL LIL
Codrgm Code du régime de transport M M
Codvhc Code du type de véhicule ' ‘ ' ‘
Debper Date de début d'aplication du tarif 20040101 20040101
Numlig Numéro de ligne 1 2
Typenr Type d'enregistrement 'O' 'O'
Ttro1 Borne supérieure de la règle d’arrondi 2000 5000
Modarr Mode d'arrondi + *
Arrondi Nature de la règle d’arrondi 10 50

Lorsque la quantité d’unités d’œuvre est inférieure ou égale à 2000 KG, elle est arrondie aux 10 kilogrammes supérieurs.

Lorsque la quantité d’unités d’œuvre est supérieure à 2000 Kg et inférieure ou égale à 5000 Kg, elle est arrondie aux 50 Kg les plus proches.

Enfin, lorsque la quantité d’unités d’œuvre est supérieure à 5000 Kg, la règle d’arrondi à appliquer est la règle définie sur l’entête du tarif, à savoir aux 100 kilogrammes près.

COLONNES DU TARIF (TRPTAE)
Champ Description Valeurs
Tranche 1 Tranche 2 Tranche 3 Tranche 4
Codsoc Code société 1 1 1 1
Typtie Type du tiers transporteur TRA TRA TRA TRA
Sigtie Sigle du tiers transporteur DANZAS DANZAS DANZAS DANZAS
Codsit1 Code site de départ du transport LIL LIL LIL LIL
Codrgm Code du régime de transport M M M M
Codvhc Code du type de véhicule ‘ ‘ ‘ ‘ ‘ ‘ ‘ ‘
Debper Date de début d’aplication du tarif 20040101 20040101 20040101 20040101
Numlig Numéro de ligne 1 2 3 4
Typenr Type d’enregistrement ‘ ‘ ‘ ‘ ‘ ‘ ‘ ‘
Uniexp Unité d’œuvre du tarif KG KG KG KG
Tranch1tro Borne inférieure du tarif 10 10 10 10
Ttro1 Borne supérieure de la colonne 100 500 1000 25000
Moduni Mode de tarification (Forfait ou Proportionnel) F P P P
Modpay Type de payant pour (supérieur, inférieur, manuel) ‘ ‘ S S ‘ ‘
Ttro2 Tranche à rechercher pour le calcul du payant pour 0 0 0 0
Arrondi Nature d’arrondi du prix calculé (granularité) 1 1 1 10
Codeta Mode d’arrondi du prix calculé (+, -, au plus près) * * * *

Ce tarif comporte 4 colonnes dont les bornes maximales sont respectivement de 100, 500, 1000 et 25000 KG. La borne inférieure du tarif est rappelée pour chaque colonne.

La première colonne est tarifée au forfait tandis que les trois suivantes sont tarifées proportionnellement à la quantité d’unités d’œuvre à transporter.

Pour les colonnes 2 et 3, on recherchera le payant pour en calculant le prix à payer avec la colonne supérieure. Pas de règle de « payant pour » pour la première colonne car elle est facturée au forfait, ni pour la dernière colonne car c’est la dernière…

Enfin, le prix calculé sera arrondi à l’euro le plus proche pour les trois premières colonnes, et aux 10 euros les plus proches pour la dernière colonne.

LIGNE DE TARIF = DESTINATION (TRPTAL)
Champ Description Valeurs
Codsoc Code société 1
Typtie Type du tiers transporteur TRA
Sigtie Sigle du tiers transporteur DANZAS
Codsit1 Code site de départ du transport LIL
Codrgm Code du régime de transport M
Codvhc Code du type de véhicule ' '
Debper Date de début d'aplication du tarif 20040101
Codpay Code pays FR
Tzon Type de zone de destination 3
Clezon Code de la zone de destination 59
Datdeb Date de début d'aplication du tarif 20040101
Typope Type de ligne destination (barème ou non) ' '
Bareme Numéro de destination ou de barème 0

Pour l’exemple, nous n’avons fait figurer qu’une seule destination dans notre tarif. Cette destination étant la première du tarif, elle porte le numéro zéro.

La zone de destination est le département 59 de la France (Type de zone ‘3’ = département).

DETAIL DU TARIF (TRPTAB)
Champ Description Valeurs
Tranche 1 Tranche 2 Tranche 3 Tranche 4
Codsoc Code société 1 1 1 1
Typtie Type du tiers transporteur TRA TRA TRA TRA
Sigtie Sigle du tiers transporteur TRA001 TRA001 TRA001 TRA001
Codsit1 Code site de départ du transport LIL LIL LIL LIL
Codrgm Code du régime de transport M M M M
Codvhc Code du type de véhicule ' ' ' ' ' ' ' '
Debper Date de début d'aplication du tarif 20040101 20040101 20040101 20040101
Datdeb Idem Debper 20040101 20040101 20040101 20040101
Tzon Type de zone ou bareme 3 3 3 3
Bareme Numéro de destination ou de barème 0 0 0 0
Numlig Numéro de tranche d'unité d'œuvre 1 2 3 4
Mttro1 Prix à appliquer 50 0.5 0.45 40
Ttro2 Tranche de tarification (x unités d'œuvre) 1 1 1 100

Pour la première colonne du tarif, le prix est de 50 € (cette colonne est tarifée au forfait).

Pour les colonnes 2 et 3, le prix est respectivement de 0.50 et 0.45 € par unité d’œuvre (par KG).

Pour la dernière colonne, le prix est de 40 € par tranches de 100 Kg.

Sujet parent: API Web
Aurea Logo
Copyright © 2020. Aurea Software, Inc. ("Aurea")