Class: FattureInCloud_Ruby_Sdk::IssuedEInvoicesApi

Inherits:
Object
  • Object
show all
Defined in:
lib/fattureincloud_ruby_sdk/api/issued_e_invoices_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ IssuedEInvoicesApi

Returns a new instance of IssuedEInvoicesApi.



19
20
21
 
# File 'lib/fattureincloud_ruby_sdk/api/issued_e_invoices_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/fattureincloud_ruby_sdk/api/issued_e_invoices_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#get_e_invoice_rejection_reason(company_id, document_id, opts = {}) ⇒ GetEInvoiceRejectionReasonResponse

Get E-Invoice Rejection Reason Get e-invoice rejection reason

Parameters:

  • company_id (Integer) —

    The ID of the company.

  • document_id (Integer) —

    The ID of the document.

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

    the optional parameters

Returns:



28
29
30
31
 
# File 'lib/fattureincloud_ruby_sdk/api/issued_e_invoices_api.rb', line 28

def get_e_invoice_rejection_reason(company_id, document_id, opts = {})
  data, _status_code, _headers = get_e_invoice_rejection_reason_with_http_info(company_id, document_id, opts)
  data
end

#get_e_invoice_rejection_reason_with_http_info(company_id, document_id, opts = {}) ⇒ Array<(GetEInvoiceRejectionReasonResponse, Integer, Hash)>

Get E-Invoice Rejection Reason Get e-invoice rejection reason

Parameters:

  • company_id (Integer) —

    The ID of the company.

  • document_id (Integer) —

    The ID of the document.

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

    the optional parameters

Returns:



39
40
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
87
88
89
 
# File 'lib/fattureincloud_ruby_sdk/api/issued_e_invoices_api.rb', line 39

