-
投稿
請求日範囲などを指定しての請求書一覧の取得ができない
お世話になっております。
会計APIにある請求書一覧取得(https://api.freee.co.jp/api/1/invoices)のパラメータについてなのですが、
いくつかうまく指定することができませんでしたので、質問させていただきます。
一つ目に、請求日による絞り込みができませんでした。
フォーマットをyyyy-MM-ddとして、
請求日の開始日(start_issue_date)、終了日(end_issue_date)を指定しても
取得結果に反映されませんでした。
例えば開始日を2020-06-01とし、終了日を2020-06-29としても、
請求日が2020-06-30の請求書含むすべての請求書が取得されました。
二つ目に、請求書ステータスでも気になる点がありました。
請求書ステータス(invoice_status)にて、”issued”を指定しても反映されず、
代わりに”unsubmitted”を指定すると”issued”の請求書が取得できるようでした。
これらについてご確認いただければ幸いです。
また、何か操作の誤りがあればご指摘ください。
よろしくお願いします。
回答するにはログインが必要です。
回答
具体的にどのようなリクエストを送りどのようなレスポンスが返ってきていますか？
自分の手元で 2020-06-15 ver のエンドポイントを叩いたところ、特におかしな挙動はみられませんでした。
今の所パラメータの指定方法のどこかに誤りがあるのかなと思われます。ご回答ありがとうございます。
リクエストとレスポンス確認はこちらで行いました。
投稿にある、請求日の範囲指定をしてのリクエストは
添付ファイルのfreee_issue_date.jpgようにしました。(事業所コードは伏せています)
そして、そのレスポンスは次のようになりました。（一部省略しています）
———-レスポンス1———-
{
“invoices”: [
{
“id”: 16051233,
“issue_date”: “2020-06-30”,
“web_published_at”: null,
“web_downloaded_at”: null,
“web_confirmed_at”: null,
“mail_sent_at”: null,
“invoice_number”: “1”,
“due_date”: null,
“booking_date”: “2020-06-30”,
“invoice_status”: “issued”,
“payment_status”: “unsettled”,
“payment_date”: null,
“posting_status”: “”,
“invoice_layout”: “standard_classic”
}
]
}——————–
なお、私のアカウントにはこの一つの請求書しか作成されていない状態です。
ここでissue_dateをみると、2020-06-30の請求書がレスポンスに含まれているため、
リクエストで指定したissue_date_startとissue_date_endの日付で絞り込まれていないと思いました。
また、請求書ステータスのほうも同様に、添付ファイルのfreee_invoice_status.jpgのようにリクエストしました。
上記のレスポンス1のように、invoice_statusがissuedの請求書もあるのですが、
レスポンスは、請求書データは一つもヒットしませんでした。
———-レスポンス2———-
{
“invoices”: []
}——————–
これに関しては、請求書を送付済みにすることで検索にかかるようになりました。
やはり、それから何度かやってみたところ同じ結果になってしまいます。
他の方ができているということは、
私のリクエストに間違いがあるのかとは思いますが、
どこが間違っているか原因がわかりません…。
すみませんが、どなたか良ければご指摘お願いします。
（前回の追記で誤って添付したファイルがなぜか削除できなかったため、
見づらくなってしまい申し訳ありません）
自分の手元でも再現しました。
どうもリファレンスから実行したときに期間指定が聞いていないように見えます。
まだ何が違うのか特定できてないのですが、普通に実装すると絞り込みできるかと思います！ご迷惑おかけしてしまい申し訳ございません。
リファレンス経由で実行したときのAPIが旧エンドポイントになっており。
旧エンドポイントの場合、パラメータ名が異なるため全件取得されてしまう状況でした。リファレンス経由で発行されるリクエストではなく、何かしらの言語で実装いただければ適切に取得ができるかと存じます。
※ 新API、旧APIに関してはこちらをご確認ください。リファレンス上での挙動に関しましては不具合としてフィードバックいたします。
ご連絡ありがとうございます。
