コンテンツにスキップ
風土記
Esc
↑↓移動↵開く⌘Jプレビュー

列の説明と金額の和の条件

歳出の木の列の説明と、金額を足すときの条件（sum_rules）、検索の入力の例（search_example）を返す。検索の前に一度読む。

GET/v1/expenditure/columns
Responses
200

成功

document_kindsobject[]required
Show properties
Array of object
namestringrequired
descriptionstringrequired
where_columnsstring[]required
order_by_columnsstring[]required
required_inputstringrequired
search_exampleobjectrequired
Show properties
document_kindstringrequired

資料区分。表の選択に使う。必須。

Allowed:settlementinitial
fiscal_yearobjectrequired

会計年度（西暦）の範囲。幅は 5 年以内（max - min <= 4）。必須。

Show properties
minintegerrequired
min 1 · max 9999
maxintegerrequired
min 1 · max 9999
whereobject

列ごとの条件。列どうしは AND。

Show properties
node_idStringCondition
Show properties
eqstring[]

いずれかに等しい（OR）

min items 1 · max items 100
not_eqstring[]

どれにも等しくない

min items 1 · max items 100
prefixstring

前方一致

min length 1 · max length 200 · matches ^[^\u0000-\u001f\u007f]*$
suffixstring

後方一致

min length 1 · max length 200 · matches ^[^\u0000-\u001f\u007f]*$
containsstring

部分一致

min length 1 · max length 200 · matches ^[^\u0000-\u001f\u007f]*$
is_nullboolean

true で NULL、false で NULL でない

parent_node_idStringCondition
Show properties
eqstring[]

いずれかに等しい（OR）

min items 1 · max items 100
not_eqstring[]

どれにも等しくない

min items 1 · max items 100
prefixstring

前方一致

min length 1 · max length 200 · matches ^[^\u0000-\u001f\u007f]*$
suffixstring

後方一致

min length 1 · max length 200 · matches ^[^\u0000-\u001f\u007f]*$
containsstring

部分一致

min length 1 · max length 200 · matches ^[^\u0000-\u001f\u007f]*$
is_nullboolean

true で NULL、false で NULL でない

jurisdiction_codeStringCondition
Show properties
eqstring[]

いずれかに等しい（OR）

min items 1 · max items 100
not_eqstring[]

どれにも等しくない

min items 1 · max items 100
prefixstring

前方一致

min length 1 · max length 200 · matches ^[^\u0000-\u001f\u007f]*$
suffixstring

後方一致

min length 1 · max length 200 · matches ^[^\u0000-\u001f\u007f]*$
containsstring

部分一致

min length 1 · max length 200 · matches ^[^\u0000-\u001f\u007f]*$
is_nullboolean

true で NULL、false で NULL でない

account_nameStringCondition
Show properties
eqstring[]

いずれかに等しい（OR）

min items 1 · max items 100
not_eqstring[]

どれにも等しくない

min items 1 · max items 100
prefixstring

前方一致

min length 1 · max length 200 · matches ^[^\u0000-\u001f\u007f]*$
suffixstring

後方一致

min length 1 · max length 200 · matches ^[^\u0000-\u001f\u007f]*$
containsstring

部分一致

min length 1 · max length 200 · matches ^[^\u0000-\u001f\u007f]*$
is_nullboolean

true で NULL、false で NULL でない

axisStringCondition
Show properties
eqstring[]

いずれかに等しい（OR）

min items 1 · max items 100
not_eqstring[]

どれにも等しくない

min items 1 · max items 100
prefixstring

前方一致

min length 1 · max length 200 · matches ^[^\u0000-\u001f\u007f]*$
suffixstring

後方一致

min length 1 · max length 200 · matches ^[^\u0000-\u001f\u007f]*$
containsstring

部分一致

min length 1 · max length 200 · matches ^[^\u0000-\u001f\u007f]*$
is_nullboolean

true で NULL、false で NULL でない

is_subjectBooleanCondition
Show properties
eqbooleanrequired
node_kindStringCondition
Show properties
eqstring[]

いずれかに等しい（OR）

min items 1 · max items 100
not_eqstring[]

どれにも等しくない

min items 1 · max items 100
prefixstring

前方一致

min length 1 · max length 200 · matches ^[^\u0000-\u001f\u007f]*$
suffixstring

後方一致

min length 1 · max length 200 · matches ^[^\u0000-\u001f\u007f]*$
containsstring

