科目
バージョン: v1
サポートされている HTTP VERB
HTTP Verb | 説明 |
|---|---|
POST
| リクエストに記載された科目を削除する。 |
POST:
- リクエスト:
- /removeGLAccounts:指定された GL 科目コードの科目を削除します。このエンドポイントは "ENable_ACCOUNTS_DELATION_JSON_API" (現在はデフォルトでオン) 機能フラグの背後にあります。UI で削除できるすべての GL 科目をサポートします。削除できない科目は無視されます。リクエスト URI の例:https://api.adaptiveplanning.com/api/rest/modeling/v1/globosales/accounts/removeGLAccountsリクエスト ヘッダーの例:認証: 基本コンテンツ タイプ: application/json
- リクエスト本文の例
- POST リクエストの例[ { "accountCodesToDelete": ["Assets", "b"] } ]ペイロード パラメータ名前説明必須accountCodesToDelete削除される科目コードの名前ありパス パラメータ名前説明必須テナント操作対象のテナント。例: グローバル営業ありクエリー パラメータ名前説明必須forceRemoveforceRemove=true の場合は使用中の科目を削除し、forceRemove=false の場合は使用中の科目を無視します。デフォルトは常にforceRemove=falseです。なしinstanceCode値の取得元の instanceCode 。たとえば、GLOBO。instanceCode が指定されていない場合は、ユーザーのデフォルトのインスタンスが使用されます。なし
- 回答例:
- 204 コンテンツなし成功した応答は空白で、ステータス コードは 204 です。400 不良のリクエストリクエストをサーバーで理解できませんでした。401 認証されていませんユーザーが許可されていません。403 は禁止されていますユーザーに必要な権限が不足しています。500 内部サーバー エラー内部サーバー エラーです。
POST:
- リクエスト:
- /removeAccounts指定された GL 科目コードの科目を削除します。このエンドポイントは、"ENable_ACCOUNTS_DELATION_JSON_API_2" (現在はデフォルトでオフ) 機能フラグの背後にあります。UI で削除できるすべての科目をサポートしています。削除できない科目は無視され、任意の警告を表示することができます。リクエスト URI の例:https://api.adaptiveplanning.com/api/rest/modeling/v1/globosales/accounts/removeAccountsリクエスト ヘッダーの例:認証: 基本コンテンツ タイプ: application/json
- リクエスト本文の例
- POST リクエストの例{ "accountCodesToDelete": ["Assets", "b"] }ペイロード パラメータ名前説明必須accountCodesToDelete削除される科目コードの名前ありパス パラメータ名前説明必須テナント操作対象のテナント。例: グローバル営業ありクエリー パラメータ名前説明デフォルト必須forceRemove使用中の科目の削除falseなしshowWarningsそれに応じて警告を表示します。falseなしdoValidateOnly検証モードを有効にします。falseなし警告account-deletion-Warning=一部の科目は削除されませんでした。error-default-root=デフォルトのルート科目は削除できません。error-sheet-root=シート ルート グループを削除できません。error-cta-account=為替換算調整勘定は削除できません。error-in-use=forceRemove がオフに設定されているため、使用中の科目は削除できません。error-cannot_delete_mi_system_account=少数株主持分システム アカウントは削除できません。完全連結方式の少数株主持分の計算に使用されています。error-cannot_delete_mi_net_income_account=少数株主持分純利益科目は削除できません。完全連結方式の少数株主持分の計算に使用されています。error-cannot_delete_mi_account_ancestor=その科目の子孫科目の 1 つが完全な連結方式の少数株主持分の計算に使用されているため、この科目を削除することはできません。error-delete_person_useed_in_breakback-msg=この科目またはその子孫の 1 つが自動按分で使用されているため、この科目を削除できません。error-cannot_delete_pCM_account=Planning Configuration Manager を使用して、この科目を削除してください。error-nonexistent-code=この科目は存在しません。警告-明確なコード=このコードは複数のアカウントで共有されています。
- 回答例:
- 200 OK{ "total": 0 }200 OK (警告あり){ "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 内部サーバー エラー内部サーバー エラーです。