Api v2icon Fordevelopers
NAV Navbar
curl PHP Ruby Python Go Node.JS

MF KESSAI API v2

ここに選択した言語タブ向けのコードサンプルや、リクエスト・レスポンス例が表示されます。

本APIはMF KESSAI APIのversion 2となります。 version 1の運用から得られた知見や売り手様からのご意見をもとにし、 さらなる機能改善や新機能をより柔軟で利用しやすいAPIとしてご提供させていただきます。

version 2での新機能は以下の通りでございます。

現在version 1をご利用中の売り手様におかれましても今後version 2のご利用を推奨してまいりますが、 version 1も引き続きご利用いただけます。クローズにつきましても利用状況を考慮して慎重を期しますのでご安心ください。

はじめに

本APIはMF KESSAIのサービスをご利用いただくためのAPIです。 より迅速な請求業務連携を実現することができます。

RESTful API

本APIはRESTful指向で設計されています。RESTfulでは各情報はObjectとして扱われ 各Endpointは対象のObjectへのCRUD ( Create / Retrieve / Update / Delete ) 操作を提供します。但し各Objectに対して CRUD操作のすべてが提供されるわけではありません。特にUD ( Update / Delete ) 操作に関してはほとんどのObjectに対して提供されていません。

HTTPメソッドは各々が以下のようにCRUD操作と対応しています。

メソッド 操作
POST Create
GET Retrieve
PATCH Update
DELETE Delete

用語の定義

本ドキュメントで利用する用語について解説します。

項目 説明
Endpoint 単一の機能を提供するURL。例:POST: /customers
Object リソース内に存在する各データ。
Property Objectの各要素。
Parameter APIへのリクエスト時に指定するクエリ引数。
Payload Object登録時に利用するリクエストデータ。

利用を開始する

MF KESSAIを利用して顧客の与信枠を取得してみましょう。 以下の行程ではSandbox環境利用を前提としています。

与信枠取得までの流れ

以下の手順で本APIを利用し、与信枠を取得していきます。

Step1. apikeyを取得する。

Step2. 顧客登録をする。

Step3. 顧客審査を申請する。

Step4. 与信枠を取得する。

Step1. apikeyを取得する

APIをご利用頂く場合、事前にその旨をご依頼いただき、MF KESSAI側で利用登録する必要があります。 お済みでない場合は、担当へお問い合わせください。

利用登録が完了すると、管理画面上のAPIキーページからapikeyを取得できるようになります。

  1. APIキーページへ行き「新規発行」ボタンでapikeyを発行してください。 本番環境であるhttps://s.mfkessai.co.jp/apikeysから取得できるapikeyはSandbox環境のものと異なります。
  2. 発行されたapikeyをコピーしておいてください。

APIキー発行

Step2. 顧客登録をする

顧客登録Endpointを利用して、顧客を登録します。 この際、同時に請求先(Destination)も一件登録されます。

この時レスポンスに含まれるidを顧客ID(customer_id)として利用していきます。

Step2. 顧客登録をします

curl -X POST "https://sandbox-api.mfkessai.co.jp/v2/customers" \
  -H "accept: application/json" \
  -H "Content-Type: application/json" \
  -H "apikey: [apikey]" \
  -d '{
      "destination": {
        "address1": "東京都千代田区1-2-3",
        "address2": "サンプルビル3F",
        "cc_emails": [
          "another.tanto1@example.jp",
          "another.tanto2@example.jp"
        ],
        "department": "経理部",
        "email": "kesai.tanto@example.jp",
        "name": "担当 太郎",
        "name_kana": "タントウ タロウ",
        "tel": "03-1234-5678",
        "title": "部長",
        "zip_code": "111-1111"
      },
      "name": "サンプル顧客",
      "number": "CUSTOMER0001"
    }'
<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'apikey' => '[apikey]',

    );

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array(
    "destination" => array(
        "address1" => "東京都千代田区1-2-3",
        "address2" => "サンプルビル3F",
        "cc_emails" => array(
            "another.tanto1@example.jp",
            "another.tanto2@example.jp"
        ),
        "department" => "経理部",
        "email" => "kesai.tanto@example.jp",
        "name" => "担当 太郎",
        "name_kana" => "タントウ タロウ",
        "tel" => "03-1234-5678",
        "title" => "部長",
        "zip_code" => "111-1111"
    ),
    "name" => "サンプル顧客",
    "number" => "CUSTOMER0001"
);

try {
    $response = $client->request('POST','https://sandbox-api.mfkessai.co.jp/v2/customers', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
}

 // ...
require 'net/http'
require 'uri'

uri = URI.parse("https://sandbox-api.mfkessai.co.jp/v2/customers")

headers = {
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'apikey' => '[apikey]'
}

req = Net::HTTP::Post.new(uri, headers)
req.body='{
  "destination": {
    "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"
  },
  "name": "サンプル顧客",
  "number": "CUSTOMER0001"
}'

req_options = {
    use_ssl: uri.scheme = "https"
}

response = Net::HTTP.start(uri.hostname, uri.port, req_options) do |http|
  res = http.request(req)
  p res
end
import requests

headers = {
    'Content-Type': 'application/json',
    'Accept': 'application/json',
    'apikey': '[apikey]'
}

r = requests.post('https://sandbox-api.mfkessai.co.jp/v2/customers', json={
    "destination": {
        "address1": "東京都千代田区1-2-3",
        "address2": "サンプルビル3F",
        "cc_emails": [
            "another.tanto1@example.jp",
            "another.tanto2@example.jp"
        ],
        "department": "経理部",
        "email": "kesai.tanto@example.jp",
        "name": "担当 太郎",
        "name_kana": "タントウ タロウ",
        "tel": "03-1234-5678",
        "title": "部長",
        "zip_code": "111-1111"
    },
    "name": "サンプル顧客",
    "number": "CUSTOMER0001"
}, headers=headers)

print(r.json())
package main

import (
    "bytes"
    "encoding/json"
    "net/http"
)

type CustomerPayloadDestination struct {
    Address1   string   `json:"address1"`
    Address2   string   `json:"address2"`
    CcEmails   []string `json:"cc_emails"`
    Department string   `json:"department"`
    Email      string   `json:"email"`
    Name       string   `json:"name"`
    NameKana   string   `json:"name_kana"`
    Tel        string   `json:"tel"`
    Title      string   `json:"title"`
    ZipCode    string   `json:"zip_code"`
}

type CustomerPayload struct {
    Destination CustomerPayloadDestination `json:"destination"`
    Name        string                     `json:"name"`
    Number      string                     `json:"number"`
}

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept":       []string{"application/json"},
        "apikey":       []string{"[apikey]"},
    }

    payload, err := json.Marshal(CustomerPayload{
        Destination: CustomerPayloadDestination{
            Address1:   "東京都千代田区1-2-3",
            Address2:   "サンプルビル3F",
            CcEmails:   []string{
                "another.tanto1@example.jp",
                "another.tanto2@example.jp",
            },
            Department: "経理部",
            Email:      "kesai.tanto@example.jp",
            Name:       "担当 太郎",
            NameKana:   "タントウ タロウ",
            Tel:        "03-1234-5678",
            Title:      "部長",
            ZipCode:    "111-1111",
        },
        Name:        "サンプル顧客",
        Number:      "CUSTOMER0001",
    })
    if err != nil {
        // handle error
        return
    }

    data := bytes.NewBuffer(payload)
    req, err := http.NewRequest("POST", "https://sandbox-api.mfkessai.co.jp/v2/customers", data)
    if err != nil {
        // handle error
        return
    }
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
const fetch = require('node-fetch');
const inputBody = `{
  "destination": {
    "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"
  },
  "name": "サンプル顧客",
  "number": "CUSTOMER0001"
}`;
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'apikey':'[apikey]'
};

fetch('https://sandbox-api.mfkessai.co.jp/v2/customers',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

レスポンス

{
    "customer": {
        "created_at": "2019-04-01T10:36:43+09:00",
        "has_alert": false,
        "id": [customer_id],
        "name": "サンプル顧客",
        "number": "CUSTOMER001",
        "object": "customer",
        "payment_method": {
            "bank_transfer": {
                "object": "bank_transfer"
            },
            "object": "payment_method"
        },
        "uri": "mfk:customer:[customer_id]"
    },
    "destination": {
        "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": "[customer_id]",
        "department": "経理部",
        "email": "kessai.tanto@example.jp",
        "id": "69M9-3P96",
        "name": "担当 太郎",
        "name_kana": "タントウ タロウ",
        "object": "destination",
        "tel": "03-1234-5678",
        "title": "部長",
        "uri": "mfk:destination:[destination_id]",
        "zip_code": "111-1111"
    }
}

Step3. 登録した顧客に対する顧客審査を申請する

Step3. 顧客審査を申請します。

curl -X POST "https://sandbox-api.mfkessai.co.jp/v2/customer_examinations" \
  -H "accept: application/json" \
  -H "Content-Type: application/json" \
  -H "apikey: [apikey]" \
  -d '{
       "address1": "東京都千代田区1-2-3",
       "address2": "サンプルビル3F",
       "amount": 20000,
       "business_description": "クラウド型企業間決済サービス",
       "business_type": "corporate",
       "corporate_number": "1234567890123",
       "customer_id": "[customer_id]",
       "email": "kesai.tanto@example.jp",
       "end_date": "2019-04-30",
       "remark": "__passed__",
       "representative_name": "代表太郎",
       "tel": "03-1234-5678",
       "website": "https://mfkessai.co.jp",
       "zip_code": "111-1111"
     }'
<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'apikey' => '[apikey]',

    );

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array(
    "address1" => "東京都千代田区1-2-3",
    "address2" => "サンプルビル3F",
    "amount" => 20000,
    "business_description" => "クラウド型企業間決済サービス",
    "business_type" => "corporate",
    "corporate_number" => "1234567890123",
    "customer_id" => "[customer_id]",
    "email" => "kesai.tanto@example.jp",
    "end_date" => "2019-04-30",
    "remark" => "__passed__",
    "representative_name" => "代表太郎",
    "tel" => "03-1234-5678",
    "website" => "https://mfkessai.co.jp",
    "zip_code" => "111-1111"
);

try {
    $response = $client->request('POST','https://sandbox-api.mfkessai.co.jp/v2/customer_examinations', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...
require 'net/http'
require 'uri'

uri = URI.parse("https://sandbox-api.mfkessai.co.jp/v2/customer_examinations")

headers = {
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'apikey' => '[apikey]'
}

req = Net::HTTP::Post.new(uri, headers)
req.body='{
    "address1": "東京都千代田区1-2-3",
    "address2": "サンプルビル3F",
    "amount": 20000,
    "business_description": "クラウド型企業間決済サービス",
    "business_type": "corporate",
    "corporate_number": "1234567890123",
    "customer_id": "[customer_id]",
    "email": "kesai.tanto@example.jp",
    "end_date": "2019-04-30",
    "remark": "一部上場企業です。",
    "representative_name": "代表太郎",
    "tel": "03-1234-5678",
    "website": "https://mfkessai.co.jp",
    "zip_code": "111-1111"
}'

req_options = {
    use_ssl: uri.scheme = "https"
}

response = Net::HTTP.start(uri.hostname, uri.port, req_options) do |http|
  res = http.request(req)
  p res
end
import requests

headers = {
    'Content-Type': 'application/json',
    'Accept': 'application/json',
    'apikey': '[apikey]'
}

r = requests.post('https://sandbox-api.mfkessai.co.jp/v2/customer_examinations', json={
    "address1": "東京都千代田区1-2-3",
    "address2": "サンプルビル3F",
    "amount": 20000,
    "business_description": "クラウド型企業間決済サービス",
    "business_type": "corporate",
    "corporate_number": "1234567890123",
    "customer_id": "[customer_id]",
    "email": "kesai.tanto@example.jp",
    "end_date": "2019-04-30",
    "remark": "__passed__",
    "representative_name": "代表太郎",
    "tel": "03-1234-5678",
    "website": "https://mfkessai.co.jp",
    "zip_code": "111-1111"
}, headers=headers)

print(r.json())

package main

import (
    "bytes"
    "encoding/json"
    "net/http"
)

type CustomerExaminationPayload struct {
    Address1            string `json:"address1"`
    Address2            string `json:"address2"`
    Amount              int    `json:"amount"`
    BusinessDescription string `json:"business_description"`
    BusinessType        string `json:"business_type"`
    CorporateNumber     string `json:"corporate_number"`
    CustomerID          string `json:"customer_id"`
    Email               string `json:"email"`
    EndDate             string `json:"end_date"`
    Remark              string `json:"remark"`
    RepresentativeName  string `json:"representative_name"`
    Tel                 string `json:"tel"`
    Website             string `json:"website"`
    ZipCode             string `json:"zip_code"`
}

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept":       []string{"application/json"},
        "apikey":       []string{"[apikey]"},
    }

    payload, err := json.Marshal(CustomerExaminationPayload{
        Address1:            "東京都千代田区1-2-3",
        Address2:            "サンプルビル3F",
        Amount:              100001,
        BusinessDescription: "クラウド型企業間決済サービス",
        BusinessType:        "corporate",
        CorporateNumber:     "1234567890123",
        CustomerID:          "NG47-R436",
        Email:               "kesai.tanto@example.jp",
        EndDate:             "2019-09-30",
        Remark:              "__passed__",
        RepresentativeName:  "代表太郎",
        Tel:                 "03-1234-5678",
        Website:             "https://mfkessai.co.jp",
        ZipCode:             "111-1111",
    })
    if err != nil {
        // handle error
        return
    }

    data := bytes.NewBuffer(payload)
    req, err := http.NewRequest("POST", "https://sandbox-api.mfkessai.co.jp/v2/customer_examinations", data)
    if err != nil {
        // handle error
        return
    }
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

const fetch = require('node-fetch');
const inputBody = `{
  "address1": "東京都千代田区1-2-3",
  "address2": "サンプルビル3F",
  "amount": 20000,
  "business_description": "クラウド型企業間決済サービス",
  "business_type": "corporate",
  "corporate_number": "1234567890123",
  "customer_id": "[customer_id]",
  "email": "kesai.tanto@example.jp",
  "end_date": "2019-04-30",
  "remark": "一部上場企業です。",
  "representative_name": "代表太郎",
  "tel": "03-1234-5678",
  "website": "https://mfkessai.co.jp",
  "zip_code": "111-1111"
}`;
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'apikey':'[apikey]'
};

fetch('https://sandbox-api.mfkessai.co.jp/v2/customer_examinations',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

レスポンス

{
  "address1": "東京都千代田区1-2-3",
  "address2": "サンプルビル3F",
  "amount": 20000,
  "business_description": "クラウド型企業間決済サービス",
  "business_type": "corporate",
  "corporate_number": "1234567890123",
  "created_at": "2019-04-25T12:50:52+09:00",
  "customer_id": "[customer_id]",
  "email": "kesai.tanto@example.jp",
  "end_date": "2019-04-30",
  "id": "6V9W-EMYN",
  "object": "customer_examination",
  "remark": "__passed__",
  "representative_name": "代表太郎",
  "status": "unexamined",
  "tel": "03-1234-5678",
  "uri": "mfk:customer_examination:6V9W-EMYN",
  "website": "https://mfkessai.co.jp",
  "zip_code": "111-1111"
}

Step2で作成した顧客に対する顧客審査を申請します。 end_dateは現在時点で指定可能な日付に入れ替えてください。

remark__passed__を入れているのは、審査結果を指定するためです。 これはsandboxのみで提供されている機能です。マジックナンバーを利用した審査結果の操作

Step4. 与信枠を確認する

Step4. 与信枠を確認します

curl -X GET "https://sandbox-api.mfkessai.co.jp/v2/credit_facilities?customer_id=[customer_id]" \
  -H "accept: application/json" \
  -H "apikey: [apikey]"
<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'apikey' => '[apikey]',

    );

$client = new \GuzzleHttp\Client();

