Method: PaymentsAppliedClient#update_payment_applied

Defined in:
lib/lockstep_sdk/clients/payments_applied_client.rb

#update_payment_applied(id:, body:) ⇒ Object

Updates an existing Payment Applied with the information supplied to this PATCH call.

The PATCH method allows you to change specific values on the object while leaving other values alone. As input you should supply a list of field names and new values. If you do not provide the name of a field, that field will remain unchanged. This allows you to ensure that you are only updating the specific fields desired.

A Payment Applied is created by a business who receives a Payment from a customer. A customer may make a single Payment to match an Invoice exactly, a partial Payment for an Invoice, or a single Payment may be made for multiple smaller Invoices. The Payment Applied contains information about which Invoices are connected to which Payments and for which amounts.



49
50
51
52
 
# File 'lib/lockstep_sdk/clients/payments_applied_client.rb', line 49

def update_payment_applied(id:, body:)
    path = "/api/v1/payments-applied/#{id}"
    @connection.request(:patch, path, body.to_camelback_keys.to_json, nil)
end