Wprowadzanie korekt płatności

Przeglądasz dokumentację Apigee Edge.
Otwórz dokumentację Apigee X. Informacje

Wstęp

Funkcja zarabiania umożliwia dostosowywanie szczegółów płatności. Na przykład z powodu rozbieżności w Twoich rejestrach może być konieczne zwiększenie lub zmniejszenie udziału w przychodach bądź opłat w danym miesiącu rozliczeniowym.

Przeglądanie strony Korekty płatności

Przejdź na stronę Korekty płatności w sposób opisany poniżej.

Dodaj korektę płatności

Aby dodać korektę płatności:

1. Otwórz stronę Korekty płatności.
2. Kliknij + Korekta.
3. Wprowadź następujące informacje:

   Pole	Opis
   Nazwa	Nazwa opisowa, która pojawi się na dokumencie rozliczeniowym.
   Dostosowanie (%)	Kwota korekty jako dodatnia lub ujemna wartość procentowa. Dodatnia wartość procentowa koryguje udział w przychodach lub opłaty w transakcji o daną wartość procentową. Korekta ujemna koryguje udział w przychodach lub opłaty w transakcji o daną wartość procentową. Wpisz dodatnią lub ujemną liczbę dziesiętną (z maksymalnie 2 miejscami po przecinku).
   Miesiąc rozliczeniowy	Miesiąc rozliczeniowy na potrzeby korekty. Wybierz miesiąc z listy.
   Typ transakcji	Typ transakcji, do której chcesz zastosować korektę. Wybierz wartość z menu: Wszystkie transakcje Opłata (obciążanie transakcjami modelu) Zakup (transakcje modelu udziału w przychodach) Zwrot środków (transakcje modelu udziału w przychodach)
   Produkt	Usługa API, do której chcesz zastosować dostosowanie. Nie możesz zastosować jednego dostosowania do wielu usług interfejsu API. Jeśli chcesz zastosować korektę do wielu usług interfejsu API, utwórz korektę dla każdej z nich. Wybierz z menu usługę API.
   Deweloper	Deweloper, u którego chcesz zastosować dostosowanie. Możesz zastosować tę korektę (domyślnie) do wszystkich lub do konkretnego dewelopera. Wybierz z menu „Wszyscy deweloperzy” lub konkretnego dewelopera.

4. Kliknij Utwórz dostosowanie.

Edytowanie korekty płatności

Aby edytować korektę płatności:

1. Otwórz stronę Korekty płatności.
2. Najedź kursorem na korektę płatności, którą chcesz edytować, i kliknij w menu działań.
3. W razie potrzeby zaktualizuj korektę płatności.
4. Kliknij Zaktualizuj dostosowanie.

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

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

Korekta płatności za pomocą interfejsu API

Możesz dostosować szczegóły płatności, wysyłając żądanie POST do /organizations/{org_name}/billing-customizements. Wysyłając żądanie, określasz w jego treści:

• Nazwa korekty płatności.
• Procent korekty, czyli dodatnia lub ujemna wartość procentowa, która odpowiednio zwiększa lub zmniejsza opłatę.
• Miesiąc rozliczeniowy.
• Rok rozliczeniowy.
• Organizacja, do której stosowana jest korekta płatności.

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

• Typ transakcji, do której chcesz zastosować korektę (np. transakcja zakupu).
• Deweloper, u którego chcesz zastosować dostosowanie.
• Określa, czy chcesz zastosować korektę do deweloperów korzystających z przedpłaty, deweloperów opłacających abonament czy w obu tych przypadkach.
• Pakiet API, do którego chcesz zastosować dostosowanie.
• Usługa API, do której chcesz zastosować dostosowanie.

Pełną listę właściwości korekty płatności, które możesz określić w prośbie o korektę, znajdziesz w sekcji Ustawienia konfiguracji korekty płatności.

Jeśli nie określisz właściwości opcjonalnej, korekta dokumentu rozliczeniowego będzie uwzględniać tę wartość all włącznie. Jeśli na przykład nie określisz typu transakcji, korekta płatności zostanie zastosowana do wszystkich typów transakcji.

Poniższy przykład przedstawia korektę płatności za otwarty miesiąc rozliczeniowy, czerwiec 2013 r. Ta korekta powoduje zmniejszenie współczynnika o 3% i jest stosowana w przypadku transakcji zakupu, usługi płatności oraz deweloperów korzystających z abonamentów. Nie określono właściwości identyfikujących określonego dewelopera lub pakiet API, dlatego dostosowanie zostanie zastosowane do wszystkich deweloperów (którzy są deweloperami płacącymi za abonament) oraz usługi 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 (widoczna będzie tylko część odpowiedzi):

