管理组织资料

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

以下部分将介绍组织个人资料,并说明如何使用 UIAPI 管理组织个人资料。

组织资料简介

在创收功能的初始设置过程中,Apigee Edge 配置团队会设置您的组织资料。

您需要修改组织资料,以根据需要添加或更新贵组织的相关信息。 例如,您可能需要更新结算类型、币种设置或税费模式。

配置有关贵组织的基本信息,包括:

  • 组织名称、地址和运营国家/地区
  • 结算类型(预付费、后付费或两者兼有),如了解结算类型中所述
  • 结算周期(按比例结算或按日历月结算)
  • 基准币种
  • 贵组织使用的税费模式

您可以使用界面API 管理组织个人资料,如以下各部分所述。

浏览“组织资料”页面

访问“组织个人资料”页面,如下所述。

Edge

如需使用 Edge 界面访问“组织付款资料”页面,请执行以下操作:

  1. 登录 apigee.com/edge
  2. 在左侧导航栏中选择发布 > 创收 > 组织资料

系统会显示“组织个人资料”页面。

如图所示,您可以通过“组织个人资料”页面执行以下操作:

  • 查看当前组织资料设置
  • 修改组织资料设置,包括:

经典边缘(私有云)

如需使用经典版 Edge 界面访问“组织个人资料”页面,请执行以下操作:

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

系统会显示“组织个人资料”页面。

通过“组织个人资料”页面,您可以执行以下操作:

  • 查看当前组织资料设置
  • 修改组织资料设置,包括:

使用界面修改组织个人资料

如需使用界面修改组织资料,请执行以下操作:

  1. 访问组织资料页面
  2. 点击修改
  3. 名称和信息下,修改组织名称和运营国家/地区。
  4. 税费和币种下,修改以下字段:
    字段 说明
    税务模型

    注意:仅当您设置了收益分成费率方案并希望生成结算凭证时,才需要执行此步骤。

    用于标识所需结算单据类型的收益分成费率方案的税费模式。

    有效值包括:

    • 披露代理:API 提供方充当开发者的披露代理。从最终用户处收取的总收入(包括销售税)会传递给开发者。API 提供方的佣金以佣金账单的形式从开发者处收取。API 提供方不处理从最终用户处收取的销售税,开发者有责任报告销售税。
    • 未披露:API 提供方充当开发者的未披露代理,会扣除从最终用户处收取的税费并将其支付给地方税务机关。开发者会向 API 提供方开具账单,其中列明开发者应得的净收入分成(扣除销售税和 API 提供方的佣金)。
    • 混合型:API 提供方充当开发者的披露代理。但是,API 提供方可代表开发者向地方税务部门缴纳从其订阅者中收取的销售税。API 提供方将剩余收入传递给开发者,然后开具佣金费用账单。
    货币

    贵组织支持的币种。对于收益分成、价目表和仅收取费用的方案,系统会使用默认币种来确定您的费率方案。创建费率表或仅收取费用的方案时,您可以从支持的货币列表中选择要使用的货币。您可以选择为每种币种设置应用开发者可以为其预付费账号余额充值的最低金额。

    如需添加币种,请执行以下操作:

    1. 点击添加币种
    2. 币种字段的下拉菜单中选择一种币种。
    3. 您可以选择在最低充值金额字段中设置应用开发者可以向其预付费账号余额充值的最低金额(以指定币种表示)。
    4. 点击添加
    5. 如果需要,点击关联的单选按钮,将其设置为默认币种。
    6. 重复上述步骤可添加其他币种。

    如需删除币种,请将光标悬停在要删除的币种上,然后点击

  5. 管理条款及条件,如使用界面管理条款及条件中所述。
  6. 点击保存

使用 API 管理组织资料

使用 API 管理组织配置文件,如以下部分所述。

使用 API 查看组织个人资料

通过向 /mint/organizations/{org_name} 发出 GET 请求来查看组织个人资料。例如:

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

以下提供了一个响应示例。如需详细了解显示的选项,请参阅 API 的组织资料配置属性

