Class: Merge::Accounting::AsyncJournalEntriesClient

Inherits:
Object
  • Object
show all
Defined in:
lib/merge_ruby_client/accounting/journal_entries/client.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(request_client:) ⇒ Merge::Accounting::AsyncJournalEntriesClient

Parameters:



213
214
215
 
# File 'lib/merge_ruby_client/accounting/journal_entries/client.rb', line 213

def initialize(request_client:)
  @request_client = request_client
end

Instance Attribute Details

#request_client ⇒ Merge::AsyncRequestClient (readonly)

Returns:



209
210
211
 
# File 'lib/merge_ruby_client/accounting/journal_entries/client.rb', line 209

def request_client
  @request_client
end

Instance Method Details

#create(model:, is_debug_mode: nil, run_async: nil, request_options: nil) ⇒ Merge::Accounting::JournalEntryResponse

Creates a ‘JournalEntry` object with the given values.

Examples:

api = Merge::Client.new(
  base_url: "https://api.example.com",
  environment: Merge::Environment::PRODUCTION,
  api_key: "YOUR_AUTH_TOKEN"
)
api.accounting.journal_entries.create(model: {  })

Parameters:

  • is_debug_mode (Boolean) (defaults to: nil) —

    Whether to include debug fields (such as log file links) in the response.

  • run_async (Boolean) (defaults to: nil) —

    Whether or not third-party updates should be run asynchronously.

  • model (Hash) —

    Request of type Merge::Accounting::JournalEntryRequest, as a Hash

    • :transaction_date (DateTime)

    • :payments (Array<Merge::Accounting::JournalEntryRequestPaymentsItem>)

    • :memo (String)

    • :currency (Merge::Accounting::CurrencyEnum)

    • :exchange_rate (String)

    • :company (Hash)

    • :tracking_categories (Array<Merge::Accounting::JournalEntryRequestTrackingCategoriesItem>)

    • :lines (Array<Merge::Accounting::JournalLineRequest>)

    • :journal_number (String)

    • :posting_status (Merge::Accounting::PostingStatusEnum)

    • :integration_params (Hash=> Object)

    • :linked_account_params (Hash=> Object)

  • request_options (Merge::RequestOptions) (defaults to: nil)

Returns:



307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
 
# File 'lib/merge_ruby_client/accounting/journal_entries/client.rb', line 307

def create(model:, is_debug_mode: nil, run_async: nil, request_options: nil)
  Async do
    response = @request_client.conn.post do |req|
      req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
      req.headers["Authorization"] = request_options.api_key unless request_options&.api_key.nil?
      req.headers["X-Account-Token"] = request_options. unless request_options&..nil?
      req.headers = {
    **(req.headers || {}),
    **@request_client.get_headers,
    **(request_options&.additional_headers || {})
      }.compact
      req.params = {
        **(request_options&.additional_query_parameters || {}),
        "is_debug_mode": is_debug_mode,
        "run_async": run_async
      }.compact
      req.body = { **(request_options&.additional_body_parameters || {}), model: model }.compact
      req.url "#{@request_client.get_url(request_options: request_options)}/accounting/v1/journal-entries"
    end
    Merge::Accounting::JournalEntryResponse.from_json(json_object: response.body)
  end
end

#list(company_id: nil, created_after: nil, created_before: nil, cursor: nil, expand: nil, include_deleted_data: nil, include_remote_data: nil, modified_after: nil, modified_before: nil, page_size: nil, remote_id: nil, transaction_date_after: nil, transaction_date_before: nil, request_options: nil) ⇒ Merge::Accounting::PaginatedJournalEntryList

Returns a list of ‘JournalEntry` objects.

Examples:

api = Merge::Client.new(
  base_url: "https://api.example.com",
  environment: Merge::Environment::PRODUCTION,
  api_key: "YOUR_AUTH_TOKEN"
)
api.accounting.journal_entries.list

Parameters:

  • company_id (String) (defaults to: nil) —

    If provided, will only return journal entries for this company.

  • created_after (DateTime) (defaults to: nil) —

    If provided, will only return objects created after this datetime.

  • created_before (DateTime) (defaults to: nil) —

    If provided, will only return objects created before this datetime.

  • cursor (String) (defaults to: nil) —

    The pagination cursor value.

  • expand (Merge::Accounting::JournalEntries::JournalEntriesListRequestExpand) (defaults to: nil) —

    Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.

  • include_deleted_data (Boolean) (defaults to: nil) —

    Whether to include data that was marked as deleted by third party webhooks.

  • include_remote_data (Boolean) (defaults to: nil) —

    Whether to include the original data Merge fetched from the third-party to produce these models.

  • modified_after (DateTime) (defaults to: nil) —

    If provided, only objects synced by Merge after this date time will be returned.

  • modified_before (DateTime) (defaults to: nil) —

    If provided, only objects synced by Merge before this date time will be returned.

  • page_size (Integer) (defaults to: nil) —

    Number of results to return per page.

  • remote_id (String) (defaults to: nil) —

    The API provider’s ID for the given object.

  • transaction_date_after (DateTime) (defaults to: nil) —

    If provided, will only return objects created after this datetime.

  • transaction_date_before (DateTime) (defaults to: nil) —

    If provided, will only return objects created before this datetime.

  • request_options (Merge::RequestOptions) (defaults to: nil)

