进行结算调整

您正在查看的是 Apigee Edge 文档。
转到 Apigee X 文档
信息

简介

通过创收功能,您可以对结算详细信息进行调整。例如,由于记录差异,您可能需要增加或减少给定结算月份的收益分成或费用。

探索“结算调整”页面

访问“结算调整项”页面,如下所述。

Edge

如需使用 Edge 界面访问“结算调整项”页面,请执行以下操作:

  1. 登录 apigee.com/edge
  2. 在左侧导航栏中,依次选择发布 > 创收 > 结算调整

此时会显示“结算调整项”页面。

如图所示,在“结算调整项”页面中,您可以执行以下操作:

传统 Edge (Private Cloud)

如需使用传统版 Edge 界面访问“结算调整项”页面,请执行以下操作:

  1. 登录 http://ms-ip:9000,其中 ms-ip 是管理服务器节点的 IP 地址或 DNS 名称。
  2. 在顶部导航栏中依次选择创收 > 调整

通过“结算调整项”页面,您可以:

  • 查看当前的结算调整项列表
  • 添加结算调整项
  • 修改结算调整项
  • 搜索结算调整项列表

添加结算调整项

要添加结算调整项,请执行以下操作:

  1. 访问“结算调整”页面
  2. 点击 + 调整
  3. 输入以下信息:
    字段 说明
    名称

    将显示在结算凭证上的描述性名称。

    调整百分比

    调整金额,以正百分比或负百分比表示。正百分比表示交易中的收益分成或费用按该百分比调整。负调整是指将交易的收益分成或费用下调该百分比。请输入一个正或负十进制数(最多精确到小数点后两位)。

    结算月份

    调整项的结算月份。从下拉列表中选择月份。

    交易类型

    您要应用调整的交易类型。从下拉列表中选择一个值:

    • 所有交易
    • 扣款(充电模式交易)
    • 购买(采用收益分成模式的交易)
    • 退款(采用收益分成模式的交易)
    产品

    您要为其应用调整的 API 产品。您不能将一项调整项应用于多个 API 产品。如果您需要对多个 API 产品应用调整项,请为每个产品创建调整项。从下拉菜单中选择 API 产品。

    开发者

    您要为其应用调整的开发者。您可以将调整项应用于所有开发者(默认)或特定的开发者。从下拉菜单中选择“所有开发者”或特定的开发者。

  4. 点击创建调整项

修改结算调整项

要修改结算调整项,请执行以下操作:

  1. 访问“结算调整”页面
  2. 将光标悬停在要修改的结算调整项上,然后点击操作菜单中的
  3. 根据需要更新结算调整项。
  4. 点击更新调整值

使用 API 进行结算调整

以下各部分介绍了如何使用 API 进行结算调整。

通过 API 进行结算调整

您可以通过向 /organizations/{org_name}/billing-adjustments 发出 POST 请求来调整结算详细信息。发出请求时,请在请求正文中指定:

  • 结算调整项的名称。
  • 调整百分比,即分别增加或减少账单金额的正百分比或负百分比值。
  • 结算月份。
  • 结算年份。
  • 应用结算调整项的组织。

您还可以指定其他属性,例如:

  • 要应用调整的交易类型(例如购买交易)。
  • 您要为其应用调整的开发者。
  • 是要将调整项应用于预付费开发者和/或后付费开发者。
  • 您要为其应用调整的 API 软件包。
  • 您要为其应用调整的 API 产品。

请参阅结算调整项配置设置,查看您可以在调整请求中指定的结算调整项属性的完整列表。

如果未指定可选属性,则该媒体资源的结算单据调整项将全部包含在内。例如,如果未指定交易类型,则结算调整项将应用于所有交易类型。

以下示例对未结结算月份(2013 年 6 月)进行结算调整。该调整将折扣幅度减少 3%,并适用于购买交易、付款产品和后付费开发者。由于未指定用于标识特定开发者或 API 软件包的属性,因此该调整将应用于所有开发者(后付费开发者)以及所有 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

响应应类似如下所示(仅显示部分响应):

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

使用 API 查看结算调整项

您可以查看组织的特定结算调整项或所有结算调整项。如需查看具体结算调整项,请向 /organizations/{org_name}/billing-adjustments/{billing_adjustment_id} 发出 GET 请求,其中 {billing_adjustment_id} 是特定结算调整项的标识(创建结算调整项时会在响应中返回该 ID)。例如:

$ 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

如需查看组织的所有结算调整项,请向 /organizations/{org_name}/billing-adjustments 发出 GET 请求。例如:

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

响应应类似如下所示(仅显示部分响应):

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

使用 API 更新结算调整项

您可以通过向 /organizations/{org_name}/billing-adjustments/{billing_adjustment_id} 发出 PUT 请求来更新结算调整项,其中 {billing_adjustment_id} 是特定结算调整项的标识。进行更新时,您需要在请求正文中指定更新后的属性以及要更新的结算调整项的标识。您还需要指定结算调整项的必需属性,即名称、调整百分比、结算月份、结算年份和组织的属性。

例如,以下 API 调用更新了调整百分比因数和名称(示例中突出显示了更新后的属性):

$ 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

使用 API 删除结算调整项

您可以通过向 /organizations/{org_name}/billing-adjustments/{billing_adjustment_id} 发出 DELETE 请求来删除结算调整项,其中 {billing_adjustment_id} 是要删除的结算调整项的标识。例如:

$ 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

API 的结算调整项配置设置

以下配置选项可用于结算调整:

名称 说明 默认 是否必需?
name

结算调整项的描述性名称。

不适用
adjustmentPercentageFactor

调整金额,以正数或负数字百分比表示。正百分比表示交易中的收益分成或费用按该百分比调整。负百分比是指将交易的收益分成或费用调低该百分比。值介于 -100 到 999.9999 之间。

不适用
billingMonth

结算调整项的结算月份,以整数表示。例如,11 表示 12 月。

不适用
billingYear

结算调整项的结算年份,请使用以下格式指定:YYYY。例如,2017 年。

不适用
organization

结算调整项适用的组织。

不适用
isPublished

一个标记,用于指定是否应发布调整项。该值可以是以下其中一项:

  • true。应发布账单调整项。
  • false。不应发布该结算调整项。
不适用
transactionType

结算调整项适用的交易类型。类型可以是以下其中一项:

  • PURCHASE
  • CHARGE
  • REFUND
  • CREDIT
  • BALANCE
  • SETUPFEES
  • TERMINATIONFEES
  • RECURRINGFEES
  • TRUEUPS。此类交易用于重新调整已评分的交易。当上一个结算月份中的税费发生变化时,系统就会调用这些账单。
不适用
developerBillingType

结算调整项适用的开发者结算类型。值可以是以下值之一:

  • PREPAID.。预付费开发者。
  • POSTPAID。后付费开发者。
  • BOTH。预付费和后付费开发者。
不适用
product

结算调整项适用的 API 产品。如果您未指定此属性,则结算调整项适用于所有 API 产品。

不适用
monetizationPackage

结算调整项适用的 API 软件包。如果您未指定此属性,则结算调整项适用于所有 API 软件包。

不适用
developer

应用结算调整项的开发者。如果您未指定此属性,则结算调整项适用于所有开发者。

不适用

后续步骤

利用创收功能,您可以灵活地向开发者发放赠金。如果开发者对某项服务不满意,并要求针对一段时间的用量支付部分或全额退款,那么您可能需要这样做。请参阅发放赠金,了解如何发放赠金。