{
    "address" : [ {
      "address1" : "Test address”,
      "city" : "Test City",
      "country" : "US",
      "id" : "test-address",
      "isPrimary" : true,
      "state" : "CA",
      "zip" : "54321"
    } ],
    "approveTrusted" : false,
    "approveUntrusted" : false,
    "billingCycle" : "CALENDAR_MONTH",
    "country" : "US",
    "currency" : "USD",
    "description" : "Test organization",
    "hasBillingAdjustment" : true,
    "hasBroker" : false,
    "hasSelfBilling" : false,
    "hasSeparateInvoiceForProduct" : false,
    "id" : "{org_name}"
    "issueNettingStmt" : false,
    "logoUrl" : " https://dl.dropboxusercontent.com/u/48279818/LOGOS/testorg.jpeg",
    "name" : "myorg",
    "nettingStmtPerCurrency" : false,
    "regNo" : "RegNo-1234-myorg",
    "selfBillingAsExchOrg" : false,
    "selfBillingForAllDev" : false,
    "separateInvoiceForFees" : true,
    "status" : "ACTIVE",
    "supportedBillingType" : "PREPAID",
    "taxModel" : "UNDISCLOSED",
    "taxRegNo" : "TaxRegNo-1234-myorg",
    "timezone" : "UTC"
}

使用 API 修改组织个人资料

通过向 /mint/organizations/{org_name} 发出 PUT 请求来修改组织个人资料。修改组织个人资料时,您需要指定所有组织个人资料属性,而不仅仅是您要修改的属性。

如需修改组织的默认币种,请将 currency 值设置为您要设为默认币种的受支持币种的 ISO 4217 货币代码。

例如,以下 API 调用会将 currency 更新为美元,并将税费模式设置更新为 HYBRID(示例中突出显示了更新后的字段)。如需详细了解显示的选项,请参阅 API 的组织个人资料配置属性

curl -X PUT "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}" \
  -H "Content-Type: application/json" \
  -d '{
  "address" : [ { 
    "address1" : "Test address”,
    "city" : "Test City",
    "country" : "US",
    "id" : "corp-address",
    "isPrimary" : true,
    "state" : "CA",
    "zip" : "54321"
  } ], 
  "approveTrusted" : false, 
  "approveUntrusted" : false, 
  "billingCycle" : "CALENDAR_MONTH", 
  "country" : "US", 
  "currency" : "USD", 
  "description" : "Test organization", 
  "hasBillingAdjustment" : true, 
  "hasBroker" : false, 
  "hasSelfBilling" : false, 
  "hasSeparateInvoiceForProduct" : false,
  "id" : "myorg", 
  "issueNettingStmt" : false, 
  "logoUrl" : "https://dl.dropboxusercontent.com/u/48279818/LOGOS/testorg.jpeg",
  "name" : "{org_name}", 
  "nettingStmtPerCurrency" : false, 
  "regNo" : "RegNo-1234-myorg", 
  "selfBillingAsExchOrg" : false, 
  "selfBillingForAllDev" : false, 
  "separateInvoiceForFees" : false, 
  "status" : "ACTIVE", 
  "supportedBillingType" : "POSTPAID",
  "taxModel" : "HYBRID", 
  "taxRegNo" : "TaxRegNo-1234-myorg", 
  "timezone" : "UTC" 
}' \

-u email:password

使用 API 配置预付费和后付费结算类型

开发者账号可以配置为使用以下结算类型:预付费、后付费或同时使用这两种结算类型。

对于预付费账号,开发者需要提前支付 API 使用费。 资金将从开发者的预付款余额中扣除,该余额通过集成式支付服务机构进行维护。开发者必须保持足够预付款余额才能购买 API。

对于后付费账号,系统会在月底按月结算(通过账单)开发者费用。 开发者根据账单中包含的方案设置的付款条件支付 API 产品使用费。

如需为组织配置预付费和后付费结算类型,请将 supportedBillingType 属性设置为以下值之一,以指明哪些结算类型有效:PREPAIDPOSTPAIDBOTH。如果您将值设置为 BOTH,则在添加应用开发者或公司时,默认值为 PREPAID。在这种情况下,您可以使用 API 明确设置公司或应用开发者的结算类型,如管理公司和应用开发者中所述。

例如:

