V1PaymentSurcharge

March 13, 2019 ยท View on GitHub

Description

V1PaymentSurcharge

Properties

NameGetterSetterTypeDescriptionNotes
namegetName()setName($value)stringThe name of the surcharge.[optional]
applied_moneygetAppliedMoney()setAppliedMoney($value)\SquareConnect\Model\V1MoneyThe amount of money applied to the order as a result of the surcharge.[optional]
rategetRate()setRate($value)stringThe amount of the surcharge as a percentage. The percentage is provided as a string representing the decimal equivalent of the percentage. For example, "0.7" corresponds to a 7% surcharge. Exactly one of rate or amount_money should be set.[optional]
amount_moneygetAmountMoney()setAmountMoney($value)\SquareConnect\Model\V1MoneyThe amount of the surcharge as a Money object. Exactly one of rate or amount_money should be set.[optional]
typegetType()setType($value)stringIndicates the source of the surcharge. For example, if it was applied as an automatic gratuity for a large group. See V1PaymentSurchargeType for possible values[optional]
taxablegetTaxable()setTaxable($value)boolIndicates whether the surcharge is taxable.[optional]
taxesgetTaxes()setTaxes($value)\SquareConnect\Model\V1PaymentTax[]The list of taxes that should be applied to the surcharge.[optional]
surcharge_idgetSurchargeId()setSurchargeId($value)stringA Square-issued unique identifier associated with the surcharge.[optional]

Note: All properties are protected and only accessed via getters and setters.

[Back to Model list] [Back to API list] [Back to README]