korona_client 1.0.0

data/docs/ResultListInventoryListItem.md

@@ -0,0 +1,13 @@
+# KoronaClient::ResultListInventoryListItem
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**current_page** | **Integer** | number of the current page, starting from 1 | 
+**links** | **Hash<String, String>** | navigation links (previous, self, next) | 
+**pages_total** | **Integer** | pages count total | 
+**results** | [**Array<InventoryListItem>**](InventoryListItem.md) | result list | 
+**results_of_page** | **Integer** | result count of the current page | 
+**results_total** | **Integer** | result count total | 
+
+

data/docs/ResultListOrganizationalUnit.md

@@ -0,0 +1,13 @@
+# KoronaClient::ResultListOrganizationalUnit
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**current_page** | **Integer** | number of the current page, starting from 1 | 
+**links** | **Hash<String, String>** | navigation links (previous, self, next) | 
+**pages_total** | **Integer** | pages count total | 
+**results** | [**Array<OrganizationalUnit>**](OrganizationalUnit.md) | result list | 
+**results_of_page** | **Integer** | result count of the current page | 
+**results_total** | **Integer** | result count total | 
+
+

data/docs/ResultListPaymentMethod.md

@@ -0,0 +1,13 @@
+# KoronaClient::ResultListPaymentMethod
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**current_page** | **Integer** | number of the current page, starting from 1 | 
+**links** | **Hash<String, String>** | navigation links (previous, self, next) | 
+**pages_total** | **Integer** | pages count total | 
+**results** | [**Array<PaymentMethod>**](PaymentMethod.md) | result list | 
+**results_of_page** | **Integer** | result count of the current page | 
+**results_total** | **Integer** | result count total | 
+
+

data/docs/ResultListPos.md

@@ -0,0 +1,13 @@
+# KoronaClient::ResultListPos
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**current_page** | **Integer** | number of the current page, starting from 1 | 
+**links** | **Hash<String, String>** | navigation links (previous, self, next) | 
+**pages_total** | **Integer** | pages count total | 
+**results** | [**Array<Pos>**](Pos.md) | result list | 
+**results_of_page** | **Integer** | result count of the current page | 
+**results_total** | **Integer** | result count total | 
+
+

data/docs/ResultListPriceGroup.md

@@ -0,0 +1,13 @@
+# KoronaClient::ResultListPriceGroup
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**current_page** | **Integer** | number of the current page, starting from 1 | 
+**links** | **Hash<String, String>** | navigation links (previous, self, next) | 
+**pages_total** | **Integer** | pages count total | 
+**results** | [**Array<PriceGroup>**](PriceGroup.md) | result list | 
+**results_of_page** | **Integer** | result count of the current page | 
+**results_total** | **Integer** | result count total | 
+
+

data/docs/ResultListProduct.md

@@ -0,0 +1,13 @@
+# KoronaClient::ResultListProduct
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**current_page** | **Integer** | number of the current page, starting from 1 | 
+**links** | **Hash<String, String>** | navigation links (previous, self, next) | 
+**pages_total** | **Integer** | pages count total | 
+**results** | [**Array<Product>**](Product.md) | result list | 
+**results_of_page** | **Integer** | result count of the current page | 
+**results_total** | **Integer** | result count total | 
+
+

data/docs/ResultListProductStock.md

@@ -0,0 +1,13 @@
+# KoronaClient::ResultListProductStock
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**current_page** | **Integer** | number of the current page, starting from 1 | 
+**links** | **Hash<String, String>** | navigation links (previous, self, next) | 
+**pages_total** | **Integer** | pages count total | 
+**results** | [**Array<ProductStock>**](ProductStock.md) | result list | 
+**results_of_page** | **Integer** | result count of the current page | 
+**results_total** | **Integer** | result count total | 
+
+

data/docs/ResultListReceipt.md

@@ -0,0 +1,13 @@
+# KoronaClient::ResultListReceipt
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**current_page** | **Integer** | number of the current page, starting from 1 | 
+**links** | **Hash<String, String>** | navigation links (previous, self, next) | 
+**pages_total** | **Integer** | pages count total | 
+**results** | [**Array<Receipt>**](Receipt.md) | result list | 
+**results_of_page** | **Integer** | result count of the current page | 
+**results_total** | **Integer** | result count total | 
+
+

