Class: TripletexRubyClient::LedgervatTypeApi

Inherits:
Object
  • Object
show all
Defined in:
lib/tripletex_ruby_client/api/ledgervat_type_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ LedgervatTypeApi

Returns a new instance of LedgervatTypeApi.



19
20
21
 
# File 'lib/tripletex_ruby_client/api/ledgervat_type_api.rb', line 19

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/tripletex_ruby_client/api/ledgervat_type_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#create_relative_vat_type(name, vat_type_id, percentage, opts = {}) ⇒ ResponseWrapperVatType

BETA

Create a new relative VAT Type. These are used if the company has ‘forholdsmessig fradrag for inngående MVA’.

Parameters:

  • name —

    VAT type name, max 8 characters.

  • vat_type_id —

    VAT type ID. The relative VAT type will behave like this VAT type, except for the basis for calculating the VAT deduction, which is decided by the basis percentage.

  • percentage —

    Basis percentage. This percentage will be multiplied with the transaction amount to find the amount that will be the basis for calculating the deduction amount.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



29
30
31
32
 
# File 'lib/tripletex_ruby_client/api/ledgervat_type_api.rb', line 29

def create_relative_vat_type(name, vat_type_id, percentage, opts = {})
  data, _status_code, _headers = create_relative_vat_type_with_http_info(name, vat_type_id, percentage, opts)
  data
end

#create_relative_vat_type_with_http_info(name, vat_type_id, percentage, opts = {}) ⇒ Array<(ResponseWrapperVatType, Fixnum, Hash)>

BETA

Create a new relative VAT Type. These are used if the company has &#39;forholdsmessig fradrag for inngående MVA&#39;.

Parameters:

  • name —

    VAT type name, max 8 characters.

  • vat_type_id —

    VAT type ID. The relative VAT type will behave like this VAT type, except for the basis for calculating the VAT deduction, which is decided by the basis percentage.

  • percentage —

    Basis percentage. This percentage will be multiplied with the transaction amount to find the amount that will be the basis for calculating the deduction amount.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(ResponseWrapperVatType, Fixnum, Hash)>) —

    ResponseWrapperVatType data, response status code and response headers



41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'lib/tripletex_ruby_client/api/ledgervat_type_api.rb', line 41

def create_relative_vat_type_with_http_info(name, vat_type_id, percentage, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LedgervatTypeApi.create_relative_vat_type ...'
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling LedgervatTypeApi.create_relative_vat_type"
  end
  # verify the required parameter 'vat_type_id' is set
  if @api_client.config.client_side_validation && vat_type_id.nil?
    fail ArgumentError, "Missing the required parameter 'vat_type_id' when calling LedgervatTypeApi.create_relative_vat_type"
  end
  # verify the required parameter 'percentage' is set
  if @api_client.config.client_side_validation && percentage.nil?
    fail ArgumentError, "Missing the required parameter 'percentage' when calling LedgervatTypeApi.create_relative_vat_type"
  end
  # resource path
  local_var_path = '/ledger/vatType/createRelativeVatType'

  # query parameters
  query_params = {}
  query_params[:'name'] = name
  query_params[:'vatTypeId'] = vat_type_id
  query_params[:'percentage'] = percentage

  # header parameters
  header_params = {}

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['tokenAuthScheme']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ResponseWrapperVatType')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: LedgervatTypeApi#create_relative_vat_type\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get(id, opts = {}) ⇒ ResponseWrapperVatType

Get vat type by ID.

Parameters:

  • id —

    Element ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :fields (String) —

    Fields filter pattern

Returns:



93
94
95
96
 
# File 'lib/tripletex_ruby_client/api/ledgervat_type_api.rb', line 93

def get(id, opts = {})
  data, _status_code, _headers = get_with_http_info(id, opts)
  data
end

#get_with_http_info(id, opts = {}) ⇒ Array<(ResponseWrapperVatType, Fixnum, Hash)>

Get vat type by ID.

Parameters:

  • id —

    Element ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :fields (String) —

    Fields filter pattern

Returns:

  • (Array<(ResponseWrapperVatType, Fixnum, Hash)>) —

    ResponseWrapperVatType data, response status code and response headers



104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
 
# File 'lib/tripletex_ruby_client/api/ledgervat_type_api.rb', line 104

def get_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LedgervatTypeApi.get ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling LedgervatTypeApi.get"
  end
  # resource path
  local_var_path = '/ledger/vatType/{id}'.sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}
  query_params[:'fields'] = opts[:'fields'] if !opts[:'fields'].nil?

  # header parameters
  header_params = {}

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['tokenAuthScheme']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ResponseWrapperVatType')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: LedgervatTypeApi#get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#search(opts = {}) ⇒ ListResponseVatType

