进行结算调整

<ph type="x-smartling-placeholder"></ph> 您正在查看 Apigee Edge 文档。
转到 Apigee X 文档
信息

简介

借助创收功能,您可以对结算明细进行调整。例如,你可能需要 增加或减少指定结算月份的收益分成或费用, 差异。

浏览“结算调整”页面

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

Edge

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

  1. 登录 apigee.com/edge
  2. 选择发布 >创收 >结算调整项

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

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

传统 Edge(私有云)

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

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

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

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

添加结算调整项

要添加结算调整项,请按以下步骤操作:

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

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

    调整 %

    调整金额,以正百分比或负百分比表示。A 型阳性 调整交易中的收益分成或费用, 百分比。负调整会下调 指定交易的百分比请输入正/负十进制数(最多 到小数点后两位)。

    结算月份

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

    交易类型

    您希望应用调整项的交易类型。请选择一个 值:

    • 所有交易
    • 费用(收费模式交易)
    • 购买(收益分成模式交易)
    • 退款(收益分成模式交易)
    产品

    要为其应用调整项的 API 产品。您不能将 对多个 API 产品进行单次调整。如果您需要对 多个 API 产品,请为每个产品创建一个调整项。选择 API 产品 。

    开发者

    您要对其应用调整项的开发者。您可以将 适用于所有开发者(默认情况下)或特定开发者的调整。选择“全部” 开发者”或特定开发者

  4. 点击创建调整项

修改结算调整项

要修改结算调整项,请按以下步骤操作:

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

使用 API 进行结算调整

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

使用 API 进行结算调整

您可以向 /organizations/{org_name}/billing-adjustments.发出请求时,您需要在 请求正文:

  • 结算调整项的名称。
  • 调整百分比,即 会相应地增加或减少账单费用
  • 结算月份。
  • 结算年份。
  • 结算调整项所应用到的组织。

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

  • 您要应用调整项的交易类型(例如购买) 交易)。
  • 您要对其应用调整项的开发者。
  • 您是要将调整项应用于预付费开发者、后付费开发者,还是 两者都有。
  • 要为其应用调整的 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 查看结算调整项

您可以查看组织的特定结算调整项或所有结算调整项。 要查看特定的结算调整项,请向以下地址发出 GET 请求: /organizations/{org_name}/billing-adjustments/{billing_adjustment_id},其中 {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

要查看某个组织的所有结算调整项,请向以下地址发出 GET 请求: /organizations/{org_name}/billing-adjustments。例如:

$ 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},其中 {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 删除结算调整项

要删除结算调整项,您可以发出 DELETE 请求, /organizations/{org_name}/billing-adjustments/{billing_adjustment_id},其中 {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

调整金额,采用正数或负数百分比的形式。A 型阳性 调整百分比时,系统会按该百分比上调交易中的收益分成或费用。答 负百分比将根据 百分比。值介于 -100 到 999.9999 之间。

不适用
billingMonth

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

不适用
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

结算调整项所适用的开发者。如果您不指定 媒体资源,则结算调整项适用于所有开发者。

不适用

后续步骤

借助创收功能,您可以灵活地向开发者发放赠金。您可能需要 如果开发者对服务不满意并要求退还部分或全部使用费, 一段时间。如需了解如何发放赠金,请参阅发放赠金