Class: FinancialAccountBalanceHistoryClient

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

Instance Method Summary collapse

Constructor Details

#initialize(connection) ⇒ FinancialAccountBalanceHistoryClient

Initialize the FinancialAccountBalanceHistoryClient class with an API client instance.

Parameters:

  • connection (LockstepApi) —

    The API client object for this connection



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

def initialize(connection)
    @connection = connection
end

Instance Method Details

#create_balance_history(body:) ⇒ Object

Creates a Financial Account Balance History from a given model.

A Financial Account Balance History records either the current or end of period balance for a corresponding financial account.

Parameters:

  • body (FinancialAccountBalanceHistoryModel) —

    The Financial Account Balance Histories to create



69
70
71
72
 
# File 'lib/lockstep_sdk/clients/financial_account_balance_history_client.rb', line 69

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

#delete_balance_history(id:) ⇒ Object

Delete the Financial Account Balance History referred to by this unique identifier.

A Financial Account Balance History records either the current or end of period balance for a corresponding financial account.

Parameters:

  • id (uuid) —

    The unique Lockstep Platform ID number of the Financial Account Balance History to disable



58
59
60
61
 
# File 'lib/lockstep_sdk/clients/financial_account_balance_history_client.rb', line 58

def delete_balance_history(id:)
    path = "/api/v1/FinancialAccountBalanceHistory/#{id}"
    @connection.request(:delete, path, nil, nil)
end

#query_balance_history(filter:, order:, page_size:, page_number:) ⇒ Object

Queries Financial Account Balance History for this account using the specified filtering, sorting, 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 Financial Account Balance History records either the current or end of period balance for a corresponding financial account.

Parameters:



85
86
87
88
89
 
# File 'lib/lockstep_sdk/clients/financial_account_balance_history_client.rb', line 85

def query_balance_history(filter:, order:, page_size:, page_number:)
    path = "/api/v1/FinancialAccountBalanceHistory/query"
    params = {:filter => filter, :order => order, :pageSize => page_size, :pageNumber => page_number}
    @connection.request(:get, path, nil, params)
end

#retrieve_balance_history(id:) ⇒ Object

Retrieves the Financial Account Balance History specified by this unique identifier.

A Financial Account Balance History records either the current or end of period balance for a corresponding financial account.

Parameters:

  • id (uuid) —

    The unique Lockstep Platform ID number of this Financial Account Balance History



33
34
35
36
 
# File 'lib/lockstep_sdk/clients/financial_account_balance_history_client.rb', line 33

def retrieve_balance_history(id:)
    path = "/api/v1/FinancialAccountBalanceHistory/#{id}"
    @connection.request(:get, path, nil, nil)
end

#update_balance_history(id:, body:) ⇒ Object

Updates a Financial Account Balance History that matches the specified id with the requested information.

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 Financial Account Balance History records either the current or end of period balance for a corresponding financial account.

Parameters:

  • id (uuid) —

    The unique Lockstep Platform ID number of the Financial Account Balance History to update

  • body (object) —

    A list of changes to apply to this Financial Account Balance History



47
48
49
50
 
# File 'lib/lockstep_sdk/clients/financial_account_balance_history_client.rb', line 47

def update_balance_history(id:, body:)
    path = "/api/v1/FinancialAccountBalanceHistory/#{id}"
    @connection.request(:patch, path, body.to_camelback_keys.to_json, nil)
end