Community

コミュニティをご利用の際は 【ガイドライン】を確認・同意いただいた上でご利用ください。

  • 投稿

    アバターson

    一覧データ取得APIについての確認事項

    一覧データ取得APIについての確認事項です。

    (1)/partners 取引先一覧の取得、/manual_journals 振替伝票一覧の取得のAPIで検索条件には、limit, offsetが指定できるが、APIの検索結果には、検索条件に合致する取引の総数が出力されていないです。検索条件に合致する取引の総数を取得する方法がありますか?ちなみに、/deals 取引一覧の取得で検索条件に合致する取引の総数が出力されています。

    (2)/items 品目一覧の取得、/sections 部門一覧の取得、/tags メモタグ一覧の取得のAPIの検索条件にlimit, offsetが設定できないようになっていると思いますが、検索条件に合致する一覧データを制限なくすべて取得できる認識があっていますか?

    以上、よろしくお願いいたします。

    回答

    freee dev-supportfreee dev-support

    ご質問有難うございます。

    (1) GET /partners, GET /manual_journals に関して。

    取得した総数が合致しないというのは、
    仮に limit=50 としたときに、レスポンスには 50 未満の結果しか返って来ない。
    という認識でお間違え無いでしょうか?
    対象データが limit 件分ない場合は、レスポンスも limit 以下になります。

    対象データが limit 以上あり、limit 分のレスポンスが受け取れない場合調査致します。

    * company id
    * 再現したときの request パラメーター
    * 再現したときの response (ステータスコード、ヘッダー、コンテンツを含む完全なもの)

    を以下のURLより、お問い合わせ対象を「Public API (会計freee)」にしてご連絡くださいませ。
    https://support.freee.co.jp/hc/ja/requests/new?referral=helppage

    (2) GET /items, GET /sections, GET /tags に関して

    はい。全て取得できる認識でご利用頂ければと存じます。

    どうぞ宜しくお願い致します。

    アバターson

    ご回答ありがとうございます。

    こちらの説明不足でどうもすみませんでした。

    (1) GET /partners, GET /manual_journals に関して。

    取得した総数が合致しないということではないです。

    単に索条件に合致する)/partners 取引先一覧の取得、/manual_journals 振替伝票一覧のAPIを利用して一覧データをすべて取得したいです。

    検索条件に合致する取引の総数が取得できれば、一覧データがすべて取得されたかを判別しやすいですが、

    この二つのAPIで検索条件に合致する取引の総数が出力されていないので、取得された一覧データの件数がlimitより少ない場合、一覧データがすべて取得されているという認識が正しですか。

     

     

    freee dev-supportfreee dev-support

    ご確認有難うございます。

    (1)
    ご質問の意図を勘違いしておりました。
    失礼しました。

    現在総数を取得する事が出来ないため、
    ご指摘の通り『limit より取得件数が少ない』または
    『取得件数が0件になるまで offset を増やす』
    ことで全件取得状態を判定頂ければと存じます。

    別途 /deals の様に meta 情報に総件数を取得できるよう、
    要望がある事を開発チームへフィードバック致します。

    引き続きどうぞ宜しくお願い致します。