Administra el perfil de la organización

Estás viendo la documentación de Apigee Edge.
Ve a la documentación de Apigee X. info

En las siguientes secciones, se presenta el perfil de la organización y se describe cómo puedes administrarlo con la IU y la API.

Acerca del perfil de la organización

Como parte de la configuración inicial de la monetización, el equipo de configuración de Apigee Edge configura el perfil de tu organización.

Debes editar el perfil de la organización para agregar o actualizar información sobre ella, según corresponda. Por ejemplo, es posible que debas actualizar el tipo de facturación, la configuración de la moneda o el modelo de impuestos.

Configura información básica sobre tu organización, como la siguiente:

• Nombre, dirección y país de operación de la organización
• Tipo de facturación (prepaga, pospago o ambos), como se describe en Comprende el tipo de facturación
• Ciclo de facturación (prorrateado o mes calendario)
• Moneda base
• Modelo fiscal que utiliza tu organización

Puedes administrar el perfil de tu organización con la IU y la API, como se describe en las siguientes secciones.

Explora la página Perfil de la organización

Accede a la página Perfil de la organización, como se describe a continuación.

Edita el perfil de la organización con la IU

Para editar el perfil de la organización con la IU, haz lo siguiente:

1. Accede a la página Perfil de la organización.
2. Haz clic en Editar.
3. En Nombre y datos, edita el nombre de la organización y el país de operación.
4. En Impuestos y moneda, edita los siguientes campos:

   Campo	Descripción
   Modelo de impuestos	Nota: Solo se aplica si configuras planes de tarifas de reparto de ingresos y deseas generar documentos de facturación. Es el modelo fiscal para los planes de tarifas de reparto de ingresos que identifica el tipo de documentos de facturación necesarios. Estos son algunos de los valores válidos: Divulgado: El proveedor de la API actúa como agente divulgado del desarrollador. Los ingresos brutos (incluidos los impuestos sobre las ventas) que se recaudan del usuario final se transfieren al desarrollador. La comisión del proveedor de la API se recauda del desarrollador en forma de una factura de comisión. El proveedor de la API no controla el impuesto sobre las ventas que se recauda del usuario final, y es responsabilidad del desarrollador informarlo. No divulgado: El proveedor de la API actúa como agente no divulgado del desarrollador y deduce el impuesto que se les asigna a los usuarios finales y lo paga a las autoridades fiscales locales. El desarrollador factura al proveedor de la API por el porcentaje de los ingresos netos que le corresponde (menos los impuestos sobre las ventas y la comisión del proveedor de la API). Híbrido: El proveedor de la API actúa como agente divulgado del desarrollador. Sin embargo, el proveedor de la API paga el impuesto sobre las ventas que se recauda de los suscriptores a las autoridades fiscales locales en nombre del desarrollador. El proveedor de la API pasa los ingresos restantes al desarrollador y, luego, factura los cargos de comisión.
   Moneda	Las monedas que admite tu organización En el caso de los planes de reparto de ingresos, hojas de tarifas y solo tarifas, se usa la moneda predeterminada para tu plan de tarifas. Cuando creas una tarifa o un plan de solo tarifas, puedes cambiar la moneda que quieres usar seleccionando una de la lista de monedas admitidas. De manera opcional, puedes establecer el importe mínimo de recarga que los desarrolladores de apps pueden agregar al saldo de su cuenta prepagada para cada moneda. Para agregar una moneda, sigue estos pasos: Haz clic en Agregar moneda. Selecciona una moneda en el menú desplegable del campo Moneda. De manera opcional, establece el importe mínimo que los desarrolladores de apps pueden agregar al saldo de su cuenta prepagada en la moneda especificada en el campo Recarga mínima. Haz clic en Agregar. Si lo deseas, haz clic en el botón de selección asociado para establecerla como la moneda predeterminada. Repite los pasos para agregar monedas adicionales. Para borrar una moneda, coloca el cursor sobre la moneda que deseas borrar y haz clic en .

