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.
@@ -19,6 +19,7 @@ module EInvoiceAPI
19
19
  currency: EInvoiceAPI::CurrencyCode::OrSymbol,
20
20
  customer_address: T.nilable(String),
21
21
  customer_address_recipient: T.nilable(String),
22
+ customer_company_id: T.nilable(String),
22
23
  customer_email: T.nilable(String),
23
24
  customer_id: T.nilable(String),
24
25
  customer_name: T.nilable(String),
@@ -60,6 +61,7 @@ module EInvoiceAPI
60
61
  vatex_note: T.nilable(String),
61
62
  vendor_address: T.nilable(String),
62
63
  vendor_address_recipient: T.nilable(String),
64
+ vendor_company_id: T.nilable(String),
63
65
  vendor_email: T.nilable(String),
64
66
  vendor_name: T.nilable(String),
65
67
  vendor_tax_id: T.nilable(String),
@@ -68,70 +70,109 @@ module EInvoiceAPI
68
70
  end
69
71
  def validate_json(
70
72
  allowances: nil,
71
- # The amount due of the invoice. Must be positive and rounded to maximum 2
72
- # decimals
73
+ # The amount due for payment. Must be positive and rounded to maximum 2 decimals
73
74
  amount_due: nil,
74
75
  attachments: nil,
76
+ # The billing address (if different from customer address)
75
77
  billing_address: nil,
78
+ # The recipient name at the billing address
76
79
  billing_address_recipient: nil,
77
80
  charges: nil,
78
- # Currency of the invoice
81
+ # Currency of the invoice (ISO 4217 currency code)
79
82
  currency: nil,
83
+ # The address of the customer/buyer
80
84
  customer_address: nil,
85
+ # The recipient name at the customer address
81
86
  customer_address_recipient: nil,
87
+ # Customer company ID. For Belgium this is the CBE number or their EUID (European
88
+ # Unique Identifier) number. In the Netherlands this is the KVK number.
89
+ customer_company_id: nil,
90
+ # The email address of the customer
82
91
  customer_email: nil,
92
+ # The unique identifier for the customer in your system
83
93
  customer_id: nil,
94
+ # The company name of the customer/buyer
84
95
  customer_name: nil,
96
+ # Customer tax ID. For Belgium this is the VAT number. Must include the country
97
+ # prefix
85
98
  customer_tax_id: nil,
99
+ # The direction of the document: INBOUND (purchases) or OUTBOUND (sales)
86
100
  direction: nil,
101
+ # The type of document: INVOICE, CREDIT_NOTE, or DEBIT_NOTE
87
102
  document_type: nil,
103
+ # The date when payment is due
88
104
  due_date: nil,
105
+ # The date when the invoice was issued
89
106
  invoice_date: nil,
107
+ # The unique invoice identifier/number
90
108
  invoice_id: nil,
91
- # The total amount of the invoice (so invoice_total = subtotal + total_tax +
92
- # total_discount). Must be positive and rounded to maximum 2 decimals
109
+ # The total amount of the invoice including tax (invoice_total = subtotal +
110
+ # total_tax + total_discount). Must be positive and rounded to maximum 2 decimals
93
111
  invoice_total: nil,
94
112
  # At least one line item is required
95
113
  items: nil,
114
+ # Additional notes or comments for the invoice
96
115
  note: nil,
97
116
  payment_details: nil,
117
+ # The payment terms (e.g., 'Net 30', 'Due on receipt', '2/10 Net 30')
98
118
  payment_term: nil,
99
- # The previous unpaid balance of the invoice, if any. Must be positive and rounded
100
- # to maximum 2 decimals
119
+ # The previous unpaid balance from prior invoices, if any. Must be positive and
120
+ # rounded to maximum 2 decimals
101
121
  previous_unpaid_balance: nil,
122
+ # The purchase order reference number
102
123
  purchase_order: nil,
124
+ # The address where payment should be sent or remitted to
103
125
  remittance_address: nil,
126
+ # The recipient name at the remittance address
104
127
  remittance_address_recipient: nil,
128
+ # The address where services were performed or goods were delivered
105
129
  service_address: nil,
130
+ # The recipient name at the service address
106
131
  service_address_recipient: nil,
132
+ # The end date of the service period or delivery period
107
133
  service_end_date: nil,
134
+ # The start date of the service period or delivery period
108
135
  service_start_date: nil,
136
+ # The shipping/delivery address
109
137
  shipping_address: nil,
138
+ # The recipient name at the shipping address
110
139
  shipping_address_recipient: nil,
140
+ # The current state of the document: DRAFT, TRANSIT, FAILED, SENT, or RECEIVED
111
141
  state: nil,
112
142
  # The taxable base of the invoice. Should be the sum of all line items -
113
143
  # allowances (for example commercial discounts) + charges with impact on VAT. Must
114
144
  # be positive and rounded to maximum 2 decimals
115
145
  subtotal: nil,
116
- # Tax category code of the invoice
146
+ # Tax category code of the invoice (e.g., S for standard rate, Z for zero rate, E
147
+ # for exempt)
117
148
  tax_code: nil,
118
149
  tax_details: nil,
119
150
  # The net financial discount/charge of the invoice (non-VAT charges minus non-VAT
120
151
  # allowances). Can be positive (net charge), negative (net discount), or zero.
121
152
  # Must be rounded to maximum 2 decimals
122
153
  total_discount: nil,
123
- # The total tax of the invoice. Must be positive and rounded to maximum 2 decimals
154
+ # The total tax amount of the invoice. Must be positive and rounded to maximum 2
155
+ # decimals
124
156
  total_tax: nil,
125
157
  # VATEX code list for VAT exemption reasons
126
158
  #
127
159
  # Agency: CEF Identifier: vatex
128
160
  vatex: nil,
129
- # VAT exemption note of the invoice
161
+ # Textual explanation for VAT exemption
130
162
  vatex_note: nil,
163
+ # The address of the vendor/seller
131
164
  vendor_address: nil,
165
+ # The recipient name at the vendor address
132
166
  vendor_address_recipient: nil,
167
+ # Vendor company ID. For Belgium this is the CBE number or their EUID (European
168
+ # Unique Identifier) number. In the Netherlands this is the KVK number.
169
+ vendor_company_id: nil,
170
+ # The email address of the vendor
133
171
  vendor_email: nil,
172
+ # The name of the vendor/seller/supplier
134
173
  vendor_name: nil,
174
+ # Vendor tax ID. For Belgium this is the VAT number. Must include the country
175
+ # prefix
135
176
  vendor_tax_id: nil,
136
177
  request_options: {}
137
178
  )
@@ -11,6 +11,7 @@ module EInvoiceAPI
11
11
  currency: EInvoiceAPI::Models::currency_code,
12
12
  customer_address: String?,
13
13
  customer_address_recipient: String?,
14
+ customer_company_id: String?,
14
15
  customer_email: String?,
15
16
  customer_id: String?,
16
17
  customer_name: String?,
@@ -45,6 +46,7 @@ module EInvoiceAPI
45
46
  vatex_note: String?,
46
47
  vendor_address: String?,
47
48
  vendor_address_recipient: String?,
49
+ vendor_company_id: String?,
48
50
  vendor_email: String?,
49
51
  vendor_name: String?,
50
52
  vendor_tax_id: String?
@@ -73,6 +75,8 @@ module EInvoiceAPI
73
75
 
74
76
  attr_accessor customer_address_recipient: String?
75
77
 
78
+ attr_accessor customer_company_id: String?
79
+
76
80
  attr_accessor customer_email: String?
77
81
 
78
82
  attr_accessor customer_id: String?
@@ -161,6 +165,8 @@ module EInvoiceAPI
161
165
 
162
166
  attr_accessor vendor_address_recipient: String?
163
167
 
168
+ attr_accessor vendor_company_id: String?
169
+
164
170
  attr_accessor vendor_email: String?
165
171
 
166
172
  attr_accessor vendor_name: String?
@@ -177,6 +183,7 @@ module EInvoiceAPI
177
183
  ?currency: EInvoiceAPI::Models::currency_code,
178
184
  ?customer_address: String?,
179
185
  ?customer_address_recipient: String?,
186
+ ?customer_company_id: String?,
180
187
  ?customer_email: String?,
181
188
  ?customer_id: String?,
182
189
  ?customer_name: String?,
@@ -211,6 +218,7 @@ module EInvoiceAPI
211
218
  ?vatex_note: String?,
212
219
  ?vendor_address: String?,
213
220
  ?vendor_address_recipient: String?,
221
+ ?vendor_company_id: String?,
214
222
  ?vendor_email: String?,
215
223
  ?vendor_name: String?,
216
224
  ?vendor_tax_id: String?
@@ -226,6 +234,7 @@ module EInvoiceAPI
226
234
  currency: EInvoiceAPI::Models::currency_code,
227
235
  customer_address: String?,
228
236
  customer_address_recipient: String?,
237
+ customer_company_id: String?,
229
238
  customer_email: String?,
230
239
  customer_id: String?,