部分一致

min length 1 · max length 200 · matches ^[^\u0000-\u001f\u007f]*$
is_nullboolean

true で NULL、false で NULL でない

codeStringCondition
Show properties
eqstring[]

いずれかに等しい（OR）

min items 1 · max items 100
not_eqstring[]

どれにも等しくない

min items 1 · max items 100
prefixstring

前方一致

min length 1 · max length 200 · matches ^[^\u0000-\u001f\u007f]*$
suffixstring

後方一致

min length 1 · max length 200 · matches ^[^\u0000-\u001f\u007f]*$
containsstring

部分一致

min length 1 · max length 200 · matches ^[^\u0000-\u001f\u007f]*$
is_nullboolean

true で NULL、false で NULL でない

nameStringCondition
Show properties
eqstring[]

いずれかに等しい（OR）

min items 1 · max items 100
not_eqstring[]

どれにも等しくない

min items 1 · max items 100
prefixstring

前方一致

min length 1 · max length 200 · matches ^[^\u0000-\u001f\u007f]*$
suffixstring

後方一致

min length 1 · max length 200 · matches ^[^\u0000-\u001f\u007f]*$
containsstring

部分一致

min length 1 · max length 200 · matches ^[^\u0000-\u001f\u007f]*$
is_nullboolean

true で NULL、false で NULL でない

amount_yenIntegerCondition
Show properties
eqinteger[]
min items 1 · max items 100
not_eqinteger[]
min items 1 · max items 100
mininteger

以上

maxinteger

以下

is_nullboolean
is_leafBooleanCondition
Show properties
eqbooleanrequired
kan_codeStringCondition
Show properties
eqstring[]

いずれかに等しい（OR）

min items 1 · max items 100
not_eqstring[]

どれにも等しくない

min items 1 · max items 100
prefixstring

前方一致

min length 1 · max length 200 · matches ^[^\u0000-\u001f\u007f]*$
suffixstring

後方一致

min length 1 · max length 200 · matches ^[^\u0000-\u001f\u007f]*$
containsstring

部分一致

min length 1 · max length 200 · matches ^[^\u0000-\u001f\u007f]*$
is_nullboolean

true で NULL、false で NULL でない

kou_codeStringCondition
Show properties
eqstring[]

いずれかに等しい（OR）

min items 1 · max items 100
not_eqstring[]

どれにも等しくない

min items 1 · max items 100
prefixstring

前方一致

min length 1 · max length 200 · matches ^[^\u0000-\u001f\u007f]*$
suffixstring

後方一致

min length 1 · max length 200 · matches ^[^\u0000-\u001f\u007f]*$
containsstring

部分一致

min length 1 · max length 200 · matches ^[^\u0000-\u001f\u007f]*$
is_nullboolean

true で NULL、false で NULL でない

moku_codeStringCondition
Show properties
eqstring[]

いずれかに等しい（OR）

min items 1 · max items 100
not_eqstring[]

どれにも等しくない

min items 1 · max items 100
prefixstring

前方一致

min length 1 · max length 200 · matches ^[^\u0000-\u001f\u007f]*$
suffixstring

後方一致

min length 1 · max length 200 · matches ^[^\u0000-\u001f\u007f]*$
containsstring

部分一致

min length 1 · max length 200 · matches ^[^\u0000-\u001f\u007f]*$
is_nullboolean

true で NULL、false で NULL でない

origin_idStringCondition
Show properties
eqstring[]

いずれかに等しい（OR）

min items 1 · max items 100
not_eqstring[]

どれにも等しくない

min items 1 · max items 100
prefixstring

前方一致

min length 1 · max length 200 · matches ^[^\u0000-\u001f\u007f]*$
suffixstring

後方一致

min length 1 · max length 200 · matches ^[^\u0000-\u001f\u007f]*$
containsstring

部分一致

min length 1 · max length 200 · matches ^[^\u0000-\u001f\u007f]*$
is_nullboolean

true で NULL、false で NULL でない

source_pageIntegerCondition
Show properties
eqinteger[]
min items 1 · max items 100
not_eqinteger[]
min items 1 · max items 100
mininteger

以上

maxinteger

以下

is_nullboolean
source_x0NumberCondition
Show properties
minnumber

以上

maxnumber

以下

is_nullboolean
source_y0NumberCondition
Show properties
minnumber