5. Administra los términos y condiciones, como se describe en Cómo administrar los términos y condiciones con la IU.
6. Haz clic en Guardar.

Administra el perfil de la organización con la API

Administra el perfil de la organización con la API, como se describe en las siguientes secciones.

Cómo ver el perfil de la organización con la API

Para ver el perfil de tu organización, envía una solicitud GET a /mint/organizations/{org_name}. Por ejemplo:

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

A continuación, se proporciona un ejemplo de la respuesta. Para obtener más información sobre las opciones que se muestran, consulta Propiedades de configuración del perfil de la organización para la 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"
}

Edita el perfil de la organización con la API

Para editar el perfil de la organización, envía una solicitud PUT a /mint/organizations/{org_name}. Cuando edites el perfil de la organización, debes especificar todas las propiedades del perfil de la organización, no solo las que estás editando.

Para editar la moneda predeterminada de la organización, establece el valor de currency en el código de moneda ISO 4217 de la moneda admitida que deseas establecer como predeterminada.

Por ejemplo, la siguiente llamada a la API actualiza currency a USD y la configuración del modelo de impuestos a HYBRID (los campos actualizados se destacan en el ejemplo). Para obtener más información sobre las opciones que se muestran, consulta Propiedades de configuración del perfil de la organización para la 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

Configura los tipos de facturación prepago y pospago con la API

Las cuentas de desarrollador se pueden configurar para usar los siguientes tipos de facturación: prepago, pospago o ambos.

Con las cuentas prepagadas, los desarrolladores pagan por adelantado el uso de tus APIs. Los fondos se deducen del saldo prepagado del desarrollador que se mantiene a través de un proveedor de pagos integrado. El desarrollador debe mantener un saldo prepago suficiente para comprar las APIs.

Con las cuentas pospagas, se les factura mensualmente (a través de una factura) a los desarrolladores al final del mes. El desarrollador paga por el uso de los productos de API según las condiciones de pago establecidas por los planes incluidos en la factura.

Para configurar los tipos de facturación prepago y pospago de tu organización, establece la propiedad supportedBillingType en uno de los siguientes valores para indicar qué tipos de facturación son válidos: PREPAID, POSTPAID o BOTH. Si estableces el valor en BOTH, el valor predeterminado será PREPAID cuando agregues un desarrollador o una empresa de apps. En este caso, puedes configurar de forma explícita el tipo de facturación de una empresa o un desarrollador de apps con la API, como se describe en Cómo administrar empresas y desarrolladores de apps.

Por ejemplo:

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

Configura el ciclo de facturación con la API

Para configurar el ciclo de facturación de tu organización, establece la propiedad billingCycle en uno de los siguientes valores:

• PRORATED: La facturación se basa en la cantidad de días que se usa un producto de API en un mes calendario.
• CALENDAR_MONTH: La facturación se realiza mensualmente.

Por ejemplo:

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

Propiedades de configuración del perfil de organización para la API

El perfil de la organización te permite establecer las siguientes propiedades de configuración con la API.

