Back to top

API Documentation

ユーザ

ユーザログイン

ログインAPI
POST/v1/user/userLogin

処理概要

  • ログイン(Cognitoかも)

Example URI

POST /v1/user/userLogin
URI Parameters
HideShow
email
string (required) Example: toshiharu.tanaka@briswell.com

メールアドレス

password
string (required) Example: 12345678

パスワード

Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "status": "success",
  "message": "メールアドレス、パスワードが一致しません。"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "status": {
      "type": "string",
      "description": "APIステータス"
    },
    "message": {
      "type": "string",
      "description": "メッセージ"
    }
  },
  "required": [
    "status",
    "message"
  ]
}

ユーザ検索

ユーザ検索API
GET/v1/user/userSearch

処理概要

  • 指定した株価情報を返す。

  • start-dateとend-dateを指定した場合は、その期間の株価情報を返す。

  • frequencyで日足、週足、月足、四半期足、年足の株価を返す。

Example URI

GET /v1/user/userSearch
URI Parameters
HideShow
sort
string (required) Example: asc

並び順[asc or desc]

limit
number (optional) Example: 10

取得件数

Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "status": "success",
  "data_count": 3,
  "data": [
    {
      "id": 1,
      "name": "北海道"
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "status": {
      "type": "string",
      "description": "APIステータス"
    },
    "data_count": {
      "type": "number",
      "description": "取得件数"
    },
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "number",
            "description": "都道府県id"
          },
          "name": {
            "type": "string",
            "description": "都道府県名\n\nFORMAT: 1A"
          }
        },
        "required": [
          "id",
          "name"
        ]
      }
    }
  },
  "required": [
    "status",
    "data_count",
    "data"
  ]
}

顧客

顧客検索

顧客検索API
GET/v1/customer/customerSearch{?customerId}

処理概要

  • 受け取った検索条件の結果をN件返却する。

  • customerIdを受け取った場合、その他の条件は無視し、customerIdの顧客情報を1件返却する。

Example URI

GET /v1/customer/customerSearch?customerId=123
URI Parameters
HideShow
customerId
bigint (optional) Example: 123

顧客id

name
string (optional) Example: ブリスウェル

顧客名/ふりがな(2カラムを曖昧検索)

tel
string (optional) Example: 0364504848

電話番号(曖昧検索)

email
string (optional) Example: info@briswell.com

メールアドレス(曖昧検索)

sectionName
string (optional) Example: ソフトウェア開発部

担当部署名

staffName
string (optional) Example: 田中 敏晴

部署担当者

sort
string (optional) Example: asc

並び順[asc or desc](idでソート)

limit
number (optional) Example: 20

取得件数

offset
number (optional) Example: 2

page数

Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "status": "success",
  "dataCount": 2,
  "data": [
    {
      "customerId": 1,
      "name": "株式会社ブリスウェル",
      "kana": "ぶりすうぇる",
      "tel": "0364504848",
      "staffName": "田中 敏晴",
      "email": "toshiharu.tanaka@briswell.com",
      "zip": "150-0012",
      "address1": "東京都",
      "address2": "渋谷区広尾1-3-17 オーツービル4F",
      "sectionId": 123,
      "staffId": 123,
      "disableFlag": 0
    },
    {
      "customerId": 2,
      "name": "株式会社ABC",
      "kana": "えーびーしー",
      "tel": "0000000000",
      "staffName": "鈴木 太郎",
      "email": "xxx@xxx.com",
      "zip": "150-0012",
      "address1": "東京都",
      "address2": "渋谷区広尾1-3-17 オーツービル4F",
      "sectionId": 123,
      "staffId": 123,
      "disableFlag": 0
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "status": {
      "type": "string",
      "description": "APIステータス"
    },
    "dataCount": {
      "type": "number",
      "description": "取得件数"
    },
    "data": {
      "type": "array",
      "items": [
        {
          "type": "object",
          "properties": {
            "customerId": {
              "type": "number",
              "description": "顧客id"
            },
            "name": {
              "type": "string",
              "description": "顧客名"
            },
            "kana": {
              "type": "string",
              "description": "ふりがな"
            },
            "tel": {
              "type": "string",
              "description": "電話番号"
            },
            "staffName": {
              "type": "string",
              "description": "顧客担当者"
            },
            "email": {
              "type": "string",
              "description": "メールアドレス"
            },
            "zip": {
              "type": "string",
              "description": "郵便番号"
            },
            "address1": {
              "type": "string",
              "description": "都道府県"
            },
            "address2": {
              "type": "string",
              "description": "住所"
            },
            "sectionId": {
              "type": "number",
              "description": "担当部署id"
            },
            "staffId": {
              "type": "number",
              "description": "担当者id"
            },
            "disableFlag": {
              "type": "number",
              "description": "無効フラグ"
            }
          },
          "required": [
            "customerId",
            "name",
            "kana"
          ]
        },
        {
          "type": "object",
          "properties": {
            "customerId": {
              "type": "number",
              "description": "顧客id"
            },
            "name": {
              "type": "string",
              "description": "顧客名"
            },
            "kana": {
              "type": "string",
              "description": "ふりがな"
            },
            "tel": {
              "type": "string",
              "description": "電話番号"
            },
            "staffName": {
              "type": "string",
              "description": "顧客担当者"
            },
            "email": {
              "type": "string",
              "description": "メールアドレス"
            },
            "zip": {
              "type": "string",
              "description": "郵便番号"
            },
            "address1": {
              "type": "string",
              "description": "都道府県"
            },
            "address2": {
              "type": "string",
              "description": "住所"
            },
            "sectionId": {
              "type": "number",
              "description": "担当部署id"
            },
            "staffId": {
              "type": "number",
              "description": "担当者id"
            },
            "disableFlag": {
              "type": "number",
              "description": "無効フラグ"
            }
          },
          "required": [
            "customerId",
            "name",
            "kana"
          ]
        }
      ]
    }
  },
  "required": [
    "status",
    "dataCount",
    "data"
  ]
}

顧客情報保存

顧客情報保存API
POST/v1/customer/customerSave{?customerId}

処理概要

  • customerIdを指定している場合、指定customerIdレコードをUPDATEする。

  • customerIdを指定指定ない場合、新規レコードをINSERTする。

Example URI

POST /v1/customer/customerSave?customerId=123
URI Parameters
HideShow
customerId
bigint (optional) Example: 123

顧客id

name
string (required) Example: 株式会社ブリスウェル

顧客名

kana
string (required) Example: ぶりすうぇる

ふりがな

tel
string (optional) Example: 0364504848

電話番号

staffName
string (optional) Example: 田中 敏晴

顧客担当者

email
string (optional) Example: toshiharu.tanaka@briswell.com

メールアドレス

zip
string (optional) Example: 150-0021

郵便番号

address1
string (optional) Example: 東京都

都道府県

address2
string (optional) Example: 渋谷区広尾1-3-17 オーツービル4F

住所

sectionId
number (optional) Example: 123

担当部署id

staffId
number (optional) Example: 123

担当者id

disableFlag
number (optional) Example: 0

無効フラグ

Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "status": "success",
  "data": [
    {
      "customerId": 1,
      "name": "株式会社ブリスウェル",
      "kana": "ぶりすうぇる",
      "tel": "0364504848",
      "staffName": "田中 敏晴",
      "email": "toshiharu.tanaka@briswell.com",
      "zip": "150-0012",
      "address1": "東京都",
      "address2": "渋谷区広尾1-3-17 オーツービル4F",
      "sectionId": 123,
      "staffId": 123,
      "disableFlag": 0
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "status": {
      "type": "string",
      "description": "APIステータス"
    },
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "customerId": {
            "type": "number",
            "description": "顧客id"
          },
          "name": {
            "type": "string",
            "description": "顧客名"
          },
          "kana": {
            "type": "string",
            "description": "ふりがな"
          },
          "tel": {
            "type": "string",
            "description": "電話番号"
          },
          "staffName": {
            "type": "string",
            "description": "顧客担当者"
          },
          "email": {
            "type": "string",
            "description": "メールアドレス"
          },
          "zip": {
            "type": "string",
            "description": "郵便番号"
          },
          "address1": {
            "type": "string",
            "description": "都道府県"
          },
          "address2": {
            "type": "string",
            "description": "住所"
          },
          "sectionId": {
            "type": "number",
            "description": "担当部署id"
          },
          "staffId": {
            "type": "number",
            "description": "担当者id"
          },
          "disableFlag": {
            "type": "number",
            "description": "無効フラグ\n\nFORMAT: 1A"
          }
        },
        "required": [
          "customerId",
          "name",
          "kana"
        ]
      }
    }
  },
  "required": [
    "status",
    "data"
  ]
}

納品先

納品先検索

納品先検索API
GET/v1/location/locationSearch{?customerId}

処理概要

  • customerIdを受け取った場合、紐づく納品先データをN件返却する。

  • locationIdを受け取った場合、該当納品先データを1件返却する。

Example URI

GET /v1/location/locationSearch?customerId=123
URI Parameters
HideShow
locationId
number (optional) Example: 123

納品先id

customerId
number (optional) Example: 123

