Class: LineItemPayment

payments.LineItemPayment()

new LineItemPayment()

Source:

Methods

(static) LineItemPayment#getBinName() → {Null|String}

Get the field value Bin this line item payment was for
Source:
Returns:
Type
Null | String

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

Get the field value Unique identifier; TBD this is confusing because it's used as either line item id or payment id
Source:
Returns:
Type
String

(static) LineItemPayment#getLineItemRef() → {base.Reference}

Get the field value The line item with which the line item payment is associated
Source:
Returns:
Type
base.Reference

(static) LineItemPayment#getPaymentRef() → {base.Reference}

Get the field value The payment with which the line item payment is associated
Source:
Returns:
Type
base.Reference

(static) LineItemPayment#getPercentage() → {Number}

Get the field value Percent of this line item covered by this payment
Source:
Returns:
must be a long integer
Type
Number

(static) LineItemPayment#getRefunded() → {Boolean}

Get the field value Payment has been refunded
Source:
Returns:
Type
Boolean

(static) LineItemPayment#setBinName(binName)

Set the field value Bin this line item payment was for
Parameters:
Name Type Description
binName Null | String
Source:

(static) LineItemPayment#setId(id)

Set the field value Unique identifier; TBD this is confusing because it's used as either line item id or payment id
Parameters:
Name Type Description
id String
Source:

(static) LineItemPayment#setLineItemRef(lineItemRef)

Set the field value The line item with which the line item payment is associated
Parameters:
Name Type Description
lineItemRef base.Reference
Source:

(static) LineItemPayment#setPaymentRef(paymentRef)

Set the field value The payment with which the line item payment is associated
Parameters:
Name Type Description
paymentRef base.Reference
Source:

(static) LineItemPayment#setPercentage(percentage)

Set the field value Percent of this line item covered by this payment
Parameters:
Name Type Description
percentage Number must be a long integer
Source:

(static) LineItemPayment#setRefunded(refunded)

Set the field value Payment has been refunded
Parameters:
Name Type Description
refunded Boolean
Source: