メインコンテンツにスキップ
ドキュメント
ドキュメント
Adaptive Planning
exportAccounts

exportAccounts

この API はユーザーのみをサポートします 概念: アクセス ルール API v22 以上
カテゴリ
Metadata retrieval
説明
前提条件、キューブ科目、カスタム科目、GL 科目、メトリック科目、モデル科目など、すべての科目タイプを含むシステム内のすべての科目の完全なリストのメタデータを返します。
起動に必要な権限
なし (インスタンスに対して有効な認証情報である必要があります)
リクエストに応じてパラメータが必要
認証情報
このメソッドのリクエストには、呼び出しユーザーを識別および認証する認証情報タグと、特定のバージョンの科目のインポート可能性に関する情報を応答に含める必要があるかどうかを示す「含める」タグが含まれています。検証されると、このメソッドはシステムの完全な科目セットを示す XML ドキュメントを返します。囲むタグで表される科目が、囲まれている科目の親である場合、科目は 1 つの科目タグで別の科目タグに囲まれ、入れ子されたツリー形式で返されます。

リクエストのフォーマット


<?xml version='1.0' encoding='UTF-8'?>
<call method="exportAccounts" callerName="a string that identifies your client application">
  <credentials login="sampleuser@company.com" password="my_pwd"/>
  <include versionName="sample version"/>
  <sheet id="3" />
</call>
認証情報要素
タグ名
認証情報
説明
すべての API 呼び出しには、API を呼び出したユーザーを識別するための単一の認証情報要素が含まれている必要があります。その後、この API 呼び出しはこのユーザーとして実行されます (システムの監査証跡やアクション履歴は、このユーザーがアクションを実行したことを示します)。そのため、API 呼び出しが成功:
要素の特性
特性名
必須？
値
例
ログイン
あり
API メソッドを呼び出すユーザーのログイン名。このユーザーは、メソッドを呼び出すために必要な権限を持っている必要があります。
sampleuser@company.com
password
あり
API メソッドを呼び出すユーザーのパスワード。
my_password
ロケール
なし
入力される数値と日付の解釈、および出力する数値と日付の形式設定 (適切な千単位の区切り文字、月名、日付の形式設定を使用) に使用されるロケールを指定します。ロケールは、応答内のシステム メッセージを表示する言語を指定するためにも使用されます。指定しない場合は、en_US (米国英語) が使用されます。
fr_FR
instanceCode
なし
認証情報で指定されたユーザーが の複数のインスタンスにアクセスできる場合、
Adaptive Planning
、この属性は、ユーザーがデフォルトのインスタンス以外のインスタンスにアクセスしようとしていることを指定するのに使用できます。指定しない場合、ユーザーのデフォルトのインスタンスが使用されます。使用可能なインスタンス コードを決定するには、exportInstances API を使用します。
MYINSTANCE1
エレメントの内容
(なし)
要素を含める
タグ名
含める
説明
科目情報のどの側面を応答に含めるか、または応答から除外するかを示すフラグのセットを表します。この要素は任意です。存在しない場合、API はすべてのバージョンの科目情報を返します。また、isImportable 特性は含まれません。
要素の特性
特性名
必須？
値
例
versionName
API v18 で更新済
なし
応答に各科目の isImportable 特性を含める必要があるかどうかを示し、科目が指定したバージョンのインポートされたデータを受け入れることができるかどうかを示します。デフォルトでは、この要素またはその特性が存在しない場合、isImportable 特性をレスポンスで送出することはありません。この要素で versionName 特性と versionID 特性の両方が指定された場合、versionID は無視されます。
バージョンを指定した場合、ユーザーがそのバージョンへのアクセス権を持っている場合にのみ、呼び出しが成功します。
2016 年予算
versionID
API v18 で更新済
なし
パラメータとして内部バージョン ID 番号を取ることを除き、versionName (上記) と同じです。応答に各科目の isImportable 特性を含める必要があるかどうかを示し、科目が指定したバージョンのインポートされたデータを受け入れることができるかどうかを示します。
バージョンを指定した場合、ユーザーがそのバージョンへのアクセス権を持っている場合にのみ、呼び出しが成功します。
102
特性
なし
回答に各科目の特性を含めるかどうかを示します。
false
inaccessibleValues
なし
現在のユーザーがアクセスできない値を回答に含めるかどうかを示します。デフォルトは false です。"モデリング" または "すべての組織にインポート" の権限を持つユーザーのみが、このオプションを true に設定できます。
false
showAccountGroupCodes
API v38 で更新済
なし
このオプションは API v38 以降で使用できます。
デフォルトは false です。
true に設定すると、以前は空になっていた科目応答要素の "コード" 特性を再利用することにより、応答に科目グループ コードを含めます。
真
includeAttributeValueNames
API v37 で更新済
なし
このオプションは API v37 以降で使用できます。
デフォルトは false です。
真に設定した場合、特性値名が応答に含まれます。
includeAttributeValueDisplayNames
API v37 で更新済
なし
このオプションは API v37 以降で使用できます。
デフォルトは false です。
true に設定した場合、特性値の表示名が応答に含まれます。
エレメントの内容
(なし)
シート要素
タグ名
シート
説明
そのシートで使用可能な科目のみを回答に含める必要があるシートを表します。この要素は任意です。存在しない場合、API は特定のシートとは関係なく科目情報を返します。
要素の特性
特性名
必須？
値
例
ID
あり
シートの内部システム ID 番号です。
234
エレメントの内容
(なし)

