Documentation

OssSubscription extends Subscription
in package

Table of Contents

Constants

KEY_COUPON  = "coupon"
KEY_CREDIT  = "credit"
KEY_CREDIT_PROMO  = "credit_promo"
KEY_CREDIT_REFUND  = "credit_refund"
KEY_DISCOUNT_ON_INVOICE  = "discount_on_invoice"
KEY_NOT_APPLICABLE  = 'N/A'
KEY_ON_INVOICE  = "on_invoice"
KEY_ON_ITEM  = "on_item"
KEY_SETUP_COST  = "setup_cost"
KEY_SUBTOTAL  = "subtotal"
KEY_TOTAL  = "total"
KEY_UNIT_PRICE  = "unit_price"
MAP_CREDIT_APPLY_TO  = [\Vatjar\Checkout\DTO\Balance::NAME_PROMOTIONAL_CREDITS => self::KEY_CREDIT_PROMO, \Vatjar\Checkout\DTO\Balance::NAME_REFUNDABLE_CREDITS => self::KEY_CREDIT_REFUND]
SERVICE_TYPE_ID  = \Vatjar\Data\Entity\CheckoutServiceType::SERVICE_TYPE_ID_OSS

Properties

$countryId  : int
$isOssRegistered  : bool|null

Methods

addAddon()  : mixed
getAddons()  : array<string|int, Addon>
getBackdateMonths()  : int
Get the value of backdateMonths
getCfServiceStartDate()  : string
getCountryId()  : int
Get the value of countryId
getCoupons()  : Coupon|null
getDiscount()  : mixed
getDiscountAmountFor()  : int|null
getDiscountFor()  : mixed
getGross()  : mixed
getGrossFor()  : mixed
getGrossForAmount()  : mixed
getIsOssRegistered()  : bool|null
getListPriceFor()  : mixed
getNet()  : mixed
getNetFor()  : mixed
getNetVatGrossArrayFor()  : mixed
getPlan()  : Plan
getPrice()  : mixed
getServiceStartDate()  : string
Get the value of serviceStartDate
getSetupCost()  : mixed
getSubscriptionStartDate()  : DateTime
getUnitPrice()  : mixed
getVat()  : mixed
getVatFor()  : mixed
getVatForAmount()  : mixed
isFuture()  : bool
jsonSerialize()  : mixed
jsonSerializeExtraFields()  : array<string|int, mixed>
setAddons()  : self
setCfServiceStartDate()  : self
setCountryId()  : self
Set the value of countryId
setCoupons()  : self
setDiscountFor()  : mixed
setGrossFor()  : mixed
setIsOssRegistered()  : self
setNetAndVatFor()  : mixed
setNetFor()  : mixed
setPlan()  : self
setServiceStartDate()  : self
Set the value of serviceStartDate
setVatFor()  : mixed
getValidFrom()  : string
jsonSerializeDiscounts()  : array<string|int, mixed>|null
jsonSerializeLineItems()  : array<string|int, mixed>
jsonSerializeTotal()  : array<string|int, mixed>
serializeLineItemFor()  : array<string|int, mixed>

Constants

KEY_CREDIT_PROMO

public mixed KEY_CREDIT_PROMO = "credit_promo"

KEY_CREDIT_REFUND

public mixed KEY_CREDIT_REFUND = "credit_refund"

KEY_DISCOUNT_ON_INVOICE

public mixed KEY_DISCOUNT_ON_INVOICE = "discount_on_invoice"

KEY_NOT_APPLICABLE

public mixed KEY_NOT_APPLICABLE = 'N/A'

KEY_ON_INVOICE

public mixed KEY_ON_INVOICE = "on_invoice"

KEY_SETUP_COST

public mixed KEY_SETUP_COST = "setup_cost"

KEY_UNIT_PRICE

public mixed KEY_UNIT_PRICE = "unit_price"

MAP_CREDIT_APPLY_TO

public mixed MAP_CREDIT_APPLY_TO = [\Vatjar\Checkout\DTO\Balance::NAME_PROMOTIONAL_CREDITS => self::KEY_CREDIT_PROMO, \Vatjar\Checkout\DTO\Balance::NAME_REFUNDABLE_CREDITS => self::KEY_CREDIT_REFUND]

SERVICE_TYPE_ID

public mixed SERVICE_TYPE_ID = \Vatjar\Data\Entity\CheckoutServiceType::SERVICE_TYPE_ID_OSS

