<ph type="x-smartling-placeholder"></ph>
您正在查看 Apigee Edge 文档。
转到
Apigee X 文档。 信息
以下部分介绍了组织资料,并说明了如何使用界面和 API 对其进行管理。
组织资料简介
在创收功能的初始设置中,Apigee Edge 配置团队会设置您的组织资料。
您需要修改组织资料,以根据需要添加或更新组织的相关信息。 例如,您可能需要更新结算类型、币种设置或税费模式。
配置有关贵组织的基本信息,包括:
- 组织名称、地址和运营国家/地区
- 结算类型(预付费和/或后付费),如了解结算类型中所述
- 结算周期(按比例计费或日历月)
- 基本货币
- 贵组织使用的税费模式
浏览“组织资料”页面
访问“组织资料”页面,如下所述。
Edge
如需使用 Edge 界面访问“组织资料”页面,请执行以下操作:
- 登录 apigee.com/edge。
- 选择发布 >创收 >Organization Profile 找到该工具。
系统随即会显示“组织资料”页面。
如图所示,您可以通过“组织资料”页面执行以下操作:
传统 Edge(私有云)
如需使用传统版 Edge 界面访问“组织资料”页面,请执行以下操作:
- 登录
http://ms-ip:9000
,其中 ms-ip 是管理服务器节点的 IP 地址或 DNS 名称。 - 选择管理 >Organization Profile 中构建组织资料。
系统随即会显示“组织资料”页面。
通过“组织资料”页面,您可以执行以下操作:
使用界面修改组织资料
要使用界面修改组织资料,请执行以下操作:
- 访问“组织资料”页面。
- 点击修改。
- 在名称和信息下,修改组织名称和运营国家/地区。
- 在税费和币种下,修改以下字段:
字段 说明 税费模式 注意:仅适用于您设置了收益分成费率方案且希望 生成结算凭证。
收益分成费率方案的税费模式,用于标识所需结算文档的类型。
有效值包括:
- 披露:API 提供方是 开发者。从最终用户处收取的总收入(包括销售税)为 传递给开发者API 提供商的佣金是从 以佣金账单的形式支付给开发者。API 提供商不负责处理 从最终用户处收取的销售税,且由开发者负责 报告销售税
- 未披露:API 提供方充当 从最终用户处扣除的税费并将税费支付给 当地的税务机关。开发者向 API 提供商开具净收入发票 应向开发者支付的收益分成(减少销售税和 API 提供商的 佣金)。
- 混合:API 提供商是 开发者。但 API 提供商负责支付 代表开发者向当地税务机关的订阅者。API 提供商会将剩余收入转给开发者, 佣金。
货币 贵组织支持的货币。对于收益分成、价目表和“仅费用”方案, 费率方案将使用默认币种创建价目表或“仅收费的方案”时,您可以更改要采用的币种 从支持的货币列表中进行选择。或者,针对每种货币,您可以设置应用开发者可向预付款账号余额充值的最低金额。
要添加货币,请执行以下操作:
- 点击添加币种。
- 从币种字段的下拉菜单中选择一个币种。
- (可选)在最低充值金额字段中,设置应用开发者可为预付款账号充值的最低金额(使用指定币种)。
- 点击添加。
- 如果需要,可以点击关联的单选按钮,设置默认货币。
- 重复步骤以添加其他币种。
要删除币种,请将光标放在要删除的币种上,然后点击 。
- 管理条款及条件,如使用界面管理条款及条件中所述。
- 点击保存。
使用 API 管理组织资料
使用 API 管理组织资料,如以下部分所述。
使用 API 查看组织资料
向
/mint/organizations/{org_name}
。例如:
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 修改组织资料
向以下用户发出 PUT 请求以修改组织资料:
/mint/organizations/{org_name}
。修改组织资料时,您需要指定所有
组织资料属性,而不仅仅是您正在修改的属性。
要修改组织的默认币种,请将 currency
值设置为
ISO 4217 货币
与您想设为默认支持的货币对应的代码。
例如,以下 API 调用将 currency
更新为 USD 并将税费模型更新为
设置为 HYBRID
(此示例中突出显示了更新的字段)。有关
请参阅组织资料配置
属性。
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
属性设置为
以下值来指示哪些结算类型是有效的:PREPAID
、POSTPAID
或 BOTH
。如果您将值设置为 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 配置结算周期。 |
不适用 | 是 |
country |
国家/地区的 ISO 3166-2 代码 如 BR 表示巴西。 |
不适用 | 是 |
currency |
“base”的 ISO 4217 代码或 组织使用的会计货币(例如,USD 表示美国) 美元)。 对于收益分成方案:指定的币种将用于您的方案。 价目表(收费模式)方案:这与收益分成方案相同。 不过,您可以将币种设置更改为 组织。 对于仅收费的方案:您可以将币种设置更改为 组织。 |
不适用 | 是 |
description |
组织的简要说明。 |
不适用 | 否 |
hasBillingAdjustment |
用于指定是否启用调整的标志。启用后,您可以 对 API 服务为您的 API 产品记录的流量详情进行调整 值可以是以下任何一项:
|
不适用 | 否 |
hasBroker |
指定收入是否基于净额的标记。该值可以是以下任何一项: 以下:
|
不适用 | 否 |
hasSelfBilling |
指示创收功能生成自行结算账单而非收入的标记 共享声明。自行结算账单是详细说明金额的财务凭证 致谢。充当 API 提供商的发票, 是应用开发者该值可以是以下任何一项:
|
不适用 | 否 |
hasSeparateInvoiceForProduct |
用于指定是否为每个 API 产品生成单独发票的标志。通过 值可以是以下任何一项:
|
不适用 | 否 |
id |
组织的 ID。 |
不适用 | 否 |
issueNettingStmt |
用于指定是否在创建结算时生成结算对账单的标志 文档。该值可以是以下任何一项:
|
不适用 | 否 |
logoUrl |
组织徽标的网址。 |
不适用 | 否 |
name |
组织名称。 |
不适用 | 是 |
netPaymentAdviceNote |
净付款建议备注。 |
不适用 | 否 |
nettingStmtPerCurrency |
用于指定是否为每个网页生成单独的网络声明的标志 所用的币种。该值可以是以下任何一项:
|
不适用 | 否 |
regNo |
组织的注册号。您为此房源输入的数字是 会显示在结算凭证的底部 |
不适用 | 否 |
selfBillingAsExchOrg |
如果已启用自助结算账单,请指明是否启用了广告交易平台 组织。该值可以是以下任何一项:
|
不适用 | 否 |
selfBillingForAllDev |
如果启用了自助结算账单,请指明是否为所有 。默认情况下,系统只会为符合以下条件的应用开发者生成自行结算账单 与 API 提供商签订协议。该值可以是以下任何一项:
|
false | 否 |
separateInvoiceForFees |
此标记指定是否发布单独的费用账单。该值可以是 以下任意一项:
|
false | 是 |
status |
组织的状态。有效值包括:
|
不适用 | 否 |
supportedBillingType |
用于结算的开发者付款模式。可以是以下值之一:
|
预付费 | 是 |
taxModel |
注意:仅适用于您设置了收益分成费率方案且希望 生成结算凭证。 收益分成费率方案的税费模式,用于标识所需结算文档的类型。 有效值包括:
|
不适用 | 是 |
taxNexus |
组织注册纳税时所在的国家/地区。 |
不适用 | 否 |
taxRegNo |
组织的税务登记号或增值税 (VAT) 登记号 数字(如果有)。此属性是可选的,因为税务登记号或 增值税登记号仅适用于部分国家/地区。您为此项输入的数字 参数会显示在结算凭证的底部。 |
不适用 | 否 |
transactionRelayURL |
交易可中继到的其他系统的网址,例如数据 模型。 |
不适用 | 否 |
timezone |
组织运营的时区标识符,例如 America/New_York 或 Europe/Paris。时区缩写,例如 UTC、EST(美国东部时间) 标准时间) 或 CET(中欧时间)。 |
不适用 | 是 |
覆盖公司或应用开发者的创收资料设置
通过界面或 API 覆盖公司或应用开发者的获利资料设置,如以下部分所述: