2025.01.23
1.初期設定
2.クライアント・商品を登録する
3.見積請求書(納品書・領収書)を作成する
4.発注書を作成する
5.売上レポート
6.データを取り出す
7.APIを使って他システムと連携する
8.承認ワークフローを使う
9.入金消込機能
10.自動化機能
11.請求書受領機能
12.ログを確認する
13.使いこなしTIPS集
2025.01.14
共通
当機能は後日実装予定のAPIのマニュアルです。
URLの指定
URLの指定 : https://cloudpaper.net/c/api/機能名.php
APIキーの指定
リクエストヘッダーに含める形式でAPIキーを渡す。
項目名 |
日本語名 |
説明 |
apikey |
APIキー |
APIキーの発行で発行したAPIキー |
curlコマンドの例)
APIキーが”xxxxxx-xxxxxx-xxxxxx-xxxxxx-xxxxxx”の場合の請求書削除のリクエストの例は下記の通り
curl -X POST -i -H “apikey : xxxxxx-xxxxxx-xxxxxx-xxxxxx-xxxxxx” -d ‘{“seikyu_id”:”3″}’
https://cloudpaper.net/c/api/clientdelete.php
正常終了の場合のレスポンス
ステータス=200
json形式のデータの戻り値は各機能の項目に記述しています。
エラーの場合のレスポンス・・・ステータス=400
json形式のデータ
項目名 |
日本語名 |
説明 |
status_code |
ステータスコード |
400 ※1 |
errors |
エラー |
|
|
messages |
メッセージ |
日本語のエラーメッセージが表示されます。 ※1 |
|
type |
タイプ |
|
※1 エラーメッセージは下記の通り
クライアント登録が出力するエラー
ステータスコード |
エラーメッセージ |
401 |
apiキーが正しくありません。 |
400 |
クライアント数がプランの上限を超えるためアップできません。 |
400 |
クライアント名が未入力です。 |
400 |
メールアドレスが未入力です。 |
クライアント変更が出力するエラー
ステータスコード |
エラーメッセージ |
401 |
apiキーが正しくありません。/td> |
400 |
クライアント名が未入力です。 |
400 |
対象となるクライアントが存在しません。 |
400 |
メールアドレスが未入力です。 |
クライアント削除が出力するエラー
ステータスコード |
エラーメッセージ |
401 |
apiキーが正しくありません。/td> |
400 |
対象となるクライアントが存在しません。 |
見積書登録が出力するエラー
ステータスコード |
エラーメッセージ |
401 |
apiキーが正しくありません。/td> |
400 |
見積書Noは既に存在しています。 |
400 |
源泉徴収税は半角数字で「1」か空で入力してください。 |
400 |
発行日の書式が違います。YYYY/MM/DDで入力してください。 |
400 |
お支払い期日の書式が違います。YYYY/MM/DDで入力してください。 |
400 |
クライアントが入力されていません。 |
400 |
クライアントが登録されていません。 |
400 |
クライアントを特定できません。 |
400 |
件名が入力されていません。 |
見積書更新が出力するエラー
ステータスコード |
エラーメッセージ |
401 |
apiキーが正しくありません。/td> |
400 |
源泉徴収税は半角数字で「1」か空で入力してください。 |
400 |
発行日の書式が違います。YYYY/MM/DDで入力してください。 |
400 |
お支払い期日の書式が違います。YYYY/MM/DDで入力してください。 |
400 |
クライアントが入力されていません。 |
400 |
クライアントが登録されていません。 |
400 |
クライアントを特定できません。 |
400 |
件名が入力されていません。 |
400 |
対象データが存在しません。 |
400 |
対象データが複数存在します。 |
400 |
申請中または承認済の見積書の更新はできません。 |
見積書削除が出力するエラー
ステータスコード |
エラーメッセージ |
401 |
apiキーが正しくありません。/td> |
400 |
対象データが存在しません。 |
400 |
対象データが複数存在します。 |
請求書登録が出力するエラー
ステータスコード |
エラーメッセージ |
401 |
apiキーが正しくありません。/td> |
400 |
請求書Noは既に存在しています。 |
400 |
源泉徴収税は半角数字で「1」か空で入力してください。 |
400 |
発行日の書式が違います。YYYY/MM/DDで入力してください。 |
400 |
お支払い期日の書式が違います。YYYY/MM/DDで入力してください。 |
400 |
クライアントが入力されていません。 |
400 |
クライアントが登録されていません。 |
400 |
クライアントを特定できません。 |
400 |
件名が入力されていません。 |
請求書更新が出力するエラー
ステータスコード |
エラーメッセージ |
401 |
apiキーが正しくありません。/td> |
400 |
源泉徴収税は半角数字で「1」か空で入力してください。 |
400 |
発行日の書式が違います。YYYY/MM/DDで入力してください。 |
400 |
お支払い期日の書式が違います。YYYY/MM/DDで入力してください。 |
400 |
クライアントが入力されていません。 |
400 |
クライアントが登録されていません。 |
400 |
クライアントを特定できません。 |
400 |
件名が入力されていません。 |
400 |
対象データが存在しません。 |
400 |
対象データが複数存在します。 |
400 |
申請中または承認済の見積書の更新はできません。 |
請求書削除が出力するエラー
ステータスコード |
エラーメッセージ |
401 |
apiキーが正しくありません。/td> |
400 |
対象データが存在しません。 |
400 |
対象データが複数存在します。 |
領収書登録が出力するエラー
ステータスコード |
エラーメッセージ |
401 |
apiキーが正しくありません。/td> |
400 |
領収書Noは既に存在しています。 |
400 |
源泉徴収税は半角数字で「1」か空で入力してください。 |
400 |
発行日の書式が違います。YYYY/MM/DDで入力してください。 |
400 |
お支払い期日の書式が違います。YYYY/MM/DDで入力してください。 |
400 |
クライアントが入力されていません。 |
400 |
クライアントが登録されていません。 |
400 |
クライアントを特定できません。 |
400 |
件名が入力されていません。 |
領収書更新が出力するエラー
ステータスコード |
エラーメッセージ |
401 |
apiキーが正しくありません。/td> |
400 |
源泉徴収税は半角数字で「1」か空で入力してください。 |
400 |
発行日の書式が違います。YYYY/MM/DDで入力してください。 |
400 |
お支払い期日の書式が違います。YYYY/MM/DDで入力してください。 |
400 |
クライアントが入力されていません。 |
400 |
クライアントが登録されていません。 |
400 |
クライアントを特定できません。 |
400 |
件名が入力されていません。 |
400 |
対象データが存在しません。 |
400 |
対象データが複数存在します。 |
400 |
申請中または承認済の見積書の更新はできません。 |
領収書削除が出力するエラー
ステータスコード |
エラーメッセージ |
401 |
apiキーが正しくありません。/td> |
400 |
対象データが存在しません。 |
400 |
対象データが複数存在します。 |
2025.01.09
共通
当機能は後日実装予定の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キー |
curlコマンドの例)
APIキー”xxxxxx-xxxxxx-xxxxxx-xxxxxx-xxxxxx”の場合の請求書削除のリクエストの例は下記の通り
curl -X POST -i -H “apikey : xxxxxx-xxxxxx-xxxxxx-xxxxxx-xxxxxx” -d ‘{“seikyu_id”:”3″}’
https://cloudpaper.net/c/api/clientdelete.php
API共通仕様
レスポンスフォーマットは JSON です。
文字コードは UTF-8 です。
通信プロトコルは HTTPS です。
HTTPリクエストヘッダに以下の情報を含めて送信してください。
認証情報(APIキー)
以下の HTTP メソッドにより操作を区別します。
HTTPメソッド |
操作 |
GET |
データ取得 |
POST |
登録 |
PUT |
更新 |
DELETE |
削除 |
エラーデータの仕様(json形式)
正常終了の場合のレスポンス・・・ステータス=200
json形式のデータの戻り値は各機能の項目に記述しています。
エラーの場合のレスポンス・・・ステータス=400
項目名 |
日本語名 |
説明 |
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 |
クライアント名 |
入力必須
送り状では漢字19文字、請求書では漢字30文字がで改行されます。
登録済みのクライアント名はエラーとなります。 |
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: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/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: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 |
備考 |
|
領収書
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:10%
3:軽減税率8%
2:8%
1:5%
未入力の場合は非課税
(小計の場合は未指定)項目名の後ろの数字は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 |
クライアント名 |
送り状では漢字19文字、請求書では漢字30文字がで改行されます。 |
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:10%
3:軽減税率8%
2:8%
1:5%
未入力の場合は非課税 |
・レスポンス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: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 |
備考 |
|
請求書
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: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 |
備考 |
|
領収書
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:10%
3:軽減税率8%
2:8%
1:5%
未入力の場合は非課税
(小計の場合は未指定)項目名の後ろの数字は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 |
入力必須 |
2024.12.09
共通
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キー |
curlコマンドの例)
APIキー”xxxxxx-xxxxxx-xxxxxx-xxxxxx-xxxxxx”の場合の請求書削除のリクエストの例は下記の通り
curl -X POST -i -H “apikey : xxxxxx-xxxxxx-xxxxxx-xxxxxx-xxxxxx” -d ‘{“seikyu_id”:”3″}’
https://cloudpaper.net/c/api/clientdelete.php
エラーデータの仕様(json形式)
正常終了の場合のレスポンス・・・ステータス=200
json形式のデータの戻り値は各機能の項目に記述しています。
エラーの場合のレスポンス・・・ステータス=400
項目名 |
日本語名 |
説明 |
status_code |
ステータスコード |
400 |
errors |
エラー |
|
|
messages |
メッセージ |
日本語のエラーメッセージが表示されます。 |
|
type |
タイプ |
|
2024.11.11
クライアントの登録
販売先情報はもとより仕入先情報も含まれます。仕入先情報における下請事業者に対しては、下請代金支払遅延等防止法第3条に定めた書式を設定する必要があります。
左側のメニューから「クライアント」をクリックします。

