e-invoice-api 0.16.2 → 0.18.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 +33 -0
- data/README.md +10 -1
- data/lib/e_invoice_api/models/document_response.rb +8 -1
- data/lib/e_invoice_api/models/document_type.rb +2 -0
- data/lib/e_invoice_api/models/inbox_list_credit_notes_params.rb +44 -1
- data/lib/e_invoice_api/models/inbox_list_invoices_params.rb +44 -1
- data/lib/e_invoice_api/models/inbox_list_params.rb +46 -3
- data/lib/e_invoice_api/models/lookup_retrieve_response.rb +17 -1
- data/lib/e_invoice_api/models/outbox_list_draft_documents_params.rb +68 -1
- data/lib/e_invoice_api/models/outbox_list_received_documents_params.rb +60 -3
- data/lib/e_invoice_api/models/paginated_document_response.rb +7 -1
- data/lib/e_invoice_api/resources/documents/attachments.rb +4 -2
- data/lib/e_invoice_api/resources/documents.rb +3 -3
- data/lib/e_invoice_api/resources/inbox.rb +16 -4
- data/lib/e_invoice_api/resources/outbox.rb +24 -4
- data/lib/e_invoice_api/version.rb +1 -1
- data/rbi/e_invoice_api/models/document_response.rbi +6 -0
- data/rbi/e_invoice_api/models/document_type.rbi +4 -0
- data/rbi/e_invoice_api/models/inbox_list_credit_notes_params.rbi +132 -0
- data/rbi/e_invoice_api/models/inbox_list_invoices_params.rbi +126 -0
- data/rbi/e_invoice_api/models/inbox_list_params.rbi +99 -2
- data/rbi/e_invoice_api/models/lookup_retrieve_response.rbi +19 -3
- data/rbi/e_invoice_api/models/outbox_list_draft_documents_params.rbi +163 -0
- data/rbi/e_invoice_api/models/outbox_list_received_documents_params.rbi +155 -2
- data/rbi/e_invoice_api/models/paginated_document_response.rbi +6 -1
- data/rbi/e_invoice_api/resources/documents/attachments.rbi +4 -2
- data/rbi/e_invoice_api/resources/documents.rbi +3 -3
- data/rbi/e_invoice_api/resources/inbox.rbi +20 -1
- data/rbi/e_invoice_api/resources/outbox.rbi +32 -2
- data/sig/e_invoice_api/models/document_response.rbs +5 -0
- data/sig/e_invoice_api/models/document_type.rbs +8 -1
- data/sig/e_invoice_api/models/inbox_list_credit_notes_params.rbs +56 -1
- data/sig/e_invoice_api/models/inbox_list_invoices_params.rbs +56 -1
- data/sig/e_invoice_api/models/inbox_list_params.rbs +52 -0
- data/sig/e_invoice_api/models/lookup_retrieve_response.rbs +13 -3
- data/sig/e_invoice_api/models/outbox_list_draft_documents_params.rbs +71 -1
- data/sig/e_invoice_api/models/outbox_list_received_documents_params.rbs +57 -0
- data/sig/e_invoice_api/models/paginated_document_response.rbs +5 -0
- data/sig/e_invoice_api/resources/inbox.rbs +6 -0
- data/sig/e_invoice_api/resources/outbox.rbs +8 -0
- metadata +16 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 8fb0bfb828758c8ddbf04bdc09f5bce1145a6ded3db11c23cc9944b3b9662c08
|
|
4
|
+
data.tar.gz: b0001510a23be50ad8a5ff691b5b7e069864ae4c3752da44362445c59e6a1e78
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 88054607bad7af3d1e0c5e0e18242658a2d759cf7ba6719166700d24ec0a542bcf55e3fad7495da806ed965c566695930d4138dd2ff736977dde45df3bfa39d7
|
|
7
|
+
data.tar.gz: 1c3e1c2590702e931781bdb4fa3ed203c970a5b87412c598e03807cfa124b1c4e99675ff4552d02711f4bc04ced4ef60aca204afa7973763234b8d04a4301304
|
data/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,38 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## 0.18.0 (2026-01-19)
|
|
4
|
+
|
|
5
|
+
Full Changelog: [v0.17.0...v0.18.0](https://github.com/e-invoice-be/e-invoice-rb/compare/v0.17.0...v0.18.0)
|
|
6
|
+
|
|
7
|
+
### Features
|
|
8
|
+
|
|
9
|
+
* **api:** api update ([6d3ef3b](https://github.com/e-invoice-be/e-invoice-rb/commit/6d3ef3b773cf13e36e20cef0008ad3dc75d36cfb))
|
|
10
|
+
|
|
11
|
+
|
|
12
|
+
### Chores
|
|
13
|
+
|
|
14
|
+
* **internal:** update `actions/checkout` version ([7bb6612](https://github.com/e-invoice-be/e-invoice-rb/commit/7bb661210fda31d5e2cc09db4d02a82c1b62a97c))
|
|
15
|
+
|
|
16
|
+
## 0.17.0 (2026-01-15)
|
|
17
|
+
|
|
18
|
+
Full Changelog: [v0.16.2...v0.17.0](https://github.com/e-invoice-be/e-invoice-rb/compare/v0.16.2...v0.17.0)
|
|
19
|
+
|
|
20
|
+
### Features
|
|
21
|
+
|
|
22
|
+
* **api:** api update ([98fcc82](https://github.com/e-invoice-be/e-invoice-rb/commit/98fcc8246c3284db794e81609d5ba755f3c219b7))
|
|
23
|
+
|
|
24
|
+
|
|
25
|
+
### Chores
|
|
26
|
+
|
|
27
|
+
* fix typo in descriptions ([8fcc06b](https://github.com/e-invoice-be/e-invoice-rb/commit/8fcc06b2c2513b0bace66a8cc022ebfb714f2c6a))
|
|
28
|
+
* **internal:** codegen related update ([54574e5](https://github.com/e-invoice-be/e-invoice-rb/commit/54574e575fdacf9430a8e1eaff3faced53cd4468))
|
|
29
|
+
* move `cgi` into dependencies for ruby 4 ([cd5cd05](https://github.com/e-invoice-be/e-invoice-rb/commit/cd5cd055aa0c36ff19de62fd9f22680de2243bac))
|
|
30
|
+
|
|
31
|
+
|
|
32
|
+
### Documentation
|
|
33
|
+
|
|
34
|
+
* prominently feature MCP server setup in root SDK readmes ([d7f0db5](https://github.com/e-invoice-be/e-invoice-rb/commit/d7f0db5aa3c51da11a8be1c3551281b47acd5b49))
|
|
35
|
+
|
|
3
36
|
## 0.16.2 (2025-12-19)
|
|
4
37
|
|
|
5
38
|
Full Changelog: [v0.16.1...v0.16.2](https://github.com/e-invoice-be/e-invoice-rb/compare/v0.16.1...v0.16.2)
|
data/README.md
CHANGED
|
@@ -4,6 +4,15 @@ The e-invoice.be Peppol library provides convenient access to the e-invoice REST
|
|
|
4
4
|
|
|
5
5
|
To get an API key, [make a free account](https://app.e-invoice.be/register?ref=ruby) and register your company.
|
|
6
6
|
|
|
7
|
+
## MCP Server
|
|
8
|
+
|
|
9
|
+
Use the E Invoice MCP Server to enable AI assistants to interact with this API, allowing them to explore endpoints, make test requests, and use documentation to help integrate this SDK into your application.
|
|
10
|
+
|
|
11
|
+
[](https://cursor.com/en-US/install-mcp?name=e-invoice-api-mcp&config=eyJjb21tYW5kIjoibnB4IiwiYXJncyI6WyIteSIsImUtaW52b2ljZS1hcGktbWNwIl19)
|
|
12
|
+
[](https://vscode.stainless.com/mcp/%7B%22name%22%3A%22e-invoice-api-mcp%22%2C%22command%22%3A%22npx%22%2C%22args%22%3A%5B%22-y%22%2C%22e-invoice-api-mcp%22%5D%7D)
|
|
13
|
+
|
|
14
|
+
> Note: You may need to set environment variables in your MCP client.
|
|
15
|
+
|
|
7
16
|
## Documentation
|
|
8
17
|
|
|
9
18
|
Documentation for releases of this gem can be found [on RubyDoc](https://gemdocs.org/gems/e-invoice-api).
|
|
@@ -17,7 +26,7 @@ To use this gem, install via Bundler by adding the following to your application
|
|
|
17
26
|
<!-- x-release-please-start-version -->
|
|
18
27
|
|
|
19
28
|
```ruby
|
|
20
|
-
gem "e-invoice-api", "~> 0.
|
|
29
|
+
gem "e-invoice-api", "~> 0.18.0"
|
|
21
30
|
```
|
|
22
31
|
|
|
23
32
|
<!-- x-release-please-end -->
|
|
@@ -9,6 +9,11 @@ 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
|
+
|
|
12
17
|
# @!attribute allowances
|
|
13
18
|
#
|
|
14
19
|
# @return [Array<EInvoiceAPI::Models::DocumentResponse::Allowance>, nil]
|
|
@@ -310,12 +315,14 @@ module EInvoiceAPI
|
|
|
310
315
|
# @return [String, nil]
|
|
311
316
|
optional :vendor_tax_id, String, nil?: true
|
|
312
317
|
|
|
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)
|
|
318
|
+
# @!method initialize(id:, created_at:, 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)
|
|
314
319
|
# Some parameter documentations has been truncated, see
|
|
315
320
|
# {EInvoiceAPI::Models::DocumentResponse} for more details.
|
|
316
321
|
#
|
|
317
322
|
# @param id [String]
|
|
318
323
|
#
|
|
324
|
+
# @param created_at [Time]
|
|
325
|
+
#
|
|
319
326
|
# @param allowances [Array<EInvoiceAPI::Models::DocumentResponse::Allowance>, nil]
|
|
320
327
|
#
|
|
321
328
|
# @param amount_due [String, nil] The amount due for payment. Must be positive and rounded to maximum 2 decimals
|
|
@@ -19,12 +19,55 @@ module EInvoiceAPI
|
|
|
19
19
|
# @return [Integer, nil]
|
|
20
20
|
optional :page_size, Integer
|
|
21
21
|
|
|
22
|
-
# @!
|
|
22
|
+
# @!attribute sort_by
|
|
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: {})
|
|
23
35
|
# @param page [Integer] Page number
|
|
24
36
|
#
|
|
25
37
|
# @param page_size [Integer] Number of items per page
|
|
26
38
|
#
|
|
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
|
+
#
|
|
27
43
|
# @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
|
|
28
71
|
end
|
|
29
72
|
end
|
|
30
73
|
end
|
|
@@ -19,12 +19,55 @@ module EInvoiceAPI
|
|
|
19
19
|
# @return [Integer, nil]
|
|
20
20
|
optional :page_size, Integer
|
|
21
21
|
|
|
22
|
-
# @!
|
|
22
|
+
# @!attribute sort_by
|
|
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: {})
|
|
23
35
|
# @param page [Integer] Page number
|
|
24
36
|
#
|
|
25
37
|
# @param page_size [Integer] Number of items per page
|
|
26
38
|
#
|
|
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
|
+
#
|
|
27
43
|
# @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
|
|
28
71
|
end
|
|
29
72
|
end
|
|
30
73
|
end
|
|
@@ -38,11 +38,23 @@ module EInvoiceAPI
|
|
|
38
38
|
optional :search, String, nil?: true
|
|
39
39
|
|
|
40
40
|
# @!attribute sender
|
|
41
|
-
# Filter by sender
|
|
41
|
+
# Filter by sender (vendor_name, vendor_email, vendor_tax_id, vendor_company_id)
|
|
42
42
|
#
|
|
43
43
|
# @return [String, nil]
|
|
44
44
|
optional :sender, String, nil?: true
|
|
45
45
|
|
|
46
|
+
# @!attribute sort_by
|
|
47
|
+
# Field to sort by
|
|
48
|
+
#
|
|
49
|
+
# @return [Symbol, EInvoiceAPI::Models::InboxListParams::SortBy, nil]
|
|
50
|
+
optional :sort_by, enum: -> { EInvoiceAPI::InboxListParams::SortBy }
|
|
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 }
|
|
57
|
+
|
|
46
58
|
# @!attribute state
|
|
47
59
|
# Filter by document state
|
|
48
60
|
#
|
|
@@ -55,7 +67,7 @@ module EInvoiceAPI
|
|
|
55
67
|
# @return [Symbol, EInvoiceAPI::Models::DocumentType, nil]
|
|
56
68
|
optional :type, enum: -> { EInvoiceAPI::DocumentType }, nil?: true
|
|
57
69
|
|
|
58
|
-
# @!method initialize(date_from: nil, date_to: nil, page: nil, page_size: nil, search: nil, sender: nil, state: nil, type: nil, request_options: {})
|
|
70
|
+
# @!method initialize(date_from: nil, date_to: nil, page: nil, page_size: nil, search: nil, sender: nil, sort_by: nil, sort_order: nil, state: nil, type: nil, request_options: {})
|
|
59
71
|
# @param date_from [Time, nil] Filter by issue date (from)
|
|
60
72
|
#
|
|
61
73
|
# @param date_to [Time, nil] Filter by issue date (to)
|
|
@@ -66,13 +78,44 @@ module EInvoiceAPI
|
|
|
66
78
|
#
|
|
67
79
|
# @param search [String, nil] Search in invoice number, seller/buyer names
|
|
68
80
|
#
|
|
69
|
-
# @param sender [String, nil] Filter by sender
|
|
81
|
+
# @param sender [String, nil] Filter by sender (vendor_name, vendor_email, vendor_tax_id, vendor_company_id)
|
|
82
|
+
#
|
|
83
|
+
# @param sort_by [Symbol, EInvoiceAPI::Models::InboxListParams::SortBy] Field to sort by
|
|
84
|
+
#
|
|
85
|
+
# @param sort_order [Symbol, EInvoiceAPI::Models::InboxListParams::SortOrder] Sort direction (asc/desc)
|
|
70
86
|
#
|
|
71
87
|
# @param state [Symbol, EInvoiceAPI::Models::DocumentState, nil] Filter by document state
|
|
72
88
|
#
|
|
73
89
|
# @param type [Symbol, EInvoiceAPI::Models::DocumentType, nil] Filter by document type
|
|
74
90
|
#
|
|
75
91
|
# @param request_options [EInvoiceAPI::RequestOptions, Hash{Symbol=>Object}]
|
|
92
|
+
|
|
93
|
+
# Field to sort by
|
|
94
|
+
module SortBy
|
|
95
|
+
extend EInvoiceAPI::Internal::Type::Enum
|
|
96
|
+
|
|
97
|
+
CREATED_AT = :created_at
|
|
98
|
+
INVOICE_DATE = :invoice_date
|
|
99
|
+
DUE_DATE = :due_date
|
|
100
|
+
INVOICE_TOTAL = :invoice_total
|
|
101
|
+
CUSTOMER_NAME = :customer_name
|
|
102
|
+
VENDOR_NAME = :vendor_name
|
|
103
|
+
INVOICE_ID = :invoice_id
|
|
104
|
+
|
|
105
|
+
# @!method self.values
|
|
106
|
+
# @return [Array<Symbol>]
|
|
107
|
+
end
|
|
108
|
+
|
|
109
|
+
# Sort direction (asc/desc)
|
|
110
|
+
module SortOrder
|
|
111
|
+
extend EInvoiceAPI::Internal::Type::Enum
|
|
112
|
+
|
|
113
|
+
ASC = :asc
|
|
114
|
+
DESC = :desc
|
|
115
|
+
|
|
116
|
+
# @!method self.values
|
|
117
|
+
# @return [Array<Symbol>]
|
|
118
|
+
end
|
|
76
119
|
end
|
|
77
120
|
end
|
|
78
121
|
end
|
|
@@ -192,7 +192,19 @@ module EInvoiceAPI
|
|
|
192
192
|
# @return [String, nil]
|
|
193
193
|
optional :error, String, nil?: true
|
|
194
194
|
|
|
195
|
-
# @!
|
|
195
|
+
# @!attribute lookup_method
|
|
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)
|
|
196
208
|
# Information about the DNS lookup performed
|
|
197
209
|
#
|
|
198
210
|
# @param dns_records [Array<EInvoiceAPI::Models::LookupRetrieveResponse::DNSInfo::DNSRecord>] List of DNS records found for the Peppol participant
|
|
@@ -202,6 +214,10 @@ module EInvoiceAPI
|
|
|
202
214
|
# @param status [String] Status of the DNS lookup: 'success', 'error', or 'pending'
|
|
203
215
|
#
|
|
204
216
|
# @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
|
|
205
221
|
|
|
206
222
|
class DNSRecord < EInvoiceAPI::Internal::Type::BaseModel
|
|
207
223
|
# @!attribute ip
|
|
@@ -19,12 +19,79 @@ module EInvoiceAPI
|
|
|
19
19
|
# @return [Integer, nil]
|
|
20
20
|
optional :page_size, Integer
|
|
21
21
|
|
|
22
|
-
# @!
|
|
22
|
+
# @!attribute search
|
|
23
|
+
# Search in invoice number, seller/buyer names
|
|
24
|
+
#
|
|
25
|
+
# @return [String, nil]
|
|
26
|
+
optional :search, String, nil?: true
|
|
27
|
+
|
|
28
|
+
# @!attribute sort_by
|
|
29
|
+
# Field to sort by
|
|
30
|
+
#
|
|
31
|
+
# @return [Symbol, EInvoiceAPI::Models::OutboxListDraftDocumentsParams::SortBy, nil]
|
|
32
|
+
optional :sort_by, enum: -> { EInvoiceAPI::OutboxListDraftDocumentsParams::SortBy }
|
|
33
|
+
|
|
34
|
+
# @!attribute sort_order
|
|
35
|
+
# Sort direction (asc/desc)
|
|
36
|
+
#
|
|
37
|
+
# @return [Symbol, EInvoiceAPI::Models::OutboxListDraftDocumentsParams::SortOrder, nil]
|
|
38
|
+
optional :sort_order, enum: -> { EInvoiceAPI::OutboxListDraftDocumentsParams::SortOrder }
|
|
39
|
+
|
|
40
|
+
# @!attribute state
|
|
41
|
+
# Filter by document state
|
|
42
|
+
#
|
|
43
|
+
# @return [Symbol, EInvoiceAPI::Models::DocumentState, nil]
|
|
44
|
+
optional :state, enum: -> { EInvoiceAPI::DocumentState }, nil?: true
|
|
45
|
+
|
|
46
|
+
# @!attribute type
|
|
47
|
+
# Filter by document type
|
|
48
|
+
#
|
|
49
|
+
# @return [Symbol, EInvoiceAPI::Models::DocumentType, nil]
|
|
50
|
+
optional :type, enum: -> { EInvoiceAPI::DocumentType }, nil?: true
|
|
51
|
+
|
|
52
|
+
# @!method initialize(page: nil, page_size: nil, search: nil, sort_by: nil, sort_order: nil, state: nil, type: nil, request_options: {})
|
|
23
53
|
# @param page [Integer] Page number
|
|
24
54
|
#
|
|
25
55
|
# @param page_size [Integer] Number of items per page
|
|
26
56
|
#
|
|
57
|
+
# @param search [String, nil] Search in invoice number, seller/buyer names
|
|
58
|
+
#
|
|
59
|
+
# @param sort_by [Symbol, EInvoiceAPI::Models::OutboxListDraftDocumentsParams::SortBy] Field to sort by
|
|
60
|
+
#
|
|
61
|
+
# @param sort_order [Symbol, EInvoiceAPI::Models::OutboxListDraftDocumentsParams::SortOrder] Sort direction (asc/desc)
|
|
62
|
+
#
|
|
63
|
+
# @param state [Symbol, EInvoiceAPI::Models::DocumentState, nil] Filter by document state
|
|
64
|
+
#
|
|
65
|
+
# @param type [Symbol, EInvoiceAPI::Models::DocumentType, nil] Filter by document type
|
|
66
|
+
#
|
|
27
67
|
# @param request_options [EInvoiceAPI::RequestOptions, Hash{Symbol=>Object}]
|
|
68
|
+
|
|
69
|
+
# Field to sort by
|
|
70
|
+
module SortBy
|
|
71
|
+
extend EInvoiceAPI::Internal::Type::Enum
|
|
72
|
+
|
|
73
|
+
CREATED_AT = :created_at
|
|
74
|
+
INVOICE_DATE = :invoice_date
|
|
75
|
+
DUE_DATE = :due_date
|
|
76
|
+
INVOICE_TOTAL = :invoice_total
|
|
77
|
+
CUSTOMER_NAME = :customer_name
|
|
78
|
+
VENDOR_NAME = :vendor_name
|
|
79
|
+
INVOICE_ID = :invoice_id
|
|
80
|
+
|
|
81
|
+
# @!method self.values
|
|
82
|
+
# @return [Array<Symbol>]
|
|
83
|
+
end
|
|
84
|
+
|
|
85
|
+
# Sort direction (asc/desc)
|
|
86
|
+
module SortOrder
|
|
87
|
+
extend EInvoiceAPI::Internal::Type::Enum
|
|
88
|
+
|
|
89
|
+
ASC = :asc
|
|
90
|
+
DESC = :desc
|
|
91
|
+
|
|
92
|
+
# @!method self.values
|
|
93
|
+
# @return [Array<Symbol>]
|
|
94
|
+
end
|
|
28
95
|
end
|
|
29
96
|
end
|
|
30
97
|
end
|
|
@@ -31,6 +31,13 @@ module EInvoiceAPI
|
|
|
31
31
|
# @return [Integer, nil]
|
|
32
32
|
optional :page_size, Integer
|
|
33
33
|
|
|
34
|
+
# @!attribute receiver
|
|
35
|
+
# Filter by receiver (customer_name, customer_email, customer_tax_id,
|
|
36
|
+
# customer_company_id, customer_id)
|
|
37
|
+
#
|
|
38
|
+
# @return [String, nil]
|
|
39
|
+
optional :receiver, String, nil?: true
|
|
40
|
+
|
|
34
41
|
# @!attribute search
|
|
35
42
|
# Search in invoice number, seller/buyer names
|
|
36
43
|
#
|
|
@@ -38,11 +45,25 @@ module EInvoiceAPI
|
|
|
38
45
|
optional :search, String, nil?: true
|
|
39
46
|
|
|
40
47
|
# @!attribute sender
|
|
41
|
-
#
|
|
48
|
+
# @deprecated
|
|
49
|
+
#
|
|
50
|
+
# (Deprecated) Filter by sender ID
|
|
42
51
|
#
|
|
43
52
|
# @return [String, nil]
|
|
44
53
|
optional :sender, String, nil?: true
|
|
45
54
|
|
|
55
|
+
# @!attribute sort_by
|
|
56
|
+
# Field to sort by
|
|
57
|
+
#
|
|
58
|
+
# @return [Symbol, EInvoiceAPI::Models::OutboxListReceivedDocumentsParams::SortBy, nil]
|
|
59
|
+
optional :sort_by, enum: -> { EInvoiceAPI::OutboxListReceivedDocumentsParams::SortBy }
|
|
60
|
+
|
|
61
|
+
# @!attribute sort_order
|
|
62
|
+
# Sort direction (asc/desc)
|
|
63
|
+
#
|
|
64
|
+
# @return [Symbol, EInvoiceAPI::Models::OutboxListReceivedDocumentsParams::SortOrder, nil]
|
|
65
|
+
optional :sort_order, enum: -> { EInvoiceAPI::OutboxListReceivedDocumentsParams::SortOrder }
|
|
66
|
+
|
|
46
67
|
# @!attribute state
|
|
47
68
|
# Filter by document state
|
|
48
69
|
#
|
|
@@ -55,7 +76,10 @@ module EInvoiceAPI
|
|
|
55
76
|
# @return [Symbol, EInvoiceAPI::Models::DocumentType, nil]
|
|
56
77
|
optional :type, enum: -> { EInvoiceAPI::DocumentType }, nil?: true
|
|
57
78
|
|
|
58
|
-
# @!method initialize(date_from: nil, date_to: nil, page: nil, page_size: nil, search: nil, sender: nil, state: nil, type: nil, request_options: {})
|
|
79
|
+
# @!method initialize(date_from: nil, date_to: nil, page: nil, page_size: nil, receiver: nil, search: nil, sender: nil, sort_by: nil, sort_order: nil, state: nil, type: nil, request_options: {})
|
|
80
|
+
# Some parameter documentations has been truncated, see
|
|
81
|
+
# {EInvoiceAPI::Models::OutboxListReceivedDocumentsParams} for more details.
|
|
82
|
+
#
|
|
59
83
|
# @param date_from [Time, nil] Filter by issue date (from)
|
|
60
84
|
#
|
|
61
85
|
# @param date_to [Time, nil] Filter by issue date (to)
|
|
@@ -64,15 +88,48 @@ module EInvoiceAPI
|
|
|
64
88
|
#
|
|
65
89
|
# @param page_size [Integer] Number of items per page
|
|
66
90
|
#
|
|
91
|
+
# @param receiver [String, nil] Filter by receiver (customer_name, customer_email, customer_tax_id, customer_com
|
|
92
|
+
#
|
|
67
93
|
# @param search [String, nil] Search in invoice number, seller/buyer names
|
|
68
94
|
#
|
|
69
|
-
# @param sender [String, nil] Filter by sender ID
|
|
95
|
+
# @param sender [String, nil] (Deprecated) Filter by sender ID
|
|
96
|
+
#
|
|
97
|
+
# @param sort_by [Symbol, EInvoiceAPI::Models::OutboxListReceivedDocumentsParams::SortBy] Field to sort by
|
|
98
|
+
#
|
|
99
|
+
# @param sort_order [Symbol, EInvoiceAPI::Models::OutboxListReceivedDocumentsParams::SortOrder] Sort direction (asc/desc)
|
|
70
100
|
#
|
|
71
101
|
# @param state [Symbol, EInvoiceAPI::Models::DocumentState, nil] Filter by document state
|
|
72
102
|
#
|
|
73
103
|
# @param type [Symbol, EInvoiceAPI::Models::DocumentType, nil] Filter by document type
|
|
74
104
|
#
|
|
75
105
|
# @param request_options [EInvoiceAPI::RequestOptions, Hash{Symbol=>Object}]
|
|
106
|
+
|
|
107
|
+
# Field to sort by
|
|
108
|
+
module SortBy
|
|
109
|
+
extend EInvoiceAPI::Internal::Type::Enum
|
|
110
|
+
|
|
111
|
+
CREATED_AT = :created_at
|
|
112
|
+
INVOICE_DATE = :invoice_date
|
|
113
|
+
DUE_DATE = :due_date
|
|
114
|
+
INVOICE_TOTAL = :invoice_total
|
|
115
|
+
CUSTOMER_NAME = :customer_name
|
|
116
|
+
VENDOR_NAME = :vendor_name
|
|
117
|
+
INVOICE_ID = :invoice_id
|
|
118
|
+
|
|
119
|
+
# @!method self.values
|
|
120
|
+
# @return [Array<Symbol>]
|
|
121
|
+
end
|
|
122
|
+
|
|
123
|
+
# Sort direction (asc/desc)
|
|
124
|
+
module SortOrder
|
|
125
|
+
extend EInvoiceAPI::Internal::Type::Enum
|
|
126
|
+
|
|
127
|
+
ASC = :asc
|
|
128
|
+
DESC = :desc
|
|
129
|
+
|
|
130
|
+
# @!method self.values
|
|
131
|
+
# @return [Array<Symbol>]
|
|
132
|
+
end
|
|
76
133
|
end
|
|
77
134
|
end
|
|
78
135
|
end
|
|
@@ -3,6 +3,11 @@
|
|
|
3
3
|
module EInvoiceAPI
|
|
4
4
|
module Models
|
|
5
5
|
class PaginatedDocumentResponse < EInvoiceAPI::Internal::Type::BaseModel
|
|
6
|
+
# @!attribute has_next_page
|
|
7
|
+
#
|
|
8
|
+
# @return [Boolean]
|
|
9
|
+
required :has_next_page, EInvoiceAPI::Internal::Type::Boolean
|
|
10
|
+
|
|
6
11
|
# @!attribute items
|
|
7
12
|
#
|
|
8
13
|
# @return [Array<EInvoiceAPI::Models::DocumentResponse>]
|
|
@@ -28,7 +33,8 @@ module EInvoiceAPI
|
|
|
28
33
|
# @return [Integer]
|
|
29
34
|
required :total, Integer
|
|
30
35
|
|
|
31
|
-
# @!method initialize(items:, page:, page_size:, pages:, total:)
|
|
36
|
+
# @!method initialize(has_next_page:, items:, page:, page_size:, pages:, total:)
|
|
37
|
+
# @param has_next_page [Boolean]
|
|
32
38
|
# @param items [Array<EInvoiceAPI::Models::DocumentResponse>]
|
|
33
39
|
# @param page [Integer]
|
|
34
40
|
# @param page_size [Integer]
|
|
@@ -76,8 +76,10 @@ module EInvoiceAPI
|
|
|
76
76
|
|
|
77
77
|
# @deprecated
|
|
78
78
|
#
|
|
79
|
-
# Add one or more attachments
|
|
80
|
-
#
|
|
79
|
+
# Add one or more attachments to an invoice. Be careful: the attachments ARE NOT
|
|
80
|
+
# ADDED to the UBL! They are only stored in our database and can be downloaded
|
|
81
|
+
# later. To add attachments to the UBL, you need to add the attachment(s) via POST
|
|
82
|
+
# /api/documents
|
|
81
83
|
#
|
|
82
84
|
# @overload add(document_id, file:, request_options: {})
|
|
83
85
|
#
|
|
@@ -174,11 +174,11 @@ module EInvoiceAPI
|
|
|
174
174
|
#
|
|
175
175
|
# @overload create_from_pdf(file:, customer_tax_id: nil, vendor_tax_id: nil, request_options: {})
|
|
176
176
|
#
|
|
177
|
-
# @param file [Pathname, StringIO, IO, String, EInvoiceAPI::FilePart] Body param
|
|
177
|
+
# @param file [Pathname, StringIO, IO, String, EInvoiceAPI::FilePart] Body param
|
|
178
178
|
#
|
|
179
|
-
# @param customer_tax_id [String, nil] Query param
|
|
179
|
+
# @param customer_tax_id [String, nil] Query param
|
|
180
180
|
#
|
|
181
|
-
# @param vendor_tax_id [String, nil] Query param
|
|
181
|
+
# @param vendor_tax_id [String, nil] Query param
|
|
182
182
|
#
|
|
183
183
|
# @param request_options [EInvoiceAPI::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
184
184
|
#
|
|
@@ -6,7 +6,7 @@ module EInvoiceAPI
|
|
|
6
6
|
# Retrieve a paginated list of received documents with filtering options including
|
|
7
7
|
# state, type, sender, date range, and text search.
|
|
8
8
|
#
|
|
9
|
-
# @overload list(date_from: nil, date_to: nil, page: nil, page_size: nil, search: nil, sender: nil, state: nil, type: nil, request_options: {})
|
|
9
|
+
# @overload list(date_from: nil, date_to: nil, page: nil, page_size: nil, search: nil, sender: nil, sort_by: nil, sort_order: nil, state: nil, type: nil, request_options: {})
|
|
10
10
|
#
|
|
11
11
|
# @param date_from [Time, nil] Filter by issue date (from)
|
|
12
12
|
#
|
|
@@ -18,7 +18,11 @@ module EInvoiceAPI
|
|
|
18
18
|
#
|
|
19
19
|
# @param search [String, nil] Search in invoice number, seller/buyer names
|
|
20
20
|
#
|
|
21
|
-
# @param sender [String, nil] Filter by sender
|
|
21
|
+
# @param sender [String, nil] Filter by sender (vendor_name, vendor_email, vendor_tax_id, vendor_company_id)
|
|
22
|
+
#
|
|
23
|
+
# @param sort_by [Symbol, EInvoiceAPI::Models::InboxListParams::SortBy] Field to sort by
|
|
24
|
+
#
|
|
25
|
+
# @param sort_order [Symbol, EInvoiceAPI::Models::InboxListParams::SortOrder] Sort direction (asc/desc)
|
|
22
26
|
#
|
|
23
27
|
# @param state [Symbol, EInvoiceAPI::Models::DocumentState, nil] Filter by document state
|
|
24
28
|
#
|
|
@@ -43,12 +47,16 @@ module EInvoiceAPI
|
|
|
43
47
|
|
|
44
48
|
# Retrieve a paginated list of received credit notes with filtering options.
|
|
45
49
|
#
|
|
46
|
-
# @overload list_credit_notes(page: nil, page_size: nil, request_options: {})
|
|
50
|
+
# @overload list_credit_notes(page: nil, page_size: nil, sort_by: nil, sort_order: nil, request_options: {})
|
|
47
51
|
#
|
|
48
52
|
# @param page [Integer] Page number
|
|
49
53
|
#
|
|
50
54
|
# @param page_size [Integer] Number of items per page
|
|
51
55
|
#
|
|
56
|
+
# @param sort_by [Symbol, EInvoiceAPI::Models::InboxListCreditNotesParams::SortBy] Field to sort by
|
|
57
|
+
#
|
|
58
|
+
# @param sort_order [Symbol, EInvoiceAPI::Models::InboxListCreditNotesParams::SortOrder] Sort direction (asc/desc)
|
|
59
|
+
#
|
|
52
60
|
# @param request_options [EInvoiceAPI::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
53
61
|
#
|
|
54
62
|
# @return [EInvoiceAPI::Internal::DocumentsNumberPage<EInvoiceAPI::Models::DocumentResponse>]
|
|
@@ -68,12 +76,16 @@ module EInvoiceAPI
|
|
|
68
76
|
|
|
69
77
|
# Retrieve a paginated list of received invoices with filtering options.
|
|
70
78
|
#
|
|
71
|
-
# @overload list_invoices(page: nil, page_size: nil, request_options: {})
|
|
79
|
+
# @overload list_invoices(page: nil, page_size: nil, sort_by: nil, sort_order: nil, request_options: {})
|
|
72
80
|
#
|
|
73
81
|
# @param page [Integer] Page number
|
|
74
82
|
#
|
|
75
83
|
# @param page_size [Integer] Number of items per page
|
|
76
84
|
#
|
|
85
|
+
# @param sort_by [Symbol, EInvoiceAPI::Models::InboxListInvoicesParams::SortBy] Field to sort by
|
|
86
|
+
#
|
|
87
|
+
# @param sort_order [Symbol, EInvoiceAPI::Models::InboxListInvoicesParams::SortOrder] Sort direction (asc/desc)
|
|
88
|
+
#
|
|
77
89
|
# @param request_options [EInvoiceAPI::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
78
90
|
#
|
|
79
91
|
# @return [EInvoiceAPI::Internal::DocumentsNumberPage<EInvoiceAPI::Models::DocumentResponse>]
|