Abrechnungsanpassungen vornehmen

Sie sehen die Dokumentation zu Apigee Edge.
Zur Apigee X-Dokumentation weitere Informationen

Einführung

Bei der Monetarisierung kannst du deine Zahlungsangaben anpassen. Es kann beispielsweise sein, dass Sie die Umsatzbeteiligung oder Gebühren für einen bestimmten Abrechnungsmonat aufgrund einer Abweichung in Ihren Datensätzen erhöhen oder senken müssen.

Erkunden der Seite "Abrechnungsanpassungen"

Rufen Sie wie unten beschrieben die Seite "Abrechnungsanpassungen" auf.

Rechnungsgutschrift hinzufügen

So fügen Sie eine Rechnungsgutschrift hinzu:

1. Rufen Sie die Seite „Abrechnungsanpassungen“ auf.
2. Klicken Sie auf + Anpassung.
3. Geben Sie die folgenden Informationen ein:

   Feld	Beschreibung
   Name	Ein beschreibender Name, der auf dem Abrechnungsdokument erscheint.
   Anpassung %	Betrag der Anpassung als positiver oder negativer Prozentsatz. Ein positiver Prozentsatz erhöht die Umsatzbeteiligung oder Gebühren in der Transaktion um diesen Prozentsatz. Mit einer negativen Anpassung werden die Umsatzbeteiligung oder Gebühren in der Transaktion um diesen Prozentsatz verringert. Geben Sie eine positive oder negative Dezimalzahl mit bis zu zwei Dezimalstellen ein.
   Abrechnungsmonat	Abrechnungsmonat für die Korrektur. Wählen Sie in der Drop-down-Liste einen Monat aus.
   Transaktionstyp	Die Art der Transaktion, auf die Sie die Anpassung anwenden möchten. Wählen Sie einen Wert aus dem Drop-down-Menü aus: Alle Transaktionen Belastung (Transaktionen mit Lademodell) Kauf (Transaktionen mit Umsatzbeteiligungsmodell) Erstattung (Transaktionen mit Umsatzbeteiligungsmodell)
   Produkt	API-Produkt, auf das Sie die Anpassung anwenden möchten. Eine einzelne Anpassung kann nicht auf mehrere API-Produkte angewendet werden. Wenn Sie eine Anpassung auf mehrere API-Produkte anwenden müssen, erstellen Sie für jedes Produkt eine Anpassung. Wählen Sie im Drop-down-Menü ein API-Produkt aus.
   Developer	Entwickler, für den Sie die Anpassung vornehmen möchten. Sie können die Anpassung auf alle Entwickler (standardmäßig) oder auf einen bestimmten Entwickler anwenden. Wählen Sie „Alle Entwickler“ oder einen bestimmten Entwickler aus dem Drop-down-Menü aus.

4. Klicken Sie auf Anpassung erstellen.

Rechnungskorrektur bearbeiten

So bearbeiten Sie eine Rechnungsanpassung:

1. Rufen Sie die Seite „Abrechnungsanpassungen“ auf.
2. Platzieren Sie den Mauszeiger auf der Abrechnungsanpassung, die Sie bearbeiten möchten, und klicken Sie im Aktionsmenü auf .
3. Aktualisieren Sie die Rechnungskorrektur nach Bedarf.
4. Klicken Sie auf Anpassung aktualisieren.

Abrechnungsanpassungen über die API vornehmen

In den folgenden Abschnitten wird beschrieben, wie Sie Rechnungsgutschriften über die API vornehmen.

Abrechnungsanpassungen über die API vornehmen

Sie können die Abrechnungsdetails anpassen, indem Sie eine POST-Anfrage an /organizations/{org_name}/billing-Anpassungen senden. Wenn Sie die Anfrage stellen, geben Sie im Anfragetext Folgendes an:

• Name der Rechnungskorrektur.
• Ein Anpassungsprozentsatz, d. h. ein positiver oder negativer Prozentsatz, der die Rechnung entsprechend erhöht oder verringert.
• Abrechnungsmonat.
• Abrechnungsjahr.
• Organisation, auf die die Rechnungsgutschrift angewendet wird.

Sie können auch andere Eigenschaften angeben, z. B.:

• Transaktionstyp, für den Sie die Anpassung vornehmen möchten (z. B. eine Kauftransaktion).
• Entwickler, für den Sie die Anpassung vornehmen möchten.
• Ob Sie die Anpassung auf Prepaid-Entwickler, Postpaid-Entwickler oder beides anwenden möchten.
• API-Paket, auf das Sie die Anpassung anwenden möchten.
• API-Produkt, auf das Sie die Anpassung anwenden möchten.

Eine vollständige Liste der Eigenschaften für Rechnungsanpassungen, die Sie in einer entsprechenden Anfrage angeben können, finden Sie unter Konfigurationseinstellungen für die Abrechnungsanpassung.

Wenn keine optionale Property angegeben ist, gilt die Anpassung des Abrechnungsdokuments für diese Property. Wenn beispielsweise kein Transaktionstyp angegeben ist, gilt die Rechnungsanpassung für alle Transaktionstypen.

Im folgenden Beispiel wird eine Rechnungsanpassung für den offenen Abrechnungsmonat Juni 2013 vorgenommen. Die Anpassung reduziert sich um einen Faktor von 3 % und wird auf Kauftransaktionen, das Zahlungsprodukt und Entwickler mit nachträglicher Zahlung angewendet. Da die Properties zum Identifizieren eines bestimmten Entwicklers oder API-Pakets nicht angegeben sind, wird die Anpassung auf alle Entwickler (die Entwickler mit nachträglicher Zahlung sind) und das Zahlungsprodukt in allen API-Paketen angewendet.

$ 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

