Ajuster la facturation

<ph type="x-smartling-placeholder"></ph> Vous consultez la documentation Apigee Edge.
Accédez à la page Documentation sur Apigee X. En savoir plus

Introduction

La monétisation vous permet d'ajuster les informations de facturation. Par exemple, vous pourriez avoir besoin d'augmenter ou de diminuer la part des revenus ou les frais pour un mois de facturation donné d’écarts dans vos enregistrements.

Explorer la page "Ajustements de facturation"

Accédez à la page "Ajustements de facturation", comme décrit ci-dessous.

Ajouter un ajustement de facturation

Pour ajouter un ajustement de facturation:

1. Accéder à la page "Ajustements de facturation"
2. Cliquez sur + Ajustement.
3. Saisissez les informations suivantes :

   Champ	Description
   Nom	Nom descriptif qui apparaîtra sur le document de facturation.
   % d'ajustement	Montant de l'ajustement, sous forme de pourcentage positif ou négatif. A positif pourcentage ajuste la part des revenus ou les frais de la transaction de ce un pourcentage. Un ajustement négatif réduit la part des revenus ou les frais dans le transaction par ce pourcentage. Saisissez un nombre décimal positif ou négatif (avec le caractère avec 2 chiffres après la virgule).
   Mois de facturation	Mois de facturation pour l'ajustement. Sélectionnez un mois dans la liste déroulante.
   Type de transaction	Type de transaction pour laquelle vous souhaitez appliquer l'ajustement. Sélectionnez un dans la liste déroulante: Toutes les transactions Charge (facturation des transactions par modèle) Achat (transactions issues d'un modèle de partage des revenus) Remboursement (transactions effectuées via un modèle de partage des revenus)
   Produit	Produit d'API auquel vous souhaitez appliquer l'ajustement. Vous ne pouvez pas appliquer de un seul ajustement à plusieurs produits API. Si vous devez appliquer un ajustement plusieurs produits API, créez un ajustement pour chaque produit. Sélectionner un produit API dans le menu déroulant.
   Développeur	Développeur pour lequel vous souhaitez appliquer l'ajustement. Vous pouvez appliquer la méthode pour tous les développeurs (par défaut) ou pour un développeur spécifique. Sélectionnez "Tous" Développeurs" ou à un développeur spécifique dans le menu déroulant.

4. Cliquez sur Créer un ajustement.

Modifier un ajustement de facturation

Pour modifier un ajustement de facturation:

1. Accéder à la page "Ajustements de facturation"
2. Placez le curseur sur l'ajustement de facturation à modifier, puis cliquez sur dans le menu "Actions".
3. Modifiez l'ajustement de facturation si nécessaire.
4. Cliquez sur Mettre à jour l'ajustement.

Ajuster la facturation à l'aide de l'API

Les sections suivantes expliquent comment effectuer des ajustements de facturation à l'aide de l'API.

Ajuster la facturation à l'aide de l'API

Vous pouvez rectifier les informations de facturation en envoyant une demande POST à /organizations/{org_name}/billing-adjustments. Lorsque vous effectuez la requête, vous spécifiez dans le champ corps de la requête:

• Nom de l'ajustement de facturation.
• Un pourcentage d'ajustement, c'est-à-dire une valeur de pourcentage positive ou négative augmente ou réduit respectivement la facture.
• Mois de facturation.
• Année de facturation
• Organisation à laquelle l'ajustement de facturation est appliqué.

Vous pouvez également spécifier d'autres propriétés, telles que:

• Type de transaction pour laquelle vous souhaitez appliquer l'ajustement (un achat, transactionnel).
• Développeur pour lequel vous souhaitez appliquer l'ajustement.
• Que vous souhaitiez appliquer l'ajustement aux développeurs prépayés ou post-payés, les deux.
• Package d'API auquel vous souhaitez appliquer l'ajustement.
• Produit d'API auquel vous souhaitez appliquer l'ajustement.

Consultez Paramètres de configuration des ajustements de facturation pour obtenir la liste complète des d'ajustement de facturation que vous pouvez spécifier dans une demande d'ajustement.

Si aucune propriété facultative n'est spécifiée, l'ajustement du document de facturation sera inclus pour cet établissement. Par exemple, si aucun type de transaction n'est spécifié, la valeur s'appliquera à tous les types de transactions.

L'exemple suivant effectue un ajustement de facturation pour le mois de facturation en cours, juin 2013. La applique un facteur de réduction de 3 % aux transactions d'achat, les développeurs de produits de paiement et de post-paiement. Étant donné que les propriétés permettant d'identifier développeur ou package d'API ne sont pas spécifiés, l'ajustement sera appliqué à tous les développeurs (qui sont des développeurs en post-paiement) et le produit de paiement dans tous les packages d'API.

$ curl -H "Content-Type:application/json" -X POST -d \
'{
  "name": "Purchase Adjustment Negative3",
  "adjustmentPercentageFactor": -3,
  "billingMonth": 6,
  "billingYear": 2017,
  "isPublished": false,
  "transactionType": "PURCHASE",
  "developerBillingType": "POSTPAID",
  "organization": {
      "id": "{org_name}" 
  },
  "product": { "id": "payment" }
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/billing-adjustments" \
-u email:password

La réponse doit se présenter comme suit (seule une partie de la réponse est affichée) :

{
  "adjustmentPercentageFactor" : -3,
  "billingMonth" : 6,
  "billingYear" : 2017,
  "developerBillingType" : "POSTPAID",
  "id" : "511144db-7fb1-4c74-bafb-5bc7a6380c9c",
  "isPublished" : false,
  "name" : "Purchase Adjustment Negative3",
  "organization" : {
   ...
  },
  "product" : {
    "customAtt1Name" : "user",
    "description" : "Payment",
    "displayName" : "Payment",
    "id" : "payment",
    "name" : "payment",
    "organization" : {
      ...
    },
    "status" : "CREATED",
    "transactionSuccessCriteria" : "Status=='200 OK'"
  },
  "transactionType" : "PURCHASE"
}