顧客id

Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "status": "success",
  "dataCount": 3,
  "data": [
    {
      "locationId": 1,
      "customerId": 123,
      "customerName": 0,
      "name": "株式会社ブリスウェル請求先",
      "kana": "ふりがな",
      "staffName": "田中 敏晴",
      "zip": "150-0012",
      "address1": "東京都",
      "address2": "渋谷区広尾1ー3ー17 オーツービル4F",
      "disableFlag": 0
    },
    {
      "locationId": 2,
      "customerId": 123,
      "customerName": 0,
      "name": "株式会社ブリスウェル請求先",
      "kana": "ふりがな",
      "staffName": "田中 敏晴",
      "zip": "150-0012",
      "address1": "東京都",
      "address2": "渋谷区広尾1ー3ー17 オーツービル4F",
      "disableFlag": 0
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "status": {
      "type": "string",
      "description": "APIステータス"
    },
    "dataCount": {
      "type": "number",
      "description": "取得件数"
    },
    "data": {
      "type": "array",
      "items": [
        {
          "type": "object",
          "properties": {
            "locationId": {
              "type": "number",
              "description": "納品先id"
            },
            "customerId": {
              "type": "number",
              "description": "顧客id"
            },
            "customerName": {
              "type": "number",
              "description": "顧客名"
            },
            "name": {
              "type": "string",
              "description": "納品先名"
            },
            "kana": {
              "type": "string",
              "description": "ふりがな"
            },
            "staffName": {
              "type": "string",
              "description": "納品先担当者"
            },
            "zip": {
              "type": "string",
              "description": "郵便番号"
            },
            "address1": {
              "type": "string",
              "description": "都道府県"
            },
            "address2": {
              "type": "string",
              "description": "住所"
            },
            "disableFlag": {
              "type": "number",
              "description": "無効フラグ"
            }
          },
          "required": [
            "locationId",
            "customerId",
            "customerName",
            "name"
          ]
        },
        {
          "type": "object",
          "properties": {
            "locationId": {
              "type": "number",
              "description": "納品先id"
            },
            "customerId": {
              "type": "number",
              "description": "顧客id"
            },
            "customerName": {
              "type": "number",
              "description": "顧客名"
            },
            "name": {
              "type": "string",
              "description": "納品先名"
            },
            "kana": {
              "type": "string",
              "description": "ふりがな"
            },
            "staffName": {
              "type": "string",
              "description": "納品先担当者"
            },
            "zip": {
              "type": "string",
              "description": "郵便番号"
            },
            "address1": {
              "type": "string",
              "description": "都道府県"
            },
            "address2": {
              "type": "string",
              "description": "住所"
            },
            "disableFlag": {
              "type": "number",
              "description": "無効フラグ\n\nFORMAT: 1A"
            }
          },
          "required": [
            "locationId",
            "customerId",
            "customerName",
            "name"
          ]
        }
      ]
    }
  },
  "required": [
    "status",
    "dataCount",
    "data"
  ]
}

納品先情報保存

納品先情報保存API
POST/v1/location/locationSave{?locationId}

処理概要

  • locationIdを指定している場合、指定locationIdレコードをUPDATEする。

  • locationIdを指定指定ない場合、新規レコードをINSERTする。

Example URI

POST /v1/location/locationSave?locationId=1
URI Parameters
HideShow
locationId
number (optional) Example: 1

納品先id

customerId
number (required) Example: 123

顧客id

name
string (required) Example: 株式会社ブリスウェル

納品先名

kana
string (optional) Example: ぶりすうぇる

ふりがな

staffName
string (optional) Example: 田中 敏晴

納品先担当者

zip
string (optional) Example: 150-0021

郵便番号

address1
string (optional) Example: 東京都

都道府県

address2
string (optional) Example: 渋谷区広尾1-3-17 オーツービル4F

住所

disableFlag
number (optional) Example: 0

無効フラグ

Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "status": "success",
  "data": [
    {
      "locationId": 1,
      "customerId": 123,
      "name": "株式会社ブリスウェル",
      "kana": "ぶりすうぇる",
      "staffName": "田中 敏晴",
      "zip": "150-0012",
      "address1": "東京都",
      "address2": "渋谷区広尾1-3-17 オーツービル4F",
      "disableFlag": 0
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "status": {
      "type": "string",
      "description": "APIステータス"
    },
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "locationId": {
            "type": "number",
            "description": "納品先id"
          },
          "customerId": {
            "type": "number",
            "description": "顧客id"
          },
          "name": {
            "type": "string",
            "description": "納品先名"
          },
          "kana": {
            "type": "string",
            "description": "ふりがな"
          },
          "staffName": {
            "type": "string",
            "description": "納品先担当者"
          },
          "zip": {
            "type": "string",
            "description": "郵便番号"
          },
          "address1": {
            "type": "string",
            "description": "都道府県"
          },
          "address2": {
            "type": "string",
            "description": "住所"
          },
          "disableFlag": {
            "type": "number",
            "description": "無効フラグ\n\nFORMAT: 1A"
          }
        },
        "required": [
          "locationId",
          "customerId",
          "name",
          "kana"
        ]
      }
    }
  },
  "required": [
    "status",
    "data"
  ]
}

請求先

請求先検索

請求先検索API
GET/v1/billing/billingSearch{?customerId}

処理概要

  • customerIdを受け取った場合、紐づく請求先データをN件返却する。

  • billingIdを受け取った場合、該当請求先データを1件返却する。

Example URI

GET /v1/billing/billingSearch?customerId=123
URI Parameters
HideShow
billingId
number (optional) Example: 123

請求先id

customerId
number (optional) Example: 123

顧客id

Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "status": "success",
  "dataCount": 3,
  "data": [
    {
      "billingId": 1,
      "customerId": 123,
      "customerName": 0,
      "name": "株式会社ブリスウェル請求先",
      "kana": "ふりがな",
      "staffName": "田中 敏晴",
      "zip": "150-0012",
      "address1": "東京都",
      "address2": "渋谷区広尾1ー3ー17 オーツービル4F",
      "disableFlag": 0
    },
    {
      "billingId": 2,
      "customerId": 123,
      "customerName": 0,
      "name": "株式会社ブリスウェル請求先",
      "kana": "ふりがな",
      "staffName": "田中 敏晴",
      "zip": "150-0012",
      "address1": "東京都",
      "address2": "渋谷区広尾1ー3ー17 オーツービル4F",
      "disableFlag": 0
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "status": {
      "type": "string",
      "description": "APIステータス"
    },
    "dataCount": {
      "type": "number",
      "description": "取得件数"
    },
    "data": {
      "type": "array",
      "items": [
        {
          "type": "object",
          "properties": {
            "billingId": {
              "type": "number",
              "description": "請求先id"
            },
            "customerId": {
              "type": "number",
              "description": "顧客id"
            },
            "customerName": {
              "type": "number",
              "description": "顧客名"
            },
            "name": {
              "type": "string",
              "description": "請求先名"
            },
            "kana": {
              "type": "string",
              "description": "ふりがな"
            },
            "staffName": {
              "type": "string",
              "description": "請求先担当者"
            },
            "zip": {
              "type": "string",
              "description": "郵便番号"
            },
            "address1": {
              "type": "string",
              "description": "都道府県"
            },
            "address2": {
              "type": "string",
              "description": "住所"
            },
            "disableFlag": {
              "type": "number",
              "description": "無効フラグ"
            }
          },
          "required": [
            "billingId",
            "customerId",
            "customerName",
            "name"
          ]
        },
        {
          "type": "object",
          "properties": {
            "billingId": {
              "type": "number",
              "description": "請求先id"
            },
            "customerId": {
              "type": "number",
              "description": "顧客id"
            },
            "customerName": {
              "type": "number",
              "description": "顧客名"
            },
            "name": {
              "type": "string",
              "description": "請求先名"
            },
            "kana": {
              "type": "string",
              "description": "ふりがな"
            },
            "staffName": {
              "type": "string",
              "description": "請求先担当者"
            },
            "zip": {
              "type": "string",
              "description": "郵便番号"
            },
            "address1": {
              "type": "string",
              "description": "都道府県"
            },
            "address2": {
              "type": "string",
              "description": "住所"
            },
            "disableFlag": {
              "type": "number",
              "description": "無効フラグ\n\nFORMAT: 1A"
            }
          },
          "required": [
            "billingId",
            "customerId",
            "customerName",
            "name"
          ]
        }
      ]
    }
  },
  "required": [
    "status",
    "dataCount",
    "data"
  ]
}

請求先情報保存

請求先情報保存API
POST/v1/billing/billingSave{?billingId}

処理概要

  • billingIdを指定している場合、指定billingIdレコードをUPDATEする。

  • billingIdを指定指定ない場合、新規レコードをINSERTする。

Example URI

POST /v1/billing/billingSave?billingId=1
URI Parameters
HideShow
billingId
number (optional) Example: 1

請求先id

customerId
number (required) Example: 123

顧客id

name
string (required) Example: 株式会社ブリスウェル

請求先名

kana
string (optional) Example: ぶりすうぇる

ふりがな

staffName
string (optional) Example: 田中 敏晴

請求先担当者

zip
string (optional) Example: 150-0021

郵便番号

address1
string (optional) Example: 東京都

都道府県

address2
string (optional) Example: 渋谷区広尾1-3-17 オーツービル4F

住所

disableFlag
number (optional) Example: 0

無効フラグ

Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "status": "success",
  "data": [
    {
      "billingId": 1,
      "customerId": 123,
      "name": "株式会社ブリスウェル",
      "kana": "ぶりすうぇる",
      "staffName": "田中 敏晴",
      "zip": "150-0012",
      "address1": "東京都",
      "address2": "渋谷区広尾1-3-17 オーツービル4F",
      "disableFlag": 0
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "status": {
      "type": "string",
      "description": "APIステータス"
    },
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "billingId": {
            "type": "number",
            "description": "請求先id"
          },
          "customerId": {
            "type": "number",
            "description": "顧客id"
          },
          "name": {
            "type": "string",
            "description": "請求先名"
          },
          "kana": {
            "type": "string",
            "description": "ふりがな"
          },
          "staffName": {
            "type": "string",
            "description": "請求先担当者"
          },
          "zip": {
            "type": "string",
            "description": "郵便番号"
          },
          "address1": {
            "type": "string",
            "description": "都道府県"
          },
          "address2": {
            "type": "string",
            "description": "住所"
          },
          "disableFlag": {
            "type": "number",
            "description": "無効フラグ\n\nFORMAT: 1A"
          }
        },
        "required": [
          "billingId",
          "customerId",
          "name",
          "kana"
        ]
      }
    }
  },
  "required": [
    "status",
    "data"
  ]
}

問合履歴

問合履歴検索

問合履歴検索API
GET/v1/inquiry/inquirySearch{?customerId}

処理概要

  • 受け取った検索条件の結果をN件返却する。

  • customerIdを受け取った場合、その他の条件は無視し、customerIdに紐づく問合履歴情報をN件返却する。

  • inquiryIdを受け取った場合、該当問合履歴データを1件返却する。

Example URI

GET /v1/inquiry/inquirySearch?customerId=123
URI Parameters
HideShow
inquiryId
number (optional) Example: 123

問合履歴id

