create amendment

POST {{baseUrl}}/payto/agreements/:agreement_uid/amendment

Create an amendment for an existing Agreement.

Any attributes of the existing Agreement that will no longer be relevant after the amendment has been applied must be set to null as part of the amendment. For example, when amending payment_terms.type from "fixed" to "variable", payment_terms.amount must be set to null.

Request Body

{"changes"=>{"description"=>"Payment plan for loan #1234", "validity_end_date"=>"2023-12-31", "payment_terms"=>{"type"=>"fixed", "frequency"=>"monthly", "count"=>1, "amount"=>10000, "max_amount"=>100000, "first_payment_amount"=>100000, "last_payment_amount"=>100000, "first_payment_date"=>"2023-12-31", "last_payment_date"=>"2024-12-31"}, "creditor"=>{"ultimate_party_name"=>"Billie Jean Senior", "party_name"=>"Billie Jean Junior", "account_identifier"=>{"type"=>"bban", "value"=>"123456-98765432"}}, "initiator"=>{"name"=>"Jane's Flowers", "legal_name"=>"Blossoming Flowers Pty Ltd", "abn"=>"56192755287"}}, "sandbox"=>{"simulate"=>"expire", "delay"=>38249886}, "resolution_requested_before"=>"2022-01-20T12:34:56Z"}

HEADERS