Class: ShellDataReportingApIs::InvoiceSearchDetails

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

Overview

InvoiceSearchDetails Model.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BaseModel

#to_hash, #to_json

Constructor Details

#initialize(account_full_name = SKIP, account_id = SKIP, account_number = SKIP, account_short_name = SKIP, col_co_id = SKIP, col_co_op_co_id = SKIP, current_billing_frequency = SKIP, current_billing_frequency_id = SKIP, current_distribution_method = SKIP, current_distribution_method_id = SKIP, customer_currency_code = SKIP, customer_currency_symbol = SKIP, del_co_client_number = SKIP, del_co_id = SKIP, del_co_op_co_id = SKIP, document_type = SKIP, document_type_id = SKIP, due_date = SKIP, gross_amount_customer_currency = SKIP, gross_amount_transaction_currency = SKIP, invoice_date = SKIP, invoiced_by = SKIP, invoiced_on_behalf_of = SKIP, invoice_id = SKIP, invoice_number = SKIP, is_international = SKIP, is_national = SKIP, net_amount_customer_currency = SKIP, net_amount_transaction_currency = SKIP, payer_id = SKIP, payer_number = SKIP, payment_terms = SKIP, payment_terms_id = SKIP, replacement_invoice_id = SKIP, reversal_invoice_id = SKIP, status = SKIP, summary_document_billing_type = SKIP, summary_document_billing_type_id = SKIP, summary_document_date = SKIP, summary_document_dd_amount = SKIP, summary_document_due_date = SKIP, summary_document_id = SKIP, summary_document_is_fully_paid = SKIP, summary_document_number = SKIP, summary_document_paid_amount = SKIP, summary_document_so_a_reference_number = SKIP, summary_document_statement_of_account_id = SKIP, transaction_currency_code = SKIP, transaction_currency_symbol = SKIP, type = SKIP, type_id = SKIP, vat_amount_customer_currency = SKIP, vat_amount_transaction_currency = SKIP, vat_country = SKIP, vat_country_id = SKIP, vat_country_iso_code = SKIP, vat_country_op_co_id = SKIP, document_reference = SKIP, additional_documents = SKIP) ⇒ InvoiceSearchDetails

Returns a new instance of InvoiceSearchDetails.



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
616
617
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
 
# File 'lib/shell_data_reporting_ap_is/models/invoice_search_details.rb', line 560