customerId
number (optional) Example: 123

顧客id

customerName
string (optional) Example: 株式会社ブリスウェル

顧客名

customerTel
string (optional) Example: 0364504848

電話番号

customerEmail
string (optional) Example: toshiharu.tanaka@briswell.com

メールアドレス

sort
string (optional) Example: asc

並び順[asc or desc](idでソート)

limit
number (optional) Example: 20

取得件数

offset
number (optional) Example: 2

page数

Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "status": "success",
  "dataCount": 3,
  "data": [
    {
      "inquiryId": 1,
      "customerId": 123,
      "customerName": "株式会社ブリスウェル",
      "staff": "田中 敏晴",
      "tel": "0364504848",
      "email": "toshiharu.tanaka@briswell.com",
      "title": "問合のタイトルがここに入ります。",
      "contents": "問合の内容がここに入ります。"
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "status": {
      "type": "string",
      "description": "APIステータス"
    },
    "dataCount": {
      "type": "number",
      "description": "取得件数"
    },
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "inquiryId": {
            "type": "number",
            "description": "問合履歴id"
          },
          "customerId": {
            "type": "number",
            "description": "顧客id"
          },
          "customerName": {
            "type": "string",
            "description": "顧客名"
          },
          "staff": {
            "type": "string",
            "description": "問合担当者"
          },
          "tel": {
            "type": "string",
            "description": "問合電話番号"
          },
          "email": {
            "type": "string",
            "description": "問合メールアドレス"
          },
          "title": {
            "type": "string",
            "description": "問合題名"
          },
          "contents": {
            "type": "string",
            "description": "問合内容"
          }
        },
        "required": [
          "inquiryId",
          "customerId"
        ]
      }
    }
  },
  "required": [
    "status",
    "dataCount",
    "data"
  ]
}

問合情報保存

問合情報保存API
POST/v1/inquiry/inquirySave{?inquiryId}

処理概要

  • inquiryIdを指定している場合、指定inquiryIdレコードをUPDATEする。

  • inquiryIdを指定指定ない場合、新規レコードをINSERTする。

Example URI

POST /v1/inquiry/inquirySave?inquiryId=123
URI Parameters
HideShow
inquiryId
number (optional) Example: 123

問合履歴id

customerId
number (optional) Example: 123

顧客id

staff
number (optional) Example: 田中 敏晴

問合担当者

tel
number (optional) Example: 0364504848

問合電話番号

email
number (optional) Example: toshiharu.tanaka@briswell.com

問合メールアドレス

title
number (optional) Example: 問合題名がここに入ります。

問合題名

contents
number (optional) Example: 問合内容がここに入ります。

問合内容

Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "status": "success",
  "data": [
    {
      "inquiryId": 123,
      "customerId": "123",
      "staff": "田中 敏晴",
      "tel": "0364504848",
      "email": "toshiharu.tanaka@briswell.com",
      "title": "問合題名がここに入ります。",
      "contents": "問合内容がここに入ります。"
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "status": {
      "type": "string",
      "description": "APIステータス"
    },
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "inquiryId": {
            "type": "number",
            "description": "問合履歴id"
          },
          "customerId": {
            "type": "string",
            "description": "顧客id"
          },
          "staff": {
            "type": "string",
            "description": "問合担当者"
          },
          "tel": {
            "type": "string",
            "description": "問合電話番号"
          },
          "email": {
            "type": "string",
            "description": "問合メールアドレス"
          },
          "title": {
            "type": "string",
            "description": "問合題名"
          },
          "contents": {
            "type": "string",
            "description": "問合内容\n\nFORMAT: 1A"
          }
        },
        "required": [
          "inquiryId",
          "customerId"
        ]
      }
    }
  },
  "required": [
    "status",
    "data"
  ]
}

見積

見積検索

見積検索API
GET/v1/quotation/quotationSearch{?customerId}

処理概要

  • 受け取った検索条件の結果をN件返却する

  • customerIdを受け取った場合、その他の条件は無視し、customerIdに紐づく見積情報をN件返却する

Example URI

GET /v1/quotation/quotationSearch?customerId=123
URI Parameters
HideShow
customerId
number (optional) Example: 123

顧客id

customerName
string (optional) Example: 株式会社ブリスウェル

顧客名

customerTel
string (optional) Example: 0364504848

顧客電話番号

customerEmail
string (optional) Example: toshiharu.tanaka@briswell.com

顧客メールアドレス

quotationDateFrom
date (optional) Example: 2018/01/01

見積日From

quotationDateTo
date (optional) Example: 2018/01/31

見積日To

quotationExpirationDateFrom
date (optional) Example: 2018/02/01

見積有効期限From

quotationExpirationDateTo
date (optional) Example: 2018/02/28

見積有効期限To

sort
string (optional) Example: asc

並び順[asc or desc](idでソート)

limit
number (optional) Example: 20

取得件数

offset
number (optional) Example: 2

page数

Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "status": "success",
  "dataCount": 3,
  "summaryAmount": 1000000,
  "data": [
    {
      "quotationId": 1,
      "customerId": "123",
      "customerName": "株式会社ブリスウェル",
      "customerKane": "ぶりすうぇる",
      "customerTel": "0364504848",
      "customerStaffName": "田中 敏晴",
      "customerEmail": "toshiharu.tanaka@briswell.com",
      "customerZip": "150-0012",
      "customerAddress1": "東京都",
      "customerAddress2": "渋谷区広尾1-3-17 オーツービル4F",
      "locatiuonId": 2,
      "billingId": 2,
      "inquiryId": 3,
      "quotationDate": "2018/01/01",
      "quotationExpirationDate": "2018/02/01",
      "taxRate": 8,
      "amount": 10000,
      "tax": 800,
      "totalAmount": 10800,
      "deliveryDate": "2018/02/28"
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "status": {
      "type": "string",
      "description": "APIステータス"
    },
    "dataCount": {
      "type": "number",
      "description": "取得件数"
    },
    "summaryAmount": {
      "type": "number",
      "description": "税抜金額集計"
    },
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "quotationId": {
            "type": "number",
            "description": "見積id"
          },
          "customerId": {
            "type": "string",
            "description": "顧客id"
          },
          "customerName": {
            "type": "string",
            "description": "顧客名"
          },
          "customerKane": {
            "type": "string",
            "description": "顧客ふりがな"
          },
          "customerTel": {
            "type": "string",
            "description": "顧客電話番号"
          },
          "customerStaffName": {
            "type": "string",
            "description": "顧客担当者"
          },
          "customerEmail": {
            "type": "string",
            "description": "顧客メールアドレス"
          },
          "customerZip": {
            "type": "string",
            "description": "顧客郵便番号"
          },
          "customerAddress1": {
            "type": "string",
            "description": "顧客都道府県"
          },
          "customerAddress2": {
            "type": "string",
            "description": "顧客住所"
          },
          "locatiuonId": {
            "type": "number",
            "description": "納品先id"
          },
          "billingId": {
            "type": "number",
            "description": "請求先id"
          },
          "inquiryId": {
            "type": "number",
            "description": "問合id"
          },
          "quotationDate": {
            "type": "string",
            "description": "見積日"
          },
          "quotationExpirationDate": {
            "type": "string",
            "description": "見積有効期限"
          },
          "taxRate": {
            "type": "number",
            "description": "消費税率"
          },
          "amount": {
            "type": "number",
            "description": "税抜金額"
          },
          "tax": {
            "type": "number",
            "description": "消費税額"
          },
          "totalAmount": {
            "type": "number",
            "description": "税込金額"
          },
          "deliveryDate": {
            "type": "string",
            "description": "納品予定日\n\nFORMAT: 1A"
          }
        },
        "required": [
          "quotationId"
        ]
      }
    }
  },
  "required": [
    "status",
    "dataCount",
    "summaryAmount",
    "data"
  ]
}

見情情報保存

見積情報保存API
POST/v1/quotation/quotationSave{?quotationId}

処理概要

  • quotationIdを指定している場合、指定quotationIdレコードをUPDATEする。

  • quotationIdを指定指定ない場合、新規レコードをINSERTする。

Example URI

POST /v1/quotation/quotationSave?quotationId=1
URI Parameters
HideShow
quotationId
number (optional) Example: 1

見積id

customerId
number (optional) Example: 123

顧客id

customerName
string (optional) Example: 株式会社ブリスウェル

顧客名

customerKana
string (optional) Example: ぶりすうぇる

顧客名ふりがな

customerTel
string (optional) Example: 0364504848

顧客電話番号

customerStaffName
string (optional) Example: 田中 敏晴

顧客担当者

customerEmail
string (optional) Example: toshiharu.tanaka@briswell.com

顧客メールアドレス

customerZip
string (optional) Example: 150-0012

顧客郵便番号

customerAddress1
string (optional) Example: 東京都

顧客都道府県

customerAddress2
string (optional) Example: 渋谷区広尾1-3-17 オーツービル4F

顧客住所

locationId
number (optional) Example: 1

納品先id

billinbId
number (optional) Example: 1

請求先id

quotationDate
string (optional) Example: 2018/01/01

見積日

quotationExpirationDate
string (optional) Example: 2018/02/28

見積有効期限

taxRate
number (optional) Example: 8

消費税率

amount
number (optional) Example: 10000

税抜合計

tax
number (optional) Example: 800

消費税額

totalAmount
number (optional) Example: 10800

税込金額

deliveryDate
string (optional) Example: 2018/03/10

納品予定日

inquiryId
number (optional) Example: 1

問合id

detailCount
number (optional) Example: 3