231
240
  customer_name: String?,
@@ -260,6 +269,7 @@ module EInvoiceAPI
260
269
  vatex_note: String?,
261
270
  vendor_address: String?,
262
271
  vendor_address_recipient: String?,
272
+ vendor_company_id: String?,
263
273
  vendor_email: String?,
264
274
  vendor_name: String?,
265
275
  vendor_tax_id: String?
@@ -11,6 +11,7 @@ module EInvoiceAPI
11
11
  currency: EInvoiceAPI::Models::currency_code,
12
12
  customer_address: String?,
13
13
  customer_address_recipient: String?,
14
+ customer_company_id: String?,
14
15
  customer_email: String?,
15
16
  customer_id: String?,
16
17
  customer_name: String?,
@@ -47,6 +48,7 @@ module EInvoiceAPI
47
48
  vatex_note: String?,
48
49
  vendor_address: String?,
49
50
  vendor_address_recipient: String?,
51
+ vendor_company_id: String?,
50
52
  vendor_email: String?,
51
53
  vendor_name: String?,
52
54
  vendor_tax_id: String?
@@ -75,6 +77,8 @@ module EInvoiceAPI
75
77
 
76
78
  attr_accessor customer_address_recipient: String?
77
79
 
80
+ attr_accessor customer_company_id: String?
81
+
78
82
  attr_accessor customer_email: String?
79
83
 
80
84
  attr_accessor customer_id: String?
@@ -169,6 +173,8 @@ module EInvoiceAPI
169
173
 
170
174
  attr_accessor vendor_address_recipient: String?
171
175
 
176
+ attr_accessor vendor_company_id: String?
177
+
172
178
  attr_accessor vendor_email: String?
173
179
 
174
180
  attr_accessor vendor_name: String?
@@ -185,6 +191,7 @@ module EInvoiceAPI
185
191
  ?currency: EInvoiceAPI::Models::currency_code,
186
192
  ?customer_address: String?,
187
193
  ?customer_address_recipient: String?,
194
+ ?customer_company_id: String?,
188
195
  ?customer_email: String?,
189
196
  ?customer_id: String?,
190
197
  ?customer_name: String?,
@@ -221,6 +228,7 @@ module EInvoiceAPI
221
228
  ?vatex_note: String?,
222
229
  ?vendor_address: String?,
223
230
  ?vendor_address_recipient: String?,
231
+ ?vendor_company_id: String?,
224
232
  ?vendor_email: String?,
225
233
  ?vendor_name: String?,
226
234
  ?vendor_tax_id: String?
@@ -236,6 +244,7 @@ module EInvoiceAPI
236
244
  currency: EInvoiceAPI::Models::currency_code,
237
245
  customer_address: String?,
238
246
  customer_address_recipient: String?,
247
+ customer_company_id: String?,
239
248
  customer_email: String?,
240
249
  customer_id: String?,
241
250
  customer_name: String?,
@@ -272,6 +281,7 @@ module EInvoiceAPI
272
281
  vatex_note: String?,
273
282
  vendor_address: String?,
274
283
  vendor_address_recipient: String?,
284
+ vendor_company_id: String?,
275
285
  vendor_email: String?,
276
286
  vendor_name: String?,
277
287
  vendor_tax_id: String?
@@ -12,6 +12,7 @@ module EInvoiceAPI
12
12
  currency: EInvoiceAPI::Models::currency_code,
13
13
  customer_address: String?,
14
14
  customer_address_recipient: String?,
15
+ customer_company_id: String?,
15
16
  customer_email: String?,
16
17
  customer_id: String?,
17
18
  customer_name: String?,
@@ -46,6 +47,7 @@ module EInvoiceAPI
46
47
  vatex_note: String?,
47
48
  vendor_address: String?,
48
49
  vendor_address_recipient: String?,
50
+ vendor_company_id: String?,
49
51
  vendor_email: String?,
50
52
  vendor_name: String?,
51
53
  vendor_tax_id: String?
@@ -76,6 +78,8 @@ module EInvoiceAPI
76
78
 
77
79
  attr_accessor customer_address_recipient: String?
78
80
 
81
+ attr_accessor customer_company_id: String?
82
+
79
83
  attr_accessor customer_email: String?
80
84
 
81
85
  attr_accessor customer_id: String?
@@ -160,6 +164,8 @@ module EInvoiceAPI
160
164
 
161
165
  attr_accessor vendor_address_recipient: String?
162
166
 
167
+ attr_accessor vendor_company_id: String?
168
+
163
169
  attr_accessor vendor_email: String?
164
170
 