data/docs/ResultListSalesTax.md

@@ -0,0 +1,13 @@
+# KoronaClient::ResultListSalesTax
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**current_page** | **Integer** | number of the current page, starting from 1 | 
+**links** | **Hash<String, String>** | navigation links (previous, self, next) | 
+**pages_total** | **Integer** | pages count total | 
+**results** | [**Array<SalesTax>**](SalesTax.md) | result list | 
+**results_of_page** | **Integer** | result count of the current page | 
+**results_total** | **Integer** | result count total | 
+
+

data/docs/ResultListSector.md

@@ -0,0 +1,13 @@
+# KoronaClient::ResultListSector
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**current_page** | **Integer** | number of the current page, starting from 1 | 
+**links** | **Hash<String, String>** | navigation links (previous, self, next) | 
+**pages_total** | **Integer** | pages count total | 
+**results** | [**Array<Sector>**](Sector.md) | result list | 
+**results_of_page** | **Integer** | result count of the current page | 
+**results_total** | **Integer** | result count total | 
+
+

data/docs/ResultListStockReceipt.md

@@ -0,0 +1,13 @@
+# KoronaClient::ResultListStockReceipt
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**current_page** | **Integer** | number of the current page, starting from 1 | 
+**links** | **Hash<String, String>** | navigation links (previous, self, next) | 
+**pages_total** | **Integer** | pages count total | 
+**results** | [**Array<StockReceipt>**](StockReceipt.md) | result list | 
+**results_of_page** | **Integer** | result count of the current page | 
+**results_total** | **Integer** | result count total | 
+
+

data/docs/ResultListStockReceiptItem.md

@@ -0,0 +1,13 @@
+# KoronaClient::ResultListStockReceiptItem
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**current_page** | **Integer** | number of the current page, starting from 1 | 
+**links** | **Hash<String, String>** | navigation links (previous, self, next) | 
+**pages_total** | **Integer** | pages count total | 
+**results** | [**Array<StockReceiptItem>**](StockReceiptItem.md) | result list | 
+**results_of_page** | **Integer** | result count of the current page | 
+**results_total** | **Integer** | result count total | 
+
+

data/docs/ResultListSupplier.md

@@ -0,0 +1,13 @@
+# KoronaClient::ResultListSupplier
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**current_page** | **Integer** | number of the current page, starting from 1 | 
+**links** | **Hash<String, String>** | navigation links (previous, self, next) | 
+**pages_total** | **Integer** | pages count total | 
+**results** | [**Array<Supplier>**](Supplier.md) | result list | 
+**results_of_page** | **Integer** | result count of the current page | 
+**results_total** | **Integer** | result count total | 
+
+

data/docs/ResultListTag.md

@@ -0,0 +1,13 @@
+# KoronaClient::ResultListTag
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**current_page** | **Integer** | number of the current page, starting from 1 | 
+**links** | **Hash<String, String>** | navigation links (previous, self, next) | 
+**pages_total** | **Integer** | pages count total | 
+**results** | [**Array<Tag>**](Tag.md) | result list | 
+**results_of_page** | **Integer** | result count of the current page | 
+**results_total** | **Integer** | result count total | 
+
+

data/docs/ResultListTicketDefinition.md

@@ -0,0 +1,13 @@
+# KoronaClient::ResultListTicketDefinition
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**current_page** | **Integer** | number of the current page, starting from 1 | 
+**links** | **Hash<String, String>** | navigation links (previous, self, next) | 
+**pages_total** | **Integer** | pages count total | 
+**results** | [**Array<TicketDefinition>**](TicketDefinition.md) | result list | 
+**results_of_page** | **Integer** | result count of the current page | 
+**results_total** | **Integer** | result count total | 
+
+

data/docs/RevenueData.md

@@ -0,0 +1,12 @@
+# KoronaClient::RevenueData
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**net_value** | **Float** |  | [optional] 
+**gross_value** | **Float** |  | [optional] 
+**average_net_value** | **Float** |  | [optional] 
+**average_gross_value** | **Float** |  | [optional] 
+**customers_total** | **Integer** |  | [optional] 
+
+

