クラウド見積請求書作成ソフトTOP > ブログ > マニュアル > 7-3,データ登録・更新・削除のAPIの仕様
2014.07.09 

7-3,データ登録・更新・削除のAPIの仕様

1)データ登録

①クライアント
 POST  URL : https://cloudpaper.net/c/api/clientinsert.php

下記の項目をjson(UTF-8)として渡す。

項目名 日本語名 説明
company クライアント名 入力必須

登録済みのクライアント名はエラーとなります。

furigana フリガナ
kubun 法人・個人 法人または個人を指定する。
busyo 部署
yakusyoku 役職
tanto 担当者
tel TEL
fax FAX
mail メール
yubin 郵便番号 「〒」が入力された場合は「〒」が削除されます。
addr 住所
url URL
bikou 備考

 

・レスポンスCODE=200

json形式の戻り値

項目名 日本語名 説明
client_id クライアントID システム内で一意となるクライアントを識別するID
company クライアント名
furigana フリガナ
kubun 法人・個人
busyo 部署
yakusyoku 役職
tanto 担当者
tel TEL
fax FAX
mail メール
yubin 郵便番号 入力データに「〒」の記号が含まれる場合、「〒」の記号は削除される。
addr 住所
url URL “/”は\でエスケープされます。
bikou 備考

 

②商品登録
 POST  URL : https://cloudpaper.net/c/api/productinsert.php

下記の項目をjson(UTF-8)として渡す。

 

項目名 日本語名 説明
koumoku 商品名
hyojyun_tanka 単価
suuryou 数量
tani 単位
item_zei 消費税 4:10%
3:軽減税率8%
2:8%
1:5%
未入力の場合は非課税

 

・レスポンスCODE=200

json形式の戻り値

項目名 日本語名 説明
shohin_id 商品ID システム内で一意となる商品を識別するID
koumoku 商品名
hyojyun_tanka 単価
suuryou 数量
tani 単位
item_zei 消費税
③見積もり書
 POST  URL : https://cloudpaper.net/c/api/quotationinsert.php

下記の項目をjson(UTF-8)として渡す。

項目名 日本語名 説明
mitumori_id 見積No
company 件名 入力必須
syoukei_name1~99 項目(品名) 明細の数だけ出力、小計行の場合はSYOUKEI
tanka1~99 単価 項目名の後ろの数字は1から99までの連番の数字
(小計の場合は未指定)
suuryou1~99 数量 項目名の後ろの数字は1から99までの連番の数字
(小計の場合は未指定)
tanni1~99 単位 項目名の後ろの数字は1から99までの連番の数字
(小計の場合は未指定)
item_zei1~99 消費税率 4:10%
3:軽減税率8%
2:8%
1:5%
未入力の場合は非課税
(小計の場合は未指定)項目名の後ろの数字は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 備考
④請求書
 POST  URL : https://cloudpaper.net/c/api/invoiceinsert.php

下記の項目をjson(UTF-8)として渡す。

項目名 日本語名 説明
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:10%
3:軽減税率8%
2:8%
1:5%
未入力の場合は非課税
(小計の場合は未指定)項目名の後ろの数字は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 備考

2)データ更新

①クライアント
 POST  URL : https://cloudpaper.net/c/api/clientupdate.php

下記の項目をjson(UTF-8)として渡す。

項目名 日本語名 説明
client_id クライアントID 登録時に戻り値として返されたシステム内で一意となるクライアントを識別するID

同一クライアントIDのデータが存在しない場合はエラーとなる。

company クライアント名 登録時に戻り値として返されたシステム内で一意となるクライアントを識別するID
furigana フリガナ
kubun 法人・個人 法人または個人を指定する。
busyo 部署
yakusyoku 役職
tanto 担当者
tel TEL
fax FAX
mail メール
yubin 郵便番号 「〒」が入力された場合は「〒」が削除されます。
addr 住所
url URL
bikou 備考

