Class: Mindee::Product::Invoice::InvoiceV4Document

Inherits:
Mindee::Parsing::Common::Prediction show all
Includes:
Mindee::Parsing::Standard
Defined in:
lib/mindee/product/invoice/invoice_v4_document.rb

Overview

Invoice API version 4.9 document data.

Direct Known Subclasses

InvoiceV4PagePrediction

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(prediction, page_id) ⇒ InvoiceV4Document

Returns a new instance of InvoiceV4Document.

Parameters:

  • prediction (Hash)
  • page_id (Integer, nil) 


93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
 
# File 'lib/mindee/product/invoice/invoice_v4_document.rb', line 93

def initialize(prediction, page_id)
  super
  @billing_address = Parsing::Standard::StringField.new(
    prediction['billing_address'],
    page_id
  )
  @customer_address = Parsing::Standard::StringField.new(
    prediction['customer_address'],
    page_id
  )
  @customer_company_registrations = [] # : Array[Parsing::Standard::CompanyRegistrationField]
  prediction['customer_company_registrations'].each do |item|
    @customer_company_registrations.push(Parsing::Standard::CompanyRegistrationField.new(item, page_id))
  end
  @customer_id = Parsing::Standard::StringField.new(
    prediction['customer_id'],
    page_id
  )
  @customer_name = Parsing::Standard::StringField.new(
    prediction['customer_name'],
    page_id
  )
  @date = Parsing::Standard::DateField.new(prediction['date'], page_id)
  @document_type = Parsing::Standard::ClassificationField.new(
    prediction['document_type'],
    page_id
  )
  @due_date = Parsing::Standard::DateField.new(
    prediction['due_date'],
    page_id
  )
  @invoice_number = Parsing::Standard::StringField.new(
    prediction['invoice_number'],
    page_id
  )
  @line_items = Product::Invoice::InvoiceV4LineItems.new(prediction['line_items'], page_id)
  @locale = Parsing::Standard::LocaleField.new(
    prediction['locale'],
    page_id
  )
  @payment_date = Parsing::Standard::DateField.new(
    prediction['payment_date'],
    page_id
  )
  @po_number = Parsing::Standard::StringField.new(
    prediction['po_number'],
    page_id
  )
  @reference_numbers = [] # : Array[Parsing::Standard::StringField]
  prediction['reference_numbers'].each do |item|
    @reference_numbers.push(Parsing::Standard::StringField.new(item, page_id))
  end
  @shipping_address = Parsing::Standard::StringField.new(
    prediction['shipping_address'],
    page_id
  )
  @supplier_address = Parsing::Standard::StringField.new(
    prediction['supplier_address'],
    page_id
  )
  @supplier_company_registrations = [] # : Array[Parsing::Standard::CompanyRegistrationField]
  prediction['supplier_company_registrations'].each do |item|
    @supplier_company_registrations.push(Parsing::Standard::CompanyRegistrationField.new(item, page_id))
  end
  @supplier_email = Parsing::Standard::StringField.new(
    prediction['supplier_email'],
    page_id
  )
  @supplier_name = Parsing::Standard::StringField.new(
    prediction['supplier_name'],
    page_id
  )
  @supplier_payment_details = [] # : Array[Parsing::Standard::PaymentDetailsField]
  prediction['supplier_payment_details'].each do |item|
    @supplier_payment_details.push(Parsing::Standard::PaymentDetailsField.new(item, page_id))
  end
  @supplier_phone_number = Parsing::Standard::StringField.new(
    prediction['supplier_phone_number'],
    page_id
  )
  @supplier_website = Parsing::Standard::StringField.new(
    prediction['supplier_website'],
    page_id
  )
  @taxes = Parsing::Standard::Taxes.new(prediction['taxes'], page_id)
  @total_amount = Parsing::Standard::AmountField.new(
    prediction['total_amount'],
    page_id
  )
  @total_net = Parsing::Standard::AmountField.new(
    prediction['total_net'],
    page_id
  )
  @total_tax = Parsing::Standard::AmountField.new(
    prediction['total_tax'],
    page_id
  )
end

Instance Attribute Details

#billing_address ⇒ Mindee::Parsing::Standard::StringField (readonly)

The customer billing address.

Returns:



14
15
16
 
# File 'lib/mindee/product/invoice/invoice_v4_document.rb', line 14

def billing_address
  @billing_address
end

#customer_address ⇒ Mindee::Parsing::Standard::StringField (readonly)

The address of the customer.

Returns:



17
18
19
 
# File 'lib/mindee/product/invoice/invoice_v4_document.rb', line 17

def customer_address
  @customer_address
end

#customer_company_registrations ⇒ Array<Mindee::Parsing::Standard::CompanyRegistrationField> (readonly)

