Link payment schedule items to payments from the payment side

A payment can be linked to an existing payment schedule upon creation or update of the payment. You can use the Payment Schedule Number field to specify the payment schedule to be linked to the payment. The payment will then be automatically linked to a payment schedule item of the specified payment schedule.

See Create a payment for information about payment creation.

Note that only when ALL the following requirements are met, the automatic linking can succeed:

• The status of the payment schedule item to be linked must be Pending.

• The amount on the payment schedule item and the payment must be the same.

• The billing document associated with the payment schedule must be the billing document that the payment will pay against.

• The effective date of the payment must be no earlier than “the scheduled date of the payment schedule item - 5 days” AND no later than “the scheduled date of the payment schedule item + 5 days”.

• The payment schedule status must be Active .

• The payment must belong to the same account of the payment schedule.

If the payment matches multiple payment schedule items, the payment schedule item with the earliest scheduled date will be linked to that payment.

Note that no error message will be displayed if the automatic link process has failed.

You can also use the Create a payment and Update a payment REST APIs to link payment to a payment schedule.

Collect Payment Schedule Items

Payment schedule items will be collected by the system scheduled payment run when it reaches the Collection Date and run Hour. For payment schedule items that have been partially paid by payments, the remaining balance will be collected at once by the Payment Run.