・レスポンスCODE=200

json形式の戻り値

項目名 日本語名 説明
client_id id
company クライアント名
furigana フリガナ
kubun 法人・個人
busyo 部署
yakusyoku 役職
tanto 担当者
tel TEL
fax FAX
mail メール
yubin 郵便番号
addr 住所
url URL “/”は\でエスケープされます。
bikou 備考
②商品更新
 POST  URL : https://cloudpaper.net/c/api/productupdate.php

下記の項目をjson(UTF-8)として渡す。

項目名 日本語名 説明
shohin_id 商品ID 登録時に戻り値として返されたシステム内で一意となる商品を識別するID

対象となるデータが存在しない場合はエラーとなる。

koumoku 商品名
hyojyun_tanka 単価
suuryou 数量
tani 単位
item_zei 消費税 4:10%
3:軽減税率8%
2:8%
1:5%
未入力の場合は非課税

・レスポンスCODE=200

json形式の戻り値

項目名 日本語名 説明
shohin_id 商品ID システム内で一意となる商品を識別するID

同一商品IDのデータが存在しない場合はエラーとなる。

koumoku 商品名
hyojyun_tanka 単価
suuryou 数量
tani 単位
item_zei 消費税
③見積もり書更新
 POST  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:10% 3:軽減税率8% 2:8% 1:5% 未入力の場合は非課税 (小計の場合は未指定)項目名の後ろの数字は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 備考
④請求書
 POST  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:10% 3:軽減税率8% 2:8% 1:5% 未入力の場合は非課税 (小計の場合は未指定)項目名の後ろの数字は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 備考

3)データ削除

①クライアント
 POST  URL : https://cloudpaper.net/c/api/clientdelete.php

下記の項目をURLに続けて渡す。 下記の項目をURLに続けてパラメータとして渡す。

項目名 日本語名 説明
client_id クライアントID 入力必須

登録時に戻り値として返されたシステム内で一意となるクライアントを識別するIDを指定する。

クライアントIDが示すデータがなければエラー

・レスポンスCODE=200

json形式の戻り値

項目名 日本語名 説明
client_id クライアントID
②商品削除
 POST  URL : https://cloudpaper.net/c/api/productdelete.php

下記の項目をURLに続けて渡す。 下記の項目をURLに続けてパラメータとして渡す。

項目名 日本語名 説明
shohin_id 商品ID 入力必須
登録時に戻り値として返されたシステム内で一意となるクライアントを識別するIDを指定する。
商品IDが示すデータがなければエラー

・レスポンスCODE=200

json形式の戻り値

項目名 日本語名 説明
shohin_id 商品ID
③見積もり書削除
 POST  URL : https://cloudpaper.net/c/api/quotationdelete.php

下記の項目をURLに続けて渡す。 下記の項目をURLに続けてパラメータとして渡す。

項目名 日本語名 説明
mitumori_id 見積No 入力必須
見積Noが示すデータがなければエラー見積Noが示すデータが複数存在したらエラー

・レスポンスCODE=200

json形式の戻り値

項目名 日本語名 説明
mitumori_id 見積No
④請求書
 POST  URL : https://cloudpaper.net/c/api/invoicedelete.php

下記の項目をURLに続けて渡す。 下記の項目をURLに続けてパラメータとして渡す。

項目名 日本語名 説明
seikyu_id 請求書No 入力必須
見積Noが示すデータがなければエラー
見積Noが示すデータが複数存在したらエラー

 

・レスポンスCODE=200

json形式の戻り値

項目名 日本語名 説明
seikyu_id 請求書No 入力必須

 

SHARE
このエントリーをはてなブックマークに追加

請求書の作成をもっとカンタンに!フリーランス・中小企業向けアプリ

見積請求書の作成・管理ができるCLOUD PAPER
WindowsでもMacでも、無料ではじめることができます!

一覧へ戻る