Class: CreditMemoAppliedClient
- Inherits:
-
Object
- Object
- CreditMemoAppliedClient
- Defined in:
- lib/lockstep_sdk/clients/credit_memo_applied_client.rb
Instance Method Summary collapse
-
#create_credit_memo_applications(body:) ⇒ Object
Creates one or more Credit Memo Applications within this account and returns the records as created.
-
#delete_credit_memo_application(id:) ⇒ Object
Deletes the Credit Memo Application referred to by this unique identifier.
-
#initialize(lockstepsdk) ⇒ CreditMemoAppliedClient
constructor
Initialize the CreditMemoAppliedClient class with a lockstepsdk instance.
-
#query_credit_memo_applications(filter:, include_param:, order:, page_size:, page_number:) ⇒ Object
Queries Credit Memo Applications for this account using the specified filtering, sorting, nested fetch, and pagination rules requested.
-
#retrieve_credit_memo_application(id:, include_param:) ⇒ Object
Retrieves the Credit Memo Application specified by this unique identifier, optionally including nested data sets.
-
#update_credit_memo_application(id:, body:) ⇒ Object
Updates an existing Credit memo Application with the information supplied to this PATCH call.
Constructor Details
#initialize(lockstepsdk) ⇒ CreditMemoAppliedClient
Initialize the CreditMemoAppliedClient class with a lockstepsdk instance.
25 26 27 |
# File 'lib/lockstep_sdk/clients/credit_memo_applied_client.rb', line 25 def initialize(lockstepsdk) @lockstepsdk = lockstepsdk end |
Instance Method Details
#create_credit_memo_applications(body:) ⇒ Object
Creates one or more Credit Memo Applications within this account and returns the records as created.
Credit Memos reflect credits granted to a customer for various reasons, such as discounts or refunds. Credit Memos may be applied to Invoices as Payments. When a Credit Memo is applied as payment to an Invoice, Lockstep creates a Credit Memo Application record to track the amount from the Credit Memo that was applied as payment to the Invoice. You can examine Credit Memo Application records to track which Invoices were paid using this Credit.
72 73 74 75 |
# File 'lib/lockstep_sdk/clients/credit_memo_applied_client.rb', line 72 def create_credit_memo_applications(body:) path = "/api/v1/CreditMemoApplied" @lockstepsdk.request(:post, path, body, nil) end |
#delete_credit_memo_application(id:) ⇒ Object
Deletes the Credit Memo Application referred to by this unique identifier.
Credit Memos reflect credits granted to a customer for various reasons, such as discounts or refunds. Credit Memos may be applied to Invoices as Payments. When a Credit Memo is applied as payment to an Invoice, Lockstep creates a Credit Memo Application record to track the amount from the Credit Memo that was applied as payment to the Invoice. You can examine Credit Memo Application records to track which Invoices were paid using this Credit.
61 62 63 64 |
# File 'lib/lockstep_sdk/clients/credit_memo_applied_client.rb', line 61 def delete_credit_memo_application(id:) path = "/api/v1/CreditMemoApplied/#{id}" @lockstepsdk.request(:delete, path, nil, nil) end |
#query_credit_memo_applications(filter:, include_param:, order:, page_size:, page_number:) ⇒ Object
Queries Credit Memo Applications 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. Credit Memos reflect credits granted to a customer for various reasons, such as discounts or refunds. Credit Memos may be applied to Invoices as Payments. When a Credit Memo is applied as payment to an Invoice, Lockstep creates a Credit Memo Application record to track the amount from the Credit Memo that was applied as payment to the Invoice. You can examine Credit Memo Application records to track which Invoices were paid using this Credit.
87 88 89 90 91 |
# File 'lib/lockstep_sdk/clients/credit_memo_applied_client.rb', line 87 def query_credit_memo_applications(filter:, include_param:, order:, page_size:, page_number:) path = "/api/v1/CreditMemoApplied/query" params = {:filter => filter, :include => include_param, :order => order, :pageSize => page_size, :pageNumber => page_number} @lockstepsdk.request(:get, path, nil, params) end |
#retrieve_credit_memo_application(id:, include_param:) ⇒ Object
Retrieves the Credit Memo Application specified by this unique identifier, optionally including nested data sets.
Credit Memos reflect credits granted to a customer for various reasons, such as discounts or refunds. Credit Memos may be applied to Invoices as Payments. When a Credit Memo is applied as payment to an Invoice, Lockstep creates a Credit Memo Application record to track the amount from the Credit Memo that was applied as payment to the Invoice. You can examine Credit Memo Application records to track which Invoices were paid using this Credit.
37 38 39 40 41 |
# File 'lib/lockstep_sdk/clients/credit_memo_applied_client.rb', line 37 def retrieve_credit_memo_application(id:, include_param:) path = "/api/v1/CreditMemoApplied/#{id}" params = {:include => include_param} @lockstepsdk.request(:get, path, nil, params) end |
#update_credit_memo_application(id:, body:) ⇒ Object
Updates an existing Credit memo Application 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. Credit Memos reflect credits granted to a customer for various reasons, such as discounts or refunds. Credit Memos may be applied to Invoices as Payments. When a Credit Memo is applied as payment to an Invoice, Lockstep creates a Credit Memo Application record to track the amount from the Credit Memo that was applied as payment to the Invoice. You can examine Credit Memo Application records to track which Invoices were paid using this Credit.
50 51 52 53 |
# File 'lib/lockstep_sdk/clients/credit_memo_applied_client.rb', line 50 def update_credit_memo_application(id:, body:) path = "/api/v1/CreditMemoApplied/#{id}" @lockstepsdk.request(:patch, path, body.to_camelback_keys.to_json, nil) end |