右上の「クライアント登録」をクリックします。

社名や住所などを登録します。一度登録すると、見積請求書作成時に呼び出すだけで使うことができるようになります。

下請事業者の場合は「下請事業者」にチェックを入れると、下請事業者向けの発注書を作成することが出来るようになります。
下請事業者をチェックした状態で「銀行休日表示」に「はい」を選択すると発注書に「支払期日が金融機関の休業日にあたる場合当該金融機関の翌営業日にお支払い致します。」の注意書きを編集出力できます。
下請事業者をチェックした状態で「手数料差引表示」に「はい」を選択すると発注書に「金融機関口座へ振り込み際の手数料は差し引いてお支払い致します。」の注意書きを編集出力できます。

登録後は一覧が出てきます。社名や担当者名での検索およびフリガナでの並び替えができます。
下請事業者向けの発注書の仕様

右上の「発注書作成」をクリックする。

クライアント登録にて下請事業者のクライアントを選択すると、選択されたクライアントで「下請事業者」がチェックされている場合は「お支払期日」「納品日」「納品場所」「支払方法」の項目が必須となります。

「下請事業者」事業者がチェックされているクライアントを選択した時に表示される値
項目 |
自動表示される内容 |
お支払期日 |
クライアントの「支払方法」の設定に従って「納品日」より計算されます。 |
納品日 |
初期値は空欄です。 |
納品場所 |
クライアントの「住所」が表示されます。(クライアントの「下請け業者」がチェックされていないケースでも表示されます。) |
支払方法 |
「銀行振込」が選択されます。 |
金融機関の休業日の注意書き |
クライアントの「銀行休日表示」が「はい」となっており、かつ、支払方法にて「銀行振込」が選択されている場合に「支払期日が金融機関の休業日にあたる場合当該金融機関の翌営業日にお支払い致します。」が表示されます。
クライアントの「銀行休日表示」が「はい」でない場合や「支払方法」が「銀行振込」でない場合はこの入力ボックス表示されません。 |
手数料差引表示の注意書き |
クライアントの「手数料差引表示」が「はい」となっており、かつ、支払方法にて「銀行振込」が選択されている場合に「金融機関口座へ振り込み際の手数料は差し引いてお支払い致します。」が表示されます。
クライアントの「銀行休日表示」が「はい」でない場合や「支払方法」が「銀行振込」でない場合はこの入力ボックス表示されません。 |
他の必要な項目を入力して下の登録ボタンをクリックすると発注書が登録され確認画面が表示されます。

