e-invoice-api 0.11.0 → 0.13.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -17,8 +17,7 @@ module EInvoiceAPI
17
17
  nil?: true
18
18
 
19
19
  # @!attribute amount_due
20
- # The amount due of the invoice. Must be positive and rounded to maximum 2
21
- # decimals
20
+ # The amount due for payment. Must be positive and rounded to maximum 2 decimals
22
21
  #
23
22
  # @return [String, nil]
24
23
  optional :amount_due, String, nil?: true
@@ -31,11 +30,13 @@ module EInvoiceAPI
31
30
  nil?: true
32
31
 
33
32
  # @!attribute billing_address
33
+ # The billing address (if different from customer address)
34
34
  #
35
35
  # @return [String, nil]
36
36
  optional :billing_address, String, nil?: true
37
37
 
38
38
  # @!attribute billing_address_recipient
39
+ # The recipient name at the billing address
39
40
  #
40
41
  # @return [String, nil]
41
42
  optional :billing_address_recipient, String, nil?: true
@@ -48,69 +49,88 @@ module EInvoiceAPI
48
49
  nil?: true
49
50
 
50
51
  # @!attribute currency
51
- # Currency of the invoice
52
+ # Currency of the invoice (ISO 4217 currency code)
52
53
  #
53
54
  # @return [Symbol, EInvoiceAPI::Models::CurrencyCode, nil]
54
55
  optional :currency, enum: -> { EInvoiceAPI::CurrencyCode }
55
56
 
56
57
  # @!attribute customer_address
58
+ # The address of the customer/buyer
57
59
  #
58
60
  # @return [String, nil]
59
61
  optional :customer_address, String, nil?: true
60
62
 
61
63
  # @!attribute customer_address_recipient
64
+ # The recipient name at the customer address
62
65
  #
63
66
  # @return [String, nil]
64
67
  optional :customer_address_recipient, String, nil?: true
65
68
 
69
+ # @!attribute customer_company_id
70
+ # Customer company ID. For Belgium this is the CBE number or their EUID (European
71
+ # Unique Identifier) number. In the Netherlands this is the KVK number.
72
+ #
73
+ # @return [String, nil]
74
+ optional :customer_company_id, String, nil?: true
75
+
66
76
  # @!attribute customer_email
77
+ # The email address of the customer
67
78
  #
68
79
  # @return [String, nil]
69
80
  optional :customer_email, String, nil?: true
70
81
 
71
82
  # @!attribute customer_id
83
+ # The unique identifier for the customer in your system
72
84
  #
73
85
  # @return [String, nil]
74
86
  optional :customer_id, String, nil?: true
75
87
 
76
88
  # @!attribute customer_name
89
+ # The company name of the customer/buyer
77
90
  #
78
91
  # @return [String, nil]
79
92
  optional :customer_name, String, nil?: true
80
93
 
81
94
  # @!attribute customer_tax_id
95
+ # Customer tax ID. For Belgium this is the VAT number. Must include the country
96
+ # prefix
82
97
  #
83
98
  # @return [String, nil]
84
99
  optional :customer_tax_id, String, nil?: true
85
100
 
86
101
  # @!attribute direction
102
+ # The direction of the document: INBOUND (purchases) or OUTBOUND (sales)
87
103
  #
88
104
  # @return [Symbol, EInvoiceAPI::Models::DocumentDirection, nil]
89
105
  optional :direction, enum: -> { EInvoiceAPI::DocumentDirection }
90
106
 
91
107
  # @!attribute document_type
108
+ # The type of document: INVOICE, CREDIT_NOTE, or DEBIT_NOTE
92
109
  #
93
110
  # @return [Symbol, EInvoiceAPI::Models::DocumentType, nil]
94
111
  optional :document_type, enum: -> { EInvoiceAPI::DocumentType }
95
112
 
96
113
  # @!attribute due_date
114
+ # The date when payment is due
97
115
  #