回答フォーマット


<?xml version='1.0' encoding='UTF-8'?>
<response success="true">
 <output>
   <accounts seqNo="42">
     <account id="2147483645" code="" name="GL Accounts" description="GL Accounts" timeStratum="" displayAs="NUMBER"
     accountTypeCode="" decimalPrecision="0" isAssumption="0" suppressZeroes="1" isDefaultRoot="1" shortName=""
     balanceType="" isLinked="0" owningSheetId="" isSystem="0" isIntercompany="0" isImportable="0" dataEntryType=""
     planBy="" timeRollup="" timeWeightAcctId="" levelDimRollup="" levelDimWeightAcctId="" rollupText="" startExpanded="1"
     hasSalaryDetail="" dataPrivacy="" isBreakbackEligible="" subType="" enableActuals="" isGroup="1">
       <account id="1" code="Assets" name="Assets" description="Total Assets" timeStratum="month" displayAs="CURRENCY"
       accountTypeCode="A" decimalPrecision="0" isAssumption="0" suppressZeroes="1" isDefaultRoot="1"
       shortName="" exchangeRateType="E" balanceType="DEBIT" isLinked="0" owningSheetId=""
       isSystem="0" isIntercompany="0" dataEntryType="" planBy="DELTA" timeRollup="LAST" timeWeightAcctId=""
       levelDimRollup="SUM" levelDimWeightAcctId="" rollupText="" startExpanded="1" hasSalaryDetail=""
       dataPrivacy="PRIVATE" isBreakbackEligible="" subType="CUMULATIVE" enableActuals="1" isGroup="0">
         <account id="16" code="Current_Assets" name="Current Assets" description="current assets" timeStratum="month"
       displayAs="CURRENCY" accountTypeCode="B" decimalPrecision="0" isAssumption="0" suppressZeroes="1"
       isDefaultRoot="1" shortName="" exchangeRateType="E" balanceType="DEBIT" isLinked="0"
       owningSheetId="" isSystem="0" isIntercompany="0" dataEntryType="" planBy="DELTA" timeRollup="LAST"
       timeWeightAcctId="" levelDimRollup="SUM" levelDimWeightAcctId="" rollupText="" startExpanded="1"
       hasSalaryDetail="" dataPrivacy="PRIVATE" isBreakbackEligible="" subType="CUMULATIVE" enableActuals="1"
       isGroup="0">
           <account id="51" code="70110" name="Bank Account" description="Wells Fargo account" timeStratum="month"
       displayAs="CURRENCY" accountTypeCode="B" decimalPrecision="0" isAssumption="0" suppressZeroes="1"
       isDefaultRoot="0" shortName="" exchangeRateType="E" balanceType="DEBIT" isLinked="0"
       owningSheetId="" isSystem="0" isIntercompany="0" dataEntryType="STANDARD" planBy="BALANCE"
       timeRollup="LAST" timeWeightAcctId="" levelDimRollup="SUM" levelDimWeightAcctId="" rollupText=""
       startExpanded="" hasSalaryDetail="0" dataPrivacy="PRIVATE" isBreakbackEligible="" subType="CUMULATIVE"
       enableActuals="1" isGroup="0">
             <attributes>
               <attribute name="SEC Reporting" value="Yes" />
               <attribute name="GAAP Reporting" value="No" />
             </attributes>
           </account>
         </account>
       </account>
     </account>
   </accounts>
 </output>
