Skip to content

Latest commit

 

History

History
327 lines (287 loc) · 24.8 KB

README.md

File metadata and controls

327 lines (287 loc) · 24.8 KB
Raw

merge_accounting_client

MergeAccountingClient - the Ruby gem for the Merge Accounting API

The unified API for building rich integrations with multiple Accounting & Finance platforms.

This SDK is automatically generated by the OpenAPI Generator project:

  • API version: 1.0
  • Package version: 1.1.0
  • Build package: org.openapitools.codegen.languages.RubyClientCodegen For more information, please visit https://www.merge.dev/

Installation

Build a gem

To build the Ruby code into a gem:

gem build merge_accounting_client.gemspec

Then either install the gem locally:

gem install ./merge_accounting_client-1.1.0.gem

(for development, run gem install --dev ./merge_accounting_client-1.1.0.gem to install the development dependencies)

or publish the gem to a gem hosting service, e.g. RubyGems.

Finally add this to the Gemfile:

gem 'merge_accounting_client', '~> 1.1.0'

Install from Git

If the Ruby gem is hosted at a git repository: https://github.com/merge-api/merge-accounting-ruby, then add the following in the Gemfile:

gem 'merge_accounting_client', :git => 'https://github.com/merge-api/merge-accounting-ruby.git'

Include the Ruby code directly

Include the Ruby code directly using -I as follows:

ruby -Ilib script.rb

Getting Started

Please follow the installation procedure and then run the following code:

# Load the gem
require 'merge_accounting_client'