98
116
  # @return [Date, nil]
99
117
  optional :due_date, Date, nil?: true
100
118
 
101
119
  # @!attribute invoice_date
120
+ # The date when the invoice was issued
102
121
  #
103
122
  # @return [Date, nil]
104
123
  optional :invoice_date, Date, nil?: true
105
124
 
106
125
  # @!attribute invoice_id
126
+ # The unique invoice identifier/number
107
127
  #
108
128
  # @return [String, nil]
109
129
  optional :invoice_id, String, nil?: true
110
130
 
111
131
  # @!attribute invoice_total
112
- # The total amount of the invoice (so invoice_total = subtotal + total_tax +
113
- # total_discount). Must be positive and rounded to maximum 2 decimals
132
+ # The total amount of the invoice including tax (invoice_total = subtotal +
133
+ # total_tax + total_discount). Must be positive and rounded to maximum 2 decimals
114
134
  #
115
135
  # @return [String, nil]
116
136
  optional :invoice_total, String, nil?: true
@@ -123,6 +143,7 @@ module EInvoiceAPI
123
143
  nil?: true
124
144
 
125
145
  # @!attribute note
146
+ # Additional notes or comments for the invoice
126
147
  #
127
148
  # @return [String, nil]
128
149
  optional :note, String, nil?: true
@@ -135,63 +156,74 @@ module EInvoiceAPI
135
156
  nil?: true
136
157
 
137
158
  # @!attribute payment_term
159
+ # The payment terms (e.g., 'Net 30', 'Due on receipt', '2/10 Net 30')
138
160
  #
139
161
  # @return [String, nil]
140
162
  optional :payment_term, String, nil?: true
141
163
 
142
164
  # @!attribute previous_unpaid_balance
143
- # The previous unpaid balance of the invoice, if any. Must be positive and rounded
144
- # to maximum 2 decimals
165
+ # The previous unpaid balance from prior invoices, if any. Must be positive and
166
+ # rounded to maximum 2 decimals
145
167
  #
146
168
  # @return [String, nil]
147
169
  optional :previous_unpaid_balance, String, nil?: true
148
170
 
149
171
  # @!attribute purchase_order
172
+ # The purchase order reference number
150
173
  #
151
174
  # @return [String, nil]
152
175
  optional :purchase_order, String, nil?: true
153
176
 
154
177
  # @!attribute remittance_address
178
+ # The address where payment should be sent or remitted to
155
179
  #
156
180
  # @return [String, nil]
157
181
  optional :remittance_address, String, nil?: true
158
182
 
159
183
  # @!attribute remittance_address_recipient
184
+ # The recipient name at the remittance address
160
185
  #
161
186
  # @return [String, nil]
162
187
  optional :remittance_address_recipient, String, nil?: true
163
188
 
164
189
  # @!attribute service_address
190
+ # The address where services were performed or goods were delivered
165
191
  #
166
192
  # @return [String, nil]
167
193
  optional :service_address, String, nil?: true
168
194
 
169
195
  # @!attribute service_address_recipient
196
+ # The recipient name at the service address
170
197
  #
171
198
  # @return [String, nil]
172
199
  optional :service_address_recipient, String, nil?: true
173
200
 
174
201
  # @!attribute service_end_date
202
+ # The end date of the service period or delivery period
175
203
  #
176
204
  # @return [Date, nil]
177
205
  optional :service_end_date, Date, nil?: true
178
206
 
179
207
  # @!attribute service_start_date
208
+ # The start date of the service period or delivery period
180
209
  #
181
210
  # @return [Date, nil]
182
211
  optional :service_start_date, Date, nil?: true
183
212
 
184
213
  # @!attribute shipping_address
214
+ # The shipping/delivery address
185
215
  #
186
216
  # @return [String, nil]
187
217
  optional :shipping_address, String, nil?: true
188
218
 
189
219
  # @!attribute shipping_address_recipient
