Fazer ajustes de faturamento

Esta é a documentação do Apigee Edge.
Acesse Documentação da Apigee X. informações

Introdução

Com a monetização, é possível ajustar os detalhes de faturamento. Por exemplo, talvez você precise para aumentar ou diminuir a participação na receita ou as taxas de um determinado mês de faturamento devido a uma discrepâncias nos seus registros.

Como explorar a página "Ajustes de faturamento"

Acesse a página "Ajustes de faturamento", conforme descrito abaixo.

Adicionar um ajuste de faturamento

Para adicionar um ajuste de faturamento:

1. Acesse a página "Ajustes de faturamento".
2. Clique em + Ajuste.
3. Digite as seguintes informações:

   Campo	Descrição
   Nome	Um nome descritivo que vai aparecer no documento de faturamento.
   % do ajuste	Valor do ajuste, como uma porcentagem positiva ou negativa. Um positivo a porcentagem ajusta a participação na receita ou as taxas na transação de acordo com porcentagem. Um ajuste negativo diminui a participação na receita ou as taxas da transação por essa porcentagem. Insira um número decimal positivo ou negativo com duas casas decimais).
   Mês de faturamento	Mês de faturamento para o ajuste. Selecione um mês na lista suspensa.
   Tipo de transação	Tipo de transação a que você quer aplicar o ajuste. Selecione um na lista suspensa: Todas as transações Cobrança (cobranças de transações de modelo) Compra (transações do modelo de participação na receita) Reembolso (transações do modelo de participação na receita)
   Produto	o produto da API a que você quer aplicar o ajuste. Não é possível aplicar uma um único ajuste a vários produtos de API. Se você precisar aplicar um ajuste vários produtos de API, crie um ajuste para cada produto. Selecione um produto de API no menu suspenso.
   Desenvolvedor	Desenvolvedor para quem você quer aplicar o ajuste. É possível aplicar ajuste a todos os desenvolvedores (por padrão) ou a um desenvolvedor específico. Selecione "Todos Desenvolvedores" ou um desenvolvedor específico no menu suspenso.

4. Clique em Criar ajuste.

Editar um ajuste de faturamento

Para editar um ajuste de faturamento:

1. Acesse a página "Ajustes de faturamento".
2. Posicione o cursor sobre o ajuste de faturamento que você quer editar e clique em no menu de ações.
3. Atualize o ajuste de faturamento conforme necessário.
4. Clique em Atualizar ajuste.

Como fazer ajustes de faturamento usando a API

As seções a seguir descrevem como fazer ajustes no faturamento usando a API.

Como fazer um ajuste de faturamento usando a API

Você pode ajustar os detalhes de faturamento emitindo uma solicitação POST para /organizations/{org_name}/billing-adjustments. Ao fazer a solicitação, você especifica no corpo da solicitação:

• Nome do ajuste de faturamento.
• Uma porcentagem de ajuste, ou seja, um valor percentual positivo ou negativo que aumenta ou reduz a fatura respectivamente.
• Mês de faturamento.
• Ano de faturamento.
• Organização à qual o ajuste de faturamento é aplicado.

Também é possível especificar outras propriedades, como:

• Tipo de transação a que você quer aplicar o ajuste (como uma compra) transação).
• Desenvolvedor para quem você quer aplicar o ajuste.
• Se você quer aplicar o ajuste para desenvolvedores pré-pagos, desenvolvedores pós-pagos ou os dois.
• do pacote de APIs ao qual você quer aplicar o ajuste.
• o produto da API a que você quer aplicar o ajuste.

Consulte Definições de configuração do ajuste de faturamento para ver uma lista completa dos propriedades de ajuste de faturamento que podem ser especificadas em uma solicitação de ajuste.

Se uma propriedade opcional não for especificada, o ajuste do documento de faturamento será todo inclusivos para essa propriedade. Por exemplo, se nenhum tipo de transação for especificado, o faturamento será aplicado a todos os tipos de transação.

O exemplo a seguir faz um ajuste de faturamento para o mês de faturamento aberto, junho de 2013. A tem uma redução de 3% e é aplicado a transações de compra, o produtos de pagamento e desenvolvedores pós-pagos. Como as propriedades para identificar um desenvolvedor ou pacote de API não for especificado, o ajuste será aplicado a todos os desenvolvedores (que (desenvolvedores pós-pagos) e o produto de pagamento em todos os pacotes de 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

A resposta deve ser semelhante a esta (apenas parte da resposta é exibida):

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

Como visualizar ajustes de faturamento usando a API

É possível ver um ajuste de serviço específico ou todos os ajustes de serviço de uma organização. Para visualizar um ajuste de faturamento específico, envie uma solicitação GET para /organizations/{org_name}/billing-adjustments/{billing_adjustment_id}, em que {billing_adjustment_id} é a identificação do ajuste de faturamento específico (o ID é retornado na resposta quando você cria o ajuste de faturamento). Exemplo:

$ 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

Para visualizar todos os ajustes de serviço de uma organização, envie uma solicitação GET para /organizations/{org_name}/billing-adjustments: Exemplo:

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

A resposta deve ser semelhante a esta (apenas parte da resposta é exibida):

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

Como atualizar um ajuste de faturamento usando a API

Você pode atualizar um ajuste de faturamento emitindo uma solicitação PUT para /organizations/{org_name}/billing-adjustments/{billing_adjustment_id}, em que {billing_adjustment_id} é a identificação do ajuste de faturamento específico. Ao fazer a atualização, você precisa especificar no corpo da solicitação as propriedades atualizadas e o identificação do ajuste de faturamento a ser atualizado. Também é necessário especificar os campos para o ajuste de cobrança, ou seja, propriedades para o nome, porcentagem de ajuste, mês de faturamento, ano de faturamento e organização.

Por exemplo, a chamada de API a seguir atualiza o fator da porcentagem e o nome do ajuste (o propriedades atualizadas estão destacadas no exemplo):

$ 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

Como excluir um ajuste de faturamento usando a API

Você pode excluir um ajuste de serviço emitindo uma solicitação DELETE para /organizations/{org_name}/billing-adjustments/{billing_adjustment_id}, em que {billing_adjustment_id} é a identificação do ajuste de faturamento a ser excluída. Exemplo:

$ 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

Configurações de ajuste de faturamento para a API

As seguintes opções de configuração estão disponíveis para ajustes de serviço:

Próximas etapas

Com a monetização, você tem flexibilidade para emitir créditos a um desenvolvedor. Talvez seja necessário fazer se um desenvolvedor está insatisfeito com um serviço e solicita um reembolso parcial ou total pelo uso por determinado período. Saiba como fazer isso em Como emitir créditos.