tripletex_api 1.0.0

data/docs/OrderApi.md

@@ -0,0 +1,319 @@
+# TripletexApi::OrderApi
+
+All URIs are relative to *https://tripletex.no/v2*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**get**](OrderApi.md#get) | **GET** /order/{id} | Get order by ID.
+[**invoice**](OrderApi.md#invoice) | **PUT** /order/{id}/:invoice | Create new invoice from order.
+[**post**](OrderApi.md#post) | **POST** /order | Create order.
+[**put**](OrderApi.md#put) | **PUT** /order/{id} | Update order.
+[**search**](OrderApi.md#search) | **GET** /order | Find orders corresponding with sent data.
+
+
+# **get**
+> ResponseWrapperOrder get(id, opts)
+
+Get order by ID.
+
+
+
+### Example
+```ruby
+# load the gem
+require 'tripletex_api'
+# setup authorization
+TripletexApi.configure do |config|
+  # Configure HTTP basic authorization: tokenAuthScheme
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = TripletexApi::OrderApi.new
+
+id = 56 # Integer | Element ID
+
+opts = { 
+  fields: "fields_example" # String | Fields filter pattern
+}
+
+begin
+  #Get order by ID.
+  result = api_instance.get(id, opts)
+  p result
+rescue TripletexApi::ApiError => e
+  puts "Exception when calling OrderApi->get: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **Integer**| Element ID | 
+ **fields** | **String**| Fields filter pattern | [optional] 
+
+### Return type
+
+[**ResponseWrapperOrder**](ResponseWrapperOrder.md)
+
+### Authorization
+
+[tokenAuthScheme](../README.md#tokenAuthScheme)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: Not defined
+
+
+
+# **invoice**
+> ResponseWrapperInvoice invoice(id, invoice_date, opts)
+
+Create new invoice from order.
+
+
+
+### Example
+```ruby
+# load the gem
+require 'tripletex_api'
+# setup authorization
+TripletexApi.configure do |config|
+  # Configure HTTP basic authorization: tokenAuthScheme
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = TripletexApi::OrderApi.new
+
+id = 56 # Integer | ID of order to invoice.
+
+invoice_date = "invoice_date_example" # String | To and excluding
+
+opts = { 
+  send_to_customer: true, # BOOLEAN | Send invoice to customer
+  payment_type_id: 56, # Integer | Payment type to register prepayment of the invoice. paymentTypeId and paidAmount are optional, but both must be provided if the invoice has already been paid.
+  paid_amount: 8.14 # Float | Paid amount to register prepayment of the invoice, in invoice currency. paymentTypeId and paidAmount are optional, but both must be provided if the invoice has already been paid.
+}
+
+begin
+  #Create new invoice from order.
+  result = api_instance.invoice(id, invoice_date, opts)
+  p result
+rescue TripletexApi::ApiError => e
+  puts "Exception when calling OrderApi->invoice: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **Integer**| ID of order to invoice. | 
+ **invoice_date** | **String**| To and excluding | 
+ **send_to_customer** | **BOOLEAN**| Send invoice to customer | [optional] [default to true]
+ **payment_type_id** | **Integer**| Payment type to register prepayment of the invoice. paymentTypeId and paidAmount are optional, but both must be provided if the invoice has already been paid. | [optional] 
+ **paid_amount** | **Float**| Paid amount to register prepayment of the invoice, in invoice currency. paymentTypeId and paidAmount are optional, but both must be provided if the invoice has already been paid. | [optional] 
+
+### Return type
+
+[**ResponseWrapperInvoice**](ResponseWrapperInvoice.md)
+
+### Authorization
+
+[tokenAuthScheme](../README.md#tokenAuthScheme)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: Not defined
+
+
+
+# **post**
+> ResponseWrapperOrder post(opts)
+
+Create order.
+
+
+
+### Example
+```ruby
+# load the gem
+require 'tripletex_api'
+# setup authorization
+TripletexApi.configure do |config|
+  # Configure HTTP basic authorization: tokenAuthScheme
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = TripletexApi::OrderApi.new
+
+opts = { 
+  body: TripletexApi::Order.new # Order | JSON representing the new object to be created. Should not have ID and version set.
+}
+
+begin
+  #Create order.
+  result = api_instance.post(opts)
+  p result
+rescue TripletexApi::ApiError => e
+  puts "Exception when calling OrderApi->post: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**Order**](Order.md)| JSON representing the new object to be created. Should not have ID and version set. | [optional] 
+
+### Return type
+
+[**ResponseWrapperOrder**](ResponseWrapperOrder.md)
+
+### Authorization
+
+[tokenAuthScheme](../README.md#tokenAuthScheme)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json; charset=utf-8
+ - **Accept**: Not defined
+
+
+
+# **put**
+> ResponseWrapperOrder put(id, opts)
+
+Update order.
+
+
+
+### Example
+```ruby
+# load the gem
+require 'tripletex_api'
+# setup authorization
+TripletexApi.configure do |config|
+  # Configure HTTP basic authorization: tokenAuthScheme
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = TripletexApi::OrderApi.new
+
+id = 56 # Integer | Element ID
+
+opts = { 
+  body: TripletexApi::Order.new # Order | Partial object describing what should be updated
+}
+
+begin
+  #Update order.
+  result = api_instance.put(id, opts)
+  p result
+rescue TripletexApi::ApiError => e
+  puts "Exception when calling OrderApi->put: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **Integer**| Element ID | 
+ **body** | [**Order**](Order.md)| Partial object describing what should be updated | [optional] 
+
+### Return type
+
+[**ResponseWrapperOrder**](ResponseWrapperOrder.md)
+
+### Authorization
+
+[tokenAuthScheme](../README.md#tokenAuthScheme)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json; charset=utf-8
+ - **Accept**: Not defined
+
+
+
+# **search**
+> ListResponseOrder search(order_date_from, order_date_to, opts)
+
+Find orders corresponding with sent data.
+
+
+
+### Example
+```ruby
+# load the gem
+require 'tripletex_api'
+# setup authorization
+TripletexApi.configure do |config|
+  # Configure HTTP basic authorization: tokenAuthScheme
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = TripletexApi::OrderApi.new
+
+order_date_from = "order_date_from_example" # String | From and including
+
+order_date_to = "order_date_to_example" # String | To and excluding
+
+opts = { 
+  id: "id_example", # String | List of IDs
+  number: "number_example", # String | Equals
+  customer_id: "customer_id_example", # String | List of IDs
+  is_closed: true, # BOOLEAN | Equals
+  from: 0, # Integer | From index
+  count: 1000, # Integer | Number of elements to return
+  sorting: "sorting_example", # String | Sorting pattern
+  fields: "fields_example" # String | Fields filter pattern
+}
+
+begin
+  #Find orders corresponding with sent data.
+  result = api_instance.search(order_date_from, order_date_to, opts)
+  p result
+rescue TripletexApi::ApiError => e
+  puts "Exception when calling OrderApi->search: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **order_date_from** | **String**| From and including | 
+ **order_date_to** | **String**| To and excluding | 
+ **id** | **String**| List of IDs | [optional] 
+ **number** | **String**| Equals | [optional] 
+ **customer_id** | **String**| List of IDs | [optional] 
+ **is_closed** | **BOOLEAN**| Equals | [optional] 
+ **from** | **Integer**| From index | [optional] [default to 0]
+ **count** | **Integer**| Number of elements to return | [optional] [default to 1000]
+ **sorting** | **String**| Sorting pattern | [optional] 
+ **fields** | **String**| Fields filter pattern | [optional] 
+
+### Return type
+
+[**ListResponseOrder**](ListResponseOrder.md)
+
+### Authorization
+
+[tokenAuthScheme](../README.md#tokenAuthScheme)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: Not defined
+
+
+

data/docs/OrderLine.md

@@ -0,0 +1,28 @@
+# TripletexApi::OrderLine
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** |  | [optional] 
+**version** | **Integer** |  | [optional] 
+**changes** | [**Array<Change>**](Change.md) |  | [optional] 
+**url** | **String** |  | [optional] 
+**product** | [**Product**](Product.md) |  | [optional] 
+**inventory** | [**Inventory**](Inventory.md) |  | [optional] 
+**description** | **String** |  | [optional] 
+**count** | **Float** |  | [optional] 
+**unit_cost_currency** | **Float** | Unit price purchase (cost) excluding VAT in the order's currency | [optional] 
+**unit_price_excluding_vat_currency** | **Float** | Unit price of purchase excluding VAT in the order's currency | [optional] 
+**currency** | [**Currency**](Currency.md) | The order line's currency. Determined by the order's currency. | [optional] 
+**markup** | **Float** | Markup given as a percentage (%) | [optional] 
+**discount** | **Float** | Discount given as a percentage (%) | [optional] 
+**vat_type** | [**VatType**](VatType.md) |  | [optional] 
+**amount_excluding_vat_currency** | **Float** | Total amount on order line excluding VAT in the order's currency | [optional] 
+**amount_including_vat_currency** | **Float** | Total amount on order line including VAT in the order's currency | [optional] 
+**order** | [**Order**](Order.md) |  | 
+**unit_price_including_vat_currency** | **Float** | Unit price of purchase including VAT in the order's currency | [optional] 
+**is_subscription** | **BOOLEAN** |  | [optional] [default to false]
+**subscription_period_start** | **String** |  | [optional] 
+**subscription_period_end** | **String** |  | [optional] 
+
+

data/docs/OrderOffer.md

@@ -0,0 +1,15 @@
+# TripletexApi::OrderOffer
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** |  | [optional] 
+**version** | **Integer** |  | [optional] 
+**changes** | [**Array<Change>**](Change.md) |  | [optional] 
+**url** | **String** |  | [optional] 
+**number** | **String** |  | [optional] 
+**department** | [**Department**](Department.md) |  | [optional] 
+**offer_date** | **String** |  | [optional] 
+**customer** | [**Customer**](Customer.md) | The offer's customer | [optional] 
+
+

data/docs/OrderorderlineApi.md

@@ -0,0 +1,229 @@
+# TripletexApi::OrderorderlineApi
+
+All URIs are relative to *https://tripletex.no/v2*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**delete**](OrderorderlineApi.md#delete) | **DELETE** /order/orderline/{id} | [BETA] Delete order line by ID.
+[**get**](OrderorderlineApi.md#get) | **GET** /order/orderline/{id} | Get order line by ID.
+[**post**](OrderorderlineApi.md#post) | **POST** /order/orderline | Create order line. When creating several order lines, use /list for better performance.
+[**post_list**](OrderorderlineApi.md#post_list) | **POST** /order/orderline/list | Create multiple order lines.
+
+
+# **delete**
+> delete(id)
+
+[BETA] Delete order line by ID.
+
+
+
+### Example
+```ruby
+# load the gem
+require 'tripletex_api'
+# setup authorization
+TripletexApi.configure do |config|
+  # Configure HTTP basic authorization: tokenAuthScheme
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = TripletexApi::OrderorderlineApi.new
+
+id = 56 # Integer | Element ID
+
+
+begin
+  #[BETA] Delete order line by ID.
+  api_instance.delete(id)
+rescue TripletexApi::ApiError => e
+  puts "Exception when calling OrderorderlineApi->delete: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **Integer**| Element ID | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[tokenAuthScheme](../README.md#tokenAuthScheme)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: Not defined
+
+
+
+# **get**
+> ResponseWrapperOrderLine get(id, opts)
+
+Get order line by ID.
+
+
+
+### Example
+```ruby
+# load the gem
+require 'tripletex_api'
+# setup authorization
+TripletexApi.configure do |config|
+  # Configure HTTP basic authorization: tokenAuthScheme
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = TripletexApi::OrderorderlineApi.new
+
+id = 56 # Integer | Element ID
+
+opts = { 
+  fields: "fields_example" # String | Fields filter pattern
+}
+
+begin
+  #Get order line by ID.
+  result = api_instance.get(id, opts)
+  p result
+rescue TripletexApi::ApiError => e
+  puts "Exception when calling OrderorderlineApi->get: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **Integer**| Element ID | 
+ **fields** | **String**| Fields filter pattern | [optional] 
+
+### Return type
+
+[**ResponseWrapperOrderLine**](ResponseWrapperOrderLine.md)
+
+### Authorization
+
+[tokenAuthScheme](../README.md#tokenAuthScheme)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: Not defined
+
+
+
+# **post**
+> ResponseWrapperOrderLine post(opts)
+
+Create order line. When creating several order lines, use /list for better performance.
+
+
+
+### Example
+```ruby
+# load the gem
+require 'tripletex_api'
+# setup authorization
+TripletexApi.configure do |config|
+  # Configure HTTP basic authorization: tokenAuthScheme
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = TripletexApi::OrderorderlineApi.new
+
+opts = { 
+  body: TripletexApi::OrderLine.new # OrderLine | JSON representing the new object to be created. Should not have ID and version set.
+}
+
+begin
+  #Create order line. When creating several order lines, use /list for better performance.
+  result = api_instance.post(opts)
+  p result
+rescue TripletexApi::ApiError => e
+  puts "Exception when calling OrderorderlineApi->post: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**OrderLine**](OrderLine.md)| JSON representing the new object to be created. Should not have ID and version set. | [optional] 
+
+### Return type
+
+[**ResponseWrapperOrderLine**](ResponseWrapperOrderLine.md)
+
+### Authorization
+
+[tokenAuthScheme](../README.md#tokenAuthScheme)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json; charset=utf-8
+ - **Accept**: Not defined
+
+
+
+# **post_list**
+> ListResponseOrderLine post_list(opts)
+
+Create multiple order lines.
+
+
+
+### Example
+```ruby
+# load the gem
+require 'tripletex_api'
+# setup authorization
+TripletexApi.configure do |config|
+  # Configure HTTP basic authorization: tokenAuthScheme
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = TripletexApi::OrderorderlineApi.new
+
+opts = { 
+  body: [TripletexApi::OrderLine.new] # Array<OrderLine> | JSON representing a list of new object to be created. Should not have ID and version set.
+}
+
+begin
+  #Create multiple order lines.
+  result = api_instance.post_list(opts)
+  p result
+rescue TripletexApi::ApiError => e
+  puts "Exception when calling OrderorderlineApi->post_list: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**Array&lt;OrderLine&gt;**](OrderLine.md)| JSON representing a list of new object to be created. Should not have ID and version set. | [optional] 
+
+### Return type
+
+[**ListResponseOrderLine**](ListResponseOrderLine.md)
+
+### Authorization
+
+[tokenAuthScheme](../README.md#tokenAuthScheme)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json; charset=utf-8
+ - **Accept**: Not defined
+
+
+