以上

maxnumber

以下

is_nullboolean
source_x1NumberCondition
Show properties
minnumber

以上

maxnumber

以下

is_nullboolean
source_y1NumberCondition
Show properties
minnumber

以上

maxnumber

以下

is_nullboolean
amount_source_pageIntegerCondition
Show properties
eqinteger[]
min items 1 · max items 100
not_eqinteger[]
min items 1 · max items 100
mininteger

以上

maxinteger

以下

is_nullboolean
amount_source_x0NumberCondition
Show properties
minnumber

以上

maxnumber

以下

is_nullboolean
amount_source_y0NumberCondition
Show properties
minnumber

以上

maxnumber

以下

is_nullboolean
amount_source_x1NumberCondition
Show properties
minnumber

以上

maxnumber

以下

is_nullboolean
amount_source_y1NumberCondition
Show properties
minnumber

以上

maxnumber

以下

is_nullboolean
kan_nameStringCondition
Show properties
eqstring[]

いずれかに等しい（OR）

min items 1 · max items 100
not_eqstring[]

どれにも等しくない

min items 1 · max items 100
prefixstring

前方一致

min length 1 · max length 200 · matches ^[^\u0000-\u001f\u007f]*$
suffixstring

後方一致

min length 1 · max length 200 · matches ^[^\u0000-\u001f\u007f]*$
containsstring

部分一致

min length 1 · max length 200 · matches ^[^\u0000-\u001f\u007f]*$
is_nullboolean

true で NULL、false で NULL でない

kou_nameStringCondition
Show properties
eqstring[]

いずれかに等しい（OR）

min items 1 · max items 100
not_eqstring[]

どれにも等しくない

min items 1 · max items 100
prefixstring

前方一致

min length 1 · max length 200 · matches ^[^\u0000-\u001f\u007f]*$
suffixstring

後方一致

min length 1 · max length 200 · matches ^[^\u0000-\u001f\u007f]*$
containsstring

部分一致

min length 1 · max length 200 · matches ^[^\u0000-\u001f\u007f]*$
is_nullboolean

true で NULL、false で NULL でない

cofog_statusStringCondition
Show properties
eqstring[]

いずれかに等しい（OR）

min items 1 · max items 100
not_eqstring[]

どれにも等しくない

min items 1 · max items 100
prefixstring

前方一致

min length 1 · max length 200 · matches ^[^\u0000-\u001f\u007f]*$
suffixstring

後方一致

min length 1 · max length 200 · matches ^[^\u0000-\u001f\u007f]*$
containsstring

部分一致

min length 1 · max length 200 · matches ^[^\u0000-\u001f\u007f]*$
is_nullboolean

true で NULL、false で NULL でない

cofog_codeStringCondition
Show properties
eqstring[]

いずれかに等しい（OR）

min items 1 · max items 100
not_eqstring[]

どれにも等しくない

min items 1 · max items 100
prefixstring

前方一致

min length 1 · max length 200 · matches ^[^\u0000-\u001f\u007f]*$
suffixstring

後方一致

min length 1 · max length 200 · matches ^[^\u0000-\u001f\u007f]*$
containsstring

部分一致

min length 1 · max length 200 · matches ^[^\u0000-\u001f\u007f]*$
is_nullboolean

true で NULL、false で NULL でない

account_kindStringCondition
Show properties
eqstring[]

いずれかに等しい（OR）

min items 1 · max items 100
not_eqstring[]

どれにも等しくない

min items 1 · max items 100
prefixstring

前方一致

min length 1 · max length 200 · matches ^[^\u0000-\u001f\u007f]*$
suffixstring

後方一致

min length 1 · max length 200 · matches ^[^\u0000-\u001f\u007f]*$
containsstring

部分一致

min length 1 · max length 200 · matches ^[^\u0000-\u001f\u007f]*$
is_nullboolean

true で NULL、false で NULL でない

is_interfund_transferBooleanCondition
Show properties
eqbooleanrequired
interfund_transfer_toStringCondition
Show properties
eqstring[]

いずれかに等しい（OR）

min items 1 · max items 100
not_eqstring[]

どれにも等しくない

min items 1 · max items 100
prefixstring

前方一致

min length 1 · max length 200 · matches ^[^\u0000-\u001f\u007f]*$
suffixstring

後方一致

min length 1 · max length 200 · matches ^[^\u0000-\u001f\u007f]*$
containsstring

