特別徴収地方税

配信登録

Endpoints

production

development

https://developer.api.bk.mufg.jp

Custom Gateway API Endpoint

パス

/

サマリー

特別徴収地方税申請

説明

以下の方法により当APIを試行することが可能です。
　①当画面でのボタン操作による呼び出し
　②開発者の皆さまにご用意いただいたアプリやツールからの呼び出し

※当API試行環境において、認証・認可スキームは実装しておりません。
※アクセス先は、画面右側（黒背景）に記載の「要求の例」をご確認ください。
※当画面でAPIを試行する際、下記「定義」の仕様説明をご確認の上、リクエスト本文を編集してください。
※後述の「添付ファイル」は、「利用コース」→「法人API体験コース」の画面にてご確認ください。

概要
　BizSTATIONに登録したサービス指定口座から、任意の口座への特別徴収地方税納入を申請します。（1申請で最大500明細）

1) 引落口座として指定可能な口座

　添付ファイル「テスト用ダミーデータ一覧」記載の口座のみ、引落口座として指定できます。
　以外の口座を指定した場合は、エラーとなります。
　また、1度の申請で指定できるのは1口座のみで、複数の引落口座は指定できません。

2) 利用可能な科目

　普通預金、当座預金です。

3) 振込の単位

　最大500明細の特別徴収地方税申請が可能です。

4) エラー時の応答について

　申請したデータに１明細でも異常がある場合は、申請できません。
　申請したデータに異常があった場合、異常のあったデータに応じて以下のエラー応答を返却します。
　エラー応答の詳細は、添付ファイル「【総給振】エラー応答」および、下記「定義」をご参照ください。

　【異常明細があり、申請が完了しなかった場合】
　申請したデータにI/Fフォーマットエラー（属性異常、桁数異常）以外の異常がある場合、応答としてエラーの詳細情報を含んだ「LocalTaxPayment400ErrorResponse」の応答を返却します。

　【その他の場合】
　申請したデータにI/Fフォーマットエラー（属性異常、桁数異常）があった場合は応答として「ErrorResponse」の応答を返却します。

セキュリティー

clientIdHeader

X-IBM-Client-Id

(apiKey located in header)

クライアントID

API利用事業者を識別するＩＤ

header で必須

string

36桁以内

[備考]　X-IBM-Client-Id: （クライアントID文字列）

パラメーター

X-BTMU-Seq-No

header で必須

string

シーケンスNo
API実行を一意に識別できるNo
Nullデータ指定不可
YYYYMMDD-[16桁の英数字(*1)] (*1)YYYYMMDD内で、重複しない値

{
    "minLength": 25,
    "maxLength": 25
}

Content-Type

header で必須

string

コンテントタイプ
フォームの送信の際のコンテントタイプ
Nullデータ指定不可
"application/json"（固定）

header でオプション

string