# Setup authorization
MergeAccountingClient.configure do |config|
  # Configure API key authorization: tokenAuth
  config.api_key['tokenAuth'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['tokenAuth'] = 'Bearer'
end

api_instance = MergeAccountingClient::AccountDetailsApi.new
x_account_token = 'x_account_token_example' # String | Token identifying the end user.

begin
  result = api_instance.account_details_retrieve(x_account_token)
  p result
rescue MergeAccountingClient::ApiError => e
  puts "Exception when calling AccountDetailsApi->account_details_retrieve: #{e}"
end

Documentation for API Endpoints

All URIs are relative to https://api.merge.dev/api/accounting/v1

Class Method HTTP request Description
MergeAccountingClient::AccountDetailsApi account_details_retrieve GET /account-details
MergeAccountingClient::AccountTokenApi account_token_retrieve GET /account-token/{public_token}
MergeAccountingClient::AccountingPeriodsApi accounting_periods_list GET /accounting-periods
MergeAccountingClient::AccountingPeriodsApi accounting_periods_retrieve GET /accounting-periods/{id}
MergeAccountingClient::AccountsApi accounts_create POST /accounts
MergeAccountingClient::AccountsApi accounts_list GET /accounts
MergeAccountingClient::AccountsApi accounts_meta_post_retrieve GET /accounts/meta/post
MergeAccountingClient::AccountsApi accounts_retrieve GET /accounts/{id}
MergeAccountingClient::AddressesApi addresses_retrieve GET /addresses/{id}
MergeAccountingClient::AsyncPassthroughApi async_passthrough_create POST /async-passthrough
MergeAccountingClient::AsyncPassthroughApi async_passthrough_retrieve GET /async-passthrough/{async_passthrough_receipt_id}
MergeAccountingClient::AttachmentsApi attachments_create POST /attachments
MergeAccountingClient::AttachmentsApi attachments_list GET /attachments
MergeAccountingClient::AttachmentsApi attachments_meta_post_retrieve GET /attachments/meta/post
MergeAccountingClient::AttachmentsApi attachments_retrieve GET /attachments/{id}
MergeAccountingClient::AuditTrailApi audit_trail_list GET /audit-trail
MergeAccountingClient::AvailableActionsApi available_actions_retrieve GET /available-actions
MergeAccountingClient::BalanceSheetsApi balance_sheets_list GET /balance-sheets
MergeAccountingClient::BalanceSheetsApi balance_sheets_retrieve GET /balance-sheets/{id}
MergeAccountingClient::CashFlowStatementsApi cash_flow_statements_list GET /cash-flow-statements
MergeAccountingClient::CashFlowStatementsApi cash_flow_statements_retrieve GET /cash-flow-statements/{id}
MergeAccountingClient::CompanyInfoApi company_info_list GET /company-info
MergeAccountingClient::CompanyInfoApi company_info_retrieve GET /company-info/{id}
MergeAccountingClient::ContactsApi contacts_create POST /contacts
MergeAccountingClient::ContactsApi contacts_list GET /contacts
MergeAccountingClient::ContactsApi contacts_meta_post_retrieve GET /contacts/meta/post
MergeAccountingClient::ContactsApi contacts_retrieve GET /contacts/{id}
MergeAccountingClient::CreditNotesApi credit_notes_list GET /credit-notes
MergeAccountingClient::CreditNotesApi credit_notes_retrieve GET /credit-notes/{id}
MergeAccountingClient::DeleteAccountApi delete_account_delete POST /delete-account
MergeAccountingClient::ExpensesApi expenses_create POST /expenses
MergeAccountingClient::ExpensesApi expenses_list GET /expenses
MergeAccountingClient::ExpensesApi expenses_meta_post_retrieve GET /expenses/meta/post
MergeAccountingClient::ExpensesApi expenses_retrieve GET /expenses/{id}
MergeAccountingClient::ForceResyncApi sync_status_resync_create POST /sync-status/resync
MergeAccountingClient::GenerateKeyApi generate_key_create POST /generate-key
MergeAccountingClient::IncomeStatementsApi income_statements_list GET /income-statements
MergeAccountingClient::IncomeStatementsApi income_statements_retrieve GET /income-statements/{id}
MergeAccountingClient::InvoicesApi invoices_create POST /invoices
MergeAccountingClient::InvoicesApi invoices_list GET /invoices
MergeAccountingClient::InvoicesApi invoices_meta_post_retrieve GET /invoices/meta/post
MergeAccountingClient::InvoicesApi invoices_retrieve GET /invoices/{id}
MergeAccountingClient::IssuesApi issues_list GET /issues
MergeAccountingClient::IssuesApi issues_retrieve GET /issues/{id}
MergeAccountingClient::ItemsApi items_list GET /items
MergeAccountingClient::ItemsApi items_retrieve GET /items/{id}
MergeAccountingClient::JournalEntriesApi journal_entries_create POST /journal-entries
MergeAccountingClient::JournalEntriesApi journal_entries_list GET /journal-entries
MergeAccountingClient::JournalEntriesApi journal_entries_meta_post_retrieve GET /journal-entries/meta/post
MergeAccountingClient::JournalEntriesApi journal_entries_retrieve GET /journal-entries/{id}
MergeAccountingClient::LinkTokenApi link_token_create POST /link-token
MergeAccountingClient::LinkedAccountsApi linked_accounts_list GET /linked-accounts
MergeAccountingClient::PassthroughApi passthrough_create POST /passthrough
MergeAccountingClient::PaymentsApi payments_create POST /payments
MergeAccountingClient::PaymentsApi payments_list GET /payments
MergeAccountingClient::PaymentsApi payments_meta_post_retrieve GET /payments/meta/post
MergeAccountingClient::PaymentsApi payments_retrieve GET /payments/{id}
MergeAccountingClient::PhoneNumbersApi phone_numbers_retrieve GET /phone-numbers/{id}
MergeAccountingClient::PurchaseOrdersApi purchase_orders_create POST /purchase-orders
MergeAccountingClient::PurchaseOrdersApi purchase_orders_list GET /purchase-orders
MergeAccountingClient::PurchaseOrdersApi purchase_orders_meta_post_retrieve GET /purchase-orders/meta/post
MergeAccountingClient::PurchaseOrdersApi purchase_orders_retrieve GET /purchase-orders/{id}
MergeAccountingClient::RegenerateKeyApi regenerate_key_create POST /regenerate-key
MergeAccountingClient::SelectiveSyncApi selective_sync_configurations_list GET /selective-sync/configurations
MergeAccountingClient::SelectiveSyncApi selective_sync_configurations_update PUT /selective-sync/configurations
MergeAccountingClient::SelectiveSyncApi selective_sync_meta_list GET /selective-sync/meta
MergeAccountingClient::SyncStatusApi sync_status_list GET /sync-status
MergeAccountingClient::TaxRatesApi tax_rates_list GET /tax-rates
MergeAccountingClient::TaxRatesApi tax_rates_retrieve GET /tax-rates/{id}
MergeAccountingClient::TrackingCategoriesApi tracking_categories_list GET /tracking-categories
MergeAccountingClient::TrackingCategoriesApi tracking_categories_retrieve GET /tracking-categories/{id}
MergeAccountingClient::TransactionsApi transactions_list GET /transactions
MergeAccountingClient::TransactionsApi transactions_retrieve GET /transactions/{id}
MergeAccountingClient::VendorCreditsApi vendor_credits_list GET /vendor-credits
MergeAccountingClient::VendorCreditsApi vendor_credits_retrieve GET /vendor-credits/{id}
MergeAccountingClient::WebhookReceiversApi webhook_receivers_create POST /webhook-receivers
MergeAccountingClient::WebhookReceiversApi webhook_receivers_list GET /webhook-receivers

Documentation for Models

Documentation for Authorization

tokenAuth

  • Type: API key
  • API key parameter name: Authorization
  • Location: HTTP header