module Ruconomic::API::TermOfPayment

Public Class Methods

create() click to toggle source

Creates a new term of payment. If the type is PaidInCash or Factoring then the contra account(s) are set to the first enterable account. Parameters: name: The name of the new term of payment. type: The type of the new term of payment. days: The number of days until payment is due if the type is Net or InvoiceMonth or InvoiceWeekStartingMonday or InvoiceWeekStartingSunday.

@note TODO: This method was autogenerated from the WSDL - see github.com/coherify/ruconomic#contributing“ @see api.e-conomic.com/secure/api1/EconomicWebService.asmx?op=TermOfPayment_Create @return [Hash] The body content of the SOAP response.

# File lib/ruconomic/api/term_of_payment.rb, line 88
def self.create
  response = invoke('TermOfPayment_Create') do |message|
    raise "TODO: This method was autogenerated from the WSDL - see https://github.com/coherify/ruconomic#contributing"
  end
end
create_from_data() click to toggle source

Creates a new term of payment from a data object. Parameters: data: The data object that specifies the properties of the new term of payment.

@note TODO: This method was autogenerated from the WSDL - see github.com/coherify/ruconomic#contributing“ @see api.e-conomic.com/secure/api1/EconomicWebService.asmx?op=TermOfPayment_CreateFromData @return [Hash] The body content of the SOAP response.

# File lib/ruconomic/api/term_of_payment.rb, line 12
def self.create_from_data
  response = invoke('TermOfPayment_CreateFromData') do |message|
    raise "TODO: This method was autogenerated from the WSDL - see https://github.com/coherify/ruconomic#contributing"
  end
end
create_from_data_array() click to toggle source

Creates new terms of payment from data objects. Parameters: dataArray: The array of data objects that specifies the properties of the new terms of payment.

@note TODO: This method was autogenerated from the WSDL - see github.com/coherify/ruconomic#contributing“ @see api.e-conomic.com/secure/api1/EconomicWebService.asmx?op=TermOfPayment_CreateFromDataArray @return [Hash] The body content of the SOAP response.

# File lib/ruconomic/api/term_of_payment.rb, line 24
def self.create_from_data_array
  response = invoke('TermOfPayment_CreateFromDataArray') do |message|
    raise "TODO: This method was autogenerated from the WSDL - see https://github.com/coherify/ruconomic#contributing"
  end
end
delete() click to toggle source

Deletes a term of peyment. ParametersL termOfPaymentHandle: Handle for the term of payment.

@note TODO: This method was autogenerated from the WSDL - see github.com/coherify/ruconomic#contributing“ @see api.e-conomic.com/secure/api1/EconomicWebService.asmx?op=TermOfPayment_Delete @return [Hash] The body content of the SOAP response.

# File lib/ruconomic/api/term_of_payment.rb, line 125
def self.delete
  response = invoke('TermOfPayment_Delete') do |message|
    raise "TODO: This method was autogenerated from the WSDL - see https://github.com/coherify/ruconomic#contributing"
  end
end
find_by_name() click to toggle source

Returns a handle for the term of payment with a given name. Parameters: name: The name to search for.

@note TODO: This method was autogenerated from the WSDL - see github.com/coherify/ruconomic#contributing“ @see api.e-conomic.com/secure/api1/EconomicWebService.asmx?op=TermOfPayment_FindByName @return [Hash] The body content of the SOAP response.

# File lib/ruconomic/api/term_of_payment.rb, line 113
def self.find_by_name
  response = invoke('TermOfPayment_FindByName') do |message|
    raise "TODO: This method was autogenerated from the WSDL - see https://github.com/coherify/ruconomic#contributing"
  end
end
get_all() click to toggle source

Returns handles for all term of payments.

@see api.e-conomic.com/secure/api1/EconomicWebService.asmx?op=TermOfPayment_GetAll @return [Hash] The body content of the SOAP response.

# File lib/ruconomic/api/term_of_payment.rb, line 98
def self.get_all
  response = invoke('TermOfPayment_GetAll')
  response.to_hash.dig(
    :term_of_payment_get_all_response,
    :term_of_payment_get_all_result,
    :term_of_payment_handle
  ).map { |result| result[:id] }
end
get_contra_account() click to toggle source

Gets the first contra account for a term of payment if the type is TermOfPaymentType.PaidInCash or TermOfPaymentType.Factoring. Parameters: termOfPaymentHandle: Handle for the term of payment.