curl -X PUT "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}" \
  -H "Content-Type: application/json" \
  -d '{
  "address" : [ {
    "address1" : "Test address",
    "city" : "Test City",
    "country" : "US",
    "id" : "corp-address",
    "isPrimary" : true,
    "state" : "CA",
    "zip" : "54321"
  } ],
  "approveTrusted" : false,
  "approveUntrusted" : false,
  "billingCycle" : "CALENDAR_MONTH",
  "country" : "US",
  "currency" : "USD",
  "description" : "Test organization",
  "hasBillingAdjustment" : true,
  "hasBroker" : false,
  "hasSelfBilling" : false,
  "hasSeparateInvoiceForProduct" : false,
  "id" : "myorg",
  "issueNettingStmt" : false,
  "logoUrl" : "https://dl.dropboxusercontent.com/u/48279818/LOGOS/testorg.jpeg",
  "name" : "{org_name}",
  "nettingStmtPerCurrency" : false,
  "regNo" : "RegNo-1234-myorg",
  "selfBillingAsExchOrg" : false,
  "selfBillingForAllDev" : false,
  "separateInvoiceForFees" : false,
  "status" : "ACTIVE",
  "supportedBillingType" : "POSTPAID",
  "taxModel" : "HYBRID",
  "taxRegNo" : "TaxRegNo-1234-myorg",
  "timezone" : "UTC"
  }' \
  -u email:password

使用 API 配置结算周期

如需为组织配置结算周期,请将 billingCycle 属性设置为以下值之一:

  • PRORATED:结算依据是 API 产品在日历月中的使用天数。
  • CALENDAR_MONTH:按月结算。

例如:

curl -X PUT "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}" \
  -H "Content-Type: application/json" \
  -d '{
    "address" : [ {
      "address1" : "Test address",
      "city" : "Test City",
      "country" : "US",
      "id" : "corp-address",
      "isPrimary" : true,
      "state" : "CA",
      "zip" : "54321"
    } ],
    "approveTrusted" : false,
    "approveUntrusted" : false,
    "billingCycle" : "CALENDAR_MONTH",
    "country" : "US",
    "currency" : "USD",
    "description" : "Test organization",
    "hasBillingAdjustment" : true,
    "hasBroker" : false,
    "hasSelfBilling" : false,
    "hasSeparateInvoiceForProduct" : false,
    "id" : "myorg",
    "issueNettingStmt" : false,
    "logoUrl" : "https://dl.dropboxusercontent.com/u/48279818/LOGOS/testorg.jpeg",
    "name" : "{org_name}",
    "nettingStmtPerCurrency" : false,
    "regNo" : "RegNo-1234-myorg",
    "selfBillingAsExchOrg" : false,
    "selfBillingForAllDev" : false,
    "separateInvoiceForFees" : false,
    "status" : "ACTIVE",
    "supportedBillingType" : "POSTPAID",
    "taxModel" : "HYBRID",
    "taxRegNo" : "TaxRegNo-1234-myorg",
    "timezone" : "UTC"
  }' \
  -u email:password

API 的组织付款资料配置属性

组织配置文件使您能够使用 API 设置以下配置属性。

名称 说明 默认值 是否必需?
address

组织的地址,可以包括街道地址、城市、州/省/直辖市/自治区、邮政编码、国家/地区,以及此地址是否为组织的主要地址。

不适用
approveTrusted

此标志未使用。

不适用
approveUntrusted

此标志未使用。

不适用
billingCycle

结算周期。可以是以下值之一:

  • 按比例:结算基于 API 产品在日历月中的使用天数。
  • CALENDAR_MONTH:按月结算。

请参阅使用 API 配置结算周期

不适用
country

组织运营所在国家/地区的 ISO 3166-2 代码,例如巴西为 BR。

不适用
currency

组织使用的“基本”或会计币种的 ISO 4217 代码(例如 USD 代表美元)。

对于收益分成方案:系统会使用为方案指定的币种。

对于价目表(收费模式)方案:与收入分成方案相同。不过,您可以将币种设置更改为组织支持的任何币种。

对于仅收取费用的方案:您可以将币种设置更改为组织支持的任何币种。

不适用
description

组织的简短说明。

不适用
hasBillingAdjustment

用于指定是否启用调整的标志。如果启用,您可以调整 API 服务为您的 API 产品记录的流量详细信息。该值可以是以下任一值:

  • true:已启用调整。
  • false:未启用调整。
不适用
hasBroker

一个标志,用于指定收入是否基于净收入。该值可以是以下任一值:

  • true:收入基于净收入。
  • false:收入不是基于净收入。
不适用
hasSelfBilling

用于指示创收功能生成自开账单而非收益分成报表的标志。自开账单是一种财务凭证,其中详细说明了应付给应用开发者的金额。它充当代表应用开发者向 API 提供方开具的账单。该值可以是以下任一值:

  • true:生成自行结算账单,而不是收益分成报表。
  • false:停用自行结算账单。