見積明細数

  • id: 1 (number, optional) - 見積明細id

  • title: 見積明細題名がここに入ります。 (string, optional) - 題名

  • detail: 見積名刺詳細がここに入ります。 (string, optional) - 詳細

  • unitPrice: 100 (number, optional) - 単価

  • count: 2 (number, optional) - 数量

  • amount: 200 (number, optional) - 金額

Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "status": "success",
  "data": [
    {
      "quotationId": 1,
      "customerId": 123,
      "customerName": "株式会社ブリスウェル",
      "customerKana": "ぶりすうぇる",
      "customerTel": "0364504848",
      "customerStaffName": "田中 敏晴",
      "customerEmail": "toshiharu.tanaka@briswell.com",
      "customerZip": "150-0012",
      "customerAddress1": "東京都",
      "customerAddress2": "渋谷区広尾1-3-17 オーツービル4F",
      "locationId": 1,
      "billinbId": 1,
      "quotationDate": "2018/01/01",
      "quotationExpirationDate": "2018/02/28",
      "taxRate": 8,
      "amount": 10000,
      "tax": 800,
      "totalAmount": 10800,
      "deliveryDate": "2018/03/10",
      "inquiryId": 1,
      "detailCount": 2,
      "detailData": [
        {
          "id": 1,
          "title": "見積明細題名がここに入ります。",
          "detail": "見積名刺詳細がここに入ります。",
          "unitPrice": 100,
          "count": 2,
          "amount": 200
        },
        {
          "id": 2,
          "title": "見積明細題名がここに入ります。",
          "detail": "見積名刺詳細がここに入ります。",
          "unitPrice": 100,
          "count": 2,
          "amount": 200
        }
      ]
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "status": {
      "type": "string",
      "description": "APIステータス"
    },
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "quotationId": {
            "type": "number",
            "description": "見積id"
          },
          "customerId": {
            "type": "number",
            "description": "顧客id"
          },
          "customerName": {
            "type": "string",
            "description": "顧客名"
          },
          "customerKana": {
            "type": "string",
            "description": "顧客名ふりがな"
          },
          "customerTel": {
            "type": "string",
            "description": "顧客電話番号"
          },
          "customerStaffName": {
            "type": "string",
            "description": "顧客担当者"
          },
          "customerEmail": {
            "type": "string",
            "description": "顧客メールアドレス"
          },
          "customerZip": {
            "type": "string",
            "description": "顧客郵便番号"
          },
          "customerAddress1": {
            "type": "string",
            "description": "顧客都道府県"
          },
          "customerAddress2": {
            "type": "string",
            "description": "顧客住所"
          },
          "locationId": {
            "type": "number",
            "description": "納品先id"
          },
          "billinbId": {
            "type": "number",
            "description": "請求先id"
          },
          "quotationDate": {
            "type": "string",
            "description": "見積日"
          },
          "quotationExpirationDate": {
            "type": "string",
            "description": "見積有効期限"
          },
          "taxRate": {
            "type": "number",
            "description": "消費税率"
          },
          "amount": {
            "type": "number",
            "description": "税抜合計"
          },
          "tax": {
            "type": "number",
            "description": "消費税額"
          },
          "totalAmount": {
            "type": "number",
            "description": "税込金額"
          },
          "deliveryDate": {
            "type": "string",
            "description": "納品予定日"
          },
          "inquiryId": {
            "type": "number",
            "description": "問合id"
          },
          "detailCount": {
            "type": "number",
            "description": "見積明細数"
          },
          "detailData": {
            "type": "array",
            "items": [
              {
                "type": "object",
                "properties": {
                  "id": {
                    "type": "number",
                    "description": "見積明細id"
                  },
                  "title": {
                    "type": "string",
                    "description": "題名"
                  },
                  "detail": {
                    "type": "string",
                    "description": "詳細"
                  },
                  "unitPrice": {
                    "type": "number",
                    "description": "単価"
                  },
                  "count": {
                    "type": "number",
                    "description": "数量"
                  },
                  "amount": {
                    "type": "number",
                    "description": "金額"
                  }
                },
                "required": [
                  "id"
                ]
              },
              {
                "type": "object",
                "properties": {
                  "id": {
                    "type": "number",
                    "description": "見積明細id"
                  },
                  "title": {
                    "type": "string",
                    "description": "題名"
                  },
                  "detail": {
                    "type": "string",
                    "description": "詳細"
                  },
                  "unitPrice": {
                    "type": "number",
                    "description": "単価"
                  },
                  "count": {
                    "type": "number",
                    "description": "数量"
                  },
                  "amount": {
                    "type": "number",
                    "description": "金額\n\nFORMAT: 1A"
                  }
                },
                "required": [
                  "id"
                ]
              }
            ]
          }
        },
        "required": [
          "quotationId",
          "detailData"
        ]
      }
    }
  },
  "required": [
    "status",
    "data"
  ]
}

見積詳細取得

見積詳細取得API
GET/v1/quotation/quotationDetailSearch{?quotationId}

処理概要

  • 受け取ったquitationIdの見積、見積明細データを返却する

Example URI

GET /v1/quotation/quotationDetailSearch?quotationId=123
URI Parameters
HideShow
quotationId
number (required) Example: 123

見積id

Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "status": "success",
  "data": [
    {
      "quotationId": 1,
      "customerId": "123",
      "customerName": "株式会社ブリスウェル",
      "customerKane": "ぶりすうぇる",
      "customerTel": "0364504848",
      "customerStaffName": "田中 敏晴",
      "customerEmail": "toshiharu.tanaka@briswell.com",
      "customerZip": "150-0012",
      "customerAddress1": "東京都",
      "customerAddress2": "渋谷区広尾1-3-17 オーツービル4F",
      "locatiuonId": 2,
      "billingId": 2,
      "inquiryId": 3,
      "quotationDate": "2018/01/01",
      "quotationExpirationDate": "2018/02/01",
      "taxRate": 8,
      "amount": 10000,
      "tax": 800,
      "totalAmount": 10800,
      "deliveryDate": "2018/02/28",
      "detailCount": 2,
      "detailData": [
        {
          "quotationDetailId": 1,
          "title": "見積明細題名がここに入ります。",
          "detail": "見積明細詳細がここに入ります。",
          "unitPrice": 100,
          "count": 2,
          "amount": 200
        },
        {
          "quotationDetailId": 2,
          "title": "見積明細題名がここに入ります。",
          "detail": "見積明細詳細がここに入ります。",
          "unitPrice": 100,
          "count": 2,
          "amount": 200
        }
      ]
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "status": {
      "type": "string",
      "description": "APIステータス"
    },
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "quotationId": {
            "type": "number",
            "description": "見積id"
          },
          "customerId": {
            "type": "string",
            "description": "顧客id"
          },
          "customerName": {
            "type": "string",
            "description": "顧客名"
          },
          "customerKane": {
            "type": "string",
            "description": "顧客ふりがな"
          },
          "customerTel": {
            "type": "string",
            "description": "顧客電話番号"
          },
          "customerStaffName": {
            "type": "string",
            "description": "顧客担当者"
          },
          "customerEmail": {
            "type": "string",
            "description": "顧客メールアドレス"
          },
          "customerZip": {
            "type": "string",
            "description": "顧客郵便番号"
          },
          "customerAddress1": {
            "type": "string",
            "description": "顧客都道府県"
          },
          "customerAddress2": {
            "type": "string",
            "description": "顧客住所"
          },
          "locatiuonId": {
            "type": "number",
            "description": "納品先id"
          },
          "billingId": {
            "type": "number",
            "description": "請求先id"
          },
          "inquiryId": {
            "type": "number",
            "description": "問合id"
          },
          "quotationDate": {
            "type": "string",
            "description": "見積日"
          },
          "quotationExpirationDate": {
            "type": "string",
            "description": "見積有効期限"
          },
          "taxRate": {
            "type": "number",
            "description": "消費税率"
          },
          "amount": {
            "type": "number",
            "description": "税抜金額"
          },
          "tax": {
            "type": "number",
            "description": "消費税額"
          },
          "totalAmount": {
            "type": "number",
            "description": "税込金額"
          },
          "deliveryDate": {
            "type": "string",
            "description": "納品予定日"
          },
          "detailCount": {
            "type": "number",
            "description": "見積明細数"
          },
          "detailData": {
            "type": "array",
            "items": [
              {
                "type": "object",
                "properties": {
                  "quotationDetailId": {
                    "type": "number",
                    "description": "見積明細id"
                  },
                  "title": {
                    "type": "string",
                    "description": "題名"
                  },
                  "detail": {
                    "type": "string",
                    "description": "詳細"
                  },
                  "unitPrice": {
                    "type": "number",
                    "description": "単価"
                  },
                  "count": {
                    "type": "number",
                    "description": "数量"
                  },
                  "amount": {
                    "type": "number",
                    "description": "金額"
                  }
                },
                "required": [
                  "quotationDetailId"
                ]
              },
              {
                "type": "object",
                "properties": {
                  "quotationDetailId": {
                    "type": "number",
                    "description": "見積明細id"
                  },
                  "title": {
                    "type": "string",
                    "description": "題名"
                  },
                  "detail": {
                    "type": "string",
                    "description": "詳細"
                  },
                  "unitPrice": {
                    "type": "number",
                    "description": "単価"
                  },
                  "count": {
                    "type": "number",
                    "description": "数量"
                  },
                  "amount": {
                    "type": "number",
                    "description": "金額\n\nFORMAT: 1A"
                  }
                },
                "required": [
                  "quotationDetailId"
                ]
              }
            ]
          }
        },
        "required": [
          "quotationId",
          "detailData"
        ]
      }
    }
  },
  "required": [
    "status",
    "data"
  ]
}

受注

受注検索

受注検索API
GET/v1/order/orderSearch{?customerId}

処理概要

  • 受け取った検索条件の結果をN件返却する。

  • customerIdを受け取った場合、その他の条件は無視し、customerIdに紐づく受注情報をN件返却する。

  • orderIdを受け取った場合、該当受注データを1件返却する。

Example URI

GET /v1/order/orderSearch?customerId=123
URI Parameters
HideShow
orderId
number (optional) Example: 123

受注id

customerId
number (optional) Example: 123

顧客id

quotationId
number (optional) Example: 123

見積id

customerName
string (optional) Example: 株式会社ブリスウェル

顧客名

customerTel
string (optional) Example: 0364504848

顧客電話番号

customerEmail
string (optional) Example: toshiharu.tanaka@briswell.com

顧客メールアドレス

orderDateFrom
date (optional) Example: 2018/01/01

受注日From

orderDateTo
date (optional) Example: 2018/01/31

受注日To

deliveryDateFrom
date (optional) Example: 2018/02/01

納品日From

deliveryDateTo
date (optional) Example: 2018/02/28

納品日To

types
string (optional) Example: 1,2