2024.11.11
入力画面表示(基本操作)
左のメニューより「発注 / 領収 / 納品書」をクリックする。

「発注書の作成」画面が表示されるので必要な項目を入力する。
下側の「登録する」ボタンをクリックする。

登録した内容が「発注書の詳細」画面に表示されます。
注)クライアントを選択すると納品場所にクライアントの住所が自動的にセットされます。

自社向けの発注書の作成

発注書の入力画面にて「送り先を自社にする」をチェックする。
必要な項目を入力する。
下側の「登録する」ボタンをクリックする。

登録した内容が表示「発注書の詳細」画面にされます。

注文請書の作成

「発注書の詳細」画面にて右上の「請書OFF」をクリックすると「請書ON」に切り替わります。

「発注書」の次のページに「注文請書」が出力されます。
2024.07.07
1.初期設定
2.クライアント・商品を登録する
3.見積請求書(納品書・領収書)を作成する
4.発注書を作成する
5.売上レポート
6.データを取り出す
7.APIを使って他システムと連携する
8.承認ワークフローを使う
9.入金消込機能
10.自動化機能
11.請求書受領機能
12.ログを確認する
13.使いこなしTIPS集
2024.01.16
〔CLOUDPAPER kintone連携とは〕
CLOUDPAPERとサイボウズ株式会社が提供している、kintoneを利用した見積書連携システムになります。
〔kintone連携設定について〕
CLOUDPAPERとkintoneを連携する場合はkintoneにアプリとプラグインのインストールと設定が必要ですが、ケースとしてCLOUDPAPERのアプリを使用する場合と、お客さまが独自の画面に作成した画面を使用するケースの二つのケースが考えられます。
CLOUDPAPERのアプリを使用する場合とお客さまが独自の画面に作成した画面を使用するケースに分けて手順を説明させていただきます。
〔kintoneプラグイン・アプリのダウンロード〕
- ① CLOUDPAPER のログイン画面にログインする。
- ② 右上の歯車マークをクリックし表示されたメニューよりkintone連携を選択する。


