production
development
https://developer.api.bk.mufg.jp
Custom Gateway API Endpoint
パス
/
post /
特別徴収地方税申請
clientIdHeader
X-IBM-Client-Id
(apiKey located in header)
X-BTMU-Seq-No
header で必須
string
{
"minLength": 25,
"maxLength": 25
}Content-Type
header で必須
string
Accept
header でオプション
string
CreateLocalTaxPayment
body で必須
object
要求の例
応答の例
POST https://developer.api.bk.mufg.jp/btmu/corporation/trial/v1/me/localtaxes/
この操作を試してみる
/{acceptance_no}
get /{acceptance_no}
特別徴収地方税受付明細照会
clientIdHeader
X-IBM-Client-Id
(apiKey located in header)
X-BTMU-Seq-No
header で必須
string
{
"minLength": 25,
"maxLength": 25
}Accept
header でオプション
string
acceptance_no
path で必須
string
{
"minLength": 12,
"maxLength": 12
}default
要求の例
応答の例
GET https://developer.api.bk.mufg.jp/btmu/corporation/trial/v1/me/localtaxes/{acceptance_no}
この操作を試してみる
定義
{
"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"
]
}
{
"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"
]
}
{
"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"
]
}
{
"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
}
{
"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
}
{
"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
}
{
"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
}
{
"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
}
{
"properties": {
"status": {
"type": "integer",
"description": "ステータスコード",
"format": "int32"
},
"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
}
{
"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": "integer",
"description": "ステータスコード",
"example": 400,
"format": "int32"
},
"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
}