2014.07.09
FlexCRMとのAPI連携の仕様
共通
URLの指定
- URLの指定 : https://cloudpaper.net/c/api/機能名.php&パラメータ・・・・・
APIキーの指定（全機能共通）
・URLのパラメータとしてAPIキーを渡す。
| 項目名 | 日本語名 | 説明 |
|---|---|---|
| apikey | APIキー | APIキーの発行で発行したAPIキー |
| curlコマンドの例 |
| APIキーが”xxxxxx-xxxxxx-xxxxxx-xxxxxx-xxxxxx”の場合の請求書削除のリクエストの例は下記の通り curl -X GET -i https://cloudpaper.net/c/api/clientdelete.php?apikey=xxxxxx-xxxxxx-xxxxxx-xxxxxx-xxxxxx&seikyu_id=3 |
・正常終了のレスポンス
ステータス=200
json形式のデータの戻り値は各機能の項目に記述しています。
・エラーの場合のレスポンス
ステータス=400
json形式のデータ
| 項目名 | 日本語名 | 説明 | |
|---|---|---|---|
| status_code | ステータスコード | 400 | |
| errors | エラー | ||
| messages | メッセージ | 日本語のエラーメッセージが表示されます。 | |
| type | タイプ | ||
１）データ登録
①クライアント
GET URL : https://cloudpaper.net/c/api/clientinsert.php
FlexCRMとの連携の場合は、下記の項目をURLに続けてパラメータとして渡す。
| 項目名 | 日本語名 | 説明 |
|---|---|---|
| company | クライアント名 | 入力必須
登録済みのクライアント名はエラーとなります。 |
| furigana | フリガナ | |
| kubun | 法人・個人 | 法人または個人を指定する。 |
| busyo | 部署 | |
| yakusyoku | 役職 | |
| tanto | 担当者 | |
| tel | TEL | |
| fax | FAX | |
| メール | ||
| yubin | 郵便番号 | 「〒」が入力された場合は「〒」が削除されます。 |
| addr | 住所 | |
| url | URL | |
| bikou | 備考 |
・レスポンスCODE=200
json形式の戻り値
| 項目名 | 日本語名 | 説明 |
|---|---|---|
| client_id | クライアントID | システム内で一意となるクライアントを識別するID |
| company | クライアント名 | |
| furigana | フリガナ | |
| kubun | 法人・個人 | |
| busyo | 部署 | |
| yakusyoku | 役職 | |
| tanto | 担当者 | |
| tel | TEL | |
| fax | FAX | |
| メール | ||
| yubin | 郵便番号 | 入力データに「〒」の記号が含まれる場合、「〒」の記号は削除される。 |
| addr | 住所 | |
| url | URL | “/”は\でエスケープされます。 |
| bikou | 備考 |
②商品登録
GET URL : https://cloudpaper.net/c/api/productinsert.php
FlexCRMとの連携の場合は、下記の項目をURLに続けてパラメータとして渡す。
| 項目名 | 日本語名 | 説明 |
|---|---|---|
| koumoku | 商品名 | |
| hyojyun_tanka | 単価 | |
| suuryou | 数量 | |
| tani | 単位 | |
| item_zei | 消費税 | 4:１０％ 3:軽減税率８％ 2:８％ 1:５％ 未入力の場合は非課税 |
・レスポンスCODE=200
json形式の戻り値
| 項目名 | 日本語名 | 説明 |
|---|---|---|
| shohin_id | 商品ID | システム内で一意となる商品を識別するID |
| koumoku | 商品名 | |
| hyojyun_tanka | 単価 | |
| suuryou | 数量 | |
| tani | 単位 | |
| item_zei | 消費税 |
③見積もり書
GET URL : https://cloudpaper.net/c/api/quotationinsert.php
FlexCRMとの連携の場合は、下記の項目をURLに続けてパラメータとして渡す。
| 項目名 | 日本語名 | 説明 |
|---|---|---|
| mitumori_id | 見積No | |
| company | 件名 | 入力必須 |
| syoukei_name1～99 | 項目（品名） | 明細の数だけ出力、小計行の場合はSYOUKEI |
| tanka1～99 | 単価 | 項目名の後ろの数字は1から99までの連番の数字 (小計の場合は未指定） |
| suuryou1～99 | 数量 | 項目名の後ろの数字は1から99までの連番の数字 (小計の場合は未指定） |
| tanni1～99 | 単位 | 項目名の後ろの数字は1から99までの連番の数字 (小計の場合は未指定） |
| item_zei1～99 | 消費税率 | 4:１０％ 3:軽減税率８％ 2:８％ 1:５％ 未入力の場合は非課税 (小計の場合は未指定）項目名の後ろの数字は1から99までの連番の数字 |
| gensen | 源泉所得税適用 | 1:源泉所得税適用有り 無指定の場合は源泉所得税適用なし |
| client | クライアント名 | 入力必須 クライアント名は登録済である必要がある |
| created_at | 発行日 | 入力必須 yyyy/mm/ddの形式で日付を指定されていなければエラー |
| nouhin | 納品予定日 | 入力必須 yyyy/mm/ddの形式で日付を指定されていなければエラー |
| yukoukigen | 有効期限 | yyyy/mm/ddの形式で日付を指定されていなければエラー |
| siharai | 支払い条件 | |
| bikou | 備考 |
・レスポンスCODE=200
json形式の戻り値
| 項目名 | 日本語名 | 説明 |
|---|---|---|
| mitumori_id | 見積No | |
| company | 件名 | |
| syoukei_name1～99 | 項目（品名） | 項目名の後ろの数字は1から99までの連番の数字 |
| tanka1～99 | 単価 | 項目名の後ろの数字は1から99までの連番の数字 |
| suuryou1～99 | 数量 | 項目名の後ろの数字は1から99までの連番の数字 |
| tanni1～99 | 単位 | 項目名の後ろの数字は1から99までの連番の数字 |
| item_zei1～99 | 消費税率 | 項目名の後ろの数字は1から99までの連番の数字 |
| gensen | 源泉所得税適用 | |
| client | クライアント名 | |
| created_at | 発行日 | “/”は\でエスケープされます。 |
| nouhin | 納品予定日 | “/”は\でエスケープされます。 |
| yukoukigen | 有効期限 | |
| siharai | 支払い条件 | |
| bikou | 備考 |
④請求書
GET URL : https://cloudpaper.net/c/api/invoiceinsert.php
FlexCRMとの連携の場合は、下記の項目をURLに続けてパラメータとして渡す。
| 項目名 | 日本語名 | 説明 |
|---|---|---|
| seikyu_id | 請求書No | |
| company | 件名 | 入力必須 |
| syoukei_name1～99 | 項目名（品名） | 項目名の後ろの数字は1から99までの連番の数字 明細の数だけ出力、小計行の場合はSYOUKEI |
| tanka1～99 | 単価 | 項目名の後ろの数字は1から99までの連番の数字 (小計の場合は未指定） |
| suuryou1～99 | 数量 | 項目名の後ろの数字は1から99までの連番の数字 (小計の場合は未指定） |
| tanni1～99 | 単位 | 項目名の後ろの数字は1から99までの連番の数字 (小計の場合は未指定） |
| item_zei1～99 | 消費税率 | 4:１０％ 3:軽減税率８％ 2:８％ 1:５％ 未入力の場合は非課税 (小計の場合は未指定）項目名の後ろの数字は1から99までの連番の数字 |
| gensen | 源泉所得税適用 | 1:源泉所得税適用有り 無指定の場合は源泉所得税適用なし |
| client | クライアント | 入力必須 クライアント名は登録済である必要がある |
| created_at | 発行日 | 入力必須 yyyy/mm/ddの形式で日付を指定 |
| kijitu | お支払い期日 | yyyy/mm/ddの形式で日付を指定 |
| bikou | 備考 |
・レスポンスCODE=200
json形式の戻り値
| 項目名 | 日本語名 | 説明 |
|---|---|---|
| seikyu_id | 請求書No | |
| company | 件名 | |
| syoukei_name1～99 | 項目名（品名） | 項目名の後ろの数字は1から99までの連番の数字 |
| tanka1～99 | 単価 | 項目名の後ろの数字は1から99までの連番の数字 |
| suuryou1～99 | 数量 | 項目名の後ろの数字は1から99までの連番の数字 |
| tanni1～99 | 単位 | 項目名の後ろの数字は1から99までの連番の数字 |
| item_zei1～99 | 消費税率 | 項目名の後ろの数字は1から99までの連番の数字 |
| gensen | 源泉所得税適用 | |
| client | クライアント | |
| created_at | 発行日 | “/”は\でエスケープされます。 |
| kijitu | お支払い期日 | “/”は\でエスケープされます。 |
| bikou | 備考 |
２）データ更新
クライアント・商品の更新・削除についてはIDをFlexCRMに渡す必要があるのでお問い合わせ願います。
①見積もり書更新
GET URL : https://cloudpaper.net/c/api/quotationupdate.php
下記の項目をjson(UTF-8)として渡す。
| 項目名 | 日本語名 | 説明 |
|---|---|---|
| mitumori_id | 見積No | 入力必須
同一の見積Noのデータが存在しない場合エラー 同一の見積Noのデータが複数存在する場合エラー |
| company | 件名 | 入力必須 |
| syoukei_name1～99 | 項目（品名） | 明細の数だけ出力、小計行の場合はSYOUKEI |
| tanka1～99 | 単価 | 項目名の後ろの数字は1から99までの連番の数字 (小計の場合は未指定） |
| suuryou1～99 | 数量 | 項目名の後ろの数字は1から99までの連番の数字 (小計の場合は未指定） |
| tanni1～99 | 単位 | 項目名の後ろの数字は1から99までの連番の数字 (小計の場合は未指定） |
| item_zei1～99 | 消費税率 | 4:１０％ 3:軽減税率８％ 2:８％ 1:５％ 未入力の場合は非課税 (小計の場合は未指定）項目名の後ろの数字は1から99までの連番の数字 |
| gensen | 源泉所得税適用 | 1:源泉所得税適用有り 無指定の場合は源泉所得税適用なし |
| client | クライアント名 | 入力必須 クライアント名は登録済である必要がある |
| created_at | 発行日 | 入力必須 yyyy/mm/ddの形式で日付を指定されていなければエラー |
| nouhin | 納品予定日 | 入力必須 yyyy/mm/ddの形式で日付を指定されていなければエラー |
| yukoukigen | 有効期限 | yyyy/mm/ddの形式で日付を指定されていなければエラー |
| siharai | 支払い条件 | |
| bikou | 備考 |
・レスポンスCODE=200
json形式の戻り値
| 項目名 | 日本語名 | 説明 |
|---|---|---|
| mitumori_id | 見積No | |
| company | 件名 | |
| syoukei_name1～99 | 項目（品名） | 項目名の後ろの数字は1から99までの連番の数字 |
| tanka1～99 | 単価 | 項目名の後ろの数字は1から99までの連番の数字 |
| suuryou1～99 | 数量 | 項目名の後ろの数字は1から99までの連番の数字 |
| tanni1～99 | 単位 | 項目名の後ろの数字は1から99までの連番の数字 |
| item_zei1～99 | 消費税率 | 項目名の後ろの数字は1から99までの連番の数字 |
| gensen | 源泉所得税適用 | |
| client | クライアント名 | |
| created_at | 発行日 | “/”は\でエスケープされます。 |
| nouhin | 納品予定日 | “/”は\でエスケープされます。 |
| yukoukigen | 有効期限 | “/”は\でエスケープされます。 |
| siharai | 支払い条件 | |
| bikou | 備考 |
②請求書
GET URL : https://cloudpaper.net/c/api/invoiceupdate.php
下記の項目をjson(UTF-8)として渡す。
| 項目名 | 日本語名 | 説明 |
|---|---|---|
| seikyu_id | 請求書No | 入力必須
同一の請求書Noのデータが存在しない場合エラー 同一の請求書Noのデータが複数存在する場合エラー |
| company | 件名 | 入力必須 |
| syoukei_name1～99 | 項目名（品名） | 項目名の後ろの数字は1から99までの連番の数字 明細の数だけ出力、小計行の場合はSYOUKEI |
| tanka1～99 | 単価 | 項目名の後ろの数字は1から99までの連番の数字 (小計の場合は未指定） |
| suuryou1～99 | 数量 | 項目名の後ろの数字は1から99までの連番の数字 (小計の場合は未指定） |
| tanni1～99 | 単位 | 項目名の後ろの数字は1から99までの連番の数字 (小計の場合は未指定） |
| item_zei1～99 | 消費税率 | 4:１０％ 3:軽減税率８％ 2:８％ 1:５％ 未入力の場合は非課税 (小計の場合は未指定）項目名の後ろの数字は1から99までの連番の数字 |
| gensen | 源泉所得税適用 | 1:源泉所得税適用有り 無指定の場合は源泉所得税適用なし |
| client | クライアント | 入力必須 クライアント名は登録済である必要がある |
| created_at | 発行日 | 入力必須 yyyy/mm/ddの形式で日付を指定 |
| kijitu | お支払い期日 | yyyy/mm/ddの形式で日付を指定 |
| bikou | 備考 |
・レスポンスCODE=200
json形式の戻り値
| 項目名 | 日本語名 | 説明 |
|---|---|---|
| seikyu_id | 請求書No | |
| company | 件名 | |
| syoukei_name1～99 | 項目名（品名） | 項目名の後ろの数字は1から99までの連番の数字 |
| tanka1～99 | 単価 | 項目名の後ろの数字は1から99までの連番の数字 |
| suuryou1～99 | 数量 | 項目名の後ろの数字は1から99までの連番の数字 |
| tanni1～99 | 単位 | 項目名の後ろの数字は1から99までの連番の数字 |
| item_zei1～99 | 消費税率 | 項目名の後ろの数字は1から99までの連番の数字 |
| gensen | 源泉所得税適用 | |
| client | クライアント | |
| created_at | 発行日 | “/”は\でエスケープされます。 |
| kijitu | お支払い期日 | “/”は\でエスケープされます。 |
| bikou | 備考 |
３）データ削除
クライアント・商品の更新・削除についてはIDをFlexCRMに渡す必要があるのでお問い合わせ願います。
①見積もり書削除
GET URL : https://cloudpaper.net/c/api/quotationdelete.php
下記の項目をURLに続けて渡す。 下記の項目をURLに続けてパラメータとして渡す。
| 項目名 | 日本語名 | 説明 |
|---|---|---|
| mitumori_id | 見積No | 入力必須 見積Noが示すデータがなければエラー見積Noが示すデータが複数存在したらエラー |
・レスポンスCODE=200
json形式の戻り値
| 項目名 | 日本語名 | 説明 |
|---|---|---|
| mitumori_id | 見積No |
②請求書
GET URL : https://cloudpaper.net/c/api/invoicedelete.php
下記の項目をURLに続けて渡す。 下記の項目をURLに続けてパラメータとして渡す。
| 項目名 | 日本語名 | 説明 |
|---|---|---|
| seikyu_id | 請求書No | 入力必須 見積Noが示すデータがなければエラー 見積Noが示すデータが複数存在したらエラー |
・レスポンスCODE=200
json形式の戻り値
| 項目名 | 日本語名 | 説明 |
|---|---|---|
| seikyu_id | 請求書No | 入力必須 |