def initialize( = SKIP,  = SKIP,
                = SKIP,  = SKIP,
               col_co_id = SKIP, col_co_op_co_id = SKIP,
               current_billing_frequency = SKIP,
               current_billing_frequency_id = SKIP,
               current_distribution_method = SKIP,
               current_distribution_method_id = SKIP,
               customer_currency_code = SKIP,
               customer_currency_symbol = SKIP, del_co_client_number = SKIP,
               del_co_id = SKIP, del_co_op_co_id = SKIP,
               document_type = SKIP, document_type_id = SKIP,
               due_date = SKIP, gross_amount_customer_currency = SKIP,
               gross_amount_transaction_currency = SKIP,
               invoice_date = SKIP, invoiced_by = SKIP,
               invoiced_on_behalf_of = SKIP, invoice_id = SKIP,
               invoice_number = SKIP, is_international = SKIP,
               is_national = SKIP, net_amount_customer_currency = SKIP,
               net_amount_transaction_currency = SKIP, payer_id = SKIP,
               payer_number = SKIP, payment_terms = SKIP,
               payment_terms_id = SKIP, replacement_invoice_id = SKIP,
               reversal_invoice_id = SKIP, status = SKIP,
               summary_document_billing_type = SKIP,
               summary_document_billing_type_id = SKIP,
               summary_document_date = SKIP,
               summary_document_dd_amount = SKIP,
               summary_document_due_date = SKIP, summary_document_id = SKIP,
               summary_document_is_fully_paid = SKIP,
               summary_document_number = SKIP,
               summary_document_paid_amount = SKIP,
               summary_document_so_a_reference_number = SKIP,
                = SKIP,
               transaction_currency_code = SKIP,
               transaction_currency_symbol = SKIP, type = SKIP,
               type_id = SKIP, vat_amount_customer_currency = SKIP,
               vat_amount_transaction_currency = SKIP, vat_country = SKIP,
               vat_country_id = SKIP, vat_country_iso_code = SKIP,
               vat_country_op_co_id = SKIP, document_reference = SKIP,
               additional_documents = SKIP)
  @account_full_name =  unless  == SKIP
  @account_id =  unless  == SKIP
  @account_number =  unless  == SKIP
  @account_short_name =  unless  == SKIP
  @col_co_id = col_co_id unless col_co_id == SKIP
  @col_co_op_co_id = col_co_op_co_id unless col_co_op_co_id == SKIP
  unless current_billing_frequency == SKIP
    @current_billing_frequency =
      current_billing_frequency
  end
  unless current_billing_frequency_id == SKIP
    @current_billing_frequency_id =
      current_billing_frequency_id
  end
  unless current_distribution_method == SKIP
    @current_distribution_method =
      current_distribution_method
  end
  unless current_distribution_method_id == SKIP
    @current_distribution_method_id =
      current_distribution_method_id
  end
  @customer_currency_code = customer_currency_code unless customer_currency_code == SKIP
  @customer_currency_symbol = customer_currency_symbol unless customer_currency_symbol == SKIP
  @del_co_client_number = del_co_client_number unless del_co_client_number == SKIP
  @del_co_id = del_co_id unless del_co_id == SKIP
  @del_co_op_co_id = del_co_op_co_id unless del_co_op_co_id == SKIP
  @document_type = document_type unless document_type == SKIP
  @document_type_id = document_type_id unless document_type_id == SKIP
  @due_date = due_date unless due_date == SKIP
  unless gross_amount_customer_currency == SKIP
    @gross_amount_customer_currency =
      gross_amount_customer_currency
  end
  unless gross_amount_transaction_currency == SKIP
    @gross_amount_transaction_currency =
      gross_amount_transaction_currency
  end
  @invoice_date = invoice_date unless invoice_date == SKIP
  @invoiced_by = invoiced_by unless invoiced_by == SKIP
  @invoiced_on_behalf_of = invoiced_on_behalf_of unless invoiced_on_behalf_of == SKIP
  @invoice_id = invoice_id unless invoice_id == SKIP
  @invoice_number = invoice_number unless invoice_number == SKIP
  @is_international = is_international unless is_international == SKIP
  @is_national = is_national unless is_national == SKIP
  unless net_amount_customer_currency == SKIP
    @net_amount_customer_currency =
      net_amount_customer_currency
  end
  unless net_amount_transaction_currency == SKIP
    @net_amount_transaction_currency =
      net_amount_transaction_currency
  end
  @payer_id = payer_id unless payer_id == SKIP
  @payer_number = payer_number unless payer_number == SKIP
  @payment_terms = payment_terms unless payment_terms == SKIP
  @payment_terms_id = payment_terms_id unless payment_terms_id == SKIP
  @replacement_invoice_id = replacement_invoice_id unless replacement_invoice_id == SKIP
  @reversal_invoice_id = reversal_invoice_id unless reversal_invoice_id == SKIP
  @status = status unless status == SKIP
  unless summary_document_billing_type == SKIP
    @summary_document_billing_type =
      summary_document_billing_type
  end
  unless summary_document_billing_type_id == SKIP
    @summary_document_billing_type_id =
      summary_document_billing_type_id
  end
  @summary_document_date = summary_document_date unless summary_document_date == SKIP
  unless summary_document_dd_amount == SKIP
    @summary_document_dd_amount =
      summary_document_dd_amount
  end
  unless summary_document_due_date == SKIP
    @summary_document_due_date =
      summary_document_due_date
  end
  @summary_document_id = summary_document_id unless summary_document_id == SKIP
  unless summary_document_is_fully_paid == SKIP
    @summary_document_is_fully_paid =
      summary_document_is_fully_paid
  end
  @summary_document_number = summary_document_number unless summary_document_number == SKIP
  unless summary_document_paid_amount == SKIP
    @summary_document_paid_amount =
      summary_document_paid_amount
  end
  unless summary_document_so_a_reference_number == SKIP
    @summary_document_so_a_reference_number =
      summary_document_so_a_reference_number
  end
  unless  == SKIP
    @summary_document_statement_of_account_id =
      
  end
  unless transaction_currency_code == SKIP
    @transaction_currency_code =
      transaction_currency_code
  end
  unless transaction_currency_symbol == SKIP
    @transaction_currency_symbol =
      transaction_currency_symbol
  end
  @type = type unless type == SKIP
  @type_id = type_id unless type_id == SKIP
  unless vat_amount_customer_currency == SKIP
    @vat_amount_customer_currency =
      vat_amount_customer_currency
  end
  unless vat_amount_transaction_currency == SKIP
    @vat_amount_transaction_currency =
      vat_amount_transaction_currency
  end
  @vat_country = vat_country unless vat_country == SKIP
  @vat_country_id = vat_country_id unless vat_country_id == SKIP
  @vat_country_iso_code = vat_country_iso_code unless vat_country_iso_code == SKIP
  @vat_country_op_co_id = vat_country_op_co_id unless vat_country_op_co_id == SKIP
  @document_reference = document_reference unless document_reference == SKIP
  @additional_documents = additional_documents unless additional_documents == SKIP
end

Instance Attribute Details

#account_full_name ⇒ String

Account Full Name Example: AT_reversal customer_FN

Returns:

  • (String) 


15
16
17
 
# File 'lib/shell_data_reporting_ap_is/models/invoice_search_details.rb', line 15

def 
  @account_full_name
end

#account_id ⇒ Integer

Account ID Example: 29484

Returns:

  • (Integer) 


20
21
22
 
# File 'lib/shell_data_reporting_ap_is/models/invoice_search_details.rb', line 20

def 
  @account_id
end

#account_number ⇒ String

Account Number Example: GB99215176

Returns:

  • (String) 


25
26
27
 
# File 'lib/shell_data_reporting_ap_is/models/invoice_search_details.rb', line 25

def 
  @account_number
end

#account_short_name ⇒ String

Account Short Name Example: AT Earth Movers-SN

Returns:

  • (String) 


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

def 
  @account_short_name
end

#additional_documents ⇒ Array[InvoiceSearchAdditionalDocument]

document reference number of the Invoice file

Returns:



358
359
360
 
# File 'lib/shell_data_reporting_ap_is/models/invoice_search_details.rb', line 358

def additional_documents
  @additional_documents
end

#col_co_id ⇒ Integer

ColCo Id. Example: 18

Returns:

  • (Integer) 


35
36
37
 
# File 'lib/shell_data_reporting_ap_is/models/invoice_search_details.rb', line 35

def col_co_id
  @col_co_id
end