区分

sort
string (optional) Example: asc

並び順[asc or desc](idでソート)

limit
number (optional) Example: 20

取得件数

offset
number (optional) Example: 2

page数

Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "status": "success",
  "dataCount": 3,
  "summaryCountractAmount": 1000000,
  "data": [
    {
      "orderId": 1,
      "quotationId": "123",
      "customerId": "123",
      "customerName": "株式会社ブリスウェル",
      "customerKane": "ぶりすうぇる",
      "customerTel": "0364504848",
      "customerStaff_name": "田中 敏晴",
      "customerEmail": "toshiharu.tanaka@briswell.com",
      "customerZip": "150-0012",
      "customerAddress1": "東京都",
      "customerAddress2": "渋谷区広尾1-3-17 オーツービル4F",
      "sectionId": 123,
      "staffId": 123,
      "locatiuonId": 2,
      "billingId": 2,
      "orderDate": "2018/01/01",
      "deliveryDate": "2018/02/01",
      "contractAmount": 10000,
      "type": 1
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "status": {
      "type": "string",
      "description": "APIステータス"
    },
    "dataCount": {
      "type": "number",
      "description": "取得件数"
    },
    "summaryCountractAmount": {
      "type": "number",
      "description": "契約金額集計"
    },
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "orderId": {
            "type": "number",
            "description": "見積明細id"
          },
          "quotationId": {
            "type": "string",
            "description": "見積id"
          },
          "customerId": {
            "type": "string",
            "description": "顧客id"
          },
          "customerName": {
            "type": "string",
            "description": "顧客名"
          },
          "customerKane": {
            "type": "string",
            "description": "顧客ふりがな"
          },
          "customerTel": {
            "type": "string",
            "description": "顧客電話番号"
          },
          "customerStaff_name": {
            "type": "string",
            "description": "顧客担当者"
          },
          "customerEmail": {
            "type": "string",
            "description": "顧客メールアドレス"
          },
          "customerZip": {
            "type": "string",
            "description": "顧客郵便番号"
          },
          "customerAddress1": {
            "type": "string",
            "description": "顧客都道府県"
          },
          "customerAddress2": {
            "type": "string",
            "description": "顧客住所"
          },
          "sectionId": {
            "type": "number",
            "description": "担当部署id"
          },
          "staffId": {
            "type": "number",
            "description": "担当者id"
          },
          "locatiuonId": {
            "type": "number",
            "description": "納品先id"
          },
          "billingId": {
            "type": "number",
            "description": "請求先id"
          },
          "orderDate": {
            "type": "string",
            "description": "受注日"
          },
          "deliveryDate": {
            "type": "string",
            "description": "納品日"
          },
          "contractAmount": {
            "type": "number",
            "description": "契約金額"
          },
          "type": {
            "type": "number",
            "description": "区分\n\nFORMAT: 1A"
          }
        },
        "required": [
          "orderId"
        ]
      }
    }
  },
  "required": [
    "status",
    "dataCount",
    "summaryCountractAmount",
    "data"
  ]
}

受注情報保存

受注情報保存API
POST/v1/order/orderSave{?orderId}

処理概要

  • orderIdを指定している場合、指定orderIdレコードをUPDATEする。

  • orderIdを指定指定ない場合、新規レコードをINSERTする。

Example URI

POST /v1/order/orderSave?orderId=1
URI Parameters
HideShow
orderId
number (optional) Example: 1

受注id

quotationId
number (optional) Example: 123

見積id

customerId
number (optional) Example: 123

顧客id

customerName
string (optional) Example: 株式会社ブリスウェル

顧客名

customerKana
string (optional) Example: ぶりすうぇる

顧客名ふりがな

customerTel
string (optional) Example: 0364504848

顧客電話番号

customerStaffName
string (optional) Example: 田中 敏晴

顧客担当者

customerEmail
string (optional) Example: toshiharu.tanaka@briswell.com

顧客メールアドレス

customerZip
string (optional) Example: 150-0012

顧客郵便番号

customerAddress1
string (optional) Example: 東京都

顧客都道府県

customerAddress2
string (optional) Example: 渋谷区広尾1-3-17 オーツービル4F

顧客住所

sectionId
number (optional) Example: 123

担当部署id

staffId
number (optional) Example: 123

担当者id

locationId
number (optional) Example: 1

納品先id

billinbId
number (optional) Example: 1

請求先id

orderDate
string (optional) Example: 2018/01/01

受注日

deliveryDate
string (optional) Example: 2018/02/28

納品日

contractAmount
number (optional) Example: 10000

契約金額

type
string (optional) Example: 1

区分

Response  200
HideShow
Headers
Content-Type: application/json
Body
FORMAT: 1A
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "status": {
      "type": "string",
      "description": "APIステータス"
    },
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {}
      }
    }
  },
  "required": [
    "status",
    "data"
  ]
}

売上

売上検索

売上検索API
GET/v1/sales/salesSearch{?customerId}

処理概要

  • 受け取った検索条件の結果をN件返却する

  • customerIdを受け取った場合、その他の条件は無視し、customerIdに紐づく売上情報をN件返却する

  • orderIdを受け取った場合、その他の条件は無視し、orderIdに紐づく売上情報をN件返却する

Example URI

GET /v1/sales/salesSearch?customerId=123
URI Parameters
HideShow
customerId
number (optional) Example: 123

顧客id

orderId
number (optional) Example: 123

受注id

customerName
string (optional) Example: 株式会社ブリスウェル

顧客名

customerTel
string (optional) Example: 0364504848

顧客電話番号

customerEmail
string (optional) Example: toshiharu.tanaka@briswell.com

顧客メールアドレス

billingDateFrom
date (optional) Example: 2018/01/01

請求日From

billingDateTo
date (optional) Example: 2018/01/31

請求日To

paymentDateFrom
date (optional) Example: 2018/02/01

支払期限日From

paymentDateTo
date (optional) Example: 2018/02/28

支払期限日To

types
string (optional) Example: 1,2

区分

sort
string (optional) Example: asc

並び順[asc or desc](idでソート)

limit
number (optional) Example: 20

取得件数

offset
number (optional) Example: 2

page数

Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "status": "success",
  "dataCount": 3,
  "summaryAmount": 1000000,
  "data": [
    {
      "salesId": 1,
      "orderId": 1,
      "customerId": "123",
      "customerName": "株式会社ブリスウェル",
      "customerKane": "ぶりすうぇる",
      "customerTel": "0364504848",
      "customerStaff_name": "田中 敏晴",
      "customerEmail": "toshiharu.tanaka@briswell.com",
      "customerZip": "150-0012",
      "customerAddress1": "東京都",
      "customerAddress2": "渋谷区広尾1-3-17 オーツービル4F",
      "locatiuonId": 2,
      "billingId": 2,
      "billingDate": "2018/01/01",
      "paymentDate": "2018/02/01",
      "taxRate": 8,
      "amount": 10000,
      "tax": 800,
      "totalAmount": 10800,
      "type": 1
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "status": {
      "type": "string",
      "description": "APIステータス"
    },
    "dataCount": {
      "type": "number",
      "description": "取得件数"
    },
    "summaryAmount": {
      "type": "number",
      "description": "税抜金額集計"
    },
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "salesId": {
            "type": "number",
            "description": "売上id"
          },
          "orderId": {
            "type": "number",
            "description": "受注id"
          },
          "customerId": {
            "type": "string",
            "description": "顧客id"
          },
          "customerName": {
            "type": "string",
            "description": "顧客名"
          },
          "customerKane": {
            "type": "string",
            "description": "顧客ふりがな"
          },
          "customerTel": {
            "type": "string",
            "description": "顧客電話番号"
          },
          "customerStaff_name": {
            "type": "string",
            "description": "顧客担当者"
          },
          "customerEmail": {
            "type": "string",
            "description": "顧客メールアドレス"
          },
          "customerZip": {
            "type": "string",
            "description": "顧客郵便番号"
          },
          "customerAddress1": {
            "type": "string",
            "description": "顧客都道府県"
          },
          "customerAddress2": {
            "type": "string",
            "description": "顧客住所"
          },
          "locatiuonId": {
            "type": "number",
            "description": "納品先id"
          },
          "billingId": {
            "type": "number",
            "description": "請求先id"
          },
          "billingDate": {
            "type": "string",
            "description": "請求日"
          },
          "paymentDate": {
            "type": "string",
            "description": "支払期限日"
          },
          "taxRate": {
            "type": "number",
            "description": "消費税率"
          },
          "amount": {
            "type": "number",
            "description": "税抜金額"
          },
          "tax": {
            "type": "number",
            "description": "消費税額"
          },
          "totalAmount": {
            "type": "number",
            "description": "税込金額"
          },
          "type": {
            "type": "number",
            "description": "区分\n\nFORMAT: 1A"
          }
        },
        "required": [
          "salesId",
          "orderId"
        ]
      }
    }
  },
  "required": [
    "status",
    "dataCount",
    "summaryAmount",
    "data"
  ]
}

売上情報保存

売上情報保存API
POST/v1/sales/salesSave{?salesId}

処理概要

  • salesIdを指定している場合、指定salesIdレコードをUPDATEする。

  • salesIdを指定指定ない場合、新規レコードをINSERTする。

Example URI

POST /v1/sales/salesSave?salesId=1
URI Parameters
HideShow
salesId
number (optional) Example: 1

売上id

orderId
number (optional) Example: 123

受注id

customerId
number (optional) Example: 123

顧客id

customerName
string (optional) Example: 株式会社ブリスウェル

顧客名

customerKana
string (optional) Example: ぶりすうぇる

顧客名ふりがな

customerTel
string (optional) Example: 0364504848

顧客電話番号

customerStaffName
string (optional) Example: 田中 敏晴

顧客担当者

customerEmail
string (optional) Example: toshiharu.tanaka@briswell.com

顧客メールアドレス

customerZip
string (optional) Example: 150-0012

顧客郵便番号

customerAddress1
string (optional) Example: 東京都

顧客都道府県

customerAddress2
string (optional) Example: 渋谷区広尾1-3-17 オーツービル4F

顧客住所

locationId
number (optional) Example: 1

納品先id

