diff options
Diffstat (limited to 'data/en_us/bssopenapi/2023-09-30')
| -rw-r--r-- | data/en_us/bssopenapi/2023-09-30/api-docs.php | 8319 |
1 files changed, 8319 insertions, 0 deletions
diff --git a/data/en_us/bssopenapi/2023-09-30/api-docs.php b/data/en_us/bssopenapi/2023-09-30/api-docs.php new file mode 100644 index 0000000..d0bbd27 --- /dev/null +++ b/data/en_us/bssopenapi/2023-09-30/api-docs.php @@ -0,0 +1,8319 @@ +<?php return [ + 'version' => '1.0', + 'info' => [ + 'style' => 'RPC', + 'product' => 'BssOpenApi', + 'version' => '2023-09-30', + ], + 'directories' => [ + [ + 'id' => 223311, + 'title' => 'Order', + 'type' => 'directory', + 'children' => [ + 'GetOrders', + 'GetOrderDetail', + ], + ], + [ + 'id' => 208736, + 'title' => 'Invoice', + 'type' => 'directory', + 'children' => [ + 'ListInvoiceTitle', + 'ListInvoiceCandidate', + 'CreateInvoice', + ], + ], + [ + 'id' => 203314, + 'title' => 'Fund Account', + 'type' => 'directory', + 'children' => [ + 'CreateFundAccountPayRelation', + 'SetFundAccountLowAvailableAmountAlarm', + 'GetFundAccountCanWithdrawAmount', + 'GetFundAccountAvailableAmount', + 'GetFundAccountLowAvailableAmountAlarm', + 'ListFundAccount', + 'CancelFundAccountLowAvailableAmountAlarm', + 'GetFundAccountCanAllocateCreditAmount', + 'ListFundAccountPayRelation', + 'GetFundAccountCanRecycleAmount', + 'CreateFundAccountTransfer', + 'GetFundAccountTransactionDetails', + 'SetFundAccountCreditAmount', + 'GetFundAccountCanTransferAmount', + ], + ], + [ + 'id' => 204580, + 'title' => 'Coupon', + 'type' => 'directory', + 'children' => [ + 'DescribeCoupon', + 'DescribeCouponItemList', + ], + ], + [ + 'id' => 208201, + 'title' => 'Billing', + 'type' => 'directory', + 'children' => [ + 'CreateReportDefinition', + 'ListReportDefinitions', + 'DeleteReportDefinition', + ], + ], + [ + 'id' => 208683, + 'title' => 'Finance Module', + 'type' => 'directory', + 'children' => [ + 'SaveCostCenterShareRule', + 'QueryCostCenterShareRule', + 'CreateCostCenter', + 'ModifyCostCenter', + 'DeleteCostCenter', + 'QueryCostCenter', + 'QueryCostCenterResource', + 'CreateCostCenterRule', + 'ModifyCostCenterRule', + 'DeleteCostCenterRule', + 'QueryCostCenterRule', + 'AllocateCostCenterResource', + ], + ], + ], + 'components' => [ + 'schemas' => [], + ], + 'apis' => [ + 'GetOrders' => [ + 'summary' => '订单列表查询', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'CreateTimeEnd', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '2016-05-23T12:00:00Z', + ], + ], + [ + 'name' => 'PageNum', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'ProductCode', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'rds', + ], + ], + [ + 'name' => 'ProductType', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'rds', + ], + ], + [ + 'name' => 'SubscriptionType', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'Subscription', + ], + ], + [ + 'name' => 'OrderType', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'New', + ], + ], + [ + 'name' => 'PaymentStatus', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'Paid', + ], + ], + [ + 'name' => 'CreateTimeStart', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '2016-05-23T13:00:00Z', + ], + ], + [ + 'name' => 'MemberUid', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1779628988149763', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Success', + ], + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Successful!', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '6000EE23-274B-4E07-A697-FF2E999520A4', + ], + 'Success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'HostName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'test', + ], + 'PageNum' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'TotalCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'OrderList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Order' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'AfterTaxAmount' => [ + 'description' => '', + 'type' => 'string', + 'example' => '66', + ], + 'ProductCode' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'rds', + ], + 'CreateTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2017-06-08T09:41:30Z', + ], + 'ProductType' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'rds', + ], + 'RelatedOrderId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '234535345345342', + ], + 'PaymentCurrency' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'CNY', + ], + 'PaymentTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2017-06-08T09:41:30Z', + ], + 'Tax' => [ + 'description' => '', + 'type' => 'string', + 'example' => '1', + ], + 'OrderId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '237258627070169', + ], + 'SubscriptionType' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Subscription', + ], + 'PretaxGrossAmount' => [ + 'description' => '', + 'type' => 'string', + 'example' => '0', + ], + 'OrderType' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'New', + ], + 'PretaxAmount' => [ + 'description' => '', + 'type' => 'string', + 'example' => '0', + ], + 'Currency' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'CNY', + ], + 'CommodityCode' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'rds', + ], + 'PaymentStatus' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Paid', + ], + 'PretaxAmountLocal' => [ + 'description' => '', + 'type' => 'string', + 'example' => '0', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidOwner', + 'errorMessage' => 'The specified owner doesn\'t belong to caller.', + ], + ], + [ + [ + 'errorCode' => 'InvalidCaller', + 'errorMessage' => 'The caller\'s primary account is invalid or does not have permission to query enterprise member account information.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"Successful!\\",\\n \\"RequestId\\": \\"6000EE23-274B-4E07-A697-FF2E999520A4\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"HostName\\": \\"test\\",\\n \\"PageNum\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 1,\\n \\"OrderList\\": {\\n \\"Order\\": [\\n {\\n \\"AfterTaxAmount\\": \\"66\\",\\n \\"ProductCode\\": \\"rds\\",\\n \\"CreateTime\\": \\"2017-06-08T09:41:30Z\\",\\n \\"ProductType\\": \\"rds\\",\\n \\"RelatedOrderId\\": \\"234535345345342\\",\\n \\"PaymentCurrency\\": \\"CNY\\",\\n \\"PaymentTime\\": \\"2017-06-08T09:41:30Z\\",\\n \\"Tax\\": \\"1\\",\\n \\"OrderId\\": \\"237258627070169\\",\\n \\"SubscriptionType\\": \\"Subscription\\",\\n \\"PretaxGrossAmount\\": \\"0\\",\\n \\"OrderType\\": \\"New\\",\\n \\"PretaxAmount\\": \\"0\\",\\n \\"Currency\\": \\"CNY\\",\\n \\"CommodityCode\\": \\"rds\\",\\n \\"PaymentStatus\\": \\"Paid\\",\\n \\"PretaxAmountLocal\\": \\"0\\"\\n }\\n ]\\n }\\n }\\n}","type":"json"}]', + ], + 'GetOrderDetail' => [ + 'summary' => '订单详情查询', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'OrderId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '233501558440169', + ], + ], + [ + 'name' => 'MemberUid', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1715322405372273', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Success', + ], + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Successful!', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'D6E068C3-25BC-455A-85FE-45F0B22ECB1F', + ], + 'Success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'HostName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'test', + ], + 'PageNum' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'TotalCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '400', + ], + 'OrderList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Order' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Operator' => [ + 'description' => '', + 'type' => 'string', + 'example' => '322315', + ], + 'AfterTaxAmount' => [ + 'description' => '', + 'type' => 'string', + 'example' => '0', + ], + 'Config' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'DBInstanceClass:[DBInstanceClass:rds.mysql.s1.small;EngineVersion:8.0;Region:cn-qingdao;]DBFlowType:[Region:cn-qingdao;]', + ], + 'SubOrderId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '234343', + ], + 'PaymentTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2017-06-08T09:41:30Z', + ], + 'Tax' => [ + 'description' => '', + 'type' => 'string', + 'example' => '0', + ], + 'PaymentCurrency' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'CNY', + ], + 'UsageEndTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2117-06-08T16:00:00Z', + ], + 'SubscriptionType' => [ + 'title' => '', + 'description' => '', + 'type' => 'string', + 'example' => 'Subscription', + ], + 'PretaxGrossAmount' => [ + 'description' => '', + 'type' => 'string', + 'example' => '0', + ], + 'OrderType' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'new', + ], + 'Currency' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'CNY', + ], + 'CommodityCode' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'rds', + ], + 'UsageStartTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2017-06-08T16:00:00Z', + ], + 'OriginalConfig' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'DBInstanceClass:[DBInstanceClass:rds.mysql.s1.small;EngineVersion:8.0;Region:cn-qingdao;]DBFlowType:[Region:cn-qingdao;]', + ], + 'InstanceIds' => [ + 'description' => '', + 'type' => 'string', + 'example' => '["rm-bp1a2vsr018313t6o"]', + ], + 'PaymentStatus' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'paid', + ], + 'ExtendInfos' => [ + 'description' => '', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'description' => '', + 'example' => '{"IsAutoRenew":"true","DiscountAmount":"100.98","DeductedByCoupons":"98.88","CouponNo":"319170900877"}', + ], + ], + 'ProductCode' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'rds', + ], + 'CreateTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2017-06-08T09:41:30Z', + ], + 'ProductType' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'rds', + ], + 'Quantity' => [ + 'description' => '', + 'type' => 'string', + 'example' => '3', + ], + 'RelatedOrderId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '241559391310332', + ], + 'OrderId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '241559391310333', + ], + 'BillModuleConfig' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'billModuleConfig' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'BillModuleProperties' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'billModuleProperties' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Value' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'cloud_ssd', + ], + 'AttrApiCode' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'cloud_ssd', + ], + 'ModuleApiCode' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'cloud_ssd', + ], + ], + ], + ], + ], + ], + 'ApiCode' => [ + 'description' => 'apiCode', + 'type' => 'string', + 'example' => 'datadisk', + ], + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'datadisk', + ], + 'Name' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + ], + ], + ], + ], + ], + 'OriginalModuleConfig' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'originalModuleConfig' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ModuleProperties' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'moduleProperties' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Value' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'cloud_efficiency', + ], + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'cloud_efficiency', + ], + 'Name' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + ], + ], + ], + ], + ], + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'systemdisk', + ], + 'Name' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + ], + ], + ], + ], + ], + 'OrderSubType' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'productsuborder', + ], + 'PretaxAmount' => [ + 'description' => '', + 'type' => 'string', + 'example' => '0', + ], + 'Region' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'PretaxAmountLocal' => [ + 'description' => '', + 'type' => 'string', + 'example' => '0', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidOwner', + 'errorMessage' => 'The specified owner doesn\'t belong to caller.', + ], + ], + [ + [ + 'errorCode' => 'InvalidCaller', + 'errorMessage' => 'The caller\'s primary account is invalid or does not have permission to query enterprise member account information.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"Successful!\\",\\n \\"RequestId\\": \\"D6E068C3-25BC-455A-85FE-45F0B22ECB1F\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"HostName\\": \\"test\\",\\n \\"PageNum\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 400,\\n \\"OrderList\\": {\\n \\"Order\\": [\\n {\\n \\"Operator\\": \\"322315\\",\\n \\"AfterTaxAmount\\": \\"0\\",\\n \\"Config\\": \\"DBInstanceClass:[DBInstanceClass:rds.mysql.s1.small;EngineVersion:8.0;Region:cn-qingdao;]DBFlowType:[Region:cn-qingdao;]\\",\\n \\"SubOrderId\\": \\"234343\\",\\n \\"PaymentTime\\": \\"2017-06-08T09:41:30Z\\",\\n \\"Tax\\": \\"0\\",\\n \\"PaymentCurrency\\": \\"CNY\\",\\n \\"UsageEndTime\\": \\"2117-06-08T16:00:00Z\\",\\n \\"SubscriptionType\\": \\"Subscription\\",\\n \\"PretaxGrossAmount\\": \\"0\\",\\n \\"OrderType\\": \\"new\\",\\n \\"Currency\\": \\"CNY\\",\\n \\"CommodityCode\\": \\"rds\\",\\n \\"UsageStartTime\\": \\"2017-06-08T16:00:00Z\\",\\n \\"OriginalConfig\\": \\"DBInstanceClass:[DBInstanceClass:rds.mysql.s1.small;EngineVersion:8.0;Region:cn-qingdao;]DBFlowType:[Region:cn-qingdao;]\\",\\n \\"InstanceIds\\": \\"[\\\\\\"rm-bp1a2vsr018313t6o\\\\\\"]\\",\\n \\"PaymentStatus\\": \\"paid\\",\\n \\"ExtendInfos\\": {\\n \\"key\\": \\"{\\\\\\"IsAutoRenew\\\\\\":\\\\\\"true\\\\\\",\\\\\\"DiscountAmount\\\\\\":\\\\\\"100.98\\\\\\",\\\\\\"DeductedByCoupons\\\\\\":\\\\\\"98.88\\\\\\",\\\\\\"CouponNo\\\\\\":\\\\\\"319170900877\\\\\\"}\\"\\n },\\n \\"ProductCode\\": \\"rds\\",\\n \\"CreateTime\\": \\"2017-06-08T09:41:30Z\\",\\n \\"ProductType\\": \\"rds\\",\\n \\"Quantity\\": \\"3\\",\\n \\"RelatedOrderId\\": \\"241559391310332\\",\\n \\"OrderId\\": \\"241559391310333\\",\\n \\"BillModuleConfig\\": {\\n \\"billModuleConfig\\": [\\n {\\n \\"BillModuleProperties\\": {\\n \\"billModuleProperties\\": [\\n {\\n \\"Value\\": \\"cloud_ssd\\",\\n \\"AttrApiCode\\": \\"cloud_ssd\\",\\n \\"ModuleApiCode\\": \\"cloud_ssd\\"\\n }\\n ]\\n },\\n \\"ApiCode\\": \\"datadisk\\",\\n \\"Code\\": \\"datadisk\\",\\n \\"Name\\": \\"数据盘\\"\\n }\\n ]\\n },\\n \\"OriginalModuleConfig\\": {\\n \\"originalModuleConfig\\": [\\n {\\n \\"ModuleProperties\\": {\\n \\"moduleProperties\\": [\\n {\\n \\"Value\\": \\"cloud_efficiency\\",\\n \\"Code\\": \\"cloud_efficiency\\",\\n \\"Name\\": \\"高效云盘\\"\\n }\\n ]\\n },\\n \\"Code\\": \\"systemdisk\\",\\n \\"Name\\": \\"系统盘\\"\\n }\\n ]\\n },\\n \\"OrderSubType\\": \\"productsuborder\\",\\n \\"PretaxAmount\\": \\"0\\",\\n \\"Region\\": \\"cn-hangzhou\\",\\n \\"PretaxAmountLocal\\": \\"0\\"\\n }\\n ]\\n }\\n }\\n}","type":"json"}]', + ], + 'ListInvoiceTitle' => [ + 'summary' => '发票抬头查询服务', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'APP' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'BssApiListResult<BssInvoiceTitleDTO>', + 'description' => 'BssApiListResult<BssInvoiceTitleDTO>', + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'title' => '数据列表', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'UnifiedSocialCreditCode' => [ + 'title' => '统一社会信用代码', + 'description' => '', + 'type' => 'string', + 'example' => '111111111111111', + ], + 'AccountId' => [ + 'title' => '用户ID', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1990699401005016', + ], + 'RegisteredAddress' => [ + 'title' => '注册场所地址', + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'CreateTime' => [ + 'title' => '创建时间', + 'description' => '', + 'type' => 'string', + 'example' => '2025-06-01 00:00:00', + ], + 'InvoiceTitle' => [ + 'title' => '发票抬头', + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'Id' => [ + 'title' => '发票抬头id', + 'description' => '', + 'type' => 'string', + 'example' => '123456', + ], + 'BankAccountNumber' => [ + 'title' => '基本开户账号', + 'description' => '', + 'type' => 'string', + 'example' => '1234567890', + ], + 'RegisteredLandline' => [ + 'title' => '注册固定电话', + 'description' => '', + 'type' => 'string', + 'example' => '010-12345678', + ], + 'AccountBankName' => [ + 'title' => '开户银行名称', + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + ], + ], + ], + 'Metadata' => [ + 'title' => '返回结构元数据', + 'description' => '', + 'type' => 'any', + 'example' => '{}', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '6000EE23-274B-4E07-A697-FF2E999520A4', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'AccountNoQueryPricePermission', + 'errorMessage' => 'This page cannot be accessed because you do not have discount rights query permissions. Please contact the main account to go to the cost center for authorization. The permission point that needs authorization is queryprice.', + ], + [ + 'errorCode' => 'InnerAccountNoQueryPricePermission', + 'errorMessage' => 'In view of data security and compliance requirements, please understand the inconvenience caused to you by controlling the amount-related information and permissions of the group\'s cloud account. More questions please refer to the document.', + ], + [ + 'errorCode' => 'InnerSubAccountNoQueryPricePermission', + 'errorMessage' => 'In view of data security and compliance requirements, please understand the inconvenience caused to you by controlling the amount-related information and permissions of the group\'s cloud account.', + ], + [ + 'errorCode' => 'SubAccountNoQueryPricePermission', + 'errorMessage' => 'This page cannot be accessed because you do not have discount rights query permissions. Contact the main account to go to the RAM console for authorization. The Action to be authorized is bss:QueryPrice.', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified request contains invalid parameters.', + ], + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'You are not authorized to perform this action.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": [\\n {\\n \\"UnifiedSocialCreditCode\\": \\"111111111111111\\",\\n \\"AccountId\\": 1990699401005016,\\n \\"RegisteredAddress\\": \\"北京市朝阳区\\",\\n \\"CreateTime\\": \\"2025-06-01 00:00:00\\",\\n \\"InvoiceTitle\\": \\"xx公司\\",\\n \\"Id\\": \\"123456\\",\\n \\"BankAccountNumber\\": \\"1234567890\\",\\n \\"RegisteredLandline\\": \\"010-12345678\\",\\n \\"AccountBankName\\": \\"招商银行\\"\\n }\\n ],\\n \\"Metadata\\": \\"{}\\",\\n \\"RequestId\\": \\"6000EE23-274B-4E07-A697-FF2E999520A4\\"\\n}","type":"json"}]', + ], + 'ListInvoiceCandidate' => [ + 'summary' => '对客OpenAPI开票对象查询', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'Status', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '状态', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'enumValueTitles' => [ + '', + '', + '', + '', + ], + 'example' => '1', + 'enum' => [ + '0', + '1', + '2', + '3', + ], + ], + 'required' => false, + 'enumValueTitles' => [], + 'enum' => [ + '0', + '1', + '2', + '3', + ], + ], + ], + [ + 'name' => 'Types', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '类型', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'enumValueTitles' => [ + 1 => '', + '', + '', + '', + '', + 7 => '', + '', + ], + 'example' => '1', + 'enum' => [ + '1', + '2', + '3', + '4', + '5', + '6', + '7', + '8', + ], + ], + 'required' => false, + 'enumValueTitles' => [], + 'enum' => [ + '1', + '2', + '3', + '4', + '5', + '6', + '7', + '8', + ], + ], + ], + [ + 'name' => 'BusinessIds', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '业务单据号', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '202506', + ], + 'required' => false, + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'title' => '开始时间', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '2025-06-01 00:00:00', + 'pattern' => '^\\d{4}(-\\d{2}){2}\\s+\\d{2}(:\\d{2}){2}$', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'title' => '结束时间', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '2025-07-01 00:00:00', + 'pattern' => '^\\d{4}(-\\d{2}){2}\\s+\\d{2}(:\\d{2}){2}$', + ], + ], + [ + 'name' => 'BillingCycles', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '账期', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '202506', + ], + 'required' => false, + ], + ], + [ + 'name' => 'InvoiceIssuers', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '开票主体', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'ALIYUN_SERVICE', + 'pattern' => '^[0-9a-zA-Z_-]+$', + ], + 'required' => false, + 'pattern' => '^[0-9a-zA-Z_-]+$', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'title' => '当前页码', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'minimum' => '1', + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'title' => '每页大小', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + 'default' => '20', + ], + ], + [ + 'name' => 'EcIdAccountIds', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '企业与账号列表，为空表示查询当前账号自身', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'AccountIds' => [ + 'title' => '访问的账号列表，为空代表全选当前实体ID下所有账号', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1990699401005016', + ], + 'required' => false, + 'maxItems' => 100, + ], + 'EcId' => [ + 'title' => '企业实体ID', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '12345', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + [ + 'name' => 'Nbid', + 'in' => 'query', + 'schema' => [ + 'title' => '一级售卖场ID，如果为空，默认使用当前用户所属的场ID填充', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '2684201000001', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'BssApiPageResult<BssOpenInvoiceEvaluateDTO>', + 'description' => 'BssApiPageResult<BssOpenInvoiceEvaluateDTO>', + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'title' => '当前页码', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'title' => '每页大小', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'TotalCount' => [ + 'title' => '总记录数', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'Data' => [ + 'title' => '数据列表', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'title' => '开票对象状态', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'BillingCycle' => [ + 'title' => '账期', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '202506', + ], + 'AccountId' => [ + 'title' => '账号ID', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1990699401005016', + ], + 'AcceptedOffsetAmount' => [ + 'title' => '接受冲抵金额', + 'description' => '', + 'type' => 'string', + 'example' => '0.01', + ], + 'ProductName' => [ + 'title' => '产品名称', + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'ProductCode' => [ + 'title' => '产品Code', + 'description' => '', + 'type' => 'string', + 'example' => 'pts', + ], + 'CreateTime' => [ + 'title' => '创建时间', + 'description' => '', + 'type' => 'string', + 'example' => '2025-06-91 00:00:00', + ], + 'TotalAmount' => [ + 'title' => '总金额', + 'description' => '', + 'type' => 'string', + 'example' => '0.01', + ], + 'ResourceOwnerAccountName' => [ + 'title' => '资源归属账号名称', + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'InvoiceIssuer' => [ + 'title' => '开票主体', + 'description' => '', + 'type' => 'string', + 'example' => 'ALIYUN_SERVICE', + ], + 'InvoiceableAmount' => [ + 'title' => '可开票金额', + 'description' => '', + 'type' => 'string', + 'example' => '0.01', + ], + 'OffsetAmount' => [ + 'title' => '冲抵金额', + 'description' => '', + 'type' => 'string', + 'example' => '0', + ], + 'Type' => [ + 'title' => '开票对象类型', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'ResourceOwnerAccountId' => [ + 'title' => '资源归属账号ID', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1990699401005016', + ], + 'CommodityCode' => [ + 'title' => '商品Code', + 'description' => '', + 'type' => 'string', + 'example' => 'pts', + ], + 'Id' => [ + 'title' => '开票对象id', + 'description' => '', + 'type' => 'string', + 'example' => '12345', + ], + 'BusinessTime' => [ + 'title' => '业务发生时间', + 'description' => '', + 'type' => 'string', + 'example' => '2025-06-01 00:00:00'."\n", + ], + 'InvoicedAmount' => [ + 'title' => '已开票金额', + 'description' => '', + 'type' => 'string', + 'example' => '0', + ], + 'BusinessId' => [ + 'title' => '业务单据号', + 'description' => '', + 'type' => 'string', + 'example' => '202506', + ], + 'CommodityName' => [ + 'title' => '商品名称', + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'AccountName' => [ + 'title' => '账号名称', + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + ], + ], + ], + 'Metadata' => [ + 'title' => '返回结构元数据', + 'description' => '', + 'type' => 'any', + 'example' => '{}', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '6000EE23-274B-4E07-A697-FF2E999520A4', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'AccountNoQueryPricePermission', + 'errorMessage' => 'This page cannot be accessed because you do not have discount rights query permissions. Please contact the main account to go to the cost center for authorization. The permission point that needs authorization is queryprice.', + ], + [ + 'errorCode' => 'InnerAccountNoQueryPricePermission', + 'errorMessage' => 'In view of data security and compliance requirements, please understand the inconvenience caused to you by controlling the amount-related information and permissions of the group\'s cloud account. More questions please refer to the document.', + ], + [ + 'errorCode' => 'InnerSubAccountNoQueryPricePermission', + 'errorMessage' => 'In view of data security and compliance requirements, please understand the inconvenience caused to you by controlling the amount-related information and permissions of the group\'s cloud account.', + ], + [ + 'errorCode' => 'SubAccountNoQueryPricePermission', + 'errorMessage' => 'This page cannot be accessed because you do not have discount rights query permissions. Contact the main account to go to the RAM console for authorization. The Action to be authorized is bss:QueryPrice.', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified request contains invalid parameters.', + ], + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'You are not authorized to perform this action.', + ], + [ + 'errorCode' => 'InvoiceCandidateSearchTimeInvalid', + 'errorMessage' => 'Invoicing Candidate query time is illegal.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"CurrentPage\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 100,\\n \\"Data\\": [\\n {\\n \\"Status\\": 1,\\n \\"BillingCycle\\": 202506,\\n \\"AccountId\\": 1990699401005016,\\n \\"AcceptedOffsetAmount\\": \\"0.01\\",\\n \\"ProductName\\": \\"性能测试\\",\\n \\"ProductCode\\": \\"pts\\",\\n \\"CreateTime\\": \\"2025-06-91 00:00:00\\",\\n \\"TotalAmount\\": \\"0.01\\",\\n \\"ResourceOwnerAccountName\\": \\"测试账号\\",\\n \\"InvoiceIssuer\\": \\"ALIYUN_SERVICE\\",\\n \\"InvoiceableAmount\\": \\"0.01\\",\\n \\"OffsetAmount\\": \\"0\\",\\n \\"Type\\": 1,\\n \\"ResourceOwnerAccountId\\": 1990699401005016,\\n \\"CommodityCode\\": \\"pts\\",\\n \\"Id\\": \\"12345\\",\\n \\"BusinessTime\\": \\"2025-06-01 00:00:00\\\\n\\",\\n \\"InvoicedAmount\\": \\"0\\",\\n \\"BusinessId\\": \\"202506\\",\\n \\"CommodityName\\": \\"性能测试\\",\\n \\"AccountName\\": \\"测试账号\\"\\n }\\n ],\\n \\"Metadata\\": \\"{}\\",\\n \\"RequestId\\": \\"6000EE23-274B-4E07-A697-FF2E999520A4\\"\\n}","type":"json"}]', + ], + 'CreateInvoice' => [ + 'summary' => '申请发票', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'autoTest' => false, + 'notSupportAutoTestReason' => '自动化测试平台配置的统一测试UID=1948392007548064不支持开票操作', + ], + 'parameters' => [ + [ + 'name' => 'Amount', + 'in' => 'query', + 'schema' => [ + 'title' => '开票信息', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '0.01', + 'pattern' => '^[\\d._-]+$', + ], + ], + [ + 'name' => 'InvoiceTitleId', + 'in' => 'query', + 'schema' => [ + 'title' => '发票抬头信息Id', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '12345', + 'pattern' => '^\\d+$', + ], + ], + [ + 'name' => 'RecipientEmails', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '接收邮箱', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '[email protected]', + ], + 'required' => true, + 'maxItems' => 3, + 'minItems' => 1, + ], + ], + [ + 'name' => 'InvoiceRemark', + 'in' => 'query', + 'schema' => [ + 'title' => '发票备注', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '', + 'maxLength' => 200, + ], + ], + [ + 'name' => 'InvoiceCandidateIds', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '开票对象列表', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '12345', + 'pattern' => '^\\d+$', + ], + 'required' => true, + 'pattern' => '^\\d+$', + 'minItems' => 1, + ], + ], + [ + 'name' => 'InvoiceType', + 'in' => 'query', + 'schema' => [ + 'title' => '开票类型', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'enumValueTitles' => [ + '', + '', + ], + 'example' => '0', + 'enum' => [ + '0', + '1', + ], + ], + ], + [ + 'name' => 'InvoiceMode', + 'in' => 'query', + 'schema' => [ + 'title' => '开票方式', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'enumValueTitles' => [ + '', + '', + ], + 'example' => '0', + 'enum' => [ + '0', + '1', + ], + ], + ], + [ + 'name' => 'EcIdAccountIds', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '企业与账号列表，为空表示查询当前账号自身', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'AccountIds' => [ + 'title' => '访问的账号列表，为空代表全选当前实体ID下所有账号', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1990699401005016', + ], + 'required' => false, + 'maxItems' => 100, + ], + 'EcId' => [ + 'title' => '企业实体ID', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '12345', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + [ + 'name' => 'Nbid', + 'in' => 'query', + 'schema' => [ + 'title' => '一级售卖场ID，如果为空，默认使用当前用户所属的场ID填充', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '2684201000001', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'BssApiListResult<BssOpenInvoiceApplyDTO>', + 'description' => 'BssApiListResult<BssOpenInvoiceApplyDTO>', + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'title' => '数据列表', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'AccountId' => [ + 'title' => '账号ID', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1990699401005016', + ], + 'Message' => [ + 'title' => '错误信息', + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'Amount' => [ + 'title' => '开票金额', + 'description' => '', + 'type' => 'string', + 'example' => '0.01', + ], + 'ErrorCode' => [ + 'title' => '错误码', + 'description' => '', + 'type' => 'string', + 'example' => '1001', + ], + 'InvoiceIssuer' => [ + 'title' => '开票主体', + 'description' => '', + 'type' => 'string', + 'example' => 'ALIYUN_SERVICE', + ], + ], + ], + ], + 'Metadata' => [ + 'title' => '返回结构元数据', + 'description' => '', + 'type' => 'any', + 'example' => '{}', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '79EE7556-0CFD-44EB-9CD6-B3B526E3A85F', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InnerAccountNoQueryPricePermission', + 'errorMessage' => 'In view of data security and compliance requirements, please understand the inconvenience caused to you by controlling the amount-related information and permissions of the group\'s cloud account. More questions please refer to the document.', + ], + [ + 'errorCode' => 'InnerSubAccountNoQueryPricePermission', + 'errorMessage' => 'In view of data security and compliance requirements, please understand the inconvenience caused to you by controlling the amount-related information and permissions of the group\'s cloud account.', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified request contains invalid parameters.', + ], + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'You are not authorized to perform this action.', + ], + [ + 'errorCode' => 'AccountNoQueryPricePermission', + 'errorMessage' => 'This page cannot be accessed because you do not have discount rights query permissions. Please contact the main account to go to the cost center for authorization. The permission point that needs authorization is queryprice.', + ], + [ + 'errorCode' => 'SubAccountNoQueryPricePermission', + 'errorMessage' => 'This page cannot be accessed because you do not have discount rights query permissions. Contact the main account to go to the RAM console for authorization. The Action to be authorized is bss:QueryPrice.', + ], + [ + 'errorCode' => 'InvoiceManualAmountNotAllowed', + 'errorMessage' => 'Cross-account independent invoicing, amount cannot be specified.', + ], + [ + 'errorCode' => 'InvoiceRecipientEmailsMoreThanThree', + 'errorMessage' => 'Maximum 3 email addresses allowed for invoice application.', + ], + [ + 'errorCode' => 'InvoiceCandidateNotFound', + 'errorMessage' => 'No valid data to be invoiced can be found based on the invoicing object list and account list passed in.', + ], + [ + 'errorCode' => 'InvoiceTitleNotExist', + 'errorMessage' => 'Invoice title does not exist.', + ], + [ + 'errorCode' => 'InvoiceRemarkTooLong', + 'errorMessage' => 'Invoice remarks must not exceed 200 characters. Please abbreviate and resubmit.', + ], + [ + 'errorCode' => 'InvoiceAmountInValid', + 'errorMessage' => 'Illegal amount requested for invoicing.', + ], + [ + 'errorCode' => 'InvoiceAmountFormatInvalid', + 'errorMessage' => 'Illegal format of invoiced amount.', + ], + [ + 'errorCode' => 'InvoiceModeInvalid', + 'errorMessage' => 'InvoiceMode field is illegal.', + ], + [ + 'errorCode' => 'InvoiceTypeInvalid', + 'errorMessage' => 'InvoiceType field is illegal.', + ], + [ + 'errorCode' => 'InvoiceSpecialOnlyForEnterprises', + 'errorMessage' => 'Special invoices can only be issued by enterprise accounts.', + ], + [ + 'errorCode' => 'InvoiceAmountNegativeInvalid', + 'errorMessage' => 'The sum of the selected amounts is negative and cannot be invoiced.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": [\\n {\\n \\"AccountId\\": 1990699401005016,\\n \\"Message\\": \\"不可开票\\",\\n \\"Amount\\": \\"0.01\\",\\n \\"ErrorCode\\": \\"1001\\",\\n \\"InvoiceIssuer\\": \\"ALIYUN_SERVICE\\"\\n }\\n ],\\n \\"Metadata\\": \\"{}\\",\\n \\"RequestId\\": \\"79EE7556-0CFD-44EB-9CD6-B3B526E3A85F\\"\\n}","type":"json"}]', + ], + 'CreateFundAccountPayRelation' => [ + 'summary' => '创建资金账户付款关系', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'FundAccountId', + 'in' => 'formData', + 'schema' => [ + 'title' => '资金账户Id', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '12332112', + ], + ], + [ + 'name' => 'EcIdAccountIds', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '企业与账号列表', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'AccountIds' => [ + 'title' => '被代付的阿里云账号列表', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1501603440974415', + ], + 'required' => true, + ], + 'EcId' => [ + 'title' => '企业实体ID', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '1501603440974415', + ], + ], + 'required' => false, + ], + 'required' => true, + ], + ], + [ + 'name' => 'Nbid', + 'in' => 'query', + 'schema' => [ + 'title' => '一级售卖场ID，如果为空，默认使用当前用户所属的场ID填充', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '2684201000001', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'BssApiListResult<CreateBillingAccountPayRelationResponse>', + 'description' => 'BssApiListResult<CreateBillingAccountPayRelationResponse>', + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'title' => '数据列表', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'AccountId' => [ + 'title' => '使用账户付款的用户AccountId', + 'description' => '', + 'type' => 'string', + 'example' => '1501603440974415', + ], + 'FundAccountId' => [ + 'title' => '账户Id', + 'description' => '', + 'type' => 'string', + 'example' => '12332112', + ], + 'ResultMessage' => [ + 'title' => '结果信息', + 'description' => '', + 'type' => 'string', + 'example' => 'Successful', + ], + 'ResultCode' => [ + 'title' => '结果编码', + 'description' => '', + 'type' => 'string', + 'example' => 'Success', + ], + 'AccountName' => [ + 'title' => '使用账户付款的用户名称', + 'description' => '', + 'type' => 'string', + 'example' => '[email protected]'."\n", + ], + ], + ], + ], + 'Metadata' => [ + 'title' => '返回结构元数据', + 'description' => '', + 'type' => 'any', + 'example' => '{}', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '6000EE23-274B-4E07-A697-FF2E999', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidBillingAccount', + 'errorMessage' => 'The caller does not have permission for the specified billing account.', + ], + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'You are not authorized to perform this action.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": [\\n {\\n \\"AccountId\\": \\"1501603440974415\\",\\n \\"FundAccountId\\": \\"12332112\\",\\n \\"ResultMessage\\": \\"Successful\\",\\n \\"ResultCode\\": \\"Success\\",\\n \\"AccountName\\": \\"[email protected]\\\\n\\"\\n }\\n ],\\n \\"Metadata\\": \\"{}\\",\\n \\"RequestId\\": \\"6000EE23-274B-4E07-A697-FF2E999\\"\\n}","type":"json"}]', + ], + 'SetFundAccountLowAvailableAmountAlarm' => [ + 'summary' => '设置资金账户低额预警', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'ThresholdAmount', + 'in' => 'formData', + 'schema' => [ + 'title' => '低额预警阈值', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '100', + ], + ], + [ + 'name' => 'FundAccountId', + 'in' => 'formData', + 'schema' => [ + 'title' => '资金账户id，不传时默认使用当前账号拥有（owner）的账户id。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '12321213', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'BssApiPlainResult<Boolean>', + 'description' => 'BssApiPlainResult<Boolean>', + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Metadata' => [ + 'title' => '返回结构元数据', + 'description' => '', + 'type' => 'any', + 'example' => '{}', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '08108BF5-1AA3-518E-9986-95A3616E8DA9', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'RequestTimeout', + 'errorMessage' => 'Request timed out. Please try again later.', + ], + [ + 'errorCode' => 'NoFundAccountPermission', + 'errorMessage' => 'The caller does not have permission for the specified fund account.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": true,\\n \\"Metadata\\": \\"{}\\",\\n \\"RequestId\\": \\"08108BF5-1AA3-518E-9986-95A3616E8DA9\\"\\n}","type":"json"}]', + ], + 'GetFundAccountCanWithdrawAmount' => [ + 'summary' => '查询资金账户可提现金额', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'FundAccountId', + 'in' => 'formData', + 'schema' => [ + 'title' => '资金账户id，不传时默认使用当前账号拥有（owner）的账户id。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '123212232', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'BssApiPlainResult<WithdrawInfoDTO>', + 'description' => 'BssApiPlainResult<WithdrawInfoDTO>', + 'type' => 'object', + 'properties' => [ + 'Metadata' => [ + 'title' => '返回结构元数据', + 'description' => '', + 'type' => 'any', + 'example' => '{}', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'DF58589C-A06C-4224-8615-7797E6474FA3', + ], + 'CashAmount' => [ + 'title' => '现金余额', + 'description' => '', + 'type' => 'string', + 'example' => '1000', + ], + 'CanWithdrawAmount' => [ + 'title' => '可提现金额 = 现金余额 - 转账账本金额 - (欠票金额 + 历史月未结清金额 + 当前月未结清金额 - 转账账本金额) - 按量付费业务预留金额', + 'description' => '', + 'type' => 'string', + 'example' => '500', + ], + 'CanOriginalWithdrawAmount' => [ + 'title' => '可原路提现金额', + 'description' => '', + 'type' => 'string', + 'example' => '400', + ], + 'CannotOriginalWithdrawAmount' => [ + 'title' => '不可原路提现金额', + 'description' => '', + 'type' => 'string', + 'example' => '100', + ], + 'PayAsYouGoReversedAmount' => [ + 'title' => '按量业务预留金额', + 'description' => '', + 'type' => 'string', + 'example' => '100', + ], + 'TransferAmount' => [ + 'title' => '转账金额', + 'description' => '', + 'type' => 'string', + 'example' => '0', + ], + 'CreditMemoAmount' => [ + 'title' => '欠票金额', + 'description' => '', + 'type' => 'string', + 'example' => '100', + ], + 'CurrentMonthUnclearedAmount' => [ + 'title' => '当前月未结清金额', + 'description' => '', + 'type' => 'string', + 'example' => '200', + ], + 'HistoryMonthUnclearedAmount' => [ + 'title' => '历史月未结清金额', + 'description' => '', + 'type' => 'string', + 'example' => '100', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NoFundAccountPermission', + 'errorMessage' => 'The caller does not have permission for the specified fund account.', + ], + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'You are not authorized to perform this action.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Metadata\\": \\"{}\\",\\n \\"RequestId\\": \\"DF58589C-A06C-4224-8615-7797E6474FA3\\",\\n \\"CashAmount\\": \\"1000\\",\\n \\"CanWithdrawAmount\\": \\"500\\",\\n \\"CanOriginalWithdrawAmount\\": \\"400\\",\\n \\"CannotOriginalWithdrawAmount\\": \\"100\\",\\n \\"PayAsYouGoReversedAmount\\": \\"100\\",\\n \\"TransferAmount\\": \\"0\\",\\n \\"CreditMemoAmount\\": \\"100\\",\\n \\"CurrentMonthUnclearedAmount\\": \\"200\\",\\n \\"HistoryMonthUnclearedAmount\\": \\"100\\"\\n}","type":"json"}]', + ], + 'GetFundAccountAvailableAmount' => [ + 'summary' => '查询资金账户可用金', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'FundAccountId', + 'in' => 'formData', + 'schema' => [ + 'title' => '账户Id，不传时默认使用当前账号拥有（owner）的账户id。', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '12332112', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'BssApiPlainResult<BillingAccountAvailableAmountResponse>', + 'description' => 'BssApiPlainResult<BillingAccountAvailableAmountResponse>', + 'type' => 'object', + 'properties' => [ + 'Metadata' => [ + 'title' => '返回结构元数据', + 'description' => '', + 'type' => 'any', + 'example' => '{}', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'F96A2D13-7509-5DF9-A60E-E7E3A3CB68E8', + ], + 'FundAccountId' => [ + 'title' => '账户Id', + 'description' => '', + 'type' => 'string', + 'example' => '12332112', + ], + 'FundAccountOwnerAccountId' => [ + 'title' => '账户归属人的账号accountId', + 'description' => '', + 'type' => 'string', + 'example' => '1344312434', + ], + 'FundAccountStatus' => [ + 'title' => '账户状态', + 'description' => '', + 'type' => 'string', + 'example' => 'valid', + ], + 'FundAccountType' => [ + 'title' => '资金账户类型'."\n" + .'DIRECT_USER-阿里云直客账户;'."\n" + .' RESELLER_QUOTA-生态账户', + 'description' => '', + 'type' => 'string', + 'example' => 'REDIRECT_USER', + ], + 'AvailableAmount' => [ + 'title' => '可用额度', + 'description' => '', + 'type' => 'string', + 'example' => '100', + ], + 'CashAmount' => [ + 'title' => '现金余额', + 'description' => '', + 'type' => 'string', + 'example' => '50', + ], + 'NegativeBillAmount' => [ + 'title' => '负账单金额', + 'description' => '', + 'type' => 'string', + 'example' => '0', + ], + 'CreditAmount' => [ + 'title' => '信控配额', + 'description' => '', + 'type' => 'string', + 'example' => '100', + ], + 'AvailableCreditAmount' => [ + 'title' => '信控余额', + 'description' => '', + 'type' => 'string', + 'example' => '50', + ], + 'CreditRefundAmount' => [ + 'title' => '信控退款余额', + 'description' => '', + 'type' => 'string', + 'example' => '0', + ], + 'UnclearedAmount' => [ + 'title' => '未结清金额 (当前月未结清 + 历史月未结清)', + 'description' => '', + 'type' => 'string', + 'example' => '50', + ], + 'CurrentMonthUnclearedAmount' => [ + 'title' => '当月未结清金额', + 'description' => '', + 'type' => 'string', + 'example' => '20', + ], + 'HistoryMonthUnclearedAmount' => [ + 'title' => '历史月未结清金额', + 'description' => '', + 'type' => 'string', + 'example' => '30', + ], + 'BankAcceptanceAmount' => [ + 'title' => '银承汇票额度', + 'description' => '', + 'type' => 'string', + 'example' => '0', + ], + 'ExtendLedgerList' => [ + 'title' => '扩展的账本列表', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Currency' => [ + 'title' => '账本金额币种，比如：CNY/USD等', + 'description' => '', + 'type' => 'string', + 'example' => 'CNY', + ], + 'LedgerName' => [ + 'title' => '账本名称', + 'description' => '', + 'type' => 'string', + 'example' => '应付对冲账本', + ], + 'OriginalAmount' => [ + 'title' => '账本余额', + 'description' => '', + 'type' => 'string', + 'example' => '50', + ], + ], + ], + ], + 'QuotaAmount' => [ + 'title' => '生态终端客户配额', + 'description' => '', + 'type' => 'string', + 'example' => '20', + ], + 'QuotaConsumedAmount' => [ + 'title' => '生态终端客户已消费额度', + 'description' => '', + 'type' => 'string', + 'example' => '10', + ], + 'Currency' => [ + 'title' => '币种', + 'description' => '', + 'type' => 'string', + 'example' => 'CNY', + ], + 'OriginalCashAmountList' => [ + 'title' => '原始现金账本列表（国际站用户可能存在多个币种的现金账本）', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Amount' => [ + 'title' => '金额', + 'description' => '', + 'type' => 'string', + 'example' => '10', + ], + 'Currency' => [ + 'title' => '币种', + 'description' => '', + 'type' => 'string', + 'example' => 'USD', + ], + ], + ], + ], + 'CreditUser' => [ + 'title' => '是否开通信控', + 'description' => '', + 'type' => 'boolean', + 'default' => 'false', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'RequestTimeout', + 'errorMessage' => 'Request timed out. Please try again later.', + ], + [ + 'errorCode' => 'AccountNoQueryPricePermission', + 'errorMessage' => 'This page cannot be accessed because you do not have discount rights query permissions. Please contact the main account to go to the cost center for authorization. The permission point that needs authorization is queryprice.', + ], + [ + 'errorCode' => 'SubAccountNoQueryPricePermission', + 'errorMessage' => 'This page cannot be accessed because you do not have discount rights query permissions. Contact the main account to go to the RAM console for authorization. The Action to be authorized is bss:QueryPrice.', + ], + [ + 'errorCode' => 'NoFundAccountPermission', + 'errorMessage' => 'The caller does not have permission for the specified fund account.', + ], + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'You are not authorized to perform this action.', + ], + [ + 'errorCode' => 'InnerAccountNoQueryPricePermission', + 'errorMessage' => 'In view of data security and compliance requirements, please understand the inconvenience caused to you by controlling the amount-related information and permissions of the group\'s cloud account. More questions please refer to the document.', + ], + [ + 'errorCode' => 'InnerSubAccountNoQueryPricePermission', + 'errorMessage' => 'In view of data security and compliance requirements, please understand the inconvenience caused to you by controlling the amount-related information and permissions of the group\'s cloud account.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Metadata\\": \\"{}\\",\\n \\"RequestId\\": \\"F96A2D13-7509-5DF9-A60E-E7E3A3CB68E8\\",\\n \\"FundAccountId\\": \\"12332112\\",\\n \\"FundAccountOwnerAccountId\\": \\"1344312434\\",\\n \\"FundAccountStatus\\": \\"valid\\",\\n \\"FundAccountType\\": \\"REDIRECT_USER\\",\\n \\"AvailableAmount\\": \\"100\\",\\n \\"CashAmount\\": \\"50\\",\\n \\"NegativeBillAmount\\": \\"0\\",\\n \\"CreditAmount\\": \\"100\\",\\n \\"AvailableCreditAmount\\": \\"50\\",\\n \\"CreditRefundAmount\\": \\"0\\",\\n \\"UnclearedAmount\\": \\"50\\",\\n \\"CurrentMonthUnclearedAmount\\": \\"20\\",\\n \\"HistoryMonthUnclearedAmount\\": \\"30\\",\\n \\"BankAcceptanceAmount\\": \\"0\\",\\n \\"ExtendLedgerList\\": [\\n {\\n \\"Currency\\": \\"CNY\\",\\n \\"LedgerName\\": \\"应付对冲账本\\",\\n \\"OriginalAmount\\": \\"50\\"\\n }\\n ],\\n \\"QuotaAmount\\": \\"20\\",\\n \\"QuotaConsumedAmount\\": \\"10\\",\\n \\"Currency\\": \\"CNY\\",\\n \\"OriginalCashAmountList\\": [\\n {\\n \\"Amount\\": \\"10\\",\\n \\"Currency\\": \\"USD\\"\\n }\\n ],\\n \\"CreditUser\\": true\\n}","type":"json"}]', + ], + 'GetFundAccountLowAvailableAmountAlarm' => [ + 'summary' => '查询资金账户低额预警', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'FundAccountId', + 'in' => 'formData', + 'schema' => [ + 'title' => '资金账户id，不传时默认使用当前账号拥有（owner）的账户id。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '12332112', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'BssApiPlainResult<BalanceAlarmDTO>', + 'description' => 'BssApiPlainResult<BalanceAlarmDTO>', + 'type' => 'object', + 'properties' => [ + 'Metadata' => [ + 'title' => '返回结构元数据', + 'description' => '', + 'type' => 'any', + 'example' => '{}', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '6000EE23-274B-4E07-A697-FF2E999520A4', + ], + 'ThresholdAmount' => [ + 'title' => '预警阈值', + 'description' => '', + 'type' => 'string', + 'example' => '100', + ], + 'AlarmEnabled' => [ + 'title' => '是否开启预警', + 'description' => '', + 'type' => 'boolean', + 'default' => 'false', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NoFundAccountPermission', + 'errorMessage' => 'The caller does not have permission for the specified fund account.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Metadata\\": \\"{}\\",\\n \\"RequestId\\": \\"6000EE23-274B-4E07-A697-FF2E999520A4\\",\\n \\"ThresholdAmount\\": \\"100\\",\\n \\"AlarmEnabled\\": true\\n}","type":"json"}]', + ], + 'ListFundAccount' => [ + 'summary' => '查询资金账户列表', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'QueryOnlyManage', + 'in' => 'formData', + 'schema' => [ + 'title' => '只查询管理的账户列表，默认false', + 'description' => '', + 'type' => 'boolean', + 'required' => false, + 'default' => 'false', + ], + ], + [ + 'name' => 'QueryOnlyInUse', + 'in' => 'formData', + 'schema' => [ + 'title' => '只查询在用的账户列表，默认为false', + 'description' => '', + 'type' => 'boolean', + 'required' => false, + 'default' => 'false', + ], + ], + [ + 'name' => 'Nbid', + 'in' => 'query', + 'schema' => [ + 'title' => '一级售卖场ID，如果为空，默认使用当前用户所属的场ID填充', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '2084210001', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'BssApiListResult<BillingAccount>', + 'description' => 'BssApiListResult<BillingAccount>', + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'title' => '数据列表', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Site' => [ + 'title' => '站点', + 'description' => '', + 'type' => 'string', + 'example' => '26842', + ], + 'FundAccountOwnerAccountId' => [ + 'title' => '账户归属人的账号accountId', + 'description' => '', + 'type' => 'string', + 'example' => '132123211', + ], + 'FundAccountType' => [ + 'title' => '账户类型'."\n" + .'DIRECT_USER-阿里云直客账户; '."\n" + .'RESELLER_QUOTA-生态账户', + 'description' => '', + 'type' => 'string', + 'example' => 'DIRECT_USER', + ], + 'FundAccountId' => [ + 'title' => '账户Id', + 'description' => '', + 'type' => 'string', + 'example' => '1022231', + ], + 'FundAccountName' => [ + 'title' => '账户名称', + 'description' => '', + 'type' => 'string', + 'example' => '云某的账户', + ], + 'Permissions' => [ + 'title' => '用户拥有的账户权限集合'."\n" + .'using - 使用；'."\n" + .'manage - 管理；'."\n" + .'owner - 拥有；', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'owner', + ], + ], + 'Nbid' => [ + 'title' => '一级售卖场', + 'description' => '', + 'type' => 'string', + 'example' => '2684210001', + ], + 'FundAccountAdminAccountName' => [ + 'title' => '账户对应的MA用户名称', + 'description' => '', + 'type' => 'string', + 'example' => '云某的账户', + ], + 'CreateDate' => [ + 'title' => '账户创建时间', + 'description' => '', + 'type' => 'string', + 'example' => '2024-12-30 12:00:00', + ], + 'FundAccountAdminAccountId' => [ + 'title' => '账户对应的MA用户accountId', + 'description' => '', + 'type' => 'string', + 'example' => '1232121', + ], + 'FundAccountStatus' => [ + 'title' => '账户状态'."\n" + .'VALID-有效;'."\n" + .'FROZEN-冻结; '."\n" + .'CLOSED-注销', + 'description' => '', + 'type' => 'string', + 'example' => 'VALID', + ], + ], + ], + ], + 'Metadata' => [ + 'title' => '返回结构元数据', + 'description' => '', + 'type' => 'any', + 'example' => '{}', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '6000EE23-274B-4E07-A697-FF2E999520A4', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'RequestTimeout', + 'errorMessage' => 'Request timed out. Please try again later.', + ], + [ + 'errorCode' => 'AccountNotExist', + 'errorMessage' => 'Account does not exist.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": [\\n {\\n \\"Site\\": \\"26842\\",\\n \\"FundAccountOwnerAccountId\\": \\"132123211\\",\\n \\"FundAccountType\\": \\"DIRECT_USER\\",\\n \\"FundAccountId\\": \\"1022231\\",\\n \\"FundAccountName\\": \\"云某的账户\\",\\n \\"Permissions\\": [\\n \\"owner\\"\\n ],\\n \\"Nbid\\": \\"2684210001\\",\\n \\"FundAccountAdminAccountName\\": \\"云某的账户\\",\\n \\"CreateDate\\": \\"2024-12-30 12:00:00\\",\\n \\"FundAccountAdminAccountId\\": \\"1232121\\",\\n \\"FundAccountStatus\\": \\"VALID\\"\\n }\\n ],\\n \\"Metadata\\": \\"{}\\",\\n \\"RequestId\\": \\"6000EE23-274B-4E07-A697-FF2E999520A4\\"\\n}","type":"json"}]', + ], + 'CancelFundAccountLowAvailableAmountAlarm' => [ + 'summary' => '取消资金账户低额预警', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'FundAccountId', + 'in' => 'formData', + 'schema' => [ + 'title' => '资金账户id，不传时默认使用当前账号拥有（owner）的账户id。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '123321123', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'BssApiPlainResult<Boolean>', + 'description' => 'BssApiPlainResult<Boolean>', + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + 'default' => 'true', + ], + 'Metadata' => [ + 'title' => '返回结构元数据', + 'description' => '', + 'type' => 'any', + 'example' => '{}', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'DFC1F7F9-3BA9-BA4D-2F2E653', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'RequestTimeout', + 'errorMessage' => 'Request timed out. Please try again later.', + ], + [ + 'errorCode' => 'NoFundAccountPermission', + 'errorMessage' => 'The caller does not have permission for the specified fund account.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": true,\\n \\"Metadata\\": \\"{}\\",\\n \\"RequestId\\": \\"DFC1F7F9-3BA9-BA4D-2F2E653\\"\\n}","type":"json"}]', + ], + 'GetFundAccountCanAllocateCreditAmount' => [ + 'summary' => '查询资金账户可分配信控额度', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'FundAccountId', + 'in' => 'formData', + 'schema' => [ + 'title' => '资金账户id，不设置时默认使用当前账号拥有（owner）的账户', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1233231', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'BssApiPlainResult<UserCreditLimitResponse>', + 'description' => 'BssApiPlainResult<UserCreditLimitResponse>', + 'type' => 'object', + 'properties' => [ + 'Metadata' => [ + 'title' => '返回结构元数据', + 'description' => '', + 'type' => 'any', + 'example' => '{}', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'CC706AAC-75A6-55B5-9AB7-7D171C6C7655', + ], + 'Ecid' => [ + 'title' => '企业实体id', + 'description' => '', + 'type' => 'string', + 'example' => '2032123221', + ], + 'EcidCreditAmount' => [ + 'title' => '企业信控配额', + 'description' => '', + 'type' => 'string', + 'example' => '1000', + ], + 'EcidAllocatedCreditAmount' => [ + 'title' => '企业已分配信控额度', + 'description' => '', + 'type' => 'string', + 'example' => '300', + ], + 'MaxCanAllocateCreditAmount' => [ + 'title' => '当前账户最大可分配信控额度', + 'description' => '', + 'type' => 'string', + 'example' => '1500', + ], + 'MinCanAllocateCreditAmount' => [ + 'title' => '当前账户最小可分配信控额度', + 'description' => '', + 'type' => 'string', + 'example' => '200', + ], + 'Site' => [ + 'title' => '站点', + 'description' => '', + 'type' => 'string', + 'example' => '26842', + ], + 'Nbid' => [ + 'title' => '一级售卖场', + 'description' => '', + 'type' => 'string', + 'example' => '2684210001', + ], + 'FundAccountId' => [ + 'title' => '账户Id', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '12332112', + ], + 'FundAccountOwnerAccountId' => [ + 'title' => '账户归属人的阿里云accountId', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123433121', + ], + 'FundAccountName' => [ + 'title' => '账户名称', + 'description' => '', + 'type' => 'string', + 'example' => '云某的名称', + ], + 'FundAccountEcid' => [ + 'title' => '账户ecid', + 'description' => '', + 'type' => 'string', + 'example' => '202321232', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'RequestTimeout', + 'errorMessage' => 'Request timed out. Please try again later.', + ], + [ + 'errorCode' => 'NoFundAccountPermission', + 'errorMessage' => 'The caller does not have permission for the specified fund account.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Metadata\\": \\"{}\\",\\n \\"RequestId\\": \\"CC706AAC-75A6-55B5-9AB7-7D171C6C7655\\",\\n \\"Ecid\\": \\"2032123221\\",\\n \\"EcidCreditAmount\\": \\"1000\\",\\n \\"EcidAllocatedCreditAmount\\": \\"300\\",\\n \\"MaxCanAllocateCreditAmount\\": \\"1500\\",\\n \\"MinCanAllocateCreditAmount\\": \\"200\\",\\n \\"Site\\": \\"26842\\",\\n \\"Nbid\\": \\"2684210001\\",\\n \\"FundAccountId\\": 12332112,\\n \\"FundAccountOwnerAccountId\\": 123433121,\\n \\"FundAccountName\\": \\"云某的名称\\",\\n \\"FundAccountEcid\\": \\"202321232\\"\\n}","type":"json"}]', + ], + 'ListFundAccountPayRelation' => [ + 'summary' => '查询资金账户的付款关系', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'FundAccountId', + 'in' => 'formData', + 'schema' => [ + 'title' => '资金账户Id', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '12323123', + ], + ], + [ + 'name' => 'Status', + 'in' => 'formData', + 'schema' => [ + 'title' => '关系状态'."\n" + .'valid - 有效'."\n" + .'expired - 无效', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'valid', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'title' => '当前页码', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'title' => '每页大小', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + 'default' => '20', + ], + ], + [ + 'name' => 'Nbid', + 'in' => 'query', + 'schema' => [ + 'title' => '一级售卖场ID，如果为空，默认使用当前用户所属的场ID填充', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '2684201000001', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'BssApiPageResult<BillingAccountPayRelation>', + 'description' => 'BssApiPageResult<BillingAccountPayRelation>', + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'title' => '当前页码', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + 'default' => '1', + ], + 'PageSize' => [ + 'title' => '每页大小', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + 'default' => '20', + ], + 'TotalCount' => [ + 'title' => '总记录数', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '50', + ], + 'Data' => [ + 'title' => '数据列表', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'FundAccountId' => [ + 'title' => '账户Id', + 'description' => '', + 'type' => 'string', + 'example' => '123231213', + ], + 'FundAccountOwnerAccountId' => [ + 'title' => '账户归属人的阿里云accountId', + 'description' => '', + 'type' => 'string', + 'example' => '312328912', + ], + 'AccountId' => [ + 'title' => '付款关系关联的用户accountId，即使用该账户付款的账号', + 'description' => '', + 'type' => 'string', + 'example' => '32812132121', + ], + 'AccountName' => [ + 'title' => '用户名称', + 'description' => '', + 'type' => 'string', + 'example' => '云某的名称', + ], + 'EffectiveTime' => [ + 'title' => '付款关系生效时间', + 'description' => '', + 'type' => 'string', + 'example' => '2024-12-01 12:00:10', + ], + 'IneffectiveTime' => [ + 'title' => '付款关系失效时间', + 'description' => '', + 'type' => 'string', + 'example' => '2025-01-01 12:12:12', + ], + 'Status' => [ + 'title' => '关系状态'."\n" + .'valid - 有效；'."\n" + .'expired - 无效', + 'description' => '', + 'type' => 'string', + 'example' => 'valid', + ], + 'RelationType' => [ + 'title' => '关系类型，收款关系/付款关系', + 'description' => '', + 'type' => 'string', + 'example' => 'PAYMENT', + ], + 'OperatorType' => [ + 'title' => '授权操作人类型'."\n" + .'aliyun_pk - 用户；'."\n" + .'system - 阿里云系统；', + 'description' => '', + 'type' => 'string', + 'example' => 'aliyun_pk', + ], + 'OperatorNo' => [ + 'title' => '授权操作人'."\n" + .'操作人类型为aliyun_pk时，operatorNo为阿里云accountId', + 'description' => '', + 'type' => 'string', + 'example' => '1232343423', + ], + 'OperatorName' => [ + 'title' => '操作人名称'."\n" + .'操作人类型为aliyun_pk时， 操作人名称为阿里云昵称'."\n" + .'操作人类型为system时， 操作人名称为"阿里云小二"', + 'description' => '', + 'type' => 'string', + 'example' => '云某的名称', + ], + 'Site' => [ + 'title' => '站点', + 'description' => '', + 'type' => 'string', + 'example' => '26842', + ], + 'Nbid' => [ + 'title' => '一级售卖场', + 'description' => '', + 'type' => 'string', + 'example' => '2684210001', + ], + 'Ecid' => [ + 'title' => '付款关系关联的用户的企业实体id', + 'description' => '', + 'type' => 'string', + 'example' => '213231232', + ], + ], + ], + ], + 'Metadata' => [ + 'title' => '返回结构元数据', + 'description' => '', + 'type' => 'any', + 'example' => '{}', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '79EE7556-0CFD-44EB-9CD6-B3B526E3A85F', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'RequestTimeout', + 'errorMessage' => 'Request timed out. Please try again later.', + ], + [ + 'errorCode' => 'NoFundAccountPermission', + 'errorMessage' => 'The caller does not have permission for the specified fund account.', + ], + [ + 'errorCode' => 'AccountNotExist', + 'errorMessage' => 'Account does not exist.', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified request contains invalid parameters.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"CurrentPage\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 50,\\n \\"Data\\": [\\n {\\n \\"FundAccountId\\": \\"123231213\\",\\n \\"FundAccountOwnerAccountId\\": \\"312328912\\",\\n \\"AccountId\\": \\"32812132121\\",\\n \\"AccountName\\": \\"云某的名称\\",\\n \\"EffectiveTime\\": \\"2024-12-01 12:00:10\\",\\n \\"IneffectiveTime\\": \\"2025-01-01 12:12:12\\",\\n \\"Status\\": \\"valid\\",\\n \\"RelationType\\": \\"PAYMENT\\",\\n \\"OperatorType\\": \\"aliyun_pk\\",\\n \\"OperatorNo\\": \\"1232343423\\",\\n \\"OperatorName\\": \\"云某的名称\\",\\n \\"Site\\": \\"26842\\",\\n \\"Nbid\\": \\"2684210001\\",\\n \\"Ecid\\": \\"213231232\\"\\n }\\n ],\\n \\"Metadata\\": \\"{}\\",\\n \\"RequestId\\": \\"79EE7556-0CFD-44EB-9CD6-B3B526E3A85F\\"\\n}","type":"json"}]', + ], + 'GetFundAccountCanRecycleAmount' => [ + 'summary' => '查询资金账户可回收金额', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'RecycleFromFundAccountId', + 'in' => 'formData', + 'schema' => [ + 'title' => '回收源账户ID (出款方账户id)，不传时默认使用当前账号拥有（owner）的账户id。', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '122321223', + ], + ], + [ + 'name' => 'Currency', + 'in' => 'formData', + 'schema' => [ + 'title' => '币种', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'CNY', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'BssApiPlainResult<RecycleBillingAccountQueryResult>', + 'description' => 'BssApiPlainResult<RecycleBillingAccountQueryResult>', + 'type' => 'object', + 'properties' => [ + 'Metadata' => [ + 'title' => '返回结构元数据', + 'description' => '', + 'type' => 'any', + 'example' => '{}', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '6000EE23-274B-4E07-A697-FF2E999520A4', + ], + 'RecycleFromFundAccountId' => [ + 'title' => '回收源账户ID', + 'description' => '', + 'type' => 'string', + 'example' => '1232122132', + ], + 'TransferAmount' => [ + 'title' => '转账账本余额', + 'description' => '', + 'type' => 'string', + 'example' => '200', + ], + 'AvailableAmount' => [ + 'title' => '被回收账户的可用金', + 'description' => '', + 'type' => 'string', + 'example' => '300', + ], + 'RecycleToFundAccountList' => [ + 'title' => '可回收到的账户列表', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'FundAccountOwnerAccountId' => [ + 'title' => '可回收到的账户归属的accountId', + 'description' => '', + 'type' => 'string', + 'example' => '183221321', + ], + 'MaxRecyclableAmount' => [ + 'title' => '最大可回收金额', + 'description' => '', + 'type' => 'string', + 'example' => '120', + ], + 'FundAccountId' => [ + 'title' => '可回收到的账户ID', + 'description' => '', + 'type' => 'string', + 'example' => '122323121', + ], + 'FundAccountName' => [ + 'title' => '可回收到的账户名称', + 'description' => '', + 'type' => 'string', + 'example' => '云某的账户', + ], + 'OriginalTransferRemainAmount' => [ + 'title' => '可原路回收的转账金额', + 'description' => '', + 'type' => 'string', + 'example' => '120', + ], + ], + ], + ], + 'Currency' => [ + 'title' => '币种', + 'description' => '', + 'type' => 'string', + 'example' => 'CNY', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'RequestTimeout', + 'errorMessage' => 'Request timed out. Please try again later.', + ], + [ + 'errorCode' => 'NoFundAccountPermission', + 'errorMessage' => 'The caller does not have permission for the specified fund account.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Metadata\\": \\"{}\\",\\n \\"RequestId\\": \\"6000EE23-274B-4E07-A697-FF2E999520A4\\",\\n \\"RecycleFromFundAccountId\\": \\"1232122132\\",\\n \\"TransferAmount\\": \\"200\\",\\n \\"AvailableAmount\\": \\"300\\",\\n \\"RecycleToFundAccountList\\": [\\n {\\n \\"FundAccountOwnerAccountId\\": \\"183221321\\",\\n \\"MaxRecyclableAmount\\": \\"120\\",\\n \\"FundAccountId\\": \\"122323121\\",\\n \\"FundAccountName\\": \\"云某的账户\\",\\n \\"OriginalTransferRemainAmount\\": \\"120\\"\\n }\\n ],\\n \\"Currency\\": \\"CNY\\"\\n}","type":"json"}]', + ], + 'CreateFundAccountTransfer' => [ + 'summary' => '创建资金账户划拨/回收', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'FromFundAccountId', + 'in' => 'formData', + 'schema' => [ + 'title' => '转出账户id (出款方账户id)', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '123212323', + ], + ], + [ + 'name' => 'ToFundAccountId', + 'in' => 'formData', + 'schema' => [ + 'title' => '转入账户id (收款方账户id)', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '11112231', + ], + ], + [ + 'name' => 'Amount', + 'in' => 'formData', + 'schema' => [ + 'title' => '转账金额', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '100', + ], + ], + [ + 'name' => 'Currency', + 'in' => 'formData', + 'schema' => [ + 'title' => '币种', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'CNY', + ], + ], + [ + 'name' => 'FinanceType', + 'in' => 'formData', + 'schema' => [ + 'title' => '资产类型(当前仅支持现金)'."\n" + .'cash-现金;', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'cash', + ], + ], + [ + 'name' => 'TransferType', + 'in' => 'formData', + 'schema' => [ + 'title' => '转账类型'."\n" + .'grant-划拨;'."\n" + .'recycle;回收', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'grant', + 'enum' => [ + 'grant', + 'recycle', + ], + ], + ], + [ + 'name' => 'Remark', + 'in' => 'formData', + 'schema' => [ + 'title' => '备注', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '转账的备注', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'BssApiPlainResult<Void>', + 'description' => 'BssApiPlainResult<Void>', + 'type' => 'object', + 'properties' => [ + 'Metadata' => [ + 'title' => '返回结构元数据', + 'description' => '', + 'type' => 'any', + 'example' => '{}', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '1BB79-5B23-3EA-BB4F-352F93E'."\n" + ."\n", + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'RequestTimeout', + 'errorMessage' => 'Request timed out. Please try again later.', + ], + [ + 'errorCode' => 'NoFundAccountPermission', + 'errorMessage' => 'The caller does not have permission for the specified fund account.', + ], + [ + 'errorCode' => 'AccountNotExist', + 'errorMessage' => 'Account does not exist.', + ], + [ + 'errorCode' => 'AvailableTransferAmountNotEnough', + 'errorMessage' => 'The available amount for granting or recycling is insufficient.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Metadata\\": \\"{}\\",\\n \\"RequestId\\": \\"1BB79-5B23-3EA-BB4F-352F93E\\\\n\\\\n\\"\\n}","type":"json"}]', + ], + 'GetFundAccountTransactionDetails' => [ + 'summary' => '查询资金账户收支明细', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'FundAccountId', + 'in' => 'formData', + 'schema' => [ + 'title' => '资金账户id，不传时默认使用当前账号拥有（owner）的账户id。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '123221232', + ], + ], + [ + 'name' => 'TransactionNumber', + 'in' => 'formData', + 'schema' => [ + 'title' => '流水号', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '543231231', + ], + ], + [ + 'name' => 'BillNumber', + 'in' => 'formData', + 'schema' => [ + 'title' => '交易单号', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '2023212312321', + ], + ], + [ + 'name' => 'ChannelTransactionNumber', + 'in' => 'formData', + 'schema' => [ + 'title' => '交易渠道流水号', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '20250312334312322', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'formData', + 'schema' => [ + 'title' => '查询开始时间戳（毫秒）', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1735664461000', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'formData', + 'schema' => [ + 'title' => '查询结束时间戳（毫秒）', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1735664561000', + ], + ], + [ + 'name' => 'TransactionDirection', + 'in' => 'formData', + 'schema' => [ + 'title' => '交易方向 in/out(资金流入流出)', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'IN', + 'enum' => [ + 'IN', + 'OUT', + ], + ], + ], + [ + 'name' => 'TransactionType', + 'in' => 'formData', + 'schema' => [ + 'title' => '交易类型。 传入以下交易类型，查询返回对应类型结果，不存在时结果为空。不传默认返回所有类型。'."\n" + ."\n" + .'充值：CHARGE。'."\n" + ."\n" + .'提现：WITHDRAW。'."\n" + ."\n" + .'退款：REFUND。'."\n" + ."\n" + .'消费：PAY。'."\n" + ."\n" + .'转账：TRANSFER。'."\n" + ."\n" + .'调账：ADJUST。'."\n" + ."\n" + .'订单失效退款: PAY_FAILED。', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'CHARGE', + ], + ], + [ + 'name' => 'TransactionTypeList', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'title' => '交易类型列表，支持多个参数查询', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'CHARGE', + ], + 'required' => false, + ], + ], + [ + 'name' => 'TransactionChannelList', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'title' => '交易渠道，传入时按交易渠道查询，不传时默认查所有。'."\n" + ."\n" + .'用户余额：ACCT_CASH。'."\n" + ."\n" + .'支付宝：ALIPAY。'."\n" + ."\n" + .'支付宝支付通：ALIPAY_ZHIFUTONG。'."\n" + ."\n" + .'对公汇款：OFFLINE_REMIT。'."\n" + ."\n" + .'信控额度退款：REFUND。'."\n" + ."\n" + .'网银：UNION_PAY_BANK。'."\n" + ."\n" + .'信用卡：CREDIT_CARD。（国际站才有）'."\n" + ."\n" + .'AYPAL：PAYPAL 。（国际站才有）'."\n" + ."\n\n", + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'ACCT_CASH', + ], + 'required' => false, + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'title' => '当前页码', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'title' => '每页大小(最大200)', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '200', + 'example' => '20', + 'default' => '20', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'BssApiPageResult<FundFlowResponse>', + 'description' => 'BssApiPageResult<FundFlowResponse>', + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'title' => '当前页码', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + 'default' => '1', + ], + 'PageSize' => [ + 'title' => '每页大小', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + 'default' => '20', + ], + 'TotalCount' => [ + 'title' => '总记录数', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + ], + 'Data' => [ + 'title' => '数据列表', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Site' => [ + 'title' => '站点', + 'description' => '', + 'type' => 'string', + 'example' => '26842', + ], + 'TransactionType' => [ + 'title' => '交易类型。 传入以下交易类型，查询返回对应类型结果，不存在时结果为空。不传默认返回所有类型。'."\n" + ."\n" + .'充值：CHARGE。'."\n" + ."\n" + .'提现：WITHDRAW。'."\n" + ."\n" + .'退款：REFUND。'."\n" + ."\n" + .'消费：PAY。'."\n" + ."\n" + .'转账：TRANSFER。'."\n" + ."\n" + .'调账：ADJUST。'."\n" + ."\n" + .'订单失效退款: PAY_FAILED。'."\n", + 'description' => '', + 'type' => 'string', + 'example' => 'CHARGE', + ], + 'ChannelTransactionNumber' => [ + 'title' => '外部交易流水号', + 'description' => '', + 'type' => 'string', + 'example' => '20244389232', + ], + 'TransactionNumber' => [ + 'title' => '流水号', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '5423121', + ], + 'FundAccountId' => [ + 'title' => '账户Id', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1232121', + ], + 'Nbid' => [ + 'title' => '一级售卖场', + 'description' => '', + 'type' => 'string', + 'example' => '2684210001', + ], + 'TransactionAccount' => [ + 'title' => '对应交易账号，比如支付宝充值账号或转账对端账号。', + 'description' => '', + 'type' => 'string', + 'example' => '186****3975', + ], + 'BillNumber' => [ + 'title' => '订单号或者账单号', + 'description' => '', + 'type' => 'string', + 'example' => '2323203243', + ], + 'Remark' => [ + 'title' => '备注', + 'description' => '', + 'type' => 'string', + 'example' => '订单备注', + ], + 'TransactionDirection' => [ + 'title' => '交易方向 in/out(收入/支出)', + 'description' => '', + 'type' => 'string', + 'example' => 'IN', + ], + 'FundType' => [ + 'title' => '资金形式', + 'description' => '', + 'type' => 'string', + 'example' => 'ACCT_BOOK', + ], + 'Currency' => [ + 'title' => '交易金额币种', + 'description' => '', + 'type' => 'string', + 'example' => 'USD', + ], + 'TransactionChannel' => [ + 'title' => '交易渠道，传入时按交易渠道查询，不传时默认查所有。'."\n" + ."\n" + .'用户余额：ACCT_CASH。'."\n" + ."\n" + .'支付宝：ALIPAY。'."\n" + ."\n" + .'支付宝支付通：ALIPAY_ZHIFUTONG。'."\n" + ."\n" + .'对公汇款：OFFLINE_REMIT。'."\n" + ."\n" + .'信控额度退款：REFUND。'."\n" + ."\n" + .'网银：UNION_PAY_BANK。'."\n" + ."\n" + .'信用卡：CREDIT_CARD。（国际站才有）'."\n" + ."\n" + .'AYPAL：PAYPAL 。（国际站才有）'."\n" + ."\n\n", + 'description' => '', + 'type' => 'string', + 'example' => 'ALIPAY', + ], + 'FundAccountName' => [ + 'title' => '账户名称', + 'description' => '', + 'type' => 'string', + 'example' => '云某的名称', + ], + 'TransactionAmount' => [ + 'title' => '交易金额', + 'description' => '', + 'type' => 'string', + 'example' => '10', + ], + 'TransactionTime' => [ + 'title' => '交易时间格式化字符串', + 'description' => '', + 'type' => 'string', + 'example' => '2024-12-01 12:00:00', + ], + 'FundAccountEcid' => [ + 'title' => '企业实体id', + 'description' => '', + 'type' => 'string', + 'example' => '23473943', + ], + 'FundAccountOwnerAccountId' => [ + 'title' => '账户归属人的阿里云accountId', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '32343231', + ], + 'Balance' => [ + 'title' => '操作后余额', + 'description' => '', + 'type' => 'string', + 'example' => '5', + ], + ], + ], + ], + 'Metadata' => [ + 'title' => '返回结构元数据', + 'description' => '', + 'type' => 'any', + 'example' => '{}', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'D6E068C3-25BC-455A-85FE-45F0B22ECB1F', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MaxOffsetLimit', + 'errorMessage' => 'Exceeded maximum page turning limit.', + ], + [ + 'errorCode' => 'RequestTimeout', + 'errorMessage' => 'Request timed out. Please try again later.', + ], + [ + 'errorCode' => 'NoFundAccountPermission', + 'errorMessage' => 'The caller does not have permission for the specified fund account.', + ], + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'You are not authorized to perform this action.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"CurrentPage\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 30,\\n \\"Data\\": [\\n {\\n \\"Site\\": \\"26842\\",\\n \\"TransactionType\\": \\"CHARGE\\",\\n \\"ChannelTransactionNumber\\": \\"20244389232\\",\\n \\"TransactionNumber\\": 5423121,\\n \\"FundAccountId\\": 1232121,\\n \\"Nbid\\": \\"2684210001\\",\\n \\"TransactionAccount\\": \\"186****3975\\",\\n \\"BillNumber\\": \\"2323203243\\",\\n \\"Remark\\": \\"订单备注\\",\\n \\"TransactionDirection\\": \\"IN\\",\\n \\"FundType\\": \\"ACCT_BOOK\\",\\n \\"Currency\\": \\"USD\\",\\n \\"TransactionChannel\\": \\"ALIPAY\\",\\n \\"FundAccountName\\": \\"云某的名称\\",\\n \\"TransactionAmount\\": \\"10\\",\\n \\"TransactionTime\\": \\"2024-12-01 12:00:00\\",\\n \\"FundAccountEcid\\": \\"23473943\\",\\n \\"FundAccountOwnerAccountId\\": 32343231,\\n \\"Balance\\": \\"5\\"\\n }\\n ],\\n \\"Metadata\\": \\"{}\\",\\n \\"RequestId\\": \\"D6E068C3-25BC-455A-85FE-45F0B22ECB1F\\"\\n}","type":"json"}]', + ], + 'SetFundAccountCreditAmount' => [ + 'summary' => '设置资金账户的信控限额', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'FundAccountId', + 'in' => 'formData', + 'schema' => [ + 'title' => '资金账户id, 不设置时默认使用当前账号拥有（owner）的账户', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1232312', + ], + ], + [ + 'name' => 'CreditAmount', + 'in' => 'formData', + 'schema' => [ + 'title' => '授信额度', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '500', + ], + ], + [ + 'name' => 'Currency', + 'in' => 'formData', + 'schema' => [ + 'title' => '信控额度币种。目前国内仅支持CNY，国际仅支持USD', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'CNY', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'BssApiPlainResult<Void>', + 'description' => 'BssApiPlainResult<Void>', + 'type' => 'object', + 'properties' => [ + 'Metadata' => [ + 'title' => '返回结构元数据', + 'description' => '', + 'type' => 'any', + 'example' => '{}', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '79EE7556-0CFD-44EB-9CD6-B3B526E3A85F'."\n", + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified request contains invalid parameters.', + ], + [ + 'errorCode' => 'RequestTimeout', + 'errorMessage' => 'Request timed out. Please try again later.', + ], + [ + 'errorCode' => 'NoFundAccountPermission', + 'errorMessage' => 'The caller does not have permission for the specified fund account.', + ], + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'You are not authorized to perform this action.', + ], + [ + 'errorCode' => 'ExistApprovingProcess', + 'errorMessage' => 'There is a credit control setting process in the approval process, please contact the business manager.', + ], + [ + 'errorCode' => 'ExistUnconfirmedContract', + 'errorMessage' => 'The account you operate has a credit contract to be confirmed. Please confirm the contract first.', + ], + [ + 'errorCode' => 'NotSupportAllocateCredit', + 'errorMessage' => 'Self-service credit limit allocation is currently unavailable. Please contact your service manager for assistance.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Metadata\\": \\"{}\\",\\n \\"RequestId\\": \\"79EE7556-0CFD-44EB-9CD6-B3B526E3A85F\\\\n\\"\\n}","type":"json"}]', + ], + 'GetFundAccountCanTransferAmount' => [ + 'summary' => '查询资金账户的可转出金额', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'FundAccountId', + 'in' => 'formData', + 'schema' => [ + 'title' => '转账源账户ID，不传时默认使用当前账号拥有（owner）的账户id。', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '123212', + ], + ], + [ + 'name' => 'Currency', + 'in' => 'formData', + 'schema' => [ + 'title' => '币种', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'CNY', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'BssApiPlainResult<TransferBillingAccount>', + 'description' => 'BssApiPlainResult<TransferBillingAccount>', + 'type' => 'object', + 'properties' => [ + 'Metadata' => [ + 'title' => '返回结构元数据', + 'description' => '', + 'type' => 'any', + 'example' => '{}', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '6000EE23-274B-4E07-A697-FF2E999520A4', + ], + 'MaxTransferableAmount' => [ + 'title' => '可转账金额', + 'description' => '', + 'type' => 'string', + 'example' => '100', + ], + 'CashAmount' => [ + 'title' => '现金账本余额', + 'description' => '', + 'type' => 'string', + 'example' => '500', + ], + 'TransferAmount' => [ + 'title' => '转账账本余额', + 'description' => '', + 'type' => 'string', + 'example' => '100', + ], + 'AvailableAmount' => [ + 'title' => '可用金', + 'description' => '', + 'type' => 'string', + 'example' => '100', + ], + 'Currency' => [ + 'title' => '币种', + 'description' => '', + 'type' => 'string', + 'example' => 'CNY', + ], + 'Site' => [ + 'title' => '站点', + 'description' => '', + 'type' => 'string', + 'example' => '26842', + ], + 'Nbid' => [ + 'title' => '一级售卖场', + 'description' => '', + 'type' => 'string', + 'example' => '2684210001', + ], + 'FundAccountId' => [ + 'title' => '账户Id', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '12332112', + ], + 'FundAccountOwnerAccountId' => [ + 'title' => '账户归属人的阿里云accountId', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '154738212323', + ], + 'FundAccountName' => [ + 'title' => '账户名称', + 'description' => '', + 'type' => 'string', + 'example' => '云某的账户', + ], + 'FundAccountEcid' => [ + 'title' => '账户归属的企业实体id', + 'description' => '', + 'type' => 'string', + 'example' => '2032121324', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'RequestTimeout', + 'errorMessage' => 'Request timed out. Please try again later.', + ], + [ + 'errorCode' => 'NoFundAccountPermission', + 'errorMessage' => 'The caller does not have permission for the specified fund account.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Metadata\\": \\"{}\\",\\n \\"RequestId\\": \\"6000EE23-274B-4E07-A697-FF2E999520A4\\",\\n \\"MaxTransferableAmount\\": \\"100\\",\\n \\"CashAmount\\": \\"500\\",\\n \\"TransferAmount\\": \\"100\\",\\n \\"AvailableAmount\\": \\"100\\",\\n \\"Currency\\": \\"CNY\\",\\n \\"Site\\": \\"26842\\",\\n \\"Nbid\\": \\"2684210001\\",\\n \\"FundAccountId\\": 12332112,\\n \\"FundAccountOwnerAccountId\\": 154738212323,\\n \\"FundAccountName\\": \\"云某的账户\\",\\n \\"FundAccountEcid\\": \\"2032121324\\"\\n}","type":"json"}]', + ], + 'DescribeCoupon' => [ + 'summary' => '查询优惠券列表', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'EffectiveStartTime', + 'in' => 'query', + 'schema' => [ + 'title' => '生效开始时间', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1684750028000', + ], + ], + [ + 'name' => 'EffectiveEndTime', + 'in' => 'query', + 'schema' => [ + 'title' => '生效结束时间', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1708423156000', + ], + ], + [ + 'name' => 'ExpireStartDate', + 'in' => 'query', + 'schema' => [ + 'title' => '失效开始时间', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1684750028000', + ], + ], + [ + 'name' => 'ExpireEndDate', + 'in' => 'query', + 'schema' => [ + 'title' => '失效结束时间', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1708423156000', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'title' => '状态', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'AVAILABLE', + ], + ], + [ + 'name' => 'CouponType', + 'in' => 'query', + 'schema' => [ + 'title' => '优惠券类型', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'CERTAIN', + ], + ], + [ + 'name' => 'Nbid', + 'in' => 'query', + 'schema' => [ + 'title' => '一级场信息', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '2684201000001', + ], + ], + [ + 'name' => 'CouponId', + 'in' => 'query', + 'schema' => [ + 'title' => '优惠券id', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '351430260343', + ], + ], + [ + 'name' => 'CouponNo', + 'in' => 'query', + 'schema' => [ + 'title' => '券编码', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '554863270150', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'title' => '当前页码', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'title' => '每页大小', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '20', + ], + ], + [ + 'name' => 'EcIdAccountIds', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '企业与账号列表，为空表示查询当前账号自身', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'EcId' => [ + 'title' => '企业实体ID', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '1501603440974415', + ], + 'AccountIds' => [ + 'title' => '访问的账号列表，为空代表全选当前实体ID下所有账号', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1501603440974415', + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'BssApiPageResult<CouponVO>', + 'description' => 'BssApiPageResult<CouponVO>', + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'title' => '当前页码', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'title' => '每页大小', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'TotalCount' => [ + 'title' => '总记录数', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'Data' => [ + 'title' => '数据列表', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'CouponId' => [ + 'title' => '优惠券id', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '59243658', + ], + 'CouponNo' => [ + 'title' => '券编码', + 'description' => '', + 'type' => 'string', + 'example' => '731074910070', + ], + 'CouponType' => [ + 'title' => '优惠券类型', + 'description' => '', + 'type' => 'string', + 'example' => 'CERTAIN', + ], + 'CouponTypeName' => [ + 'title' => '优惠券类型名称', + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'Amount' => [ + 'title' => '面值', + 'description' => '', + 'type' => 'string', + 'example' => '9929.750000', + ], + 'RemainAmount' => [ + 'title' => '剩余金额', + 'description' => '', + 'type' => 'string', + 'example' => '100.00', + ], + 'ItemNames' => [ + 'title' => '产品code列表', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + ], + 'UniversalType' => [ + 'title' => '优惠券适用范围', + 'description' => '', + 'type' => 'string', + 'example' => 'UNIVERSAL', + ], + 'YhOrderTypes' => [ + 'title' => '优惠券适用订单类型列表', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + ], + 'Status' => [ + 'title' => '状态', + 'description' => '', + 'type' => 'string', + 'example' => 'Available', + ], + 'GmtCreate' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2021-03-02T15:12Z'."\n", + ], + 'StartTime' => [ + 'title' => '开始时间', + 'description' => '', + 'type' => 'string', + 'example' => '2021-03-02T15:12Z', + ], + 'EndTime' => [ + 'title' => '结束时间', + 'description' => '', + 'type' => 'string', + 'example' => '2021-03-06T15:12Z', + ], + 'Site' => [ + 'title' => '站点', + 'description' => '', + 'type' => 'string', + 'example' => 'CHINA', + ], + 'SiteName' => [ + 'title' => '站点名称', + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'Remark' => [ + 'title' => '备注', + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'MoneyLimit' => [ + 'title' => '金额限制', + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'Currency' => [ + 'title' => '币种', + 'description' => '', + 'type' => 'string', + 'example' => 'CNY', + ], + 'SuitAccount' => [ + 'title' => '适用帐号', + 'description' => '', + 'type' => 'string', + 'example' => '1902671110151254', + ], + 'OrderTimeRule' => [ + 'title' => '订单时长限制规则', + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'ShareUidList' => [ + 'title' => '共享帐号列表', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Uid' => [ + 'title' => '阿里云uid', + 'description' => '', + 'type' => 'string', + 'example' => '1902671110151254', + ], + 'UserNick' => [ + 'title' => '阿里云帐号', + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + ], + ], + ], + 'SuitItemType' => [ + 'title' => '适用产品类型：all 全产品通用 white 指定产品适用 black 指定产品不适用', + 'description' => '', + 'type' => 'string', + 'example' => 'all', + ], + 'ShowSetDeductTagButton' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'CertainAmount' => [ + 'type' => 'string', + ], + 'FirstBuy' => [ + 'title' => '是否有首购限制', + 'type' => 'boolean', + ], + ], + ], + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'C880B065-A781-4F19-B6DD-3E0E3B715C64', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'AccountNoQueryPricePermission', + 'errorMessage' => 'This page cannot be accessed because you do not have discount rights query permissions. Please contact the main account to go to the cost center for authorization. The permission point that needs authorization is queryprice.', + ], + [ + 'errorCode' => 'SubAccountNoQueryPricePermission', + 'errorMessage' => 'This page cannot be accessed because you do not have discount rights query permissions. Contact the main account to go to the RAM console for authorization. The Action to be authorized is bss:QueryPrice.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"CurrentPage\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 2,\\n \\"Data\\": [\\n {\\n \\"CouponId\\": 59243658,\\n \\"CouponNo\\": \\"731074910070\\",\\n \\"CouponType\\": \\"CERTAIN\\",\\n \\"CouponTypeName\\": \\"满减券\\",\\n \\"Amount\\": \\"9929.750000\\",\\n \\"RemainAmount\\": \\"100.00\\",\\n \\"ItemNames\\": [\\n \\"全产品适用\\"\\n ],\\n \\"UniversalType\\": \\"UNIVERSAL\\",\\n \\"YhOrderTypes\\": [\\n \\"新购\\"\\n ],\\n \\"Status\\": \\"Available\\",\\n \\"GmtCreate\\": \\"2021-03-02T15:12Z\\\\n\\",\\n \\"StartTime\\": \\"2021-03-02T15:12Z\\",\\n \\"EndTime\\": \\"2021-03-06T15:12Z\\",\\n \\"Site\\": \\"CHINA\\",\\n \\"SiteName\\": \\"官网自营\\",\\n \\"Remark\\": \\"新买28号\\",\\n \\"MoneyLimit\\": \\"无订单金额限制\\",\\n \\"Currency\\": \\"CNY\\",\\n \\"SuitAccount\\": \\"1902671110151254\\",\\n \\"OrderTimeRule\\": \\"预付费规则：购买订单时长大于3600s才能使用\\",\\n \\"ShareUidList\\": [\\n {\\n \\"Uid\\": \\"1902671110151254\\",\\n \\"UserNick\\": \\"阿里云计算有限公司\\"\\n }\\n ],\\n \\"SuitItemType\\": \\"all\\",\\n \\"ShowSetDeductTagButton\\": true,\\n \\"CertainAmount\\": \\"\\",\\n \\"FirstBuy\\": true\\n }\\n ],\\n \\"RequestId\\": \\"C880B065-A781-4F19-B6DD-3E0E3B715C64\\"\\n}","type":"json"}]', + ], + 'DescribeCouponItemList' => [ + 'summary' => '查询优惠券可用商品列表', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'CouponId', + 'in' => 'query', + 'schema' => [ + 'title' => '优惠券id', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '59104570', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'title' => '商品名称(支持模糊匹配)', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'title' => '当前页码', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'title' => '每页大小', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'EcIdAccountIds', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '企业与账号列表，为空表示查询当前账号自身', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'EcId' => [ + 'title' => '企业实体ID', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '1004064243473974', + ], + 'AccountIds' => [ + 'title' => '访问的账号列表，为空代表全选当前实体ID下所有账号', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1004064243473974', + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + [ + 'name' => 'Nbid', + 'in' => 'query', + 'schema' => [ + 'title' => '一级售卖场ID，如果为空，默认使用当前用户所属的场ID填充', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '2684201000001', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'BssApiPageResult<ItemNameVO>', + 'description' => 'BssApiPageResult<ItemNameVO>', + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'title' => '当前页码', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'title' => '每页大小', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'TotalCount' => [ + 'title' => '总记录数', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'Data' => [ + 'title' => '数据列表', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'title' => '商品code', + 'description' => '', + 'type' => 'string', + 'example' => 'vm', + ], + 'Name' => [ + 'title' => '商品名称', + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + ], + ], + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'EAE08A27-386C-579E-966D-8853EC3C5D0E', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"CurrentPage\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 5,\\n \\"Data\\": [\\n {\\n \\"Code\\": \\"vm\\",\\n \\"Name\\": \\"云服务器ECS\\"\\n }\\n ],\\n \\"RequestId\\": \\"EAE08A27-386C-579E-966D-8853EC3C5D0E\\"\\n}","type":"json"}]', + ], + 'CreateReportDefinition' => [ + 'summary' => '创建账单订阅', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'ReportSourceType', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'OSS', + ], + ], + [ + 'name' => 'ReportType', + 'in' => 'query', + 'schema' => [ + 'title' => '账单存储类型，类型来源参考API：ListReportTypesForReportDefinition', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'BillingItemDetailForBillingPeriod', + ], + ], + [ + 'name' => 'BeginBillingCycle', + 'in' => 'query', + 'schema' => [ + 'title' => '推送起始账期。订阅成功后，系统会自动推送起始账期到当前时间的数据。月账单PDF订阅时此参数无效，不会对历史数据重新推送。最多可推送最近1年内数据。', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '2025-05', + ], + ], + [ + 'name' => 'OssBucketOwnerAccountId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1234567812345678', + ], + ], + [ + 'name' => 'OssBucketName', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'sh-bill', + ], + ], + [ + 'name' => 'OssBucketPath', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'bill/', + ], + ], + [ + 'name' => 'McProject', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'project', + ], + ], + [ + 'name' => 'McTableName', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'table', + ], + ], + [ + 'name' => 'Nbid', + 'in' => 'query', + 'schema' => [ + 'title' => '一级售卖场ID，如果为空，默认使用当前用户所属的场ID填充', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '2684201000001', + ], + ], + [ + 'name' => 'SplitFileOnUserId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + [ + 'name' => 'NotSendOnNoData', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + [ + 'name' => 'SendWithAttach', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + [ + 'name' => 'IncludeMembers', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Metadata' => [ + 'title' => '返回结构元数据', + 'description' => '', + 'type' => 'any', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '340CAB45-0637-5875-9BE4-EFD5750F6BA5', + ], + 'ReportTaskId' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123123', + ], + 'ReportSourceType' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'OSS', + ], + 'ReportSourceName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'OSS', + ], + 'ReportType' => [ + 'title' => '账单存储类型', + 'description' => '', + 'type' => 'string', + 'example' => 'BillingItemDetailForBillingPeriod', + ], + 'BeginBillingCycle' => [ + 'title' => '推送起始账期。订阅成功后，系统会自动推送起始账期到当前时间的数据。月账单PDF订阅时此参数无效，不会对历史数据重新推送。最多可推送最近1年内数据。', + 'description' => '', + 'type' => 'string', + 'example' => '2025-05', + ], + 'SubscribeCreateTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2025-05-21 10:36:31', + ], + 'OssBucketOwnerAccountId' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234567812345678', + ], + 'OssBucketName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'sh-bill', + ], + 'OssBucketPath' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'bill/', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'TASK_EXIST', + 'errorMessage' => 'task has already exist.', + ], + [ + 'errorCode' => 'InvalidBucket', + 'errorMessage' => 'The bucket is invalid or the bucket does not belong to you.', + ], + [ + 'errorCode' => 'InvalidHistoricalNbid', + 'errorMessage' => 'Historical field does not support subscription bill.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Metadata\\": \\"\\",\\n \\"RequestId\\": \\"340CAB45-0637-5875-9BE4-EFD5750F6BA5\\",\\n \\"ReportTaskId\\": 123123,\\n \\"ReportSourceType\\": \\"OSS\\",\\n \\"ReportSourceName\\": \\"OSS\\",\\n \\"ReportType\\": \\"BillingItemDetailForBillingPeriod\\",\\n \\"BeginBillingCycle\\": \\"2025-05\\",\\n \\"SubscribeCreateTime\\": \\"2025-05-21 10:36:31\\",\\n \\"OssBucketOwnerAccountId\\": 1234567812345678,\\n \\"OssBucketName\\": \\"sh-bill\\",\\n \\"OssBucketPath\\": \\"bill/\\"\\n}","type":"json"}]', + ], + 'ListReportDefinitions' => [ + 'summary' => '查看已订阅的报告列表', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Nbid', + 'in' => 'query', + 'schema' => [ + 'title' => '一级售卖场ID，如果为空，默认使用当前用户所属的场ID填充', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '2684201000001', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'ReportDefinitions' => [ + 'title' => '数据列表', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ReportTaskId' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123321', + ], + 'ReportSourceType' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'OSS', + ], + 'ReportSourceName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'OSS', + ], + 'ReportType' => [ + 'title' => '账单存储类型', + 'description' => '', + 'type' => 'string', + 'example' => 'BillingItemDetailForBillingPeriod', + ], + 'BeginBillingCycle' => [ + 'title' => '推送起始账期。订阅成功后，系统会自动推送起始账期到当前时间的数据。月账单PDF订阅时此参数无效，不会对历史数据重新推送。最多可推送最近1年内数据。', + 'description' => '', + 'type' => 'string', + 'example' => '2025-05', + ], + 'SubscribeCreateTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2025-05-21 10:36:31', + ], + 'OssBucketOwnerAccountId' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234567812345678', + ], + 'OssBucketName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'oss-bill', + ], + 'OssBucketPath' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'bill/', + ], + ], + ], + ], + 'Metadata' => [ + 'title' => '返回结构元数据', + 'description' => '', + 'type' => 'any', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '79EE7556-0CFD-44EB-9CD6-B3B526E3A85F', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidHistoricalNbid', + 'errorMessage' => 'Historical field does not support subscription bill.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ReportDefinitions\\": [\\n {\\n \\"ReportTaskId\\": 123321,\\n \\"ReportSourceType\\": \\"OSS\\",\\n \\"ReportSourceName\\": \\"OSS\\",\\n \\"ReportType\\": \\"BillingItemDetailForBillingPeriod\\",\\n \\"BeginBillingCycle\\": \\"2025-05\\",\\n \\"SubscribeCreateTime\\": \\"2025-05-21 10:36:31\\",\\n \\"OssBucketOwnerAccountId\\": 1234567812345678,\\n \\"OssBucketName\\": \\"oss-bill\\",\\n \\"OssBucketPath\\": \\"bill/\\"\\n }\\n ],\\n \\"Metadata\\": \\"\\",\\n \\"RequestId\\": \\"79EE7556-0CFD-44EB-9CD6-B3B526E3A85F\\"\\n}","type":"json"}]', + ], + 'DeleteReportDefinition' => [ + 'summary' => '取消账单订阅', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'ReportTaskId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '123123', + ], + ], + [ + 'name' => 'Nbid', + 'in' => 'query', + 'schema' => [ + 'title' => '一级售卖场ID，如果为空，默认使用当前用户所属的场ID填充', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '2684201000001', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Metadata' => [ + 'title' => '返回结构元数据', + 'description' => '', + 'type' => 'any', + 'example' => '{}', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '79EE7556-0CFD-44EB-9CD6-B3B526E3A85F'."\n", + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidHistoricalNbid', + 'errorMessage' => 'Historical field does not support subscription bill.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": true,\\n \\"Metadata\\": \\"{}\\",\\n \\"RequestId\\": \\"79EE7556-0CFD-44EB-9CD6-B3B526E3A85F\\\\n\\"\\n}","type":"json"}]', + ], + 'SaveCostCenterShareRule' => [ + 'summary' => '修改财务单元分摊规则', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'OwnerAccountId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1977800748053695', + ], + ], + [ + 'name' => 'CreateShareRuleList', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'ToCostCenterList' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '583055', + ], + 'required' => false, + 'maxItems' => 100, + ], + 'FromCostCenterList' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '583053', + ], + 'required' => false, + 'maxItems' => 100, + ], + 'ShareRatioList' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'double', + 'required' => false, + 'example' => '0.5', + ], + 'required' => false, + 'maxItems' => 100, + ], + 'ShareRuleName' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + 'ShareType' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [ + 'AVERAGE' => '', + 'CUSTOM' => '', + 'RATIO' => '', + ], + 'example' => 'RATIO', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + [ + 'name' => 'ModifyShareRuleList', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'ShareRuleId' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1828', + ], + 'ToCostCenterList' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '583056', + ], + 'required' => false, + 'maxItems' => 100, + ], + 'FromCostCenterList' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '583052', + ], + 'required' => false, + 'maxItems' => 100, + ], + 'ShareRatioList' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'double', + 'required' => false, + 'example' => '0.2', + ], + 'required' => false, + 'maxItems' => 100, + ], + 'ShareRuleName' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + 'ShareType' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [ + 'AVERAGE' => '', + 'CUSTOM' => '', + 'RATIO' => '', + ], + 'example' => 'CUSTOM', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + [ + 'name' => 'RemoveShareRuleList', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1827', + ], + 'required' => false, + ], + ], + [ + 'name' => 'Nbid', + 'in' => 'query', + 'schema' => [ + 'title' => '一级售卖场ID，如果为空，默认使用当前用户所属的场ID填充', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '2684201000001', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'BssApiPlainResult<CostCenterShareRuleSaveDto>', + 'description' => 'BssApiPlainResult<CostCenterShareRuleSaveDto>', + 'type' => 'object', + 'properties' => [ + 'Metadata' => [ + 'title' => '返回结构元数据', + 'description' => '', + 'type' => 'any', + 'example' => '{}', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '6000EE23-274B-4E07-A697-FF2E999520A4', + ], + 'Success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'CostCenter.MasterAndSubHasNoRelation', + 'errorMessage' => 'Your account has no valid account relation yet.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Metadata\\": \\"{}\\",\\n \\"RequestId\\": \\"6000EE23-274B-4E07-A697-FF2E999520A4\\",\\n \\"Success\\": true\\n}","type":"json"}]', + ], + 'QueryCostCenterShareRule' => [ + 'summary' => '查询财务单元分摊规则', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'OwnerAccountId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1529600453335198', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'title' => '下一个查询开始Token，NextToken为空说明没有下一个', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'AAAAAV3MpHK1AP0pfERHZN5pu6nYCisJwqt18pP5E9yb47iu', + ], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => [ + 'title' => '单次查询的最大记录数', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'EcIdAccountIds', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'title' => '企业与账号列表，为空表示查询当前账号自身', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'EcId' => [ + 'title' => '企业实体ID', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '1004064243473974', + ], + 'AccountIds' => [ + 'title' => '访问的账号列表，为空代表全选当前实体ID下所有账号', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1501603440974415', + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + [ + 'name' => 'Nbid', + 'in' => 'query', + 'schema' => [ + 'title' => '一级售卖场ID，如果为空，默认使用当前用户所属的场ID填充', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '2684201000001', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'BssApiTokenResult<CostCenterShareRuleDto>', + 'description' => 'BssApiTokenResult<CostCenterShareRuleDto>', + 'type' => 'object', + 'properties' => [ + 'NextToken' => [ + 'title' => '下一个查询开始Token，NextToken为空说明没有下一个', + 'description' => '', + 'type' => 'string', + 'example' => 'eyJwYWdlTnVtIjoyLCJwYWdlU2l6ZSI6NH0=', + ], + 'MaxResults' => [ + 'title' => '单次查询的最大记录数', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'TotalCount' => [ + 'title' => '总记录数', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'Data' => [ + 'title' => '数据列表', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'OwnerAccountId' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1529600453335198', + ], + 'ShareRuleId' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1826', + ], + 'ShareRuleName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'test', + ], + 'ShareRuleType' => [ + 'description' => '', + 'type' => 'string', + 'enumValueTitles' => [ + 'AVERAGE' => '', + 'CUSTOM' => '', + 'RATIO' => '', + ], + 'example' => 'AVERAGE', + ], + 'FromCostCenterShareRuleDetails' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'OwnerAccountId' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1529600453335198', + ], + 'RootCostCenterId' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '583050', + ], + 'CostCenterId' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '637127', + ], + 'ParentCostCenterId' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '637537', + ], + 'PrevCostCenterId' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '583059', + ], + 'CostCenterCode' => [ + 'description' => '', + 'type' => 'string', + 'example' => '970354711219#', + ], + 'CostCenterName' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'GmtCreate' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2025-07-16 13:49:59', + ], + 'GmtModified' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2025-07-16 13:49:59', + 'title' => '', + ], + ], + ], + ], + 'ToCostCenterShareRuleDetails' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'OwnerAccountId' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1529600453335198', + ], + 'RootCostCenterId' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '583050', + ], + 'CostCenterId' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '637127', + ], + 'ParentCostCenterId' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '637537', + ], + 'PrevCostCenterId' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '583055', + ], + 'CostCenterCode' => [ + 'description' => '', + 'type' => 'string', + 'example' => '970354711215#', + ], + 'CostCenterName' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'ShareRatio' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.2', + ], + 'GmtCreate' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2025-07-16 13:49:59', + ], + 'GmtModified' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2025-07-16 13:49:59', + ], + ], + ], + ], + 'GmtModified' => [ + 'title' => '最近修改时间', + 'type' => 'string', + 'example' => '2026-01-01 00:00:00', + ], + ], + ], + ], + 'Metadata' => [ + 'title' => '返回结构元数据', + 'description' => '', + 'type' => 'any', + 'example' => '{}', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '79EE7556-0CFD-44EB-9CD6-B3B526E3A85F', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'CostCenter.MasterAndSubHasNoRelation', + 'errorMessage' => 'Your account has no valid account relation yet.', + ], + [ + 'errorCode' => 'CostCenter.ResourceAuthFailed', + 'errorMessage' => 'The instance does not belong to the current user.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"NextToken\\": \\"eyJwYWdlTnVtIjoyLCJwYWdlU2l6ZSI6NH0=\\",\\n \\"MaxResults\\": 20,\\n \\"TotalCount\\": 20,\\n \\"Data\\": [\\n {\\n \\"OwnerAccountId\\": 1529600453335198,\\n \\"ShareRuleId\\": 1826,\\n \\"ShareRuleName\\": \\"test\\",\\n \\"ShareRuleType\\": \\"AVERAGE\\",\\n \\"FromCostCenterShareRuleDetails\\": [\\n {\\n \\"OwnerAccountId\\": 1529600453335198,\\n \\"RootCostCenterId\\": 583050,\\n \\"CostCenterId\\": 637127,\\n \\"ParentCostCenterId\\": 637537,\\n \\"PrevCostCenterId\\": 583059,\\n \\"CostCenterCode\\": \\"970354711219#\\",\\n \\"CostCenterName\\": \\"成本计划\\",\\n \\"GmtCreate\\": \\"2025-07-16 13:49:59\\",\\n \\"GmtModified\\": \\"2025-07-16 13:49:59\\"\\n }\\n ],\\n \\"ToCostCenterShareRuleDetails\\": [\\n {\\n \\"OwnerAccountId\\": 1529600453335198,\\n \\"RootCostCenterId\\": 583050,\\n \\"CostCenterId\\": 637127,\\n \\"ParentCostCenterId\\": 637537,\\n \\"PrevCostCenterId\\": 583055,\\n \\"CostCenterCode\\": \\"970354711215#\\",\\n \\"CostCenterName\\": \\"成本分摊\\",\\n \\"ShareRatio\\": 0.2,\\n \\"GmtCreate\\": \\"2025-07-16 13:49:59\\",\\n \\"GmtModified\\": \\"2025-07-16 13:49:59\\"\\n }\\n ],\\n \\"GmtModified\\": \\"2026-01-01 00:00:00\\"\\n }\\n ],\\n \\"Metadata\\": \\"{}\\",\\n \\"RequestId\\": \\"79EE7556-0CFD-44EB-9CD6-B3B526E3A85F\\"\\n}","type":"json"}]', + ], + 'CreateCostCenter' => [ + 'summary' => '创建财务单元', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'CostCenterEntityList', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '财务单元实体列表', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'CostCenterName' => [ + 'title' => '财务单元名称（同一个账号必须唯一）', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '', + ], + 'OwnerAccountId' => [ + 'title' => '新财务单元的属主用户 ID', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1314839403940987', + ], + 'ParentCostCenterId' => [ + 'title' => '父财务单元 ID，-1 表示财务单元根。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '-1', + ], + ], + 'required' => false, + ], + 'required' => true, + ], + ], + [ + 'name' => 'Nbid', + 'in' => 'query', + 'schema' => [ + 'title' => '一级售卖场ID，如果为空，默认使用当前用户所属的场ID填充', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '2084210001', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'BssApiListResult<CostCenterCreateDto>', + 'description' => 'BssApiPageResult<CostCenterDto>', + 'type' => 'object', + 'properties' => [ + 'CostCenterDtoList' => [ + 'title' => '数据列表', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'CostCenterName' => [ + 'title' => '财务单元名字（同一个账号必须唯一）', + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'OwnerAccountId' => [ + 'title' => '财务单元的属主用户', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1314839403940987', + ], + 'CostCenterId' => [ + 'title' => '财务单元ID', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '485938', + ], + 'ParentCostCenterId' => [ + 'title' => '父级财务单元ID', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '-1', + ], + ], + ], + ], + 'Metadata' => [ + 'title' => '返回结构元数据', + 'description' => '', + 'type' => 'any', + 'example' => '{}', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'C1BD134E-D914-6AE0-1901-AEB2A99FA205', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'CostCenter.MasterAndSubHasNoRelation', + 'errorMessage' => 'Your account has no valid account relation yet.', + ], + [ + 'errorCode' => 'CostCenter.UnitNameLengthExceed', + 'errorMessage' => 'The length of the financial unit name exceeds the maximum limit.', + ], + [ + 'errorCode' => 'CostCenter.UnitNotBelongToUser', + 'errorMessage' => 'Cost unit is not belong to this user.', + ], + [ + 'errorCode' => 'CostCenter.UnitNameExist', + 'errorMessage' => 'The financial unit name already exists.', + ], + [ + 'errorCode' => 'CostCenter.UnitNumberExceed', + 'errorMessage' => 'The maximum number of financial units has been exceeded.', + ], + [ + 'errorCode' => 'CostCenter.UnitNotExist', + 'errorMessage' => 'The financial unit does not exist or is invalid.', + ], + [ + 'errorCode' => 'CostCenter.UnitLevelExceed', + 'errorMessage' => 'The depth of the financial unit exceeds the maximum hierarchy level.', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified request contains invalid parameters.', + ], + [ + 'errorCode' => 'MissingParameter', + 'errorMessage' => 'The specified request lacks essential parameters.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"CostCenterDtoList\\": [\\n {\\n \\"CostCenterName\\": \\"资源组\\",\\n \\"OwnerAccountId\\": 1314839403940987,\\n \\"CostCenterId\\": 485938,\\n \\"ParentCostCenterId\\": -1\\n }\\n ],\\n \\"Metadata\\": \\"{}\\",\\n \\"RequestId\\": \\"C1BD134E-D914-6AE0-1901-AEB2A99FA205\\"\\n}","type":"json"}]', + ], + 'ModifyCostCenter' => [ + 'summary' => '修改财务单元', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'autoTest' => true, + ], + 'parameters' => [ + [ + 'name' => 'CostCenterEntityList', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '财务单元实体列表', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'CostCenterName' => [ + 'title' => '财务单元的新名字（同一个账号必须唯一）', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '', + ], + 'OwnerAccountId' => [ + 'title' => '财务单元的属主用户', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1314839403940987', + ], + 'CostCenterId' => [ + 'title' => '财务单元ID', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '485938', + ], + ], + 'required' => false, + ], + 'required' => true, + ], + ], + [ + 'name' => 'Nbid', + 'in' => 'query', + 'schema' => [ + 'title' => '一级售卖场ID，如果为空，默认使用当前用户所属的场ID填充', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '2684201000001', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'BssApiListResult<CostCenterOperateDto>', + 'description' => 'BssApiListResult<CostCenterOperateDto>', + 'type' => 'object', + 'properties' => [ + 'CostCenterOperateDto' => [ + 'title' => '数据列表', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'IsSuccess' => [ + 'title' => '是否成功', + 'description' => '', + 'type' => 'boolean', + 'example' => 'True', + ], + 'OwnerAccountId' => [ + 'title' => '财务单元的属主用户', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1314839403940987', + ], + 'CostCenterId' => [ + 'title' => '财务单元ID', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '485938', + ], + ], + ], + ], + 'Metadata' => [ + 'title' => '返回结构元数据', + 'description' => '', + 'type' => 'any', + 'example' => '{}', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '6000EE23-274B-4E07-A697-FF2E999520A4', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MissingParameter', + 'errorMessage' => 'The specified request lacks essential parameters.', + ], + [ + 'errorCode' => 'CostCenter.MasterAndSubHasNoRelation', + 'errorMessage' => 'Your account has no valid account relation yet.', + ], + [ + 'errorCode' => 'CostCenter.UnitNotBelongToUser', + 'errorMessage' => 'Cost unit is not belong to this user.', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified request contains invalid parameters.', + ], + [ + 'errorCode' => 'CostCenter.UnitNameLengthExceed', + 'errorMessage' => 'The length of the financial unit name exceeds the maximum limit.', + ], + [ + 'errorCode' => 'CostCenter.UnitNameExist', + 'errorMessage' => 'The financial unit name already exists.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"CostCenterOperateDto\\": [\\n {\\n \\"IsSuccess\\": true,\\n \\"OwnerAccountId\\": 1314839403940987,\\n \\"CostCenterId\\": 485938\\n }\\n ],\\n \\"Metadata\\": \\"{}\\",\\n \\"RequestId\\": \\"6000EE23-274B-4E07-A697-FF2E999520A4\\"\\n}","type":"json"}]', + ], + 'DeleteCostCenter' => [ + 'summary' => '删除财务单元', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'OwnerAccountId', + 'in' => 'query', + 'schema' => [ + 'title' => '财务单元的属主用户', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1314839403940987', + ], + ], + [ + 'name' => 'CostCenterId', + 'in' => 'query', + 'schema' => [ + 'title' => '财务单元ID', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '485938', + ], + ], + [ + 'name' => 'Nbid', + 'in' => 'query', + 'schema' => [ + 'title' => '一级售卖场ID，如果为空，默认使用当前用户所属的场ID填充', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '2684201000001', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'BssApiPlainResult<CostCenterOperateDto>', + 'description' => 'BssApiPlainResult<CostCenterOperateDto>', + 'type' => 'object', + 'properties' => [ + 'Metadata' => [ + 'title' => '返回结构元数据', + 'description' => '', + 'type' => 'any', + 'example' => '{}', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'C1BD134E-D914-6AE0-1901-AEB2A99FA205', + ], + 'OwnerAccountId' => [ + 'title' => '财务单元的属主用户', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1314839403940987', + ], + 'CostCenterId' => [ + 'title' => '财务单元ID', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '485938', + ], + 'IsSuccess' => [ + 'title' => '是否成功', + 'description' => '', + 'type' => 'boolean', + 'example' => 'True', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'CostCenter.DeleteWithShareRule', + 'errorMessage' => 'This financial unit involves splitting expense rules. Please adjust relevant rules before deleting the financial unit.', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified request contains invalid parameters.', + ], + [ + 'errorCode' => 'CostCenter.MasterAndSubHasNoRelation', + 'errorMessage' => 'Your account has no valid account relation yet.', + ], + [ + 'errorCode' => 'CostCenter.UnitNotExist', + 'errorMessage' => 'The financial unit does not exist or is invalid.', + ], + [ + 'errorCode' => 'CostCenter.DeleteWithSubUnitOrResource', + 'errorMessage' => 'Financial units with sub-units, allocated resources, or auto-allocation rules cannot be deleted.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Metadata\\": \\"{}\\",\\n \\"RequestId\\": \\"C1BD134E-D914-6AE0-1901-AEB2A99FA205\\",\\n \\"OwnerAccountId\\": 1314839403940987,\\n \\"CostCenterId\\": 485938,\\n \\"IsSuccess\\": true\\n}","type":"json"}]', + ], + 'QueryCostCenter' => [ + 'summary' => '查询财务单元', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'OwnerAccountId', + 'in' => 'query', + 'schema' => [ + 'title' => '财务单元的属主用户', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1314839403940987', + ], + ], + [ + 'name' => 'ParentCostCenterId', + 'in' => 'query', + 'schema' => [ + 'title' => '父财务单元 ID，-1 表示财务单元根。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '-1', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'title' => '当前页码', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'title' => '每页大小', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '20', + ], + ], + [ + 'name' => 'EcIdAccountIds', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '企业与账号列表，为空表示查询当前账号自身', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'AccountIds' => [ + 'title' => '访问的账号列表，为空代表全选当前实体ID下所有账号', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1501603440974415', + ], + 'required' => false, + 'maxItems' => 100, + ], + 'EcId' => [ + 'title' => '企业实体ID', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '1004064243473974', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + [ + 'name' => 'Nbid', + 'in' => 'query', + 'schema' => [ + 'title' => '一级售卖场ID，如果为空，默认使用当前用户所属的场ID填充', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '2684201000001', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'BssApiPageResult<CostCenterDto>', + 'description' => 'BssApiPageResult<CostCenterDto>', + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'title' => '当前页码', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'title' => '每页大小', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'TotalCount' => [ + 'title' => '总记录数', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + ], + 'CostCenterDtoList' => [ + 'title' => '数据列表', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'PrevCostCenterId' => [ + 'title' => '前序财务单元 ID', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '485996', + ], + 'CostCenterName' => [ + 'title' => '财务单元名字（同一个账号必须唯一）', + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'CostCenterCode' => [ + 'title' => '财务单元CODE', + 'description' => '', + 'type' => 'string', + 'example' => '15945703968#', + ], + 'Level' => [ + 'title' => '财务单元节点级数', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => 'loose', + ], + 'OwnerAccountId' => [ + 'title' => '财务单元的属主用户', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1314839403940987', + ], + 'CostCenterId' => [ + 'title' => '财务单元ID', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '485938', + ], + 'ParentCostCenterId' => [ + 'title' => '父级财务单元ID', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '-1', + ], + ], + ], + ], + 'Metadata' => [ + 'title' => '返回结构元数据', + 'description' => '', + 'type' => 'any', + 'example' => '{}', + ], + 'RequestId' => [ + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '79EE7556-0CFD-44EB-9CD6-B3B526E3A85F', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'CostCenter.MasterAndSubHasNoRelation', + 'errorMessage' => 'Your account has no valid account relation yet.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"CurrentPage\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 30,\\n \\"CostCenterDtoList\\": [\\n {\\n \\"PrevCostCenterId\\": 485996,\\n \\"CostCenterName\\": \\"资源组\\",\\n \\"CostCenterCode\\": \\"15945703968#\\",\\n \\"Level\\": 0,\\n \\"OwnerAccountId\\": 1314839403940987,\\n \\"CostCenterId\\": 485938,\\n \\"ParentCostCenterId\\": -1\\n }\\n ],\\n \\"Metadata\\": \\"{}\\",\\n \\"RequestId\\": \\"79EE7556-0CFD-44EB-9CD6-B3B526E3A85F\\"\\n}","type":"json"}]', + ], + 'QueryCostCenterResource' => [ + 'summary' => '查询财务单元下资源信息', + 'path' => '', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'OwnerAccountId', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1234567812345678', + 'title' => '账号ID', + ], + ], + [ + 'name' => 'CostCenterId', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '123456', + 'title' => '成本中心ID', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'title' => '下一个查询开始Token，NextToken为空说明没有下一个', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'CAESEgoQCg4KCmd', + ], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'title' => '单次查询的最大记录数', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '200', + ], + ], + [ + 'name' => 'EcIdAccountIds', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'title' => '企业与账号列表，为空表示查询当前账号自身', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'EcId' => [ + 'title' => '企业实体ID', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '1501603440974415', + ], + 'AccountIds' => [ + 'title' => '访问的账号列表，为空代表全选当前实体ID下所有账号', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1501603440974415', + 'title' => '账号id', + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + 'required' => false, + 'title' => '账号信息', + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + [ + 'name' => 'Nbid', + 'in' => 'query', + 'schema' => [ + 'title' => '一级售卖场ID，如果为空，默认使用当前用户所属的场ID填充', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '2684201000001', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '', + 'description' => 'BssApiTokenResult<CostCenterResourceDto>', + 'type' => 'object', + 'properties' => [ + 'NextToken' => [ + 'title' => '下一个查询开始Token，NextToken为空说明没有下一个', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'eyJwYWdlTnVtIjoyLCJwYWdlU2l6ZSI6MTB9', + ], + 'MaxResults' => [ + 'title' => '单次查询的最大记录数', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'TotalCount' => [ + 'title' => '总记录数', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2000', + ], + 'CostCenterResourceDtoList' => [ + 'title' => '数据列表', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'OwnerAccountId' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234567812345678', + 'title' => '资源归属账号id', + ], + 'OwnerAccountName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'XXX公司', + 'title' => '资源归属账号名称', + ], + 'ResourceUserId' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234567812345678', + 'title' => '分配资源账号id', + ], + 'ResourceUserName' => [ + 'description' => '', + 'type' => 'string', + 'example' => '[email protected]'."\n", + 'title' => '分配资源账号名称', + ], + 'RootCostCenterId' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '-1', + 'title' => '财务单元根节点id', + ], + 'CostCenterId' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123456', + 'title' => '财务单元id', + ], + 'ParentCostCenterId' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123456', + 'title' => '财务单元上级节点id', + ], + 'CostCenterCode' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'code', + 'title' => '财务单元code', + ], + 'CostCenterName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'test', + 'title' => '财务单元名称', + ], + 'CostCenterCreateTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2025-05-18 12:12:25', + 'title' => '财务单元创建时间', + ], + 'CostCenterUpdateTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2025-05-18 16:12:25', + 'title' => '财务单元修改时间', + ], + 'ResourceUpdateTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2025-05-18 16:12:25'."\n", + ], + 'PipCode' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'rds', + ], + 'PipName' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'CommodityCode' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'otsbag', + ], + 'CommodityName' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'ApportionItemCode' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'test', + ], + 'ApportionItemName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'test', + ], + 'ResourceId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'OSSBAG-cn-v0h1s4hma018'."\n", + ], + 'InstanceId' => [ + 'type' => 'string', + ], + 'ResourceType' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'FPT_ossbag_absolute_Storage_bj', + ], + 'ResourceTag' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'tag', + ], + 'ResourceNick' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'testResource', + ], + 'ResourceGroup' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'ResourceSource' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'MANUAL_ALLOCATE', + 'title' => '资源来源', + ], + 'RegionNo' => [ + 'title' => '地域', + 'type' => 'string', + 'example' => 'cn-shanghai', + ], + 'RegionName' => [ + 'title' => '地域名称', + 'type' => 'string', + 'example' => '上海', + ], + 'RecentBillingMonth' => [ + 'title' => '最近出账账期', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '202509', + ], + 'FinanceUnitRuleVersion' => [ + 'title' => '规则版本', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3', + ], + 'StartBillingMonth' => [ + 'title' => '规则生效账期', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '202509', + ], + 'ApplicablePeriodNum' => [ + 'title' => '刷新账期数量', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3', + ], + 'AddStrategy' => [ + 'title' => '添加策略', + 'type' => 'string', + 'example' => 'AUTO_ALLOCATE', + ], + 'AddStrategyName' => [ + 'title' => '添加策略名称', + 'type' => 'string', + 'example' => '自动分配', + ], + 'MasterCommodityCode' => [ + 'title' => '关联商品code', + 'type' => 'string', + 'example' => 'ecs', + ], + 'MasterInstanceId' => [ + 'title' => '关联实例ID', + 'type' => 'string', + 'example' => 'i-xxxxx', + ], + ], + 'title' => '', + ], + ], + 'Metadata' => [ + 'title' => '返回结构元数据', + 'description' => '', + 'type' => 'any', + 'example' => '{}', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '79EE7556-0CFD-44EB-9CD6-B3B526E3A85F', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'CostCenter.MasterAndSubHasNoRelation', + 'errorMessage' => 'Your account has no valid account relation yet.', + ], + [ + 'errorCode' => 'CostCenter.ResourceAuthFailed', + 'errorMessage' => 'The instance does not belong to the current user.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"NextToken\\": \\"eyJwYWdlTnVtIjoyLCJwYWdlU2l6ZSI6MTB9\\",\\n \\"MaxResults\\": 200,\\n \\"TotalCount\\": 2000,\\n \\"CostCenterResourceDtoList\\": [\\n {\\n \\"OwnerAccountId\\": 1234567812345678,\\n \\"OwnerAccountName\\": \\"客户A\\",\\n \\"ResourceUserId\\": 1234567812345678,\\n \\"ResourceUserName\\": \\"[email protected]\\\\n\\",\\n \\"RootCostCenterId\\": -1,\\n \\"CostCenterId\\": 123456,\\n \\"ParentCostCenterId\\": 123456,\\n \\"CostCenterCode\\": \\"code\\",\\n \\"CostCenterName\\": \\"test\\",\\n \\"CostCenterCreateTime\\": \\"2025-05-18 12:12:25\\",\\n \\"CostCenterUpdateTime\\": \\"2025-05-18 16:12:25\\",\\n \\"ResourceUpdateTime\\": \\"2025-05-18 16:12:25\\\\n\\",\\n \\"PipCode\\": \\"rds\\",\\n \\"PipName\\": \\"云数据库\\",\\n \\"CommodityCode\\": \\"otsbag\\",\\n \\"CommodityName\\": \\"云数据库\\",\\n \\"ApportionItemCode\\": \\"test\\",\\n \\"ApportionItemName\\": \\"test\\",\\n \\"ResourceId\\": \\"OSSBAG-cn-v0h1s4hma018\\\\n\\",\\n \\"InstanceId\\": \\"cn-hangzhou;standard\\",\\n \\"ResourceType\\": \\"FPT_ossbag_absolute_Storage_bj\\",\\n \\"ResourceTag\\": \\"tag\\",\\n \\"ResourceNick\\": \\"testResource\\",\\n \\"ResourceGroup\\": \\"默认资源组\\\\n\\",\\n \\"ResourceSource\\": \\"MANUAL_ALLOCATE\\",\\n \\"RegionNo\\": \\"cn-shanghai\\",\\n \\"RegionName\\": \\"上海\\",\\n \\"RecentBillingMonth\\": 202509,\\n \\"FinanceUnitRuleVersion\\": 3,\\n \\"StartBillingMonth\\": 202509,\\n \\"ApplicablePeriodNum\\": 3,\\n \\"AddStrategy\\": \\"AUTO_ALLOCATE\\",\\n \\"AddStrategyName\\": \\"自动分配\\",\\n \\"MasterCommodityCode\\": \\"ecs\\",\\n \\"MasterInstanceId\\": \\"i-xxxxx\\"\\n }\\n ],\\n \\"Metadata\\": \\"{}\\",\\n \\"RequestId\\": \\"79EE7556-0CFD-44EB-9CD6-B3B526E3A85F\\"\\n}","type":"json"}]', + ], + 'CreateCostCenterRule' => [ + 'summary' => '新建财务单元规则', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'CostCenterId', + 'in' => 'formData', + 'schema' => [ + 'title' => '财务单元ID', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '485938', + ], + ], + [ + 'name' => 'FilterExpression', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '规则表达式', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'ExpressionType' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'DIMENSION' => '', + 'TAG' => '', + 'NARY' => '', + ], + 'example' => 'NARY', + ], + 'OperatorType' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'OR' => 'OR', + 'AND' => 'AND', + ], + 'example' => 'AND', + ], + 'Operands' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'any', + 'required' => false, + 'example' => '{'."\n" + .' '."\n" + .' "Operands": ['."\n" + .' {'."\n" + .' "FilterValues": {'."\n" + .' "Code": "TAG-xxx",'."\n" + .' "Values": ['."\n" + .' "xxxx"'."\n" + .' ],'."\n" + .' "SelectType": "IN"'."\n" + .' },'."\n" + .' "ExpressionType": "TAG"'."\n" + .' },'."\n" + .' {'."\n" + .' "FilterValues": {'."\n" + .' "Code": "INSTANCE_ID",'."\n" + .' "Values": ['."\n" + .' "xxxxx"'."\n" + .' ],'."\n" + .' "SelectType": "LIKE"'."\n" + .' },'."\n" + .' "ExpressionType": "DIMENSION"'."\n" + .' },'."\n" + .' {'."\n" + .' "FilterValues": {'."\n" + .' "Code": "INSTANCE_NICK",'."\n" + .' "Values": ['."\n" + .' "111"'."\n" + .' ],'."\n" + .' "SelectType": "LIKE"'."\n" + .' },'."\n" + .' "ExpressionType": "DIMENSION"'."\n" + .' },'."\n" + .' {'."\n" + .' "FilterValues": {'."\n" + .' "Code": "RESOURCE_GROUP",'."\n" + .' "Values": ['."\n" + .' "xxxxx"'."\n" + .' ],'."\n" + .' "SelectType": "IN"'."\n" + .' },'."\n" + .' "ExpressionType": "DIMENSION"'."\n" + .' },'."\n" + .' {'."\n" + .' "FilterValues": {'."\n" + .' "Code": "ARTICLE",'."\n" + .' "Values": ['."\n" + .' "xxxxx"'."\n" + .' ],'."\n" + .' "SelectType": "IN"'."\n" + .' },'."\n" + .' "ExpressionType": "DIMENSION"'."\n" + .' },'."\n" + .' {'."\n" + .' "FilterValues": {'."\n" + .' "Code": "PRODUCT",'."\n" + .' "Values": ['."\n" + .' "xxxxx"'."\n" + .' ],'."\n" + .' "SelectType": "IN"'."\n" + .' },'."\n" + .' "ExpressionType": "DIMENSION"'."\n" + .' },'."\n" + .' {'."\n" + .' "FilterValues": {'."\n" + .' "Code": "OWNER",'."\n" + .' "Values": ['."\n" + .' "xxxxx"'."\n" + .' ],'."\n" + .' "SelectType": "IN"'."\n" + .' },'."\n" + .' "ExpressionType": "DIMENSION"'."\n" + .' }'."\n" + .' ]'."\n" + .' }', + ], + 'required' => false, + ], + 'Operand' => [ + 'description' => '', + 'type' => 'any', + 'required' => false, + 'example' => '', + ], + 'FilterValues' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'OWNER' => '', + 'ARTICLE' => '', + 'RESOURCE_GROUP' => '', + 'xxx（用户自定义标签key）' => '', + 'PRODUCT' => '', + 'INSTANCE_NICK' => '', + 'INSTANCE_ID' => '', + ], + 'example' => 'TAG-test-xxx-key', + ], + 'CodeName' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '', + ], + 'Values' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '["TAG-test-xxx"]'."\n", + ], + 'required' => false, + ], + 'SelectType' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'LIKE' => '', + 'IN' => '', + ], + 'example' => 'IN', + ], + ], + 'required' => false, + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'Nbid', + 'in' => 'query', + 'schema' => [ + 'title' => '一级售卖场ID，如果为空，默认使用当前用户所属的场ID填充', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '2084210001', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'BssApiPlainResult<Long>', + 'description' => 'BssApiPlainResult<Long>', + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1111', + ], + 'Metadata' => [ + 'title' => '返回结构元数据', + 'description' => '', + 'type' => 'any', + 'example' => '{}', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '79EE7556-0CFD-44EB-9CD6-B3B526E3A85F', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'CostCenter.MasterAndSubHasNoRelation', + 'errorMessage' => 'Your account has no valid account relation yet.', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified request contains invalid parameters.', + ], + [ + 'errorCode' => 'CostCenter.RuleExpressionIllegal', + 'errorMessage' => 'The auto-allocation rule configuration is invalid.', + ], + [ + 'errorCode' => 'CostCenter.UnitNotExist', + 'errorMessage' => 'The financial unit does not exist or is invalid.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": 1111,\\n \\"Metadata\\": \\"{}\\",\\n \\"RequestId\\": \\"79EE7556-0CFD-44EB-9CD6-B3B526E3A85F\\"\\n}","type":"json"}]', + ], + 'ModifyCostCenterRule' => [ + 'summary' => '修改财务单元规则', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'OwnerAccountId', + 'in' => 'formData', + 'schema' => [ + 'title' => '财务单元的属主用户', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1234567812345678', + ], + ], + [ + 'name' => 'CostCenterId', + 'in' => 'formData', + 'schema' => [ + 'title' => '财务单元ID', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '485938', + ], + ], + [ + 'name' => 'FilterExpression', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '规则表达式', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'ExpressionType' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'DIMENSION' => '', + 'TAG' => '', + 'NARY' => '', + ], + 'example' => 'NARY', + ], + 'OperatorType' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'OR' => 'OR', + 'AND' => 'AND', + ], + 'example' => 'AND', + ], + 'Operands' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'any', + 'required' => false, + 'example' => '{'."\n" + .' '."\n" + .' "Operands": ['."\n" + .' {'."\n" + .' "FilterValues": {'."\n" + .' "Code": "TAG-xxx",'."\n" + .' "Values": ['."\n" + .' "xxxx"'."\n" + .' ],'."\n" + .' "SelectType": "IN"'."\n" + .' },'."\n" + .' "ExpressionType": "TAG"'."\n" + .' },'."\n" + .' {'."\n" + .' "FilterValues": {'."\n" + .' "Code": "INSTANCE_ID",'."\n" + .' "Values": ['."\n" + .' "xxxxx"'."\n" + .' ],'."\n" + .' "SelectType": "LIKE"'."\n" + .' },'."\n" + .' "ExpressionType": "DIMENSION"'."\n" + .' },'."\n" + .' {'."\n" + .' "FilterValues": {'."\n" + .' "Code": "INSTANCE_NICK",'."\n" + .' "Values": ['."\n" + .' "111"'."\n" + .' ],'."\n" + .' "SelectType": "LIKE"'."\n" + .' },'."\n" + .' "ExpressionType": "DIMENSION"'."\n" + .' },'."\n" + .' {'."\n" + .' "FilterValues": {'."\n" + .' "Code": "RESOURCE_GROUP",'."\n" + .' "Values": ['."\n" + .' "xxxxx"'."\n" + .' ],'."\n" + .' "SelectType": "IN"'."\n" + .' },'."\n" + .' "ExpressionType": "DIMENSION"'."\n" + .' },'."\n" + .' {'."\n" + .' "FilterValues": {'."\n" + .' "Code": "ARTICLE",'."\n" + .' "Values": ['."\n" + .' "xxxxx"'."\n" + .' ],'."\n" + .' "SelectType": "IN"'."\n" + .' },'."\n" + .' "ExpressionType": "DIMENSION"'."\n" + .' },'."\n" + .' {'."\n" + .' "FilterValues": {'."\n" + .' "Code": "PRODUCT",'."\n" + .' "Values": ['."\n" + .' "xxxxx"'."\n" + .' ],'."\n" + .' "SelectType": "IN"'."\n" + .' },'."\n" + .' "ExpressionType": "DIMENSION"'."\n" + .' },'."\n" + .' {'."\n" + .' "FilterValues": {'."\n" + .' "Code": "OWNER",'."\n" + .' "Values": ['."\n" + .' "xxxxx"'."\n" + .' ],'."\n" + .' "SelectType": "IN"'."\n" + .' },'."\n" + .' "ExpressionType": "DIMENSION"'."\n" + .' }'."\n" + .' ]'."\n" + .' }', + ], + 'required' => false, + ], + 'Operand' => [ + 'description' => '', + 'type' => 'any', + 'required' => false, + 'example' => '', + ], + 'FilterValues' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'OWNER' => '', + 'ARTICLE' => '', + 'RESOURCE_GROUP' => '', + 'xxx（用户自定义标签key）' => '', + 'PRODUCT' => '', + 'INSTANCE_NICK' => '', + 'INSTANCE_ID' => '', + ], + 'example' => 'TAG-test-xxx-key', + ], + 'CodeName' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '', + ], + 'Values' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '["TAG-test-xxx"]'."\n", + ], + 'required' => false, + ], + 'SelectType' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'LIKE' => '', + 'IN' => '', + ], + 'example' => 'IN', + ], + ], + 'required' => false, + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'Nbid', + 'in' => 'query', + 'schema' => [ + 'title' => '一级售卖场ID，如果为空，默认使用当前用户所属的场ID填充', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '2684201000001', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'BssApiPlainResult<Long>', + 'description' => 'BssApiPlainResult<Long>', + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '5632', + ], + 'Metadata' => [ + 'title' => '返回结构元数据', + 'description' => '', + 'type' => 'any', + 'example' => '{}', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '6000EE23-274B-4E07-A697-FF2E999520A4', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'CostCenter.MasterAndSubHasNoRelation', + 'errorMessage' => 'Your account has no valid account relation yet.', + ], + [ + 'errorCode' => 'CostCenter.RuleExpressionIllegal', + 'errorMessage' => 'The auto-allocation rule configuration is invalid.', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified request contains invalid parameters.', + ], + [ + 'errorCode' => 'CostCenter.UnitNotExist', + 'errorMessage' => 'The financial unit does not exist or is invalid.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": 5632,\\n \\"Metadata\\": \\"{}\\",\\n \\"RequestId\\": \\"6000EE23-274B-4E07-A697-FF2E999520A4\\"\\n}","type":"json"}]', + ], + 'DeleteCostCenterRule' => [ + 'summary' => '删除财务单元规则', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'CostCenterId', + 'in' => 'formData', + 'schema' => [ + 'title' => '财务单元ID', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '637127', + ], + ], + [ + 'name' => 'FilterExpression', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '规则表达式', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'ExpressionType' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'DIMENSION' => '', + 'TAG' => '', + 'NARY' => '', + ], + 'example' => 'NARY', + ], + 'OperatorType' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'AND', + ], + 'Operands' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'any', + 'required' => false, + 'example' => '{'."\n" + .' '."\n" + .' "Operands": ['."\n" + .' {'."\n" + .' "FilterValues": {'."\n" + .' "Code": "TAG-xxx",'."\n" + .' "Values": ['."\n" + .' "xxxx"'."\n" + .' ],'."\n" + .' "SelectType": "IN"'."\n" + .' },'."\n" + .' "ExpressionType": "TAG"'."\n" + .' },'."\n" + .' {'."\n" + .' "FilterValues": {'."\n" + .' "Code": "INSTANCE_ID",'."\n" + .' "Values": ['."\n" + .' "xxxxx"'."\n" + .' ],'."\n" + .' "SelectType": "LIKE"'."\n" + .' },'."\n" + .' "ExpressionType": "DIMENSION"'."\n" + .' },'."\n" + .' {'."\n" + .' "FilterValues": {'."\n" + .' "Code": "INSTANCE_NICK",'."\n" + .' "Values": ['."\n" + .' "111"'."\n" + .' ],'."\n" + .' "SelectType": "LIKE"'."\n" + .' },'."\n" + .' "ExpressionType": "DIMENSION"'."\n" + .' },'."\n" + .' {'."\n" + .' "FilterValues": {'."\n" + .' "Code": "RESOURCE_GROUP",'."\n" + .' "Values": ['."\n" + .' "xxxxx"'."\n" + .' ],'."\n" + .' "SelectType": "IN"'."\n" + .' },'."\n" + .' "ExpressionType": "DIMENSION"'."\n" + .' },'."\n" + .' {'."\n" + .' "FilterValues": {'."\n" + .' "Code": "ARTICLE",'."\n" + .' "Values": ['."\n" + .' "xxxxx"'."\n" + .' ],'."\n" + .' "SelectType": "IN"'."\n" + .' },'."\n" + .' "ExpressionType": "DIMENSION"'."\n" + .' },'."\n" + .' {'."\n" + .' "FilterValues": {'."\n" + .' "Code": "PRODUCT",'."\n" + .' "Values": ['."\n" + .' "xxxxx"'."\n" + .' ],'."\n" + .' "SelectType": "IN"'."\n" + .' },'."\n" + .' "ExpressionType": "DIMENSION"'."\n" + .' },'."\n" + .' {'."\n" + .' "FilterValues": {'."\n" + .' "Code": "OWNER",'."\n" + .' "Values": ['."\n" + .' "xxxxx"'."\n" + .' ],'."\n" + .' "SelectType": "IN"'."\n" + .' },'."\n" + .' "ExpressionType": "DIMENSION"'."\n" + .' }'."\n" + .' ]'."\n" + .' }', + ], + 'required' => false, + ], + 'Operand' => [ + 'description' => '', + 'type' => 'any', + 'required' => false, + 'example' => '', + ], + 'FilterValues' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'OWNER' => '', + 'ARTICLE' => '', + 'RESOURCE_GROUP' => '', + 'xxx（用户自定义标签key）' => '', + 'PRODUCT' => '', + 'INSTANCE_NICK' => '', + 'INSTANCE_ID' => '', + ], + 'example' => 'TAG-test-xxx-key'."\n", + ], + 'CodeName' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '', + ], + 'Values' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '["TAG-test-xxx"]'."\n", + ], + 'required' => false, + ], + 'SelectType' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'LIKE' => '', + 'IN' => '', + ], + 'example' => 'IN', + ], + ], + 'required' => false, + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'Nbid', + 'in' => 'query', + 'schema' => [ + 'title' => '一级售卖场ID，如果为空，默认使用当前用户所属的场ID填充', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '2684201000001', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'BssApiPlainResult<Long>', + 'description' => 'BssApiPlainResult<Long>', + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '37404', + ], + 'Metadata' => [ + 'title' => '返回结构元数据', + 'description' => '', + 'type' => 'any', + 'example' => '{}', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'UUID', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'CostCenter.MasterAndSubHasNoRelation', + 'errorMessage' => 'Your account has no valid account relation yet.', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified request contains invalid parameters.', + ], + [ + 'errorCode' => 'CostCenter.UnitNotExist', + 'errorMessage' => 'The financial unit does not exist or is invalid.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": 37404,\\n \\"Metadata\\": \\"{}\\",\\n \\"RequestId\\": \\"UUID\\"\\n}","type":"json"}]', + ], + 'QueryCostCenterRule' => [ + 'summary' => '查询财务单元规则', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'CostCenterId', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '597745', + ], + ], + [ + 'name' => 'EcIdAccountIds', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'title' => '企业与账号列表，为空表示查询当前账号自身', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'AccountIds' => [ + 'title' => '访问的账号列表，为空代表全选当前实体ID下所有账号', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1990699401005016', + ], + 'required' => false, + 'maxItems' => 100, + ], + 'EcId' => [ + 'title' => '企业实体ID', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '1004064243473974', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + [ + 'name' => 'Nbid', + 'in' => 'query', + 'schema' => [ + 'title' => '一级售卖场ID，如果为空，默认使用当前用户所属的场ID填充', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '2684201000001', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'BssApiPlainResult<CostCenterRuleDto>', + 'description' => 'BssApiPlainResult<CostCenterRuleDto>', + 'type' => 'object', + 'properties' => [ + 'Metadata' => [ + 'title' => '返回结构元数据', + 'description' => '', + 'type' => 'any', + 'example' => '{}', + ], + 'RequestId' => [ + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => 'UUID', + ], + 'OwnerAccountId' => [ + 'title' => '财务单元的属主用户', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1977800748053695', + ], + 'RootCostCenterId' => [ + 'title' => '根财务单元ID', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'CostCenterId' => [ + 'title' => '财务单元ID', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '597745', + ], + 'Id' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '32048', + ], + 'FilterExpression' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'ExpressionType' => [ + 'description' => '', + 'type' => 'string', + 'enumValueTitles' => [ + 'DIMENSION' => '', + 'TAG' => '', + 'NARY' => '', + ], + 'example' => 'NARY', + ], + 'OperatorType' => [ + 'description' => '', + 'type' => 'string', + 'enumValueTitles' => [ + 'OR' => 'OR', + 'AND' => 'AND', + ], + 'example' => 'AND', + ], + 'Operands' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'any', + 'example' => '{'."\n" + .' '."\n" + .' "Operands": ['."\n" + .' {'."\n" + .' "FilterValues": {'."\n" + .' "Code": "TAG-xxx",'."\n" + .' "Values": ['."\n" + .' "xxxx"'."\n" + .' ],'."\n" + .' "SelectType": "IN"'."\n" + .' },'."\n" + .' "ExpressionType": "TAG"'."\n" + .' },'."\n" + .' {'."\n" + .' "FilterValues": {'."\n" + .' "Code": "INSTANCE_ID",'."\n" + .' "Values": ['."\n" + .' "xxxxx"'."\n" + .' ],'."\n" + .' "SelectType": "LIKE"'."\n" + .' },'."\n" + .' "ExpressionType": "DIMENSION"'."\n" + .' },'."\n" + .' {'."\n" + .' "FilterValues": {'."\n" + .' "Code": "INSTANCE_NICK",'."\n" + .' "Values": ['."\n" + .' "111"'."\n" + .' ],'."\n" + .' "SelectType": "LIKE"'."\n" + .' },'."\n" + .' "ExpressionType": "DIMENSION"'."\n" + .' },'."\n" + .' {'."\n" + .' "FilterValues": {'."\n" + .' "Code": "RESOURCE_GROUP",'."\n" + .' "Values": ['."\n" + .' "xxxxx"'."\n" + .' ],'."\n" + .' "SelectType": "IN"'."\n" + .' },'."\n" + .' "ExpressionType": "DIMENSION"'."\n" + .' },'."\n" + .' {'."\n" + .' "FilterValues": {'."\n" + .' "Code": "ARTICLE",'."\n" + .' "Values": ['."\n" + .' "xxxxx"'."\n" + .' ],'."\n" + .' "SelectType": "IN"'."\n" + .' },'."\n" + .' "ExpressionType": "DIMENSION"'."\n" + .' },'."\n" + .' {'."\n" + .' "FilterValues": {'."\n" + .' "Code": "PRODUCT",'."\n" + .' "Values": ['."\n" + .' "xxxxx"'."\n" + .' ],'."\n" + .' "SelectType": "IN"'."\n" + .' },'."\n" + .' "ExpressionType": "DIMENSION"'."\n" + .' },'."\n" + .' {'."\n" + .' "FilterValues": {'."\n" + .' "Code": "OWNER",'."\n" + .' "Values": ['."\n" + .' "xxxxx"'."\n" + .' ],'."\n" + .' "SelectType": "IN"'."\n" + .' },'."\n" + .' "ExpressionType": "DIMENSION"'."\n" + .' }'."\n" + .' ]'."\n" + .' }', + ], + ], + 'Operand' => [ + 'description' => '', + 'type' => 'any', + 'example' => '', + ], + 'FilterValues' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'enumValueTitles' => [ + 'OWNER' => '', + 'ARTICLE' => '', + 'RESOURCE_GROUP' => '', + 'xxx（用户自定义标签key）' => '', + 'PRODUCT' => '', + 'INSTANCE_NICK' => '', + 'INSTANCE_ID' => '', + ], + 'example' => 'TAG-test-xxx-key'."\n", + ], + 'CodeName' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'Values' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'example' => '["TAG-test-xxx"]'."\n", + ], + ], + 'SelectType' => [ + 'description' => '', + 'type' => 'string', + 'enumValueTitles' => [ + 'LIKE' => '', + 'IN' => '', + ], + 'example' => 'IN', + ], + ], + ], + ], + ], + 'Status' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'on', + ], + 'IsDeleted' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => 'false', + ], + 'GmtCreate' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Tue Nov 12 14:49:43 CST 2024', + ], + 'GmtModified' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Wed Oct 16 10:15:37 CST 2024', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'CostCenter.MasterAndSubHasNoRelation', + 'errorMessage' => 'Your account has no valid account relation yet.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Metadata\\": \\"{}\\",\\n \\"RequestId\\": \\"UUID\\",\\n \\"OwnerAccountId\\": 1977800748053695,\\n \\"RootCostCenterId\\": 0,\\n \\"CostCenterId\\": 597745,\\n \\"Id\\": 32048,\\n \\"FilterExpression\\": {\\n \\"ExpressionType\\": \\"NARY\\",\\n \\"OperatorType\\": \\"AND\\",\\n \\"Operands\\": [\\n \\"{\\\\n \\\\n \\\\\\"Operands\\\\\\": [\\\\n {\\\\n \\\\\\"FilterValues\\\\\\": {\\\\n \\\\\\"Code\\\\\\": \\\\\\"TAG-xxx\\\\\\",\\\\n \\\\\\"Values\\\\\\": [\\\\n \\\\\\"xxxx\\\\\\"\\\\n ],\\\\n \\\\\\"SelectType\\\\\\": \\\\\\"IN\\\\\\"\\\\n },\\\\n \\\\\\"ExpressionType\\\\\\": \\\\\\"TAG\\\\\\"\\\\n },\\\\n {\\\\n \\\\\\"FilterValues\\\\\\": {\\\\n \\\\\\"Code\\\\\\": \\\\\\"INSTANCE_ID\\\\\\",\\\\n \\\\\\"Values\\\\\\": [\\\\n \\\\\\"xxxxx\\\\\\"\\\\n ],\\\\n \\\\\\"SelectType\\\\\\": \\\\\\"LIKE\\\\\\"\\\\n },\\\\n \\\\\\"ExpressionType\\\\\\": \\\\\\"DIMENSION\\\\\\"\\\\n },\\\\n {\\\\n \\\\\\"FilterValues\\\\\\": {\\\\n \\\\\\"Code\\\\\\": \\\\\\"INSTANCE_NICK\\\\\\",\\\\n \\\\\\"Values\\\\\\": [\\\\n \\\\\\"111\\\\\\"\\\\n ],\\\\n \\\\\\"SelectType\\\\\\": \\\\\\"LIKE\\\\\\"\\\\n },\\\\n \\\\\\"ExpressionType\\\\\\": \\\\\\"DIMENSION\\\\\\"\\\\n },\\\\n {\\\\n \\\\\\"FilterValues\\\\\\": {\\\\n \\\\\\"Code\\\\\\": \\\\\\"RESOURCE_GROUP\\\\\\",\\\\n \\\\\\"Values\\\\\\": [\\\\n \\\\\\"xxxxx\\\\\\"\\\\n ],\\\\n \\\\\\"SelectType\\\\\\": \\\\\\"IN\\\\\\"\\\\n },\\\\n \\\\\\"ExpressionType\\\\\\": \\\\\\"DIMENSION\\\\\\"\\\\n },\\\\n {\\\\n \\\\\\"FilterValues\\\\\\": {\\\\n \\\\\\"Code\\\\\\": \\\\\\"ARTICLE\\\\\\",\\\\n \\\\\\"Values\\\\\\": [\\\\n \\\\\\"xxxxx\\\\\\"\\\\n ],\\\\n \\\\\\"SelectType\\\\\\": \\\\\\"IN\\\\\\"\\\\n },\\\\n \\\\\\"ExpressionType\\\\\\": \\\\\\"DIMENSION\\\\\\"\\\\n },\\\\n {\\\\n \\\\\\"FilterValues\\\\\\": {\\\\n \\\\\\"Code\\\\\\": \\\\\\"PRODUCT\\\\\\",\\\\n \\\\\\"Values\\\\\\": [\\\\n \\\\\\"xxxxx\\\\\\"\\\\n ],\\\\n \\\\\\"SelectType\\\\\\": \\\\\\"IN\\\\\\"\\\\n },\\\\n \\\\\\"ExpressionType\\\\\\": \\\\\\"DIMENSION\\\\\\"\\\\n },\\\\n {\\\\n \\\\\\"FilterValues\\\\\\": {\\\\n \\\\\\"Code\\\\\\": \\\\\\"OWNER\\\\\\",\\\\n \\\\\\"Values\\\\\\": [\\\\n \\\\\\"xxxxx\\\\\\"\\\\n ],\\\\n \\\\\\"SelectType\\\\\\": \\\\\\"IN\\\\\\"\\\\n },\\\\n \\\\\\"ExpressionType\\\\\\": \\\\\\"DIMENSION\\\\\\"\\\\n }\\\\n ]\\\\n }\\"\\n ],\\n \\"Operand\\": \\"无\\",\\n \\"FilterValues\\": {\\n \\"Code\\": \\"TAG-test-xxx-key\\\\n\\",\\n \\"CodeName\\": \\"无\\",\\n \\"Values\\": [\\n \\"[\\\\\\"TAG-test-xxx\\\\\\"]\\\\n\\"\\n ],\\n \\"SelectType\\": \\"IN\\"\\n }\\n },\\n \\"Status\\": \\"on\\",\\n \\"IsDeleted\\": 0,\\n \\"GmtCreate\\": \\"Tue Nov 12 14:49:43 CST 2024\\",\\n \\"GmtModified\\": \\"Wed Oct 16 10:15:37 CST 2024\\"\\n}","type":"json"}]', + ], + 'AllocateCostCenterResource' => [ + 'summary' => '财务单元实例重分配', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'FromOwnerAccountId', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1529600453335198', + ], + ], + [ + 'name' => 'FromCostCenterId', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '637180', + ], + ], + [ + 'name' => 'ToCostCenterId', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '638288', + ], + ], + [ + 'name' => 'ResourceInstanceList', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'ResourceUserId' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '273394581313325532', + ], + 'InstanceId' => [ + 'type' => 'string', + ], + 'ResourceType' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'SCU', + ], + 'PipCode' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'ecs', + ], + 'ResourceNick' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'ecs-test-1', + ], + 'ApportionCode' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'qwer1-cn-beijing', + ], + 'ResourceTag' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'tag-test1', + ], + 'RelatedResources' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'related-resource', + ], + 'ApportionName' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'split-item-test1', + ], + 'ResourceId' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou;standard', + ], + 'ResourceSource' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'AUTO_ALLOCATE', + ], + 'CommodityCode' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'oss', + ], + 'ResourceStatus' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '0', + ], + 'ResourceUserName' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + 'CommodityName' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'RESOURCE_UDR', + ], + 'ResourceGroup' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'xihe_mpp', + ], + ], + 'required' => false, + ], + 'required' => true, + ], + ], + [ + 'name' => 'Nbid', + 'in' => 'query', + 'schema' => [ + 'title' => '一级售卖场ID，如果为空，默认使用当前用户所属的场ID填充', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '2684201000001', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'BssApiPlainResult<CostCenterOperateDto>', + 'description' => 'BssApiPlainResult<CostCenterOperateDto>', + 'type' => 'object', + 'properties' => [ + 'Metadata' => [ + 'title' => '返回结构元数据', + 'description' => '', + 'type' => 'any', + 'example' => '{}', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'UUID', + ], + 'OwnerAccountId' => [ + 'title' => '财务单元的属主用户', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1529600453335198', + ], + 'CostCenterId' => [ + 'title' => '财务单元ID', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '640403', + ], + 'IsSuccess' => [ + 'title' => '是否成功', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'CostCenter.MasterAndSubHasNoRelation', + 'errorMessage' => 'Your account has no valid account relation yet.', + ], + [ + 'errorCode' => 'CostCenter.ResourceAuthFailed', + 'errorMessage' => 'The instance does not belong to the current user.', + ], + [ + 'errorCode' => 'CostCenter.ResourceNotExist', + 'errorMessage' => 'The specified instance is not found in our records.', + ], + [ + 'errorCode' => 'CostCenter.AllocateResourceRepeat', + 'errorMessage' => 'The instance has already been assigned a financial unit. Use transfer allocation for adjustment.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Metadata\\": \\"{}\\",\\n \\"RequestId\\": \\"UUID\\",\\n \\"OwnerAccountId\\": 1529600453335198,\\n \\"CostCenterId\\": 640403,\\n \\"IsSuccess\\": true\\n}","type":"json"}]', + ], + ], + 'endpoints' => [ + [ + 'regionId' => 'cn-qingdao', + 'endpoint' => 'business.aliyuncs.com', + ], + [ + 'regionId' => 'cn-beijing', + 'endpoint' => 'business.aliyuncs.com', + ], + [ + 'regionId' => 'cn-zhangjiakou', + 'endpoint' => 'business.aliyuncs.com', + ], + [ + 'regionId' => 'cn-huhehaote', + 'endpoint' => 'business.aliyuncs.com', + ], + [ + 'regionId' => 'cn-wulanchabu', + 'endpoint' => 'business.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hangzhou', + 'endpoint' => 'business.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shanghai', + 'endpoint' => 'business.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shenzhen', + 'endpoint' => 'business.aliyuncs.com', + ], + [ + 'regionId' => 'cn-chengdu', + 'endpoint' => 'business.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hongkong', + 'endpoint' => 'business.aliyuncs.com', + ], + [ + 'regionId' => 'ap-northeast-1', + 'endpoint' => 'business.ap-southeast-1.aliyuncs.com', + ], + [ + 'regionId' => 'ap-northeast-2', + 'endpoint' => 'business.ap-southeast-1.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-1', + 'endpoint' => 'business.ap-southeast-1.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-3', + 'endpoint' => 'business.ap-southeast-1.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-5', + 'endpoint' => 'business.ap-southeast-1.aliyuncs.com', + ], + [ + 'regionId' => 'us-east-1', + 'endpoint' => 'business.ap-southeast-1.aliyuncs.com', + ], + [ + 'regionId' => 'us-west-1', + 'endpoint' => 'business.ap-southeast-1.aliyuncs.com', + ], + [ + 'regionId' => 'eu-west-1', + 'endpoint' => 'business.ap-southeast-1.aliyuncs.com', + ], + [ + 'regionId' => 'eu-central-1', + 'endpoint' => 'business.ap-southeast-1.aliyuncs.com', + ], + [ + 'regionId' => 'ap-south-1', + 'endpoint' => 'business.ap-southeast-1.aliyuncs.com', + ], + [ + 'regionId' => 'me-east-1', + 'endpoint' => 'business.ap-southeast-1.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hangzhou-finance', + 'endpoint' => 'business.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shanghai-finance-1', + 'endpoint' => 'business.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shenzhen-finance-1', + 'endpoint' => 'business.aliyuncs.com', + ], + [ + 'regionId' => 'cn-beijing-finance-1', + 'endpoint' => 'business.aliyuncs.com', + ], + ], +]; |