#col_co_op_co_id ⇒ String

ColCo’s OpCo Id. Example: 018

Returns:

  • (String) 


40
41
42
 
# File 'lib/shell_data_reporting_ap_is/models/invoice_search_details.rb', line 40

def col_co_op_co_id
  @col_co_op_co_id
end

#current_billing_frequency ⇒ String

Current billing frequency of the account. A few of the possible IDs and Description are below: 1 Daily (all days) 2 Daily (only working days) 3 Weekly - Monday 4 Weekly - Tuesday 5 Weekly - Wednesday 6 Weekly - Thursday 7 Weekly - Friday 8 Weekly - Saturday 9 Weekly - Sunday 10 Monthly - 1st Example: Weekly – Wednesday

Returns:

  • (String) 


56
57
58
 
# File 'lib/shell_data_reporting_ap_is/models/invoice_search_details.rb', line 56

def current_billing_frequency
  @current_billing_frequency
end

#current_billing_frequency_id ⇒ Integer

Current billing frequency id of the account. A few of the possible IDs and Description are below: 1 Daily (all days) 2 Daily (only working days) 3 Weekly - Monday 4 Weekly - Tuesday 5 Weekly - Wednesday 6 Weekly - Thursday 7 Weekly - Friday 8 Weekly - Saturday 9 Weekly - Sunday 10 Monthly - 1st Example: 5

Returns:

  • (Integer) 


72
73
74
 
# File 'lib/shell_data_reporting_ap_is/models/invoice_search_details.rb', line 72

def current_billing_frequency_id
  @current_billing_frequency_id
end

#current_distribution_method ⇒ String

Current distribution method name of the account. Example : Id & Description 1 e-mail 2 Fax 3 Courier to Customer 4 Courier to Client 5 Print 6 FTP 7 SMS

Returns:

  • (String) 


84
85
86
 
# File 'lib/shell_data_reporting_ap_is/models/invoice_search_details.rb', line 84

def current_distribution_method
  @current_distribution_method
end

#current_distribution_method_id ⇒ Integer

Current distribution method id of the account. Example : Id & Description 1 e-mail 2 Fax 3 Courier to Customer 4 Courier to Client 5 Print 6 FTP 7 SMS

Returns:

  • (Integer) 


96
97
98
 
# File 'lib/shell_data_reporting_ap_is/models/invoice_search_details.rb', line 96

def current_distribution_method_id
  @current_distribution_method_id
end

#customer_currency_code ⇒ String

Customer currency ISO code. Example: EUR

Returns:

  • (String) 


101
102
103
 
# File 'lib/shell_data_reporting_ap_is/models/invoice_search_details.rb', line 101

def customer_currency_code
  @customer_currency_code
end

#customer_currency_symbol ⇒ String

Customer currency code. Example: €

Returns:

  • (String) 


106
107
108
 
# File 'lib/shell_data_reporting_ap_is/models/invoice_search_details.rb', line 106

def customer_currency_symbol
  @customer_currency_symbol
end

#del_co_client_number ⇒ String

DelCo’s client company number. Example: 132

Returns:

  • (String) 


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

def del_co_client_number
  @del_co_client_number
end

#del_co_id ⇒ Integer

DelCo Id. Example: 132

Returns:

  • (Integer) 


116
117
118
 
# File 'lib/shell_data_reporting_ap_is/models/invoice_search_details.rb', line 116

def del_co_id
  @del_co_id
end

#del_co_op_co_id ⇒ String

DelCo’s OpCo Id. Example: 032

Returns:

  • (String) 


121
122
123
 
# File 'lib/shell_data_reporting_ap_is/models/invoice_search_details.rb', line 121

def del_co_op_co_id
  @del_co_op_co_id
end

#document_reference ⇒ String

document reference number of the Invoice file

Returns:

  • (String) 


354
355
356
 
# File 'lib/shell_data_reporting_ap_is/models/invoice_search_details.rb', line 354

def document_reference
  @document_reference
end

#document_type ⇒ String

Document type Id description.

Returns:

  • (String) 


125
126
127
 
# File 'lib/shell_data_reporting_ap_is/models/invoice_search_details.rb', line 125

def document_type
  @document_type
end

#document_type_id ⇒ Integer

Document type Id.

Returns:

  • (Integer) 


129
130
131
 
# File 'lib/shell_data_reporting_ap_is/models/invoice_search_details.rb', line 129

def document_type_id
  @document_type_id
end

#due_date ⇒ String

Due date. Format: yyyyMMdd. Example: 20170115

Returns:

  • (String) 


134
135
136
 
# File 'lib/shell_data_reporting_ap_is/models/invoice_search_details.rb', line 134

def due_date
  @due_date
end

#gross_amount_customer_currency ⇒ Float

Gross amount in customer currency in the document.

Returns:

  • (Float) 


138
139
140
 
# File 'lib/shell_data_reporting_ap_is/models/invoice_search_details.rb', line 138

def gross_amount_customer_currency
  @gross_amount_customer_currency
end

#gross_amount_transaction_currency ⇒ Float

Gross amount in transaction currency in the document

Returns:

  • (Float) 


142
143
144
 
# File 'lib/shell_data_reporting_ap_is/models/invoice_search_details.rb', line 142

def gross_amount_transaction_currency
  @gross_amount_transaction_currency
end

#invoice_date ⇒ String

Invoicing date. Format: yyyyMMdd Example: 20170101

Returns:

  • (String) 


147
148
149
 
