Class: EInvoiceAPI::Models::DocumentCreateFromPdfResponse

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/e_invoice_api/models/document_create_from_pdf_response.rb

Overview

See Also:

Defined Under Namespace

Modules: TaxCode, Vatex Classes: Item, TaxDetail

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, inspect, #inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(amount: nil, rate: nil) ⇒ Object

Parameters:

  • amount (String, nil) (defaults to: nil) —

    The tax amount for this tax category. Must be rounded to maximum 2 decimals

  • rate (String, nil) (defaults to: nil) —

    The tax rate as a percentage (e.g., ‘21.00’, ‘6.00’, ‘0.00’)




# File 'lib/e_invoice_api/models/document_create_from_pdf_response.rb', line 491

Instance Attribute Details

#allowances ⇒ Array<EInvoiceAPI::Models::Allowance>?

Returns:



10
 
# File 'lib/e_invoice_api/models/document_create_from_pdf_response.rb', line 10

optional :allowances, -> { EInvoiceAPI::Internal::Type::ArrayOf[EInvoiceAPI::Allowance] }, nil?: true

#amount_due ⇒ String?

The amount due for payment. Must be positive and rounded to maximum 2 decimals

Returns:

  • (String, nil) 


16
 
# File 'lib/e_invoice_api/models/document_create_from_pdf_response.rb', line 16

optional :amount_due, String, nil?: true

#attachments ⇒ Array<EInvoiceAPI::Models::DocumentAttachmentCreate>?

Returns:



21
22
23
 
# File 'lib/e_invoice_api/models/document_create_from_pdf_response.rb', line 21

optional :attachments,
-> { EInvoiceAPI::Internal::Type::ArrayOf[EInvoiceAPI::DocumentAttachmentCreate] },
nil?: true

#billing_address ⇒ String?

The billing address (if different from customer address)

Returns:

  • (String, nil) 


29
 
# File 'lib/e_invoice_api/models/document_create_from_pdf_response.rb', line 29

optional :billing_address, String, nil?: true

#billing_address_recipient ⇒ String?

The recipient name at the billing address

Returns:

  • (String, nil) 


35
 
# File 'lib/e_invoice_api/models/document_create_from_pdf_response.rb', line 35

optional :billing_address_recipient, String, nil?: true

#charges ⇒ Array<EInvoiceAPI::Models::Charge>?

Returns:



40
 
# File 'lib/e_invoice_api/models/document_create_from_pdf_response.rb', line 40

optional :charges, -> { EInvoiceAPI::Internal::Type::ArrayOf[EInvoiceAPI::Charge] }, nil?: true

#currency ⇒ Symbol, ...

Currency of the invoice (ISO 4217 currency code)

Returns:



46
 
# File 'lib/e_invoice_api/models/document_create_from_pdf_response.rb', line 46

optional :currency, enum: -> { EInvoiceAPI::CurrencyCode }

#customer_address ⇒ String?

The address of the customer/buyer

Returns:

  • (String, nil) 


52
 
# File 'lib/e_invoice_api/models/document_create_from_pdf_response.rb', line 52

optional :customer_address, String, nil?: true

#customer_address_recipient ⇒ String?

The recipient name at the customer address

Returns:

  • (String, nil) 


58
 
# File 'lib/e_invoice_api/models/document_create_from_pdf_response.rb', line 58

optional :customer_address_recipient, String, nil?: true

#customer_company_id ⇒ String?

Customer company ID. For Belgium this is the CBE number or their EUID (European Unique Identifier) number. In the Netherlands this is the KVK number.

Returns:

  • (String, nil) 


65
 
# File 'lib/e_invoice_api/models/document_create_from_pdf_response.rb', line 65

optional :customer_company_id, String, nil?: true

#customer_email ⇒ String?

The email address of the customer

Returns:

  • (String, nil) 


71
 
# File 'lib/e_invoice_api/models/document_create_from_pdf_response.rb', line 71

optional :customer_email, String, nil?: true

#customer_id ⇒ String?

The unique identifier for the customer in your system

Returns:

  • (String, nil) 


77
 
# File 'lib/e_invoice_api/models/document_create_from_pdf_response.rb', line 77

optional :customer_id, String, nil?: true

#customer_name ⇒ String?

The company name of the customer/buyer

Returns:

  • (String, nil) 


83
 
# File 'lib/e_invoice_api/models/document_create_from_pdf_response.rb', line 83

optional :customer_name, String, nil?: true

#customer_tax_id ⇒ String?

Customer tax ID. For Belgium this is the VAT number. Must include the country prefix

Returns:

  • (String, nil) 


90
 
# File 'lib/e_invoice_api/models/document_create_from_pdf_response.rb', line 90

optional :customer_tax_id, String, nil?: true

#direction ⇒ Symbol, ...

The direction of the document: INBOUND (purchases) or OUTBOUND (sales)

Returns:



96
 
# File 'lib/e_invoice_api/models/document_create_from_pdf_response.rb', line 96

optional :direction, enum: -> { EInvoiceAPI::DocumentDirection }