Find vat types corresponding with sent data.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :id (String) —

    List of IDs

  • :number (String) —

    List of IDs

  • :type_of_vat (String) —

    Type of VAT

  • :vat_date (String) —

    yyyy-MM-dd. Defaults to today. Note that this is only used in combination with typeOfVat-parameter. Only valid vatTypes on the given date are returned.

  • :from (Integer) —

    From index (default to 0)

  • :count (Integer) —

    Number of elements to return (default to 1000)

  • :sorting (String) —

    Sorting pattern

  • :fields (String) —

    Fields filter pattern

Returns:



152
153
154
155
 
# File 'lib/tripletex_ruby_client/api/ledgervat_type_api.rb', line 152

def search(opts = {})
  data, _status_code, _headers = search_with_http_info(opts)
  data
end

#search_with_http_info(opts = {}) ⇒ Array<(ListResponseVatType, Fixnum, Hash)>

Find vat types corresponding with sent data.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :id (String) —

    List of IDs

  • :number (String) —

    List of IDs

  • :type_of_vat (String) —

    Type of VAT

  • :vat_date (String) —

    yyyy-MM-dd. Defaults to today. Note that this is only used in combination with typeOfVat-parameter. Only valid vatTypes on the given date are returned.

  • :from (Integer) —

    From index

  • :count (Integer) —

    Number of elements to return

  • :sorting (String) —

    Sorting pattern

  • :fields (String) —

    Fields filter pattern

Returns:

  • (Array<(ListResponseVatType, Fixnum, Hash)>) —

    ListResponseVatType data, response status code and response headers



169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
 
# File 'lib/tripletex_ruby_client/api/ledgervat_type_api.rb', line 169

def search_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LedgervatTypeApi.search ...'
  end
  if @api_client.config.client_side_validation && opts[:'type_of_vat'] && !['OUTGOING', 'INCOMING'].include?(opts[:'type_of_vat'])
    fail ArgumentError, 'invalid value for "type_of_vat", must be one of OUTGOING, INCOMING'
  end
  # resource path
  local_var_path = '/ledger/vatType'

  # query parameters
  query_params = {}
  query_params[:'id'] = opts[:'id'] if !opts[:'id'].nil?
  query_params[:'number'] = opts[:'number'] if !opts[:'number'].nil?
  query_params[:'typeOfVat'] = opts[:'type_of_vat'] if !opts[:'type_of_vat'].nil?
  query_params[:'vatDate'] = opts[:'vat_date'] if !opts[:'vat_date'].nil?
  query_params[:'from'] = opts[:'from'] if !opts[:'from'].nil?
  query_params[:'count'] = opts[:'count'] if !opts[:'count'].nil?
  query_params[:'sorting'] = opts[:'sorting'] if !opts[:'sorting'].nil?
  query_params[:'fields'] = opts[:'fields'] if !opts[:'fields'].nil?

  # header parameters
  header_params = {}

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['tokenAuthScheme']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ListResponseVatType')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: LedgervatTypeApi#search\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end