List of company registration numbers associated to the customer.

Returns:



20
21
22
 
# File 'lib/mindee/product/invoice/invoice_v4_document.rb', line 20

def customer_company_registrations
  @customer_company_registrations
end

#customer_id ⇒ Mindee::Parsing::Standard::StringField (readonly)

The customer account number or identifier from the supplier.

Returns:



23
24
25
 
# File 'lib/mindee/product/invoice/invoice_v4_document.rb', line 23

def customer_id
  @customer_id
end

#customer_name ⇒ Mindee::Parsing::Standard::StringField (readonly)

The name of the customer or client.

Returns:



26
27
28
 
# File 'lib/mindee/product/invoice/invoice_v4_document.rb', line 26

def customer_name
  @customer_name
end

#date ⇒ Mindee::Parsing::Standard::DateField (readonly)

The date the purchase was made.

Returns:



29
30
31
 
# File 'lib/mindee/product/invoice/invoice_v4_document.rb', line 29

def date
  @date
end

#document_type ⇒ Mindee::Parsing::Standard::ClassificationField (readonly)

Document type: INVOICE or CREDIT NOTE.

Returns:



32
33
34
 
# File 'lib/mindee/product/invoice/invoice_v4_document.rb', line 32

def document_type
  @document_type
end

#due_date ⇒ Mindee::Parsing::Standard::DateField (readonly)

The date on which the payment is due.

Returns:



35
36
37
 
# File 'lib/mindee/product/invoice/invoice_v4_document.rb', line 35

def due_date
  @due_date
end

#invoice_number ⇒ Mindee::Parsing::Standard::StringField (readonly)

The invoice number or identifier.

Returns:



38
39
40
 
# File 'lib/mindee/product/invoice/invoice_v4_document.rb', line 38

def invoice_number
  @invoice_number
end

#line_items ⇒ Mindee::Product::Invoice::InvoiceV4LineItems (readonly)

List of all the line items present on the invoice.

Returns:



41
42
43
 
# File 'lib/mindee/product/invoice/invoice_v4_document.rb', line 41

def line_items
  @line_items
end

#locale ⇒ Mindee::Parsing::Standard::LocaleField (readonly)

The locale of the document.

Returns:



44
45
46
 
# File 'lib/mindee/product/invoice/invoice_v4_document.rb', line 44

def locale
  @locale
end

#payment_date ⇒ Mindee::Parsing::Standard::DateField (readonly)

The date on which the payment is due / was full-filled.

Returns:



47
48
49
 
# File 'lib/mindee/product/invoice/invoice_v4_document.rb', line 47

def payment_date
  @payment_date
end

#po_number ⇒ Mindee::Parsing::Standard::StringField (readonly)

The purchase order number.

Returns:



50
51
52
 
# File 'lib/mindee/product/invoice/invoice_v4_document.rb', line 50

def po_number
  @po_number
end

#reference_numbers ⇒ Array<Mindee::Parsing::Standard::StringField> (readonly)

List of all reference numbers on the invoice, including the purchase order number.

Returns:



53
54
55
 
# File 'lib/mindee/product/invoice/invoice_v4_document.rb', line 53

def reference_numbers
  @reference_numbers
end

#shipping_address ⇒ Mindee::Parsing::Standard::StringField (readonly)

Customer’s delivery address.

Returns:



56
57
58
 
# File 'lib/mindee/product/invoice/invoice_v4_document.rb', line 56

def shipping_address
  @shipping_address
end

#supplier_address ⇒ Mindee::Parsing::Standard::StringField (readonly)

The address of the supplier or merchant.

Returns:



59
60
61
 
# File 'lib/mindee/product/invoice/invoice_v4_document.rb', line 59

def supplier_address
  @supplier_address
end

#supplier_company_registrations ⇒ Array<Mindee::Parsing::Standard::CompanyRegistrationField> (readonly)

List of company registration numbers associated to the supplier.

Returns:



62
63
64
 
# File 'lib/mindee/product/invoice/invoice_v4_document.rb', line 62

def supplier_company_registrations
  @supplier_company_registrations
end

#supplier_email ⇒ Mindee::Parsing::Standard::StringField (readonly)

The email address of the supplier or merchant.

Returns:



65
66
67
 
# File 'lib/mindee/product/invoice/invoice_v4_document.rb', line 65

def supplier_email
  @supplier_email
end

#supplier_name ⇒ Mindee::Parsing::Standard::StringField (readonly)

The name of the supplier or merchant.

Returns:



68
69
70
 
# File 'lib/mindee/product/invoice/invoice_v4_document.rb', line 68

def supplier_name
  @supplier_name
end

