API version: unstable
API version: 2021-07 Release candidate
API version: 2021-04 Latest
API version: 2021-01
API version: 2020-10
API version: 2020-07
API version: 2020-04
API version: 2020-01 Unsupported
API version: 2019-10 Unsupported

PaymentScheduleSortKeys enum

Version unstable

The set of valid sort keys for the PaymentSchedule query.

Values

  • COMPLETED_AT

    Sort by the completed_at value.

  • DUE_AT

    Sort by the due_at value.

  • ID

    Sort by the id value.

  • ISSUED_AT

    Sort by the issued_at value.

  • RELEVANCE

    During a search (i.e. when the query parameter has been specified on the connection) this sorts the results by relevance to the search term(s). When no search query is specified, this sort key is not deterministic and should not be used.