Class: ShellDataReportingApIs::PayerDetails

Inherits:
BaseModel
  • Object
show all
Defined in:
lib/shell_data_reporting_ap_is/models/payer_details.rb

Overview

PayerDetails Model.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BaseModel

#to_hash, #to_json

Constructor Details

#initialize(col_co_id = SKIP, col_co_code = SKIP, country_code = SKIP, country = SKIP, payer_id = SKIP, payer_number = SKIP, payer_full_name = SKIP, payer_short_name = SKIP, payer_group_id = SKIP, amount_due = SKIP, amount_overdue = SKIP, amount_not_overdue = SKIP, outstanding_balance = SKIP, unallocated_payment = SKIP, soa_currency_code = SKIP, soa_currency_symbol = SKIP, soa_credit_limit_currency_code = SKIP, soa_credit_limit_currency_symbol = SKIP, last_payment_currency_code = SKIP, last_payment_currency_symbol = SKIP, last_payment_amount = SKIP, last_payment_date = SKIP, soa_last_payment_amount = SKIP, soa_last_payment_date = SKIP, currency_code = SKIP, currency_symbol = SKIP, col_co_country_code = SKIP, local_currency_code = SKIP, local_currency_symbol = SKIP, local_currency_exchange_rate = SKIP, local_currency_exchange_rate_so_a = SKIP, billing_frequency_type_id = SKIP, billing_frequency_type = SKIP, billing_run_frequency_type_id = SKIP, billing_run_frequnecy = SKIP, day1_run = SKIP, day2_run = SKIP, day3_run = SKIP, day4_run = SKIP, invoice_distribution_methods = SKIP, output_type = SKIP, invoice_account_id = SKIP, invoice_account_number = SKIP, invoice_account_short_name = SKIP, best_of_indicator = false, is_international = false, total_accounts = SKIP, total_active_accounts = SKIP, total_cards = SKIP, total_active_cards = SKIP, total_blocked_cards = SKIP, total_cancelled_cards = SKIP, total_expired_cards = SKIP, total_renewal_pending_cards = SKIP, total_replaced_cards = SKIP, total_temporary_block_cards_by_customer = SKIP, total_temporary_block_cards_by_shell = SKIP, total_new_cards = SKIP, total_fraud_cards = SKIP, total_blocked_accounts = SKIP, total_cancelled_accounts = SKIP, payer_trading_name = SKIP, status = SKIP, billing_language = SKIP, legal_entity = SKIP, date_established = SKIP, customer_classification = SKIP, industry_class = SKIP, marketing_segmentation = SKIP, line_of_business = SKIP, print_credit_limit = false, card_group_type = SKIP, renew_cards = false, allow_select_pin = false, use_fleet_pin = SKIP, vat_reg_number = SKIP, vat_reg_number2 = SKIP, registration_number = SKIP, registration_number2 = SKIP, sales_ledger_balance = SKIP, exposure = SKIP, outstanding_debt = SKIP, available_credit = SKIP, band = SKIP, global_customer_reference_id = SKIP, credit_limit = SKIP, credit_limit_in_customer_currency = SKIP, billing_currency_code = SKIP, billing_currency_symbol = SKIP, payment_method = SKIP, payment_terms = SKIP, temporary_credit_limit_increase = SKIP, temporary_credit_limit_increase_in_customer_currency = SKIP, temporary_credit_limit_expiry_date = SKIP, payer_bank_account = SKIP, card_delivery_address = SKIP, correspondance_address = SKIP, billing_address = SKIP, has_active_vol_based_pricing = SKIP, has_active_vol_based_bonus = SKIP, has_active_vol_based_association_bonus = SKIP, finance_currency = SKIP, tolls_customer_id = SKIP, tolls_colco_country_type_id = SKIP, contracts = SKIP) ⇒ PayerDetails

Returns a new instance of PayerDetails.



821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
 
# File 'lib/shell_data_reporting_ap_is/models/payer_details.rb', line 821