Afficher les ajustements de facturation à l'aide de l'API

Vous pouvez afficher un ajustement de facturation spécifique ou tous les ajustements de facturation pour une organisation. Pour afficher un ajustement de facturation spécifique, envoyez une demande GET à /organizations/{org_name}/billing-adjustments/{billing_adjustment_id}, où {billing_adjustment_id} permet d'identifier l'ajustement de facturation concerné. L'ID est renvoyé dans la réponse lorsque vous créez l'ajustement de facturation. Exemple :

$ curl -H "Accept:application/json" -X GET \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/billing-adjustments/511144db-7fb1-4c74-bafb-5bc7a6380c9c" \
-u email:password

Pour afficher tous les ajustements de facturation d'une organisation, envoyez une demande GET à /organizations/{org_name}/billing-adjustments Exemple :

$ curl -H "Accept:application/json" -X GET \ 
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/billing-adjustments" \ 
-u email:password

La réponse doit se présenter comme suit (seule une partie de la réponse est affichée) :

{
  "billingAdjustment" : [ {
    "adjustmentPercentageFactor" : -3,
    "billingMonth" : 6,
    "billingYear" : 2017,
    "developerBillingType" : "POSTPAID",
    "id" : "511144db-7fb1-4c74-bafb-5bc7a6380c9c",
    "isPublished" : false,
    "name" : "Purchase Adjustment Negative3",
    "organization" : {
      ...
    },
    "product" : {
      "customAtt1Name" : "user",
      "description" : "Payment",
      "displayName" : "Payment",
      "id" : "payment",
      "name" : "payment",
      "organization" : {
        ...
      },
      "status" : "CREATED",
      "transactionSuccessCriteria" : "Status=='200 OK'"
    },
    "transactionType" : "PURCHASE"
  }, {
    "adjustmentPercentageFactor" : 5.0000,
    "billingMonth" : 5,
    "billingYear" : 2017,
    "id" : "53c363c0-7e1d-4dc1-9392-cf86656225f2",
    "isPublished" : false,
    "monetizationPackage" : {
      "description" : "Communications",
      "displayName" : "Communications",
      "id" : "communications",
      "name" : "Communications",
      "organization" : {
       ...
      },
      "product" : [ {
        "customAtt1Name" : "user",
        "description" : "Messaging",
        "displayName" : "Messaging",
        "id" : "messaging",
        "name" : "messaging",
        "organization" : {
          ...
        },
        "status" : "CREATED"
      }, {
        ...
        },
        "status" : "CREATED",
        "transactionSuccessCriteria" : "Status=='200 OK'"
      } ],
      "status" : "CREATED"
    },
    "name" : "Test Package Adjustment",
    "organization" : {
     ...
    },
    "product" : {
      "customAtt1Name" : "user",
      "description" : "Location",
      "displayName" : "Location",
      "id" : "location",
      "name" : "location",
      "organization" : {
        ...
      },
      "status" : "CREATED",
      "transactionSuccessCriteria" : "Status=='200 OK'"
    }
  } ],
  "totalRecords" : 2
}

Mettre à jour un ajustement de facturation à l'aide de l'API

Vous pouvez mettre à jour un ajustement de facturation en envoyant une requête PUT à /organizations/{org_name}/billing-adjustments/{billing_adjustment_id}, où {billing_adjustment_id} permet d'identifier l'ajustement de facturation concerné. Lorsque vous effectuez la mise à jour, vous devez spécifier dans le corps de la requête les propriétés mises à jour et les propriétés Identification de l'ajustement de facturation à mettre à jour. Vous devez également spécifier les attributs les propriétés de l'ajustement de facturation, c'est-à-dire les propriétés du nom, du pourcentage d'ajustement le mois de facturation, l'année de facturation et l'organisation.

Par exemple, l'appel d'API suivant met à jour le facteur de pourcentage d'ajustement et le nom (le mises à jour sont mises en surbrillance dans l'exemple):

$ curl -H "Content-Type: application/json" -X PUT -d \
'{
  "id" : "511144db-7fb1-4c74-bafb-5bc7a6380c9c ",
  "adjustmentPercentageFactor": -5,
  "name" : "Purchase Adjustment Negative5",
  "billingMonth": 6,
  "billingYear": 2017,
  "isPublished": false,
  "transactionType": "PURCHASE",
  "developerBillingType": "POSTPAID",
  "organization": {
      "id": "{org_name}" 
    },
  "product": { "id": "payment" }
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/billing-adjustments/511144db-7fb1-4c74-bafb-5bc7a6380c9c" \
-u email:password

Supprimer un ajustement de facturation à l'aide de l'API

Vous pouvez supprimer un ajustement de facturation en envoyant une demande DELETE à /organizations/{org_name}/billing-adjustments/{billing_adjustment_id}, où {billing_adjustment_id} permet d'identifier l'ajustement de facturation à appliquer. supprimés. Exemple :

$ curl -H "Accept:application/json" -X GET \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/billing-adjustments/511144db-7fb1-4c74-bafb-5bc7a6380c9c" \
-u email:password

Paramètres de configuration des ajustements de facturation pour l'API

Les options de configuration suivantes sont disponibles pour les ajustements de facturation:

Étapes suivantes

La monétisation vous permet d'émettre des crédits en faveur d'un développeur. Vous devrez peut-être faire si un développeur n'est pas satisfait d'un service et demande un remboursement partiel ou total de son utilisation pendant un certain temps. Pour savoir comment émettre des crédits, consultez Émettre des crédits.