@note TODO: This method was autogenerated from the WSDL - see github.com/coherify/ruconomic#contributing“ @see api.e-conomic.com/secure/api1/EconomicWebService.asmx?op=TermOfPayment_GetContraAccount @return [Hash] The body content of the SOAP response.

# File lib/ruconomic/api/term_of_payment.rb, line 209
def self.get_contra_account
  response = invoke('TermOfPayment_GetContraAccount') do |message|
    raise "TODO: This method was autogenerated from the WSDL - see https://github.com/coherify/ruconomic#contributing"
  end
end
get_contra_account2() click to toggle source

Gets the second contra account for a term of payment if the type is TermOfPaymentType.Factoring. Parameters: termOfPaymentHandle: Handle for the term of payment.

@note TODO: This method was autogenerated from the WSDL - see github.com/coherify/ruconomic#contributing“ @see api.e-conomic.com/secure/api1/EconomicWebService.asmx?op=TermOfPayment_GetContraAccount2 @return [Hash] The body content of the SOAP response.

# File lib/ruconomic/api/term_of_payment.rb, line 233
def self.get_contra_account2
  response = invoke('TermOfPayment_GetContraAccount2') do |message|
    raise "TODO: This method was autogenerated from the WSDL - see https://github.com/coherify/ruconomic#contributing"
  end
end
get_data(handle) click to toggle source

Returns an term of payment data object for a given term of payment. Parameters: entityHandle: A handle for the term of payment.

@see api.e-conomic.com/secure/api1/EconomicWebService.asmx?op=TermOfPayment_GetData @return [Hash] The body content of the SOAP response.

# File lib/ruconomic/api/term_of_payment.rb, line 59
def self.get_data(handle)
  response = invoke('TermOfPayment_GetData') do |message|
    message.add_handle('entityHandle', handle, "Id")
  end

  response.to_hash.dig(
    :term_of_payment_get_data_response,
    :term_of_payment_get_data_result
  )
end
get_data_array() click to toggle source

Returns term of paryment data objects for a given set of term of payment handles. Parameters: entityHandles: An array of the term of payment handles.

@note TODO: This method was autogenerated from the WSDL - see github.com/coherify/ruconomic#contributing“ @see api.e-conomic.com/secure/api1/EconomicWebService.asmx?op=TermOfPayment_GetDataArray @return [Hash] The body content of the SOAP response.

# File lib/ruconomic/api/term_of_payment.rb, line 76
def self.get_data_array
  response = invoke('TermOfPayment_GetDataArray') do |message|
    raise "TODO: This method was autogenerated from the WSDL - see https://github.com/coherify/ruconomic#contributing"
  end
end
get_days() click to toggle source

Gets the number of days before payment is due for a term of payment if the type is TermOfPaymentType.Net or TermOfPaymentType.InvoiceMonth or TermOfPaymentType.InvoiceWeekStartingMonday or TermOfPaymentType.InvoiceWeekStartingSunday. Parameters: termOfPaymentHandle: Handle for the term of payment.

@note TODO: This method was autogenerated from the WSDL - see github.com/coherify/ruconomic#contributing“ @see api.e-conomic.com/secure/api1/EconomicWebService.asmx?op=TermOfPayment_GetDays @return [Hash] The body content of the SOAP response.

# File lib/ruconomic/api/term_of_payment.rb, line 173
def self.get_days
  response = invoke('TermOfPayment_GetDays') do |message|
    raise "TODO: This method was autogenerated from the WSDL - see https://github.com/coherify/ruconomic#contributing"
  end
end
get_debtor() click to toggle source

Gets the debtor for a term of payment if the type is TermOfPaymentType.Creditcard. Parameters: termOfPaymentHandle: Handle for the term of payment.

@note TODO: This method was autogenerated from the WSDL - see github.com/coherify/ruconomic#contributing“ @see api.e-conomic.com/secure/api1/EconomicWebService.asmx?op=TermOfPayment_GetDebtor @return [Hash] The body content of the SOAP response.

# File lib/ruconomic/api/term_of_payment.rb, line 257
def self.get_debtor
  response = invoke('TermOfPayment_GetDebtor') do |message|
    raise "TODO: This method was autogenerated from the WSDL - see https://github.com/coherify/ruconomic#contributing"
  end
end
get_description() click to toggle source

Gets the description of a term of payment. Parameters: termOfPaymentHandle: Handle for the term of payment.

@note TODO: This method was autogenerated from the WSDL - see github.com/coherify/ruconomic#contributing“ @see api.e-conomic.com/secure/api1/EconomicWebService.asmx?op=TermOfPayment_GetDescription @return [Hash] The body content of the SOAP response.

