Payment Line Apply Input

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.

JSON Example 

1{
2  "appliedToId": "3ttR000000001IkIAI",
3  "amount": 10,
4  "effectiveDate": "2020-08-11T07:53:15.000Z",
5  "comments": "Apply payment",
6  "associatedAccountId": "001R00000060AyuIAE"
7}

Properties 

NameTypeDescriptionRequired 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​DateStringDate from which the payment line application takes effect.Optional64.0

Supported values:

  • Invoice
  • Invoice Line