Gerencie o perfil da organização

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

As seções a seguir apresentam o perfil da organização e descrevem como gerenciá-lo usando a interface e a API.

Sobre o perfil da organização

Como parte da configuração inicial da monetização, a equipe de configuração do Apigee Edge configura o perfil da sua organização.

Você precisa editar o perfil da organização para adicionar ou atualizar informações sobre ela, conforme apropriado. Por exemplo, talvez seja necessário atualizar o tipo de faturamento, as configurações de moeda ou o modelo de imposto.

Configure informações básicas sobre sua organização, incluindo:

• Nome, endereço e país de operação da organização
• Tipo de faturamento (pré-pago, pós-pago ou ambos), conforme descrito em Entenda o tipo de faturamento
• Ciclo de faturamento (pro rata ou mês do calendário)
• Moeda base
• Modelo fiscal usado pela sua organização

É possível gerenciar o perfil da sua organização usando a interface e a API, conforme descrito nas seções a seguir.

Conheça a página "Perfil da organização"

Acesse a página "Perfil da organização", conforme descrito abaixo.

Editar o perfil da organização usando a interface

Para editar o perfil da organização usando a interface:

1. Acesse a página do perfil da organização.
2. Clique em Editar.
3. Em Nome e informações, edite o nome da organização e o país de operação.
4. Em Tributos e moeda, edite os seguintes campos:

   Campo	Descrição
   Modelo tributário	Observação:isso se aplica apenas se você configurar planos de tarifas de participação na receita e quiser gerar documentos de faturamento. Modelo fiscal para planos de tarifas de participação na receita que identifica o tipo de documentos de faturamento necessários. Valores válidos: Divulgado: o provedor de API atua como um agente divulgado do desenvolvedor. A receita bruta (incluindo impostos sobre vendas) coletada do usuário final é transmitida ao desenvolvedor. A comissão do provedor da API é coletada do desenvolvedor na forma de uma fatura de comissão. O provedor de API não processa o imposto sobre vendas coletado do usuário final, e é responsabilidade do desenvolvedor informar o imposto sobre vendas. Não divulgado: o provedor de API atua como um agente não divulgado do desenvolvedor e deduz o imposto coletado dos usuários finais e o paga às autoridades fiscais locais. O desenvolvedor fatura o provedor da API pela parte da receita líquida devida ao desenvolvedor (menos impostos sobre vendas e a comissão do provedor da API). Híbrido: o provedor de API atua como um agente divulgado do desenvolvedor. No entanto, o provedor da API paga o imposto sobre vendas coletado dos assinantes às autoridades fiscais locais em nome do desenvolvedor. O provedor da API transmite a receita restante ao desenvolvedor e depois fatura as cobranças de comissão.
   Moeda	Moedas aceitas pela sua organização. Para planos de participação na receita, tabela de preços e apenas de taxas, a moeda padrão é usada para seu plano de preços. Ao criar um plano de taxas ou de preço, é possível mudar a moeda a ser usada selecionando uma opção na lista de moedas aceitas. Você também pode definir o valor mínimo de recarga que os desenvolvedores de apps podem adicionar ao saldo da conta pré-paga para cada moeda. Para adicionar uma moeda: Clique em Adicionar moeda. Selecione uma moeda no menu suspenso do campo Currency. Opcionalmente, defina o valor mínimo que os desenvolvedores de apps podem adicionar ao saldo da conta pré-paga na moeda especificada no campo Recarga mínima. Clique em Adicionar. Defina como a moeda padrão, se quiser, clicando no botão de opção associado. Repita as etapas para adicionar outras moedas. Para excluir uma moeda, posicione o cursor sobre ela e clique em .

5. Gerencie os termos e condições, conforme descrito em Como gerenciar termos e condições usando a interface.
6. Clique em Salvar.

Gerenciar o perfil da organização usando a API

Gerencie o perfil da organização usando a API, conforme descrito nas seções a seguir.

Conferir o perfil da organização usando a API

Para acessar o perfil da sua organização, emita uma solicitação GET para /mint/organizations/{org_name}. Exemplo:

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

