Skip to content

ObjectInvoiceApi.md

Latest commit

 

History

History
441 lines (306 loc) · 13.4 KB

ObjectInvoiceApi.md

File metadata and controls

441 lines (306 loc) · 13.4 KB

EzmaxApi::ObjectInvoiceApi

All URIs are relative to https://prod.api.appcluster01.ca-central-1.ezmax.com/rest

Method HTTP request Description
invoice_get_attachments_v1 GET /1/object/invoice/{pkiInvoiceID}/getAttachments Retrieve Invoice's Attachments
invoice_get_communication_count_v1 GET /1/object/invoice/{pkiInvoiceID}/getCommunicationCount Retrieve Communication count
invoice_get_communication_list_v1 GET /1/object/invoice/{pkiInvoiceID}/getCommunicationList Retrieve Communication list
invoice_get_communicationrecipients_v1 GET /1/object/invoice/{pkiInvoiceID}/getCommunicationrecipients Retrieve Invoice's Communicationrecipient
invoice_get_communicationsenders_v1 GET /1/object/invoice/{pkiInvoiceID}/getCommunicationsenders Retrieve Invoice's Communicationsender
invoice_import_into_edmv1 POST /1/object/invoice/{pkiInvoiceID}/importIntoEDM Import attachments into the Invoice

invoice_get_attachments_v1

invoice_get_attachments_v1(pki_invoice_id)

Retrieve Invoice's Attachments

Examples