def initialize(col_co_id = SKIP, col_co_code = SKIP, country_code = SKIP,
               country = SKIP, payer_id = SKIP, payer_number = SKIP,
               payer_full_name = SKIP, payer_short_name = SKIP,
               payer_group_id = SKIP, amount_due = SKIP,
               amount_overdue = SKIP, amount_not_overdue = SKIP,
               outstanding_balance = SKIP, unallocated_payment = SKIP,
               soa_currency_code = SKIP, soa_currency_symbol = SKIP,
               soa_credit_limit_currency_code = SKIP,
               soa_credit_limit_currency_symbol = SKIP,
               last_payment_currency_code = SKIP,
               last_payment_currency_symbol = SKIP,
               last_payment_amount = SKIP, last_payment_date = SKIP,
               soa_last_payment_amount = SKIP, soa_last_payment_date = SKIP,
               currency_code = SKIP, currency_symbol = SKIP,
               col_co_country_code = SKIP, local_currency_code = SKIP,
               local_currency_symbol = SKIP,
               local_currency_exchange_rate = SKIP,
               local_currency_exchange_rate_so_a = SKIP,
               billing_frequency_type_id = SKIP,
               billing_frequency_type = SKIP,
               billing_run_frequency_type_id = SKIP,
               billing_run_frequnecy = SKIP, day1_run = SKIP,
               day2_run = SKIP, day3_run = SKIP, day4_run = SKIP,
               invoice_distribution_methods = SKIP, output_type = SKIP,
                = SKIP,  = SKIP,
                = SKIP, best_of_indicator = false,
               is_international = false, total_accounts = SKIP,
               total_active_accounts = SKIP, total_cards = SKIP,
               total_active_cards = SKIP, total_blocked_cards = SKIP,
               total_cancelled_cards = SKIP, total_expired_cards = SKIP,
               total_renewal_pending_cards = SKIP,
               total_replaced_cards = SKIP,
               total_temporary_block_cards_by_customer = SKIP,
               total_temporary_block_cards_by_shell = SKIP,
               total_new_cards = SKIP, total_fraud_cards = SKIP,
               total_blocked_accounts = SKIP,
               total_cancelled_accounts = SKIP, payer_trading_name = SKIP,
               status = SKIP, billing_language = SKIP, legal_entity = SKIP,
               date_established = SKIP, customer_classification = SKIP,
               industry_class = SKIP, marketing_segmentation = SKIP,
               line_of_business = SKIP, print_credit_limit = false,
               card_group_type = SKIP, renew_cards = false,
               allow_select_pin = false, use_fleet_pin = SKIP,
               vat_reg_number = SKIP, vat_reg_number2 = SKIP,
               registration_number = SKIP, registration_number2 = SKIP,
               sales_ledger_balance = SKIP, exposure = SKIP,
               outstanding_debt = SKIP, available_credit = SKIP,
               band = SKIP, global_customer_reference_id = SKIP,
               credit_limit = SKIP,
               credit_limit_in_customer_currency = SKIP,
               billing_currency_code = SKIP, billing_currency_symbol = SKIP,
               payment_method = SKIP, payment_terms = SKIP,
               temporary_credit_limit_increase = SKIP,
               temporary_credit_limit_increase_in_customer_currency = SKIP,
               temporary_credit_limit_expiry_date = SKIP,
                = SKIP, card_delivery_address = SKIP,
               correspondance_address = SKIP, billing_address = SKIP,
               has_active_vol_based_pricing = SKIP,
               has_active_vol_based_bonus = SKIP,
               has_active_vol_based_association_bonus = SKIP,
               finance_currency = SKIP, tolls_customer_id = SKIP,
               tolls_colco_country_type_id = SKIP, contracts = SKIP)
  @col_co_id = col_co_id unless col_co_id == SKIP
  @col_co_code = col_co_code unless col_co_code == SKIP
  @country_code = country_code unless country_code == SKIP
  @country = country unless country == SKIP
  @payer_id = payer_id unless payer_id == SKIP
  @payer_number = payer_number unless payer_number == SKIP
  @payer_full_name = payer_full_name unless payer_full_name == SKIP
  @payer_short_name = payer_short_name unless payer_short_name == SKIP
  @payer_group_id = payer_group_id unless payer_group_id == SKIP
  @amount_due = amount_due unless amount_due == SKIP
  @amount_overdue = amount_overdue unless amount_overdue == SKIP
  @amount_not_overdue = amount_not_overdue unless amount_not_overdue == SKIP
  @outstanding_balance = outstanding_balance unless outstanding_balance == SKIP
  @unallocated_payment = unallocated_payment unless unallocated_payment == SKIP
  @soa_currency_code = soa_currency_code unless soa_currency_code == SKIP
  @soa_currency_symbol = soa_currency_symbol unless soa_currency_symbol == SKIP
  unless soa_credit_limit_currency_code == SKIP
    @soa_credit_limit_currency_code =
      soa_credit_limit_currency_code
  end
  unless soa_credit_limit_currency_symbol == SKIP
    @soa_credit_limit_currency_symbol =
      soa_credit_limit_currency_symbol
  end
  unless last_payment_currency_code == SKIP
    @last_payment_currency_code =
      last_payment_currency_code
  end
  unless last_payment_currency_symbol == SKIP
    @last_payment_currency_symbol =
      last_payment_currency_symbol
  end
  @last_payment_amount = last_payment_amount unless last_payment_amount == SKIP
  @last_payment_date = last_payment_date unless last_payment_date == SKIP
  @soa_last_payment_amount = soa_last_payment_amount unless soa_last_payment_amount == SKIP
  @soa_last_payment_date = soa_last_payment_date unless soa_last_payment_date == SKIP
  @currency_code = currency_code unless currency_code == SKIP
  @currency_symbol = currency_symbol unless currency_symbol == SKIP
  @col_co_country_code = col_co_country_code unless col_co_country_code == SKIP
  @local_currency_code = local_currency_code unless local_currency_code == SKIP
  @local_currency_symbol = local_currency_symbol unless local_currency_symbol == SKIP
  unless local_currency_exchange_rate == SKIP
    @local_currency_exchange_rate =
      local_currency_exchange_rate
  end
  unless local_currency_exchange_rate_so_a == SKIP
    @local_currency_exchange_rate_so_a =
      local_currency_exchange_rate_so_a
  end
  unless billing_frequency_type_id == SKIP
    @billing_frequency_type_id =
      billing_frequency_type_id
  end
  @billing_frequency_type = billing_frequency_type unless billing_frequency_type == SKIP
  unless billing_run_frequency_type_id == SKIP
    @billing_run_frequency_type_id =
      billing_run_frequency_type_id
  end
  @billing_run_frequnecy = billing_run_frequnecy unless billing_run_frequnecy == SKIP
  @day1_run = day1_run unless day1_run == SKIP
  @day2_run = day2_run unless day2_run == SKIP
  @day3_run = day3_run unless day3_run == SKIP
  @day4_run = day4_run unless day4_run == SKIP
  unless invoice_distribution_methods == SKIP
    @invoice_distribution_methods =
      invoice_distribution_methods
  end
  @output_type = output_type unless output_type == SKIP
  @invoice_account_id =  unless  == SKIP
  @invoice_account_number =  unless  == SKIP
  unless  == SKIP
    @invoice_account_short_name =
      
  end
  @best_of_indicator = best_of_indicator unless best_of_indicator == SKIP
  @is_international = is_international unless is_international == SKIP
  @total_accounts = total_accounts unless total_accounts == SKIP
  @total_active_accounts = total_active_accounts unless total_active_accounts == SKIP
  @total_cards = total_cards unless total_cards == SKIP
  @total_active_cards = total_active_cards unless total_active_cards == SKIP
  @total_blocked_cards = total_blocked_cards unless total_blocked_cards == SKIP
  @total_cancelled_cards = total_cancelled_cards unless total_cancelled_cards == SKIP
  @total_expired_cards = total_expired_cards unless total_expired_cards == SKIP
  unless total_renewal_pending_cards == SKIP
    @total_renewal_pending_cards =
      total_renewal_pending_cards
  end
  @total_replaced_cards = total_replaced_cards unless total_replaced_cards == SKIP
  unless total_temporary_block_cards_by_customer == SKIP
    @total_temporary_block_cards_by_customer =
      total_temporary_block_cards_by_customer
  end
  unless total_temporary_block_cards_by_shell == SKIP
    @total_temporary_block_cards_by_shell =
      total_temporary_block_cards_by_shell
  end
  @total_new_cards = total_new_cards unless total_new_cards == SKIP
  @total_fraud_cards = total_fraud_cards unless total_fraud_cards == SKIP
  @total_blocked_accounts = total_blocked_accounts unless total_blocked_accounts == SKIP
  @total_cancelled_accounts = total_cancelled_accounts unless total_cancelled_accounts == SKIP
  @payer_trading_name = payer_trading_name unless payer_trading_name == SKIP
  @status = status unless status == SKIP
  @billing_language = billing_language unless billing_language == SKIP
  @legal_entity = legal_entity unless legal_entity == SKIP
  @date_established = date_established unless date_established == SKIP
  @customer_classification = customer_classification unless customer_classification == SKIP
  @industry_class = industry_class unless industry_class == SKIP
  @marketing_segmentation = marketing_segmentation unless marketing_segmentation == SKIP
  @line_of_business = line_of_business unless line_of_business == SKIP
  @print_credit_limit = print_credit_limit unless print_credit_limit == SKIP
  @card_group_type = card_group_type unless card_group_type == SKIP
  @renew_cards = renew_cards unless renew_cards == SKIP
  @allow_select_pin = allow_select_pin unless allow_select_pin == SKIP
  @use_fleet_pin = use_fleet_pin unless use_fleet_pin == SKIP
  @vat_reg_number = vat_reg_number unless vat_reg_number == SKIP
  @vat_reg_number2 = vat_reg_number2 unless vat_reg_number2 == SKIP
  @registration_number = registration_number unless registration_number == SKIP
  @registration_number2 = registration_number2 unless registration_number2 == SKIP
  @sales_ledger_balance = sales_ledger_balance unless sales_ledger_balance == SKIP
  @exposure = exposure unless exposure == SKIP
  @outstanding_debt = outstanding_debt unless outstanding_debt == SKIP
  @available_credit = available_credit unless available_credit == SKIP
  @band = band unless band == SKIP
  unless global_customer_reference_id == SKIP
    @global_customer_reference_id =
      global_customer_reference_id
  end
  @credit_limit = credit_limit unless credit_limit == SKIP
  unless credit_limit_in_customer_currency == SKIP
    @credit_limit_in_customer_currency =
      credit_limit_in_customer_currency
  end
  @billing_currency_code = billing_currency_code unless billing_currency_code == SKIP
  @billing_currency_symbol = billing_currency_symbol unless billing_currency_symbol == SKIP
  @payment_method = payment_method unless payment_method == SKIP
  @payment_terms = payment_terms unless payment_terms == SKIP
  unless temporary_credit_limit_increase == SKIP
    @temporary_credit_limit_increase =
      temporary_credit_limit_increase
  end
  unless temporary_credit_limit_increase_in_customer_currency == SKIP
    @temporary_credit_limit_increase_in_customer_currency =
      temporary_credit_limit_increase_in_customer_currency
  end
  unless temporary_credit_limit_expiry_date == SKIP
    @temporary_credit_limit_expiry_date =
      temporary_credit_limit_expiry_date
  end
  @payer_bank_account =  unless  == SKIP
  @card_delivery_address = card_delivery_address unless card_delivery_address == SKIP
  @correspondance_address = correspondance_address unless correspondance_address == SKIP
  @billing_address = billing_address unless billing_address == SKIP
  unless has_active_vol_based_pricing == SKIP
    @has_active_vol_based_pricing =
      has_active_vol_based_pricing
  end
  unless has_active_vol_based_bonus == SKIP
    @has_active_vol_based_bonus =
      has_active_vol_based_bonus
  end
  unless has_active_vol_based_association_bonus == SKIP
    @has_active_vol_based_association_bonus =
      has_active_vol_based_association_bonus
  end
  @finance_currency = finance_currency unless finance_currency == SKIP
  @tolls_customer_id = tolls_customer_id unless tolls_customer_id == SKIP
  unless tolls_colco_country_type_id == SKIP
    @tolls_colco_country_type_id =
      tolls_colco_country_type_id
  end
  @contracts = contracts unless contracts == SKIP
end

Instance Attribute Details

#allow_select_pin ⇒ TrueClass | FalseClass

If set to True then Self Select PIN is allowed for Payer

Returns:

  • (TrueClass | FalseClass) 


343
344
345
 
# File 'lib/shell_data_reporting_ap_is/models/payer_details.rb', line 343

def allow_select_pin
  @allow_select_pin
end

#amount_due ⇒ Float

Invoiced amount and due for payment from the last SOA.

Returns:

  • (Float) 


50
51
52
 
# File 'lib/shell_data_reporting_ap_is/models/payer_details.rb', line 50

def amount_due
  @amount_due
end

#amount_not_overdue ⇒ Float

Invoiced amount and not overdue for payment from the last SOA.

Returns:

  • (Float) 


58
59
60
 
# File 'lib/shell_data_reporting_ap_is/models/payer_details.rb', line 58

def amount_not_overdue
  @amount_not_overdue
end

#amount_overdue ⇒ Float

Invoiced amount and overdue for payment from the last SOA.

Returns:

  • (Float) 


54
55
56
 
# File 'lib/shell_data_reporting_ap_is/models/payer_details.rb', line 54

def amount_overdue
  @amount_overdue
end

#available_credit ⇒ Float

The available credit for the payer. This is the credit limit minus the outstanding debt.

Returns:

  • (Float) 


381
382
383
 
# File 'lib/shell_data_reporting_ap_is/models/payer_details.rb', line 381

def available_credit
  @available_credit
end

#band ⇒ String

Band Id and Description of the Payer in Card Platform. e.g. (Id – Description): 1-Platinum 2-Gold 3-Silver 4-Bronze

Returns:

  • (String) 


390
391
392
 
# File 'lib/shell_data_reporting_ap_is/models/payer_details.rb', line 390

def band
  @band
end

#best_of_indicator ⇒ TrueClass | FalseClass

Best of Indicator of the Pricing customer/account configured.

Returns:

  • (TrueClass | FalseClass) 


214
215
216
 
# File 'lib/shell_data_reporting_ap_is/models/payer_details.rb', line 214

def best_of_indicator
  @best_of_indicator
end

#billing_address ⇒ Address

Temporary Credit limit expiry date

Returns:



449
450
451
 
# File 'lib/shell_data_reporting_ap_is/models/payer_details.rb', line 449

def billing_address
  @billing_address
end

#billing_currency_code ⇒ String

Customer Billing currency ISO code.

Returns:

  • (String) 


409
410
411
 
# File 'lib/shell_data_reporting_ap_is/models/payer_details.rb', line 409