</response>
回答エレメント
タグ名
response
要素の特性
特性名
必須？
値
例
成功
あり
真偽のいずれか。API 呼び出しが成功したかどうかを示します。呼び出しが成功した場合でも、応答に警告メッセージが含まれる場合があります。
真
廃止
なし
レスポンス タグに存在し、true に設定されている場合、この属性は呼び出しているメソッドまたは API のバージョンが廃止されており、正式に廃止されたことを示します。現時点では機能し続けていますが、まもなく機能が停止する可能性があります。通常、この属性は存在しません。
false
エレメントの内容
単一の任意のメッセージ要素と、厳密に 1 つの必須の出力要素。
出力要素
タグ名
出力
要素の特性
(なし)
エレメントの内容
単一の科目要素この出力ラベンダーはすべての API 応答の標準であり、成功した API 呼び出しの有効な出力を囲みます。
科目要素
タグ名
科目
説明
1 つ以上の科目要素のコンテナです。
要素の特性
特性名
必須？
値
例
連番
API v17 で追加されましたが、将来の使用のために予約されています。
エレメントの内容
1 つ以上の科目要素
科目要素
タグ名
account
説明
exportAccounts API コールへの応答で返される単一科目を表します。この要素が応答のそれを囲む科目要素内に直接ある場合 (つまり、別の科目要素に囲まれていない場合)、この科目要素はルート科目、つまり親を持たない科目を表します。
要素の特性
特性名
必須？
値
例
名前
あり
レポートおよびシートに表示される科目の名前。
流動資産
code
あり
科目のコード。数式で参照された場合に表示されます。
Cur_Assets
ID
なし
科目の内部システム ID 番号。これは、exportDimensionFamilies などの他の API 呼び出しで科目を識別するために使用できます。
16
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
API v16 以上でサポート
なし
科目の時間層 (時間層のコードとして)。キューブ科目、モデル科目、キューブ入力 GL 科目の場合、時間層はそれらを所有するシートの時間層によって決まります。他のすべての科目は、時間管理 UI 内で設定されたデフォルトの時間層を使用します。
Month
displayAs
なし
科目の出力表示設定: NUMBER、通貨、パーセント"科目の管理" で "表示形式" プロパティがある科目に対してのみ提供されます。
NUMBER
IS前提条件
なし
"0" または "1" のいずれかで、科目が前提条件であるかどうかを示します。これは前提条件および為替レート科目では 1 に設定されます。
1
suppressZeroes
なし
この科目でユーザーがシート上のゼロを非表示にできるかどうかを示すフラグです。0 は許可されず、1 は許可されます。"科目の管理" で "ゼロを表示しない" プロパティがある科目に対してのみ提供されます。
1
isDefaultRoot
なし
"0" または "1"。科目または科目グループがデフォルト ルートであるかどうかを示します。
1
decimalPrecision
なし
この科目の数値を表示する小数点以下の桁数。デフォルトは 0 です。特殊値 99 は、ターゲットの小数点以下の桁数を継承するリンク元科目を示すために使用されます。値が -1 の場合、その科目は通貨科目であり、表示されているいずれかの通貨の小数部桁数が使用されます。
0
planBy
なし
ストック科目の場合、科目が残高での計画 (BALANCE) か、差額での計画 (DELTA) かを示します。
残高
exchangeRateType
なし
displayAs="CARERENCY" を持つ科目の場合のみ存在します。可能な値: "通貨の管理" で設定された、インスタンスに表示されている任意の為替レート タイプ コード。"A" = 月平均、"E" = "月末"
E
isImportable
なし
科目がインポートされたデータを受け入れることができるかどうかを示します。0 はその科目がインポート不可であることを、1 はインポート可能であることを示します。リクエストで versionName または versionId が指定されている場合にのみ存在します。
注: "isImportable" は、科目が指定されたバージョンでインポート可能であることのみを示します。API を呼び出しているユーザーが、バージョンまたは科目にインポートする権限を持っていることは意味しません。exportVersions を使用して、ユーザーがインポートに使用できるバージョンを確認します。
1
balanceType
なし
科目の残高タイプ (借方または貸方) を示します。科目に関連付けられた残高タイプがない場合、この特性は空になります。GL 科目のみに残高タイプがあります。
借方
dataEntryType
なし
科目のデータ入力タイプを示します。STANDARD または CUBE空白の値は、データ入力タイプが科目に適用されないことを示します。たとえば、リンク元科目またはモデル科目のデータ入力タイプが空白の場合、
キューブ
timeRollUp
なし
特定の期間にわたってロールアップされた科目の動作を示します。SUM、WEITETED_AVERAGE、LAST、AVERAGE を指定できます。これは、科目グループおよびメトリック科目の場合は空になります。
SUM
timeWeightAcctId
なし
この科目の timeRollup が ”WESIGNED_AVERAGE” である場合、これは科目の内部システム ID 番号になります。この内部システム ID 番号は加重値の決定元となります。これは、加重科目が存在しない場合、または科目の timeRollup が WESIGNED_AVERAGE の場合、空になります。
133
hasSalaryDetail
なし
0 または 1 で、この科目に "給与詳細にアクセス" 権限を表示する必要がある分割があるかどうかを示します。この科目に該当しない場合は空になります。
1
dataPrivacy
なし
科目の値がどの組織において公開され、数式の作成時に他の組織で参照可能であるかを示します。科目の値が非公開になる場合は "PRIVATE" を、最上位組織のみで科目の値が公開される場合は "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
isIntercompany
なし
0 または 1 で、この科目が内部取引科目であるかどうかを示します。
1
数式
API v18+ では使用できません。
なし
科目の数式 (ある場合)。
ACCT.Revenue - ACCT.Expenses
isLinked
なし
0 または 1 でこの科目がリンク元科目であるかどうかを示します。
1
isSystem
なし
0 または 1 でシステム科目であるかどうかを示します。
1
owningSheetId
なし
モデル シートおよびキューブ シートにある科目の場合、この科目があるシートの内部システム ID 番号そのような科目ではない場合、またはそのような科目であるがシートに現在割り当てられていない場合は、空になります。
17
エレメントの内容
この科目の直接の子科目ごとに 1 つのネストされた科目要素科目に関連付けられた 1 つまたは複数の特性がある場合は、1 つの特性要素。
特性要素
タグ名
特性
説明
1 つ以上の特性要素のコンテナです。
要素の特性
特性名
必須？
値
例
(なし)
エレメントの内容
1 つ以上の特性要素
特性要素
タグ名
特性
説明
科目が関連付けられている、空白ではない単一の科目特性マッピングを示します。
要素の特性
特性名
必須？
値
例
名前
あり
科目特性の名前。
SEC レポート
値
有効な表示名設定がオンの場合、API v34 でサポートされます。
あり
科目に関連付けられた科目特性の値。
はい
valueCode
表示名が有効になっているインスタンスの API v32 および API v33 でのみ使用できます。
"有効な表示名" 設定がオンの場合、API v34 ではサポートされません。
なし
この特性の特性値コード。
API v32 および API v33 では、valueCode が意味を持つのは次の場合のみです。
  • インスタンスの "表示名" 設定がオンになっています。
  • displayNameEnabled=1
YR
valueName
表示名が有効になっているインスタンスの API v32 および API v33 でのみ使用できます。
"有効な表示名" 設定がオンの場合、API v34 ではサポートされません。
なし
この特性の特性値名。
API v32 および API v33 では、valueName が意味を持つのは、以下の場合のみです。
  • インスタンスの "表示名" 設定がオンになっています。
  • displayNameEnabled=1
はい
valueDisplayName
表示名を有効にするインスタンスの API v32 以上でのみ使用できます。
あり
API v32 以降では、valueDisplayName が意味を持つのは、以下の場合に限られます。
  • インスタンスの "表示名" 設定がオンになっています。
  • displayNameEnabled=1value
はい
attributeID
あり
科目特性の内部システム ID 番号。
10
valueID
あり
科目特性の内部システム ID 番号。
108
エレメントの内容
なし