Realizar ajustes de facturación

Estás consultando la documentación de Apigee Edge.
Consulta la documentación de Apigee X.
Información

Introducción

La monetización te permite hacer ajustes a los detalles de facturación. Por ejemplo, es posible que debas aumentar o disminuir el porcentaje de ingresos o las tarifas para un mes de facturación determinado debido a una discrepancia en tus registros.

Cómo explorar la página Ajustes de facturación

Acceda a la página Ajustes de facturación, como se describe a continuación.

Conexión de integración

Para acceder a la página Ajustes de facturación con la IU de Edge, haz lo siguiente:

  1. Accede a apigee.com/edge.
  2. Selecciona Publicar > Monetización > Ajustes de facturación en la barra de navegación izquierda.

Se mostrará la página Ajustes de facturación.

Como se destaca en la imagen, la página Ajustes de facturación te permite hacer lo siguiente:

Versión clásica de Edge (nube privada)

Para acceder a la página Ajustes de facturación con la IU clásica de Edge, haz lo siguiente:

  1. Accede a http://ms-ip:9000, donde ms-ip es la dirección IP o el nombre de DNS del nodo del servidor de administración.
  2. Selecciona Monetización > Ajustes en la barra de navegación superior.

La página Ajustes de facturación te permite hacer lo siguiente:

  • Consulta la lista actual de ajustes de facturación
  • Agregar un ajuste de facturación
  • Cómo editar un ajuste de facturación
  • Buscar en la lista de ajustes de facturación

Agregar un ajuste de facturación

Para agregar un ajuste de facturación, sigue estos pasos:

  1. Accede a la página Ajustes de facturación.
  2. Haga clic en + Ajuste.
  3. Ingresa la siguiente información:
    Campo Descripción
    Nombre

    Es un nombre descriptivo que aparecerá en el documento de facturación.

    Porcentaje de ajuste

    Es el importe del ajuste, como porcentaje positivo o negativo. Un porcentaje positivo ajusta el porcentaje de ingresos o las tarifas de la transacción en función de ese porcentaje. Un ajuste negativo reduce el porcentaje de ingresos o las tarifas de la transacción en ese porcentaje. Ingresa un número decimal positivo o negativo (con hasta dos decimales).

    Mes de facturación

    Es el mes de facturación del ajuste. Selecciona un mes de la lista desplegable.

    Tipo de transacción

    Indica el tipo de transacción para la que deseas aplicar el ajuste. Selecciona un valor en el menú desplegable:

    • Todas las transacciones
    • Cargo (carga de las transacciones del modelo)
    • Compra (transacciones del modelo de reparto de ingresos)
    • Reembolso (transacciones con modelo de reparto de ingresos)
    Producto

    Producto de API para el que deseas aplicar el ajuste. No puedes aplicar un solo ajuste a varios productos de API. Si necesitas aplicar un ajuste a varios productos de API, crea un ajuste para cada uno. En el menú desplegable, selecciona un producto de API.

    Desarrollador

    Desarrollador para el que deseas aplicar el ajuste. Puedes aplicar el ajuste a todos los desarrolladores (de forma predeterminada) o a un desarrollador específico. Selecciona "Todos los desarrolladores" o un desarrollador específico en el menú desplegable.

  4. Haz clic en Crear ajuste.

Cómo editar un ajuste de facturación

Para editar un ajuste de facturación, sigue estos pasos:

  1. Accede a la página Ajustes de facturación.
  2. Coloque el cursor sobre el ajuste de facturación que desee editar y haga clic en en el menú de acciones.
  3. Actualiza el ajuste de facturación según sea necesario.
  4. Haga clic en Actualizar ajuste.

Cómo realizar ajustes de facturación con la API

En las siguientes secciones, se describe cómo realizar ajustes de facturación con la API.

Cómo realizar un ajuste de facturación con la API

Para ajustar los detalles de facturación, envía una solicitud POST a /organizations/{org_name}/billing-adjustments. Cuando realizas la solicitud, especificas lo siguiente en el cuerpo de la solicitud:

  • Nombre del ajuste de facturación.
  • Un porcentaje de ajuste, es decir, un valor porcentual positivo o negativo que aumenta o reduce la factura, respectivamente.
  • Mes de facturación
  • Es el año de facturación.
  • Es la organización a la que se aplica el ajuste de facturación.

También puedes especificar otras propiedades, como las siguientes:

  • Indica el tipo de transacción para la que deseas aplicar el ajuste (p. ej., una transacción de compra).
  • Desarrollador para el que deseas aplicar el ajuste.
  • Indica si deseas aplicar el ajuste a desarrolladores prepagados, desarrolladores de pospago o ambos.
  • Es el paquete de API para el que deseas aplicar el ajuste.
  • Producto de API para el que deseas aplicar el ajuste.

Consulta Configuración del ajuste de facturación para obtener una lista completa de las propiedades de ajuste de facturación que puedes especificar en una solicitud de ajuste.

Si no se especifica una propiedad opcional, el ajuste del documento de facturación será todo incluido para esa propiedad. Por ejemplo, si no se especifica un tipo de transacción, el ajuste de facturación se aplicará a todos los tipos de transacción.