def billing_currency_code
  @billing_currency_code
end

#billing_currency_symbol ⇒ String

Customer Billing currency Symbol.

Returns:

  • (String) 


413
414
415
 
# File 'lib/shell_data_reporting_ap_is/models/payer_details.rb', line 413

def billing_currency_symbol
  @billing_currency_symbol
end

#billing_frequency_type ⇒ String

Billing/Invoice frequency. The frequency in which the transactions will be considered for invoicing in a bulling run E.g.: 1 Daily (all days) 2 Daily (only working days) 3 Weekly - Monday 4 Weekly – Tuesday Etc.

Returns:

  • (String) 


152
153
154
 
# File 'lib/shell_data_reporting_ap_is/models/payer_details.rb', line 152

def billing_frequency_type
  @billing_frequency_type
end

#billing_frequency_type_id ⇒ Integer

Billing/Invoice frequency Identifier. Indicates the frequency in which the transactions will be considered for invoicing in a bulling run E.g.: 1, 2, 3, etc.

Returns:

  • (Integer) 


141
142
143
 
# File 'lib/shell_data_reporting_ap_is/models/payer_details.rb', line 141

def billing_frequency_type_id
  @billing_frequency_type_id
end

#billing_language ⇒ String

Payer Billing Language id and description

Returns:

  • (String) 


298
299
300
 
# File 'lib/shell_data_reporting_ap_is/models/payer_details.rb', line 298

def billing_language
  @billing_language
end

#billing_run_frequency_type_id ⇒ Integer

Frequency at which the billing process is triggered. E.g.: 1, 2, 3, etc.

Returns:

  • (Integer) 


157
158
159
 
# File 'lib/shell_data_reporting_ap_is/models/payer_details.rb', line 157

def billing_run_frequency_type_id
  @billing_run_frequency_type_id
end

#billing_run_frequnecy ⇒ String

Frequency at which the billing process is triggered.E.g.: 1 Daily (all days) 2 Daily (only working days) 3 Weekly - Monday 4 Weekly – Tuesday Etc.

Returns:

  • (String) 


166
167
168
 
# File 'lib/shell_data_reporting_ap_is/models/payer_details.rb', line 166

def billing_run_frequnecy
  @billing_run_frequnecy
end

#card_delivery_address ⇒ Address

Temporary Credit limit expiry date

Returns:



441
442
443
 
# File 'lib/shell_data_reporting_ap_is/models/payer_details.rb', line 441

def card_delivery_address
  @card_delivery_address
end

#card_group_type ⇒ String

Card Group Type configured for Payer e.g. (Id – Description): 1-Horizontal only 2-Vertical only 3-Both

Returns:

  • (String) 


335
336
337
 
# File 'lib/shell_data_reporting_ap_is/models/payer_details.rb', line 335

def card_group_type
  @card_group_type
end

#col_co_code ⇒ Integer

Collecting company code of the customer.

Returns:

  • (Integer) 


18
19
20
 
# File 'lib/shell_data_reporting_ap_is/models/payer_details.rb', line 18

def col_co_code
  @col_co_code
end

#col_co_country_code ⇒ String

The 2-character ISO Code for the customer and card owning country.

Returns:

  • (String) 


119
120
121
 
# File 'lib/shell_data_reporting_ap_is/models/payer_details.rb', line 119

def col_co_country_code
  @col_co_country_code
end

#col_co_id ⇒ Integer

Collecting company id of the customer.

Returns:

  • (Integer) 


14
15
16
 
# File 'lib/shell_data_reporting_ap_is/models/payer_details.rb', line 14

def col_co_id
  @col_co_id
end

#contracts ⇒ Array[CustomerContract]

String Colco country type id in e-TM system This field will have value only when ReturnTollsCustomerId is set to true in the request else set to null or empty.

Returns:



495
496
497
 
# File 'lib/shell_data_reporting_ap_is/models/payer_details.rb', line 495

def contracts
  @contracts
end

#correspondance_address ⇒ Address

Temporary Credit limit expiry date

Returns:



445
446
447
 
# File 'lib/shell_data_reporting_ap_is/models/payer_details.rb', line 445

def correspondance_address
  @correspondance_address
end

#country ⇒ String

Country of the customer

Returns:

  • (String) 


26
27
28
 
# File 'lib/shell_data_reporting_ap_is/models/payer_details.rb', line 26

def country
  @country
end

#country_code ⇒ String

ISO code of the customer country.

Returns:

  • (String) 


22
23
24
 
# File 'lib/shell_data_reporting_ap_is/models/payer_details.rb', line 22

def country_code
  @country_code
end

#credit_limit ⇒ Float

Payment Credit limit of Payer.

Returns:

  • (Float) 


399
400
401
 
# File 'lib/shell_data_reporting_ap_is/models/payer_details.rb', line 399

def credit_limit
  @credit_limit
end

#credit_limit_in_customer_currency ⇒ Float

Credit limit in Customer currency. Note: For currency details refer the parameters CurrencyCode & CurrencySymbol in the PayerDetail response.

Returns:

  • (Float) 


405
406
407
 
# File 'lib/shell_data_reporting_ap_is/models/payer_details.rb', line 405

def credit_limit_in_customer_currency
  @credit_limit_in_customer_currency
end

#currency_code ⇒ String

Currency ISO code

Returns:

  • (String) 


111
112
113
 
# File 'lib/shell_data_reporting_ap_is/models/payer_details.rb', line 111

def currency_code
  @currency_code
end

#currency_symbol ⇒ String

Currency Symbol

Returns:

  • (String) 


115
116
117
 
# File 'lib/shell_data_reporting_ap_is/models/payer_details.rb', line 115

def currency_symbol
  @currency_symbol
end

#customer_classification ⇒ String

Payer/Company Classification id and description

Returns:

  • (String) 


310
311
312
 
# File 'lib/shell_data_reporting_ap_is/models/payer_details.rb', line 310

def customer_classification
  @customer_classification
end

#date_established ⇒ String

Payer/Company Established Date.

Returns:

  • (String) 


306
307
308
 
# File 'lib/shell_data_reporting_ap_is/models/payer_details.rb', line 306

def date_established
  @date_established
end

#day1_run ⇒ Integer

The first day in a month when the billing should run in case of multiple billing runs configured with in a single month.

Returns:

  • (Integer) 


171
172
173
 
# File 'lib/shell_data_reporting_ap_is/models/payer_details.rb', line 171

def day1_run
  @day1_run
end

#day2_run ⇒ Integer

The second day in a month when the billing should run in case of multiple billing runs configured with in a single month.

Returns:

  • (Integer) 


176
177
178
 
# File 'lib/shell_data_reporting_ap_is/models/payer_details.rb', line 176

def day2_run
  @day2_run
end

#day3_run ⇒ Integer

The third day in a month when the billing should run in case of multiple billing runs configured with in a single month.

Returns:

  • (Integer) 


181
182
183
 
# File 'lib/shell_data_reporting_ap_is/models/payer_details.rb', line 181

def day3_run
  @day3_run
end

#day4_run ⇒ Integer

The fourth day in a month when the billing should run in case of multiple billing runs configured with in a single month.

Returns:

  • (Integer) 


186
187
188
 
# File 'lib/shell_data_reporting_ap_is/models/payer_details.rb', line 186

def day4_run
  @day4_run
end

#exposure ⇒ Float

Exposure after guarantee

Returns:

  • (Float) 


372
373
374
 
# File 'lib/shell_data_reporting_ap_is/models/payer_details.rb', line 372

def exposure
  @exposure
end

#finance_currency ⇒ FinanceCurrency2

True, if the payer is setup for volume-based association bonus and is active on the current date, else false. This field is returned only when IncludeBonusParameters is set to True in the request. Else set to null.

Returns:



477
478
479
 
# File 'lib/shell_data_reporting_ap_is/models/payer_details.rb', line 477

def finance_currency
  @finance_currency
end

#global_customer_reference_id ⇒ String

Global Customer reference id configured in card platform for Payer (Same as Payer Group)

Returns:

  • (String) 


395
396
397
 
# File 'lib/shell_data_reporting_ap_is/models/payer_details.rb', line 395

def global_customer_reference_id
  @global_customer_reference_id
end

#has_active_vol_based_association_bonus ⇒ TrueClass | FalseClass

True, if the payer is setup for volume-based association bonus and is active on the current date, else false. This field is returned only when IncludeBonusParameters is set to True in the request. Else set to null.

Returns:

  • (TrueClass | FalseClass) 


470
471
472
 
# File 'lib/shell_data_reporting_ap_is/models/payer_details.rb', line 470

def has_active_vol_based_association_bonus
  @has_active_vol_based_association_bonus
end

#has_active_vol_based_bonus ⇒ TrueClass | FalseClass

True, if the payer is setup for volume-based bonus and is active on the current date, else false. This field is returned only when IncludeBonusParameters is set to True in the request. Else set to null.

Returns:

  • (TrueClass | FalseClass) 


463
464
465
 
# File 'lib/shell_data_reporting_ap_is/models/payer_details.rb', line 463

def has_active_vol_based_bonus
  @has_active_vol_based_bonus
end

#has_active_vol_based_pricing ⇒ TrueClass | FalseClass

True, if the payer is setup for volume-based pricing and is active on the current date, else false. This field is returned only when IncludeBonusParameters is set to True in the request. Else set to null.

Returns:

  • (TrueClass | FalseClass) 