billinbId
number (optional) Example: 1

請求先id

billingDate
string (optional) Example: 2018/01/01

請求日

paymentDate
string (optional) Example: 2018/02/28

支払期限日

taxRate
number (optional) Example: 8

消費税率

amount
number (optional) Example: 10000

税抜合計

tax
number (optional) Example: 800

消費税額

totalAmount
number (optional) Example: 10800

税込金額

types
string (optional) Example: 1,2

区分

detailCount
number (optional) Example: 3

売上明細数

  • id: 1 (number, optional) - 売上明細id

  • title: 売上明細題名がここに入ります。 (string, optional) - 題名

  • detail: 売上明細詳細がここに入ります。 (string, optional) - 詳細

  • unitPrice: 100 (number, optional) - 単価

  • count: 2 (number, optional) - 数量

  • amount: 200 (number, optional) - 金額

Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "status": "success",
  "data": [
    {
      "salesId": 1,
      "orderId": 1,
      "customerId": 123,
      "customerName": "株式会社ブリスウェル",
      "customerKana": "ぶりすうぇる",
      "customerTel": "0364504848",
      "customerStaffName": "田中 敏晴",
      "customerEmail": "toshiharu.tanaka@briswell.com",
      "customerZip": "150-0012",
      "customerAddress1": "東京都",
      "customerAddress2": "渋谷区広尾1-3-17 オーツービル4F",
      "locationId": 1,
      "billinbId": 1,
      "billingDate": "2018/01/01",
      "paymentDate": "2018/02/28",
      "taxRate": 8,
      "amount": 10000,
      "tax": 800,
      "totalAmount": 10800,
      "types": "1,2",
      "detailCount": 2,
      "detailData": [
        {
          "id": 1,
          "title": "売上明細題名がここに入ります。",
          "detail": "売上明細詳細がここに入ります。",
          "unitPrice": 100,
          "count": 2,
          "amount": 200
        },
        {
          "id": 2,
          "title": "売上明細題名がここに入ります。",
          "detail": "売上明細詳細がここに入ります。",
          "unitPrice": 100,
          "count": 2,
          "amount": 200
        }
      ]
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "status": {
      "type": "string",
      "description": "APIステータス"
    },
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "salesId": {
            "type": "number",
            "description": "売上id"
          },
          "orderId": {
            "type": "number",
            "description": "受注id"
          },
          "customerId": {
            "type": "number",
            "description": "顧客id"
          },
          "customerName": {
            "type": "string",
            "description": "顧客名"
          },
          "customerKana": {
            "type": "string",
            "description": "顧客名ふりがな"
          },
          "customerTel": {
            "type": "string",
            "description": "顧客電話番号"
          },
          "customerStaffName": {
            "type": "string",
            "description": "顧客担当者"
          },
          "customerEmail": {
            "type": "string",
            "description": "顧客メールアドレス"
          },
          "customerZip": {
            "type": "string",
            "description": "顧客郵便番号"
          },
          "customerAddress1": {
            "type": "string",
            "description": "顧客都道府県"
          },
          "customerAddress2": {
            "type": "string",
            "description": "顧客住所"
          },
          "locationId": {
            "type": "number",
            "description": "納品先id"
          },
          "billinbId": {
            "type": "number",
            "description": "請求先id"
          },
          "billingDate": {
            "type": "string",
            "description": "請求日"
          },
          "paymentDate": {
            "type": "string",
            "description": "支払期限日"
          },
          "taxRate": {
            "type": "number",
            "description": "消費税率"
          },
          "amount": {
            "type": "number",
            "description": "税抜合計"
          },
          "tax": {
            "type": "number",
            "description": "消費税額"
          },
          "totalAmount": {
            "type": "number",
            "description": "税込金額"
          },
          "types": {
            "type": "string",
            "description": "区分"
          },
          "detailCount": {
            "type": "number",
            "description": "売上明細数"
          },
          "detailData": {
            "type": "array",
            "items": [
              {
                "type": "object",
                "properties": {
                  "id": {
                    "type": "number",
                    "description": "売上明細id"
                  },
                  "title": {
                    "type": "string",
                    "description": "題名"
                  },
                  "detail": {
                    "type": "string",
                    "description": "詳細"
                  },
                  "unitPrice": {
                    "type": "number",
                    "description": "単価"
                  },
                  "count": {
                    "type": "number",
                    "description": "数量"
                  },
                  "amount": {
                    "type": "number",
                    "description": "金額"
                  }
                },
                "required": [
                  "id"
                ]
              },
              {
                "type": "object",
                "properties": {
                  "id": {
                    "type": "number",
                    "description": "売上明細id"
                  },
                  "title": {
                    "type": "string",
                    "description": "題名"
                  },
                  "detail": {
                    "type": "string",
                    "description": "詳細"
                  },
                  "unitPrice": {
                    "type": "number",
                    "description": "単価"
                  },
                  "count": {
                    "type": "number",
                    "description": "数量"
                  },
                  "amount": {
                    "type": "number",
                    "description": "金額\n\nFORMAT: 1A"
                  }
                },
                "required": [
                  "id"
                ]
              }
            ]
          }
        },
        "required": [
          "salesId",
          "orderId",
          "detailData"
        ]
      }
    }
  },
  "required": [
    "status",
    "data"
  ]
}

売上詳細取得

売上詳細取得API
GET/v1/salesDetail/salesDetailSearch{?salesId}

処理概要

  • 受け取ったsalesIdの売上、売上明細データを返却する

Example URI

GET /v1/salesDetail/salesDetailSearch?salesId=123
URI Parameters
HideShow
salesId
number (required) Example: 123

売上id

Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "status": "success",
  "data": [
    {
      "salesId": 1,
      "customerId": 123,
      "customerName": "株式会社ブリスウェル",
      "customerKana": "ぶりすうぇる",
      "customerTel": "0364504848",
      "customerStaffName": "田中 敏晴",
      "customerEmail": "toshiharu.tanaka@briswell.com",
      "customerZip": "150-0012",
      "customerAddress1": "東京都",
      "customerAddress2": "渋谷区広尾1-3-17 オーツービル4F",
      "locationId": 1,
      "billinbId": 1,
      "billingDate": "2018/01/01",
      "paymentDate": "2018/02/28",
      "taxRate": 8,
      "amount": 10000,
      "tax": 800,
      "totalAmount": 10800,
      "types": "1,2",
      "detailCount": 2,
      "detailData": [
        {
          "detailId": 1,
          "title": "売上明細題名がここに入ります。",
          "detail": "売上明細詳細がここに入ります。",
          "unitPrice": 100,
          "count": 2,
          "amount": 200
        },
        {
          "detailId": 2,
          "title": "売上明細題名がここに入ります。",
          "detail": "売上明細詳細がここに入ります。",
          "unitPrice": 100,
          "count": 2,
          "amount": 200
        }
      ]
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "status": {
      "type": "string",
      "description": "APIステータス"
    },
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "salesId": {
            "type": "number",
            "description": "売上id"
          },
          "customerId": {
            "type": "number",
            "description": "顧客id"
          },
          "customerName": {
            "type": "string",
            "description": "顧客名"
          },
          "customerKana": {
            "type": "string",
            "description": "顧客名ふりがな"
          },
          "customerTel": {
            "type": "string",
            "description": "顧客電話番号"
          },
          "customerStaffName": {
            "type": "string",
            "description": "顧客担当者"
          },
          "customerEmail": {
            "type": "string",
            "description": "顧客メールアドレス"
          },
          "customerZip": {
            "type": "string",
            "description": "顧客郵便番号"
          },
          "customerAddress1": {
            "type": "string",
            "description": "顧客都道府県"
          },
          "customerAddress2": {
            "type": "string",
            "description": "顧客住所"
          },
          "locationId": {
            "type": "number",
            "description": "納品先id"
          },
          "billinbId": {
            "type": "number",
            "description": "請求先id"
          },
          "billingDate": {
            "type": "string",
            "description": "請求日"
          },
          "paymentDate": {
            "type": "string",
            "description": "支払期限日"
          },
          "taxRate": {
            "type": "number",
            "description": "消費税率"
          },
          "amount": {
            "type": "number",
            "description": "税抜合計"
          },
          "tax": {
            "type": "number",
            "description": "消費税額"
          },
          "totalAmount": {
            "type": "number",
            "description": "税込金額"
          },
          "types": {
            "type": "string",
            "description": "区分"
          },
          "detailCount": {
            "type": "number",
            "description": "売上明細数"
          },
          "detailData": {
            "type": "array",
            "items": [
              {
                "type": "object",
                "properties": {
                  "detailId": {
                    "type": "number",
                    "description": "売上明細id"
                  },
                  "title": {
                    "type": "string",
                    "description": "題名"
                  },
                  "detail": {
                    "type": "string",
                    "description": "詳細"
                  },
                  "unitPrice": {
                    "type": "number",
                    "description": "単価"
                  },
                  "count": {
                    "type": "number",
                    "description": "数量"
                  },
                  "amount": {
                    "type": "number",
                    "description": "金額"
                  }
                },
                "required": [
                  "detailId"
                ]
              },
              {
                "type": "object",
                "properties": {
                  "detailId": {
                    "type": "number",
                    "description": "売上明細id"
                  },
                  "title": {
                    "type": "string",
                    "description": "題名"
                  },
                  "detail": {
                    "type": "string",
                    "description": "詳細"
                  },
                  "unitPrice": {
                    "type": "number",
                    "description": "単価"
                  },
                  "count": {
                    "type": "number",
                    "description": "数量"
                  },
                  "amount": {
                    "type": "number",
                    "description": "金額\n\nFORMAT: 1A"
                  }
                },
                "required": [
                  "detailId"
                ]
              }
            ]
          }
        },
        "required": [
          "salesId",
          "detailData"
        ]
      }
    }
  },
  "required": [
    "status",
    "data"
  ]
}

クレーム

クレーム検索

クレーム検索API
GET/v1/claim/claimSearch{?customerId}

処理概要

  • 受け取った検索条件の結果をN件返却する。

  • customerIdを受け取った場合、その他の条件は無視し、customerIdに紐づくクレーム情報をN件返却する。

  • claimIdを受け取った場合、該当クレームデータを1件返却する。