Properties

Methods

getBackdateMonths()

Get the value of backdateMonths

public getBackdateMonths() : int
Return values
int

getCfServiceStartDate()

public getCfServiceStartDate() : string
Return values
string

getCountryId()

Get the value of countryId

public getCountryId() : int
Return values
int

getDiscountAmountFor()

public getDiscountAmountFor([mixed $element = null ][, mixed $source = null ]) : int|null
Parameters
$element : mixed = null
$source : mixed = null
Return values
int|null

getDiscountFor()

public getDiscountFor(mixed $element[, mixed $source = null ][, mixed $group = null ]) : mixed
Parameters
$element : mixed
$source : mixed = null
$group : mixed = null

getGrossFor()

public getGrossFor(mixed $key) : mixed
Parameters
$key : mixed

getGrossForAmount()

public getGrossForAmount(mixed $amount[, mixed $rate = null ]) : mixed
Parameters
$amount : mixed
$rate : mixed = null

getIsOssRegistered()

public getIsOssRegistered() : bool|null
Return values
bool|null

getListPriceFor()

public getListPriceFor(mixed $key) : mixed
Parameters
$key : mixed

getNetFor()

public getNetFor(mixed $key) : mixed
Parameters
$key : mixed

getNetVatGrossArrayFor()

public final getNetVatGrossArrayFor(string $key) : mixed
Parameters
$key : string

getServiceStartDate()

Get the value of serviceStartDate

public getServiceStartDate() : string
Return values
string

getSubscriptionStartDate()

public getSubscriptionStartDate() : DateTime
Return values
DateTime

getVatFor()

public getVatFor(mixed $key) : mixed
Parameters
$key : mixed

getVatForAmount()

public getVatForAmount(mixed $amount[, mixed $rate = null ]) : mixed
Parameters
$amount : mixed
$rate : mixed = null

jsonSerializeExtraFields()

public jsonSerializeExtraFields() : array<string|int, mixed>
Return values
array<string|int, mixed>

setAddons()

public setAddons(array<string|int, Addon> $addons) : self
Parameters
$addons : array<string|int, Addon>
Return values
self

setCfServiceStartDate()

public setCfServiceStartDate(string $cfServiceStartDate) : self
Parameters
$cfServiceStartDate : string
Return values
self

setCountryId()

Set the value of countryId

public setCountryId(int $countryId) : self
Parameters
$countryId : int
Return values
self

setCoupons()

public setCoupons(array<string|int, Coupon> $coupons) : self
Parameters
$coupons : array<string|int, Coupon>
Return values
self

setDiscountFor()

public setDiscountFor(mixed $element, mixed $source, mixed $group, mixed $discount) : mixed
Parameters
$element : mixed
$source : mixed
$group : mixed
$discount : mixed

setGrossFor()

public setGrossFor(mixed $key, mixed $amount) : mixed
Parameters
$key : mixed
$amount : mixed

setIsOssRegistered()

public setIsOssRegistered(bool|null $isOssRegistered) : self
Parameters
$isOssRegistered : bool|null
Return values
self

setNetAndVatFor()

public setNetAndVatFor(mixed $key, mixed $netAmount, mixed $vatAmount) : mixed
Parameters
$key : mixed
$netAmount : mixed
$vatAmount : mixed

setNetFor()

public setNetFor(mixed $key, mixed $amount) : mixed
Parameters
$key : mixed
$amount : mixed

setServiceStartDate()

Set the value of serviceStartDate

public setServiceStartDate(string $serviceStartDate) : self
Parameters
$serviceStartDate : string
Return values
self

setVatFor()

public setVatFor(mixed $key, mixed $amount) : mixed
Parameters
$key : mixed
$amount : mixed

getValidFrom()

protected final getValidFrom() : string
Return values
string

jsonSerializeDiscounts()

protected final jsonSerializeDiscounts() : array<string|int, mixed>|null
Return values
array<string|int, mixed>|null

jsonSerializeLineItems()

protected final jsonSerializeLineItems() : array<string|int, mixed>
Return values
array<string|int, mixed>

jsonSerializeTotal()

protected final jsonSerializeTotal() : array<string|int, mixed>
Return values
array<string|int, mixed>

serializeLineItemFor()

protected final serializeLineItemFor(string $key) : array<string|int, mixed>
Parameters
$key : string
Return values
array<string|int, mixed> 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results