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

PaymentTerms object

Version unstable

Represents the payment terms for an order or draft order.

Required access

read_payment_terms access scope.

Connections

  • paymentSchedules (PaymentScheduleConnection)

    List of schedules for the payment terms.

    Argument Description
    after ( String )

    Returns the elements that come after the specified cursor.

    before ( String )

    Returns the elements that come before the specified cursor.

    first ( Int )

    Returns up to the first n elements from the list.

    last ( Int )

    Returns up to the last n elements from the list.

    query ( String )

    Supported filter parameters:

    • completed_at
    • due_at
    • issued_at

    See the detailed search syntax for more information about using filters.

    reverse ( Boolean )

    Reverse the order of the underlying list.
    Default value: false

    sortKey ( PaymentScheduleSortKeys )

    Sort the underlying list by the given key.
    Default value: ISSUED_AT

Fields

  • dueInDays (Int)

    Duration of payment terms in days based on the payment terms template used to create the payment terms.

  • id (ID!)

    Globally unique identifier.

  • overdue (Boolean!)

    Whether the payment terms have overdue payment schedules.

  • paymentTermsName (String!)

    The name of the payment terms template used to create the payment terms.

  • paymentTermsType (PaymentTermsType!)

    The type of a payment terms template used to create the payment terms.

Types that return PaymentTerms

Implements