Method: PaymentsClient#create_payments

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

#create_payments(body:) ⇒ Object

Creates one or more Payments within this account and returns the records as created.

A Payment represents money sent from one company to another. A single payment may contain payments for one or more invoices; it is also possible for payments to be made in advance of an invoice, for example, as a deposit. The creator of the Payment is identified by the ‘CustomerId` field, and the recipient of the Payment is identified by the `CompanyId` field. Most Payments are uniquely identified both by a Lockstep Platform ID number and a customer ERP “key” that was generated by the system that originated the Payment. Payments that have not been fully applied have a nonzero `UnappliedAmount` value, which represents a deposit that has been paid and not yet applied to an Invoice.

Parameters:

  • body (PaymentModel) —

    The Payments to create



71
72
73
74
 
# File 'lib/lockstep_sdk/clients/payments_client.rb', line 71

def create_payments(body:)
    path = "/api/v1/Payments"
    @connection.request(:post, path, body, nil)
end