220
+ # The recipient name at the shipping address
190
221
  #
191
222
  # @return [String, nil]
192
223
  optional :shipping_address_recipient, String, nil?: true
193
224
 
194
225
  # @!attribute state
226
+ # The current state of the document: DRAFT, TRANSIT, FAILED, SENT, or RECEIVED
195
227
  #
196
228
  # @return [Symbol, EInvoiceAPI::Models::DocumentState, nil]
197
229
  optional :state, enum: -> { EInvoiceAPI::DocumentState }
@@ -205,7 +237,8 @@ module EInvoiceAPI
205
237
  optional :subtotal, String, nil?: true
206
238
 
207
239
  # @!attribute tax_code
208
- # Tax category code of the invoice
240
+ # Tax category code of the invoice (e.g., S for standard rate, Z for zero rate, E
241
+ # for exempt)
209
242
  #
210
243
  # @return [Symbol, EInvoiceAPI::Models::DocumentResponse::TaxCode, nil]
211
244
  optional :tax_code, enum: -> { EInvoiceAPI::DocumentResponse::TaxCode }
@@ -226,7 +259,8 @@ module EInvoiceAPI
226
259
  optional :total_discount, String, nil?: true
227
260
 
228
261
  # @!attribute total_tax
229
- # The total tax of the invoice. Must be positive and rounded to maximum 2 decimals
262
+ # The total tax amount of the invoice. Must be positive and rounded to maximum 2
263
+ # decimals
230
264
  #
231
265
  # @return [String, nil]
232
266
  optional :total_tax, String, nil?: true
@@ -240,37 +274,50 @@ module EInvoiceAPI
240
274
  optional :vatex, enum: -> { EInvoiceAPI::DocumentResponse::Vatex }, nil?: true
241
275
 
242
276
  # @!attribute vatex_note
243
- # VAT exemption note of the invoice
277
+ # Textual explanation for VAT exemption
244
278
  #
245
279
  # @return [String, nil]
246
280
  optional :vatex_note, String, nil?: true
247
281
 
248
282
  # @!attribute vendor_address
283
+ # The address of the vendor/seller
249
284
  #
250
285
  # @return [String, nil]
251
286
  optional :vendor_address, String, nil?: true
252
287
 
253
288
  # @!attribute vendor_address_recipient
289
+ # The recipient name at the vendor address
254
290
  #
255
291
  # @return [String, nil]
256
292
  optional :vendor_address_recipient, String, nil?: true
257
293
 
294
+ # @!attribute vendor_company_id
295
+ # Vendor company ID. For Belgium this is the CBE number or their EUID (European
296
+ # Unique Identifier) number. In the Netherlands this is the KVK number.
297
+ #
298
+ # @return [String, nil]
299
+ optional :vendor_company_id, String, nil?: true
300
+
258
301
  # @!attribute vendor_email
302
+ # The email address of the vendor
259
303
  #
260
304
  # @return [String, nil]
261
305
  optional :vendor_email, String, nil?: true
262
306
 
263
307
  # @!attribute vendor_name
308
+ # The name of the vendor/seller/supplier
264
309
  #
265
310
  # @return [String, nil]
266
311
  optional :vendor_name, String, nil?: true
267
312
 
268
313
  # @!attribute vendor_tax_id
314
+ # Vendor tax ID. For Belgium this is the VAT number. Must include the country
315
+ # prefix
269
316
  #
270
317
  # @return [String, nil]
271
318
  optional :vendor_tax_id, String, nil?: true
272
319
 
