アーカイブ : 2014年7月

2014.07.10 

「単位」を入力できるようになりました

見積請求書作成時に、自由に「単位」を追加できるようになりました。

単位追加

「単位(個、式)を入力」にチェックをつけると、単位の項目が出てきますので、式・個・cmなど自由にご利用いただけます。

2014.07.09 

7-3,データ登録・更新・削除のAPIの仕様

1)データ登録

①クライアント
 POST  URL : https://cloudpaper.net/c/api/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/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/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 備考

2)データ更新

①クライアント
 POST  URL : https://cloudpaper.net/c/api/clientupdate.php

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

項目名 日本語名 説明
client_id クライアントID 登録時に戻り値として返されたシステム内で一意となるクライアントを識別するID

同一クライアントIDのデータが存在しない場合はエラーとなる。

company クライアント名 登録時に戻り値として返されたシステム内で一意となるクライアントを識別するID
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 備考
②商品更新
 POST  URL : https://cloudpaper.net/c/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 消費税
③見積もり書更新
 POST  URL : https://cloudpaper.net/c/api/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 備考
④請求書
 POST  URL : https://cloudpaper.net/c/api/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 備考

3)データ削除

①クライアント
 POST  URL : https://cloudpaper.net/c/api/clientdelete.php

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

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

登録時に戻り値として返されたシステム内で一意となるクライアントを識別するIDを指定する。

クライアントIDが示すデータがなければエラー

・レスポンスCODE=200

json形式の戻り値

項目名 日本語名 説明
client_id クライアントID
②商品削除
 POST  URL : https://cloudpaper.net/c/api/productdelete.php

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

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

・レスポンスCODE=200

json形式の戻り値

項目名 日本語名 説明
shohin_id 商品ID
③見積もり書削除
 POST  URL : https://cloudpaper.net/c/api/quotationdelete.php

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

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

・レスポンスCODE=200

json形式の戻り値

項目名 日本語名 説明
mitumori_id 見積No
④請求書
 POST  URL : https://cloudpaper.net/c/api/invoicedelete.php

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

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

 

・レスポンスCODE=200

json形式の戻り値

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

 

2014.07.09 

7-2,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
errors エラー
messages メッセージ 日本語のエラーメッセージが表示されます。
type タイプ

2014.07.09 

7-1.APIの概要

概要

APIを利用することで下記の操作を実行する事が出来ます。

  • ・クライアントの登録・変更・削除
  • ・商品の登録・変更・削除
  • ・見積書の登録・変更・削除
  • ・請求書の登録・変更・削除

 

APIを使用する手順

APIを利用は下記の手順で実施します。

APIキーの発行

apiキーは管理画面で発行を行い管理者のみ設定可能です。

①メニューよりAPIキーを選択する。

 

②APIKEY発行ボタンをクリックする。

③APIKEY発行が発行されるのでコピーしてアプリケーションに記述する。(APIKEY発行ボタンをクリック毎にAPIキーは変更されます)

2014.07.09 

6-1.CSVエクスポート

エクスポートメニュー

メニューから「エクスポート」をクリックします。


エクスポート

期間、見積書・請求書などの項目を選択後、「CSVエクスポート」をクリックするとダウンロードがはじまります。


エクセル

CSVデータはエクセルで開けますので、自由に加工してご利用いただけるほか、バックアップとしてもご活用いただけます。

2014.07.09 

5-1.売上レポートを確認する

売上レポートメニュー

メニューから「売上レポート」を選択します。


売上レポート

請求書を元に、グラフや月別・クライアント別の売上を確認することができます。

2014.07.09 

4-2.見積請求書個別のログを確認する

ログボタン

見積請求書の詳細ページのメニューボタンより、「ログ」をクリックします。


個別ログ

該当する見積請求書に関するログが時系列で表示されます。

2014.07.09 

4-1.作業ログを確認する

ログ

メニューから「ログ」をクリックします。


ログ一覧

見積書をいつ作成・編集したか、メールで送ったかなどの作業ログを確認することができます。

2014.07.09 

3-10.請求書から納品書・領収書を作成する

見積請求書

メニューから「請求書」をクリックします。


請求書一覧

納品書・領収書を作成したい請求書をクリックします。


納品・領収書

詳細ページにて「納品書」および「領収書」をクリックすると、請求書をもとに書類が作成され、プレビューできます。


領収書

2014.07.09 

3-9.請求書の状態を管理する

見積請求書

メニューから「請求書」をクリックします。


請求書一覧

一覧で、状態の項目を選択して管理することができます。

「送付済」…請求書を送付したかどうかを管理します。
「入金済」…入金確認後に選択します。


入金予定

請求書の情報をもとに自動的に売上レポートや入金予定欄が更新されます。

1 / 41234