require 'time'
require 'Ezmaxapi'
# setup authorization
EzmaxApi.configure do |config|
  # Configure API key authorization: Authorization
  config.api_key['Authorization'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['Authorization'] = 'Bearer'
end

api_instance = EzmaxApi::ObjectInvoiceApi.new
pki_invoice_id = 56 # Integer | 

begin
  # Retrieve Invoice's Attachments
  result = api_instance.invoice_get_attachments_v1(pki_invoice_id)
  p result
rescue EzmaxApi::ApiError => e
  puts "Error when calling ObjectInvoiceApi->invoice_get_attachments_v1: #{e}"
end

Using the invoice_get_attachments_v1_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> invoice_get_attachments_v1_with_http_info(pki_invoice_id)

begin
  # Retrieve Invoice's Attachments
  data, status_code, headers = api_instance.invoice_get_attachments_v1_with_http_info(pki_invoice_id)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <InvoiceGetAttachmentsV1Response>
rescue EzmaxApi::ApiError => e
  puts "Error when calling ObjectInvoiceApi->invoice_get_attachments_v1_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
pki_invoice_id Integer

Return type

InvoiceGetAttachmentsV1Response

Authorization

Authorization

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

invoice_get_communication_count_v1

invoice_get_communication_count_v1(pki_invoice_id)

Retrieve Communication count

Examples

require 'time'
require 'Ezmaxapi'
# setup authorization
EzmaxApi.configure do |config|
  # Configure API key authorization: Authorization
  config.api_key['Authorization'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['Authorization'] = 'Bearer'
end

api_instance = EzmaxApi::ObjectInvoiceApi.new
pki_invoice_id = 56 # Integer | 

begin
  # Retrieve Communication count
  result = api_instance.invoice_get_communication_count_v1(pki_invoice_id)
  p result
rescue EzmaxApi::ApiError => e
  puts "Error when calling ObjectInvoiceApi->invoice_get_communication_count_v1: #{e}"
end

Using the invoice_get_communication_count_v1_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> invoice_get_communication_count_v1_with_http_info(pki_invoice_id)

begin
  # Retrieve Communication count
  data, status_code, headers = api_instance.invoice_get_communication_count_v1_with_http_info(pki_invoice_id)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <InvoiceGetCommunicationCountV1Response>
rescue EzmaxApi::ApiError => e
  puts "Error when calling ObjectInvoiceApi->invoice_get_communication_count_v1_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
pki_invoice_id Integer

Return type

InvoiceGetCommunicationCountV1Response

Authorization

Authorization

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

invoice_get_communication_list_v1

invoice_get_communication_list_v1(pki_invoice_id)

Retrieve Communication list

Examples

require 'time'
require 'Ezmaxapi'
# setup authorization
EzmaxApi.configure do |config|
  # Configure API key authorization: Authorization
  config.api_key['Authorization'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['Authorization'] = 'Bearer'
end

api_instance = EzmaxApi::ObjectInvoiceApi.new
pki_invoice_id = 56 # Integer | 

begin
  # Retrieve Communication list
  result = api_instance.invoice_get_communication_list_v1(pki_invoice_id)
  p result
rescue EzmaxApi::ApiError => e
  puts "Error when calling ObjectInvoiceApi->invoice_get_communication_list_v1: #{e}"
end

Using the invoice_get_communication_list_v1_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> invoice_get_communication_list_v1_with_http_info(pki_invoice_id)

begin
  # Retrieve Communication list
  data, status_code, headers = api_instance.invoice_get_communication_list_v1_with_http_info(pki_invoice_id)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <InvoiceGetCommunicationListV1Response>
rescue EzmaxApi::ApiError => e
  puts "Error when calling ObjectInvoiceApi->invoice_get_communication_list_v1_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
pki_invoice_id Integer

Return type

InvoiceGetCommunicationListV1Response

Authorization

Authorization

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

invoice_get_communicationrecipients_v1

invoice_get_communicationrecipients_v1(pki_invoice_id)

Retrieve Invoice's Communicationrecipient

Examples

require 'time'
require 'Ezmaxapi'
# setup authorization
EzmaxApi.configure do |config|
  # Configure API key authorization: Authorization
  config.api_key['Authorization'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['Authorization'] = 'Bearer'
end

api_instance = EzmaxApi::ObjectInvoiceApi.new
pki_invoice_id = 56 # Integer | 

begin
  # Retrieve Invoice's Communicationrecipient
  result = api_instance.invoice_get_communicationrecipients_v1(pki_invoice_id)
  p result
rescue EzmaxApi::ApiError => e
  puts "Error when calling ObjectInvoiceApi->invoice_get_communicationrecipients_v1: #{e}"
end

Using the invoice_get_communicationrecipients_v1_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> invoice_get_communicationrecipients_v1_with_http_info(pki_invoice_id)

begin
  # Retrieve Invoice's Communicationrecipient
  data, status_code, headers = api_instance.invoice_get_communicationrecipients_v1_with_http_info(pki_invoice_id)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <InvoiceGetCommunicationrecipientsV1Response>
rescue EzmaxApi::ApiError => e
  puts "Error when calling ObjectInvoiceApi->invoice_get_communicationrecipients_v1_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
pki_invoice_id Integer

Return type

InvoiceGetCommunicationrecipientsV1Response

Authorization

Authorization

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

invoice_get_communicationsenders_v1

invoice_get_communicationsenders_v1(pki_invoice_id)

Retrieve Invoice's Communicationsender

Examples

require 'time'
require 'Ezmaxapi'
# setup authorization
EzmaxApi.configure do |config|
  # Configure API key authorization: Authorization
  config.api_key['Authorization'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['Authorization'] = 'Bearer'
end

api_instance = EzmaxApi::ObjectInvoiceApi.new
pki_invoice_id = 56 # Integer | 

begin
  # Retrieve Invoice's Communicationsender
  result = api_instance.invoice_get_communicationsenders_v1(pki_invoice_id)
  p result
rescue EzmaxApi::ApiError => e
  puts "Error when calling ObjectInvoiceApi->invoice_get_communicationsenders_v1: #{e}"
end

Using the invoice_get_communicationsenders_v1_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> invoice_get_communicationsenders_v1_with_http_info(pki_invoice_id)

begin
  # Retrieve Invoice's Communicationsender
  data, status_code, headers = api_instance.invoice_get_communicationsenders_v1_with_http_info(pki_invoice_id)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <InvoiceGetCommunicationsendersV1Response>
rescue EzmaxApi::ApiError => e
  puts "Error when calling ObjectInvoiceApi->invoice_get_communicationsenders_v1_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
pki_invoice_id Integer

Return type

InvoiceGetCommunicationsendersV1Response

Authorization

Authorization

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

invoice_import_into_edmv1

invoice_import_into_edmv1(pki_invoice_id, invoice_import_into_edmv1_request)

Import attachments into the Invoice

Examples

require 'time'
require 'Ezmaxapi'
# setup authorization
EzmaxApi.configure do |config|
  # Configure API key authorization: Authorization
  config.api_key['Authorization'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['Authorization'] = 'Bearer'
end

api_instance = EzmaxApi::ObjectInvoiceApi.new
pki_invoice_id = 56 # Integer | 
invoice_import_into_edmv1_request = EzmaxApi::InvoiceImportIntoEDMV1Request.new({a_obj_attachment: [EzmaxApi::CustomAttachmentImportIntoEDMRequest.new({e_attachment_source: 'Attachment', s_attachment_name: 'Document.pdf', s_attachment_category: 'Inscription', e_attachment_privacy: EzmaxApi::FieldEAttachmentPrivacy::ALL})]}) # InvoiceImportIntoEDMV1Request | 

begin
  # Import attachments into the Invoice
  result = api_instance.invoice_import_into_edmv1(pki_invoice_id, invoice_import_into_edmv1_request)
  p result
rescue EzmaxApi::ApiError => e
  puts "Error when calling ObjectInvoiceApi->invoice_import_into_edmv1: #{e}"
end

Using the invoice_import_into_edmv1_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> invoice_import_into_edmv1_with_http_info(pki_invoice_id, invoice_import_into_edmv1_request)

begin
  # Import attachments into the Invoice
  data, status_code, headers = api_instance.invoice_import_into_edmv1_with_http_info(pki_invoice_id, invoice_import_into_edmv1_request)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <InvoiceImportIntoEDMV1Response>
rescue EzmaxApi::ApiError => e
  puts "Error when calling ObjectInvoiceApi->invoice_import_into_edmv1_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
pki_invoice_id Integer
invoice_import_into_edmv1_request InvoiceImportIntoEDMV1Request

Return type

InvoiceImportIntoEDMV1Response

Authorization

Authorization

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json