456
457
458
 
# File 'lib/shell_data_reporting_ap_is/models/payer_details.rb', line 456

def has_active_vol_based_pricing
  @has_active_vol_based_pricing
end

#industry_class ⇒ String

Payer/Company Industry class id and description

Returns:

  • (String) 


314
315
316
 
# File 'lib/shell_data_reporting_ap_is/models/payer_details.rb', line 314

def industry_class
  @industry_class
end

#invoice_account_id ⇒ Integer

The Account ID of the account on which the invoice is generated.

Returns:

  • (Integer) 


202
203
204
 
# File 'lib/shell_data_reporting_ap_is/models/payer_details.rb', line 202

def 
  @invoice_account_id
end

#invoice_account_number ⇒ String

The Account Number of the account on which the invoice is generated.

Returns:

  • (String) 


206
207
208
 
# File 'lib/shell_data_reporting_ap_is/models/payer_details.rb', line 206

def 
  @invoice_account_number
end

#invoice_account_short_name ⇒ String

The Account Short Name of the account on which the invoice is generated.

Returns:

  • (String) 


210
211
212
 
# File 'lib/shell_data_reporting_ap_is/models/payer_details.rb', line 210

def 
  @invoice_account_short_name
end

#invoice_distribution_methods ⇒ Array[InvoiceDistributionMethod]

The fourth day in a month when the billing should run in case of multiple billing runs configured with in a single month.

Returns:



191
192
193
 
# File 'lib/shell_data_reporting_ap_is/models/payer_details.rb', line 191

def invoice_distribution_methods
  @invoice_distribution_methods
end

#is_international ⇒ TrueClass | FalseClass

Whether the account is international.

Returns:

  • (TrueClass | FalseClass) 


218
219
220
 
# File 'lib/shell_data_reporting_ap_is/models/payer_details.rb', line 218

def is_international
  @is_international
end

#last_payment_amount ⇒ Float

Latest payment amount for the requested payer.

Returns:

  • (Float) 


95
96
97
 
# File 'lib/shell_data_reporting_ap_is/models/payer_details.rb', line 95

def last_payment_amount
  @last_payment_amount
end

#last_payment_currency_code ⇒ String

Currency ISO code

Returns:

  • (String) 


87
88
89
 
# File 'lib/shell_data_reporting_ap_is/models/payer_details.rb', line 87

def last_payment_currency_code
  @last_payment_currency_code
end

#last_payment_currency_symbol ⇒ String

currency symbol

Returns:

  • (String) 


91
92
93
 
# File 'lib/shell_data_reporting_ap_is/models/payer_details.rb', line 91

def last_payment_currency_symbol
  @last_payment_currency_symbol
end

#last_payment_date ⇒ String

Latest payment date for the requested payer.

Returns:

  • (String) 


99
100
101
 
# File 'lib/shell_data_reporting_ap_is/models/payer_details.rb', line 99

def last_payment_date
  @last_payment_date
end

#legal_entity ⇒ String

Legal entity id and description of the Payer

Returns:

  • (String) 


302
303
304
 
# File 'lib/shell_data_reporting_ap_is/models/payer_details.rb', line 302

def legal_entity
  @legal_entity
end

#line_of_business ⇒ String

Payer/Company Line of Business Id and Description

Returns:

  • (String) 


322
323
324
 
# File 'lib/shell_data_reporting_ap_is/models/payer_details.rb', line 322

def line_of_business
  @line_of_business
end

#local_currency_code ⇒ String

Currency ISO code of the local country.

Returns:

  • (String) 


123
124
125
 
# File 'lib/shell_data_reporting_ap_is/models/payer_details.rb', line 123

def local_currency_code
  @local_currency_code
end

#local_currency_exchange_rate ⇒ Float

Exchange rate from OU base currency to local currency.

Returns:

  • (Float) 


131
132
133
 
# File 'lib/shell_data_reporting_ap_is/models/payer_details.rb', line 131

def local_currency_exchange_rate
  @local_currency_exchange_rate
end

#local_currency_exchange_rate_so_a ⇒ Float

Exchange rate from SoA credit limit currency to local currency

Returns:

  • (Float) 


135
136
137
 
# File 'lib/shell_data_reporting_ap_is/models/payer_details.rb', line 135

def local_currency_exchange_rate_so_a
  @local_currency_exchange_rate_so_a
end

#local_currency_symbol ⇒ String

Currency Symbol of the local country

Returns:

  • (String) 


127
128
129
 
# File 'lib/shell_data_reporting_ap_is/models/payer_details.rb', line 127

def local_currency_symbol
  @local_currency_symbol
end

#marketing_segmentation ⇒ String

Marketing Segmentation id and description

Returns:

  • (String) 


318
319
320
 
# File 'lib/shell_data_reporting_ap_is/models/payer_details.rb', line 318

def marketing_segmentation
  @marketing_segmentation
end

#output_type ⇒ String

Invoice output type (Id-Description) E.g.: 1-PDF 6-Print

Returns:

  • (String) 


198
199
200
 
# File 'lib/shell_data_reporting_ap_is/models/payer_details.rb', line 198

def output_type
  @output_type
end

#outstanding_balance ⇒ Float

Current outstanding balance amount from the last SOA.

Returns:

  • (Float) 


62
63
64
 
# File 'lib/shell_data_reporting_ap_is/models/payer_details.rb', line 62

def outstanding_balance
  @outstanding_balance
end

#outstanding_debt ⇒ Float

Total outstanding debt (including billed and unbilled sales and fee items)

Returns:

  • (Float) 


376
377
378
 
# File 'lib/shell_data_reporting_ap_is/models/payer_details.rb', line 376

def outstanding_debt
  @outstanding_debt
end

#payer_bank_account ⇒ Array[BankAccount]

Temporary Credit limit expiry date

Returns:



437
438
439
 
# File 'lib/shell_data_reporting_ap_is/models/payer_details.rb', line 437

def 
  @payer_bank_account
end

#payer_full_name ⇒ String

Full Name of the Payer

Returns:

  • (String) 


38
39
40
 
# File 'lib/shell_data_reporting_ap_is/models/payer_details.rb', line 38

def payer_full_name
  @payer_full_name
end

#payer_group_id ⇒ Integer

Payer Group Id

Returns:

  • (Integer) 


46
47
48
 
# File 'lib/shell_data_reporting_ap_is/models/payer_details.rb', line 46

def payer_group_id
  @payer_group_id
end

#payer_id ⇒ Integer

Payer id of the customer

Returns:

  • (Integer) 


30
31
32
 
# File 'lib/shell_data_reporting_ap_is/models/payer_details.rb', line 30

def payer_id
  @payer_id
end

#payer_number ⇒ String

Payer Number of the customer

Returns:

  • (String) 


34
35
36
 
# File 'lib/shell_data_reporting_ap_is/models/payer_details.rb', line 34

def payer_number
  @payer_number
end

#payer_short_name ⇒ String

Short name of the payer

Returns:

  • (String) 


42
43
44
 
# File 'lib/shell_data_reporting_ap_is/models/payer_details.rb', line 42

def payer_short_name
  @payer_short_name
end

#payer_trading_name ⇒ String

Trading name for the Payer

Returns:

  • (String) 


284
285
286
 
# File 'lib/shell_data_reporting_ap_is/models/payer_details.rb', line 284

def payer_trading_name
  @payer_trading_name
end

#payment_method ⇒ String

Payment method Id and Description as configured for Payer in Card Platform

Returns:

  • (String) 


417
418
419
 
# File 'lib/shell_data_reporting_ap_is/models/payer_details.rb', line 417

def payment_method
  @payment_method
end

#payment_terms ⇒ String

Payment terms Id and Description as configured for Payer in Card Platform

Returns:

  • (String) 


421
422
423
 
# File 'lib/shell_data_reporting_ap_is/models/payer_details.rb', line 421

def payment_terms
  @payment_terms
end

#print_credit_limit ⇒ TrueClass | FalseClass

Is Credit Limit printed on the statement of account: True/False If True Credit Limit is printed on invoice/SOA

Returns:

  • (TrueClass | FalseClass) 


327
328
329
 
# File 'lib/shell_data_reporting_ap_is/models/payer_details.rb', line 327

def print_credit_limit
  @print_credit_limit
end

#registration_number ⇒ String

Payer/Company Registration number

Returns:

  • (String) 


360
361
362
 
# File 'lib/shell_data_reporting_ap_is/models/payer_details.rb', line 360

def registration_number
  @registration_number
end

#registration_number2 ⇒ String

Payer/Company Registration number2

Returns:

  • (String) 


364
365
366
 
# File 'lib/shell_data_reporting_ap_is/models/payer_details.rb', line 364

def registration_number2
  @registration_number2
end

#renew_cards ⇒ TrueClass | FalseClass

If set to True cards will be automatically renewed on expiry

Returns:

  • (TrueClass | FalseClass) 


339
340
341
 
# File 'lib/shell_data_reporting_ap_is/models/payer_details.rb', line 339

def renew_cards
  @renew_cards
end

#sales_ledger_balance ⇒ Float

Sales Ledger Balance (Billed)

Returns:

  • (Float) 


368
369
370
 
# File 'lib/shell_data_reporting_ap_is/models/payer_details.rb', line 368

def sales_ledger_balance
  @sales_ledger_balance
end

#soa_credit_limit_currency_code ⇒ String

Currency ISO code

Returns:

  • (String) 


79
80
81
 
