merge_accounting_client 1.0.0

data/docs/BalanceSheetsApi.md

@@ -0,0 +1,177 @@
+# MergeAccountingClient::BalanceSheetsApi
+
+All URIs are relative to *https://api.merge.dev/api/accounting/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**balance_sheets_list**](BalanceSheetsApi.md#balance_sheets_list) | **GET** /balance-sheets |  |
+| [**balance_sheets_retrieve**](BalanceSheetsApi.md#balance_sheets_retrieve) | **GET** /balance-sheets/{id} |  |
+
+
+## balance_sheets_list
+
+> <PaginatedBalanceSheetList> balance_sheets_list(x_account_token, opts)
+
+
+
+Returns a list of `BalanceSheet` objects.
+
+### Examples
+
+```ruby
+require 'time'
+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::BalanceSheetsApi.new
+x_account_token = 'x_account_token_example' # String | Token identifying the end user.
+opts = {
+  created_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects created after this datetime.
+  created_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects created before this datetime.
+  cursor: 'cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw', # String | The pagination cursor value.
+  include_deleted_data: true, # Boolean | Whether to include data that was deleted in the third-party service.
+  include_remote_data: true, # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
+  modified_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects modified after this datetime.
+  modified_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects modified before this datetime.
+  page_size: 56, # Integer | Number of results to return per page.
+  remote_id: 'remote_id_example' # String | The API provider's ID for the given object.
+}
+
+begin
+  
+  result = api_instance.balance_sheets_list(x_account_token, opts)
+  p result
+rescue MergeAccountingClient::ApiError => e
+  puts "Error when calling BalanceSheetsApi->balance_sheets_list: #{e}"
+end
+```
+
+#### Using the balance_sheets_list_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<PaginatedBalanceSheetList>, Integer, Hash)> balance_sheets_list_with_http_info(x_account_token, opts)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.balance_sheets_list_with_http_info(x_account_token, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <PaginatedBalanceSheetList>
+rescue MergeAccountingClient::ApiError => e
+  puts "Error when calling BalanceSheetsApi->balance_sheets_list_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **x_account_token** | **String** | Token identifying the end user. |  |
+| **created_after** | **Time** | If provided, will only return objects created after this datetime. | [optional] |
+| **created_before** | **Time** | If provided, will only return objects created before this datetime. | [optional] |
+| **cursor** | **String** | The pagination cursor value. | [optional] |
+| **include_deleted_data** | **Boolean** | Whether to include data that was deleted in the third-party service. | [optional] |
+| **include_remote_data** | **Boolean** | Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] |
+| **modified_after** | **Time** | If provided, will only return objects modified after this datetime. | [optional] |
+| **modified_before** | **Time** | If provided, will only return objects modified before this datetime. | [optional] |
+| **page_size** | **Integer** | Number of results to return per page. | [optional] |
+| **remote_id** | **String** | The API provider&#39;s ID for the given object. | [optional] |
+
+### Return type
+
+[**PaginatedBalanceSheetList**](PaginatedBalanceSheetList.md)
+
+### Authorization
+
+[tokenAuth](../README.md#tokenAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## balance_sheets_retrieve
+
+> <BalanceSheet> balance_sheets_retrieve(x_account_token, id, opts)
+
+
+
+Returns a `BalanceSheet` object with the given `id`.
+
+### Examples
+
+```ruby
+require 'time'
+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::BalanceSheetsApi.new
+x_account_token = 'x_account_token_example' # String | Token identifying the end user.
+id = TODO # String | 
+opts = {
+  include_remote_data: true # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
+}
+
+begin
+  
+  result = api_instance.balance_sheets_retrieve(x_account_token, id, opts)
+  p result
+rescue MergeAccountingClient::ApiError => e
+  puts "Error when calling BalanceSheetsApi->balance_sheets_retrieve: #{e}"
+end
+```
+
+#### Using the balance_sheets_retrieve_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<BalanceSheet>, Integer, Hash)> balance_sheets_retrieve_with_http_info(x_account_token, id, opts)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.balance_sheets_retrieve_with_http_info(x_account_token, id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <BalanceSheet>
+rescue MergeAccountingClient::ApiError => e
+  puts "Error when calling BalanceSheetsApi->balance_sheets_retrieve_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **x_account_token** | **String** | Token identifying the end user. |  |
+| **id** | [**String**](.md) |  |  |
+| **include_remote_data** | **Boolean** | Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] |
+
+### Return type
+
+[**BalanceSheet**](BalanceSheet.md)
+
+### Authorization
+
+[tokenAuth](../README.md#tokenAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/CashFlowStatement.md

@@ -0,0 +1,40 @@
+# MergeAccountingClient::CashFlowStatement
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  | [optional][readonly] |
+| **remote_id** | **String** | The third-party API ID of the matching object. | [optional] |
+| **remote_data** | [**Array<RemoteData>**](RemoteData.md) |  | [optional][readonly] |
+| **name** | **String** | The cash flow statement's name. | [optional] |
+| **start_period** | **Time** | The cash flow statement's start period. | [optional] |
+| **end_period** | **Time** | The cash flow statement's end period. | [optional] |
+| **cash_at_beginning_of_period** | **Float** | Cash and cash equivalents at the beginning of the cash flow statement's period. | [optional] |
+| **cash_at_end_of_period** | **Float** | Cash and cash equivalents at the beginning of the cash flow statement's period. | [optional] |
+| **operating_activities** | [**Array<ReportItem>**](ReportItem.md) |  | [optional][readonly] |
+| **investing_activities** | [**Array<ReportItem>**](ReportItem.md) |  | [optional][readonly] |
+| **financing_activities** | [**Array<ReportItem>**](ReportItem.md) |  | [optional][readonly] |
+| **remote_generated_at** | **Time** | The time that cash flow statement was generated by the accounting system. | [optional] |
+
+## Example
+
+```ruby
+require 'merge_accounting_client'
+
+instance = MergeAccountingClient::CashFlowStatement.new(
+  id: 5b3c1341-a20f-4e51-b72c-f3830a16c97b,
+  remote_id: 8211088,
+  remote_data: [{"path":"/actions","data":["Varies by platform"]}],
+  name: CashFlow,
+  start_period: 2020-01-01T00:00Z,
+  end_period: 2020-03-31T00:00Z,
+  cash_at_beginning_of_period: 5000.0,
+  cash_at_end_of_period: 4063.52,
+  operating_activities: [{"remote_id":"10299","name":"Operating Activities","value":1000,"sub_items":null}],
+  investing_activities: [{"remote_id":"10230","name":"Investing Activities","value":1000,"sub_items":null}],
+  financing_activities: [{"remote_id":"10231","name":"Financing Activities","value":1000,"sub_items":null}],
+  remote_generated_at: 2020-04-01T00:00Z
+)
+```
+

data/docs/CashFlowStatementsApi.md

@@ -0,0 +1,177 @@
+# MergeAccountingClient::CashFlowStatementsApi
+
+All URIs are relative to *https://api.merge.dev/api/accounting/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**cash_flow_statements_list**](CashFlowStatementsApi.md#cash_flow_statements_list) | **GET** /cash-flow-statements |  |
+| [**cash_flow_statements_retrieve**](CashFlowStatementsApi.md#cash_flow_statements_retrieve) | **GET** /cash-flow-statements/{id} |  |
+
+
+## cash_flow_statements_list
+
+> <PaginatedCashFlowStatementList> cash_flow_statements_list(x_account_token, opts)
+
+
+
+Returns a list of `CashFlowStatement` objects.
+
+### Examples
+
+```ruby
+require 'time'
+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::CashFlowStatementsApi.new
+x_account_token = 'x_account_token_example' # String | Token identifying the end user.
+opts = {
+  created_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects created after this datetime.
+  created_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects created before this datetime.
+  cursor: 'cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw', # String | The pagination cursor value.
+  include_deleted_data: true, # Boolean | Whether to include data that was deleted in the third-party service.
+  include_remote_data: true, # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
+  modified_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects modified after this datetime.
+  modified_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects modified before this datetime.
+  page_size: 56, # Integer | Number of results to return per page.
+  remote_id: 'remote_id_example' # String | The API provider's ID for the given object.
+}
+
+begin
+  
+  result = api_instance.cash_flow_statements_list(x_account_token, opts)
+  p result
+rescue MergeAccountingClient::ApiError => e
+  puts "Error when calling CashFlowStatementsApi->cash_flow_statements_list: #{e}"
+end
+```
+
+#### Using the cash_flow_statements_list_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<PaginatedCashFlowStatementList>, Integer, Hash)> cash_flow_statements_list_with_http_info(x_account_token, opts)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.cash_flow_statements_list_with_http_info(x_account_token, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <PaginatedCashFlowStatementList>
+rescue MergeAccountingClient::ApiError => e
+  puts "Error when calling CashFlowStatementsApi->cash_flow_statements_list_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **x_account_token** | **String** | Token identifying the end user. |  |
+| **created_after** | **Time** | If provided, will only return objects created after this datetime. | [optional] |
+| **created_before** | **Time** | If provided, will only return objects created before this datetime. | [optional] |
+| **cursor** | **String** | The pagination cursor value. | [optional] |
+| **include_deleted_data** | **Boolean** | Whether to include data that was deleted in the third-party service. | [optional] |
+| **include_remote_data** | **Boolean** | Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] |
+| **modified_after** | **Time** | If provided, will only return objects modified after this datetime. | [optional] |
+| **modified_before** | **Time** | If provided, will only return objects modified before this datetime. | [optional] |
+| **page_size** | **Integer** | Number of results to return per page. | [optional] |
+| **remote_id** | **String** | The API provider&#39;s ID for the given object. | [optional] |
+
+### Return type
+
+[**PaginatedCashFlowStatementList**](PaginatedCashFlowStatementList.md)
+
+### Authorization
+
+[tokenAuth](../README.md#tokenAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## cash_flow_statements_retrieve
+
+> <CashFlowStatement> cash_flow_statements_retrieve(x_account_token, id, opts)
+
+
+
+Returns a `CashFlowStatement` object with the given `id`.
+
+### Examples
+
+```ruby
+require 'time'
+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::CashFlowStatementsApi.new
+x_account_token = 'x_account_token_example' # String | Token identifying the end user.
+id = TODO # String | 
+opts = {
+  include_remote_data: true # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
+}
+
+begin
+  
+  result = api_instance.cash_flow_statements_retrieve(x_account_token, id, opts)
+  p result
+rescue MergeAccountingClient::ApiError => e
+  puts "Error when calling CashFlowStatementsApi->cash_flow_statements_retrieve: #{e}"
+end
+```
+
+#### Using the cash_flow_statements_retrieve_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CashFlowStatement>, Integer, Hash)> cash_flow_statements_retrieve_with_http_info(x_account_token, id, opts)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.cash_flow_statements_retrieve_with_http_info(x_account_token, id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CashFlowStatement>
+rescue MergeAccountingClient::ApiError => e
+  puts "Error when calling CashFlowStatementsApi->cash_flow_statements_retrieve_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **x_account_token** | **String** | Token identifying the end user. |  |
+| **id** | [**String**](.md) |  |  |
+| **include_remote_data** | **Boolean** | Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] |
+
+### Return type
+
+[**CashFlowStatement**](CashFlowStatement.md)
+
+### Authorization
+
+[tokenAuth](../README.md#tokenAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/CategoriesEnum.md

@@ -0,0 +1,15 @@
+# MergeAccountingClient::CategoriesEnum
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+
+## Example
+
+```ruby
+require 'merge_accounting_client'
+
+instance = MergeAccountingClient::CategoriesEnum.new()
+```
+

data/docs/CategoryEnum.md

@@ -0,0 +1,15 @@
+# MergeAccountingClient::CategoryEnum
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+
+## Example
+
+```ruby
+require 'merge_accounting_client'
+
+instance = MergeAccountingClient::CategoryEnum.new()
+```
+

data/docs/ClassificationEnum.md

@@ -0,0 +1,15 @@
+# MergeAccountingClient::ClassificationEnum
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+
+## Example
+
+```ruby
+require 'merge_accounting_client'
+
+instance = MergeAccountingClient::ClassificationEnum.new()
+```
+

data/docs/CompanyInfo.md

@@ -0,0 +1,42 @@
+# MergeAccountingClient::CompanyInfo
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  | [optional][readonly] |
+| **remote_id** | **String** | The third-party API ID of the matching object. | [optional] |
+| **remote_data** | [**Array<RemoteData>**](RemoteData.md) |  | [optional][readonly] |
+| **name** | **String** | The company's name. | [optional] |
+| **legal_name** | **String** | The company's legal name. | [optional] |
+| **tax_number** | **String** | The company's tax number. | [optional] |
+| **fiscal_year_end_month** | **Integer** | The company's fiscal year end month. | [optional] |
+| **fiscal_year_end_day** | **Integer** | The company's fiscal year end day. | [optional] |
+| **currency** | [**CurrencyEnum**](CurrencyEnum.md) | The currency set in the company's accounting platform. | [optional] |
+| **remote_created_at** | **Time** | When the third party's company was created. | [optional] |
+| **urls** | **Array<String>** | The company's urls. | [optional] |
+| **addresses** | [**Array<Address>**](Address.md) |  | [optional] |
+| **phone_numbers** | [**Array<AccountingPhoneNumber>**](AccountingPhoneNumber.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'merge_accounting_client'
+
+instance = MergeAccountingClient::CompanyInfo.new(
+  id: 65d8ffd0-211b-4ba4-b85a-fbe2ce220982,
+  remote_id: 19202938,
+  remote_data: [{"path":"/actions","data":["Varies by platform"]}],
+  name: Merge Pickleball Company,
+  legal_name: Merge Pickleball Company Inc.,
+  tax_number: 11-0011000,
+  fiscal_year_end_month: 12,
+  fiscal_year_end_day: 31,
+  currency: USD,
+  remote_created_at: 2020-03-31T00:00Z,
+  urls: https://www.merge.dev,
+  addresses: [{"street_1":"2920 Broadway","street_2":"2nd Floor","city":"New York","state":"NY","country":"USA","zip_code":"10027"}],
+  phone_numbers: null
+)
+```
+

data/docs/CompanyInfoApi.md

@@ -0,0 +1,181 @@
+# MergeAccountingClient::CompanyInfoApi
+
+All URIs are relative to *https://api.merge.dev/api/accounting/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**company_info_list**](CompanyInfoApi.md#company_info_list) | **GET** /company-info |  |
+| [**company_info_retrieve**](CompanyInfoApi.md#company_info_retrieve) | **GET** /company-info/{id} |  |
+
+
+## company_info_list
+
+> <PaginatedCompanyInfoList> company_info_list(x_account_token, opts)
+
+
+
+Returns a list of `CompanyInfo` objects.
+
+### Examples
+
+```ruby
+require 'time'
+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::CompanyInfoApi.new
+x_account_token = 'x_account_token_example' # String | Token identifying the end user.
+opts = {
+  created_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects created after this datetime.
+  created_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects created before this datetime.
+  cursor: 'cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw', # String | The pagination cursor value.
+  expand: 'addresses', # String | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+  include_deleted_data: true, # Boolean | Whether to include data that was deleted in the third-party service.
+  include_remote_data: true, # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
+  modified_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects modified after this datetime.
+  modified_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects modified before this datetime.
+  page_size: 56, # Integer | Number of results to return per page.
+  remote_id: 'remote_id_example' # String | The API provider's ID for the given object.
+}
+
+begin
+  
+  result = api_instance.company_info_list(x_account_token, opts)
+  p result
+rescue MergeAccountingClient::ApiError => e
+  puts "Error when calling CompanyInfoApi->company_info_list: #{e}"
+end
+```
+
+#### Using the company_info_list_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<PaginatedCompanyInfoList>, Integer, Hash)> company_info_list_with_http_info(x_account_token, opts)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.company_info_list_with_http_info(x_account_token, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <PaginatedCompanyInfoList>
+rescue MergeAccountingClient::ApiError => e
+  puts "Error when calling CompanyInfoApi->company_info_list_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **x_account_token** | **String** | Token identifying the end user. |  |
+| **created_after** | **Time** | If provided, will only return objects created after this datetime. | [optional] |
+| **created_before** | **Time** | If provided, will only return objects created before this datetime. | [optional] |
+| **cursor** | **String** | The pagination cursor value. | [optional] |
+| **expand** | **String** | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. | [optional] |
+| **include_deleted_data** | **Boolean** | Whether to include data that was deleted in the third-party service. | [optional] |
+| **include_remote_data** | **Boolean** | Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] |
+| **modified_after** | **Time** | If provided, will only return objects modified after this datetime. | [optional] |
+| **modified_before** | **Time** | If provided, will only return objects modified before this datetime. | [optional] |
+| **page_size** | **Integer** | Number of results to return per page. | [optional] |
+| **remote_id** | **String** | The API provider&#39;s ID for the given object. | [optional] |
+
+### Return type
+
+[**PaginatedCompanyInfoList**](PaginatedCompanyInfoList.md)
+
+### Authorization
+
+[tokenAuth](../README.md#tokenAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## company_info_retrieve
+
+> <CompanyInfo> company_info_retrieve(x_account_token, id, opts)
+
+
+
+Returns a `CompanyInfo` object with the given `id`.
+
+### Examples
+
+```ruby
+require 'time'
+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::CompanyInfoApi.new
+x_account_token = 'x_account_token_example' # String | Token identifying the end user.
+id = TODO # String | 
+opts = {
+  expand: 'addresses', # String | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+  include_remote_data: true # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
+}
+
+begin
+  
+  result = api_instance.company_info_retrieve(x_account_token, id, opts)
+  p result
+rescue MergeAccountingClient::ApiError => e
+  puts "Error when calling CompanyInfoApi->company_info_retrieve: #{e}"
+end
+```
+
+#### Using the company_info_retrieve_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CompanyInfo>, Integer, Hash)> company_info_retrieve_with_http_info(x_account_token, id, opts)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.company_info_retrieve_with_http_info(x_account_token, id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CompanyInfo>
+rescue MergeAccountingClient::ApiError => e
+  puts "Error when calling CompanyInfoApi->company_info_retrieve_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **x_account_token** | **String** | Token identifying the end user. |  |
+| **id** | [**String**](.md) |  |  |
+| **expand** | **String** | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. | [optional] |
+| **include_remote_data** | **Boolean** | Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] |
+
+### Return type
+
+[**CompanyInfo**](CompanyInfo.md)
+
+### Authorization
+
+[tokenAuth](../README.md#tokenAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+