# File lib/ruconomic/api/term_of_payment.rb, line 185
def self.get_description
  response = invoke('TermOfPayment_GetDescription') do |message|
    raise "TODO: This method was autogenerated from the WSDL - see https://github.com/coherify/ruconomic#contributing"
  end
end
get_distribution_in_percent() click to toggle source

Gets the distribution in percent for the first contra account if the type of the term of payment is TermOfPaymentType.Factoring. Parameters: termOfPaymentHandle: Handle for the term of payment.

@note TODO: This method was autogenerated from the WSDL - see github.com/coherify/ruconomic#contributing“ @see api.e-conomic.com/secure/api1/EconomicWebService.asmx?op=TermOfPayment_GetDistributionInPercent @return [Hash] The body content of the SOAP response.

# File lib/ruconomic/api/term_of_payment.rb, line 281
def self.get_distribution_in_percent
  response = invoke('TermOfPayment_GetDistributionInPercent') do |message|
    raise "TODO: This method was autogenerated from the WSDL - see https://github.com/coherify/ruconomic#contributing"
  end
end
get_distribution_in_percent2() click to toggle source

Gets the distribution in percent for the second contra account if the type of the term of payment is TermOfPaymentType.Factoring. Parameters: termOfPaymentHandle: Handle for the term of payment.

@note TODO: This method was autogenerated from the WSDL - see github.com/coherify/ruconomic#contributing“ @see api.e-conomic.com/secure/api1/EconomicWebService.asmx?op=TermOfPayment_GetDistributionInPercent2 @return [Hash] The body content of the SOAP response.

# File lib/ruconomic/api/term_of_payment.rb, line 305
def self.get_distribution_in_percent2
  response = invoke('TermOfPayment_GetDistributionInPercent2') do |message|
    raise "TODO: This method was autogenerated from the WSDL - see https://github.com/coherify/ruconomic#contributing"
  end
end
get_name() click to toggle source

Gets the name of a term of payment. Parameters: termOfPaymentHandle: Handle for the term of payment.

@note TODO: This method was autogenerated from the WSDL - see github.com/coherify/ruconomic#contributing“ @see api.e-conomic.com/secure/api1/EconomicWebService.asmx?op=TermOfPayment_GetName @return [Hash] The body content of the SOAP response.

# File lib/ruconomic/api/term_of_payment.rb, line 137
def self.get_name
  response = invoke('TermOfPayment_GetName') do |message|
    raise "TODO: This method was autogenerated from the WSDL - see https://github.com/coherify/ruconomic#contributing"
  end
end
get_type() click to toggle source

Gets the type of a term of payment. Parameters: termOfPaymentHandle: Handle for the term of payment.

@note TODO: This method was autogenerated from the WSDL - see github.com/coherify/ruconomic#contributing“ @see api.e-conomic.com/secure/api1/EconomicWebService.asmx?op=TermOfPayment_GetType @return [Hash] The body content of the SOAP response.

# File lib/ruconomic/api/term_of_payment.rb, line 161
def self.get_type
  response = invoke('TermOfPayment_GetType') do |message|
    raise "TODO: This method was autogenerated from the WSDL - see https://github.com/coherify/ruconomic#contributing"
  end
end
set_contra_account() click to toggle source

Sets the first contra account for a term of payment if the type is TermOfPaymentType.PaidInCash or TermOfPaymentType.Factoring. Parameters: termOfPaymentHandle: Handle for the term of payment. value: The first contra account.

@note TODO: This method was autogenerated from the WSDL - see github.com/coherify/ruconomic#contributing“ @see api.e-conomic.com/secure/api1/EconomicWebService.asmx?op=TermOfPayment_SetContraAccount @return [Hash] The body content of the SOAP response.

# File lib/ruconomic/api/term_of_payment.rb, line 221
def self.set_contra_account
  response = invoke('TermOfPayment_SetContraAccount') do |message|
    raise "TODO: This method was autogenerated from the WSDL - see https://github.com/coherify/ruconomic#contributing"
  end
end
set_contra_account2() click to toggle source

Sets the second contra account for a term of payment if the type is TermOfPaymentType.Factoring. Parameters: termOfPaymentHandle: Handle for the term of payment. value: The second contra account.

@note TODO: This method was autogenerated from the WSDL - see github.com/coherify/ruconomic#contributing“ @see api.e-conomic.com/secure/api1/EconomicWebService.asmx?op=TermOfPayment_SetContraAccount2 @return [Hash] The body content of the SOAP response.