Veja a seguir um exemplo de resposta. Para mais informações sobre as opções mostradas, consulte Propriedades de configuração do perfil da organização para a API.

{
    "address" : [ {
      "address1" : "Test address”,
      "city" : "Test City",
      "country" : "US",
      "id" : "test-address",
      "isPrimary" : true,
      "state" : "CA",
      "zip" : "54321"
    } ],
    "approveTrusted" : false,
    "approveUntrusted" : false,
    "billingCycle" : "CALENDAR_MONTH",
    "country" : "US",
    "currency" : "USD",
    "description" : "Test organization",
    "hasBillingAdjustment" : true,
    "hasBroker" : false,
    "hasSelfBilling" : false,
    "hasSeparateInvoiceForProduct" : false,
    "id" : "{org_name}"
    "issueNettingStmt" : false,
    "logoUrl" : " https://dl.dropboxusercontent.com/u/48279818/LOGOS/testorg.jpeg",
    "name" : "myorg",
    "nettingStmtPerCurrency" : false,
    "regNo" : "RegNo-1234-myorg",
    "selfBillingAsExchOrg" : false,
    "selfBillingForAllDev" : false,
    "separateInvoiceForFees" : true,
    "status" : "ACTIVE",
    "supportedBillingType" : "PREPAID",
    "taxModel" : "UNDISCLOSED",
    "taxRegNo" : "TaxRegNo-1234-myorg",
    "timezone" : "UTC"
}

Editar o perfil da organização usando a API

Edite o perfil da organização emitindo uma solicitação PUT para /mint/organizations/{org_name}. Ao editar o perfil da organização, é necessário especificar todas as propriedades do perfil da organização, não apenas as propriedades que você está editando.

Para editar a moeda padrão da organização, defina o valor currency como o código de moeda ISO 4217 da moeda com suporte que você quer definir como padrão.

Por exemplo, a chamada de API a seguir atualiza currency para USD e a configuração do modelo de imposto para HYBRID. Os campos atualizados estão destacados no exemplo. Para mais informações sobre as opções mostradas, consulte Propriedades de configuração do perfil da organização para a API.

curl -X PUT "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}" \
  -H "Content-Type: application/json" \
  -d '{
  "address" : [ { 
    "address1" : "Test address”,
    "city" : "Test City",
    "country" : "US",
    "id" : "corp-address",
    "isPrimary" : true,
    "state" : "CA",
    "zip" : "54321"
  } ], 
  "approveTrusted" : false, 
  "approveUntrusted" : false, 
  "billingCycle" : "CALENDAR_MONTH", 
  "country" : "US", 
  "currency" : "USD", 
  "description" : "Test organization", 
  "hasBillingAdjustment" : true, 
  "hasBroker" : false, 
  "hasSelfBilling" : false, 
  "hasSeparateInvoiceForProduct" : false,
  "id" : "myorg", 
  "issueNettingStmt" : false, 
  "logoUrl" : "https://dl.dropboxusercontent.com/u/48279818/LOGOS/testorg.jpeg",
  "name" : "{org_name}", 
  "nettingStmtPerCurrency" : false, 
  "regNo" : "RegNo-1234-myorg", 
  "selfBillingAsExchOrg" : false, 
  "selfBillingForAllDev" : false, 
  "separateInvoiceForFees" : false, 
  "status" : "ACTIVE", 
  "supportedBillingType" : "POSTPAID",
  "taxModel" : "HYBRID", 
  "taxRegNo" : "TaxRegNo-1234-myorg", 
  "timezone" : "UTC" 
}' \

-u email:password

Configurar tipos de faturamento pré-pago e pós-pago usando a API

As contas de desenvolvedor podem ser configuradas para usar os seguintes tipos de faturamento: pré-pago, pós-pago ou ambos.

Com as contas pré-pagas, os desenvolvedores pagam antecipadamente pelo uso das suas APIs. Os fundos são deduzidos do saldo pré-pago do desenvolvedor, que é mantido por um provedor de pagamentos integrado. O desenvolvedor precisa manter um saldo pré-pago suficiente para comprar as APIs.

