クラウド見積請求書作成ソフトTOP > ブログ > 未分類 > 7-2.APIの仕様（各機能共通部分）(Ver 1.01)

2025.01.14　

7-2.APIの仕様（各機能共通部分）(Ver 1.01)

共通

当機能は後日実装予定の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	対象データが複数存在します。

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

クラウド見積請求書ソフト CLOUD PAPER

一覧へ戻る