#supplier_payment_details ⇒ Array<Mindee::Parsing::Standard::PaymentDetailsField> (readonly)

List of payment details associated to the supplier of the invoice.

Returns:



71
72
73
 
# File 'lib/mindee/product/invoice/invoice_v4_document.rb', line 71

def supplier_payment_details
  @supplier_payment_details
end

#supplier_phone_number ⇒ Mindee::Parsing::Standard::StringField (readonly)

The phone number of the supplier or merchant.

Returns:



74
75
76
 
# File 'lib/mindee/product/invoice/invoice_v4_document.rb', line 74

def supplier_phone_number
  @supplier_phone_number
end

#supplier_website ⇒ Mindee::Parsing::Standard::StringField (readonly)

The website URL of the supplier or merchant.

Returns:



77
78
79
 
# File 'lib/mindee/product/invoice/invoice_v4_document.rb', line 77

def supplier_website
  @supplier_website
end

#taxes ⇒ Mindee::Parsing::Standard::Taxes (readonly)

List of taxes. Each item contains the detail of the tax.

Returns:



80
81
82
 
# File 'lib/mindee/product/invoice/invoice_v4_document.rb', line 80

def taxes
  @taxes
end

#total_amount ⇒ Mindee::Parsing::Standard::AmountField (readonly)

The total amount of the invoice: includes taxes, tips, fees, and other charges.

Returns:



83
84
85
 
# File 'lib/mindee/product/invoice/invoice_v4_document.rb', line 83

def total_amount
  @total_amount
end

#total_net ⇒ Mindee::Parsing::Standard::AmountField (readonly)

The net amount of the invoice: does not include taxes, fees, and discounts.

Returns:



86
87
88
 
# File 'lib/mindee/product/invoice/invoice_v4_document.rb', line 86

def total_net
  @total_net
end

#total_tax ⇒ Mindee::Parsing::Standard::AmountField (readonly)

The total tax: the sum of all the taxes for this invoice.

Returns:



89
90
91
 
# File 'lib/mindee/product/invoice/invoice_v4_document.rb', line 89

def total_tax
  @total_tax
end

Instance Method Details

#to_s ⇒ String

Returns:

  • (String) 


193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
 
# File 'lib/mindee/product/invoice/invoice_v4_document.rb', line 193

def to_s
  reference_numbers = @reference_numbers.join("\n #{' ' * 19}")
  supplier_payment_details = @supplier_payment_details.join("\n #{' ' * 26}")
  supplier_company_registrations = @supplier_company_registrations.join("\n #{' ' * 32}")
  customer_company_registrations = @customer_company_registrations.join("\n #{' ' * 32}")
  line_items = line_items_to_s
  out_str = String.new
  out_str << "\n:Locale: #{@locale}".rstrip
  out_str << "\n:Invoice Number: #{@invoice_number}".rstrip
  out_str << "\n:Purchase Order Number: #{@po_number}".rstrip
  out_str << "\n:Reference Numbers: #{reference_numbers}".rstrip
  out_str << "\n:Purchase Date: #{@date}".rstrip
  out_str << "\n:Due Date: #{@due_date}".rstrip
  out_str << "\n:Payment Date: #{@payment_date}".rstrip
  out_str << "\n:Total Net: #{@total_net}".rstrip
  out_str << "\n:Total Amount: #{@total_amount}".rstrip
  out_str << "\n:Total Tax: #{@total_tax}".rstrip
  out_str << "\n:Taxes:#{@taxes}".rstrip
  out_str << "\n:Supplier Payment Details: #{supplier_payment_details}".rstrip
  out_str << "\n:Supplier Name: #{@supplier_name}".rstrip
  out_str << "\n:Supplier Company Registrations: #{supplier_company_registrations}".rstrip
  out_str << "\n:Supplier Address: #{@supplier_address}".rstrip
  out_str << "\n:Supplier Phone Number: #{@supplier_phone_number}".rstrip
  out_str << "\n:Supplier Website: #{@supplier_website}".rstrip
  out_str << "\n:Supplier Email: #{@supplier_email}".rstrip
  out_str << "\n:Customer Name: #{@customer_name}".rstrip
  out_str << "\n:Customer Company Registrations: #{customer_company_registrations}".rstrip
  out_str << "\n:Customer Address: #{@customer_address}".rstrip
  out_str << "\n:Customer ID: #{@customer_id}".rstrip
  out_str << "\n:Shipping Address: #{@shipping_address}".rstrip
  out_str << "\n:Billing Address: #{@billing_address}".rstrip
  out_str << "\n:Document Type: #{@document_type}".rstrip
  out_str << "\n:Line Items:"
  out_str << line_items
  out_str[1..].to_s
end