Example URI

GET /v1/claim/claimSearch?customerId=123
URI Parameters
HideShow
claimId
number (optional) Example: 123

クレームid

customerId
number (optional) Example: 123

顧客id

customerName
number (optional) Example: 株式会社ブリスウェル

顧客名

title
string (optional) Example: クレームの題名がここに入ります。

クレーム題名

sort
string (optional) Example: asc

並び順[asc or desc](idでソート)

limit
number (optional) Example: 20

取得件数

offset
number (optional) Example: 2

page数

Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "status": "success",
  "dataCount": 3,
  "data": [
    {
      "claimId": 1,
      "customerId": 123,
      "customerName": "株式会社ブリスウェル",
      "title": "クレームの題名がここに入ります。",
      "contents": "クレームの内容がここに入ります。"
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "status": {
      "type": "string",
      "description": "APIステータス"
    },
    "dataCount": {
      "type": "number",
      "description": "取得件数"
    },
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "claimId": {
            "type": "number",
            "description": "クレームid"
          },
          "customerId": {
            "type": "number",
            "description": "顧客id"
          },
          "customerName": {
            "type": "string",
            "description": "顧客名"
          },
          "title": {
            "type": "string",
            "description": "クレーム題名"
          },
          "contents": {
            "type": "string",
            "description": "クレーム内容"
          }
        },
        "required": [
          "claimId"
        ]
      }
    }
  },
  "required": [
    "status",
    "dataCount",
    "data"
  ]
}

クレーム保存

クレーム保存API
POST/v1/claim/claimSave{?claimId}

処理概要

  • claimIdを指定している場合、指定claimIdレコードをUPDATEする。

  • claimIdを指定指定ない場合、新規レコードをINSERTする。

Example URI

POST /v1/claim/claimSave?claimId=123
URI Parameters
HideShow
claimId
number (optional) Example: 123

クレームid

customerId
number (optional) Example: 123

顧客id

orderId
number (optional) Example: 123

受注id

title
number (optional) Example: クレーム題名がここに入ります。

クレーム題名

contents
number (optional) Example: クレーム内容がここに入ります。

クレーム内容

Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "status": "success",
  "data": [
    {
      "claimId": 123,
      "customerId": "123",
      "orderId": "123",
      "title": "クレーム題名がここに入ります。",
      "contents": "クレーム内容がここに入ります。"
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "status": {
      "type": "string",
      "description": "APIステータス"
    },
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "claimId": {
            "type": "number",
            "description": "問合履歴id"
          },
          "customerId": {
            "type": "string",
            "description": "顧客id"
          },
          "orderId": {
            "type": "string",
            "description": "受注id"
          },
          "title": {
            "type": "string",
            "description": "クレーム題名"
          },
          "contents": {
            "type": "string",
            "description": "クレーム内容\n\nFORMAT: 1A"
          }
        },
        "required": [
          "claimId"
        ]
      }
    }
  },
  "required": [
    "status",
    "data"
  ]
}

外部

住所検索

住所検索API
POST/v1/outside/addressSearch{?zipCode}

処理概要

  • frontendはapiにパラメーターを渡す。

  • 受け取ったapiは外部URLにパラメーターをセットし返却値をfrontendに返却する。

  • http://zipcloud.ibsnet.co.jp/api/search?zipcode=150-0012

  • ToDo 外部APIがStopした場合を考慮して、Jobから一括でDBに取り込んでおいた方が良い

Example URI

POST /v1/outside/addressSearch?zipCode=150-0012
URI Parameters
HideShow
zipCode
string (optional) Example: 150-0012

郵便番号

Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "null",
  "results": [
    {
      "address1": "東京都",
      "address2": "渋谷区",
      "address3": "広尾",
      "kana1": "トウキョウト",
      "kana2": "シブヤク",
      "kana3": "ヒロオ",
      "prefcode": "13",
      "zipcode": "1500012"
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "description": "メッセージ"
    },
    "results": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "address1": {
            "type": "string",
            "description": "都道府県"
          },
          "address2": {
            "type": "string",
            "description": "市区町村"
          },
          "address3": {
            "type": "string",
            "description": "町村名番地"
          },
          "kana1": {
            "type": "string",
            "description": "都道府県カナ"
          },
          "kana2": {
            "type": "string",
            "description": "市区町村カナ"
          },
          "kana3": {
            "type": "string",
            "description": "町村名番地カナ"
          },
          "prefcode": {
            "type": "string",
            "description": "都道府県コード"
          },
          "zipcode": {
            "type": "string",
            "description": "郵便番号\n\nFORMAT: 1A"
          }
        },
        "required": [
          "address1",
          "address2",
          "address3"
        ]
      }
    }
  },
  "required": [
    "message",
    "results"
  ]
}

消費税率

受注検索

消費税率検索API
GET/v1/taxRate/taxRateSearch{?date}

処理概要

  • 受け取った日付を元に該当する消費税率を返却する

Example URI

GET /v1/taxRate/taxRateSearch?date=2018/01/12
URI Parameters
HideShow
date
date (required) Example: 2018/01/12
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "status": "success",
  "data": [
    {
      "taxRate": 8
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "status": {
      "type": "string",
      "description": "APIステータス"
    },
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "taxRate": {
            "type": "number",
            "description": "消費税率\n\nFORMAT: 1A"
          }
        },
        "required": [
          "taxRate"
        ]
      }
    }
  },
  "required": [
    "status",
    "data"
  ]
}

担当部署

担当部署検索

担当部署検索API
GET/v1/section/sectionSearch{?sectionId}

処理概要

  • 受け取った検索条件の結果をN件返却する。

  • sectionIdを受け取った場合、その他の条件は無視し、sectionIdの顧客情報を1件返却する。

Example URI

GET /v1/section/sectionSearch?sectionId=123
URI Parameters
HideShow
sectionId
number (optional) Example: 123

担当部署id

sectionName
string (optional) Example: ソフトウェア開発部

担当部署名

sort
string (optional) Example: asc

並び順[asc or desc](idでソート)

limit
number (optional) Example: 20

取得件数

offset
number (optional) Example: 2

page数

Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "status": "success",
  "dataCount": 3,
  "data": [
    {
      "sectionId": 123,
      "sectionName": "ソフトウェア開発部"
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "status": {
      "type": "string",
      "description": "APIステータス"
    },
    "dataCount": {
      "type": "number",
      "description": "取得件数"
    },
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "sectionId": {
            "type": "number",
            "description": "担当部署id"
          },
          "sectionName": {
            "type": "string",
            "description": "担当部署名\n\nFORMAT: 1A"
          }
        }
      }
    }
  },
  "required": [
    "status",
    "dataCount",
    "data"
  ]
}

担当部署情報保存

担当部署情報保存API
POST/v1/section/sectionSave

処理概要

  • sectionIdを指定している場合、指定sectionIdレコードをUPDATEする。

  • sectionIdを指定指定ない場合、新規レコードをINSERTする。

Example URI

POST /v1/section/sectionSave
URI Parameters
HideShow
customerId
number (required) Example: 123

顧客id

sectionName
string (required) Example: ソフトウェア開発部

担当部署名

Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "status": "success",
  "data": [
    {
      "sectionId": 123,
      "sectionName": "ソフトウェア開発部"
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "status": {
      "type": "string",
      "description": "APIステータス"
    },
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "sectionId": {
            "type": "number",
            "description": "担当部署id"
          },
          "sectionName": {
            "type": "string",
            "description": "担当部署名\n\nFORMAT: 1A"
          }
        },
        "required": [
          "sectionId",
          "sectionName"
        ]
      }
    }
  },
  "required": [
    "status",
    "data"
  ]
}

担当者

担当者検索

担当者検索API
GET/v1/staff/staffSearch{?sectionId}

処理概要

  • 受け取った検索条件の結果をN件返却する。

  • sectionIdを受け取った場合、担当部署に紐づく担当者データをN件返却する。

  • staffIdを受け取った場合、該当担当者データを1件返却する。

Example URI

GET /v1/staff/staffSearch?sectionId=123
URI Parameters
HideShow
staffId
number (optional) Example: 123

担当者id

sectionId
number (optional) Example: 123

担当部署id

staffName
string (optional) Example: 田中 敏晴

担当者

sort
string (optional) Example: asc

並び順[asc or desc](idでソート)

limit
number (optional) Example: 20

取得件数

offset
number (optional) Example: 2

page数

Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "status": "success",
  "dataCount": 3,
  "data": [
    {
      "staffId": 1,
      "sectionId": 123,
      "staffName": "田中 敏晴",
      "type": "1"
    },
    {
      "staffId": 2,
      "sectionId": 123,
      "staffName": "田中 敏晴",
      "type": "1"
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "status": {
      "type": "string",
      "description": "APIステータス"
    },
    "dataCount": {
      "type": "number",
      "description": "取得件数"
    },
    "data": {
      "type": "array",
      "items": [
        {
          "type": "object",
          "properties": {
            "staffId": {
              "type": "number",
              "description": "担当者id"
            },
            "sectionId": {
              "type": "number",
              "description": "顧担当部署id"
            },
            "staffName": {
              "type": "string",
              "description": "担当者"
            },
            "type": {
              "type": "string",
              "description": "在籍区分"
            }
          },
          "required": [
            "staffId",
            "sectionId"
          ]
        },
        {
          "type": "object",
          "properties": {
            "staffId": {
              "type": "number",
              "description": "担当者id"
            },
            "sectionId": {
              "type": "number",
              "description": "担当部署id"
            },
            "staffName": {
              "type": "string",
              "description": "担当者"
            },
            "type": {
              "type": "string",
              "description": "在籍区分\n\nFORMAT: 1A"
            }
          },
          "required": [
            "staffId",
            "sectionId"
          ]
        }
      ]
    }
  },
  "required": [
    "status",
    "dataCount",
    "data"
  ]
}

担当者情報保存

担当者保存API
POST/v1/staff/staffSave{?staffId}

処理概要

  • staffIdを指定している場合、指定staffIdレコードをUPDATEする。

  • staffIdを指定指定ない場合、新規レコードをINSERTする。

Example URI

