Apportare aggiustamenti della fatturazione

Stai visualizzando la documentazione di Apigee Edge.
Vai alla documentazione di Apigee X. informazioni

Introduzione

La monetizzazione ti consente di modificare i dettagli di fatturazione. Ad esempio, potresti dover aumentare o diminuire la quota di condivisione delle entrate o le tariffe per un determinato mese di fatturazione a causa di una discrepanza nei dati.

Esplorazione della pagina Aggiustamenti di fatturazione

Accedere 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. 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. Una percentuale positiva rettifica la quota di condivisione delle entrate o le commissioni nella transazione in base a questa percentuale. Un aggiustamento negativo adegua la quota di condivisione delle entrate o le commissioni nella transazione in base a questa percentuale. Inserisci un numero decimale positivo o negativo (con un massimo di 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 un valore dal menu a discesa: Tutte le transazioni Addebito (transazioni modello di ricarica) Acquisto (transazioni del modello di condivisione delle entrate) Rimborso (transazioni modello di condivisione delle entrate)
   Prodotto	Prodotto API a cui vuoi applicare l'aggiustamento. Non puoi applicare un singolo aggiustamento a più prodotti API. Se devi applicare un aggiustamento a più prodotti basati su API, creane uno per ogni prodotto. Seleziona un prodotto API dal menu a discesa.
   Sviluppatore	Sviluppatore a 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 da modificare e fai clic su nel menu Azioni.
3. Aggiorna l'aggiustamento di fatturazione come richiesto.
4. Fai clic su Aggiorna aggiustamento.

Apportare aggiustamenti di fatturazione tramite l'API

Le seguenti sezioni descrivono come effettuare 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, nel corpo della richiesta specifichi:

• Nome dell'aggiustamento di fatturazione.
• Una percentuale di aggiustamento, ovvero un valore percentuale positivo o negativo che aumenta o riduce rispettivamente l'importo della fattura.
• 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 vuoi applicare l'aggiustamento (ad esempio una transazione di acquisto).
• Sviluppatore a cui vuoi applicare l'aggiustamento.
• Se vuoi applicare l'aggiustamento agli sviluppatori prepagati, agli sviluppatori con pagamento posticipato o a entrambi.
• Pacchetto API a cui vuoi applicare l'aggiustamento.
• Prodotto API a cui vuoi applicare l'aggiustamento.

Consulta Impostazioni di configurazione degli aggiustamenti della fatturazione per un elenco completo delle proprietà degli aggiustamenti della fatturazione che puoi specificare in una richiesta di aggiustamento.

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

Nell'esempio seguente viene effettuato un aggiustamento di fatturazione per il mese di fatturazione aperto, giugno 2013. L'aggiustamento effettua una riduzione 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):

{
  "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 tramite 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):

{
  "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 esegui l'aggiornamento, devi specificare nel corpo della richiesta le proprietà aggiornate e l'identificazione dell'aggiustamento di fatturazione da aggiornare. Devi inoltre specificare le proprietà obbligatorie dell'aggiustamento di fatturazione, ovvero le proprietà del nome, della percentuale di aggiustamento, del mese di fatturazione, dell'anno di fatturazione e dell'organizzazione.

Ad esempio, la seguente chiamata API aggiorna il nome e il fattore percentuale di aggiustamento (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 tramite 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 degli aggiustamenti della fatturazione per l'API

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

Nome	Descrizione	Predefinito	Campo obbligatorio?
name	Un nome descrittivo per l'aggiustamento di fatturazione.	N/A	Sì
adjustmentPercentageFactor	L'importo della rettifica, espresso come percentuale numerica positiva o negativa. Una percentuale positiva rettifica la quota di condivisione delle entrate o le commissioni nella transazione in base a questa percentuale. Una percentuale negativa rettifica la quota di condivisione delle entrate o le commissioni nella transazione in base a questa percentuale. I valori sono compresi tra -100 e 999,9999.	N/A	Sì
billingMonth	Il mese di fatturazione per l'aggiustamento di fatturazione, indicato come numero intero. Ad esempio, 11 per dicembre.	N/A	Sì
billingYear	L'anno di fatturazione per l'aggiustamento di fatturazione, specificato nel seguente formato: AAAA. Ad esempio, 2017.	N/A	Sì
organization	L'organizzazione a cui si applica l'aggiustamento di fatturazione.	N/A	Sì
isPublished	Un flag che specifica se l'aggiustamento deve essere pubblicato. Il valore può essere uno dei seguenti: true. L'aggiustamento di fatturazione dovrebbe essere pubblicato. false. L'aggiustamento di fatturazione non deve essere pubblicato.	N/A	No
transactionType	Il tipo di transazioni a cui si applica l'aggiustamento di fatturazione. Il tipo può essere uno dei seguenti: PURCHASE CHARGE REFUND CREDIT BALANCE SETUPFEES TERMINATIONFEES RECURRINGFEES TRUEUPS. Si tratta di transazioni utilizzate per rettificare nuovamente le transazioni con valutazione. Vengono richiamati quando sono state apportate modifiche fiscali nel mese di fatturazione precedente.	N/A	No
developerBillingType	Il tipo di fatturazione sviluppatore a cui si applica l'aggiustamento di fatturazione. Il valore può essere uno dei seguenti: PREPAID.. Sviluppatori prepagati. POSTPAID. Sviluppatori con pagamento posticipato. BOTH. Sviluppatori prepagati e con pagamento posticipato.	N/A	No
product	Il prodotto API a cui si applica l'aggiustamento di fatturazione. Se non specifichi questa proprietà, l'aggiustamento della fatturazione si applica a tutti i prodotti API.	N/A	No
monetizationPackage	Il pacchetto API a cui si applica l'aggiustamento della fatturazione. Se non specifichi questa proprietà, l'aggiustamento di fatturazione si applica a tutti i pacchetti API.	N/A	No
developer	Lo sviluppatore per il quale si applica l'aggiustamento di fatturazione. Se non specifichi questa proprietà, l'aggiustamento di fatturazione si applica a tutti gli sviluppatori.	N/A	No

Passaggi successivi

La monetizzazione ti offre la flessibilità di assegnare crediti a uno sviluppatore. Potresti dover svolgere questa operazione se uno sviluppatore non è soddisfatto di un servizio e richiede un rimborso parziale o totale dell'utilizzo per un determinato periodo. Scopri come emettere credito nella pagina Emissione di crediti.