# File lib/ruconomic/api/term_of_payment.rb, line 245
def self.set_contra_account2
  response = invoke('TermOfPayment_SetContraAccount2') do |message|
    raise "TODO: This method was autogenerated from the WSDL - see https://github.com/coherify/ruconomic#contributing"
  end
end
set_debtor() click to toggle source

Sets the debtor for a term of payment if the type is TermOfPaymentType.Creditcard. Parameters: termOfPaymentHandle: Handle for the term of payment. value: The debtor.

@note TODO: This method was autogenerated from the WSDL - see github.com/coherify/ruconomic#contributing“ @see api.e-conomic.com/secure/api1/EconomicWebService.asmx?op=TermOfPayment_SetDebtor @return [Hash] The body content of the SOAP response.

# File lib/ruconomic/api/term_of_payment.rb, line 269
def self.set_debtor
  response = invoke('TermOfPayment_SetDebtor') do |message|
    raise "TODO: This method was autogenerated from the WSDL - see https://github.com/coherify/ruconomic#contributing"
  end
end
set_description() click to toggle source

Sets the description of a term of payment. Parameters: termOfPaymentHandle: Handle for the term of payment. value: The description of the term of payment.

@note TODO: This method was autogenerated from the WSDL - see github.com/coherify/ruconomic#contributing“ @see api.e-conomic.com/secure/api1/EconomicWebService.asmx?op=TermOfPayment_SetDescription @return [Hash] The body content of the SOAP response.

# File lib/ruconomic/api/term_of_payment.rb, line 197
def self.set_description
  response = invoke('TermOfPayment_SetDescription') do |message|
    raise "TODO: This method was autogenerated from the WSDL - see https://github.com/coherify/ruconomic#contributing"
  end
end
set_distribution_in_percent() click to toggle source

Sets the distribution in percent of the first contra account for a term of payment if the type is TermOfPaymentType.Factoring. Parameters: termOfPaymentHandle: Handle for the term of payment. value: A value between 0 and 100.

@note TODO: This method was autogenerated from the WSDL - see github.com/coherify/ruconomic#contributing“ @see api.e-conomic.com/secure/api1/EconomicWebService.asmx?op=TermOfPayment_SetDistributionInPercent @return [Hash] The body content of the SOAP response.

# File lib/ruconomic/api/term_of_payment.rb, line 293
def self.set_distribution_in_percent
  response = invoke('TermOfPayment_SetDistributionInPercent') do |message|
    raise "TODO: This method was autogenerated from the WSDL - see https://github.com/coherify/ruconomic#contributing"
  end
end
set_name() click to toggle source

Sets the name of a term of payment. Parameters: termOfPaymentHandle: Handle for the term of payment. value: The new name of the term of payment.

@note TODO: This method was autogenerated from the WSDL - see github.com/coherify/ruconomic#contributing“ @see api.e-conomic.com/secure/api1/EconomicWebService.asmx?op=TermOfPayment_SetName @return [Hash] The body content of the SOAP response.

# File lib/ruconomic/api/term_of_payment.rb, line 149
def self.set_name
  response = invoke('TermOfPayment_SetName') do |message|
    raise "TODO: This method was autogenerated from the WSDL - see https://github.com/coherify/ruconomic#contributing"
  end
end
update_from_data() click to toggle source

Updates a term of payment from a data object. Parameters: data: The data object.

@note TODO: This method was autogenerated from the WSDL - see github.com/coherify/ruconomic#contributing“ @see api.e-conomic.com/secure/api1/EconomicWebService.asmx?op=TermOfPayment_UpdateFromData @return [Hash] The body content of the SOAP response.

# File lib/ruconomic/api/term_of_payment.rb, line 48
def self.update_from_data
  response = invoke('TermOfPayment_UpdateFromData') do |message|
    raise "TODO: This method was autogenerated from the WSDL - see https://github.com/coherify/ruconomic#contributing"
  end
end
update_from_data_array() click to toggle source

Update termn of payments from data objects. Parameters: dataArray: The array of data objects.

@note TODO: This method was autogenerated from the WSDL - see github.com/coherify/ruconomic#contributing“ @see api.e-conomic.com/secure/api1/EconomicWebService.asmx?op=TermOfPayment_UpdateFromDataArray @return [Hash] The body content of the SOAP response.

# File lib/ruconomic/api/term_of_payment.rb, line 36
def self.update_from_data_array
  response = invoke('TermOfPayment_UpdateFromDataArray') do |message|
    raise "TODO: This method was autogenerated from the WSDL - see https://github.com/coherify/ruconomic#contributing"
  end
end