273
- # @!method initialize(id:, allowances: nil, amount_due: nil, attachments: nil, billing_address: nil, billing_address_recipient: nil, charges: nil, currency: nil, customer_address: nil, customer_address_recipient: nil, customer_email: nil, customer_id: nil, customer_name: nil, customer_tax_id: nil, direction: nil, document_type: nil, due_date: nil, invoice_date: nil, invoice_id: nil, invoice_total: nil, items: nil, note: nil, payment_details: nil, payment_term: nil, previous_unpaid_balance: nil, purchase_order: nil, remittance_address: nil, remittance_address_recipient: nil, service_address: nil, service_address_recipient: nil, service_end_date: nil, service_start_date: nil, shipping_address: nil, shipping_address_recipient: nil, state: nil, subtotal: nil, tax_code: nil, tax_details: nil, total_discount: nil, total_tax: nil, vatex: nil, vatex_note: nil, vendor_address: nil, vendor_address_recipient: nil, vendor_email: nil, vendor_name: nil, vendor_tax_id: nil)
320
+ # @!method initialize(id:, allowances: nil, amount_due: nil, attachments: nil, billing_address: nil, billing_address_recipient: nil, charges: nil, currency: nil, customer_address: nil, customer_address_recipient: nil, customer_company_id: nil, customer_email: nil, customer_id: nil, customer_name: nil, customer_tax_id: nil, direction: nil, document_type: nil, due_date: nil, invoice_date: nil, invoice_id: nil, invoice_total: nil, items: nil, note: nil, payment_details: nil, payment_term: nil, previous_unpaid_balance: nil, purchase_order: nil, remittance_address: nil, remittance_address_recipient: nil, service_address: nil, service_address_recipient: nil, service_end_date: nil, service_start_date: nil, shipping_address: nil, shipping_address_recipient: nil, state: nil, subtotal: nil, tax_code: nil, tax_details: nil, total_discount: nil, total_tax: nil, vatex: nil, vatex_note: nil, vendor_address: nil, vendor_address_recipient: nil, vendor_company_id: nil, vendor_email: nil, vendor_name: nil, vendor_tax_id: nil)
274
321
  # Some parameter documentations has been truncated, see
275
322
  # {EInvoiceAPI::Models::DocumentResponse} for more details.
276
323
  #
@@ -278,95 +325,99 @@ module EInvoiceAPI
278
325
  #
279
326
  # @param allowances [Array<EInvoiceAPI::Models::DocumentResponse::Allowance>, nil]
280
327
  #
281
- # @param amount_due [String, nil] The amount due of the invoice. Must be positive and rounded to maximum 2 decimal
328
+ # @param amount_due [String, nil] The amount due for payment. Must be positive and rounded to maximum 2 decimals
282
329
  #
283
330
  # @param attachments [Array<EInvoiceAPI::Models::Documents::DocumentAttachment>, nil]
284
331
  #
285
- # @param billing_address [String, nil]
332
+ # @param billing_address [String, nil] The billing address (if different from customer address)
286
333
  #
287
- # @param billing_address_recipient [String, nil]
334
+ # @param billing_address_recipient [String, nil] The recipient name at the billing address
288
335
  #
289
336
  # @param charges [Array<EInvoiceAPI::Models::DocumentResponse::Charge>, nil]
290
337
  #
291
- # @param currency [Symbol, EInvoiceAPI::Models::CurrencyCode] Currency of the invoice
338
+ # @param currency [Symbol, EInvoiceAPI::Models::CurrencyCode] Currency of the invoice (ISO 4217 currency code)
292
339
  #
293
- # @param customer_address [String, nil]
340
+ # @param customer_address [String, nil] The address of the customer/buyer
294
341
  #
295
- # @param customer_address_recipient [String, nil]
342
+ # @param customer_address_recipient [String, nil] The recipient name at the customer address
296
343
  #
297
- # @param customer_email [String, nil]
344
+ # @param customer_company_id [String, nil] Customer company ID. For Belgium this is the CBE number or their EUID (European
298
345
  #
299
- # @param customer_id [String, nil]
346
+ # @param customer_email [String, nil] The email address of the customer
300
347
  #
301
- # @param customer_name [String, nil]
348
+ # @param customer_id [String, nil] The unique identifier for the customer in your system
302
349
  #