不适用
hasSeparateInvoiceForProduct

用于指定是否为每个 API 产品生成单独的账单的标志。该值可以是以下任一值:

  • true:为每个 API 产品生成单独的账单。
  • false:不为每个 API 产品单独生成发票。
不适用
id

组织的 ID。

不适用
issueNettingStmt

一个标志,用于指定在创建结算凭证时是否生成抵销对账单。该值可以是以下任一值:

  • true:在创建结算凭证时生成抵销对账单。
  • false:创建结算凭证时不生成抵销对账单。
不适用
logoUrl

组织徽标的网址。

不适用
name

组织名称。

不适用
netPaymentAdviceNote

净付款建议备注。

不适用
nettingStmtPerCurrency

标志,用于指定是否为所用的每种币种生成单独的净额结算对账单。该值可以是以下任一值:

  • true:为所使用的每种币种生成单独的净额结算对账单。
  • false:不针对所使用的每种币种生成单独的净额结算对账单。
不适用
regNo

组织的注册号。您为此媒体资源输入的编号会显示在结算凭证的底部。

不适用
selfBillingAsExchOrg

如果启用了自开账单,则指示是否为交换组织启用了自开账单。该值可以是以下任一值:

  • true:为交易平台组织启用自开账单。
  • false:未为交易所组织启用自开账单。
不适用
selfBillingForAllDev

如果已启用自开账单,则指示是否已为所有应用开发者启用自开账单。默认情况下,只有与 API 提供方签署协议的应用开发者才会收到自开账单。该值可以是以下任一值:

  • true:所有应用开发者均已启用自开账单。
  • false:并非所有应用开发者都可以使用自开账单。
false
separateInvoiceForFees

用于指定是否单独发布费用账单的标志。该值可以是以下任一值:

  • true:单独发布费用账单。
  • 错误:不会单独发布费用账单。
false
status

组织的状态。有效值包括:

  • ACTIVE:组织账号已在创收中注册,可供使用。
  • INACTIVE:组织账号已注册创收,但无法使用。
不适用
supportedBillingType

用于结算的开发者付款模式。可以是以下值之一:

  • 预付费:开发者提前支付 API 产品的使用费。使用 API 产品时将从开发者的余额中扣除相应资金。开发者必须保持足够预付款余额才能购买 API 产品。
  • POSTPAID:按月结算(通过账单)API 产品使用费的开发者。开发者根据账单中包含的方案设置的付款条件支付 API 产品使用费。
  • BOTH:支持任一结算类型。默认值为 PREPAID。

请参阅使用 API 配置预付费和后付费结算类型

预付费
taxModel

注意:仅当您设置了收益分成费率方案并希望生成结算凭证时,才需要执行此步骤。

用于标识所需结算单据类型的收益分成费率方案的税费模式。

有效值包括:

  • 披露代理:API 提供方充当开发者的披露代理。从最终用户处收取的总收入(包括销售税)会传递给开发者。API 提供方的佣金以佣金账单的形式从开发者处收取。API 提供方不处理从最终用户处收取的销售税,开发者有责任报告销售税。
  • 未披露:API 提供方充当开发者的未披露代理,会扣除从最终用户处收取的税费并将其支付给地方税务机关。开发者会向 API 提供方开具账单,其中列明开发者应得的净收入分成(扣除销售税和 API 提供方的佣金)。
  • 混合型:API 提供方充当开发者的披露代理。但是,API 提供方可代表开发者向地方税务部门缴纳从其订阅者中收取的销售税。API 提供方将剩余收入传递给开发者,然后开具佣金费用账单。
不适用
taxNexus

组织注册的税务国家/地区。

不适用
taxRegNo

组织的税号或增值税 (VAT) 登记号(如适用)。此属性是可选属性,因为税务登记号或增值税登记号不适用于所有国家/地区。您为此参数输入的编号会显示在结算凭证的底部。

不适用
transactionRelayURL

可将交易中继到的其他系统的网址,例如数据仓库。

不适用
timezone

组织运营的时区标识符,例如 America/New_York 或 Europe/Paris。系统还支持时区缩写,例如 UTC、EST(东部标准时间)或 CET(中欧时间)。

不适用

替换公司或应用开发者的创收配置文件设置

使用界面或 API 替换公司或应用开发者的创收配置文件设置,如以下部分所述: