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

歳出の木のノードの検索

歳出の木のノード(款・項・目と、節・備考など別の軸の内訳)を条件で絞って一覧する。検索の前に describe_expenditure_columns を一度読む。団体の比較は node_kind を “目” などに絞って行い、詳細は get_expenditure_node で木を辿る。資料区分や軸の違う金額を足さない。足すときは describe_expenditure_columns の sum_rules に従う。where は列をまたぐ OR・NOT が無いので、2回に分けて問い合わせる。

POST/v1/expenditure/nodes:search
Request body
requiredapplication/json
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_-]*$
Responses
200

成功

nodesNode[]required
Show properties
Array of Node
document_kindstringrequired
node_idstringrequired
parent_node_idstring | nullrequired
jurisdiction_codestringrequired
fiscal_yearnumberrequired
account_namestringrequired
axisstringrequired
is_subjectbooleanrequired
node_kindstringrequired
codestring | nullrequired
namestringrequired
amount_yennumber | nullrequired
is_leafbooleanrequired
kan_codestringrequired
kou_codestring | nullrequired
moku_codestring | nullrequired
origin_idstringrequired
source_pagenumberrequired
source_x0number | nullrequired
source_y0number | nullrequired
source_x1number | nullrequired
source_y1number | nullrequired
amount_source_pagenumber | nullrequired
amount_source_x0number | nullrequired
amount_source_y0number | nullrequired
amount_source_x1number | nullrequired
amount_source_y1number | nullrequired
kan_namestringrequired
kou_namestring | nullrequired
cofog_statusstring | nullrequired
cofog_codestring | nullrequired
account_kindstringrequired
is_interfund_transferbooleanrequired
interfund_transfer_tostring | nullrequired
expenditure_setsu_idstring | nullrequired
next_page_tokenstring | nullrequired

次のページの token。無ければ null。位置は 100000 件目までで、それ以上は null になるので、条件を絞って問い合わせる。

originsOrigin[]required

結果の行が指す原典。行の origin_id から引く。

Show properties
Array of Origin
origin_idstringrequired
jurisdiction_codestringrequired
fiscal_yearnumberrequired
document_kindstringrequired
amendment_numbernumber | nullrequired
titlestringrequired
urlstringrequired
formatstringrequired
sha256stringrequired
400

入力が不正

errorobjectrequired
Show properties
codestringrequired
messagestringrequired
404

見つからない

errorobjectrequired
Show properties
codestringrequired
messagestringrequired
413

body が 16384 バイトを超える

errorobjectrequired
Show properties
codestringrequired
messagestringrequired
415

Content-Type が application/json でない

errorobjectrequired
Show properties
codestringrequired
messagestringrequired
503

提供を止めている

errorobjectrequired
Show properties
codestringrequired
messagestringrequired
Request
curl -X POST 'https://api.fudoki.dev/v1/expenditure/nodes:search' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "document_kind": "settlement",
  "fiscal_year": {
    "min": 2025,
    "max": 2025
  },
  "where": {
    "node_kind": {
      "eq": [
        "目"
      ]
    },
    "cofog_code": {
      "prefix": "10.4"
    }
  },
  "order_by": [
    {
      "column": "amount_yen",
      "desc": true
    }
  ],
  "page_size": 50
}'
Response
{
  "nodes": [
    {
      "document_kind": "string",
      "node_id": "string",
      "parent_node_id": "string",
      "jurisdiction_code": "string",
      "fiscal_year": 0,
      "account_name": "string",
      "axis": "string",
      "is_subject": true,
      "node_kind": "string",
      "code": "string",
      "name": "string",
      "amount_yen": 0,
      "is_leaf": true,
      "kan_code": "string",
      "kou_code": "string",
      "moku_code": "string",
      "origin_id": "string",
      "source_page": 0,
      "source_x0": 0,
      "source_y0": 0,
      "source_x1": 0,
      "source_y1": 0,
      "amount_source_page": 0,
      "amount_source_x0": 0,
      "amount_source_y0": 0,
      "amount_source_x1": 0,
      "amount_source_y1": 0,
      "kan_name": "string",
      "kou_name": "string",
      "cofog_status": "string",
      "cofog_code": "string",
      "account_kind": "string",
      "is_interfund_transfer": true,
      "interfund_transfer_to": "string",
      "expenditure_setsu_id": "string"
    }
  ],
  "next_page_token": "string",
  "origins": [
    {
      "origin_id": "string",
      "jurisdiction_code": "string",
      "fiscal_year": 0,
      "document_kind": "string",
      "amendment_number": 0,
      "title": "string",
      "url": "string",
      "format": "string",
      "sha256": "string"
    }
  ]
}

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