Google 会使用 AI 技术将内容翻译成您偏好的语言。AI 翻译可能包含错误。

进行结算调整

您正在查看 Apigee Edge 文档。
前往 Apigee X 文档。 info

简介

通过创收功能，您可以调整结算详情。例如，由于记录存在差异，您可能需要增加或减少给定结算月份的收益分成或费用。

浏览“结算调整”页面

访问“结算调整”页面（如下所述）。

Edge

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

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

系统随即会显示“结算调整”页面。

如图所示，您可以通过“结算调整”页面执行以下操作：

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

经典版 Edge (Private Cloud)

如需使用经典版 Edge 界面访问“结算调整”页面，请执行以下操作：

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

通过“结算调整”页面，您可以执行以下操作：

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

添加账单调整项

如需添加结算调整，请执行以下操作：

访问“结算调整”页面。
点击 + 调整项。

输入以下信息：

字段	说明
名称	结算文档中将显示的描述性名称。
调整百分比	调整金额，以正百分比或负百分比表示。正百分比表示将交易中的收益分成或费用按该百分比调高。负百分比表示将交易中的收益分成或费用按该百分比调低。输入正数或负数（最多两位小数）。
结算月份	调整项的结算月份。从下拉列表中选择一个月份。
交易类型	您要对其应用调整项的交易类型。从下拉列表中选择一个值：所有交易收费（收费模式交易）购买（收益分成模式交易）退款（收益分成模式交易）
产品	您要对其应用调整项的 API 产品。您无法将单个调整项应用于多个 API 产品。如果您需要将调整项应用于多个 API 产品，请为每个产品创建一个调整项。从下拉菜单中选择一个 API 产品。
开发者	您要对其应用调整项的开发者。您可以将调整项应用于所有开发者（默认）或特定开发者。从下拉菜单中选择“所有开发者”或特定开发者。注意：您为特定开发者所做的任何调整都会替换为所有开发者所做的调整。

点击创建调整项 。

修改结算调整项

如需修改账单调整项，请执行以下操作：

访问“结算调整”页面。
将光标置于要修改的账单调整项上，然后点击操作菜单中的。
根据需要更新账单调整项。
点击更新调整项 。

使用 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 产品。注意：您无法将单个调整项应用于多个 API 产品。如果您需要将调整项应用于多个 API 产品，请为每个产品创建一个调整项。	不适用	否
`monetizationPackage`	应用账单调整项的 API 软件包。如果您未指定此属性，则账单调整项将应用于所有 API 软件包。注意：您无法将单个调整项应用于多个 API 软件包。如果您需要将调整项应用于多个 API 软件包，请为每个软件包创建一个调整项。	不适用	否
`developer`	应用账单调整项的开发者。如果您未指定此属性，则账单调整项将应用于所有开发者。注意：您为特定开发者所做的任何调整都会替换为所有开发者所做的任何调整。	不适用	否

后续步骤

通过创收功能，您可以灵活地向开发者发放赠送金额。如果开发者对某项服务不满意，并请求对一段时间的使用量进行部分或全额退款，您可能需要这样做。如需了解如何发放赠送金额，请参阅发放赠送金额。