Fazer ajustes de faturamento

Você está lendo a documentação do Apigee Edge.
Acesse a documentação da Apigee X. info

Introdução

A monetização permite fazer ajustes nos detalhes de faturamento. Por exemplo, talvez seja necessário aumentar ou diminuir a participação na receita ou as taxas de um determinado mês de faturamento devido a uma discrepância nos seus registros.

Conhecer a página "Ajustes de faturamento"

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

Adicionar um ajuste de serviço

Para adicionar um ajuste de serviço:

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.
   % de ajuste	Valor do ajuste, como uma porcentagem positiva ou negativa. Uma porcentagem positiva ajusta para cima a participação na receita ou as taxas na transação por essa porcentagem. Um ajuste negativo ajusta para baixo a participação na receita ou as taxas na transação por essa porcentagem. Insira um número decimal positivo ou negativo (com até duas casas decimais).
   Mês de faturamento	Mês de faturamento do ajuste. Selecione um mês na lista suspensa.
   Tipo de transação	Tipo de transação para a qual você quer aplicar o ajuste. Selecione um valor no menu suspenso: Todas as transações Cobrança (transações de modelo de cobrança) Compra (transações de modelo de participação na receita) Reembolso (transações de modelo de participação na receita)
   Produto	Produto de API para o qual você quer aplicar o ajuste. Não é possível aplicar um único ajuste a vários produtos de API. Se você precisar aplicar um ajuste a 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 o ajuste a todos os desenvolvedores (por padrão) ou a um desenvolvedor específico. Selecione "Todos os desenvolvedores" ou um desenvolvedor específico no menu suspenso.

4. Clique em Criar ajuste.

Editar um ajuste de serviço

Para editar um ajuste de serviço:

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

Fazer ajustes de faturamento usando a API

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

Fazer um ajuste de serviço usando a API

É possível ajustar os detalhes de faturamento emitindo uma solicitação POST para /organizations/{org_name}/billing-adjustments. Ao fazer a solicitação, especifique no corpo da solicitação:

• Nome do ajuste de serviço.
• 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 a que o ajuste de serviço é aplicado.

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

• Tipo de transação para a qual você quer aplicar o ajuste (como uma transação de compra ).
• Desenvolvedor para quem você quer aplicar o ajuste.
• Se você quer aplicar o ajuste a desenvolvedores pré-pagos, pós-pagos ou ambos.
• Pacote de API para o qual você quer aplicar o ajuste.
• Produto de API para o qual você quer aplicar o ajuste.

Consulte Configurações de ajuste de serviço para uma lista completa de propriedades de ajuste de serviço 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á inclusivo para essa propriedade. Por exemplo, se nenhum tipo de transação for especificado, o ajuste de faturamento será aplicado a todos os tipos de transação.

O exemplo a seguir faz um ajuste de serviço para o mês de faturamento aberto, junho de 2013. O ajuste faz uma redução por um fator de 3% e é aplicado a transações de compra, ao produto de pagamento e a desenvolvedores pós-pagos. Como as propriedades para identificar um desenvolvedor ou pacote de API específico não são especificadas, o ajuste será aplicado a todos os desenvolvedores (que são desenvolvedores pós-pagos) e ao 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"
}

Conferir ajustes de faturamento usando a API

É possível conferir um ajuste de serviço específico ou todos os ajustes de serviço de uma organização. Para conferir um ajuste de serviço específico, emita uma solicitação GET para /organizations/{org_name}/billing-adjustments/{billing_adjustment_id}, em que {billing_adjustment_id} é a identificação do ajuste de serviço específico (o ID é retornado na resposta quando você cria o ajuste de serviço). 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 conferir todos os ajustes de faturamento de uma organização, emita 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
}

Atualizar um ajuste de serviço usando a API

É possível atualizar um ajuste de serviço 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 serviço específico. Ao fazer a atualização, é necessário especificar no corpo da solicitação as propriedades atualizadas e a identificação do ajuste de serviço a ser atualizado. Você também precisa especificar as propriedades obrigatórias para o ajuste de serviço, 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 de porcentagem de ajuste e o nome (as propriedades atualizadas sã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

Excluir um ajuste de serviço usando a API

É possível 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 serviço a ser excluído. 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 serviço para a API

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

Próximas etapas

A monetização oferece a flexibilidade de emitir créditos para um desenvolvedor. Talvez seja necessário fazer isso se um desenvolvedor estiver insatisfeito com um serviço e solicitar um reembolso parcial ou total do uso de um período. Saiba como emitir crédito em Emitir créditos.