MFクラウド請求書APIを使用した雑感
結論からいうとAPI使用自体にかなり未完成感を感じました。
アクセストークンの発行
・MFクラウド請求書API スタートアップガイドとgithubを見れば、わりとスムーズにアクセストークンの発行は可能だと思います。
取引先API
・取引先検索のAPIはありません。
→一覧を取得し、eachで回してください。
取引先一覧の取得
・ソートの指定はできません。
・取得フィールドの指定はできません。
取引先の作成
・gitgubには都道府県が「必須」とありますが、実際は必須ではありません。また、実在しない都道府県の登録も可能です。
・レスポンスにある[id]と[departments][0][id]それぞれ役割があり、
取引先の変更・削除には[id]
請求書の登録には[departments][0][id]
を使用します。
(今現在取引先に[departments]が複数つくことはありません。)
取引先の更新
・department[0][id]を渡すと[department]以下も更新できますが、指定しないと[partner]のみ更新されます。
(作成と同じく都道府県は任意です。)
請求書API
検索はかろうじてできますが、かゆいところに手が届きません。
品目とリレーションがあるのかないのか謎です。
請求書一覧の取得
・ソートの指定はできません。
・取得フィールドの指定はできません。
請求書一覧の検索
・検索対象は検索文字列(q)と期間絞込対象(range_key)のみです、複数条件の検索はできません。
・検索文字列(q)と期間絞込対象(range_key)はOR検索になっています。
→◯◯クライアントの2015年1月売上計上の請求書を検索したい場合は、
一度「2015年1月売上計上の請求書を検索」しレスポンスの中から「◯◯クライアント」の請求書を自力で探すこととなります。
・請求書内の品目をkeyにして検索することはできません。
(◯◯品目の請求書、単価10000円の商品を持っている請求書等)
・ソートの指定はできません。
・取得フィールドの指定はできません。
請求書の作成
・[注意]請求書APIから品目を追加すると、APIのレスポンスも正しく、請求書にも記載されますが、品目APIから取得・更新ができません。(管理画面からも見えません。)
事前に品目APIから登録を行い、items['n'][code]に品物APIの[code]のみを入力すればその他の情報を補完されます。
[注意][id]でなく[code]です。
請求書の更新
・[注意][billing]以下は更新できますが、[items]以下は更新できません。
・[items]の追加、削除、別のitemsに置き換えを行いたい場合は、一度請求書を削除し、再度新規作成します。
品目API
・取引先検索のAPIはありません。
→一覧を取得し、eachで回してください。
・レスポンスの[item_code]とgithubにある部分は、
実際には[code]が帰ってくるので注意してください。
サポート体制
・フォードバックフォームはありますが、APIの仕様についてはgithubのissueから開発者に直接質問をする方式です。
・記述時現在では7issueありました。
・質問後1〜2日は待たないとレンポンスはないのでご注意ください。