部分一致

min length 1 · max length 200 · matches ^[^\u0000-\u001f\u007f]*$
is_nullboolean

true で NULL、false で NULL でない

expenditure_setsu_idStringCondition
Show properties
eqstring[]

いずれかに等しい（OR）

min items 1 · max items 100
not_eqstring[]

どれにも等しくない

min items 1 · max items 100
prefixstring

前方一致

min length 1 · max length 200 · matches ^[^\u0000-\u001f\u007f]*$
suffixstring

後方一致

min length 1 · max length 200 · matches ^[^\u0000-\u001f\u007f]*$
containsstring

部分一致

min length 1 · max length 200 · matches ^[^\u0000-\u001f\u007f]*$
is_nullboolean

true で NULL、false で NULL でない

order_byobject[]

並び順。末尾に node_id が足される。

max items 5
Show properties
Array of object
columnstringrequired
Allowed:node_idparent_node_idjurisdiction_codefiscal_yearaccount_nameaxisis_subjectnode_kindcodenameamount_yenis_leafkan_codekou_codemoku_codeorigin_idsource_pagesource_x0source_y0source_x1source_y1amount_source_pageamount_source_x0amount_source_y0amount_source_x1amount_source_y1kan_namekou_namecofog_statuscofog_codeaccount_kindis_interfund_transferinterfund_transfer_toexpenditure_setsu_id
descboolean
page_sizeinteger

1ページの件数。

min 1 · max 1000 · default: 100
page_tokenstring

前回の応答の next_page_token。page_size 以外は前回と同じ入力にする。

max length 512 · matches ^[A-Za-z0-9_-]*$
where_conditionsobjectrequired
sum_rulesstring[]required
columnsobject[]required
Show properties
Array of object
namestringrequired
typestringrequired
descriptionobjectrequired
origin_columnsobject[]required
Show properties
Array of object
namestringrequired
typestringrequired
descriptionstring | nullrequired
nullableboolean
400

入力が不正

errorobjectrequired
Show properties
codestringrequired
messagestringrequired
404

見つからない

errorobjectrequired
Show properties
codestringrequired
messagestringrequired
503

提供を止めている

errorobjectrequired
Show properties
codestringrequired
messagestringrequired
Request
curl -X GET 'https://api.fudoki.dev/v1/expenditure/columns' \
  -H 'Accept: application/json'