#document_type ⇒ Symbol, ...

The type of document: INVOICE, CREDIT_NOTE, or DEBIT_NOTE

Returns:



102
 
# File 'lib/e_invoice_api/models/document_create_from_pdf_response.rb', line 102

optional :document_type, enum: -> { EInvoiceAPI::DocumentType }

#due_date ⇒ Date?

The date when payment is due

Returns:

  • (Date, nil) 


108
 
# File 'lib/e_invoice_api/models/document_create_from_pdf_response.rb', line 108

optional :due_date, Date, nil?: true

#invoice_date ⇒ Date?

The date when the invoice was issued

Returns:

  • (Date, nil) 


114
 
# File 'lib/e_invoice_api/models/document_create_from_pdf_response.rb', line 114

optional :invoice_date, Date, nil?: true

#invoice_id ⇒ String?

The unique invoice identifier/number

Returns:

  • (String, nil) 


120
 
# File 'lib/e_invoice_api/models/document_create_from_pdf_response.rb', line 120

optional :invoice_id, String, nil?: true

#invoice_total ⇒ String?

The total amount of the invoice including tax (invoice_total = subtotal + total_tax + total_discount). Must be positive and rounded to maximum 2 decimals

Returns:

  • (String, nil) 


127
 
# File 'lib/e_invoice_api/models/document_create_from_pdf_response.rb', line 127

optional :invoice_total, String, nil?: true

#items ⇒ Array<EInvoiceAPI::Models::DocumentCreateFromPdfResponse::Item>?

At least one line item is required

Returns:



133
134
 
# File 'lib/e_invoice_api/models/document_create_from_pdf_response.rb', line 133

optional :items,
-> { EInvoiceAPI::Internal::Type::ArrayOf[EInvoiceAPI::Models::DocumentCreateFromPdfResponse::Item] }

#note ⇒ String?

Additional notes or comments for the invoice

Returns:

  • (String, nil) 


140
 
# File 'lib/e_invoice_api/models/document_create_from_pdf_response.rb', line 140

optional :note, String, nil?: true

#payment_details ⇒ Array<EInvoiceAPI::Models::PaymentDetailCreate>?

Returns:



145
146
147
 
# File 'lib/e_invoice_api/models/document_create_from_pdf_response.rb', line 145

optional :payment_details,
-> { EInvoiceAPI::Internal::Type::ArrayOf[EInvoiceAPI::PaymentDetailCreate] },
nil?: true

#payment_term ⇒ String?

The payment terms (e.g., ‘Net 30’, ‘Due on receipt’, ‘2/10 Net 30’)

Returns:

  • (String, nil) 


153
 
# File 'lib/e_invoice_api/models/document_create_from_pdf_response.rb', line 153

optional :payment_term, String, nil?: true

#purchase_order ⇒ String?

The purchase order reference number

Returns:

  • (String, nil) 


159
 
# File 'lib/e_invoice_api/models/document_create_from_pdf_response.rb', line 159

optional :purchase_order, String, nil?: true

#remittance_address ⇒ String?

The address where payment should be sent or remitted to

Returns:

  • (String, nil) 


165
 
# File 'lib/e_invoice_api/models/document_create_from_pdf_response.rb', line 165

optional :remittance_address, String, nil?: true

#remittance_address_recipient ⇒ String?

The recipient name at the remittance address

Returns:

  • (String, nil) 


171
 
# File 'lib/e_invoice_api/models/document_create_from_pdf_response.rb', line 171

optional :remittance_address_recipient, String, nil?: true

#service_address ⇒ String?

The address where services were performed or goods were delivered

Returns:

  • (String, nil) 


177
 
# File 'lib/e_invoice_api/models/document_create_from_pdf_response.rb', line 177

optional :service_address, String, nil?: true

#service_address_recipient ⇒ String?

The recipient name at the service address

Returns:

  • (String, nil) 


183
 
# File 'lib/e_invoice_api/models/document_create_from_pdf_response.rb', line 183

optional :service_address_recipient, String, nil?: true

#service_end_date ⇒ Date?

The end date of the service period or delivery period

Returns:

  • (Date, nil) 


189
 
# File 'lib/e_invoice_api/models/document_create_from_pdf_response.rb', line 189

optional :service_end_date, Date, nil?: true

#service_start_date ⇒ Date?

The start date of the service period or delivery period

Returns:

  • (Date, nil) 


195
 
# File 'lib/e_invoice_api/models/document_create_from_pdf_response.rb', line 195

optional :service_start_date, Date, nil?: true

#shipping_address ⇒ String?

The shipping/delivery address

Returns:

  • (String, nil) 


201
 
# File 'lib/e_invoice_api/models/document_create_from_pdf_response.rb', line 201

optional :shipping_address, String, nil?: true

#shipping_address_recipient ⇒ String?

The recipient name at the shipping address

Returns:

  • (String, nil) 


207
 
# File 'lib/e_invoice_api/models/document_create_from_pdf_response.rb', line 207

optional :shipping_address_recipient, String, nil?: true

#state ⇒ Symbol, ...

