ConnectApi.PaymentLineApplyRequest

Input representation of the payment line details. This representation covers details on allocation of a payment to a specific invoice line. It also provides additional context through optional fields, such as associated account and effective date.

PropertyTypeDescriptionRequired or OptionalAvailable Version
amountDoubleAmount that’s applied. The amount must be less than the invoice line and payment balance.Required64.0
applied​ToIdStringID of the invoice line that this payment is applied to. Specify the IDs for these records.Required64.0
associated​AccountIdStringID of the associated account.Optional64.0
commentsStringComments that you can add to the payment line application.Optional64.0
effective​DateDatetimeDate from which the payment line application takes effect.Optional64.0

applied​ToId values:

  • Invoice
  • Invoice Line