アプリケーションメディアタイプ
利用可能なデータ形式
Nullデータ指定不可
省略可能。設定する場合は「application/json」または「*/*」のいずれかを指定してください。

CreateLocalTaxPayment

body で必須

object

特別徴収地方税申請リクエストオブジェクト
特別徴収地方税申請の情報
Nullデータ指定不可

CreateLocalTaxPayment

応答

201

正常終了
レスポンス内容は、特別徴収地方税申請レスポンスオブジェクトをご参照ください。
特別徴収地方税申請レスポンスオブジェクト
Nullデータの返却なし

LocalTaxPaymentResponse

400

異常終了（エラー明細あり）
特別徴収地方税申請エラーレスポンスオブジェクト
Nullデータの返却なし

LocalTaxPayment400ErrorResponse

default

異常終了
エラーレスポンスオブジェクト
Nullデータの返却なし

ErrorResponse

要求の例

応答の例

定義

POST https://developer.api.bk.mufg.jp/btmu/corporation/trial/v1/me/localtaxes/

レスポンス

この操作を試してみる

https://developer.api.bk.mufg.jp/btmu/corporation/trial/v1/me/localtaxes/

本文

ヘッダー

content-type

X-BTMU-Seq-No

要求

レスポンス

/{acceptance_no}

サマリー

特別徴収地方税受付明細照会

説明

概要
　APIより申請されたデータの最新の受付状態や明細を返却します。
　照会はAPIからの申請時に返却される受付番号をキーに行います。

1) 照会可能な受付明細

　添付ファイル「テスト用ダミーデータ一覧」記載の受付明細のみ指定できます。
　以外の受付明細を照会した場合は、エラーとなります。

ステータス	概要
申請済	APIより申請され、Web画面上での承認が未済の状態
申請済（差戻）	Web画面上で承認権限者に差し戻された状態
申請済（予約取消）	Web画面上で承認された後に、取り消された状態
一次承認済	Web画面上で一次承認権限者が承認した状態（別の一次承認権限者あるいは承認権限者による承認が必要）
承認済	Web画面上での承認が完了した状態（Web画面上での予約取消は可能）
受付済	Web画面上での承認後、当行の勘定系システムの処理に引き渡した状態（Web画面上での予約取消は不可）

2) 照会の単位

　最大500明細の受付明細照会が可能です。
　（APIで申請可能な最大明細数）

セキュリティー

clientIdHeader

X-IBM-Client-Id

(apiKey located in header)

クライアントID

API利用事業者を識別するＩＤ

header で必須

string

36桁以内

[備考]　X-IBM-Client-Id: （クライアントID文字列）

パラメーター

X-BTMU-Seq-No

header で必須

string

シーケンスNo
API実行を一意に識別できるNo
Nullデータ指定不可
YYYYMMDD-[16桁の英数字(*1)] (*1)YYYYMMDD内で、重複しない値

{
    "minLength": 25,
    "maxLength": 25
}

header でオプション

string

acceptance_no

path で必須

string

受付番号
申請時に返却される受付番号
Nullデータ指定不可
特別徴収地方税申請で返却された受付番号

{
    "minLength": 12,
    "maxLength": 12
}

応答

200

正常終了
レスポンス内容は、特別徴収地方税受付明細照会レスポンスオブジェクトをご参照ください。
特別徴収地方税受付明細照会レスポンスオブジェクト
Nullデータの返却なし

LocalTaxPaymentDetailsInquiryResponse

default

異常終了
エラーレスポンスオブジェクト
Nullデータの返却なし

ErrorResponse

要求の例

応答の例

定義

GET https://developer.api.bk.mufg.jp/btmu/corporation/trial/v1/me/localtaxes/{acceptance_no}

レスポンス

この操作を試してみる

https://developer.api.bk.mufg.jp/btmu/corporation/trial/v1/me/localtaxes/{acceptance_no}

ヘッダー

X-BTMU-Seq-No

パラメーター

acceptance_no

要求

レスポンス

定義

CreateLocalTaxPayment

特別徴収地方税申請リクエストオブジェクト

日本語名	英字名	説明	Nullデータ	備考
納入データ名	localTaxPaymentDataName	納入データの名称	(※1)	全角文字すべて
コード優先フラグ	codeOnlyFlag	特別徴収地方税申請明細オブジェクトの市区町村名を無効とし、市区町村コードのみで納入先を指定	不可	0：コード優先無し、1：コード優先有り
特別徴収地方税申請ロット情報	localTaxPaymentInfo	特別徴収地方税申請ロットオブジェクト参照	不可

(※1) 値を設定しない場合は、キー・値自体を設定しないでください。
"Key"：Null　の指定はできません。

{
    "properties": {
        "localTaxPaymentDataName": {
            "type": "string",
            "description": "納入データ名",
            "minLength": 1,
            "maxLength": 60,
            "example": "０１０１　１月納付分"
        },
        "codeOnlyFlag": {
            "type": "string",
            "description": "コード優先フラグ",
            "minLength": 1,
            "maxLength": 1,
            "example": "0"
        },
        "localTaxPaymentInfo": {
            "description": "特別徴収地方税申請ロット情報",
            "$ref": "#\/definitions\/LocalTaxPaymentRequestInfo"
        }
    },
    "additionalProperties": false,
    "required": [
        "codeOnlyFlag",
        "localTaxPaymentInfo"
    ]
}

LocalTaxPaymentRequestInfo

特別徴収地方税申請ロットオブジェクト

日本語名	英字名	説明	Nullデータ	備考
種別コード	transactionCode	種別コード	不可	99：特別徴収地方税 97：地方税（UFJ） 98：地方税（地銀）
引落口座支店番号	payingBranchNo	引落口座の支店番号	不可	半角数字 "^(\d{3})$"
引落口座預金種目	payingDepositType	引落口座の科目コード	不可	1：普通預金　2：当座預金
引落口座口座番号	payingAccountNo	引落口座の口座番号	不可
納入指定日	dueDate	納入期限	不可	YYYY-MM-DD形式
納入月	monthForWhichPaymentIsDue	納付月	不可	YYYY-MM形式
依頼人名(カナ)	applicantName	依頼人名	不可	全角数字、全角英字、全角カナ、許容記号1(※1)
住所(カナ)	address	住所	不可	全角数字、全角英字、全角カナ、許容記号1(※1)
特別徴収地方税申請明細配列	localTaxPaymentRequestDetails	特別徴収地方税申請の明細情報	不可
給与税件数合計	totalNumberOfPayrollTaxPayments	給与税件数の合計	不可	0～9999999
給与税額合計	totalAmountOfPayrollTaxPayments	給与税額の合計	不可	0～99999999999
退職税件数合計	totalNumberOfRetirementIncomeTaxPayments	退職税件数の合計	不可	0～9999999
退職税額合計	totalAmountOfRetirementIncomeTaxPayments	退職税額の合計	不可	0～99999999999
納入件数合計	totalNumber	納付先の合計	不可	0～9999999
納税額合計	totalAmount	納税額の合計	不可	0～99999999999

(※1) ￥「」（）／＊＆＄，．＠＝％＋；スペースー(カナ長音)－(ハイフン)―(２バイトの長い横棒)‐(２バイトの短い横棒)

　　の計21文字になります。

「ー、－、―、‐」については、全て「－(ハイフン)」に変換して処理されます。

{
    "properties": {
        "transactionCode": {
            "type": "string",
            "description": "種別コード",
            "minLength": 2,
            "maxLength": 2,
            "example": "99"
        },
        "payingBranchNo": {
            "type": "string",
            "description": "引落口座 支店番号",
            "minLength": 3,
            "maxLength": 3,
            "example": "001"
        },
        "payingDepositType": {
            "type": "string",
            "description": "引落口座 預金種目",
            "minLength": 1,
            "maxLength": 1,
            "example": "2"
        },
        "payingAccountNo": {
            "type": "string",
            "description": "引落口座 口座番号",
            "minLength": 7,
            "maxLength": 7,
            "example": "1234567"
        },
        "dueDate": {
            "type": "string",
            "description": "納入指定日",
            "minLength": 10,
            "maxLength": 10,
            "example": "2016-07-10"
        },
        "monthForWhichPaymentIsDue": {
            "type": "string",
            "description": "納入月",
            "minLength": 7,
            "maxLength": 7,
            "example": "2016-06"
        },
        "applicantName": {
            "type": "string",
            "description": "依頼人名(カナ)",
            "minLength": 1,
            "maxLength": 40,
            "example": "エジソンショウジ"
        },
        "address": {
            "type": "string",
            "description": "住所(カナ)",
            "minLength": 1,
            "maxLength": 50,
            "example": "トウキョウ"
        },
        "localTaxPaymentRequestDetails": {
            "type": "array",
            "description": "特別徴収地方税申請明細配列",
            "minItems": 0,
            "maxItems": 500,
            "items": {
                "$ref": "#\/definitions\/LocalTaxPaymentRequestDetailInfo"
            }
        },
        "totalNumberOfPayrollTaxPayments": {
            "type": "integer",
            "format": "int32",
            "description": "給与税件数合計",
            "minimum": 0,
            "maximum": 9999999,
            "example": 1
        },
        "totalAmountOfPayrollTaxPayments": {
            "type": "integer",
            "format": "int64",
            "description": "給与税額合計",
            "minimum": 0,
            "maximum": 99999999999,
            "example": 1000
        },
        "totalNumberOfRetirementIncomeTaxPayments": {
            "type": "integer",
            "format": "int32",
            "description": "退職税件数合計",
            "minimum": 0,
            "maximum": 9999999,
            "example": 1
        },
        "totalAmountOfRetirementIncomeTaxPayments": {
            "type": "integer",
            "format": "int64",
            "description": "退職税額合計",
            "minimum": 0,
            "maximum": 99999999999,
            "example": 1000
        },
        "totalNumber": {
            "type": "integer",
            "description": "納入件数合計",
            "format": "int32",
            "minimum": 0,
            "maximum": 9999999,
            "example": 2
        },
        "totalAmount": {
            "type": "integer",
            "description": "納税額合計",
            "format": "int64",
            "minimum": 0,
            "maximum": 99999999999,
            "example": 2000
        }
    },
    "additionalProperties": false,
    "required": [
        "transactionCode",
        "payingBranchNo",
        "payingDepositType",
        "payingAccountNo",
        "dueDate",
        "monthForWhichPaymentIsDue",
        "applicantName",
        "address",
        "localTaxPaymentRequestDetails",
        "totalNumberOfPayrollTaxPayments",
        "totalAmountOfPayrollTaxPayments",
        "totalNumberOfRetirementIncomeTaxPayments",
        "totalAmountOfRetirementIncomeTaxPayments",
        "totalNumber",
        "totalAmount"
    ]
}

LocalTaxPaymentRequestDetailInfo

特別徴収地方税申請明細オブジェクト

日本語名	英字名	説明	Nullデータ	備考
市区町村コード	municipalityCode	市区町村コード	不可	全銀フォーマット許容文字（※2）
市区町村名（カナ）	municipalityName	市区町村名（カナ）	（※1）	全銀フォーマット許容文字（※2）
指定番号	designatedNumber	指定番号	（※1）	全銀フォーマット許容文字（※2）
異動	change	異動	（※1）	0：異動なし　1：異動あり " "：スペース設定しない場合は" "：スペースと同じ扱い
給与税件数	numberOfPayrollTaxPayments	給与税件数	不可	0～99999
給与税額	amountOfPayrollTaxPayments	給与税額	不可	0～999999999
退職税件数	numberOfRetirementIncomeTaxPayments	退職税件数	不可	0～99999
退職税額	amountOfRetirementIncomeTaxPayments	退職税額	不可	0～999999999
納入件数	totalNumberOfDetails	納入件数	不可	0～99999
納税額	totalAmountOfDetails	納税額	不可	0～999999999
退職人員	numberOfRetirees	退職人員	不可	0～999
退職手当等支払金額	amountOfRetirementBenefitPayments	退職手当等支払金額	不可	0～9999999999
退職明細市区町村民税額	amountOfMunicipalInhabitantTaxPayments	退職明細市区町村民税額	不可	0～999999999
退職明細都道府県民税額	amountOfPrefecturalInhabitantsTaxPayments	退職明細都道府県民税額	不可	0～999999999

(※1) 値を設定しない場合は、キー・値自体を設定しないでください。
Key：Null　の指定はできません。

(※2) 半角/全角英数、半角/全角カナ記号、全銀フォーマット許容記号

（半角/全角文字で、濁点・半濁点、特殊文字（(ｽﾍﾟｰｽ)｡｢｣､･[].<>{}()!&ｰ-*;/,:'+|%_?#@="$））

{
    "properties": {
        "municipalityCode": {
            "type": "string",
            "description": "市区町村コード",
            "minLength": 6,
            "maxLength": 6,
            "example": "131101"
        },
        "municipalityName": {
            "type": "string",
            "description": "市区町村名（カナ）",
            "minLength": 1,
            "maxLength": 15,
            "example": "チヨダク"
        },
        "designatedNumber": {
            "type": "string",
            "description": "指定番号",
            "minLength": 1,
            "maxLength": 15,
            "example": "ＳＨＩＴＥＩ-１２３４５６７８"
        },
        "change": {
            "type": "string",
            "description": "異動",
            "minLength": 1,
            "maxLength": 1,
            "example": "0"
        },
        "numberOfPayrollTaxPayments": {
            "type": "integer",
            "description": "給与税件数",
            "minimum": 0,
            "maximum": 99999,
            "format": "int32",
            "example": 1
        },
        "amountOfPayrollTaxPayments": {
            "type": "integer",
            "description": "給与税額",
            "minimum": 0,
            "maximum": 999999999,
            "format": "int64",
            "example": 1000
        },
        "numberOfRetirementIncomeTaxPayments": {
            "type": "integer",
            "description": "退職税件数",
            "minimum": 0,
            "maximum": 99999,
            "format": "int32",
            "example": 1
        },
        "amountOfRetirementIncomeTaxPayments": {
            "type": "integer",
            "description": "退職税額",
            "minimum": 0,
            "maximum": 999999999,
            "format": "int64",
            "example": 1000
        },
        "totalNumberOfDetails": {
            "type": "integer",
            "description": "納入件数",
            "format": "int32",
            "minimum": 0,
            "maximum": 99999,
            "example": 2
        },
        "totalAmountOfDetails": {
            "type": "integer",
            "description": "納税額",
            "minimum": 0,
            "maximum": 999999999,
            "format": "int64",
            "example": 2000
        },
        "numberOfRetirees": {
            "type": "integer",
            "description": "退職人員",
            "minimum": 0,
            "maximum": 999,
            "format": "int32",
            "example": 300
        },
        "amountOfRetirementBenefitPayments": {
            "type": "integer",
            "description": "退職手当等支払金額",
            "minimum": 0,
            "maximum": 9999999999,
            "format": "int64",
            "example": 8000000
        },
        "amountOfMunicipalInhabitantTaxPayments": {
            "type": "integer",
            "description": "退職明細市区町村民税額",
            "format": "int64",
            "minimum": 0,
            "maximum": 999999999,
            "example": 8000000
        },
        "amountOfPrefecturalInhabitantsTaxPayments": {
            "type": "integer",
            "description": "退職明細都道府県民税額",
            "format": "int64",
            "minimum": 0,
            "maximum": 999999999,
            "example": 8000000
        }
    },
    "additionalProperties": false,
    "required": [
        "municipalityCode",
        "numberOfPayrollTaxPayments",
        "amountOfPayrollTaxPayments",
        "numberOfRetirementIncomeTaxPayments",
        "amountOfRetirementIncomeTaxPayments",
        "totalNumberOfDetails",
        "totalAmountOfDetails",
        "numberOfRetirees",
        "amountOfRetirementBenefitPayments",
        "amountOfMunicipalInhabitantTaxPayments",
        "amountOfPrefecturalInhabitantsTaxPayments"
    ]
}

LocalTaxPaymentResponse

特別徴収地方税申請レスポンスオブジェクト

日本語名	英字名	説明	Nullデータ	備考
申請日	appliedDate	申請した日付	なし	YYYY-MM-DD形式
申請時刻	appliedTime	申請した時刻	なし	HH：MM：SS形式
申請ステータス	appliedStatus	申請した結果	なし	booking：申請中、failed：申請失敗
エラーコード	errorCode	エラーコード	(※1)	申請ステータスがfailedの場合のみ、エラーコードをセット
エラー文言	errorInfo	エラー文言	(※1)	申請ステータスがfailedの場合のみ、エラー文言をセット
申請結果	localTaxPaymentResult	申請結果詳細オブジェクト　参照	なし

(※1) 該当項目にて返却するデータがない場合、キー・値ともに返却しません。

{
    "properties": {
        "appliedDate": {
            "type": "string",
            "description": "申請日",
            "example": "2016-07-15"
        },
        "appliedTime": {
            "type": "string",
            "description": "申請時刻",
            "example": "01:23:04"
        },
        "appliedStatus": {
            "type": "string",
            "description": "申請ステータス",
            "example": "failed"
        },
        "errorCode": {
            "type": "string",
            "description": "エラーコード",
            "example": "APICHD5012"
        },
        "errorInfo": {
            "type": "string",
            "description": "エラー文言",
            "example": "納入明細にエラー分があるため申請できません"
        },
        "localTaxPaymentResult": {
            "description": "申請結果",
            "$ref": "#\/definitions\/LocalTaxPaymentResultInfo"
        }
    },
    "additionalProperties": false
}

LocalTaxPaymentResultInfo

申請結果詳細オブジェクト

日本語名	英字名	説明	Nullデータ	備考
受付番号	acceptanceNo	特別徴収地方税申請受付番号	(※1)	申請ステータスがfailedの場合は、Null 半角数字 "^(\d{12})$"
種別	type	種別	なし（※2）	特別徴収地方税
依頼人名(カナ)	applicantName	依頼人名	なし（※2）	全角数字、全角英字、全角カナ、許容記号1(※3)
住所(カナ)	address	住所	なし（※2）	全角数字、全角英字、全角カナ、許容記号1(※3)
納入月	monthForWhichPaymentIsDue	納入月指定	なし	YYYY-MM形式
納入指定日	dueDate	納入期限	なし（※2）	YYYY-MM-DD形式
納入データ名	localTaxPaymentDataName	納入データの名称	なし（※2）
市区町村数	municipalityCount	市区町村数	（※1）	0～500
給与税件数合計	totalNumberOfPayrollTaxPayments	給与税件数の合計	なし（※2）	0～9999999
給与税額合計	totalAmountOfPayrollTaxPayments	給与税額の合計	なし（※2）	0～99999999999
退職人員合計	totalNumberOfRetirees	退職人員合計	（※1）	0～9999999
退職手当等支払金額合計	totalAmountOfRetirementBenefitPayments	退職手当等支払金額合計	（※1）	0～9999999999999
退職明細市区町村民税額合計	totalAmountOfMunicipalInhabitantTaxPayments	退職明細市区町村民税額合計	（※1）	0～99999999999
退職明細都道府県民税額合計	totalAmountOfPrefecturalInhabitantsTaxPayments	退職明細都道府県民税額合計	（※1）	0～99999999999
納入件数合計	totalNumber	納入件数合計	なし（※2）	0～9999999
納税額合計	totalAmount	納税額合計	なし（※2）	0～99999999999
地方税基本手数料合計	totalBasicCharge	地方税基本手数料合計	（※1）	0～99999999999
他行取次分件数	localTaxCommissionCount	他行取次分件数	（※1）	0～500
為替手数料合計	totalPaymentCharge	為替手数料合計	（※1）	0～99999999999
引落口座支店番号	payingBranchNo	引落口座の支店番号	なし（※2）	半角数字 "^(\d{3})$"
引落口座支店名	payingBranchNameKanji	引落口座の支店名	（※1）	申請ステータスがfailedの場合は、Null
引落口座預金種目	payingDepositType	引落口座の科目コード	なし（※2）	リクエスト.引落口座預金種目
引落口座預金種目名	payingDepositTypeName	引落口座の科目名称	（※1）
引落口座口座番号	payingAccountNo	引落口座の口座番号	なし（※2）	リクエスト.引落口座口座番号
引落口座口座名義(漢字)	payingAccountNameKanji	引落口座の名義（漢字）	（※1）	引落口座の名義（漢字）・取引先名（漢字）＋付属取引先名（漢字）・取引先名（漢字）がないとき、　取引先名（カナ）＋付属取引先名（カナ）
引落口座口座名義(カナ)	payingAccountName	引落口座の名義（カナ）	（※1）	引落口座の名義（カナ）取引先名（カナ）＋付属取引先名（カナ）
エラー明細件数	numberOfError	エラー明細の件数	なし	0～500
エラー情報配列	localTaxPaymentError	エラー明細の内容（リクエスト）	（※1）

(※1) 該当項目にて返却するデータがない場合、キー・値ともに返却しません。

(※2) リクエストの値を返却するケースで、リクエストの値が設定されていない場合はNullとなる。

(※3) ￥「」（）／＊＆＄，．＠＝％＋；スペースー(カナ長音)－(ハイフン)―(２バイトの長い横棒)‐(２バイトの短い横棒)　

　　の計21文字になります。

「ー、－、―、‐」については、全て「－(ハイフン)」に変換して処理されます。

{
    "properties": {
        "acceptanceNo": {
            "type": "string",
            "description": "受付番号",
            "example": "201702134567"
        },
        "type": {
            "type": "string",
            "description": "種別",
            "example": "特別徴収地方税"
        },
        "applicantName": {
            "type": "string",
            "description": "依頼人名(カナ)",
            "example": "エジソンショウジ"
        },
        "address": {
            "type": "string",
            "description": "住所(カナ)",
            "example": "トウキョウ"
        },
        "monthForWhichPaymentIsDue": {
            "type": "string",
            "description": "納入月",
            "example": "2016-06"
        },
        "dueDate": {
            "type": "string",
            "description": "納入指定日",
            "example": "2016-07-10"
        },
        "localTaxPaymentDataName": {
            "type": "string",
            "description": "納入データ名",
            "example": "０１０１　1月納付分"
        },
        "municipalityCount": {
            "type": "integer",
            "description": "市区町村数",
            "format": "int32",
            "example": 2
        },
        "totalNumberOfPayrollTaxPayments": {
            "type": "integer",
            "description": "給与税件数合計",
            "format": "int32",
            "example": 3
        },
        "totalAmountOfPayrollTaxPayments": {
            "type": "integer",
            "description": "給与税額合計",
            "format": "int64",
            "example": 8020
        },
        "totalNumberOfRetirees": {
            "type": "integer",
            "description": "退職人員合計",
            "format": "int32",
            "example": 11212
        },
        "totalAmountOfRetirementBenefitPayments": {
            "type": "integer",
            "description": "退職手当等支払金額合計",
            "format": "int64",
            "example": 3000
        },
        "totalAmountOfMunicipalInhabitantTaxPayments": {
            "type": "integer",
            "description": "退職明細市区町村民税額合計",
            "format": "int64",
            "example": 101
        },
        "totalAmountOfPrefecturalInhabitantsTaxPayments": {
            "type": "integer",
            "description": "退職明細都道府県民税額合計",
            "format": "int64",
            "example": 202
        },
        "totalNumber": {
            "type": "integer",
            "description": "納入件数合計",
            "format": "int32",
            "example": 3
        },
        "totalAmount": {
            "type": "integer",
            "description": "納税額合計",
            "format": "int64",
            "example": 8020
        },
        "totalBasicCharge": {
            "type": "integer",
            "description": "地方税基本手数料合計",
            "format": "int64",
            "example": 21600
        },
        "localTaxCommissionCount": {
            "type": "integer",
            "description": "他行取次分件数",
            "format": "int32",
            "example": 2
        },
        "totalPaymentCharge": {
            "type": "integer",
            "description": "為替手数料合計",
            "format": "int64",
            "example": 133198
        },
        "payingBranchNo": {
            "type": "string",
            "description": "引落口座 支店番号",
            "example": "001"
        },
        "payingBranchNameKanji": {
            "type": "string",
            "description": "引落口座 支店名",
            "example": "本店"
        },
        "payingDepositType": {
            "type": "string",
            "description": "引落口座 預金種目",
            "example": "2"
        },
        "payingDepositTypeName": {
            "type": "string",
            "description": "引落口座 預金種目名",
            "example": "当座"
        },
        "payingAccountNo": {
            "type": "string",
            "description": "引落口座 口座番号",
            "example": "1234567"
        },
        "payingAccountNameKanji": {
            "type": "string",
            "description": "引落口座 口座名義(漢字)",
            "example": "銀座利用者０７"
        },
        "payingAccountName": {
            "type": "string",
            "description": "引落口座 口座名義(カナ)",
            "example": "ギンザリヨウシャ０７"
        },
        "numberOfError": {
            "type": "integer",
            "description": "エラー明細件数",
            "format": "int32",
            "example": 1
        },
        "localTaxPaymentError": {
            "type": "array",
            "description": "エラー情報配列",
            "items": {
                "$ref": "#\/definitions\/LocalTaxPaymentErrorInfo"
            }
        }
    },
    "additionalProperties": false
}

LocalTaxPaymentErrorInfo

エラー情報詳細オブジェクト

日本語名	英字名	説明	Nullデータ
明細通番	recordNo	リクエスト明細の順番	なし
エラーコード	errorCode	エラーコード	なし
エラー文言	errorInfo	エラー文言	なし
エラーデータ	errorData	エラーとなったリクエストデータ	なし

{
    "properties": {
        "recordNo": {
            "type": "integer",
            "description": "明細通番",
            "format": "int32",
            "example": 1
        },
        "errorCode": {
            "type": "string",
            "description": "エラーコード",
            "example": "APICHD6004"
        },
        "errorInfo": {
            "type": "string",
            "description": "エラー文言",
            "example": "給与件数が正しくありません"
        },
        "errorData": {
            "description": "エラーデータ",
            "$ref": "#\/definitions\/LocalTaxPaymentRequestDetailInfo"
        }
    },
    "additionalProperties": false
}

LocalTaxPaymentDetailsInquiryResponse

特別徴収地方税受付明細照会レスポンスオブジェク

日本語名	英字名	説明	Nullデータ	備考
取引ステータス	transactionStatus	受付明細の状態	なし	"申請済"、"申請済（差戻）"、"申請済（予約取消）"、"一次承認済"、"承認済"、"受付済"
取引ステータスコード	transactionStatusCode	取引ステータスコード	なし	2：申請済、3：一次承認済、 4：承認済、5：処理済
申請済区分	appliedStatusCode	申請済区分	(※1)	1：通常、2：差戻、3：予約取消
操作日	operationDate	当APIを実行した日付	なし	YYYY-MM-DD形式
操作時刻	operationTime	当APIを実行した時刻	なし	HH：MM：SS形式
取引日付	transactionDate	直近の操作の日付　詳細は(※2)	なし	YYYY-MM-DD形式
取引時刻	transactionTime	直近の操作の時刻　詳細は(※2)	なし	HH：MM：SS形式
申請日付	appliedDate	API取引から申請した日付　詳細は(※2) （あるいはWeb上で再申請した場合は、その日付）	(※1)	YYYY-MM-DD形式
申請時刻	appliedTime	API取引から申請した時刻　詳細は(※2) （あるいはWeb上で再申請した場合は、その時刻）	(※1)	HH：MM：SS形式
一次承認日付	firstApprovedDate	Web上で一次承認した日付　詳細は(※2)	(※1)	YYYY-MM-DD形式
一次承認時刻	firstApprovedTime	Web上で一次承認した時刻　詳細は(※2)	(※1)	HH：MM：SS形式
承認日付	approvedDate	Web上で承認した日付　詳細は(※2)	(※1)	YYYY-MM-DD形式
承認時刻	approvedTime	Web上で承認した時刻　詳細は(※2)	(※1)	HH：MM：SS形式
受付番号	acceptanceNo	特別徴収地方税申請時の受付番号	なし	半角数字 "^(\d{12})$"
種別	type	種別	なし	"特別徴収地方税"
依頼人名(カナ)	applicantName	振込依頼人名(カナ)	(※1)	全角数字、全角英字、全角カナ、許容記号1(※3)
住所(カナ)	address	振込依頼人コード	(※1)	全角数字、全角英字、全角カナ、許容記号1(※3)
納入月	monthForWhichPaymentIsDue	納入月	(※1)	YYYY-MM形式
納入指定日	dueDate	納入指定日	(※1)	YYYY-MM-DD形式
納入データ名	localTaxPaymentDataName	納入データ名	(※1)	全角文字すべて
引落口座支店番号	payingBranchNo	引落口座支店番号	なし	半角数字 "^(\d{3})$"
引落口座支店名	payingBranchNameKanji	引落口座支店	なし	全角文字すべて
引落口座預金種目	payingDepositType	引落口座預金種目	なし	1：普通預金　2：当座預金
引落口座預金種目名	payingDepositTypeName	引落口座預金種目名	なし	全角文字すべて
引落口座口座番号	payingAccountNo	引落口座口座番号	なし	半角数字 "^(\d{7})$"
引落口座口座名義(漢字)	payingAccountNameKanji	引落口座口座名義(漢字)	なし	全角文字すべて
引落口座口座名義(カナ)	payingAccountName	引落口座口座名義(カナ)	なし	全角数字、全角英字、全角カナ、許容記号1(※3)
給与税件数合計	totalNumberOfPayrollTaxPayments	給与税件数の合計	なし	0～9999999
給与税額合計	totalAmountOfPayrollTaxPayments	給与税額の合計	なし	0～99999999999
退職人員合計	totalNumberOfRetirees	退職税件数の合計	なし	0～9999999
退職手当等支払金額合計	totalAmountOfRetirementBenefitPayments	退職税額の合計	なし	0～9999999999999
退職明細市区町村民税額合計	totalAmountOfMunicipalInhabitantTaxPayments	退職明細市区町村民税額合計	なし	0～99999999999
退職明細都道府県民税額合計	totalAmountOfPrefecturalInhabitantsTaxPayments	退職明細都道府県民税額合計	なし	0～99999999999
市区町村数	municipalityCount	明細の市区町村数	なし	0～500
納入件数合計	totalNumber	納付先の合計	なし	0～9999999
納税額合計	totalAmount	納税額の合計	なし	0～99999999999
地方税基本手数料合計	totalBasicCharge	地方税基本手数料合計	なし	0～99999999999
他行取次分件数	localTaxCommissionCount	他行取次分件数	なし	0～500
為替手数料合計	totalPaymentCharge	為替手数料合計	なし	0～99999999999
明細配列	normalDetails	明細情報の詳細	なし

(※1) 該当項目にて返却するデータがない場合、キー・値ともに返却しません。

(※2) 取引ステータスによって設定される値が異なり、取引操作によって変わる最新の日時が設定される。

取引ステータス	項目
取引ステータス	取引日付/時刻に設定される内容	申請日付/時刻設定有無	一次承認日付/時刻設定有無	承認日付／時刻設定有無
申請済	APIで申請した日時 Web上で再申請した場合は、その日時	あり	なし	なし
申請済（差戻）	Web上で差戻した日時	あり	なし	なし
申請済（予約取消）	Web上で取り消した日時	あり	なし	なし
一次承認済	Web上で一次承認した日時	あり	あり	なし
承認済	Web上で承認した日時	あり	一次承認から承認した場合のみ、あり	あり
受付済	Web上で承認した日時	あり	一次承認から承認した場合のみ、あり	あり

(※3) ￥「」（）／＊＆＄，．＠＝％＋；スペースー(カナ長音)－(ハイフン)―(２バイトの長い横棒)‐(２バイトの短い横棒)

　　の計21文字になります。

「ー、－、―、‐」については、全て「－(ハイフン)」に変換して処理されます。

{
    "properties": {
        "transactionStatus": {
            "type": "string",
            "description": "取引ステータス",
            "example": "承認済"
        },
        "transactionStatusCode": {
            "type": "string",
            "description": "取引ステータスコード",
            "example": "4"
        },
        "appliedStatusCode": {
            "type": "string",
            "description": "申請済区分",
            "example": "1"
        },
        "operationDate": {
            "type": "string",
            "description": "操作日",
            "example": "2016-07-15"
        },
        "operationTime": {
            "type": "string",
            "description": "操作時刻",
            "example": "01:23:04"
        },
        "transactionDate": {
            "type": "string",
            "description": "取引日付",
            "example": "2016-07-15"
        },
        "transactionTime": {
            "type": "string",
            "description": "取引時刻",
            "example": "01:23:04"
        },
        "appliedDate": {
            "type": "string",
            "description": "申請日付",
            "example": "2016-07-15"
        },
        "appliedTime": {
            "type": "string",
            "description": "申請時刻",
            "example": "01:23:04"
        },
        "firstApprovedDate": {
            "type": "string",
            "description": "一次承認日付",
            "example": "2016-07-15"
        },
        "firstApprovedTime": {
            "type": "string",
            "description": "一次承認時刻",
            "example": "01:23:04"
        },
        "approvedDate": {
            "type": "string",
            "description": "承認日付",
            "example": "2016-07-15"
        },
        "approvedTime": {
            "type": "string",
            "description": "承認時刻",
            "example": "01:23:04"
        },
        "acceptanceNo": {
            "type": "string",
            "description": "受付番号",
            "example": "201702134567"
        },
        "type": {
            "type": "string",
            "description": "種別",
            "example": "特別徴収地方税"
        },
        "applicantName": {
            "type": "string",
            "description": "依頼人名(カナ)",
            "example": "エジソンショウジ"
        },
        "address": {
            "type": "string",
            "description": "住所(カナ)",
            "example": "トウキョウ"
        },
        "monthForWhichPaymentIsDue": {
            "type": "string",
            "description": "納入月",
            "example": "2016-06"
        },
        "dueDate": {
            "type": "string",
            "description": "納入指定日",
            "example": "2016-07-15"
        },
        "localTaxPaymentDataName": {
            "type": "string",
            "description": "納入データ名",
            "example": "０１０１　1月納付分"
        },
        "payingBranchNo": {
            "type": "string",
            "description": "引落口座 支店番号",
            "example": "001"
        },
        "payingBranchNameKanji": {
            "type": "string",
            "description": "引落口座 支店名",
            "example": "本店"
        },
        "payingDepositType": {
            "type": "string",
            "description": "引落口座 預金種目",
            "example": "2"
        },
        "payingDepositTypeName": {
            "type": "string",
            "description": "引落口座 預金種目名",
            "example": "当座"
        },
        "payingAccountNo": {
            "type": "string",
            "description": "引落口座 口座番号",
            "example": "1234567"
        },
        "payingAccountNameKanji": {
            "type": "string",
            "description": "引落口座 口座名義(漢字)",
            "example": "銀座利用者０７"
        },
        "payingAccountName": {
            "type": "string",
            "description": "引落口座 口座名義(カナ)",
            "example": "ギンザリヨウシャ０７"
        },
        "totalNumberOfPayrollTaxPayments": {
            "type": "integer",
            "format": "int32",
            "description": "給与税件数合計",
            "example": 3
        },
        "totalAmountOfPayrollTaxPayments": {
            "type": "integer",
            "format": "int64",
            "description": "給与税額合計",
            "example": 8020
        },
        "totalNumberOfRetirees": {
            "type": "integer",
            "format": "int32",
            "description": "退職人員合計",
            "example": 11212
        },
        "totalAmountOfRetirementBenefitPayments": {
            "type": "integer",
            "format": "int64",
            "description": "退職手当等支払金額合計",
            "example": 3000
        },
        "totalAmountOfMunicipalInhabitantTaxPayments": {
            "type": "integer",
            "format": "int64",
            "description": "退職明細市区町村民税額合計",
            "example": 101
        },
        "totalAmountOfPrefecturalInhabitantsTaxPayments": {
            "type": "integer",
            "format": "int64",
            "description": "退職明細都道府県民税額合計",
            "example": 202
        },
        "municipalityCount": {
            "type": "integer",
            "format": "int32",
            "description": "市区町村数",
            "example": 2
        },
        "totalNumber": {
            "type": "integer",
            "format": "int32",
            "description": "納入件数合計",
            "example": 3
        },
        "totalAmount": {
            "type": "integer",
            "format": "int64",
            "description": "納税額合計",
            "example": 8020
        },
        "totalBasicCharge": {
            "type": "integer",
            "format": "int64",
            "description": "地方税基本手数料合計",
            "example": 21600
        },
        "localTaxCommissionCount": {
            "type": "integer",
            "format": "int32",
            "description": "他行取次分件数",
            "example": 2
        },
        "totalPaymentCharge": {
            "type": "integer",
            "format": "int64",
            "description": "為替手数料合計",
            "example": 133198
        },
        "normalDetails": {
            "type": "array",
            "items": {
                "$ref": "#\/definitions\/LocalTaxPaymentDetailInfo"
            },
            "description": "明細配列"
        }
    },
    "additionalProperties": false
}

LocalTaxPaymentDetailInfo

明細情報オブジェクト

日本語名	英字名	説明	Nullデータ	備考
明細通番	recordNo	明細通番	なし	1～500
市区町村コード	municipalityCode	市区町村コード	なし	半角数字 "^(\d{6})$"
都道府県名	prefectureName	都道府県名	(※1)	全角文字すべて
市区町村名	municipalityNameKanji	市区町村名	(※1)	全角文字すべて
市区町村名（カナ）	municipalityName	市区町村名（カナ）	(※1)	全角数字、全角英字、全角カナ、許容記号1(※2)
指定番号	designatedNumber	指定番号	(※1)	全角文字すべて
異動	change	異動の有無	(※1)	0：異動なし　1：異動あり　" "：スペース
給与税件数	numberOfPayrollTaxPayments	給与税件数	なし	0～99999
給与税額	amountOfPayrollTaxPayments	給与税額	なし	0～999999999
退職税件数	numberOfRetirementIncomeTaxPayments	退職税件数	なし	0～99999
退職税額	amountOfRetirementIncomeTaxPayments	退職税額	なし	0～999999999
納入件数	totalNumberOfDetails	納入件数	なし	0～99999
納税額	totalAmountOfDetails	納税額	なし	0～9999999999
退職人員	numberOfRetirees	退職人員	なし	0～999
退職手当等支払金額	amountOfRetirementBenefitPayments	退職手当等支払金額	なし	0～9999999999
退職明細市区町村民税額	amountOfMunicipalInhabitantTaxPayments	退職明細市区町村民税額	なし	0～999999999
退職明細都道府県民税額	amountOfPrefecturalInhabitantsTaxPayments	退職明細都道府県民税額	なし	0～999999999
為替手数料	paymentCharge	為替手数料	なし	0～9999

(※1) 該当項目にて返却するデータがない場合、キー・値ともに返却しません。

(※2) ￥「」（）／＊＆＄，．＠＝％＋；スペースー(カナ長音)－(ハイフン)―(２バイトの長い横棒)‐(２バイトの短い横棒)

　　の計21文字になります。

「ー、－、―、‐」については、全て「－(ハイフン)」に変換して処理されます。

{
    "properties": {
        "recordNo": {
            "type": "integer",
            "format": "int32",
            "description": "明細通番",
            "example": 1
        },
        "municipalityCode": {
            "type": "string",
            "description": "市区町村コード",
            "example": "131101"
        },
        "prefectureName": {
            "type": "string",
            "description": "都道府県名",
            "example": "東京都"
        },
        "municipalityNameKanji": {
            "type": "string",
            "description": "市区町村名",
            "example": "港区"
        },
        "municipalityName": {
            "type": "string",
            "description": "市区町村名（カナ）",
            "example": "ミナトク"
        },
        "designatedNumber": {
            "type": "string",
            "description": "指定番号",
            "example": "SHITEI-8888888"
        },
        "change": {
            "type": "string",
            "description": "異動",
            "example": "0"
        },
        "numberOfPayrollTaxPayments": {
            "type": "integer",
            "description": "給与税件数",
            "format": "int32",
            "example": 3
        },
        "amountOfPayrollTaxPayments": {
            "type": "integer",
            "description": "給与税額",
            "format": "int64",
            "example": 8020
        },
        "numberOfRetirementIncomeTaxPayments": {
            "type": "integer",
            "description": "退職税件数",
            "format": "int32",
            "example": 11212
        },
        "amountOfRetirementIncomeTaxPayments": {
            "type": "integer",
            "description": "退職税額",
            "format": "int64",
            "example": 3000
        },
        "totalNumberOfDetails": {
            "type": "integer",
            "description": "納入件数",
            "format": "int32",
            "example": 3
        },
        "totalAmountOfDetails": {
            "type": "integer",
            "description": "納税額",
            "format": "int64",
            "example": 11212
        },
        "numberOfRetirees": {
            "type": "integer",
            "description": "退職人員",
            "format": "int32",
            "example": 300
        },
        "amountOfRetirementBenefitPayments": {
            "type": "integer",
            "description": "退職手当等支払金額",
            "format": "int64",
            "example": 3000
        },
        "amountOfMunicipalInhabitantTaxPayments": {
            "type": "integer",
            "description": "退職明細市区町村民税額",
            "format": "int64",
            "example": 101
        },
        "amountOfPrefecturalInhabitantsTaxPayments": {
            "type": "integer",
            "description": "退職明細都道府県民税額",
            "format": "int64",
            "example": 202
        },
        "paymentCharge": {
            "type": "integer",
            "format": "int32",
            "description": "為替手数料",
            "example": 133198
        }
    },
    "additionalProperties": false
}

ErrorResponse

エラーレスポンスオブジェクト

日本語名	英字名	説明	Nullデータ
ステータスコード	status	ステータスコード	(※1)
メッセージ	message	ステータスコードに紐づくメッセージ	(※1)
エラーコード	code	エラーコード	(※1)
開発者向け詳細メッセージ	developer_message	開発者向けの詳細メッセージ	(※1)

日本語名	英字名	説明	Nullデータ
httpステータスコード	httpCode	httpステータスコードと同値	(※1)
httpステータスメッセージ	httpMessage	httpステータスコードの文字列	(※1)
詳細メッセージ	moreInformation	開発者向けの詳細メッセージ	(※1)

日本語名	英字名	説明	Nullデータ
エラー種別	error	エラーの種別を表す文字列	(※1)
詳細メッセージ	error_description	開発者向けの詳細メッセージ	(※1)

(※1) 該当項目にて返却するデータがない場合、キー・値ともに返却しません

{
    "properties": {
        "status": {
            "type": "string",
            "description": "ステータスコード"
        },
        "message": {
            "type": "string",
            "description": "メッセージ"
        },
        "code": {
            "type": "string",
            "description": "エラーコード"
        },
        "developer_message": {
            "type": "string",
            "description": "開発者向け詳細メッセージ"
        },
        "httpCode": {
            "type": "string",
            "description": "httpステータスコード"
        },
        "httpMessage": {
            "type": "string",
            "description": "httpステータスメッセージ"
        },
        "moreInformation": {
            "type": "string",
            "description": "詳細メッセージ"
        },
        "error": {
            "type": "string",
            "description": "エラー種別"
        },
        "error_description": {
            "type": "string",
            "description": "詳細メッセージ"
        }
    },
    "additionalProperties": false
}

LocalTaxPayment400ErrorResponse

特別徴収地方税申請エラーレスポンスオブジェクト

日本語名	英字名	説明	Nullデータ
申請日	appliedDate	申請した日付	(※1)
申請時刻	appliedTime	申請した時刻	(※1)
申請ステータス	appliedStatus	申請した結果	(※1)
エラーコード	errorCode	エラーコード	(※1)
エラー文言	errorInfo	エラー文言	(※1)
申請結果	localTaxPaymentResult	申請結果詳細オブジェクト　参照	(※1)

日本語名	英字名	説明	Nullデータ
ステータスコード	status	ステータスコード	(※1)
メッセージ	message	ステータスコードに紐づくメッセージ	(※1)
エラーコード	code	エラーコード	(※1)
開発者向け詳細メッセージ	developer_message	開発者向けの詳細メッセージ	(※1)

日本語名	英字名	説明	Nullデータ
httpステータスコード	httpCode	httpステータスコードと同値	(※1)
httpステータスメッセージ	httpMessage	httpステータスコードの文字列	(※1)
詳細メッセージ	moreInformation	開発者向けの詳細メッセージ	(※1)

日本語名	英字名	説明	Nullデータ
エラー種別	error	エラーの種別を表す文字列	(※1)
詳細メッセージ	error_description	開発者向けの詳細メッセージ	(※1)

(※1) 該当項目にて返却するデータがない場合、キー・値ともに返却しません

{
    "properties": {
        "appliedDate": {
            "type": "string",
            "description": "申請日",
            "example": "2016-07-15"
        },
        "appliedTime": {
            "type": "string",
            "description": "申請時刻",
            "example": "01:23:04"
        },
        "appliedStatus": {
            "type": "string",
            "description": "ステータス",
            "example": "failed"
        },
        "errorCode": {
            "type": "string",
            "description": "エラーコード",
            "example": "APICHD5012"
        },
        "errorInfo": {
            "type": "string",
            "description": "エラー文言",
            "example": "納入明細にエラー分があるため申請できません"
        },
        "localTaxPaymentResult": {
            "description": "申請結果",
            "$ref": "#\/definitions\/LocalTaxPaymentResultInfo"
        },
        "status": {
            "type": "string",
            "description": "ステータスコード",
            "example": "400"
        },
        "message": {
            "type": "string",
            "description": "メッセージ",
            "example": "不正なパラメータ"
        },
        "code": {
            "type": "string",
            "description": "エラーコード",
            "example": "ERR006"
        },
        "developer_message": {
            "type": "string",
            "description": "開発者向け詳細メッセージ",
            "example": "指定した口座からは振込できません。"
        },
        "httpCode": {
            "type": "string",
            "description": "httpステータスコード",
            "example": "401"
        },
        "httpMessage": {
            "type": "string",
            "description": "httpステータスメッセージ",
            "example": "Unauthorized"
        },
        "moreInformation": {
            "type": "string",
            "description": "詳細メッセージ",
            "example": "Not registered to plan"
        },
        "error": {
            "type": "string",
            "description": "エラー種別",
            "example": "invalid_client"
        },
        "error_description": {
            "type": "string",
            "description": "詳細メッセージ",
            "example": "client_id unauthorized"
        }
    },
    "additionalProperties": false
}

developer.portal.bk.mufg.jp

メニュー

特別徴収地方税

特別徴収地方税

パス

/

1) 引落口座として指定可能な口座

2) 利用可能な科目

3) 振込の単位

4) エラー時の応答について

/{acceptance_no}

1) 照会可能な受付明細

2) 照会の単位

定義