Returns:



244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
 
# File 'lib/merge_ruby_client/accounting/journal_entries/client.rb', line 244

def list(company_id: nil, created_after: nil, created_before: nil, cursor: nil, expand: nil,
         include_deleted_data: nil, include_remote_data: nil, modified_after: nil, modified_before: nil, page_size: nil, remote_id: nil, transaction_date_after: nil, transaction_date_before: nil, request_options: nil)
  Async do
    response = @request_client.conn.get do |req|
      req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
      req.headers["Authorization"] = request_options.api_key unless request_options&.api_key.nil?
      req.headers["X-Account-Token"] = request_options. unless request_options&..nil?
      req.headers = {
    **(req.headers || {}),
    **@request_client.get_headers,
    **(request_options&.additional_headers || {})
      }.compact
      req.params = {
        **(request_options&.additional_query_parameters || {}),
        "company_id": company_id,
        "created_after": created_after,
        "created_before": created_before,
        "cursor": cursor,
        "expand": expand,
        "include_deleted_data": include_deleted_data,
        "include_remote_data": include_remote_data,
        "modified_after": modified_after,
        "modified_before": modified_before,
        "page_size": page_size,
        "remote_id": remote_id,
        "transaction_date_after": transaction_date_after,
        "transaction_date_before": transaction_date_before
      }.compact
      unless request_options.nil? || request_options&.additional_body_parameters.nil?
        req.body = { **(request_options&.additional_body_parameters || {}) }.compact
      end
      req.url "#{@request_client.get_url(request_options: request_options)}/accounting/v1/journal-entries"
    end
    Merge::Accounting::PaginatedJournalEntryList.from_json(json_object: response.body)
  end
end

#meta_post_retrieve(request_options: nil) ⇒ Merge::Accounting::MetaResponse

Returns metadata for ‘JournalEntry` POSTs.

Examples:

api = Merge::Client.new(
  base_url: "https://api.example.com",
  environment: Merge::Environment::PRODUCTION,
  api_key: "YOUR_AUTH_TOKEN"
)
api.accounting.journal_entries.meta_post_retrieve

Parameters:

Returns:



382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
 
# File 'lib/merge_ruby_client/accounting/journal_entries/client.rb', line 382

def meta_post_retrieve(request_options: nil)
  Async do
    response = @request_client.conn.get do |req|
      req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
      req.headers["Authorization"] = request_options.api_key unless request_options&.api_key.nil?
      req.headers["X-Account-Token"] = request_options. unless request_options&..nil?
      req.headers = {
    **(req.headers || {}),
    **@request_client.get_headers,
    **(request_options&.additional_headers || {})
      }.compact
      unless request_options.nil? || request_options&.additional_query_parameters.nil?
        req.params = { **(request_options&.additional_query_parameters || {}) }.compact
      end
      unless request_options.nil? || request_options&.additional_body_parameters.nil?
        req.body = { **(request_options&.additional_body_parameters || {}) }.compact
      end
      req.url "#{@request_client.get_url(request_options: request_options)}/accounting/v1/journal-entries/meta/post"
    end
    Merge::Accounting::MetaResponse.from_json(json_object: response.body)
  end
end

#retrieve(id:, expand: nil, include_remote_data: nil, request_options: nil) ⇒ Merge::Accounting::JournalEntry

Returns a ‘JournalEntry` object with the given `id`.

Examples:

api = Merge::Client.new(
  base_url: "https://api.example.com",
  environment: Merge::Environment::PRODUCTION,
  api_key: "YOUR_AUTH_TOKEN"
)
api.accounting.journal_entries.retrieve(id: "id")

Parameters:

Returns:



346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
 
# File 'lib/merge_ruby_client/accounting/journal_entries/client.rb', line 346

def retrieve(id:, expand: nil, include_remote_data: nil, request_options: nil)
  Async do
    response = @request_client.conn.get do |req|
      req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
      req.headers["Authorization"] = request_options.api_key unless request_options&.api_key.nil?
      req.headers["X-Account-Token"] = request_options. unless request_options&..nil?
      req.headers = {
    **(req.headers || {}),
    **@request_client.get_headers,
    **(request_options&.additional_headers || {})
      }.compact
      req.params = {
        **(request_options&.additional_query_parameters || {}),
        "expand": expand,
        "include_remote_data": include_remote_data
      }.compact
      unless request_options.nil? || request_options&.additional_body_parameters.nil?
        req.body = { **(request_options&.additional_body_parameters || {}) }.compact
      end
      req.url "#{@request_client.get_url(request_options: request_options)}/accounting/v1/journal-entries/#{id}"
    end
    Merge::Accounting::JournalEntry.from_json(json_object: response.body)
  end
end