# File 'lib/shell_data_reporting_ap_is/models/payer_details.rb', line 79

def soa_credit_limit_currency_code
  @soa_credit_limit_currency_code
end

#soa_credit_limit_currency_symbol ⇒ String

Currency symbol

Returns:

  • (String) 


83
84
85
 
# File 'lib/shell_data_reporting_ap_is/models/payer_details.rb', line 83

def soa_credit_limit_currency_symbol
  @soa_credit_limit_currency_symbol
end

#soa_currency_code ⇒ String

Currency ISO code

Returns:

  • (String) 


71
72
73
 
# File 'lib/shell_data_reporting_ap_is/models/payer_details.rb', line 71

def soa_currency_code
  @soa_currency_code
end

#soa_currency_symbol ⇒ String

Currency symbol

Returns:

  • (String) 


75
76
77
 
# File 'lib/shell_data_reporting_ap_is/models/payer_details.rb', line 75

def soa_currency_symbol
  @soa_currency_symbol
end

#soa_last_payment_amount ⇒ Float

Last payment amount in statement of account for the requested payer.

Returns:

  • (Float) 


103
104
105
 
# File 'lib/shell_data_reporting_ap_is/models/payer_details.rb', line 103

def soa_last_payment_amount
  @soa_last_payment_amount
end

#soa_last_payment_date ⇒ String

Last payment date in statement of account for the requested payer.

Returns:

  • (String) 


107
108
109
 
# File 'lib/shell_data_reporting_ap_is/models/payer_details.rb', line 107

def soa_last_payment_date
  @soa_last_payment_date
end

#status ⇒ String

Payer current status id and description e.g. (Id – Description): 1-Active 2-Requested from UTA 3-Awaiting embossing 4-Manufactured 5-Awaiting despatch

Returns:

  • (String) 


294
295
296
 
# File 'lib/shell_data_reporting_ap_is/models/payer_details.rb', line 294

def status
  @status
end

#temporary_credit_limit_expiry_date ⇒ String

Temporary Credit limit expiry date

Returns:

  • (String) 


433
434
435
 
# File 'lib/shell_data_reporting_ap_is/models/payer_details.rb', line 433

def temporary_credit_limit_expiry_date
  @temporary_credit_limit_expiry_date
end

#temporary_credit_limit_increase ⇒ Float

Temporary Credit limit increase value

Returns:

  • (Float) 


425
426
427
 
# File 'lib/shell_data_reporting_ap_is/models/payer_details.rb', line 425

def temporary_credit_limit_increase
  @temporary_credit_limit_increase
end

#temporary_credit_limit_increase_in_customer_currency ⇒ Float

Temporary Credit limit increase value

Returns:

  • (Float) 


429
430
431
 
# File 'lib/shell_data_reporting_ap_is/models/payer_details.rb', line 429

def temporary_credit_limit_increase_in_customer_currency
  @temporary_credit_limit_increase_in_customer_currency
end

#tolls_colco_country_type_id ⇒ String

String Colco country type id in e-TM system This field will have value only when ReturnTollsCustomerId is set to true in the request else set to null or empty.

Returns:

  • (String) 


489
490
491
 
# File 'lib/shell_data_reporting_ap_is/models/payer_details.rb', line 489

def tolls_colco_country_type_id
  @tolls_colco_country_type_id
end

#tolls_customer_id ⇒ String

Customer id in e-TM system This field will have value only when ReturnTollsCustomerId is set to true in the request else set to null or empty.

Returns:

  • (String) 


483
484
485
 
# File 'lib/shell_data_reporting_ap_is/models/payer_details.rb', line 483

def tolls_customer_id
  @tolls_customer_id
end

#total_accounts ⇒ Integer

Total number of accounts under the payer.

Returns:

  • (Integer) 


222
223
224
 
# File 'lib/shell_data_reporting_ap_is/models/payer_details.rb', line 222

def total_accounts
  @total_accounts
end

#total_active_accounts ⇒ Integer

Total number of active accounts under the payer.

Returns:

  • (Integer) 


226
227
228
 
# File 'lib/shell_data_reporting_ap_is/models/payer_details.rb', line 226

def total_active_accounts
  @total_active_accounts
end

#total_active_cards ⇒ Integer

Total number of active cards under the payer.

Returns:

  • (Integer) 


234
235
236
 
# File 'lib/shell_data_reporting_ap_is/models/payer_details.rb', line 234

def total_active_cards
  @total_active_cards
end

#total_blocked_accounts ⇒ Integer

Total number of accounts in Blocked status

Returns:

  • (Integer) 


276
277
278
 
# File 'lib/shell_data_reporting_ap_is/models/payer_details.rb', line 276

def total_blocked_accounts
  @total_blocked_accounts
end

#total_blocked_cards ⇒ Integer

Total number of cards under the payer that are permanently blocked

Returns:

  • (Integer) 


238
239
240
 
# File 'lib/shell_data_reporting_ap_is/models/payer_details.rb', line 238

def total_blocked_cards
  @total_blocked_cards
end

#total_cancelled_accounts ⇒ Integer

Total number of accounts in Cancel status

Returns:

  • (Integer) 


280
281
282
 
# File 'lib/shell_data_reporting_ap_is/models/payer_details.rb', line 280

def total_cancelled_accounts
  @total_cancelled_accounts
end

#total_cancelled_cards ⇒ Integer

Total number of cards under the payer that are cancelled

Returns:

  • (Integer) 


242
243
244
 
# File 'lib/shell_data_reporting_ap_is/models/payer_details.rb', line 242

def total_cancelled_cards
  @total_cancelled_cards
end

#total_cards ⇒ Integer

Total number of cards under the payer.

Returns:

  • (Integer) 


230
231
232
 
# File 'lib/shell_data_reporting_ap_is/models/payer_details.rb', line 230

def total_cards
  @total_cards
end

#total_expired_cards ⇒ Integer

Total number of expired cards under the payer.

Returns:

  • (Integer) 


246
247
248
 
# File 'lib/shell_data_reporting_ap_is/models/payer_details.rb', line 246

def total_expired_cards
  @total_expired_cards
end

#total_fraud_cards ⇒ Integer

Total number of cards in Fraud status

Returns:

  • (Integer) 


272
273
274
 
# File 'lib/shell_data_reporting_ap_is/models/payer_details.rb', line 272

def total_fraud_cards
  @total_fraud_cards
end

#total_new_cards ⇒ Integer

Total number of cards in “New” status

Returns:

  • (Integer) 


268
269
270
 
# File 'lib/shell_data_reporting_ap_is/models/payer_details.rb', line 268

def total_new_cards
  @total_new_cards
end

#total_renewal_pending_cards ⇒ Integer

Total number of Renewal Pending cards under the payer.

Returns:

  • (Integer) 


250
251
252
 
# File 'lib/shell_data_reporting_ap_is/models/payer_details.rb', line 250

def total_renewal_pending_cards
  @total_renewal_pending_cards
end

#total_replaced_cards ⇒ Integer

Total number of cards under the payer with status as “Replaced

Returns:

  • (Integer) 


254
255
256
 
# File 'lib/shell_data_reporting_ap_is/models/payer_details.rb', line 254

def total_replaced_cards
  @total_replaced_cards
end

#total_temporary_block_cards_by_customer ⇒ Integer

Total number of cards under the payer that are temporarily blocked by customer.

Returns:

  • (Integer) 


259
260
261
 
# File 'lib/shell_data_reporting_ap_is/models/payer_details.rb', line 259

def total_temporary_block_cards_by_customer
  @total_temporary_block_cards_by_customer
end

#total_temporary_block_cards_by_shell ⇒ Integer

Total number of cards under the payer that are temporarily blocked by Shell.

Returns:

  • (Integer) 


264
265
266
 
# File 'lib/shell_data_reporting_ap_is/models/payer_details.rb', line 264

def total_temporary_block_cards_by_shell
  @total_temporary_block_cards_by_shell
end

#unallocated_payment ⇒ Float

Unallocated payment. When negative, indicates overdue amount from the last SOA.

Returns:

  • (Float) 


67
68
69
 
# File 'lib/shell_data_reporting_ap_is/models/payer_details.rb', line 67

def unallocated_payment
  @unallocated_payment
end

#use_fleet_pin ⇒ TrueClass | FalseClass

If set to True then Fleet PIN is applied for the cards directly under payer

Returns:

  • (TrueClass | FalseClass) 


348
349
350
 
# File 'lib/shell_data_reporting_ap_is/models/payer_details.rb', line 348

def use_fleet_pin
  @use_fleet_pin
end

#vat_reg_number ⇒ String

Payer/Company VAT registration number.

Returns:

  • (String) 


352
353
354
 
# File 'lib/shell_data_reporting_ap_is/models/payer_details.rb', line 352

def vat_reg_number
  @vat_reg_number
end

#vat_reg_number2 ⇒ String

Payer/Company VAT registration number 2.

Returns:

  • (String) 


356
357
358
 
# File 'lib/shell_data_reporting_ap_is/models/payer_details.rb', line 356

def vat_reg_number2
  @vat_reg_number2
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
 