{
  "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 wyrównań płatności przy użyciu interfejsu API

Możesz wyświetlić konkretną korektę płatności lub wszystkie wyrównania płatności w organizacji. Aby wyświetlić konkretną korektę płatności, wyślij żądanie GET do usługi /organizations/{org_name}/billing-adjustments/{billing_adjustment_id}, gdzie {billing_adjustment_id} to identyfikator tej korekty płatności (identyfikator jest zwracany w odpowiedzi po utworzeniu korekty płatności). Na 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 wyrównania płatności w organizacji, wyślij żądanie GET do /organizations/{org_name}/billing-adjustments. Na 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 (widoczna będzie tylko część odpowiedzi):

{
  "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 korekty płatności przy użyciu interfejsu API

Możesz zaktualizować korektę płatności, wysyłając żądanie PUT do /organizations/{org_name}/billing-adjustments/{billing_adjustment_id}, gdzie {billing_adjustment_id} wskazuje daną korektę płatności. Podczas aktualizacji musisz podać w treści żądania zaktualizowane właściwości oraz identyfikator korekty płatności do zaktualizowania. Musisz też określić wymagane właściwości korekty płatności, czyli właściwości nazwy, odsetka korekty, miesiąca rozliczeniowego, roku rozliczeniowego i organizacji.

Na przykład to wywołanie interfejsu API aktualizuje procent dostosowania oraz nazwę (w tym przykładzie wyróżnione są zaktualizowane właściwości):

$ 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 korekty płatności przy użyciu interfejsu API

Możesz usunąć korektę płatności, wysyłając żądanie DELETE do /organizations/{org_name}/billing-adjustments/{billing_adjustment_id}, gdzie {billing_adjustment_id} to korekta płatności, która ma zostać usunięta. Na 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 dostosowania płatności w interfejsie API

W przypadku wyrównań płatności dostępne są te opcje konfiguracji:

Nazwa	Opis	Domyślne	Wymagana?
name	Opisowa nazwa korekty płatności.	Nie dotyczy	Tak
adjustmentPercentageFactor	Kwota korekty wyrażona w postaci dodatniej lub ujemnej wartości procentowej. Dodatnia wartość procentowa koryguje udział w przychodach lub opłaty w transakcji o daną wartość procentową. Ujemna wartość procentowa koryguje udział w przychodach lub opłaty w transakcji o daną wartość procentową. Wartości muszą mieścić się w zakresie od -100 do 999,9999.	Nie dotyczy	Tak
billingMonth	Miesiąc rozliczeniowy na potrzeby korekty płatności, określony jako liczba całkowita. Na przykład 11 dla grudnia.	Nie dotyczy	Tak
billingYear	Rok rozliczeniowy na potrzeby korekty płatności, określony w tym formacie: RRRR. Na przykład 2017.	Nie dotyczy	Tak
organization	Organizacja, której dotyczy korekta płatności.	Nie dotyczy	Tak
isPublished	Flaga określająca, czy dostosowanie powinno zostać opublikowane. Wartość może być jedną z tych: true. Korekta płatności powinna zostać opublikowana. false. Korekta płatności nie powinna zostać opublikowana.	Nie dotyczy	Nie
transactionType	Typ transakcji, których dotyczy korekta płatności. Możliwe typy wartości: PURCHASE CHARGE REFUND CREDIT BALANCE SETUPFEES TERMINATIONFEES RECURRINGFEES TRUEUPS. To transakcje, które służą do skorygowania sklasyfikowanych transakcji. Są wywoływane po wprowadzeniu zmian dotyczących podatków w poprzednim miesiącu rozliczeniowym.	Nie dotyczy	Nie
developerBillingType	Typ rozliczenia dewelopera, którego dotyczy korekta płatności. Możliwe wartości: PREPAID.. Deweloperzy korzystający z przedpłaty. POSTPAID. Deweloperzy korzystający z opcji płatności po wykonaniu usługi. BOTH. Deweloperzy korzystający z przedpłat i abonamentów.	Nie dotyczy	Nie
product	Usługa interfejsu API, której dotyczy korekta płatności. Jeśli nie określisz tej właściwości, korekta płatności będzie dotyczyła wszystkich usług API.	Nie dotyczy	Nie
monetizationPackage	Pakiet interfejsu API, którego dotyczy korekta płatności. Jeśli nie określisz tej właściwości, dostosowanie płatności będzie dotyczyć wszystkich pakietów API.	Nie dotyczy	Nie
developer	Deweloper, którego dotyczy korekta płatności. Jeśli nie określisz tej usługi, korekta płatności będzie dotyczyła wszystkich deweloperów.	Nie dotyczy	Nie

Dalsze kroki

Zarabianie daje Ci możliwość przyznawania środków deweloperowi. Może to być konieczne, jeśli deweloper nie jest zadowolony z usługi i poprosi o częściowy lub pełny zwrot środków za korzystanie z usługi za dany okres. Więcej informacji o przyznawaniu środków znajdziesz w artykule Wystawianie środków.