Response
{
  "document_kinds": [
    {
      "name": "string",
      "description": "string"
    }
  ],
  "where_columns": [
    "string"
  ],
  "order_by_columns": [
    "string"
  ],
  "required_input": "string",
  "search_example": {
    "document_kind": "settlement",
    "fiscal_year": {
      "min": 1,
      "max": 1
    },
    "where": {
      "node_id": {
        "eq": [
          "string"
        ],
        "not_eq": [
          "string"
        ],
        "prefix": "string",
        "suffix": "string",
        "contains": "string",
        "is_null": true
      },
      "parent_node_id": {
        "eq": [
          "string"
        ],
        "not_eq": [
          "string"
        ],
        "prefix": "string",
        "suffix": "string",
        "contains": "string",
        "is_null": true
      },
      "jurisdiction_code": {
        "eq": [
          "string"
        ],
        "not_eq": [
          "string"
        ],
        "prefix": "string",
        "suffix": "string",
        "contains": "string",
        "is_null": true
      },
      "account_name": {
        "eq": [
          "string"
        ],
        "not_eq": [
          "string"
        ],
        "prefix": "string",
        "suffix": "string",
        "contains": "string",
        "is_null": true
      },
      "axis": {
        "eq": [
          "string"
        ],
        "not_eq": [
          "string"
        ],
        "prefix": "string",
        "suffix": "string",
        "contains": "string",
        "is_null": true
      },
      "is_subject": {
        "eq": true
      },
      "node_kind": {
        "eq": [
          "string"
        ],
        "not_eq": [
          "string"
        ],
        "prefix": "string",
        "suffix": "string",
        "contains": "string",
        "is_null": true
      },
      "code": {
        "eq": [
          "string"
        ],
        "not_eq": [
          "string"
        ],
        "prefix": "string",
        "suffix": "string",
        "contains": "string",
        "is_null": true
      },
      "name": {
        "eq": [
          "string"
        ],
        "not_eq": [
          "string"
        ],
        "prefix": "string",
        "suffix": "string",
        "contains": "string",
        "is_null": true
      },
      "amount_yen": {
        "eq": [
          0
        ],
        "not_eq": [
          0
        ],
        "min": 0,
        "max": 0,
        "is_null": true
      },
      "is_leaf": {
        "eq": true
      },
      "kan_code": {
        "eq": [
          "string"
        ],
        "not_eq": [
          "string"
        ],
        "prefix": "string",
        "suffix": "string",
        "contains": "string",
        "is_null": true
      },
      "kou_code": {
        "eq": [
          "string"
        ],
        "not_eq": [
          "string"
        ],
        "prefix": "string",
        "suffix": "string",
        "contains": "string",
        "is_null": true
      },
      "moku_code": {
        "eq": [
          "string"
        ],
        "not_eq": [
          "string"
        ],
        "prefix": "string",
        "suffix": "string",
        "contains": "string",
        "is_null": true
      },
      "origin_id": {
        "eq": [
          "string"
        ],
        "not_eq": [
          "string"
        ],
        "prefix": "string",
        "suffix": "string",
        "contains": "string",
        "is_null": true
      },
      "source_page": {
        "eq": [
          0
        ],
        "not_eq": [
          0
        ],
        "min": 0,
        "max": 0,
        "is_null": true
      },
      "source_x0": {
        "min": 0,
        "max": 0,
        "is_null": true
      },
      "source_y0": {
        "min": 0,
        "max": 0,
        "is_null": true
      },
      "source_x1": {
        "min": 0,
        "max": 0,
        "is_null": true
      },
      "source_y1": {
        "min": 0,
        "max": 0,
        "is_null": true
      },
      "amount_source_page": {
        "eq": [
          0
        ],
        "not_eq": [
          0
        ],
        "min": 0,
        "max": 0,
        "is_null": true
      },
      "amount_source_x0": {
        "min": 0,
        "max": 0,
        "is_null": true
      },
      "amount_source_y0": {
        "min": 0,
        "max": 0,
        "is_null": true
      },
      "amount_source_x1": {
        "min": 0,
        "max": 0,
        "is_null": true
      },
      "amount_source_y1": {
        "min": 0,
        "max": 0,
        "is_null": true
      },
      "kan_name": {
        "eq": [
          "string"
        ],
        "not_eq": [
          "string"
        ],
        "prefix": "string",
        "suffix": "string",
        "contains": "string",
        "is_null": true
      },
      "kou_name": {
        "eq": [
          "string"
        ],
        "not_eq": [
          "string"
        ],
        "prefix": "string",
        "suffix": "string",
        "contains": "string",
        "is_null": true
      },
      "cofog_status": {
        "eq": [
          "string"
        ],
        "not_eq": [
          "string"
        ],
        "prefix": "string",
        "suffix": "string",
        "contains": "string",
        "is_null": true
      },
      "cofog_code": {
        "eq": [
          "string"
        ],
        "not_eq": [
          "string"
        ],
        "prefix": "string",
        "suffix": "string",
        "contains": "string",
        "is_null": true
      },
      "account_kind": {
        "eq": [
          "string"
        ],
        "not_eq": [
          "string"
        ],
        "prefix": "string",
        "suffix": "string",
        "contains": "string",
        "is_null": true
      },
      "is_interfund_transfer": {
        "eq": true
      },
      "interfund_transfer_to": {
        "eq": [
          "string"
        ],
        "not_eq": [
          "string"
        ],
        "prefix": "string",
        "suffix": "string",
        "contains": "string",
        "is_null": true
      },
      "expenditure_setsu_id": {
        "eq": [
          "string"
        ],
        "not_eq": [
          "string"
        ],
        "prefix": "string",
        "suffix": "string",
        "contains": "string",
        "is_null": true
      }
    },
    "order_by": [
      {
        "column": "node_id",
        "desc": true
      }
    ],
    "page_size": 100,
    "page_token": "string"
  },
  "where_conditions": {
    "property1": "string",
    "property2": "string"
  },
  "sum_rules": [
    "string"
  ],
  "columns": [
    {
      "name": "string",
      "type": "string",
      "description": {
        "property1": "string",
        "property2": "string"
      }
    }
  ],
  "origin_columns": [
    {
      "name": "string",
      "type": "string",
      "description": "string",
      "nullable": true
    }
  ]
}

このページは役に立ちましたか？