# File 'lib/shell_data_reporting_ap_is/models/payer_details.rb', line 1057

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  col_co_id = hash.key?('ColCoId') ? hash['ColCoId'] : SKIP
  col_co_code = hash.key?('ColCoCode') ? hash['ColCoCode'] : SKIP
  country_code = hash.key?('CountryCode') ? hash['CountryCode'] : SKIP
  country = hash.key?('Country') ? hash['Country'] : SKIP
  payer_id = hash.key?('PayerId') ? hash['PayerId'] : SKIP
  payer_number = hash.key?('PayerNumber') ? hash['PayerNumber'] : SKIP
  payer_full_name =
    hash.key?('PayerFullName') ? hash['PayerFullName'] : SKIP
  payer_short_name =
    hash.key?('PayerShortName') ? hash['PayerShortName'] : SKIP
  payer_group_id = hash.key?('PayerGroupId') ? hash['PayerGroupId'] : SKIP
  amount_due = hash.key?('AmountDue') ? hash['AmountDue'] : SKIP
  amount_overdue = hash.key?('AmountOverdue') ? hash['AmountOverdue'] : SKIP
  amount_not_overdue =
    hash.key?('AmountNotOverdue') ? hash['AmountNotOverdue'] : SKIP
  outstanding_balance =
    hash.key?('OutstandingBalance') ? hash['OutstandingBalance'] : SKIP
  unallocated_payment =
    hash.key?('UnallocatedPayment') ? hash['UnallocatedPayment'] : SKIP
  soa_currency_code =
    hash.key?('SOACurrencyCode') ? hash['SOACurrencyCode'] : SKIP
  soa_currency_symbol =
    hash.key?('SOACurrencySymbol') ? hash['SOACurrencySymbol'] : SKIP
  soa_credit_limit_currency_code =
    hash.key?('SOACreditLimitCurrencyCode') ? hash['SOACreditLimitCurrencyCode'] : SKIP
  soa_credit_limit_currency_symbol =
    hash.key?('SOACreditLimitCurrencySymbol') ? hash['SOACreditLimitCurrencySymbol'] : SKIP
  last_payment_currency_code =
    hash.key?('LastPaymentCurrencyCode') ? hash['LastPaymentCurrencyCode'] : SKIP
  last_payment_currency_symbol =
    hash.key?('LastPaymentCurrencySymbol') ? hash['LastPaymentCurrencySymbol'] : SKIP
  last_payment_amount =
    hash.key?('LastPaymentAmount') ? hash['LastPaymentAmount'] : SKIP
  last_payment_date =
    hash.key?('LastPaymentDate') ? hash['LastPaymentDate'] : SKIP
  soa_last_payment_amount =
    hash.key?('SOALastPaymentAmount') ? hash['SOALastPaymentAmount'] : SKIP
  soa_last_payment_date =
    hash.key?('SOALastPaymentDate') ? hash['SOALastPaymentDate'] : SKIP
  currency_code = hash.key?('CurrencyCode') ? hash['CurrencyCode'] : SKIP
  currency_symbol =
    hash.key?('CurrencySymbol') ? hash['CurrencySymbol'] : SKIP
  col_co_country_code =
    hash.key?('ColCoCountryCode') ? hash['ColCoCountryCode'] : SKIP
  local_currency_code =
    hash.key?('LocalCurrencyCode') ? hash['LocalCurrencyCode'] : SKIP
  local_currency_symbol =
    hash.key?('LocalCurrencySymbol') ? hash['LocalCurrencySymbol'] : SKIP
  local_currency_exchange_rate =
    hash.key?('LocalCurrencyExchangeRate') ? hash['LocalCurrencyExchangeRate'] : SKIP
  local_currency_exchange_rate_so_a =
    hash.key?('LocalCurrencyExchangeRate_SoA') ? hash['LocalCurrencyExchangeRate_SoA'] : SKIP
  billing_frequency_type_id =
    hash.key?('BillingFrequencyTypeId') ? hash['BillingFrequencyTypeId'] : SKIP
  billing_frequency_type =
    hash.key?('BillingFrequencyType') ? hash['BillingFrequencyType'] : SKIP
  billing_run_frequency_type_id =
    hash.key?('BillingRunFrequencyTypeId') ? hash['BillingRunFrequencyTypeId'] : SKIP
  billing_run_frequnecy =
    hash.key?('BillingRunFrequnecy') ? hash['BillingRunFrequnecy'] : SKIP
  day1_run = hash.key?('Day1Run') ? hash['Day1Run'] : SKIP
  day2_run = hash.key?('Day2Run') ? hash['Day2Run'] : SKIP
  day3_run = hash.key?('Day3Run') ? hash['Day3Run'] : SKIP
  day4_run = hash.key?('Day4Run') ? hash['Day4Run'] : SKIP
  # Parameter is an array, so we need to iterate through it
  invoice_distribution_methods = nil
  unless hash['InvoiceDistributionMethods'].nil?
    invoice_distribution_methods = []
    hash['InvoiceDistributionMethods'].each do |structure|
      invoice_distribution_methods << (InvoiceDistributionMethod.from_hash(structure) if structure)
    end
  end

  invoice_distribution_methods = SKIP unless hash.key?('InvoiceDistributionMethods')
  output_type = hash.key?('OutputType') ? hash['OutputType'] : SKIP
   =
    hash.key?('InvoiceAccountID') ? hash['InvoiceAccountID'] : SKIP
   =
    hash.key?('InvoiceAccountNumber') ? hash['InvoiceAccountNumber'] : SKIP
   =
    hash.key?('InvoiceAccountShortName') ? hash['InvoiceAccountShortName'] : SKIP
  best_of_indicator = hash['BestOfIndicator'] ||= false
  is_international = hash['IsInternational'] ||= false
  total_accounts = hash.key?('TotalAccounts') ? hash['TotalAccounts'] : SKIP
  total_active_accounts =
    hash.key?('TotalActiveAccounts') ? hash['TotalActiveAccounts'] : SKIP
  total_cards = hash.key?('TotalCards') ? hash['TotalCards'] : SKIP
  total_active_cards =
    hash.key?('TotalActiveCards') ? hash['TotalActiveCards'] : SKIP
  total_blocked_cards =
    hash.key?('TotalBlockedCards') ? hash['TotalBlockedCards'] : SKIP
  total_cancelled_cards =
    hash.key?('TotalCancelledCards') ? hash['TotalCancelledCards'] : SKIP
  total_expired_cards =
    hash.key?('TotalExpiredCards') ? hash['TotalExpiredCards'] : SKIP
  total_renewal_pending_cards =
    hash.key?('TotalRenewalPendingCards') ? hash['TotalRenewalPendingCards'] : SKIP
  total_replaced_cards =
    hash.key?('TotalReplacedCards') ? hash['TotalReplacedCards'] : SKIP
  total_temporary_block_cards_by_customer =
    hash.key?('TotalTemporaryBlockCardsByCustomer') ? hash['TotalTemporaryBlockCardsByCustomer'] : SKIP
  total_temporary_block_cards_by_shell =
    hash.key?('TotalTemporaryBlockCardsByShell') ? hash['TotalTemporaryBlockCardsByShell'] : SKIP
  total_new_cards =
    hash.key?('TotalNewCards') ? hash['TotalNewCards'] : SKIP
  total_fraud_cards =
    hash.key?('TotalFraudCards') ? hash['TotalFraudCards'] : SKIP
  total_blocked_accounts =
    hash.key?('TotalBlockedAccounts') ? hash['TotalBlockedAccounts'] : SKIP
  total_cancelled_accounts =
    hash.key?('TotalCancelledAccounts') ? hash['TotalCancelledAccounts'] : SKIP
  payer_trading_name =
    hash.key?('PayerTradingName') ? hash['PayerTradingName'] : SKIP
  status = hash.key?('Status') ? hash['Status'] : SKIP
  billing_language =
    hash.key?('BillingLanguage') ? hash['BillingLanguage'] : SKIP
  legal_entity = hash.key?('LegalEntity') ? hash['LegalEntity'] : SKIP
  date_established =
    hash.key?('DateEstablished') ? hash['DateEstablished'] : SKIP
  customer_classification =
    hash.key?('CustomerClassification') ? hash['CustomerClassification'] : SKIP
  industry_class = hash.key?('IndustryClass') ? hash['IndustryClass'] : SKIP
  marketing_segmentation =
    hash.key?('MarketingSegmentation') ? hash['MarketingSegmentation'] : SKIP
  line_of_business =
    hash.key?('LineOfBusiness') ? hash['LineOfBusiness'] : SKIP
  print_credit_limit = hash['PrintCreditLimit'] ||= false
  card_group_type =
    hash.key?('CardGroupType') ? hash['CardGroupType'] : SKIP
  renew_cards = hash['RenewCards'] ||= false
  allow_select_pin = hash['AllowSelectPIN'] ||= false
  use_fleet_pin = hash.key?('UseFleetPIN') ? hash['UseFleetPIN'] : SKIP
  vat_reg_number = hash.key?('VATRegNumber') ? hash['VATRegNumber'] : SKIP
  vat_reg_number2 =
    hash.key?('VATRegNumber2') ? hash['VATRegNumber2'] : SKIP
  registration_number =
    hash.key?('RegistrationNumber') ? hash['RegistrationNumber'] : SKIP
  registration_number2 =
    hash.key?('RegistrationNumber2') ? hash['RegistrationNumber2'] : SKIP
  sales_ledger_balance =
    hash.key?('SalesLedgerBalance') ? hash['SalesLedgerBalance'] : SKIP
  exposure = hash.key?('Exposure') ? hash['Exposure'] : SKIP
  outstanding_debt =
    hash.key?('OutstandingDebt') ? hash['OutstandingDebt'] : SKIP
  available_credit =
    hash.key?('AvailableCredit') ? hash['AvailableCredit'] : SKIP
  band = hash.key?('Band') ? hash['Band'] : SKIP
  global_customer_reference_id =
    hash.key?('GlobalCustomerReferenceId') ? hash['GlobalCustomerReferenceId'] : SKIP
  credit_limit = hash.key?('CreditLimit') ? hash['CreditLimit'] : SKIP
  credit_limit_in_customer_currency =
    hash.key?('CreditLimitInCustomerCurrency') ? hash['CreditLimitInCustomerCurrency'] : SKIP
  billing_currency_code =
    hash.key?('BillingCurrencyCode') ? hash['BillingCurrencyCode'] : SKIP
  billing_currency_symbol =
    hash.key?('BillingCurrencySymbol') ? hash['BillingCurrencySymbol'] : SKIP
  payment_method = hash.key?('PaymentMethod') ? hash['PaymentMethod'] : SKIP
  payment_terms = hash.key?('PaymentTerms') ? hash['PaymentTerms'] : SKIP
  temporary_credit_limit_increase =
    hash.key?('TemporaryCreditLimitIncrease') ? hash['TemporaryCreditLimitIncrease'] : SKIP
  temporary_credit_limit_increase_in_customer_currency =
    hash.key?('TemporaryCreditLimitIncreaseInCustomerCurrency') ? hash['TemporaryCreditLimitIncreaseInCustomerCurrency'] : SKIP
  temporary_credit_limit_expiry_date =
    hash.key?('TemporaryCreditLimitExpiryDate') ? hash['TemporaryCreditLimitExpiryDate'] : SKIP
  # Parameter is an array, so we need to iterate through it
   = nil
  unless hash['PayerBankAccount'].nil?
     = []
    hash['PayerBankAccount'].each do |structure|
       << (BankAccount.from_hash(structure) if structure)
    end
  end

   = SKIP unless hash.key?('PayerBankAccount')
  card_delivery_address = Address.from_hash(hash['CardDeliveryAddress']) if
    hash['CardDeliveryAddress']
  correspondance_address = Address.from_hash(hash['CorrespondanceAddress']) if
    hash['CorrespondanceAddress']
  billing_address = Address.from_hash(hash['BillingAddress']) if hash['BillingAddress']
  has_active_vol_based_pricing =
    hash.key?('HasActiveVolBasedPricing') ? hash['HasActiveVolBasedPricing'] : SKIP
  has_active_vol_based_bonus =
    hash.key?('HasActiveVolBasedBonus') ? hash['HasActiveVolBasedBonus'] : SKIP
  has_active_vol_based_association_bonus =
    hash.key?('HasActiveVolBasedAssociationBonus') ? hash['HasActiveVolBasedAssociationBonus'] : SKIP
  finance_currency = FinanceCurrency2.from_hash(hash['FinanceCurrency']) if
    hash['FinanceCurrency']
  tolls_customer_id =
    hash.key?('TollsCustomerId') ? hash['TollsCustomerId'] : SKIP
  tolls_colco_country_type_id =
    hash.key?('TollsColcoCountryTypeId') ? hash['TollsColcoCountryTypeId'] : SKIP
  # Parameter is an array, so we need to iterate through it
  contracts = nil
  unless hash['Contracts'].nil?
    contracts = []
    hash['Contracts'].each do |structure|
      contracts << (CustomerContract.from_hash(structure) if structure)
    end
  end

  contracts = SKIP unless hash.key?('Contracts')

  # Create object from extracted values.
  PayerDetails.new(col_co_id,
                   col_co_code,
                   country_code,
                   country,
                   payer_id,
                   payer_number,
                   payer_full_name,
                   payer_short_name,
                   payer_group_id,
                   amount_due,
                   amount_overdue,
                   amount_not_overdue,
                   outstanding_balance,
                   unallocated_payment,
                   soa_currency_code,
                   soa_currency_symbol,
                   soa_credit_limit_currency_code,
                   soa_credit_limit_currency_symbol,
                   last_payment_currency_code,
                   last_payment_currency_symbol,
                   last_payment_amount,
                   last_payment_date,
                   soa_last_payment_amount,
                   soa_last_payment_date,
                   currency_code,
                   currency_symbol,
                   col_co_country_code,
                   local_currency_code,
                   local_currency_symbol,
                   local_currency_exchange_rate,
                   local_currency_exchange_rate_so_a,
                   billing_frequency_type_id,
                   billing_frequency_type,
                   billing_run_frequency_type_id,
                   billing_run_frequnecy,
                   day1_run,
                   day2_run,
                   day3_run,
                   day4_run,
                   invoice_distribution_methods,
                   output_type,
                   ,
                   ,
                   ,
                   best_of_indicator,
                   is_international,
                   total_accounts,
                   total_active_accounts,
                   total_cards,
                   total_active_cards,
                   total_blocked_cards,
                   total_cancelled_cards,
                   total_expired_cards,
                   total_renewal_pending_cards,
                   total_replaced_cards,
                   total_temporary_block_cards_by_customer,
                   total_temporary_block_cards_by_shell,
                   total_new_cards,
                   total_fraud_cards,
                   total_blocked_accounts,
                   total_cancelled_accounts,
                   payer_trading_name,
                   status,
                   billing_language,
                   legal_entity,
                   date_established,
                   customer_classification,
                   industry_class,
                   marketing_segmentation,
                   line_of_business,
                   print_credit_limit,
                   card_group_type,
                   renew_cards,
                   allow_select_pin,
                   use_fleet_pin,
                   vat_reg_number,
                   vat_reg_number2,
                   registration_number,
                   registration_number2,
                   sales_ledger_balance,
                   exposure,
                   outstanding_debt,
                   available_credit,
                   band,
                   global_customer_reference_id,
                   credit_limit,
                   credit_limit_in_customer_currency,
                   billing_currency_code,
                   billing_currency_symbol,
                   payment_method,
                   payment_terms,
                   temporary_credit_limit_increase,
                   temporary_credit_limit_increase_in_customer_currency,
                   temporary_credit_limit_expiry_date,
                   ,
                   card_delivery_address,
                   correspondance_address,
                   billing_address,
                   has_active_vol_based_pricing,
                   has_active_vol_based_bonus,
                   has_active_vol_based_association_bonus,
                   finance_currency,
                   tolls_customer_id,
                   tolls_colco_country_type_id,
                   contracts)