Die Antwort sollte in etwa so aussehen (nur ein Teil der Antwort wird angezeigt):

{
  "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"
}

Rechnungsgutschriften über die API ansehen

Sie können eine bestimmte oder alle Rechnungsgutschriften für eine Organisation aufrufen. Wenn Sie eine bestimmte Rechnungskorrektur aufrufen möchten, senden Sie eine GET-Anfrage an /organizations/{org_name}/billing-adjustments/{billing_adjustment_id}, wobei {billing_adjustment_id} die Identifizierung der entsprechenden Rechnungskorrektur ist. Die ID wird in der Antwort zurückgegeben, wenn Sie die Rechnungskorrektur erstellen. Beispiel:

$ 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

Wenn Sie alle Rechnungsgutschriften für eine Organisation ansehen möchten, senden Sie eine GET-Anfrage an /organizations/{org_name}/billing-adjustments. Beispiel:

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

Die Antwort sollte in etwa so aussehen (nur ein Teil der Antwort wird angezeigt):

{
  "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
}

Abrechnungskorrektur über die API aktualisieren

Sie können eine Rechnungskorrektur aktualisieren, indem Sie eine PUT-Anfrage an /organizations/{org_name}/billing-adjustments/{billing_adjustment_id} senden, wobei {billing_adjustment_id} die Identifizierung der jeweiligen Rechnungskorrektur ist. Wenn Sie die Aktualisierung vornehmen, müssen Sie im Anfragetext die aktualisierten Eigenschaften und die Kennzeichnung der zu aktualisierenden Abrechnungsanpassung angeben. Außerdem müssen Sie die erforderlichen Properties für die Rechnungsanpassung angeben, d. h. die Attribute für den Namen, den Prozentsatz der Anpassung, den Abrechnungsmonat, das Abrechnungsjahr und die Organisation.

Mit dem folgenden API-Aufruf werden beispielsweise der Prozentsatzfaktor und der Name der Anpassung aktualisiert (die aktualisierten Eigenschaften sind im Beispiel hervorgehoben):

$ 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

Abrechnungskorrektur über die API löschen

Sie können eine Rechnungskorrektur löschen, indem Sie eine DELETE-Anfrage an /organizations/{org_name}/billing-adjustments/{billing_adjustment_id} senden. Dabei ist {billing_adjustment_id} die Identifizierung der zu löschenden Rechnungskorrektur. Beispiel:

$ 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

Konfigurationseinstellungen für Abrechnungsanpassungen für die API

Für Rechnungsgutschriften stehen folgende Konfigurationsoptionen zur Verfügung:

Name	Beschreibung	Standard	Erforderlich?
name	Ein beschreibender Name für die Rechnungsgutschrift.	–	Ja
adjustmentPercentageFactor	Der Betrag der Anpassung als positiver oder negativer numerischer Prozentsatz. Ein positiver Prozentsatz erhöht die Umsatzbeteiligung oder Gebühren in der Transaktion um diesen Prozentsatz. Ein negativer Prozentsatz korrigiert die Umsatzbeteiligung oder Gebühren in der Transaktion um diesen Prozentsatz. Die Werte können zwischen -100 und 999,9999 liegen.	–	Ja
billingMonth	Der Abrechnungsmonat für die Rechnungskorrektur, angegeben als Ganzzahl. Beispiel: 11 für Dezember.	–	Ja
billingYear	Das Abrechnungsjahr für die Abrechnungsanpassung im folgenden Format: JJJJ. Beispiel: 2017.	–	Ja
organization	Die Organisation, für die die Rechnungsgutschrift gilt.	–	Ja
isPublished	Ein Flag, das angibt, ob die Anpassung veröffentlicht werden soll. Folgende Werte sind möglich: true. Die Rechnungsanpassung sollte veröffentlicht werden. false. Die Rechnungsgutschrift darf nicht veröffentlicht werden.	–	Nein
transactionType	Die Art der Transaktionen, für die die Rechnungsgutschrift gilt. Folgende Typen sind möglich: PURCHASE CHARGE REFUND CREDIT BALANCE SETUPFEES TERMINATIONFEES RECURRINGFEES TRUEUPS: Dies sind Transaktionen, mit denen bewertete Transaktionen neu angepasst werden. Sie werden aufgerufen, wenn im vorherigen Abrechnungsmonat Steueränderungen vorgenommen wurden.	–	Nein
developerBillingType	Der Abrechnungstyp des Entwicklers, für den die Rechnungsgutschrift gilt. Folgende Werte sind möglich: PREPAID.. Prepaid-Entwickler. POSTPAID. Postpaid-Entwickler. BOTH. Prepaid- und Postpaid-Entwickler.	–	Nein
product	Das API-Produkt, für das die Rechnungsgutschrift gilt. Wenn Sie diese Property nicht angeben, gilt die Rechnungsanpassung für alle API-Produkte.	–	Nein
monetizationPackage	Das API-Paket, für das die Rechnungsgutschrift gilt. Wenn Sie diese Property nicht angeben, gilt die Rechnungsanpassung für alle API-Pakete.	–	Nein
developer	Der Entwickler, für den die Rechnungsgutschrift gilt. Wenn Sie diese Property nicht angeben, gilt die Rechnungsanpassung für alle Entwickler.	–	Nein

Nächste Schritte

Bei der Monetarisierung haben Sie die Flexibilität, einem Entwickler Gutschriften auszustellen. Das kann sinnvoll sein, wenn ein Entwickler mit einem Dienst nicht zufrieden ist und eine teilweise oder vollständige Erstattung der Nutzung für einen bestimmten Zeitraum anfordert. Weitere Informationen zum Ausstellen von Gutschriften finden Sie unter Gutschriften ausstellen.