- ④ ダウンロードしたkintone.zipを解凍し、CLOUDPAPER見積書・クライアント.zip、COUDPAPERクライアントプラグイン.zip、COUDPAPER見積書プラグイン.zipを取り出す。
〔kintone連携設定〕
下図のようにインストールと登録・更新処理を行います。

〔kintone連携設定〕
CLOUDPAPERのアプリを使用する場合
1.APIキー発行
- ① CLOUDPAPER のログイン画面にログインする。
- ② 右上の歯車マークをクリックする。
- ③ メニューよりAPIキーを選択する。



2.プラグインインストール
CLOUDPAPERのkinetone連携画面のリンクより「COUDPAPERクライアントプラグイン.zip」「COUDPAPER見積書プラグイン.zip」「CLOUDPAPER見積書・クライアント.zip」をダンロード頂き、kintoneへのプラグイン・アプリとして追加、設定が必要になります。
※必ずプラグインをインストールした後にアプリをインストールしてください。
- ① kintone画面にて右上の歯車をクリックする
- ② kintoneシステム管理を選択する。

- ② kintoneシステム管理にてその他 プラグインを選択


- ④ 参照ボタンにて「COUDPAPERクライアントプラグイン.zip」を選択します。

- ⑤ 読み込むボタンをクリックしプラグインに追加します。

- ⑥プラグイン欄に「CLOUDPAPERクライアント連携」が追加されます。


- ⑧「参照」ボタンにて「COUDPAPER見積書プラグイン.zip」を選択します。

- ⑨「読み込む」ボタンをクリックしプラグインに追加します。

- ⑩プラグイン欄に「CLOUDPAPER見積書連携」が追加されます。

