Fluent builder for creating and saving an InvoicePayment. Set the payment's properties by chaining calls, add one or more invoices with the amount applied to each, then call build() to create and save the InvoicePayment and link it to those invoices. A payment must be linked to exactly one of a PaymentTransaction or a PointsDebit, never both. Obtained from PaymentManager.newInvoicePaymentBuilder().

Group: Builders

---

Methods

build()

Returns: InvoicePayment

Creates and saves the InvoicePayment using the options set on this builder, and links it to each invoice added via addInvoice.

addInvoice(Invoice invoice, BigDecimal amount)

Returns: InvoicePaymentBuilder

Adds an invoice to be linked to the payment being built, along with the amount applied to it.

paymentDate(Date pd)

Returns: InvoicePaymentBuilder

Sets the date the payment was made. Defaults to null if not set.

createdDate(Date pd)

Returns: InvoicePaymentBuilder

Sets the created date recorded on the payment. Defaults to the current date if not set.

createdBy(Profile pd)

Returns: InvoicePaymentBuilder

Sets the profile the payment is recorded as created by. Defaults to the current user if not set.

paymentAmount(BigDecimal pd)

Returns: InvoicePaymentBuilder

Sets the total amount of the payment.

paymentTransaction(PaymentTransaction pd)

Returns: InvoicePaymentBuilder

Sets the payment transaction the payment is recorded against. Cannot be combined with a points debit.

pointsDebit(PointsDebit pd)

Returns: InvoicePaymentBuilder

Sets the points debit the payment is recorded against. Cannot be combined with a payment transaction.