Class: PaymentTaxRate

payments.PaymentTaxRate()

new PaymentTaxRate()

Source:

Methods

(static) PaymentTaxRate#getId() → {String}

Get the field value Tax rate id.
Source:
Returns:
Type
String

(static) PaymentTaxRate#getIsDefault() → {Boolean}

Get the field value Whether the tax rate was configued as a default tax rate at the time that the payment was created.
Source:
Returns:
Type
Boolean

(static) PaymentTaxRate#getIsVat() → {Boolean}

Get the field value Whether merchant is configured as VAT
Source:
Returns:
Type
Boolean

(static) PaymentTaxRate#getName() → {String}

Get the field value Tax rate name. This field is optional.
Source:
Returns:
Type
String

(static) PaymentTaxRate#getRate() → {Number}

Get the field value The tax rate. 100% = 1e7.
Source:
Returns:
must be a long integer
Type
Number

(static) PaymentTaxRate#getTaxableAmount() → {Number}

Get the field value The sub-total of line items that the tax was based on. For VAT, this amount includes tax. For all others, this amount does not include tax.
Source:
Returns:
must be a long integer
Type
Number

(static) PaymentTaxRate#getTaxAmount() → {Number}

Get the field value The amount of tax collected. In cases where there are multiple payments for an order then it may be necessary to add an extra cent of tax to the last payment.
Source:
Returns:
must be a long integer
Type
Number

(static) PaymentTaxRate#setId(id)

Set the field value Tax rate id.
Parameters:
Name Type Description
id String
Source:

(static) PaymentTaxRate#setIsDefault(isDefault)

Set the field value Whether the tax rate was configued as a default tax rate at the time that the payment was created.
Parameters:
Name Type Description
isDefault Boolean
Source:

(static) PaymentTaxRate#setIsVat(isVat)

Set the field value Whether merchant is configured as VAT
Parameters:
Name Type Description
isVat Boolean
Source:

(static) PaymentTaxRate#setName(name)

Set the field value Tax rate name. This field is optional.
Parameters:
Name Type Description
name String
Source:

(static) PaymentTaxRate#setRate(rate)

Set the field value The tax rate. 100% = 1e7.
Parameters:
Name Type Description
rate Number must be a long integer
Source:

(static) PaymentTaxRate#setTaxableAmount(taxableAmount)

Set the field value The sub-total of line items that the tax was based on. For VAT, this amount includes tax. For all others, this amount does not include tax.
Parameters:
Name Type Description
taxableAmount Number must be a long integer
Source:

(static) PaymentTaxRate#setTaxAmount(taxAmount)

Set the field value The amount of tax collected. In cases where there are multiple payments for an order then it may be necessary to add an extra cent of tax to the last payment.
Parameters:
Name Type Description
taxAmount Number must be a long integer
Source: