TipSale object

Version unstable

A sale associated with a tip.

Required access

read_orders access scope.

Fields

  • actionType (SaleActionType!)

    The type of order action that the sale represents.

  • id (ID!)

    The unique identifier for the sale.

  • lineItem (LineItem!)

    The line item for the associated sale.

  • lineType (SaleLineType!)

    The line type assocated with the sale.

  • quantity (Int)

    The number of units either ordered or intended to be returned.

  • taxes ([SaleTax!]!)

    All individual taxes associated with the sale.

  • totalAmount (MoneyBag!)

    The total sale amount after taxes and discounts.

  • totalDiscountAmountAfterTaxes (MoneyBag!)

    The total discounts allocated to the line item after taxes.

  • totalDiscountAmountBeforeTaxes (MoneyBag!)

    The total discounts allocated to the line item before taxes.

  • totalTaxAmount (MoneyBag!)

    The total amount of taxes for the sale.

Implements

Version 2021-10 (Release candidate)

A sale associated with a tip.

Required access

read_orders access scope.

Fields

  • actionType (SaleActionType!)

    The type of order action that the sale represents.

  • id (ID!)

    The unique identifier for the sale.

  • lineItem (LineItem!)

    The line item for the associated sale.

  • lineType (SaleLineType!)

    The line type assocated with the sale.

  • quantity (Int)

    The number of units either ordered or intended to be returned.

  • taxes ([SaleTax!]!)

    All individual taxes associated with the sale.

  • totalAmount (MoneyBag!)

    The total sale amount after taxes and discounts.

  • totalDiscountAmountAfterTaxes (MoneyBag!)

    The total discounts allocated to the line item after taxes.

  • totalDiscountAmountBeforeTaxes (MoneyBag!)

    The total discounts allocated to the line item before taxes.

  • totalTaxAmount (MoneyBag!)

    The total amount of taxes for the sale.

Implements

Version 2021-07 (Latest)

A sale associated with a tip.

Required access

read_orders access scope.

Fields

  • actionType (SaleActionType!)

    The type of order action that the sale represents.

  • id (ID!)

    The unique identifier for the sale.

  • lineItem (LineItem!)

    The line item for the associated sale.

  • lineType (SaleLineType!)

    The line type assocated with the sale.

  • quantity (Int)

    The number of units either ordered or intended to be returned.

  • taxes ([SaleTax!]!)

    All individual taxes associated with the sale.

  • totalAmount (MoneyBag!)

    The total sale amount after taxes and discounts.

  • totalDiscountAmountAfterTaxes (MoneyBag!)

    The total discounts allocated to the line item after taxes.

  • totalDiscountAmountBeforeTaxes (MoneyBag!)

    The total discounts allocated to the line item before taxes.

  • totalTaxAmount (MoneyBag!)

    The total amount of taxes for the sale.

Implements