7-3.データ登録・更新・削除のAPIの仕様(Ver1.02)

共通

当機能は後日実装予定のAPIのマニュアルです。

URLの指定

URLの指定 : https://cloudpaper.net/c/api/機能名.php

APIキーの指定及び認証

APIの認証は、APIキーをHTTPSによるAPIリクエスト時に付与することにより行います。
APIキーは管理画面より取得します。
取得可能なAPIキーは1契約につき、1つです。APIの再発行は可能です。
APIキーによるアクセスに、IPアドレス制限を付与する事も可能です。
取得したAPIキーはHTTPリクエストヘッダーに付与して使用します。
　　以下の通りリクエストヘッダーに含める形式でAPIキーを渡します。

項目名	日本語名	説明
apikey	APIキー	APIキーの発行で発行したAPIキー

 

 

API共通仕様

レスポンスフォーマットは JSON です。
文字コードは UTF-8 です。
通信プロトコルは HTTPS です。
HTTPリクエストヘッダに以下の情報を含めて送信してください。
　　認証情報(APIキー)
以下の HTTP メソッドにより操作を区別します。

HTTPメソッド	操作
GET	データ取得
POST	登録
PUT	更新
DELETE	削除

 

 

エラーデータの仕様（json形式）

項目名		日本語名	説明
status_code		ステータスコード	400 ※1
errors		エラー
	messages	メッセージ	日本語のエラーメッセージが表示されます。 ※1
	type	タイプ	内容は別途協議

 

※1 エラーメッセージは下記の通り
クライアント登録が出力するエラー

ステータスコード	エラーメッセージ
401	apiキーが正しくありません。
400	クライアント数がプランの上限を超えるためアップできません。
400	クライアント名が未入力です。
400	メールアドレスが未入力です。

クライアント変更が出力するエラー

ステータスコード	エラーメッセージ
401	apiキーが正しくありません。
400	クライアント名が未入力です。
400	対象となるクライアントが存在しません。
400	メールアドレスが未入力です。

クライアント削除が出力するエラー

ステータスコード	エラーメッセージ
401	apiキーが正しくありません。
400	対象となるクライアントが存在しません。

領収書登録が出力するエラー

ステータスコード	エラーメッセージ
401	apiキーが正しくありません。
400	領収書Noは既に存在しています。
400	源泉徴収税は半角数字で「1」か空で入力してください。
400	発行日の書式が違います。YYYY/MM/DDで入力してください。
400	お支払い期日の書式が違います。YYYY/MM/DDで入力してください。
400	クライアントが入力されていません。
400	クライアントが登録されていません。
400	クライアントを特定できません。
400	件名が入力されていません。

領収書更新が出力するエラー

ステータスコード	エラーメッセージ
401	apiキーが正しくありません。
400	源泉徴収税は半角数字で「1」か空で入力してください。
400	発行日の書式が違います。YYYY/MM/DDで入力してください。
400	お支払い期日の書式が違います。YYYY/MM/DDで入力してください。
400	クライアントが入力されていません。
400	クライアントが登録されていません。
400	クライアントを特定できません。
400	件名が入力されていません。
400	対象データが存在しません。
400	対象データが複数存在します。
400	申請中または承認済の見積書の更新はできません。

領収書削除が出力するエラー

ステータスコード	エラーメッセージ
401	apiキーが正しくありません。
400	対象データが存在しません。
400	対象データが複数存在します。

データ登録

当機能は後日実装予定のAPIのマニュアルです。

現在はこちらのVer1.00の機能のみご利用いただけます。

クライアント

　POST　　URL : https://cloudpaper.net/c/api/v102/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/v102/productinsert.php

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

 

項目名	日本語名	説明
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	消費税

見積書

　POST　　URL : https://cloudpaper.net/c/api/v102/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:１０％ 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	備考

請求書

　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:１０％ 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	備考

領収書

　POST　　URL : https://cloudpaper.net/c/v102/api/receiptinsert.php

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

項目名	日本語名	説明
ryousyu_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の形式で日付を指定
bikou	備考

 

・レスポンスCODE=200

json形式の戻り値

項目名	日本語名	説明
ryousyu_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	発行日	“/”は\でエスケープされます。
bikou	備考

データ更新

クライアント

　PUT　　URL : https://cloudpaper.net/c/api/v102/clientupdate.php

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

項目名	日本語名	説明
client_id	クライアントID	登録時に戻り値として返されたシステム内で一意となるクライアントを識別するID 同一クライアントIDのデータが存在しない場合はエラーとなる。 クライントのメールアドレス
company	クライアント名	送り状では漢字１９文字、請求書では漢字３０文字がで改行されます。
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	備考

商品

　PUT　　URL : https://cloudpaper.net/c/v102/api/productupdate.php

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

項目名	日本語名	説明
shohin_id	商品ID	登録時に戻り値として返されたシステム内で一意となる商品を識別するID 対象となるデータが存在しない場合はエラーとなる。
koumoku	商品名
hyojyun_tanka	単価
suuryou	数量
tani	単位
item_zei	消費税	4:１０％ 3:軽減税率８％ 2:８％ 1:５％ 未入力の場合は非課税

・レスポンスCODE=200

json形式の戻り値

項目名	日本語名	説明
shohin_id	商品ID	システム内で一意となる商品を識別するID 同一商品IDのデータが存在しない場合はエラーとなる。
koumoku	商品名
hyojyun_tanka	単価
suuryou	数量
tani	単位
item_zei	消費税

見積書

　PUT　　URL : https://cloudpaper.net/c/api/v102/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	備考

請求書

　PUT　　URL : https://cloudpaper.net/c/api/v102/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	備考

領収書

　PUT　　URL : https://cloudpaper.net/c/api/receiptupdate.php

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

同一の領収書Noのデータが存在しない場合エラー同一の領収書Noのデータが複数存在する場合エラー

項目名	日本語名	説明
ryousyu_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の形式で日付を指定
bikou	備考

 

・レスポンスCODE=200

json形式の戻り値

項目名	日本語名	説明
ryousyu_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	発行日	“/”は\でエスケープされます。
bikou	備考

データ削除

クライアント

　DELETE　　URL : https://cloudpaper.net/c/api/clientdelete.php

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

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

・レスポンスCODE=200

json形式の戻り値

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

商品

　DELETE　　URL : https://cloudpaper.net/c/api/v102/productdelete.php

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

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

・レスポンスCODE=200

json形式の戻り値

項目名	日本語名	説明
shohin_id	商品ID

見積書

　DELETE　　URL : https://cloudpaper.net/c/api/quotationdelete.php

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

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

・レスポンスCODE=200

json形式の戻り値

項目名	日本語名	説明
mitumori_id	見積No

請求書

　DELETE　　URL : https://cloudpaper.net/c/api/invoicedelete.php

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

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

 

・レスポンスCODE=200

json形式の戻り値

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

領収書

　DELETE　　URL : https://cloudpaper.net/c/api/receiptdelete.php

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

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

 

・レスポンスCODE=200

json形式の戻り値

項目名	日本語名	説明
ryousyu_id	領収書No	入力必須

 

一覧へ戻る