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