# File 'lib/shell_data_reporting_ap_is/models/invoice_search_details.rb', line 147

def invoice_date
  @invoice_date
end

#invoice_id ⇒ Integer

Invoice id. Example: 1

Returns:

  • (Integer) 


161
162
163
 
# File 'lib/shell_data_reporting_ap_is/models/invoice_search_details.rb', line 161

def invoice_id
  @invoice_id
end

#invoice_number ⇒ String

Invoice number. Example: 0123456789

Returns:

  • (String) 


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

def invoice_number
  @invoice_number
end

#invoiced_by ⇒ String

Company name.

Returns:

  • (String) 


151
152
153
 
# File 'lib/shell_data_reporting_ap_is/models/invoice_search_details.rb', line 151

def invoiced_by
  @invoiced_by
end

#invoiced_on_behalf_of ⇒ String

Country Name. Example: Czech Republic

Returns:

  • (String) 


156
157
158
 
# File 'lib/shell_data_reporting_ap_is/models/invoice_search_details.rb', line 156

def invoiced_on_behalf_of
  @invoiced_on_behalf_of
end

#is_international ⇒ TrueClass | FalseClass

True/False. True if this is an International invoice, else false.

Returns:

  • (TrueClass | FalseClass) 


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

def is_international
  @is_international
end

#is_national ⇒ TrueClass | FalseClass

True/False. True if this is a National invoice, else false.

Returns:

  • (TrueClass | FalseClass) 


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

def is_national
  @is_national
end

#net_amount_customer_currency ⇒ Float

Net amount in customer currency in the document.

Returns:

  • (Float) 


180
181
182
 
# File 'lib/shell_data_reporting_ap_is/models/invoice_search_details.rb', line 180

def net_amount_customer_currency
  @net_amount_customer_currency
end

#net_amount_transaction_currency ⇒ Float

Net amount in transaction currency in the document.

Returns:

  • (Float) 


184
185
186
 
# File 'lib/shell_data_reporting_ap_is/models/invoice_search_details.rb', line 184

def net_amount_transaction_currency
  @net_amount_transaction_currency
end

#payer_id ⇒ Integer

Payment customer id of the customer. Example: 123456

Returns:

  • (Integer) 


189
190
191
 
# File 'lib/shell_data_reporting_ap_is/models/invoice_search_details.rb', line 189

def payer_id
  @payer_id
end

#payer_number ⇒ String

Payment customer number. Example: GB000000123

Returns:

  • (String) 


194
195
196
 
# File 'lib/shell_data_reporting_ap_is/models/invoice_search_details.rb', line 194

def payer_number
  @payer_number
end

#payment_terms ⇒ String

A few of the possible IDs and Descriptions are below: 1 14 days after Invoice 2 15 days after Invoice 3 21 days after Invoice 4 30 days after Invoice 5 45 days after Invoice

Returns:

  • (String) 


203
204
205
 
# File 'lib/shell_data_reporting_ap_is/models/invoice_search_details.rb', line 203

def payment_terms
  @payment_terms
end

#payment_terms_id ⇒ Integer

Payment terms id of the payment customer. A few of the possible IDs and Descriptions are below: 1 14 days after Invoice 2 15 days after Invoice 3 21 days after Invoice 4 30 days after Invoice 5 45 days after Invoice

Returns:

  • (Integer) 


213
214
215
 
# File 'lib/shell_data_reporting_ap_is/models/invoice_search_details.rb', line 213

def payment_terms_id
  @payment_terms_id
end

#replacement_invoice_id ⇒ Integer

Replaced document id. Example: 2

Returns:

  • (Integer) 


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

def replacement_invoice_id
  @replacement_invoice_id
end

#reversal_invoice_id ⇒ Integer

Reversed document id. Example: 3

Returns:

  • (Integer) 


223
224
225
 
# File 'lib/shell_data_reporting_ap_is/models/invoice_search_details.rb', line 223

def reversal_invoice_id
  @reversal_invoice_id
end

#status ⇒ String

Status of the document. Valid values – • [Empty] – For all document types except for Invoice and Statement. • Due – Invoices/Statements due for payment and is within the due date. • Paid – Fully paid Invoices/Statements. Overdue – Invoices/Statements due of payment and has crossed the due date.

Returns:

  • (String) 


231
232
233
 
# File 'lib/shell_data_reporting_ap_is/models/invoice_search_details.rb', line 231

def status
  @status
end

#summary_document_billing_type ⇒ String

Billing type description. Example: Id & Description -3 Guarantee History -1 Initial Balance 0 Standard Invoice 1 Immediate Invoice 2 Guarantee 4 Advanced DD Invoice

Returns:

  • (String) 


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

def summary_document_billing_type
  @summary_document_billing_type
end

#summary_document_billing_type_id ⇒ Integer

Billing type id. Example: Id & Description -3 Guarantee History -1 Initial Balance 0 Standard Invoice 1 Immediate Invoice 2 Guarantee 4 Advanced DD Invoice

Returns:

  • (Integer) 


253
254
255
 
# File 'lib/shell_data_reporting_ap_is/models/invoice_search_details.rb', line 253

def summary_document_billing_type_id
  @summary_document_billing_type_id
end

#summary_document_date ⇒ String

Document generated date. Format: yyyyMMdd Example: 20170101

Returns:

  • (String) 


258
259
260
 
# File 'lib/shell_data_reporting_ap_is/models/invoice_search_details.rb', line 258

def summary_document_date
  @summary_document_date