data/docs/SalesTax.md

@@ -0,0 +1,15 @@
+# KoronaClient::SalesTax
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**active** | **BOOLEAN** | indicates whether the object is active for use or not | [optional] 
+**id** | **String** | global object uuid (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx) | [optional] 
+**number** | **String** | number of the object, like it is set in backoffice; will be removed when active=false | [optional] 
+**revision** | **Integer** | the revision number of the object. revision numbers are unique per object-type. there is is no object of the same type with identical revision numbers. | [optional] 
+**economic_zone** | [**ModelReference**](ModelReference.md) |  | [optional] 
+**included** | **BOOLEAN** |  | [optional] 
+**name** | **String** |  | [optional] 
+**rates** | [**Array<SalesTaxRate>**](SalesTaxRate.md) |  | [optional] 
+
+

data/docs/SalesTaxRate.md

@@ -0,0 +1,9 @@
+# KoronaClient::SalesTaxRate
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**rate** | **Float** |  | [optional] 
+**valid_from** | **DateTime** |  | [optional] 
+
+

data/docs/SalesTaxesApi.md

@@ -0,0 +1,131 @@
+# KoronaClient::SalesTaxesApi
+
+All URIs are relative to *https://www.koronacloud.com/web/api/v3*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**get_sales_tax**](SalesTaxesApi.md#get_sales_tax) | **GET** /accounts/{koronaAccountId}/salesTaxes/{salesTaxIdOrNumber} | lists the sales tax
+[**get_sales_taxes**](SalesTaxesApi.md#get_sales_taxes) | **GET** /accounts/{koronaAccountId}/salesTaxes | lists all sales taxes
+
+
+# **get_sales_tax**
+> SalesTax get_sales_tax(korona_account_id, sales_tax_id_or_number)
+
+lists the sales tax
+
+
+
+### Example
+```ruby
+# load the gem
+require 'korona_client'
+# setup authorization
+KoronaClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = KoronaClient::SalesTaxesApi.new
+
+korona_account_id = "korona_account_id_example" # String | the account id
+
+sales_tax_id_or_number = "sales_tax_id_or_number_example" # String | id or number of the related object (important: if a number should match the uuid-format, the system will lookup for an id instead of a number)
+
+
+begin
+  #lists the sales tax
+  result = api_instance.get_sales_tax(korona_account_id, sales_tax_id_or_number)
+  p result
+rescue KoronaClient::ApiError => e
+  puts "Exception when calling SalesTaxesApi->get_sales_tax: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **korona_account_id** | **String**| the account id | 
+ **sales_tax_id_or_number** | **String**| id or number of the related object (important: if a number should match the uuid-format, the system will lookup for an id instead of a number) | 
+
+### Return type
+
+[**SalesTax**](SalesTax.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **get_sales_taxes**
+> ResultListSalesTax get_sales_taxes(korona_account_id, opts)
+
+lists all sales taxes
+
+
+
+### Example
+```ruby
+# load the gem
+require 'korona_client'
+# setup authorization
+KoronaClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = KoronaClient::SalesTaxesApi.new
+
+korona_account_id = "korona_account_id_example" # String | the account id
+
+opts = { 
+  page: 56, # Integer | number of the page to fetch
+  size: 56, # Integer | amount of objects to return per page
+  sort: "sort_example", # String | attribute to sort by (multiple separated by comma; max. 5)
+  revision: 789, # Integer | last revision number, objects with a greater revision than this will be returned
+  include_deleted: true # BOOLEAN | indicates deleted objects should be loaded or not (default: false)
+}
+
+begin
+  #lists all sales taxes
+  result = api_instance.get_sales_taxes(korona_account_id, opts)
+  p result
+rescue KoronaClient::ApiError => e
+  puts "Exception when calling SalesTaxesApi->get_sales_taxes: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **korona_account_id** | **String**| the account id | 
+ **page** | **Integer**| number of the page to fetch | [optional] 
+ **size** | **Integer**| amount of objects to return per page | [optional] 
+ **sort** | **String**| attribute to sort by (multiple separated by comma; max. 5) | [optional] 
+ **revision** | **Integer**| last revision number, objects with a greater revision than this will be returned | [optional] 
+ **include_deleted** | **BOOLEAN**| indicates deleted objects should be loaded or not (default: false) | [optional] 
+
+### Return type
+
+[**ResultListSalesTax**](ResultListSalesTax.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+

data/docs/Sector.md

@@ -0,0 +1,13 @@
+# KoronaClient::Sector
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**active** | **BOOLEAN** | indicates whether the object is active for use or not | [optional] 
+**id** | **String** | global object uuid (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx) | [optional] 
+**number** | **String** | number of the object, like it is set in backoffice; will be removed when active=false | [optional] 
+**revision** | **Integer** | the revision number of the object. revision numbers are unique per object-type. there is is no object of the same type with identical revision numbers. | [optional] 
+**name** | **String** |  | [optional] 
+**sales_taxes** | [**Array<SectorSalesTaxItem>**](SectorSalesTaxItem.md) |  | [optional] 
+
+

data/docs/SectorSalesTaxItem.md

@@ -0,0 +1,9 @@
+# KoronaClient::SectorSalesTaxItem
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**index** | **Integer** |  | [optional] 
+**sales_tax** | [**ModelReference**](ModelReference.md) |  | [optional] 
+
+

data/docs/SectorsApi.md

@@ -0,0 +1,131 @@
+# KoronaClient::SectorsApi
+
+All URIs are relative to *https://www.koronacloud.com/web/api/v3*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**get_sector**](SectorsApi.md#get_sector) | **GET** /accounts/{koronaAccountId}/sectors/{sectorIdOrNumber} | lists the sector
+[**get_sectors**](SectorsApi.md#get_sectors) | **GET** /accounts/{koronaAccountId}/sectors | lists all sectors
+
+
+# **get_sector**
+> Sector get_sector(korona_account_id, sector_id_or_number)
+
+lists the sector
+
+
+
+### Example
+```ruby
+# load the gem
+require 'korona_client'
+# setup authorization
+KoronaClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = KoronaClient::SectorsApi.new
+
+korona_account_id = "korona_account_id_example" # String | the account id
+
+sector_id_or_number = "sector_id_or_number_example" # String | id or number of the related object (important: if a number should match the uuid-format, the system will lookup for an id instead of a number)
+
+
+begin
+  #lists the sector
+  result = api_instance.get_sector(korona_account_id, sector_id_or_number)
+  p result
+rescue KoronaClient::ApiError => e
+  puts "Exception when calling SectorsApi->get_sector: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **korona_account_id** | **String**| the account id | 
+ **sector_id_or_number** | **String**| id or number of the related object (important: if a number should match the uuid-format, the system will lookup for an id instead of a number) | 
+
+### Return type
+
+[**Sector**](Sector.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **get_sectors**
+> ResultListSector get_sectors(korona_account_id, opts)
+
+lists all sectors
+
+
+
+### Example
+```ruby
+# load the gem
+require 'korona_client'
+# setup authorization
+KoronaClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = KoronaClient::SectorsApi.new
+
+korona_account_id = "korona_account_id_example" # String | the account id
+
+opts = { 
+  page: 56, # Integer | number of the page to fetch
+  size: 56, # Integer | amount of objects to return per page
+  sort: "sort_example", # String | attribute to sort by (multiple separated by comma; max. 5)
+  revision: 789, # Integer | last revision number, objects with a greater revision than this will be returned
+  include_deleted: true # BOOLEAN | indicates deleted objects should be loaded or not (default: false)
+}
+
+begin
+  #lists all sectors
+  result = api_instance.get_sectors(korona_account_id, opts)
+  p result
+rescue KoronaClient::ApiError => e
+  puts "Exception when calling SectorsApi->get_sectors: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **korona_account_id** | **String**| the account id | 
+ **page** | **Integer**| number of the page to fetch | [optional] 
+ **size** | **Integer**| amount of objects to return per page | [optional] 
+ **sort** | **String**| attribute to sort by (multiple separated by comma; max. 5) | [optional] 
+ **revision** | **Integer**| last revision number, objects with a greater revision than this will be returned | [optional] 
+ **include_deleted** | **BOOLEAN**| indicates deleted objects should be loaded or not (default: false) | [optional] 
+
+### Return type
+
+[**ResultListSector**](ResultListSector.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+