Class: Mindee::Product::FinancialDocument::FinancialDocumentV1Document

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

Overview

Financial Document API version 1.11 document data.

Direct Known Subclasses

FinancialDocumentV1PagePrediction

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(prediction, page_id) ⇒ FinancialDocumentV1Document

Returns a new instance of FinancialDocumentV1Document.

Parameters:

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


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
 
# File 'lib/mindee/product/financial_document/financial_document_v1_document.rb', line 111

def initialize(prediction, page_id)
  super()
  @billing_address = StringField.new(prediction['billing_address'], page_id)
  @category = ClassificationField.new(prediction['category'], page_id)
  @customer_address = StringField.new(prediction['customer_address'], page_id)
  @customer_company_registrations = []
  prediction['customer_company_registrations'].each do |item|
    @customer_company_registrations.push(CompanyRegistrationField.new(item, page_id))
  end
  @customer_id = StringField.new(prediction['customer_id'], page_id)
  @customer_name = StringField.new(prediction['customer_name'], page_id)
  @date = DateField.new(prediction['date'], page_id)
  @document_number = StringField.new(prediction['document_number'], page_id)
  @document_type = ClassificationField.new(prediction['document_type'], page_id)
  @due_date = DateField.new(prediction['due_date'], page_id)
  @invoice_number = StringField.new(prediction['invoice_number'], page_id)
  @line_items = []
  prediction['line_items'].each do |item|
    @line_items.push(FinancialDocumentV1LineItem.new(item, page_id))
  end
  @locale = LocaleField.new(prediction['locale'], page_id)
  @payment_date = DateField.new(prediction['payment_date'], page_id)
  @po_number = StringField.new(prediction['po_number'], page_id)
  @receipt_number = StringField.new(prediction['receipt_number'], page_id)
  @reference_numbers = []
  prediction['reference_numbers'].each do |item|
    @reference_numbers.push(StringField.new(item, page_id))
  end
  @shipping_address = StringField.new(prediction['shipping_address'], page_id)
  @subcategory = ClassificationField.new(prediction['subcategory'], page_id)
  @supplier_address = StringField.new(prediction['supplier_address'], page_id)
  @supplier_company_registrations = []
  prediction['supplier_company_registrations'].each do |item|
    @supplier_company_registrations.push(CompanyRegistrationField.new(item, page_id))
  end
  @supplier_email = StringField.new(prediction['supplier_email'], page_id)
  @supplier_name = StringField.new(prediction['supplier_name'], page_id)
  @supplier_payment_details = []
  prediction['supplier_payment_details'].each do |item|
    @supplier_payment_details.push(PaymentDetailsField.new(item, page_id))
  end
  @supplier_phone_number = StringField.new(prediction['supplier_phone_number'], page_id)
  @supplier_website = StringField.new(prediction['supplier_website'], page_id)
  @taxes = Taxes.new(prediction['taxes'], page_id)
  @time = StringField.new(prediction['time'], page_id)
  @tip = AmountField.new(prediction['tip'], page_id)
  @total_amount = AmountField.new(prediction['total_amount'], page_id)
  @total_net = AmountField.new(prediction['total_net'], page_id)
  @total_tax = AmountField.new(prediction['total_tax'], page_id)
end

Instance Attribute Details

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

The customer's address used for billing.

Returns:



14
15
16
 
# File 'lib/mindee/product/financial_document/financial_document_v1_document.rb', line 14

def billing_address
  @billing_address
end

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

The purchase category among predefined classes.

Returns:



17
18
19
 
# File 'lib/mindee/product/financial_document/financial_document_v1_document.rb', line 17

def category
  @category
end

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

The address of the customer.

Returns:



20
21
22
 
# File 'lib/mindee/product/financial_document/financial_document_v1_document.rb', line 20

def customer_address
  @customer_address
end

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

List of company registrations associated to the customer.

Returns:



23
24
25
 
# File 'lib/mindee/product/financial_document/financial_document_v1_document.rb', line 23

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:



26
27
28
 
# File 'lib/mindee/product/financial_document/financial_document_v1_document.rb', line 26

def customer_id
  @customer_id
end

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

The name of the customer.

Returns:



29
30
31
 
# File 'lib/mindee/product/financial_document/financial_document_v1_document.rb', line 29

def customer_name
  @customer_name
end

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

The date the purchase was made.

Returns:



32
33
34
 
# File 'lib/mindee/product/financial_document/financial_document_v1_document.rb', line 32

def date
  @date
end

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

The document number or identifier.

Returns:



35
36
37
 
# File 'lib/mindee/product/financial_document/financial_document_v1_document.rb', line 35

def document_number
  @document_number
end

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

One of: 'INVOICE', 'CREDIT NOTE', 'CREDIT CARD RECEIPT', 'EXPENSE RECEIPT'.

Returns:



38
39
40
 
# File 'lib/mindee/product/financial_document/financial_document_v1_document.rb', line 38

def document_type
  @document_type
end

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

The date on which the payment is due.

Returns:



41
42
43
 
# File 'lib/mindee/product/financial_document/financial_document_v1_document.rb', line 41

def due_date
  @due_date
end

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

The invoice number or identifier only if document is an invoice.

Returns:



44
45
46
 
# File 'lib/mindee/product/financial_document/financial_document_v1_document.rb', line 44

