6-3.請求書(invoice)インポート
共通仕様
ファイル取込時の仕様
〔新規/更新/削除〕
請求Noはユニークキー（固有キー）となります。新規登録の場合は、一意となる請求Noを新たに作成してください。更新を行う場合は、更新対象の請求Noをご指定ください。
インポート時には、請求Noをキーとして一致するデータが存在する場合、各項目に値がある場合には、その内容で上書きされます。
インポート時に、請求Noが一致するデータで、特定の項目の情報を削除したい場合は、「％削除％」（全角4文字）をその項目に入力してください。該当項目のデータが削除されます。
〔取込エラー〕
同一の請求Noのデータが、同一ファイル内に複数存在する場合は、重複エラーとなり、データの取り込みは行われません。
同一の請求Noに対して、明細行番号が重複している場合も、重複エラーと判定され、データの取り込みは行われません。
クライアントは事前に登録されている必要があります。登録済みの「client_id」を入力してください。この項目は条件付き必須です。「client_id」が未入力で、かつクライアント名が未入力、または重複している場合には、エラーとなりデータの取り込みはできません。
担当者情報を取り込む場合は、該当する担当者のメールアドレスが必須です。メールアドレスをキーとして担当者情報を取得します。メールアドレスが存在しない、または重複している場合は、エラーとなりデータは取り込まれません。
必須項目に値が入力されていない場合は、必須項目エラーとなり、データは取り込まれません。必須項目の詳細については、別途記載のファイルレイアウトをご参照ください。
〔CSVファイル仕様〕
1行目の「請求No」などの行（ヘッダー部分）はそのまま残してください。
ファイルの取込時には、文字コードとしてShift_JIS（外字には対応しておりません）を使用しております。
ファイルサイズは200KBまでアップロード可能です。制限を超えるとエラーとなりデータは取り込まれません。
ファイル（項目）レイアウト
| NO | 項目名 | 内容 |
|---|---|---|
| 1 | 請求NO | 必須 |
| 2 | 明細行番号 | １行目=”１”2行目、２行目=”２” |
| 3 | 件名 | 必須 |
| 4 | クライアントID | 条件付必須 ・クライアント名未入力andクライアントID入力の場合：クライアントIDでクライアントが存在するかチェックを行う。存在しないの場合はエラー ・クライアント名未入力andクライアントID未入力の場合：エラー ・クライアント名入力andクライアントID未入力の場合：クライアント名でユーザー登録チェックを行う。同名称のクライアントが複数存在するor存在しないの場合はエラー ・クライアント名入力andクライアントID入力の場合：クライアントIDでクライアントが存在するかチェックを行う。存在しないの場合はエラー |
| 5 | クライアント名 | 必須 |
| 6 | 作成日 | 必須 日付の様式チェックを行います。YYYY/MM/DD |
| 7 | お支払期日 | 日付の様式チェックを行います。YYYY/MM/DD 未入力も許容。取込み後にワーニングメッセージを表示 |
| 8 | 明細項目 | 明細項目 小計行には「SYOUKEI」を設定 |
| 9 | 単価 | 明細行（小計行を除いて）は数値のみ |
| 10 | 数量 | 明細行（小計行を除いて）は数値のみ |
| 11 | 単位 | |
| 12 | 消費税区分 | 10%=”4″、軽減8％=”3″、8%=”2″、5%=”1″、非課税=”0″ |
| 13 | 備考 | |
| 14 | 源泉徴収税 | 「明細行番号」=1の場合、必須 あり＝”1” なし＝”0” |
| 15 | invice | 「明細行番号」=1の場合、必須 あり＝”1” なし＝”0” |
| 16 | お振込先 | 歯車マーク：自社情報の編集：請求振込先口座情報より取得する場合は「空白」でも可。その場合、データを取り込んだ後に再登録（取得）を行う必要があります。 |
| 17 | 担当者名 | 担当者メールアドレスをキーに情報を取得する為、入力は必要ありません。 |
| 18 | 担当者メールアドレス | 担当者を登録する場合必須 |
ステータス管理機能
共通
ステータス変更の基本仕様
〔各案件レコードのステータス〕
発行側機能では、手動で変更することができます。
| 帳票種別 | 状態一覧 |
|---|---|
| 見積書 | 「送付済」「受注済」「納品済」「請求書発行済」「不採用」 |
| 請求書 | 「送付済」「入金済」「キャンセル」「保留」 |
| 発注書 | 「送付済」「発注済」 |
| 納品書 | 「送付済」 |
| 領収書 | 「送付済」 |
| 入金情報※１ | 「入金」「返金処理」「仮受処理」「再請求」「手数料」「その他」 |
※１ 入金情報は、エキスパートプランでご利用頂ける機能です。
入金消込の際、自動消込処理により条件が合致した時点で、ステータスが「入金済」に変更されます。
受領側の機能では、作業を進めることで「請求書受付」「出金準備中」「完了」へと、工程に応じてステータスが推移します。
メールを送信すると、自動的にステータスが「送信済」に変更されます。
freeeと連携する場合、「送信済」または「入金済」のステータスに推移した時点で、freeeへデータが連携されます。なお、データ連携のトリガーとなるステータスは、freeeの設定画面で任意に設定可能です。
〔外部との送受信のステータス〕
メールの送信履歴機能（ダウンロードURL発行のみ）では、「送信済」「ダウンロード済」などの状態・証跡を確認することができます。
Pepool送信機能では、送信した際に、「送信成功」「送信失敗」など状態を確認することができます。
Pepool受信機能では、受信した際に、「受信成功」「受信失敗」「買取不備」「不備補完」など状態を確認することができます。
〔配送センターとのステータス〕
郵送代行した際は、「発送準備中」「投函」の郵送状態の推移を確認することができます。また一覧リストにステータス（＝タグ）が付与されます。
ステータス変更の権限
以下の帳票種別と権限に応じてステータス（状態）を変更することが出来ます。
| 帳票種別 | 本人変更 | 他メンバ変更 | 管理者変更 |
|---|---|---|---|
| 請求書 | 〇 | 〇 | 〇 |
| 見積書 | 〇 | 変更不可 | 変更不可 |
| 発注書 | 〇 | 変更不可 | 変更不可 |
| 納品書 | 〇 | 変更不可 | 変更不可 |
| 領収書 | 〇 | 変更不可 | 変更不可 |
| 入金消込※１ | 〇※２ | 〇※２ | 〇※２ |
| 請求書受領※１ | 〇 | 〇 | 〇 |
※１ 入金消込は、エキスパートプランでご利用頂ける機能です。
※２ ステータスによって、条件が合致した段階でステータスを変更することが出来ます。
ステータスによる編集制限
発行側機能では、ステータスを手動で変更することができ、また編集が可能になっております。ステータスによって、編集を許可したくない場合は、以下の設定によって制御が可能です。
その他設定画面の表示
右上の歯車メニューより「その他設定」を選択する。
見積書のステータスによる編集制限
「ステータス編集制限の設定」グループ内の「見積書」の右の「ステータス設定」ボタンをクリックする。
編集を禁止したい状態（ステータス）の場合は、チェックボックスにレ点を入力する。
「閉じる」をクリックする。
下部にスクロールして「設定を変更」ボタンをクリック。設定を保存する。
請求書のステータスによる編集制限
「ステータス編集制限の設定」グループ内の「請求書」の右の「ステータス設定」ボタンをクリックする。
編集を禁止したい状態（ステータス）の場合は、チェックボックスにレ点を入力する。
「閉じる」をクリックする。
下部にスクロールして「設定を変更」ボタンをクリック。設定を保存する。
発注書のステータスによる編集制限
「ステータス編集制限の設定」グループ内の「発注書」の右の「ステータス設定」ボタンをクリックする。
編集を禁止したい状態（ステータス）の場合は、チェックボックスにレ点を入力する。
「閉じる」をクリックする。
下部にスクロールして「設定を変更」ボタンをクリック。設定を保存する。
領収書のステータスによる編集制限
「ステータス編集制限の設定」グループ内の「領収書」の右の「ステータス設定」ボタンをクリックする。
編集を禁止したい状態（ステータス）の場合は、チェックボックスにレ点を入力する。
「閉じる」をクリックする。
下部にスクロールして「設定を変更」ボタンをクリック。設定を保存する。
納品書のステータスによる編集制限
「ステータス編集制限の設定」グループ内の「納品書」の右の「ステータス設定」ボタンをクリックする。
編集を禁止したい状態（ステータス）の場合は、チェックボックスにレ点を入力する。
「閉じる」をクリックする。
下部にスクロールして「設定を変更」ボタンをクリック。設定を保存する。
7-2.APIの仕様（各機能共通部分）(Ver 1.01)
共通
当機能は後日実装予定のAPIのマニュアルです。
URLの指定
URLの指定 : https://cloudpaper.net/c/api/機能名.php
APIキーの指定
リクエストヘッダーに含める形式でAPIキーを渡す。
| 項目名 | 日本語名 | 説明 |
|---|---|---|
| apikey | APIキー | APIキーの発行で発行したAPIキー |
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 | 対象データが複数存在します。 |
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キー”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形式）
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 | クライアント名 | 入力必須 送り状では漢字１９文字、請求書では漢字３０文字がで改行されます。 |
| 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 | 備考 |
商品
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 |
クライントのメールアドレス |
| 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 | 備考 |
商品
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 | 入力必須 |
7-2.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キー”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形式）
json形式のデータの戻り値は各機能の項目に記述しています。
エラーの場合のレスポンス・・・ステータス=400
| 項目名 | 日本語名 | 説明 | |
|---|---|---|---|
| status_code | ステータスコード | 400 | |
| errors | エラー | ||
| messages | メッセージ | 日本語のエラーメッセージが表示されます。 | |
| type | タイプ | ||
4-2 下請事業者向けの発注書の仕様について
クライアントの登録
左側のメニューから「クライアント」をクリックします。
右上の「クライアント登録」をクリックします。
社名や住所などを登録します。一度登録すると、見積請求書作成時に呼び出すだけで使うことができるようになります。
下請事業者の場合は「下請事業者」にチェックを入れると、下請事業者向けの発注書を作成することが出来るようになります。
下請事業者をチェックした状態で「銀行休日表示」に「はい」を選択すると発注書に「支払期日が金融機関の休業日にあたる場合当該金融機関の翌営業日にお支払い致します。」の注意書きを編集出力できます。
下請事業者をチェックした状態で「手数料差引表示」に「はい」を選択すると発注書に「金融機関口座へ振り込み際の手数料は差し引いてお支払い致します。」の注意書きを編集出力できます。
登録後は一覧が出てきます。社名や担当者名での検索およびフリガナでの並び替えができます。
下請事業者向けの発注書の仕様
右上の「発注書作成」をクリックする。
クライアント登録にて下請事業者のクライアントを選択すると、選択されたクライアントで「下請事業者」がチェックされている場合は「お支払期日」「納品日」「納品場所」「支払方法」の項目が必須となります。
「下請事業者」事業者がチェックされているクライアントを選択した時に表示される値
| 項目 | 自動表示される内容 |
|---|---|
| お支払期日 | クライアントの「支払方法」の設定に従って「納品日」より計算されます。 |
| 納品日 | 初期値は空欄です。 |
| 納品場所 | クライアントの「住所」が表示されます。（クライアントの「下請け業者」がチェックされていないケースでも表示されます。） |
| 支払方法 | 「銀行振込」が選択されます。 |
| 金融機関の休業日の注意書き | クライアントの「銀行休日表示」が「はい」となっており、かつ、支払方法にて「銀行振込」が選択されている場合に「支払期日が金融機関の休業日にあたる場合当該金融機関の翌営業日にお支払い致します。」が表示されます。 クライアントの「銀行休日表示」が「はい」でない場合や「支払方法」が「銀行振込」でない場合はこの入力ボックス表示されません。 |
手数料差引表示の注意書き | クライアントの「手数料差引表示」が「はい」となっており、かつ、支払方法にて「銀行振込」が選択されている場合に「金融機関口座へ振り込み際の手数料は差し引いてお支払い致します。」が表示されます。 クライアントの「銀行休日表示」が「はい」でない場合や「支払方法」が「銀行振込」でない場合はこの入力ボックス表示されません。 |
他の必要な項目を入力して下の登録ボタンをクリックすると発注書が登録され確認画面が表示されます。
4-1 発注書を作成する
入力画面表示(基本操作)
左のメニューより「発注 / 領収 / 納品書」をクリックする。
「発注書の作成」画面が表示されるので必要な項目を入力する。
下側の「登録する」ボタンをクリックする。
登録した内容が「発注書の詳細」画面に表示されます。
注）クライアントを選択すると納品場所にクライアントの住所が自動的にセットされます。
自社向けの発注書の作成
発注書の入力画面にて「送り先を自社にする」をチェックする。
必要な項目を入力する。
下側の「登録する」ボタンをクリックする。
登録した内容が表示「発注書の詳細」画面にされます。
注文請書の作成
「発注書の詳細」画面にて右上の「請書OFF」をクリックすると「請書ON」に切り替わります。
「発注書」の次のページに「注文請書」が出力されます。
CLOUDPAPER マニュアル
1．初期設定
- 1-1.CloudPaperとは
- 1-2.CloudPaperにユーザー登録する
- 1-3.CloudPaperにログインする
- 1-4.自社情報やロゴ等の初期設定
- 1-5.適格請求書(インボイス)登録方法
2．クライアント・商品を登録する
3．見積請求書（納品書・領収書）を作成する
- 3-1.見積請求書を作成する
- 3-2.見積請求書を印刷する
- 3-3.見積請求書をPDFでダウンロード
- 3-4.複数のPDFをダウンロードする
- 3-5.見積請求書をメール送信する
- 3-6.見積書の状態を管理する
- 3-7.見積書をもとに発注書を作成する
- 3-8.見積書を請求書に変換する
- 3-9.請求書の状態を管理する
- 3-10.請求書から納品書・領収書を作成する
- 3-11.見積書で標準価格・ご提供価格を追加する
4．発注書を作成する
5．売上レポート
6．データのエクスポート・インポート
7．APIを使って他システムと連携する
8．承認ワークフローを使う
9．入金消込機能
10．自動化機能
11．請求書受領機能
12．その他設定
13．ログを確認する
14．使いこなしTIPS集
Kintone連携
〔CLOUDPAPER kintone連携とは〕
CLOUDPAPERとサイボウズ株式会社が提供している、kintoneを利用した見積書連携システムになります。
〔kintone連携設定について〕
CLOUDPAPERとkintoneを連携する場合はkintoneにアプリとプラグインのインストールと設定が必要ですが、ケースとしてCLOUDPAPERのアプリを使用する場合と、お客さまが独自の画面に作成した画面を使用するケースの二つのケースが考えられます。
CLOUDPAPERのアプリを使用する場合とお客さまが独自の画面に作成した画面を使用するケースに分けて手順を説明させていただきます。
〔kintoneプラグイン・アプリのダウンロード〕
- ① CLOUDPAPER のログイン画面にログインする。
- ② 右上の歯車マークをクリックし表示されたメニューよりkintone連携を選択する。
- ③ 今すぐダウンロードをクリックする。
- ④ ダウンロードしたkintone.zipを解凍し、CLOUDPAPER見積書・クライアント.zip、COUDPAPERクライアントプラグイン.zip、COUDPAPER見積書プラグイン.zipを取り出す。
〔kintone連携設定〕
下図のようにインストールと登録・更新処理を行います。
〔kintone連携設定〕
CLOUDPAPERのアプリを使用する場合
１．APIキー発行
- ① CLOUDPAPER のログイン画面にログインする。
- ② 右上の歯車マークをクリックする。
- ③ メニューよりAPIキーを選択する。
- ④ APIKEY発行 ボタンをクリックする。
- ⑤ APIKEYが発行されます。
２．プラグインインストール
CLOUDPAPERのkinetone連携画面のリンクより「COUDPAPERクライアントプラグイン.zip」「COUDPAPER見積書プラグイン.zip」「CLOUDPAPER見積書・クライアント.zip」をダンロード頂き、kintoneへのプラグイン・アプリとして追加、設定が必要になります。
※必ずプラグインをインストールした後にアプリをインストールしてください。
- ① kintone画面にて右上の歯車をクリックする
- ② kintoneシステム管理を選択する。
- ② kintoneシステム管理にてその他 プラグインを選択
- ③ プラグインにて読み込むを選択
- ④ 参照ボタンにて「COUDPAPERクライアントプラグイン.zip」を選択します。
- ⑤ 読み込むボタンをクリックしプラグインに追加します。
- ⑥プラグイン欄に「CLOUDPAPERクライアント連携」が追加されます。
- ⑦「読み込む」を選択
- ⑧「参照」ボタンにて「COUDPAPER見積書プラグイン.zip」を選択します。
- ⑨「読み込む」ボタンをクリックしプラグインに追加します。
- ⑩プラグイン欄に「CLOUDPAPER見積書連携」が追加されます。
３．アプリインストール
- ① kintone画面にて右上の歯車をクリックする
- ② アプリ管理を選択する。
- ③ アプリを作成するを選択する。
- ④ テンプレートファイルを読み込んで作成を選択する。
- ⑤ 参照ボタンにて「CLOUDPAPER見積書・クライアント.zip」を選択します。
- ⑥ アプリを作成をクリックします。
- ⑦ CLOUDPAPERクライアントとCLOUDPAPER見積書が追加されます。
４．APIキー登録
- ① CLOUDPAPERクライアントを選択します。
- ② 右上の歯車を選択します。
- ③ 設定を選択します。
- ④ プラグインを選択します。
- ⑤ 歯車を選択します。
- ⑥ １ APIキー発行の⑤にて取得したAPIキーを入力します。
- ⑦ APIキー保存をクリックします。
- ⑧ OKをクリックします。
- ⑨ アプリを更新をクリックします。
- ⑩ アプリを更新をクリックします。
- ⑪ 家のマークアイコンをクリックします。
- ⑫ CLOUDPAPER見積書を選択します。
- ⑬ 右上の歯車を選択します。
- ⑭ 設定を選択します。
- ⑮ プラグインを選択します。
- ⑯ 歯車を選択します。
- ⑰ １ APIキー発行の⑤にて取得したAPIキーを入力します。
- ⑱ APIキー保存をクリックします。
- ⑲ OKをクリックします。
- ⑳ アプリを更新をクリックします。
- ㉑ アプリを更新をクリックします。
５．項目のマッピング
- ① CLOUDPAPERクライアントを選択します。
- ② 右上の歯車を選択します。
- ③ 設定を選択します。
- ④ プラグインを選択します。
- ⑤ 歯車を選択します。
- ⑥ 設定を保存をクリックします。
- ⑦ OKをクリックします。
- ⑧ アプリを更新をクリックします。
- ⑨ アプリを更新をクリックします。
- ⑩ 家のマークアイコンをクリックします。
- ⑪ CLOUDPAPER見積書を選択します。
- ⑫ 右上の歯車を選択します。
- ⑬ 設定を選択します。
- ⑭ プラグインを選択します。
- ⑮ 歯車を選択します。
- ⑯ 設定を保存をクリックします。
- ⑰ OKをクリックします。
- ⑱ アプリを更新をクリックします。
- ⑲ アプリを更新をクリックします。
お客さまが独自の画面に作成した画面を使用するケース
１．APIキー発行
- CLOUDPAPERのアプリを使用する場合 １．APIキー発行 と同様
２．プラグインインストール
- CLOUDPAPERのアプリを使用する場合 ２．プラグインインストール と同様
３．独自画面作成
- お客様の仕様に合わせてアプリを作成ください。一部、仕様に制限がございますので「５．項目のマッピング」を確認願います。
４．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のアプリを使用する場合の登録・変更方法
１．クライアントの登録
- ① CLOUDPAPERクライアントのアプリをクリックする。
- ② 左上の＋マークをクリックする。
- ③ 必要な項目を入力して、保存をクリックする。
- ④ CLOUDPAPERに反映される
２．見積書の登録
- ① CLOUDPAPER見積書のアプリをクリックする。
- ② 左上の＋マークをクリックする。
- ③ 取得をクリックする。
- ④ クライアントの一覧が表示されるので選択をクリックする。
- ⑤ 品名・数量・単位・単価・消費税率の行を追加したい場合は＋をクリックする。
- ⑥ 必要な項目を入力して保存をクリックする。
- ⑦ CLOUDPAPERに反映される
３．クライアントの変更
- ① CLOUDPAPERクライアントのアプリをクリックする。
- ② 左端の文書マークをクリックする。
- ③ 右上の鉛筆マークをクリックする。
- ④ 修正したい項目を入力して保存をクリックする。
- ⑤ CLOUDPAPERに反映される
４．見積書の変更
- ① CLOUDPAPER見積書のアプリをクリックする。
- ② 左端の文書マークをクリックする。
- ③ 右上の鉛筆マークをクリックする。
- ④ 修正したい項目を入力して保存をクリックする。
- ⑤ CLOUDPAPERに反映される
注意）クライアントの削除・見積書の削除は連携しません。