Com as contas pós-pagas, os desenvolvedores recebem uma fatura mensal no final do mês. O desenvolvedor paga pelo uso dos produtos de API com base nas condições de pagamento definidas pelos planos incluídos na fatura.

Para configurar os tipos de faturamento pré-pago e pós-pago da sua organização, defina a propriedade supportedBillingType como um dos seguintes valores para indicar quais tipos de faturamento são válidos: PREPAID, POSTPAID ou BOTH. Se você definir o valor como BOTH, o padrão será PREPAID ao adicionar um desenvolvedor de app ou uma empresa. Nesse caso, é possível definir explicitamente o tipo de faturamento de uma empresa ou de um desenvolvedor de apps usando a API, conforme descrito em Gerenciar empresas e desenvolvedores de apps.

Exemplo:

curl -X PUT "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}" \
  -H "Content-Type: application/json" \
  -d '{
  "address" : [ {
    "address1" : "Test address",
    "city" : "Test City",
    "country" : "US",
    "id" : "corp-address",
    "isPrimary" : true,
    "state" : "CA",
    "zip" : "54321"
  } ],
  "approveTrusted" : false,
  "approveUntrusted" : false,
  "billingCycle" : "CALENDAR_MONTH",
  "country" : "US",
  "currency" : "USD",
  "description" : "Test organization",
  "hasBillingAdjustment" : true,
  "hasBroker" : false,
  "hasSelfBilling" : false,
  "hasSeparateInvoiceForProduct" : false,
  "id" : "myorg",
  "issueNettingStmt" : false,
  "logoUrl" : "https://dl.dropboxusercontent.com/u/48279818/LOGOS/testorg.jpeg",
  "name" : "{org_name}",
  "nettingStmtPerCurrency" : false,
  "regNo" : "RegNo-1234-myorg",
  "selfBillingAsExchOrg" : false,
  "selfBillingForAllDev" : false,
  "separateInvoiceForFees" : false,
  "status" : "ACTIVE",
  "supportedBillingType" : "POSTPAID",
  "taxModel" : "HYBRID",
  "taxRegNo" : "TaxRegNo-1234-myorg",
  "timezone" : "UTC"
  }' \
  -u email:password

Configurar o ciclo de faturamento usando a API

Para configurar o ciclo de faturamento da sua organização, defina a propriedade billingCycle como um dos seguintes valores:

• PRORATED: o faturamento é baseado no número de dias em que um produto de API é usado em um mês.
• CALENDAR_MONTH: o faturamento é feito mensalmente.

Exemplo:

curl -X PUT "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}" \
  -H "Content-Type: application/json" \
  -d '{
    "address" : [ {
      "address1" : "Test address",
      "city" : "Test City",
      "country" : "US",
      "id" : "corp-address",
      "isPrimary" : true,
      "state" : "CA",
      "zip" : "54321"
    } ],
    "approveTrusted" : false,
    "approveUntrusted" : false,
    "billingCycle" : "CALENDAR_MONTH",
    "country" : "US",
    "currency" : "USD",
    "description" : "Test organization",
    "hasBillingAdjustment" : true,
    "hasBroker" : false,
    "hasSelfBilling" : false,
    "hasSeparateInvoiceForProduct" : false,
    "id" : "myorg",
    "issueNettingStmt" : false,
    "logoUrl" : "https://dl.dropboxusercontent.com/u/48279818/LOGOS/testorg.jpeg",
    "name" : "{org_name}",
    "nettingStmtPerCurrency" : false,
    "regNo" : "RegNo-1234-myorg",
    "selfBillingAsExchOrg" : false,
    "selfBillingForAllDev" : false,
    "separateInvoiceForFees" : false,
    "status" : "ACTIVE",
    "supportedBillingType" : "POSTPAID",
    "taxModel" : "HYBRID",
    "taxRegNo" : "TaxRegNo-1234-myorg",
    "timezone" : "UTC"
  }' \
  -u email:password

Propriedades de configuração do perfil da organização para a API

Com o perfil da organização, você pode definir as seguintes propriedades de configuração usando a API.