def invoice_number
  @invoice_number
end

#line_items ⇒ Array<Mindee::Product::FinancialDocument::FinancialDocumentV1LineItem> (readonly)

List of line item details.

Returns:



47
48
49
 
# File 'lib/mindee/product/financial_document/financial_document_v1_document.rb', line 47

def line_items
  @line_items
end

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

The locale detected on the document.

Returns:



50
51
52
 
# File 'lib/mindee/product/financial_document/financial_document_v1_document.rb', line 50

def locale
  @locale
end

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

The date on which the payment is due / fullfilled.

Returns:



53
54
55
 
# File 'lib/mindee/product/financial_document/financial_document_v1_document.rb', line 53

def payment_date
  @payment_date
end

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

The purchase order number.

Returns:



56
57
58
 
# File 'lib/mindee/product/financial_document/financial_document_v1_document.rb', line 56

def po_number
  @po_number
end

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

The receipt number or identifier only if document is a receipt.

Returns:



59
60
61
 
# File 'lib/mindee/product/financial_document/financial_document_v1_document.rb', line 59

def receipt_number
  @receipt_number
end

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

List of Reference numbers, including PO number.

Returns:



62
63
64
 
# File 'lib/mindee/product/financial_document/financial_document_v1_document.rb', line 62

def reference_numbers
  @reference_numbers
end

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

The customer's address used for shipping.

Returns:



65
66
67
 
# File 'lib/mindee/product/financial_document/financial_document_v1_document.rb', line 65

def shipping_address
  @shipping_address
end

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

The purchase subcategory among predefined classes for transport and food.

Returns:



68
69
70
 
# File 'lib/mindee/product/financial_document/financial_document_v1_document.rb', line 68

def subcategory
  @subcategory
end

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

The address of the supplier or merchant.

Returns:



71
72
73
 
# File 'lib/mindee/product/financial_document/financial_document_v1_document.rb', line 71

def supplier_address
  @supplier_address
end

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

List of company registrations associated to the supplier.

Returns:



74
75
76
 
# File 'lib/mindee/product/financial_document/financial_document_v1_document.rb', line 74

def supplier_company_registrations
  @supplier_company_registrations
end

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

The email of the supplier or merchant.

Returns:



77
78
79
 
# File 'lib/mindee/product/financial_document/financial_document_v1_document.rb', line 77

def supplier_email
  @supplier_email
end

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

The name of the supplier or merchant.

Returns:



80
81
82
 
# File 'lib/mindee/product/financial_document/financial_document_v1_document.rb', line 80

def supplier_name
  @supplier_name
end

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

List of payment details associated to the supplier.

Returns:



83
84
85
 
# File 'lib/mindee/product/financial_document/financial_document_v1_document.rb', line 83

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:



86
87
88
 
# File 'lib/mindee/product/financial_document/financial_document_v1_document.rb', line 86

def supplier_phone_number
  @supplier_phone_number
end

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

The website URL of the supplier or merchant.

Returns:



89
90
91
 
# File 'lib/mindee/product/financial_document/financial_document_v1_document.rb', line 89

def supplier_website
  @supplier_website
end

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

List of tax lines information.

Returns:



92
93
94
 
# File 'lib/mindee/product/financial_document/financial_document_v1_document.rb', line 92

def taxes
  @taxes
end

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

The time the purchase was made.

Returns:



95
96
97
 
# File 'lib/mindee/product/financial_document/financial_document_v1_document.rb', line 95

def time
  @time
end

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

The total amount of tip and gratuity

Returns:



98
99
100
 
# File 'lib/mindee/product/financial_document/financial_document_v1_document.rb', line 98

def tip
  @tip
end

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

The total amount paid: includes taxes, tips, fees, and other charges.

Returns:



101
102
103
 
# File 'lib/mindee/product/financial_document/financial_document_v1_document.rb', line 101

def total_amount
  @total_amount
end

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

The net amount paid: does not include taxes, fees, and discounts.

Returns:



104
105
106
 
# File 'lib/mindee/product/financial_document/financial_document_v1_document.rb', line 104

def total_net
  @total_net
end

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

The total amount of taxes.

Returns:



107
108
109
 
# File 'lib/mindee/product/financial_document/financial_document_v1_document.rb', line 107

def total_tax
  @total_tax
end

Instance Method Details

#to_s ⇒ String

Returns:

  • (String) 


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
191
192
193
194
195
196
197
198
199
200
201
202
203
204
 
# File 'lib/mindee/product/financial_document/financial_document_v1_document.rb', line 163

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:Receipt Number: #{@receipt_number}".rstrip
  out_str << "\n:Document Number: #{@document_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: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:Customer Name: #{@customer_name}".rstrip
  out_str << "\n:Supplier Website: #{@supplier_website}".rstrip
  out_str << "\n:Supplier Email: #{@supplier_email}".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:Purchase Subcategory: #{@subcategory}".rstrip
  out_str << "\n:Purchase Category: #{@category}".rstrip
  out_str << "\n:Total Tax: #{@total_tax}".rstrip
  out_str << "\n:Tip and Gratuity: #{@tip}".rstrip
  out_str << "\n:Purchase Time: #{@time}".rstrip
  out_str << "\n:Line Items:"
  out_str << line_items
  out_str[1..].to_s
end