e-invoice-api 0.24.0 → 0.25.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.
- checksums.yaml +4 -4
- data/CHANGELOG.md +31 -0
- data/README.md +1 -1
- data/lib/e_invoice_api/internal/util.rb +31 -0
- data/lib/e_invoice_api/models/document_create.rb +1 -9
- data/lib/e_invoice_api/models/document_create_from_pdf_response.rb +1 -9
- data/lib/e_invoice_api/models/document_create_params.rb +1 -13
- data/lib/e_invoice_api/models/document_delete_params.rb +7 -1
- data/lib/e_invoice_api/models/document_response.rb +1 -16
- data/lib/e_invoice_api/models/document_retrieve_params.rb +7 -1
- data/lib/e_invoice_api/models/document_send_params.rb +7 -1
- data/lib/e_invoice_api/models/document_type.rb +0 -2
- data/lib/e_invoice_api/models/document_validate_params.rb +7 -1
- data/lib/e_invoice_api/models/documents/attachment_add_params.rb +7 -1
- data/lib/e_invoice_api/models/documents/attachment_delete_params.rb +7 -1
- data/lib/e_invoice_api/models/documents/attachment_list_params.rb +7 -1
- data/lib/e_invoice_api/models/documents/attachment_retrieve_params.rb +7 -1
- data/lib/e_invoice_api/models/documents/ubl_get_params.rb +7 -1
- data/lib/e_invoice_api/models/inbox_list_credit_notes_params.rb +1 -44
- data/lib/e_invoice_api/models/inbox_list_invoices_params.rb +1 -44
- data/lib/e_invoice_api/models/inbox_list_params.rb +10 -45
- data/lib/e_invoice_api/models/lookup_retrieve_response.rb +1 -17
- data/lib/e_invoice_api/models/me_retrieve_response.rb +17 -17
- data/lib/e_invoice_api/models/outbox_list_draft_documents_params.rb +1 -68
- data/lib/e_invoice_api/models/outbox_list_received_documents_params.rb +10 -57
- data/lib/e_invoice_api/models/paginated_document_response.rb +1 -7
- data/lib/e_invoice_api/models/webhook_delete_params.rb +7 -1
- data/lib/e_invoice_api/models/webhook_retrieve_params.rb +7 -1
- data/lib/e_invoice_api/models/webhook_update_params.rb +7 -1
- data/lib/e_invoice_api/resources/documents/attachments.rb +2 -4
- data/lib/e_invoice_api/resources/documents.rb +56 -65
- data/lib/e_invoice_api/resources/inbox.rb +12 -19
- data/lib/e_invoice_api/resources/lookup.rb +4 -2
- data/lib/e_invoice_api/resources/outbox.rb +10 -28
- data/lib/e_invoice_api/resources/validate.rb +3 -4
- data/lib/e_invoice_api/version.rb +1 -1
- data/rbi/e_invoice_api/internal/util.rbi +20 -0
- data/rbi/e_invoice_api/models/document_create.rbi +0 -8
- data/rbi/e_invoice_api/models/document_create_from_pdf_response.rbi +0 -8
- data/rbi/e_invoice_api/models/document_create_params.rbi +5 -26
- data/rbi/e_invoice_api/models/document_delete_params.rbi +13 -5
- data/rbi/e_invoice_api/models/document_response.rbi +0 -14
- data/rbi/e_invoice_api/models/document_retrieve_params.rbi +13 -5
- data/rbi/e_invoice_api/models/document_send_params.rbi +6 -0
- data/rbi/e_invoice_api/models/document_type.rbi +0 -4
- data/rbi/e_invoice_api/models/document_validate_params.rbi +13 -5
- data/rbi/e_invoice_api/models/documents/attachment_add_params.rbi +6 -1
- data/rbi/e_invoice_api/models/documents/attachment_delete_params.rbi +6 -1
- data/rbi/e_invoice_api/models/documents/attachment_list_params.rbi +14 -5
- data/rbi/e_invoice_api/models/documents/attachment_retrieve_params.rbi +6 -1
- data/rbi/e_invoice_api/models/documents/ubl_get_params.rbi +14 -5
- data/rbi/e_invoice_api/models/inbox_list_credit_notes_params.rbi +0 -132
- data/rbi/e_invoice_api/models/inbox_list_invoices_params.rbi +0 -126
- data/rbi/e_invoice_api/models/inbox_list_params.rbi +11 -100
- data/rbi/e_invoice_api/models/lookup_retrieve_response.rbi +3 -19
- data/rbi/e_invoice_api/models/me_retrieve_response.rbi +18 -30
- data/rbi/e_invoice_api/models/outbox_list_draft_documents_params.rbi +0 -163
- data/rbi/e_invoice_api/models/outbox_list_received_documents_params.rbi +11 -156
- data/rbi/e_invoice_api/models/paginated_document_response.rbi +1 -6
- data/rbi/e_invoice_api/models/webhook_delete_params.rbi +13 -5
- data/rbi/e_invoice_api/models/webhook_retrieve_params.rbi +13 -5
- data/rbi/e_invoice_api/models/webhook_update_params.rbi +12 -1
- data/rbi/e_invoice_api/resources/documents/attachments.rbi +2 -4
- data/rbi/e_invoice_api/resources/documents.rbi +56 -78
- data/rbi/e_invoice_api/resources/inbox.rbi +5 -21
- data/rbi/e_invoice_api/resources/outbox.rbi +6 -33
- data/rbi/e_invoice_api/resources/validate.rbi +0 -3
- data/sig/e_invoice_api/internal/util.rbs +10 -0
- data/sig/e_invoice_api/models/document_create.rbs +0 -5
- data/sig/e_invoice_api/models/document_create_from_pdf_response.rbs +0 -5
- data/sig/e_invoice_api/models/document_create_params.rbs +3 -13
- data/sig/e_invoice_api/models/document_delete_params.rbs +11 -3
- data/sig/e_invoice_api/models/document_response.rbs +0 -10
- data/sig/e_invoice_api/models/document_retrieve_params.rbs +11 -3
- data/sig/e_invoice_api/models/document_send_params.rbs +5 -0
- data/sig/e_invoice_api/models/document_type.rbs +1 -8
- data/sig/e_invoice_api/models/document_validate_params.rbs +11 -3
- data/sig/e_invoice_api/models/documents/attachment_add_params.rbs +5 -1
- data/sig/e_invoice_api/models/documents/attachment_delete_params.rbs +5 -1
- data/sig/e_invoice_api/models/documents/attachment_list_params.rbs +12 -3
- data/sig/e_invoice_api/models/documents/attachment_retrieve_params.rbs +5 -1
- data/sig/e_invoice_api/models/documents/ubl_get_params.rbs +12 -3
- data/sig/e_invoice_api/models/inbox_list_credit_notes_params.rbs +1 -56
- data/sig/e_invoice_api/models/inbox_list_invoices_params.rbs +1 -56
- data/sig/e_invoice_api/models/inbox_list_params.rbs +4 -51
- data/sig/e_invoice_api/models/lookup_retrieve_response.rbs +3 -13
- data/sig/e_invoice_api/models/me_retrieve_response.rbs +10 -16
- data/sig/e_invoice_api/models/outbox_list_draft_documents_params.rbs +1 -71
- data/sig/e_invoice_api/models/outbox_list_received_documents_params.rbs +4 -56
- data/sig/e_invoice_api/models/paginated_document_response.rbs +0 -5
- data/sig/e_invoice_api/models/webhook_delete_params.rbs +11 -3
- data/sig/e_invoice_api/models/webhook_retrieve_params.rbs +11 -3
- data/sig/e_invoice_api/models/webhook_update_params.rbs +10 -1
- data/sig/e_invoice_api/resources/documents.rbs +0 -2
- data/sig/e_invoice_api/resources/inbox.rbs +1 -6
- data/sig/e_invoice_api/resources/outbox.rbs +1 -8
- data/sig/e_invoice_api/resources/validate.rbs +0 -1
- metadata +2 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 33c96f54fdf2c6d53e4375effa39c59342c7fa32cb2aa19ed6204c3efcab4861
|
|
4
|
+
data.tar.gz: e8975bc00e020a94d865b0fff93c44d37d8b88ee879e0d3e4d322fcbfcc36c96
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 9dcbd7f9256193fa87e1becbd6623c600034562f72aaf8b3dd1016204b852ec61626c2587e033acc324c2d66f754ffdba06dc2c7f91c967a6360fd53c3779c34
|
|
7
|
+
data.tar.gz: 7a62a21175e5386d2e1632dc44d06e857485b1dcb9041e4c73776f5ed6e6a89ab3208b94646ffff2327cd74cb4622512f2e080a3eba3674f96158e0c3e36eaa5
|
data/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,36 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## 0.25.0 (2026-03-09)
|
|
4
|
+
|
|
5
|
+
Full Changelog: [v0.24.1...v0.25.0](https://github.com/e-invoice-be/e-invoice-rb/compare/v0.24.1...v0.25.0)
|
|
6
|
+
|
|
7
|
+
### Features
|
|
8
|
+
|
|
9
|
+
* **api:** api update ([1ddf3a7](https://github.com/e-invoice-be/e-invoice-rb/commit/1ddf3a7ff1a45ec8bf41330acda0fd423e106ae4))
|
|
10
|
+
|
|
11
|
+
|
|
12
|
+
### Chores
|
|
13
|
+
|
|
14
|
+
* **ci:** add build step ([b48f5ff](https://github.com/e-invoice-be/e-invoice-rb/commit/b48f5fffbbf62a14f99c8773657e7290de5cc3b8))
|
|
15
|
+
* **ci:** skip uploading artifacts on stainless-internal branches ([24d4e8b](https://github.com/e-invoice-be/e-invoice-rb/commit/24d4e8b599b40467668c0b2546316f56da852a24))
|
|
16
|
+
* **internal:** codegen related update ([413ebdf](https://github.com/e-invoice-be/e-invoice-rb/commit/413ebdf6f0651dc190507f8dac2f0613cbc577e4))
|
|
17
|
+
* **internal:** codegen related update ([90aacdf](https://github.com/e-invoice-be/e-invoice-rb/commit/90aacdf2d72161fd78bed080d67362d317e262d0))
|
|
18
|
+
* update placeholder string ([ba061b0](https://github.com/e-invoice-be/e-invoice-rb/commit/ba061b082989675ed4c4dbcf79e3c6fc429ba7cd))
|
|
19
|
+
|
|
20
|
+
## 0.24.1 (2026-02-27)
|
|
21
|
+
|
|
22
|
+
Full Changelog: [v0.24.0...v0.24.1](https://github.com/e-invoice-be/e-invoice-rb/compare/v0.24.0...v0.24.1)
|
|
23
|
+
|
|
24
|
+
### Bug Fixes
|
|
25
|
+
|
|
26
|
+
* properly mock time in ruby ci tests ([52ec541](https://github.com/e-invoice-be/e-invoice-rb/commit/52ec541253abb91ffc061779a8f7023d542414b2))
|
|
27
|
+
|
|
28
|
+
|
|
29
|
+
### Chores
|
|
30
|
+
|
|
31
|
+
* **internal:** remove mock server code ([b32ab61](https://github.com/e-invoice-be/e-invoice-rb/commit/b32ab61227d3ebcd872f1ac9c5860628538d81a4))
|
|
32
|
+
* update mock server docs ([bfae676](https://github.com/e-invoice-be/e-invoice-rb/commit/bfae6768aa2e0b22c35690209664a8973bc34077))
|
|
33
|
+
|
|
3
34
|
## 0.24.0 (2026-02-16)
|
|
4
35
|
|
|
5
36
|
Full Changelog: [v0.23.0...v0.24.0](https://github.com/e-invoice-be/e-invoice-rb/compare/v0.23.0...v0.24.0)
|
data/README.md
CHANGED
|
@@ -490,6 +490,37 @@ module EInvoiceAPI
|
|
|
490
490
|
JSONL_CONTENT = %r{^application/(:?x-(?:n|l)djson)|(:?(?:x-)?jsonl)}
|
|
491
491
|
|
|
492
492
|
class << self
|
|
493
|
+
# @api private
|
|
494
|
+
#
|
|
495
|
+
# @param query [Hash{Symbol=>Object}]
|
|
496
|
+
#
|
|
497
|
+
# @return [Hash{Symbol=>Object}]
|
|
498
|
+
def encode_query_params(query)
|
|
499
|
+
out = {}
|
|
500
|
+
query.each { write_query_param_element!(out, _1, _2) }
|
|
501
|
+
out
|
|
502
|
+
end
|
|
503
|
+
|
|
504
|
+
# @api private
|
|
505
|
+
#
|
|
506
|
+
# @param collection [Hash{Symbol=>Object}]
|
|
507
|
+
# @param key [String]
|
|
508
|
+
# @param element [Object]
|
|
509
|
+
#
|
|
510
|
+
# @return [nil]
|
|
511
|
+
private def write_query_param_element!(collection, key, element)
|
|
512
|
+
case element
|
|
513
|
+
in Hash
|
|
514
|
+
element.each do |name, value|
|
|
515
|
+
write_query_param_element!(collection, "#{key}[#{name}]", value)
|
|
516
|
+
end
|
|
517
|
+
in Array
|
|
518
|
+
collection[key] = element.map(&:to_s).join(",")
|
|
519
|
+
else
|
|
520
|
+
collection[key] = element.to_s
|
|
521
|
+
end
|
|
522
|
+
end
|
|
523
|
+
|
|
493
524
|
# @api private
|
|
494
525
|
#
|
|
495
526
|
# @param y [Enumerator::Yielder]
|
|
@@ -85,12 +85,6 @@ module EInvoiceAPI
|
|
|
85
85
|
# @return [String, nil]
|
|
86
86
|
optional :customer_name, String, nil?: true
|
|
87
87
|
|
|
88
|
-
# @!attribute customer_peppol_id
|
|
89
|
-
# Customer Peppol ID
|
|
90
|
-
#
|
|
91
|
-
# @return [String, nil]
|
|
92
|
-
optional :customer_peppol_id, String, nil?: true
|
|
93
|
-
|
|
94
88
|
# @!attribute customer_tax_id
|
|
95
89
|
# Customer tax ID. For Belgium this is the VAT number. Must include the country
|
|
96
90
|
# prefix
|
|
@@ -318,7 +312,7 @@ module EInvoiceAPI
|
|
|
318
312
|
# @return [String, nil]
|
|
319
313
|
optional :vendor_tax_id, String, nil?: true
|
|
320
314
|
|
|
321
|
-
# @!method initialize(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,
|
|
315
|
+
# @!method initialize(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)
|
|
322
316
|
# Some parameter documentations has been truncated, see
|
|
323
317
|
# {EInvoiceAPI::Models::DocumentCreate} for more details.
|
|
324
318
|
#
|
|
@@ -348,8 +342,6 @@ module EInvoiceAPI
|
|
|
348
342
|
#
|
|
349
343
|
# @param customer_name [String, nil] The company name of the customer/buyer
|
|
350
344
|
#
|
|
351
|
-
# @param customer_peppol_id [String, nil] Customer Peppol ID
|
|
352
|
-
#
|
|
353
345
|
# @param customer_tax_id [String, nil] Customer tax ID. For Belgium this is the VAT number. Must include the country pr
|
|
354
346
|
#
|
|
355
347
|
# @param direction [Symbol, EInvoiceAPI::Models::DocumentDirection] The direction of the document: INBOUND (purchases) or OUTBOUND (sales)
|
|
@@ -82,12 +82,6 @@ module EInvoiceAPI
|
|
|
82
82
|
# @return [String, nil]
|
|
83
83
|
optional :customer_name, String, nil?: true
|
|
84
84
|
|
|
85
|
-
# @!attribute customer_peppol_id
|
|
86
|
-
# Customer Peppol ID
|
|
87
|
-
#
|
|
88
|
-
# @return [String, nil]
|
|
89
|
-
optional :customer_peppol_id, String, nil?: true
|
|
90
|
-
|
|
91
85
|
# @!attribute customer_tax_id
|
|
92
86
|
# Customer tax ID. For Belgium this is the VAT number. Must include the country
|
|
93
87
|
# prefix
|
|
@@ -319,7 +313,7 @@ module EInvoiceAPI
|
|
|
319
313
|
# @return [String, nil]
|
|
320
314
|
optional :vendor_tax_id, String, nil?: true
|
|
321
315
|
|
|
322
|
-
# @!method initialize(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,
|
|
316
|
+
# @!method initialize(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, 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, success: nil, tax_code: nil, tax_details: nil, total_discount: nil, total_tax: nil, ubl_document: 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)
|
|
323
317
|
# Some parameter documentations has been truncated, see
|
|
324
318
|
# {EInvoiceAPI::Models::DocumentCreateFromPdfResponse} for more details.
|
|
325
319
|
#
|
|
@@ -349,8 +343,6 @@ module EInvoiceAPI
|
|
|
349
343
|
#
|
|
350
344
|
# @param customer_name [String, nil] The company name of the customer/buyer
|
|
351
345
|
#
|
|
352
|
-
# @param customer_peppol_id [String, nil] Customer Peppol ID
|
|
353
|
-
#
|
|
354
346
|
# @param customer_tax_id [String, nil] Customer tax ID. For Belgium this is the VAT number. Must include the country pr
|
|
355
347
|
#
|
|
356
348
|
# @param direction [Symbol, EInvoiceAPI::Models::DocumentDirection] The direction of the document: INBOUND (purchases) or OUTBOUND (sales)
|
|
@@ -7,19 +7,7 @@ module EInvoiceAPI
|
|
|
7
7
|
extend EInvoiceAPI::Internal::Type::RequestParameters::Converter
|
|
8
8
|
include EInvoiceAPI::Internal::Type::RequestParameters
|
|
9
9
|
|
|
10
|
-
# @!
|
|
11
|
-
# If true, generate a constructed PDF from the document and include it both as
|
|
12
|
-
# document attachment and embedded in the UBL.
|
|
13
|
-
#
|
|
14
|
-
# @return [Boolean, nil]
|
|
15
|
-
optional :construct_pdf, EInvoiceAPI::Internal::Type::Boolean
|
|
16
|
-
|
|
17
|
-
# @!method initialize(construct_pdf: nil, request_options: {})
|
|
18
|
-
# Some parameter documentations has been truncated, see
|
|
19
|
-
# {EInvoiceAPI::Models::DocumentCreateParams} for more details.
|
|
20
|
-
#
|
|
21
|
-
# @param construct_pdf [Boolean] If true, generate a constructed PDF from the document and include it both as doc
|
|
22
|
-
#
|
|
10
|
+
# @!method initialize(request_options: {})
|
|
23
11
|
# @param request_options [EInvoiceAPI::RequestOptions, Hash{Symbol=>Object}]
|
|
24
12
|
end
|
|
25
13
|
end
|
|
@@ -7,7 +7,13 @@ module EInvoiceAPI
|
|
|
7
7
|
extend EInvoiceAPI::Internal::Type::RequestParameters::Converter
|
|
8
8
|
include EInvoiceAPI::Internal::Type::RequestParameters
|
|
9
9
|
|
|
10
|
-
# @!
|
|
10
|
+
# @!attribute document_id
|
|
11
|
+
#
|
|
12
|
+
# @return [String]
|
|
13
|
+
required :document_id, String
|
|
14
|
+
|
|
15
|
+
# @!method initialize(document_id:, request_options: {})
|
|
16
|
+
# @param document_id [String]
|
|
11
17
|
# @param request_options [EInvoiceAPI::RequestOptions, Hash{Symbol=>Object}]
|
|
12
18
|
end
|
|
13
19
|
end
|
|
@@ -9,11 +9,6 @@ module EInvoiceAPI
|
|
|
9
9
|
# @return [String]
|
|
10
10
|
required :id, String
|
|
11
11
|
|
|
12
|
-
# @!attribute created_at
|
|
13
|
-
#
|
|
14
|
-
# @return [Time]
|
|
15
|
-
required :created_at, Time
|
|
16
|
-
|
|
17
12
|
# @!attribute allowances
|
|
18
13
|
#
|
|
19
14
|
# @return [Array<EInvoiceAPI::Models::DocumentResponse::Allowance>, nil]
|
|
@@ -96,12 +91,6 @@ module EInvoiceAPI
|
|
|
96
91
|
# @return [String, nil]
|
|
97
92
|
optional :customer_name, String, nil?: true
|
|
98
93
|
|
|
99
|
-
# @!attribute customer_peppol_id
|
|
100
|
-
# Customer Peppol ID
|
|
101
|
-
#
|
|
102
|
-
# @return [String, nil]
|
|
103
|
-
optional :customer_peppol_id, String, nil?: true
|
|
104
|
-
|
|
105
94
|
# @!attribute customer_tax_id
|
|
106
95
|
# Customer tax ID. For Belgium this is the VAT number. Must include the country
|
|
107
96
|
# prefix
|
|
@@ -321,14 +310,12 @@ module EInvoiceAPI
|
|
|
321
310
|
# @return [String, nil]
|
|
322
311
|
optional :vendor_tax_id, String, nil?: true
|
|
323
312
|
|
|
324
|
-
# @!method initialize(id:,
|
|
313
|
+
# @!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, 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)
|
|
325
314
|
# Some parameter documentations has been truncated, see
|
|
326
315
|
# {EInvoiceAPI::Models::DocumentResponse} for more details.
|
|
327
316
|
#
|
|
328
317
|
# @param id [String]
|
|
329
318
|
#
|
|
330
|
-
# @param created_at [Time]
|
|
331
|
-
#
|
|
332
319
|
# @param allowances [Array<EInvoiceAPI::Models::DocumentResponse::Allowance>, nil]
|
|
333
320
|
#
|
|
334
321
|
# @param amount_due [String, nil] The amount due for payment. Must be positive and rounded to maximum 2 decimals
|
|
@@ -355,8 +342,6 @@ module EInvoiceAPI
|
|
|
355
342
|
#
|
|
356
343
|
# @param customer_name [String, nil] The company name of the customer/buyer
|
|
357
344
|
#
|
|
358
|
-
# @param customer_peppol_id [String, nil] Customer Peppol ID
|
|
359
|
-
#
|
|
360
345
|
# @param customer_tax_id [String, nil] Customer tax ID. For Belgium this is the VAT number. Must include the country pr
|
|
361
346
|
#
|
|
362
347
|
# @param direction [Symbol, EInvoiceAPI::Models::DocumentDirection] The direction of the document: INBOUND (purchases) or OUTBOUND (sales)
|
|
@@ -7,7 +7,13 @@ module EInvoiceAPI
|
|
|
7
7
|
extend EInvoiceAPI::Internal::Type::RequestParameters::Converter
|
|
8
8
|
include EInvoiceAPI::Internal::Type::RequestParameters
|
|
9
9
|
|
|
10
|
-
# @!
|
|
10
|
+
# @!attribute document_id
|
|
11
|
+
#
|
|
12
|
+
# @return [String]
|
|
13
|
+
required :document_id, String
|
|
14
|
+
|
|
15
|
+
# @!method initialize(document_id:, request_options: {})
|
|
16
|
+
# @param document_id [String]
|
|
11
17
|
# @param request_options [EInvoiceAPI::RequestOptions, Hash{Symbol=>Object}]
|
|
12
18
|
end
|
|
13
19
|
end
|
|
@@ -7,6 +7,11 @@ module EInvoiceAPI
|
|
|
7
7
|
extend EInvoiceAPI::Internal::Type::RequestParameters::Converter
|
|
8
8
|
include EInvoiceAPI::Internal::Type::RequestParameters
|
|
9
9
|
|
|
10
|
+
# @!attribute document_id
|
|
11
|
+
#
|
|
12
|
+
# @return [String]
|
|
13
|
+
required :document_id, String
|
|
14
|
+
|
|
10
15
|
# @!attribute email
|
|
11
16
|
#
|
|
12
17
|
# @return [String, nil]
|
|
@@ -32,7 +37,8 @@ module EInvoiceAPI
|
|
|
32
37
|
# @return [String, nil]
|
|
33
38
|
optional :sender_peppol_scheme, String, nil?: true
|
|
34
39
|
|
|
35
|
-
# @!method initialize(email: nil, receiver_peppol_id: nil, receiver_peppol_scheme: nil, sender_peppol_id: nil, sender_peppol_scheme: nil, request_options: {})
|
|
40
|
+
# @!method initialize(document_id:, email: nil, receiver_peppol_id: nil, receiver_peppol_scheme: nil, sender_peppol_id: nil, sender_peppol_scheme: nil, request_options: {})
|
|
41
|
+
# @param document_id [String]
|
|
36
42
|
# @param email [String, nil]
|
|
37
43
|
# @param receiver_peppol_id [String, nil]
|
|
38
44
|
# @param receiver_peppol_scheme [String, nil]
|
|
@@ -7,7 +7,13 @@ module EInvoiceAPI
|
|
|
7
7
|
extend EInvoiceAPI::Internal::Type::RequestParameters::Converter
|
|
8
8
|
include EInvoiceAPI::Internal::Type::RequestParameters
|
|
9
9
|
|
|
10
|
-
# @!
|
|
10
|
+
# @!attribute document_id
|
|
11
|
+
#
|
|
12
|
+
# @return [String]
|
|
13
|
+
required :document_id, String
|
|
14
|
+
|
|
15
|
+
# @!method initialize(document_id:, request_options: {})
|
|
16
|
+
# @param document_id [String]
|
|
11
17
|
# @param request_options [EInvoiceAPI::RequestOptions, Hash{Symbol=>Object}]
|
|
12
18
|
end
|
|
13
19
|
end
|
|
@@ -8,12 +8,18 @@ module EInvoiceAPI
|
|
|
8
8
|
extend EInvoiceAPI::Internal::Type::RequestParameters::Converter
|
|
9
9
|
include EInvoiceAPI::Internal::Type::RequestParameters
|
|
10
10
|
|
|
11
|
+
# @!attribute document_id
|
|
12
|
+
#
|
|
13
|
+
# @return [String]
|
|
14
|
+
required :document_id, String
|
|
15
|
+
|
|
11
16
|
# @!attribute file
|
|
12
17
|
#
|
|
13
18
|
# @return [Pathname, StringIO, IO, String, EInvoiceAPI::FilePart]
|
|
14
19
|
required :file, EInvoiceAPI::Internal::Type::FileInput
|
|
15
20
|
|
|
16
|
-
# @!method initialize(file:, request_options: {})
|
|
21
|
+
# @!method initialize(document_id:, file:, request_options: {})
|
|
22
|
+
# @param document_id [String]
|
|
17
23
|
# @param file [Pathname, StringIO, IO, String, EInvoiceAPI::FilePart]
|
|
18
24
|
# @param request_options [EInvoiceAPI::RequestOptions, Hash{Symbol=>Object}]
|
|
19
25
|
end
|
|
@@ -13,8 +13,14 @@ module EInvoiceAPI
|
|
|
13
13
|
# @return [String]
|
|
14
14
|
required :document_id, String
|
|
15
15
|
|
|
16
|
-
# @!
|
|
16
|
+
# @!attribute attachment_id
|
|
17
|
+
#
|
|
18
|
+
# @return [String]
|
|
19
|
+
required :attachment_id, String
|
|
20
|
+
|
|
21
|
+
# @!method initialize(document_id:, attachment_id:, request_options: {})
|
|
17
22
|
# @param document_id [String]
|
|
23
|
+
# @param attachment_id [String]
|
|
18
24
|
# @param request_options [EInvoiceAPI::RequestOptions, Hash{Symbol=>Object}]
|
|
19
25
|
end
|
|
20
26
|
end
|
|
@@ -8,7 +8,13 @@ module EInvoiceAPI
|
|
|
8
8
|
extend EInvoiceAPI::Internal::Type::RequestParameters::Converter
|
|
9
9
|
include EInvoiceAPI::Internal::Type::RequestParameters
|
|
10
10
|
|
|
11
|
-
# @!
|
|
11
|
+
# @!attribute document_id
|
|
12
|
+
#
|
|
13
|
+
# @return [String]
|
|
14
|
+
required :document_id, String
|
|
15
|
+
|
|
16
|
+
# @!method initialize(document_id:, request_options: {})
|
|
17
|
+
# @param document_id [String]
|
|
12
18
|
# @param request_options [EInvoiceAPI::RequestOptions, Hash{Symbol=>Object}]
|
|
13
19
|
end
|
|
14
20
|
end
|
|
@@ -13,8 +13,14 @@ module EInvoiceAPI
|
|
|
13
13
|
# @return [String]
|
|
14
14
|
required :document_id, String
|
|
15
15
|
|
|
16
|
-
# @!
|
|
16
|
+
# @!attribute attachment_id
|
|
17
|
+
#
|
|
18
|
+
# @return [String]
|
|
19
|
+
required :attachment_id, String
|
|
20
|
+
|
|
21
|
+
# @!method initialize(document_id:, attachment_id:, request_options: {})
|
|
17
22
|
# @param document_id [String]
|
|
23
|
+
# @param attachment_id [String]
|
|
18
24
|
# @param request_options [EInvoiceAPI::RequestOptions, Hash{Symbol=>Object}]
|
|
19
25
|
end
|
|
20
26
|
end
|
|
@@ -8,7 +8,13 @@ module EInvoiceAPI
|
|
|
8
8
|
extend EInvoiceAPI::Internal::Type::RequestParameters::Converter
|
|
9
9
|
include EInvoiceAPI::Internal::Type::RequestParameters
|
|
10
10
|
|
|
11
|
-
# @!
|
|
11
|
+
# @!attribute document_id
|
|
12
|
+
#
|
|
13
|
+
# @return [String]
|
|
14
|
+
required :document_id, String
|
|
15
|
+
|
|
16
|
+
# @!method initialize(document_id:, request_options: {})
|
|
17
|
+
# @param document_id [String]
|
|
12
18
|
# @param request_options [EInvoiceAPI::RequestOptions, Hash{Symbol=>Object}]
|
|
13
19
|
end
|
|
14
20
|
end
|
|
@@ -19,55 +19,12 @@ module EInvoiceAPI
|
|
|
19
19
|
# @return [Integer, nil]
|
|
20
20
|
optional :page_size, Integer
|
|
21
21
|
|
|
22
|
-
# @!
|
|
23
|
-
# Field to sort by
|
|
24
|
-
#
|
|
25
|
-
# @return [Symbol, EInvoiceAPI::Models::InboxListCreditNotesParams::SortBy, nil]
|
|
26
|
-
optional :sort_by, enum: -> { EInvoiceAPI::InboxListCreditNotesParams::SortBy }
|
|
27
|
-
|
|
28
|
-
# @!attribute sort_order
|
|
29
|
-
# Sort direction (asc/desc)
|
|
30
|
-
#
|
|
31
|
-
# @return [Symbol, EInvoiceAPI::Models::InboxListCreditNotesParams::SortOrder, nil]
|
|
32
|
-
optional :sort_order, enum: -> { EInvoiceAPI::InboxListCreditNotesParams::SortOrder }
|
|
33
|
-
|
|
34
|
-
# @!method initialize(page: nil, page_size: nil, sort_by: nil, sort_order: nil, request_options: {})
|
|
22
|
+
# @!method initialize(page: nil, page_size: nil, request_options: {})
|
|
35
23
|
# @param page [Integer] Page number
|
|
36
24
|
#
|
|
37
25
|
# @param page_size [Integer] Number of items per page
|
|
38
26
|
#
|
|
39
|
-
# @param sort_by [Symbol, EInvoiceAPI::Models::InboxListCreditNotesParams::SortBy] Field to sort by
|
|
40
|
-
#
|
|
41
|
-
# @param sort_order [Symbol, EInvoiceAPI::Models::InboxListCreditNotesParams::SortOrder] Sort direction (asc/desc)
|
|
42
|
-
#
|
|
43
27
|
# @param request_options [EInvoiceAPI::RequestOptions, Hash{Symbol=>Object}]
|
|
44
|
-
|
|
45
|
-
# Field to sort by
|
|
46
|
-
module SortBy
|
|
47
|
-
extend EInvoiceAPI::Internal::Type::Enum
|
|
48
|
-
|
|
49
|
-
CREATED_AT = :created_at
|
|
50
|
-
INVOICE_DATE = :invoice_date
|
|
51
|
-
DUE_DATE = :due_date
|
|
52
|
-
INVOICE_TOTAL = :invoice_total
|
|
53
|
-
CUSTOMER_NAME = :customer_name
|
|
54
|
-
VENDOR_NAME = :vendor_name
|
|
55
|
-
INVOICE_ID = :invoice_id
|
|
56
|
-
|
|
57
|
-
# @!method self.values
|
|
58
|
-
# @return [Array<Symbol>]
|
|
59
|
-
end
|
|
60
|
-
|
|
61
|
-
# Sort direction (asc/desc)
|
|
62
|
-
module SortOrder
|
|
63
|
-
extend EInvoiceAPI::Internal::Type::Enum
|
|
64
|
-
|
|
65
|
-
ASC = :asc
|
|
66
|
-
DESC = :desc
|
|
67
|
-
|
|
68
|
-
# @!method self.values
|
|
69
|
-
# @return [Array<Symbol>]
|
|
70
|
-
end
|
|
71
28
|
end
|
|
72
29
|
end
|
|
73
30
|
end
|
|
@@ -19,55 +19,12 @@ module EInvoiceAPI
|
|
|
19
19
|
# @return [Integer, nil]
|
|
20
20
|
optional :page_size, Integer
|
|
21
21
|
|
|
22
|
-
# @!
|
|
23
|
-
# Field to sort by
|
|
24
|
-
#
|
|
25
|
-
# @return [Symbol, EInvoiceAPI::Models::InboxListInvoicesParams::SortBy, nil]
|
|
26
|
-
optional :sort_by, enum: -> { EInvoiceAPI::InboxListInvoicesParams::SortBy }
|
|
27
|
-
|
|
28
|
-
# @!attribute sort_order
|
|
29
|
-
# Sort direction (asc/desc)
|
|
30
|
-
#
|
|
31
|
-
# @return [Symbol, EInvoiceAPI::Models::InboxListInvoicesParams::SortOrder, nil]
|
|
32
|
-
optional :sort_order, enum: -> { EInvoiceAPI::InboxListInvoicesParams::SortOrder }
|
|
33
|
-
|
|
34
|
-
# @!method initialize(page: nil, page_size: nil, sort_by: nil, sort_order: nil, request_options: {})
|
|
22
|
+
# @!method initialize(page: nil, page_size: nil, request_options: {})
|
|
35
23
|
# @param page [Integer] Page number
|
|
36
24
|
#
|
|
37
25
|
# @param page_size [Integer] Number of items per page
|
|
38
26
|
#
|
|
39
|
-
# @param sort_by [Symbol, EInvoiceAPI::Models::InboxListInvoicesParams::SortBy] Field to sort by
|
|
40
|
-
#
|
|
41
|
-
# @param sort_order [Symbol, EInvoiceAPI::Models::InboxListInvoicesParams::SortOrder] Sort direction (asc/desc)
|
|
42
|
-
#
|
|
43
27
|
# @param request_options [EInvoiceAPI::RequestOptions, Hash{Symbol=>Object}]
|
|
44
|
-
|
|
45
|
-
# Field to sort by
|
|
46
|
-
module SortBy
|
|
47
|
-
extend EInvoiceAPI::Internal::Type::Enum
|
|
48
|
-
|
|
49
|
-
CREATED_AT = :created_at
|
|
50
|
-
INVOICE_DATE = :invoice_date
|
|
51
|
-
DUE_DATE = :due_date
|
|
52
|
-
INVOICE_TOTAL = :invoice_total
|
|
53
|
-
CUSTOMER_NAME = :customer_name
|
|
54
|
-
VENDOR_NAME = :vendor_name
|
|
55
|
-
INVOICE_ID = :invoice_id
|
|
56
|
-
|
|
57
|
-
# @!method self.values
|
|
58
|
-
# @return [Array<Symbol>]
|
|
59
|
-
end
|
|
60
|
-
|
|
61
|
-
# Sort direction (asc/desc)
|
|
62
|
-
module SortOrder
|
|
63
|
-
extend EInvoiceAPI::Internal::Type::Enum
|
|
64
|
-
|
|
65
|
-
ASC = :asc
|
|
66
|
-
DESC = :desc
|
|
67
|
-
|
|
68
|
-
# @!method self.values
|
|
69
|
-
# @return [Array<Symbol>]
|
|
70
|
-
end
|
|
71
28
|
end
|
|
72
29
|
end
|
|
73
30
|
end
|
|
@@ -38,30 +38,24 @@ module EInvoiceAPI
|
|
|
38
38
|
optional :search, String, nil?: true
|
|
39
39
|
|
|
40
40
|
# @!attribute sender
|
|
41
|
-
# Filter by sender
|
|
41
|
+
# Filter by sender ID
|
|
42
42
|
#
|
|
43
43
|
# @return [String, nil]
|
|
44
44
|
optional :sender, String, nil?: true
|
|
45
45
|
|
|
46
|
-
# @!attribute
|
|
47
|
-
#
|
|
46
|
+
# @!attribute state
|
|
47
|
+
# Filter by document state
|
|
48
48
|
#
|
|
49
|
-
# @return [Symbol, EInvoiceAPI::Models::
|
|
50
|
-
optional :
|
|
51
|
-
|
|
52
|
-
# @!attribute sort_order
|
|
53
|
-
# Sort direction (asc/desc)
|
|
54
|
-
#
|
|
55
|
-
# @return [Symbol, EInvoiceAPI::Models::InboxListParams::SortOrder, nil]
|
|
56
|
-
optional :sort_order, enum: -> { EInvoiceAPI::InboxListParams::SortOrder }
|
|
49
|
+
# @return [Symbol, EInvoiceAPI::Models::DocumentState, nil]
|
|
50
|
+
optional :state, enum: -> { EInvoiceAPI::DocumentState }, nil?: true
|
|
57
51
|
|
|
58
52
|
# @!attribute type
|
|
59
|
-
# Filter by document type
|
|
53
|
+
# Filter by document type
|
|
60
54
|
#
|
|
61
55
|
# @return [Symbol, EInvoiceAPI::Models::DocumentType, nil]
|
|
62
56
|
optional :type, enum: -> { EInvoiceAPI::DocumentType }, nil?: true
|
|
63
57
|
|
|
64
|
-
# @!method initialize(date_from: nil, date_to: nil, page: nil, page_size: nil, search: nil, sender: nil,
|
|
58
|
+
# @!method initialize(date_from: nil, date_to: nil, page: nil, page_size: nil, search: nil, sender: nil, state: nil, type: nil, request_options: {})
|
|
65
59
|
# @param date_from [Time, nil] Filter by issue date (from)
|
|
66
60
|
#
|
|
67
61
|
# @param date_to [Time, nil] Filter by issue date (to)
|
|
@@ -72,42 +66,13 @@ module EInvoiceAPI
|
|
|
72
66
|
#
|
|
73
67
|
# @param search [String, nil] Search in invoice number, seller/buyer names
|
|
74
68
|
#
|
|
75
|
-
# @param sender [String, nil] Filter by sender
|
|
76
|
-
#
|
|
77
|
-
# @param sort_by [Symbol, EInvoiceAPI::Models::InboxListParams::SortBy] Field to sort by
|
|
69
|
+
# @param sender [String, nil] Filter by sender ID
|
|
78
70
|
#
|
|
79
|
-
# @param
|
|
71
|
+
# @param state [Symbol, EInvoiceAPI::Models::DocumentState, nil] Filter by document state
|
|
80
72
|
#
|
|
81
|
-
# @param type [Symbol, EInvoiceAPI::Models::DocumentType, nil] Filter by document type
|
|
73
|
+
# @param type [Symbol, EInvoiceAPI::Models::DocumentType, nil] Filter by document type
|
|
82
74
|
#
|
|
83
75
|
# @param request_options [EInvoiceAPI::RequestOptions, Hash{Symbol=>Object}]
|
|
84
|
-
|
|
85
|
-
# Field to sort by
|
|
86
|
-
module SortBy
|
|
87
|
-
extend EInvoiceAPI::Internal::Type::Enum
|
|
88
|
-
|
|
89
|
-
CREATED_AT = :created_at
|
|
90
|
-
INVOICE_DATE = :invoice_date
|
|
91
|
-
DUE_DATE = :due_date
|
|
92
|
-
INVOICE_TOTAL = :invoice_total
|
|
93
|
-
CUSTOMER_NAME = :customer_name
|
|
94
|
-
VENDOR_NAME = :vendor_name
|
|
95
|
-
INVOICE_ID = :invoice_id
|
|
96
|
-
|
|
97
|
-
# @!method self.values
|
|
98
|
-
# @return [Array<Symbol>]
|
|
99
|
-
end
|
|
100
|
-
|
|
101
|
-
# Sort direction (asc/desc)
|
|
102
|
-
module SortOrder
|
|
103
|
-
extend EInvoiceAPI::Internal::Type::Enum
|
|
104
|
-
|
|
105
|
-
ASC = :asc
|
|
106
|
-
DESC = :desc
|
|
107
|
-
|
|
108
|
-
# @!method self.values
|
|
109
|
-
# @return [Array<Symbol>]
|
|
110
|
-
end
|
|
111
76
|
end
|
|
112
77
|
end
|
|
113
78
|
end
|
|
@@ -192,19 +192,7 @@ module EInvoiceAPI
|
|
|
192
192
|
# @return [String, nil]
|
|
193
193
|
optional :error, String, nil?: true
|
|
194
194
|
|
|
195
|
-
# @!
|
|
196
|
-
# DNS lookup method used: 'naptr' (new spec) or 'busdox' (legacy)
|
|
197
|
-
#
|
|
198
|
-
# @return [String, nil]
|
|
199
|
-
optional :lookup_method, String, api_name: :lookupMethod, nil?: true
|
|
200
|
-
|
|
201
|
-
# @!attribute smp_hostname
|
|
202
|
-
# Hostname of the SMP (Service Metadata Publisher) discovered via DNS
|
|
203
|
-
#
|
|
204
|
-
# @return [String, nil]
|
|
205
|
-
optional :smp_hostname, String, api_name: :smpHostname, nil?: true
|
|
206
|
-
|
|
207
|
-
# @!method initialize(dns_records:, sml_hostname:, status:, error: nil, lookup_method: nil, smp_hostname: nil)
|
|
195
|
+
# @!method initialize(dns_records:, sml_hostname:, status:, error: nil)
|
|
208
196
|
# Information about the DNS lookup performed
|
|
209
197
|
#
|
|
210
198
|
# @param dns_records [Array<EInvoiceAPI::Models::LookupRetrieveResponse::DNSInfo::DNSRecord>] List of DNS records found for the Peppol participant
|
|
@@ -214,10 +202,6 @@ module EInvoiceAPI
|
|
|
214
202
|
# @param status [String] Status of the DNS lookup: 'success', 'error', or 'pending'
|
|
215
203
|
#
|
|
216
204
|
# @param error [String, nil] Error message if the DNS lookup failed
|
|
217
|
-
#
|
|
218
|
-
# @param lookup_method [String, nil] DNS lookup method used: 'naptr' (new spec) or 'busdox' (legacy)
|
|
219
|
-
#
|
|
220
|
-
# @param smp_hostname [String, nil] Hostname of the SMP (Service Metadata Publisher) discovered via DNS
|
|
221
205
|
|
|
222
206
|
class DNSRecord < EInvoiceAPI::Internal::Type::BaseModel
|
|
223
207
|
# @!attribute ip
|