Webサービス(SOAP通信)により仕訳勘定科目の照会を実施する公開サービス を提供する。
財務会計システムからの要求電文に設定された科目情報をもとに、資金仕訳変 換表を検索し、対応する仕訳勘定科目のリストを応答電文として返信する。
なお、Webサービスインターフェース情報(WSDL)は、日々仕訳用のサーバのセ ットアップ完了後、以下のURLからダウンロードが可能である。
(DNSを使用している場合)
http://<サーバのFQDN>:10080/zaims_soap/
ZAIMS_SEARCH_SWKCODE_LIST_PSV?wsdl
(DNSを使用していない場合)
http://<サーバのホスト名称>:10080/zaims_soap/
ZAIMS_SEARCH_SWKCODE_LIST_PSV?wsdl また、仕訳勘定科目の照会の要求電文は、以下のURLに送信すること。
(DNSを使用している場合)
http://<サーバのFQDN>:10080/zaims_soap/
ZAIMS_SEARCH_SWKCODE_LIST_PSV
(DNSを使用していない場合)
http://<サーバのホスト名称>:10080/ zaims_soap/
ZAIMS_SEARCH_SWKCODE_LIST_PSV A. 要求電文
SOAP通信の要求電文フォーマットを以下の表に示す。
表 7-1 要求電文フォーマット
項番 タグ名 項目名 階層 繰返し 備考
(1) <root> ルート 1 1
(2) <header> ヘッダー部 2 1
(3) <auth> 認証・認可情報 3 1
(4) <userId> ユーザID 4 1
(5) <szkCd> 所属コード 4 1
(6) <ticket> 認証チケット 4 1
(7) <service> 公開サービス情報 3 1
(8) <name> 公開サービス名 4 1
(9) <logInfo> ログ情報 3 1
(10) <date> 要求時の日時分秒 4 1
(11) <clientIp> クライアントIPアドレス 4 1
(12) <appId> システムID 4 1
(13) <body> ボディー部 2 1 (14) <request> リクエスト情報 3 1
(15) serviceName 情報サービス名 - 1 リクエスト情報の属
性値 (16) <params> 照会パラメータ群 4 1
(17) <param> 照会パラメータ項目 5 {1, }
(18) itemName 照会パラメータ名 - 1 照会パラメータ項目
の属性値
(凡例:タグ名) (凡例:繰返し)
< … >:要素(element) 1 :1回(繰返し無し) … :属性(attribute) {1, }:1回以上の繰返し
※各タグで設定が必要な最下層項目について、その設定内容を以下に示す。
(4)ユーザID
要求電文を発行したユーザIDを設定する。
(5)所属コード
要求電文を発行したユーザの所属コードを設定する。
(6)認証チケット
要求電文を発行したユーザの認証チケット情報を設定する。
(8)公開サービス名
仕訳勘定科目照会の公開サービス名である「ZAIMS_SEARCH_SWKCODE_LIST_
PSV」を設定する。
(10)要求時の日時分秒
ログに出力される情報として、要求電文を発行した日時を「YYYY/MM/DD hh:mm:ss」形式で設定する。
(11)クライアントIPアドレス
ログに出力される情報として、要求電文を発行したユーザのクライアント IPアドレスを設定する。
(12)システムID
ログに出力される情報として、要求電文を発行したシステムIDを設定す る。
リクエスト情報の属性として、仕訳勘定科目照会の情報サービス名である
「ZAIMS_SEARCH_SWKCODE_LIST」を設定する。
(18)照会パラメータ項目:照会パラメータ名
照会する仕訳勘定科目の検索条件となるパラメータを以下の表に示す。
表 7-2 要求電文項目 項番 照会パラメータ名
(物理英字名)
属性 桁数 必須 備考 (1) 自治体コード
(JttiCd)
半角数字 5 ○ (2) 団体コード
(DntCd)
半角数字 3 ○ (3) 伝票種別
(DnpyType)
半角英数字 2 ○ (4) 振替種別
(FrkeType)
半角数字 2 ○ (5) 振替元先区分
(FrkaMsKbn)
半角数字 1 ○ (6) 調定増減区分
(CytiZgnKbn)
半角数字 1 ○ (7) 処理区分
(SyoriKbn)
半角数字 1 ○ (8) 会計年度
(Nendo)
半角数字 4 ○ (9) 会計コード
(KikiCd)
半角数字 3 ○ (10) 款項目コード
(KnkomkCd)
半角英数字 19 △ 歳入データの場合、必須。
歳出データで「事業コード」
が未入力の場合、必須。
(11) 事業コード
(JgyoCd)
半角英数字 20 △ 歳入データの場合は、設定し てもシステムには反映され ない。
(12) 節細節細々節コード
(SsstCd)
半角英数字 20 △ 歳出データの場合、かつ事業 コードの設定がない場合は 必須。
(13) 予備項目1
(Reserve1)
半角英数字 20 △ (14) 予備項目2
(Reserve2)
半角英数字 20 △ (15) 予備項目3
(Reserve3)
半角英数字 20 △
(物理英字名)
(16) 予備項目4
(Reserve4)
半角英数字 20 △ (17) 予備項目5
(Reserve5)
半角英数字 20 △ (18) 予備項目6
(Reserve6)
半角英数字 20 △ (19) 予備項目7
(Reserve7)
半角英数字 20 △ (20) 予備項目8
(Reserve8)
半角英数字 20 △ (21) 予備項目9
(Reserve9)
半角英数字 20 △ (22) 予備項目10
(Reserve10)
半角英数字 20 △
(凡例)
〇:必須
△:任意
(1)自治体コード
全国地方公共団体コードを、末尾のチェックデジットは省いて、5桁で設 定する。
(2)団体コード
団体のコードを設定する。あらかじめ、団体会計コードマスタに登録して おく必要がある。
(3)伝票種別
財務会計システムにおける伝票種別を設定する。あらかじめ、財務書類管 理コードマスタ(管理種別:004)に登録しておく必要がある。
(4)振替種別
歳入の収入額振替か、還付額振替等を識別する振替種別を設定する。あら かじめ、財務書類管理コードマスタ(管理種別:004)に、予算執行伝票 種別と連結して登録しておく必要がある。振替伝票以外の場合、00 で設 定する。
(5)振替元先区分
振替元の場合1、振替先の場合2、振替伝票以外の場合0で設定する。
増額調定伝票の場合1、減額調定伝票の場合2、調定伝票以外の場合0で 設定する。
(7)処理区分
通常処理の0を設定する。
(8)会計年度
会計年度(西暦のYYYY)を設定する。
(9)会計コード
会計のコードを設定する。あらかじめ、団体会計コードマスタに登録して おく必要がある。
(10)款項目コード
歳入・歳出共に、目コード(予算科目コードマスタにレベル区分03で登 録したコード)を設定する。歳出で事業コードが設定されている場合は、
自動的に補完する。事業コードと款項目コードが両方設定されている場合 は、設定されている款項目コードをそのまま設定する。あらかじめ、予算 科目コードマスタに登録しておく必要がある。
(11)事業コード
事業コードを設定する。あらかじめ、事業コードマスタに登録しておく必 要がある。
(12)節細節細々節コード
① 歳入の場合
予算科目コードマスタに設定した款項目コード+節コード+細節コー ド+細々節コードを設定する。
② 歳出の場合
・共通細節あるいは共通細々節の場合
歳出節細節細々節コードマスタにレベル区分02または03で登録し たコード。
・自由細節あるいは自由細々節の場合
事業節細節細々節コードマスタにレベル区分02または03で登録し たコード。
(13)~(22)予備項目1~10
拡張用の項目である。空文字を設定する。
SOAP通信の応答電文フォーマットを以下の表に示す。
表 7-3 応答電文フォーマット
項番 タグ名 項目名 階層 繰返し 備考
(1) <root> ルート 1 1
(2) <header> ヘッダー部 2 1
(3) <auth> 認証・認可情報 3 1
(4) <userId> ユーザID 4 1
(5) <szkCd> 所属コード 4 1
(6) <ticket> 認証チケット 4 1
(7) <service> 公開サービス情報 3 1
(8) <name> 公開サービス名 4 1
(9) <logInfo> ログ情報 3 1
(10) <date> 要求時の日時分秒 4 1
(11) <clientIp> クライアントIPアドレス 4 1
(12) <appId> システムID 4 1
(13) <error> エラー情報 3 {0,1} エ ラ ー 発 生 時 のみ 設定
(14) <errorCode> エラーコード 4 1 (15) <errorMsg> エラーメッセージ 4 1 (16) <errorLevel> エラーレベル 4 1
(17) <body> ボディー部 2 1
(18) <response> レスポンス情報 3 {0,1} エ ラ ー 発 生 時 は省 略
(19) <resultCount> 照会結果件数 4 1
(20) <swkKbn> 仕訳区分 4 1
(21) <dataSet> 照会データ群 4 1 (22) <swkPtn> 仕訳パターン 5 {1, } (23) <swkPtnCd> 仕訳パターンコード 6 1
(24) swkZks 仕訳パターン属性 - 1
(25) <data> 照会データ 6 {1, } (26) <account> 照会勘定科目情報 7 {1, } (27) itemName 照会データ名 - 1
(凡例:タグ名) (凡例:繰返し)
< … >:要素(element) 1 :1回(繰返し無し)
… :属性(attribute) {0,1}:0回もしくは1回
{1, }:1回以上の繰返し
(1)<root>~(12)<clientIp>までは要求電文の内容をそのまま設定して返信する。
(13)エラーコード
照会処理でエラーが発生した場合に、エラー情報としてエラーコードが設 定される。
(14)エラーメッセージ
照会処理でエラーが発生した場合に、エラー情報としてエラーメッセージ が設定される。
(15)エラーレベル
照会処理でエラーが発生した場合に、エラー情報としてエラーレベルが設 定される。
(19)照会結果件数
照会結果の仕訳勘定科目リスト数が設定される。
(20)仕訳区分
要求電文の科目情報に合致した仕訳勘定科目が、確定仕訳の場合1、仮仕 訳の場合2が設定される。
(23)仕訳パターンコード
仕訳勘定科目の仕訳パターンコードが設定される。
仕訳パターンコードマスタに登録された仕訳勘定科目の仕訳パターンコ ードが設定される。
(24)仕訳パターンコード:仕訳パターン属性
仕訳パターンコードの拡張用の属性である。空文字を設定する。
(27)照会勘定科目情報:照会データ名
照会された仕訳勘定科目情報として設定される照会データを以下の表に 示す。
表 7-4 応答電文項目 項番 照会データ名
(物理英字名)
属性 桁数 必須 備考 (1) 勘定科目属性
(KmkZksei)
半角数字 1 ○ (2) 自動仕訳区分
(AutoSwkKbn)
半角数字 1 ○ (3) 整理仕訳要否区分
(SrSwkYhKbn)
半角数字 1 ○
(物理英字名)
(4) 借方勘定科目区分
(DrSheetType)
半角数字 1 ○ (5) 借方表名称
(DrSheetName)
全半角文字 40 ○ (6) 借方勘定科目連番
(DrAccountCode)
半角数字 3 ○ (7) 借方勘定科目枝番
(DrAccountBranchC ode)
半角数字 3 ○
(8) 借方勘定科目名称
(DrAccountTitle)
全半角文字 40 ○ (9) 貸方勘定科目区分
(CrSheetType)
半角数字 1 ○ (10) 貸方表名称
(CrSheetName)
全半角文字 40 ○ (11) 貸方勘定科目連番
(CrAccountCode)
半角数字 3 ○ (12) 貸方勘定科目枝番
(CrAccountBranchC ode)
半角数字 3 ○
(13) 貸方勘定科目名称
(CrAccountTitle)
全半角文字 40 ○
(凡例)
〇:必須 (1)勘定科目属性
仕訳勘定科目が確定用の場合1、未収未払用の場合2、支払収入用の場合 3が設定される。
(2)自動仕訳区分
予算科目から勘定科目への変換が、確定仕訳の場合1、仮仕訳の場合2が 設定される。
(3)整理仕訳要否区分
整理仕訳の発行が必要である場合1、整理仕訳の発行が不要の場合0が設 定される。
(7)借方勘定科目枝番/(8)借方勘定科目名称 借方の勘定科目コードが設定される。
名称には、財務書類管理コードマスタ(管理種別:031)に登録されてい る勘定科目区分の枝名称と、勘定科目コードマスタに登録されている勘定 科目名称が設定される。
(9)貸方勘定科目区分/(10)貸方表名称/(11)貸方勘定科目連番/
(12)貸方勘定科目枝番/(13)貸方勘定科目名称 貸方の勘定科目コードが設定される。
名称には、財務書類管理コードマスタ(管理種別:031)に登録されてい る勘定科目区分の枝名称と、勘定科目コードマスタに登録されている勘定 科目名称が設定される。