Community

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

  • 投稿

    アバターflying pan

    取引先一覧取得APIの仕様についての質問

    毎度お世話になっております。二点質問がございます。

     – 取引先の作成可能上限数は3000でしょうか?(その場合下の質問については無視していただいて構いません)

     – 取引先一覧取得でのoffsetは最大で7000までしか入力を受け付けないという認識で合っておりますでしょうか?

    リファレンス

     

    質問を連投してしまい恐縮ですが、回答の程よろしくお願いいたします。

    回答

    freee dev-supportfreee dev-support

    ご質問ありがとうございます。

    『取引先一覧APIの limit 上限』

    取引先一覧API (GET /api/1/partners) の limit 上限は、
    リファレンスに記載されている 3000 となります。

    リファレンス

    『取引登録数上限』

    7000件という数値はどこかに記載がございましたか?
    7001件目の登録を試みたさい、エラーメッセージとして返却された形でしょうか?
    認識不足で申し訳ございません、もう少し詳細いただけると幸いです。

    ご確認よろしくお願いいたします。

    アバターflying pan

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

    誤解を与える質問の仕方をしてしまい申し訳ありません。

     

    現在試したい動作として、例えば12000件の取引先が存在する場合、何回かのリクエストで全件を取得する動作があります。

    この時、そもそも取引先が3000件までしか作成できないのであればこのような実装は必要がなくなります(一回のリクエストで3000件取得できる為)。その為、一つ目の質問として「(取得できる取引先件数ではなく)作成できる最大の取引件数は何件か」をさせていただきました。

     

    また、取引先が仮に12000件作成できる場合、全件取得のためにはlimit = 3000で4回のリクエストをすることになります。この時、1回目のリクエストで最初の3000件取得した後、2回目のリクエストでは3001件目から6000件目をすることになると考えております。その為には2回目のリクエストではoffset = 3000, limit = 3000でリクエストをすることになります。同じようにすると、4回目のリクエストではoffset = 9000, limit = 3000でリクエストを送ることになるのですが、リファレンス上で試してみた所500エラーが返ってきました。

    そこでoffsetの値に上限があると仮定して値を検証していったところ、offset <= 7000の場合リクエストに成功し、offset >= 7001の場合は500エラーが帰ってきました。その為、二つ目の質問として「offset は最大で7000か」をさせていただいた次第です。

     

    拙い長文で申し訳ありません。(よくわからない部分があればご指摘お願い致します。)

    重ねてご回答よろしくお願い致します。

    freee dev-supportfreee dev-support

    ご確認ありがとうございます。

    取引先の登録件数ですが現状特定の制限はもうけていないかと思われます。
    ※ 約 7000 件登録された状態では問題ない事を確認しています。
    ※ 今後も制限が無いことは保証できかねます

    サンプルデータを投入し手元にて、

    * limit:3000, offset:3000
    * limit:3000, offset:6000
    * limit:3000, offset:7000
    * limit:3000, offset:9000

    の条件で実行しましたが 500 エラーは発生しませんでした。
    現在も発生しますでしょうか?

    たまたまその時発生した可能性がございます。
    再度ご確認いただき、改善がされない場合。

    * 実際に実行したときのリクエスト情報 (パラメータ & エンドポイント)
    * ヘッダーを含む完全なレスポンス情報

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

    ご確認よろしくお願いいたします。

    アバターflying pan

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

    現状では3000件以上も作成できるのですね。

    改めて500 エラーが出たやり方を再現してみたところ、500 エラーは出ませんでした。一時的な不具合だった可能性がありますね。(なお当時は24:00頃にリクエストを送信していました。)

     

    ご確認いただきありがとうございました。

    freee dev-supportfreee dev-support

    ご確認ありがとうございます。
    無事解決でき何よりでございます。
    引き続きよろしくお願いいたします。