end

#summary_document_dd_amount ⇒ Float

DD amount.

Returns:

  • (Float) 


262
263
264
 
# File 'lib/shell_data_reporting_ap_is/models/invoice_search_details.rb', line 262

def summary_document_dd_amount
  @summary_document_dd_amount
end

#summary_document_due_date ⇒ String

Due date for document. Format: yyyyMMdd Example: 20170115

Returns:

  • (String) 


267
268
269
 
# File 'lib/shell_data_reporting_ap_is/models/invoice_search_details.rb', line 267

def summary_document_due_date
  @summary_document_due_date
end

#summary_document_id ⇒ Integer

Summary document identifier Example: 1

Returns:

  • (Integer) 


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

def summary_document_id
  @summary_document_id
end

#summary_document_is_fully_paid ⇒ TrueClass | FalseClass

True/False True if invoice amount is fully paid, else false

Returns:

  • (TrueClass | FalseClass) 


277
278
279
 
# File 'lib/shell_data_reporting_ap_is/models/invoice_search_details.rb', line 277

def summary_document_is_fully_paid
  @summary_document_is_fully_paid
end

#summary_document_number ⇒ String

Summary document number Example: ‘0/CZ0000000123456/2017’

Returns:

  • (String) 


282
283
284
 
# File 'lib/shell_data_reporting_ap_is/models/invoice_search_details.rb', line 282

def summary_document_number
  @summary_document_number
end

#summary_document_paid_amount ⇒ Float

Total amount paid.

Returns:

  • (Float) 


286
287
288
 
# File 'lib/shell_data_reporting_ap_is/models/invoice_search_details.rb', line 286

def summary_document_paid_amount
  @summary_document_paid_amount
end

#summary_document_so_a_reference_number ⇒ String

Statement of Account reference number of the payment customer.

Returns:

  • (String) 


290
291
292
 
# File 'lib/shell_data_reporting_ap_is/models/invoice_search_details.rb', line 290

def summary_document_so_a_reference_number
  @summary_document_so_a_reference_number
end

#summary_document_statement_of_account_id ⇒ Integer

Statement of Account Id of the payment customer.

Returns:

  • (Integer) 


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

def 
  @summary_document_statement_of_account_id
end

#transaction_currency_code ⇒ String

Transaction currency ISO code. Example: EUR

Returns:

  • (String) 


299
300
301
 
# File 'lib/shell_data_reporting_ap_is/models/invoice_search_details.rb', line 299

def transaction_currency_code
  @transaction_currency_code
end

#transaction_currency_symbol ⇒ String

Transaction currency symbol. Example: €

Returns:

  • (String) 


304
305
306
 
# File 'lib/shell_data_reporting_ap_is/models/invoice_search_details.rb', line 304

def transaction_currency_symbol
  @transaction_currency_symbol
end

#type ⇒ String

Invoice type description. A few of the possible IDs and Description are below: 1 Original 2 Reversal 3 Replacement Example: Original

Returns:

  • (String) 


313
314
315
 
# File 'lib/shell_data_reporting_ap_is/models/invoice_search_details.rb', line 313

def type
  @type
end

#type_id ⇒ Integer

Invoice type id. A few of the possible IDs and Descriptions are below: 1 Original 2 Reversal 3 Replacement Example: 1

Returns:

  • (Integer) 


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

def type_id
  @type_id
end

#vat_amount_customer_currency ⇒ Float

VAT amount in customer currency in the document

Returns:

  • (Float) 


326
327
328
 
# File 'lib/shell_data_reporting_ap_is/models/invoice_search_details.rb', line 326

def vat_amount_customer_currency
  @vat_amount_customer_currency
end

#vat_amount_transaction_currency ⇒ Float

VAT amount in transaction currency in the document

Returns:

  • (Float) 


330
331
332
 
# File 'lib/shell_data_reporting_ap_is/models/invoice_search_details.rb', line 330

def vat_amount_transaction_currency
  @vat_amount_transaction_currency
end

#vat_country ⇒ String

Country name of the VAT country. Example: France, Germany

Returns:

  • (String) 


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

def vat_country
  @vat_country
end

#vat_country_id ⇒ Integer

Country Id of the VAT country. Example: 1,2

Returns:

  • (Integer) 


340
341
342
 
# File 'lib/shell_data_reporting_ap_is/models/invoice_search_details.rb', line 340

def vat_country_id
  @vat_country_id
end

#vat_country_iso_code ⇒ String

Country ISO code of the VAT country. Example : CZ, SK, UK, etc.,

Returns:

  • (String) 


345
346
347
 
# File 'lib/shell_data_reporting_ap_is/models/invoice_search_details.rb', line 345

def vat_country_iso_code
  @vat_country_iso_code
end

#vat_country_op_co_id ⇒ String

VAT country’s OpCo Id. Example: 032

Returns:

  • (String) 


350
351
352
 
# File 'lib/shell_data_reporting_ap_is/models/invoice_search_details.rb', line 350

def vat_country_op_co_id
  @vat_country_op_co_id
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



720
721
722
723
724
725
726
727
728
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
820
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
 
