merge_accounting_client 1.0.0

data/docs/IncomeStatementsApi.md

@@ -0,0 +1,177 @@
+# MergeAccountingClient::IncomeStatementsApi
+
+All URIs are relative to *https://api.merge.dev/api/accounting/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**income_statements_list**](IncomeStatementsApi.md#income_statements_list) | **GET** /income-statements |  |
+| [**income_statements_retrieve**](IncomeStatementsApi.md#income_statements_retrieve) | **GET** /income-statements/{id} |  |
+
+
+## income_statements_list
+
+> <PaginatedIncomeStatementList> income_statements_list(x_account_token, opts)
+
+
+
+Returns a list of `IncomeStatement` 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::IncomeStatementsApi.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.income_statements_list(x_account_token, opts)
+  p result
+rescue MergeAccountingClient::ApiError => e
+  puts "Error when calling IncomeStatementsApi->income_statements_list: #{e}"
+end
+```
+
+#### Using the income_statements_list_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<PaginatedIncomeStatementList>, Integer, Hash)> income_statements_list_with_http_info(x_account_token, opts)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.income_statements_list_with_http_info(x_account_token, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <PaginatedIncomeStatementList>
+rescue MergeAccountingClient::ApiError => e
+  puts "Error when calling IncomeStatementsApi->income_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
+
+[**PaginatedIncomeStatementList**](PaginatedIncomeStatementList.md)
+
+### Authorization
+
+[tokenAuth](../README.md#tokenAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## income_statements_retrieve
+
+> <IncomeStatement> income_statements_retrieve(x_account_token, id, opts)
+
+
+
+Returns an `IncomeStatement` 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::IncomeStatementsApi.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.income_statements_retrieve(x_account_token, id, opts)
+  p result
+rescue MergeAccountingClient::ApiError => e
+  puts "Error when calling IncomeStatementsApi->income_statements_retrieve: #{e}"
+end
+```
+
+#### Using the income_statements_retrieve_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<IncomeStatement>, Integer, Hash)> income_statements_retrieve_with_http_info(x_account_token, id, opts)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.income_statements_retrieve_with_http_info(x_account_token, id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <IncomeStatement>
+rescue MergeAccountingClient::ApiError => e
+  puts "Error when calling IncomeStatementsApi->income_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
+
+[**IncomeStatement**](IncomeStatement.md)
+
+### Authorization
+
+[tokenAuth](../README.md#tokenAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/Invoice.md

@@ -0,0 +1,54 @@
+# MergeAccountingClient::Invoice
+
+## 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] |
+| **type** | [**InvoiceTypeEnum**](InvoiceTypeEnum.md) | The invoice's type. | [optional] |
+| **contact** | **String** |  | [optional] |
+| **number** | **String** | The invoice's number. | [optional] |
+| **issue_date** | **Time** | The invoice's issue date. | [optional] |
+| **due_date** | **Time** | The invoice's due date. | [optional] |
+| **paid_on_date** | **Time** | The invoice's paid date. | [optional] |
+| **memo** | **String** | The invoice's private note. | [optional] |
+| **currency** | [**CurrencyEnum**](CurrencyEnum.md) | The invoice's currency. | [optional] |
+| **total_discount** | **Float** | The invoice's total discount. | [optional] |
+| **sub_total** | **Float** | The invoice's sub-total. | [optional] |
+| **total_tax_amount** | **Float** | The invoice's total tax amount. | [optional] |
+| **total_amount** | **Float** | The invoice's total amount. | [optional] |
+| **balance** | **Float** | The invoice's remaining balance. | [optional] |
+| **remote_updated_at** | **Time** | When the third party's invoice entry was updated. | [optional] |
+| **payments** | **Array<String>** | Array of `Payment` object IDs. | [optional] |
+| **line_items** | [**Array<InvoiceLineItem>**](InvoiceLineItem.md) |  | [optional][readonly] |
+
+## Example
+
+```ruby
+require 'merge_accounting_client'
+
+instance = MergeAccountingClient::Invoice.new(
+  id: 9871b4a9-f5d2-4f3b-a66b-dfedbed42c46,
+  remote_id: 990110,
+  remote_data: [{"path":"/actions","data":["Varies by platform"]}],
+  type: ACCOUNTS_RECEIVABLE,
+  contact: 022a2bef-57e5-4def-8ed2-7c41bd9a5ed8,
+  number: AIQ12546,
+  issue_date: 2020-03-31T00:00Z,
+  due_date: 2020-04-15T00:00Z,
+  paid_on_date: 2020-04-01T00:00Z,
+  memo: Weekly Payment,
+  currency: USD,
+  total_discount: null,
+  sub_total: 100,
+  total_tax_amount: 5,
+  total_amount: 105,
+  balance: 105,
+  remote_updated_at: 2020-04-01T00:00Z,
+  payments: ["b26fd49a-cbae-470a-a8f8-bcbc119e0390"],
+  line_items: [{"id":"022a2bef-57e5-4def-8ed2-7c41bd9a5ed8","remote_id":"8765432","description":"Pickleball lessons","unit_price":50.0,"quantity":2.0,"total_amount":100.0,"item":"5b3c1341-a20f-4e51-b72c-f3830a16c97b","remote_data":[{"path":"/actions","data":["Varies by platform"]}]}]
+)
+```
+

data/docs/InvoiceEndpointRequest.md

@@ -0,0 +1,18 @@
+# MergeAccountingClient::InvoiceEndpointRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **model** | [**InvoiceRequest**](InvoiceRequest.md) |  |  |
+
+## Example
+
+```ruby
+require 'merge_accounting_client'
+
+instance = MergeAccountingClient::InvoiceEndpointRequest.new(
+  model: null
+)
+```
+

data/docs/InvoiceLineItem.md

@@ -0,0 +1,34 @@
+# MergeAccountingClient::InvoiceLineItem
+
+## 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] |
+| **description** | **String** | The line item's description. | [optional] |
+| **unit_price** | **Float** | The line item's unit price. | [optional] |
+| **quantity** | **Float** | The line item's quantity. | [optional] |
+| **total_amount** | **Float** | The line item's total amount. | [optional] |
+| **item** | **String** |  | [optional] |
+| **account** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'merge_accounting_client'
+
+instance = MergeAccountingClient::InvoiceLineItem.new(
+  id: 022a2bef-57e5-4def-8ed2-7c41bd9a5ed8,
+  remote_id: 8765432,
+  remote_data: [{"path":"/actions","data":["Varies by platform"]}],
+  description: Pickleball lessons,
+  unit_price: 50.0,
+  quantity: 1.0,
+  total_amount: 50.0,
+  item: 5b3c1341-a20f-4e51-b72c-f3830a16c97b,
+  account: cd0f32d4-a493-11ec-b909-0242ac120002
+)
+```
+

data/docs/InvoiceLineItemRequest.md

@@ -0,0 +1,30 @@
+# MergeAccountingClient::InvoiceLineItemRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **remote_id** | **String** | The third-party API ID of the matching object. | [optional] |
+| **description** | **String** | The line item's description. | [optional] |
+| **unit_price** | **Float** | The line item's unit price. | [optional] |
+| **quantity** | **Float** | The line item's quantity. | [optional] |
+| **total_amount** | **Float** | The line item's total amount. | [optional] |
+| **item** | **String** |  | [optional] |
+| **account** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'merge_accounting_client'
+
+instance = MergeAccountingClient::InvoiceLineItemRequest.new(
+  remote_id: 8765432,
+  description: Pickleball lessons,
+  unit_price: 50.0,
+  quantity: 1.0,
+  total_amount: 50.0,
+  item: 5b3c1341-a20f-4e51-b72c-f3830a16c97b,
+  account: cd0f32d4-a493-11ec-b909-0242ac120002
+)
+```
+

data/docs/InvoiceRequest.md

@@ -0,0 +1,48 @@
+# MergeAccountingClient::InvoiceRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **remote_id** | **String** | The third-party API ID of the matching object. | [optional] |
+| **type** | [**InvoiceTypeEnum**](InvoiceTypeEnum.md) | The invoice's type. | [optional] |
+| **contact** | **String** |  | [optional] |
+| **number** | **String** | The invoice's number. | [optional] |
+| **issue_date** | **Time** | The invoice's issue date. | [optional] |
+| **due_date** | **Time** | The invoice's due date. | [optional] |
+| **paid_on_date** | **Time** | The invoice's paid date. | [optional] |
+| **memo** | **String** | The invoice's private note. | [optional] |
+| **currency** | [**CurrencyEnum**](CurrencyEnum.md) | The invoice's currency. | [optional] |
+| **total_discount** | **Float** | The invoice's total discount. | [optional] |
+| **sub_total** | **Float** | The invoice's sub-total. | [optional] |
+| **total_tax_amount** | **Float** | The invoice's total tax amount. | [optional] |
+| **total_amount** | **Float** | The invoice's total amount. | [optional] |
+| **balance** | **Float** | The invoice's remaining balance. | [optional] |
+| **remote_updated_at** | **Time** | When the third party's invoice entry was updated. | [optional] |
+| **payments** | **Array<String>** | Array of `Payment` object IDs. | [optional] |
+
+## Example
+
+```ruby
+require 'merge_accounting_client'
+
+instance = MergeAccountingClient::InvoiceRequest.new(
+  remote_id: 990110,
+  type: ACCOUNTS_RECEIVABLE,
+  contact: 022a2bef-57e5-4def-8ed2-7c41bd9a5ed8,
+  number: AIQ12546,
+  issue_date: 2020-03-31T00:00Z,
+  due_date: 2020-04-15T00:00Z,
+  paid_on_date: 2020-04-01T00:00Z,
+  memo: Weekly Payment,
+  currency: USD,
+  total_discount: null,
+  sub_total: 100,
+  total_tax_amount: 5,
+  total_amount: 105,
+  balance: 105,
+  remote_updated_at: 2020-04-01T00:00Z,
+  payments: ["b26fd49a-cbae-470a-a8f8-bcbc119e0390"]
+)
+```
+

data/docs/InvoiceResponse.md

@@ -0,0 +1,24 @@
+# MergeAccountingClient::InvoiceResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **model** | [**Invoice**](Invoice.md) |  |  |
+| **warnings** | [**Array<WarningValidationProblem>**](WarningValidationProblem.md) |  |  |
+| **errors** | [**Array<ErrorValidationProblem>**](ErrorValidationProblem.md) |  |  |
+| **logs** | [**Array<DebugModeLog>**](DebugModeLog.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'merge_accounting_client'
+
+instance = MergeAccountingClient::InvoiceResponse.new(
+  model: null,
+  warnings: null,
+  errors: null,
+  logs: null
+)
+```
+

data/docs/InvoiceTypeEnum.md

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