end

.names ⇒ Object

A mapping from model property names to API property names.



498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
 
# File 'lib/shell_data_reporting_ap_is/models/payer_details.rb', line 498

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['col_co_id'] = 'ColCoId'
  @_hash['col_co_code'] = 'ColCoCode'
  @_hash['country_code'] = 'CountryCode'
  @_hash['country'] = 'Country'
  @_hash['payer_id'] = 'PayerId'
  @_hash['payer_number'] = 'PayerNumber'
  @_hash['payer_full_name'] = 'PayerFullName'
  @_hash['payer_short_name'] = 'PayerShortName'
  @_hash['payer_group_id'] = 'PayerGroupId'
  @_hash['amount_due'] = 'AmountDue'
  @_hash['amount_overdue'] = 'AmountOverdue'
  @_hash['amount_not_overdue'] = 'AmountNotOverdue'
  @_hash['outstanding_balance'] = 'OutstandingBalance'
  @_hash['unallocated_payment'] = 'UnallocatedPayment'
  @_hash['soa_currency_code'] = 'SOACurrencyCode'
  @_hash['soa_currency_symbol'] = 'SOACurrencySymbol'
  @_hash['soa_credit_limit_currency_code'] = 'SOACreditLimitCurrencyCode'
  @_hash['soa_credit_limit_currency_symbol'] =
    'SOACreditLimitCurrencySymbol'
  @_hash['last_payment_currency_code'] = 'LastPaymentCurrencyCode'
  @_hash['last_payment_currency_symbol'] = 'LastPaymentCurrencySymbol'
  @_hash['last_payment_amount'] = 'LastPaymentAmount'
  @_hash['last_payment_date'] = 'LastPaymentDate'
  @_hash['soa_last_payment_amount'] = 'SOALastPaymentAmount'
  @_hash['soa_last_payment_date'] = 'SOALastPaymentDate'
  @_hash['currency_code'] = 'CurrencyCode'
  @_hash['currency_symbol'] = 'CurrencySymbol'
  @_hash['col_co_country_code'] = 'ColCoCountryCode'
  @_hash['local_currency_code'] = 'LocalCurrencyCode'
  @_hash['local_currency_symbol'] = 'LocalCurrencySymbol'
  @_hash['local_currency_exchange_rate'] = 'LocalCurrencyExchangeRate'
  @_hash['local_currency_exchange_rate_so_a'] =
    'LocalCurrencyExchangeRate_SoA'
  @_hash['billing_frequency_type_id'] = 'BillingFrequencyTypeId'
  @_hash['billing_frequency_type'] = 'BillingFrequencyType'
  @_hash['billing_run_frequency_type_id'] = 'BillingRunFrequencyTypeId'
  @_hash['billing_run_frequnecy'] = 'BillingRunFrequnecy'
  @_hash['day1_run'] = 'Day1Run'
  @_hash['day2_run'] = 'Day2Run'
  @_hash['day3_run'] = 'Day3Run'
  @_hash['day4_run'] = 'Day4Run'
  @_hash['invoice_distribution_methods'] = 'InvoiceDistributionMethods'
  @_hash['output_type'] = 'OutputType'
  @_hash['invoice_account_id'] = 'InvoiceAccountID'
  @_hash['invoice_account_number'] = 'InvoiceAccountNumber'
  @_hash['invoice_account_short_name'] = 'InvoiceAccountShortName'
  @_hash['best_of_indicator'] = 'BestOfIndicator'
  @_hash['is_international'] = 'IsInternational'
  @_hash['total_accounts'] = 'TotalAccounts'
  @_hash['total_active_accounts'] = 'TotalActiveAccounts'
  @_hash['total_cards'] = 'TotalCards'
  @_hash['total_active_cards'] = 'TotalActiveCards'
  @_hash['total_blocked_cards'] = 'TotalBlockedCards'
  @_hash['total_cancelled_cards'] = 'TotalCancelledCards'
  @_hash['total_expired_cards'] = 'TotalExpiredCards'
  @_hash['total_renewal_pending_cards'] = 'TotalRenewalPendingCards'
  @_hash['total_replaced_cards'] = 'TotalReplacedCards'
  @_hash['total_temporary_block_cards_by_customer'] =
    'TotalTemporaryBlockCardsByCustomer'
  @_hash['total_temporary_block_cards_by_shell'] =
    'TotalTemporaryBlockCardsByShell'
  @_hash['total_new_cards'] = 'TotalNewCards'
  @_hash['total_fraud_cards'] = 'TotalFraudCards'
  @_hash['total_blocked_accounts'] = 'TotalBlockedAccounts'
  @_hash['total_cancelled_accounts'] = 'TotalCancelledAccounts'
  @_hash['payer_trading_name'] = 'PayerTradingName'
  @_hash['status'] = 'Status'
  @_hash['billing_language'] = 'BillingLanguage'
  @_hash['legal_entity'] = 'LegalEntity'
  @_hash['date_established'] = 'DateEstablished'
  @_hash['customer_classification'] = 'CustomerClassification'
  @_hash['industry_class'] = 'IndustryClass'
  @_hash['marketing_segmentation'] = 'MarketingSegmentation'
  @_hash['line_of_business'] = 'LineOfBusiness'
  @_hash['print_credit_limit'] = 'PrintCreditLimit'
  @_hash['card_group_type'] = 'CardGroupType'
  @_hash['renew_cards'] = 'RenewCards'
  @_hash['allow_select_pin'] = 'AllowSelectPIN'
  @_hash['use_fleet_pin'] = 'UseFleetPIN'
  @_hash['vat_reg_number'] = 'VATRegNumber'
  @_hash['vat_reg_number2'] = 'VATRegNumber2'
  @_hash['registration_number'] = 'RegistrationNumber'
  @_hash['registration_number2'] = 'RegistrationNumber2'
  @_hash['sales_ledger_balance'] = 'SalesLedgerBalance'
  @_hash['exposure'] = 'Exposure'
  @_hash['outstanding_debt'] = 'OutstandingDebt'
  @_hash['available_credit'] = 'AvailableCredit'
  @_hash['band'] = 'Band'
  @_hash['global_customer_reference_id'] = 'GlobalCustomerReferenceId'
  @_hash['credit_limit'] = 'CreditLimit'
  @_hash['credit_limit_in_customer_currency'] =
    'CreditLimitInCustomerCurrency'
  @_hash['billing_currency_code'] = 'BillingCurrencyCode'
  @_hash['billing_currency_symbol'] = 'BillingCurrencySymbol'
  @_hash['payment_method'] = 'PaymentMethod'
  @_hash['payment_terms'] = 'PaymentTerms'
  @_hash['temporary_credit_limit_increase'] =
    'TemporaryCreditLimitIncrease'
  @_hash['temporary_credit_limit_increase_in_customer_currency'] =
    'TemporaryCreditLimitIncreaseInCustomerCurrency'
  @_hash['temporary_credit_limit_expiry_date'] =
    'TemporaryCreditLimitExpiryDate'
  @_hash['payer_bank_account'] = 'PayerBankAccount'
  @_hash['card_delivery_address'] = 'CardDeliveryAddress'
  @_hash['correspondance_address'] = 'CorrespondanceAddress'
  @_hash['billing_address'] = 'BillingAddress'
  @_hash['has_active_vol_based_pricing'] = 'HasActiveVolBasedPricing'
  @_hash['has_active_vol_based_bonus'] = 'HasActiveVolBasedBonus'
  @_hash['has_active_vol_based_association_bonus'] =
    'HasActiveVolBasedAssociationBonus'
  @_hash['finance_currency'] = 'FinanceCurrency'
  @_hash['tolls_customer_id'] = 'TollsCustomerId'
  @_hash['tolls_colco_country_type_id'] = 'TollsColcoCountryTypeId'
  @_hash['contracts'] = 'Contracts'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
 