303
- # @param customer_tax_id [String, nil]
350
+ # @param customer_name [String, nil] The company name of the customer/buyer
304
351
  #
305
- # @param direction [Symbol, EInvoiceAPI::Models::DocumentDirection]
352
+ # @param customer_tax_id [String, nil] Customer tax ID. For Belgium this is the VAT number. Must include the country pr
306
353
  #
307
- # @param document_type [Symbol, EInvoiceAPI::Models::DocumentType]
354
+ # @param direction [Symbol, EInvoiceAPI::Models::DocumentDirection] The direction of the document: INBOUND (purchases) or OUTBOUND (sales)
308
355
  #
309
- # @param due_date [Date, nil]
356
+ # @param document_type [Symbol, EInvoiceAPI::Models::DocumentType] The type of document: INVOICE, CREDIT_NOTE, or DEBIT_NOTE
310
357
  #
311
- # @param invoice_date [Date, nil]
358
+ # @param due_date [Date, nil] The date when payment is due
312
359
  #
313
- # @param invoice_id [String, nil]
360
+ # @param invoice_date [Date, nil] The date when the invoice was issued
314
361
  #
315
- # @param invoice_total [String, nil] The total amount of the invoice (so invoice_total = subtotal + total_tax + total
362
+ # @param invoice_id [String, nil] The unique invoice identifier/number
363
+ #
364
+ # @param invoice_total [String, nil] The total amount of the invoice including tax (invoice*total = subtotal + total*
316
365
  #
317
366
  # @param items [Array<EInvoiceAPI::Models::DocumentResponse::Item>, nil]
318
367
  #
319
- # @param note [String, nil]
368
+ # @param note [String, nil] Additional notes or comments for the invoice
320
369
  #
321
370
  # @param payment_details [Array<EInvoiceAPI::Models::DocumentResponse::PaymentDetail>, nil]
322
371
  #
323
- # @param payment_term [String, nil]
372
+ # @param payment_term [String, nil] The payment terms (e.g., 'Net 30', 'Due on receipt', '2/10 Net 30')
324
373
  #
325
- # @param previous_unpaid_balance [String, nil] The previous unpaid balance of the invoice, if any. Must be positive and rounded
374
+ # @param previous_unpaid_balance [String, nil] The previous unpaid balance from prior invoices, if any. Must be positive and ro
326
375
  #
327
- # @param purchase_order [String, nil]
376
+ # @param purchase_order [String, nil] The purchase order reference number
328
377
  #
329
- # @param remittance_address [String, nil]
378
+ # @param remittance_address [String, nil] The address where payment should be sent or remitted to
330
379
  #
331
- # @param remittance_address_recipient [String, nil]
380
+ # @param remittance_address_recipient [String, nil] The recipient name at the remittance address
332
381
  #
333
- # @param service_address [String, nil]
382
+ # @param service_address [String, nil] The address where services were performed or goods were delivered
334
383
  #
335
- # @param service_address_recipient [String, nil]
384
+ # @param service_address_recipient [String, nil] The recipient name at the service address
336
385
  #
337
- # @param service_end_date [Date, nil]
386
+ # @param service_end_date [Date, nil] The end date of the service period or delivery period
338
387
  #
339
- # @param service_start_date [Date, nil]
388
+ # @param service_start_date [Date, nil] The start date of the service period or delivery period
340
389
  #
341
- # @param shipping_address [String, nil]
390
+ # @param shipping_address [String, nil] The shipping/delivery address
342
391
  #
343
- # @param shipping_address_recipient [String, nil]
392
+ # @param shipping_address_recipient [String, nil] The recipient name at the shipping address
344
393
  #
345
- # @param state [Symbol, EInvoiceAPI::Models::DocumentState]
394
+ # @param state [Symbol, EInvoiceAPI::Models::DocumentState] The current state of the document: DRAFT, TRANSIT, FAILED, SENT, or RECEIVED
346
395
  #