Nome	Descrição	Padrão	Obrigatório?
address	Endereço da organização, que pode incluir o endereço da rua, cidade, estado, CEP, país e uma indicação de se esse é o endereço principal da organização.	N/A	Não
approveTrusted	Essa flag não é usada.	N/A	Não
approveUntrusted	Essa flag não é usada.	N/A	Não
billingCycle	Período do ciclo de faturamento. O papel pode ser um dos seguintes: PROPORCIONAL: o faturamento é baseado no número de dias em que um produto de API é usado em um mês do calendário. CALENDAR_MONTH: o faturamento é mensal. Consulte Como configurar o ciclo de faturamento usando a API.	N/A	Sim
country	Código ISO 3166-2 do país de operação da organização, como BR para o Brasil.	N/A	Sim
currency	Código ISO 4217 para a moeda "base" ou contábil que a organização usa (como USD para o dólar americano). Para planos de participação na receita: a moeda especificada é usada no seu plano. Para planos de tabela de preços (modelo de cobrança): o mesmo se aplica aos planos de compartilhamento de receita. No entanto, é possível mudar a configuração de moeda para qualquer moeda aceita pela organização. Para planos somente com taxas: é possível mudar a configuração da moeda para qualquer moeda aceita pela organização.	N/A	Sim
description	Breve descrição da organização.	N/A	Não
hasBillingAdjustment	Flag que especifica se os ajustes estão ativados. Se ativada, é possível fazer ajustes nos detalhes de tráfego registrados pelos Serviços de API para seus produtos de API. O valor pode ser um dos seguintes: true: os ajustes estão ativados. false: os ajustes não estão ativados.	N/A	Não
hasBroker	Flag que especifica se a receita é baseada na receita líquida. O valor pode ser um dos seguintes: Verdadeiro: a receita é baseada no valor líquido. Falso: a receita não é baseada na receita líquida.	N/A	Não
hasSelfBilling	Flag que direciona a monetização para gerar uma fatura de autofaturamento em vez de um extrato de participação na receita. Uma fatura de autofaturamento é um documento financeiro que detalha o valor devido ao desenvolvedor do app. Ele funciona como uma fatura para o provedor de API em nome do desenvolvedor do app. O valor pode ser um dos seguintes: true: gera faturas de autofaturamento em vez de extratos de participação na receita. "false": desativa as faturas de autofaturamento.	N/A	Não
hasSeparateInvoiceForProduct	Flag que especifica se uma fatura separada é gerada para cada produto de API. O valor pode ser um dos seguintes: true: uma fatura separada é gerada para cada produto da API. Falso: a fatura separada não é gerada para cada produto de API.	N/A	Não
id	ID da organização.	N/A	Não
issueNettingStmt	Flag que especifica se uma declaração de compensação é gerada ao criar documentos de faturamento. O valor pode ser um dos seguintes: Verdadeiro: a declaração de compensação é gerada ao criar documentos de faturamento. Falso: a declaração de compensação não é gerada ao criar documentos de faturamento.	N/A	Não
logoUrl	URL do logotipo da organização.	N/A	Não
name	Nome da organização.	N/A	Sim
netPaymentAdviceNote	Observação de pagamento líquido.	N/A	Não
nettingStmtPerCurrency	Flag que especifica se uma declaração de compensação separada é gerada para cada moeda usada. O valor pode ser um dos seguintes: true: uma declaração de compensação separada é gerada para cada moeda usada. Falso: a declaração de compensação separada não é gerada para cada moeda usada.	N/A	Não
regNo	Número de registro da organização. O número inserido para essa propriedade é exibido na parte de baixo dos documentos de faturamento.	N/A	Não
selfBillingAsExchOrg	Se as faturas de autofaturamento estiverem ativadas, indica se elas estão ativadas para organizações de troca. O valor pode ser um dos seguintes: True: as faturas de autofaturamento estão ativadas para organizações de troca. Falso: as faturas de autofaturamento não estão ativadas para organizações de troca.	N/A	Não
selfBillingForAllDev	Se as faturas de autofaturamento estiverem ativadas, indique se elas estão ativadas para todos os desenvolvedores de apps. Por padrão, as faturas de autofaturamento são geradas apenas para desenvolvedores de apps que assinaram um contrato com o provedor de API. O valor pode ser um dos seguintes: verdadeiro: as faturas de autofaturamento são ativadas para todos os desenvolvedores de apps. Falso: as faturas de autofaturamento não são ativadas para todos os desenvolvedores de apps.	falso	Não
separateInvoiceForFees	Flag que especifica se uma fatura separada é publicada para taxas. O valor pode ser um dos seguintes: true: uma fatura separada é publicada para as taxas. Falso: uma fatura separada não é publicada para taxas.	falso	Sim
status	Status da organização. Valores válidos: ATIVO: a conta da organização está registrada na monetização e está disponível para uso. INATIVO: a conta da organização está registrada na monetização, mas não está disponível para uso.	N/A	Não
supportedBillingType	Modelo de pagamento do desenvolvedor usado para faturamento. O papel pode ser um dos seguintes: PREPAID: o desenvolvedor paga antecipadamente pelo uso de um produto de API. Os fundos são deduzidos do saldo do desenvolvedor quando o produto de API é usado. O desenvolvedor precisa manter um saldo pré-pago suficiente para comprar o produto de API. PÓS-PAGO: o desenvolvedor é cobrado mensalmente (por meio de uma fatura) pelo uso de produtos de API. O desenvolvedor paga pelo uso dos produtos de API com base nas condições de pagamento definidas pelos planos incluídos na fatura. AMBOS: aceita qualquer tipo de faturamento. O padrão é "PRÉ-PAGO". Consulte Como configurar tipos de faturamento pré-pago e pós-pago usando a API.	PREPAID	Sim
taxModel	Observação:isso se aplica apenas se você configurar planos de tarifas de participação na receita e quiser gerar documentos de faturamento. Modelo fiscal para planos de tarifas de participação na receita que identifica o tipo de documentos de faturamento necessários. Valores válidos: Divulgado: o provedor de API atua como um agente divulgado do desenvolvedor. A receita bruta (incluindo impostos sobre vendas) coletada do usuário final é transmitida ao desenvolvedor. A comissão do provedor da API é coletada do desenvolvedor na forma de uma fatura de comissão. O provedor de API não processa o imposto sobre vendas coletado do usuário final, e é responsabilidade do desenvolvedor informar o imposto sobre vendas. Não divulgado: o provedor de API atua como um agente não divulgado do desenvolvedor e deduz o imposto coletado dos usuários finais e o paga às autoridades fiscais locais. O desenvolvedor fatura o provedor da API pela parte da receita líquida devida ao desenvolvedor (menos impostos sobre vendas e a comissão do provedor da API). Híbrido: o provedor de API atua como um agente divulgado do desenvolvedor. No entanto, o provedor da API paga o imposto sobre vendas coletado dos assinantes às autoridades fiscais locais em nome do desenvolvedor. O provedor da API transmite a receita restante ao desenvolvedor e depois fatura as cobranças de comissão.	N/A	Sim
taxNexus	O país em que a organização está registrada para fins fiscais.	N/A	Não
taxRegNo	Número de registro fiscal ou de Imposto sobre Valor Agregado (IVA) da organização, se aplicável. Essa propriedade é opcional porque o número de registro fiscal ou de registro do IVA não se aplica a todos os países. O número inserido para esse parâmetro é exibido na parte de baixo dos documentos de faturamento.	N/A	Não
transactionRelayURL	URL de outro sistema para o qual as transações podem ser retransmitidas, como um data warehouse.	N/A	Não
timezone	O identificador de fuso horário das operações da organização, como América/Nova York ou Europa/Paris. Abreviações de fuso horário, como UTC, EST (horário padrão do leste dos EUA) ou CET (horário da Europa Central), também são aceitas.	N/A	Sim

Como substituir as configurações do perfil de monetização de uma empresa ou de um desenvolvedor de apps

Substitua as configurações do perfil de monetização de uma empresa ou desenvolvedor de apps usando a IU ou a API, conforme descrito nas seções a seguir:

• Como gerenciar atributos personalizados para um desenvolvedor de apps
• Como gerenciar empresas e desenvolvedores de apps
• Como gerenciar desenvolvedores de apps