Wprowadzanie korekt płatności

Wyświetlasz dokumentację Apigee Edge.
Otwórz dokumentację Apigee X. info

Wprowadzenie

Monetyzacja umożliwia wprowadzanie zmian w szczegółach płatności. Może być na przykład konieczne zwiększenie lub zmniejszenie udziału w przychodach albo opłat za dany miesiąc rozliczeniowy z powodu rozbieżności w danych.

Przeglądanie strony Korekty płatności

Otwórz stronę Korekty płatności w sposób opisany poniżej.

Dodawanie wyrównania płatności

Aby dodać wyrównanie płatności:

1. Otwórz stronę Korekty płatności.
2. Kliknij + Korekta.
3. Podaj te informacje:

   Pole	Opis
   Nazwa	Nazwa opisowa, która będzie widoczna w dokumencie rozliczeniowym.
   Korekta %	Wysokość korekty jako dodatnia lub ujemna wartość procentowa. Dodatnia wartość procentowa zwiększa udział w przychodach lub opłaty w transakcji o tę wartość. Ujemna wartość procentowa zmniejsza udział w przychodach lub opłaty w transakcji o tę wartość. Wpisz dodatnią lub ujemną liczbę dziesiętną (z maksymalnie 2 miejscami po przecinku).
   Miesiąc rozliczeniowy	Miesiąc rozliczeniowy, którego dotyczy korekta. Wybierz miesiąc z listy.
   Typ transakcji	Typ transakcji, do której chcesz zastosować korektę. Wybierz wartość z menu: Wszystkie transakcje Obciążenie (transakcje w modelu opłat) Zakup (transakcje w modelu udziału w przychodach) Zwrot środków (transakcje w modelu udziału w przychodach)
   Produkt	Produkt API, do którego chcesz zastosować korektę. Nie możesz zastosować jednej korekty do wielu produktów API. Jeśli chcesz zastosować korektę do wielu produktów API, utwórz korektę dla każdego z nich. Wybierz produkt API z menu.
   Deweloper	Deweloper, do którego chcesz zastosować korektę. Korektę możesz zastosować do wszystkich deweloperów (domyślnie) lub do konkretnego dewelopera. W menu wybierz „Wszyscy deweloperzy” lub konkretnego dewelopera.

4. Kliknij Utwórz korektę.

Edytowanie wyrównania płatności

Aby edytować wyrównanie płatności:

1. Otwórz stronę Korekty płatności.
2. Najedź kursorem na wyrównanie płatności, które chcesz edytować, i w menu czynności kliknij .
3. W razie potrzeby zaktualizuj wyrównanie płatności.
4. Kliknij Zaktualizuj korektę.

Wprowadzanie korekt płatności za pomocą interfejsu API

W sekcjach poniżej opisujemy, jak wprowadzać korekty płatności za pomocą interfejsu API.

Wprowadzanie wyrównania płatności za pomocą interfejsu API

Szczegóły płatności możesz zmienić, wysyłając żądanie POST na adres /organizations/{org_name}/billing-adjustments. W treści żądania podaj:

• nazwę wyrównania płatności;
• wartość procentową korekty, czyli dodatnią lub ujemną wartość procentową, która odpowiednio zwiększa lub zmniejsza rachunek;
• miesiąc rozliczeniowy;
• rok rozliczeniowy;
• organizację, do której ma zastosowanie wyrównanie płatności.

Możesz też określić inne właściwości, takie jak:

• typ transakcji, do której chcesz zastosować korektę (np. transakcja zakupu );
• deweloper, do którego chcesz zastosować korektę;
• czy chcesz zastosować korektę do deweloperów korzystających z przedpłaty, deweloperów korzystających z płatności po wykonaniu usługi czy do obu tych grup;
• pakiet API, do którego chcesz zastosować korektę;
• produkt API, do którego chcesz zastosować korektę.

Pełną listę właściwości wyrównania płatności, które możesz określić w żądaniu wyrównania, znajdziesz w sekcji Ustawienia konfiguracji wyrównania płatności.

Jeśli nie określisz opcjonalnej właściwości, korekta w dokumencie rozliczeniowym będzie obejmować wszystkie wartości tej właściwości. Jeśli na przykład nie określisz typu transakcji, korekta płatności będzie dotyczyć wszystkich typów transakcji.

Poniższy przykład wprowadza wyrównanie płatności za otwarty miesiąc rozliczeniowy, czyli czerwiec 2013 r. Korekta zmniejsza kwotę o 3% i jest stosowana do transakcji zakupu, produktu płatności i deweloperów korzystających z płatności po wykonaniu usługi. Ponieważ nie określono właściwości identyfikujących konkretnego dewelopera ani pakiet API, korekta zostanie zastosowana do wszystkich deweloperów (którzy korzystają z płatności po wykonaniu usługi) oraz do produktu płatności we wszystkich pakietach 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

Odpowiedź powinna wyglądać mniej więcej tak (pokazana jest tylko jej część):

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

Wyświetlanie korekt płatności za pomocą interfejsu API

Możesz wyświetlić konkretne wyrównanie płatności lub wszystkie wyrównania płatności w organizacji. Aby wyświetlić konkretne wyrównanie płatności, wyślij żądanie GET na adres /organizations/{org_name}/billing-adjustments/{billing_adjustment_id}, gdzie {billing_adjustment_id} to identyfikator konkretnego wyrównania płatności (identyfikator jest zwracany w odpowiedzi podczas tworzenia wyrównania płatności). Przykład:

$ 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

Aby wyświetlić wszystkie korekty płatności w organizacji, wyślij żądanie GET na adres /organizations/{org_name}/billing-adjustments. Przykład:

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

Odpowiedź powinna wyglądać mniej więcej tak (pokazana jest tylko jej część):

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

Aktualizowanie wyrównania płatności za pomocą interfejsu API

Wyrównanie płatności możesz zaktualizować, wysyłając żądanie PUT na adres /organizations/{org_name}/billing-adjustments/{billing_adjustment_id}, gdzie {billing_adjustment_id} to identyfikator konkretnego wyrównania płatności. Podczas aktualizacji musisz w treści żądania określić zaktualizowane właściwości oraz identyfikator wyrównania płatności, które ma zostać zaktualizowane. Musisz też określić obowiązkowe właściwości wyrównania płatności, czyli właściwości nazwy, wartości procentowej korekty, miesiąca rozliczeniowego, roku rozliczeniowego i organizacji.

Na przykład to wywołanie interfejsu API aktualizuje wartość procentową korekty i nazwę (zaktualizowane właściwości są w przykładzie wyróżnione):

$ 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

Usuwanie wyrównania płatności za pomocą interfejsu API

Korektę płatności możesz usunąć, wysyłając żądanie DELETE na adres /organizations/{org_name}/billing-adjustments/{billing_adjustment_id}, gdzie {billing_adjustment_id} to identyfikator korekty płatności, która ma zostać usunięta. Przykład:

$ 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

Ustawienia konfiguracji wyrównania płatności w interfejsie API

W przypadku korekt płatności dostępne są te opcje konfiguracji:

Dalsze kroki

Monetyzacja umożliwia przyznawanie deweloperowi środków. Może być to konieczne, jeśli deweloper nie jest zadowolony z usługi i prosi o częściowy lub całkowity zwrot środków za okres korzystania. Dowiedz się, jak przyznać środki, w artykule Przyznawanie środków.