korona-cloud-client 1.0.1 → 1.0.2
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +71 -4
- data/docs/AddressInformation.md +2 -0
- data/docs/Cashier.md +16 -6
- data/docs/CashierRole.md +27 -0
- data/docs/CashierRolesApi.md +402 -0
- data/docs/CashiersApi.md +286 -2
- data/docs/CloudSubscriptionDetails.md +19 -0
- data/docs/CurrenciesApi.md +166 -0
- data/docs/Customer.md +5 -1
- data/docs/EconomicZonesApi.md +166 -0
- data/docs/FiscalTransaction.md +43 -0
- data/docs/FiscalUnit.md +51 -0
- data/docs/FiscalUnitCertificateInfo.md +19 -0
- data/docs/FiscalUnitState.md +27 -0
- data/docs/FiscalUnitStateUsageLevel.md +23 -0
- data/docs/FiscalUnitStateUsageLevelValue.md +19 -0
- data/docs/FiscalUnitStateVersionInfo.md +21 -0
- data/docs/FiscalUnitsApi.md +299 -0
- data/docs/InfoTextsApi.md +166 -0
- data/docs/KoronaAccount.md +2 -0
- data/docs/OrganizationalUnit.md +9 -7
- data/docs/PaymentMethod.md +2 -0
- data/docs/PointsOfSaleApi.md +6 -2
- data/docs/Pos.md +10 -4
- data/docs/PriceGroupsApi.md +166 -0
- data/docs/ProductionType.md +33 -0
- data/docs/ProductionTypesApi.md +294 -0
- data/docs/Receipt.md +18 -8
- data/docs/ReceiptItem.md +3 -1
- data/docs/ReceiptMaxRevisions.md +27 -0
- data/docs/ReceiptsApi.md +9 -3
- data/docs/ResultListCashierRole.md +27 -0
- data/docs/ResultListFiscalUnit.md +27 -0
- data/docs/ResultListProductionType.md +27 -0
- data/docs/ResultListStockOrder.md +27 -0
- data/docs/SalesTax.md +2 -0
- data/docs/SalesTaxesApi.md +166 -0
- data/docs/SectorsApi.md +54 -0
- data/docs/Service.md +19 -0
- data/docs/StockOrder.md +73 -0
- data/docs/StockOrderItem.md +39 -0
- data/docs/StockOrdersApi.md +195 -0
- data/docs/StockReceipt.md +4 -0
- data/docs/SuppliersApi.md +166 -0
- data/docs/TicketingApi.md +223 -3
- data/docs/VoidedReceiptItem.md +25 -0
- data/korona-cloud-client-1.0.1.gem +0 -0
- data/korona-cloud-client.gemspec +2 -2
- data/lib/korona-cloud-client.rb +24 -1
- data/lib/korona-cloud-client/api/accounts_api.rb +1 -1
- data/lib/korona-cloud-client/api/additional_receipt_info_types_api.rb +1 -1
- data/lib/korona-cloud-client/api/assortments_api.rb +1 -1
- data/lib/korona-cloud-client/api/cashier_roles_api.rb +513 -0
- data/lib/korona-cloud-client/api/cashiers_api.rb +366 -1
- data/lib/korona-cloud-client/api/commodity_groups_api.rb +1 -1
- data/lib/korona-cloud-client/api/currencies_api.rb +208 -1
- data/lib/korona-cloud-client/api/customer_groups_api.rb +1 -1
- data/lib/korona-cloud-client/api/customer_orders_api.rb +1 -1
- data/lib/korona-cloud-client/api/customers_api.rb +1 -1
- data/lib/korona-cloud-client/api/delivery_notes_api.rb +1 -1
- data/lib/korona-cloud-client/api/economic_zones_api.rb +208 -1
- data/lib/korona-cloud-client/api/external_system_calls_api.rb +1 -1
- data/lib/korona-cloud-client/api/fiscal_units_api.rb +389 -0
- data/lib/korona-cloud-client/api/images_api.rb +1 -1
- data/lib/korona-cloud-client/api/info_texts_api.rb +208 -1
- data/lib/korona-cloud-client/api/inventories_api.rb +1 -1
- data/lib/korona-cloud-client/api/korona_account_api.rb +1 -1
- data/lib/korona-cloud-client/api/organizational_units_api.rb +1 -1
- data/lib/korona-cloud-client/api/payment_methods_api.rb +1 -1
- data/lib/korona-cloud-client/api/points_of_sale_api.rb +7 -1
- data/lib/korona-cloud-client/api/price_groups_api.rb +208 -1
- data/lib/korona-cloud-client/api/production_types_api.rb +373 -0
- data/lib/korona-cloud-client/api/products_api.rb +1 -1
- data/lib/korona-cloud-client/api/receipts_api.rb +7 -1
- data/lib/korona-cloud-client/api/sales_taxes_api.rb +208 -1
- data/lib/korona-cloud-client/api/sectors_api.rb +69 -1
- data/lib/korona-cloud-client/api/statistics_api.rb +1 -1
- data/lib/korona-cloud-client/api/stock_orders_api.rb +257 -0
- data/lib/korona-cloud-client/api/stock_receipts_api.rb +1 -1
- data/lib/korona-cloud-client/api/suppliers_api.rb +208 -1
- data/lib/korona-cloud-client/api/tags_api.rb +1 -1
- data/lib/korona-cloud-client/api/ticket_creation_api.rb +1 -1
- data/lib/korona-cloud-client/api/ticketing_api.rb +277 -4
- data/lib/korona-cloud-client/api/time_tracking_api.rb +1 -1
- data/lib/korona-cloud-client/api_client.rb +1 -1
- data/lib/korona-cloud-client/api_error.rb +1 -1
- data/lib/korona-cloud-client/configuration.rb +1 -1
- data/lib/korona-cloud-client/models/account.rb +1 -1
- data/lib/korona-cloud-client/models/account_summary.rb +1 -1
- data/lib/korona-cloud-client/models/account_transaction.rb +1 -1
- data/lib/korona-cloud-client/models/add_or_update_result.rb +1 -1
- data/lib/korona-cloud-client/models/additional_info.rb +1 -1
- data/lib/korona-cloud-client/models/additional_receipt_info_type.rb +1 -1
- data/lib/korona-cloud-client/models/address_information.rb +11 -2
- data/lib/korona-cloud-client/models/admission.rb +1 -1
- data/lib/korona-cloud-client/models/amount.rb +1 -1
- data/lib/korona-cloud-client/models/amount_count_data.rb +1 -1
- data/lib/korona-cloud-client/models/assortment.rb +1 -1
- data/lib/korona-cloud-client/models/attendance.rb +1 -1
- data/lib/korona-cloud-client/models/bad_request_error.rb +1 -1
- data/lib/korona-cloud-client/models/capacity.rb +1 -1
- data/lib/korona-cloud-client/models/cashier.rb +55 -10
- data/lib/korona-cloud-client/models/cashier_role.rb +279 -0
- data/lib/korona-cloud-client/models/cashier_summary.rb +1 -1
- data/lib/korona-cloud-client/models/category.rb +1 -1
- data/lib/korona-cloud-client/models/cloud_subscription.rb +1 -1
- data/lib/korona-cloud-client/models/cloud_subscription_details.rb +249 -0
- data/lib/korona-cloud-client/models/commodity_group.rb +1 -1
- data/lib/korona-cloud-client/models/commodity_group_summary.rb +1 -1
- data/lib/korona-cloud-client/models/company_identification.rb +1 -1
- data/lib/korona-cloud-client/models/creation_task.rb +1 -1
- data/lib/korona-cloud-client/models/currency.rb +1 -1
- data/lib/korona-cloud-client/models/currency_denomination.rb +1 -1
- data/lib/korona-cloud-client/models/currency_exchange_rate.rb +1 -1
- data/lib/korona-cloud-client/models/customer.rb +23 -5
- data/lib/korona-cloud-client/models/customer_card.rb +1 -1
- data/lib/korona-cloud-client/models/customer_data.rb +1 -1
- data/lib/korona-cloud-client/models/customer_group.rb +1 -1
- data/lib/korona-cloud-client/models/customer_group_summary.rb +1 -1
- data/lib/korona-cloud-client/models/customer_information.rb +1 -1
- data/lib/korona-cloud-client/models/customer_order.rb +1 -1
- data/lib/korona-cloud-client/models/day_rating.rb +1 -1
- data/lib/korona-cloud-client/models/day_time_period.rb +1 -1
- data/lib/korona-cloud-client/models/delivery_note.rb +1 -1
- data/lib/korona-cloud-client/models/delivery_note_item.rb +1 -1
- data/lib/korona-cloud-client/models/deposit.rb +1 -1
- data/lib/korona-cloud-client/models/device_information.rb +1 -1
- data/lib/korona-cloud-client/models/discount.rb +1 -1
- data/lib/korona-cloud-client/models/economic_zone.rb +1 -1
- data/lib/korona-cloud-client/models/end_of_day_statement.rb +1 -1
- data/lib/korona-cloud-client/models/end_of_day_statement_summary.rb +1 -1
- data/lib/korona-cloud-client/models/entry_gate.rb +1 -1
- data/lib/korona-cloud-client/models/event.rb +1 -1
- data/lib/korona-cloud-client/models/external_system_call.rb +1 -1
- data/lib/korona-cloud-client/models/fiscal_transaction.rb +342 -0
- data/lib/korona-cloud-client/models/fiscal_unit.rb +415 -0
- data/lib/korona-cloud-client/models/fiscal_unit_certificate_info.rb +233 -0
- data/lib/korona-cloud-client/models/fiscal_unit_state.rb +287 -0
- data/lib/korona-cloud-client/models/fiscal_unit_state_usage_level.rb +233 -0
- data/lib/korona-cloud-client/models/fiscal_unit_state_usage_level_value.rb +215 -0
- data/lib/korona-cloud-client/models/fiscal_unit_state_version_info.rb +224 -0
- data/lib/korona-cloud-client/models/forbidden_error.rb +1 -1
- data/lib/korona-cloud-client/models/geo_location.rb +1 -1
- data/lib/korona-cloud-client/models/info_text.rb +1 -1
- data/lib/korona-cloud-client/models/interval.rb +1 -1
- data/lib/korona-cloud-client/models/inventory.rb +1 -1
- data/lib/korona-cloud-client/models/inventory_list.rb +1 -1
- data/lib/korona-cloud-client/models/inventory_list_item.rb +1 -1
- data/lib/korona-cloud-client/models/inventory_list_item_stock.rb +1 -1
- data/lib/korona-cloud-client/models/korona_account.rb +13 -2
- data/lib/korona-cloud-client/models/media_url.rb +1 -1
- data/lib/korona-cloud-client/models/method_not_allowed_error.rb +1 -1
- data/lib/korona-cloud-client/models/model_reference.rb +1 -1
- data/lib/korona-cloud-client/models/not_found_error.rb +1 -1
- data/lib/korona-cloud-client/models/opening_hours.rb +1 -1
- data/lib/korona-cloud-client/models/organizational_unit.rb +43 -34
- data/lib/korona-cloud-client/models/payment.rb +1 -1
- data/lib/korona-cloud-client/models/payment_method.rb +11 -2
- data/lib/korona-cloud-client/models/payment_summary.rb +1 -1
- data/lib/korona-cloud-client/models/period.rb +1 -1
- data/lib/korona-cloud-client/models/period_list_top_seller.rb +1 -1
- data/lib/korona-cloud-client/models/period_map_string_revenue_data.rb +1 -1
- data/lib/korona-cloud-client/models/period_object.rb +1 -1
- data/lib/korona-cloud-client/models/period_revenue_data.rb +1 -1
- data/lib/korona-cloud-client/models/pos.rb +44 -17
- data/lib/korona-cloud-client/models/price_group.rb +1 -1
- data/lib/korona-cloud-client/models/product.rb +1 -1
- data/lib/korona-cloud-client/models/product_code.rb +1 -1
- data/lib/korona-cloud-client/models/product_description.rb +1 -1
- data/lib/korona-cloud-client/models/product_price.rb +1 -1
- data/lib/korona-cloud-client/models/product_stock.rb +1 -1
- data/lib/korona-cloud-client/models/product_subproduct.rb +1 -1
- data/lib/korona-cloud-client/models/product_supplier_price.rb +1 -1
- data/lib/korona-cloud-client/models/product_transfer_involved_party_information.rb +1 -1
- data/lib/korona-cloud-client/models/product_transfer_involved_party_information_data.rb +1 -1
- data/lib/korona-cloud-client/models/production_type.rb +328 -0
- data/lib/korona-cloud-client/models/rating.rb +1 -1
- data/lib/korona-cloud-client/models/receipt.rb +82 -31
- data/lib/korona-cloud-client/models/receipt_item.rb +14 -5
- data/lib/korona-cloud-client/models/receipt_max_revisions.rb +251 -0
- data/lib/korona-cloud-client/models/result_list.rb +1 -1
- data/lib/korona-cloud-client/models/result_list_account.rb +1 -1
- data/lib/korona-cloud-client/models/result_list_additional_receipt_info_type.rb +1 -1
- data/lib/korona-cloud-client/models/result_list_assortment.rb +1 -1
- data/lib/korona-cloud-client/models/result_list_attendance.rb +1 -1
- data/lib/korona-cloud-client/models/result_list_cashier.rb +1 -1
- data/lib/korona-cloud-client/models/result_list_cashier_role.rb +291 -0
- data/lib/korona-cloud-client/models/result_list_commodity_group.rb +1 -1
- data/lib/korona-cloud-client/models/result_list_creation_task.rb +1 -1
- data/lib/korona-cloud-client/models/result_list_currency.rb +1 -1
- data/lib/korona-cloud-client/models/result_list_customer.rb +1 -1
- data/lib/korona-cloud-client/models/result_list_customer_group.rb +1 -1
- data/lib/korona-cloud-client/models/result_list_customer_order.rb +1 -1
- data/lib/korona-cloud-client/models/result_list_day_rating.rb +1 -1
- data/lib/korona-cloud-client/models/result_list_delivery_note.rb +1 -1
- data/lib/korona-cloud-client/models/result_list_economic_zone.rb +1 -1
- data/lib/korona-cloud-client/models/result_list_end_of_day_statement.rb +1 -1
- data/lib/korona-cloud-client/models/result_list_entry_gate.rb +1 -1
- data/lib/korona-cloud-client/models/result_list_event.rb +1 -1
- data/lib/korona-cloud-client/models/result_list_external_system_call.rb +1 -1
- data/lib/korona-cloud-client/models/result_list_fiscal_unit.rb +291 -0
- data/lib/korona-cloud-client/models/result_list_info_text.rb +1 -1
- data/lib/korona-cloud-client/models/result_list_inventory.rb +1 -1
- data/lib/korona-cloud-client/models/result_list_inventory_list.rb +1 -1
- data/lib/korona-cloud-client/models/result_list_inventory_list_item.rb +1 -1
- data/lib/korona-cloud-client/models/result_list_organizational_unit.rb +1 -1
- data/lib/korona-cloud-client/models/result_list_payment_method.rb +1 -1
- data/lib/korona-cloud-client/models/result_list_pos.rb +1 -1
- data/lib/korona-cloud-client/models/result_list_price_group.rb +1 -1
- data/lib/korona-cloud-client/models/result_list_product.rb +1 -1
- data/lib/korona-cloud-client/models/result_list_product_stock.rb +1 -1
- data/lib/korona-cloud-client/models/result_list_production_type.rb +291 -0
- data/lib/korona-cloud-client/models/result_list_receipt.rb +1 -1
- data/lib/korona-cloud-client/models/result_list_sales_tax.rb +1 -1
- data/lib/korona-cloud-client/models/result_list_sector.rb +1 -1
- data/lib/korona-cloud-client/models/result_list_stock_order.rb +291 -0
- data/lib/korona-cloud-client/models/result_list_stock_receipt.rb +1 -1
- data/lib/korona-cloud-client/models/result_list_stock_receipt_item.rb +1 -1
- data/lib/korona-cloud-client/models/result_list_supplier.rb +1 -1
- data/lib/korona-cloud-client/models/result_list_tag.rb +1 -1
- data/lib/korona-cloud-client/models/result_list_ticket.rb +1 -1
- data/lib/korona-cloud-client/models/result_list_ticket_definition.rb +1 -1
- data/lib/korona-cloud-client/models/result_list_time_tracking_entity.rb +1 -1
- data/lib/korona-cloud-client/models/result_list_time_tracking_entry.rb +1 -1
- data/lib/korona-cloud-client/models/revenue_data.rb +1 -1
- data/lib/korona-cloud-client/models/sales_tax.rb +45 -2
- data/lib/korona-cloud-client/models/sales_tax_rate.rb +1 -1
- data/lib/korona-cloud-client/models/sector.rb +1 -1
- data/lib/korona-cloud-client/models/sector_revenue_account_item.rb +1 -1
- data/lib/korona-cloud-client/models/sector_sales_tax_item.rb +1 -1
- data/lib/korona-cloud-client/models/service.rb +249 -0
- data/lib/korona-cloud-client/models/signature.rb +1 -1
- data/lib/korona-cloud-client/models/statistic.rb +1 -1
- data/lib/korona-cloud-client/models/statistic_list_top_seller.rb +1 -1
- data/lib/korona-cloud-client/models/statistic_map_string_revenue_data.rb +1 -1
- data/lib/korona-cloud-client/models/statistic_revenue_data.rb +1 -1
- data/lib/korona-cloud-client/models/stock_order.rb +498 -0
- data/lib/korona-cloud-client/models/stock_order_item.rb +305 -0
- data/lib/korona-cloud-client/models/stock_receipt.rb +20 -2
- data/lib/korona-cloud-client/models/stock_receipt_item.rb +1 -1
- data/lib/korona-cloud-client/models/stock_receipt_item_amount.rb +1 -1
- data/lib/korona-cloud-client/models/stock_receipt_item_identification.rb +1 -1
- data/lib/korona-cloud-client/models/stock_receipt_item_purchase_price.rb +1 -1
- data/lib/korona-cloud-client/models/supplier.rb +1 -1
- data/lib/korona-cloud-client/models/supplier_contact.rb +1 -1
- data/lib/korona-cloud-client/models/supplier_contact_person.rb +1 -1
- data/lib/korona-cloud-client/models/supplier_payment_information.rb +1 -1
- data/lib/korona-cloud-client/models/tag.rb +1 -1
- data/lib/korona-cloud-client/models/tax_payment.rb +1 -1
- data/lib/korona-cloud-client/models/tax_summary.rb +1 -1
- data/lib/korona-cloud-client/models/ticket.rb +1 -1
- data/lib/korona-cloud-client/models/ticket_data.rb +1 -1
- data/lib/korona-cloud-client/models/ticket_definition.rb +1 -1
- data/lib/korona-cloud-client/models/ticket_personalization.rb +1 -1
- data/lib/korona-cloud-client/models/time_period.rb +1 -1
- data/lib/korona-cloud-client/models/time_tracking_entity.rb +1 -1
- data/lib/korona-cloud-client/models/time_tracking_entry.rb +1 -1
- data/lib/korona-cloud-client/models/too_many_requests_error.rb +1 -1
- data/lib/korona-cloud-client/models/top_seller.rb +1 -1
- data/lib/korona-cloud-client/models/total_period.rb +1 -1
- data/lib/korona-cloud-client/models/total_price.rb +1 -1
- data/lib/korona-cloud-client/models/validity.rb +1 -1
- data/lib/korona-cloud-client/models/voided_receipt_item.rb +242 -0
- data/lib/korona-cloud-client/models/weather.rb +1 -1
- data/lib/korona-cloud-client/version.rb +2 -2
- data/spec/api/cashier_roles_api_spec.rb +126 -0
- data/spec/api/fiscal_units_api_spec.rb +104 -0
- data/spec/api/production_types_api_spec.rb +101 -0
- data/spec/api/stock_orders_api_spec.rb +83 -0
- data/spec/models/cashier_role_spec.rb +75 -0
- data/spec/models/cloud_subscription_details_spec.rb +51 -0
- data/spec/models/fiscal_transaction_spec.rb +119 -0
- data/spec/models/fiscal_unit_certificate_info_spec.rb +47 -0
- data/spec/models/fiscal_unit_spec.rb +147 -0
- data/spec/models/fiscal_unit_state_spec.rb +75 -0
- data/spec/models/fiscal_unit_state_usage_level_spec.rb +59 -0
- data/spec/models/fiscal_unit_state_usage_level_value_spec.rb +47 -0
- data/spec/models/fiscal_unit_state_version_info_spec.rb +53 -0
- data/spec/models/production_type_spec.rb +97 -0
- data/spec/models/receipt_max_revisions_spec.rb +71 -0
- data/spec/models/result_list_cashier_role_spec.rb +71 -0
- data/spec/models/result_list_fiscal_unit_spec.rb +71 -0
- data/spec/models/result_list_production_type_spec.rb +71 -0
- data/spec/models/result_list_stock_order_spec.rb +71 -0
- data/spec/models/service_spec.rb +51 -0
- data/spec/models/stock_order_item_spec.rb +107 -0
- data/spec/models/stock_order_spec.rb +213 -0
- data/spec/models/voided_receipt_item_spec.rb +65 -0
- metadata +96 -3
data/docs/Customer.md
CHANGED
@@ -23,6 +23,8 @@ Name | Type | Description | Notes
|
|
23
23
|
**tax_id** | **String** | | [optional]
|
24
24
|
**privacy_policy_accepted** | **Boolean** | | [optional]
|
25
25
|
**marketing_contact_permitted** | **Boolean** | | [optional]
|
26
|
+
**create_time** | **Date** | | [optional] [readonly]
|
27
|
+
**last_receipt_time** | **Date** | | [optional] [readonly]
|
26
28
|
|
27
29
|
## Code Sample
|
28
30
|
|
@@ -47,7 +49,9 @@ instance = KoronaCloudClient::Customer.new(active: null,
|
|
47
49
|
phone: null,
|
48
50
|
tax_id: null,
|
49
51
|
privacy_policy_accepted: null,
|
50
|
-
marketing_contact_permitted: null
|
52
|
+
marketing_contact_permitted: null,
|
53
|
+
create_time: null,
|
54
|
+
last_receipt_time: null)
|
51
55
|
```
|
52
56
|
|
53
57
|
|
data/docs/EconomicZonesApi.md
CHANGED
@@ -4,11 +4,124 @@ All URIs are relative to *https://www.koronacloud.com/web/api/v3*
|
|
4
4
|
|
5
5
|
Method | HTTP request | Description
|
6
6
|
------------- | ------------- | -------------
|
7
|
+
[**add_economic_zones**](EconomicZonesApi.md#add_economic_zones) | **POST** /accounts/{koronaAccountId}/economicZones | adds a batch of new economic zones
|
8
|
+
[**delete_economic_zones**](EconomicZonesApi.md#delete_economic_zones) | **DELETE** /accounts/{koronaAccountId}/economicZones | deletes a batch of economic zones
|
7
9
|
[**get_economic_zone**](EconomicZonesApi.md#get_economic_zone) | **GET** /accounts/{koronaAccountId}/economicZones/{economicZoneId} | returns the single economic zone
|
8
10
|
[**get_economic_zones**](EconomicZonesApi.md#get_economic_zones) | **GET** /accounts/{koronaAccountId}/economicZones | lists all economic zones
|
11
|
+
[**update_economic_zones**](EconomicZonesApi.md#update_economic_zones) | **PATCH** /accounts/{koronaAccountId}/economicZones | updates a batch of economic zones
|
9
12
|
|
10
13
|
|
11
14
|
|
15
|
+
## add_economic_zones
|
16
|
+
|
17
|
+
> Array<AddOrUpdateResult> add_economic_zones(korona_account_id, body, opts)
|
18
|
+
|
19
|
+
adds a batch of new economic zones
|
20
|
+
|
21
|
+
### Example
|
22
|
+
|
23
|
+
```ruby
|
24
|
+
# load the gem
|
25
|
+
require 'korona-cloud-client'
|
26
|
+
# setup authorization
|
27
|
+
KoronaCloudClient.configure do |config|
|
28
|
+
# Configure HTTP basic authorization: basicAuth
|
29
|
+
config.username = 'YOUR USERNAME'
|
30
|
+
config.password = 'YOUR PASSWORD'
|
31
|
+
end
|
32
|
+
|
33
|
+
api_instance = KoronaCloudClient::EconomicZonesApi.new
|
34
|
+
korona_account_id = 'korona_account_id_example' # String | account id of the KORONA.cloud account
|
35
|
+
body = [KoronaCloudClient::EconomicZone.new] # Array<EconomicZone> | array of new economic zones
|
36
|
+
opts = {
|
37
|
+
upsert: true # Boolean | when set to true, updates the object instead of generating a already-exists-error
|
38
|
+
}
|
39
|
+
|
40
|
+
begin
|
41
|
+
#adds a batch of new economic zones
|
42
|
+
result = api_instance.add_economic_zones(korona_account_id, body, opts)
|
43
|
+
p result
|
44
|
+
rescue KoronaCloudClient::ApiError => e
|
45
|
+
puts "Exception when calling EconomicZonesApi->add_economic_zones: #{e}"
|
46
|
+
end
|
47
|
+
```
|
48
|
+
|
49
|
+
### Parameters
|
50
|
+
|
51
|
+
|
52
|
+
Name | Type | Description | Notes
|
53
|
+
------------- | ------------- | ------------- | -------------
|
54
|
+
**korona_account_id** | **String**| account id of the KORONA.cloud account |
|
55
|
+
**body** | [**Array<EconomicZone>**](EconomicZone.md)| array of new economic zones |
|
56
|
+
**upsert** | **Boolean**| when set to true, updates the object instead of generating a already-exists-error | [optional]
|
57
|
+
|
58
|
+
### Return type
|
59
|
+
|
60
|
+
[**Array<AddOrUpdateResult>**](AddOrUpdateResult.md)
|
61
|
+
|
62
|
+
### Authorization
|
63
|
+
|
64
|
+
[basicAuth](../README.md#basicAuth)
|
65
|
+
|
66
|
+
### HTTP request headers
|
67
|
+
|
68
|
+
- **Content-Type**: application/json
|
69
|
+
- **Accept**: application/json
|
70
|
+
|
71
|
+
|
72
|
+
## delete_economic_zones
|
73
|
+
|
74
|
+
> Array<AddOrUpdateResult> delete_economic_zones(korona_account_id, body)
|
75
|
+
|
76
|
+
deletes a batch of economic zones
|
77
|
+
|
78
|
+
### Example
|
79
|
+
|
80
|
+
```ruby
|
81
|
+
# load the gem
|
82
|
+
require 'korona-cloud-client'
|
83
|
+
# setup authorization
|
84
|
+
KoronaCloudClient.configure do |config|
|
85
|
+
# Configure HTTP basic authorization: basicAuth
|
86
|
+
config.username = 'YOUR USERNAME'
|
87
|
+
config.password = 'YOUR PASSWORD'
|
88
|
+
end
|
89
|
+
|
90
|
+
api_instance = KoronaCloudClient::EconomicZonesApi.new
|
91
|
+
korona_account_id = 'korona_account_id_example' # String | account id of the KORONA.cloud account
|
92
|
+
body = [KoronaCloudClient::EconomicZone.new] # Array<EconomicZone> | array of existing economic zones (id or number required)
|
93
|
+
|
94
|
+
begin
|
95
|
+
#deletes a batch of economic zones
|
96
|
+
result = api_instance.delete_economic_zones(korona_account_id, body)
|
97
|
+
p result
|
98
|
+
rescue KoronaCloudClient::ApiError => e
|
99
|
+
puts "Exception when calling EconomicZonesApi->delete_economic_zones: #{e}"
|
100
|
+
end
|
101
|
+
```
|
102
|
+
|
103
|
+
### Parameters
|
104
|
+
|
105
|
+
|
106
|
+
Name | Type | Description | Notes
|
107
|
+
------------- | ------------- | ------------- | -------------
|
108
|
+
**korona_account_id** | **String**| account id of the KORONA.cloud account |
|
109
|
+
**body** | [**Array<EconomicZone>**](EconomicZone.md)| array of existing economic zones (id or number required) |
|
110
|
+
|
111
|
+
### Return type
|
112
|
+
|
113
|
+
[**Array<AddOrUpdateResult>**](AddOrUpdateResult.md)
|
114
|
+
|
115
|
+
### Authorization
|
116
|
+
|
117
|
+
[basicAuth](../README.md#basicAuth)
|
118
|
+
|
119
|
+
### HTTP request headers
|
120
|
+
|
121
|
+
- **Content-Type**: application/json
|
122
|
+
- **Accept**: application/json
|
123
|
+
|
124
|
+
|
12
125
|
## get_economic_zone
|
13
126
|
|
14
127
|
> EconomicZone get_economic_zone(korona_account_id, economic_zone_id)
|
@@ -126,3 +239,56 @@ Name | Type | Description | Notes
|
|
126
239
|
- **Content-Type**: Not defined
|
127
240
|
- **Accept**: application/json
|
128
241
|
|
242
|
+
|
243
|
+
## update_economic_zones
|
244
|
+
|
245
|
+
> Array<AddOrUpdateResult> update_economic_zones(korona_account_id, body)
|
246
|
+
|
247
|
+
updates a batch of economic zones
|
248
|
+
|
249
|
+
### Example
|
250
|
+
|
251
|
+
```ruby
|
252
|
+
# load the gem
|
253
|
+
require 'korona-cloud-client'
|
254
|
+
# setup authorization
|
255
|
+
KoronaCloudClient.configure do |config|
|
256
|
+
# Configure HTTP basic authorization: basicAuth
|
257
|
+
config.username = 'YOUR USERNAME'
|
258
|
+
config.password = 'YOUR PASSWORD'
|
259
|
+
end
|
260
|
+
|
261
|
+
api_instance = KoronaCloudClient::EconomicZonesApi.new
|
262
|
+
korona_account_id = 'korona_account_id_example' # String | account id of the KORONA.cloud account
|
263
|
+
body = [KoronaCloudClient::EconomicZone.new] # Array<EconomicZone> | array of existing economic zones (id or number required)
|
264
|
+
|
265
|
+
begin
|
266
|
+
#updates a batch of economic zones
|
267
|
+
result = api_instance.update_economic_zones(korona_account_id, body)
|
268
|
+
p result
|
269
|
+
rescue KoronaCloudClient::ApiError => e
|
270
|
+
puts "Exception when calling EconomicZonesApi->update_economic_zones: #{e}"
|
271
|
+
end
|
272
|
+
```
|
273
|
+
|
274
|
+
### Parameters
|
275
|
+
|
276
|
+
|
277
|
+
Name | Type | Description | Notes
|
278
|
+
------------- | ------------- | ------------- | -------------
|
279
|
+
**korona_account_id** | **String**| account id of the KORONA.cloud account |
|
280
|
+
**body** | [**Array<EconomicZone>**](EconomicZone.md)| array of existing economic zones (id or number required) |
|
281
|
+
|
282
|
+
### Return type
|
283
|
+
|
284
|
+
[**Array<AddOrUpdateResult>**](AddOrUpdateResult.md)
|
285
|
+
|
286
|
+
### Authorization
|
287
|
+
|
288
|
+
[basicAuth](../README.md#basicAuth)
|
289
|
+
|
290
|
+
### HTTP request headers
|
291
|
+
|
292
|
+
- **Content-Type**: application/json
|
293
|
+
- **Accept**: application/json
|
294
|
+
|
@@ -0,0 +1,43 @@
|
|
1
|
+
# KoronaCloudClient::FiscalTransaction
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**error_description** | **String** | | [optional]
|
8
|
+
**failed** | **Boolean** | | [optional]
|
9
|
+
**finish_time** | **DateTime** | | [optional]
|
10
|
+
**first_process_time** | **DateTime** | | [optional]
|
11
|
+
**fiscal_unit** | [**ModelReference**](ModelReference.md) | | [optional]
|
12
|
+
**number** | **Integer** | | [optional]
|
13
|
+
**print_link** | **String** | | [optional]
|
14
|
+
**print_qr_code** | **String** | | [optional]
|
15
|
+
**print_texts** | **Array<String>** | | [optional]
|
16
|
+
**process_data** | **String** | | [optional]
|
17
|
+
**process_type** | **String** | | [optional]
|
18
|
+
**signature** | **String** | | [optional]
|
19
|
+
**signature_counter** | **Integer** | | [optional]
|
20
|
+
**start_time** | **DateTime** | | [optional]
|
21
|
+
|
22
|
+
## Code Sample
|
23
|
+
|
24
|
+
```ruby
|
25
|
+
require 'KoronaCloudClient'
|
26
|
+
|
27
|
+
instance = KoronaCloudClient::FiscalTransaction.new(error_description: null,
|
28
|
+
failed: null,
|
29
|
+
finish_time: null,
|
30
|
+
first_process_time: null,
|
31
|
+
fiscal_unit: null,
|
32
|
+
number: null,
|
33
|
+
print_link: null,
|
34
|
+
print_qr_code: null,
|
35
|
+
print_texts: null,
|
36
|
+
process_data: null,
|
37
|
+
process_type: null,
|
38
|
+
signature: null,
|
39
|
+
signature_counter: null,
|
40
|
+
start_time: null)
|
41
|
+
```
|
42
|
+
|
43
|
+
|
data/docs/FiscalUnit.md
ADDED
@@ -0,0 +1,51 @@
|
|
1
|
+
# KoronaCloudClient::FiscalUnit
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**active** | **Boolean** | indicates whether the object is active for use or not | [optional] [readonly]
|
8
|
+
**id** | **String** | global object uuid (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx) | [optional]
|
9
|
+
**number** | **String** | number of the object, like it is set in backoffice; will be removed when active=false | [optional]
|
10
|
+
**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] [readonly]
|
11
|
+
**admin_pin** | **String** | | [optional]
|
12
|
+
**admin_puk** | **String** | | [optional]
|
13
|
+
**certificate** | [**FiscalUnitCertificateInfo**](FiscalUnitCertificateInfo.md) | | [optional]
|
14
|
+
**log_time_format** | **String** | | [optional]
|
15
|
+
**name** | **String** | | [optional]
|
16
|
+
**process_data_encoding** | **String** | | [optional]
|
17
|
+
**public_key** | **String** | public key of the fiscal unit. Value can only be set on create and is not changable on update. | [optional]
|
18
|
+
**signature_algorithm** | **String** | | [optional]
|
19
|
+
**state** | [**FiscalUnitState**](FiscalUnitState.md) | | [optional]
|
20
|
+
**time_admin_pin** | **String** | | [optional]
|
21
|
+
**type** | **String** | | [optional]
|
22
|
+
**api_key** | **String** | | [optional]
|
23
|
+
**api_secret** | **String** | | [optional]
|
24
|
+
**remote_url** | **String** | | [optional]
|
25
|
+
|
26
|
+
## Code Sample
|
27
|
+
|
28
|
+
```ruby
|
29
|
+
require 'KoronaCloudClient'
|
30
|
+
|
31
|
+
instance = KoronaCloudClient::FiscalUnit.new(active: null,
|
32
|
+
id: null,
|
33
|
+
number: null,
|
34
|
+
revision: null,
|
35
|
+
admin_pin: null,
|
36
|
+
admin_puk: null,
|
37
|
+
certificate: null,
|
38
|
+
log_time_format: null,
|
39
|
+
name: null,
|
40
|
+
process_data_encoding: null,
|
41
|
+
public_key: null,
|
42
|
+
signature_algorithm: null,
|
43
|
+
state: null,
|
44
|
+
time_admin_pin: null,
|
45
|
+
type: null,
|
46
|
+
api_key: null,
|
47
|
+
api_secret: null,
|
48
|
+
remote_url: null)
|
49
|
+
```
|
50
|
+
|
51
|
+
|
@@ -0,0 +1,19 @@
|
|
1
|
+
# KoronaCloudClient::FiscalUnitCertificateInfo
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**data** | **String** | log message certificate of the fiscal unit. Value can only be set on create and is not changable on update. | [optional]
|
8
|
+
**expiration_date** | **DateTime** | | [optional]
|
9
|
+
|
10
|
+
## Code Sample
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'KoronaCloudClient'
|
14
|
+
|
15
|
+
instance = KoronaCloudClient::FiscalUnitCertificateInfo.new(data: null,
|
16
|
+
expiration_date: null)
|
17
|
+
```
|
18
|
+
|
19
|
+
|
@@ -0,0 +1,27 @@
|
|
1
|
+
# KoronaCloudClient::FiscalUnitState
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**additional_information** | **Hash<String, String>** | | [optional]
|
8
|
+
**error_description** | **String** | | [optional]
|
9
|
+
**setup_failed** | **Boolean** | | [optional]
|
10
|
+
**usage_level** | [**FiscalUnitStateUsageLevel**](FiscalUnitStateUsageLevel.md) | | [optional]
|
11
|
+
**versions** | [**FiscalUnitStateVersionInfo**](FiscalUnitStateVersionInfo.md) | | [optional]
|
12
|
+
**working_state** | **String** | | [optional]
|
13
|
+
|
14
|
+
## Code Sample
|
15
|
+
|
16
|
+
```ruby
|
17
|
+
require 'KoronaCloudClient'
|
18
|
+
|
19
|
+
instance = KoronaCloudClient::FiscalUnitState.new(additional_information: null,
|
20
|
+
error_description: null,
|
21
|
+
setup_failed: null,
|
22
|
+
usage_level: null,
|
23
|
+
versions: null,
|
24
|
+
working_state: null)
|
25
|
+
```
|
26
|
+
|
27
|
+
|
@@ -0,0 +1,23 @@
|
|
1
|
+
# KoronaCloudClient::FiscalUnitStateUsageLevel
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**registered_clients** | [**FiscalUnitStateUsageLevelValue**](FiscalUnitStateUsageLevelValue.md) | | [optional]
|
8
|
+
**created_signatures** | [**FiscalUnitStateUsageLevelValue**](FiscalUnitStateUsageLevelValue.md) | | [optional]
|
9
|
+
**stored_bytes** | [**FiscalUnitStateUsageLevelValue**](FiscalUnitStateUsageLevelValue.md) | | [optional]
|
10
|
+
**unfinished_transactions** | [**FiscalUnitStateUsageLevelValue**](FiscalUnitStateUsageLevelValue.md) | | [optional]
|
11
|
+
|
12
|
+
## Code Sample
|
13
|
+
|
14
|
+
```ruby
|
15
|
+
require 'KoronaCloudClient'
|
16
|
+
|
17
|
+
instance = KoronaCloudClient::FiscalUnitStateUsageLevel.new(registered_clients: null,
|
18
|
+
created_signatures: null,
|
19
|
+
stored_bytes: null,
|
20
|
+
unfinished_transactions: null)
|
21
|
+
```
|
22
|
+
|
23
|
+
|
@@ -0,0 +1,19 @@
|
|
1
|
+
# KoronaCloudClient::FiscalUnitStateUsageLevelValue
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**current** | **Integer** | | [optional]
|
8
|
+
**limit** | **Integer** | | [optional]
|
9
|
+
|
10
|
+
## Code Sample
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'KoronaCloudClient'
|
14
|
+
|
15
|
+
instance = KoronaCloudClient::FiscalUnitStateUsageLevelValue.new(current: null,
|
16
|
+
limit: null)
|
17
|
+
```
|
18
|
+
|
19
|
+
|
@@ -0,0 +1,21 @@
|
|
1
|
+
# KoronaCloudClient::FiscalUnitStateVersionInfo
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**api** | **String** | | [optional]
|
8
|
+
**hardware** | **String** | | [optional]
|
9
|
+
**software** | **String** | | [optional]
|
10
|
+
|
11
|
+
## Code Sample
|
12
|
+
|
13
|
+
```ruby
|
14
|
+
require 'KoronaCloudClient'
|
15
|
+
|
16
|
+
instance = KoronaCloudClient::FiscalUnitStateVersionInfo.new(api: null,
|
17
|
+
hardware: null,
|
18
|
+
software: null)
|
19
|
+
```
|
20
|
+
|
21
|
+
|
@@ -0,0 +1,299 @@
|
|
1
|
+
# KoronaCloudClient::FiscalUnitsApi
|
2
|
+
|
3
|
+
All URIs are relative to *https://www.koronacloud.com/web/api/v3*
|
4
|
+
|
5
|
+
Method | HTTP request | Description
|
6
|
+
------------- | ------------- | -------------
|
7
|
+
[**add_fiscal_units**](FiscalUnitsApi.md#add_fiscal_units) | **POST** /accounts/{koronaAccountId}/fiscalUnits | adds a batch of fiscal units
|
8
|
+
[**get_fiscal_unit**](FiscalUnitsApi.md#get_fiscal_unit) | **GET** /accounts/{koronaAccountId}/fiscalUnits/{fiscalUnitId} | returns the single fiscal unit
|
9
|
+
[**get_fiscal_units**](FiscalUnitsApi.md#get_fiscal_units) | **GET** /accounts/{koronaAccountId}/fiscalUnits | lists all fiscal units
|
10
|
+
[**update_fiscal_unit**](FiscalUnitsApi.md#update_fiscal_unit) | **PATCH** /accounts/{koronaAccountId}/fiscalUnits/{fiscalUnitId} | updates the fiscal unit
|
11
|
+
[**update_fiscal_units**](FiscalUnitsApi.md#update_fiscal_units) | **PATCH** /accounts/{koronaAccountId}/fiscalUnits | updates a batch of fiscal units
|
12
|
+
|
13
|
+
|
14
|
+
|
15
|
+
## add_fiscal_units
|
16
|
+
|
17
|
+
> Array<AddOrUpdateResult> add_fiscal_units(korona_account_id, body, opts)
|
18
|
+
|
19
|
+
adds a batch of fiscal units
|
20
|
+
|
21
|
+
### Example
|
22
|
+
|
23
|
+
```ruby
|
24
|
+
# load the gem
|
25
|
+
require 'korona-cloud-client'
|
26
|
+
# setup authorization
|
27
|
+
KoronaCloudClient.configure do |config|
|
28
|
+
# Configure HTTP basic authorization: basicAuth
|
29
|
+
config.username = 'YOUR USERNAME'
|
30
|
+
config.password = 'YOUR PASSWORD'
|
31
|
+
end
|
32
|
+
|
33
|
+
api_instance = KoronaCloudClient::FiscalUnitsApi.new
|
34
|
+
korona_account_id = 'korona_account_id_example' # String | account id of the KORONA.cloud account
|
35
|
+
body = [KoronaCloudClient::FiscalUnit.new] # Array<FiscalUnit> | array of new fiscal units
|
36
|
+
opts = {
|
37
|
+
upsert: true # Boolean | when set to true, updates the object instead of generating a already-exists-error
|
38
|
+
}
|
39
|
+
|
40
|
+
begin
|
41
|
+
#adds a batch of fiscal units
|
42
|
+
result = api_instance.add_fiscal_units(korona_account_id, body, opts)
|
43
|
+
p result
|
44
|
+
rescue KoronaCloudClient::ApiError => e
|
45
|
+
puts "Exception when calling FiscalUnitsApi->add_fiscal_units: #{e}"
|
46
|
+
end
|
47
|
+
```
|
48
|
+
|
49
|
+
### Parameters
|
50
|
+
|
51
|
+
|
52
|
+
Name | Type | Description | Notes
|
53
|
+
------------- | ------------- | ------------- | -------------
|
54
|
+
**korona_account_id** | **String**| account id of the KORONA.cloud account |
|
55
|
+
**body** | [**Array<FiscalUnit>**](FiscalUnit.md)| array of new fiscal units |
|
56
|
+
**upsert** | **Boolean**| when set to true, updates the object instead of generating a already-exists-error | [optional]
|
57
|
+
|
58
|
+
### Return type
|
59
|
+
|
60
|
+
[**Array<AddOrUpdateResult>**](AddOrUpdateResult.md)
|
61
|
+
|
62
|
+
### Authorization
|
63
|
+
|
64
|
+
[basicAuth](../README.md#basicAuth)
|
65
|
+
|
66
|
+
### HTTP request headers
|
67
|
+
|
68
|
+
- **Content-Type**: application/json
|
69
|
+
- **Accept**: application/json
|
70
|
+
|
71
|
+
|
72
|
+
## get_fiscal_unit
|
73
|
+
|
74
|
+
> FiscalUnit get_fiscal_unit(korona_account_id, fiscal_unit_id)
|
75
|
+
|
76
|
+
returns the single fiscal unit
|
77
|
+
|
78
|
+
### Example
|
79
|
+
|
80
|
+
```ruby
|
81
|
+
# load the gem
|
82
|
+
require 'korona-cloud-client'
|
83
|
+
# setup authorization
|
84
|
+
KoronaCloudClient.configure do |config|
|
85
|
+
# Configure HTTP basic authorization: basicAuth
|
86
|
+
config.username = 'YOUR USERNAME'
|
87
|
+
config.password = 'YOUR PASSWORD'
|
88
|
+
end
|
89
|
+
|
90
|
+
api_instance = KoronaCloudClient::FiscalUnitsApi.new
|
91
|
+
korona_account_id = 'korona_account_id_example' # String | account id of the KORONA.cloud account
|
92
|
+
fiscal_unit_id = 'fiscal_unit_id_example' # String | id of the related object (important: id should match the uuid-format)
|
93
|
+
|
94
|
+
begin
|
95
|
+
#returns the single fiscal unit
|
96
|
+
result = api_instance.get_fiscal_unit(korona_account_id, fiscal_unit_id)
|
97
|
+
p result
|
98
|
+
rescue KoronaCloudClient::ApiError => e
|
99
|
+
puts "Exception when calling FiscalUnitsApi->get_fiscal_unit: #{e}"
|
100
|
+
end
|
101
|
+
```
|
102
|
+
|
103
|
+
### Parameters
|
104
|
+
|
105
|
+
|
106
|
+
Name | Type | Description | Notes
|
107
|
+
------------- | ------------- | ------------- | -------------
|
108
|
+
**korona_account_id** | **String**| account id of the KORONA.cloud account |
|
109
|
+
**fiscal_unit_id** | **String**| id of the related object (important: id should match the uuid-format) |
|
110
|
+
|
111
|
+
### Return type
|
112
|
+
|
113
|
+
[**FiscalUnit**](FiscalUnit.md)
|
114
|
+
|
115
|
+
### Authorization
|
116
|
+
|
117
|
+
[basicAuth](../README.md#basicAuth)
|
118
|
+
|
119
|
+
### HTTP request headers
|
120
|
+
|
121
|
+
- **Content-Type**: Not defined
|
122
|
+
- **Accept**: application/json
|
123
|
+
|
124
|
+
|
125
|
+
## get_fiscal_units
|
126
|
+
|
127
|
+
> ResultListFiscalUnit get_fiscal_units(korona_account_id, opts)
|
128
|
+
|
129
|
+
lists all fiscal units
|
130
|
+
|
131
|
+
### Example
|
132
|
+
|
133
|
+
```ruby
|
134
|
+
# load the gem
|
135
|
+
require 'korona-cloud-client'
|
136
|
+
# setup authorization
|
137
|
+
KoronaCloudClient.configure do |config|
|
138
|
+
# Configure HTTP basic authorization: basicAuth
|
139
|
+
config.username = 'YOUR USERNAME'
|
140
|
+
config.password = 'YOUR PASSWORD'
|
141
|
+
end
|
142
|
+
|
143
|
+
api_instance = KoronaCloudClient::FiscalUnitsApi.new
|
144
|
+
korona_account_id = 'korona_account_id_example' # String | account id of the KORONA.cloud account
|
145
|
+
opts = {
|
146
|
+
page: 56, # Integer | number of the page to fetch
|
147
|
+
size: 56, # Integer | amount of objects to return per page
|
148
|
+
sort: 'sort_example', # String | attribute to sort by (multiple separated by comma; max. 5)
|
149
|
+
revision: 56, # Integer | last revision number, objects with a greater revision than this will be returned
|
150
|
+
include_deleted: true, # Boolean | indicates deleted objects should be loaded or not (default: false)
|
151
|
+
number: 'number_example', # String | number of the related object
|
152
|
+
type: 'type_example', # String | type of fiscal unit
|
153
|
+
api_key: 'api_key_example' # String | api key of fiscal unit
|
154
|
+
}
|
155
|
+
|
156
|
+
begin
|
157
|
+
#lists all fiscal units
|
158
|
+
result = api_instance.get_fiscal_units(korona_account_id, opts)
|
159
|
+
p result
|
160
|
+
rescue KoronaCloudClient::ApiError => e
|
161
|
+
puts "Exception when calling FiscalUnitsApi->get_fiscal_units: #{e}"
|
162
|
+
end
|
163
|
+
```
|
164
|
+
|
165
|
+
### Parameters
|
166
|
+
|
167
|
+
|
168
|
+
Name | Type | Description | Notes
|
169
|
+
------------- | ------------- | ------------- | -------------
|
170
|
+
**korona_account_id** | **String**| account id of the KORONA.cloud account |
|
171
|
+
**page** | **Integer**| number of the page to fetch | [optional]
|
172
|
+
**size** | **Integer**| amount of objects to return per page | [optional]
|
173
|
+
**sort** | **String**| attribute to sort by (multiple separated by comma; max. 5) | [optional]
|
174
|
+
**revision** | **Integer**| last revision number, objects with a greater revision than this will be returned | [optional]
|
175
|
+
**include_deleted** | **Boolean**| indicates deleted objects should be loaded or not (default: false) | [optional]
|
176
|
+
**number** | **String**| number of the related object | [optional]
|
177
|
+
**type** | **String**| type of fiscal unit | [optional]
|
178
|
+
**api_key** | **String**| api key of fiscal unit | [optional]
|
179
|
+
|
180
|
+
### Return type
|
181
|
+
|
182
|
+
[**ResultListFiscalUnit**](ResultListFiscalUnit.md)
|
183
|
+
|
184
|
+
### Authorization
|
185
|
+
|
186
|
+
[basicAuth](../README.md#basicAuth)
|
187
|
+
|
188
|
+
### HTTP request headers
|
189
|
+
|
190
|
+
- **Content-Type**: Not defined
|
191
|
+
- **Accept**: application/json
|
192
|
+
|
193
|
+
|
194
|
+
## update_fiscal_unit
|
195
|
+
|
196
|
+
> update_fiscal_unit(korona_account_id, fiscal_unit_id, body)
|
197
|
+
|
198
|
+
updates the fiscal unit
|
199
|
+
|
200
|
+
### Example
|
201
|
+
|
202
|
+
```ruby
|
203
|
+
# load the gem
|
204
|
+
require 'korona-cloud-client'
|
205
|
+
# setup authorization
|
206
|
+
KoronaCloudClient.configure do |config|
|
207
|
+
# Configure HTTP basic authorization: basicAuth
|
208
|
+
config.username = 'YOUR USERNAME'
|
209
|
+
config.password = 'YOUR PASSWORD'
|
210
|
+
end
|
211
|
+
|
212
|
+
api_instance = KoronaCloudClient::FiscalUnitsApi.new
|
213
|
+
korona_account_id = 'korona_account_id_example' # String | account id of the KORONA.cloud account
|
214
|
+
fiscal_unit_id = 'fiscal_unit_id_example' # String | id of the related object (important: id should match the uuid-format)
|
215
|
+
body = KoronaCloudClient::FiscalUnit.new # FiscalUnit | the properties to update of the fiscal unit
|
216
|
+
|
217
|
+
begin
|
218
|
+
#updates the fiscal unit
|
219
|
+
api_instance.update_fiscal_unit(korona_account_id, fiscal_unit_id, body)
|
220
|
+
rescue KoronaCloudClient::ApiError => e
|
221
|
+
puts "Exception when calling FiscalUnitsApi->update_fiscal_unit: #{e}"
|
222
|
+
end
|
223
|
+
```
|
224
|
+
|
225
|
+
### Parameters
|
226
|
+
|
227
|
+
|
228
|
+
Name | Type | Description | Notes
|
229
|
+
------------- | ------------- | ------------- | -------------
|
230
|
+
**korona_account_id** | **String**| account id of the KORONA.cloud account |
|
231
|
+
**fiscal_unit_id** | **String**| id of the related object (important: id should match the uuid-format) |
|
232
|
+
**body** | [**FiscalUnit**](FiscalUnit.md)| the properties to update of the fiscal unit |
|
233
|
+
|
234
|
+
### Return type
|
235
|
+
|
236
|
+
nil (empty response body)
|
237
|
+
|
238
|
+
### Authorization
|
239
|
+
|
240
|
+
[basicAuth](../README.md#basicAuth)
|
241
|
+
|
242
|
+
### HTTP request headers
|
243
|
+
|
244
|
+
- **Content-Type**: application/json
|
245
|
+
- **Accept**: application/json
|
246
|
+
|
247
|
+
|
248
|
+
## update_fiscal_units
|
249
|
+
|
250
|
+
> Array<AddOrUpdateResult> update_fiscal_units(korona_account_id, body)
|
251
|
+
|
252
|
+
updates a batch of fiscal units
|
253
|
+
|
254
|
+
### Example
|
255
|
+
|
256
|
+
```ruby
|
257
|
+
# load the gem
|
258
|
+
require 'korona-cloud-client'
|
259
|
+
# setup authorization
|
260
|
+
KoronaCloudClient.configure do |config|
|
261
|
+
# Configure HTTP basic authorization: basicAuth
|
262
|
+
config.username = 'YOUR USERNAME'
|
263
|
+
config.password = 'YOUR PASSWORD'
|
264
|
+
end
|
265
|
+
|
266
|
+
api_instance = KoronaCloudClient::FiscalUnitsApi.new
|
267
|
+
korona_account_id = 'korona_account_id_example' # String | account id of the KORONA.cloud account
|
268
|
+
body = [KoronaCloudClient::FiscalUnit.new] # Array<FiscalUnit> | array of existing fiscal units (id or number required)
|
269
|
+
|
270
|
+
begin
|
271
|
+
#updates a batch of fiscal units
|
272
|
+
result = api_instance.update_fiscal_units(korona_account_id, body)
|
273
|
+
p result
|
274
|
+
rescue KoronaCloudClient::ApiError => e
|
275
|
+
puts "Exception when calling FiscalUnitsApi->update_fiscal_units: #{e}"
|
276
|
+
end
|
277
|
+
```
|
278
|
+
|
279
|
+
### Parameters
|
280
|
+
|
281
|
+
|
282
|
+
Name | Type | Description | Notes
|
283
|
+
------------- | ------------- | ------------- | -------------
|
284
|
+
**korona_account_id** | **String**| account id of the KORONA.cloud account |
|
285
|
+
**body** | [**Array<FiscalUnit>**](FiscalUnit.md)| array of existing fiscal units (id or number required) |
|
286
|
+
|
287
|
+
### Return type
|
288
|
+
|
289
|
+
[**Array<AddOrUpdateResult>**](AddOrUpdateResult.md)
|
290
|
+
|
291
|
+
### Authorization
|
292
|
+
|
293
|
+
[basicAuth](../README.md#basicAuth)
|
294
|
+
|
295
|
+
### HTTP request headers
|
296
|
+
|
297
|
+
- **Content-Type**: application/json
|
298
|
+
- **Accept**: application/json
|
299
|
+
|