Class: PaymentsAppliedClient

Inherits:
Object
  • Object
show all
Defined in:
lib/lockstep_sdk/clients/payments_applied_client.rb

Instance Method Summary collapse

Constructor Details

#initialize(connection) ⇒ PaymentsAppliedClient

Initialize the PaymentsAppliedClient class with an API client instance.

Parameters:

  • connection (LockstepApi) —

    The API client object for this connection



22
23
24
 
# File 'lib/lockstep_sdk/clients/payments_applied_client.rb', line 22

def initialize(connection)
    @connection = connection
end

Instance Method Details

#create_payments_applied(body:) ⇒ Object

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

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.

Parameters:

  • body (PaymentAppliedModel) —

    The Payments Applied to create



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

def create_payments_applied(body:)
    path = "/api/v1/payments-applied"
    @connection.request(:post, path, body, nil)
end

#delete_payment_applied(id:) ⇒ Object

Deletes the Payment Applied referred to by this unique identifier.

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.

Parameters:

  • id (uuid) —

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



60
61
62
63
 
# File 'lib/lockstep_sdk/clients/payments_applied_client.rb', line 60

def delete_payment_applied(id:)
    path = "/api/v1/payments-applied/#{id}"
    @connection.request(:delete, path, nil, nil)
end

#query_payments_applied(filter:, include_param:, order:, page_size:, page_number:) ⇒ Object

Queries Payments Applied for this account using the specified filtering, sorting, nested fetch, and pagination rules requested.

More information on querying can be found on the [Searchlight Query Language](developer.lockstep.io/docs/querying-with-searchlight) page on the Lockstep Developer website.

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.

Parameters:



88
89
90
91
92
 
# File 'lib/lockstep_sdk/clients/payments_applied_client.rb', line 88

def query_payments_applied(filter:, include_param:, order:, page_size:, page_number:)
    path = "/api/v1/payments-applied/query"
    params = {:filter => filter, :include => include_param, :order => order, :pageSize => page_size, :pageNumber => page_number}
    @connection.request(:get, path, nil, params)
end

#retrieve_payment_applied(id:, include_param:) ⇒ Object

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

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.

Parameters:

  • id (uuid) —

    The unique Lockstep Platform ID number of this Payment Applied; 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: Invoice, Payment



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

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

#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.

Parameters:

  • id (uuid) —

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

  • body (object) —

    A list of changes to apply to this Payment Applied



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