請求書決済リストに作成日によるフィルタリングを追加
新機能
請求書決済を一覧表示する際に、新しい created パラメーターを使用して請求書決済を作成日でフィルタリングできるようになりました。
このパラメーターでは、gt (より大きい)、gte (以上)、lt (より小さい)、lte (以下) という演算子を使って日付範囲を指定することで、日付範囲クエリをサポートします。
影響
list エンドポイントを呼び出す際に、請求書の支払いを作成日でフィルタリングできるようになりました。これにより、取得する支払いをより詳細に制御できるようになり、以下が可能になります。
- 特定の日に作成された請求書決済を取得するには
createdパラメーターにタイムスタンプを指定します。例えば?created=1609459200を指定するとその正確なタイムスタンプで作成された決済を絞り込むことができます。 - 比較演算子を用いて特定の日付以前または以降に作成された請求書決済を取得します。例えば
created[gte]=1609459200を指定すると 2021 年 1 月 1 日以降に作成された請求書決済に絞り込みます。 - 演算子を組み合わせることで指定した日付範囲内の請求書決済を取得できます。例えば
created[gte]=1609459200&created[lt]=1612137600を指定すると 2021 年 1 月に作成された請求書決済に絞り込むことができます。
これらの新しい絞り込み演算子により、すべての請求書決済を取得してクライアント側でフィルタリングする必要性が減り、パフォーマンスが向上し、日付固有のクエリのデータ転送量が軽減されます。