{"basePath":"/v2","consumes":["application/json"],"definitions":{"AccountTransfer":{"description":"口座振替に関する情報です。お支払方法が口座振替の顧客のみ利用できます。","properties":{"object":{"description":"このObjectの種別を示します。ここでは必ず`account_transfer`が入ります。","enum":["account_transfer"],"example":"account_transfer","type":"string"}},"type":"object"},"AccountTransferNotification":{"example":{"account_transfer_date":"2021-06-09","amount":20000,"billing_id":"79NR-9WR6","created_at":"2021-06-15T10:21:34+09:00","destination_id":"WNAV-37R6","id":"79NR-AP96","invoice_delivery_methods":["posting","email"],"object":"account_transfer_notification","uri":"mfk:account_transfer_notification:7679-YW36"},"properties":{"account_transfer_date":{"description":"口座振替通知書兼請求書に記載される口座振替日です。","example":"2021-06-15","format":"date","type":"string"},"amount":{"description":"口座振替通知書兼請求書に記載される請求金額です。","example":20000,"type":"integer"},"billing_id":{"description":"請求IDです。","example":"79NR-9WR6","minLength":1,"type":"string"},"created_at":{"description":"口座振替通知書兼請求書の発行日時です。","example":"2021-06-15T10:21:34+09:00","format":"date-time","type":"string"},"destination_id":{"description":"請求先IDです。送付したい請求先を指定してください。","example":"WNAV-37R6","type":"string"},"id":{"description":"口座振替通知書兼請求書IDです。","example":"79NR-AP96","type":"string"},"invoice_delivery_methods":{"description":"口座振替通知書兼請求書送付方法です。郵送(posting) またはメール送付(email)のうちから少なくとも１つになります。","example":["posting","email"],"items":{"$ref":"#/definitions/InvoiceDeliveryMethod"},"type":"array"},"object":{"description":"このObjectの種別を示します。ここでは必ず`account_transfer_notification`が入ります。","enum":["account_transfer_notification"],"example":"account_transfer_notification","type":"string"},"uri":{"description":"口座振替通知書兼請求書URIです。すべてのリソースで一意の識別子として自動で付与されます。","example":"mfk:account_transfer_notification:79NR-AP96","type":"string"}},"type":"object"},"AccountTransferRequest":{"description":"口座振替依頼書の送付先情報です。","example":{"address1":"東京都千代田区1-2-3","address2":"サンプルビル3F","department":"経理部","email":"kessai.tanto@example.jp","name":"担当 太郎","object":"account_transfer_request","tel":"03-1234-5678","title":"部長","zip_code":"111-1111"},"properties":{"address1":{"$ref":"#/definitions/Address1"},"address2":{"$ref":"#/definitions/Address2"},"department":{"description":"担当者の部署名です。","example":"経理部","type":"string"},"email":{"$ref":"#/definitions/Email"},"name":{"description":"担当者名です。","example":"担当　太郎","type":"string"},"object":{"description":"このObjectの種別を示します。ここでは必ず`account_transfer_request`が入ります。","enum":["account_transfer_request"],"example":"account_transfer_request","type":"string"},"tel":{"$ref":"#/definitions/Tel"},"title":{"description":"担当者の役職です。","example":"部長","type":"string"},"zip_code":{"$ref":"#/definitions/ZipCode"}},"type":"object"},"AccountTransferRequestPayload":{"description":"口座振替依頼申請情報です。口座振替依頼申請で利用します。","example":{"address1":"東京都千代田区1-2-3","address2":"サンプルビル3F","department":"経理部","email":"kessai.tanto@example.jp","name":"担当 太郎","tel":"03-1234-5678","title":"部長","zip_code":"111-1111"},"properties":{"address1":{"$ref":"#/definitions/Address1"},"address2":{"$ref":"#/definitions/Address2"},"department":{"description":"担当者の部署名です。","example":"経理部","maxLength":50,"type":"string"},"email":{"$ref":"#/definitions/Email"},"name":{"description":"担当者名です。","example":"担当　太郎","maxLength":30,"type":"string"},"tel":{"$ref":"#/definitions/Tel"},"title":{"description":"担当者の役職です。","example":"部長","maxLength":30,"type":"string"},"zip_code":{"$ref":"#/definitions/ZipCode"}},"required":["zip_code","address1","tel","email"],"type":"object"},"Address1":{"description":"都道府県・市区町村・番地です。必ず都道府県名から始めてください。","example":"東京都千代田区1-2-3","maxLength":100,"minLength":1,"pattern":"^(北海道|青森県|岩手県|宮城県|秋田県|山形県|福島県|茨城県|栃木県|群馬県|埼玉県|千葉県|東京都|神奈川県|新潟県|富山県|石川県|福井県|山梨県|長野県|岐阜県|静岡県|愛知県|三重県|滋賀県|京都府|大阪府|兵庫県|奈良県|和歌山県|鳥取県|島根県|岡山県|広島県|山口県|徳島県|香川県|愛媛県|高知県|福岡県|佐賀県|長崎県|熊本県|大分県|宮崎県|鹿児島県|沖縄県).+$","type":"string"},"Address2":{"description":"建物名・部屋番号などです。","example":"サンプルビル3F","maxLength":100,"type":"string"},"AmountPerTaxRateType":{"description":"各税率種別毎の**税込**の合計金額です。","example":{"amount":11000,"tax_rate_type":"normal_10"},"properties":{"amount":{"description":"対象税率種別毎の合計金額です。**税込**金額になります。","example":12000,"maximum":2147483647,"minimum":-2147483648,"type":"integer"},"tax_rate_type":{"$ref":"#/definitions/TaxRateType"}},"required":["amount","tax_rate_type"],"type":"object"},"Authorization":{"example":{"amount":10000,"canceled_at":"2019-04-22T10:36:43+09:00","created_at":"2019-04-01T10:36:43+09:00","credit_facility_id":"4N3W-ER7N","customer_id":"W463-AA6V","expiration_date":"2019-06-16","id":"9NR3-P9A6","max_due_date":"2019-06-30","number":"AUTHORIZATION001","object":"authorization","status":"active","transaction_id":"GY9N-EWNM","uri":"mfk:authorization:9NR3-P9A6"},"properties":{"amount":{"description":"オーソリゼーション金額です。**税込**金額になります。","example":10000,"type":"integer"},"canceled_at":{"description":"オーソリゼーションがキャンセルされた日時です。未キャンセルの場合は空になります。","example":"2019-04-22T10:36:43+09:00","format":"date-time","type":"string","x-nullable":true},"created_at":{"description":"オーソリゼーションが登録された日時を示します。","example":"2019-04-01T10:36:43+09:00","format":"date-time","type":"string"},"credit_facility_id":{"description":"与信枠IDです。このオーソリゼーションが紐づく与信枠を示します。","example":"4N3W-ER7N","type":"string"},"customer_id":{"description":"顧客IDです。このオーソリゼーションが紐づく顧客を示します。","example":"W463-AA6V","type":"string"},"expiration_date":{"description":"有効期限日です。この日付を含む有効期間中はこのオーソリゼーションを利用して取引登録ができます。","example":"2019-06-16","format":"date","type":"string"},"id":{"description":"オーソリゼーションIDです。一意の識別子として自動で付与されます。","example":"9NR3-P9A6","type":"string"},"max_due_date":{"description":"このオーソリゼーションを利用して取引登録する際に指定可能な最大支払期限です。","example":"2019-06-30","format":"date","type":"string"},"number":{"description":"オーソリゼーションに付与できる任意の番号です。自動で付与されるオーソリゼーションIDとは別に、売り手様が独自に管理する識別子を登録することができます。ただし、売り手様の管理されるオーソリゼーション間で一意でなければなりません。","example":"AUTHORIZATION001","type":"string"},"object":{"description":"このObjectの種別を示します。ここでは必ず`authorization`が入ります。","enum":["authorization"],"example":"authorization","type":"string"},"status":{"description":"オーソリゼーションステータスです。アクティブ(`active`)、有効期限切れ(`expired`)、取引登録済み(`captured`)、キャンセル済み(`canceled`)があります。","enum":["active","expired","captured","canceled"],"example":"active","type":"string"},"transaction_id":{"description":"取引IDです。このオーソリゼーションが紐づく取引を示します。空の場合はそのオーソリゼーションを利用して取引登録がまだされていないことを示します。","example":"GY9N-EWNM","type":"string","x-nullable":true},"uri":{"description":"オーソリゼーションURIです。すべてのリソースで一意の識別子として自動で付与されます。","example":"mfk:authorization:9NR3-P9A6","type":"string"}},"type":"object"},"AuthorizationPayload":{"properties":{"amount":{"description":"オーソリゼーション金額です。必ず**税込**金額を指定してください。","example":10000,"maximum":2147483647,"minimum":1,"type":"integer"},"customer_id":{"description":"顧客IDです。このオーソリゼーションが紐づく顧客を指定してください。","example":"W463-AA6V","minLength":1,"type":"string"},"number":{"description":"オーソリゼーションに付与できる任意の番号です。自動で付与されるオーソリゼーションIDとは別に、売り手様が独自に管理する識別子を登録することができます。ただし、売り手様の管理されるオーソリゼーション間で一意でなければなりません。","example":"AUTHORIZATION001","maxLength":100,"minLength":1,"type":"string"}},"required":["amount","customer_id","number"],"type":"object"},"AuthorizationsList":{"properties":{"items":{"description":"オーソリゼーション一覧です。","items":{"$ref":"#/definitions/Authorization"},"type":"array"},"object":{"description":"このObjectの種別を示します。ここでは必ず `list`が設定されます。","enum":["list"],"example":"list","type":"string"},"pagination":{"$ref":"#/definitions/Pagination"}},"type":"object"},"BankTransfer":{"description":"銀行振込に関する情報です。お支払方法が銀行振込の顧客のみ利用できます。 初回請求前は振込先口座が未割当のため、`object`以外は空で返却されます。","properties":{"account_number":{"description":"振込先口座番号です。未割当の場合は空で返却されます。","example":"12345678","type":"string"},"bank_code":{"description":"振込先銀行コードです。未割当の場合は空で返却されます。","example":"0001","type":"string"},"bank_name":{"description":"振込先銀行名です。未割当の場合は空で返却されます。","example":"MFKESSSAI銀行","type":"string"},"bank_name_kana":{"description":"振込先銀行名フリガナです。未割当の場合は空で返却されます。","example":"ｴﾑｴﾌｹﾂｻｲ","type":"string"},"branch_code":{"description":"振込先銀行支店コードです。未割当の場合は空で返却されます。","example":"001","type":"string"},"branch_name":{"description":"振込先銀行支店名です。未割当の場合は空で返却されます。","example":"大手町支店","type":"string"},"branch_name_kana":{"description":"振込先銀行支店名フリガナです。未割当の場合は空で返却されます。","example":"ｵｵﾃﾏﾁ","type":"string"},"holder_name":{"description":"振込先口座名義です。必ず`ﾏﾈ-ﾌｵﾜ-ﾄﾞｹﾂｻｲ(ｶ`になります。未割当の場合は空で返却されます。","example":"ﾏﾈ-ﾌｵﾜ-ﾄﾞｹﾂｻｲ(ｶ","type":"string"},"object":{"description":"このObjectの種別を示します。ここでは必ず`bank_transfer`が入ります。","enum":["bank_transfer"],"example":"bank_transfer","type":"string"},"type":{"description":"振込先口座種別です。`current`(当座)、`saving`(普通)の2種類のうちどちらかになります。未割当の場合は空で返却されます。","enum":["current","saving"],"type":"string"}},"type":"object"},"Billing":{"description":"請求です。取引のうち、請求先・支払期限・請求書発行日・取引登録方式が同一の取引が同じ請求にまとめられます。","example":{"account_transfer_notification_ids":["7MW6-AW6A"],"amount":21800,"amounts_per_tax_rate_type":[{"amount":11000,"tax_rate_type":"normal_10"},{"amount":10800,"tax_rate_type":"reduced_8"}],"customer_id":"WNAV-37R6","destination_id":"7679-YW36","due_date":"2019-04-30","id":"9R6M-VMAN","invoice_delivery_method":["posting","email"],"invoice_ids":["W47N-7WNM","AY9N-VPN3"],"issue_date":"2019-04-01","object":"billing","status":"scheduled","unpaid":{"shortage_amount":12000,"updated_date":"2019-04-30"},"uri":"mfk:billing:9R6M-VMAN"},"properties":{"account_transfer_notification_ids":{"description":"口座振替通知書IDです。取引が紐づく口座振替通知書を示します。口座振替通知書が発行され次第非同期に値が追加されます。","items":{"type":"string"},"type":"array"},"amount":{"description":"請求の**税込**の合計金額です。区分記載請求書モードの請求では請求に含まれる取引金額の合計となり、インボイスモードの請求では含まれる全ての明細情報からインボイス制度の端数処理方法に則り算出した金額となります。インボイスモードでは審査中の取引を含んだ請求金額となり、請求対象の取引がなければ0になります。","example":12000,"type":"integer","x-omitempty":false},"amounts_per_tax_rate_type":{"description":"各税率種別毎の**税込**の合計金額です。","items":{"$ref":"#/definitions/AmountPerTaxRateType"},"type":"array"},"customer_id":{"description":"顧客IDです。請求の顧客を示します。","example":"WNAV-37R6","type":"string"},"destination_id":{"description":"請求先IDです。請求先を示します。","example":"7679-YW36","type":"string"},"due_date":{"description":"支払期限です。","example":"2019-04-30","format":"date","type":"string"},"id":{"description":"請求IDです。一意の識別子として自動で付与されます。請求先ID・支払期限・請求書発行日・取引登録方式が同一の取引がこの請求によってまとめられます。請求書は請求をもとに発行されます。","example":"9R6M-VMAN","type":"string"},"invoice_delivery_methods":{"description":"請求書送付方法です。郵送(posting) またはメール送付(email)のうちから少なくとも１つを指定してください。どちらも選択された場合、どちらの方法でも送付されます。 また、各取引で指定しなかった送付方法でも、請求にまとまった取引のうちでその送付方法を選択しているものがあれば、そちらの送付方法も採用されます。","example":["posting","email"],"items":{"$ref":"#/definitions/InvoiceDeliveryMethod"},"type":"array"},"invoice_ids":{"description":"請求書IDです。請求に紐づく請求書を示します。請求書が発行され次第非同期で値が追加されます。","items":{"type":"string"},"type":"array"},"issue_date":{"description":"請求書発行日です。請求書送付日については\u003ca href=\"https://support.mfkessai.co.jp/hc/ja/articles/900002297303\" target=\"_blank\"\u003eこちら\u003c/a\u003eをご参照ください。","example":"2019-04-20","format":"date","type":"string"},"object":{"description":"このObjectの種別を示します。ここでは必ず`billing`が入ります。","enum":["billing"],"example":"billing","type":"string"},"status":{"description":"請求ステータスです。請求予定(`scheduled`)、請求書発行済(`invoice_issued`) 、口座振替通知済(`account_transfer_notified`)、請求停止(`stopped`)、請求停止予定(`scheduled_to_be_stopped`)で指定されます。 請求停止(`stopped`)は請求モードがインボイスモードの場合のみ返却されます。","enum":["scheduled","invoice_issued","account_transfer_notified","stopped","scheduled_to_be_stopped"],"example":"invoice_issued","type":"string"},"unpaid":{"description":"未入金情報です。請求に対して支払期限後未入金がある場合のみ返却されます。","properties":{"shortage_amount":{"description":"未入金額です。","example":12000,"type":"integer"},"updated_date":{"description":"入金情報が最後に更新された日付です。この日付以降に入金されている可能性があります。","example":"2019-04-30","format":"date","type":"string"}},"type":"object"},"uri":{"description":"請求URIです。すべてのリソースで一意の識別子として自動で付与されます。","example":"mfk:billing:9R6M-VMAN","type":"string"}},"type":"object"},"BillingCondition":{"description":"請求される条件です。登録時は審査結果に関わらずすべて請求する(`all`)、審査通過の取引のみ請求する(`passed`)のうちから選択してください。\u003cbr\u003e 空の場合は管理画面の「請求対象の設定」で設定された条件で登録されます。請求対象について詳しくは\u003ca href=\"https://support.mfkessai.co.jp/hc/ja/articles/900002241626\" target=\"_blank\"\u003eこちら\u003c/a\u003eを参照ください。","enum":["passed","all"],"type":"string"},"BillingsList":{"properties":{"items":{"description":"請求一覧です。","items":{"$ref":"#/definitions/Billing"},"type":"array"},"object":{"description":"このObjectの種別を示します。ここでは必ず `list`が設定されます。","enum":["list"],"example":"list","type":"string"},"pagination":{"$ref":"#/definitions/Pagination"}},"type":"object"},"CreateCustomerResponse":{"properties":{"customer":{"$ref":"#/definitions/Customer"},"destination":{"$ref":"#/definitions/Destination"}},"type":"object"},"CreditFacilitiesList":{"properties":{"items":{"description":"与信枠一覧です。","items":{"$ref":"#/definitions/CreditFacility"},"type":"array"},"object":{"description":"このObjectの種別を示します。ここでは必ず `list`が設定されます。","enum":["list"],"example":"list","type":"string"},"pagination":{"$ref":"#/definitions/Pagination"}},"type":"object"},"CreditFacility":{"description":"顧客の与信枠です。この枠内の取引登録であれば取引審査なしで登録することができます。","example":{"amount":200000,"balance":100000,"customer_examination_id":"WNAV-37R6","customer_id":"9R6M-VMAN","end_date":"2019-04-30","id":"7679-YW36","start_date":"2019-04-01","status":"inactive","uri":"mfk:credit_facility:7679-YW36"},"properties":{"amount":{"description":"与信額です。取引登録期間(`start_date`~`end_date`)にこの金額までの取引であれば取引審査なしで登録することができます。","example":200000,"type":"integer"},"balance":{"description":"与信額残高です。与信額からこの与信枠を利用して登録された取引の合計金額を差し引いた金額です。現在与信枠を利用して登録できる取引金額を示しています。","example":100000,"type":"integer","x-nullable":true},"customer_examination_id":{"description":"与信枠審査IDです。","example":"7679-YW36","type":"string"},"customer_id":{"description":"顧客IDです。一意の識別子として自動で付与されます。","example":"9R6M-VMAN","type":"string"},"end_date":{"description":"取引登録期間終了日です。この日付まで対象の与信枠を利用して取引登録ができます。","example":"2019-04-30","format":"date","type":"string"},"id":{"description":"与信枠IDです。一意の識別子として自動で付与されます。","example":"7679-YW36","type":"string"},"object":{"description":"このObjectの種別を示します。ここでは必ず`credit_facility`が入ります。","enum":["credit_facility"],"example":"credit_facility","type":"string"},"start_date":{"description":"取引登録期間開始日です。この日付から対象の与信枠を利用して取引登録ができます。","example":"2019-04-01","format":"date","type":"string"},"status":{"description":"与信枠ステータスです。未適用(`inactive`)、適用中(`active`)、期限切れ(`expired`)があります。 現在の日付が`start_date`~`end_date`の期間内であれば`active`、`start_date`よりも前であれば`inactive`、`end_date`を過ぎていれば`expired`になります。","enum":["inactive","active","expired"],"example":"inactive","type":"string"},"uri":{"description":"与信枠URIです。すべてのリソースで一意の識別子として自動で付与されます。","example":"mfk:credit_facility:7679-YW36","type":"string"}},"type":"object"},"Customer":{"description":"顧客です。取引登録や与信枠取得などあらゆる機能を利用する起点となります。","example":{"created_at":"2019-04-01T10:36:43+09:00","has_alert":false,"id":"7679-YW36","name":"サンプル顧客","number":"CUSTOEMR001","object":"customer","payment_method":{"bank_transfer":{"account_number":"123456789","bank_name":"MEKESSAI銀行","branch_name":"大手町支店","holder_name":"ﾏﾈ-ﾌｵﾜ-ﾄﾞｹﾂｻｲ(ｶ","object":"bank_transfer","type":"current"},"object":"payment_method"},"uri":"mfk:customer:7679-YW36"},"properties":{"created_at":{"description":"顧客が登録された日時を示します。","example":"2019-04-01T10:36:43+09:00","format":"date-time","type":"string"},"has_alert":{"default":false,"description":"アラートの有無を示します。アラートがある場合は`true`、ない場合は`false`を返します。アラートがあると、自動で毎月付与されている与信枠が停止します。","type":"boolean"},"id":{"description":"顧客IDです。 本サービスによって発番される一意の識別子です。","example":"7679-YW36","type":"string"},"name":{"description":"顧客名です。","example":"サンプル顧客","type":"string"},"number":{"description":"顧客に付与できる任意の顧客番号です。自動で付与される顧客IDとは別に、売り手様が独自に管理する識別子を登録することができます。ただし、売り手様の管理される顧客間で一意でなければなりません。","example":"CUSTOMER0001","type":"string"},"object":{"description":"このObjectの種別を示します。ここでは必ず`customer`が入ります。","enum":["customer"],"example":"customer","type":"string"},"payment_method":{"$ref":"#/definitions/PaymentMethod"},"uri":{"description":"顧客URIです。すべてのリソースで一意の識別子として自動で付与されます。","example":"mfk:customer:7679-YW36","type":"string"}},"type":"object"},"CustomerExamination":{"description":"与信枠審査です。顧客に対する与信枠取得のために利用します。申請後２営業日以内に審査いたします。 自動与信枠審査を利用している場合は顧客登録と同時に与信枠審査も申請されます。","example":{"address1":"東京都千代田区1-2-3","address2":"サンプルビル3F","amount":20000,"business_description":"クラウド型企業間決済サービス","business_type":"corporate","corporate_number":"1234567890123","created_at":"2019-02-18T10:20:34+09:00","customer_id":"7679-YW36","email":"kessai.tanto@example.jp","end_date":"2019-04-30","id":"WNAV-37R6","remark":"一部上場企業です。","representative_name":"代表太郎","start_date":"2019-04-01","status":"passed","tel":"03-1234-5678","type":"auto","uri":"mfk:customer_examination:WNAV-37R6","website":"https://mfkessai.co.jp","zip_code":"111-1111"},"properties":{"address1":{"$ref":"#/definitions/Address1"},"address2":{"$ref":"#/definitions/Address2"},"amount":{"description":"希望与信額です。審査通過の場合に付与される与信枠の希望金額になります。審査の結果減額されて与信枠付与されることもあります。","example":200000,"type":"integer"},"business_description":{"description":"事業内容です。顧客の主なサービス、商材などです。","example":"クラウド型企業間決済サービス","type":"string"},"business_type":{"description":"事業所区分です。法人(`corporate`)または、個人(`individual`)で指定されます。不明な場合は空になります。","enum":["corporate","individual"],"example":"corporate","type":"string"},"corporate_number":{"description":"法人番号です。事業所区分(`business_type`)が法人(`corporate`)の場合にのみ利用されます。","example":"1234567890123","type":"string"},"created_at":{"description":"与信枠審査の申請日時です。","example":"2019-02-18T10:21:34+09:00","format":"date-time","type":"string"},"customer_id":{"description":"顧客IDです。一意の識別子として自動で付与されます。","example":"7679-YW36","type":"string"},"email":{"$ref":"#/definitions/Email"},"end_date":{"description":"希望取引登録期間終了日です。この日付まで対象の与信枠を利用して取引登録ができます。","example":"2019-04-30","format":"date","type":"string"},"id":{"description":"与信枠審査IDです。一意の識別子として自動で付与されます。","example":"7679-YW36","type":"string"},"object":{"description":"このObjectの種別を示します。ここでは必ず`customer_examination`が入ります。","enum":["customer_examination"],"example":"customer_examination","type":"string"},"remark":{"description":"その他情報です。審査に利用できる情報を記載できます。","example":"一部上場企業です。","type":"string"},"representative_name":{"description":"代表者名です。","example":"代表太郎","type":"string"},"start_date":{"description":"希望取引登録期間開始日。この日付から対象の与信枠を利用して取引登録ができます。 手動での申請の場合、審査通過日となるため空で返却されます。自動与信枠審査による申請の場合は、月次での与信枠付与になり対象月の月初日となります。","example":"2019-04-01","format":"date","type":"string","x-nullable":true},"status":{"description":"与信枠審査ステータスです。審査中(`unexamined`)、審査通過(`passed`)、審査否決(`rejected`)があります。審査通過の場合には与信枠が付与されています。","enum":["unexamined","passed","rejected"],"example":"passed","maxLength":60,"type":"string"},"tel":{"$ref":"#/definitions/Tel"},"type":{"description":"申請理由の種別です。手動(`manual`)、自動(`auto`)、回復(`recovery`)があります。手動(manual)には増枠申請と手動回復審査申請が含まれます。","enum":["manual","auto","recovery"],"type":"string"},"uri":{"description":"与信枠審査URIです。すべてのリソースで一意の識別子として自動で付与されます。","example":"mfk:customer_examination:7679-YW36","type":"string"},"website":{"description":"顧客企業のwebサイトです。","example":"https://mfkessai.co.jp","type":"string"},"zip_code":{"$ref":"#/definitions/ZipCode"}},"type":"object"},"CustomerExaminationPayload":{"description":"与信枠審査申請情報です。与信枠審査申請で利用します。","example":{"address1":"東京都千代田区1-2-3","address2":"サンプルビル3F","amount":20000,"business_description":"クラウド型企業間決済サービス","business_type":"corporate","corporate_number":"1234567890123","customer_id":"7679-YW36","email":"kessai.tanto@example.jp","end_date":"2019-04-30","remark":"一部上場企業です。","representative_name":"代表太郎","tel":"03-1234-5678","website":"https://mfkessai.co.jp","zip_code":"111-1111"},"properties":{"address1":{"$ref":"#/definitions/Address1"},"address2":{"$ref":"#/definitions/Address2"},"amount":{"description":"希望与信額です。審査通過の場合に付与される与信枠の金額になります。現在与信枠が適用中の場合は、その与信額未満の金額は指定できません。 審査の結果減額されて与信枠付与されることもあります。","example":200000,"maximum":150000000,"minimum":1,"type":"integer"},"business_description":{"description":"事業内容です。顧客の主なサービス、商材などを記載してください。","example":"クラウド型企業間決済サービス","maxLength":500,"type":"string"},"business_type":{"description":"事業所区分です。法人(`corporate`)または、個人(`individual`)で指定してください。不明な場合は空にしてください。","enum":["corporate","individual"],"example":"corporate","type":"string"},"corporate_number":{"description":"法人番号です。事業所区分(`business_type`)が法人(`corporate`)の場合にのみ指定してください。","example":"1234567890123","pattern":"^\\d{13}$","type":"string"},"customer_id":{"description":"与信枠審査を申請する顧客のIDです。","example":"7679-YW36","minLength":1,"type":"string"},"email":{"$ref":"#/definitions/Email"},"end_date":{"description":"希望取引登録期間終了日です。この日付まで対象の与信枠を利用して取引登録ができます。 直近三ヶ月の月末のみ指定できます。","example":"2019-04-30","format":"date","type":"string"},"remark":{"description":"与信枠審査に利用できるその他情報を記載できます。\u003cbr\u003eSandbox環境において与信枠審査で任意の結果を指定するためにこの値を用います。詳しくは[審査結果の操作](#environment_magic_number)を参照ください。","example":"一部上場企業です。","maxLength":500,"type":"string"},"representative_name":{"description":"代表者氏名です。","example":"代表太郎","maxLength":30,"type":"string"},"tel":{"$ref":"#/definitions/Tel"},"website":{"description":"顧客企業のwebサイトです。","example":"https://mfkessai.co.jp","maxLength":500,"pattern":"^https?://(www\\.)?[-a-zA-Z0-9@:%._+~#=]{1,256}\\.[a-zA-Z0-9()]{1,9}\\b([-a-zA-Z0-9()@:%_+.~#?\u0026/=]*)$","type":"string"},"zip_code":{"$ref":"#/definitions/ZipCode"}},"required":["address1","amount","customer_id","email","end_date","tel","zip_code"],"type":"object"},"CustomerExaminationsList":{"properties":{"items":{"description":"与信枠審査一覧です。","items":{"$ref":"#/definitions/CustomerExamination"},"type":"array"},"object":{"description":"このObjectの種別を示します。ここでは必ず `list`が設定されます。","enum":["list"],"example":"list","type":"string"},"pagination":{"$ref":"#/definitions/Pagination"}},"type":"object"},"CustomerNameUpdate":{"example":{"created_at":"2019-04-01T10:36:43+09:00","customer_id":"W463-AA6V","id":"9NR3-P9A6","name":"マネーフォワードケッサイ株式会社","object":"customer_name_update","reason":"社名変更のため","status":"passed","uri":"mfk:customer_name_update:9NR3-P9A6"},"properties":{"created_at":{"description":"顧客名変更申請が登録された日時を示します。","example":"2019-04-01T10:36:43+09:00","format":"date-time","type":"string"},"customer_id":{"description":"顧客IDです。この顧客名変更申請が紐づく顧客を示します。","example":"W463-AA6V","type":"string"},"id":{"description":"顧客名変更申請IDです。一意の識別子として自動で付与されます。","example":"9NR3-P9A6","type":"string"},"name":{"description":"変更後の顧客名です。","example":"マネーフォワードケッサイ株式会社","type":"string"},"object":{"description":"このObjectの種別を示します。ここでは必ず`customer_name_update`が入ります。","enum":["customer_name_update"],"example":"customer_name_update","type":"string"},"reason":{"description":"変更希望理由です。","example":"社名変更のため","type":"string"},"status":{"description":"顧客名変更申請ステータスです。審査中(`unexamined`)、審査通過(`passed`)、審査否決(`rejected`)、申請キャンセル(`canceled`)があります。審査通過の場合には顧客名が変更されています。","enum":["unexamined","passed","rejected","canceled"],"example":"passed","type":"string"},"uri":{"description":"顧客名変更申請URIです。すべてのリソースで一意の識別子として自動で付与されます。","example":"mfk:customer_name_update:9NR3-P9A6","type":"string"}},"type":"object"},"CustomerNameUpdatePayload":{"properties":{"customer_id":{"description":"顧客idです。顧客名を変更したい顧客を指定してください。","example":"W463-AA6V","minLength":1,"type":"string"},"name":{"description":"変更後の顧客名です。","example":"マネーフォワードケッサイ株式会社","maxLength":50,"minLength":1,"type":"string"},"reason":{"description":"変更希望理由です。","example":"社名変更のため","maxLength":500,"minLength":1,"type":"string"}},"required":["customer_id","name","reason"],"type":"object"},"CustomerNameUpdatesList":{"properties":{"items":{"description":"顧客名変更申請一覧です。","items":{"$ref":"#/definitions/CustomerNameUpdate"},"type":"array"},"object":{"description":"このObjectの種別を示します。ここでは必ず `list`が設定されます。","enum":["list"],"example":"list","type":"string"},"pagination":{"$ref":"#/definitions/Pagination"}},"type":"object"},"CustomerPayload":{"description":"顧客登録情報です。顧客登録時に利用します。顧客には必ず一つの請求先が必要であるため同時に請求先一件も登録します。","properties":{"customer_examination":{"description":"与信枠審査申請情報です。与信枠審査申請で利用します","example":{"amount":20000,"business_description":"クラウド型企業間決済サービス","business_type":"corporate","corporate_number":"1234567890123","examinee":{"address1":"東京都千代田区1-2-3","address2":"サンプルビル3F","email":"kessai.tanto@example.jp","tel":"03-1234-5678","zip_code":"111-1111"},"initial_amount":50000,"remark":"一部上場企業です。","representative_name":"代表太郎","website":"https://mfkessai.co.jp"},"properties":{"amount":{"description":"希望与信額です。審査通過の場合に付与される与信枠の金額になります。 現在与信枠が適用中の場合は、その与信額未満の金額は指定できません。0円を指定した場合は無視されます。 審査の結果減額されて与信枠付与されることもあります。","example":200000,"maximum":150000000,"minimum":1,"type":"integer"},"business_description":{"description":"事業内容です。顧客の主なサービス、商材などを記載してください。","example":"クラウド型企業間決済サービス","maxLength":500,"type":"string"},"business_type":{"description":"事業所区分です。法人(`corporate`)または、個人(`individual`)で指定してください。不明な場合は空にしてください。","enum":["corporate","individual"],"example":"corporate","type":"string"},"corporate_number":{"description":"法人番号です。事業所区分(`business_type`)が法人(`corporate`)の場合にのみ指定してください。","example":"1234567890123","pattern":"^\\d{13}$","type":"string"},"examinee":{"description":"与信枠審査時顧客情報です。指定する場合はaddress2以外は必須項目となります。","properties":{"address1":{"$ref":"#/definitions/Address1"},"address2":{"$ref":"#/definitions/Address2"},"email":{"$ref":"#/definitions/Email"},"tel":{"$ref":"#/definitions/Tel"},"zip_code":{"$ref":"#/definitions/ZipCode"}},"required":["zip_code","address1","email","tel"],"type":"object"},"initial_amount":{"description":"初月希望与信額です。初月希望与信額については\u003ca href=\"https://support.mfkessai.co.jp/hc/ja/articles/900002208763\" target=\"_blank\"\u003eサポートページ\u003c/a\u003eを確認してください。 0円を指定した場合は無視されます。審査の結果減額されて与信枠付与されることもあります。","example":500000,"maximum":150000000,"minimum":1,"type":"integer"},"remark":{"description":"与信枠審査に利用できるその他情報を記載できます。","example":"一部上場企業です。","maxLength":500,"type":"string"},"representative_name":{"description":"代表者氏名です。","example":"代表太郎","maxLength":30,"type":"string"},"website":{"description":"顧客企業のwebサイトです。","example":"https://mfkessai.co.jp","maxLength":500,"pattern":"^https?://(www\\.)?[-a-zA-Z0-9@:%._+~#=]{1,256}\\.[a-zA-Z0-9()]{1,9}\\b([-a-zA-Z0-9()@:%_+.~#?\u0026/=]*)$","type":"string"}},"type":"object"},"destination":{"description":"請求先情報です。","example":{"address1":"東京都千代田区1-2-3","address2":"サンプルビル3F","cc_emails":["another.tanto1@example.jp","another.tanto2@example.jp"],"department":"経理部","email":"kessai.tanto@example.jp","name":"担当 太郎","name_kana":"タントウ　タロウ","tel":"03-1234-5678","title":"部長","zip_code":"111-1111"},"properties":{"address1":{"$ref":"#/definitions/Address1"},"address2":{"$ref":"#/definitions/Address2"},"cc_emails":{"description":"請求書をメール送付する際のCCメールアドレスです。最大で4つまで指定できます。","example":["another.tanto1@example.jp","another.tanto2@example.jp"],"items":{"$ref":"#/definitions/Email"},"maxItems":4,"type":"array"},"department":{"description":"担当者の部署名です。","example":"経理部","maxLength":50,"type":"string"},"email":{"$ref":"#/definitions/Email"},"name":{"description":"担当者氏名です。","example":"担当　太郎","maxLength":30,"type":"string"},"name_kana":{"description":"担当者名カナです。全角カタカナで入力してください。","example":"タントウ　タロウ","maxLength":60,"type":"string"},"tel":{"$ref":"#/definitions/Tel"},"title":{"description":"担当者の役職です。","example":"部長","maxLength":30,"type":"string"},"zip_code":{"$ref":"#/definitions/ZipCode"}},"required":["address1","email","tel","zip_code"],"type":"object"},"name":{"description":"顧客名です。","example":"サンプル顧客","maxLength":50,"minLength":1,"type":"string"},"number":{"description":"顧客に付与できる任意の顧客番号です。本サービスが発番する顧客IDとは別で、売り手様が独自に管理する識別子を登録することができます。 ただし、売り手様の所有する顧客間で一意である必要があります。","example":"CUSTOMER0001","maxLength":100,"minLength":1,"type":"string"}},"required":["destination","name","number"],"type":"object"},"CustomerUpdatePayload":{"description":"顧客更新情報です。顧客更新時に利用します。","properties":{"number":{"description":"顧客に付与できる任意の顧客番号です。本サービスが発番する顧客IDとは別で、売り手様が独自に管理する識別子を登録することができます。 ただし、売り手様の所有する顧客間で一意である必要があります。指定がないか空文字の場合は更新されません。","example":"CUSTOMER0001","maxLength":100,"type":"string"}},"type":"object"},"CustomersList":{"properties":{"items":{"description":"条件に該当する顧客の一覧です。","items":{"$ref":"#/definitions/Customer"},"type":"array"},"object":{"description":"このObjectの種別を示します。ここでは必ず `list`が設定されます。","enum":["list"],"type":"string"},"pagination":{"$ref":"#/definitions/Pagination"}},"type":"object"},"Deduction":{"description":"振込から控除される金額とその内訳です。","example":{"amount":10000,"returned_credit_amount":500,"tax":{"amount":500,"rate_type":"normal_10"},"tax_free":{"amount":4000,"card_payment_commission_amount":220,"commission_amount":3000,"early_payout_commission_amount":1000},"taxable":{"amount":20000,"basic_monthly_charge":4500,"billing_charge":{"amount":2000,"quantity":10,"unit_price":200},"convenience_billing":{"charge":15000,"quantity":100,"unit_price":150},"posting":{"amount":500,"quantity":5,"unit_price":100}},"untaxable":{"amount":15000,"revenue_stamp":{"amount":15000,"quantity":100,"unit_price":150}}},"properties":{"amount":{"description":"債権合計額から控除される合計金額です。","example":10000,"type":"integer","x-nullable":true},"canceled_reconciliation_amount":{"description":"入金消込の解除による回収金額の返金額です。","example":10000,"type":"integer","x-nullable":true},"returned_credit_amount":{"description":"キャンセルによる債権金額の返金額です。","example":10000,"type":"integer","x-nullable":true},"tax":{"description":"消費税です。","properties":{"amount":{"description":"消費税額です。","example":10000,"type":"integer","x-nullable":true},"rate_type":{"$ref":"#/definitions/TaxRateType"}},"type":"object"},"tax_free":{"description":"非課税の控除金額とその内訳です。手数料と早期振込手数料が非課税となります。","properties":{"amount":{"description":"非課税の控除金額です。","example":1000,"type":"integer","x-nullable":true},"card_payment_commission_amount":{"description":"カード払い手数料額です。","example":220,"type":"integer","x-nullable":true},"commission_amount":{"description":"手数料の金額です。","example":10000,"type":"integer","x-nullable":true},"early_payout_commission_amount":{"description":"早期振込手数料の金額です。","example":10000,"type":"integer","x-nullable":true}},"type":"object"},"taxable":{"description":"課税対象の控除金額とその内訳です。郵送料と月額基本料が課税対象となります。","properties":{"amount":{"description":"課税対象の控除金額です。","example":25000,"type":"integer","x-nullable":true},"basic_monthly_charge":{"description":"月額基本料金です。","example":10000,"type":"integer","x-nullable":true},"billing_charge":{"description":"付随請求業務手数料とその内訳です。","properties":{"amount":{"description":"付随請求業務手数料です。","example":2000,"type":"integer","x-nullable":true},"quantity":{"description":"請求件数です。","example":10,"type":"integer","x-nullable":true},"unit_price":{"description":"請求１件あたりの付随請求業務手数料です。","example":200,"type":"integer","x-nullable":true}},"type":"object"},"convenience_billing":{"description":"コンビニ払込手数料とその内訳です。","properties":{"charge":{"description":"コンビニ払込手数料です。","example":15000,"type":"integer","x-nullable":true},"quantity":{"description":"コンビニ払込件数です。","example":100,"type":"integer","x-nullable":true},"unit_price":{"description":"コンビニ払込１件あたりの手数料です。","example":150,"type":"integer","x-nullable":true}},"type":"object"},"posting":{"description":"郵送料金とその内訳です。","properties":{"amount":{"description":"郵送料です。","example":15000,"type":"integer","x-nullable":true},"quantity":{"description":"郵送件数です。","example":100,"type":"integer","x-nullable":true},"unit_price":{"description":"郵送１件あたりの郵送料です。","example":150,"type":"integer","x-nullable":true}},"type":"object"}},"type":"object"},"untaxable":{"description":"不課税の控除金額とその内訳です。収入印紙代が不課税となります。","properties":{"amount":{"description":"不課税の控除金額です。","example":15000,"type":"integer","x-nullable":true},"revenue_stamp":{"description":"収入印紙代とその内訳です。","properties":{"amount":{"description":"収入印紙代です。","example":15000,"type":"integer","x-nullable":true},"quantity":{"description":"収入印紙件数です。","example":100,"type":"integer","x-nullable":true},"unit_price":{"description":"収入印紙１件あたりの料金です。","example":150,"type":"integer","x-nullable":true}},"type":"object"}},"type":"object"}},"type":"object"},"Destination":{"description":"請求先です。一つの顧客に対して複数作成することができます。請求先の情報を利用して請求書送付を行います。\u003cbr\u003e 請求書の印字との対照については\u003ca href=\"https://support.mfkessai.co.jp/hc/ja/articles/900002320343\" target=\"_blank\"\u003eサポートページ\u003c/a\u003eを確認してください。","example":{"address1":"東京都千代田区1-2-3","address2":"サンプルビル3F","cc_emails":["another.tanto1@example.jp","another.tanto2@example.jp"],"created_at":"2019-04-01T10:36:43+09:00","customer_id":"7679-YW36","department":"経理部","email":"kessai.tanto@example.jp","id":"WNAV-37R6","name":"担当 太郎","name_kana":"タントウ　タロウ","object":"destination","tel":"03-1234-5678","title":"部長","uri":"mfk:destination:WNAV-37R6","zip_code":"111-1111"},"properties":{"address1":{"$ref":"#/definitions/Address1"},"address2":{"$ref":"#/definitions/Address2"},"cc_emails":{"description":"CCメールアドレスです。最大4件まで登録できます。","example":["another.tanto1@example.jp","another.tanto2@example.jp"],"items":{"$ref":"#/definitions/Email"},"type":"array"},"created_at":{"description":"請求先が登録された日時を示します。","example":"2019-04-01T10:36:43+09:00","format":"date-time","type":"string"},"customer_id":{"description":"顧客IDです。一意の識別子として自動で付与されます。","example":"7679-YW36","type":"string"},"department":{"description":"担当者の部署名です。","example":"経理部","type":"string"},"email":{"$ref":"#/definitions/Email"},"id":{"description":"請求先IDです。一意の識別子として自動で付与されます。","example":"7679-YW36","type":"string"},"name":{"description":"担当者名です。","example":"担当 太郎","type":"string"},"name_kana":{"description":"担当者名カナです。全角カタカナで入力してください。","example":"タントウ タロウ","type":"string"},"object":{"description":"このObjectの種別を示します。ここでは必ず`destination`が入ります。","enum":["destination"],"example":"destination","type":"string"},"tel":{"$ref":"#/definitions/Tel"},"title":{"description":"担当者の役職です。","example":"部長","type":"string"},"uri":{"description":"請求先URIです。すべてのリソースで一意の識別子として自動で付与されます。","example":"mfk:destination:7679-YW36","type":"string"},"zip_code":{"$ref":"#/definitions/ZipCode"}},"type":"object"},"DestinationPayload":{"description":"請求先登録情報です。請求先登録時に利用します。一つの顧客に対して複数の請求先を登録できます。","example":{"address1":"東京都千代田区1-2-3","address2":"サンプルビル3F","cc_emails":["another.tanto1@example.jp","another.tanto2@example.jp"],"customer_id":"7679-YW36","department":"経理部","email":"kessai.tanto@example.jp","name":"担当 太郎","name_kana":"タントウ　タロウ","tel":"03-1234-5678","title":"部長","zip_code":"111-1111"},"properties":{"address1":{"$ref":"#/definitions/Address1"},"address2":{"$ref":"#/definitions/Address2"},"cc_emails":{"description":"請求書をメール送付する際のCCメールアドレスです。最大で4件まで指定できます。","example":["another.tanto1@example.jp","another.tanto2@example.jp"],"items":{"$ref":"#/definitions/Email"},"maxItems":4,"type":"array"},"customer_id":{"description":"請求先を登録する顧客のIDです。","example":"7679-YW36","minLength":1,"type":"string"},"department":{"description":"担当者の部署名です。","example":"経理部","maxLength":50,"type":"string"},"email":{"$ref":"#/definitions/Email"},"name":{"description":"担当者氏名です。","example":"担当　太郎","maxLength":30,"type":"string"},"name_kana":{"description":"担当者名カナです。全角カタカナで入力してください。","example":"タントウ　タロウ","maxLength":60,"type":"string"},"tel":{"$ref":"#/definitions/Tel"},"title":{"description":"担当者の役職です。","example":"部長","maxLength":30,"type":"string"},"zip_code":{"$ref":"#/definitions/ZipCode"}},"required":["address1","customer_id","email","tel","zip_code"],"type":"object"},"DestinationUpdatePayload":{"description":"請求先更新情報です。請求先更新時に利用します。","example":{"address1":"東京都千代田区1-2-3","address2":"サンプルビル3F","cc_emails":["another.tanto1@example.jp","another.tanto2@example.jp"],"department":"経理部","email":"kessai.tanto@example.jp","name":"担当 太郎","name_kana":"タントウ　タロウ","tel":"03-1234-5678","title":"部長","zip_code":"111-1111"},"properties":{"address1":{"$ref":"#/definitions/Address1"},"address2":{"$ref":"#/definitions/Address2"},"cc_emails":{"description":"請求書をメール送付する際のCCメールアドレスです。最大で4件まで指定できます。","example":["another.tanto1@example.jp","another.tanto2@example.jp"],"items":{"$ref":"#/definitions/Email"},"maxItems":4,"type":"array"},"department":{"description":"担当者の部署名です。","example":"経理部","maxLength":50,"type":"string"},"email":{"$ref":"#/definitions/Email"},"name":{"description":"担当者氏名です。","example":"担当　太郎","maxLength":30,"type":"string"},"name_kana":{"description":"担当者名カナです。全角カタカナで入力してください。","example":"タントウ　タロウ","maxLength":60,"type":"string"},"tel":{"$ref":"#/definitions/Tel"},"title":{"description":"担当者の役職です。","example":"部長","maxLength":30,"type":"string"},"zip_code":{"$ref":"#/definitions/ZipCode"}},"required":["address1","email","tel","zip_code"],"type":"object"},"DestinationsList":{"properties":{"items":{"description":"請求先一覧です。","items":{"$ref":"#/definitions/Destination"},"type":"array"},"object":{"description":"このObjectの種別を示します。ここでは必ず `list`が設定されます。","enum":["list"],"example":"list","type":"string"},"pagination":{"$ref":"#/definitions/Pagination"}},"type":"object"},"DownloadSignedURL":{"example":{"expired_at":"2023-03-08T10:36:43+09:00","signed_url":"https://download.mfk.jp/api/billings/7679-YW36/content?Signature=mfkrandomsignature","type":"pdf"},"properties":{"expired_at":{"description":"ファイルダウンロード用の署名付きURLの有効期限です。","example":"2023-03-08T10:36:43+09:00","format":"date-time","type":"string"},"signed_url":{"description":"ファイルダウンロード用の署名付きURLです。","example":"https://download.mfk.jp/api/billings/7679-YW36/content?Signature=mfkrandomsignature","type":"string"},"type":{"description":"ダウンロードするファイルの種別です。","enum":["pdf","excel"],"example":"pdf","type":"string"}},"type":"object"},"DownloadSignedURLList":{"properties":{"items":{"description":"ファイルダウンロード用の署名付きURLの一覧です。","items":{"$ref":"#/definitions/DownloadSignedURL"},"type":"array"},"object":{"description":"このObjectの種別を示します。ここでは必ず `list`が設定されます。","enum":["list"],"example":"list","type":"string"}},"type":"object"},"Email":{"description":"メールアドレスです。email形式で指定してください。","example":"kessai.tanto@example.jp","maxLength":255,"pattern":"^[\\w.+-]{1,64}@[a-zA-Z\\d](?:[a-zA-Z\\d-]{0,253}[a-zA-Z\\d])?(?:\\.[a-zA-Z\\d](?:[a-zA-Z\\d-]{0,253}[a-zA-Z\\d])?)+$","type":"string"},"Error":{"description":"エラー内容の詳細です。4xxのエラーコードとともに返却されます。","example":{"code":"invalid_after","message":"parameter must be a valid one.","param":"9R6M-VMAN"},"properties":{"code":{"description":"エラーコードです。それぞれの説明については、[エラーコード](#error_codes)を参照してください。","enum":["unavailable_seller","not_found","request_canceled","already_exists","seller_setting_required","forbidden_seller","invalid_json_format","invalid_after","invalid_before","invalid_limit","out_of_range_by_after","out_of_range_by_before","invalid_amount_per_tax_rate_type_amount","invalid_amount_per_tax_rate_type_tax_rate_type","invalid_created_at_from","invalid_created_at_to","invalid_canceled_at_from","invalid_canceled_at_to","invalid_accepted_at_from","invalid_accepted_at_to","invalid_account_transfer_notification_id","invalid_authorization_amount","invalid_authorization_canceled","invalid_authorization_captured","invalid_authorization_credit_facility_balance_shortage","invalid_authorization_expired","invalid_authorization_id","invalid_authorization_not_available","invalid_authorization_not_found","invalid_authorization_not_matched","invalid_authorization_number","invalid_authorization_over_amount","invalid_authorization_over_due_date","invalid_authorization_status","invalid_billing_accepted_at_from","invalid_billing_accepted_at_to","invalid_canceled_transaction_already_used","invalid_canceled_transaction_canceled_in_effective_period","invalid_canceled_transaction_customer_not_matched","invalid_canceled_transaction_expired","invalid_canceled_transaction_id","invalid_canceled_transaction_inherited","invalid_canceled_transaction_not_found","invalid_canceled_transaction_not_accepted","invalid_canceled_transaction_not_available","invalid_canceled_transaction_not_canceled","invalid_canceled_transaction_over_amount","invalid_content_type","invalid_customer_destination","invalid_customer_has_alert","invalid_customer_id","invalid_customer_ids","invalid_customer_name","invalid_customer_number","invalid_customer_payment_method","invalid_customer_account_transfer_request_address1","invalid_customer_account_transfer_request_address2","invalid_customer_account_transfer_request_department","invalid_customer_account_transfer_request_email","invalid_customer_account_transfer_request_name","invalid_customer_account_transfer_request_tel","invalid_customer_account_transfer_request_title","invalid_customer_account_transfer_request_zip_code","invalid_destination_address1","invalid_destination_address2","invalid_destination_cc_emails","invalid_destination_department","invalid_destination_email","invalid_destination_id","invalid_destination_name","invalid_destination_name_kana","invalid_destination_tel","invalid_destination_title","invalid_destination_zip_code","invalid_customer_examination_id","invalid_customer_examination_address1","invalid_customer_examination_address2","invalid_customer_examination_amount","invalid_customer_examination_amount_with_balance","invalid_customer_examination_business_description","invalid_customer_examination_business_type","invalid_customer_examination_corporate_number","invalid_customer_examination_email","invalid_customer_examination_end_date","invalid_customer_examination_remark","invalid_customer_examination_representative_name","invalid_customer_examination_status","invalid_customer_examination_tel","invalid_customer_examination_website","invalid_customer_examination_zip_code","invalid_credit_facility_end_date_from","invalid_credit_facility_end_date_to","invalid_credit_facility_id","invalid_credit_facility_start_date_from","invalid_credit_facility_start_date_to","invalid_credit_facility_status","invalid_customer_name_update_id","invalid_customer_name_update_not_found","invalid_customer_name_update_status","invalid_customer_name_update_name","invalid_customer_name_update_reason","invalid_customer_name_update_under_examination","invalid_invoice_id","invalid_transaction_amount","invalid_transaction_amounts_per_tax_rate_type","invalid_transaction_billing","invalid_transaction_billing_condition","invalid_transaction_details","invalid_transaction_details_amount_total","invalid_transaction_detail_amount","invalid_transaction_detail_description","invalid_transaction_detail_quantity","invalid_transaction_detail_tax_included_type","invalid_transaction_detail_tax_rate_type","invalid_transaction_detail_unit_price","invalid_transaction_date","invalid_transaction_date_from","invalid_transaction_date_to","invalid_transaction_due_date","invalid_transaction_duplicate_invoice_delivery_method","invalid_transaction_multiple_inheritable_options","invalid_transaction_invoice_delivery_methods","invalid_transaction_issue_date","invalid_transaction_id","invalid_transaction_number","invalid_transaction_status","not_cancelable_transaction_status","invalid_billing_due_date_from","invalid_billing_due_date_to","invalid_billing_id","invalid_billing_issue_date_from","invalid_billing_issue_date_to","invalid_billing_status","invalid_billing_unpaid","invalid_payout_date_from","invalid_payout_date_to","invalid_payout_id","invalid_payout_status","invalid_payout_transaction_id","invalid_reissuing_billing_canceled","invalid_reissuing_billing_not_issued","invalid_reissuing_payload_customer_not_matched","invalid_reissuing_payload_destination_not_found","invalid_reissuing_payload_duplicated_invoice_delivery_methods","invalid_reissuing_payload_invoice_delivery_methods","invalid_reissuing_unavailable"],"type":"string"},"message":{"description":"エラー発生原因に関する情報です。","type":"string"},"param":{"description":"何らかの値に関連するエラーの場合その値が入ります。","type":"string"},"type":{"description":"エラー種別です。","enum":["already_exisits_error","conflict_operation_error","invalid_argument_error","not_found_error","rate_limit_error","request_canceled","unavailable_seller","seller_setting_required","forbidden"],"type":"string"}},"type":"object"},"Errors":{"description":"4xx系のエラーが発生した場合にエラー情報を返します。エラーObjectを配列として複数返します。","example":[{"code":"invalid_after","message":"parameter must be a valid one.","param":"9R6M-VMAN"}],"items":{"$ref":"#/definitions/Error"},"type":"array"},"Invoice":{"example":{"amount":20000,"billing_date":"2021-06-09","billing_id":"79NR-9WR6","created_at":"2021-06-15T10:21:34+09:00","destination_id":"WNAV-37R6","id":"79NR-AP96","invoice_delivery_methods":["posting","email"],"object":"invoice","uri":"mfk:invoice:7679-YW36"},"properties":{"amount":{"description":"請求書に記載される請求金額です。","example":20000,"type":"integer"},"billing_date":{"description":"請求書に記載される請求日です。","example":"2021-06-15","format":"date","type":"string"},"billing_id":{"description":"請求IDです。","example":"79NR-9WR6","minLength":1,"type":"string"},"created_at":{"description":"請求書の発行日時です。","example":"2021-06-15T10:21:34+09:00","format":"date-time","type":"string"},"destination_id":{"description":"請求先IDです。送付したい請求先を指定してください。","example":"WNAV-37R6","type":"string"},"id":{"description":"請求書IDです。","example":"79NR-AP96","type":"string"},"invoice_delivery_methods":{"description":"請求書送付方法です。郵送(posting) またはメール送付(email)のうちから少なくとも１つになります。","example":["posting","email"],"items":{"$ref":"#/definitions/InvoiceDeliveryMethod"},"type":"array"},"object":{"description":"このObjectの種別を示します。ここでは必ず`invoice`が入ります。","enum":["invoice"],"example":"invoice","type":"string"},"uri":{"description":"請求書URIです。すべてのリソースで一意の識別子として自動で付与されます。","example":"mfk:invoice:79NR-AP96","type":"string"}},"type":"object"},"InvoiceDeliveryMethod":{"description":"請求書送付方法です。登録時は郵送(posting) またはメール送付(email)のうちから少なくとも１つを指定してください。","enum":["posting","email"],"example":"posting","type":"string"},"Issue":{"example":{"created_at":"2019-04-01T10:36:43+09:00","id":"i/79NR-AP96","type":"invoice"},"properties":{"created_at":{"description":"請求書または口座振替通知書の発行日時です。","example":"2019-04-01T10:36:43+09:00","format":"date-time","type":"string"},"id":{"description":"発行済の請求書または口座振替通知書を表すIDです。請求書の場合は「i/」、口座振替通知書の場合は「a/」がprefixとして付きます。ファイルダウンロード用URL発行エンドポイントでそのままこのIDを使うことができます。","example":"i/79NR-AP96","type":"string"},"type":{"description":"請求種別です。請求書(invoice)もしくは口座振替通知書(account_transfer_notification)のいずれかになります。","enum":["account_transfer_notification","invoice"],"example":"invoice","type":"string"}},"type":"object"},"IssuesList":{"properties":{"items":{"description":"発行済請求情報の一覧です。","items":{"$ref":"#/definitions/Issue"},"type":"array"},"object":{"description":"このObjectの種別を示します。ここでは必ず `list`が設定されます。","enum":["list"],"example":"list","type":"string"}},"type":"object"},"Pagination":{"description":"ページネーション情報です。各Objectの一覧取得の際にリストとともに返却されます。この情報をもとにページ繰りを行うことができます。","properties":{"end":{"description":"この一覧に含まれるリソースのうち最後のリソースのIDです。次ページがある場合は、この値をクエリパラメーター`after`に設定することで次ページを取得することができます。","example":"7679-YW36","type":"string"},"has_next":{"default":false,"description":"次ページがある場合は`true`、ない場合は`false`が返却されます。","example":true,"type":"boolean"},"has_previous":{"default":false,"description":"前ページがある場合は`true`、ない場合は`false`が返却されます。","example":false,"type":"boolean"},"limit":{"description":"ページ当たりの最大件数です。","example":20,"type":"integer"},"start":{"description":"この一覧に含まれるリソースのうち最初のリソースのIDです。前ページがある場合は、この値をクエリパラメーター`before`に設定することで前ページを取得することができます。","example":"9R6M-VMAN","type":"string"},"total":{"description":"条件に合致するリソースの全件数です。","example":143,"type":"integer","x-nullable":true}},"type":"object"},"PaymentMethod":{"description":"顧客の支払方法です。口座振替(`AccountTransfer`)もしくは銀行振込(`BankTransfer`)のいずれかです。顧客の支払方法に応じたObjectが返却されます。 デフォルトでは銀行振込になっています。ただし、初回請求前には振込先口座が指定されていない場合があります。 口座振替に変更する場合には別途書面でのお手続きが必要であるため、サポートセンターへお問い合わせください。","minProperties":1,"properties":{"account_transfer":{"$ref":"#/definitions/AccountTransfer"},"bank_transfer":{"$ref":"#/definitions/BankTransfer"},"object":{"description":"このObjectの種別を示します。ここでは必ず`payment_method`が入ります。","enum":["payment_method"],"example":"payment_method","type":"string"}},"type":"object"},"Payout":{"description":"弊社から売り手様への金額確定済みの振込です。","example":{"amount":300800,"collected_amount":200000,"deduction":{"amount":9400,"returned_credit_amount":500,"tax":{"amount":500,"rate_type":"normal_10"},"tax_free":{"amount":3200,"commission_amount":2200,"early_payout_commission_amount":1000},"taxable":{"amount":7000,"basic_monthly_charge":4500,"billing_charge":{"amount":2000,"quantity":10,"unit_price":200},"convenience_billing":{"charge":15000,"quantity":100,"unit_price":150},"posting":{"amount":500,"quantity":5,"unit_price":100}},"untaxable":{"amount":15000,"revenue_stamp":{"amount":15000,"quantity":100,"unit_price":150}}},"id":"7679-YW36","payout_date":"2019-07-29","receivables_amount":110000,"returned_commission_amount":220,"status":"completed","type":"normal","uri":"mfk:payout:7679-YW36"},"properties":{"amount":{"description":"振込金額です。","example":1000000,"type":"integer"},"collected_amount":{"description":"振込の対象となる回収金額です。","example":200000,"type":"integer","x-nullable":true},"deduction":{"$ref":"#/definitions/Deduction"},"id":{"description":"振込IDです。一意の識別子として自動で付与されます。","example":"7679-YW36","type":"string"},"object":{"description":"このObjectの種別を示します。ここでは必ず`payout`が入ります。","enum":["payout"],"example":"payout","type":"string"},"payout_date":{"description":"振込予定日です。","example":"2019-04-01","format":"date","type":"string"},"receivables_amount":{"description":"振込の対象となる債権金額です。","example":1100000,"type":"integer","x-nullable":true},"returned_commission_amount":{"description":"カード払いが行われた場合に弊社から返還する手数料額です。","example":220,"type":"integer","x-nullable":true},"status":{"description":"振込ステータスです。振込手続中(`in_progress`)、振込完了(`completed`)があります。","enum":["in_progress","completed"],"example":"completed","type":"string"},"type":{"description":"振込種別です。通常振込(`normal`)、早期振込(`early`)があります。","enum":["normal","early"],"example":"normal","type":"string"},"uri":{"description":"振込URIです。すべてのリソースで一意の識別子として自動で付与されます。","example":"mfk:payout:7679-YW36","type":"string"}},"type":"object"},"PayoutRefund":{"description":"売り手さまへの振込金額確定後に発生した取引キャンセルに伴う返金です。","example":{"amount":10000,"commission_amount":100,"customer_id":"W463-AA6V","id":"9NR3-P9A6","object":"payout_refund","payout_id":"7679-YW36","transaction_id":"GY9N-EWNM","uri":"mfk:payout_refund:9NR3-P9A6"},"properties":{"amount":{"description":"返金金額です。","example":10000,"type":"integer"},"commission_amount":{"description":"手数料の金額です。","example":100,"type":"integer","x-nullable":true},"customer_id":{"description":"顧客IDです。この返金が紐づく顧客を示します。","example":"W463-AA6V","type":"string"},"id":{"description":"返金IDです。一意の識別子として自動で付与されます。","example":"9NR3-P9A6","type":"string"},"object":{"description":"このObjectの種別を示します。ここでは必ず`payout_refund`が入ります。","enum":["payout_refund"],"example":"payout_refund","type":"string"},"payout_id":{"description":"返金が含まれる振込のIDです。","example":"7679-YW36","type":"string"},"transaction_id":{"description":"取引IDです。この返金が紐づく取引を示します。","example":"GY9N-EWNM","type":"string"},"uri":{"description":"返金URIです。すべてのリソースで一意の識別子として自動で付与されます。","example":"mfk:payout_refund:9NR3-P9A6","type":"string"}},"type":"object"},"PayoutRefundsList":{"properties":{"items":{"description":"返金一覧です。","items":{"$ref":"#/definitions/PayoutRefund"},"type":"array"},"object":{"description":"このObjectの種別を示します。ここでは必ず `list`が設定されます。","enum":["list"],"example":"list","type":"string"},"pagination":{"$ref":"#/definitions/Pagination"}},"type":"object"},"PayoutTransaction":{"description":"売り手様へ振込に紐づく債権です。","example":{"accepted_at":"2019-04-01T10:36:43+09:00","amount":10000,"commission_amount":200,"commission_rate":2,"early_payout_commission_amount":400,"early_payout_commission_rate":4,"id":"9NR3-P9A6","payout_date":"2019-04-15","payout_id":"7679-YW36","standard_payout_date":"2019-05-01","transaction_id":"GY9N-EWNM","uri":"mfk:payout_transaction:9NR3-P9A6"},"properties":{"accepted_at":{"description":"債権譲受日時です。","example":"2019-04-01T10:36:43+09:00","format":"date-time","type":"string","x-nullable":true},"amount":{"description":"債権金額です。","example":10000,"type":"integer"},"commission_amount":{"description":"手数料の金額です。","example":10000,"type":"integer","x-nullable":true},"commission_rate":{"description":"手数料率です。","example":2,"type":"number","x-nullable":true},"early_payout_commission_amount":{"description":"早期振込手数料です。","example":10000,"type":"integer","x-nullable":true},"early_payout_commission_rate":{"description":"早期振込手数料率です。","example":4,"type":"number","x-nullable":true},"id":{"description":"債権IDです。一意の識別子として自動で付与されます。","example":"9NR3-P9A6","type":"string"},"object":{"description":"このObjectの種別を示します。ここでは必ず`payout_transaction`が入ります。","enum":["payout_transaction"],"example":"payout_transaction","type":"string"},"offset_at":{"description":"譲受した債権の相殺日時です。（本フィールドはマイナス取引の場合に埋まることがあります。0円以下の取引登録をご希望の場合は営業担当までご連絡ください。）","example":"2019-04-01T10:36:43+09:00","format":"date-time","type":"string","x-nullable":true},"payout_date":{"description":"振込予定日です。早期振込の場合、`standard_payout_date`よりも早くなります。","example":"2019-04-15","format":"date","type":"string"},"payout_id":{"description":"債権が含まれる振込のIDです。","example":"7679-YW36","type":"string"},"standard_payout_date":{"description":"通常の振込予定日です。","example":"2019-05-01","format":"date","type":"string"},"transaction_id":{"description":"取引IDです。この債権が紐づく取引を示します。","example":"GY9N-EWNM","type":"string"},"uri":{"description":"債権URIです。すべてのリソースで一意の識別子として自動で付与されます。","example":"mfk:payout_transaction:9NR3-P9A6","type":"string"}},"type":"object"},"PayoutTransactionsList":{"properties":{"items":{"description":"債権一覧です。","items":{"$ref":"#/definitions/PayoutTransaction"},"type":"array"},"object":{"description":"このObjectの種別を示します。ここでは必ず `list`が設定されます。","enum":["list"],"example":"list","type":"string"},"pagination":{"$ref":"#/definitions/Pagination"}},"type":"object"},"PayoutsList":{"properties":{"items":{"description":"振込一覧です。","items":{"$ref":"#/definitions/Payout"},"type":"array"},"object":{"description":"このObjectの種別を示します。ここでは必ず `list`が設定されます。","enum":["list"],"example":"list","type":"string"},"pagination":{"$ref":"#/definitions/Pagination"}},"type":"object"},"ReissuingPayload":{"example":{"destination_id":"WNAV-37R6","invoice_delivery_methods":["posting","email"]},"properties":{"destination_id":{"description":"請求先IDです。送付したい請求先を指定してください。","example":"WNAV-37R6","minLength":1,"type":"string"},"invoice_delivery_methods":{"description":"請求書送付方法です。郵送(posting) またはメール送付(email)のうちから少なくとも１つを指定してください。どちらも選択された場合、どちらの方法でも送付されます。 また、各取引で指定しなかった送付方法でも、請求にまとまった取引のうちでその送付方法を選択しているものがあれば、そちらの送付方法も採用されます。","example":["posting","email"],"items":{"$ref":"#/definitions/InvoiceDeliveryMethod"},"maxItems":2,"minItems":1,"type":"array"}},"required":["destination_id","invoice_delivery_methods"],"type":"object"},"ReissuingResponse":{"properties":{"account_transfer_notification":{"$ref":"#/definitions/AccountTransferNotification"},"invoice":{"$ref":"#/definitions/Invoice"},"type":{"description":"請求種別です。請求書(invoice)もしくは口座振替通知書(account_transfer_notification)のいずれかになります。","enum":["account_transfer_notification","invoice"],"example":"invoice","type":"string"}},"type":"object"},"TaxIncludedType":{"description":"取引明細の単価(`unit_price`), 小計(`amount`)の値が税込(`included`)か税抜(`excluded`)かを示します。返り値が空の場合は旧形式での登録時に指定されなかったことを表します。","enum":["included","excluded"],"type":"string"},"TaxRateType":{"description":"税率種別です。登録時は非課税(`non_taxable`)、消費税8%(`normal_8`)、消費税10%(`normal_10`)、軽減税率8%(`reduced_8`)、経過措置8%(`transitional_measures_8`)、対象外(`inapplicable`)のうちいずれかを指定してください。 返り値が空の場合は旧形式での登録時に指定されなかったことを表します。","enum":["non_taxable","normal_8","normal_10","reduced_8","transitional_measures_8","inapplicable"],"example":"normal_10","type":"string"},"Tel":{"description":"電話番号です。ハイフン有無は任意になります。一部の形式は許容していません。（例：0570-XXX-XXX、0800-XXX-XXXXなど）","example":"03-1234-5678","pattern":"^((0(\\d{1}-?\\d{4}|\\d{2}-?\\d{3}|\\d{3}-?\\d{2}|\\d{4}-?\\d{1}|[5789]0-?\\d{4})-?\\d{4})|(0120-?\\d{3}-?\\d{3}))$","type":"string"},"Transaction":{"description":"取引です。","example":{"accepted_at":"2019-04-03T10:36:43+09:00","amount":5440,"amounts_per_tax_rate_type":[{"amount":2200,"tax_rate_type":"normal_10"},{"amount":3240,"tax_rate_type":"reduced_8"}],"billing":true,"billing_accepted_at":"2019-04-22T10:36:43+09:00","billing_condition":"passed","billing_id":"9R6M-VMAN","canceled_at":"2019-04-22T10:36:43+09:00","created_at":"2019-04-01T10:36:43+09:00","customer_id":"9PNG-VYR6","date":"2019-04-10","destination_id":"WNAV-37R6","due_date":"2019-04-30","id":"7679-YW36","invoice_delivery_method":["posting","email"],"issue_date":"2019-04-20","number":"Transaction-0001","object":"transaction","status":"passed","transaction_details":[{"amount":3000,"description":"商品名A","quantity":3,"tax_included_type":"excluded","tax_rate_type":"normal_10","unit_price":1000},{"amount":3000,"description":"商品名B","quantity":3,"tax_included_type":"excluded","tax_rate_type":"reduced_8","unit_price":1000},{"amount":-1000,"description":"商品名A 返品","quantity":-1,"tax_included_type":"excluded","tax_rate_type":"normal_10","unit_price":1000}],"uri":"mfk:transaction:7679-YW36"},"properties":{"accepted_at":{"description":"債権譲受日時です。","example":"2019-04-03T10:36:43+09:00","format":"date-time","type":"string","x-nullable":true},"amount":{"description":"取引金額です。**税込**金額になります。\n請求モードの設定によって値が変わります。\n- 区分記載請求書モード：TransactionPayload.amountで指定した金額\n- インボイスモード（請求単位）：弊社システムにて算出した金額\n- インボイスモード（取引単位）：TransactionPayload.amountで指定した金額\n","example":2180,"type":"integer"},"amounts_per_tax_rate_type":{"description":"各税率種別毎の**税込**の合計金額です。\n請求モードの設定によって値が変わります。各税率種別の取引明細行の小計を合計した値の税込金額になっています。\n- 区分記載請求書モード：TransactionPayload.amounts_per_tax_rate_typeで指定した金額\n- インボイスモード（請求単位）：空の配列\n- インボイスモード（取引単位）：TransactionPayload.amounts_per_tax_rate_typeで指定した金額\n","items":{"$ref":"#/definitions/AmountPerTaxRateType"},"type":"array"},"billing":{"description":"請求対象であるかをboolean値で表します。`true`の場合請求対象で、`false`の場合は請求対象ではないことを表します。","example":true,"type":"boolean","x-nullable":true},"billing_accepted_at":{"description":"請求依頼受領日時です。請求対象になった日時を表します。請求対象でない場合は空になります。","example":"2019-04-22T10:36:43+09:00","format":"date-time","type":"string","x-nullable":true},"billing_condition":{"$ref":"#/definitions/BillingCondition"},"billing_id":{"description":"請求IDです。請求書にまとめられる単位のIDです。同じ請求IDを持つ取引とまとめられて請求書に記載されます。","example":"9R6M-VMAN","type":"string"},"canceled_at":{"description":"取引がキャンセルされた日時です。未キャンセルの場合は空になります。","example":"2019-04-22T10:36:43+09:00","format":"date-time","type":"string","x-nullable":true},"canceled_transaction_id":{"description":"先行してキャンセルし与信に利用したキャンセル済み取引のIDです。キャンセル取引を利用していない場合は空になります。","example":"79NR-9WR6","type":"string","x-nullable":true},"created_at":{"description":"取引が登録された日時です。","example":"2019-04-01T10:36:43+09:00","format":"date-time","type":"string"},"customer_id":{"description":"顧客IDです。","example":"9PNG-VYR6","type":"string"},"date":{"description":"取引日です。売り手様と顧客様の間で取引を行った日付です。","example":"2019-04-01","format":"date","type":"string"},"destination_id":{"description":"請求先IDです。取引の請求先を示します。","example":"WNAV-37R6","type":"string"},"due_date":{"description":"支払期限です。この日付を超えて入金が確認できない場合は未入金になります。","example":"2019-04-30","format":"date","type":"string"},"id":{"description":"取引IDです。一意の識別子として自動で付与されます。","example":"7679-YW36","type":"string"},"invoice_delivery_methods":{"description":"請求書送付方法です。郵送(posting) またはメール送付(email)のうちから少なくとも１つになります。どちらも選択された場合、どちらの方法でも送付されます。 また、各取引で指定しなかった送付方法でも、請求にまとまった取引のうちでその送付方法を選択しているものがあれば、そちらの送付方法も採用されます。","example":["posting","email"],"items":{"$ref":"#/definitions/InvoiceDeliveryMethod"},"type":"array"},"issue_date":{"description":"請求書発行日です。請求書発送日については\u003ca href=\"https://support.mfkessai.co.jp/hc/ja/articles/900002297303-%E8%AB%8B%E6%B1%82%E6%9B%B8%E7%99%BA%E8%A1%8C%E6%97%A5%E3%81%AB%E3%81%A4%E3%81%84%E3%81%A6\" target=\"_blank\"\u003e請求書発行日について\u003c/a\u003eを参照ください。","example":"2019-04-20","format":"date","type":"string"},"number":{"description":"取引に付与できる任意の取引番号です。本サービスが自動で付与する取引IDとは別で、売り手様が独自に管理する識別子を登録することができます。ただし、売り手様の所有する取引間で一意である必要があります。","example":"Transaction-0001","type":"string"},"object":{"description":"このObjectの種別を示します。ここでは必ず`transaction`が入ります。","enum":["transaction"],"example":"transaction","type":"string"},"offset_at":{"description":"譲受した債権の相殺日時です。（本フィールドはマイナス取引の場合に埋まることがあります。0円以下の取引登録をご希望の場合は営業担当までご連絡ください。）","example":"2019-04-03T10:36:43+09:00","format":"date-time","type":"string","x-nullable":true},"status":{"description":"取引ステータスです。審査中(`unexamined`)、審査通過(`passed`)、審査否決(`rejected`)、キャンセル済(`canceled`)、審査対象外(`examination_exempt`)があります。","enum":["unexamined","passed","rejected","canceled","examination_exempt"],"example":"passed","type":"string"},"transaction_details":{"description":"取引明細行です。","items":{"$ref":"#/definitions/TransactionDetail"},"type":"array"},"uri":{"description":"取引URIです。すべてのリソースで一意の識別子として自動で付与されます。","example":"mfk:transaction:7679-YW36","type":"string"}},"type":"object"},"TransactionDetail":{"description":"取引明細です。請求書に記載される明細行になります。","example":{"amount":3000,"description":"商品名A","quantity":3,"tax_rate_type":"normal_10","unit_price":1000},"properties":{"amount":{"description":"小計です。単価(`unit_price`)×数量(`quantity`)の金額、またはその税込金額です。","example":12000,"type":"number"},"description":{"description":"商品名などです。","example":"商品名A","type":"string"},"object":{"description":"このObjectの種別を示します。ここでは必ず`transaction_detail`が入ります。","enum":["transaction_detail"],"example":"transaction_detail","type":"string"},"quantity":{"description":"数量です。","example":3,"type":"number"},"tax_included_type":{"$ref":"#/definitions/TaxIncludedType"},"tax_rate_type":{"$ref":"#/definitions/TaxRateType"},"unit_price":{"description":"単価です。","example":1000,"type":"number"}},"type":"object"},"TransactionDetailPayload":{"example":{"amount":3000,"description":"商品名A","quantity":3,"tax_included_type":"excluded","tax_rate_type":"normal_10","unit_price":1000},"properties":{"amount":{"description":"小計です。単価(`unit_price`)×数量(`quantity`)の金額を指定してください。またはその金額の税込金額も指定可能です。","example":12000,"maximum":2147483647,"minimum":-2147483648,"multipleOf":0.0001,"type":"number"},"amount_str":{"description":"小計を文字列で指定してください。こちらが指定されている場合、数値型のamountは無視されます。単価(`unit_price`)×数量(`quantity`)の金額を指定してください。","example":"12000.5","maxLength":16,"minLength":1,"pattern":"^-?\\d+(\\.\\d{1,4})?$","type":"string"},"description":{"description":"商品名などです。\u003cbr\u003eSandbox環境において取引審査で任意の結果を指定するためにこの値を用います。詳しくは[審査結果の操作](#environment_magic_number)を参照ください。","example":"商品名A","maxLength":250,"minLength":1,"type":"string"},"quantity":{"description":"数量を指定してください。","example":3,"maximum":2147483647,"minimum":-2147483648,"multipleOf":0.0001,"type":"number"},"quantity_str":{"description":"数量を文字列で指定してください。こちらが指定されている場合、数値型のquantityは無視されます。","example":"3.14","maxLength":16,"minLength":1,"pattern":"^-?\\d+(\\.\\d{1,4})?$","type":"string"},"tax_included_type":{"$ref":"#/definitions/TaxIncludedType"},"tax_rate_type":{"$ref":"#/definitions/TaxRateType"},"unit_price":{"description":"単価を指定してください。","example":1000,"maximum":2147483647,"minimum":-2147483648,"multipleOf":0.0001,"type":"number"},"unit_price_str":{"description":"単価を文字列で指定してください。こちらが指定されている場合、数値型のunit_priceは無視されます。","example":"1.5","maxLength":16,"minLength":1,"pattern":"^-?\\d+(\\.\\d{1,4})?$","type":"string"}},"required":["description","tax_included_type","tax_rate_type"],"type":"object"},"TransactionPayload":{"description":"取引登録情報です。取引登録で利用します。","example":{"amount":5440,"amounts_per_tax_rate_type":[{"amount":2200,"tax_rate_type":"normal_10"},{"amount":3240,"tax_rate_type":"reduced_8"}],"authorization_id":"WNAV-37R6","billing_condition":"passed","canceled_transaction_id":"79NR-9WR6","date":"2019-04-10","destination_id":"WNAV-37R6","due_date":"2019-04-30","invoice_delivery_methods":["posting","email"],"issue_date":"2019-04-20","number":"Transaction-0001","transaction_details":[{"amount":3000,"description":"商品名A","quantity":3,"tax_included_type":"excluded","tax_rate_type":"normal_10","unit_price":1000},{"amount":3000,"description":"商品名B","quantity":3,"tax_included_type":"excluded","tax_rate_type":"reduced_8","unit_price":1000},{"amount":-1000,"description":"商品名A 返品","quantity":1,"tax_included_type":"excluded","tax_rate_type":"normal_10","unit_price":-1000}]},"properties":{"amount":{"description":"取引の税込合計金額です。各課税種別毎の税込金額(amounts_per_tax_rate_type)の合計である必要があります。\n複数取引が請求としてまとまる際に請求金額が2147483647円を超えないようにする必要があります。\n請求モードの設定によって項目の要否が変わります。\n- 区分記載請求書モード：必須項目\n- インボイスモード（請求単位）：任意項目\n- インボイスモード（取引単位）：必須項目\n\nマイナス取引設定が有効な場合、0円以下の値も指定可能です。マイナス取引設定が有効でない場合は1円以上の値を指定する必要があります。\nまた、マイナス取引設定が有効な場合でも月間の取引金額があらかじめ設定されている売り手様ごとの下限を下回らないようにする必要があります。\n0円以下の取引登録をご希望の場合は営業担当までご連絡ください。\n","example":5000,"maximum":2147483647,"minimum":-2147483648,"type":"integer","x-nullable":true},"amounts_per_tax_rate_type":{"description":"各課税種別毎の税込の合計金額です。各課税種別の取引明細行の小計を合計した値の税込金額になっていなければなりません。\n請求モードの設定によって項目の要否が変わります。\n- 区分記載請求書モード：必須項目\n- インボイスモード（請求単位）：任意項目\n- インボイスモード（取引単位）：必須項目\n","example":[{"amount":1100,"tax_rate_type":"normal_10"},{"amount":1080,"tax_rate_type":"reduced_8"}],"items":{"$ref":"#/definitions/AmountPerTaxRateType"},"minItems":1,"type":"array","x-nullable":true},"authorization_id":{"description":"オーソリゼーションIDです。事前に取得したオーソリゼーションを指定してください。利用できないオーソリゼーションである場合は取引登録もできません。 `canceled_transaction_id`と同時に指定はできません。","example":"WNAV-37R6","minLength":1,"type":"string"},"billing_condition":{"$ref":"#/definitions/BillingCondition"},"canceled_transaction_id":{"description":"先行してキャンセルした取引のIDです。与信に利用するキャンセル済み取引を指定します。指定された場合、キャンセル済み取引の与信を利用して審査を行います。利用できないキャンセル取引である場合は取引登録もできません。 `authorization_id`と同時に指定はできません。（本フィールドを利用する場合は審査が必要になります。利用をご希望の場合は営業担当までご連絡ください。）","example":"79NR-9WR6","minLength":1,"type":"string"},"date":{"description":"取引日です。売り手様と顧客の間で取引を行った日付を指定してください。","example":"2019-04-01","format":"date","type":"string"},"destination_id":{"description":"請求先IDです。取引の請求先を指定してください。","example":"WNAV-37R6","minLength":1,"type":"string"},"due_date":{"description":"支払期限です。\u003cbr\u003e取引登録時の制約事項については\u003ca href=\"https://support.mfkessai.co.jp/hc/ja/articles/900002212123\" target=\"_blank\"\u003eサポートページ\u003c/a\u003eを確認してください。","example":"2019-04-30","format":"date","type":"string"},"invoice_delivery_methods":{"description":"請求書送付方法です。郵送(posting) またはメール送付(email)のうちから少なくとも１つを指定してください。どちらも選択された場合、どちらの方法でも送付されます。 また、各取引で指定しなかった送付方法でも、請求にまとまった取引のうちでその送付方法を選択しているものがあれば、そちらの送付方法も採用されます。","example":["posting","email"],"items":{"$ref":"#/definitions/InvoiceDeliveryMethod"},"maxItems":2,"minItems":1,"type":"array"},"issue_date":{"description":"請求書発行日です。請求書が発行される日付を指定します。指定した日付が営業日でない場合は翌営業日になります。また、請求書送付日については\u003ca href=\"https://support.mfkessai.co.jp/hc/ja/articles/900002297303\" target=\"_blank\"\u003eこちら\u003c/a\u003eを参照ください。\u003cbr\u003e 取引登録時の制約事項については\u003ca href=\"https://support.mfkessai.co.jp/hc/ja/articles/900002212123\" target=\"_blank\"\u003eサポートページ\u003c/a\u003eを確認してください。","example":"2019-04-20","format":"date","type":"string"},"number":{"description":"取引に付与できる任意の取引番号です。本サービスが自動で付与する取引IDとは別で、売り手様が独自に管理する識別子を登録することができます。ただし、売り手様の所有する取引間で一意である必要があります。","example":"Transaction-0001","maxLength":100,"minLength":1,"type":"string"},"transaction_details":{"description":"取引明細行です。","example":[{"amount":3000,"description":"商品名A","quantity":3,"tax_included_type":"excluded","tax_rate_type":"normal_8","unit_price":1000},{"amount":3000,"description":"商品名B","quantity":3,"tax_included_type":"excluded","tax_rate_type":"reduced_8","unit_price":1000},{"amount":-1000,"description":"商品名A 返品","quantity":1,"tax_included_type":"excluded","tax_rate_type":"normal_8","unit_price":-1000}],"items":{"$ref":"#/definitions/TransactionDetailPayload"},"maxItems":500,"minItems":1,"type":"array"}},"required":["date","destination_id","due_date","invoice_delivery_methods","issue_date","number","transaction_details"],"type":"object"},"TransactionsList":{"properties":{"items":{"description":"取引一覧です。","items":{"$ref":"#/definitions/Transaction"},"type":"array"},"object":{"description":"このObjectの種別を示します。ここでは必ず `list`が設定されます。","enum":["list"],"example":"list","type":"string"},"pagination":{"$ref":"#/definitions/Pagination"}},"type":"object"},"UploadSignedURL":{"example":{"expires_at":"2023-03-08T10:36:43+09:00","url":"https://upload.mfk.jp/billings/7679-YW36/billing_files?signature=mfkrandomsignature"},"properties":{"expires_at":{"description":"ファイルアップロード用の署名付きURLの有効期限です。","example":"2023-03-08T10:36:43+09:00","format":"date-time","type":"string"},"url":{"description":"ファイルアップロード用の署名付きURLです。","example":"https://upload.mfk.jp/billings/7679-YW36/billing_files?signature=mfkrandomsignature","type":"string"}},"type":"object"},"UploadSignedUrlPayload":{"example":{"content_type":"application/pdf"},"properties":{"content_type":{"description":"アップロードするファイルのメディアタイプです。MIME タイプに準拠した文字列を指定します。\u003cbr\u003e 値は `application/pdf`, `application/json`, `text/csv`, `text/plain` の中から指定します。","enum":["application/pdf","application/json","text/csv","text/plain"],"type":"string"}},"required":["content_type"],"type":"object"},"ZipCode":{"description":"郵便番号です。ハイフン有無は任意になります。但しハイフン無しで登録されますと、請求書にもハイフン無しで記載されます。","example":"111-1111","pattern":"^\\d{3}-?\\d{4}$","type":"string"}},"host":"sandbox-api.mfkessai.co.jp","info":{"contact":{"email":"api.support@mfkessai.co.jp","name":"Support Center","url":"https://support.mfkessai.co.jp/hc/ja"},"description":"Money Forward Kessai REST API","license":{"name":""},"termsOfService":"https://corp.mfkessai.co.jp/images/terms/mfkessai.pdf","title":"Money Forward Kessai API v2","version":"2.14.0"},"parameters":{"after":{"description":"任意のリソースIDを指定します。追加日時の降順でこのIDのリソースよりも後のリソースを取得します。この時`after`で指定したIDのリソースは結果に含まれません。","in":"query","name":"after","required":false,"type":"string"},"before":{"description":"任意のリソースIDを指定します。追加日時の降順でこのIDのリソースよりも前のリソースを取得します。この時`before`で指定したIDのリソースは結果に含まれません。","in":"query","name":"before","required":false,"type":"string"},"limit":{"description":"取得したいリソースの最大件数を指定します。1~200の間の整数で指定してください。指定がない場合は20になります。","format":"int32","in":"query","maximum":200,"minimum":1,"name":"limit","required":false,"type":"integer"}},"paths":{"/authorizations":{"get":{"description":"オーソリゼーション一覧取得","operationId":"GetAuthorizationsList","parameters":[{"description":"顧客IDを指定します。指定された顧客のオーソリゼーションを取得します。","in":"query","name":"customer_id","required":false,"type":"string"},{"description":"オーソリゼーション番号を指定します。 指定されたオーソリゼーションを取得します。","in":"query","maxLength":100,"name":"number","required":false,"type":"string"},{"description":"ステータスを指定します。該当するステータスのオーソリゼーションが返却されます。指定できる値は `active`(有効), `expired`(期限切れ), `captured`(確定済),　`canceled`(キャンセル済) の4種類のみです。","enum":["active","expired","captured","canceled"],"in":"query","name":"status","required":false,"type":"string"},{"description":"指定された日時以降に作成されたオーソリゼーションを取得します。指定された日時に作成されたものも含まれます。 RFC3339の`date-time`(2019-04-01T10:36:43%2B09:00)で指定してください。","format":"date-time","in":"query","name":"created_at_from","required":false,"type":"string"},{"description":"指定された日時以前に作成されたオーソリゼーションを取得します。指定された日時に作成されたものも含まれます。 RFC3339の`date-time`(2019-04-01T10:36:43%2B09:00)で指定してください。","format":"date-time","in":"query","name":"created_at_to","required":false,"type":"string"},{"$ref":"#/parameters/after"},{"$ref":"#/parameters/before"},{"$ref":"#/parameters/limit"}],"responses":{"200":{"description":"オーソリゼーション一覧とページネーション情報です。","schema":{"$ref":"#/definitions/AuthorizationsList"}},"400":{"description":"リクエスト内容の不備によるエラーです。エラー内容を確認してください。","schema":{"$ref":"#/definitions/Errors"}}},"summary":"オーソリゼーション登録の一覧を取得します。顧客IDや番号で絞り込んで取得することもできます。","tags":["Authorization"]},"post":{"description":"オーソリゼーション登録","operationId":"CreateAuthorization","parameters":[{"description":"オーソリゼーション登録情報です。","in":"body","name":"payload","required":true,"schema":{"$ref":"#/definitions/AuthorizationPayload"}}],"responses":{"200":{"description":"登録されたオーソリゼーションが返却されます。","schema":{"$ref":"#/definitions/Authorization"}},"400":{"description":"リクエスト内容の不備によるエラーです。エラー内容を確認してください。","schema":{"$ref":"#/definitions/Errors"}},"404":{"description":"顧客IDで指定した顧客が存在しない場合のエラーです。Errorのparamには指定した顧客IDが入ります。","schema":{"$ref":"#/definitions/Errors"}},"409":{"description":"登録しようとしたと一致するオーソリゼーションが既に登録されている場合のエラーです。指定した`number`が既に登録済みでないか確認してください。","schema":{"$ref":"#/definitions/Errors"}}},"summary":"顧客と金額を指定してオーソリゼーションを登録します。","tags":["Authorization"]}},"/authorizations/{authorization_id}":{"delete":{"description":"オーソリゼーションキャンセル","operationId":"CancelAuthorization","responses":{"200":{"description":"キャンセルしたオーソリゼーションが返却されます。","schema":{"$ref":"#/definitions/Authorization"}},"400":{"description":"リクエスト内容の不備によるエラーです。エラー内容を確認してください。","schema":{"$ref":"#/definitions/Errors"}},"409":{"description":"キャンセルしようとしたオーソリゼーションがキャンセルできない状態の場合のエラーです。","schema":{"$ref":"#/definitions/Errors"}}},"summary":"オーソリゼーションの状態によってはキャンセルができない場合もあります。","tags":["Authorization"]},"get":{"description":"オーソリゼーション取得","operationId":"GetAuthorization","responses":{"200":{"description":"指定したオーソリゼーションが返却されます。","schema":{"$ref":"#/definitions/Authorization"}},"400":{"description":"リクエスト内容の不備によるエラーです。エラー内容を確認してください。","schema":{"$ref":"#/definitions/Errors"}},"404":{"description":"オーソリゼーションIDで指定したオーソリゼーションが存在しない場合のエラーです。Errorのparamには指定したオーソリゼーションIDが入ります。","schema":{"$ref":"#/definitions/Errors"}}},"summary":"オーソリゼーションIDを指定して対象オーソリゼーション１件を取得することができます。","tags":["Authorization"]},"parameters":[{"description":"対象のオーソリゼーションIDを指定してください。","in":"path","name":"authorization_id","required":true,"type":"string"}]},"/billings":{"get":{"description":"請求一覧取得","operationId":"GetBillingsList","parameters":[{"description":"任意の顧客IDを指定します。指定した顧客への請求が返却されます。","in":"query","name":"customer_id","required":false,"type":"string"},{"description":"顧客番号を指定します。指定された顧客の請求を取得します。","in":"query","maxLength":100,"name":"customer_number","required":false,"type":"string"},{"description":"請求ステータスを指定します。該当するステータスの請求が返却されます。複数指定することが可能です。指定できる値は `scheduled`(請求予定), `invoice_issued`(請求書発行済), `account_transfer_notified`(口座振替通知済)の3種類のみです。","in":"query","items":{"enum":["scheduled","invoice_issued","account_transfer_notified"],"type":"string"},"name":"status","required":false,"type":"array"},{"description":"日付を指定します。指定した日付以降の支払期限となっている請求を取得できます。指定された日付のものも含まれます。","format":"date","in":"query","name":"due_date_from","required":false,"type":"string"},{"description":"日付を指定します。指定した日付以前の支払期限となっている請求を取得できます。指定された日付のものも含まれます。","format":"date","in":"query","name":"due_date_to","required":false,"type":"string"},{"description":"日付を指定します。指定した日付以降の請求書発行日となっている請求を取得できます。指定された日付のものも含まれます。","format":"date","in":"query","name":"issue_date_from","required":false,"type":"string"},{"description":"日付を指定します。指定した日付以前の請求書発行日となっている請求を取得できます。指定された日付のものも含まれます。","format":"date","in":"query","name":"issue_date_to","required":false,"type":"string"},{"description":"未入金のあり(`true`)、なし(`false`)を指定します。空文字が指定された場合、`false`として扱われます。","in":"query","name":"unpaid","required":false,"type":"boolean"},{"description":"任意の請求書IDを指定します。指定した請求書に紐付く請求が返却されます。","in":"query","name":"invoice_id","required":false,"type":"string"},{"description":"任意の口座振替通知書IDを指定します。指定した口座振替通知書に紐付く請求が返却されます。","in":"query","name":"account_transfer_notification_id","required":false,"type":"string"},{"$ref":"#/parameters/after"},{"$ref":"#/parameters/before"},{"$ref":"#/parameters/limit"}],"responses":{"200":{"description":"請求一覧とページネーション情報です。","schema":{"$ref":"#/definitions/BillingsList"}},"400":{"description":"リクエスト内容の不備によるエラーです。エラー内容を確認してください。","schema":{"$ref":"#/definitions/Errors"}}},"summary":"区分記載請求書等保存方式に対応した請求一覧を取得します。","tags":["Billing"]}},"/billings/qualified":{"get":{"description":"インボイス請求一覧取得","operationId":"GetBillingsListForQualified","parameters":[{"description":"任意の顧客IDを指定します。指定した顧客への請求が返却されます。","in":"query","name":"customer_id","required":false,"type":"string"},{"description":"顧客番号を指定します。指定された顧客の請求を取得します。","in":"query","maxLength":100,"name":"customer_number","required":false,"type":"string"},{"description":"請求ステータスを指定します。該当するステータスの請求が返却されます。複数指定することが可能です。指定できる値は `scheduled`(請求予定), `invoice_issued`(請求書発行済), `account_transfer_notified`(口座振替通知済)の3種類のみです。","in":"query","items":{"enum":["scheduled","invoice_issued","account_transfer_notified"],"type":"string"},"name":"status","required":false,"type":"array"},{"description":"日付を指定します。指定した日付以降の支払期限となっている請求を取得できます。指定された日付のものも含まれます。","format":"date","in":"query","name":"due_date_from","required":false,"type":"string"},{"description":"日付を指定します。指定した日付以前の支払期限となっている請求を取得できます。指定された日付のものも含まれます。","format":"date","in":"query","name":"due_date_to","required":false,"type":"string"},{"description":"日付を指定します。指定した日付以降の請求書発行日となっている請求を取得できます。指定された日付のものも含まれます。","format":"date","in":"query","name":"issue_date_from","required":false,"type":"string"},{"description":"日付を指定します。指定した日付以前の請求書発行日となっている請求を取得できます。指定された日付のものも含まれます。","format":"date","in":"query","name":"issue_date_to","required":false,"type":"string"},{"description":"未入金のあり(`true`)、なし(`false`)を指定します。空文字が指定された場合、`false`として扱われます。","in":"query","name":"unpaid","required":false,"type":"boolean"},{"description":"任意の請求書IDを指定します。指定した請求書に紐付く請求が返却されます。","in":"query","name":"invoice_id","required":false,"type":"string"},{"description":"任意の口座振替通知書IDを指定します。指定した口座振替通知書に紐付く請求が返却されます。","in":"query","name":"account_transfer_notification_id","required":false,"type":"string"},{"$ref":"#/parameters/after"},{"$ref":"#/parameters/before"},{"$ref":"#/parameters/limit"}],"responses":{"200":{"description":"請求一覧とページネーション情報です。","schema":{"$ref":"#/definitions/BillingsList"}},"400":{"description":"リクエスト内容の不備によるエラーです。エラー内容を確認してください。","schema":{"$ref":"#/definitions/Errors"}}},"summary":"インボイス制度（適格請求書等保存方式）に対応した請求一覧を取得します。請求対象の取引がなくなった請求や、審査中の取引のみを含む請求も含まれます。","tags":["Billing"]}},"/billings/{billing_id}":{"get":{"description":"請求取得","operationId":"GetBilling","responses":{"200":{"description":"指定した請求が返却されます。","schema":{"$ref":"#/definitions/Billing"}},"400":{"description":"リクエスト内容の不備によるエラーです。エラー内容を確認してください。","schema":{"$ref":"#/definitions/Errors"}},"404":{"description":"請求IDで指定した請求が存在しない場合のエラーです。Errorのparamには指定した請求IDが入ります。","schema":{"$ref":"#/definitions/Errors"}}},"summary":"請求IDを指定して請求を取得します。インボイスモードでは請求対象の取引がなくなった請求や、審査中の取引のみを含む請求も取得できます。","tags":["Billing"]},"parameters":[{"description":"対象の請求IDを指定してください。","in":"path","name":"billing_id","required":true,"type":"string"}]},"/billings/{billing_id}/issues":{"get":{"description":"発行済請求情報一覧取得","operationId":"GetIssuesList","responses":{"200":{"description":"指定した請求が発行済請求情報されます。","schema":{"$ref":"#/definitions/IssuesList"}},"400":{"description":"リクエスト内容の不備によるエラーです。エラー内容を確認してください。","schema":{"$ref":"#/definitions/Errors"}},"404":{"description":"請求IDで指定した請求が存在しない場合のエラーです。Errorのparamには指定した請求IDが入ります。","schema":{"$ref":"#/definitions/Errors"}}},"summary":"請求IDを指定して発行済請求情報一覧を取得します。","tags":["Billing"]},"parameters":[{"description":"対象の請求IDを指定してください。","in":"path","name":"billing_id","required":true,"type":"string"}]},"/billings/{billing_id}/issues/{issue_id}/download_signed_url":{"parameters":[{"description":"対象の請求IDを指定してください。","in":"path","name":"billing_id","required":true,"type":"string"},{"description":"対象の発行済の請求書または口座振替通知書を表すIDを指定してください。このIDは請求書の場合は「i/」、口座振替通知書の場合は「a/」がprefixとして付きます。","in":"path","name":"issue_id","required":true,"type":"string"}],"post":{"description":"請求ファイルダウンロードのための署名付きURL発行","operationId":"CreateDownloadSignedUrl","responses":{"200":{"description":"署名付きURLが返却されます。","schema":{"$ref":"#/definitions/DownloadSignedURLList"}},"400":{"description":"リクエスト内容の不備によるエラーです。エラー内容を確認してください。","schema":{"$ref":"#/definitions/Errors"}},"404":{"description":"請求IDで指定した請求が存在しない場合のエラーです。Errorのparamには指定した請求IDが入ります。","schema":{"$ref":"#/definitions/Errors"}}},"summary":"指定した発行済み請求書ファイルまたは口座振替通知書ファイルをダウンロードするための署名付きURLを発行します。\u003cbr\u003e 成功時に返却されたURLに対してGETリクエストを送ることでファイルをダウンロードすることができます。\u003cbr\u003e","tags":["Billing"]}},"/billings/{billing_id}/reissue":{"parameters":[{"description":"対象の請求IDを指定してください。","in":"path","name":"billing_id","required":true,"type":"string"}],"post":{"description":"請求書・口座振替通知書兼請求書再発行","operationId":"ReissueBilling","parameters":[{"description":"再発行情報です。","in":"body","name":"payload","required":true,"schema":{"$ref":"#/definitions/ReissuingPayload"}}],"responses":{"200":{"description":"再発行された請求書または口座振替通知書兼請求書が返却されます。","schema":{"$ref":"#/definitions/ReissuingResponse"}},"400":{"description":"リクエスト内容の不備によるエラーです。エラー内容を確認してください。","schema":{"$ref":"#/definitions/Errors"}},"404":{"description":"請求IDで指定した請求が存在しない場合のエラーです。Errorのparamには指定した請求IDが入ります。","schema":{"$ref":"#/definitions/Errors"}}},"summary":"指定した請求に対する請求書または口座振替通知書兼請求書を再発行します。請求が直近で発行した請求書または口座振替通知書兼請求書と同じ種別で再発行されます。\u003cbr\u003e 振替金額決定以降に口座振替通知書兼請求書が再発行された場合は、振替金額決定時点でキャンセルされていなかった取引を対象に再発行をおこないます。\u003cbr\u003e インボイスモードの請求では、請求対象がなくなり0円になった請求も0円の適格返還請求書として再発行ができます。","tags":["Billing"]}},"/billings/{billing_id}/upload_signed_url":{"parameters":[{"description":"対象の請求IDを指定してください。","in":"path","name":"billing_id","required":true,"type":"string"}],"post":{"description":"請求付記ファイルアップロードのための署名付きURL発行","operationId":"CreateUploadSignedUrl","parameters":[{"description":"請求付記ファイルアップロードのための署名付きURL発行情報です。","in":"body","name":"payload","required":true,"schema":{"$ref":"#/definitions/UploadSignedUrlPayload"}}],"responses":{"200":{"description":"署名付きURLが返却されます。","schema":{"$ref":"#/definitions/UploadSignedURL"}},"400":{"description":"リクエスト内容の不備によるエラーです。エラー内容を確認してください。","schema":{"$ref":"#/definitions/Errors"}},"403":{"description":"このエンドポイントの利用権限がない場合のエラーです。","schema":{"$ref":"#/definitions/Errors"}},"404":{"description":"請求IDで指定した請求が存在しない場合のエラーです。Errorのparamには指定した請求IDが入ります。","schema":{"$ref":"#/definitions/Errors"}}},"summary":"指定した請求に対する付記ファイルをアップロードするための署名付きURLを発行します。\u003cbr\u003e 成功時に返却されたURLに対してファイルをPOSTすることでファイルをアップロードすることができます。\u003cbr\u003e このエンドポイントは利用者を限定しています。使用するには事前設定が必要です。","tags":["Billing"]}},"/credit_facilities":{"get":{"description":"与信枠一覧取得","operationId":"GetCreditFacilitiesList","parameters":[{"description":"顧客IDを指定します。指定された顧客の与信枠を取得します。","in":"query","name":"customer_id","required":false,"type":"string"},{"description":"顧客番号を指定します。 指定された顧客の与信枠を取得します。","in":"query","maxLength":100,"name":"customer_number","required":false,"type":"string"},{"description":"与信枠審査IDを指定します。指定された与信枠審査によって付与された与信枠を取得します。","in":"query","name":"customer_examination_id","required":false,"type":"string"},{"description":"ステータスを指定します。該当するステータスの与信枠が返却されます。指定できる値は `expired`(期限切れ), `active`(適用中), `inactive`(未適用), の３種類のみです。ステータスは複数指定することができます。 複数指定する場合は`?status=expired\u0026status=active`もしくは`?status=expired,active`のように指定してください。","in":"query","items":{"enum":["expired","active","inactive"],"type":"string"},"name":"status","required":false,"type":"array"},{"description":"取引登録期間開始日が指定された日時よりも後の与信枠を取得します。指定された日時のものも含まれます。 RFC3339の`full-date`(2019-04-01)で指定してください。","format":"date","in":"query","name":"start_date_from","required":false,"type":"string"},{"description":"取引登録期間開始日が指定された日時よりも前の与信枠を取得します。指定された日時のものも含まれます。 RFC3339の`full-date`(2019-04-01)で指定してください。","format":"date","in":"query","name":"start_date_to","required":false,"type":"string"},{"description":"取引登録期間終了日が指定された日時よりも後の与信枠を取得します。指定された日時のものも含まれます。 RFC3339の`full-date`(2019-04-01)で指定してください。","format":"date","in":"query","name":"end_date_from","required":false,"type":"string"},{"description":"取引登録期間終了日が指定された日時よりも前の与信枠を取得します。指定された日時のものも含まれます。 RFC3339の`full-date`(2019-04-01)で指定してください。","format":"date","in":"query","name":"end_date_to","required":false,"type":"string"},{"$ref":"#/parameters/after"},{"$ref":"#/parameters/before"},{"$ref":"#/parameters/limit"}],"responses":{"200":{"description":"与信枠一覧とページネーション情報です。","schema":{"$ref":"#/definitions/CreditFacilitiesList"}},"400":{"description":"リクエスト内容の不備によるエラーです。エラー内容を確認してください。","schema":{"$ref":"#/definitions/Errors"}}},"summary":"与信枠の一覧を取得します。顧客IDや取引登録期間開始日・終了日で絞り込んで取得することもできます。","tags":["CreditFacility"]}},"/credit_facilities/{credit_facility_id}":{"get":{"description":"与信枠取得","operationId":"GetCreditFacility","responses":{"200":{"description":"指定した与信枠が返却されます。","schema":{"$ref":"#/definitions/CreditFacility"}},"400":{"description":"リクエスト内容の不備によるエラーです。エラー内容を確認してください。","schema":{"$ref":"#/definitions/Errors"}},"404":{"description":"与信枠IDで指定した与信枠が存在しない場合のエラーです。Errorのparamには指定した与信枠IDが入ります。","schema":{"$ref":"#/definitions/Errors"}}},"summary":"与信枠IDを指定して対象与信枠１件を取得することができます。","tags":["CreditFacility"]},"parameters":[{"description":"対象の与信枠IDを指定してください。","in":"path","name":"credit_facility_id","required":true,"type":"string"}]},"/customer_examinations":{"get":{"description":"与信枠審査一覧取得","operationId":"GetCustomerExaminationsList","parameters":[{"description":"顧客IDを指定します。指定された顧客に対する与信枠審査を取得します。","in":"query","name":"customer_id","required":false,"type":"string"},{"description":"顧客番号を指定します。","in":"query","maxLength":100,"name":"customer_number","required":false,"type":"string"},{"description":"与信枠審査のステータスを指定します。未審査(`unexamined`)、審査通過(`passed`)、審査否決(`rejected`)のいずれかを指定してください。","enum":["passed","rejected","unexamined"],"in":"query","name":"status","required":false,"type":"string"},{"description":"指定された日時以降に作成された与信枠審査を取得します。指定された日時に作成されたものも含まれます。 RFC3339の`date-time`(2019-04-01T10:36:43%2B09:00)で指定してください。","format":"date-time","in":"query","name":"created_at_from","required":false,"type":"string"},{"description":"指定された日時以前に作成された与信枠審査を取得します。指定された日時に作成されたものも含まれます。 RFC3339の`date-time`(2019-04-01T10:36:43%2B09:00)で指定してください。","format":"date-time","in":"query","name":"created_at_to","required":false,"type":"string"},{"$ref":"#/parameters/after"},{"$ref":"#/parameters/before"},{"$ref":"#/parameters/limit"}],"responses":{"200":{"description":"与信枠審査一覧とページネーション情報です。","schema":{"$ref":"#/definitions/CustomerExaminationsList"}},"400":{"description":"リクエスト内容の不備によるエラーです。エラー内容を確認してください。","schema":{"$ref":"#/definitions/Errors"}}},"summary":"与信枠審査の一覧を取得します。顧客IDやステータスで絞り込んで取得することもできます。","tags":["CustomerExamination"]},"post":{"description":"与信枠審査申請","operationId":"CreateCustomerExamination","parameters":[{"description":"与信枠審査申請情報です。","in":"body","name":"payload","required":true,"schema":{"$ref":"#/definitions/CustomerExaminationPayload"}}],"responses":{"200":{"description":"登録した与信枠審査が返却されます。","schema":{"$ref":"#/definitions/CustomerExamination"}},"400":{"description":"リクエスト内容の不備によるエラーです。エラー内容を確認してください。","schema":{"$ref":"#/definitions/Errors"}},"404":{"description":"顧客IDで指定した顧客が存在しない場合のエラーです。Errorのparamには指定した顧客IDが入ります。","schema":{"$ref":"#/definitions/Errors"}},"409":{"description":"審査中の与信枠審査が存在している場合のエラーです。審査中は与信枠審査を登録できません。","schema":{"$ref":"#/definitions/Errors"}}},"summary":"顧客を指定して与信枠審査を申請することができます。最長で申請後2営業日以内に審査いたします。\u003cbr\u003e 自動与信枠審査をご利用の場合、こちらで増枠した金額は今後の与信枠付与に継続して利用されます。また、対象顧客のアラートは解消されます。\u003cbr\u003e Sandbox環境では動作テストのため、任意の審査結果を指定することができます。[審査結果の操作](#environment_magic_number)を参照してください。","tags":["CustomerExamination"]}},"/customer_examinations/{customer_examination_id}":{"get":{"description":"与信枠審査取得","operationId":"GetCustomerExamination","responses":{"200":{"description":"指定した与信枠審査が返却されます。","schema":{"$ref":"#/definitions/CustomerExamination"}},"400":{"description":"リクエスト内容の不備によるエラーです。エラー内容を確認してください。","schema":{"$ref":"#/definitions/Errors"}},"404":{"description":"与信枠審査IDで指定した与信枠審査が存在しない場合のエラーです。Errorのparamには指定した与信枠審査IDが入ります。","schema":{"$ref":"#/definitions/Errors"}}},"summary":"与信枠審査IDを指定して対象与信枠審査１件を取得することができます。","tags":["CustomerExamination"]},"parameters":[{"description":"対象の与信枠審査IDを指定してください。","in":"path","name":"customer_examination_id","required":true,"type":"string"}]},"/customer_name_updates":{"get":{"description":"顧客名変更申請一覧取得","operationId":"GetCustomerNameUpdatesList","parameters":[{"description":"顧客IDを指定します。指定された顧客の顧客名変更申請を取得します。","in":"query","name":"customer_id","required":false,"type":"string"},{"description":"ステータスを指定します。該当するステータスの顧客名変更申請が返却されます。指定できる値は `unexamined`(審査中), `passed`(審査通過), `rejected`(審査否決) の3種類のみです。","enum":["unexamined","passed","rejected"],"in":"query","name":"status","required":false,"type":"string"},{"description":"指定された日時以降に作成された顧客名変更申請を取得します。指定された日時に作成されたものも含まれます。 RFC3339の`date-time`(2019-04-01T10:36:43%2B09:00)で指定してください。","format":"date-time","in":"query","name":"created_at_from","required":false,"type":"string"},{"description":"指定された日時以前に作成された顧客名変更申請を取得します。指定された日時に作成されたものも含まれます。 RFC3339の`date-time`(2019-04-01T10:36:43%2B09:00)で指定してください。","format":"date-time","in":"query","name":"created_at_to","required":false,"type":"string"},{"$ref":"#/parameters/after"},{"$ref":"#/parameters/before"},{"$ref":"#/parameters/limit"}],"responses":{"200":{"description":"顧客名変更申請一覧とページネーション情報です。","schema":{"$ref":"#/definitions/CustomerNameUpdatesList"}},"400":{"description":"リクエスト内容の不備によるエラーです。エラー内容を確認してください。","schema":{"$ref":"#/definitions/Errors"}}},"summary":"顧客名変更申請の一覧を取得します。顧客IDやステータスで絞り込んで取得することもできます。","tags":["CustomerNameUpdate"]},"post":{"description":"顧客名変更申請登録","operationId":"CreateCustomerNameUpdate","parameters":[{"description":"顧客名変更申請情報です。","in":"body","name":"payload","required":true,"schema":{"$ref":"#/definitions/CustomerNameUpdatePayload"}}],"responses":{"200":{"description":"登録された顧客名変更申請が返却されます。","schema":{"$ref":"#/definitions/CustomerNameUpdate"}},"400":{"description":"リクエスト内容の不備によるエラーです。エラー内容を確認してください。","schema":{"$ref":"#/definitions/Errors"}},"404":{"description":"顧客IDで指定した顧客が存在しない場合のエラーです。Errorのparamには指定した顧客IDが入ります。","schema":{"$ref":"#/definitions/Errors"}},"409":{"description":"指定した顧客に対する顧客名変更申請が既に登録されている場合のエラーです。指定した`customer_id`で審査中の申請がないか確認してください。","schema":{"$ref":"#/definitions/Errors"}}},"summary":"顧客と変更希望の顧客名を指定して顧客名変更申請を登録することができます。通常、申請後2営業日以内に審査いたします。\u003cbr\u003e ただし、申請内容に関するご確認事項が発生した場合は、審査が遅れる可能性があります。","tags":["CustomerNameUpdate"]}},"/customer_name_updates/{customer_name_update_id}":{"delete":{"description":"顧客名変更申請キャンセル","operationId":"CanceledCustomerNameUpdate","responses":{"200":{"description":"キャンセルされた顧客名変更申請が返却されます。","schema":{"$ref":"#/definitions/CustomerNameUpdate"}},"400":{"description":"リクエスト内容の不備によるエラーです。エラー内容を確認してください。","schema":{"$ref":"#/definitions/Errors"}},"404":{"description":"顧客名変更申請IDで指定した顧客名変更申請が存在しない場合のエラーです。Errorのparamには指定した顧客名変更申請IDが入ります。","schema":{"$ref":"#/definitions/Errors"}},"409":{"description":"顧客名変更申請IDで指定した顧客名変更申請が既に審査済みまたはキャンセルされている場合のエラーです。","schema":{"$ref":"#/definitions/Errors"}}},"summary":"顧客名変更申請IDを指定して対象顧客名変更申請をキャンセルすることができます。","tags":["CustomerNameUpdate"]},"get":{"description":"顧客名変更申請取得","operationId":"GetCustomerNameUpdate","responses":{"200":{"description":"指定した顧客名変更申請が返却されます。","schema":{"$ref":"#/definitions/CustomerNameUpdate"}},"400":{"description":"リクエスト内容の不備によるエラーです。エラー内容を確認してください。","schema":{"$ref":"#/definitions/Errors"}},"404":{"description":"顧客名変更申請IDで指定した顧客名変更申請が存在しない場合のエラーです。Errorのparamには指定した顧客名変更申請IDが入ります。","schema":{"$ref":"#/definitions/Errors"}}},"summary":"顧客名変更申請IDを指定して対象顧客名変更申請１件を取得することができます。","tags":["CustomerNameUpdate"]},"parameters":[{"description":"対象の顧客名変更申請IDを指定してください。","in":"path","name":"customer_name_update_id","required":true,"type":"string"}]},"/customers":{"get":{"description":"顧客一覧取得","operationId":"GetCustomersList","parameters":[{"description":"任意の顧客の `number`を指定します。該当する顧客がいる場合、その一件のみが返却されます。","in":"query","maxLength":100,"name":"number","required":false,"type":"string"},{"description":"任意の顧客の `id` を指定します。最大で200件まで指定できます。 複数指定する場合は`?ids=ABCD-XXXX\u0026ids=ABCD-YYYY`のように指定してください。","in":"query","items":{"type":"string"},"name":"ids","required":false,"type":"array"},{"description":"支払方法を指定します。該当する支払方法の顧客が返却されます。指定できる値は `bank_transfer`(銀行振込), `account_transfer`(口座振替)の２種類のみです。支払方法は複数指定することができます。 複数指定する場合は`?payment_method=bank_transfer\u0026payment_method=account_transfer`のように指定してください。","in":"query","items":{"enum":["bank_transfer","account_transfer"],"type":"string"},"name":"payment_method","required":false,"type":"array"},{"description":"アラートの有無をboolean値で指定します。`true`の場合アラート有り、`false`の場合はアラート無しを表します。","in":"query","name":"has_alert","required":false,"type":"boolean"},{"description":"指定された日時以降に作成された顧客を取得します。指定された日時に作成されたものも含まれます。 RFC3339の`date-time`(2019-04-01T10:36:43%2B09:00)で指定してください。","format":"date-time","in":"query","name":"created_at_from","required":false,"type":"string"},{"description":"指定された日時以前に作成された顧客を取得します。指定された日時に作成されたものも含まれます。 RFC3339の`date-time`(2019-04-01T10:36:43%2B09:00)で指定してください。","format":"date-time","in":"query","name":"created_at_to","required":false,"type":"string"},{"$ref":"#/parameters/after"},{"$ref":"#/parameters/before"},{"$ref":"#/parameters/limit"}],"responses":{"200":{"description":"顧客一覧とページネーション情報です。","schema":{"$ref":"#/definitions/CustomersList"}},"400":{"description":"リクエスト内容の不備によるエラーです。エラー内容を確認してください。","schema":{"$ref":"#/definitions/Errors"}}},"summary":"顧客の一覧を取得することができます。顧客番号や支払方法、未入金の有無で絞り込んで取得することもできます。","tags":["Customer"]},"post":{"description":"顧客登録","operationId":"CreateCustomer","parameters":[{"description":"顧客登録情報です。請求先情報も含まれています。","in":"body","name":"payload","required":true,"schema":{"$ref":"#/definitions/CustomerPayload"}}],"responses":{"200":{"description":"作成された顧客が返却されます。","schema":{"$ref":"#/definitions/CreateCustomerResponse"}},"400":{"description":"リクエスト内容の不備によるエラーです。エラー内容を確認してください。","schema":{"$ref":"#/definitions/Errors"}},"409":{"description":"登録しようとした顧客と一致する顧客が既に登録されている場合のエラーです。指定した`number`や、その他住所・電話番号などが既に登録済みでないか確認してください。","schema":{"$ref":"#/definitions/Errors"}}},"summary":"顧客を登録することができます。顧客には必ず一つの請求先が必要であるため同時に請求先一件も登録します。","tags":["Customer"]}},"/customers/{customer_id}":{"get":{"description":"顧客取得","operationId":"GetCustomer","responses":{"200":{"description":"指定した顧客が返却されます。","schema":{"$ref":"#/definitions/Customer"}},"400":{"description":"リクエスト内容の不備によるエラーです。エラー内容を確認してください。","schema":{"$ref":"#/definitions/Errors"}},"404":{"description":"顧客IDで指定した顧客が存在しない場合のエラーです。Errorのparamには指定した顧客IDが入ります。","schema":{"$ref":"#/definitions/Errors"}}},"summary":"顧客IDを指定して対象顧客１件を取得することができます。","tags":["Customer"]},"parameters":[{"description":"対象の顧客IDを指定してください。","in":"path","name":"customer_id","required":true,"type":"string"}],"patch":{"description":"顧客更新","operationId":"UpdateCustomer","parameters":[{"description":"顧客更新情報です。","in":"body","name":"payload","required":true,"schema":{"$ref":"#/definitions/CustomerUpdatePayload"}}],"responses":{"200":{"description":"更新した顧客が返却されます。","schema":{"$ref":"#/definitions/Customer"}},"400":{"description":"リクエスト内容の不備によるエラーです。エラー内容を確認してください。","schema":{"$ref":"#/definitions/Errors"}},"404":{"description":"顧客IDで指定した顧客が存在しない場合のエラーです。Errorのparamには指定した顧客IDが入ります。","schema":{"$ref":"#/definitions/Errors"}}},"summary":"顧客の情報を更新することができます。","tags":["Customer"]}},"/customers/{customer_id}/account_transfer_request":{"parameters":[{"description":"対象の顧客IDを指定してください。","in":"path","name":"customer_id","required":true,"type":"string"}],"post":{"description":"口座振替依頼申請","operationId":"ApplyAccountTransferRequest","parameters":[{"description":"口座振替依頼申請に用いる送付先情報です。","in":"body","name":"payload","required":true,"schema":{"$ref":"#/definitions/AccountTransferRequestPayload"}}],"responses":{"200":{"description":"登録された口座振替申請情報が返却されます。","schema":{"$ref":"#/definitions/AccountTransferRequest"}},"400":{"description":"リクエスト内容の不備によるエラーです。エラー内容を確認してください。","schema":{"$ref":"#/definitions/Errors"}},"404":{"description":"顧客IDで指定した顧客が存在しない場合のエラーです。Errorのparamには指定した顧客IDが入ります。","schema":{"$ref":"#/definitions/Errors"}},"409":{"description":"指定した顧客IDで、前回の口座振替依頼の申請から1時間以上時間が経っていない場合のエラーです。","schema":{"$ref":"#/definitions/Errors"}},"412":{"description":"口座振替依頼の申請が現在利用できない場合のエラーです。","schema":{"$ref":"#/definitions/Errors"}}},"summary":"顧客IDを指定して、口座振替依頼を申請することができます。弊社から顧客に口座振替依頼に必要な書類を送付 (無料) します。","tags":["Customer"]}},"/customers/{customer_id}/bank_transfer":{"parameters":[{"description":"対象の顧客IDを指定してください。","in":"path","name":"customer_id","required":true,"type":"string"}],"post":{"description":"振込先口座割り当て","operationId":"AssignBankTransfer","responses":{"200":{"description":"割り当てられた振込先口座情報が返却されます。","schema":{"$ref":"#/definitions/BankTransfer"}},"400":{"description":"リクエスト内容の不備によるエラーです。エラー内容を確認してください。","schema":{"$ref":"#/definitions/Errors"}},"404":{"description":"顧客IDで指定した顧客が存在しない場合のエラーです。Errorのparamには指定した顧客IDが入ります。","schema":{"$ref":"#/definitions/Errors"}},"409":{"description":"振込先口座を割り当てようとした顧客がすでに割り当て済みの場合のエラーです。","schema":{"$ref":"#/definitions/Errors"}}},"summary":"対象顧客１件に振込先口座番号を未割り当ての場合、割り当てます。","tags":["Customer"]}},"/destinations":{"get":{"description":"請求先一覧取得","operationId":"GetDestinationsList","parameters":[{"description":"顧客IDを指定します。指定された顧客の請求先を取得します。`customer_number`に別の顧客の顧客番号を指定した場合には該当請求先は0件になります。","in":"query","name":"customer_id","required":false,"type":"string"},{"description":"顧客番号を指定します。指定された顧客の請求先を取得します。`customer_id`に別の顧客の顧客IDを指定した場合には該当請求先は0件になります。","in":"query","maxLength":100,"name":"customer_number","required":false,"type":"string"},{"description":"指定された日時以降に作成された請求先を取得します。指定された日時に作成されたものも含まれます。 RFC3339の`date-time`(2019-04-01T10:36:43%2B09:00)で指定してください。","format":"date-time","in":"query","name":"created_at_from","required":false,"type":"string"},{"description":"指定された日時以前に作成された請求先を取得します。指定された日時に作成されたものも含まれます。 RFC3339の`date-time`(2019-04-01T10:36:43%2B09:00)で指定してください。","format":"date-time","in":"query","name":"created_at_to","required":false,"type":"string"},{"$ref":"#/parameters/after"},{"$ref":"#/parameters/before"},{"$ref":"#/parameters/limit"}],"responses":{"200":{"description":"請求先一覧とページネーション情報です。","schema":{"$ref":"#/definitions/DestinationsList"}},"400":{"description":"リクエスト内容の不備によるエラーです。エラー内容を確認してください。","schema":{"$ref":"#/definitions/Errors"}}},"summary":"請求先の一覧を取得します。顧客IDや顧客番号で特定の顧客に紐づく請求先に絞り込んで取得することもできます。","tags":["Destination"]},"post":{"description":"請求先登録","operationId":"CreateDestination","parameters":[{"description":"請求先登録情報です。","in":"body","name":"payload","required":true,"schema":{"$ref":"#/definitions/DestinationPayload"}}],"responses":{"200":{"description":"登録した請求先が返却されます。","schema":{"$ref":"#/definitions/Destination"}},"400":{"description":"リクエスト内容の不備によるエラーです。エラー内容を確認してください。","schema":{"$ref":"#/definitions/Errors"}},"404":{"description":"顧客IDで指定した顧客が存在しない場合のエラーです。Errorのparamには指定した顧客IDが入ります。","schema":{"$ref":"#/definitions/Errors"}},"409":{"description":"登録しようとした請求先と一致する請求先が既に登録されている場合のエラーです。住所・電話番号などが既に登録済みでないか確認してください。Errorのparamには登録済みの請求先IDが入ります。","schema":{"$ref":"#/definitions/Errors"}}},"summary":"顧客を指定して請求先を登録することができます。","tags":["Destination"]}},"/destinations/{destination_id}":{"get":{"description":"請求先取得","operationId":"GetDestination","responses":{"200":{"description":"指定した請求先が返却されます。","schema":{"$ref":"#/definitions/Destination"}},"400":{"description":"リクエスト内容の不備によるエラーです。エラー内容を確認してください。","schema":{"$ref":"#/definitions/Errors"}},"404":{"description":"請求先IDで指定した請求先が存在しない場合のエラーです。Errorのparamには指定した請求先IDが入ります。","schema":{"$ref":"#/definitions/Errors"}}},"summary":"請求先IDを指定して対象請求先１件を取得することができます。","tags":["Destination"]},"parameters":[{"description":"対象の請求先IDを指定してください。","in":"path","name":"destination_id","required":true,"type":"string"}],"put":{"description":"請求先更新","operationId":"UpdateDestination","parameters":[{"description":"請求先更新情報です。","in":"body","name":"payload","required":true,"schema":{"$ref":"#/definitions/DestinationUpdatePayload"}}],"responses":{"200":{"description":"更新した請求先が返却されます。","schema":{"$ref":"#/definitions/Destination"}},"400":{"description":"リクエスト内容の不備によるエラーです。エラー内容を確認してください。","schema":{"$ref":"#/definitions/Errors"}},"404":{"description":"請求先IDで指定した顧客が存在しない場合のエラーです。Errorのparamには指定した請求先IDが入ります。","schema":{"$ref":"#/definitions/Errors"}},"409":{"description":"更新しようとした請求先と一致する請求先が既に登録されている場合のエラーです。住所・電話番号などが既に登録済みでないか確認してください。Errorのparamには登録済みの請求先IDが入ります。","schema":{"$ref":"#/definitions/Errors"}}},"summary":"請求先の情報を更新することができます。","tags":["Destination"]}},"/payout_refunds":{"get":{"description":"返金一覧取得","operationId":"GetPayoutRefundsList","parameters":[{"description":"任意の振込IDを指定します。指定した振込に含まれる返金が返却されます。","in":"query","name":"payout_id","required":false,"type":"string"},{"$ref":"#/parameters/after"},{"$ref":"#/parameters/before"},{"$ref":"#/parameters/limit"}],"responses":{"200":{"description":"返金一覧とページネーション情報です。","schema":{"$ref":"#/definitions/PayoutRefundsList"}},"400":{"description":"リクエスト内容の不備によるエラーです。エラー内容を確認してください。","schema":{"$ref":"#/definitions/Errors"}}},"tags":["PayoutRefund"]}},"/payout_transactions":{"get":{"description":"債権一覧取得","operationId":"GetPayoutTransactionsList","parameters":[{"description":"任意の振込IDを指定します。指定した振込に含まれる債権が返却されます。","in":"query","name":"payout_id","required":false,"type":"string"},{"$ref":"#/parameters/after"},{"$ref":"#/parameters/before"},{"$ref":"#/parameters/limit"}],"responses":{"200":{"description":"債権一覧とページネーション情報です。","schema":{"$ref":"#/definitions/PayoutTransactionsList"}},"400":{"description":"リクエスト内容の不備によるエラーです。エラー内容を確認してください。","schema":{"$ref":"#/definitions/Errors"}}},"tags":["PayoutTransaction"]}},"/payout_transactions/{payout_transaction_id}":{"get":{"description":"債権取得","operationId":"GetPayoutTransaction","responses":{"200":{"description":"指定した債権が返却されます。","schema":{"$ref":"#/definitions/PayoutTransaction"}},"400":{"description":"リクエスト内容の不備によるエラーです。エラー内容を確認してください。","schema":{"$ref":"#/definitions/Errors"}},"404":{"description":"債権IDで指定した債権が存在しない場合のエラーです。Errorのparamには指定した債権IDが入ります。","schema":{"$ref":"#/definitions/Errors"}}},"tags":["PayoutTransaction"]},"parameters":[{"description":"取得したい債権のID。","in":"path","name":"payout_transaction_id","required":true,"type":"string"}]},"/payouts":{"get":{"description":"振込一覧取得","operationId":"GetPayoutsList","parameters":[{"description":"振込ステータスを指定します。該当するステータスの振込が返却されます。指定できる値は `in_progress`(振込手続中), `completed`(振込完了)の2種類のみです。","in":"query","items":{"enum":["in_progress","completed"],"type":"string"},"name":"status","required":false,"type":"array"},{"description":"日付を指定します。指定した日付以降の振込予定日となっている振込を取得できます。指定された日付のものも含まれます。","format":"date","in":"query","name":"payout_date_from","required":false,"type":"string"},{"description":"日付を指定します。指定した日付以前の振込予定日となっている振込を取得できます。指定された日付のものも含まれます。","format":"date","in":"query","name":"payout_date_to","required":false,"type":"string"},{"$ref":"#/parameters/after"},{"$ref":"#/parameters/before"},{"$ref":"#/parameters/limit"}],"responses":{"200":{"description":"振込一覧とページネーション情報です。","schema":{"$ref":"#/definitions/PayoutsList"}},"400":{"description":"リクエスト内容の不備によるエラーです。エラー内容を確認してください。","schema":{"$ref":"#/definitions/Errors"}}},"tags":["Payout"]}},"/payouts/{payout_id}":{"get":{"description":"振込取得","operationId":"GetPayout","responses":{"200":{"description":"指定した振込が返却されます。","schema":{"$ref":"#/definitions/Payout"}},"400":{"description":"リクエスト内容の不備によるエラーです。エラー内容を確認してください。","schema":{"$ref":"#/definitions/Errors"}},"404":{"description":"振込IDで指定した振込が存在しない場合のエラーです。Errorのparamには指定した振込IDが入ります。","schema":{"$ref":"#/definitions/Errors"}}},"tags":["Payout"]},"parameters":[{"description":"対象の振込ID。","in":"path","name":"payout_id","required":true,"type":"string"}]},"/transactions":{"get":{"description":"取引一覧取得","operationId":"GetTransactionsList","parameters":[{"description":"任意の取引の `number`を指定します。該当する取引がある場合、その一件のみが返却されます。","in":"query","maxLength":100,"name":"number","required":false,"type":"string"},{"description":"任意の顧客IDを指定します。指定した顧客に対する取引が返却されます。","in":"query","name":"customer_id","required":false,"type":"string"},{"description":"顧客番号を指定します。指定された顧客の取引を取得します。","in":"query","maxLength":100,"name":"customer_number","required":false,"type":"string"},{"description":"任意の請求IDを指定します。指定した請求に含まれる取引が返却されます。","in":"query","name":"billing_id","required":false,"type":"string"},{"description":"取引のステータスを指定します。未審査(`unexamined`)、審査通過(`passed`)、審査否決(`rejected`)、キャンセル済み(`canceled`)のいずれかを指定してください。","enum":["unexamined","passed","rejected","canceled"],"in":"query","name":"status","required":false,"type":"string"},{"description":"請求対象であるかどうかを指定します。請求対象(`true`)、請求対象外(`false`)のいずれかを指定してください。 詳しくは\u003ca href=\"https://support.mfkessai.co.jp/hc/ja/articles/900002241626\" target=\"_blank\"\u003e請求対象とは\u003c/a\u003eを参照してください。","in":"query","name":"billing","required":false,"type":"boolean"},{"description":"取引日が指定された日付以降の取引を取得します。指定された日付が取引日のものも含まれます。 RFC3339の`full-date`(2019-04-01)で指定してください。","format":"date","in":"query","name":"date_from","required":false,"type":"string"},{"description":"取引日が指定された日付以前の取引を取得します。指定された日付が取引日のものも含まれます。 RFC3339の`full-date`(2019-04-01`)で指定してください。","format":"date","in":"query","name":"date_to","required":false,"type":"string"},{"description":"指定された日時以降に作成された取引を取得します。指定された日時に作成されたものも含まれます。 RFC3339の`date-time`(2019-04-01T10:36:43%2B09:00)で指定してください。","format":"date-time","in":"query","name":"created_at_from","required":false,"type":"string"},{"description":"指定された日時以前に作成された取引を取得します。指定された日時に作成されたものも含まれます。 RFC3339の`date-time`(2019-04-01T10:36:43%2B09:00)で指定してください。","format":"date-time","in":"query","name":"created_at_to","required":false,"type":"string"},{"description":"指定された日時以降にキャンセルされた取引を取得します。指定された日時にキャンセルされたものも含まれます。 RFC3339の`date-time`(2019-04-01T10:36:43%2B09:00)で指定してください。","format":"date-time","in":"query","name":"canceled_at_from","required":false,"type":"string"},{"description":"指定された日時以前にキャンセルされた取引を取得します。指定された日時にキャンセルされたものも含まれます。 RFC3339の`date-time`(2019-04-01T10:36:43%2B09:00)で指定してください。","format":"date-time","in":"query","name":"canceled_at_to","required":false,"type":"string"},{"description":"指定された日時以降に債権譲受された取引を取得します。指定された日時に債権譲受されたものも含まれます。 RFC3339の`date-time`(2019-04-01T10:36:43%2B09:00)で指定してください。","format":"date-time","in":"query","name":"accepted_at_from","required":false,"type":"string"},{"description":"指定された日時以前に債権譲受された取引を取得します。指定された日時に債権譲受されたものも含まれます。 RFC3339の`date-time`(2019-04-01T10:36:43%2B09:00)で指定してください。","format":"date-time","in":"query","name":"accepted_at_to","required":false,"type":"string"},{"description":"指定された日時以降に請求依頼を受領した取引を取得します。指定された日時に請求依頼を受領したものも含まれます。 RFC3339の`date-time`(2019-04-01T10:36:43%2B09:00)で指定してください。","format":"date-time","in":"query","name":"billing_accepted_at_from","required":false,"type":"string"},{"description":"指定された日時以前に請求依頼を受領した取引を取得します。指定された日時に請求依頼を受領したものも含まれます。 RFC3339の`date-time`(2019-04-01T10:36:43%2B09:00)で指定してください。","format":"date-time","in":"query","name":"billing_accepted_at_to","required":false,"type":"string"},{"description":"指定された金額以上の取引を取得します。","in":"query","maximum":2147483647,"minimum":1,"name":"amount_from","required":false,"type":"integer"},{"description":"指定された金額未満の取引を取得します。","in":"query","maximum":2147483647,"minimum":1,"name":"amount_to","required":false,"type":"integer"},{"$ref":"#/parameters/after"},{"$ref":"#/parameters/before"},{"$ref":"#/parameters/limit"}],"responses":{"200":{"description":"取引一覧とページネーション情報です。","schema":{"$ref":"#/definitions/TransactionsList"}},"400":{"description":"リクエスト内容の不備によるエラーです。エラー内容を確認してください。","schema":{"$ref":"#/definitions/Errors"}}},"tags":["Transaction"]},"post":{"description":"取引登録","operationId":"CreateTransaction","parameters":[{"in":"body","name":"payload","required":true,"schema":{"$ref":"#/definitions/TransactionPayload"}}],"responses":{"200":{"description":"作成した取引が返却されます。","schema":{"$ref":"#/definitions/Transaction"}},"400":{"description":"リクエスト内容の不備によるエラーです。エラー内容を確認してください。","schema":{"$ref":"#/definitions/Errors"}},"404":{"description":"請求先IDで指定した請求先が存在しない場合のエラーです。Errorのparamには指定した請求先IDが入ります。","schema":{"$ref":"#/definitions/Errors"}},"409":{"description":"登録しようとした取引と一致する取引が既に登録されている場合のエラーです。指定した`number`が既に登録済みでないか確認してください。","schema":{"$ref":"#/definitions/Errors"}}},"summary":"請求先を指定して取引を登録できます。最長で申請後2営業日以内に審査いたします。\u003cbr\u003e 取引登録時の制約事項については\u003ca href=\"https://support.mfkessai.co.jp/hc/ja/articles/900002212123\" target=\"_blank\"\u003eサポートページ\u003c/a\u003eを確認してください。\u003cbr\u003e Sandbox環境では動作テストのため、任意の審査結果を指定することができます。[審査結果の操作](#environment_magic_number)を参照してください。","tags":["Transaction"]}},"/transactions/{transaction_id}":{"delete":{"description":"取引キャンセル","operationId":"CancelTransaction","responses":{"200":{"description":"キャンセルした取引が返却されます。","schema":{"$ref":"#/definitions/Transaction"}},"400":{"description":"リクエスト内容の不備によるエラーです。エラー内容を確認してください。","schema":{"$ref":"#/definitions/Errors"}},"409":{"description":"キャンセルしようとした取引が既にキャンセルされている場合のエラーです。","schema":{"$ref":"#/definitions/Errors"}}},"summary":"取引の状態によってはキャンセルができない場合もあります。\u003ca target=\"_blank\" href=\"https://support.mfkessai.co.jp/hc/ja/articles/900002235166-%E5%8F%96%E5%BC%95%E3%81%AE%E3%82%AD%E3%83%A3%E3%83%B3%E3%82%BB%E3%83%AB\"\u003eキャンセルについて\u003c/a\u003eを参照してください。","tags":["Transaction"]},"get":{"description":"取引取得","operationId":"GetTransaction","responses":{"200":{"description":"指定した取引が返却されます。","schema":{"$ref":"#/definitions/Transaction"}},"400":{"description":"リクエスト内容の不備によるエラーです。エラー内容を確認してください。","schema":{"$ref":"#/definitions/Errors"}},"404":{"description":"取引IDで指定した取引が存在しない場合のエラーです。Errorのparamには指定した取引IDが入ります。","schema":{"$ref":"#/definitions/Errors"}}},"tags":["Transaction"]},"parameters":[{"description":"対象の取引IDを指定してください。","in":"path","name":"transaction_id","required":true,"type":"string"}]}},"produces":["application/json"],"schemes":["https"],"security":[{"apikey":[]}],"securityDefinitions":{"apikey":{"description":"管理画面で取得できるapikeyを`HTTP Header`に `apikey` Headerとして設定してください。","in":"header","name":"apikey","type":"apiKey"}},"swagger":"2.0"}