Payment Agreements

Returns the payment agreement for the specified invoice.

Creates a new payment agreement for the specified invoice. The invoice must have status Sent or Partial for the agreement to be created. When the agreement is created, reminders for the invoice are stopped and the invoice due date is updated to the latest payment line date if payment lines are provided. Only one active payment agreement can exist per invoice at a time.

Deletes the payment agreement associated with the specified invoice. When the agreement is deleted, invoice reminders are restarted.

Updates the status of an existing payment agreement linked to an invoice. Supported status transitions are activate and delete.

Note: The invoice must have status Sent or Partial for the update to be accepted. The payment agreement must exist and cannot be set to a status it already has.