OrderReturnServiceCharge
February 26, 2020 ยท View on GitHub
Description
Represents the service charge applied to the original order.
Properties
| Name | Getter | Setter | Type | Description | Notes |
|---|---|---|---|---|---|
| uid | getUid() | setUid($value) | string | Unique ID that identifies the return service charge only within this order. | [optional] [beta] |
| source_service_charge_uid | getSourceServiceChargeUid() | setSourceServiceChargeUid($value) | string | `uid` of the Service Charge from the Order containing the original charge of the service charge. `source_service_charge_uid` is `null` for unlinked returns. | [optional] |
| name | getName() | setName($value) | string | The name of the service charge. | [optional] |
| catalog_object_id | getCatalogObjectId() | setCatalogObjectId($value) | string | The catalog object ID of the associated `CatalogServiceCharge`. | [optional] |
| percentage | getPercentage() | setPercentage($value) | string | The percentage of the service charge, as a string representation of a decimal number. For example, a value of `"7.25"` corresponds to a percentage of 7.25%. Exactly one of `percentage` or `amount_money` should be set. | [optional] |
| amount_money | getAmountMoney() | setAmountMoney($value) | \SquareConnect\Model\Money | The amount of a non-percentage based service charge. Exactly one of `percentage` or `amount_money` should be set. | [optional] |
| applied_money | getAppliedMoney() | setAppliedMoney($value) | \SquareConnect\Model\Money | The amount of money applied to the order by the service charge, including any inclusive tax amounts, as calculated by Square. - For fixed-amount service charges, `applied_money` is equal to `amount_money`. - For percentage-based service charges, `applied_money` is the money calculated using the percentage. | [optional] |
| total_money | getTotalMoney() | setTotalMoney($value) | \SquareConnect\Model\Money | The total amount of money to collect for the service charge. NOTE: if an inclusive tax is applied to the service charge, `total_money` does not equal `applied_money` plus `total_tax_money` since the inclusive tax amount will already be included in both `applied_money` and `total_tax_money`. | [optional] |
| total_tax_money | getTotalTaxMoney() | setTotalTaxMoney($value) | \SquareConnect\Model\Money | The total amount of tax money to collect for the service charge. | [optional] |
| calculation_phase | getCalculationPhase() | setCalculationPhase($value) | string | The calculation phase after which to apply the service charge. See OrderServiceChargeCalculationPhase for possible values | [optional] |
| taxable | getTaxable() | setTaxable($value) | bool | Indicates whether the surcharge can be taxed. Service charges calculated in the `TOTAL_PHASE` cannot be marked as taxable. | [optional] |
| applied_taxes | getAppliedTaxes() | setAppliedTaxes($value) | \SquareConnect\Model\OrderLineItemAppliedTax[] | The list of references to `OrderReturnTax` entities applied to the `OrderReturnServiceCharge`. Each `OrderLineItemAppliedTax` has a `tax_uid` that references the `uid` of a top-level `OrderReturnTax` that is being applied to the `OrderReturnServiceCharge`. On reads, the amount applied is populated. | [optional] [beta] |
Note: All properties are protected and only accessed via getters and setters.