165
171
  attr_accessor vendor_name: String?
@@ -177,6 +183,7 @@ module EInvoiceAPI
177
183
  ?currency: EInvoiceAPI::Models::currency_code,
178
184
  ?customer_address: String?,
179
185
  ?customer_address_recipient: String?,
186
+ ?customer_company_id: String?,
180
187
  ?customer_email: String?,
181
188
  ?customer_id: String?,
182
189
  ?customer_name: String?,
@@ -211,6 +218,7 @@ module EInvoiceAPI
211
218
  ?vatex_note: String?,
212
219
  ?vendor_address: String?,
213
220
  ?vendor_address_recipient: String?,
221
+ ?vendor_company_id: String?,
214
222
  ?vendor_email: String?,
215
223
  ?vendor_name: String?,
216
224
  ?vendor_tax_id: String?
@@ -227,6 +235,7 @@ module EInvoiceAPI
227
235
  currency: EInvoiceAPI::Models::currency_code,
228
236
  customer_address: String?,
229
237
  customer_address_recipient: String?,
238
+ customer_company_id: String?,
230
239
  customer_email: String?,
231
240
  customer_id: String?,
232
241
  customer_name: String?,
@@ -261,6 +270,7 @@ module EInvoiceAPI
261
270
  vatex_note: String?,
262
271
  vendor_address: String?,
263
272
  vendor_address_recipient: String?,
273
+ vendor_company_id: String?,
264
274
  vendor_email: String?,
265
275
  vendor_name: String?,
266
276
  vendor_tax_id: String?
@@ -12,6 +12,7 @@ module EInvoiceAPI
12
12
  company_email: String?,
13
13
  company_name: String?,
14
14
  company_number: String?,
15
+ company_tax_id: String?,
15
16
  company_zip: String?,
16
17
  description: String?,
17
18
  ibans: ::Array[String]?,
@@ -41,6 +42,8 @@ module EInvoiceAPI
41
42
 
42
43
  attr_accessor company_number: String?
43
44
 
45
+ attr_accessor company_tax_id: String?
46
+
44
47
  attr_accessor company_zip: String?
45
48
 
46
49
  attr_accessor description: String?
@@ -64,6 +67,7 @@ module EInvoiceAPI
64
67
  ?company_email: String?,
65
68
  ?company_name: String?,
66
69
  ?company_number: String?,
70
+ ?company_tax_id: String?,
67
71
  ?company_zip: String?,
68
72
  ?description: String?,
69
73
  ?ibans: ::Array[String]?,
@@ -83,6 +87,7 @@ module EInvoiceAPI
83
87
  company_email: String?,
84
88
  company_name: String?,
85
89
  company_number: String?,
90
+ company_tax_id: String?,
86
91
  company_zip: String?,
87
92
  description: String?,
88
93
  ibans: ::Array[String]?,
@@ -15,6 +15,7 @@ module EInvoiceAPI
15
15
  ?currency: EInvoiceAPI::Models::currency_code,
16
16
  ?customer_address: String?,
17
17
  ?customer_address_recipient: String?,
18
+ ?customer_company_id: String?,
18
19
  ?customer_email: String?,
19
20
  ?customer_id: String?,
20
21
  ?customer_name: String?,
@@ -49,6 +50,7 @@ module EInvoiceAPI
49
50
  ?vatex_note: String?,
50
51
  ?vendor_address: String?,
51
52
  ?vendor_address_recipient: String?,
53
+ ?vendor_company_id: String?,
52
54
  ?vendor_email: String?,
53
55
  ?vendor_name: String?,
54
56
  ?vendor_tax_id: String?,
@@ -11,6 +11,7 @@ module EInvoiceAPI
11
11
  ?currency: EInvoiceAPI::Models::currency_code,
12
12
  ?customer_address: String?,
13
13
  ?customer_address_recipient: String?,
14
+ ?customer_company_id: String?,
14
15
  ?customer_email: String?,
15
16
  ?customer_id: String?,
16
17
  ?customer_name: String?,
@@ -45,6 +46,7 @@ module EInvoiceAPI
45
46
  ?vatex_note: String?,
46
47
  ?vendor_address: String?,
47
48
  ?vendor_address_recipient: String?,
49
+ ?vendor_company_id: String?,
48
50
  ?vendor_email: String?,
49
51
  ?vendor_name: String?,
50
52
  ?vendor_tax_id: String?,
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: e-invoice-api
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.11.0
4
+ version: 0.13.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - e-invoice
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2025-11-06 00:00:00.000000000 Z
11
+ date: 2025-11-15 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: connection_pool