# File 'lib/shell_data_reporting_ap_is/models/invoice_search_details.rb', line 720

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
   =
    hash.key?('AccountFullName') ? hash['AccountFullName'] : SKIP
   = hash.key?('AccountId') ? hash['AccountId'] : SKIP
   = hash.key?('AccountNumber') ? hash['AccountNumber'] : SKIP
   =
    hash.key?('AccountShortName') ? hash['AccountShortName'] : SKIP
  col_co_id = hash.key?('ColCoId') ? hash['ColCoId'] : SKIP
  col_co_op_co_id = hash.key?('ColCoOpCoId') ? hash['ColCoOpCoId'] : SKIP
  current_billing_frequency =
    hash.key?('CurrentBillingFrequency') ? hash['CurrentBillingFrequency'] : SKIP
  current_billing_frequency_id =
    hash.key?('CurrentBillingFrequencyId') ? hash['CurrentBillingFrequencyId'] : SKIP
  current_distribution_method =
    hash.key?('CurrentDistributionMethod') ? hash['CurrentDistributionMethod'] : SKIP
  current_distribution_method_id =
    hash.key?('CurrentDistributionMethodId') ? hash['CurrentDistributionMethodId'] : SKIP
  customer_currency_code =
    hash.key?('CustomerCurrencyCode') ? hash['CustomerCurrencyCode'] : SKIP
  customer_currency_symbol =
    hash.key?('CustomerCurrencySymbol') ? hash['CustomerCurrencySymbol'] : SKIP
  del_co_client_number =
    hash.key?('DelCoClientNumber') ? hash['DelCoClientNumber'] : SKIP
  del_co_id = hash.key?('DelCoId') ? hash['DelCoId'] : SKIP
  del_co_op_co_id = hash.key?('DelCoOpCoId') ? hash['DelCoOpCoId'] : SKIP
  document_type = hash.key?('DocumentType') ? hash['DocumentType'] : SKIP
  document_type_id =
    hash.key?('DocumentTypeId') ? hash['DocumentTypeId'] : SKIP
  due_date = hash.key?('DueDate') ? hash['DueDate'] : SKIP
  gross_amount_customer_currency =
    hash.key?('GrossAmountCustomerCurrency') ? hash['GrossAmountCustomerCurrency'] : SKIP
  gross_amount_transaction_currency =
    hash.key?('GrossAmountTransactionCurrency') ? hash['GrossAmountTransactionCurrency'] : SKIP
  invoice_date = hash.key?('InvoiceDate') ? hash['InvoiceDate'] : SKIP
  invoiced_by = hash.key?('InvoicedBy') ? hash['InvoicedBy'] : SKIP
  invoiced_on_behalf_of =
    hash.key?('InvoicedOnBehalfOf') ? hash['InvoicedOnBehalfOf'] : SKIP
  invoice_id = hash.key?('InvoiceId') ? hash['InvoiceId'] : SKIP
  invoice_number = hash.key?('InvoiceNumber') ? hash['InvoiceNumber'] : SKIP
  is_international =
    hash.key?('IsInternational') ? hash['IsInternational'] : SKIP
  is_national = hash.key?('IsNational') ? hash['IsNational'] : SKIP
  net_amount_customer_currency =
    hash.key?('NetAmountCustomerCurrency') ? hash['NetAmountCustomerCurrency'] : SKIP
  net_amount_transaction_currency =
    hash.key?('NetAmountTransactionCurrency') ? hash['NetAmountTransactionCurrency'] : SKIP
  payer_id = hash.key?('PayerId') ? hash['PayerId'] : SKIP
  payer_number = hash.key?('PayerNumber') ? hash['PayerNumber'] : SKIP
  payment_terms = hash.key?('PaymentTerms') ? hash['PaymentTerms'] : SKIP
  payment_terms_id =
    hash.key?('PaymentTermsId') ? hash['PaymentTermsId'] : SKIP
  replacement_invoice_id =
    hash.key?('ReplacementInvoiceId') ? hash['ReplacementInvoiceId'] : SKIP
  reversal_invoice_id =
    hash.key?('ReversalInvoiceId') ? hash['ReversalInvoiceId'] : SKIP
  status = hash.key?('Status') ? hash['Status'] : SKIP
  summary_document_billing_type =
    hash.key?('SummaryDocumentBillingType') ? hash['SummaryDocumentBillingType'] : SKIP
  summary_document_billing_type_id =
    hash.key?('SummaryDocumentBillingTypeId') ? hash['SummaryDocumentBillingTypeId'] : SKIP
  summary_document_date =
    hash.key?('SummaryDocumentDate') ? hash['SummaryDocumentDate'] : SKIP
  summary_document_dd_amount =
    hash.key?('SummaryDocumentDDAmount') ? hash['SummaryDocumentDDAmount'] : SKIP
  summary_document_due_date =
    hash.key?('SummaryDocumentDueDate') ? hash['SummaryDocumentDueDate'] : SKIP
  summary_document_id =
    hash.key?('SummaryDocumentId') ? hash['SummaryDocumentId'] : SKIP
  summary_document_is_fully_paid =
    hash.key?('SummaryDocumentIsFullyPaid') ? hash['SummaryDocumentIsFullyPaid'] : SKIP
  summary_document_number =
    hash.key?('SummaryDocumentNumber') ? hash['SummaryDocumentNumber'] : SKIP
  summary_document_paid_amount =
    hash.key?('SummaryDocumentPaidAmount') ? hash['SummaryDocumentPaidAmount'] : SKIP
  summary_document_so_a_reference_number =
    hash.key?('SummaryDocumentSoAReferenceNumber') ? hash['SummaryDocumentSoAReferenceNumber'] : SKIP
   =
    hash.key?('SummaryDocumentStatementOfAccountId') ? hash['SummaryDocumentStatementOfAccountId'] : SKIP
  transaction_currency_code =
    hash.key?('TransactionCurrencyCode') ? hash['TransactionCurrencyCode'] : SKIP
  transaction_currency_symbol =
    hash.key?('TransactionCurrencySymbol') ? hash['TransactionCurrencySymbol'] : SKIP
  type = hash.key?('Type') ? hash['Type'] : SKIP
  type_id = hash.key?('TypeId') ? hash['TypeId'] : SKIP
  vat_amount_customer_currency =
    hash.key?('VATAmountCustomerCurrency') ? hash['VATAmountCustomerCurrency'] : SKIP
  vat_amount_transaction_currency =
    hash.key?('VATAmountTransactionCurrency') ? hash['VATAmountTransactionCurrency'] : SKIP
  vat_country = hash.key?('VATCountry') ? hash['VATCountry'] : SKIP
  vat_country_id = hash.key?('VATCountryId') ? hash['VATCountryId'] : SKIP
  vat_country_iso_code =
    hash.key?('VATCountryISOCode') ? hash['VATCountryISOCode'] : SKIP
  vat_country_op_co_id =
    hash.key?('VATCountryOpCoId') ? hash['VATCountryOpCoId'] : SKIP
  document_reference =
    hash.key?('DocumentReference') ? hash['DocumentReference'] : SKIP
  # Parameter is an array, so we need to iterate through it
  additional_documents = nil
  unless hash['AdditionalDocuments'].nil?
    additional_documents = []
    hash['AdditionalDocuments'].each do |structure|
      additional_documents << (InvoiceSearchAdditionalDocument.from_hash(structure) if structure)
    end
  end

  additional_documents = SKIP unless hash.key?('AdditionalDocuments')

  # Create object from extracted values.
  InvoiceSearchDetails.new(,
                           ,
                           ,
                           ,
                           col_co_id,
                           col_co_op_co_id,
                           current_billing_frequency,
                           current_billing_frequency_id,
                           current_distribution_method,
                           current_distribution_method_id,
                           customer_currency_code,
                           customer_currency_symbol,
                           del_co_client_number,
                           del_co_id,
                           del_co_op_co_id,
                           document_type,
                           document_type_id,
                           due_date,
                           gross_amount_customer_currency,
                           gross_amount_transaction_currency,
                           invoice_date,
                           invoiced_by,
                           invoiced_on_behalf_of,
                           invoice_id,
                           invoice_number,
                           is_international,
                           is_national,
                           net_amount_customer_currency,
                           net_amount_transaction_currency,
                           payer_id,
                           payer_number,
                           payment_terms,
                           payment_terms_id,
                           replacement_invoice_id,
                           reversal_invoice_id,
                           status,
                           summary_document_billing_type,
                           summary_document_billing_type_id,
                           summary_document_date,
                           summary_document_dd_amount,
                           summary_document_due_date,
                           summary_document_id,
                           summary_document_is_fully_paid,
                           summary_document_number,
                           summary_document_paid_amount,
                           summary_document_so_a_reference_number,
                           ,
                           transaction_currency_code,
                           transaction_currency_symbol,
                           type,
                           type_id,
                           vat_amount_customer_currency,
                           vat_amount_transaction_currency,
                           vat_country,
                           vat_country_id,
                           vat_country_iso_code,
                           vat_country_op_co_id,
                           document_reference,
                           additional_documents)
