Method: PaymentsClient#retrieve_payment

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

#retrieve_payment(id:, include_param:) ⇒ Object

Retrieves the Payment specified by this unique identifier, optionally including nested data sets.

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:

  • id (uuid) —

    The unique Lockstep Platform ID number of this Payment; NOT the customer’s ERP key

  • include_param (string) —

    To fetch additional data on this object, specify the list of elements to retrieve. Available collections: Applications, Notes, Attachments, CustomFields



34
35
36
37
38
 
# File 'lib/lockstep_sdk/clients/payments_client.rb', line 34

def retrieve_payment(id:, include_param:)
    path = "/api/v1/Payments/#{id}"
    params = {:include => include_param}
    @connection.request(:get, path, nil, params)
end