try {
    $response = $client->request('GET','https://sandbox-api.mfkessai.co.jp/v2/credit_facilities?customer_id=[customer_id]', array(
        'headers' => $headers,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...
require 'net/http'
require 'uri'

uri = URI.parse("https://sandbox-api.mfk.asia/v2/credit_facilities?customer_id=[customer_id]")

headers = {
    'Accept' => 'application/json',
    'apikey' => '[apikey]'
}

req = Net::HTTP::Get.new(uri, headers)

req_options = {
    use_ssl: uri.scheme = "https"
}

response = Net::HTTP.start(uri.hostname, uri.port, req_options) do |http|
  res = http.request(req)
  p res
end
import requests

headers = {
    'Content-Type': 'application/json',
    'Accept': 'application/json',
    'apikey': '[apikey]'
}

r = requests.get('https://sandbox-api.mfkessai.co.jp/v2/credit_facilities?customer_id=[customer_id]', headers=headers)

print(r.json())
package main

import (
    "fmt"
    "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept":       []string{"application/json"},
        "apikey":       []string{"[apikey]"},
    }

    req, err := http.NewRequest("GET", "https://sandbox-api.mfkessai.co.jp/v2/credit_facilities?customer_id=[customer_id]", nil)
    if err != nil {
        // handle error
        return
    }
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'apikey':'[apikey]'
};

fetch('https://sandbox-api.mfkessai.co.jp/v2/credit_facilities?customer_id=[customer_id]',
{
  method: 'GET',
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

レスポンス

{
  "items": [
    {
      "amount": 200000,
      "balance": 100000,
      "customer_examination_id": "6V9W-EMYN",
      "customer_id": [customer_id],
      "end_date": "2019-04-30",
      "id": "7679-YW36",
      "start_date": "2019-04-25",
      "uri": "mfk:credit_facility:7679-YW36"
    }
  ],
  "object": "list",
  "pagination": {
    "end": "7679-YW36",
    "has_next": false,
    "has_previous": false,
    "limit": 20,
    "start": "7679-YW36",
    "total": 1
  }
}

顧客審査が通過した場合、与信枠が付与されます。 Step3ではマジックナンバーを利用して即時審査通過するように指定したため、顧客審査申請後すぐに与信枠が付与されたことが確認できます。

OpenAPIについて

本APIではAPIのインタフェース定義にOpenAPI Specification(以下OAS)を利用しています。 バージョンはSwaggerとして知られているOpenAPI2.0です。

OAS定義ファイルを利用して本APIのクライアントコードを生成できます。 コード生成ツールが以下のサイトにまとめられていますので、ご利用ください。

APIクライアントの生成

docker run --rm -v ${PWD}:/local openapitools/openapi-generator-cli generate \
    -i  https://mfkessai.co.jp/developer/v2/docs/swagger.yaml \
    -g go \
    -o /local/out/go

swagger.jsonを提供しておりますので、openapi-generatorをご利用いただくことで、APIクライアントを生成することができます。

openapi-generatorの導入方法、使い方はhttps://openapi-generator.tech/をご参照ください。 右はDockerを用いてGoクライアントを生成する例です。他の言語も同様に生成することができます。

ダウンロード

以下のリンクからswagger.yamlをダウンロードしてください。

認証

本APIではHTTP Headerを利用したapikey方式で認可を行っています。 apikeyはお問い合わせ頂いた後にMF KESSAI側で利用登録を行います。その後、管理画面上から発行・取得ができるようになります。 また、apikeyはAPIの旧バージョンであるv1と共通で利用できます。既に発行済みの場合は、再度発行する必要はありません。

漏洩リスク

apikeyは漏洩リスクが高いため、安全に保管するようにしてください。 Github,Bitbucketなどのサードパーティーのホスティングサービスや、フロントエンドのコード内など、外部に公開される場所には絶対に置かないようにしてください。

利用方法

ヘッダー設定例

apikey: abcfc38888b419215612146c427f34637eb05e340e55b68664d81c37276357ba

API利用をご希望される売り手様は、MF KESSAIへお問い合わせください。API利用登録を行います。

  1. APIキーページへ行き「新規発行」ボタンでapikeyを発行してください。 ※本番URLはこちらです。本番APIキーページ
  2. 発行されたapikeyをコピーしておいてください。 APIキー発行
  3. 取得したapikeyを利用して各Endpointへアクセスします。 HTTPヘッダーに右のように設定してください。

環境

本APIではProduction環境とテスト用のSandbox環境を提供しています。

環境名 URL
Production https://api.mfkessai.co.jp/v2/
Sandbox https://sandbox-api.mfkessai.co.jp/v2/

Sandbox環境

Sandbox環境では一部機能が制限されています。 また、Sandbox環境ではテストのため、審査結果などを指定することができます。

機能の制限

制限されている機能は以下の通りです。

マジックナンバーを利用した審査結果の操作

取引審査・顧客審査などで特定の結果を指定してテストを行いたい場合、 Sandbox環境に限りマジックナンバーを利用して期待する結果を得ることができます。

取引審査

対象の取引の取引明細(TransactionDetail)のdescriptionすべて以下に示す結果と対応する文字列にすると、取引の審査結果を指定することができます。

結果 対応する文字列
審査通過 __passed__
審査否決 __rejected__
未審査 __unexamined__

顧客審査

対象の顧客審査(CustomerExamination)のremarkを以下に示す結果と対応する文字列にすると顧客審査結果を指定することができます。

結果 対応する文字列
審査通過 __passed__
審査否決 __rejected__
未審査 __unexamined__

文字コードとデータ形式

文字コード

本APIではリクエスト/レスポンスともに文字コードとしてUTF-8を使用しています。 他の文字コードでの利用はできません。

日時・日付

本APIでの日時・日付を表すデータ形式はRFC3339に準拠しています。 GETメソッドを使用したエンドポイントで、URLにクエリとして含める場合にはURLエンコードしてください。+はURLではスペースとして扱われてしまうので、%2Bとする必要があります。

データ型 フォーマット 凡例
日時 RFC3339 date-time 2019-04-22T15:04:05+09:00
URLに含める場合 2019-04-22T15:04:05%2B09:00
日付 RFC3339 full-date 2019-04-22

小数

小数を表すデータ形式として小数点以下4桁までのdecimal型を利用しています。 小数点以下5桁以上の入力を行うとエラーが返却されます。

エラー

レスポンスコード

本APIは一般的なHTTPレスポンスコードを利用しています。 2xxの範囲のステータスコードは正常処理を表します。 4xxの範囲はリクエストのParameterなどの入力に起因するエラーで、リクエストが受付られない状態を表します。 5xxの範囲はMF KESSAI内部で正常に処理が行われなかった状態を表します。

ステータスコード 内容
200 - OK 成功
400 - Bad Request Parameterの不備などでリクエストを受付られない
401 - Unauthorized 認証・認可できない。apikeyが不正である。
404 - Not Found 指定したリソースが存在しない。
405 - Method Not Allowed 不正なメソッドが利用された。
409 - Conflict 作成しようとしたリソースが既に存在する。
429 - Too Many Requests レートリミットを超えてリクエストがされた
500, 502, 503, 504 - Server Errors MF KESSAI内で処理が正常に行われなかった

タイムアウト

本APIはリクエストの処理時間が一定時間以上になった場合にTimeoutとなることがあります。 指定したレスポンスを返しません。

エラー

レスポンス例

[
  {
    "code": "invalid_parameter",
    "message": "parameter must be a valid one.",
    "param": "9R6M-VMAN"
  }
]

エラー発生時にはエラーレスポンスコードと共にエラーObjectを返却します。

項目 内容
code string エラーコード文字列。発生したエラーに対応したエラーコード
message string エラー発生原因に関する情報。
param string 何らかの値に関するエラーの場合、その値がはいります。

エラーコード

4xxの範囲のエラー時に返却されるエラーコードとその説明の一覧です。

code 内容 param
not_found 指定されたObjectが見つかりませんでした。 -
request_canceled リクエストがキャンセルされました。処理が正常に完了していない可能性があります。 -
already_exists 作成しようとしたObjectが既に存在します。同一の情報をもつObjectがないか確認してください。 -
invalid_json_format POSTデータのjsonが不正なフォーマットになっています。 -
invalid_after ページネーションで指定されたafterの値が不正です。afterは存在するリソースのIDで指定してください。 指定されたafterの値
invalid_before ページネーションで指定されたbeforeの値が不正です。beforeは存在するリソースのIDで指定してください。 指定されたbeforeの値
invalid_limit ページネーションで指定されたlimitの値が不正です。limitは1~200までの整数で指定してください。 指定されたlimitの値
out_of_range_by_after ページネーションで指定されたafterの値が範囲外を指しています。 指定されたafterの値
out_of_range_by_before ページネーションで指定されたbeforeの値が範囲外を指しています。 指定されたbeforeの値
invalid_amount_per_tax_rate_type_amount 指定された各税率種別毎の合計金額amountの値が不正です。 指定されたamountの値
invalid_amount_per_tax_rate_type_tax_rate_type 指定された税率種別tax_rate_typeの値が不正です。取引明細に指定した税率種別をもつ明細が存在することも確認してください。 指定されたtax_rate_typeの値
invalid_created_at_from 指定されたcreated_at_fromの形式または値が不正です。例:2019-04-02T07:00:00+09:00 指定されたcreated_at_fromの値
invalid_created_at_to 指定されたcreated_at_toの形式または値が不正です。例:2019-04-02T07:00:00+09:00 指定されたcreated_at_toの値
invalid_customer_name 指定された顧客名nameの値が不正です。1~50文字の文字列で指定してください。 指定されたnameの値
invalid_customer_number 指定された顧客番号numberの値が不正です。100文字以内の文字列で指定してください。 指定されたnumberの値
invalid_customer_destination 指定された請求先情報destinationの値が不正です。 -
invalid_customer_has_alert 指定されたhas_alertの値が不正です。アラートありtrueまたはアラートなしfalseで指定してください。 指定されたhas_alertの値
invalid_customer_id 指定されたcustomer_idの形式または値が不正です。例:9R6M-VMAN 指定されたcustomer_idの値
invalid_customer_payment_method 指定された支払方法payment_methodの値が不正です。口座振替account_transferまたは銀行振込bank_transferで指定してください。 指定されたpayment_methodの値
invalid_destination_address1 指定されたaddress1の値が不正です。1~100文字の文字列で指定してください。 指定されたaddress1の値
invalid_destination_address2 指定されたaddress1の値が不正です。100文字以内の文字列で指定してください。 指定されたaddress2の値
invalid_destination_cc_emails 指定されたcc_emailsの値が不正です。それぞれメールアドレス形式で指定し、4件以内としてください。 指定されたcc_emailsの値
invalid_destination_department 指定されたdepartmentの値が不正です。50じい内の文字列で指定してください。 指定されたdepartmentの値
invalid_destination_email 指定されたemailの値が不正です。メールアドレス形式で指定してください。 指定されたemailの値
invalid_destination_id 指定されたdestination_idの形式または値が不正です。例:9R6M-VMAN 指定されたdestination_idの値
invalid_destination_name 指定されたnameの値が不正です。60文字以内の文字列で指定してください。 指定されたnameの値
invalid_destination_name_kana 指定されたname_kanaの値が不正です。60文字以内のカタカナで指定してください。 指定されたname_kanaの値
invalid_destination_tel 指定されたtelの値が不正です。有効な電話番号を指定してください。 指定されたtelの値
invalid_destination_title 指定されたtitleの値が不正です。30文字以内の文字列で指定してください。 指定されたtitleの値
invalid_destination_zip_code 指定されたzip_codeの値が不正です。有効な郵便番号を指定してください。 指定されたzip_codeの値
invalid_customer_examination_amount 指定されたamountの値が不正です。10,000,000円以下かつ現在適用中の与信額残高以上の金額を指定してください。 指定されたamountの値
invalid_customer_examination_amount_with_balance 指定されたamountの値が現在適用中の与信額残高以下になっています。10,000,000円以下かつ現在適用中の与信額残高よりも大きな金額を指定してください。 現在適用中の与信額残高balanceの値
invalid_customer_examination_business_description 指定されたbusiness_descriptionの値が不正です。500文字以下で指定してください。 指定されたbusiness_descriptionの値
invalid_customer_examination_business_type 指定されたbusiness_typeの値が不正です。個人事業主individual, 法人corporateのうちから指定してください。不明な場合は空で指定してください。 指定されたbusiness_typeの値
invalid_customer_examination_address1 指定されたaddress1の値が不正です。1~100文字の文字列で指定してください。 指定されたaddress1の値
invalid_customer_examination_address2 指定されたaddress1の値が不正です。100文字以内の文字列で指定してください。 指定されたaddress2の値
invalid_customer_examination_corporate_number 指定されたcorporate_numberの値が不正です。13文字の数字を文字列として指定してください。 指定されたcorporate_numberの値
invalid_customer_examination_email 指定されたemailの値が不正です。メールアドレス形式で指定してください。 指定されたemailの値
invalid_customer_examination_end_date 指定されたend_dateの値が不正です。利用可能な日付を指定してください。例:2019-04-30 有効な候補日のリスト
invalid_customer_examination_id 指定されたcustomer_examination_idの形式または値が不正です。例:9R6M-VMAN 指定されたcustomer_examination_idの値
invalid_customer_examination_remark 指定されたremarkの値が不正です。500文字以内で指定してください。 指定されたremarkの値
invalid_customer_examination_representative_name 指定されたrepresentative_nameの値が不正です。30文字以内で指定してください。 指定されたrepresentative_nameの値
invalid_customer_examination_status 指定されたstatusの値が不正です。未審査unexamined, 審査通過passed, 審査否決rejectedのうちから指定してください。 指定されたstatusの値
invalid_customer_examination_tel 指定されたtelの値が不正です。有効な電話番号を指定してください。 指定されたtelの値
invalid_customer_examination_website 指定されたwebsiteの値が不正です。500文字以内で有効なURLを指定してください。 指定されたwebsiteの値
invalid_customer_examination_zip_code 指定されたzip_codeの値が不正です。有効な郵便番号を指定してください。 指定されたzip_codeの値
invalid_credit_facility_end_date_from 指定されたend_date_fromの形式または値が不正です。日付形式で指定してください。例:2019-04-02 指定されたend_date_fromの値
invalid_credit_facility_end_date_to 指定されたend_date_toの形式または値が不正です。日付形式で指定してください。例:2019-04-02 指定されたend_date_toの値
invalid_credit_facility_id 指定されたcredit_facility_idの形式または値が不正です。例:9R6M-VMAN 指定されたcredit_facility_idの値
invalid_credit_facility_start_date_from 指定されたstart_date_fromの形式または値が不正です。日付形式で指定してください。例:2019-04-02 指定されたstart_date_fromの値
invalid_credit_facility_start_date_to 指定されたstart_date_toの形式または値が不正です。日付形式で指定してください。例:2019-04-02 指定されたstart_date_toの値
invalid_transaction_amount 指定されたamountの値が不正です。1~2,147,483,647円の間で指定してください。 指定されたamountの値
invalid_transaction_amounts_per_tax_rate_type 指定されたamounts_per_tax_rate_typeの値が不正です。 指定されたamounts_per_tax_rate_typeの値
invalid_transaction_details 指定されたdetailsの値が不正です。 -
invalid_transaction_detail_amount 指定されたamountの値が不正です。-2147483648~2147483647の間で小数点以下4桁以内の値を指定してください。また、単価×数量の値と一致するようにしてください。 指定されたamountの値
invalid_transaction_detail_description 指定されたdescriptionの値が不正です。1~250文字の文字列で指定してください。 指定されたdescriptionの値
invalid_transaction_detail_quantity 指定されたquantityの値が不正です。0~2147483647の間で小数点以下4桁以内の値を指定してください。 指定されたquantityの値
invalid_transaction_detail_tax_included_type 指定されたtax_included_typeの値が不正です。税込included, 税抜excludedのうちから指定してください。 指定されたtax_included_typeの値
invalid_transaction_detail_tax_rate_type 指定されたtax_rate_typeの値が不正です。非課税non_taxable、消費税8%8、消費税10%10、軽減税率8%reduced_8、経過措置8%transitional_measures_8のうちいずれかを指定してください。 指定されたtax_rate_typeの値
invalid_transaction_detail_unit_price 指定されたunit_priceの値が不正です。-2147483648~2147483647の間で小数点以下4桁以内の値を指定してください。 指定されたunit_priceの値
invalid_transaction_date 指定されたdateの形式または値が不正です。日付形式で指定してください。例:2019-04-02 指定されたdateの値
invalid_transaction_date_from 指定されたdate_fromの形式または値が不正です。日付形式で指定してください。例:2019-04-02 指定されたdate_fromの値
invalid_transaction_date_to 指定されたdate_toの形式または値が不正です。日付形式で指定してください。例:2019-04-02 指定されたdate_toの値
invalid_transaction_due_date 指定されたdue_dateの形式または値が不正です。日付形式で利用可能な日付を指定してください。例:2019-04-30 指定されたdue_dateの値
invalid_transaction_duplicate_invoice_delivery_method 指定されたinvoice_delivery_methodsで送付方法が重複しています。 重複している送付方法の値
invalid_transaction_invoice_delivery_methods 指定されたinvoice_delivery_methodsの値が不正です。 指定されたinvoice_delivery_methodsの値
invalid_transaction_issue_date 指定されたissue_dateの形式または値が不正です。日付形式で利用可能な日付を指定してください。例:2019-04-30 指定されたissue_dateの値
invalid_transaction_id 指定されたtransaction_idの形式または値が不正です。例:9R6M-VMAN 指定されたtransaction_idの値
invalid_transaction_number 指定されたnumberの値が不正です。1~100文字の文字列で指定してください。また、他の取引と重複しないようにしてください。 指定されたnumberの値
invalid_transaction_status 指定されたstatusの値が不正です。審査中unexamined、審査通過passed、審査否決rejected、キャンセル済canceledのいずれかで指定してください。 指定されたstatusの値
not_cancelable_transaction_status 指定された取引はキャンセル不可の状態です。 指定されたtransaction_id
invalid_billing_due_date_from 指定されたdue_date_fromの形式または値が不正です。日付形式で指定してください。例:2019-04-02 指定されたdue_date_fromの値
invalid_billing_due_date_to 指定されたdue_date_toの形式または値が不正です。日付形式で指定してください。例:2019-04-02 指定されたdue_date_toの値
invalid_billing_id 指定されたbilling_idの形式または値が不正です。例:9R6M-VMAN 指定されたbilling_idの値
invalid_billing_issue_date_from 指定されたissue_date_fromの形式または値が不正です。日付形式で指定してください。例:2019-04-02 指定されたissue_date_fromの値
invalid_billing_issue_date_to 指定されたissue_date_toの形式または値が不正です。日付形式で指定してください。例:2019-04-02 指定されたissue_date_toの値
invalid_billing_unpaid 指定されたunpaidの値が不正です。未入金ありtrue, 未入金なしfalseのいずれかで指定してください。 指定されたunpaidの値
invalid_billing_status 指定されたstatusの値が不正です。請求予定scheduled、請求書発行済invoice_issued 、口座振替通知済account_transfer_notifiedのいずれかで指定してください。 指定されたstatusの値
invalid_payout_date_from 指定されたpayout_date_fromの形式または値が不正です。日付形式で指定してください。例:2019-04-02 指定されたpayout_date_fromの値
invalid_payout_date_to 指定されたpayout_date_toの形式または値が不正です。日付形式で指定してください。例:2019-04-02 指定されたpayout_date_toの値
invalid_payout_id 指定されたpayout_idの形式または値が不正です。例:9R6M-VMAN 指定されたpayout_idの値
invalid_payout_status 指定されたstatusの値が不正です。振込手続中in_progress、振込完了completedのいずれかで指定してください。 指定されたstatusの値
invalid_payout_transaction_id 指定されたpayout_transaction_idの形式または値が不正です。例:9R6M-VMAN 指定されたpayout_transaction_idの値

ページネーション

Cursor Based Paginationについて

本APIのページング方式はCursorBasedを採用しています。

ページ番号やoffsetを指定する方式ではなく、起点となるCursorであるafter(本APIでは各ObjectのID)からlimitの件数だけ取得する方式です。

beforeは前ページの取得になります。afterbeforeのどちらも指定された場合、beforeが利用されます。

本APIではObjectの作成日時降順でObjectの一覧を返却しています。

ページネーションレスポンス

本APIではページネーションが発生するEndpointでは listObjectが返却されます。 listObjectには以下のPropertyが含まれます。

ページネーションのあるEndpointのレスポンス

{
  "object": "list",
  "items": [
    {
      ...
    }
  ],
  "pagination": {
    "end": "7679-YW36",
    "has_next": true,
    "has_previous": true,
    "limit": 20,
    "start": "9R6M-VMAN",
    "total": 143
  }
}

リストObject

項目名 内容
object Objectのタイプ識別子。ここでは必ずlistが入ります。各Objectには必ずこのAttributeがあります。
items 目的のObjectのリスト。array形式になっています。
pagination ページング情報が含まれるObjectです。

ページネーションObject

Pagination

ページ繰り

次ページ

次ページのリクエスト例

curl -X GET https://sandbox-api.mfkessai.co.jp/v2/customers?after=7679-YW36 \
  -H 'Accept: application/json' \
  -H 'apikey: [apikey]'

次のページを取得したい場合には、afterpagination.endの値を入れてリクエストします。

この時、afterで指定したObjectは次のページには含まれません。

また、pagination.has_nextfalseの場合に同じリクエストを行うと範囲外指定のエラー(out_of_range)が返却されます。

前ページ

前ページのリクエスト例

curl -X GET https://sandbox-api.mfkessai.co.jp/v2/customers?before=9R6M-VMAN \
  -H 'Accept: application/json' \
  -H 'apikey: [apikey]'

逆に前ページを取得したい場合には、beforepagination.startの値を入れてリクエストします。

Object関連

MF KESSAI API内の各Objectの関連は下図のようになっています。

Object関連図

レートリミット

本APIではレートリミットを設定しています。 ある一定の頻度を超えてリクエストが行われた際には 単位時間あたりの利用回数を制限させていただく場合があります。

レートリミットを超えた場合には429 Too Many Requestsというエラーコードが返却されはじめます。 その際には利用頻度を抑えるようにしてください。 またこの時正しく処理は行われていないので、リトライするようにしてください。

バージョン

MF KESSAIが提供しているAPIには現在 v1,v2が存在します。 本APIはv2であり、v1との互換性はありません。 但し、apikeyに関しては両APIで共通で利用できます。

新しいPropertyについて

機能改善により、既存のObjectに新たなPropertyが追加されることがあります。 Client側では未知のPropertyは無視するようにしてください。

提供終了について

提供が終了する予定のEndpoint、またはPropertyはDeprecatedと表示されます。 DeprecatedとなっているEndpointまたはPropertyは将来削除予定のものなので、利用を控えてください。

Deprecatedである期間は1年間で、それを過ぎると提供終了します。

リリースについて

新機能や提供終了の連絡はリリースノートと売り手様向けのお知らせメールで行います。

定期的に確認するようにしてください。

リリースノート

新機能のリリースや機能改善・非推奨機能・機能削除の情報を随時更新していきます。

2019.09.26

変更

2019.09.03

新機能

2019.08.22

新機能

2019.07.23

新機能

2019.06.25

新機能

Customer

Customer Object

Customer

{
  "created_at": "2019-04-01T10:36:43+09:00",
  "has_alert": false,
  "id": "7679-YW36",
  "name": "サンプル顧客",
  "number": "CUSTOEMR001",
  "object": "customer",
  "payment_method": {
    "bank_transfer": {
      "object": "bank_transfer",
      "account_number": "123456789",
      "bank_name": "MEKESSAI銀行",
      "branch_name": "大手町支店",
      "holder_name": "エムエフケツサイ(カ",
      "type": "current"
    },
    "object": "payment_method"
  },
  "uri": "mfk:customer:7679-YW36"
}

顧客です。取引登録や与信枠取得などあらゆる機能を利用する起点となります。

Property

項目名 説明
created_at string(date-time) 顧客が登録された日時を示します。
has_alert boolean 未入金アラートの有無を示します。未入金アラートがある場合はtrue、ない場合はfalseを返します。未入金アラートがあると、自動で毎月付与されている与信枠が停止します。
id string 顧客IDです。 MF KESSAIによって発番される一意の識別子です。
name string 顧客名です。
number string 顧客に付与できる任意の顧客番号です。自動で付与される顧客IDとは別に、売り手様が独自に管理する識別子を登録することができます。ただし、売り手様の管理される顧客間で一意でなければなりません。
object string このObjectの種別を示します。ここでは必ずcustomerが入ります。
  • customer
  • payment_method PaymentMethod 顧客の支払方法です。口座振替(AccountTransfer)もしくは銀行振込(BankTransfer)のいずれかです。顧客の支払方法に応じたObjectが返却されます。 デフォルトでは銀行振込になっています。ただし、初回請求前には振込先口座が指定されていない場合があります。 口座振替に変更する場合には別途書面でのお手続きが必要であるため、サポートセンターへお問い合わせください。
    uri string 顧客URIです。すべてのリソースで一意の識別子として自動で付与されます。

    顧客一覧取得

    コードサンプル

    curl -X GET https://sandbox-api.mfkessai.co.jp/v2/customers \
      -H 'Accept: application/json'
      -H 'apikey: API_KEY'
    
    
    <?php
    
    require 'vendor/autoload.php';
    
    $headers = array(
        'Accept' => 'application/json',
        'apikey' => 'API_KEY',
    
        );
    
    $client = new \GuzzleHttp\Client();
    
    // Define array of request body.
    $request_body = '';
    
    try {
        $response = $client->request('GET','https://sandbox-api.mfkessai.co.jp/v2/customers', array(
            'headers' => $headers,
            'body' => $request_body,
           )
        );
        print_r($response->getBody()->getContents());
     }
     catch (\GuzzleHttp\Exception\BadResponseException $e) {
        // handle exception or api errors.
        print_r($e->getMessage());
     }
    
     // ...
    
    
    require 'net/http'
    require 'uri'
    
    uri = URI.parse("https://sandbox-api.mfkessai.co.jp/v2/customers")
    
    headers = {
      'Accept' => 'application/json',
      'apikey' => 'API_KEY'
    }
    
    req = Net::HTTP::Get.new(uri, headers)
    
    req_options = {
        use_ssl: uri.scheme = "https"
    }
    
    response = Net::HTTP.start(uri.hostname, uri.port, req_options) do |http|
      res = http.request(req)
      p res
    end
    
    import requests
    headers = {
      'Accept': 'application/json',
      'apikey': 'API_KEY'
    }
    
    r = requests.get('https://sandbox-api.mfkessai.co.jp/v2/customers', params={
    
    }, headers=headers)
    
    print(r.json())
    
    
    package main
    
    import (
           "bytes"
           "net/http"
    )
    
    func main() {
    
        headers := map[string][]string{
            "Accept": []string{"application/json"},
            "apikey": []string{"API_KEY"},
    
        }
    
        data := bytes.NewBuffer([]byte{``})
        req, err := http.NewRequest("GET", "https://sandbox-api.mfkessai.co.jp/v2/customers", data)
        if err != nil {
            // handle error
            return
        }
        req.Header = headers
    
        client := &http.Client{}
        resp, err := client.Do(req)
        if err != nil {
            // handle error
            return
        }
        // ...
    }
    
    
    const fetch = require('node-fetch');
    
    const headers = {
      'Accept':'application/json',
      'apikey':'API_KEY'
    };
    
    fetch('https://sandbox-api.mfkessai.co.jp/v2/customers',
    {
      method: 'GET',
      headers: headers
    })
    .then(function(res) {
        return res.json();
    }).then(function(body) {
        console.log(body);
    });
    
    

    /customers

    顧客の一覧を取得することができます。顧客番号や支払方法、未入金の有無で絞り込んで取得することもできます。

    QueryParameters

    項目名 説明
    number string 任意の顧客の numberを指定します。該当する顧客がいる場合、その一件のみが返却されます。
    payment_method array[string] 支払方法を指定します。該当する支払方法の顧客が返却されます。指定できる値は bank_transfer(銀行振込), account_transfer(口座振替)の2種類のみです。支払方法は複数指定することができます。 複数指定する場合は?payment_method=bank_transfer&payment_method=account_transferのように指定してください。
    値は以下のうちの一つになります。
    • bank_transfer
    • account_transfer
    has_alert boolean アラートの有無をboolean値で指定します。trueの場合アラート有り、falseの場合はアラート無しを表します。
    created_at_from string(date-time) 指定された日時以降に作成された顧客を取得します。指定された日時に作成されたものも含まれます。 RFC3399のdate-time(2019-04-01T10:36:43%2B09:00)で指定してください。
    created_at_to string(date-time) 指定された日時以前に作成された顧客を取得します。指定された日時に作成されたものも含まれます。 RFC3399のdate-time(2019-04-01T10:36:43%2B09:00)で指定してください。
    after string 任意のリソースIDを指定します。追加日時の降順でこのIDのリソースよりも後のリソースを取得します。この時afterで指定したIDのリソースは結果に含まれません。
    before string 任意のリソースIDを指定します。追加日時の降順でこのIDのリソースよりも前のリソースを取得します。この時beforeで指定したIDのリソースは結果に含まれません。
    limit integer(int32) 取得したいリソースの最大件数を指定します。1~200の間の整数で指定してください。指定がない場合は20になります。

    レスポンス例

    200 Response

    {
      "items": [
        {
          "created_at": "2019-04-01T10:36:43+09:00",
          "has_alert": false,
          "id": "7679-YW36",
          "name": "サンプル顧客",
          "number": "CUSTOEMR001",
          "object": "customer",
          "payment_method": {
            "bank_transfer": {
              "object": "bank_transfer",
              "account_number": "123456789",
              "bank_name": "MEKESSAI銀行",
              "branch_name": "大手町支店",
              "holder_name": "エムエフケツサイ(カ",
              "type": "current"
            },
            "object": "payment_method"
          },
          "uri": "mfk:customer:7679-YW36"
        }
      ],
      "object": "list",
      "pagination": {
        "end": "7679-YW36",
        "has_next": true,
        "has_previous": false,
        "limit": 20,
        "start": "9R6M-VMAN",
        "total": 143
      }
    }
    

    Responses

    ステータス 説明
    200 顧客一覧とページネーション情報です。
    400 リクエスト内容の不備によるエラーです。エラー内容を確認してください。

    Status Code 200

    項目名 説明
    items [Customer] 条件に該当する顧客の一覧です。
    object string このObjectの種別を示します。ここでは必ず listが設定されます。
    pagination Pagination ページネーション情報です。各Objectの一覧取得の際にリストとともに返却されます。この情報をもとにページ繰りを行うことができます。

    顧客登録

    コードサンプル

    curl -X POST https://sandbox-api.mfkessai.co.jp/v2/customers \
      -H 'Content-Type: application/json' \
      -H 'Accept: application/json' \
      -H 'apikey: API_KEY' \
      -d `{
      "destination": {
        "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"
      },
      "customer_examination": {
        "amount": 20000,
        "business_description": "クラウド型企業間決済サービス",
        "business_type": "corporate",
        "corporate_number": "1234567890123",
        "remark": "一部上場企業です。",
        "representative_name": "代表太郎",
        "website": "https://mfkessai.co.jp"
      },
      "name": "サンプル顧客",
      "number": "CUSTOMER0001"
    }`
    
    
    <?php
    
    require 'vendor/autoload.php';
    
    $headers = array(
        'Content-Type' => 'application/json',
        'Accept' => 'application/json',
        'apikey' => 'API_KEY',
    
        );
    
    $client = new \GuzzleHttp\Client();
    
    // Define array of request body.
    $request_body = '{
      "destination": {
        "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"
      },
      "customer_examination": {
        "amount": 20000,
        "business_description": "クラウド型企業間決済サービス",
        "business_type": "corporate",
        "corporate_number": "1234567890123",
        "remark": "一部上場企業です。",
        "representative_name": "代表太郎",
        "website": "https://mfkessai.co.jp"
      },
      "name": "サンプル顧客",
      "number": "CUSTOMER0001"
    }';
    
    try {
        $response = $client->request('POST','https://sandbox-api.mfkessai.co.jp/v2/customers', array(
            'headers' => $headers,
            'body' => $request_body,
           )
        );
        print_r($response->getBody()->getContents());
     }
     catch (\GuzzleHttp\Exception\BadResponseException $e) {
        // handle exception or api errors.
        print_r($e->getMessage());
     }
    
     // ...
    
    
    require 'net/http'
    require 'uri'
    
    uri = URI.parse("https://sandbox-api.mfkessai.co.jp/v2/customers")
    
    headers = {
      'Content-Type' => 'application/json',
      'Accept' => 'application/json',
      'apikey' => 'API_KEY'
    }
    
    req = Net::HTTP::Post.new(uri, headers)
    req.body='{
      "destination": {
        "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"
      },
      "customer_examination": {
        "amount": 20000,
        "business_description": "クラウド型企業間決済サービス",
        "business_type": "corporate",
        "corporate_number": "1234567890123",
        "remark": "一部上場企業です。",
        "representative_name": "代表太郎",
        "website": "https://mfkessai.co.jp"
      },
      "name": "サンプル顧客",
      "number": "CUSTOMER0001"
    }'
    
    req_options = {
        use_ssl: uri.scheme = "https"
    }
    
    response = Net::HTTP.start(uri.hostname, uri.port, req_options) do |http|
      res = http.request(req)
      p res
    end
    
    import requests
    headers = {
      'Content-Type': 'application/json',
      'Accept': 'application/json',
      'apikey': 'API_KEY'
    }
    
    r = requests.post('https://sandbox-api.mfkessai.co.jp/v2/customers', params={
    
    }, json={
      "destination": {
        "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"
      },
      "customer_examination": {
        "amount": 20000,
        "business_description": "クラウド型企業間決済サービス",
        "business_type": "corporate",
        "corporate_number": "1234567890123",
        "remark": "一部上場企業です。",
        "representative_name": "代表太郎",
        "website": "https://mfkessai.co.jp"
      },
      "name": "サンプル顧客",
      "number": "CUSTOMER0001"
    }, headers=headers)
    
    print(r.json())
    
    
    package main
    
    import (
           "bytes"
           "net/http"
    )
    
    func main() {
    
        headers := map[string][]string{
            "Content-Type": []string{"application/json"},
            "Accept": []string{"application/json"},
            "apikey": []string{"API_KEY"},
    
        }
    
        data := bytes.NewBuffer([]byte{`{
      "destination": {
        "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"
      },
      "customer_examination": {
        "amount": 20000,
        "business_description": "クラウド型企業間決済サービス",
        "business_type": "corporate",
        "corporate_number": "1234567890123",
        "remark": "一部上場企業です。",
        "representative_name": "代表太郎",
        "website": "https://mfkessai.co.jp"
      },
      "name": "サンプル顧客",
      "number": "CUSTOMER0001"
    }`})
        req, err := http.NewRequest("POST", "https://sandbox-api.mfkessai.co.jp/v2/customers", data)
        if err != nil {
            // handle error
            return
        }
        req.Header = headers
    
        client := &http.Client{}
        resp, err := client.Do(req)
        if err != nil {
            // handle error
            return
        }
        // ...
    }
    
    
    const fetch = require('node-fetch');
    const inputBody = `{
      "destination": {
        "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"
      },
      "customer_examination": {
        "amount": 20000,
        "business_description": "クラウド型企業間決済サービス",
        "business_type": "corporate",
        "corporate_number": "1234567890123",
        "remark": "一部上場企業です。",
        "representative_name": "代表太郎",
        "website": "https://mfkessai.co.jp"
      },
      "name": "サンプル顧客",
      "number": "CUSTOMER0001"
    }`;
    const headers = {
      'Content-Type':'application/json',
      'Accept':'application/json',
      'apikey':'API_KEY'
    };
    
    fetch('https://sandbox-api.mfkessai.co.jp/v2/customers',
    {
      method: 'POST',
      body: inputBody,
      headers: headers
    })
    .then(function(res) {
        return res.json();
    }).then(function(body) {
        console.log(body);
    });
    
    

    /customers

    顧客を登録することができます。顧客には必ず一つの請求先が必要であるため同時に請求先一件も登録します。

    Body parameter

    {
      "destination": {
        "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"
      },
      "customer_examination": {
        "amount": 20000,
        "business_description": "クラウド型企業間決済サービス",
        "business_type": "corporate",
        "corporate_number": "1234567890123",
        "remark": "一部上場企業です。",
        "representative_name": "代表太郎",
        "website": "https://mfkessai.co.jp"
      },
      "name": "サンプル顧客",
      "number": "CUSTOMER0001"
    }
    

    BodyParameters

    項目名 説明
    body
    required
    CustomerPayload 顧客登録情報です。請求先情報も含まれています。

    レスポンス例

    200 Response

    {
      "customer": {
        "created_at": "2019-04-01T10:36:43+09:00",
        "has_alert": false,
        "id": "7679-YW36",
        "name": "サンプル顧客",
        "number": "CUSTOEMR001",
        "object": "customer",
        "payment_method": {
          "bank_transfer": {
            "object": "bank_transfer",
            "account_number": "123456789",
            "bank_name": "MEKESSAI銀行",
            "branch_name": "大手町支店",
            "holder_name": "エムエフケツサイ(カ",
            "type": "current"
          },
          "object": "payment_method"
        },
        "uri": "mfk:customer:7679-YW36"
      },
      "destination": {
        "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"
      }
    }
    

    Responses

    ステータス 説明
    200 作成された顧客が返却されます。
    400 リクエスト内容の不備によるエラーです。エラー内容を確認してください。
    409 登録しようとした顧客と一致する顧客が既に登録されている場合のエラーです。指定したnumberや、その他住所・電話番号などが既に登録済みでないか確認してください。

    Status Code 200

    項目名 説明
    customer Customer 顧客です。取引登録や与信枠取得などあらゆる機能を利用する起点となります。
    destination Destination 請求先です。一つの顧客に対して複数作成することができます。請求先の情報を利用して請求書送付を行います。

    顧客取得

    コードサンプル

    curl -X GET https://sandbox-api.mfkessai.co.jp/v2/customers/{customer_id} \
      -H 'Accept: application/json'
      -H 'apikey: API_KEY'
    
    
    <?php
    
    require 'vendor/autoload.php';
    
    $headers = array(
        'Accept' => 'application/json',
        'apikey' => 'API_KEY',
    
        );
    
    $client = new \GuzzleHttp\Client();
    
    // Define array of request body.
    $request_body = '';
    
    try {
        $response = $client->request('GET','https://sandbox-api.mfkessai.co.jp/v2/customers/{customer_id}', array(
            'headers' => $headers,
            'body' => $request_body,
           )
        );
        print_r($response->getBody()->getContents());
     }
     catch (\GuzzleHttp\Exception\BadResponseException $e) {
        // handle exception or api errors.
        print_r($e->getMessage());
     }
    
     // ...
    
    
    require 'net/http'
    require 'uri'
    
    uri = URI.parse("https://sandbox-api.mfkessai.co.jp/v2/customers")
    
    headers = {
      'Accept' => 'application/json',
      'apikey' => 'API_KEY'
    }
    
    req = Net::HTTP::Get.new(uri, headers)
    
    req_options = {
        use_ssl: uri.scheme = "https"
    }
    
    response = Net::HTTP.start(uri.hostname, uri.port, req_options) do |http|
      res = http.request(req)
      p res
    end
    
    import requests
    headers = {
      'Accept': 'application/json',
      'apikey': 'API_KEY'
    }
    
    r = requests.get('https://sandbox-api.mfkessai.co.jp/v2/customers/{customer_id}', params={
    
    }, headers=headers)
    
    print(r.json())
    
    
    package main
    
    import (
           "bytes"
           "net/http"
    )
    
    func main() {
    
        headers := map[string][]string{
            "Accept": []string{"application/json"},
            "apikey": []string{"API_KEY"},
    
        }
    
        data := bytes.NewBuffer([]byte{``})
        req, err := http.NewRequest("GET", "https://sandbox-api.mfkessai.co.jp/v2/customers/{customer_id}", data)
        if err != nil {
            // handle error
            return
        }
        req.Header = headers
    
        client := &http.Client{}
        resp, err := client.Do(req)
        if err != nil {
            // handle error
            return
        }
        // ...
    }
    
    
    const fetch = require('node-fetch');
    
    const headers = {
      'Accept':'application/json',
      'apikey':'API_KEY'
    };
    
    fetch('https://sandbox-api.mfkessai.co.jp/v2/customers/{customer_id}',
    {
      method: 'GET',
      headers: headers
    })
    .then(function(res) {
        return res.json();
    }).then(function(body) {
        console.log(body);
    });
    
    

    /customers/{customer_id}

    顧客IDを指定して対象顧客1件を取得することができます。

    PathParameters

    項目名 説明
    customer_id
    required
    string 対象の顧客IDを指定してください。

    レスポンス例

    200 Response

    {
      "created_at": "2019-04-01T10:36:43+09:00",
      "has_alert": false,
      "id": "7679-YW36",
      "name": "サンプル顧客",
      "number": "CUSTOEMR001",
      "object": "customer",
      "payment_method": {
        "bank_transfer": {
          "object": "bank_transfer",
          "account_number": "123456789",
          "bank_name": "MEKESSAI銀行",
          "branch_name": "大手町支店",
          "holder_name": "エムエフケツサイ(カ",
          "type": "current"
        },
        "object": "payment_method"
      },
      "uri": "mfk:customer:7679-YW36"
    }
    

    Responses

    ステータス 説明
    200 指定した顧客が返却されます。
    400 リクエスト内容の不備によるエラーです。エラー内容を確認してください。
    404 顧客IDで指定した顧客が存在しない場合のエラーです。

    Status Code 200

    項目名 説明
    created_at string(date-time) 顧客が登録された日時を示します。
    has_alert boolean 未入金アラートの有無を示します。未入金アラートがある場合はtrue、ない場合はfalseを返します。未入金アラートがあると、自動で毎月付与されている与信枠が停止します。
    id string 顧客IDです。 MF KESSAIによって発番される一意の識別子です。
    name string 顧客名です。
    number string 顧客に付与できる任意の顧客番号です。自動で付与される顧客IDとは別に、売り手様が独自に管理する識別子を登録することができます。ただし、売り手様の管理される顧客間で一意でなければなりません。
    object string このObjectの種別を示します。ここでは必ずcustomerが入ります。
    payment_method PaymentMethod 顧客の支払方法です。口座振替(AccountTransfer)もしくは銀行振込(BankTransfer)のいずれかです。顧客の支払方法に応じたObjectが返却されます。 デフォルトでは銀行振込になっています。ただし、初回請求前には振込先口座が指定されていない場合があります。 口座振替に変更する場合には別途書面でのお手続きが必要であるため、サポートセンターへお問い合わせください。
    uri string 顧客URIです。すべてのリソースで一意の識別子として自動で付与されます。

    Destination

    Destination Object

    Destination

    {
      "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"
    }
    
    

    請求先です。一つの顧客に対して複数作成することができます。請求先の情報を利用して請求書送付を行います。

    Property

    項目名 説明
    address1 Address1 都道府県・市区町村・番地です。必ず都道府県名から始めてください。
    address2 Address2 建物名・部屋番号などです。
    cc_emails [Email] CCメールアドレスです。最大4件まで登録できます。
    created_at string(date-time) 請求先が登録された日時を示します。
    customer_id string 顧客IDです。一意の識別子として自動で付与されます。
    department string 担当者の部署名です。
    email Email メールアドレスです。email形式で指定してください。
    id string 請求先IDです。一意の識別子として自動で付与されます。
    name string 担当者名です。
    name_kana string 担当者名カナです。全角カタカナで入力してください。
    object string このObjectの種別を示します。ここでは必ずdestinationが入ります。
  • destination
  • tel Tel 電話番号です。ハイフン有無は任意になります。
    title string 担当者の役職です。
    uri string 請求先URIです。すべてのリソースで一意の識別子として自動で付与されます。
    zip_code ZipCode 郵便番号です。ハイフン有無は任意になります。

    請求先一覧取得

    コードサンプル

    curl -X GET https://sandbox-api.mfkessai.co.jp/v2/destinations \
      -H 'Accept: application/json'
      -H 'apikey: API_KEY'
    
    
    <?php
    
    require 'vendor/autoload.php';
    
    $headers = array(
        'Accept' => 'application/json',
        'apikey' => 'API_KEY',
    
        );
    
    $client = new \GuzzleHttp\Client();
    
    // Define array of request body.
    $request_body = '';
    
    try {
        $response = $client->request('GET','https://sandbox-api.mfkessai.co.jp/v2/destinations', array(
            'headers' => $headers,
            'body' => $request_body,
           )
        );
        print_r($response->getBody()->getContents());
     }
     catch (\GuzzleHttp\Exception\BadResponseException $e) {
        // handle exception or api errors.
        print_r($e->getMessage());
     }
    
     // ...
    
    
    require 'net/http'
    require 'uri'
    
    uri = URI.parse("https://sandbox-api.mfkessai.co.jp/v2/customers")
    
    headers = {
      'Accept' => 'application/json',
      'apikey' => 'API_KEY'
    }
    
    req = Net::HTTP::Get.new(uri, headers)
    
    req_options = {
        use_ssl: uri.scheme = "https"
    }
    
    response = Net::HTTP.start(uri.hostname, uri.port, req_options) do |http|
      res = http.request(req)
      p res
    end
    
    import requests
    headers = {
      'Accept': 'application/json',
      'apikey': 'API_KEY'
    }
    
    r = requests.get('https://sandbox-api.mfkessai.co.jp/v2/destinations', params={
    
    }, headers=headers)
    
    print(r.json())
    
    
    package main
    
    import (
           "bytes"
           "net/http"
    )
    
    func main() {
    
        headers := map[string][]string{
            "Accept": []string{"application/json"},
            "apikey": []string{"API_KEY"},
    
        }
    
        data := bytes.NewBuffer([]byte{``})
        req, err := http.NewRequest("GET", "https://sandbox-api.mfkessai.co.jp/v2/destinations", data)
        if err != nil {
            // handle error
            return
        }
        req.Header = headers
    
        client := &http.Client{}
        resp, err := client.Do(req)
        if err != nil {
            // handle error
            return
        }
        // ...
    }
    
    
    const fetch = require('node-fetch');
    
    const headers = {
      'Accept':'application/json',
      'apikey':'API_KEY'
    };
    
    fetch('https://sandbox-api.mfkessai.co.jp/v2/destinations',
    {
      method: 'GET',
      headers: headers
    })
    .then(function(res) {
        return res.json();
    }).then(function(body) {
        console.log(body);
    });
    
    

    /destinations

    請求先の一覧を取得します。顧客IDや顧客番号で特定の顧客に紐づく請求先に絞り込んで取得することもできます。

    QueryParameters

    項目名 説明
    customer_id string 顧客IDを指定します。指定された顧客の請求先を取得します。customer_numberに別の顧客の顧客番号を指定した場合には該当請求先は0件になります。
    customer_number string 顧客番号を指定します。指定された顧客の請求先を取得します。customer_idに別の顧客の顧客IDを指定した場合には該当請求先は0件になります。
    created_at_from string(date-time) 指定された日時以降に作成された請求先を取得します。指定された日時に作成されたものも含まれます。 RFC3399のdate-time(2019-04-01T10:36:43%2B09:00)で指定してください。
    created_at_to string(date-time) 指定された日時以前に作成された請求先を取得します。指定された日時に作成されたものも含まれます。 RFC3399のdate-time(2019-04-01T10:36:43%2B09:00)で指定してください。
    after string 任意のリソースIDを指定します。追加日時の降順でこのIDのリソースよりも後のリソースを取得します。この時afterで指定したIDのリソースは結果に含まれません。
    before string 任意のリソースIDを指定します。追加日時の降順でこのIDのリソースよりも前のリソースを取得します。この時beforeで指定したIDのリソースは結果に含まれません。
    limit integer(int32) 取得したいリソースの最大件数を指定します。1~200の間の整数で指定してください。指定がない場合は20になります。

    レスポンス例

    200 Response

    {
      "items": [
        {
          "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"
        }
      ],
      "object": "list",
      "pagination": {
        "end": "7679-YW36",
        "has_next": true,
        "has_previous": false,
        "limit": 20,
        "start": "9R6M-VMAN",
        "total": 143
      }
    }
    

    Responses

    ステータス 説明
    200 請求先一覧とページネーション情報です。
    400 リクエスト内容の不備によるエラーです。エラー内容を確認してください。

    Status Code 200

    項目名 説明
    items [Destination] 請求先一覧です。
    object string このObjectの種別を示します。ここでは必ず listが設定されます。
    pagination Pagination ページネーション情報です。各Objectの一覧取得の際にリストとともに返却されます。この情報をもとにページ繰りを行うことができます。

    請求先登録

    コードサンプル

    curl -X POST https://sandbox-api.mfkessai.co.jp/v2/destinations \
      -H 'Content-Type: application/json' \
      -H 'Accept: application/json' \
      -H 'apikey: API_KEY' \
      -d `{
      "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"
    }`
    
    
    <?php
    
    require 'vendor/autoload.php';
    
    $headers = array(
        'Content-Type' => 'application/json',
        'Accept' => 'application/json',
        'apikey' => 'API_KEY',
    
        );
    
    $client = new \GuzzleHttp\Client();
    
    // Define array of request body.
    $request_body = '{
      "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"
    }';
    
    try {
        $response = $client->request('POST','https://sandbox-api.mfkessai.co.jp/v2/destinations', array(
            'headers' => $headers,
            'body' => $request_body,
           )
        );
        print_r($response->getBody()->getContents());
     }
     catch (\GuzzleHttp\Exception\BadResponseException $e) {
        // handle exception or api errors.
        print_r($e->getMessage());
     }
    
     // ...
    
    
    require 'net/http'
    require 'uri'
    
    uri = URI.parse("https://sandbox-api.mfkessai.co.jp/v2/customers")
    
    headers = {
      'Content-Type' => 'application/json',
      'Accept' => 'application/json',
      'apikey' => 'API_KEY'
    }
    
    req = Net::HTTP::Post.new(uri, headers)
    req.body='{
      "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"
    }'
    
    req_options = {
        use_ssl: uri.scheme = "https"
    }
    
    response = Net::HTTP.start(uri.hostname, uri.port, req_options) do |http|
      res = http.request(req)
      p res
    end
    
    import requests
    headers = {
      'Content-Type': 'application/json',
      'Accept': 'application/json',
      'apikey': 'API_KEY'
    }
    
    r = requests.post('https://sandbox-api.mfkessai.co.jp/v2/destinations', params={
    
    }, json={
      "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"
    }, headers=headers)
    
    print(r.json())
    
    
    package main
    
    import (
           "bytes"
           "net/http"
    )
    
    func main() {
    
        headers := map[string][]string{
            "Content-Type": []string{"application/json"},
            "Accept": []string{"application/json"},
            "apikey": []string{"API_KEY"},
    
        }
    
        data := bytes.NewBuffer([]byte{`{
      "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"
    }`})
        req, err := http.NewRequest("POST", "https://sandbox-api.mfkessai.co.jp/v2/destinations", data)
        if err != nil {
            // handle error
            return
        }
        req.Header = headers
    
        client := &http.Client{}
        resp, err := client.Do(req)
        if err != nil {
            // handle error
            return
        }
        // ...
    }
    
    
    const fetch = require('node-fetch');
    const inputBody = `{
      "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"
    }`;
    const headers = {
      'Content-Type':'application/json',
      'Accept':'application/json',
      'apikey':'API_KEY'
    };
    
    fetch('https://sandbox-api.mfkessai.co.jp/v2/destinations',
    {
      method: 'POST',
      body: inputBody,
      headers: headers
    })
    .then(function(res) {
        return res.json();
    }).then(function(body) {
        console.log(body);
    });
    
    

    /destinations

    顧客を指定して請求先を登録することができます。

    Body parameter

    {
      "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"
    }
    

    BodyParameters

    項目名 説明
    body
    required
    DestinationPayload 請求先登録情報です。

    レスポンス例

    200 Response

    {
      "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"
    }
    

    Responses

    ステータス 説明
    200 登録した請求先が返却されます。
    400 リクエスト内容の不備によるエラーです。エラー内容を確認してください。
    404 顧客IDで指定した顧客が存在しない場合のエラーです。
    409 登録しようとした請求先と一致する請求先が既に登録されている場合のエラーです。住所・電話番号などが既に登録済みでないか確認してください。

    Status Code 200

    項目名 説明
    address1 Address1 都道府県・市区町村・番地です。必ず都道府県名から始めてください。
    address2 Address2 建物名・部屋番号などです。
    cc_emails [Email] CCメールアドレスです。最大4件まで登録できます。
    created_at string(date-time) 請求先が登録された日時を示します。
    customer_id string 顧客IDです。一意の識別子として自動で付与されます。
    department string 担当者の部署名です。
    email Email(email) メールアドレスです。email形式で指定してください。
    id string 請求先IDです。一意の識別子として自動で付与されます。
    name string 担当者名です。
    name_kana string 担当者名カナです。全角カタカナで入力してください。
    object string このObjectの種別を示します。ここでは必ずdestinationが入ります。
    tel Tel 電話番号です。ハイフン有無は任意になります。
    title string 担当者の役職です。
    uri string 請求先URIです。すべてのリソースで一意の識別子として自動で付与されます。
    zip_code ZipCode 郵便番号です。ハイフン有無は任意になります。

    請求先取得

    コードサンプル

    curl -X GET https://sandbox-api.mfkessai.co.jp/v2/destinations/{destination_id} \
      -H 'Accept: application/json'
      -H 'apikey: API_KEY'
    
    
    <?php
    
    require 'vendor/autoload.php';
    
    $headers = array(
        'Accept' => 'application/json',
        'apikey' => 'API_KEY',
    
        );
    
    $client = new \GuzzleHttp\Client();
    
    // Define array of request body.
    $request_body = '';
    
    try {
        $response = $client->request('GET','https://sandbox-api.mfkessai.co.jp/v2/destinations/{destination_id}', array(
            'headers' => $headers,
            'body' => $request_body,
           )
        );
        print_r($response->getBody()->getContents());
     }
     catch (\GuzzleHttp\Exception\BadResponseException $e) {
        // handle exception or api errors.
        print_r($e->getMessage());
     }
    
     // ...
    
    
    require 'net/http'
    require 'uri'
    
    uri = URI.parse("https://sandbox-api.mfkessai.co.jp/v2/customers")
    
    headers = {
      'Accept' => 'application/json',
      'apikey' => 'API_KEY'
    }
    
    req = Net::HTTP::Get.new(uri, headers)
    
    req_options = {
        use_ssl: uri.scheme = "https"
    }
    
    response = Net::HTTP.start(uri.hostname, uri.port, req_options) do |http|
      res = http.request(req)
      p res
    end
    
    import requests
    headers = {
      'Accept': 'application/json',
      'apikey': 'API_KEY'
    }
    
    r = requests.get('https://sandbox-api.mfkessai.co.jp/v2/destinations/{destination_id}', params={
    
    }, headers=headers)
    
    print(r.json())
    
    
    package main
    
    import (
           "bytes"
           "net/http"
    )
    
    func main() {
    
        headers := map[string][]string{
            "Accept": []string{"application/json"},
            "apikey": []string{"API_KEY"},
    
        }
    
        data := bytes.NewBuffer([]byte{``})
        req, err := http.NewRequest("GET", "https://sandbox-api.mfkessai.co.jp/v2/destinations/{destination_id}", data)
        if err != nil {
            // handle error
            return
        }
        req.Header = headers
    
        client := &http.Client{}
        resp, err := client.Do(req)
        if err != nil {
            // handle error
            return
        }
        // ...
    }
    
    
    const fetch = require('node-fetch');
    
    const headers = {
      'Accept':'application/json',
      'apikey':'API_KEY'
    };
    
    fetch('https://sandbox-api.mfkessai.co.jp/v2/destinations/{destination_id}',
    {
      method: 'GET',
      headers: headers
    })
    .then(function(res) {
        return res.json();
    }).then(function(body) {
        console.log(body);
    });
    
    

    /destinations/{destination_id}

    請求先IDを指定して対象請求先1件を取得することができます。

    PathParameters

    項目名 説明
    destination_id
    required
    string 対象の請求先IDを指定してください。

    レスポンス例

    200 Response

    {
      "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"
    }
    

    Responses

    ステータス 説明
    200 指定した請求先が返却されます。
    400 リクエスト内容の不備によるエラーです。エラー内容を確認してください。
    404 請求先IDで指定した請求先が存在しない場合のエラーです。

    Status Code 200

    項目名 説明
    address1 Address1 都道府県・市区町村・番地です。必ず都道府県名から始めてください。
    address2 Address2 建物名・部屋番号などです。
    cc_emails [Email] CCメールアドレスです。最大4件まで登録できます。
    created_at string(date-time) 請求先が登録された日時を示します。
    customer_id string 顧客IDです。一意の識別子として自動で付与されます。
    department string 担当者の部署名です。
    email Email(email) メールアドレスです。email形式で指定してください。
    id string 請求先IDです。一意の識別子として自動で付与されます。
    name string 担当者名です。
    name_kana string 担当者名カナです。全角カタカナで入力してください。
    object string このObjectの種別を示します。ここでは必ずdestinationが入ります。
    tel Tel 電話番号です。ハイフン有無は任意になります。
    title string 担当者の役職です。
    uri string 請求先URIです。すべてのリソースで一意の識別子として自動で付与されます。
    zip_code ZipCode 郵便番号です。ハイフン有無は任意になります。

    CustomerExamination

    CustomerExamination Object

    CustomerExamination

    {
      "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": "kesai.tanto@example.jp",
      "end_date": "2019-04-30",
      "id": "WNAV-37R6",
      "remark": "一部上場企業です。",
      "representative_name": "代表太郎",
      "start_date": "2019-04-01",
      "statue": "passed",
      "tel": "03-1234-5678",
      "uri": "mfk:customer_examination:WNAV-37R6",
      "website": "https://mfkessai.co.jp",
      "zip_code": "111-1111"
    }
    
    

    顧客審査です。顧客に対する与信枠取得のために利用します。申請後2営業日以内に審査いたします。自動顧客審査を利用している場合は顧客登録と同時に顧客審査も申請されます。

    Property

    項目名 説明
    address1 Address1 都道府県・市区町村・番地です。必ず都道府県名から始めてください。
    address2 Address2 建物名・部屋番号などです。
    amount integer 希望与信額です。審査通過の場合に付与される与信枠の金額になります。
    business_description string 事業内容です。顧客の主なサービス、商材などです。
    business_type string 事業所区分です。法人(corporate)または、個人(individual)で指定されます。不明な場合は空になります。
    値は以下のうちの一つになります。
    • corporate
    • individual
    corporate_number string 法人番号です。事業所区分(business_type)が法人(corporate)の場合にのみ指定されます。
    created_at string(date-time) 顧客審査の申請日時です。
    customer_id string 顧客IDです。一意の識別子として自動で付与されます。
    email Email メールアドレスです。email形式で指定してください。
    end_date string(date) 希望取引登録期間終了日です。この日付まで対象の与信枠を利用して取引登録ができます。
    id string 顧客審査IDです。一意の識別子として自動で付与されます。
    remark string その他情報です。審査に利用できる情報を記載できます。
    representative_name string 代表者名です。
    start_date string(date) 希望取引登録期間開始日。この日付から対象の与信枠を利用して取引登録ができます。 手動での申請の場合、審査通過日となるため空で返却されます。自動顧客審査による申請の場合は、月次での与信枠付与になり対象月の月初日となります。
    status string 顧客審査ステータスです。審査中(unexamined)、審査通過(passed)、審査否決(rejected)があります。審査通過の場合には与信枠が付与されています。
    値は以下のうちの一つになります。
    • unexamined
    • passed
    • rejected
    tel Tel 電話番号です。ハイフン有無は任意になります。
    object string このObjectの種別を示します。ここでは必ずcustomer_examinationが入ります。
  • customer_examination
  • uri string 顧客審査URIです。すべてのリソースで一意の識別子として自動で付与されます。
    website string 顧客企業のwebサイトです。
    zip_code ZipCode 郵便番号です。ハイフン有無は任意になります。

    顧客審査一覧取得

    コードサンプル

    curl -X GET https://sandbox-api.mfkessai.co.jp/v2/customer_examinations \
      -H 'Accept: application/json'
      -H 'apikey: API_KEY'
    
    
    <?php
    
    require 'vendor/autoload.php';
    
    $headers = array(
        'Accept' => 'application/json',
        'apikey' => 'API_KEY',
    
        );
    
    $client = new \GuzzleHttp\Client();
    
    // Define array of request body.
    $request_body = '';
    
    try {
        $response = $client->request('GET','https://sandbox-api.mfkessai.co.jp/v2/customer_examinations', array(
            'headers' => $headers,
            'body' => $request_body,
           )
        );
        print_r($response->getBody()->getContents());
     }
     catch (\GuzzleHttp\Exception\BadResponseException $e) {
        // handle exception or api errors.
        print_r($e->getMessage());
     }
    
     // ...
    
    
    require 'net/http'
    require 'uri'
    
    uri = URI.parse("https://sandbox-api.mfkessai.co.jp/v2/customers")
    
    headers = {
      'Accept' => 'application/json',
      'apikey' => 'API_KEY'
    }
    
    req = Net::HTTP::Get.new(uri, headers)
    
    req_options = {
        use_ssl: uri.scheme = "https"
    }
    
    response = Net::HTTP.start(uri.hostname, uri.port, req_options) do |http|
      res = http.request(req)
      p res
    end
    
    import requests
    headers = {
      'Accept': 'application/json',
      'apikey': 'API_KEY'
    }
    
    r = requests.get('https://sandbox-api.mfkessai.co.jp/v2/customer_examinations', params={
    
    }, headers=headers)
    
    print(r.json())
    
    
    package main
    
    import (
           "bytes"
           "net/http"
    )
    
    func main() {
    
        headers := map[string][]string{
            "Accept": []string{"application/json"},
            "apikey": []string{"API_KEY"},
    
        }
    
        data := bytes.NewBuffer([]byte{``})
        req, err := http.NewRequest("GET", "https://sandbox-api.mfkessai.co.jp/v2/customer_examinations", data)
        if err != nil {
            // handle error
            return
        }
        req.Header = headers
    
        client := &http.Client{}
        resp, err := client.Do(req)
        if err != nil {
            // handle error
            return
        }
        // ...
    }
    
    
    const fetch = require('node-fetch');
    
    const headers = {
      'Accept':'application/json',
      'apikey':'API_KEY'
    };
    
    fetch('https://sandbox-api.mfkessai.co.jp/v2/customer_examinations',
    {
      method: 'GET',
      headers: headers
    })
    .then(function(res) {
        return res.json();
    }).then(function(body) {
        console.log(body);
    });
    
    

    /customer_examinations

    顧客審査の一覧を取得します。顧客IDやステータスで絞り込んで取得することもできます。

    QueryParameters

    項目名 説明
    customer_id string 顧客IDを指定します。指定された顧客に対する顧客審査を取得します。
    status string 顧客審査のステータスを指定します。未審査(unexamined)、審査通過(passed)、審査否決(rejected)のいずれかを指定してください。
    値は以下のうちの一つになります。
    • passed
    • rejected
    • unexamined
    created_at_from string(date-time) 指定された日時以降に作成された請求先を取得します。指定された日時に作成されたものも含まれます。 RFC3399のdate-time(2019-04-01T10:36:43%2B09:00)で指定してください。
    created_at_to string(date-time) 指定された日時以前に作成された請求先を取得します。指定された日時に作成されたものも含まれます。 RFC3399のdate-time(2019-04-01T10:36:43%2B09:00)で指定してください。
    after string 任意のリソースIDを指定します。追加日時の降順でこのIDのリソースよりも後のリソースを取得します。この時afterで指定したIDのリソースは結果に含まれません。
    before string 任意のリソースIDを指定します。追加日時の降順でこのIDのリソースよりも前のリソースを取得します。この時beforeで指定したIDのリソースは結果に含まれません。
    limit integer(int32) 取得したいリソースの最大件数を指定します。1~200の間の整数で指定してください。指定がない場合は20になります。

    レスポンス例

    200 Response

    {
      "items": [
        {
          "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": "kesai.tanto@example.jp",
          "end_date": "2019-04-30",
          "id": "WNAV-37R6",
          "remark": "一部上場企業です。",
          "representative_name": "代表太郎",
          "start_date": "2019-04-01",
          "statue": "passed",
          "tel": "03-1234-5678",
          "uri": "mfk:customer_examination:WNAV-37R6",
          "website": "https://mfkessai.co.jp",
          "zip_code": "111-1111"
        }
      ],
      "object": "list",
      "pagination": {
        "end": "7679-YW36",
        "has_next": true,
        "has_previous": false,
        "limit": 20,
        "start": "9R6M-VMAN",
        "total": 143
      }
    }
    

    Responses

    ステータス 説明
    200 顧客審査一覧とページネーション情報です。
    400 リクエスト内容の不備によるエラーです。エラー内容を確認してください。

    Status Code 200

    項目名 説明
    items [CustomerExamination] 顧客審査一覧です。
    object string このObjectの種別を示します。ここでは必ず listが設定されます。
    pagination Pagination ページネーション情報です。各Objectの一覧取得の際にリストとともに返却されます。この情報をもとにページ繰りを行うことができます。

    顧客審査申請

    コードサンプル

    curl -X POST https://sandbox-api.mfkessai.co.jp/v2/customer_examinations \
      -H 'Content-Type: application/json' \
      -H 'Accept: application/json' \
      -H 'apikey: API_KEY' \
      -d `{
      "address1": "東京都千代田区1-2-3",
      "address2": "サンプルビル3F",
      "amount": 20000,
      "business_description": "クラウド型企業間決済サービス",
      "business_type": "corporate",
      "corporate_number": "1234567890123",
      "customer_id": "7679-YW36",
      "email": "kesai.tanto@example.jp",
      "end_date": "2019-04-30",
      "remark": "一部上場企業です。",
      "representative_name": "代表太郎",
      "tel": "03-1234-5678",
      "website": "https://mfkessai.co.jp",
      "zip_code": "111-1111"
    }`
    
    
    <?php
    
    require 'vendor/autoload.php';
    
    $headers = array(
        'Content-Type' => 'application/json',
        'Accept' => 'application/json',
        'apikey' => 'API_KEY',
    
        );
    
    $client = new \GuzzleHttp\Client();
    
    // Define array of request body.
    $request_body = '{
      "address1": "東京都千代田区1-2-3",
      "address2": "サンプルビル3F",
      "amount": 20000,
      "business_description": "クラウド型企業間決済サービス",
      "business_type": "corporate",
      "corporate_number": "1234567890123",
      "customer_id": "7679-YW36",
      "email": "kesai.tanto@example.jp",
      "end_date": "2019-04-30",
      "remark": "一部上場企業です。",
      "representative_name": "代表太郎",
      "tel": "03-1234-5678",
      "website": "https://mfkessai.co.jp",
      "zip_code": "111-1111"
    }';
    
    try {
        $response = $client->request('POST','https://sandbox-api.mfkessai.co.jp/v2/customer_examinations', array(
            'headers' => $headers,
            'body' => $request_body,
           )
        );
        print_r($response->getBody()->getContents());
     }
     catch (\GuzzleHttp\Exception\BadResponseException $e) {
        // handle exception or api errors.
        print_r($e->getMessage());
     }
    
     // ...
    
    
    require 'net/http'
    require 'uri'
    
    uri = URI.parse("https://sandbox-api.mfkessai.co.jp/v2/customers")
    
    headers = {
      'Content-Type' => 'application/json',
      'Accept' => 'application/json',
      'apikey' => 'API_KEY'
    }
    
    req = Net::HTTP::Post.new(uri, headers)
    req.body='{
      "address1": "東京都千代田区1-2-3",
      "address2": "サンプルビル3F",
      "amount": 20000,
      "business_description": "クラウド型企業間決済サービス",
      "business_type": "corporate",
      "corporate_number": "1234567890123",
      "customer_id": "7679-YW36",
      "email": "kesai.tanto@example.jp",
      "end_date": "2019-04-30",
      "remark": "一部上場企業です。",
      "representative_name": "代表太郎",
      "tel": "03-1234-5678",
      "website": "https://mfkessai.co.jp",
      "zip_code": "111-1111"
    }'
    
    req_options = {
        use_ssl: uri.scheme = "https"
    }
    
    response = Net::HTTP.start(uri.hostname, uri.port, req_options) do |http|
      res = http.request(req)
      p res
    end
    
    import requests
    headers = {
      'Content-Type': 'application/json',
      'Accept': 'application/json',
      'apikey': 'API_KEY'
    }
    
    r = requests.post('https://sandbox-api.mfkessai.co.jp/v2/customer_examinations', params={
    
    }, json={
      "address1": "東京都千代田区1-2-3",
      "address2": "サンプルビル3F",
      "amount": 20000,
      "business_description": "クラウド型企業間決済サービス",
      "business_type": "corporate",
      "corporate_number": "1234567890123",
      "customer_id": "7679-YW36",
      "email": "kesai.tanto@example.jp",
      "end_date": "2019-04-30",
      "remark": "一部上場企業です。",
      "representative_name": "代表太郎",
      "tel": "03-1234-5678",
      "website": "https://mfkessai.co.jp",
      "zip_code": "111-1111"
    }, headers=headers)
    
    print(r.json())
    
    
    package main
    
    import (
           "bytes"
           "net/http"
    )
    
    func main() {
    
        headers := map[string][]string{
            "Content-Type": []string{"application/json"},
            "Accept": []string{"application/json"},
            "apikey": []string{"API_KEY"},
    
        }
    
        data := bytes.NewBuffer([]byte{`{
      "address1": "東京都千代田区1-2-3",
      "address2": "サンプルビル3F",
      "amount": 20000,
      "business_description": "クラウド型企業間決済サービス",
      "business_type": "corporate",
      "corporate_number": "1234567890123",
      "customer_id": "7679-YW36",
      "email": "kesai.tanto@example.jp",
      "end_date": "2019-04-30",
      "remark": "一部上場企業です。",
      "representative_name": "代表太郎",
      "tel": "03-1234-5678",
      "website": "https://mfkessai.co.jp",
      "zip_code": "111-1111"
    }`})
        req, err := http.NewRequest("POST", "https://sandbox-api.mfkessai.co.jp/v2/customer_examinations", data)
        if err != nil {
            // handle error
            return
        }
        req.Header = headers
    
        client := &http.Client{}
        resp, err := client.Do(req)
        if err != nil {
            // handle error
            return
        }
        // ...
    }
    
    
    const fetch = require('node-fetch');
    const inputBody = `{
      "address1": "東京都千代田区1-2-3",
      "address2": "サンプルビル3F",
      "amount": 20000,
      "business_description": "クラウド型企業間決済サービス",
      "business_type": "corporate",
      "corporate_number": "1234567890123",
      "customer_id": "7679-YW36",
      "email": "kesai.tanto@example.jp",
      "end_date": "2019-04-30",
      "remark": "一部上場企業です。",
      "representative_name": "代表太郎",
      "tel": "03-1234-5678",
      "website": "https://mfkessai.co.jp",
      "zip_code": "111-1111"
    }`;
    const headers = {
      'Content-Type':'application/json',
      'Accept':'application/json',
      'apikey':'API_KEY'
    };
    
    fetch('https://sandbox-api.mfkessai.co.jp/v2/customer_examinations',
    {
      method: 'POST',
      body: inputBody,
      headers: headers
    })
    .then(function(res) {
        return res.json();
    }).then(function(body) {
        console.log(body);
    });
    
    

    /customer_examinations

    顧客を指定して顧客審査を申請することができます。申請後2営業日以内に審査いたします。

    Body parameter

    {
      "address1": "東京都千代田区1-2-3",
      "address2": "サンプルビル3F",
      "amount": 20000,
      "business_description": "クラウド型企業間決済サービス",
      "business_type": "corporate",
      "corporate_number": "1234567890123",
      "customer_id": "7679-YW36",
      "email": "kesai.tanto@example.jp",
      "end_date": "2019-04-30",
      "remark": "一部上場企業です。",
      "representative_name": "代表太郎",
      "tel": "03-1234-5678",
      "website": "https://mfkessai.co.jp",
      "zip_code": "111-1111"
    }
    

    BodyParameters

    項目名 説明
    body
    required
    CustomerExaminationPayload 顧客審査申請情報です。

    レスポンス例

    200 Response

    {
      "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": "kesai.tanto@example.jp",
      "end_date": "2019-04-30",
      "id": "WNAV-37R6",
      "remark": "一部上場企業です。",
      "representative_name": "代表太郎",
      "start_date": "2019-04-01",
      "statue": "passed",
      "tel": "03-1234-5678",
      "uri": "mfk:customer_examination:WNAV-37R6",
      "website": "https://mfkessai.co.jp",
      "zip_code": "111-1111"
    }
    

    Responses

    ステータス 説明
    200 登録した顧客審査が返却されます。
    400 リクエスト内容の不備によるエラーです。エラー内容を確認してください。
    404 顧客IDで指定した顧客が存在しない場合のエラーです。
    409 審査中の顧客審査が存在している場合のエラーです。審査中は顧客審査を登録できません。

    Status Code 200

    項目名 説明
    address1 Address1 都道府県・市区町村・番地です。必ず都道府県名から始めてください。
    address2 Address2 建物名・部屋番号などです。
    amount integer 希望与信額です。審査通過の場合に付与される与信枠の金額になります。
    business_description string 事業内容です。顧客の主なサービス、商材などです。
    business_type string 事業所区分です。法人(corporate)または、個人(individual)で指定されます。不明な場合は空になります。
    値は以下のうちの一つになります。
    • corporate
    • individual
    corporate_number string 法人番号です。事業所区分(business_type)が法人(corporate)の場合にのみ指定されます。
    created_at string(date-time) 顧客審査の申請日時です。
    customer_id string 顧客IDです。一意の識別子として自動で付与されます。
    email Email(email) メールアドレスです。email形式で指定してください。
    end_date string(date) 希望取引登録期間終了日です。この日付まで対象の与信枠を利用して取引登録ができます。
    id string 顧客審査IDです。一意の識別子として自動で付与されます。
    remark string その他情報です。審査に利用できる情報を記載できます。
    representative_name string 代表者名です。
    start_date string(date) 希望取引登録期間開始日。この日付から対象の与信枠を利用して取引登録ができます。 手動での申請の場合、審査通過日となるため空で返却されます。自動顧客審査による申請の場合は、月次での与信枠付与になり対象月の月初日となります。
    status string 顧客審査ステータスです。審査中(unexamined)、審査通過(passed)、審査否決(rejected)があります。審査通過の場合には与信枠が付与されています。
    値は以下のうちの一つになります。
    • unexamined
    • passed
    • rejected
    tel Tel 電話番号です。ハイフン有無は任意になります。
    object string このObjectの種別を示します。ここでは必ずcustomer_examinationが入ります。
    uri string 顧客審査URIです。すべてのリソースで一意の識別子として自動で付与されます。
    website string 顧客企業のwebサイトです。
    zip_code ZipCode 郵便番号です。ハイフン有無は任意になります。

    顧客審査取得

    コードサンプル

    curl -X GET https://sandbox-api.mfkessai.co.jp/v2/customer_examinations/{customer_examination_id} \
      -H 'Accept: application/json'
      -H 'apikey: API_KEY'
    
    
    <?php
    
    require 'vendor/autoload.php';
    
    $headers = array(
        'Accept' => 'application/json',
        'apikey' => 'API_KEY',
    
        );
    
    $client = new \GuzzleHttp\Client();
    
    // Define array of request body.
    $request_body = '';
    
    try {
        $response = $client->request('GET','https://sandbox-api.mfkessai.co.jp/v2/customer_examinations/{customer_examination_id}', array(
            'headers' => $headers,
            'body' => $request_body,
           )
        );
        print_r($response->getBody()->getContents());
     }
     catch (\GuzzleHttp\Exception\BadResponseException $e) {
        // handle exception or api errors.
        print_r($e->getMessage());
     }
    
     // ...
    
    
    require 'net/http'
    require 'uri'
    
    uri = URI.parse("https://sandbox-api.mfkessai.co.jp/v2/customers")
    
    headers = {
      'Accept' => 'application/json',
      'apikey' => 'API_KEY'
    }
    
    req = Net::HTTP::Get.new(uri, headers)
    
    req_options = {
        use_ssl: uri.scheme = "https"
    }
    
    response = Net::HTTP.start(uri.hostname, uri.port, req_options) do |http|
      res = http.request(req)
      p res
    end
    
    import requests
    headers = {
      'Accept': 'application/json',
      'apikey': 'API_KEY'
    }
    
    r = requests.get('https://sandbox-api.mfkessai.co.jp/v2/customer_examinations/{customer_examination_id}', params={
    
    }, headers=headers)
    
    print(r.json())
    
    
    package main
    
    import (
           "bytes"
           "net/http"
    )
    
    func main() {
    
        headers := map[string][]string{
            "Accept": []string{"application/json"},
            "apikey": []string{"API_KEY"},
    
        }
    
        data := bytes.NewBuffer([]byte{``})
        req, err := http.NewRequest("GET", "https://sandbox-api.mfkessai.co.jp/v2/customer_examinations/{customer_examination_id}", data)
        if err != nil {
            // handle error
            return
        }
        req.Header = headers
    
        client := &http.Client{}
        resp, err := client.Do(req)
        if err != nil {
            // handle error
            return
        }
        // ...
    }
    
    
    const fetch = require('node-fetch');
    
    const headers = {
      'Accept':'application/json',
      'apikey':'API_KEY'
    };
    
    fetch('https://sandbox-api.mfkessai.co.jp/v2/customer_examinations/{customer_examination_id}',
    {
      method: 'GET',
      headers: headers
    })
    .then(function(res) {
        return res.json();
    }).then(function(body) {
        console.log(body);
    });
    
    

    /customer_examinations/{customer_examination_id}

    顧客審査IDを指定して対象顧客審査1件を取得することができます。

    PathParameters

    項目名 説明
    customer_examination_id
    required
    string 対象の顧客審査IDを指定してください。

    レスポンス例

    200 Response

    {
      "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": "kesai.tanto@example.jp",
      "end_date": "2019-04-30",
      "id": "WNAV-37R6",
      "remark": "一部上場企業です。",
      "representative_name": "代表太郎",
      "start_date": "2019-04-01",
      "statue": "passed",
      "tel": "03-1234-5678",
      "uri": "mfk:customer_examination:WNAV-37R6",
      "website": "https://mfkessai.co.jp",
      "zip_code": "111-1111"
    }
    

    Responses

    ステータス 説明
    200 指定した顧客審査が返却されます。
    400 リクエスト内容の不備によるエラーです。エラー内容を確認してください。
    404 顧客審査IDで指定した顧客審査が存在しない場合のエラーです。

    Status Code 200

    項目名 説明
    address1 Address1 都道府県・市区町村・番地です。必ず都道府県名から始めてください。
    address2 Address2 建物名・部屋番号などです。
    amount integer 希望与信額です。審査通過の場合に付与される与信枠の金額になります。
    business_description string 事業内容です。顧客の主なサービス、商材などです。
    business_type string 事業所区分です。法人(corporate)または、個人(individual)で指定されます。不明な場合は空になります。
    値は以下のうちの一つになります。
    • corporate
    • individual
    corporate_number string 法人番号です。事業所区分(business_type)が法人(corporate)の場合にのみ指定されます。
    created_at string(date-time) 顧客審査の申請日時です。
    customer_id string 顧客IDです。一意の識別子として自動で付与されます。
    email Email(email) メールアドレスです。email形式で指定してください。
    end_date string(date) 希望取引登録期間終了日です。この日付まで対象の与信枠を利用して取引登録ができます。
    id string 顧客審査IDです。一意の識別子として自動で付与されます。
    remark string その他情報です。審査に利用できる情報を記載できます。
    representative_name string 代表者名です。
    start_date string(date) 希望取引登録期間開始日。この日付から対象の与信枠を利用して取引登録ができます。 手動での申請の場合、審査通過日となるため空で返却されます。自動顧客審査による申請の場合は、月次での与信枠付与になり対象月の月初日となります。
    status string 顧客審査ステータスです。審査中(unexamined)、審査通過(passed)、審査否決(rejected)があります。審査通過の場合には与信枠が付与されています。
    値は以下のうちの一つになります。
    • unexamined
    • passed
    • rejected
    tel Tel 電話番号です。ハイフン有無は任意になります。
    object string このObjectの種別を示します。ここでは必ずcustomer_examinationが入ります。
    uri string 顧客審査URIです。すべてのリソースで一意の識別子として自動で付与されます。
    website string 顧客企業のwebサイトです。
    zip_code ZipCode 郵便番号です。ハイフン有無は任意になります。

    CreditFacility

    CreditFacility Object

    CreditFacility

    {
      "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"
    }
    
    

    顧客の与信枠です。この枠内の取引登録であれば取引審査なしで登録することができます。

    Property

    項目名 説明
    amount integer 与信額です。取引登録期間(start_date~end_date)にこの金額までの取引であれば取引審査なしで登録することができます。
    balance integer 与信額残高です。与信額からこの与信枠を利用して登録された取引の合計金額を差し引いた金額です。現在与信枠を利用して登録できる取引金額を示しています。
    customer_id string 顧客IDです。一意の識別子として自動で付与されます。
    customer_examination_id string 顧客審査IDです。
    end_date string(date) 取引登録期間終了日です。この日付まで対象の与信枠を利用して取引登録ができます。
    id string 与信枠IDです。一意の識別子として自動で付与されます。
    object string このObjectの種別を示します。ここでは必ずcredit_facilityが入ります。
  • credit_facility
  • start_date string(date) 取引登録期間開始日です。この日付から対象の与信枠を利用して取引登録ができます。
    status string 与信枠ステータスです。未適用(inactive)、適用中(active)、期限切れ(expired)があります。 現在の日付がstart_date~end_dateの期間内であればactivestart_dateよりも前であればinactiveend_dateを過ぎていればexpiredになります。
    値は以下のうちの一つになります。
    • inactive
    • active
    • expired
    uri string 与信枠URIです。すべてのリソースで一意の識別子として自動で付与されます。

    与信枠一覧取得

    コードサンプル

    curl -X GET https://sandbox-api.mfkessai.co.jp/v2/credit_facilities \
      -H 'Accept: application/json'
      -H 'apikey: API_KEY'
    
    
    <?php
    
    require 'vendor/autoload.php';
    
    $headers = array(
        'Accept' => 'application/json',
        'apikey' => 'API_KEY',
    
        );
    
    $client = new \GuzzleHttp\Client();
    
    // Define array of request body.
    $request_body = '';
    
    try {
        $response = $client->request('GET','https://sandbox-api.mfkessai.co.jp/v2/credit_facilities', array(
            'headers' => $headers,
            'body' => $request_body,
           )
        );
        print_r($response->getBody()->getContents());
     }
     catch (\GuzzleHttp\Exception\BadResponseException $e) {
        // handle exception or api errors.
        print_r($e->getMessage());
     }
    
     // ...
    
    
    require 'net/http'
    require 'uri'
    
    uri = URI.parse("https://sandbox-api.mfkessai.co.jp/v2/customers")
    
    headers = {
      'Accept' => 'application/json',
      'apikey' => 'API_KEY'
    }
    
    req = Net::HTTP::Get.new(uri, headers)
    
    req_options = {
        use_ssl: uri.scheme = "https"
    }
    
    response = Net::HTTP.start(uri.hostname, uri.port, req_options) do |http|
      res = http.request(req)
      p res
    end
    
    import requests
    headers = {
      'Accept': 'application/json',
      'apikey': 'API_KEY'
    }
    
    r = requests.get('https://sandbox-api.mfkessai.co.jp/v2/credit_facilities', params={
    
    }, headers=headers)
    
    print(r.json())
    
    
    package main
    
    import (
           "bytes"
           "net/http"
    )
    
    func main() {
    
        headers := map[string][]string{
            "Accept": []string{"application/json"},
            "apikey": []string{"API_KEY"},
    
        }
    
        data := bytes.NewBuffer([]byte{``})
        req, err := http.NewRequest("GET", "https://sandbox-api.mfkessai.co.jp/v2/credit_facilities", data)
        if err != nil {
            // handle error
            return
        }
        req.Header = headers
    
        client := &http.Client{}
        resp, err := client.Do(req)
        if err != nil {
            // handle error
            return
        }
        // ...
    }
    
    
    const fetch = require('node-fetch');
    
    const headers = {
      'Accept':'application/json',
      'apikey':'API_KEY'
    };
    
    fetch('https://sandbox-api.mfkessai.co.jp/v2/credit_facilities',
    {
      method: 'GET',
      headers: headers
    })
    .then(function(res) {
        return res.json();
    }).then(function(body) {
        console.log(body);
    });
    
    

    /credit_facilities

    与信枠の一覧を取得します。顧客IDや取引登録期間開始日・終了日で絞り込んで取得することもできます。

    QueryParameters

    項目名 説明
    customer_id string 顧客IDを指定します。指定された顧客の与信枠を取得します。
    start_date_from string(date-time) 取引登録期間開始日が指定された日時よりも後の顧客を取得します。指定された日時のものも含まれます。
    start_date_to string(date-time) 取引登録期間開始日が指定された日時よりも前の顧客を取得します。指定された日時のものも含まれます。
    end_date_from string(date-time) 取引登録期間終了日が指定された日時よりも後の顧客を取得します。指定された日時のものも含まれます。
    end_date_to string(date-time) 取引登録期間終了日が指定された日時よりも前の顧客を取得します。指定された日時のものも含まれます。
    after string 任意のリソースIDを指定します。追加日時の降順でこのIDのリソースよりも後のリソースを取得します。この時afterで指定したIDのリソースは結果に含まれません。
    before string 任意のリソースIDを指定します。追加日時の降順でこのIDのリソースよりも前のリソースを取得します。この時beforeで指定したIDのリソースは結果に含まれません。
    limit integer(int32) 取得したいリソースの最大件数を指定します。1~200の間の整数で指定してください。指定がない場合は20になります。

    レスポンス例

    200 Response

    {
      "items": [
        {
          "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"
        }
      ],
      "object": "list",
      "pagination": {
        "end": "7679-YW36",
        "has_next": true,
        "has_previous": false,
        "limit": 20,
        "start": "9R6M-VMAN",
        "total": 143
      }
    }
    

    Responses

    ステータス 説明
    200 与信枠一覧とページネーション情報です。
    400 リクエスト内容の不備によるエラーです。エラー内容を確認してください。

    Status Code 200

    項目名 説明
    items [CreditFacility] 与信枠一覧です。
    object string このObjectの種別を示します。ここでは必ず listが設定されます。
    pagination Pagination ページネーション情報です。各Objectの一覧取得の際にリストとともに返却されます。この情報をもとにページ繰りを行うことができます。

    与信枠取得

    コードサンプル

    curl -X GET https://sandbox-api.mfkessai.co.jp/v2/credit_facilities/{credit_facility_id} \
      -H 'Accept: application/json'
      -H 'apikey: API_KEY'
    
    
    <?php
    
    require 'vendor/autoload.php';
    
    $headers = array(
        'Accept' => 'application/json',
        'apikey' => 'API_KEY',
    
        );
    
    $client = new \GuzzleHttp\Client();
    
    // Define array of request body.
    $request_body = '';
    
    try {
        $response = $client->request('GET','https://sandbox-api.mfkessai.co.jp/v2/credit_facilities/{credit_facility_id}', array(
            'headers' => $headers,
            'body' => $request_body,
           )
        );
        print_r($response->getBody()->getContents());
     }
     catch (\GuzzleHttp\Exception\BadResponseException $e) {
        // handle exception or api errors.
        print_r($e->getMessage());
     }
    
     // ...
    
    
    require 'net/http'
    require 'uri'
    
    uri = URI.parse("https://sandbox-api.mfkessai.co.jp/v2/customers")
    
    headers = {
      'Accept' => 'application/json',
      'apikey' => 'API_KEY'
    }
    
    req = Net::HTTP::Get.new(uri, headers)
    
    req_options = {
        use_ssl: uri.scheme = "https"
    }
    
    response = Net::HTTP.start(uri.hostname, uri.port, req_options) do |http|
      res = http.request(req)
      p res
    end
    
    import requests
    headers = {
      'Accept': 'application/json',
      'apikey': 'API_KEY'
    }
    
    r = requests.get('https://sandbox-api.mfkessai.co.jp/v2/credit_facilities/{credit_facility_id}', params={
    
    }, headers=headers)
    
    print(r.json())
    
    
    package main
    
    import (
           "bytes"
           "net/http"
    )
    
    func main() {
    
        headers := map[string][]string{
            "Accept": []string{"application/json"},
            "apikey": []string{"API_KEY"},
    
        }
    
        data := bytes.NewBuffer([]byte{``})
        req, err := http.NewRequest("GET", "https://sandbox-api.mfkessai.co.jp/v2/credit_facilities/{credit_facility_id}", data)
        if err != nil {
            // handle error
            return
        }
        req.Header = headers
    
        client := &http.Client{}
        resp, err := client.Do(req)
        if err != nil {
            // handle error
            return
        }
        // ...
    }
    
    
    const fetch = require('node-fetch');
    
    const headers = {
      'Accept':'application/json',
      'apikey':'API_KEY'
    };
    
    fetch('https://sandbox-api.mfkessai.co.jp/v2/credit_facilities/{credit_facility_id}',
    {
      method: 'GET',
      headers: headers
    })
    .then(function(res) {
        return res.json();
    }).then(function(body) {
        console.log(body);
    });
    
    

    /credit_facilities/{credit_facility_id}

    与信枠IDを指定して対象与信枠1件を取得することができます。

    PathParameters

    項目名 説明
    credit_facility_id
    required
    string 対象の与信枠IDを指定してください。

    レスポンス例

    200 Response

    {
      "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"
    }
    

    Responses

    ステータス 説明
    200 指定した与信枠が返却されます。
    400 リクエスト内容の不備によるエラーです。エラー内容を確認してください。
    404 与信枠IDで指定した与信枠が存在しない場合のエラーです。

    Status Code 200

    項目名 説明
    amount integer 与信額です。取引登録期間(start_date~end_date)にこの金額までの取引であれば取引審査なしで登録することができます。
    balance integer 与信額残高です。与信額からこの与信枠を利用して登録された取引の合計金額を差し引いた金額です。現在与信枠を利用して登録できる取引金額を示しています。
    customer_id string 顧客IDです。一意の識別子として自動で付与されます。
    customer_examination_id string 顧客審査IDです。
    end_date string(date) 取引登録期間終了日です。この日付まで対象の与信枠を利用して取引登録ができます。
    id string 与信枠IDです。一意の識別子として自動で付与されます。
    object string このObjectの種別を示します。ここでは必ずcredit_facilityが入ります。
    start_date string(date) 取引登録期間開始日です。この日付から対象の与信枠を利用して取引登録ができます。
    status string 与信枠ステータスです。未適用(inactive)、適用中(active)、期限切れ(expired)があります。 現在の日付がstart_date~end_dateの期間内であればactivestart_dateよりも前であればinactiveend_dateを過ぎていればexpiredになります。
    値は以下のうちの一つになります。
    • inactive
    • active
    • expired
    uri string 与信枠URIです。すべてのリソースで一意の識別子として自動で付与されます。

    Transaction

    Transaction Object

    Transaction

    {
      "amount": 5440,
      "amounts_per_tax_rate_type": [
        {
          "amount": 2200,
          "tax_rate_type": "10"
        },
        {
          "amount": 3240,
          "tax_rate_type": "reduced_8"
        }
      ],
      "billing_id": "9R6M-VMAN",
      "canceled_at": "2019-04-22T10:36:43+09:00",
      "created_at": "2019-04-01T10:36:43+09:00",
      "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",
          "tax_included_type": "excluded",
          "tax_rate_type": "10",
          "quantity": 3,
          "unit_price": 1000
        },
        {
          "amount": 3000,
          "description": "商品名B",
          "tax_included_type": "excluded",
          "tax_rate_type": "reduced_8",
          "quantity": 3,
          "unit_price": 1000
        },
        {
          "amount": -1000,
          "description": "商品名A 返品",
          "tax_included_type": "excluded",
          "tax_rate_type": "10",
          "quantity": -1,
          "unit_price": 1000
        }
      ],
      "uri": "mfk:transaction:7679-YW36"
    }
    
    

    取引です。

    Property

    項目名 説明
    amount integer 取引の合計金額です。税込金額になります。
    amounts_per_tax_rate_type [AmountPerTaxRateType] 各税率種別毎の税込の合計金額です。各税率種別の取引明細行の小計を合計した値に各税率を乗じた値になっています。
    billing_id string 請求IDです。請求書にまとめられる単位のIDです。同じ請求IDを持つ取引とまとめられて請求書に記載されます。
    canceled_at string(date-time)¦null 取引がキャンセルされた日時です。未キャンセルの場合は空になります。
    created_at string(date-time) 取引が登録された日時です。
    destination_id string 請求先IDです。取引の請求先を示します。
    date string(date) 取引日です。売り手様と顧客様の間で取引を行った日付です。
    due_date string(date) 支払期限日です。この日付を超えてMF KESSAIへの入金が確認できない場合は未入金になります。
    id string 取引IDです。一意の識別子として自動で付与されます。
    invoice_delivery_methods [InvoiceDeliveryMethod] 請求書送付方法です。郵送(posting) またはメール送付(email)のうちから少なくとも1つを指定してください。どちらも選択された場合、どちらの方法でも送付されます。 また、各取引で指定しなかった送付方法でも、請求にまとまった取引のうちでその送付方法を選択しているものがあれば、そちらの送付方法も採用されます。
    issue_date string(date) 請求書発行日です。請求書が発行される日付を指定します。指定した日付が営業日でない場合は翌営業日になります。 また、請求書発送日については請求書発行日についてを参照ください。
    number string 取引に付与できる任意の取引番号です。MF KESSAIが自動で付与する取引IDとは別で、売り手様が独自に管理する識別子を登録することができます。ただし、売り手様の所有する取引間で一意である必要があります。
    object string このObjectの種別を示します。ここでは必ずtransactionが入ります。
  • transaction
  • status string 取引ステータスです。審査中(unexamined)、審査通過(passed)、審査否決(rejected)、キャンセル済(canceled)があります。
    値は以下のうちの一つになります。
    • unexamined
    • passed
    • rejected
    • canceled
    transaction_details [TransactionDetail] 取引明細行です。
    uri string 取引URIです。すべてのリソースで一意の識別子として自動で付与されます。

    取引一覧取得

    コードサンプル

    curl -X GET https://sandbox-api.mfkessai.co.jp/v2/transactions \
      -H 'Accept: application/json'
      -H 'apikey: API_KEY'
    
    
    <?php
    
    require 'vendor/autoload.php';
    
    $headers = array(
        'Accept' => 'application/json',
        'apikey' => 'API_KEY',
    
        );
    
    $client = new \GuzzleHttp\Client();
    
    // Define array of request body.
    $request_body = '';
    
    try {
        $response = $client->request('GET','https://sandbox-api.mfkessai.co.jp/v2/transactions', array(
            'headers' => $headers,
            'body' => $request_body,
           )
        );
        print_r($response->getBody()->getContents());
     }
     catch (\GuzzleHttp\Exception\BadResponseException $e) {
        // handle exception or api errors.
        print_r($e->getMessage());
     }
    
     // ...
    
    
    require 'net/http'
    require 'uri'
    
    uri = URI.parse("https://sandbox-api.mfkessai.co.jp/v2/customers")
    
    headers = {
      'Accept' => 'application/json',
      'apikey' => 'API_KEY'
    }
    
    req = Net::HTTP::Get.new(uri, headers)
    
    req_options = {
        use_ssl: uri.scheme = "https"
    }
    
    response = Net::HTTP.start(uri.hostname, uri.port, req_options) do |http|
      res = http.request(req)
      p res
    end
    
    import requests
    headers = {
      'Accept': 'application/json',
      'apikey': 'API_KEY'
    }
    
    r = requests.get('https://sandbox-api.mfkessai.co.jp/v2/transactions', params={
    
    }, headers=headers)
    
    print(r.json())
    
    
    package main
    
    import (
           "bytes"
           "net/http"
    )
    
    func main() {
    
        headers := map[string][]string{
            "Accept": []string{"application/json"},
            "apikey": []string{"API_KEY"},
    
        }
    
        data := bytes.NewBuffer([]byte{``})
        req, err := http.NewRequest("GET", "https://sandbox-api.mfkessai.co.jp/v2/transactions", data)
        if err != nil {
            // handle error
            return
        }
        req.Header = headers
    
        client := &http.Client{}
        resp, err := client.Do(req)
        if err != nil {
            // handle error
            return
        }
        // ...
    }
    
    
    const fetch = require('node-fetch');
    
    const headers = {
      'Accept':'application/json',
      'apikey':'API_KEY'
    };
    
    fetch('https://sandbox-api.mfkessai.co.jp/v2/transactions',
    {
      method: 'GET',
      headers: headers
    })
    .then(function(res) {
        return res.json();
    }).then(function(body) {
        console.log(body);
    });
    
    

    /transactions

    QueryParameters

    項目名 説明
    created_at_from string(date-time) 指定された日時以降に作成された取引を取得します。指定された日時に作成されたものも含まれます。 RFC3399のdate-time(2019-04-01T10:36:43%2B09:00)で指定してください。
    created_at_to string(date-time) 指定された日時以前に作成された取引を取得します。指定された日時に作成されたものも含まれます。 RFC3399のdate-time(2019-04-01T10:36:43%2B09:00)で指定してください。
    date_from string(date) 取引日が指定された日付以降の取引を取得します。指定された日付が取引日のものも含まれます。 RFC3399のfull-time(2019-04-01)で指定してください。
    date_to string(date) 取引日が指定された日付以前の取引を取得します。指定された日付が取引日のものも含まれます。 RFC3399のfull-time(2019-04-01`)で指定してください。
    status string 取引のステータスを指定します。未審査(unexamined)、審査通過(passed)、審査否決(rejected)、キャンセル済み(canceled)のいずれかを指定してください。
    値は以下のうちの一つになります。
    • unexamined
    • passed
    • rejected
    • canceled
    number string 任意の取引の numberを指定します。該当する取引がある場合、その一件のみが返却されます。
    customer_id string 任意の顧客IDを指定します。指定した顧客に対する取引が返却されます。
    billing_id string 任意の請求IDを指定します。指定した請求に含まれる取引が返却されます。
    after string 任意のリソースIDを指定します。追加日時の降順でこのIDのリソースよりも後のリソースを取得します。この時afterで指定したIDのリソースは結果に含まれません。
    before string 任意のリソースIDを指定します。追加日時の降順でこのIDのリソースよりも前のリソースを取得します。この時beforeで指定したIDのリソースは結果に含まれません。
    limit integer(int32) 取得したいリソースの最大件数を指定します。1~200の間の整数で指定してください。指定がない場合は20になります。

    レスポンス例

    200 Response

    {
      "items": [
        {
          "amount": 5440,
          "amounts_per_tax_rate_type": [
            {
              "amount": 2200,
              "tax_rate_type": "10"
            },
            {
              "amount": 3240,
              "tax_rate_type": "reduced_8"
            }
          ],
          "billing_id": "9R6M-VMAN",
          "canceled_at": "2019-04-22T10:36:43+09:00",
          "created_at": "2019-04-01T10:36:43+09:00",
          "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",
              "tax_included_type": "excluded",
              "tax_rate_type": "10",
              "quantity": 3,
              "unit_price": 1000
            },
            {
              "amount": 3000,
              "description": "商品名B",
              "tax_included_type": "excluded",
              "tax_rate_type": "reduced_8",
              "quantity": 3,
              "unit_price": 1000
            },
            {
              "amount": -1000,
              "description": "商品名A 返品",
              "tax_included_type": "excluded",
              "tax_rate_type": "10",
              "quantity": -1,
              "unit_price": 1000
            }
          ],
          "uri": "mfk:transaction:7679-YW36"
        }
      ],
      "object": "list",
      "pagination": {
        "end": "7679-YW36",
        "has_next": true,
        "has_previous": false,
        "limit": 20,
        "start": "9R6M-VMAN",
        "total": 143
      }
    }
    

    Responses

    ステータス 説明
    200 取引一覧とページネーション情報です。
    400 リクエスト内容の不備によるエラーです。エラー内容を確認してください。

    Status Code 200

    項目名 説明
    items [Transaction] 取引一覧です。
    object string このObjectの種別を示します。ここでは必ず listが設定されます。
    pagination Pagination ページネーション情報です。各Objectの一覧取得の際にリストとともに返却されます。この情報をもとにページ繰りを行うことができます。

    取引登録

    コードサンプル

    curl -X POST https://sandbox-api.mfkessai.co.jp/v2/transactions \
      -H 'Content-Type: application/json' \
      -H 'Accept: application/json' \
      -H 'apikey: API_KEY' \
      -d `{
      "amount": 5440,
      "amounts_per_tax_rate_type": [
        {
          "amount": 2200,
          "tax_rate_type": "10"
        },
        {
          "amount": 3240,
          "tax_rate_type": "reduced_8"
        }
      ],
      "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",
          "tax_included_type": "excluded",
          "tax_rate_type": "10",
          "quantity": 3,
          "unit_price": 1000
        },
        {
          "amount": 3000,
          "description": "商品名B",
          "tax_included_type": "excluded",
          "tax_rate_type": "reduced_8",
          "quantity": 3,
          "unit_price": 1000
        },
        {
          "amount": -1000,
          "description": "商品名A 返品",
          "tax_included_type": "excluded",
          "tax_rate_type": "10",
          "quantity": 1,
          "unit_price": -1000
        }
      ]
    }`
    
    
    <?php
    
    require 'vendor/autoload.php';
    
    $headers = array(
        'Content-Type' => 'application/json',
        'Accept' => 'application/json',
        'apikey' => 'API_KEY',
    
        );
    
    $client = new \GuzzleHttp\Client();
    
    // Define array of request body.
    $request_body = '{
      "amount": 5440,
      "amounts_per_tax_rate_type": [
        {
          "amount": 2200,
          "tax_rate_type": "10"
        },
        {
          "amount": 3240,
          "tax_rate_type": "reduced_8"
        }
      ],
      "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",
          "tax_included_type": "excluded",
          "tax_rate_type": "10",
          "quantity": 3,
          "unit_price": 1000
        },
        {
          "amount": 3000,
          "description": "商品名B",
          "tax_included_type": "excluded",
          "tax_rate_type": "reduced_8",
          "quantity": 3,
          "unit_price": 1000
        },
        {
          "amount": -1000,
          "description": "商品名A 返品",
          "tax_included_type": "excluded",
          "tax_rate_type": "10",
          "quantity": 1,
          "unit_price": -1000
        }
      ]
    }';
    
    try {
        $response = $client->request('POST','https://sandbox-api.mfkessai.co.jp/v2/transactions', array(
            'headers' => $headers,
            'body' => $request_body,
           )
        );
        print_r($response->getBody()->getContents());
     }
     catch (\GuzzleHttp\Exception\BadResponseException $e) {
        // handle exception or api errors.
        print_r($e->getMessage());
     }
    
     // ...
    
    
    require 'net/http'
    require 'uri'
    
    uri = URI.parse("https://sandbox-api.mfkessai.co.jp/v2/customers")
    
    headers = {
      'Content-Type' => 'application/json',
      'Accept' => 'application/json',
      'apikey' => 'API_KEY'
    }
    
    req = Net::HTTP::Post.new(uri, headers)
    req.body='{
      "amount": 5440,
      "amounts_per_tax_rate_type": [
        {
          "amount": 2200,
          "tax_rate_type": "10"
        },
        {
          "amount": 3240,
          "tax_rate_type": "reduced_8"
        }
      ],
      "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",
          "tax_included_type": "excluded",
          "tax_rate_type": "10",
          "quantity": 3,
          "unit_price": 1000
        },
        {
          "amount": 3000,
          "description": "商品名B",
          "tax_included_type": "excluded",
          "tax_rate_type": "reduced_8",
          "quantity": 3,
          "unit_price": 1000
        },
        {
          "amount": -1000,
          "description": "商品名A 返品",
          "tax_included_type": "excluded",
          "tax_rate_type": "10",
          "quantity": 1,
          "unit_price": -1000
        }
      ]
    }'
    
    req_options = {
        use_ssl: uri.scheme = "https"
    }
    
    response = Net::HTTP.start(uri.hostname, uri.port, req_options) do |http|
      res = http.request(req)
      p res
    end
    
    import requests
    headers = {
      'Content-Type': 'application/json',
      'Accept': 'application/json',
      'apikey': 'API_KEY'
    }
    
    r = requests.post('https://sandbox-api.mfkessai.co.jp/v2/transactions', params={
    
    }, json={
      "amount": 5440,
      "amounts_per_tax_rate_type": [
        {
          "amount": 2200,
          "tax_rate_type": "10"
        },
        {
          "amount": 3240,
          "tax_rate_type": "reduced_8"
        }
      ],
      "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",
          "tax_included_type": "excluded",
          "tax_rate_type": "10",
          "quantity": 3,
          "unit_price": 1000
        },
        {
          "amount": 3000,
          "description": "商品名B",
          "tax_included_type": "excluded",
          "tax_rate_type": "reduced_8",
          "quantity": 3,
          "unit_price": 1000
        },
        {
          "amount": -1000,
          "description": "商品名A 返品",
          "tax_included_type": "excluded",
          "tax_rate_type": "10",
          "quantity": 1,
          "unit_price": -1000
        }
      ]
    }, headers=headers)
    
    print(r.json())
    
    
    package main
    
    import (
           "bytes"
           "net/http"
    )
    
    func main() {
    
        headers := map[string][]string{
            "Content-Type": []string{"application/json"},
            "Accept": []string{"application/json"},
            "apikey": []string{"API_KEY"},
    
        }
    
        data := bytes.NewBuffer([]byte{`{
      "amount": 5440,
      "amounts_per_tax_rate_type": [
        {
          "amount": 2200,
          "tax_rate_type": "10"
        },
        {
          "amount": 3240,
          "tax_rate_type": "reduced_8"
        }
      ],
      "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",
          "tax_included_type": "excluded",
          "tax_rate_type": "10",
          "quantity": 3,
          "unit_price": 1000
        },
        {
          "amount": 3000,
          "description": "商品名B",
          "tax_included_type": "excluded",
          "tax_rate_type": "reduced_8",
          "quantity": 3,
          "unit_price": 1000
        },
        {
          "amount": -1000,
          "description": "商品名A 返品",
          "tax_included_type": "excluded",
          "tax_rate_type": "10",
          "quantity": 1,
          "unit_price": -1000
        }
      ]
    }`})
        req, err := http.NewRequest("POST", "https://sandbox-api.mfkessai.co.jp/v2/transactions", data)
        if err != nil {
            // handle error
            return
        }
        req.Header = headers
    
        client := &http.Client{}
        resp, err := client.Do(req)
        if err != nil {
            // handle error
            return
        }
        // ...
    }
    
    
    const fetch = require('node-fetch');
    const inputBody = `{
      "amount": 5440,
      "amounts_per_tax_rate_type": [
        {
          "amount": 2200,
          "tax_rate_type": "10"
        },
        {
          "amount": 3240,
          "tax_rate_type": "reduced_8"
        }
      ],
      "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",
          "tax_included_type": "excluded",
          "tax_rate_type": "10",
          "quantity": 3,
          "unit_price": 1000
        },
        {
          "amount": 3000,
          "description": "商品名B",
          "tax_included_type": "excluded",
          "tax_rate_type": "reduced_8",
          "quantity": 3,
          "unit_price": 1000
        },
        {
          "amount": -1000,
          "description": "商品名A 返品",
          "tax_included_type": "excluded",
          "tax_rate_type": "10",
          "quantity": 1,
          "unit_price": -1000
        }
      ]
    }`;
    const headers = {
      'Content-Type':'application/json',
      'Accept':'application/json',
      'apikey':'API_KEY'
    };
    
    fetch('https://sandbox-api.mfkessai.co.jp/v2/transactions',
    {
      method: 'POST',
      body: inputBody,
      headers: headers
    })
    .then(function(res) {
        return res.json();
    }).then(function(body) {
        console.log(body);
    });
    
    

    /transactions

    Body parameter

    {
      "amount": 5440,
      "amounts_per_tax_rate_type": [
        {
          "amount": 2200,
          "tax_rate_type": "10"
        },
        {
          "amount": 3240,
          "tax_rate_type": "reduced_8"
        }
      ],
      "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",
          "tax_included_type": "excluded",
          "tax_rate_type": "10",
          "quantity": 3,
          "unit_price": 1000
        },
        {
          "amount": 3000,
          "description": "商品名B",
          "tax_included_type": "excluded",
          "tax_rate_type": "reduced_8",
          "quantity": 3,
          "unit_price": 1000
        },
        {
          "amount": -1000,
          "description": "商品名A 返品",
          "tax_included_type": "excluded",
          "tax_rate_type": "10",
          "quantity": 1,
          "unit_price": -1000
        }
      ]
    }
    

    BodyParameters

    項目名 説明
    body
    required
    TransactionPayload

    レスポンス例

    200 Response

    {
      "amount": 5440,
      "amounts_per_tax_rate_type": [
        {
          "amount": 2200,
          "tax_rate_type": "10"
        },
        {
          "amount": 3240,
          "tax_rate_type": "reduced_8"
        }
      ],
      "billing_id": "9R6M-VMAN",
      "canceled_at": "2019-04-22T10:36:43+09:00",
      "created_at": "2019-04-01T10:36:43+09:00",
      "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",
          "tax_included_type": "excluded",
          "tax_rate_type": "10",
          "quantity": 3,
          "unit_price": 1000
        },
        {
          "amount": 3000,
          "description": "商品名B",
          "tax_included_type": "excluded",
          "tax_rate_type": "reduced_8",
          "quantity": 3,
          "unit_price": 1000
        },
        {
          "amount": -1000,
          "description": "商品名A 返品",
          "tax_included_type": "excluded",
          "tax_rate_type": "10",
          "quantity": -1,
          "unit_price": 1000
        }
      ],
      "uri": "mfk:transaction:7679-YW36"
    }
    

    Responses

    ステータス 説明
    200 作成した取引が返却されます。
    400 リクエスト内容の不備によるエラーです。エラー内容を確認してください。
    409 登録しようとした取引と一致する取引が既に登録されている場合のエラーです。指定したnumberが既に登録済みでないか確認してください。

    Status Code 200

    項目名 説明
    amount integer 取引の合計金額です。税込金額になります。
    amounts_per_tax_rate_type [AmountPerTaxRateType] 各税率種別毎の税込の合計金額です。各税率種別の取引明細行の小計を合計した値に各税率を乗じた値になっています。
    billing_id string 請求IDです。請求書にまとめられる単位のIDです。同じ請求IDを持つ取引とまとめられて請求書に記載されます。
    canceled_at string(date-time)¦null 取引がキャンセルされた日時です。未キャンセルの場合は空になります。
    created_at string(date-time) 取引が登録された日時です。
    destination_id string 請求先IDです。取引の請求先を示します。
    date string(date) 取引日です。売り手様と顧客様の間で取引を行った日付です。
    due_date string(date) 支払期限日です。この日付を超えてMF KESSAIへの入金が確認できない場合は未入金になります。
    id string 取引IDです。一意の識別子として自動で付与されます。
    invoice_delivery_methods [InvoiceDeliveryMethod] 請求書送付方法です。郵送(posting) またはメール送付(email)のうちから少なくとも1つを指定してください。どちらも選択された場合、どちらの方法でも送付されます。 また、各取引で指定しなかった送付方法でも、請求にまとまった取引のうちでその送付方法を選択しているものがあれば、そちらの送付方法も採用されます。
    issue_date string(date) 請求書発行日です。請求書が発行される日付を指定します。指定した日付が営業日でない場合は翌営業日になります。 また、請求書発送日については請求書発行日についてを参照ください。
    number string 取引に付与できる任意の取引番号です。MF KESSAIが自動で付与する取引IDとは別で、売り手様が独自に管理する識別子を登録することができます。ただし、売り手様の所有する取引間で一意である必要があります。
    object string このObjectの種別を示します。ここでは必ずtransactionが入ります。
    status string 取引ステータスです。審査中(unexamined)、審査通過(passed)、審査否決(rejected)、キャンセル済(canceled)があります。
    値は以下のうちの一つになります。
    • unexamined
    • passed
    • rejected
    • canceled
    transaction_details [TransactionDetail] 取引明細行です。
    uri string 取引URIです。すべてのリソースで一意の識別子として自動で付与されます。

    取引取得

    コードサンプル

    curl -X GET https://sandbox-api.mfkessai.co.jp/v2/transactions/{transaction_id} \
      -H 'Accept: application/json'
      -H 'apikey: API_KEY'
    
    
    <?php
    
    require 'vendor/autoload.php';
    
    $headers = array(
        'Accept' => 'application/json',
        'apikey' => 'API_KEY',
    
        );
    
    $client = new \GuzzleHttp\Client();
    
    // Define array of request body.
    $request_body = '';
    
    try {
        $response = $client->request('GET','https://sandbox-api.mfkessai.co.jp/v2/transactions/{transaction_id}', array(
            'headers' => $headers,
            'body' => $request_body,
           )
        );
        print_r($response->getBody()->getContents());
     }
     catch (\GuzzleHttp\Exception\BadResponseException $e) {
        // handle exception or api errors.
        print_r($e->getMessage());
     }
    
     // ...
    
    
    require 'net/http'
    require 'uri'
    
    uri = URI.parse("https://sandbox-api.mfkessai.co.jp/v2/customers")
    
    headers = {
      'Accept' => 'application/json',
      'apikey' => 'API_KEY'
    }
    
    req = Net::HTTP::Get.new(uri, headers)
    
    req_options = {
        use_ssl: uri.scheme = "https"
    }
    
    response = Net::HTTP.start(uri.hostname, uri.port, req_options) do |http|
      res = http.request(req)
      p res
    end
    
    import requests
    headers = {
      'Accept': 'application/json',
      'apikey': 'API_KEY'
    }
    
    r = requests.get('https://sandbox-api.mfkessai.co.jp/v2/transactions/{transaction_id}', params={
    
    }, headers=headers)
    
    print(r.json())
    
    
    package main
    
    import (
           "bytes"
           "net/http"
    )
    
    func main() {
    
        headers := map[string][]string{
            "Accept": []string{"application/json"},
            "apikey": []string{"API_KEY"},
    
        }
    
        data := bytes.NewBuffer([]byte{``})
        req, err := http.NewRequest("GET", "https://sandbox-api.mfkessai.co.jp/v2/transactions/{transaction_id}", data)
        if err != nil {
            // handle error
            return
        }
        req.Header = headers
    
        client := &http.Client{}
        resp, err := client.Do(req)
        if err != nil {
            // handle error
            return
        }
        // ...
    }
    
    
    const fetch = require('node-fetch');
    
    const headers = {
      'Accept':'application/json',
      'apikey':'API_KEY'
    };
    
    fetch('https://sandbox-api.mfkessai.co.jp/v2/transactions/{transaction_id}',
    {
      method: 'GET',
      headers: headers
    })
    .then(function(res) {
        return res.json();
    }).then(function(body) {
        console.log(body);
    });
    
    

    /transactions/{transaction_id}

    PathParameters

    項目名 説明
    transaction_id
    required
    string 対象の取引IDを指定してください。

    レスポンス例

    200 Response

    {
      "amount": 5440,
      "amounts_per_tax_rate_type": [
        {
          "amount": 2200,
          "tax_rate_type": "10"
        },
        {
          "amount": 3240,
          "tax_rate_type": "reduced_8"
        }
      ],
      "billing_id": "9R6M-VMAN",
      "canceled_at": "2019-04-22T10:36:43+09:00",
      "created_at": "2019-04-01T10:36:43+09:00",
      "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",
          "tax_included_type": "excluded",
          "tax_rate_type": "10",
          "quantity": 3,
          "unit_price": 1000
        },
        {
          "amount": 3000,
          "description": "商品名B",
          "tax_included_type": "excluded",
          "tax_rate_type": "reduced_8",
          "quantity": 3,
          "unit_price": 1000
        },
        {
          "amount": -1000,
          "description": "商品名A 返品",
          "tax_included_type": "excluded",
          "tax_rate_type": "10",
          "quantity": -1,
          "unit_price": 1000
        }
      ],
      "uri": "mfk:transaction:7679-YW36"
    }
    

    Responses

    ステータス 説明
    200 指定した与信枠が返却されます。
    400 リクエスト内容の不備によるエラーです。エラー内容を確認してください。
    404 与信枠IDで指定した与信枠が存在しない場合のエラーです。

    Status Code 200

    項目名 説明
    amount integer 取引の合計金額です。税込金額になります。
    amounts_per_tax_rate_type [AmountPerTaxRateType] 各税率種別毎の税込の合計金額です。各税率種別の取引明細行の小計を合計した値に各税率を乗じた値になっています。
    billing_id string 請求IDです。請求書にまとめられる単位のIDです。同じ請求IDを持つ取引とまとめられて請求書に記載されます。
    canceled_at string(date-time)¦null 取引がキャンセルされた日時です。未キャンセルの場合は空になります。
    created_at string(date-time) 取引が登録された日時です。
    destination_id string 請求先IDです。取引の請求先を示します。
    date string(date) 取引日です。売り手様と顧客様の間で取引を行った日付です。
    due_date string(date) 支払期限日です。この日付を超えてMF KESSAIへの入金が確認できない場合は未入金になります。
    id string 取引IDです。一意の識別子として自動で付与されます。
    invoice_delivery_methods [InvoiceDeliveryMethod] 請求書送付方法です。郵送(posting) またはメール送付(email)のうちから少なくとも1つを指定してください。どちらも選択された場合、どちらの方法でも送付されます。 また、各取引で指定しなかった送付方法でも、請求にまとまった取引のうちでその送付方法を選択しているものがあれば、そちらの送付方法も採用されます。
    issue_date string(date) 請求書発行日です。請求書が発行される日付を指定します。指定した日付が営業日でない場合は翌営業日になります。 また、請求書発送日については請求書発行日についてを参照ください。
    number string 取引に付与できる任意の取引番号です。MF KESSAIが自動で付与する取引IDとは別で、売り手様が独自に管理する識別子を登録することができます。ただし、売り手様の所有する取引間で一意である必要があります。
    object string このObjectの種別を示します。ここでは必ずtransactionが入ります。
    status string 取引ステータスです。審査中(unexamined)、審査通過(passed)、審査否決(rejected)、キャンセル済(canceled)があります。
    値は以下のうちの一つになります。
    • unexamined
    • passed
    • rejected
    • canceled
    transaction_details [TransactionDetail] 取引明細行です。
    uri string 取引URIです。すべてのリソースで一意の識別子として自動で付与されます。

    取引キャンセル

    コードサンプル

    curl -X DELETE https://sandbox-api.mfkessai.co.jp/v2/transactions/{transaction_id} \
      -H 'Accept: application/json'
      -H 'apikey: API_KEY'
    
    
    <?php
    
    require 'vendor/autoload.php';
    
    $headers = array(
        'Accept' => 'application/json',
        'apikey' => 'API_KEY',
    
        );
    
    $client = new \GuzzleHttp\Client();
    
    // Define array of request body.
    $request_body = '';
    
    try {
        $response = $client->request('DELETE','https://sandbox-api.mfkessai.co.jp/v2/transactions/{transaction_id}', array(
            'headers' => $headers,
            'body' => $request_body,
           )
        );
        print_r($response->getBody()->getContents());
     }
     catch (\GuzzleHttp\Exception\BadResponseException $e) {
        // handle exception or api errors.
        print_r($e->getMessage());
     }
    
     // ...
    
    
    require 'net/http'
    require 'uri'
    
    uri = URI.parse("https://sandbox-api.mfkessai.co.jp/v2/customers")
    
    headers = {
      'Accept' => 'application/json',
      'apikey' => 'API_KEY'
    }
    
    req = Net::HTTP::Delete.new(uri, headers)
    
    req_options = {
        use_ssl: uri.scheme = "https"
    }
    
    response = Net::HTTP.start(uri.hostname, uri.port, req_options) do |http|
      res = http.request(req)
      p res
    end
    
    import requests
    headers = {
      'Accept': 'application/json',
      'apikey': 'API_KEY'
    }
    
    r = requests.delete('https://sandbox-api.mfkessai.co.jp/v2/transactions/{transaction_id}', params={
    
    }, headers=headers)
    
    print(r.json())
    
    
    package main
    
    import (
           "bytes"
           "net/http"
    )
    
    func main() {
    
        headers := map[string][]string{
            "Accept": []string{"application/json"},
            "apikey": []string{"API_KEY"},
    
        }
    
        data := bytes.NewBuffer([]byte{``})
        req, err := http.NewRequest("DELETE", "https://sandbox-api.mfkessai.co.jp/v2/transactions/{transaction_id}", data)
        if err != nil {
            // handle error
            return
        }
        req.Header = headers
    
        client := &http.Client{}
        resp, err := client.Do(req)
        if err != nil {
            // handle error
            return
        }
        // ...
    }
    
    
    const fetch = require('node-fetch');
    
    const headers = {
      'Accept':'application/json',
      'apikey':'API_KEY'
    };
    
    fetch('https://sandbox-api.mfkessai.co.jp/v2/transactions/{transaction_id}',
    {
      method: 'DELETE',
      headers: headers
    })
    .then(function(res) {
        return res.json();
    }).then(function(body) {
        console.log(body);
    });
    
    

    /transactions/{transaction_id}

    PathParameters

    項目名 説明
    transaction_id
    required
    string 対象の取引IDを指定してください。

    レスポンス例

    200 Response

    {
      "amount": 5440,
      "amounts_per_tax_rate_type": [
        {
          "amount": 2200,
          "tax_rate_type": "10"
        },
        {
          "amount": 3240,
          "tax_rate_type": "reduced_8"
        }
      ],
      "billing_id": "9R6M-VMAN",
      "canceled_at": "2019-04-22T10:36:43+09:00",
      "created_at": "2019-04-01T10:36:43+09:00",
      "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",
          "tax_included_type": "excluded",
          "tax_rate_type": "10",
          "quantity": 3,
          "unit_price": 1000
        },
        {
          "amount": 3000,
          "description": "商品名B",
          "tax_included_type": "excluded",
          "tax_rate_type": "reduced_8",
          "quantity": 3,
          "unit_price": 1000
        },
        {
          "amount": -1000,
          "description": "商品名A 返品",
          "tax_included_type": "excluded",
          "tax_rate_type": "10",
          "quantity": -1,
          "unit_price": 1000
        }
      ],
      "uri": "mfk:transaction:7679-YW36"
    }
    

    Responses

    ステータス 説明
    200 キャンセルした取引が返却されます。
    400 リクエスト内容の不備によるエラーです。エラー内容を確認してください。
    409 キャンセルしようとした取引が既にキャンセルされている場合のエラーです。

    Status Code 200

    項目名 説明
    amount integer 取引の合計金額です。税込金額になります。
    amounts_per_tax_rate_type [AmountPerTaxRateType] 各税率種別毎の税込の合計金額です。各税率種別の取引明細行の小計を合計した値に各税率を乗じた値になっています。
    billing_id string 請求IDです。請求書にまとめられる単位のIDです。同じ請求IDを持つ取引とまとめられて請求書に記載されます。
    canceled_at string(date-time)¦null 取引がキャンセルされた日時です。未キャンセルの場合は空になります。
    created_at string(date-time) 取引が登録された日時です。
    destination_id string 請求先IDです。取引の請求先を示します。
    date string(date) 取引日です。売り手様と顧客様の間で取引を行った日付です。
    due_date string(date) 支払期限日です。この日付を超えてMF KESSAIへの入金が確認できない場合は未入金になります。
    id string 取引IDです。一意の識別子として自動で付与されます。
    invoice_delivery_methods [InvoiceDeliveryMethod] 請求書送付方法です。郵送(posting) またはメール送付(email)のうちから少なくとも1つを指定してください。どちらも選択された場合、どちらの方法でも送付されます。 また、各取引で指定しなかった送付方法でも、請求にまとまった取引のうちでその送付方法を選択しているものがあれば、そちらの送付方法も採用されます。
    issue_date string(date) 請求書発行日です。請求書が発行される日付を指定します。指定した日付が営業日でない場合は翌営業日になります。 また、請求書発送日については請求書発行日についてを参照ください。
    number string 取引に付与できる任意の取引番号です。MF KESSAIが自動で付与する取引IDとは別で、売り手様が独自に管理する識別子を登録することができます。ただし、売り手様の所有する取引間で一意である必要があります。
    object string このObjectの種別を示します。ここでは必ずtransactionが入ります。
    status string 取引ステータスです。審査中(unexamined)、審査通過(passed)、審査否決(rejected)、キャンセル済(canceled)があります。
    値は以下のうちの一つになります。
    • unexamined
    • passed
    • rejected
    • canceled
    transaction_details [TransactionDetail] 取引明細行です。
    uri string 取引URIです。すべてのリソースで一意の識別子として自動で付与されます。

    Billing

    Billing Object

    Billing

    {
      "amount": 21800,
      "amounts_per_tax_rate_type": [
        {
          "amount": 11000,
          "tax_rate_type": "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"
      ],
      "issue_date": "2019-04-01",
      "object": "billing",
      "status": "scheduled",
      "unpaid": {
        "shortage_amount": 12000,
        "updated_date": "2019-04-30"
      },
      "uri": "mfk:billing:9R6M-VMAN"
    }
    
    

    請求です。取引のうち、請求先・支払期限日・請求書発行日・取引登録方式が同一の取引が同じ請求にまとめられます。

    Property

    項目名 説明
    amount integer 請求の税込の合計金額です。請求に含まれる取引金額の合計です。
    amounts_per_tax_rate_type [AmountPerTaxRateType] 各税率種別毎の税込の合計金額です。各税率種別の取引金額を合計した値に各税率を乗じた値になっています。
    customer_id string 顧客IDです。請求の顧客を示します。
    destination_id string 請求先IDです。請求先を示します。
    due_date string(date) 支払期限日です。
    id string 請求IDです。一意の識別子として自動で付与されます。請求先ID・支払期限日・請求書発行日・取引登録方式が同一の取引がこの請求によってまとめられます。請求書は請求をもとに発行されます。
    invoice_delivery_methods [InvoiceDeliveryMethod] 請求書送付方法です。郵送(posting) またはメール送付(email)のうちから少なくとも1つを指定してください。どちらも選択された場合、どちらの方法でも送付されます。 また、各取引で指定しなかった送付方法でも、請求にまとまった取引のうちでその送付方法を選択しているものがあれば、そちらの送付方法も採用されます。
    issue_date string(date) 請求書発行日です。請求書が発行される日付を指定します。指定した日付が営業日でない場合は翌営業日になります。また、請求書送付日についてはこちらをご参照ください。
    object string このObjectの種別を示します。ここでは必ずbillingが入ります。
  • billing
  • status string 請求ステータスです。請求予定(scheduled)、請求書発行済(invoice_issued) 、口座振替通知済(account_transfer_notified)で指定されます。
    値は以下のうちの一つになります。
    • scheduled
    • invoice_issued
    • account_transfer_notified
    unpaid object 未入金情報です。請求に対して未入金がある場合のみ返却されます。
    » shortage_amount integer 未入金額です。
    » updated_date string(date) 入金情報が最後に更新された日付です。この日付移行に入金されている可能性があります。
    uri string 請求URIです。すべてのリソースで一意の識別子として自動で付与されます。

    請求一覧取得

    コードサンプル

    curl -X GET https://sandbox-api.mfkessai.co.jp/v2/billings \
      -H 'Accept: application/json'
      -H 'apikey: API_KEY'
    
    
    <?php
    
    require 'vendor/autoload.php';
    
    $headers = array(
        'Accept' => 'application/json',
        'apikey' => 'API_KEY',
    
        );
    
    $client = new \GuzzleHttp\Client();
    
    // Define array of request body.
    $request_body = '';
    
    try {
        $response = $client->request('GET','https://sandbox-api.mfkessai.co.jp/v2/billings', array(
            'headers' => $headers,
            'body' => $request_body,
           )
        );
        print_r($response->getBody()->getContents());
     }
     catch (\GuzzleHttp\Exception\BadResponseException $e) {
        // handle exception or api errors.
        print_r($e->getMessage());
     }
    
     // ...
    
    
    require 'net/http'
    require 'uri'
    
    uri = URI.parse("https://sandbox-api.mfkessai.co.jp/v2/customers")
    
    headers = {
      'Accept' => 'application/json',
      'apikey' => 'API_KEY'
    }
    
    req = Net::HTTP::Get.new(uri, headers)
    
    req_options = {
        use_ssl: uri.scheme = "https"
    }
    
    response = Net::HTTP.start(uri.hostname, uri.port, req_options) do |http|
      res = http.request(req)
      p res
    end
    
    import requests
    headers = {
      'Accept': 'application/json',
      'apikey': 'API_KEY'
    }
    
    r = requests.get('https://sandbox-api.mfkessai.co.jp/v2/billings', params={
    
    }, headers=headers)
    
    print(r.json())
    
    
    package main
    
    import (
           "bytes"
           "net/http"
    )
    
    func main() {
    
        headers := map[string][]string{
            "Accept": []string{"application/json"},
            "apikey": []string{"API_KEY"},
    
        }
    
        data := bytes.NewBuffer([]byte{``})
        req, err := http.NewRequest("GET", "https://sandbox-api.mfkessai.co.jp/v2/billings", data)
        if err != nil {
            // handle error
            return
        }
        req.Header = headers
    
        client := &http.Client{}
        resp, err := client.Do(req)
        if err != nil {
            // handle error
            return
        }
        // ...
    }
    
    
    const fetch = require('node-fetch');
    
    const headers = {
      'Accept':'application/json',
      'apikey':'API_KEY'
    };
    
    fetch('https://sandbox-api.mfkessai.co.jp/v2/billings',
    {
      method: 'GET',
      headers: headers
    })
    .then(function(res) {
        return res.json();
    }).then(function(body) {
        console.log(body);
    });
    
    

    /billings

    QueryParameters

    項目名 説明
    customer_id string 任意の顧客IDを指定します。指定した顧客への請求が返却されます。
    status array[string] 請求ステータスを指定します。該当するステータスの請求が返却されます。複数指定することが可能です。指定できる値は scheduled(請求予定), invoice_issued(請求書発行済), account_transfer_notified(口座振替通知済)の3種類のみです。
    値は以下のうちの一つになります。
    • scheduled
    • invoice_issued
    • account_transfer_notified
    due_date_from string(date) 日付を指定します。指定した日付以降の支払期限となっている請求を取得できます。指定された日付のものも含まれます。
    due_date_to string(date) 日付を指定します。指定した日付以前の支払期限となっている請求を取得できます。指定された日付のものも含まれます。
    issue_date_from string(date) 日付を指定します。指定した日付以降の請求書発行日となっている請求を取得できます。指定された日付のものも含まれます。
    issue_date_to string(date) 日付を指定します。指定した日付以前の請求書発行日となっている請求を取得できます。指定された日付のものも含まれます。
    unpaid boolean 未入金のあり(true)、なし(false)を指定します。空文字が指定された場合、falseとして扱われます。
    after string 任意のリソースIDを指定します。追加日時の降順でこのIDのリソースよりも後のリソースを取得します。この時afterで指定したIDのリソースは結果に含まれません。
    before string 任意のリソースIDを指定します。追加日時の降順でこのIDのリソースよりも前のリソースを取得します。この時beforeで指定したIDのリソースは結果に含まれません。
    limit integer(int32) 取得したいリソースの最大件数を指定します。1~200の間の整数で指定してください。指定がない場合は20になります。

    レスポンス例

    200 Response

    {
      "items": [
        {
          "amount": 21800,
          "amounts_per_tax_rate_type": [
            {
              "amount": 11000,
              "tax_rate_type": "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"
          ],
          "issue_date": "2019-04-01",
          "object": "billing",
          "status": "scheduled",
          "unpaid": {
            "shortage_amount": 12000,
            "updated_date": "2019-04-30"
          },
          "uri": "mfk:billing:9R6M-VMAN"
        }
      ],
      "object": "list",
      "pagination": {
        "end": "7679-YW36",
        "has_next": true,
        "has_previous": false,
        "limit": 20,
        "start": "9R6M-VMAN",
        "total": 143
      }
    }
    

    Responses

    ステータス 説明
    200 請求一覧とページネーション情報です。
    400 リクエスト内容の不備によるエラーです。エラー内容を確認してください。

    Status Code 200

    項目名 説明
    items [Billing] 請求一覧です。
    object string このObjectの種別を示します。ここでは必ず listが設定されます。
    pagination Pagination ページネーション情報です。各Objectの一覧取得の際にリストとともに返却されます。この情報をもとにページ繰りを行うことができます。

    請求取得

    コードサンプル

    curl -X GET https://sandbox-api.mfkessai.co.jp/v2/billings/{billing_id} \
      -H 'Accept: application/json'
      -H 'apikey: API_KEY'
    
    
    <?php
    
    require 'vendor/autoload.php';
    
    $headers = array(
        'Accept' => 'application/json',
        'apikey' => 'API_KEY',
    
        );
    
    $client = new \GuzzleHttp\Client();
    
    // Define array of request body.
    $request_body = '';
    
    try {
        $response = $client->request('GET','https://sandbox-api.mfkessai.co.jp/v2/billings/{billing_id}', array(
            'headers' => $headers,
            'body' => $request_body,
           )
        );
        print_r($response->getBody()->getContents());
     }
     catch (\GuzzleHttp\Exception\BadResponseException $e) {
        // handle exception or api errors.
        print_r($e->getMessage());
     }
    
     // ...
    
    
    require 'net/http'
    require 'uri'
    
    uri = URI.parse("https://sandbox-api.mfkessai.co.jp/v2/customers")
    
    headers = {
      'Accept' => 'application/json',
      'apikey' => 'API_KEY'
    }
    
    req = Net::HTTP::Get.new(uri, headers)
    
    req_options = {
        use_ssl: uri.scheme = "https"
    }
    
    response = Net::HTTP.start(uri.hostname, uri.port, req_options) do |http|
      res = http.request(req)
      p res
    end
    
    import requests
    headers = {
      'Accept': 'application/json',
      'apikey': 'API_KEY'
    }
    
    r = requests.get('https://sandbox-api.mfkessai.co.jp/v2/billings/{billing_id}', params={
    
    }, headers=headers)
    
    print(r.json())
    
    
    package main
    
    import (
           "bytes"
           "net/http"
    )
    
    func main() {
    
        headers := map[string][]string{
            "Accept": []string{"application/json"},
            "apikey": []string{"API_KEY"},
    
        }
    
        data := bytes.NewBuffer([]byte{``})
        req, err := http.NewRequest("GET", "https://sandbox-api.mfkessai.co.jp/v2/billings/{billing_id}", data)
        if err != nil {
            // handle error
            return
        }
        req.Header = headers
    
        client := &http.Client{}
        resp, err := client.Do(req)
        if err != nil {
            // handle error
            return
        }
        // ...
    }
    
    
    const fetch = require('node-fetch');
    
    const headers = {
      'Accept':'application/json',
      'apikey':'API_KEY'
    };
    
    fetch('https://sandbox-api.mfkessai.co.jp/v2/billings/{billing_id}',
    {
      method: 'GET',
      headers: headers
    })
    .then(function(res) {
        return res.json();
    }).then(function(body) {
        console.log(body);
    });
    
    

    /billings/{billing_id}

    PathParameters

    項目名 説明
    billing_id
    required
    string 対象の請求IDを指定してください。

    レスポンス例

    200 Response

    {
      "amount": 21800,
      "amounts_per_tax_rate_type": [
        {
          "amount": 11000,
          "tax_rate_type": "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"
      ],
      "issue_date": "2019-04-01",
      "object": "billing",
      "status": "scheduled",
      "unpaid": {
        "shortage_amount": 12000,
        "updated_date": "2019-04-30"
      },
      "uri": "mfk:billing:9R6M-VMAN"
    }
    

    Responses

    ステータス 説明
    200 指定した請求が返却されます。
    400 リクエスト内容の不備によるエラーです。エラー内容を確認してください。
    404 請求IDで指定した請求が存在しない場合のエラーです。

    Status Code 200

    項目名 説明
    amount integer 請求の税込の合計金額です。請求に含まれる取引金額の合計です。
    amounts_per_tax_rate_type [AmountPerTaxRateType] 各税率種別毎の税込の合計金額です。各税率種別の取引金額を合計した値に各税率を乗じた値になっています。
    customer_id string 顧客IDです。請求の顧客を示します。
    destination_id string 請求先IDです。請求先を示します。
    due_date string(date) 支払期限日です。
    id string 請求IDです。一意の識別子として自動で付与されます。請求先ID・支払期限日・請求書発行日・取引登録方式が同一の取引がこの請求によってまとめられます。請求書は請求をもとに発行されます。
    invoice_delivery_methods [InvoiceDeliveryMethod] 請求書送付方法です。郵送(posting) またはメール送付(email)のうちから少なくとも1つを指定してください。どちらも選択された場合、どちらの方法でも送付されます。 また、各取引で指定しなかった送付方法でも、請求にまとまった取引のうちでその送付方法を選択しているものがあれば、そちらの送付方法も採用されます。
    issue_date string(date) 請求書発行日です。請求書が発行される日付を指定します。指定した日付が営業日でない場合は翌営業日になります。また、請求書送付日についてはこちらをご参照ください。
    object string このObjectの種別を示します。ここでは必ずbillingが入ります。
    status string 請求ステータスです。請求予定(scheduled)、請求書発行済(invoice_issued) 、口座振替通知済(account_transfer_notified)で指定されます。
    値は以下のうちの一つになります。
    • scheduled
    • invoice_issued
    • account_transfer_notified
    unpaid object 未入金情報です。請求に対して未入金がある場合のみ返却されます。
    uri string 請求URIです。すべてのリソースで一意の識別子として自動で付与されます。

    Payout

    Payout Object

    Payout

    {
      "amount": 100800,
      "receivables_amount": 110000,
      "deduction": {
        "amount": 9200,
        "returned_credit_amount": 500,
        "tax_free": {
          "amount": 3200,
          "commission_amount": 2200,
          "early_payout_commission_amount": 1000
        },
        "taxable": {
          "amount": 5000,
          "basic_monthly_charge": 4500,
          "posting": {
            "amount": 500,
            "unit_price": 100,
            "quantity": 5
          }
        },
        "tax": {
          "rate_type": "10",
          "amount": 500
        }
      },
      "id": "7679-YW36",
      "payout_date": "2019-07-29",
      "status": "completed",
      "type": "normal",
      "uri": "mfk:payout:7679-YW36"
    }
    
    

    MFKESSAIから売り手様への金額確定済みの振込です。

    Property

    項目名 説明
    amount integer 振込金額です。
    receivables_amount integer 振込の対象となる債権金額です。
    deduction Deduction 振込から控除される金額とその内訳です。
    id string 振込IDです。一意の識別子として自動で付与されます。
    object string このObjectの種別を示します。ここでは必ずpayoutが入ります。
  • payout
  • payout_date string(date) 振込予定日です。
    status string 振込ステータスです。振込手続中(in_progress)、振込完了(completed)があります。
    値は以下のうちの一つになります。
    • in_progress
    • completed
    type string 振込種別です。通常振込(normal)、早期振込(early)があります。
    値は以下のうちの一つになります。
    • normal
    • early
    uri string 振込URIです。すべてのリソースで一意の識別子として自動で付与されます。

    振込一覧取得

    コードサンプル

    curl -X GET https://sandbox-api.mfkessai.co.jp/v2/payouts \
      -H 'Accept: application/json'
      -H 'apikey: API_KEY'
    
    
    <?php
    
    require 'vendor/autoload.php';
    
    $headers = array(
        'Accept' => 'application/json',
        'apikey' => 'API_KEY',
    
        );
    
    $client = new \GuzzleHttp\Client();
    
    // Define array of request body.
    $request_body = '';
    
    try {
        $response = $client->request('GET','https://sandbox-api.mfkessai.co.jp/v2/payouts', array(
            'headers' => $headers,
            'body' => $request_body,
           )
        );
        print_r($response->getBody()->getContents());
     }
     catch (\GuzzleHttp\Exception\BadResponseException $e) {
        // handle exception or api errors.
        print_r($e->getMessage());
     }
    
     // ...
    
    
    require 'net/http'
    require 'uri'
    
    uri = URI.parse("https://sandbox-api.mfkessai.co.jp/v2/customers")
    
    headers = {
      'Accept' => 'application/json',
      'apikey' => 'API_KEY'
    }
    
    req = Net::HTTP::Get.new(uri, headers)
    
    req_options = {
        use_ssl: uri.scheme = "https"
    }
    
    response = Net::HTTP.start(uri.hostname, uri.port, req_options) do |http|
      res = http.request(req)
      p res
    end
    
    import requests
    headers = {
      'Accept': 'application/json',
      'apikey': 'API_KEY'
    }
    
    r = requests.get('https://sandbox-api.mfkessai.co.jp/v2/payouts', params={
    
    }, headers=headers)
    
    print(r.json())
    
    
    package main
    
    import (
           "bytes"
           "net/http"
    )
    
    func main() {
    
        headers := map[string][]string{
            "Accept": []string{"application/json"},
            "apikey": []string{"API_KEY"},
    
        }
    
        data := bytes.NewBuffer([]byte{``})
        req, err := http.NewRequest("GET", "https://sandbox-api.mfkessai.co.jp/v2/payouts", data)
        if err != nil {
            // handle error
            return
        }
        req.Header = headers
    
        client := &http.Client{}
        resp, err := client.Do(req)
        if err != nil {
            // handle error
            return
        }
        // ...
    }
    
    
    const fetch = require('node-fetch');
    
    const headers = {
      'Accept':'application/json',
      'apikey':'API_KEY'
    };
    
    fetch('https://sandbox-api.mfkessai.co.jp/v2/payouts',
    {
      method: 'GET',
      headers: headers
    })
    .then(function(res) {
        return res.json();
    }).then(function(body) {
        console.log(body);
    });
    
    

    /payouts

    QueryParameters

    項目名 説明
    status array[string] 振込ステータスを指定します。該当するステータスの振込が返却されます。指定できる値は in_progress(振込手続中), completed(振込完了)の2種類のみです。
    値は以下のうちの一つになります。
    • in_progress
    • completed
    payout_date_from string(date) 日付を指定します。指定した日付以降の振込予定日となっている振込を取得できます。指定された日付のものも含まれます。
    payout_date_to string(date) 日付を指定します。指定した日付以前の振込予定日となっている振込を取得できます。指定された日付のものも含まれます。
    after string 任意のリソースIDを指定します。追加日時の降順でこのIDのリソースよりも後のリソースを取得します。この時afterで指定したIDのリソースは結果に含まれません。
    before string 任意のリソースIDを指定します。追加日時の降順でこのIDのリソースよりも前のリソースを取得します。この時beforeで指定したIDのリソースは結果に含まれません。
    limit integer(int32) 取得したいリソースの最大件数を指定します。1~200の間の整数で指定してください。指定がない場合は20になります。

    レスポンス例

    200 Response

    {
      "items": [
        {
          "amount": 100800,
          "receivables_amount": 110000,
          "deduction": {
            "amount": 9200,
            "returned_credit_amount": 500,
            "tax_free": {
              "amount": 3200,
              "commission_amount": 2200,
              "early_payout_commission_amount": 1000
            },
            "taxable": {
              "amount": 5000,
              "basic_monthly_charge": 4500,
              "posting": {
                "amount": 500,
                "unit_price": 100,
                "quantity": 5
              }
            },
            "tax": {
              "rate_type": "10",
              "amount": 500
            }
          },
          "id": "7679-YW36",
          "payout_date": "2019-07-29",
          "status": "completed",
          "type": "normal",
          "uri": "mfk:payout:7679-YW36"
        }
      ],
      "object": "list",
      "pagination": {
        "end": "7679-YW36",
        "has_next": true,
        "has_previous": false,
        "limit": 20,
        "start": "9R6M-VMAN",
        "total": 143
      }
    }
    

    Responses

    ステータス 説明
    200 振込一覧とページネーション情報です。
    400 リクエスト内容の不備によるエラーです。エラー内容を確認してください。

    Status Code 200

    項目名 説明
    items [Payout] 振込一覧です。

    振込取得

    コードサンプル

    curl -X GET https://sandbox-api.mfkessai.co.jp/v2/payouts/{payout_id} \
      -H 'Accept: application/json'
      -H 'apikey: API_KEY'
    
    
    <?php
    
    require 'vendor/autoload.php';
    
    $headers = array(
        'Accept' => 'application/json',
        'apikey' => 'API_KEY',
    
        );
    
    $client = new \GuzzleHttp\Client();
    
    // Define array of request body.
    $request_body = '';
    
    try {
        $response = $client->request('GET','https://sandbox-api.mfkessai.co.jp/v2/payouts/{payout_id}', array(
            'headers' => $headers,
            'body' => $request_body,
           )
        );
        print_r($response->getBody()->getContents());
     }
     catch (\GuzzleHttp\Exception\BadResponseException $e) {
        // handle exception or api errors.
        print_r($e->getMessage());
     }
    
     // ...
    
    
    require 'net/http'
    require 'uri'
    
    uri = URI.parse("https://sandbox-api.mfkessai.co.jp/v2/customers")
    
    headers = {
      'Accept' => 'application/json',
      'apikey' => 'API_KEY'
    }
    
    req = Net::HTTP::Get.new(uri, headers)
    
    req_options = {
        use_ssl: uri.scheme = "https"
    }
    
    response = Net::HTTP.start(uri.hostname, uri.port, req_options) do |http|
      res = http.request(req)
      p res
    end
    
    import requests
    headers = {
      'Accept': 'application/json',
      'apikey': 'API_KEY'
    }
    
    r = requests.get('https://sandbox-api.mfkessai.co.jp/v2/payouts/{payout_id}', params={
    
    }, headers=headers)
    
    print(r.json())
    
    
    package main
    
    import (
           "bytes"
           "net/http"
    )
    
    func main() {
    
        headers := map[string][]string{
            "Accept": []string{"application/json"},
            "apikey": []string{"API_KEY"},
    
        }
    
        data := bytes.NewBuffer([]byte{``})
        req, err := http.NewRequest("GET", "https://sandbox-api.mfkessai.co.jp/v2/payouts/{payout_id}", data)
        if err != nil {
            // handle error
            return
        }
        req.Header = headers
    
        client := &http.Client{}
        resp, err := client.Do(req)
        if err != nil {
            // handle error
            return
        }
        // ...
    }
    
    
    const fetch = require('node-fetch');
    
    const headers = {
      'Accept':'application/json',
      'apikey':'API_KEY'
    };
    
    fetch('https://sandbox-api.mfkessai.co.jp/v2/payouts/{payout_id}',
    {
      method: 'GET',
      headers: headers
    })
    .then(function(res) {
        return res.json();
    }).then(function(body) {
        console.log(body);
    });
    
    

    /payouts/{payout_id}

    PathParameters

    項目名 説明
    payout_id
    required
    string 対象の振込ID。

    レスポンス例

    200 Response

    {
      "amount": 100800,
      "receivables_amount": 110000,
      "deduction": {
        "amount": 9200,
        "returned_credit_amount": 500,
        "tax_free": {
          "amount": 3200,
          "commission_amount": 2200,
          "early_payout_commission_amount": 1000
        },
        "taxable": {
          "amount": 5000,
          "basic_monthly_charge": 4500,
          "posting": {
            "amount": 500,
            "unit_price": 100,
            "quantity": 5
          }
        },
        "tax": {
          "rate_type": "10",
          "amount": 500
        }
      },
      "id": "7679-YW36",
      "payout_date": "2019-07-29",
      "status": "completed",
      "type": "normal",
      "uri": "mfk:payout:7679-YW36"
    }
    

    Responses

    ステータス 説明
    200 指定した振込が返却されます。
    400 リクエスト内容の不備によるエラーです。エラー内容を確認してください。
    404 振込IDで指定した振込が存在しない場合のエラーです。

    Status Code 200

    項目名 説明
    amount integer 振込金額です。
    receivables_amount integer 振込の対象となる債権金額です。
    deduction Deduction 振込から控除される金額とその内訳です。

    PayoutTransaction

    PayoutTransaction Object

    PayoutTransaction

    {
      "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"
    }
    
    

    売り手様へ振込に紐づく債権です。

    Property

    項目名 説明
    accepted_at string(date-time) 債権譲受日時です。
    amount integer 債権金額です。
    commission_amount integer 手数料の金額です。
    commission_rate number 手数料率です。
    early_payout_commission_amount integer 早期振込手数料です。
    early_payout_commission_rate number 早期振込手数料率です。
    id string 債権IDです。一意の識別子として自動で付与されます。
    object string このObjectの種別を示します。ここでは必ずpayout_transactionが入ります。
  • payout_transaction
  • payout_date string(date) 振込予定日です。早期振込の場合、standard_payout_dateよりも早くなります。
    payout_id string 債権が含まれる振込のIDです。
    standard_payout_date string(date) 通常の振込予定日です。
    transaction_id string 取引IDです。この債権が紐づく取引を示します。
    uri string 債権URIです。すべてのリソースで一意の識別子として自動で付与されます。

    債権一覧取得

    コードサンプル

    curl -X GET https://sandbox-api.mfkessai.co.jp/v2/payout_transactions \
      -H 'Accept: application/json'
      -H 'apikey: API_KEY'
    
    
    <?php
    
    require 'vendor/autoload.php';
    
    $headers = array(
        'Accept' => 'application/json',
        'apikey' => 'API_KEY',
    
        );
    
    $client = new \GuzzleHttp\Client();
    
    // Define array of request body.
    $request_body = '';
    
    try {
        $response = $client->request('GET','https://sandbox-api.mfkessai.co.jp/v2/payout_transactions', array(
            'headers' => $headers,
            'body' => $request_body,
           )
        );
        print_r($response->getBody()->getContents());
     }
     catch (\GuzzleHttp\Exception\BadResponseException $e) {
        // handle exception or api errors.
        print_r($e->getMessage());
     }
    
     // ...
    
    
    require 'net/http'
    require 'uri'
    
    uri = URI.parse("https://sandbox-api.mfkessai.co.jp/v2/customers")
    
    headers = {
      'Accept' => 'application/json',
      'apikey' => 'API_KEY'
    }
    
    req = Net::HTTP::Get.new(uri, headers)
    
    req_options = {
        use_ssl: uri.scheme = "https"
    }
    
    response = Net::HTTP.start(uri.hostname, uri.port, req_options) do |http|
      res = http.request(req)
      p res
    end
    
    import requests
    headers = {
      'Accept': 'application/json',
      'apikey': 'API_KEY'
    }
    
    r = requests.get('https://sandbox-api.mfkessai.co.jp/v2/payout_transactions', params={
    
    }, headers=headers)
    
    print(r.json())
    
    
    package main
    
    import (
           "bytes"
           "net/http"
    )
    
    func main() {
    
        headers := map[string][]string{
            "Accept": []string{"application/json"},
            "apikey": []string{"API_KEY"},
    
        }
    
        data := bytes.NewBuffer([]byte{``})
        req, err := http.NewRequest("GET", "https://sandbox-api.mfkessai.co.jp/v2/payout_transactions", data)
        if err != nil {
            // handle error
            return
        }
        req.Header = headers
    
        client := &http.Client{}
        resp, err := client.Do(req)
        if err != nil {
            // handle error
            return
        }
        // ...
    }
    
    
    const fetch = require('node-fetch');
    
    const headers = {
      'Accept':'application/json',
      'apikey':'API_KEY'
    };
    
    fetch('https://sandbox-api.mfkessai.co.jp/v2/payout_transactions',
    {
      method: 'GET',
      headers: headers
    })
    .then(function(res) {
        return res.json();
    }).then(function(body) {
        console.log(body);
    });
    
    

    /payout_transactions

    QueryParameters

    項目名 説明
    payout_id string 任意の振込IDを指定します。指定した振込に含まれる債権が返却されます。
    after string 任意のリソースIDを指定します。追加日時の降順でこのIDのリソースよりも後のリソースを取得します。この時afterで指定したIDのリソースは結果に含まれません。
    before string 任意のリソースIDを指定します。追加日時の降順でこのIDのリソースよりも前のリソースを取得します。この時beforeで指定したIDのリソースは結果に含まれません。
    limit integer(int32) 取得したいリソースの最大件数を指定します。1~200の間の整数で指定してください。指定がない場合は20になります。

    レスポンス例

    200 Response

    {
      "items": [
        {
          "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"
        }
      ],
      "object": "list",
      "pagination": {
        "end": "7679-YW36",
        "has_next": true,
        "has_previous": false,
        "limit": 20,
        "start": "9R6M-VMAN",
        "total": 143
      }
    }
    

    Responses

    ステータス 説明
    200 債権一覧とページネーション情報です。
    400 リクエスト内容の不備によるエラーです。エラー内容を確認してください。

    Status Code 200

    項目名 説明
    items [PayoutTransaction] 債権一覧です。
    object string このObjectの種別を示します。ここでは必ず listが設定されます。
    pagination Pagination ページネーション情報です。各Objectの一覧取得の際にリストとともに返却されます。この情報をもとにページ繰りを行うことができます。

    債権取得

    コードサンプル

    curl -X GET https://sandbox-api.mfkessai.co.jp/v2/payout_transactions/{payout_transaction_id} \
      -H 'Accept: application/json'
      -H 'apikey: API_KEY'
    
    
    <?php
    
    require 'vendor/autoload.php';
    
    $headers = array(
        'Accept' => 'application/json',
        'apikey' => 'API_KEY',
    
        );
    
    $client = new \GuzzleHttp\Client();
    
    // Define array of request body.
    $request_body = '';
    
    try {
        $response = $client->request('GET','https://sandbox-api.mfkessai.co.jp/v2/payout_transactions/{payout_transaction_id}', array(
            'headers' => $headers,
            'body' => $request_body,
           )
        );
        print_r($response->getBody()->getContents());
     }
     catch (\GuzzleHttp\Exception\BadResponseException $e) {
        // handle exception or api errors.
        print_r($e->getMessage());
     }
    
     // ...
    
    
    require 'net/http'
    require 'uri'
    
    uri = URI.parse("https://sandbox-api.mfkessai.co.jp/v2/customers")
    
    headers = {
      'Accept' => 'application/json',
      'apikey' => 'API_KEY'
    }
    
    req = Net::HTTP::Get.new(uri, headers)
    
    req_options = {
        use_ssl: uri.scheme = "https"
    }
    
    response = Net::HTTP.start(uri.hostname, uri.port, req_options) do |http|
      res = http.request(req)
      p res
    end
    
    import requests
    headers = {
      'Accept': 'application/json',
      'apikey': 'API_KEY'
    }
    
    r = requests.get('https://sandbox-api.mfkessai.co.jp/v2/payout_transactions/{payout_transaction_id}', params={
    
    }, headers=headers)
    
    print(r.json())
    
    
    package main
    
    import (
           "bytes"
           "net/http"
    )
    
    func main() {
    
        headers := map[string][]string{
            "Accept": []string{"application/json"},
            "apikey": []string{"API_KEY"},
    
        }
    
        data := bytes.NewBuffer([]byte{``})
        req, err := http.NewRequest("GET", "https://sandbox-api.mfkessai.co.jp/v2/payout_transactions/{payout_transaction_id}", data)
        if err != nil {
            // handle error
            return
        }
        req.Header = headers
    
        client := &http.Client{}
        resp, err := client.Do(req)
        if err != nil {
            // handle error
            return
        }
        // ...
    }
    
    
    const fetch = require('node-fetch');
    
    const headers = {
      'Accept':'application/json',
      'apikey':'API_KEY'
    };
    
    fetch('https://sandbox-api.mfkessai.co.jp/v2/payout_transactions/{payout_transaction_id}',
    {
      method: 'GET',
      headers: headers
    })
    .then(function(res) {
        return res.json();
    }).then(function(body) {
        console.log(body);
    });
    
    

    /payout_transactions/{payout_transaction_id}

    PathParameters

    項目名 説明
    payout_transaction_id
    required
    string 取得したい債権のID。

    レスポンス例

    200 Response

    {
      "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"
    }
    

    Responses

    ステータス 説明
    200 指定した債権が返却されます。
    400 リクエスト内容の不備によるエラーです。エラー内容を確認してください。
    404 債権IDで指定した債権が存在しない場合のエラーです。

    Status Code 200

    項目名 説明
    accepted_at string(date-time) 債権譲受日時です。
    amount integer 債権金額です。
    commission_amount integer 手数料の金額です。
    commission_rate number 手数料率です。
    early_payout_commission_amount integer 早期振込手数料です。
    early_payout_commission_rate number 早期振込手数料率です。
    id string 債権IDです。一意の識別子として自動で付与されます。
    object string このObjectの種別を示します。ここでは必ずpayout_transactionが入ります。
    payout_date string(date) 振込予定日です。早期振込の場合、standard_payout_dateよりも早くなります。
    payout_id string 債権が含まれる振込のIDです。
    standard_payout_date string(date) 通常の振込予定日です。
    transaction_id string 取引IDです。この債権が紐づく取引を示します。
    uri string 債権URIです。すべてのリソースで一意の識別子として自動で付与されます。

    Object

    Error

    {
      "code": "invalid_after",
      "message": "parameter must be a valid one.",
      "param": "9R6M-VMAN"
    }
    
    

    エラー内容の詳細です。4xxのエラーコードとともに返却されます。

    Property

    項目名 説明
    code string エラーコードです。それぞれの説明については、エラーコードを参照してください。
    値は以下のうちの一つになります。
    • not_found
    • request_canceled
    • already_exists
    • 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_customer_destination
    • invalid_customer_has_alert
    • invalid_customer_id
    • invalid_customer_name
    • invalid_customer_number
    • invalid_customer_payment_method
    • 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_transaction_amount
    • invalid_transaction_amounts_per_tax_rate_type
    • invalid_transaction_details
    • 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_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
    message string エラー発生原因に関する情報です。
    param string 何らかの値に関連するエラーの場合その値が入ります。
    type string エラー種別です。
    値は以下のうちの一つになります。
    • already_exisits_error
    • conflict_operation_error
    • invalid_argument_error
    • not_found_error
    • rate_limit_error
    • request_canceled

    Errors

    [
      {
        "code": "invalid_after",
        "message": "parameter must be a valid one.",
        "param": "9R6M-VMAN"
      }
    ]
    
    

    4xx系のエラーが発生した場合にエラー情報を返します。エラーObjectを配列として複数返します。

    Property

    項目名 説明
    - [Error] 4xx系のエラーが発生した場合にエラー情報を返します。エラーObjectを配列として複数返します。

    Pagination

    {
      "end": "7679-YW36",
      "has_next": true,
      "has_previous": false,
      "limit": 20,
      "start": "9R6M-VMAN",
      "total": 143
    }
    
    

    ページネーション情報です。各Objectの一覧取得の際にリストとともに返却されます。この情報をもとにページ繰りを行うことができます。

    Property

    項目名 説明
    end string この一覧に含まれるリソースのうち最後のリソースのIDです。次ページがある場合は、この値をクエリパラメーターafterに設定することで次ページを取得することができます。
    has_next boolean 次ページがある場合はtrue、ない場合はfalseが返却されます。
    has_previous boolean 前ページがある場合はtrue、ない場合はfalseが返却されます。
    limit integer ページ当たりの最大件数です。
    start string この一覧に含まれるリソースのうち最初のリソースのIDです。前ページがある場合は、この値をクエリパラメーターbeforeに設定することで前ページを取得することができます。
    total integer¦null 条件に合致するリソースの全件数です。

    Customer

    {
      "created_at": "2019-04-01T10:36:43+09:00",
      "has_alert": false,
      "id": "7679-YW36",
      "name": "サンプル顧客",
      "number": "CUSTOEMR001",
      "object": "customer",
      "payment_method": {
        "bank_transfer": {
          "object": "bank_transfer",
          "account_number": "123456789",
          "bank_name": "MEKESSAI銀行",
          "branch_name": "大手町支店",
          "holder_name": "エムエフケツサイ(カ",
          "type": "current"
        },
        "object": "payment_method"
      },
      "uri": "mfk:customer:7679-YW36"
    }
    
    

    顧客です。取引登録や与信枠取得などあらゆる機能を利用する起点となります。

    Property

    項目名 説明
    created_at string(date-time) 顧客が登録された日時を示します。
    has_alert boolean 未入金アラートの有無を示します。未入金アラートがある場合はtrue、ない場合はfalseを返します。未入金アラートがあると、自動で毎月付与されている与信枠が停止します。
    id string 顧客IDです。 MF KESSAIによって発番される一意の識別子です。
    name string 顧客名です。
    number string 顧客に付与できる任意の顧客番号です。自動で付与される顧客IDとは別に、売り手様が独自に管理する識別子を登録することができます。ただし、売り手様の管理される顧客間で一意でなければなりません。
    object string このObjectの種別を示します。ここでは必ずcustomerが入ります。
  • customer
  • payment_method PaymentMethod 顧客の支払方法です。口座振替(AccountTransfer)もしくは銀行振込(BankTransfer)のいずれかです。顧客の支払方法に応じたObjectが返却されます。 デフォルトでは銀行振込になっています。ただし、初回請求前には振込先口座が指定されていない場合があります。 口座振替に変更する場合には別途書面でのお手続きが必要であるため、サポートセンターへお問い合わせください。
    uri string 顧客URIです。すべてのリソースで一意の識別子として自動で付与されます。

    CustomerPayload

    {
      "destination": {
        "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"
      },
      "customer_examination": {
        "amount": 20000,
        "business_description": "クラウド型企業間決済サービス",
        "business_type": "corporate",
        "corporate_number": "1234567890123",
        "remark": "一部上場企業です。",
        "representative_name": "代表太郎",
        "website": "https://mfkessai.co.jp"
      },
      "name": "サンプル顧客",
      "number": "CUSTOMER0001"
    }
    
    

    顧客登録情報です。顧客登録時に利用します。顧客には必ず一つの請求先が必要であるため同時に請求先一件も登録します。

    Property

    項目名 説明
    destination required object 請求先情報です。
    » address1 required Address1 都道府県・市区町村・番地です。必ず都道府県名から始めてください。
    » address2 Address2 建物名・部屋番号などです。
    » cc_emails [Email] 請求書をメール送付する際のCCメールアドレスです。最大で4つまで指定できます。
    » department string 担当者の部署名です。
    » email required Email メールアドレスです。email形式で指定してください。
    » name string 担当者氏名です。
    » name_kana string 担当者名カナです。全角カタカナで入力してください。
    » tel required Tel 電話番号です。ハイフン有無は任意になります。
    » title string 担当者の役職です。
    » zip_code required ZipCode 郵便番号です。ハイフン有無は任意になります。
    customer_examination object 顧客審査申請情報です。顧客審査申請で利用します
    » amount integer 希望与信額です。審査通過の場合に付与される与信枠の金額になります。現在与信枠が適用中の場合は、その与信額以下の金額は指定できません。0円を指定した場合は無視されます。
    » business_description string 事業内容です。顧客の主なサービス、商材などを記載してください。
    » business_type string 事業所区分です。法人(corporate)または、個人(individual)で指定してください。不明な場合は空にしてください。
    値は以下のうちの一つになります。
    • corporate
    • individual
    » corporate_number string 法人番号です。事業所区分(business_type)が法人(corporate)の場合にのみ指定してください。
    » remark string 顧客審査に利用できるその他情報を記載できます。
    » representative_name string 代表者氏名です。
    » website string 顧客企業のwebサイトです。
    name required string 顧客名です。
    number required string 顧客に付与できる任意の顧客番号です。MF KESSAIが発番する顧客IDをとは別で、売り手様が独自に管理する識別子を登録することができます。 ただし、売り手様の所有する顧客間で一意である必要があります。

    PaymentMethod

    {
      "account_transfer": {
        "object": "account_transfer"
      },
      "bank_transfer": {
        "account_number": "12345678",
        "bank_name": "MFKESSSAI銀行",
        "branch_name": "大手町支店",
        "object": "bank_transfer",
        "type": "current",
        "holder_name": "エムエフケツサイ(カ"
      },
      "object": "payment_method"
    }
    
    

    顧客の支払方法です。口座振替(AccountTransfer)もしくは銀行振込(BankTransfer)のいずれかです。顧客の支払方法に応じたObjectが返却されます。 デフォルトでは銀行振込になっています。ただし、初回請求前には振込先口座が指定されていない場合があります。 口座振替に変更する場合には別途書面でのお手続きが必要であるため、サポートセンターへお問い合わせください。

    Property

    項目名 説明
    account_transfer AccountTransfer 口座振替に関する情報です。お支払方法が口座振替の顧客のみ利用できます。
    bank_transfer BankTransfer 銀行振込に関する情報です。お支払方法が銀行振込の顧客のみ利用できます。 初回請求前は振込先口座が未割当のため、object以外は空で返却されます。
    object string このObjectの種別を示します。ここでは必ずpayment_methodが入ります。
  • payment_method
  • AccountTransfer

    {
      "object": "account_transfer"
    }
    
    

    口座振替に関する情報です。お支払方法が口座振替の顧客のみ利用できます。

    Property

    項目名 説明
    object string このObjectの種別を示します。ここでは必ずaccount_transferが入ります。
  • account_transfer
  • BankTransfer

    {
      "account_number": "12345678",
      "bank_name": "MFKESSSAI銀行",
      "branch_name": "大手町支店",
      "object": "bank_transfer",
      "type": "current",
      "holder_name": "エムエフケツサイ(カ"
    }
    
    

    銀行振込に関する情報です。お支払方法が銀行振込の顧客のみ利用できます。 初回請求前は振込先口座が未割当のため、object以外は空で返却されます。

    Property

    項目名 説明
    account_number string 振込先口座番号です。未割当の場合は空で返却されます。
    bank_name string 振込先銀行名です。未割当の場合は空で返却されます。
    branch_name string 振込先銀行支店名です。未割当の場合は空で返却されます。
    object string このObjectの種別を示します。ここでは必ずbank_transferが入ります。
  • bank_transfer
  • type string 振込先口座種別です。current(当座)、saving(普通)の2種類のうちどちらかが指定されます。未割当の場合は空で返却されます。
    値は以下のうちの一つになります。
    • current
    • saving
    holder_name string 振込先口座名義です。必ずエムエフケツサイ(カになります。未割当の場合は空で返却されます。

    Destination

    {
      "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"
    }
    
    

    請求先です。一つの顧客に対して複数作成することができます。請求先の情報を利用して請求書送付を行います。

    Property

    項目名 説明
    address1 Address1 都道府県・市区町村・番地です。必ず都道府県名から始めてください。
    address2 Address2 建物名・部屋番号などです。
    cc_emails [Email] CCメールアドレスです。最大4件まで登録できます。
    created_at string(date-time) 請求先が登録された日時を示します。
    customer_id string 顧客IDです。一意の識別子として自動で付与されます。
    department string 担当者の部署名です。
    email Email メールアドレスです。email形式で指定してください。
    id string 請求先IDです。一意の識別子として自動で付与されます。
    name string 担当者名です。
    name_kana string 担当者名カナです。全角カタカナで入力してください。
    object string このObjectの種別を示します。ここでは必ずdestinationが入ります。
  • destination
  • tel Tel 電話番号です。ハイフン有無は任意になります。
    title string 担当者の役職です。
    uri string 請求先URIです。すべてのリソースで一意の識別子として自動で付与されます。
    zip_code ZipCode 郵便番号です。ハイフン有無は任意になります。

    DestinationPayload

    {
      "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"
    }
    
    

    請求先登録情報です。請求先登録時に利用します。一つの顧客に対して複数の請求先を登録できます。

    Property

    項目名 説明
    address1 required Address1 都道府県・市区町村・番地です。必ず都道府県名から始めてください。
    address2 Address2 建物名・部屋番号などです。
    cc_emails [Email] 請求書をメール送付する際のCCメールアドレスです。最大で4件まで指定できます。
    customer_id required string 請求先を登録する顧客のIDです。
    department string 担当者の部署名です。
    email required Email メールアドレスです。email形式で指定してください。
    name string 担当者氏名です。
    name_kana string 担当者名カナです。全角カタカナで入力してください。
    tel required Tel 電話番号です。ハイフン有無は任意になります。
    title string 担当者の役職です。
    zip_code required ZipCode 郵便番号です。ハイフン有無は任意になります。

    CustomerExamination

    {
      "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": "kesai.tanto@example.jp",
      "end_date": "2019-04-30",
      "id": "WNAV-37R6",
      "remark": "一部上場企業です。",
      "representative_name": "代表太郎",
      "start_date": "2019-04-01",
      "statue": "passed",
      "tel": "03-1234-5678",
      "uri": "mfk:customer_examination:WNAV-37R6",
      "website": "https://mfkessai.co.jp",
      "zip_code": "111-1111"
    }
    
    

    顧客審査です。顧客に対する与信枠取得のために利用します。申請後2営業日以内に審査いたします。自動顧客審査を利用している場合は顧客登録と同時に顧客審査も申請されます。

    Property

    項目名 説明
    address1 Address1 都道府県・市区町村・番地です。必ず都道府県名から始めてください。
    address2 Address2 建物名・部屋番号などです。
    amount integer 希望与信額です。審査通過の場合に付与される与信枠の金額になります。
    business_description string 事業内容です。顧客の主なサービス、商材などです。
    business_type string 事業所区分です。法人(corporate)または、個人(individual)で指定されます。不明な場合は空になります。
    値は以下のうちの一つになります。
    • corporate
    • individual
    corporate_number string 法人番号です。事業所区分(business_type)が法人(corporate)の場合にのみ指定されます。
    created_at string(date-time) 顧客審査の申請日時です。
    customer_id string 顧客IDです。一意の識別子として自動で付与されます。
    email Email メールアドレスです。email形式で指定してください。
    end_date string(date) 希望取引登録期間終了日です。この日付まで対象の与信枠を利用して取引登録ができます。
    id string 顧客審査IDです。一意の識別子として自動で付与されます。
    remark string その他情報です。審査に利用できる情報を記載できます。
    representative_name string 代表者名です。
    start_date string(date) 希望取引登録期間開始日。この日付から対象の与信枠を利用して取引登録ができます。 手動での申請の場合、審査通過日となるため空で返却されます。自動顧客審査による申請の場合は、月次での与信枠付与になり対象月の月初日となります。
    status string 顧客審査ステータスです。審査中(unexamined)、審査通過(passed)、審査否決(rejected)があります。審査通過の場合には与信枠が付与されています。
    値は以下のうちの一つになります。
    • unexamined
    • passed
    • rejected
    tel Tel 電話番号です。ハイフン有無は任意になります。
    object string このObjectの種別を示します。ここでは必ずcustomer_examinationが入ります。
  • customer_examination
  • uri string 顧客審査URIです。すべてのリソースで一意の識別子として自動で付与されます。
    website string 顧客企業のwebサイトです。
    zip_code ZipCode 郵便番号です。ハイフン有無は任意になります。

    CustomerExaminationPayload

    {
      "address1": "東京都千代田区1-2-3",
      "address2": "サンプルビル3F",
      "amount": 20000,
      "business_description": "クラウド型企業間決済サービス",
      "business_type": "corporate",
      "corporate_number": "1234567890123",
      "customer_id": "7679-YW36",
      "email": "kesai.tanto@example.jp",
      "end_date": "2019-04-30",
      "remark": "一部上場企業です。",
      "representative_name": "代表太郎",
      "tel": "03-1234-5678",
      "website": "https://mfkessai.co.jp",
      "zip_code": "111-1111"
    }
    
    

    顧客審査申請情報です。顧客審査申請で利用します。

    Property

    項目名 説明
    address1 required Address1 都道府県・市区町村・番地です。必ず都道府県名から始めてください。
    address2 Address2 建物名・部屋番号などです。
    amount required integer 希望与信額です。審査通過の場合に付与される与信枠の金額になります。現在与信枠が適用中の場合は、その与信額以下の金額は指定できません。
    business_description string 事業内容です。顧客の主なサービス、商材などを記載してください。
    business_type string 事業所区分です。法人(corporate)または、個人(individual)で指定してください。不明な場合は空にしてください。
    値は以下のうちの一つになります。
    • corporate
    • individual
    corporate_number string 法人番号です。事業所区分(business_type)が法人(corporate)の場合にのみ指定してください。
    customer_id required string 顧客審査を申請する顧客のIDです。
    email required Email メールアドレスです。email形式で指定してください。
    end_date required string(date) 希望取引登録期間終了日です。この日付まで対象の与信枠を利用して取引登録ができます。 直近三ヶ月の月末のみ指定できます。ただし当月残りの営業日数が審査に要する2日を下回っている場合は、当月末は指定できません。
    remark string 顧客審査に利用できるその他情報を記載できます。
    representative_name string 代表者氏名です。
    tel required Tel 電話番号です。ハイフン有無は任意になります。
    website string 顧客企業のwebサイトです。
    zip_code required ZipCode 郵便番号です。ハイフン有無は任意になります。

    CreditFacility

    {
      "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"
    }
    
    

    顧客の与信枠です。この枠内の取引登録であれば取引審査なしで登録することができます。

    Property

    項目名 説明
    amount integer 与信額です。取引登録期間(start_date~end_date)にこの金額までの取引であれば取引審査なしで登録することができます。
    balance integer 与信額残高です。与信額からこの与信枠を利用して登録された取引の合計金額を差し引いた金額です。現在与信枠を利用して登録できる取引金額を示しています。
    customer_id string 顧客IDです。一意の識別子として自動で付与されます。
    customer_examination_id string 顧客審査IDです。
    end_date string(date) 取引登録期間終了日です。この日付まで対象の与信枠を利用して取引登録ができます。
    id string 与信枠IDです。一意の識別子として自動で付与されます。
    object string このObjectの種別を示します。ここでは必ずcredit_facilityが入ります。
  • credit_facility
  • start_date string(date) 取引登録期間開始日です。この日付から対象の与信枠を利用して取引登録ができます。
    status string 与信枠ステータスです。未適用(inactive)、適用中(active)、期限切れ(expired)があります。 現在の日付がstart_date~end_dateの期間内であればactivestart_dateよりも前であればinactiveend_dateを過ぎていればexpiredになります。
    値は以下のうちの一つになります。
    • inactive
    • active
    • expired
    uri string 与信枠URIです。すべてのリソースで一意の識別子として自動で付与されます。

    Transaction

    {
      "amount": 5440,
      "amounts_per_tax_rate_type": [
        {
          "amount": 2200,
          "tax_rate_type": "10"
        },
        {
          "amount": 3240,
          "tax_rate_type": "reduced_8"
        }
      ],
      "billing_id": "9R6M-VMAN",
      "canceled_at": "2019-04-22T10:36:43+09:00",
      "created_at": "2019-04-01T10:36:43+09:00",
      "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",
          "tax_included_type": "excluded",
          "tax_rate_type": "10",
          "quantity": 3,
          "unit_price": 1000
        },
        {
          "amount": 3000,
          "description": "商品名B",
          "tax_included_type": "excluded",
          "tax_rate_type": "reduced_8",
          "quantity": 3,
          "unit_price": 1000
        },
        {
          "amount": -1000,
          "description": "商品名A 返品",
          "tax_included_type": "excluded",
          "tax_rate_type": "10",
          "quantity": -1,
          "unit_price": 1000
        }
      ],
      "uri": "mfk:transaction:7679-YW36"
    }
    
    

    取引です。

    Property

    項目名 説明
    amount integer 取引の合計金額です。税込金額になります。
    amounts_per_tax_rate_type [AmountPerTaxRateType] 各税率種別毎の税込の合計金額です。各税率種別の取引明細行の小計を合計した値に各税率を乗じた値になっています。
    billing_id string 請求IDです。請求書にまとめられる単位のIDです。同じ請求IDを持つ取引とまとめられて請求書に記載されます。
    canceled_at string(date-time)¦null 取引がキャンセルされた日時です。未キャンセルの場合は空になります。
    created_at string(date-time) 取引が登録された日時です。
    destination_id string 請求先IDです。取引の請求先を示します。
    date string(date) 取引日です。売り手様と顧客様の間で取引を行った日付です。
    due_date string(date) 支払期限日です。この日付を超えてMF KESSAIへの入金が確認できない場合は未入金になります。
    id string 取引IDです。一意の識別子として自動で付与されます。
    invoice_delivery_methods [InvoiceDeliveryMethod] 請求書送付方法です。郵送(posting) またはメール送付(email)のうちから少なくとも1つを指定してください。どちらも選択された場合、どちらの方法でも送付されます。 また、各取引で指定しなかった送付方法でも、請求にまとまった取引のうちでその送付方法を選択しているものがあれば、そちらの送付方法も採用されます。
    issue_date string(date) 請求書発行日です。請求書が発行される日付を指定します。指定した日付が営業日でない場合は翌営業日になります。 また、請求書発送日については請求書発行日についてを参照ください。
    number string 取引に付与できる任意の取引番号です。MF KESSAIが自動で付与する取引IDとは別で、売り手様が独自に管理する識別子を登録することができます。ただし、売り手様の所有する取引間で一意である必要があります。
    object string このObjectの種別を示します。ここでは必ずtransactionが入ります。
  • transaction
  • status string 取引ステータスです。審査中(unexamined)、審査通過(passed)、審査否決(rejected)、キャンセル済(canceled)があります。
    値は以下のうちの一つになります。
    • unexamined
    • passed
    • rejected
    • canceled
    transaction_details [TransactionDetail] 取引明細行です。
    uri string 取引URIです。すべてのリソースで一意の識別子として自動で付与されます。

    TransactionDetail

    {
      "amount": 3000,
      "description": "商品名A",
      "tax_rate_type": "10",
      "quantity": 3,
      "unit_price": 1000
    }
    
    

    取引明細です。請求書に記載される明細行になります。

    Property

    項目名 説明
    amount number 小計です。単価(unit_price)×数量(quantity)の金額です。
    description string 商品名などです。
    object string このObjectの種別を示します。ここでは必ずtransaction_detailが入ります。
  • transaction_detail
  • tax_rate_type TaxRateType 税率種別です。非課税(non_taxable)、消費税8%(8)、消費税10%(10)、軽減税率8%(reduced_8)、経過措置8%(transitional_measures_8)、対象外(inapplicable)のうちいずれかを指定してください。 返り値で空の場合は登録時に指定されなかったことを表します。
    unit_price number 単価です。
    quantity number 数量です。
    tax_included_type TaxIncludedType 取引明細の単価(unit_price), 小計(amount)の値が税込(included)か税抜(excluded)かを示します。空の場合は登録時に指定がなかったことを表します。

    TransactionPayload

    {
      "amount": 5440,
      "amounts_per_tax_rate_type": [
        {
          "amount": 2200,
          "tax_rate_type": "10"
        },
        {
          "amount": 3240,
          "tax_rate_type": "reduced_8"
        }
      ],
      "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",
          "tax_included_type": "excluded",
          "tax_rate_type": "10",
          "quantity": 3,
          "unit_price": 1000
        },
        {
          "amount": 3000,
          "description": "商品名B",
          "tax_included_type": "excluded",
          "tax_rate_type": "reduced_8",
          "quantity": 3,
          "unit_price": 1000
        },
        {
          "amount": -1000,
          "description": "商品名A 返品",
          "tax_included_type": "excluded",
          "tax_rate_type": "10",
          "quantity": 1,
          "unit_price": -1000
        }
      ]
    }
    
    

    取引登録情報です。取引登録で利用します。

    Property

    項目名 説明
    amount required integer 取引の税込合計金額です。取引明細(transaction_details)の小計の合計額である必要があります。また、負の値を指定することはできません。
    amounts_per_tax_rate_type required [AmountPerTaxRateType] 各課税種別毎の税込の合計金額です。各課税種別の取引明細行の小計を合計した値になっていなければなりません。
    date required string(date) 取引日です。売り手様と顧客の間で取引を行った日付を指定してください。
    destination_id required string 請求先IDです。取引の請求先を指定してください。
    due_date required string(date) 支払期限日です。
    invoice_delivery_methods required [InvoiceDeliveryMethod] 請求書送付方法です。郵送(posting) またはメール送付(email)のうちから少なくとも1つを指定してください。どちらも選択された場合、どちらの方法でも送付されます。 また、各取引で指定しなかった送付方法でも、請求にまとまった取引のうちでその送付方法を選択しているものがあれば、そちらの送付方法も採用されます。
    issue_date required string(date) 請求書発行日です。請求書が発行される日付を指定します。指定した日付が営業日でない場合は翌営業日になります。また、請求書送付日についてはこちらを参照ください。
    number required string 取引に付与できる任意の取引番号です。MF KESSAIが自動で付与する取引IDとは別で、売り手様が独自に管理する識別子を登録することができます。ただし、売り手様の所有する取引間で一意である必要があります。
    transaction_details required [TransactionDetailPayload] 取引明細行です。

    TransactionDetailPayload

    {
      "amount": 3000,
      "description": "商品名A",
      "tax_included_type": "excluded",
      "tax_rate_type": "10",
      "quantity": 3,
      "unit_price": 1000
    }
    
    

    Property

    項目名 説明
    amount required number 小計です。単価(unit_price)×数量(quantity)の金額を指定してください。
    description required string 商品名などです。
    tax_included_type required TaxIncludedType 取引明細の単価(unit_price), 小計(amount)の値が税込(included)か税抜(excluded)かを示します。空の場合は登録時に指定がなかったことを表します。
    tax_rate_type required TaxRateType 税率種別です。非課税(non_taxable)、消費税8%(8)、消費税10%(10)、軽減税率8%(reduced_8)、経過措置8%(transitional_measures_8)、対象外(inapplicable)のうちいずれかを指定してください。 返り値で空の場合は登録時に指定されなかったことを表します。
    quantity required number 数量を指定してください。
    unit_price required number 単価を指定してください。

    Billing

    {
      "amount": 21800,
      "amounts_per_tax_rate_type": [
        {
          "amount": 11000,
          "tax_rate_type": "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"
      ],
      "issue_date": "2019-04-01",
      "object": "billing",
      "status": "scheduled",
      "unpaid": {
        "shortage_amount": 12000,
        "updated_date": "2019-04-30"
      },
      "uri": "mfk:billing:9R6M-VMAN"
    }
    
    

    請求です。取引のうち、請求先・支払期限日・請求書発行日・取引登録方式が同一の取引が同じ請求にまとめられます。

    Property

    項目名 説明
    amount integer 請求の税込の合計金額です。請求に含まれる取引金額の合計です。
    amounts_per_tax_rate_type [AmountPerTaxRateType] 各税率種別毎の税込の合計金額です。各税率種別の取引金額を合計した値に各税率を乗じた値になっています。
    customer_id string 顧客IDです。請求の顧客を示します。
    destination_id string 請求先IDです。請求先を示します。
    due_date string(date) 支払期限日です。
    id string 請求IDです。一意の識別子として自動で付与されます。請求先ID・支払期限日・請求書発行日・取引登録方式が同一の取引がこの請求によってまとめられます。請求書は請求をもとに発行されます。
    invoice_delivery_methods [InvoiceDeliveryMethod] 請求書送付方法です。郵送(posting) またはメール送付(email)のうちから少なくとも1つを指定してください。どちらも選択された場合、どちらの方法でも送付されます。 また、各取引で指定しなかった送付方法でも、請求にまとまった取引のうちでその送付方法を選択しているものがあれば、そちらの送付方法も採用されます。
    issue_date string(date) 請求書発行日です。請求書が発行される日付を指定します。指定した日付が営業日でない場合は翌営業日になります。また、請求書送付日についてはこちらをご参照ください。
    object string このObjectの種別を示します。ここでは必ずbillingが入ります。
  • billing
  • status string 請求ステータスです。請求予定(scheduled)、請求書発行済(invoice_issued) 、口座振替通知済(account_transfer_notified)で指定されます。
    値は以下のうちの一つになります。
    • scheduled
    • invoice_issued
    • account_transfer_notified
    unpaid object 未入金情報です。請求に対して未入金がある場合のみ返却されます。
    » shortage_amount integer 未入金額です。
    » updated_date string(date) 入金情報が最後に更新された日付です。この日付移行に入金されている可能性があります。
    uri string 請求URIです。すべてのリソースで一意の識別子として自動で付与されます。

    Address1

    "東京都千代田区1-2-3"
    
    

    都道府県・市区町村・番地です。必ず都道府県名から始めてください。

    Property

    項目名 説明
    - string 都道府県・市区町村・番地です。必ず都道府県名から始めてください。

    Address2

    "サンプルビル3F"
    
    

    建物名・部屋番号などです。

    Property

    項目名 説明
    - string 建物名・部屋番号などです。

    Tel

    "03-1234-5678"
    
    

    電話番号です。ハイフン有無は任意になります。

    Property

    項目名 説明
    - string 電話番号です。ハイフン有無は任意になります。

    ZipCode

    "111-1111"
    
    

    郵便番号です。ハイフン有無は任意になります。

    Property

    項目名 説明
    - string 郵便番号です。ハイフン有無は任意になります。

    Email

    "kessai.tanto@example.jp"
    
    

    メールアドレスです。email形式で指定してください。

    Property

    項目名 説明
    - string(email) メールアドレスです。email形式で指定してください。

    InvoiceDeliveryMethod

    "posting"
    
    

    請求書送付方法です。郵送(posting) またはメール送付(email)のいずれかを指定してください。

    Property

    項目名 説明
    - string 請求書送付方法です。郵送(posting) またはメール送付(email)のいずれかを指定してください。
    値は以下のうちの一つになります。
    • posting
    • email

    TaxRateType

    "10"
    
    

    税率種別です。非課税(non_taxable)、消費税8%(8)、消費税10%(10)、軽減税率8%(reduced_8)、経過措置8%(transitional_measures_8)、対象外(inapplicable)のうちいずれかを指定してください。 返り値で空の場合は登録時に指定されなかったことを表します。

    Property

    項目名 説明
    - string 税率種別です。非課税(non_taxable)、消費税8%(8)、消費税10%(10)、軽減税率8%(reduced_8)、経過措置8%(transitional_measures_8)、対象外(inapplicable)のうちいずれかを指定してください。 返り値で空の場合は登録時に指定されなかったことを表します。
    値は以下のうちの一つになります。
    • non_taxable
    • normal_8
    • normal_10
    • reduced_8
    • transitional_measures_8
    • inapplicable

    AmountPerTaxRateType

    {
      "amount": 11000,
      "tax_rate_type": "10"
    }
    
    

    各税率種別毎の税込の合計金額です。

    Property

    項目名 説明
    amount required integer 対象税率種別毎の合計金額です。税込金額になります。
    tax_rate_type required TaxRateType 税率種別です。非課税(non_taxable)、消費税8%(8)、消費税10%(10)、軽減税率8%(reduced_8)、経過措置8%(transitional_measures_8)、対象外(inapplicable)のうちいずれかを指定してください。 返り値で空の場合は登録時に指定されなかったことを表します。

    TaxIncludedType

    "included"
    
    

    取引明細の単価(unit_price), 小計(amount)の値が税込(included)か税抜(excluded)かを示します。空の場合は登録時に指定がなかったことを表します。

    Property

    項目名 説明
    - string 取引明細の単価(unit_price), 小計(amount)の値が税込(included)か税抜(excluded)かを示します。空の場合は登録時に指定がなかったことを表します。
    値は以下のうちの一つになります。
    • included
    • excluded

    Payout

    {
      "amount": 100800,
      "receivables_amount": 110000,
      "deduction": {
        "amount": 9200,
        "returned_credit_amount": 500,
        "tax_free": {
          "amount": 3200,
          "commission_amount": 2200,
          "early_payout_commission_amount": 1000
        },
        "taxable": {
          "amount": 5000,
          "basic_monthly_charge": 4500,
          "posting": {
            "amount": 500,
            "unit_price": 100,
            "quantity": 5
          }
        },
        "tax": {
          "rate_type": "10",
          "amount": 500
        }
      },
      "id": "7679-YW36",
      "payout_date": "2019-07-29",
      "status": "completed",
      "type": "normal",
      "uri": "mfk:payout:7679-YW36"
    }
    
    

    MFKESSAIから売り手様への金額確定済みの振込です。

    Property

    項目名 説明
    amount integer 振込金額です。
    receivables_amount integer 振込の対象となる債権金額です。
    deduction Deduction 振込から控除される金額とその内訳です。
    id string 振込IDです。一意の識別子として自動で付与されます。
    object string このObjectの種別を示します。ここでは必ずpayoutが入ります。
  • payout
  • payout_date string(date) 振込予定日です。
    status string 振込ステータスです。振込手続中(in_progress)、振込完了(completed)があります。
    値は以下のうちの一つになります。
    • in_progress
    • completed
    type string 振込種別です。通常振込(normal)、早期振込(early)があります。
    値は以下のうちの一つになります。
    • normal
    • early
    uri string 振込URIです。すべてのリソースで一意の識別子として自動で付与されます。

    Deduction

    {
      "amount": 10000,
      "returned_credit_amount": 500,
      "tax": {
        "rate_type": "10",
        "amount": 500
      },
      "taxable": {
        "amount": 5000,
        "basic_monthly_charge": 4500,
        "posting": {
          "amount": 500,
          "unit_price": 100,
          "quantity": 5
        }
      },
      "tax_free": {
        "amount": 4000,
        "commission_amout": 3000,
        "early_payout_commission_amount": 1000
      }
    }
    
    

    振込から控除される金額とその内訳です。

    Property

    項目名 説明
    amount integer 債権合計額から控除される合計金額です。
    returned_credit_amount integer 売り手様へのの振込後に発生したキャンセルに伴う返金額です。
    tax object 消費税です。
    » amount integer 消費税額です。
    » rate_type TaxRateType 税率種別です。非課税(non_taxable)、消費税8%(8)、消費税10%(10)、軽減税率8%(reduced_8)、経過措置8%(transitional_measures_8)、対象外(inapplicable)のうちいずれかを指定してください。 返り値で空の場合は登録時に指定されなかったことを表します。
    taxable object 課税対象の控除金額とその内訳です。郵送料と月額基本料が課税対象となります。
    » amount integer 課税対象の控除金額です。
    » basic_monthly_charge integer 月額基本料金です。
    » posting object 郵送料金とその内訳です。
    »» amount integer 郵送料です。
    »» quantity integer 郵送件数です。
    »» unit_price integer 郵送1件あたりの郵送料です。
    » tax_free object 非課税の控除金額とその内訳です。手数料と早期振込手数料が非課税となります。
    »» amount integer 非課税の控除金額です。
    »» commission_amount integer 手数料の金額です。
    »» early_payout_commission_amount integer 早期振込手数料の金額です。

    PayoutTransaction

    {
      "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"
    }
    
    

    売り手様へ振込に紐づく債権です。

    Property

    項目名 説明
    accepted_at string(date-time) 債権譲受日時です。
    amount integer 債権金額です。
    commission_amount integer 手数料の金額です。
    commission_rate number 手数料率です。
    early_payout_commission_amount integer 早期振込手数料です。
    early_payout_commission_rate number 早期振込手数料率です。
    id string 債権IDです。一意の識別子として自動で付与されます。
    object string このObjectの種別を示します。ここでは必ずpayout_transactionが入ります。
  • payout_transaction
  • payout_date string(date) 振込予定日です。早期振込の場合、standard_payout_dateよりも早くなります。
    payout_id string 債権が含まれる振込のIDです。
    standard_payout_date string(date) 通常の振込予定日です。
    transaction_id string 取引IDです。この債権が紐づく取引を示します。
    uri string 債権URIです。すべてのリソースで一意の識別子として自動で付与されます。

    CustomersList

    {
      "items": [
        {
          "created_at": "2019-04-01T10:36:43+09:00",
          "has_alert": false,
          "id": "7679-YW36",
          "name": "サンプル顧客",
          "number": "CUSTOEMR001",
          "object": "customer",
          "payment_method": {
            "bank_transfer": {
              "object": "bank_transfer",
              "account_number": "123456789",
              "bank_name": "MEKESSAI銀行",
              "branch_name": "大手町支店",
              "holder_name": "エムエフケツサイ(カ",
              "type": "current"
            },
            "object": "payment_method"
          },
          "uri": "mfk:customer:7679-YW36"
        }
      ],
      "object": "list",
      "pagination": {
        "end": "7679-YW36",
        "has_next": true,
        "has_previous": false,
        "limit": 20,
        "start": "9R6M-VMAN",
        "total": 143
      }
    }
    
    

    Property

    項目名 説明
    items [Customer] 条件に該当する顧客の一覧です。
    object string このObjectの種別を示します。ここでは必ず listが設定されます。
  • list
  • pagination Pagination ページネーション情報です。各Objectの一覧取得の際にリストとともに返却されます。この情報をもとにページ繰りを行うことができます。

    DestinationsList

    {
      "items": [
        {
          "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"
        }
      ],
      "object": "list",
      "pagination": {
        "end": "7679-YW36",
        "has_next": true,
        "has_previous": false,
        "limit": 20,
        "start": "9R6M-VMAN",
        "total": 143
      }
    }
    
    

    Property

    項目名 説明
    items [Destination] 請求先一覧です。
    object string このObjectの種別を示します。ここでは必ず listが設定されます。
  • list
  • pagination Pagination ページネーション情報です。各Objectの一覧取得の際にリストとともに返却されます。この情報をもとにページ繰りを行うことができます。

    CustomerExaminationsList

    {
      "items": [
        {
          "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": "kesai.tanto@example.jp",
          "end_date": "2019-04-30",
          "id": "WNAV-37R6",
          "remark": "一部上場企業です。",
          "representative_name": "代表太郎",
          "start_date": "2019-04-01",
          "statue": "passed",
          "tel": "03-1234-5678",
          "uri": "mfk:customer_examination:WNAV-37R6",
          "website": "https://mfkessai.co.jp",
          "zip_code": "111-1111"
        }
      ],
      "object": "list",
      "pagination": {
        "end": "7679-YW36",
        "has_next": true,
        "has_previous": false,
        "limit": 20,
        "start": "9R6M-VMAN",
        "total": 143
      }
    }
    
    

    Property

    項目名 説明
    items [CustomerExamination] 顧客審査一覧です。
    object string このObjectの種別を示します。ここでは必ず listが設定されます。
  • list
  • pagination Pagination ページネーション情報です。各Objectの一覧取得の際にリストとともに返却されます。この情報をもとにページ繰りを行うことができます。

    CreditFacilitiesList

    {
      "items": [
        {
          "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"
        }
      ],
      "object": "list",
      "pagination": {
        "end": "7679-YW36",
        "has_next": true,
        "has_previous": false,
        "limit": 20,
        "start": "9R6M-VMAN",
        "total": 143
      }
    }
    
    

    Property

    項目名 説明
    items [CreditFacility] 与信枠一覧です。
    object string このObjectの種別を示します。ここでは必ず listが設定されます。
  • list
  • pagination Pagination ページネーション情報です。各Objectの一覧取得の際にリストとともに返却されます。この情報をもとにページ繰りを行うことができます。

    TransactionsList

    {
      "items": [
        {
          "amount": 5440,
          "amounts_per_tax_rate_type": [
            {
              "amount": 2200,
              "tax_rate_type": "10"
            },
            {
              "amount": 3240,
              "tax_rate_type": "reduced_8"
            }
          ],
          "billing_id": "9R6M-VMAN",
          "canceled_at": "2019-04-22T10:36:43+09:00",
          "created_at": "2019-04-01T10:36:43+09:00",
          "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",
              "tax_included_type": "excluded",
              "tax_rate_type": "10",
              "quantity": 3,
              "unit_price": 1000
            },
            {
              "amount": 3000,
              "description": "商品名B",
              "tax_included_type": "excluded",
              "tax_rate_type": "reduced_8",
              "quantity": 3,
              "unit_price": 1000
            },
            {
              "amount": -1000,
              "description": "商品名A 返品",
              "tax_included_type": "excluded",
              "tax_rate_type": "10",
              "quantity": -1,
              "unit_price": 1000
            }
          ],
          "uri": "mfk:transaction:7679-YW36"
        }
      ],
      "object": "list",
      "pagination": {
        "end": "7679-YW36",
        "has_next": true,
        "has_previous": false,
        "limit": 20,
        "start": "9R6M-VMAN",
        "total": 143
      }
    }
    
    

    Property

    項目名 説明
    items [Transaction] 取引一覧です。
    object string このObjectの種別を示します。ここでは必ず listが設定されます。
  • list
  • pagination Pagination ページネーション情報です。各Objectの一覧取得の際にリストとともに返却されます。この情報をもとにページ繰りを行うことができます。

    BillingsList

    {
      "items": [
        {
          "amount": 21800,
          "amounts_per_tax_rate_type": [
            {
              "amount": 11000,
              "tax_rate_type": "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"
          ],
          "issue_date": "2019-04-01",
          "object": "billing",
          "status": "scheduled",
          "unpaid": {
            "shortage_amount": 12000,
            "updated_date": "2019-04-30"
          },
          "uri": "mfk:billing:9R6M-VMAN"
        }
      ],
      "object": "list",
      "pagination": {
        "end": "7679-YW36",
        "has_next": true,
        "has_previous": false,
        "limit": 20,
        "start": "9R6M-VMAN",
        "total": 143
      }
    }
    
    

    Property

    項目名 説明
    items [Billing] 請求一覧です。
    object string このObjectの種別を示します。ここでは必ず listが設定されます。
  • list
  • pagination Pagination ページネーション情報です。各Objectの一覧取得の際にリストとともに返却されます。この情報をもとにページ繰りを行うことができます。

    PayoutsList

    {
      "items": [
        {
          "amount": 100800,
          "receivables_amount": 110000,
          "deduction": {
            "amount": 9200,
            "returned_credit_amount": 500,
            "tax_free": {
              "amount": 3200,
              "commission_amount": 2200,
              "early_payout_commission_amount": 1000
            },
            "taxable": {
              "amount": 5000,
              "basic_monthly_charge": 4500,
              "posting": {
                "amount": 500,
                "unit_price": 100,
                "quantity": 5
              }
            },
            "tax": {
              "rate_type": "10",
              "amount": 500
            }
          },
          "id": "7679-YW36",
          "payout_date": "2019-07-29",
          "status": "completed",
          "type": "normal",
          "uri": "mfk:payout:7679-YW36"
        }
      ],
      "object": "list",
      "pagination": {
        "end": "7679-YW36",
        "has_next": true,
        "has_previous": false,
        "limit": 20,
        "start": "9R6M-VMAN",
        "total": 143
      }
    }
    
    

    Property

    項目名 説明
    items [Payout] 振込一覧です。
    object string このObjectの種別を示します。ここでは必ず listが設定されます。
  • list
  • pagination Pagination ページネーション情報です。各Objectの一覧取得の際にリストとともに返却されます。この情報をもとにページ繰りを行うことができます。

    PayoutTransactionsList

    {
      "items": [
        {
          "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"
        }
      ],
      "object": "list",
      "pagination": {
        "end": "7679-YW36",
        "has_next": true,
        "has_previous": false,
        "limit": 20,
        "start": "9R6M-VMAN",
        "total": 143
      }
    }
    
    

    Property

    項目名 説明
    items [PayoutTransaction] 債権一覧です。
    object string このObjectの種別を示します。ここでは必ず listが設定されます。
  • list
  • pagination Pagination ページネーション情報です。各Objectの一覧取得の際にリストとともに返却されます。この情報をもとにページ繰りを行うことができます。

    CreateCustomerResponse

    {
      "customer": {
        "created_at": "2019-04-01T10:36:43+09:00",
        "has_alert": false,
        "id": "7679-YW36",
        "name": "サンプル顧客",
        "number": "CUSTOEMR001",
        "object": "customer",
        "payment_method": {
          "bank_transfer": {
            "object": "bank_transfer",
            "account_number": "123456789",
            "bank_name": "MEKESSAI銀行",
            "branch_name": "大手町支店",
            "holder_name": "エムエフケツサイ(カ",
            "type": "current"
          },
          "object": "payment_method"
        },
        "uri": "mfk:customer:7679-YW36"
      },
      "destination": {
        "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"
      }
    }
    
    

    Property

    項目名 説明
    customer Customer 顧客です。取引登録や与信枠取得などあらゆる機能を利用する起点となります。
    destination Destination 請求先です。一つの顧客に対して複数作成することができます。請求先の情報を利用して請求書送付を行います。