end

.names ⇒ Object

A mapping from model property names to API property names.



361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
 
# File 'lib/shell_data_reporting_ap_is/models/invoice_search_details.rb', line 361

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['account_full_name'] = 'AccountFullName'
  @_hash['account_id'] = 'AccountId'
  @_hash['account_number'] = 'AccountNumber'
  @_hash['account_short_name'] = 'AccountShortName'
  @_hash['col_co_id'] = 'ColCoId'
  @_hash['col_co_op_co_id'] = 'ColCoOpCoId'
  @_hash['current_billing_frequency'] = 'CurrentBillingFrequency'
  @_hash['current_billing_frequency_id'] = 'CurrentBillingFrequencyId'
  @_hash['current_distribution_method'] = 'CurrentDistributionMethod'
  @_hash['current_distribution_method_id'] = 'CurrentDistributionMethodId'
  @_hash['customer_currency_code'] = 'CustomerCurrencyCode'
  @_hash['customer_currency_symbol'] = 'CustomerCurrencySymbol'
  @_hash['del_co_client_number'] = 'DelCoClientNumber'
  @_hash['del_co_id'] = 'DelCoId'
  @_hash['del_co_op_co_id'] = 'DelCoOpCoId'
  @_hash['document_type'] = 'DocumentType'
  @_hash['document_type_id'] = 'DocumentTypeId'
  @_hash['due_date'] = 'DueDate'
  @_hash['gross_amount_customer_currency'] = 'GrossAmountCustomerCurrency'
  @_hash['gross_amount_transaction_currency'] =
    'GrossAmountTransactionCurrency'
  @_hash['invoice_date'] = 'InvoiceDate'
  @_hash['invoiced_by'] = 'InvoicedBy'
  @_hash['invoiced_on_behalf_of'] = 'InvoicedOnBehalfOf'
  @_hash['invoice_id'] = 'InvoiceId'
  @_hash['invoice_number'] = 'InvoiceNumber'
  @_hash['is_international'] = 'IsInternational'
  @_hash['is_national'] = 'IsNational'
  @_hash['net_amount_customer_currency'] = 'NetAmountCustomerCurrency'
  @_hash['net_amount_transaction_currency'] =
    'NetAmountTransactionCurrency'
  @_hash['payer_id'] = 'PayerId'
  @_hash['payer_number'] = 'PayerNumber'
  @_hash['payment_terms'] = 'PaymentTerms'
  @_hash['payment_terms_id'] = 'PaymentTermsId'
  @_hash['replacement_invoice_id'] = 'ReplacementInvoiceId'
  @_hash['reversal_invoice_id'] = 'ReversalInvoiceId'
  @_hash['status'] = 'Status'
  @_hash['summary_document_billing_type'] = 'SummaryDocumentBillingType'
  @_hash['summary_document_billing_type_id'] =
    'SummaryDocumentBillingTypeId'
  @_hash['summary_document_date'] = 'SummaryDocumentDate'
  @_hash['summary_document_dd_amount'] = 'SummaryDocumentDDAmount'
  @_hash['summary_document_due_date'] = 'SummaryDocumentDueDate'
  @_hash['summary_document_id'] = 'SummaryDocumentId'
  @_hash['summary_document_is_fully_paid'] = 'SummaryDocumentIsFullyPaid'
  @_hash['summary_document_number'] = 'SummaryDocumentNumber'
  @_hash['summary_document_paid_amount'] = 'SummaryDocumentPaidAmount'
  @_hash['summary_document_so_a_reference_number'] =
    'SummaryDocumentSoAReferenceNumber'
  @_hash['summary_document_statement_of_account_id'] =
    'SummaryDocumentStatementOfAccountId'
  @_hash['transaction_currency_code'] = 'TransactionCurrencyCode'
  @_hash['transaction_currency_symbol'] = 'TransactionCurrencySymbol'
  @_hash['type'] = 'Type'
  @_hash['type_id'] = 'TypeId'
  @_hash['vat_amount_customer_currency'] = 'VATAmountCustomerCurrency'
  @_hash['vat_amount_transaction_currency'] =
    'VATAmountTransactionCurrency'
  @_hash['vat_country'] = 'VATCountry'
  @_hash['vat_country_id'] = 'VATCountryId'
  @_hash['vat_country_iso_code'] = 'VATCountryISOCode'
  @_hash['vat_country_op_co_id'] = 'VATCountryOpCoId'
  @_hash['document_reference'] = 'DocumentReference'
  @_hash['additional_documents'] = 'AdditionalDocuments'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



