V1Fee

November 20, 2019 ยท View on GitHub

Description

V1Fee Note: This model is deprecated.

Properties

NameGetterSetterTypeDescriptionNotes
idgetId()setId($value)stringThe fee's unique ID.[optional]
namegetName()setName($value)stringThe fee's name.[optional]
rategetRate()setRate($value)stringThe rate of the fee, as a string representation of a decimal number. A value of 0.07 corresponds to a rate of 7%.[optional]
calculation_phasegetCalculationPhase()setCalculationPhase($value)stringForthcoming See V1FeeCalculationPhase for possible values[optional]
adjustment_typegetAdjustmentType()setAdjustmentType($value)stringThe type of adjustment the fee applies to a payment. Currently, this value is TAX for all fees. See V1FeeAdjustmentType for possible values[optional]
applies_to_custom_amountsgetAppliesToCustomAmounts()setAppliesToCustomAmounts($value)boolIf true, the fee applies to custom amounts entered into Square Point of Sale that are not associated with a particular item.[optional]
enabledgetEnabled()setEnabled($value)boolIf true, the fee is applied to all appropriate items. If false, the fee is not applied at all.[optional]
inclusion_typegetInclusionType()setInclusionType($value)stringWhether the fee is ADDITIVE or INCLUSIVE. See V1FeeInclusionType for possible values[optional]
typegetType()setType($value)stringIn countries with multiple classifications for sales taxes, indicates which classification the fee falls under. Currently relevant only to Canadian merchants. See V1FeeType for possible values[optional]
v2_idgetV2Id()setV2Id($value)stringThe ID of the CatalogObject in the Connect v2 API. Objects that are shared across multiple locations share the same v2 ID.[optional]

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

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