Realizar ajustes de facturación

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

Introducción

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

Explora la página Ajustes de facturación

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

Agrega un ajuste de facturación

Para agregar un ajuste de facturación, haz lo siguiente:

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

   Campo	Descripción
   Nombre	Un nombre descriptivo que aparecerá en el documento de facturación
   % de ajuste	Importe del ajuste, como un porcentaje positivo o negativo Un porcentaje positivo ajusta hacia arriba el porcentaje de ingresos o las tarifas de la transacción en ese porcentaje. Un ajuste negativo ajusta hacia abajo 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	Mes de facturación del ajuste Selecciona un mes de la lista desplegable.
   Tipo de transacción	Tipo de transacción para la que deseas aplicar el ajuste Selecciona un valor en el menú desplegable: Todas las transacciones Cargo (transacciones del modelo de carga) Compra (transacciones del modelo de reparto de ingresos) Reembolso (transacciones del 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 producto. Selecciona un producto de API en el menú desplegable.
   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.

Edita un ajuste de facturación

Para editar un ajuste de facturación, haz lo siguiente:

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

Realiza ajustes de facturación con la API

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

Realiza un ajuste de facturación con la API

Puedes ajustar los detalles de facturación si envías 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
• Año de facturación
• Organización a la que se aplica el ajuste de facturación

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

• Tipo de transacción para la que deseas aplicar el ajuste (como una transacción de compra transacción)
• Desarrollador para el que deseas aplicar el ajuste
• Si deseas aplicar el ajuste a desarrolladores prepagos, desarrolladores pospagos o ambos.
• Paquete de API para el que deseas aplicar el ajuste
• Producto de API para el que deseas aplicar el ajuste

Consulta Opciones de configuración de ajustes de facturación para obtener una lista completa de las propiedades de ajustes 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 incluirá todo 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 transacciones.

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, al producto de pago y a los desarrolladores pospagos. Como no se especifican las propiedades para identificar un desarrollador o un paquete de API específicos, el ajuste se aplicará a todos los desarrolladores (que son desarrolladores pospagos) 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 de la respuesta):

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

Visualiza 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, envía una solicitud GET a /organizations/{org_name}/billing-adjustments/{billing_adjustment_id}, donde {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 de la respuesta):

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

Actualiza un ajuste de facturación con la API

Puedes actualizar un ajuste de facturación si envías una solicitud PUT a /organizations/{org_name}/billing-adjustments/{billing_adjustment_id}, donde {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 de porcentaje de ajuste y el nombre (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

Borra un ajuste de facturación con la API

Puedes borrar un ajuste de facturación si envías una solicitud DELETE a /organizations/{org_name}/billing-adjustments/{billing_adjustment_id}, donde {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

Opciones de 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:

Próximos pasos

La monetización te brinda la flexibilidad de emitir créditos a un desarrollador. Es posible que debas hacer esto si un desarrollador no está satisfecho con un servicio y solicita un reembolso parcial o total del uso durante un período. Obtén información para emitir créditos en Emite créditos.