POST /v1/staff/staffSave?staffId=123
URI Parameters
HideShow
staffId
number (optional) Example: 123

担当者id

sectionId
number (optional) Example: 123

担当部署id

staffName
string (optional) Example: 田中 敏晴

担当者

types
string (optional) Example: 1

在籍区分

Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "status": "success",
  "data": [
    {
      "staffId": 123,
      "sectionId": 123,
      "staffName": "田中 敏晴",
      "type": "1"
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "status": {
      "type": "string",
      "description": "APIステータス"
    },
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "staffId": {
            "type": "number",
            "description": "担当者id"
          },
          "sectionId": {
            "type": "number",
            "description": "担当部署id"
          },
          "staffName": {
            "type": "string",
            "description": "担当者"
          },
          "type": {
            "type": "string",
            "description": "在籍区分\n\nFORMAT: 1A"
          }
        }
      }
    }
  },
  "required": [
    "status",
    "data"
  ]
}

見積集計

見積集計検索

見積集計検索API
GET/v1/quotationSummary/quotationSummarySearch

処理概要

  • 受け取った検索条件の結果をN件返却する

Example URI

GET /v1/quotationSummary/quotationSummarySearch
URI Parameters
HideShow
quotationDateFrom
date (optional) Example: 2018/01/01

見積日From

quotationDateTo
date (optional) Example: 2018/01/31

見積日To

Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "status": "success",
  "dataCount": 3,
  "data": [
    {
      "quotationSummaryId": 1,
      "quotationDate": "2018/01/01",
      "summaryCount": 8,
      "summaryAmount": 10000
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "status": {
      "type": "string",
      "description": "APIステータス"
    },
    "dataCount": {
      "type": "number",
      "description": "取得件数"
    },
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "quotationSummaryId": {
            "type": "number",
            "description": "見積集計id"
          },
          "quotationDate": {
            "type": "string",
            "description": "見積日"
          },
          "summaryCount": {
            "type": "number",
            "description": "見積件数"
          },
          "summaryAmount": {
            "type": "number",
            "description": "見積金額"
          }
        },
        "required": [
          "quotationSummaryId"
        ]
      }
    }
  },
  "required": [
    "status",
    "dataCount",
    "data"
  ]
}

見情集計情報保存

見積情報保存API
POST/v1/quotationSummary/quotationSummarySave

処理概要

  • quotationDateを指定している場合、指定quotationDateレコードをUPDATEする。存在しない場合はINSERTする。

Example URI

POST /v1/quotationSummary/quotationSummarySave
URI Parameters
HideShow
quotationDate
string (optional) Example: 2018/01/01

見積日

summaryCount
string (optional) Example: 8

見積件数

summaryAmount
number (optional) Example: 123456

見積金額

Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "status": "success",
  "data": [
    {
      "quotationSummaryId": 1,
      "quotationDate": "2018/01/01",
      "summaryCount": "8",
      "summaryAmount": "123456"
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "status": {
      "type": "string",
      "description": "APIステータス"
    },
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "quotationSummaryId": {
            "type": "number",
            "description": "見積集計id"
          },
          "quotationDate": {
            "type": "string",
            "description": "見積日"
          },
          "summaryCount": {
            "type": "string",
            "description": "見積件数"
          },
          "summaryAmount": {
            "type": "string",
            "description": "見積金額"
          }
        },
        "required": [
          "quotationSummaryId"
        ]
      }
    }
  },
  "required": [
    "status",
    "data"
  ]
}

受注集計

受注集計検索

受注集計検索API
GET/v1/orderSummary/orderSummarySearch

処理概要

  • 受け取った検索条件の結果をN件返却する

Example URI

GET /v1/orderSummary/orderSummarySearch
URI Parameters
HideShow
orderDateFrom
date (optional) Example: 2018/01/01

受注日From

orderDateTo
date (optional) Example: 2018/01/31

受注日To

type
number (optional) Example: 1

区分

Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "status": "success",
  "dataCount": 3,
  "data": [
    {
      "orderSummaryId": 1,
      "orderDate": "2018/01/01",
      "type": 1,
      "summaryCount": 8,
      "summaryContractAmount": 10000
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "status": {
      "type": "string",
      "description": "APIステータス"
    },
    "dataCount": {
      "type": "number",
      "description": "取得件数"
    },
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "orderSummaryId": {
            "type": "number",
            "description": "受注集計id"
          },
          "orderDate": {
            "type": "string",
            "description": "受注日"
          },
          "type": {
            "type": "number",
            "description": "区分"
          },
          "summaryCount": {
            "type": "number",
            "description": "受注件数"
          },
          "summaryContractAmount": {
            "type": "number",
            "description": "受注金額"
          }
        },
        "required": [
          "orderSummaryId"
        ]
      }
    }
  },
  "required": [
    "status",
    "dataCount",
    "data"
  ]
}

受注集計情報保存

受注情報保存API
POST/v1/orderSummary/orderSummarySave

処理概要

  • orderDateを指定している場合、指定orderDateレコードをUPDATEする。存在しない場合はINSERTする。

Example URI

POST /v1/orderSummary/orderSummarySave
URI Parameters
HideShow
orderDate
string (optional) Example: 2018/01/01

受注日

type
number (optional) Example: 1

区分

summaryCount
string (optional) Example: 8

受注件数

summaryContractAmount
number (optional) Example: 123456

受注金額

Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "status": "success",
  "data": [
    {
      "orderSummaryId": 1,
      "orderDate": "2018/01/01",
      "type": 1,
      "summaryCount": "8",
      "summaryContractAmount": "123456"
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "status": {
      "type": "string",
      "description": "APIステータス"
    },
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "orderSummaryId": {
            "type": "number",
            "description": "受注集計id"
          },
          "orderDate": {
            "type": "string",
            "description": "受注日"
          },
          "type": {
            "type": "number",
            "description": "区分"
          },
          "summaryCount": {
            "type": "string",
            "description": "受注件数"
          },
          "summaryContractAmount": {
            "type": "string",
            "description": "受注金額"
          }
        },
        "required": [
          "orderSummaryId"
        ]
      }
    }
  },
  "required": [
    "status",
    "data"
  ]
}

ファイル出力状況

ファイル出力状況検索

ファイル出力状況API
GET/v1/fileStatus/fileStatusSearch{?fileStatusId}

処理概要

  • 受け取った検索条件の結果をN件返却する。

  • fileStatusIdを受け取った場合、その他の条件は無視し、fileStatusIdの顧客情報を1件返却する。

Example URI

GET /v1/fileStatus/fileStatusSearch?fileStatusId=``
URI Parameters
HideShow
fileStatusId
number (required) Example: ``

ファイル出力状況id

status
number (required) Example: 1

ステータス

createdAtFrom
date (optional) Example: 2018/01/17

出力依頼日From

createdAtTo
date (optional) Example: 2018/01/31

出力依頼日To

sort
string (optional) Example: asc

並び順[asc or desc](idでソート)

limit
number (optional) Example: 20

取得件数

offset
number (optional) Example: 2

page数

Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "status": "success",
  "dataCount": 2,
  "data": [
    {
      "fileStatusId": "123",
      "status": "1",
      "filePath": "1",
      "sqsId": "1",
      "createdAtFrom": "2018/01/17"
    },
    {
      "fileStatusId": "124",
      "status": "1",
      "filePath": "2",
      "sqsId": "2",
      "createdAt": "2018/01/19"
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "status": {
      "type": "string",
      "description": "APIステータス"
    },
    "dataCount": {
      "type": "number",
      "description": "取得件数"
    },
    "data": {
      "type": "array",
      "items": [
        {
          "type": "object",
          "properties": {
            "fileStatusId": {
              "type": "string",
              "description": "ファイル出力状況id"
            },
            "status": {
              "type": "string",
              "description": "ステータス"
            },
            "filePath": {
              "type": "string",
              "description": "S3ファイルパス"
            },
            "sqsId": {
              "type": "string",
              "description": "SQSキューid"
            },
            "createdAtFrom": {
              "type": "string",
              "description": "出力依頼日"
            }
          },
          "required": [
            "fileStatusId",
            "status",
            "filePath",
            "sqsId"
          ]
        },
        {
          "type": "object",
          "properties": {
            "fileStatusId": {
              "type": "string",
              "description": "ファイル出力状況id"
            },
            "status": {
              "type": "string",
              "description": "ステータス"
            },
            "filePath": {
              "type": "string",
              "description": "S3ファイルパス"
            },
            "sqsId": {
              "type": "string",
              "description": "SQSキューid"
            },
            "createdAt": {
              "type": "string",
              "description": "出力依頼日"
            }
          },
          "required": [
            "fileStatusId",
            "status",
            "filePath",
            "sqsId"
          ]
        }
      ]
    }
  },
  "required": [
    "status",
    "dataCount",
    "data"
  ]
}

ファイル出力状況情報保存

ファイル出力状況情報保存API
POST/v1/fileStatus/fileStatusSave{?fileStatusId}

処理概要

  • fileStatusIdを指定している場合、指定fileStatusIdレコードをUPDATEする。

  • fileStatusIdを指定指定ない場合、新規レコードをINSERTする。

Example URI

POST /v1/fileStatus/fileStatusSave?fileStatusId=123
URI Parameters
HideShow
fileStatusId
number (required) Example: 123

ファイル出力状況id

status
number (required) Example: 1

ステータス

filePath
string (required) Example: 1

S3ファイルパス

sqsId
number (required) Example: 1

SQSキューid

Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "status": "success",
  "data": [
    {
      "fileStatusId": 123,
      "status": 1,
      "filePath": "1",
      "sqsId": 1
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "status": {
      "type": "string",
      "description": "APIステータス"
    },
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "fileStatusId": {
            "type": "number",
            "description": "ファイル出力状況id"
          },
          "status": {
            "type": "number",
            "description": "ステータス"
          },
          "filePath": {
            "type": "string",
            "description": "S3ファイルパス"
          },
          "sqsId": {
            "type": "number",
            "description": "SQSキューid"
          }
        },
        "required": [
          "fileStatusId",
          "status",
          "filePath",
          "sqsId"
        ]
      }
    }
  },
  "required": [
    "status",
    "data"
  ]
}

Generated by aglio on 29 Jan 2019