def get_e_invoice_rejection_reason_with_http_info(company_id, document_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IssuedEInvoicesApi.get_e_invoice_rejection_reason ...'
  end
  # verify the required parameter 'company_id' is set
  if @api_client.config.client_side_validation && company_id.nil?
    fail ArgumentError, "Missing the required parameter 'company_id' when calling IssuedEInvoicesApi.get_e_invoice_rejection_reason"
  end
  # verify the required parameter 'document_id' is set
  if @api_client.config.client_side_validation && document_id.nil?
    fail ArgumentError, "Missing the required parameter 'document_id' when calling IssuedEInvoicesApi.get_e_invoice_rejection_reason"
  end
  # resource path
  local_var_path = '/c/{company_id}/issued_documents/{document_id}/e_invoice/error_reason'.sub('{' + 'company_id' + '}', CGI.escape(company_id.to_s)).sub('{' + 'document_id' + '}', CGI.escape(document_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'GetEInvoiceRejectionReasonResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['OAuth2AuthenticationCodeFlow']

  new_options = opts.merge(
    :operation => :"IssuedEInvoicesApi.get_e_invoice_rejection_reason",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IssuedEInvoicesApi#get_e_invoice_rejection_reason\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_e_invoice_xml(company_id, document_id, opts = {}) ⇒ String

Get E-Invoice XML Downloads the e-invoice in XML format.

Parameters:

  • company_id (Integer) —

    The ID of the company.

  • document_id (Integer) —

    The ID of the document.

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

    the optional parameters

Options Hash (opts):

  • :include_attachment (Boolean) —

    Include the attachment to the XML e-invoice.

Returns:

  • (String) 


98
99
100
101
 
# File 'lib/fattureincloud_ruby_sdk/api/issued_e_invoices_api.rb', line 98

def get_e_invoice_xml(company_id, document_id, opts = {})
  data, _status_code, _headers = get_e_invoice_xml_with_http_info(company_id, document_id, opts)
  data
end

#get_e_invoice_xml_with_http_info(company_id, document_id, opts = {}) ⇒ Array<(String, Integer, Hash)>

Get E-Invoice XML Downloads the e-invoice in XML format.

Parameters:

  • company_id (Integer) —

    The ID of the company.

  • document_id (Integer) —

    The ID of the document.

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

    the optional parameters

Options Hash (opts):

  • :include_attachment (Boolean) —

    Include the attachment to the XML e-invoice.

Returns:

  • (Array<(String, Integer, Hash)>) —

    String data, response status code and response headers



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
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
 
# File 'lib/fattureincloud_ruby_sdk/api/issued_e_invoices_api.rb', line 110

def get_e_invoice_xml_with_http_info(company_id, document_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IssuedEInvoicesApi.get_e_invoice_xml ...'
  end
  # verify the required parameter 'company_id' is set
  if @api_client.config.client_side_validation && company_id.nil?
    fail ArgumentError, "Missing the required parameter 'company_id' when calling IssuedEInvoicesApi.get_e_invoice_xml"
  end
  # verify the required parameter 'document_id' is set
  if @api_client.config.client_side_validation && document_id.nil?
    fail ArgumentError, "Missing the required parameter 'document_id' when calling IssuedEInvoicesApi.get_e_invoice_xml"
  end
  # resource path
  local_var_path = '/c/{company_id}/issued_documents/{document_id}/e_invoice/xml'.sub('{' + 'company_id' + '}', CGI.escape(company_id.to_s)).sub('{' + 'document_id' + '}', CGI.escape(document_id.to_s))

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

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['text/xml']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'String'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['OAuth2AuthenticationCodeFlow']

  new_options = opts.merge(
    :operation => :"IssuedEInvoicesApi.get_e_invoice_xml",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IssuedEInvoicesApi#get_e_invoice_xml\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#send_e_invoice(company_id, document_id, opts = {}) ⇒ SendEInvoiceResponse

Send E-Invoice Sends the e-invoice to SDI.

Parameters:

  • company_id (Integer) —

    The ID of the company.

  • document_id (Integer) —

    The ID of the document.

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

    the optional parameters

Options Hash (opts):

Returns:



170
171
172
173
 
# File 'lib/fattureincloud_ruby_sdk/api/issued_e_invoices_api.rb', line 170

def send_e_invoice(company_id, document_id, opts = {})
  data, _status_code, _headers = send_e_invoice_with_http_info(company_id, document_id, opts)
  data
end

#send_e_invoice_with_http_info(company_id, document_id, opts = {}) ⇒ Array<(SendEInvoiceResponse, Integer, Hash)>

Send E-Invoice Sends the e-invoice to SDI.

Parameters:

  • company_id (Integer) —

    The ID of the company.

  • document_id (Integer) —

    The ID of the document.

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

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(SendEInvoiceResponse, Integer, Hash)>) —

    SendEInvoiceResponse data, response status code and response headers



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
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
 
# File 'lib/fattureincloud_ruby_sdk/api/issued_e_invoices_api.rb', line 182

def send_e_invoice_with_http_info(company_id, document_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IssuedEInvoicesApi.send_e_invoice ...'
  end
  # verify the required parameter 'company_id' is set
  if @api_client.config.client_side_validation && company_id.nil?
    fail ArgumentError, "Missing the required parameter 'company_id' when calling IssuedEInvoicesApi.send_e_invoice"
  end
  # verify the required parameter 'document_id' is set
  if @api_client.config.client_side_validation && document_id.nil?
    fail ArgumentError, "Missing the required parameter 'document_id' when calling IssuedEInvoicesApi.send_e_invoice"
  end
  # resource path
  local_var_path = '/c/{company_id}/issued_documents/{document_id}/e_invoice/send'.sub('{' + 'company_id' + '}', CGI.escape(company_id.to_s)).sub('{' + 'document_id' + '}', CGI.escape(document_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
    header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'send_e_invoice_request'])

  # return_type
  return_type = opts[:debug_return_type] || 'SendEInvoiceResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['OAuth2AuthenticationCodeFlow']

  new_options = opts.merge(
    :operation => :"IssuedEInvoicesApi.send_e_invoice",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IssuedEInvoicesApi#send_e_invoice\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#verify_e_invoice_xml(company_id, document_id, opts = {}) ⇒ VerifyEInvoiceXmlResponse

Verify E-Invoice XML Verifies the e-invoice XML format. Checks if all of the mandatory fields are filled and compliant to the right format.

Parameters:

  • company_id (Integer) —

    The ID of the company.

  • document_id (Integer) —

    The ID of the document.

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

    the optional parameters

Returns:



245
246
247
248
 
# File 'lib/fattureincloud_ruby_sdk/api/issued_e_invoices_api.rb', line 245

def verify_e_invoice_xml(company_id, document_id, opts = {})
  data, _status_code, _headers = verify_e_invoice_xml_with_http_info(company_id, document_id, opts)
  data
end

#verify_e_invoice_xml_with_http_info(company_id, document_id, opts = {}) ⇒ Array<(VerifyEInvoiceXmlResponse, Integer, Hash)>

Verify E-Invoice XML Verifies the e-invoice XML format. Checks if all of the mandatory fields are filled and compliant to the right format.

Parameters:

  • company_id (Integer) —

    The ID of the company.

  • document_id (Integer) —

    The ID of the document.

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

    the optional parameters

Returns:

  • (Array<(VerifyEInvoiceXmlResponse, Integer, Hash)>) —

    VerifyEInvoiceXmlResponse data, response status code and response headers



256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
 
# File 'lib/fattureincloud_ruby_sdk/api/issued_e_invoices_api.rb', line 256

def verify_e_invoice_xml_with_http_info(company_id, document_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IssuedEInvoicesApi.verify_e_invoice_xml ...'
  end
  # verify the required parameter 'company_id' is set
  if @api_client.config.client_side_validation && company_id.nil?
    fail ArgumentError, "Missing the required parameter 'company_id' when calling IssuedEInvoicesApi.verify_e_invoice_xml"
  end
  # verify the required parameter 'document_id' is set
  if @api_client.config.client_side_validation && document_id.nil?
    fail ArgumentError, "Missing the required parameter 'document_id' when calling IssuedEInvoicesApi.verify_e_invoice_xml"
  end
  # resource path
  local_var_path = '/c/{company_id}/issued_documents/{document_id}/e_invoice/xml_verify'.sub('{' + 'company_id' + '}', CGI.escape(company_id.to_s)).sub('{' + 'document_id' + '}', CGI.escape(document_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'VerifyEInvoiceXmlResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['OAuth2AuthenticationCodeFlow']

  new_options = opts.merge(
    :operation => :"IssuedEInvoicesApi.verify_e_invoice_xml",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IssuedEInvoicesApi#verify_e_invoice_xml\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end