Spendia Open API

予算残データ出力

OpenAPI説明

本APIはSpendiaに予算残データ出力

リクエストURI

/api/openapi/budget/balance/query

リクエスト形式

POST

リクエスト例

{
  "setOfBooksCode": "DEFAULT_SOB",
  "budgetOrganizationCode": "1001",
  "budgetVersionCode": "b001",
  "budgetStructureCode": "month",
  "budgetScenarioCode": "c001",
  "budgetPeriodYear": "2024",
  "budgetPeriodSemiannual": "",
  "quarterFrom": "",
  "quarterTo": "",
  "periodFrom": "2023-1",
  "periodTo": "2023-12",
  "periodSummaryFlag": "Y",
  "balanceQueryLineDTOS": [
    {
      "parameterType": "1003",
      "parameterValueList": ["f001"],
      "costCenterCode": "",
      "isAll": "N"
    },
    {
      "parameterType": "1005",
      "parameterValueList": [],
      "costCenterCode": "PROJECT",
      "isAll": "Y"
    }
  ]
}

リクエスト項目

項目 タイプ 必須 キー 制限 説明
setOfBooksCode String ○ 元帳コード
budgetOrganizationCode String ○ 予算組織コード
budgetVersionCode String ○ 予算バージョンコード
budgetStructureCode String ○ 予算テーブルコード
budgetScenarioCode String ○ 予算シナリオコード
budgetPeriodYear String ▲ 日付フォーマット：YYYYY
予算テープは年度の場合、必須入力		 年度
budgetPeriodSemiannual String ▲ 日付フォーマット：YYYY-H1
予算テープは半期の場合、必須入力		 半期
quarterFrom String ▲ 日付フォーマット：YYYY-1Q
予算テープは四半期の場合、必須入力		 四半期（自）
quarterTo String ▲ 日付フォーマット：YYYY-2Q
予算テープは四半期の場合、必須入力		 四半期（至）
periodFrom String ▲ 日付フォーマット：会計期間に定義された名称（例：2024-1）
予算テープは月度の場合、必須入力		 期間（自）
periodTo String ▲ 日付フォーマット：会計期間に定義された名称（例：2024-2）
予算テープは月度の場合、必須入力		 期間（至）
periodSummaryFlag String ○ Y：累計
N：明細		 集計方法
balanceQueryLineDTOS Array ○ 予算ディメンション検索条件

balanceQueryLineDTOS

項目 タイプ 必須 キー 制限 説明
parameterType String ○ 1001：予算プロジェクトタイプ
1002：予算プロジェクトグループ
1003：予算プロジェクト
1004：通貨（未実装）
1005：コストセンター		 ディメンション検索タイプ
costCenterCode String コストセンター値コード、ディメンション検索タイプ=!コストセンターの場合、連携不要
isAll String Y：全て
Nまたは空白：手動選択		 すべて選択

OpenAPIリターン例

[
  {
    "itemTypeName": null,
    "itemName": "テストプロジェクト",
    "itemGroupName": null,
    "periodYear": 2023,
    "periodSemiannual": null,
    "periodQuarter": null,
    "periodName": "2023-1~2023-12",
    "currency": "JPY",
    "bgtFunAmount": "0",
    "expReserveFunAmount": "0",
    "expUsedFunAmount": "577568",
    "expAvailableFunAmount": "-577568",
    "dimension1Name": "テスト用項目",
    "dimension2Name": null,
    "dimension3Name": null,
    "dimension4Name": null,
    "dimension5Name": null,
    "dimension6Name": null,
    "dimension7Name": null,
    "dimension8Name": null,
    "dimension9Name": null,
    "dimension10Name": null,
    "dimension11Name": null,
    "dimension12Name": null,
    "dimension13Name": null,
    "dimension14Name": null,
    "dimension15Name": null,
    "dimension16Name": null,
    "dimension17Name": null,
    "dimension18Name": null,
    "dimension19Name": null,
    "dimension20Name": null
  },
  {
    "itemTypeName": null,
    "itemName": "デフォルト項目",
    "itemGroupName": null,
    "periodYear": 2023,
    "periodSemiannual": null,
    "periodQuarter": null,
    "periodName": "2023-1~2023-12",
    "currency": "JPY",
    "bgtFunAmount": "0",
    "expReserveFunAmount": "0",
    "expUsedFunAmount": "700",
    "expAvailableFunAmount": "-700",
    "dimension1Name": "123",
    "dimension2Name": null,
    "dimension3Name": null,
    "dimension4Name": null,
    "dimension5Name": null,
    "dimension6Name": null,
    "dimension7Name": null,
    "dimension8Name": null,
    "dimension9Name": null,
    "dimension10Name": null,
    "dimension11Name": null,
    "dimension12Name": null,
    "dimension13Name": null,
    "dimension14Name": null,
    "dimension15Name": null,
    "dimension16Name": null,
    "dimension17Name": null,
    "dimension18Name": null,
    "dimension19Name": null,
    "dimension20Name": null
  }
]

OpenAPIリターン項目

項目 タイプ 説明
itemTypeName String 予算費用タイプ
itemName String 予算管理単位
itemGroupName String 予算管理グループ
periodYear String 年度
periodSemiannual String 半期
periodQuarter String 四半期
periodName String 期間
currency String 通貨
bgtFunAmount String 予算額
expReserveFunAmount String 保留額
expUsedFunAmount String 発生額
expAvailableFunAmount String 予算残高
dimension1Name~dimension20Name String コストセンター値名

失敗例

{
  "message": "パラメータ:setOfBooksCodeは存在しません",
  "errorCode": "spd.28016.004"
}

項目説明

項目 タイプ 説明
message String エラーメッセージを返
errorCode String エラーコードを返す

エラーコード説明

errorCode message 説明
120003 パラメータ:{0}は指定必須の項目です
spd.28016.003 パラメータ:{0}は不正な日付フォーマットです
spd.28016.004 パラメータ:{0}は存在しません
spd.28016.005 {0}のフォーマットが不正です
spd.28016.006 パラメータ:{0}は正しい日付範囲を入力してください
spd.29262.001 {0}と{1}の検索範囲は同じ年度に必要があります
120001 テナントの権限がありません
spd.29262.002 パラメータ値:{0} は存在しません
spd.29262.003 コストセンター:{0} は存在しません
spd.29262.004 コストセンター値:{0} は存在しません
spd.28016.014 コストセンター:{0} 無効または存在しません

←