updateAccounts
API v20 以上でサポート
カテゴリ | メタデータの変更 |
説明 | 既存の GL 科目のセットを更新するか、新しい GL 科目を作成します。複数の値を持つ複数の科目は、1 回の呼び出しで更新できます。成功した場合、この API は更新または作成された科目の詳細を返します。API が失敗すると、エラーとその原因の包括的なリストが返されます。 |
起動に必要な権限 | 各組織のモデルと権限 |
リクエストに応じてパラメータが必要 | 認証情報 |
このメソッドのリクエストには、呼び出し元のユーザーを識別し、認証するための認証情報タグが含まれています。ユーザーには "モデル" が指定されている必要があります 概念: 権限セット および更新する科目を管理するために必要な権限
ベスト プラクティス:exportAccounts を呼び出して
Adaptive Planning
updateAccounts リクエストに必要なアカウント ID。exportAccounts の呼び出しから updateAccount のリクエストまでの時間を、できるだけ短くするように注意してください。HTTP | 説明 |
|---|---|
Method | Post |
Content-Type | text/xml |
curl の例
curl -H "Content-Type: text/xml" -d @C:/temp/updateAccounts.xml -X POST https://api.adaptiveplanning.com/api/v20
updateAccounts.xml contents
リクエストのフォーマット
<?xml version='1.0' encoding='UTF-8'?> <call method="updateAccounts" callerName="a string that identifies your client application"> <credentials login="sampleuser@company.com" password="my_pwd"/> <accounts proceedWithWarnings="0"> <account id="1441" code="LocalAssets" name="LocalAssets" shortName="" description="Local Assets" displayAs="CURRENCY" decimalPrecision="0" suppressZeroes="1" exchangeRateType="E" isIntercompany="0" planBy="DELTA" timeRollup="LAST" hasSalaryDetail="0" dataPrivacy="PRIVATE" subType="CUMULATIVE" enableActuals="1"> <account id="1610" code="LocalCashAssets" name="Local Cash Assets" shortName="" description="cash assets" displayAs="CURRENCY" decimalPrecision="0" suppressZeroes="1" exchangeRateType="E" isIntercompany="0" planBy="DELTA" timeRollup="LAST" hasSalaryDetail="0" dataPrivacy="PRIVATE" subType="CUMULATIVE" enableActuals="1" propagateToDescendants="1"> <attribute name="SEC Reporting" value="Yes" /> <attribute name="GAAP Reporting" value="No" /> </account> </account> </accounts> </call>
ペイロードが多い場合は、圧縮 XML ファイル (ZIP 形式) を計上できます。その方法については、 こちらをご覧ください。
次の条件が updateAccounts に適用されます。
- 更新対象の科目は内部 ID 番号によって識別されます。
- 新規科目を作成するには、空白または ID プロパティがない科目を指定します。
- 既存の (新規ではない) アイテムを移動して、新しいアイテムの子にすることができます。これにより、新しいアイテムが作成され、既存のアイテムが子としてその下に移動します。
- API v31 以降の場合、既存の親とその子科目の間に新しい親科目を作成できます。
科目の親を再設定
- updateAccounts子の特性値が新しい親特性と互換性がない場合、エラーが発生します。例: reparentedAccount1 特性の SEC レポート値 = いいえ。newParentAccount2 の SEC レポート値 = はいのため、互換性がありません。
- updateAccounts次の場合に、親の再設定中に互換性のない特性値が新しい親と一致するように修正されます。proceedWithWarnings=1.
- 科目の親を再設定すると循環関係を作成できません。
- 親の再設定は、システムで生成されたルート科目では許可されていません。Assets, Liabilities and Equities, Net Income, PL Income, Non-Operating Income, PL COGS, PL Expense, Non-Operating Expenses。
API のバージョンに応じて、以下のようになります。
updateAccounts
既存の親とその子科目の間に新しい親科目を作成できます。ソース科目 | 移動先 | API v30 以前 | API v31 + |
|---|---|---|---|
ルート | ルート | 阻止 | 阻止 |
ルート | 親 | 阻止 | 阻止 |
ルート | 最下位 | 阻止 | 阻止 |
親 | ルート | 許可 | 許可 |
親 | 親 | 許可 | 許可 |
親 | 既存の最下位を最初の子として設定 | 阻止 | 阻止 |
親 | 既存の最下位を最初の子以外として表示 | 許可 | 許可 |
親 | 既存の親の子である新しい最初の科目 | 阻止 | 許可 |
親 | 既存の親の子である新しい科目以外の科目 | 許可 | 許可 |
最下位 | ルート | 許可 | 許可 |
最下位 | 親 | 許可 | 許可 |
最下位 | 既存の最下位を最初の子として設定 | 阻止 | 阻止 |
最下位 | 既存の最下位を最初の子以外として表示 | 許可 | 許可 |
最下位 | 既存の親の子である新しい最初の科目 | 阻止 | 許可 |
最下位 | 既存の親の子である新しい科目以外の科目 | 許可 | 許可 |
最下位 | 既存の最下位科目の子である新しい最初の科目 | 阻止 | 阻止 |
最下位 | 既存の最下位科目の子である新しい科目以外の科目 | 許可 | 許可 |
最下位科目の子
- 最下位科目の最初の子は新しい科目のみにすることができます。既存の GL 科目を既存の最下位科目の下に移動することはできません。
- 親の再設定中に科目が最初の子を取得すると、"インテグレーション" > "インポート科目マッピング" にある科目マッピングは削除されます。
- 科目の親を再設定する場合、balanceTypeおよびsubTypeプロパティは親の GL 科目から継承されます。
キューブ科目とキューブ入力データ
- キューブ入力科目は、親の再設定が可能です。
- 親の再設定が可能な科目は、ソースとターゲットのサブツリーにキューブ入力データがない科目のみです。
- キューブ/ミックス科目の親の再設定はできません。
- キューブ アカウントの下にある新しい科目は許可されていません。STANDARD/mixed ACCOUNT の下の新しい科目を使用できます。
新規科目を作成するためのリクエスト形式
新しい科目を作成するには、その親 ID を含めます。たとえば、L の下に新しい子科目を追加すると、
ocalAssets
が含まれる科目 id 1441
では、以下を使用できます。<?xml version='1.0' encoding='UTF-8'?> <call method="updateAccounts" callerName="Steve C"> <credentials login="sampleuser@company.com" password="my_password"/> <accounts> <account id="1441"> <account id="" code="newLocalAssets" name="new Local Assets" description="new local assets account for this area" shortName="" > </account> </account> </accounts> </call>
この方法では、科目に関する何もの変更も行われません
id 1441
。"子" という名前の新しい子が作成されます。 new Local Assets
対象 id 1441
。指定されていないすべての子 LocalAssets
子リストの最後に移動する。これは新しい科目の "親を設定" することと同じです。1 回の updateAccounts コールでの複数の名前変更の処理
リモート システム内の同一エンティティに対して複数の名称変更が発生する可能性があります。
updateAccounts
。リモート システムのエンティティ名は、同じエンティティ ID と交換できます。条件 updateAccounts
名前の交換後に呼び出しが発生する場合、 updateAccounts
呼び出しは、氏名変更全体の ID を追跡することによって、これらの変更を管理します。この呼び出しは、既存の名称を使用する新しい ID の導入を処理することもできます。それぞれの例が成功するには、固有の値を使って ID が完全に交換される必要があります。
例 1: リモート システムでの単純な名称交換。
ID Unique Value New Unique Value 1 AA BB 2 BB AA
例 2: リモート システムでの 3 つの名前変更のシーケンス。
ID Unique Value New Unique Value 1 AA BB 2 BB CC 3 CC AA
例 3: 既存の一意値を使用した新しいエンティティ。
ID Unique Value New Unique Value 4 AA 1 AA BB 2 BB Old BB
認証情報要素 | |||
タグ名 | 認証情報 | ||
説明 | すべての API 呼び出しには、API を呼び出したユーザーを識別するための単一の認証情報要素が含まれている必要があります。その後、この API 呼び出しはこのユーザーとして実行されます (システムの監査証跡やアクション履歴は、このユーザーがアクションを実行したことを示します)。そのため、API 呼び出しが成功: | ||
要素の特性 | |||
特性名 | 必須? | 値 | 例 |
ログイン | あり | API メソッドを呼び出すユーザーのログイン名。このユーザーは、メソッドを呼び出すために必要な権限を持っている必要があります。 | sampleuser@company.com |
password | あり | API メソッドを呼び出すユーザーのパスワード。 | my_password |
ロケール | なし | 入力される数値と日付の解釈、および出力する数値と日付の形式設定 (適切な千単位の区切り文字、月名、日付の形式設定を使用) に使用されるロケールを指定します。ロケールは、応答内のシステム メッセージを表示する言語を指定するためにも使用されます。指定しない場合は、en_US (米国英語) が使用されます。 | fr_FR |
instanceCode | なし | 認証情報で指定されたユーザーが Adaptive Planning の複数のインスタンスにアクセスできる場合、この属性を使用して、ユーザーがデフォルトのインスタンス以外のインスタンスにアクセスしようとしていることを指定できます。指定しない場合、ユーザーのデフォルトのインスタンスが使用されます。使用可能なインスタンス コードを決定するには、exportInstances API を使用します。 | MYINSTANCE1 |
エレメントの内容 | |||
(なし) | |||
科目要素 | |||
タグ名 | 科目 | ||
説明 | ペイロードごとに許可される科目要素のリクエストは 1 つだけです。1 つ以上の科目要素が含まれます。 | ||
要素の特性 | |||
特性名 | 必須? | 値 | 例 |
proceedWithWarnings | なし | proceedWithWarnings="1" は、updateAccounts API が親の再設定に基づいて科目の特性とプロパティを調整することを示します。 proceedWithWarnings="0" は、updateAccounts API が親の再設定に基づいて科目の特性とプロパティを調整しないことを示します。UpdateAccounts はエラーが発生し、失敗の理由を示すメッセージが表示されます。たとえば、親を再設定すると特性マッピングが無効になります。 ない場合はデフォルトで 0 になります。 | 1 |
retainExistingOrder API v26 以上で使用可能 | なし | tainExistingOrder="1" は、updateAccounts API が XML ペイロード内の要素の順序を無視する必要があり、既存の定義済み順序は保持されることを示します。 retainExistingOrder="0" は、updateAccounts API が XML ペイロード内の他の兄弟と比較したタグの位置に基づいて要素の順序を更新する必要があることを示します。 tainExistingOrder 特性は、API v26 より前の API バージョンでは無視されます。 v26 では、retainExistingOrder のデフォルト値が "0" です。API バージョン v27 以降の場合、retainExistingOrder のデフォルト値は "1" です。 | 1 |
displayNameEnabled
表示名を有効にするインスタンスの API v32 以上でのみ使用できます。 | なし | displayNameEnabled=1 は、updateAccounts が の表示名プロパティに従う必要があることを示します code , displayNameType 、および description インスタンスで "表示名の有効化" がオンの場合。displayNameEnabled=0 は、インスタンスで "表示名の有効化" がオンになっている場合でも、updateAccounts API が v32 前の API 契約に従う必要があることを示します。updateAccounts API は表示名プロパティを無視します。 code , displayNameType および description 。displayNameEnabled のデフォルト値は "0" です。 | 1 |
エレメントの内容 | |||
1 つまたは複数の科目要素が含まれます。 | |||
科目要素 | |||
タグ名 | account | ||
説明 | 作成する科目を指定します。 | ||
要素の特性 | |||
特性名 | 必須? | 値 | 例 |
ID | あり | 科目の内部システム ID 番号。 | 16 |
code
| なし | 科目のコード。英数字と下線のみです。科目グループのコード特性を指定することはできません。
| Cur_Assets |
名前
| あり | レポートおよびシートに表示される科目の名前。
| 流動資産 |
shortName | なし | 科目の短い名前。 | CA |
説明 | なし | 科目のテキストによる説明。最大文字数は 2048 文字です。 | 合計流動資産 |
subType | なし | 科目がフローかストックかを示します。科目がフローである場合、特定の月の値はその月の正味アクティビティに等しくなります。例としては、収益科目と経費科目が挙げられます。科目がストックの場合、その値は特定の月の終了残高に等しくなります。これは、前月の値とその月のアクティビティの値の合計です。貸借対照表の科目はストックです。これは、科目グループおよびメトリック科目の場合は空になります。 読み取り専用で、親科目に基づいて識別されます。 | ストック |
planBy | なし | ストック科目の場合、科目が残高での計画 (BALANCE) か、差額での計画 (DELTA) かを示します。 デフォルトは "差額" です。 科目が実績以外のバージョンで分割されている場合、planBy を Delete に変更することはできません。 最下位科目でのみ適用されます。ユーザーが最下位科目以外に対して PlanBy を設定しようとすると、updateAccounts エラーが発生します。 | DELTA |
actualsBy | なし | ストック科目の場合、科目が残高ごとの実績 (BALANCE) か、差額ごとの実績 (DELTA) かを示します。 デフォルトは "BALANCE" です。 最下位科目でのみ適用されます。ユーザーが最下位科目以外の科目に actualsBy を設定しようとすると、updateAccounts エラーが発生します。 | 残高 |
enableActuals | なし | 0 を選択すると、その科目の計画データのみが表示されます。1: 科目に実績をインポートします。リンクされた科目の場合、0 を指定するとリンク元科目に実績がある場合にのみ実績が表示され、1 を指定するとリンク元科目の実績が有効になります。これは、科目グループおよびメトリック科目の場合は空になります。Planning の GL 管理 UI では、「実績のオーバーレイ」という用語を使用します。 現在の科目がグループである場合、デフォルトは 0 です。現在の科目が最下位の場合、デフォルトは 1 です。 | 1 |
balanceType
API v33 で更新済 | なし | 科目の残高タイプ (借方または貸方) を示します。科目に関連付けられた残高タイプがない場合、 balanceType は空になります。 GL 科目のみに残高タイプがあります。 API v32 以前の場合、残高タイプは親科目で識別される読み取り専用プロパティです。 API v33+ では、子科目が親科目とは異なる balanceType を使用することができます。 | 貸方 |
timeStratum | なし | 科目の時間層のコード。モデル科目およびキューブ科目の場合、これは科目の所有シートから継承されます。 参照 ステップ: カレンダーの変更 時間構造および期間コードの詳細を参照してください。 時間構造、モデル シート、またはキューブ シートから選択された読み取り専用プロパティ。 | month |
displayAs | なし | 科目の出力表示設定: NUMBER、通貨、パーセント"科目の管理" で "表示形式" プロパティがある科目に対してのみ提供されます。 総勘定元帳科目の場合は読み取り専用プロパティです。 | NUMBER |
decimalPrecision | なし | この科目の数値を表示する小数点以下の桁数。 特殊値 99 は、ターゲットの小数点以下の桁数を継承するリンク元科目を示します。値 -1 は、その科目が通貨科目であり、表示される通貨の小数部桁数を使用することを示します。 指定可能な値: -1、0、1 ~ 9、99 デフォルトは 0 です。 | 0 |
exchangeRateType | なし | 多通貨が有効になっているインスタンス、および displayAs="CURRENCY" を指定している科目にのみ存在します。可能な値: "通貨の管理" で設定された、インスタンスに表示されている任意の為替レート タイプ コード。"A" = 月平均、"E" = "月末" 値がない場合、"PERIODIC" は "A"、"ストック" は "E" を使用します。 | E |
suppressZeroes | なし | 科目でユーザーがシート上のゼロを非表示にすることを許可するかどうかを示します。"0" の場合、ユーザーはゼロを非表示にすることはできません。1 人の場合は、ユーザーがゼロを非表示にすることができます。科目の管理で "シート上で表示しない" プロパティがオンになっている科目に対してのみ提供されます。 存在しない場合は、デフォルトで 1 が指定されます。 | 1 |
startExpanded | なし | シートが最初にロードされたときに、科目とその子が展開された状態で開始するかどうかを示します。親科目にのみ適用されます。 展開済みの場合は 1、折り畳みの場合は 0。 存在しない場合は、デフォルトで 1 が指定されます。 | 1 |
dataEntryType API v29 で更新済 | なし | 最下位科目のデータ入力タイプを示します。STANDARD または CUBE 親の dataEntryType が CUBE の場合、新しい科目はデフォルトで dataEntryType CUBE になります。それ以外の場合、新しい科目はデフォルトで dataEntryType STANDARD になります。 最下位科目以外に対する dataEntryType の変更は無視されます。システムによって、最下位科目以外のすべての科目に対する新しい dataEntryType が自動的に計算されます。 API v29 以降では、dataEntryType=CUBE を使用した新規科目の追加がサポートされています。 | 標準 |
hasSalaryDetail | なし | この科目に、表示するために "給与詳細にアクセス" 権限が必要な分割があるかどうかを示します。この科目に該当しない場合は空です。 科目グループ/最下位科目以外に対して hasSalaryDetail=1 は許可されません。 hasSalaryDetail=1 にする場合:
dataEntryType が NOT STANDARD の場合、エラーが発生します。 最下位科目以外で dataEntryType=1 の場合にエラーが発生します。 GL 以外およびカスタム科目でエラーが発生しました。 | 1 |
dataPrivacy | なし | 科目の値がどの組織で公開され、数式の書き込み時に他の組織で参照可能であるかを示します。"非公開" は、科目の値が非公開であることを示します。PUBLIC_Top は科目の値が最上位組織のみで公開されることを示し、Public_ALL は科目の値がすべての組織で公開されるようにします。前提条件は常に公開され、dataPrivacy 設定はありません。 存在しない場合は、デフォルトで "PRIVATE" が指定されます。 科目グループと前提条件科目のエラーが表示されます。 | 非公開 |
isIntercompany | なし | 科目が内部取引科目であるかどうかを示します。 isIntercompany プロパティへの変更はサポートされていません。 | 0 |
propagateToDescendants | なし | 特性マッピングの変更を子孫に伝達することを示します。 値がない場合は、デフォルトで 0 になります。 空の場合、または 1 や 0 以外の値が含まれている場合、エラーが発生します。 子孫に伝達されるプロパティ:
| 1 |
エレメントの内容 | |||
科目に関連付けられた 1 つ以上の科目特性を編集する場合は、1 つの任意の特性要素。 | |||
特性要素 | |||
タグ名 | 特性 | ||
説明 | 更新する特性を指定します。モデルに科目特性がある場合、科目に特性のタグを付けます。 | ||
要素の特性 | |||
特性名 | 必須? | 値 | 例 |
名前 | あり | 特性の名前。 この名前がシステムにまだ存在しない場合は、エラーが発生します。 名前は存在するが特性が科目特性でない場合はエラーになります。 特性名が空であるか、見つからない場合、エラーが発生します。 | 勤務地 |
値
API v34 で更新済 | あり | この特性の特性値。 空の値によって現在の値を削除するか、定義済みの科目特性値を削除できます。 特性値は、科目に割り当てられた特性と互換性がある必要があります。 API v32 および v33 では、この属性が意味を持つのは、インスタンスの表示名設定がオフになっている場合のみです。 API v34 以降の場合:
| 170 |
valueCode
表示名が有効になっているインスタンスの API v32 および API v33 でのみ使用できます。 API v34 ではサポートされていません。 | あり | 特性値の一意のコード。
valueCode 入力が意味を持つのは、displayNameEnabled=1で、表示名の設定が API v32 および API v33 のインスタンスに対してオンになっている場合に限られます。 無効な特性値コード:
| SFO |
valueName
表示名が有効になっているインスタンスの API v32 および API v33 でのみ使用できます。 API v34 ではサポートされていません。 | なし | 新しく自動作成された特性値の名前。
特性 valueName が意味を持つのは、次の場合のみです。
| サンフランシスコ |
エレメントの内容 | |||
(なし) | |||
上から下へのペイロード処理
科目特性は論理的に値をグループ化し、科目にタグを付けます。updateAccounts API は XML ペイロードを上から下に処理するため、親科目の科目特性を割り当ててから、子科目の特性を変更します。親科目の特性値が空白の場合、子科目は任意の特性値でタグ付けできます。子科目特性が親特性と整合しない場合、互換性検証エラーが発生します。
以下のツリー構造を検討します。親科目 "Product Line" に、2 つの子科目 "A" と "B-Ste" が含まれています。科目 "A" と "B-Ste" は兄弟です。
Product Line|__A __A |__B-Ste __B-Ste |__B1 __Product B-1 |__B2 __Product B-2 |__B3 __Product B-3
科目属性を含む元のリクエスト XML の例
科目特性値 "A" が "その他の科目" と "スイス銀行" の両方に割り当てられていることを確認します。
<accounts> <account id="60" code="70140" name="Other Accounts"> <attribute name="Product Line" value="A" /> <account id="91" code="70150" name="Swiss Bank"> <attribute name="Product Line" value="A" /> </account> </account> </accounts>
ペイロード処理の順序の誤りの例
以下の XML ペイロードでエラーが発生します。
The attribute value B-1 is not compatible with the parent's attribute value
"。上から下へのペイロード処理では、親の "その他の科目" は前のコード ブロックの値 "A" を持っていると見なされ、"B-1" が "A" の子として処理されます。このエラーが生成されるのは、ツリー構造で示されているとおり、子 "Swas Bank" の特性値が "A" または "B-Ste" に限られるためです。<accounts> <account id="60" code="70140" name="Other Accounts"> <account id="91" code="70150" name="Swiss Bank"> <attribute name="Product Line" value="B-1" /> </account> <attribute name="Product Line" value="B-Ste" /> <!-- Account Attribute change ignored due to placement order--> </account> </accounts>
ペイロード処理の有効な順序の例
"B-Ste" の配置順序を "その他の科目" の下に並べ替えることにより、API が親科目特性 "B-Ste" を最初に処理できるようになり、"Swas Bank" が "B-Ste" または "B-Ste" のいずれかの値を持つことを可能にします。いずれかの子
<accounts> <account id="60" code="70140" name="Other Accounts"> <attribute name="Product Line" value="B-Ste" /> <!-- Account Attribute change processed due to correct placement order--> <account id="91" code="70150" name="Swiss Bank"> <attribute name="Product Line" value="B-1" /> </account> </account> </accounts>
回答フォーマット
<?xml version="1.0" encoding="UTF-8"?> <response success="true"> <messages> <message type="INFO">Accounts were saved successfully.</message> </messages> <output> <accounts> <account id="1441" code="LocalAssets" name="LocalAssets" shortName="" description="Local Assets"displayAs="CURRENCY" decimalPrecision="0" suppressZeroes="true" exchangeRateType="E" formula="" isIntercompany="0" planBy="DELTA" timeRollup="LAST" timeWeightAcctId="" levelDimRollup="SUM" levelDimWeightAcctId="" rollupText="" startExpanded="true" hasSalaryDetail="" dataPrivacy="PRIVATE" isBreakbackEligible="" subType="CUMULATIVE" enableActuals="true"> <account id="1610" code="LocalCashAssets" name="Local Cash Assets" shortName="" description="cash assets" displayAs="CURRENCY" decimalPrecision="0" suppressZeroes="true" exchangeRateType="E" formula="" isIntercompany="0" planBy="DELTA" timeRollup="LAST" timeWeightAcctId="" levelDimRollup="SUM" levelDimWeightAcctId="" rollupText="" startExpanded="true" hasSalaryDetail="" dataPrivacy="PRIVATE" isBreakbackEligible="" subType="CUMULATIVE" enableActuals="true"> </account> </accounts> </output> </response>
出力要素 | |
タグ名 | 出力 |
要素の特性 | |
(なし) | |
エレメントの内容 | |
単一の必須科目要素この出力ラベンダーはすべての API 応答の標準であり、成功した API 呼び出しの有効な出力を囲みます。 | |
科目要素 | |||
タグ名 | 科目 | ||
説明 | 1 つ以上の科目要素のコンテナです。 | ||
要素の特性 | |||
特性名 | 必須? | 値 | 例 |
エレメントの内容 | |||
1 つ以上の科目要素 | |||
科目要素 | |||||
タグ名 | account | ||||
説明 | updateAccounts API コールへの応答で返される単一科目を表します。この要素が応答のそれを囲む科目要素内に直接ある場合 (つまり、別の科目要素に囲まれていない場合)、この科目要素はルート科目 (親を持たない科目) を表します。 | ||||
要素の特性 | |||||
特性名 | 必須? | 値 | 例 | ||
ID | あり | 科目の内部システム ID 番号。これは、exportDimensionFamilies などの他の API 呼び出しで科目を識別するために使用できます。 | 16 | ||
code | あり | 科目のコード。数式で参照された場合に表示されます。 | Cur_Assets | ||
名前 | あり | レポートおよびシートに表示される科目の名前。 | 流動資産 | ||
accountTypeCode | なし | この科目のデータ タイプに対応する文字コード | |||
タイプ コード | 科目タイプ | 科目クラス | |||
A | 資産 | 総勘定元帳 | |||
B | 流動資産 | 総勘定元帳 | |||
C | 負債と純資産 | 総勘定元帳 | |||
キューブ | キューブ | キューブ | |||
EN | 年初来の利益/損失 | 総勘定元帳 | |||
F | 固定資産 | 総勘定元帳 | |||
G | 売上原価 | 総勘定元帳 | |||
I | Income | 総勘定元帳 | |||
J | 営業外収益 | 総勘定元帳 | |||
K | 為替換算調整勘定 | システム | |||
L | 負債 | 総勘定元帳 | |||
M | 流動負債 | 総勘定元帳 | |||
MI | 連結比率 | 定義済 | |||
MT | メトリック | メトリック | |||
なし | 純利益 | 総勘定元帳 | |||
O | 他の資産 | 総勘定元帳 | |||
Q | 純資産 | 総勘定元帳 | |||
R | 長期資産 | 総勘定元帳 | |||
S | 前提条件 | 前提条件 | |||
T | 長期負債 | 総勘定元帳 | |||
W | モデル | モデル | |||
X | 経費 | 総勘定元帳 | |||
XR | 為替レート | 定義済 | |||
あり | 営業外費用 | 総勘定元帳 | |||
Z | カスタム | カスタム | |||
説明 | なし | 科目管理で入力された科目のテキスト説明 (存在する場合) | 合計流動資産 | ||
shortName | なし | 科目管理で入力された科目の短縮名 (存在する場合) | CA | ||
timeStratum | なし | 科目の時間層のコード。モデル科目およびキューブ科目の場合、これは科目の所有シートから継承されます。 | Month | ||
displayAs | なし | 科目の出力表示設定: NUMBER、通貨、パーセント"科目の管理" で "表示形式" プロパティがある科目に対してのみ提供されます。 | NUMBER | ||
IS前提条件 | なし | "0" または "1" のいずれかで、科目が前提条件であるかどうかを示します。これは前提条件および為替レート科目では 1 に設定されます。 | 1 | ||
suppressZeroes | なし | 科目でユーザーがシート上のゼロを非表示にすることを許可するかどうかを示します。"0" の場合、ユーザーはゼロを非表示にすることはできません。1 人の場合は、ユーザーがゼロを非表示にすることができます。科目の管理で "シート上で表示しない" プロパティがオンになっている科目に対してのみ提供されます。 | 1 | ||
isDefaultRoot | なし | "0" または "1"。科目または科目グループがデフォルト ルートであるかどうかを示します。 | 1 | ||
decimalPrecision | なし | この科目の数値を表示する小数点以下の桁数。 特殊値 99 は、ターゲットの小数点以下の桁数を継承するリンク元科目を示します。値 -1 は、その科目が通貨科目であり、表示される通貨の小数部桁数を使用することを示します。 指定可能な値: -1、0、1 ~ 9、99 デフォルトは 0 です。 | 0 | ||
planBy | なし | ストック科目の場合、科目が残高での計画 (BALANCE) か、差額での計画 (DELTA) かを示します。 | 残高 | ||
exchangeRateType | なし | displayAs="CARERENCY" を持つ科目の場合のみ存在します。可能な値: "通貨の管理" で設定された、インスタンスに表示されている任意の為替レート タイプ コード。"A" = 月平均、"E" = "月末" | E | ||
balanceType | なし | 科目の残高タイプ (借方または貸方) を示します。科目に関連付けられた残高タイプがない場合、この特性は空になります。GL 科目のみに残高タイプがあります。 | 借方 | ||
dataEntryType API v29 で更新済 | なし | 科目のデータ入力タイプを示します。STANDARD または CUBE空の値は、データ入力タイプが科目に適用されないことを示します。 システムによって、最下位科目以外のすべての科目に対する新しい dataEntryType が自動的に計算されます。 API v29 以降の場合:
| 標準 | ||
timeRollUp | なし | 特定の期間にわたってロールアップされた科目の動作を示します。SUM、WEITETED_AVERAGE、LAST、AVERAGE を指定できます。これは、科目グループおよびメトリック科目の場合は空になります。 | SUM | ||
timeWeightAcctId | なし | この科目の timeRollup が ”WESIGNED_AVERAGE” である場合、これは科目の内部システム ID 番号になります。この内部システム ID 番号は加重値の決定元となります。これは、加重科目が存在しない場合、または科目の timeRollup が WESIGNED_AVERAGE の場合、空になります。 | 133 | ||
hasSalaryDetail | なし | この科目に、表示するために "給与詳細にアクセス" 権限が必要な分割があるかどうかを示します。この科目に該当しない場合は空です。 | 1 | ||
dataPrivacy | なし | 科目の値がどの組織で公開され、数式の書き込み時に他の組織で参照可能であるかを示します。"非公開" は、科目の値が非公開であることを示します。PUBLIC_Top は科目の値が最上位組織のみで公開されることを示し、Public_ALL は科目の値がすべての組織で公開されるようにします。前提条件は常に公開され、dataPrivacy 設定はありません。 | 非公開 | ||
subType | なし | 科目がフローかストックかを示します。科目がフローである場合、特定の期間の値はその期間の正味アクティビティに等しくなります。例としては、収益科目と経費科目が挙げられます。科目がストックの場合、その値は特定の期間の終了残高と等しくなります。これは、前の期間の値と指定された期間のアクティビティの値です。貸借対照表の科目はストックです。これは、科目グループおよびメトリック科目の場合は空になります。 | フロー | ||
startExpanded | なし | これは、シートを最初にロードしたときに科目とその子が展開された状態で開始するかどうかを示します。これは親科目にのみ適用されます。これは最下位科目の場合空になります。 | 1 | ||
isBreakbackEligible | なし | 0 または 1 のいずれかで、この科目を按分で使用できるかどうかを示します。これは標準の前提条件にのみ適用されます。これは他のタイプの科目では空になります。 | 0 | ||
levelDimRollup | なし | 組織または属性に沿ってロールアップされた科目の挙動を示します。SUM、WEITETED_AVERAGE、TEXT、NONBLANK_AVERAGE を指定できます。これは、科目グループおよびメトリック科目の場合は空になります。 | NONBLANK_AVERAGE | ||
levelDimWeightAcctId | なし | この科目の levelDimRollup が "WE却下" の場合、これは科目の内部システム ID 番号になります。この内部システム ID 番号は加重値の決定元となります。加重科目が存在しない場合、または科目の levelDimRollup が WE却下_AVERAGE でない場合、これは空になります。 | 118 | ||
rollupText | なし | この科目の levelDimRollup が TEXT の場合、これは科目のロールアップされた値を示すセルに表示されるテキスト文字列です。 | なし | ||
enableActuals | なし | 0 を選択すると、その科目の計画データのみが表示されます。1: 科目に実績をインポートします。リンクされた科目の場合、0 を指定するとリンク元科目に実績がある場合にのみ実績が表示され、1 を指定するとリンク元科目の実績が有効になります。これは、科目グループおよびメトリック科目の場合は空になります。 | 1 | ||
isGroup | あり | 0 または 1 で科目グループかどうかを示します。 | 1 | ||
isContra
API v34+ で使用可能 | なし | 0 または 1 で相対科目であるかどうかを示します。 | 1 | ||
isIntercompany | なし | 0 または 1 で、この科目が内部取引科目であるかどうかを示します。 | 1 | ||
isLinked | なし | 0 または 1 でこの科目がリンク元科目であるかどうかを示します。 | 1 | ||
isSystem | なし | 0 または 1 でシステム科目であるかどうかを示します。 | 1 | ||
ステータス | あり | 更新後の科目のステータス警告とエラーの場合は、メッセージ要素にメッセージ内容が含まれます。更新ステータスはメッセージ内容を返しません。
| 更新 | ||
message | なし | 科目入力に関するエラー メッセージ。 | 科目の ModAccount33 は、ペイロードで重複している、または ID 8 でシステムにすでに存在しています。 | ||
エレメントの内容 | |||||
この科目の直接の子科目ごとに 1 つのネストされた科目要素科目に関連付けられた 1 つまたは複数の特性がある場合は、1 つの特性要素。 | |||||
特性要素 | |||
タグ名 | 特性 | ||
説明 | 科目に特性がタグ付けされることを示します。 | ||
要素の特性 | |||
特性名 | 必須? | 値 | 例 |
名前 | あり | 科目特性の名前。 | 学歴タイプ |
値
API v34 で更新済 | あり | 科目特性の値。
API v32 および API v33 では、この特性が意味を持つのは、インスタンスの表示名設定がオフになっている場合のみです。 | Tech1 |
valueCode
表示名が有効になっているインスタンスの API v32 および API v33 でのみ使用できます。 | あり | 特性値の一意のコード。
API v32 および API v33 では、valueCode が意味を持つのは次の場合のみです。
| |
valueName
表示名が有効になっているインスタンスの API v32 および API v33 でのみ使用できます。 | なし | 新しく自動作成された特性値の名前。
特性 valueName が意味を持つのは、次の場合のみです。
| |
ステータス | あり | 更新後の特性のステータス。警告とエラーの場合は、メッセージ要素にメッセージ内容が含まれます。更新ステータスはメッセージ内容を返しません。
| 更新されました |
message | なし | 無効な特性が入力されたことを示すエラー メッセージ。 | |
エレメントの内容 | |||
(なし) | |||