347
396
  # @param subtotal [String, nil] The taxable base of the invoice. Should be the sum of all line items - allowance
348
397
  #
349
- # @param tax_code [Symbol, EInvoiceAPI::Models::DocumentResponse::TaxCode] Tax category code of the invoice
398
+ # @param tax_code [Symbol, EInvoiceAPI::Models::DocumentResponse::TaxCode] Tax category code of the invoice (e.g., S for standard rate, Z for zero rate, E
350
399
  #
351
400
  # @param tax_details [Array<EInvoiceAPI::Models::DocumentResponse::TaxDetail>, nil]
352
401
  #
353
402
  # @param total_discount [String, nil] The net financial discount/charge of the invoice (non-VAT charges minus non-VAT
354
403
  #
355
- # @param total_tax [String, nil] The total tax of the invoice. Must be positive and rounded to maximum 2 decimals
404
+ # @param total_tax [String, nil] The total tax amount of the invoice. Must be positive and rounded to maximum 2 d
356
405
  #
357
406
  # @param vatex [Symbol, EInvoiceAPI::Models::DocumentResponse::Vatex, nil] VATEX code list for VAT exemption reasons
358
407
  #
359
- # @param vatex_note [String, nil] VAT exemption note of the invoice
408
+ # @param vatex_note [String, nil] Textual explanation for VAT exemption
409
+ #
410
+ # @param vendor_address [String, nil] The address of the vendor/seller
360
411
  #
361
- # @param vendor_address [String, nil]
412
+ # @param vendor_address_recipient [String, nil] The recipient name at the vendor address
362
413
  #
363
- # @param vendor_address_recipient [String, nil]
414
+ # @param vendor_company_id [String, nil] Vendor company ID. For Belgium this is the CBE number or their EUID (European Un
364
415
  #
365
- # @param vendor_email [String, nil]
416
+ # @param vendor_email [String, nil] The email address of the vendor
366
417
  #
367
- # @param vendor_name [String, nil]
418
+ # @param vendor_name [String, nil] The name of the vendor/seller/supplier
368
419
  #
369
- # @param vendor_tax_id [String, nil]
420
+ # @param vendor_tax_id [String, nil] Vendor tax ID. For Belgium this is the VAT number. Must include the country pref
370
421
 
371
422
  class Allowance < EInvoiceAPI::Internal::Type::BaseModel
372
423
  # @!attribute amount
@@ -644,33 +695,45 @@ module EInvoiceAPI
644
695
 
645
696
  class PaymentDetail < EInvoiceAPI::Internal::Type::BaseModel
646
697
  # @!attribute bank_account_number
698
+ # Bank account number (for non-IBAN accounts)
647
699
  #
648
700
  # @return [String, nil]
649
701
  optional :bank_account_number, String, nil?: true
650
702
 
651
703
  # @!attribute iban
704
+ # International Bank Account Number for payment transfers
652
705
  #
653
706
  # @return [String, nil]
654
707
  optional :iban, String, nil?: true
655
708
 
656
709
  # @!attribute payment_reference
710
+ # Structured payment reference or communication (e.g., structured communication
711
+ # for Belgian bank transfers)
657
712
  #
658
713
  # @return [String, nil]
659
714
  optional :payment_reference, String, nil?: true
660
715
 
661
716
  # @!attribute swift
717
+ # SWIFT/BIC code of the bank
662
718
  #
663
719
  # @return [String, nil]
664
720
  optional :swift, String, nil?: true
665
721
 
666
722
  # @!method initialize(bank_account_number: nil, iban: nil, payment_reference: nil, swift: nil)