The current state of the document: DRAFT, TRANSIT, FAILED, SENT, or RECEIVED

Returns:



213
 
# File 'lib/e_invoice_api/models/document_create_from_pdf_response.rb', line 213

optional :state, enum: -> { EInvoiceAPI::DocumentState }

#subtotal ⇒ String?

The taxable base of the invoice. Should be the sum of all line items - allowances (for example commercial discounts) + charges with impact on VAT. Must be positive and rounded to maximum 2 decimals

Returns:

  • (String, nil) 


221
 
# File 'lib/e_invoice_api/models/document_create_from_pdf_response.rb', line 221

optional :subtotal, String, nil?: true

#success ⇒ Boolean?

Whether the PDF was successfully converted into a compliant e-invoice

Returns:

  • (Boolean, nil) 


227
 
# File 'lib/e_invoice_api/models/document_create_from_pdf_response.rb', line 227

optional :success, EInvoiceAPI::Internal::Type::Boolean

#tax_code ⇒ Symbol, ...

Tax category code of the invoice (e.g., S for standard rate, Z for zero rate, E for exempt)

Returns:



234
 
# File 'lib/e_invoice_api/models/document_create_from_pdf_response.rb', line 234

optional :tax_code, enum: -> { EInvoiceAPI::Models::DocumentCreateFromPdfResponse::TaxCode }

#tax_details ⇒ Array<EInvoiceAPI::Models::DocumentCreateFromPdfResponse::TaxDetail>?

Returns:



239
240
241
 
# File 'lib/e_invoice_api/models/document_create_from_pdf_response.rb', line 239

optional :tax_details,
-> { EInvoiceAPI::Internal::Type::ArrayOf[EInvoiceAPI::Models::DocumentCreateFromPdfResponse::TaxDetail] },
nil?: true

#total_discount ⇒ String?

The net financial discount/charge of the invoice (non-VAT charges minus non-VAT allowances). Can be positive (net charge), negative (net discount), or zero. Must be rounded to maximum 2 decimals

Returns:

  • (String, nil) 


249
 
# File 'lib/e_invoice_api/models/document_create_from_pdf_response.rb', line 249

optional :total_discount, String, nil?: true

#total_tax ⇒ String?

The total tax amount of the invoice. Must be positive and rounded to maximum 2 decimals

Returns:

  • (String, nil) 


256
 
# File 'lib/e_invoice_api/models/document_create_from_pdf_response.rb', line 256

optional :total_tax, String, nil?: true

#ubl_document ⇒ String?

The UBL document as an XML string

Returns:

  • (String, nil) 


262
 
# File 'lib/e_invoice_api/models/document_create_from_pdf_response.rb', line 262

optional :ubl_document, String, nil?: true

#vatex ⇒ Symbol, ...

VATEX code list for VAT exemption reasons

Agency: CEF Identifier: vatex

Returns:



270
 
# File 'lib/e_invoice_api/models/document_create_from_pdf_response.rb', line 270

optional :vatex, enum: -> { EInvoiceAPI::Models::DocumentCreateFromPdfResponse::Vatex }, nil?: true

#vatex_note ⇒ String?

Textual explanation for VAT exemption

Returns:

  • (String, nil) 


276
 
# File 'lib/e_invoice_api/models/document_create_from_pdf_response.rb', line 276

optional :vatex_note, String, nil?: true

#vendor_address ⇒ String?

The address of the vendor/seller

Returns:

  • (String, nil) 


282
 
# File 'lib/e_invoice_api/models/document_create_from_pdf_response.rb', line 282

optional :vendor_address, String, nil?: true

#vendor_address_recipient ⇒ String?

The recipient name at the vendor address

Returns:

  • (String, nil) 


288
 
# File 'lib/e_invoice_api/models/document_create_from_pdf_response.rb', line 288

optional :vendor_address_recipient, String, nil?: true

#vendor_company_id ⇒ String?

Vendor company ID. For Belgium this is the CBE number or their EUID (European Unique Identifier) number. In the Netherlands this is the KVK number.

Returns:

  • (String, nil) 


295
 
# File 'lib/e_invoice_api/models/document_create_from_pdf_response.rb', line 295

optional :vendor_company_id, String, nil?: true

#vendor_email ⇒ String?

The email address of the vendor

Returns:

  • (String, nil) 


301
 
# File 'lib/e_invoice_api/models/document_create_from_pdf_response.rb', line 301

optional :vendor_email, String, nil?: true

#vendor_name ⇒ String?

The name of the vendor/seller/supplier

Returns:

  • (String, nil) 


307
 
# File 'lib/e_invoice_api/models/document_create_from_pdf_response.rb', line 307

optional :vendor_name, String, nil?: true

#vendor_tax_id ⇒ String?

Vendor tax ID. For Belgium this is the VAT number. Must include the country prefix

Returns:

  • (String, nil) 


314
 
# File 'lib/e_invoice_api/models/document_create_from_pdf_response.rb', line 314

optional :vendor_tax_id, String, nil?: true

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/e_invoice_api/models/document_create_from_pdf_response.rb', line 536