Class: InvoiceHistoryClient
- Inherits:
-
Object
- Object
- InvoiceHistoryClient
- Defined in:
- lib/lockstep_sdk/clients/invoice_history_client.rb
Instance Method Summary collapse
-
#initialize(lockstepsdk) ⇒ InvoiceHistoryClient
constructor
Initialize the InvoiceHistoryClient class with a lockstepsdk instance.
-
#query_invoice_history(filter:, include_param:, order:, page_size:, page_number:) ⇒ Object
Queries Invoice History for this account using the specified filtering, sorting, and pagination rules requested.
-
#retrieve_invoice_history(id:) ⇒ Object
Retrieves the history of the Invoice specified by this unique identifier.
Constructor Details
#initialize(lockstepsdk) ⇒ InvoiceHistoryClient
Initialize the InvoiceHistoryClient class with a lockstepsdk instance.
25 26 27 |
# File 'lib/lockstep_sdk/clients/invoice_history_client.rb', line 25 def initialize(lockstepsdk) @lockstepsdk = lockstepsdk end |
Instance Method Details
#query_invoice_history(filter:, include_param:, order:, page_size:, page_number:) ⇒ Object
Queries Invoice History for this account using the specified filtering, sorting, and pagination rules requested.
An Invoice represents a bill sent from one company to another. The Lockstep Platform tracks changes to each Invoice so that you can observe the changes over time. You can view the InvoiceHistory list to monitor and observe the changes of this Invoice and track the dates when changes occurred.
51 52 53 54 55 |
# File 'lib/lockstep_sdk/clients/invoice_history_client.rb', line 51 def query_invoice_history(filter:, include_param:, order:, page_size:, page_number:) path = "/api/v1/InvoiceHistory/query" params = {:filter => filter, :include => include_param, :order => order, :pageSize => page_size, :pageNumber => page_number} @lockstepsdk.request(:get, path, nil, params) end |
#retrieve_invoice_history(id:) ⇒ Object
Retrieves the history of the Invoice specified by this unique identifier.
An Invoice represents a bill sent from one company to another. The Lockstep Platform tracks changes to each Invoice so that you can observe the changes over time. You can view the InvoiceHistory list to monitor and observe the changes of this Invoice and track the dates when changes occurred.
36 37 38 39 |
# File 'lib/lockstep_sdk/clients/invoice_history_client.rb', line 36 def retrieve_invoice_history(id:) path = "/api/v1/InvoiceHistory/#{id}" @lockstepsdk.request(:get, path, nil, nil) end |