En el siguiente ejemplo, se realiza un ajuste de facturación para el mes de facturación abierto, junio de 2013. El ajuste realiza una reducción en un factor del 3% y se aplica a las transacciones de compra, el producto de pago y los desarrolladores pospago. Debido a que no se especifican las propiedades para identificar un desarrollador específico o un paquete de API, el ajuste se aplicará a todos los desarrolladores (que son desarrolladores de pospago) y al producto de pago en todos los paquetes 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

La respuesta debería ser similar a la siguiente (solo se muestra 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"
}

Cómo visualizar los ajustes de facturación con la API

Puedes ver un ajuste de facturación específico o todos los ajustes de facturación de una organización. Para ver un ajuste de facturación específico, emite una solicitud GET a /organizations/{org_name}/billing-adjustments/{billing_adjustment_id}, en la que {billing_adjustment_id} es la identificación del ajuste de facturación específico (el ID se muestra en la respuesta cuando creas el ajuste de facturación). Por ejemplo:

$ 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 ver todos los ajustes de facturación de una organización, envía una solicitud GET a /organizations/{org_name}/billing-adjustments. Por ejemplo:

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

La respuesta debería ser similar a la siguiente (solo se muestra 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
}

Cómo actualizar un ajuste de facturación con la API

Puedes actualizar un ajuste de facturación si emites una solicitud PUT a /organizations/{org_name}/billing-adjustments/{billing_adjustment_id}, en la que {billing_adjustment_id} es la identificación del ajuste de facturación específico. Cuando realizas la actualización, debes especificar en el cuerpo de la solicitud las propiedades actualizadas y la identificación del ajuste de facturación que se actualizará. También debes especificar las propiedades obligatorias para el ajuste de facturación, es decir, las propiedades del nombre, el porcentaje de ajuste, el mes de facturación, el año de facturación y la organización.

Por ejemplo, la siguiente llamada a la API actualiza el factor y el nombre del porcentaje de ajuste (las propiedades actualizadas se destacan en el ejemplo):

$ 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

Cómo borrar un ajuste de facturación con la API

Para borrar un ajuste de facturación, envía una solicitud DELETE a /organizations/{org_name}/billing-adjustments/{billing_adjustment_id}, en la que {billing_adjustment_id} es la identificación del ajuste de facturación que se borrará. Por ejemplo:

$ 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

Configuración de ajustes de facturación para la API

Las siguientes opciones de configuración están disponibles para los ajustes de facturación:

Nombre Descripción Predeterminada ¿Obligatorio?
name

Es un nombre descriptivo para el ajuste de facturación.

No disponible
adjustmentPercentageFactor

Es el importe del ajuste, como un porcentaje numérico positivo o negativo. Un porcentaje positivo ajusta el porcentaje de ingresos o las tarifas de la transacción en función de ese porcentaje. Un porcentaje negativo ajusta el porcentaje de ingresos o las tarifas de la transacción en ese porcentaje. Los valores pueden variar de -100 a 999.9999.

No disponible
billingMonth

El mes de facturación del ajuste de facturación, especificado como un número entero. Por ejemplo, 11 para diciembre.

No disponible
billingYear

El año de facturación del ajuste de facturación, que se especifica con el siguiente formato: AAAA. Por ejemplo, 2017.

No disponible
organization

Es la organización a la que se aplica el ajuste de facturación.

No disponible
isPublished

Una marca que especifica si se debe publicar el ajuste. El valor puede ser uno de los siguientes:

  • true. El ajuste de facturación debería publicarse.
  • false. El ajuste de facturación no se debe publicar.
No disponible No
transactionType

Es el tipo de transacciones para las que se aplica el ajuste de facturación. El tipo puede ser uno de los siguientes:

  • PURCHASE
  • CHARGE
  • REFUND
  • CREDIT
  • BALANCE
  • SETUPFEES
  • TERMINATIONFEES
  • RECURRINGFEES
  • TRUEUPS. Estas son transacciones que se usan para reajustar las transacciones calificadas. Se invocan cuando se realizan cambios en los impuestos en el mes de facturación anterior.
No disponible No
developerBillingType

Es el tipo de facturación del desarrollador al que se aplica el ajuste de facturación. El valor puede ser uno de los siguientes:

  • PREPAID.. Desarrolladores prepagados.
  • POSTPAID. Desarrolladores pospago.
  • BOTH. Programadores de prepago y pospago.
No disponible No
product

El producto de API para el que se aplica el ajuste de facturación. Si no especificas esta propiedad, el ajuste de facturación se aplicará a todos los productos de API.

No disponible No
monetizationPackage

Es el paquete de API para el que se aplica el ajuste de facturación. Si no especificas esta propiedad, el ajuste de facturación se aplicará a todos los paquetes de API.

No disponible No
developer

El desarrollador para el que se aplica el ajuste de facturación Si no especificas esta propiedad, el ajuste de facturación se aplicará a todos los desarrolladores.

No disponible No

Próximos pasos

La monetización te brinda la flexibilidad de emitir créditos a un desarrollador. Es posible que debas hacerlo si un desarrollador no está satisfecho con un servicio y solicita un reembolso total o parcial por el uso durante un período determinado. Obtén información para emitir crédito en Cómo emitir créditos.