e-invoice-api 0.25.0 → 0.26.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 +8 -0
- data/README.md +1 -1
- data/lib/e_invoice_api/models/document_create.rb +9 -1
- data/lib/e_invoice_api/models/document_create_from_pdf_response.rb +9 -1
- data/lib/e_invoice_api/models/document_create_params.rb +13 -1
- data/lib/e_invoice_api/models/document_response.rb +16 -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 +45 -10
- data/lib/e_invoice_api/models/lookup_retrieve_response.rb +17 -1
- data/lib/e_invoice_api/models/me_retrieve_response.rb +17 -17
- 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 +57 -10
- 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 +63 -51
- data/lib/e_invoice_api/resources/inbox.rb +16 -6
- data/lib/e_invoice_api/resources/outbox.rb +26 -6
- data/lib/e_invoice_api/resources/validate.rb +3 -1
- data/lib/e_invoice_api/version.rb +1 -1
- data/rbi/e_invoice_api/models/document_create.rbi +8 -0
- data/rbi/e_invoice_api/models/document_create_from_pdf_response.rbi +8 -0
- data/rbi/e_invoice_api/models/document_create_params.rbi +26 -5
- data/rbi/e_invoice_api/models/document_response.rbi +14 -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 +100 -11
- data/rbi/e_invoice_api/models/lookup_retrieve_response.rbi +19 -3
- data/rbi/e_invoice_api/models/me_retrieve_response.rbi +30 -18
- 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 +156 -11
- 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 +78 -56
- data/rbi/e_invoice_api/resources/inbox.rbi +21 -5
- data/rbi/e_invoice_api/resources/outbox.rbi +33 -6
- data/rbi/e_invoice_api/resources/validate.rbi +3 -0
- data/sig/e_invoice_api/models/document_create.rbs +5 -0
- data/sig/e_invoice_api/models/document_create_from_pdf_response.rbs +5 -0
- data/sig/e_invoice_api/models/document_create_params.rbs +13 -3
- data/sig/e_invoice_api/models/document_response.rbs +10 -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 +51 -4
- data/sig/e_invoice_api/models/lookup_retrieve_response.rbs +13 -3
- data/sig/e_invoice_api/models/me_retrieve_response.rbs +16 -10
- 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 +56 -4
- data/sig/e_invoice_api/models/paginated_document_response.rbs +5 -0
- data/sig/e_invoice_api/resources/documents.rbs +2 -0
- data/sig/e_invoice_api/resources/inbox.rbs +6 -1
- data/sig/e_invoice_api/resources/outbox.rbs +8 -1
- data/sig/e_invoice_api/resources/validate.rbs +1 -0
- metadata +1 -1
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: db0a02b2fdcf8bc2e9194f4410092ecef52ac1b6de8a2c94bd6b4d3ed81faae6
|
|
4
|
+
data.tar.gz: 51379e84106bbaa07fea49a9e46bee139d94d7bcd49fbf56581ce88bed163c05
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 133f69f5b73d45f428075b58be94fd16f854f5d859a852411179930f589bdbce45019258bea0635bb3f713b941e3a1c32b8cac0efc977a54a8f240ed9f144bec
|
|
7
|
+
data.tar.gz: 9a20feb042e5c91652a6cadaec249738ec6fbc48202e4d25c38ad84879fbe21f0a1a2e202dfdbc49886c174d22ebf1e04dca00b73362c0203249324185034c83
|
data/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,13 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## 0.26.0 (2026-03-09)
|
|
4
|
+
|
|
5
|
+
Full Changelog: [v0.25.0...v0.26.0](https://github.com/e-invoice-be/e-invoice-rb/compare/v0.25.0...v0.26.0)
|
|
6
|
+
|
|
7
|
+
### Features
|
|
8
|
+
|
|
9
|
+
* **api:** api update ([c5bd692](https://github.com/e-invoice-be/e-invoice-rb/commit/c5bd6924ff66c6733b751e6145ba325f62175931))
|
|
10
|
+
|
|
3
11
|
## 0.25.0 (2026-03-09)
|
|
4
12
|
|
|
5
13
|
Full Changelog: [v0.24.1...v0.25.0](https://github.com/e-invoice-be/e-invoice-rb/compare/v0.24.1...v0.25.0)
|
data/README.md
CHANGED
|
@@ -85,6 +85,12 @@ 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
|
+
|
|
88
94
|
# @!attribute customer_tax_id
|
|
89
95
|
# Customer tax ID. For Belgium this is the VAT number. Must include the country
|
|
90
96
|
# prefix
|
|
@@ -312,7 +318,7 @@ module EInvoiceAPI
|
|
|
312
318
|
# @return [String, nil]
|
|
313
319
|
optional :vendor_tax_id, String, nil?: true
|
|
314
320
|
|
|
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)
|
|
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, customer_peppol_id: 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)
|
|
316
322
|
# Some parameter documentations has been truncated, see
|
|
317
323
|
# {EInvoiceAPI::Models::DocumentCreate} for more details.
|
|
318
324
|
#
|
|
@@ -342,6 +348,8 @@ module EInvoiceAPI
|
|
|
342
348
|
#
|
|
343
349
|
# @param customer_name [String, nil] The company name of the customer/buyer
|
|
344
350
|
#
|
|
351
|
+
# @param customer_peppol_id [String, nil] Customer Peppol ID
|
|
352
|
+
#
|
|
345
353
|
# @param customer_tax_id [String, nil] Customer tax ID. For Belgium this is the VAT number. Must include the country pr
|
|
346
354
|
#
|
|
347
355
|
# @param direction [Symbol, EInvoiceAPI::Models::DocumentDirection] The direction of the document: INBOUND (purchases) or OUTBOUND (sales)
|
|
@@ -82,6 +82,12 @@ 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
|
+
|
|
85
91
|
# @!attribute customer_tax_id
|
|
86
92
|
# Customer tax ID. For Belgium this is the VAT number. Must include the country
|
|
87
93
|
# prefix
|
|
@@ -313,7 +319,7 @@ module EInvoiceAPI
|
|
|
313
319
|
# @return [String, nil]
|
|
314
320
|
optional :vendor_tax_id, String, nil?: true
|
|
315
321
|
|
|
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)
|
|
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, customer_peppol_id: 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)
|
|
317
323
|
# Some parameter documentations has been truncated, see
|
|
318
324
|
# {EInvoiceAPI::Models::DocumentCreateFromPdfResponse} for more details.
|
|
319
325
|
#
|
|
@@ -343,6 +349,8 @@ module EInvoiceAPI
|
|
|
343
349
|
#
|
|
344
350
|
# @param customer_name [String, nil] The company name of the customer/buyer
|
|
345
351
|
#
|
|
352
|
+
# @param customer_peppol_id [String, nil] Customer Peppol ID
|
|
353
|
+
#
|
|
346
354
|
# @param customer_tax_id [String, nil] Customer tax ID. For Belgium this is the VAT number. Must include the country pr
|
|
347
355
|
#
|
|
348
356
|
# @param direction [Symbol, EInvoiceAPI::Models::DocumentDirection] The direction of the document: INBOUND (purchases) or OUTBOUND (sales)
|
|
@@ -7,7 +7,19 @@ module EInvoiceAPI
|
|
|
7
7
|
extend EInvoiceAPI::Internal::Type::RequestParameters::Converter
|
|
8
8
|
include EInvoiceAPI::Internal::Type::RequestParameters
|
|
9
9
|
|
|
10
|
-
# @!
|
|
10
|
+
# @!attribute construct_pdf
|
|
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
|
+
#
|
|
11
23
|
# @param request_options [EInvoiceAPI::RequestOptions, Hash{Symbol=>Object}]
|
|
12
24
|
end
|
|
13
25
|
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]
|
|
@@ -91,6 +96,12 @@ module EInvoiceAPI
|
|
|
91
96
|
# @return [String, nil]
|
|
92
97
|
optional :customer_name, String, nil?: true
|
|
93
98
|
|
|
99
|
+
# @!attribute customer_peppol_id
|
|
100
|
+
# Customer Peppol ID
|
|
101
|
+
#
|
|
102
|
+
# @return [String, nil]
|
|
103
|
+
optional :customer_peppol_id, String, nil?: true
|
|
104
|
+
|
|
94
105
|
# @!attribute customer_tax_id
|
|
95
106
|
# Customer tax ID. For Belgium this is the VAT number. Must include the country
|
|
96
107
|
# prefix
|
|
@@ -310,12 +321,14 @@ module EInvoiceAPI
|
|
|
310
321
|
# @return [String, nil]
|
|
311
322
|
optional :vendor_tax_id, String, nil?: true
|
|
312
323
|
|
|
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)
|
|
324
|
+
# @!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_peppol_id: 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
325
|
# Some parameter documentations has been truncated, see
|
|
315
326
|
# {EInvoiceAPI::Models::DocumentResponse} for more details.
|
|
316
327
|
#
|
|
317
328
|
# @param id [String]
|
|
318
329
|
#
|
|
330
|
+
# @param created_at [Time]
|
|
331
|
+
#
|
|
319
332
|
# @param allowances [Array<EInvoiceAPI::Models::DocumentResponse::Allowance>, nil]
|
|
320
333
|
#
|
|
321
334
|
# @param amount_due [String, nil] The amount due for payment. Must be positive and rounded to maximum 2 decimals
|
|
@@ -342,6 +355,8 @@ module EInvoiceAPI
|
|
|
342
355
|
#
|
|
343
356
|
# @param customer_name [String, nil] The company name of the customer/buyer
|
|
344
357
|
#
|
|
358
|
+
# @param customer_peppol_id [String, nil] Customer Peppol ID
|
|
359
|
+
#
|
|
345
360
|
# @param customer_tax_id [String, nil] Customer tax ID. For Belgium this is the VAT number. Must include the country pr
|
|
346
361
|
#
|
|
347
362
|
# @param direction [Symbol, EInvoiceAPI::Models::DocumentDirection] The direction of the document: INBOUND (purchases) or OUTBOUND (sales)
|
|
@@ -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,24 +38,30 @@ 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
|
|
47
|
-
#
|
|
46
|
+
# @!attribute sort_by
|
|
47
|
+
# Field to sort by
|
|
48
48
|
#
|
|
49
|
-
# @return [Symbol, EInvoiceAPI::Models::
|
|
50
|
-
optional :
|
|
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 }
|
|
51
57
|
|
|
52
58
|
# @!attribute type
|
|
53
|
-
# Filter by document type
|
|
59
|
+
# Filter by document type. If not provided, returns all types.
|
|
54
60
|
#
|
|
55
61
|
# @return [Symbol, EInvoiceAPI::Models::DocumentType, nil]
|
|
56
62
|
optional :type, enum: -> { EInvoiceAPI::DocumentType }, nil?: true
|
|
57
63
|
|
|
58
|
-
# @!method initialize(date_from: nil, date_to: nil, page: nil, page_size: nil, search: nil, sender: nil,
|
|
64
|
+
# @!method initialize(date_from: nil, date_to: nil, page: nil, page_size: nil, search: nil, sender: nil, sort_by: nil, sort_order: nil, type: nil, request_options: {})
|
|
59
65
|
# @param date_from [Time, nil] Filter by issue date (from)
|
|
60
66
|
#
|
|
61
67
|
# @param date_to [Time, nil] Filter by issue date (to)
|
|
@@ -66,13 +72,42 @@ module EInvoiceAPI
|
|
|
66
72
|
#
|
|
67
73
|
# @param search [String, nil] Search in invoice number, seller/buyer names
|
|
68
74
|
#
|
|
69
|
-
# @param sender [String, nil] Filter by sender
|
|
75
|
+
# @param sender [String, nil] Filter by sender (vendor_name, vendor_email, vendor_tax_id, vendor_company_id)
|
|
76
|
+
#
|
|
77
|
+
# @param sort_by [Symbol, EInvoiceAPI::Models::InboxListParams::SortBy] Field to sort by
|
|
70
78
|
#
|
|
71
|
-
# @param
|
|
79
|
+
# @param sort_order [Symbol, EInvoiceAPI::Models::InboxListParams::SortOrder] Sort direction (asc/desc)
|
|
72
80
|
#
|
|
73
|
-
# @param type [Symbol, EInvoiceAPI::Models::DocumentType, nil] Filter by document type
|
|
81
|
+
# @param type [Symbol, EInvoiceAPI::Models::DocumentType, nil] Filter by document type. If not provided, returns all types.
|
|
74
82
|
#
|
|
75
83
|
# @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
|
|
76
111
|
end
|
|
77
112
|
end
|
|
78
113
|
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
|
|
@@ -4,23 +4,11 @@ module EInvoiceAPI
|
|
|
4
4
|
module Models
|
|
5
5
|
# @see EInvoiceAPI::Resources::Me#retrieve
|
|
6
6
|
class MeRetrieveResponse < EInvoiceAPI::Internal::Type::BaseModel
|
|
7
|
-
# @!attribute credit_balance
|
|
8
|
-
# Credit balance of the tenant
|
|
9
|
-
#
|
|
10
|
-
# @return [Integer]
|
|
11
|
-
required :credit_balance, Integer
|
|
12
|
-
|
|
13
7
|
# @!attribute name
|
|
14
8
|
#
|
|
15
9
|
# @return [String]
|
|
16
10
|
required :name, String
|
|
17
11
|
|
|
18
|
-
# @!attribute plan
|
|
19
|
-
# Plan of the tenant
|
|
20
|
-
#
|
|
21
|
-
# @return [Symbol, EInvoiceAPI::Models::MeRetrieveResponse::Plan]
|
|
22
|
-
required :plan, enum: -> { EInvoiceAPI::Models::MeRetrieveResponse::Plan }
|
|
23
|
-
|
|
24
12
|
# @!attribute bcc_recipient_email
|
|
25
13
|
# BCC recipient email to deliver documents
|
|
26
14
|
#
|
|
@@ -78,6 +66,12 @@ module EInvoiceAPI
|
|
|
78
66
|
# @return [String, nil]
|
|
79
67
|
optional :company_zip, String, nil?: true
|
|
80
68
|
|
|
69
|
+
# @!attribute credit_balance
|
|
70
|
+
# Credit balance of the tenant
|
|
71
|
+
#
|
|
72
|
+
# @return [Integer, nil]
|
|
73
|
+
optional :credit_balance, Integer
|
|
74
|
+
|
|
81
75
|
# @!attribute description
|
|
82
76
|
#
|
|
83
77
|
# @return [String, nil]
|
|
@@ -95,6 +89,12 @@ module EInvoiceAPI
|
|
|
95
89
|
# @return [Array<String>, nil]
|
|
96
90
|
optional :peppol_ids, EInvoiceAPI::Internal::Type::ArrayOf[String], nil?: true
|
|
97
91
|
|
|
92
|
+
# @!attribute plan
|
|
93
|
+
# Plan of the tenant
|
|
94
|
+
#
|
|
95
|
+
# @return [Symbol, EInvoiceAPI::Models::MeRetrieveResponse::Plan, nil]
|
|
96
|
+
optional :plan, enum: -> { EInvoiceAPI::Models::MeRetrieveResponse::Plan }
|
|
97
|
+
|
|
98
98
|
# @!attribute smp_registration
|
|
99
99
|
# Whether the tenant is registered on our SMP
|
|
100
100
|
#
|
|
@@ -107,16 +107,12 @@ module EInvoiceAPI
|
|
|
107
107
|
# @return [Time, nil]
|
|
108
108
|
optional :smp_registration_date, Time, nil?: true
|
|
109
109
|
|
|
110
|
-
# @!method initialize(
|
|
110
|
+
# @!method initialize(name:, 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, credit_balance: nil, description: nil, ibans: nil, peppol_ids: nil, plan: nil, smp_registration: nil, smp_registration_date: nil)
|
|
111
111
|
# Some parameter documentations has been truncated, see
|
|
112
112
|
# {EInvoiceAPI::Models::MeRetrieveResponse} for more details.
|
|
113
113
|
#
|
|
114
|
-
# @param credit_balance [Integer] Credit balance of the tenant
|
|
115
|
-
#
|
|
116
114
|
# @param name [String]
|
|
117
115
|
#
|
|
118
|
-
# @param plan [Symbol, EInvoiceAPI::Models::MeRetrieveResponse::Plan] Plan of the tenant
|
|
119
|
-
#
|
|
120
116
|
# @param bcc_recipient_email [String, nil] BCC recipient email to deliver documents
|
|
121
117
|
#
|
|
122
118
|
# @param company_address [String, nil] Address of the company. Must be in the form of `Street Name Street Number`
|
|
@@ -135,12 +131,16 @@ module EInvoiceAPI
|
|
|
135
131
|
#
|
|
136
132
|
# @param company_zip [String, nil] Zip code of the company
|
|
137
133
|
#
|
|
134
|
+
# @param credit_balance [Integer] Credit balance of the tenant
|
|
135
|
+
#
|
|
138
136
|
# @param description [String, nil]
|
|
139
137
|
#
|
|
140
138
|
# @param ibans [Array<String>, nil] IBANs of the tenant
|
|
141
139
|
#
|
|
142
140
|
# @param peppol_ids [Array<String>, nil] Peppol IDs of the tenant
|
|
143
141
|
#
|
|
142
|
+
# @param plan [Symbol, EInvoiceAPI::Models::MeRetrieveResponse::Plan] Plan of the tenant
|
|
143
|
+
#
|
|
144
144
|
# @param smp_registration [Boolean, nil] Whether the tenant is registered on our SMP
|
|
145
145
|
#
|
|
146
146
|
# @param smp_registration_date [Time, nil] Date when the tenant was registered on SMP
|
|
@@ -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
|