Apportare aggiustamenti della fatturazione

Stai visualizzando la documentazione di Apigee Edge.
Consulta la documentazione di Apigee X. info

Introduzione

La monetizzazione ti consente di apportare modifiche ai dettagli di fatturazione. Ad esempio, potresti dover aumentare o diminuire la quota di condivisione delle entrate o le commissioni per un determinato mese di fatturazione a causa di una discrepanza nei tuoi record.

Esplorare la pagina Aggiustamenti di fatturazione

Accedi alla pagina Aggiustamenti di fatturazione come descritto di seguito.

Aggiungere un aggiustamento di fatturazione

Per aggiungere un aggiustamento di fatturazione:

1. Accedi alla pagina Aggiustamenti di fatturazione.
2. Fai clic su + Aggiustamento.
3. Inserisci le seguenti informazioni:

   Campo	Descrizione
   Nome	Un nome descrittivo che verrà visualizzato nel documento di fatturazione.
   Percentuale di aggiustamento	Importo dell'aggiustamento, come percentuale positiva o negativa. Una percentuale positiva aumenta la quota di condivisione delle entrate o le commissioni nella transazione di quella percentuale. Un aggiustamento negativo riduce la quota di condivisione delle entrate o le commissioni nella transazione di quella percentuale. Inserisci un numero decimale positivo o negativo (con un massimo di due cifre decimali).
   Mese di fatturazione	Mese di fatturazione per l'aggiustamento. Seleziona un mese dall'elenco a discesa.
   Tipo di transazione	Tipo di transazione per cui vuoi applicare l'aggiustamento. Seleziona un valore dal menu a discesa: Tutte le transazioni Addebito (transazioni del modello di addebito) Acquisto (transazioni del modello di condivisione delle entrate) Rimborso (transazioni del modello di condivisione delle entrate)
   Prodotto	Prodotto API per cui vuoi applicare l'aggiustamento. Non puoi applicare un singolo aggiustamento a più prodotti API. Se devi applicare un aggiustamento a multiple prodotti API, crea un aggiustamento per ogni prodotto. Seleziona un prodotto API dal menu a discesa.
   Sviluppatore	Sviluppatore per cui vuoi applicare l'aggiustamento. Puoi applicare l' aggiustamento a tutti gli sviluppatori (per impostazione predefinita) o a uno sviluppatore specifico. Seleziona "Tutti gli sviluppatori" o uno sviluppatore specifico dal menu a discesa.

4. Fai clic su Crea aggiustamento.

Modificare un aggiustamento di fatturazione

Per modificare un aggiustamento di fatturazione:

1. Accedi alla pagina Aggiustamenti di fatturazione.
2. Posiziona il cursore sull'aggiustamento di fatturazione che vuoi modificare e fai clic su nel menu delle azioni.
3. Aggiorna l'aggiustamento di fatturazione, se necessario.
4. Fai clic su Aggiorna aggiustamento.

Apportare aggiustamenti di fatturazione utilizzando l'API

Le sezioni seguenti descrivono come apportare aggiustamenti di fatturazione utilizzando l'API.

Apportare un aggiustamento di fatturazione utilizzando l'API

Puoi modificare i dettagli di fatturazione inviando una richiesta POST a /organizations/{org_name}/billing-adjustments. Quando effettui la richiesta, specifica nel corpo della richiesta:

• Il nome dell'aggiustamento di fatturazione.
• Una percentuale di aggiustamento, ovvero un valore percentuale positivo o negativo che aumenta o riduce rispettivamente la fattura.
• Il mese di fatturazione.
• L'anno di fatturazione.
• L'organizzazione a cui viene applicato l'aggiustamento di fatturazione.

Puoi anche specificare altre proprietà, ad esempio:

• Il tipo di transazione per cui vuoi applicare l'aggiustamento (ad esempio una transazione di acquisto ).
• Lo sviluppatore per cui vuoi applicare l'aggiustamento.
• Se vuoi applicare l'aggiustamento agli sviluppatori con pagamento anticipato, agli sviluppatori con pagamento posticipato o a entrambi.
• Il pacchetto API per cui vuoi applicare l'aggiustamento.
• Il prodotto API per cui vuoi applicare l'aggiustamento.