497
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
 
# File 'lib/shell_data_reporting_ap_is/models/invoice_search_details.rb', line 497

def self.nullables
  %w[
    account_full_name
    account_id
    account_number
    account_short_name
    col_co_id
    col_co_op_co_id
    current_billing_frequency
    current_billing_frequency_id
    current_distribution_method
    current_distribution_method_id
    customer_currency_code
    customer_currency_symbol
    del_co_client_number
    del_co_id
    del_co_op_co_id
    document_type
    document_type_id
    due_date
    gross_amount_customer_currency
    gross_amount_transaction_currency
    invoice_date
    invoiced_by
    invoiced_on_behalf_of
    invoice_id
    invoice_number
    is_international
    is_national
    net_amount_customer_currency
    net_amount_transaction_currency
    payer_id
    payer_number
    payment_terms
    payment_terms_id
    replacement_invoice_id
    reversal_invoice_id
    status
    summary_document_billing_type
    summary_document_billing_type_id
    summary_document_date
    summary_document_dd_amount
    summary_document_due_date
    summary_document_id
    summary_document_is_fully_paid
    summary_document_number
    summary_document_paid_amount
    summary_document_so_a_reference_number
    summary_document_statement_of_account_id
    transaction_currency_code
    transaction_currency_symbol
    type
    type_id
    vat_amount_customer_currency
    vat_amount_transaction_currency
    vat_country
    vat_country_id
    vat_country_iso_code
    vat_country_op_co_id
    document_reference
  ]
end

.optionals ⇒ Object

An array for optional fields



432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
 
# File 'lib/shell_data_reporting_ap_is/models/invoice_search_details.rb', line 432

def self.optionals
  %w[
    account_full_name
    account_id
    account_number
    account_short_name
    col_co_id
    col_co_op_co_id
    current_billing_frequency
    current_billing_frequency_id
    current_distribution_method
    current_distribution_method_id
    customer_currency_code
    customer_currency_symbol
    del_co_client_number
    del_co_id
    del_co_op_co_id
    document_type
    document_type_id
    due_date
    gross_amount_customer_currency
    gross_amount_transaction_currency
    invoice_date
    invoiced_by
    invoiced_on_behalf_of
    invoice_id
    invoice_number
    is_international
    is_national
    net_amount_customer_currency
    net_amount_transaction_currency
    payer_id
    payer_number
    payment_terms
    payment_terms_id
    replacement_invoice_id
    reversal_invoice_id
    status
    summary_document_billing_type
    summary_document_billing_type_id
    summary_document_date
    summary_document_dd_amount
    summary_document_due_date
    summary_document_id
    summary_document_is_fully_paid
    summary_document_number
    summary_document_paid_amount
    summary_document_so_a_reference_number
    summary_document_statement_of_account_id
    transaction_currency_code
    transaction_currency_symbol
    type
    type_id
    vat_amount_customer_currency
    vat_amount_transaction_currency
    vat_country
    vat_country_id
    vat_country_iso_code
    vat_country_op_co_id
    document_reference
    additional_documents
  ]
end