# File 'lib/shell_data_reporting_ap_is/models/payer_details.rb', line 729

def self.nullables
  %w[
    col_co_id
    col_co_code
    country_code
    country
    payer_id
    payer_number
    payer_full_name
    payer_short_name
    payer_group_id
    amount_due
    amount_overdue
    amount_not_overdue
    outstanding_balance
    unallocated_payment
    soa_currency_code
    soa_currency_symbol
    soa_credit_limit_currency_code
    soa_credit_limit_currency_symbol
    last_payment_currency_code
    last_payment_currency_symbol
    last_payment_amount
    last_payment_date
    soa_last_payment_amount
    soa_last_payment_date
    currency_code
    currency_symbol
    col_co_country_code
    local_currency_code
    local_currency_symbol
    local_currency_exchange_rate
    local_currency_exchange_rate_so_a
    billing_frequency_type_id
    billing_frequency_type
    billing_run_frequency_type_id
    billing_run_frequnecy
    day1_run
    day2_run
    day3_run
    day4_run
    output_type
    invoice_account_id
    invoice_account_number
    invoice_account_short_name
    total_accounts
    total_active_accounts
    total_cards
    total_active_cards
    total_blocked_cards
    total_cancelled_cards
    total_expired_cards
    total_renewal_pending_cards
    total_replaced_cards
    total_temporary_block_cards_by_customer
    total_temporary_block_cards_by_shell
    total_new_cards
    total_fraud_cards
    total_blocked_accounts
    total_cancelled_accounts
    payer_trading_name
    billing_language
    legal_entity
    date_established
    customer_classification
    industry_class
    marketing_segmentation
    line_of_business
    card_group_type
    vat_reg_number
    registration_number
    registration_number2
    sales_ledger_balance
    exposure
    outstanding_debt
    available_credit
    band
    global_customer_reference_id
    credit_limit
    credit_limit_in_customer_currency
    billing_currency_code
    billing_currency_symbol
    payment_method
    payment_terms
    temporary_credit_limit_increase
    temporary_credit_limit_increase_in_customer_currency
    temporary_credit_limit_expiry_date
    tolls_customer_id
    tolls_colco_country_type_id
  ]
end

.optionals ⇒ Object

An array for optional fields



618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
 
# File 'lib/shell_data_reporting_ap_is/models/payer_details.rb', line 618

def self.optionals
  %w[
    col_co_id
    col_co_code
    country_code
    country
    payer_id
    payer_number
    payer_full_name
    payer_short_name
    payer_group_id
    amount_due
    amount_overdue
    amount_not_overdue
    outstanding_balance
    unallocated_payment
    soa_currency_code
    soa_currency_symbol
    soa_credit_limit_currency_code
    soa_credit_limit_currency_symbol
    last_payment_currency_code
    last_payment_currency_symbol
    last_payment_amount
    last_payment_date
    soa_last_payment_amount
    soa_last_payment_date
    currency_code
    currency_symbol
    col_co_country_code
    local_currency_code
    local_currency_symbol
    local_currency_exchange_rate
    local_currency_exchange_rate_so_a
    billing_frequency_type_id
    billing_frequency_type
    billing_run_frequency_type_id
    billing_run_frequnecy
    day1_run
    day2_run
    day3_run
    day4_run
    invoice_distribution_methods
    output_type
    invoice_account_id
    invoice_account_number
    invoice_account_short_name
    best_of_indicator
    is_international
    total_accounts
    total_active_accounts
    total_cards
    total_active_cards
    total_blocked_cards
    total_cancelled_cards
    total_expired_cards
    total_renewal_pending_cards
    total_replaced_cards
    total_temporary_block_cards_by_customer
    total_temporary_block_cards_by_shell
    total_new_cards
    total_fraud_cards
    total_blocked_accounts
    total_cancelled_accounts
    payer_trading_name
    status
    billing_language
    legal_entity
    date_established
    customer_classification
    industry_class
    marketing_segmentation
    line_of_business
    print_credit_limit
    card_group_type
    renew_cards
    allow_select_pin
    use_fleet_pin
    vat_reg_number
    vat_reg_number2
    registration_number
    registration_number2
    sales_ledger_balance
    exposure
    outstanding_debt
    available_credit
    band
    global_customer_reference_id
    credit_limit
    credit_limit_in_customer_currency
    billing_currency_code
    billing_currency_symbol
    payment_method
    payment_terms
    temporary_credit_limit_increase
    temporary_credit_limit_increase_in_customer_currency
    temporary_credit_limit_expiry_date
    payer_bank_account
    card_delivery_address
    correspondance_address
    billing_address
    has_active_vol_based_pricing
    has_active_vol_based_bonus
    has_active_vol_based_association_bonus
    finance_currency
    tolls_customer_id
    tolls_colco_country_type_id
    contracts
  ]
end