e-invoice-api 0.20.3 → 0.22.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 +16 -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 +9 -1
- data/lib/e_invoice_api/resources/documents.rb +56 -50
- 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 +8 -0
- data/rbi/e_invoice_api/resources/documents.rbi +72 -55
- 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 +5 -0
- data/sig/e_invoice_api/resources/documents.rbs +2 -0
- data/sig/e_invoice_api/resources/validate.rbs +1 -0
- 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: 37e6e3c109306db98f4fa6bd1fea2e0d01c80523b9bd1669f4e1cc7e2bc4b8bb
|
|
4
|
+
data.tar.gz: 4469ae435b08b47e097b56a83594c4ef7b3d24c26b5b6acbbc8ec95b0e8c8b43
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 7527b3e726db27d010d7198f1bc0b23766af7bac9c3c646a065e015bb73d0f9e5bca9cc6e7d7f04865e2ab869998f7b6790271cd48101ee7fe001b9131a2a41a
|
|
7
|
+
data.tar.gz: e101d1a282d31f7e0d21bca944ab2c678614a867cae918f2a6f00a124bfd6c28f98c41372201aff84a89eba5540c3bf761336159f6d927bf503e23d7bed8973a
|
data/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,21 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## 0.22.0 (2026-02-13)
|
|
4
|
+
|
|
5
|
+
Full Changelog: [v0.21.0...v0.22.0](https://github.com/e-invoice-be/e-invoice-rb/compare/v0.21.0...v0.22.0)
|
|
6
|
+
|
|
7
|
+
### Features
|
|
8
|
+
|
|
9
|
+
* **api:** api update ([57478fb](https://github.com/e-invoice-be/e-invoice-rb/commit/57478fb22e37bd7300fb8d94d9471a8862d46371))
|
|
10
|
+
|
|
11
|
+
## 0.21.0 (2026-02-09)
|
|
12
|
+
|
|
13
|
+
Full Changelog: [v0.20.3...v0.21.0](https://github.com/e-invoice-be/e-invoice-rb/compare/v0.20.3...v0.21.0)
|
|
14
|
+
|
|
15
|
+
### Features
|
|
16
|
+
|
|
17
|
+
* **api:** api update ([ce79dba](https://github.com/e-invoice-be/e-invoice-rb/commit/ce79dba27b692bb54257509c1d3cff3e25f5be43))
|
|
18
|
+
|
|
3
19
|
## 0.20.3 (2026-02-07)
|
|
4
20
|
|
|
5
21
|
Full Changelog: [v0.20.2...v0.20.3](https://github.com/e-invoice-be/e-invoice-rb/compare/v0.20.2...v0.20.3)
|
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
|
|
@@ -96,6 +96,12 @@ module EInvoiceAPI
|
|
|
96
96
|
# @return [String, nil]
|
|
97
97
|
optional :customer_name, String, nil?: true
|
|
98
98
|
|
|
99
|
+
# @!attribute customer_peppol_id
|
|
100
|
+
# Customer Peppol ID
|
|
101
|
+
#
|
|
102
|
+
# @return [String, nil]
|
|
103
|
+
optional :customer_peppol_id, String, nil?: true
|
|
104
|
+
|
|
99
105
|
# @!attribute customer_tax_id
|
|
100
106
|
# Customer tax ID. For Belgium this is the VAT number. Must include the country
|
|
101
107
|
# prefix
|
|
@@ -315,7 +321,7 @@ module EInvoiceAPI
|
|
|
315
321
|
# @return [String, nil]
|
|
316
322
|
optional :vendor_tax_id, String, nil?: true
|
|
317
323
|
|
|
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)
|
|
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)
|
|
319
325
|
# Some parameter documentations has been truncated, see
|
|
320
326
|
# {EInvoiceAPI::Models::DocumentResponse} for more details.
|
|
321
327
|
#
|
|
@@ -349,6 +355,8 @@ module EInvoiceAPI
|
|
|
349
355
|
#
|
|
350
356
|
# @param customer_name [String, nil] The company name of the customer/buyer
|
|
351
357
|
#
|
|
358
|
+
# @param customer_peppol_id [String, nil] Customer Peppol ID
|
|
359
|
+
#
|
|
352
360
|
# @param customer_tax_id [String, nil] Customer tax ID. For Belgium this is the VAT number. Must include the country pr
|
|
353
361
|
#
|
|
354
362
|
# @param direction [Symbol, EInvoiceAPI::Models::DocumentDirection] The direction of the document: INBOUND (purchases) or OUTBOUND (sales)
|
|
@@ -14,103 +14,107 @@ module EInvoiceAPI
|
|
|
14
14
|
#
|
|
15
15
|
# Create a new invoice or credit note
|
|
16
16
|
#
|
|
17
|
-
# @overload create(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, request_options: {})
|
|
17
|
+
# @overload create(construct_pdf: nil, 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, request_options: {})
|
|
18
18
|
#
|
|
19
|
-
# @param
|
|
19
|
+
# @param construct_pdf [Boolean] Query param: If true, generate a constructed PDF from the document and include i
|
|
20
20
|
#
|
|
21
|
-
# @param
|
|
21
|
+
# @param allowances [Array<EInvoiceAPI::Models::DocumentCreate::Allowance>, nil] Body param
|
|
22
22
|
#
|
|
23
|
-
# @param
|
|
23
|
+
# @param amount_due [Float, String, nil] Body param: The amount due for payment. Must be positive and rounded to maximum
|
|
24
24
|
#
|
|
25
|
-
# @param
|
|
25
|
+
# @param attachments [Array<EInvoiceAPI::Models::DocumentAttachmentCreate>, nil] Body param
|
|
26
26
|
#
|
|
27
|
-
# @param
|
|
27
|
+
# @param billing_address [String, nil] Body param: The billing address (if different from customer address)
|
|
28
28
|
#
|
|
29
|
-
# @param
|
|
29
|
+
# @param billing_address_recipient [String, nil] Body param: The recipient name at the billing address
|
|
30
30
|
#
|
|
31
|
-
# @param
|
|
31
|
+
# @param charges [Array<EInvoiceAPI::Models::DocumentCreate::Charge>, nil] Body param
|
|
32
32
|
#
|
|
33
|
-
# @param
|
|
33
|
+
# @param currency [Symbol, EInvoiceAPI::Models::CurrencyCode] Body param: Currency of the invoice (ISO 4217 currency code)
|
|
34
34
|
#
|
|
35
|
-
# @param
|
|
35
|
+
# @param customer_address [String, nil] Body param: The address of the customer/buyer
|
|
36
36
|
#
|
|
37
|
-
# @param
|
|
37
|
+
# @param customer_address_recipient [String, nil] Body param: The recipient name at the customer address
|
|
38
38
|
#
|
|
39
|
-
# @param
|
|
39
|
+
# @param customer_company_id [String, nil] Body param: Customer company ID. For Belgium this is the CBE number or their EUI
|
|
40
40
|
#
|
|
41
|
-
# @param
|
|
41
|
+
# @param customer_email [String, nil] Body param: The email address of the customer
|
|
42
42
|
#
|
|
43
|
-
# @param
|
|
43
|
+
# @param customer_id [String, nil] Body param: The unique identifier for the customer in your system
|
|
44
44
|
#
|
|
45
|
-
# @param
|
|
45
|
+
# @param customer_name [String, nil] Body param: The company name of the customer/buyer
|
|
46
46
|
#
|
|
47
|
-
# @param
|
|
47
|
+
# @param customer_peppol_id [String, nil] Body param: Customer Peppol ID
|
|
48
48
|
#
|
|
49
|
-
# @param
|
|
49
|
+
# @param customer_tax_id [String, nil] Body param: Customer tax ID. For Belgium this is the VAT number. Must include th
|
|
50
50
|
#
|
|
51
|
-
# @param
|
|
51
|
+
# @param direction [Symbol, EInvoiceAPI::Models::DocumentDirection] Body param: The direction of the document: INBOUND (purchases) or OUTBOUND (sale
|
|
52
52
|
#
|
|
53
|
-
# @param
|
|
53
|
+
# @param document_type [Symbol, EInvoiceAPI::Models::DocumentType] Body param: The type of document: INVOICE, CREDIT_NOTE, or DEBIT_NOTE
|
|
54
54
|
#
|
|
55
|
-
# @param
|
|
55
|
+
# @param due_date [Date, nil] Body param: The date when payment is due
|
|
56
56
|
#
|
|
57
|
-
# @param
|
|
57
|
+
# @param invoice_date [Date, nil] Body param: The date when the invoice was issued
|
|
58
58
|
#
|
|
59
|
-
# @param
|
|
59
|
+
# @param invoice_id [String, nil] Body param: The unique invoice identifier/number
|
|
60
60
|
#
|
|
61
|
-
# @param
|
|
61
|
+
# @param invoice_total [Float, String, nil] Body param: The total amount of the invoice including tax (invoice_total = subto
|
|
62
62
|
#
|
|
63
|
-
# @param
|
|
63
|
+
# @param items [Array<EInvoiceAPI::Models::DocumentCreate::Item>] Body param: At least one line item is required
|
|
64
64
|
#
|
|
65
|
-
# @param
|
|
65
|
+
# @param note [String, nil] Body param: Additional notes or comments for the invoice
|
|
66
66
|
#
|
|
67
|
-
# @param
|
|
67
|
+
# @param payment_details [Array<EInvoiceAPI::Models::PaymentDetailCreate>, nil] Body param
|
|
68
68
|
#
|
|
69
|
-
# @param
|
|
69
|
+
# @param payment_term [String, nil] Body param: The payment terms (e.g., 'Net 30', 'Due on receipt', '2/10 Net 30')
|
|
70
70
|
#
|
|
71
|
-
# @param
|
|
71
|
+
# @param previous_unpaid_balance [Float, String, nil] Body param: The previous unpaid balance from prior invoices, if any. Must be pos
|
|
72
72
|
#
|
|
73
|
-
# @param
|
|
73
|
+
# @param purchase_order [String, nil] Body param: The purchase order reference number
|
|
74
74
|
#
|
|
75
|
-
# @param
|
|
75
|
+
# @param remittance_address [String, nil] Body param: The address where payment should be sent or remitted to
|
|
76
76
|
#
|
|
77
|
-
# @param
|
|
77
|
+
# @param remittance_address_recipient [String, nil] Body param: The recipient name at the remittance address
|
|
78
78
|
#
|
|
79
|
-
# @param
|
|
79
|
+
# @param service_address [String, nil] Body param: The address where services were performed or goods were delivered
|
|
80
80
|
#
|
|
81
|
-
# @param
|
|
81
|
+
# @param service_address_recipient [String, nil] Body param: The recipient name at the service address
|
|
82
82
|
#
|
|
83
|
-
# @param
|
|
83
|
+
# @param service_end_date [Date, nil] Body param: The end date of the service period or delivery period
|
|
84
84
|
#
|
|
85
|
-
# @param
|
|
85
|
+
# @param service_start_date [Date, nil] Body param: The start date of the service period or delivery period
|
|
86
86
|
#
|
|
87
|
-
# @param
|
|
87
|
+
# @param shipping_address [String, nil] Body param: The shipping/delivery address
|
|
88
88
|
#
|
|
89
|
-
# @param
|
|
89
|
+
# @param shipping_address_recipient [String, nil] Body param: The recipient name at the shipping address
|
|
90
90
|
#
|
|
91
|
-
# @param
|
|
91
|
+
# @param state [Symbol, EInvoiceAPI::Models::DocumentState] Body param: The current state of the document: DRAFT, TRANSIT, FAILED, SENT, or
|
|
92
92
|
#
|
|
93
|
-
# @param
|
|
93
|
+
# @param subtotal [Float, String, nil] Body param: The taxable base of the invoice. Should be the sum of all line items
|
|
94
94
|
#
|
|
95
|
-
# @param
|
|
95
|
+
# @param tax_code [Symbol, EInvoiceAPI::Models::DocumentCreate::TaxCode] Body param: Tax category code of the invoice (e.g., S for standard rate, Z for z
|
|
96
96
|
#
|
|
97
|
-
# @param
|
|
97
|
+
# @param tax_details [Array<EInvoiceAPI::Models::DocumentCreate::TaxDetail>, nil] Body param
|
|
98
98
|
#
|
|
99
|
-
# @param
|
|
99
|
+
# @param total_discount [Float, String, nil] Body param: The net financial discount/charge of the invoice (non-VAT charges mi
|
|
100
100
|
#
|
|
101
|
-
# @param
|
|
101
|
+
# @param total_tax [Float, String, nil] Body param: The total tax amount of the invoice. Must be positive and rounded to
|
|
102
102
|
#
|
|
103
|
-
# @param
|
|
103
|
+
# @param vatex [Symbol, EInvoiceAPI::Models::DocumentCreate::Vatex, nil] Body param: VATEX code list for VAT exemption reasons
|
|
104
104
|
#
|
|
105
|
-
# @param
|
|
105
|
+
# @param vatex_note [String, nil] Body param: Textual explanation for VAT exemption
|
|
106
106
|
#
|
|
107
|
-
# @param
|
|
107
|
+
# @param vendor_address [String, nil] Body param: The address of the vendor/seller
|
|
108
108
|
#
|
|
109
|
-
# @param
|
|
109
|
+
# @param vendor_address_recipient [String, nil] Body param: The recipient name at the vendor address
|
|
110
110
|
#
|
|
111
|
-
# @param
|
|
111
|
+
# @param vendor_company_id [String, nil] Body param: Vendor company ID. For Belgium this is the CBE number or their EUID
|
|
112
112
|
#
|
|
113
|
-
# @param
|
|
113
|
+
# @param vendor_email [String, nil] Body param: The email address of the vendor
|
|
114
|
+
#
|
|
115
|
+
# @param vendor_name [String, nil] Body param: The name of the vendor/seller/supplier
|
|
116
|
+
#
|
|
117
|
+
# @param vendor_tax_id [String, nil] Body param: Vendor tax ID. For Belgium this is the VAT number. Must include the
|
|
114
118
|
#
|
|
115
119
|
# @param request_options [EInvoiceAPI::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
116
120
|
#
|
|
@@ -119,10 +123,12 @@ module EInvoiceAPI
|
|
|
119
123
|
# @see EInvoiceAPI::Models::DocumentCreateParams
|
|
120
124
|
def create(params = {})
|
|
121
125
|
parsed, options = EInvoiceAPI::DocumentCreateParams.dump_request(params)
|
|
126
|
+
query_params = [:construct_pdf]
|
|
122
127
|
@client.request(
|
|
123
128
|
method: :post,
|
|
124
129
|
path: "api/documents/",
|
|
125
|
-
|
|
130
|
+
query: parsed.slice(*query_params),
|
|
131
|
+
body: parsed.except(*query_params),
|
|
126
132
|
model: EInvoiceAPI::DocumentResponse,
|
|
127
133
|
options: options
|
|
128
134
|
)
|
|
@@ -8,7 +8,7 @@ module EInvoiceAPI
|
|
|
8
8
|
#
|
|
9
9
|
# Validate if the JSON document can be converted to a valid UBL document
|
|
10
10
|
#
|
|
11
|
-
# @overload validate_json(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, request_options: {})
|
|
11
|
+
# @overload validate_json(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, request_options: {})
|
|
12
12
|
#
|
|
13
13
|
# @param allowances [Array<EInvoiceAPI::Models::DocumentCreate::Allowance>, nil]
|
|
14
14
|
#
|
|
@@ -36,6 +36,8 @@ module EInvoiceAPI
|
|
|
36
36
|
#
|
|
37
37
|
# @param customer_name [String, nil] The company name of the customer/buyer
|
|
38
38
|
#
|
|
39
|
+
# @param customer_peppol_id [String, nil] Customer Peppol ID
|
|
40
|
+
#
|
|
39
41
|
# @param customer_tax_id [String, nil] Customer tax ID. For Belgium this is the VAT number. Must include the country pr
|
|
40
42
|
#
|
|
41
43
|
# @param direction [Symbol, EInvoiceAPI::Models::DocumentDirection] The direction of the document: INBOUND (purchases) or OUTBOUND (sales)
|
|
@@ -67,6 +67,10 @@ module EInvoiceAPI
|
|
|
67
67
|
sig { returns(T.nilable(String)) }
|
|
68
68
|
attr_accessor :customer_name
|
|
69
69
|
|
|
70
|
+
# Customer Peppol ID
|
|
71
|
+
sig { returns(T.nilable(String)) }
|
|
72
|
+
attr_accessor :customer_peppol_id
|
|
73
|
+
|
|
70
74
|
# Customer tax ID. For Belgium this is the VAT number. Must include the country
|
|
71
75
|
# prefix
|
|
72
76
|
sig { returns(T.nilable(String)) }
|
|
@@ -272,6 +276,7 @@ module EInvoiceAPI
|
|
|
272
276
|
customer_email: T.nilable(String),
|
|
273
277
|
customer_id: T.nilable(String),
|
|
274
278
|
customer_name: T.nilable(String),
|
|
279
|
+
customer_peppol_id: T.nilable(String),
|
|
275
280
|
customer_tax_id: T.nilable(String),
|
|
276
281
|
direction: EInvoiceAPI::DocumentDirection::OrSymbol,
|
|
277
282
|
document_type: EInvoiceAPI::DocumentType::OrSymbol,
|
|
@@ -341,6 +346,8 @@ module EInvoiceAPI
|
|
|
341
346
|
customer_id: nil,
|
|
342
347
|
# The company name of the customer/buyer
|
|
343
348
|
customer_name: nil,
|
|
349
|
+
# Customer Peppol ID
|
|
350
|
+
customer_peppol_id: nil,
|
|
344
351
|
# Customer tax ID. For Belgium this is the VAT number. Must include the country
|
|
345
352
|
# prefix
|
|
346
353
|
customer_tax_id: nil,
|
|
@@ -444,6 +451,7 @@ module EInvoiceAPI
|
|
|
444
451
|
customer_email: T.nilable(String),
|
|
445
452
|
customer_id: T.nilable(String),
|
|
446
453
|
customer_name: T.nilable(String),
|
|
454
|
+
customer_peppol_id: T.nilable(String),
|
|
447
455
|
customer_tax_id: T.nilable(String),
|
|
448
456
|
direction: EInvoiceAPI::DocumentDirection::OrSymbol,
|
|
449
457
|
document_type: EInvoiceAPI::DocumentType::OrSymbol,
|
|
@@ -66,6 +66,10 @@ module EInvoiceAPI
|
|
|
66
66
|
sig { returns(T.nilable(String)) }
|
|
67
67
|
attr_accessor :customer_name
|
|
68
68
|
|
|
69
|
+
# Customer Peppol ID
|
|
70
|
+
sig { returns(T.nilable(String)) }
|
|
71
|
+
attr_accessor :customer_peppol_id
|
|
72
|
+
|
|
69
73
|
# Customer tax ID. For Belgium this is the VAT number. Must include the country
|
|
70
74
|
# prefix
|
|
71
75
|
sig { returns(T.nilable(String)) }
|
|
@@ -292,6 +296,7 @@ module EInvoiceAPI
|
|
|
292
296
|
customer_email: T.nilable(String),
|
|
293
297
|
customer_id: T.nilable(String),
|
|
294
298
|
customer_name: T.nilable(String),
|
|
299
|
+
customer_peppol_id: T.nilable(String),
|
|
295
300
|
customer_tax_id: T.nilable(String),
|
|
296
301
|
direction: EInvoiceAPI::DocumentDirection::OrSymbol,
|
|
297
302
|
document_type: EInvoiceAPI::DocumentType::OrSymbol,
|
|
@@ -368,6 +373,8 @@ module EInvoiceAPI
|
|
|
368
373
|
customer_id: nil,
|
|
369
374
|
# The company name of the customer/buyer
|
|
370
375
|
customer_name: nil,
|
|
376
|
+
# Customer Peppol ID
|
|
377
|
+
customer_peppol_id: nil,
|
|
371
378
|
# Customer tax ID. For Belgium this is the VAT number. Must include the country
|
|
372
379
|
# prefix
|
|
373
380
|
customer_tax_id: nil,
|
|
@@ -470,6 +477,7 @@ module EInvoiceAPI
|
|
|
470
477
|
customer_email: T.nilable(String),
|
|
471
478
|
customer_id: T.nilable(String),
|
|
472
479
|
customer_name: T.nilable(String),
|
|
480
|
+
customer_peppol_id: T.nilable(String),
|
|
473
481
|
customer_tax_id: T.nilable(String),
|
|
474
482
|
direction: EInvoiceAPI::DocumentDirection::TaggedSymbol,
|
|
475
483
|
document_type: EInvoiceAPI::DocumentType::TaggedSymbol,
|
|
@@ -14,15 +14,36 @@ module EInvoiceAPI
|
|
|
14
14
|
)
|
|
15
15
|
end
|
|
16
16
|
|
|
17
|
+
# If true, generate a constructed PDF from the document and include it both as
|
|
18
|
+
# document attachment and embedded in the UBL.
|
|
19
|
+
sig { returns(T.nilable(T::Boolean)) }
|
|
20
|
+
attr_reader :construct_pdf
|
|
21
|
+
|
|
22
|
+
sig { params(construct_pdf: T::Boolean).void }
|
|
23
|
+
attr_writer :construct_pdf
|
|
24
|
+
|
|
17
25
|
sig do
|
|
18
|
-
params(
|
|
19
|
-
T
|
|
20
|
-
|
|
26
|
+
params(
|
|
27
|
+
construct_pdf: T::Boolean,
|
|
28
|
+
request_options: EInvoiceAPI::RequestOptions::OrHash
|
|
29
|
+
).returns(T.attached_class)
|
|
21
30
|
end
|
|
22
|
-
def self.new(
|
|
31
|
+
def self.new(
|
|
32
|
+
# If true, generate a constructed PDF from the document and include it both as
|
|
33
|
+
# document attachment and embedded in the UBL.
|
|
34
|
+
construct_pdf: nil,
|
|
35
|
+
request_options: {}
|
|
36
|
+
)
|
|
23
37
|
end
|
|
24
38
|
|
|
25
|
-
sig
|
|
39
|
+
sig do
|
|
40
|
+
override.returns(
|
|
41
|
+
{
|
|
42
|
+
construct_pdf: T::Boolean,
|
|
43
|
+
request_options: EInvoiceAPI::RequestOptions
|
|
44
|
+
}
|
|
45
|
+
)
|
|
46
|
+
end
|
|
26
47
|
def to_hash
|
|
27
48
|
end
|
|
28
49
|
end
|
|
@@ -73,6 +73,10 @@ module EInvoiceAPI
|
|
|
73
73
|
sig { returns(T.nilable(String)) }
|
|
74
74
|
attr_accessor :customer_name
|
|
75
75
|
|
|
76
|
+
# Customer Peppol ID
|
|
77
|
+
sig { returns(T.nilable(String)) }
|
|
78
|
+
attr_accessor :customer_peppol_id
|
|
79
|
+
|
|
76
80
|
# Customer tax ID. For Belgium this is the VAT number. Must include the country
|
|
77
81
|
# prefix
|
|
78
82
|
sig { returns(T.nilable(String)) }
|
|
@@ -266,6 +270,7 @@ module EInvoiceAPI
|
|
|
266
270
|
customer_email: T.nilable(String),
|
|
267
271
|
customer_id: T.nilable(String),
|
|
268
272
|
customer_name: T.nilable(String),
|
|
273
|
+
customer_peppol_id: T.nilable(String),
|
|
269
274
|
customer_tax_id: T.nilable(String),
|
|
270
275
|
direction: EInvoiceAPI::DocumentDirection::OrSymbol,
|
|
271
276
|
document_type: EInvoiceAPI::DocumentType::OrSymbol,
|
|
@@ -336,6 +341,8 @@ module EInvoiceAPI
|
|
|
336
341
|
customer_id: nil,
|
|
337
342
|
# The company name of the customer/buyer
|
|
338
343
|
customer_name: nil,
|
|
344
|
+
# Customer Peppol ID
|
|
345
|
+
customer_peppol_id: nil,
|
|
339
346
|
# Customer tax ID. For Belgium this is the VAT number. Must include the country
|
|
340
347
|
# prefix
|
|
341
348
|
customer_tax_id: nil,
|
|
@@ -436,6 +443,7 @@ module EInvoiceAPI
|
|
|
436
443
|
customer_email: T.nilable(String),
|
|
437
444
|
customer_id: T.nilable(String),
|
|
438
445
|
customer_name: T.nilable(String),
|
|
446
|
+
customer_peppol_id: T.nilable(String),
|
|
439
447
|
customer_tax_id: T.nilable(String),
|
|
440
448
|
direction: EInvoiceAPI::DocumentDirection::TaggedSymbol,
|
|
441
449
|
document_type: EInvoiceAPI::DocumentType::TaggedSymbol,
|
|
@@ -12,6 +12,7 @@ module EInvoiceAPI
|
|
|
12
12
|
# Create a new invoice or credit note
|
|
13
13
|
sig do
|
|
14
14
|
params(
|
|
15
|
+
construct_pdf: T::Boolean,
|
|
15
16
|
allowances:
|
|
16
17
|
T.nilable(T::Array[EInvoiceAPI::DocumentCreate::Allowance::OrHash]),
|
|
17
18
|
amount_due:
|
|
@@ -29,6 +30,7 @@ module EInvoiceAPI
|
|
|
29
30
|
customer_email: T.nilable(String),
|
|
30
31
|
customer_id: T.nilable(String),
|
|
31
32
|
customer_name: T.nilable(String),
|
|
33
|
+
customer_peppol_id: T.nilable(String),
|
|
32
34
|
customer_tax_id: T.nilable(String),
|
|
33
35
|
direction: EInvoiceAPI::DocumentDirection::OrSymbol,
|
|
34
36
|
document_type: EInvoiceAPI::DocumentType::OrSymbol,
|
|
@@ -75,110 +77,125 @@ module EInvoiceAPI
|
|
|
75
77
|
).returns(EInvoiceAPI::DocumentResponse)
|
|
76
78
|
end
|
|
77
79
|
def create(
|
|
80
|
+
# Query param: If true, generate a constructed PDF from the document and include
|
|
81
|
+
# it both as document attachment and embedded in the UBL.
|
|
82
|
+
construct_pdf: nil,
|
|
83
|
+
# Body param
|
|
78
84
|
allowances: nil,
|
|
79
|
-
# The amount due for payment. Must be positive and rounded to maximum
|
|
85
|
+
# Body param: The amount due for payment. Must be positive and rounded to maximum
|
|
86
|
+
# 2 decimals
|
|
80
87
|
amount_due: nil,
|
|
88
|
+
# Body param
|
|
81
89
|
attachments: nil,
|
|
82
|
-
# The billing address (if different from customer address)
|
|
90
|
+
# Body param: The billing address (if different from customer address)
|
|
83
91
|
billing_address: nil,
|
|
84
|
-
# The recipient name at the billing address
|
|
92
|
+
# Body param: The recipient name at the billing address
|
|
85
93
|
billing_address_recipient: nil,
|
|
94
|
+
# Body param
|
|
86
95
|
charges: nil,
|
|
87
|
-
# Currency of the invoice (ISO 4217 currency code)
|
|
96
|
+
# Body param: Currency of the invoice (ISO 4217 currency code)
|
|
88
97
|
currency: nil,
|
|
89
|
-
# The address of the customer/buyer
|
|
98
|
+
# Body param: The address of the customer/buyer
|
|
90
99
|
customer_address: nil,
|
|
91
|
-
# The recipient name at the customer address
|
|
100
|
+
# Body param: The recipient name at the customer address
|
|
92
101
|
customer_address_recipient: nil,
|
|
93
|
-
# Customer company ID. For Belgium this is the CBE number or their
|
|
94
|
-
# Unique Identifier) number. In the Netherlands this is the KVK
|
|
102
|
+
# Body param: Customer company ID. For Belgium this is the CBE number or their
|
|
103
|
+
# EUID (European Unique Identifier) number. In the Netherlands this is the KVK
|
|
104
|
+
# number.
|
|
95
105
|
customer_company_id: nil,
|
|
96
|
-
# The email address of the customer
|
|
106
|
+
# Body param: The email address of the customer
|
|
97
107
|
customer_email: nil,
|
|
98
|
-
# The unique identifier for the customer in your system
|
|
108
|
+
# Body param: The unique identifier for the customer in your system
|
|
99
109
|
customer_id: nil,
|
|
100
|
-
# The company name of the customer/buyer
|
|
110
|
+
# Body param: The company name of the customer/buyer
|
|
101
111
|
customer_name: nil,
|
|
102
|
-
# Customer
|
|
103
|
-
|
|
112
|
+
# Body param: Customer Peppol ID
|
|
113
|
+
customer_peppol_id: nil,
|
|
114
|
+
# Body param: Customer tax ID. For Belgium this is the VAT number. Must include
|
|
115
|
+
# the country prefix
|
|
104
116
|
customer_tax_id: nil,
|
|
105
|
-
# The direction of the document: INBOUND (purchases) or OUTBOUND
|
|
117
|
+
# Body param: The direction of the document: INBOUND (purchases) or OUTBOUND
|
|
118
|
+
# (sales)
|
|
106
119
|
direction: nil,
|
|
107
|
-
# The type of document: INVOICE, CREDIT_NOTE, or DEBIT_NOTE
|
|
120
|
+
# Body param: The type of document: INVOICE, CREDIT_NOTE, or DEBIT_NOTE
|
|
108
121
|
document_type: nil,
|
|
109
|
-
# The date when payment is due
|
|
122
|
+
# Body param: The date when payment is due
|
|
110
123
|
due_date: nil,
|
|
111
|
-
# The date when the invoice was issued
|
|
124
|
+
# Body param: The date when the invoice was issued
|
|
112
125
|
invoice_date: nil,
|
|
113
|
-
# The unique invoice identifier/number
|
|
126
|
+
# Body param: The unique invoice identifier/number
|
|
114
127
|
invoice_id: nil,
|
|
115
|
-
# The total amount of the invoice including tax (invoice_total =
|
|
116
|
-
# total_tax + total_discount). Must be positive and rounded to maximum
|
|
128
|
+
# Body param: The total amount of the invoice including tax (invoice_total =
|
|
129
|
+
# subtotal + total_tax + total_discount). Must be positive and rounded to maximum
|
|
130
|
+
# 2 decimals
|
|
117
131
|
invoice_total: nil,
|
|
118
|
-
# At least one line item is required
|
|
132
|
+
# Body param: At least one line item is required
|
|
119
133
|
items: nil,
|
|
120
|
-
# Additional notes or comments for the invoice
|
|
134
|
+
# Body param: Additional notes or comments for the invoice
|
|
121
135
|
note: nil,
|
|
136
|
+
# Body param
|
|
122
137
|
payment_details: nil,
|
|
123
|
-
# The payment terms (e.g., 'Net 30', 'Due on receipt', '2/10 Net 30')
|
|
138
|
+
# Body param: The payment terms (e.g., 'Net 30', 'Due on receipt', '2/10 Net 30')
|
|
124
139
|
payment_term: nil,
|
|
125
|
-
# The previous unpaid balance from prior invoices, if any. Must be
|
|
126
|
-
# rounded to maximum 2 decimals
|
|
140
|
+
# Body param: The previous unpaid balance from prior invoices, if any. Must be
|
|
141
|
+
# positive and rounded to maximum 2 decimals
|
|
127
142
|
previous_unpaid_balance: nil,
|
|
128
|
-
# The purchase order reference number
|
|
143
|
+
# Body param: The purchase order reference number
|
|
129
144
|
purchase_order: nil,
|
|
130
|
-
# The address where payment should be sent or remitted to
|
|
145
|
+
# Body param: The address where payment should be sent or remitted to
|
|
131
146
|
remittance_address: nil,
|
|
132
|
-
# The recipient name at the remittance address
|
|
147
|
+
# Body param: The recipient name at the remittance address
|
|
133
148
|
remittance_address_recipient: nil,
|
|
134
|
-
# The address where services were performed or goods were delivered
|
|
149
|
+
# Body param: The address where services were performed or goods were delivered
|
|
135
150
|
service_address: nil,
|
|
136
|
-
# The recipient name at the service address
|
|
151
|
+
# Body param: The recipient name at the service address
|
|
137
152
|
service_address_recipient: nil,
|
|
138
|
-
# The end date of the service period or delivery period
|
|
153
|
+
# Body param: The end date of the service period or delivery period
|
|
139
154
|
service_end_date: nil,
|
|
140
|
-
# The start date of the service period or delivery period
|
|
155
|
+
# Body param: The start date of the service period or delivery period
|
|
141
156
|
service_start_date: nil,
|
|
142
|
-
# The shipping/delivery address
|
|
157
|
+
# Body param: The shipping/delivery address
|
|
143
158
|
shipping_address: nil,
|
|
144
|
-
# The recipient name at the shipping address
|
|
159
|
+
# Body param: The recipient name at the shipping address
|
|
145
160
|
shipping_address_recipient: nil,
|
|
146
|
-
# The current state of the document: DRAFT, TRANSIT, FAILED, SENT, or
|
|
161
|
+
# Body param: The current state of the document: DRAFT, TRANSIT, FAILED, SENT, or
|
|
162
|
+
# RECEIVED
|
|
147
163
|
state: nil,
|
|
148
|
-
# The taxable base of the invoice. Should be the sum of all line
|
|
149
|
-
# allowances (for example commercial discounts) + charges with impact on
|
|
150
|
-
# be positive and rounded to maximum 2 decimals
|
|
164
|
+
# Body param: The taxable base of the invoice. Should be the sum of all line
|
|
165
|
+
# items - allowances (for example commercial discounts) + charges with impact on
|
|
166
|
+
# VAT. Must be positive and rounded to maximum 2 decimals
|
|
151
167
|
subtotal: nil,
|
|
152
|
-
# Tax category code of the invoice (e.g., S for standard rate, Z for
|
|
153
|
-
# for exempt)
|
|
168
|
+
# Body param: Tax category code of the invoice (e.g., S for standard rate, Z for
|
|
169
|
+
# zero rate, E for exempt)
|
|
154
170
|
tax_code: nil,
|
|
171
|
+
# Body param
|
|
155
172
|
tax_details: nil,
|
|
156
|
-
# The net financial discount/charge of the invoice (non-VAT charges
|
|
157
|
-
# allowances). Can be positive (net charge), negative (net
|
|
158
|
-
# Must be rounded to maximum 2 decimals
|
|
173
|
+
# Body param: The net financial discount/charge of the invoice (non-VAT charges
|
|
174
|
+
# minus non-VAT allowances). Can be positive (net charge), negative (net
|
|
175
|
+
# discount), or zero. Must be rounded to maximum 2 decimals
|
|
159
176
|
total_discount: nil,
|
|
160
|
-
# The total tax amount of the invoice. Must be positive and rounded to
|
|
161
|
-
# decimals
|
|
177
|
+
# Body param: The total tax amount of the invoice. Must be positive and rounded to
|
|
178
|
+
# maximum 2 decimals
|
|
162
179
|
total_tax: nil,
|
|
163
|
-
# VATEX code list for VAT exemption reasons
|
|
180
|
+
# Body param: VATEX code list for VAT exemption reasons
|
|
164
181
|
#
|
|
165
182
|
# Agency: CEF Identifier: vatex
|
|
166
183
|
vatex: nil,
|
|
167
|
-
# Textual explanation for VAT exemption
|
|
184
|
+
# Body param: Textual explanation for VAT exemption
|
|
168
185
|
vatex_note: nil,
|
|
169
|
-
# The address of the vendor/seller
|
|
186
|
+
# Body param: The address of the vendor/seller
|
|
170
187
|
vendor_address: nil,
|
|
171
|
-
# The recipient name at the vendor address
|
|
188
|
+
# Body param: The recipient name at the vendor address
|
|
172
189
|
vendor_address_recipient: nil,
|
|
173
|
-
# Vendor company ID. For Belgium this is the CBE number or their EUID
|
|
174
|
-
# Unique Identifier) number. In the Netherlands this is the KVK number.
|
|
190
|
+
# Body param: Vendor company ID. For Belgium this is the CBE number or their EUID
|
|
191
|
+
# (European Unique Identifier) number. In the Netherlands this is the KVK number.
|
|
175
192
|
vendor_company_id: nil,
|
|
176
|
-
# The email address of the vendor
|
|
193
|
+
# Body param: The email address of the vendor
|
|
177
194
|
vendor_email: nil,
|
|
178
|
-
# The name of the vendor/seller/supplier
|
|
195
|
+
# Body param: The name of the vendor/seller/supplier
|
|
179
196
|
vendor_name: nil,
|
|
180
|
-
# Vendor tax ID. For Belgium this is the VAT number. Must include the
|
|
181
|
-
# prefix
|
|
197
|
+
# Body param: Vendor tax ID. For Belgium this is the VAT number. Must include the
|
|
198
|
+
# country prefix
|
|
182
199
|
vendor_tax_id: nil,
|
|
183
200
|
request_options: {}
|
|
184
201
|
)
|
|
@@ -23,6 +23,7 @@ module EInvoiceAPI
|
|
|
23
23
|
customer_email: T.nilable(String),
|
|
24
24
|
customer_id: T.nilable(String),
|
|
25
25
|
customer_name: T.nilable(String),
|
|
26
|
+
customer_peppol_id: T.nilable(String),
|
|
26
27
|
customer_tax_id: T.nilable(String),
|
|
27
28
|
direction: EInvoiceAPI::DocumentDirection::OrSymbol,
|
|
28
29
|
document_type: EInvoiceAPI::DocumentType::OrSymbol,
|
|
@@ -93,6 +94,8 @@ module EInvoiceAPI
|
|
|
93
94
|
customer_id: nil,
|
|
94
95
|
# The company name of the customer/buyer
|
|
95
96
|
customer_name: nil,
|
|
97
|
+
# Customer Peppol ID
|
|
98
|
+
customer_peppol_id: nil,
|
|
96
99
|
# Customer tax ID. For Belgium this is the VAT number. Must include the country
|
|
97
100
|
# prefix
|
|
98
101
|
customer_tax_id: nil,
|
|
@@ -15,6 +15,7 @@ module EInvoiceAPI
|
|
|
15
15
|
customer_email: String?,
|
|
16
16
|
customer_id: String?,
|
|
17
17
|
customer_name: String?,
|
|
18
|
+
customer_peppol_id: String?,
|
|
18
19
|
customer_tax_id: String?,
|
|
19
20
|
direction: EInvoiceAPI::Models::document_direction,
|
|
20
21
|
document_type: EInvoiceAPI::Models::document_type,
|
|
@@ -83,6 +84,8 @@ module EInvoiceAPI
|
|
|
83
84
|
|
|
84
85
|
attr_accessor customer_name: String?
|
|
85
86
|
|
|
87
|
+
attr_accessor customer_peppol_id: String?
|
|
88
|
+
|
|
86
89
|
attr_accessor customer_tax_id: String?
|
|
87
90
|
|
|
88
91
|
attr_reader direction: EInvoiceAPI::Models::document_direction?
|
|
@@ -187,6 +190,7 @@ module EInvoiceAPI
|
|
|
187
190
|
?customer_email: String?,
|
|
188
191
|
?customer_id: String?,
|
|
189
192
|
?customer_name: String?,
|
|
193
|
+
?customer_peppol_id: String?,
|
|
190
194
|
?customer_tax_id: String?,
|
|
191
195
|
?direction: EInvoiceAPI::Models::document_direction,
|
|
192
196
|
?document_type: EInvoiceAPI::Models::document_type,
|
|
@@ -238,6 +242,7 @@ module EInvoiceAPI
|
|
|
238
242
|
customer_email: String?,
|
|
239
243
|
customer_id: String?,
|
|
240
244
|
customer_name: String?,
|
|
245
|
+
customer_peppol_id: String?,
|
|
241
246
|
customer_tax_id: String?,
|
|
242
247
|
direction: EInvoiceAPI::Models::document_direction,
|
|
243
248
|
document_type: EInvoiceAPI::Models::document_type,
|
|
@@ -15,6 +15,7 @@ module EInvoiceAPI
|
|
|
15
15
|
customer_email: String?,
|
|
16
16
|
customer_id: String?,
|
|
17
17
|
customer_name: String?,
|
|
18
|
+
customer_peppol_id: String?,
|
|
18
19
|
customer_tax_id: String?,
|
|
19
20
|
direction: EInvoiceAPI::Models::document_direction,
|
|
20
21
|
document_type: EInvoiceAPI::Models::document_type,
|
|
@@ -84,6 +85,8 @@ module EInvoiceAPI
|
|
|
84
85
|
|
|
85
86
|
attr_accessor customer_name: String?
|
|
86
87
|
|
|
88
|
+
attr_accessor customer_peppol_id: String?
|
|
89
|
+
|
|
87
90
|
attr_accessor customer_tax_id: String?
|
|
88
91
|
|
|
89
92
|
attr_reader direction: EInvoiceAPI::Models::document_direction?
|
|
@@ -192,6 +195,7 @@ module EInvoiceAPI
|
|
|
192
195
|
?customer_email: String?,
|
|
193
196
|
?customer_id: String?,
|
|
194
197
|
?customer_name: String?,
|
|
198
|
+
?customer_peppol_id: String?,
|
|
195
199
|
?customer_tax_id: String?,
|
|
196
200
|
?direction: EInvoiceAPI::Models::document_direction,
|
|
197
201
|
?document_type: EInvoiceAPI::Models::document_type,
|
|
@@ -244,6 +248,7 @@ module EInvoiceAPI
|
|
|
244
248
|
customer_email: String?,
|
|
245
249
|
customer_id: String?,
|
|
246
250
|
customer_name: String?,
|
|
251
|
+
customer_peppol_id: String?,
|
|
247
252
|
customer_tax_id: String?,
|
|
248
253
|
direction: EInvoiceAPI::Models::document_direction,
|
|
249
254
|
document_type: EInvoiceAPI::Models::document_type,
|
|
@@ -1,15 +1,25 @@
|
|
|
1
1
|
module EInvoiceAPI
|
|
2
2
|
module Models
|
|
3
3
|
type document_create_params =
|
|
4
|
-
{
|
|
4
|
+
{ construct_pdf: bool } & EInvoiceAPI::Internal::Type::request_parameters
|
|
5
5
|
|
|
6
6
|
class DocumentCreateParams < EInvoiceAPI::Models::DocumentCreate
|
|
7
7
|
extend EInvoiceAPI::Internal::Type::RequestParameters::Converter
|
|
8
8
|
include EInvoiceAPI::Internal::Type::RequestParameters
|
|
9
9
|
|
|
10
|
-
def
|
|
10
|
+
def construct_pdf: -> bool?
|
|
11
11
|
|
|
12
|
-
def
|
|
12
|
+
def construct_pdf=: (bool _) -> bool
|
|
13
|
+
|
|
14
|
+
def initialize: (
|
|
15
|
+
?construct_pdf: bool,
|
|
16
|
+
?request_options: EInvoiceAPI::request_opts
|
|
17
|
+
) -> void
|
|
18
|
+
|
|
19
|
+
def to_hash: -> {
|
|
20
|
+
construct_pdf: bool,
|
|
21
|
+
request_options: EInvoiceAPI::RequestOptions
|
|
22
|
+
}
|
|
13
23
|
end
|
|
14
24
|
end
|
|
15
25
|
end
|
|
@@ -17,6 +17,7 @@ module EInvoiceAPI
|
|
|
17
17
|
customer_email: String?,
|
|
18
18
|
customer_id: String?,
|
|
19
19
|
customer_name: String?,
|
|
20
|
+
customer_peppol_id: String?,
|
|
20
21
|
customer_tax_id: String?,
|
|
21
22
|
direction: EInvoiceAPI::Models::document_direction,
|
|
22
23
|
document_type: EInvoiceAPI::Models::document_type,
|
|
@@ -88,6 +89,8 @@ module EInvoiceAPI
|
|
|
88
89
|
|
|
89
90
|
attr_accessor customer_name: String?
|
|
90
91
|
|
|
92
|
+
attr_accessor customer_peppol_id: String?
|
|
93
|
+
|
|
91
94
|
attr_accessor customer_tax_id: String?
|
|
92
95
|
|
|
93
96
|
attr_reader direction: EInvoiceAPI::Models::document_direction?
|
|
@@ -188,6 +191,7 @@ module EInvoiceAPI
|
|
|
188
191
|
?customer_email: String?,
|
|
189
192
|
?customer_id: String?,
|
|
190
193
|
?customer_name: String?,
|
|
194
|
+
?customer_peppol_id: String?,
|
|
191
195
|
?customer_tax_id: String?,
|
|
192
196
|
?direction: EInvoiceAPI::Models::document_direction,
|
|
193
197
|
?document_type: EInvoiceAPI::Models::document_type,
|
|
@@ -240,6 +244,7 @@ module EInvoiceAPI
|
|
|
240
244
|
customer_email: String?,
|
|
241
245
|
customer_id: String?,
|
|
242
246
|
customer_name: String?,
|
|
247
|
+
customer_peppol_id: String?,
|
|
243
248
|
customer_tax_id: String?,
|
|
244
249
|
direction: EInvoiceAPI::Models::document_direction,
|
|
245
250
|
document_type: EInvoiceAPI::Models::document_type,
|
|
@@ -6,6 +6,7 @@ module EInvoiceAPI
|
|
|
6
6
|
attr_reader ubl: EInvoiceAPI::Resources::Documents::Ubl
|
|
7
7
|
|
|
8
8
|
def create: (
|
|
9
|
+
?construct_pdf: bool,
|
|
9
10
|
?allowances: ::Array[EInvoiceAPI::DocumentCreate::Allowance]?,
|
|
10
11
|
?amount_due: EInvoiceAPI::Models::DocumentCreate::amount_due?,
|
|
11
12
|
?attachments: ::Array[EInvoiceAPI::DocumentAttachmentCreate]?,
|
|
@@ -19,6 +20,7 @@ module EInvoiceAPI
|
|
|
19
20
|
?customer_email: String?,
|
|
20
21
|
?customer_id: String?,
|
|
21
22
|
?customer_name: String?,
|
|
23
|
+
?customer_peppol_id: String?,
|
|
22
24
|
?customer_tax_id: String?,
|
|
23
25
|
?direction: EInvoiceAPI::Models::document_direction,
|
|
24
26
|
?document_type: EInvoiceAPI::Models::document_type,
|
|
@@ -15,6 +15,7 @@ module EInvoiceAPI
|
|
|
15
15
|
?customer_email: String?,
|
|
16
16
|
?customer_id: String?,
|
|
17
17
|
?customer_name: String?,
|
|
18
|
+
?customer_peppol_id: String?,
|
|
18
19
|
?customer_tax_id: String?,
|
|
19
20
|
?direction: EInvoiceAPI::Models::document_direction,
|
|
20
21
|
?document_type: EInvoiceAPI::Models::document_type,
|
metadata
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: e-invoice-api
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 0.
|
|
4
|
+
version: 0.22.0
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- e-invoice
|
|
8
8
|
autorequire:
|
|
9
9
|
bindir: bin
|
|
10
10
|
cert_chain: []
|
|
11
|
-
date: 2026-02-
|
|
11
|
+
date: 2026-02-13 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
name: cgi
|