Nombre	Descripción	Predeterminado	¿Obligatorio?
address	Dirección de la organización, que puede incluir la dirección, la ciudad, el estado, el código postal, el país y una indicación de si esta es la dirección principal de la organización	N/A	No
approveTrusted	Esta marca no se usa.	N/A	No
approveUntrusted	Esta marca no se usa.	N/A	No
billingCycle	Es el período del ciclo de facturación. El valor puede ser uno de los siguientes: PRORRATEADO: La facturación se basa en la cantidad de días que se usa un producto de API en un mes calendario. CALENDAR_MONTH: La facturación se realiza mensualmente. Consulta Cómo configurar el ciclo de facturación con la API.	N/A	Sí
country	Código ISO 3166-2 del país de operación de la organización, como BR para Brasil.	N/A	Sí
currency	Código ISO 4217 para la moneda “base” o de contabilidad que usa la organización (como USD para dólares estadounidenses). En el caso de los planes de reparto de ingresos, se usa la moneda especificada para tu plan. En el caso de los planes de tarjeta de tarifas (modelo de facturación), se aplica lo mismo que para los planes de reparto de ingresos. Sin embargo, puedes cambiar la configuración de la moneda a cualquier moneda que admita la organización. En el caso de los planes de solo tarifas, puedes cambiar la configuración de la moneda a cualquier moneda que admita la organización.	N/A	Sí
description	Descripción breve de la organización.	N/A	No
hasBillingAdjustment	Marca que especifica si los ajustes están habilitados. Si está habilitado, puedes realizar ajustes en los detalles del tráfico que registran los servicios de API para tus productos de API. El valor puede ser uno de los siguientes: verdadero: Los ajustes están habilitados. "false": Los ajustes no están habilitados.	N/A	No
hasBroker	Marca que especifica si los ingresos se basan en la cantidad neta. El valor puede ser uno de los siguientes: true: Los ingresos se basan en la cantidad neta. false: Los ingresos no se basan en la cantidad neta.	N/A	No
hasSelfBilling	Es una marca que dirige la monetización para que genere una factura de autofacturación en lugar de una declaración de porcentaje de ingresos. Una factura de autofacturación es un documento financiero que detalla el importe que se le debe al desarrollador de la app. Actúa como una factura para el proveedor de la API en nombre del desarrollador de la app. El valor puede ser cualquiera de los siguientes: true: Genera facturas de facturación automática en lugar de declaraciones de porcentaje de ingresos. false: Inhabilita las facturas de facturación automática.	N/A	No
hasSeparateInvoiceForProduct	Marca que especifica si se genera una factura independiente para cada producto de API. El valor puede ser cualquiera de los siguientes: true: Se genera una factura independiente para cada producto de API. false: No se genera una factura independiente para cada producto de la API.	N/A	No
id	Es el ID de la organización.	N/A	No
issueNettingStmt	Es una marca que especifica si se genera una declaración de compensación cuando se crean documentos de facturación. El valor puede ser cualquiera de los siguientes: true: Se genera una declaración de compensación cuando se crean documentos de facturación. false: No se genera la declaración de compensación cuando se crean documentos de facturación.	N/A	No
logoUrl	Es la URL del logotipo de la organización.	N/A	No
name	Nombre de la organización.	N/A	Sí
netPaymentAdviceNote	Nota de aviso de pago neto	N/A	No
nettingStmtPerCurrency	Es una marca que especifica si se genera una declaración de compensación independiente para cada moneda que se usa. El valor puede ser cualquiera de los siguientes: true: Se genera una declaración de compensación independiente para cada moneda que se usa. false: No se genera un estado de compensación independiente para cada moneda que se usa.	N/A	No
regNo	Es el número de registro de la organización. El número que ingreses para esta propiedad se mostrará en la parte inferior de los documentos de facturación.	N/A	No
selfBillingAsExchOrg	Si las facturas de autofacturación están habilitadas, indica si está habilitada para las organizaciones de intercambio. El valor puede ser cualquiera de los siguientes: true: Las facturas de autofacturación están habilitadas para las organizaciones de intercambio. false: Las facturas de autofacturación no están habilitadas para las organizaciones de intercambio.	N/A	No
selfBillingForAllDev	Si las facturas de autofacturación están habilitadas, indica si están habilitadas para todos los desarrolladores de apps. De forma predeterminada, las facturas de autofacturación solo se generan para los desarrolladores de apps que firmaron un acuerdo con el proveedor de la API. El valor puede ser cualquiera de los siguientes: true: Las facturas de autofacturación están habilitadas para todos los desarrolladores de apps. false: Las facturas de autofacturación no están habilitadas para todos los desarrolladores de apps.	falso	No
separateInvoiceForFees	Marca que especifica si se publica una factura independiente para las tarifas. El valor puede ser cualquiera de los siguientes: true: Se publica una factura independiente para las tarifas. false: No se publica una factura independiente para las tarifas.	falso	Sí
status	Es el estado de la organización. Estos son algunos de los valores válidos: ACTIVE: La cuenta de la organización está registrada en la monetización y está disponible para su uso. INACTIVE: La cuenta de la organización está registrada en la monetización, pero no está disponible para su uso.	N/A	No
supportedBillingType	Es el modelo de pago del desarrollador que se usa para la facturación. El valor puede ser uno de los siguientes: PREPAID: El desarrollador paga por adelantado el uso de un producto de API. Los fondos se deducen del saldo del desarrollador cuando se usa el producto de API. El desarrollador debe mantener un saldo prepago suficiente para comprar el producto de API. POSTPAID: Se le factura mensualmente (a través de una factura) al desarrollador por el uso de los productos de la API. El desarrollador paga por el uso de los productos de API según las condiciones de pago establecidas por los planes incluidos en la factura. BOTH: Admite cualquier tipo de facturación. El valor predeterminado es PREPAID. Consulta Cómo configurar los tipos de facturación prepago y pospago con la API.	PREPAID	Sí
taxModel	Nota: Solo se aplica si configuras planes de tarifas de reparto de ingresos y deseas generar documentos de facturación. Es el modelo fiscal para los planes de tarifas de reparto de ingresos que identifica el tipo de documentos de facturación necesarios. Estos son algunos de los valores válidos: Divulgado: El proveedor de la API actúa como agente divulgado del desarrollador. Los ingresos brutos (incluidos los impuestos sobre las ventas) que se recaudan del usuario final se transfieren al desarrollador. La comisión del proveedor de la API se recauda del desarrollador en forma de una factura de comisión. El proveedor de la API no controla el impuesto sobre las ventas que se recauda del usuario final, y es responsabilidad del desarrollador informarlo. No divulgado: El proveedor de la API actúa como agente no divulgado del desarrollador y deduce el impuesto que se les asigna a los usuarios finales y lo paga a las autoridades fiscales locales. El desarrollador factura al proveedor de la API por el porcentaje de los ingresos netos que le corresponde (menos los impuestos sobre las ventas y la comisión del proveedor de la API). Híbrido: El proveedor de la API actúa como agente divulgado del desarrollador. Sin embargo, el proveedor de la API paga el impuesto sobre las ventas que se recauda de los suscriptores a las autoridades fiscales locales en nombre del desarrollador. El proveedor de la API pasa los ingresos restantes al desarrollador y, luego, factura los cargos de comisión.	N/A	Sí
taxNexus	Es el país en el que la organización está registrada a efectos fiscales.	N/A	No
taxRegNo	Número de registro fiscal de la organización o número de registro del Impuesto sobre el valor agregado (IVA), si corresponde Esta propiedad es opcional porque el número de registro fiscal o el número de registro del IVA no se aplica en todos los países. El número que ingreses para este parámetro se muestra en la parte inferior de los documentos de facturación.	N/A	No
transactionRelayURL	Es la URL de otro sistema al que se pueden retransmitir las transacciones, como un almacén de datos.	N/A	No
timezone	Es el identificador de zona horaria de las operaciones de la organización, como America/New_York o Europe/Paris. También se admiten las abreviaturas de zonas horarias, como UTC, EST (hora estándar del este) o CET (hora central europea).	N/A	Sí

Anular la configuración del perfil de monetización de una empresa o un desarrollador de apps

Anula la configuración del perfil de monetización de una empresa o un desarrollador de apps con la IU o la API, como se describe en las siguientes secciones:

• Administra atributos personalizados para un desarrollador de apps
• Administra empresas y desarrolladores de apps
• Administra a los desarrolladores de apps