跳至主要内容
Adaptive Planning
上次更新时间 :2023-06-23
账户

账户

版本:v1

支持的 HTTP VERB

HTTP 谓词
描述
POST
删除请求中提及的账户。

发布:

请求:
/removeGLAccounts:
删除给定总分类账账户代码对应的账户。
此端点位于“
ENable_ACCOUNTS_DELETION_JSON_API
”(当前默认为开启)功能标志后面。
支持可在用户界面中删除的所有总分类账账户。忽略无法删除的账户。
请求 URI 示例:
https://api.adaptiveplanning.com/api/rest/modeling/v1/globosales/accounts/removeGLAccounts
请求标头示例:
授权:基本
Content-Type: application/json
请求正文示例
POST 请求示例
[ { "accountCodesToDelete": ["Assets", "b"] } ]
负载参数
名称
描述
必填
accountCodesToDelete
要删除的账户代码名称
路径参数
名称
描述
必填
租户
要操作的租户。例如 globosales
查询参数
名称
描述
必填
forceRemove
当forceRemove=true 时删除正在使用的账户,当forceRemove=false 时忽略正在使用的账户。
默认值始终为forceRemove=false。
instanceCode
要从中检索值的 instanceCode。例如,GLOBO。如果未指定 instanceCode,则使用用户的默认实例。
示例回复:
204 无内容
成功响应为空,状态代码为 204。
400 错误请求
服务器无法识别该请求。
401 未授权
用户未获授权。
403 禁止访问
用户权限不足。
500 内部服务器错误
内部服务器错误。

发布:

请求:
/removeAccounts
删除给定总分类账账户代码对应的账户。
此端点启用了“
ENable_ACCOUNTS_DELETION_JSON_API_2
”功能标志(当前默认为“关闭”)。
支持可在用户界面中删除的所有账户。忽略无法删除的账户,并提供可选的警告信息。
请求 URI 示例:
https://api.adaptiveplanning.com/api/rest/modeling/v1/globosales/accounts/removeAccounts
请求标头示例:
授权:基本
Content-Type: application/json
请求正文示例
POST 请求示例
{ "accountCodesToDelete": ["Assets", "b"] }
负载参数
名称
描述
必填
accountCodesToDelete
要删除的账户代码名称
路径参数
名称
描述
必填
租户
要操作的租户。例如 globosales
查询参数
名称
描述
默认
必填
forceRemove
删除正在使用的账户。
false
ShowWarnings
在回复中显示警告。
false
doValidateOnly
启用验证模式。
false
警告
account-deletion-warning=某些帐户未删除。
warning-default-root=无法删除默认根账户。
warning-sheet-root=无法删除工作表根组。
warning-cta-account=无法删除累计折算调整账户。
warning-in-use=无法删除正在使用的账户,因为forceRemove 已设置为“关闭”。
warning-cannot_delete_mi_system_account=无法删除少数股东权益系统账户。该账户可用于为完整合并方法计算少数股东权益。
warning-cannot_delete_mi_net_venue_account=无法删除少数股东权益净利润账户。该账户可用于为完整合并方法计算少数股东权益。
warning-cannot_delete_mi_account_ancestor=无法删除该账户,因为该账户的一个后代账户用于“完整合并”方法的少数股东权益计算。
warning-delete_Child_used_in_breakback-msg=无法删除此账户,因为此账户或其某个后代账户已用于自动摊回。
warning-cannot_delete_pcm_account=请使用 Planning Configuration Manager 删除此账户。
warning-nonexistent-code=此账户不存在。
Warning-Am采格-code=此代码由多个账户共享。
示例回复:
200 OK
{ "total": 0 }
200 正常(有警告)
{ "total": 0, "warning": { "info": "Some accounts were not deleted.", "warnings": [ { "field": "xyz", "warning": "This account does not exist." } ] } }
400 错误请求
服务器无法识别该请求。
401 未授权
用户未获授权。
403 禁止访问
用户权限不足/功能标志为“关闭”。
{ "error": "Service Unavailable" }
500 内部服务器错误
内部服务器错误。