〔各案件レコードのステータス〕
発行側機能では、手動で変更することができます。
| 帳票種別 | 状態一覧 |
|---|---|
| 見積書 | 「送付済」「受注済」「納品済」「請求書発行済」「不採用」 |
| 請求書 | 「送付済」「入金済」「キャンセル」「保留」 |
| 発注書 | 「送付済」「発注済」 |
| 納品書 | 「送付済」 |
| 領収書 | 「送付済」 |
| 入金情報※１ | 「入金」「返金処理」「仮受処理」「再請求」「手数料」「その他」 |
※１ 入金情報は、エキスパートプランでご利用頂ける機能です。
入金消込の際、自動消込処理により条件が合致した時点で、ステータスが「入金済」に変更されます。
受領側の機能では、作業を進めることで「請求書受付」「出金準備中」「完了」へと、工程に応じてステータスが推移します。
メールを送信すると、自動的にステータスが「送信済」に変更されます。
freeeと連携する場合、「送信済」または「入金済」のステータスに推移した時点で、freeeへデータが連携されます。なお、データ連携のトリガーとなるステータスは、freeeの設定画面で任意に設定可能です。
〔外部との送受信のステータス〕
メールの送信履歴機能（ダウンロードURL発行のみ）では、「送信済」「ダウンロード済」などの状態・証跡を確認することができます。
Pepool送信機能では、送信した際に、「送信成功」「送信失敗」など状態を確認することができます。
Pepool受信機能では、受信した際に、「受信成功」「受信失敗」「買取不備」「不備補完」など状態を確認することができます。
〔配送センターとのステータス〕
郵送代行した際は、「発送準備中」「投函」の郵送状態の推移を確認することができます。また一覧リストにステータス（＝タグ）が付与されます。
以下の帳票種別と権限に応じてステータス（状態）を変更することが出来ます。
| 帳票種別 | 本人変更 | 他メンバ変更 | 管理者変更 |
|---|---|---|---|
| 請求書 | 〇 | 〇 | 〇 |
| 見積書 | 〇 | 変更不可 | 変更不可 |
| 発注書 | 〇 | 変更不可 | 変更不可 |
| 納品書 | 〇 | 変更不可 | 変更不可 |
| 領収書 | 〇 | 変更不可 | 変更不可 |
| 入金消込※１ | 〇※２ | 〇※２ | 〇※２ |
| 請求書受領※１ | 〇 | 〇 | 〇 |
※１ 入金消込は、エキスパートプランでご利用頂ける機能です。
※２ ステータスによって、条件が合致した段階でステータスを変更することが出来ます。
発行側機能では、ステータスを手動で変更することができ、また編集が可能になっております。ステータスによって、編集を許可したくない場合は、以下の設定によって制御が可能です。
右上の歯車メニューより「その他設定」を選択する。
「ステータス編集制限の設定」グループ内の「見積書」の右の「ステータス設定」ボタンをクリックする。
編集を禁止したい状態（ステータス）の場合は、チェックボックスにレ点を入力する。
「閉じる」をクリックする。
下部にスクロールして「設定を変更」ボタンをクリック。設定を保存する。
「ステータス編集制限の設定」グループ内の「請求書」の右の「ステータス設定」ボタンをクリックする。
編集を禁止したい状態（ステータス）の場合は、チェックボックスにレ点を入力する。
「閉じる」をクリックする。
下部にスクロールして「設定を変更」ボタンをクリック。設定を保存する。
「ステータス編集制限の設定」グループ内の「発注書」の右の「ステータス設定」ボタンをクリックする。
編集を禁止したい状態（ステータス）の場合は、チェックボックスにレ点を入力する。
「閉じる」をクリックする。
下部にスクロールして「設定を変更」ボタンをクリック。設定を保存する。
「ステータス編集制限の設定」グループ内の「領収書」の右の「ステータス設定」ボタンをクリックする。
編集を禁止したい状態（ステータス）の場合は、チェックボックスにレ点を入力する。
「閉じる」をクリックする。
下部にスクロールして「設定を変更」ボタンをクリック。設定を保存する。
「ステータス編集制限の設定」グループ内の「納品書」の右の「ステータス設定」ボタンをクリックする。
編集を禁止したい状態（ステータス）の場合は、チェックボックスにレ点を入力する。
「閉じる」をクリックする。
下部にスクロールして「設定を変更」ボタンをクリック。設定を保存する。
当機能は後日実装予定のAPIのマニュアルです。
URLの指定 : https://cloudpaper.net/c/api/機能名.php
リクエストヘッダーに含める形式でAPIキーを渡す。
| 項目名 | 日本語名 | 説明 |
|---|---|---|
| apikey | APIキー | APIキーの発行で発行したAPIキー |
正常終了の場合のレスポンス
ステータス=200
json形式のデータの戻り値は各機能の項目に記述しています。
エラーの場合のレスポンス・・・ステータス=400
json形式のデータ
| 項目名 | 日本語名 | 説明 | |
|---|---|---|---|
| status_code | ステータスコード | 400 ※1 | |
| errors | エラー | ||
| messages | メッセージ | 日本語のエラーメッセージが表示されます。 ※1 | |
| type | タイプ | ||
| ステータスコード | エラーメッセージ |
|---|---|
| 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 | 対象データが複数存在します。 |
当機能は後日実装予定のAPIのマニュアルです。
URLの指定 : https://cloudpaper.net/c/api/機能名.php
APIの認証は、APIキーをHTTPSによるAPIリクエスト時に付与することにより行います。
APIキーは管理画面より取得します。
取得可能なAPIキーは1契約につき、1つです。APIの再発行は可能です。
APIキーによるアクセスに、IPアドレス制限を付与する事も可能です。
取得したAPIキーはHTTPリクエストヘッダーに付与して使用します。
以下の通りリクエストヘッダーに含める形式でAPIキーを渡します。
| 項目名 | 日本語名 | 説明 |
|---|---|---|
| apikey | APIキー | APIキーの発行で発行したAPIキー |
レスポンスフォーマットは JSON です。
文字コードは UTF-8 です。
通信プロトコルは HTTPS です。
HTTPリクエストヘッダに以下の情報を含めて送信してください。
認証情報(APIキー)
以下の HTTP メソッドにより操作を区別します。
| HTTPメソッド | 操作 |
|---|---|
| GET | データ取得 |
| POST | 登録 |
| PUT | 更新 |
| DELETE | 削除 |
エラーの場合のレスポンス・・・ステータス=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の機能のみご利用いただけます。
下記の項目をjson(UTF-8)として渡す。
| 項目名 | 日本語名 | 説明 |
|---|---|---|
| company | クライアント名 | 入力必須 送り状では漢字１９文字、請求書では漢字３０文字がで改行されます。 |
| furigana | フリガナ | |
| kubun | 法人・個人 | 法人または個人を指定する。 |
| busyo | 部署 | |
| yakusyoku | 役職 | |
| tanto | 担当者 | |
| tel | TEL | |
| fax | FAX | |
| メール | 入力必須 登録済みのメールアドレスはエラーとなります。 |
|
| yubin | 郵便番号 | 「〒」が入力された場合は「〒」が削除されます。 |
| addr | 住所 | |
| url | URL | |
| bikou | 備考 |
・レスポンスCODE=200
json形式の戻り値
| 項目名 | 日本語名 | 説明 |
|---|---|---|
| client_id | クライアントID | クライントのメールアドレス |
| company | クライアント名 | |
| furigana | フリガナ | |
| kubun | 法人・個人 | |
| busyo | 部署 | |
| yakusyoku | 役職 | |
| tanto | 担当者 | |
| tel | TEL | |
| fax | FAX | |
| メール | ||
| yubin | 郵便番号 | 入力データに「〒」の記号が含まれる場合、「〒」の記号は削除される。 |
| addr | 住所 | |
| url | URL | “/”は\でエスケープされます。 |
| bikou | 備考 |
下記の項目を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 | 消費税 |
下記の項目を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 | 備考 |
下記の項目を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 | 備考 |
下記の項目を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 | 備考 |
下記の項目をjson(UTF-8)として渡す。
| 項目名 | 日本語名 | 説明 |
|---|---|---|
| client_id | クライアントID |
クライントのメールアドレス |
| company | クライアント名 | 送り状では漢字１９文字、請求書では漢字３０文字がで改行されます。 |
| furigana | フリガナ | |
| kubun | 法人・個人 | 法人または個人を指定する。 |
| busyo | 部署 | |
| yakusyoku | 役職 | |
| tanto | 担当者 | |
| tel | TEL | |
| fax | FAX | |
| メール | 入力必須 同一のメールアドレスのクライアントが存在しない場合はエラーとなります。同一のメールアドレスのクライアントが複数存在する場合はエラーとなります。 |
|
| yubin | 郵便番号 | 「〒」が入力された場合は「〒」が削除されます。 |
| addr | 住所 | |
| url | URL | |
| bikou | 備考 |
・レスポンスCODE=200
json形式の戻り値
| 項目名 | 日本語名 | 説明 |
|---|---|---|
| client_id | id | |
| company | クライアント名 | |
| furigana | フリガナ | |
| kubun | 法人・個人 | |
| busyo | 部署 | |
| yakusyoku | 役職 | |
| tanto | 担当者 | |
| tel | TEL | |
| fax | FAX | |
| メール | ||
| yubin | 郵便番号 | |
| addr | 住所 | |
| url | URL | “/”は\でエスケープされます。 |
| bikou | 備考 |
下記の項目を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 | 消費税 |
下記の項目を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 | 備考 |
下記の項目を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 | 備考 |
下記の項目を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 | 備考 |
下記の項目をURLに続けて渡す。 下記の項目をURLに続けてパラメータとして渡す。
| 項目名 | 日本語名 | 説明 |
|---|---|---|
| client_id | クライアントID | 入力必須
登録時に戻り値として返されたシステム内で一意となるクライアントを識別するIDを指定する。 クライアントIDが示すデータがなければエラー |
・レスポンスCODE=200
json形式の戻り値
| 項目名 | 日本語名 | 説明 |
|---|---|---|
| client_id | クライアントID |
下記の項目をURLに続けて渡す。 下記の項目をURLに続けてパラメータとして渡す。
| 項目名 | 日本語名 | 説明 |
|---|---|---|
| shohin_id | 商品ID | 入力必須 登録時に戻り値として返されたシステム内で一意となるクライアントを識別するIDを指定する。 商品IDが示すデータがなければエラー |
・レスポンスCODE=200
json形式の戻り値
| 項目名 | 日本語名 | 説明 |
|---|---|---|
| shohin_id | 商品ID |
下記の項目をURLに続けて渡す。 下記の項目をURLに続けてパラメータとして渡す。
| 項目名 | 日本語名 | 説明 |
|---|---|---|
| mitumori_id | 見積No | 入力必須 見積Noが示すデータがなければエラー見積Noが示すデータが複数存在したらエラー |
・レスポンスCODE=200
json形式の戻り値
| 項目名 | 日本語名 | 説明 |
|---|---|---|
| mitumori_id | 見積No |
下記の項目をURLに続けて渡す。 下記の項目をURLに続けてパラメータとして渡す。
| 項目名 | 日本語名 | 説明 |
|---|---|---|
| seikyu_id | 請求書No | 入力必須 請求書Noが示すデータがなければエラー 請求書Noが示すデータが複数存在したらエラー |
・レスポンスCODE=200
json形式の戻り値
| 項目名 | 日本語名 | 説明 |
|---|---|---|
| seikyu_id | 請求書No | 入力必須 |
下記の項目をURLに続けて渡す。 下記の項目をURLに続けてパラメータとして渡す。
| 項目名 | 日本語名 | 説明 |
|---|---|---|
| ryousyu_id | 領収書No | 入力必須 領収書Noが示すデータがなければエラー 領収書Noが示すデータが複数存在したらエラー |
・レスポンスCODE=200
json形式の戻り値
| 項目名 | 日本語名 | 説明 |
|---|---|---|
| ryousyu_id | 領収書No | 入力必須 |
URLの指定 : https://cloudpaper.net/c/api/機能名.php
APIの認証は、APIキーをHTTPSによるAPIリクエスト時に付与することにより行います。
APIキーは管理画面より取得します。
取得可能なAPIキーは1契約につき、1つです。APIの再発行は可能です。
APIキーによるアクセスに、IPアドレス制限を付与する事も可能です。
取得したAPIキーはHTTPリクエストヘッダーに付与して使用します。
以下の通りリクエストヘッダーに含める形式でAPIキーを渡します。
| 項目名 | 日本語名 | 説明 |
|---|---|---|
| apikey | APIキー | APIキーの発行で発行したAPIキー |
エラーの場合のレスポンス・・・ステータス=400
| 項目名 | 日本語名 | 説明 | |
|---|---|---|---|
| status_code | ステータスコード | 400 | |
| errors | エラー | ||
| messages | メッセージ | 日本語のエラーメッセージが表示されます。 | |
| type | タイプ | ||
左側のメニューから「クライアント」をクリックします。
右上の「クライアント登録」をクリックします。
社名や住所などを登録します。一度登録すると、見積請求書作成時に呼び出すだけで使うことができるようになります。
下請事業者の場合は「下請事業者」にチェックを入れると、下請事業者向けの発注書を作成することが出来るようになります。
下請事業者をチェックした状態で「銀行休日表示」に「はい」を選択すると発注書に「支払期日が金融機関の休業日にあたる場合当該金融機関の翌営業日にお支払い致します。」の注意書きを編集出力できます。
下請事業者をチェックした状態で「手数料差引表示」に「はい」を選択すると発注書に「金融機関口座へ振り込み際の手数料は差し引いてお支払い致します。」の注意書きを編集出力できます。
登録後は一覧が出てきます。社名や担当者名での検索およびフリガナでの並び替えができます。
右上の「発注書作成」をクリックする。
クライアント登録にて下請事業者のクライアントを選択すると、選択されたクライアントで「下請事業者」がチェックされている場合は「お支払期日」「納品日」「納品場所」「支払方法」の項目が必須となります。
「下請事業者」事業者がチェックされているクライアントを選択した時に表示される値
| 項目 | 自動表示される内容 |
|---|---|
| お支払期日 | クライアントの「支払方法」の設定に従って「納品日」より計算されます。 |
| 納品日 | 初期値は空欄です。 |
| 納品場所 | クライアントの「住所」が表示されます。（クライアントの「下請け業者」がチェックされていないケースでも表示されます。） |
| 支払方法 | 「銀行振込」が選択されます。 |
| 金融機関の休業日の注意書き | クライアントの「銀行休日表示」が「はい」となっており、かつ、支払方法にて「銀行振込」が選択されている場合に「支払期日が金融機関の休業日にあたる場合当該金融機関の翌営業日にお支払い致します。」が表示されます。 クライアントの「銀行休日表示」が「はい」でない場合や「支払方法」が「銀行振込」でない場合はこの入力ボックス表示されません。 |
手数料差引表示の注意書き | クライアントの「手数料差引表示」が「はい」となっており、かつ、支払方法にて「銀行振込」が選択されている場合に「金融機関口座へ振り込み際の手数料は差し引いてお支払い致します。」が表示されます。 クライアントの「銀行休日表示」が「はい」でない場合や「支払方法」が「銀行振込」でない場合はこの入力ボックス表示されません。 |
他の必要な項目を入力して下の登録ボタンをクリックすると発注書が登録され確認画面が表示されます。
左のメニューより「発注 / 領収 / 納品書」をクリックする。
「発注書の作成」画面が表示されるので必要な項目を入力する。
下側の「登録する」ボタンをクリックする。
登録した内容が「発注書の詳細」画面に表示されます。
注）クライアントを選択すると納品場所にクライアントの住所が自動的にセットされます。
発注書の入力画面にて「送り先を自社にする」をチェックする。
必要な項目を入力する。
下側の「登録する」ボタンをクリックする。
登録した内容が表示「発注書の詳細」画面にされます。
「発注書の詳細」画面にて右上の「請書OFF」をクリックすると「請書ON」に切り替わります。
「発注書」の次のページに「注文請書」が出力されます。
〔CLOUDPAPER kintone連携とは〕
CLOUDPAPERとサイボウズ株式会社が提供している、kintoneを利用した見積書連携システムになります。
〔kintone連携設定について〕
CLOUDPAPERとkintoneを連携する場合はkintoneにアプリとプラグインのインストールと設定が必要ですが、ケースとしてCLOUDPAPERのアプリを使用する場合と、お客さまが独自の画面に作成した画面を使用するケースの二つのケースが考えられます。
CLOUDPAPERのアプリを使用する場合とお客さまが独自の画面に作成した画面を使用するケースに分けて手順を説明させていただきます。
〔kintoneプラグイン・アプリのダウンロード〕
〔kintone連携設定〕
下図のようにインストールと登録・更新処理を行います。
〔kintone連携設定〕
CLOUDPAPERのアプリを使用する場合
１．APIキー発行
２．プラグインインストール
CLOUDPAPERのkinetone連携画面のリンクより「COUDPAPERクライアントプラグイン.zip」「COUDPAPER見積書プラグイン.zip」「CLOUDPAPER見積書・クライアント.zip」をダンロード頂き、kintoneへのプラグイン・アプリとして追加、設定が必要になります。
※必ずプラグインをインストールした後にアプリをインストールしてください。
３．アプリインストール
４．APIキー登録
５．項目のマッピング
お客さまが独自の画面に作成した画面を使用するケース
１．APIキー発行
２．プラグインインストール
３．独自画面作成
４．APIキー登録
５．項目のマッピング
| 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:５％ 2:８％ 3:軽減税率８％ 4:１０％ |
K消費税率 | |
| 源泉所得税適用 | 1:源泉所得税適用有り 無指定の場合は源泉所得税適用なし |
K源泉所得税適用 | |
| 支払い条件 | K支払条件 | ||
| 備考 | K備考 | ||
| 連携状態 | 連携制御用項目、プラグインのみが編集する項目 | K連携状態 | |
上記対応表に従って作成した項目を下記の画面（表示する手順はCLOUDPAPERのアプリを使用する場合 ５．項目のマッピングを参考にしてください。）に入力し、設定を保存をクリックする。
〔kintone連携〕
CLOUDPAPERのアプリを使用する場合の登録・変更方法
１．クライアントの登録
２．見積書の登録
３．クライアントの変更
４．見積書の変更
注意）クライアントの削除・見積書の削除は連携しません。
「CLOUD PAPER」は、日本におけるデジタルインボイスの標準仕様「JP PINT」に準拠したデジタルインボイスの送受信機能の提供を開始したことをお知らせします。本サービスは必要に応じてオプションで付帯いただけます。詳しくはお問合せください。
※Peppolについて
Peppol（Pan European Public Procurement Online)とは、公共部門や企業間での、電子的な文書（請求書など）をネットワーク上でやり取りするための、「文書仕様」「ネットワーク」「運用」のグローバルな標準仕様（国際規格）です。ベルギーの国際的非営利組織「OpenPeppol」がその管理等を行っています。現在、欧州各国のみならず、オーストラリア、ニュージーランドやシンガポールなどの国も含め30か国以上で利用が進んでいます。
日本においては、デジタル庁が、日本のPeppol Authority（PA）として、デジタルインボイスの標準仕様（JP PINT）の管理等を行っています。