3.アプリインストール
- ① kintone画面にて右上の歯車をクリックする
- ② アプリ管理を選択する。


- ④ テンプレートファイルを読み込んで作成を選択する。

- ⑤ 参照ボタンにて「CLOUDPAPER見積書・クライアント.zip」を選択します。


- ⑦ CLOUDPAPERクライアントとCLOUDPAPER見積書が追加されます。

4.APIキー登録
- ① CLOUDPAPERクライアントを選択します。





- ⑥ 1 APIキー発行の⑤にて取得したAPIキーを入力します。
- ⑦ APIキー保存をクリックします。










- ⑰ 1 APIキー発行の⑤にて取得したAPIキーを入力します。
- ⑱ APIキー保存をクリックします。




5.項目のマッピング
- ① CLOUDPAPERクライアントを選択します。



















お客さまが独自の画面に作成した画面を使用するケース
1.APIキー発行
- CLOUDPAPERのアプリを使用する場合 1.APIキー発行 と同様
2.プラグインインストール
- CLOUDPAPERのアプリを使用する場合 2.プラグインインストール と同様
3.独自画面作成
- お客様の仕様に合わせてアプリを作成ください。一部、仕様に制限がございますので「5.項目のマッピング」を確認願います。
4.APIキー登録
5.項目のマッピング
- 独自に作成したクライアントには下記の項目を準備し設定する必要がある。
CLOUDPAPER項目 |
内容 |
kintone項目(フィールドコード) |
クライアント名 |
必須項目 最大200文字 |
Kクライアント名 |
フリガナ |
|
Kフリガナ |
法人・個人 |
法人 個人 のいずれかを指定する。 |
K法人・個人 |
部署 |
|
K部署 |
役職 |
|
K役職 |
担当者 |
|
K担当者 |
TEL |
|
KTEL |
FAX |
|
KFAX |
メール |
|
Kメール |
郵便番号 |
|
K郵便番号 |
住所 |
|
K住所 |
URL |
|
KURL |
備考 |
|
K備考 |
CLOUDPAPER クライアントID(編集禁止) |
連携制御用項目 |
Kclient_id |
- ②独自に作成した見積書には下記の項目を準備し設定する必要がある。
CLOUDPAPER項目 |
内容 |
kintone項目(フィールドコード) |
見積書No |
必須項目 最大200文字 |
K見積No |
発行日 |
必須項目 yyyy/mm/dd形式の日付 |
K発行日 |
納品予定日 |
yyyy/mm/dd形式の日付 |
K納品予定日 |
有効期限 |
yyyy/mm/dd形式の日付 |
K有効期限 |
クライアント名 |
クライアントの連携にて取得するクライアント名と同じ内容を設定する。 |
Kクライアント名 |
CLOUDPAPER クライアントID |
クライアントの連携にて取得するCLOUDPAPER クライアントIDと同じ値 |
Kclient_id |
件名 |
最大200文字 |
K件名 |
|
テーブル |
|
Kテーブル |
品名 |
画面の項目はテーブル内に品名が設定されている形式である必要がある。 |
K品名 |
数量 |
画面の項目はテーブル内に数量が設定されている形式である必要がある。 |
K数量 |
単位 |
画面の項目はテーブル内に単位が設定されている形式である必要がある。 |
K単位 |
単価 |
画面の項目はテーブル内に単価が設定されている形式である必要がある。 |
K単価 |
消費税率 |
画面の項目はテーブル内に消費税率が設定されている形式である必要がある。 1:5% 2:8% 3:軽減税率8% 4:10% |
K消費税率 |
源泉所得税適用 |
1:源泉所得税適用有り 無指定の場合は源泉所得税適用なし |
K源泉所得税適用 |
支払い条件 |
|
K支払条件 |
備考 |
|
K備考 |
連携状態 |
連携制御用項目、プラグインのみが編集する項目 |
K連携状態 |
上記対応表に従って作成した項目を下記の画面(表示する手順はCLOUDPAPERのアプリを使用する場合 5.項目のマッピングを参考にしてください。)に入力し、設定を保存をクリックする。
〔kintone連携〕
CLOUDPAPERのアプリを使用する場合の登録・変更方法
1.クライアントの登録
- ① CLOUDPAPERクライアントのアプリをクリックする。