667
- # @param bank_account_number [String, nil]
668
- # @param iban [String, nil]
669
- # @param payment_reference [String, nil]
670
- # @param swift [String, nil]
723
+ # Some parameter documentations has been truncated, see
724
+ # {EInvoiceAPI::Models::DocumentResponse::PaymentDetail} for more details.
725
+ #
726
+ # @param bank_account_number [String, nil] Bank account number (for non-IBAN accounts)
727
+ #
728
+ # @param iban [String, nil] International Bank Account Number for payment transfers
729
+ #
730
+ # @param payment_reference [String, nil] Structured payment reference or communication (e.g., structured communication fo
731
+ #
732
+ # @param swift [String, nil] SWIFT/BIC code of the bank
671
733
  end
672
734
 
673
- # Tax category code of the invoice
735
+ # Tax category code of the invoice (e.g., S for standard rate, Z for zero rate, E
736
+ # for exempt)
674
737
  #
675
738
  # @see EInvoiceAPI::Models::DocumentResponse#tax_code
676
739
  module TaxCode
@@ -693,18 +756,21 @@ module EInvoiceAPI
693
756
 
694
757
  class TaxDetail < EInvoiceAPI::Internal::Type::BaseModel
695
758
  # @!attribute amount
759
+ # The tax amount for this tax category. Must be rounded to maximum 2 decimals
696
760
  #
697
761
  # @return [String, nil]
698
762
  optional :amount, String, nil?: true
699
763
 
700
764
  # @!attribute rate
765
+ # The tax rate as a percentage (e.g., '21.00', '6.00', '0.00')
701
766
  #
702
767
  # @return [String, nil]
703
768
  optional :rate, String, nil?: true
704
769
 
705
770
  # @!method initialize(amount: nil, rate: nil)
706
- # @param amount [String, nil]
707
- # @param rate [String, nil]
771
+ # @param amount [String, nil] The tax amount for this tax category. Must be rounded to maximum 2 decimals
772
+ #
773
+ # @param rate [String, nil] The tax rate as a percentage (e.g., '21.00', '6.00', '0.00')
708
774
  end
709
775
 
710
776
  # VATEX code list for VAT exemption reasons
@@ -28,7 +28,7 @@ module EInvoiceAPI
28
28
  optional :bcc_recipient_email, String, nil?: true
29
29
 
30
30
  # @!attribute company_address
31
- # Address of the company
31
+ # Address of the company. Must be in the form of `Street Name Street Number`
32
32
  #
33
33
  # @return [String, nil]
34
34
  optional :company_address, String, nil?: true
@@ -52,17 +52,26 @@ module EInvoiceAPI
52
52
  optional :company_email, String, nil?: true
53
53
 
54
54
  # @!attribute company_name
55
- # Name of the company
55
+ # Name of the company. Must include the company type. For example: `BV`, `NV`,
56
+ # `CVBA`, `VOF`
56
57
  #
57
58
  # @return [String, nil]
58
59
  optional :company_name, String, nil?: true
59
60
 
60
61
  # @!attribute company_number
61
- # Company number
62
+ # Company number. For Belgium this is the CBE number or their EUID (European
63
+ # Unique Identifier) number
62
64
  #
63
65
  # @return [String, nil]
64
66
  optional :company_number, String, nil?: true
65
67
 
68
+ # @!attribute company_tax_id
69
+ # Company tax ID. For Belgium this is the VAT number. Must include the country
70
+ # prefix
71
+ #
72
+ # @return [String, nil]
73
+ optional :company_tax_id, String, nil?: true
74
+
66
75
  # @!attribute company_zip
67
76
  # Zip code of the company
68
77
  #
@@ -98,7 +107,10 @@ module EInvoiceAPI
98
107
  # @return [Time, nil]
99
108
  optional :smp_registration_date, Time, nil?: true
100
109
 
