Apportare aggiustamenti della fatturazione

Stai visualizzando la documentazione di Apigee Edge.
Vai alla sezione Documentazione di Apigee X. Informazioni

Introduzione

La monetizzazione ti consente di apportare modifiche ai dettagli di fatturazione. Ad esempio, potresti aver bisogno aumentare o diminuire la quota di condivisione delle entrate o le tariffe per un dato mese di fatturazione a causa di di discrepanza nei tuoi registri.

Esplorazione della pagina Aggiustamenti di fatturazione

Accedi alla pagina Aggiustamenti di fatturazione, come descritto di seguito.

Aggiungi un aggiustamento di fatturazione

Per aggiungere un aggiustamento di fatturazione:

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

   Campo	Descrizione
   Nome	Un nome descrittivo che verrà visualizzato sul documento di fatturazione.
   % aggiustamento	Importo dell'aggiustamento, espresso in percentuale positiva o negativa. Un positivo percentuale adegua la quota di condivisione delle entrate o le commissioni nella transazione in base al percentuale. Un aggiustamento negativo adegua la quota di condivisione delle entrate o le commissioni nel transazione per questa percentuale. Inserisci un numero decimale positivo o negativo (con con due cifre decimali).
   Mese di fatturazione	Mese di fatturazione dell'aggiustamento. Seleziona un mese dall'elenco a discesa.
   Tipo di transazione	Tipo di transazione a cui vuoi applicare l'aggiustamento. Seleziona uno dal menu a discesa: Tutte le transazioni Addebito (addebito delle transazioni del modello) Acquisto (transazioni del modello di condivisione delle entrate) Rimborso (transazioni del modello di condivisione delle entrate)
   Prodotto	Prodotto API per il quale vuoi applicare l'aggiustamento. Non puoi applicare un un singolo aggiustamento a più prodotti API. Per applicare un aggiustamento più prodotti API, creare un aggiustamento per ciascun prodotto. Seleziona un prodotto API nel menu a discesa.
   Sviluppatore	Sviluppatore per il quale vuoi applicare l'aggiustamento. Puoi applicare a tutti gli sviluppatori (per impostazione predefinita) o a uno specifico sviluppatore. Seleziona "Tutte Sviluppatori" o uno sviluppatore specifico dal menu a discesa.

4. Fai clic su Crea aggiustamento.

Modifica di 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 da modificare e fai clic su nel menu Azioni.
3. Aggiorna l'aggiustamento di fatturazione come richiesto.
4. Fai clic su Aggiorna aggiustamento.

Aggiustamenti di fatturazione tramite l'API

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

Effettuare 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, specifichi nel corpo della richiesta:

• Nome dell'aggiustamento di fatturazione.
• Una percentuale di aggiustamento, ovvero un valore percentuale positivo o negativo che rispettivamente aumenta o riduce l'importo.
• Mese di fatturazione.
• Anno di fatturazione.
• Organizzazione a cui viene applicato l'aggiustamento di fatturazione.

Puoi anche specificare altre proprietà, ad esempio:

• Tipo di transazione a cui applicare l'aggiustamento (ad esempio un acquisto) transazione).
• Sviluppatore per il quale vuoi applicare l'aggiustamento.
• Se vuoi applicare l'aggiustamento agli sviluppatori con pagamento anticipato, agli sviluppatori con pagamento posticipato o entrambi.
• pacchetto API a cui applicare l'aggiustamento.
• Prodotto API per il quale vuoi applicare l'aggiustamento.

Per un elenco completo, consulta Impostazioni di configurazione degli aggiustamenti di fatturazione. che puoi specificare in una richiesta di aggiustamento.

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

Nell'esempio seguente viene eseguito un aggiustamento di fatturazione per il mese di fatturazione aperto, giugno 2013. La l'aggiustamento apporta una riduzione di un fattore del 3% e viene applicato alle transazioni di acquisto, prodotti di pagamento e sviluppatori con pagamento posticipato. Poiché le proprietà per identificare una specifica sviluppatore o pacchetto API, l'aggiustamento verrà applicato a tutti gli sviluppatori (che sono sviluppatori con pagamento posticipato) e il 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 avere un aspetto simile al seguente (è 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"
}

Visualizzazione degli aggiustamenti di fatturazione utilizzando l'API

Puoi visualizzare un aggiustamento di fatturazione specifico o tutti gli aggiustamenti di fatturazione di 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 avere un aspetto simile al seguente (è 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
}

Aggiornamento di 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 esegui l'aggiornamento, devi specificare nel corpo della richiesta le proprietà aggiornate dell'aggiustamento di fatturazione da aggiornare. Devi anche specificare i campi obbligatori relative all'aggiustamento di fatturazione, ovvero proprietà del nome, percentuale dell'aggiustamento mese di fatturazione, anno di fatturazione e organizzazione.

Ad esempio, la seguente chiamata API aggiorna il fattore e il nome di percentuale di aggiustamento (il parametro 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

Eliminazione di 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 eliminati. 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 degli aggiustamenti di fatturazione per l'API

Per gli aggiustamenti di fatturazione sono disponibili le seguenti opzioni di configurazione:

Passaggi successivi

La monetizzazione ti offre la flessibilità di emettere crediti per uno sviluppatore. Potresti dover fare questo messaggio se uno sviluppatore non è soddisfatto di un servizio e richiede un rimborso parziale o totale per l'utilizzo per un determinato periodo di tempo. Scopri come emettere credito in Emissione di crediti.