2.見積書の登録
- ① CLOUDPAPER見積書のアプリをクリックする。



- ④ クライアントの一覧が表示されるので選択をクリックする。

- ⑤ 品名・数量・単位・単価・消費税率の行を追加したい場合は+をクリックする。



3.クライアントの変更
- ① CLOUDPAPERクライアントのアプリをクリックする。





4.見積書の変更
- ① CLOUDPAPER見積書のアプリをクリックする。





注意)クライアントの削除・見積書の削除は連携しません。
2023.11.01
「CLOUD PAPER」は、日本におけるデジタルインボイスの標準仕様「JP PINT」に準拠したデジタルインボイスの送受信機能の提供を開始したことをお知らせします。本サービスは必要に応じてオプションで付帯いただけます。詳しくはお問合せください。
※Peppolについて
Peppol(Pan European Public Procurement Online)とは、公共部門や企業間での、電子的な文書(請求書など)をネットワーク上でやり取りするための、「文書仕様」「ネットワーク」「運用」のグローバルな標準仕様(国際規格)です。ベルギーの国際的非営利組織「OpenPeppol」がその管理等を行っています。現在、欧州各国のみならず、オーストラリア、ニュージーランドやシンガポールなどの国も含め30か国以上で利用が進んでいます。
日本においては、デジタル庁が、日本のPeppol Authority(PA)として、デジタルインボイスの標準仕様(JP PINT)の管理等を行っています。
2023.09.30
自社口座情報登録
口座情報一覧にて「口座情報を登録」をクリックする。

「自社口座情報登録」画面にて口座情報を登録する。
no. |
項目 |
内容 |
① |
振込指定日 |
銀行振込日を指定します。 |
② |
支払口座 |
口座情報から入力した自社の口座を選択します。 |
③ |
名寄せする |
同一振込先に複数の支払が存在する場合に合算してデータを作成する。 |
④ |
名寄せしない |
同一振込先に複数の支払が存在する場合に合算してデータを作成しない。 |
① |
銀行名 |
銀行名を入力する。 |
② |
支店名 |
支店名を入力する。 |
③ |
口座種別 |
普通、当座、その他のいずれかを選択する。 |
④ |
口座番号 |
口座番号を入力する。 |
⑤ |
口座名半角カナ |
口座半角カナを入力する。 |
⑥ |
委託者コード |
金融機関が割り当てる委託者コードを入力する。 |
⑦ |
デフォルト口座 |
チェックすると「zedi出力(個別)」「zedi出力(全件)」を実行の際にチェックした口座が選択された状態で画面が表示されます。必ず一口座指定する必要がある。 |
⑧ |
振込手数料設定 支払金額 |
銀行の手数料の支払金額の範囲のfromを入力する。 |
⑨ |
振込手数料設定 同行宛て |
同行宛ての手数料を入力する。 |
⑩ |
振込手数料設定 他行宛て |
他行宛ての手数料を入力する。 |
⑪ |
振込手数料設定 同行同一支店宛て |
上のチェックボックスをチェックすると同行同一支店宛ての手数料の入力項目が表示されるので、同行同一支店宛ての手数料を入力する。 |
※注意「委託者コード」は、zediデータに記載する必要がある金融機関が会社に割り当てる10桁のコードです。 「振込依頼人委託者コード」や「会社コード」という名称で発行されている場合もございます。
弊社ではこの番号を発行することができないため、コードについてご不明な場合はご利用の金融機関へご確認ください。

「登録する」ボタンをクリックする。

自社口座情報確認
口座情報一覧にて対象となる口座情報をクリックする。

「自社口座情報確認」画面が表示される。

自社口座情報編集
口座情報一覧にて対象となる口座情報をクリックする。

「自社口座情報確認」画面が表示される。

「口座編集」をクリックする。

編集項目を入力後に「登録する」ボタンをクリックする。

a