101
- # @!method initialize(credit_balance:, name:, plan:, bcc_recipient_email: nil, company_address: nil, company_city: nil, company_country: nil, company_email: nil, company_name: nil, company_number: nil, company_zip: nil, description: nil, ibans: nil, peppol_ids: nil, smp_registration: nil, smp_registration_date: nil)
110
+ # @!method initialize(credit_balance:, name:, plan:, bcc_recipient_email: nil, company_address: nil, company_city: nil, company_country: nil, company_email: nil, company_name: nil, company_number: nil, company_tax_id: nil, company_zip: nil, description: nil, ibans: nil, peppol_ids: nil, smp_registration: nil, smp_registration_date: nil)
111
+ # Some parameter documentations has been truncated, see
112
+ # {EInvoiceAPI::Models::MeRetrieveResponse} for more details.
113
+ #
102
114
  # @param credit_balance [Integer] Credit balance of the tenant
103
115
  #
104
116
  # @param name [String]
@@ -107,7 +119,7 @@ module EInvoiceAPI
107
119
  #
108
120
  # @param bcc_recipient_email [String, nil] BCC recipient email to deliver documents
109
121
  #
110
- # @param company_address [String, nil] Address of the company
122
+ # @param company_address [String, nil] Address of the company. Must be in the form of `Street Name Street Number`
111
123
  #
112
124
  # @param company_city [String, nil] City of the company
113
125
  #
@@ -115,9 +127,11 @@ module EInvoiceAPI
115
127
  #
116
128
  # @param company_email [String, nil] Email of the company
117
129
  #
118
- # @param company_name [String, nil] Name of the company
130
+ # @param company_name [String, nil] Name of the company. Must include the company type. For example: `BV`, `NV`, `CV
131
+ #
132
+ # @param company_number [String, nil] Company number. For Belgium this is the CBE number or their EUID (European Uniqu
119
133
  #
120
- # @param company_number [String, nil] Company number
134
+ # @param company_tax_id [String, nil] Company tax ID. For Belgium this is the VAT number. Must include the country pre
121
135
  #
122
136
  # @param company_zip [String, nil] Zip code of the company
123
137
  #
@@ -4,30 +4,41 @@ module EInvoiceAPI
4
4
  module Models
5
5
  class PaymentDetailCreate < EInvoiceAPI::Internal::Type::BaseModel
6
6
  # @!attribute bank_account_number
7
+ # Bank account number (for non-IBAN accounts)
7
8
  #
8
9
  # @return [String, nil]
9
10
  optional :bank_account_number, String, nil?: true
10
11
 
11
12
  # @!attribute iban
13
+ # International Bank Account Number for payment transfers
12
14
  #
13
15
  # @return [String, nil]
14
16
  optional :iban, String, nil?: true
15
17
 
16
18
  # @!attribute payment_reference
19
+ # Structured payment reference or communication (e.g., structured communication
20
+ # for Belgian bank transfers)
17
21
  #
18
22
  # @return [String, nil]
19
23
  optional :payment_reference, String, nil?: true
20
24
 
21
25
  # @!attribute swift
26
+ # SWIFT/BIC code of the bank
22
27
  #
23
28
  # @return [String, nil]
24
29
  optional :swift, String, nil?: true
25
30
 
26
31
  # @!method initialize(bank_account_number: nil, iban: nil, payment_reference: nil, swift: nil)
27
- # @param bank_account_number [String, nil]
28
- # @param iban [String, nil]
29
- # @param payment_reference [String, nil]
30
- # @param swift [String, nil]
32
+ # Some parameter documentations has been truncated, see
33
+ # {EInvoiceAPI::Models::PaymentDetailCreate} for more details.
34
+ #
35
+ # @param bank_account_number [String, nil] Bank account number (for non-IBAN accounts)
36
+ #
37
+ # @param iban [String, nil] International Bank Account Number for payment transfers
38
+ #
39
+ # @param payment_reference [String, nil] Structured payment reference or communication (e.g., structured communication fo
40
+ #
41
+ # @param swift [String, nil] SWIFT/BIC code of the bank
31
42
  end
32
43
  end
33
44
  end