Per un elenco completo delle proprietà di aggiustamento di fatturazione che puoi specificare in una richiesta di aggiustamento, consulta Impostazioni di configurazione dell'aggiustamento di fatturazione.

Se non viene specificata una proprietà facoltativa, l'aggiustamento del documento di fatturazione sarà onnicomprensivo per quella proprietà. Ad esempio, se non viene specificato alcun tipo di transazione, l'aggiustamento di fatturazione verrà applicato a tutti i tipi di transazione.

L'esempio seguente apporta un aggiustamento di fatturazione per il mese di fatturazione aperto, giugno 2013. L' aggiustamento comporta una riduzione di un fattore del 3% e viene applicato alle transazioni di acquisto, al prodotto di pagamento e agli sviluppatori con pagamento posticipato. Poiché le proprietà per identificare uno sviluppatore o un pacchetto API specifici non sono specificate, l'aggiustamento verrà applicato a tutti gli sviluppatori (che sono sviluppatori con pagamento posticipato) e al prodotto di pagamento in tutti i pacchetti 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 risposta dovrebbe essere simile alla seguente (viene mostrata solo una parte della risposta):

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

Visualizzare gli aggiustamenti di fatturazione utilizzando l'API

Puoi visualizzare un aggiustamento di fatturazione specifico o tutti gli aggiustamenti di fatturazione per un'organizzazione. Per visualizzare un aggiustamento di fatturazione specifico, invia una richiesta GET a /organizations/{org_name}/billing-adjustments/{billing_adjustment_id}, dove {billing_adjustment_id} è l'identificazione dell'aggiustamento di fatturazione specifico (l'ID viene restituito nella risposta quando crei l'aggiustamento di fatturazione). Ad esempio:

$ 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

Per visualizzare tutti gli aggiustamenti di fatturazione per un'organizzazione, invia una richiesta GET a /organizations/{org_name}/billing-adjustments. Ad esempio:

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

La risposta dovrebbe essere simile alla seguente (viene mostrata solo una parte della risposta):

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

Aggiornare un aggiustamento di fatturazione utilizzando l'API

Puoi aggiornare un aggiustamento di fatturazione inviando una richiesta PUT a /organizations/{org_name}/billing-adjustments/{billing_adjustment_id}, dove {billing_adjustment_id} è l'identificazione dell'aggiustamento di fatturazione specifico. Quando effettui l'aggiornamento, devi specificare nel corpo della richiesta le proprietà aggiornate e la identificazione dell'aggiustamento di fatturazione da aggiornare. Devi anche specificare le proprietà obbligatorie per l'aggiustamento di fatturazione, ovvero le proprietà per il nome, la percentuale di aggiustamento, il mese di fatturazione, l'anno di fatturazione e l'organizzazione.

Ad esempio, la seguente chiamata API aggiorna il fattore percentuale di aggiustamento e il nome (le proprietà aggiornate sono evidenziate nell'esempio):

$ 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

Eliminare un aggiustamento di fatturazione utilizzando l'API

Puoi eliminare un aggiustamento di fatturazione inviando una richiesta DELETE a /organizations/{org_name}/billing-adjustments/{billing_adjustment_id}, dove {billing_adjustment_id} è l'identificazione dell'aggiustamento di fatturazione da eliminare. Ad esempio:

$ 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

Impostazioni di configurazione dell'aggiustamento di fatturazione per l'API

Sono disponibili le seguenti opzioni di configurazione per gli aggiustamenti di fatturazione:

Passaggi successivi

La monetizzazione ti offre la flessibilità di emettere crediti a uno sviluppatore. Potresti doverlo fare se uno sviluppatore non è soddisfatto di un servizio e richiede un rimborso parziale o totale dell'utilizzo per un periodo. Scopri come emettere crediti in Emettere crediti.