e-invoice-api 0.20.3 → 0.21.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_params.rb +13 -1
- data/lib/e_invoice_api/resources/documents.rb +54 -50
- data/lib/e_invoice_api/version.rb +1 -1
- data/rbi/e_invoice_api/models/document_create_params.rbi +26 -5
- data/rbi/e_invoice_api/resources/documents.rbi +69 -55
- data/sig/e_invoice_api/models/document_create_params.rbs +13 -3
- data/sig/e_invoice_api/resources/documents.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: 5e9af0e782b8222197b3b51df35131749a28598e1b4e81fa5873303a0ff735b5
|
|
4
|
+
data.tar.gz: 94ff5931f865c4b6329130be709105c614d5aca3a24f17ca08f5e905676991c7
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 136b49718d1ee76f98159180970a85c543689053f2ca0ba1fc511333fd72056399cd76a0820c975a0fcf83597be98444179a18d371baeb862627c4ececfde220
|
|
7
|
+
data.tar.gz: 4e6a55c35de4337e8442e98f8045240b0b923af47f462e48af8d654acd12a71e9d201cb247cbabf5901c139c505c6330487f3de9aec28b1d1de2f9b181dd40a8
|
data/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,13 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## 0.21.0 (2026-02-09)
|
|
4
|
+
|
|
5
|
+
Full Changelog: [v0.20.3...v0.21.0](https://github.com/e-invoice-be/e-invoice-rb/compare/v0.20.3...v0.21.0)
|
|
6
|
+
|
|
7
|
+
### Features
|
|
8
|
+
|
|
9
|
+
* **api:** api update ([ce79dba](https://github.com/e-invoice-be/e-invoice-rb/commit/ce79dba27b692bb54257509c1d3cff3e25f5be43))
|
|
10
|
+
|
|
3
11
|
## 0.20.3 (2026-02-07)
|
|
4
12
|
|
|
5
13
|
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
|
@@ -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
|
|
@@ -14,103 +14,105 @@ 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_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_tax_id [String, nil] Body param: Customer tax ID. For Belgium this is the VAT number. Must include th
|
|
48
48
|
#
|
|
49
|
-
# @param
|
|
49
|
+
# @param direction [Symbol, EInvoiceAPI::Models::DocumentDirection] Body param: The direction of the document: INBOUND (purchases) or OUTBOUND (sale
|
|
50
50
|
#
|
|
51
|
-
# @param
|
|
51
|
+
# @param document_type [Symbol, EInvoiceAPI::Models::DocumentType] Body param: The type of document: INVOICE, CREDIT_NOTE, or DEBIT_NOTE
|
|
52
52
|
#
|
|
53
|
-
# @param
|
|
53
|
+
# @param due_date [Date, nil] Body param: The date when payment is due
|
|
54
54
|
#
|
|
55
|
-
# @param
|
|
55
|
+
# @param invoice_date [Date, nil] Body param: The date when the invoice was issued
|
|
56
56
|
#
|
|
57
|
-
# @param
|
|
57
|
+
# @param invoice_id [String, nil] Body param: The unique invoice identifier/number
|
|
58
58
|
#
|
|
59
|
-
# @param
|
|
59
|
+
# @param invoice_total [Float, String, nil] Body param: The total amount of the invoice including tax (invoice_total = subto
|
|
60
60
|
#
|
|
61
|
-
# @param
|
|
61
|
+
# @param items [Array<EInvoiceAPI::Models::DocumentCreate::Item>] Body param: At least one line item is required
|
|
62
62
|
#
|
|
63
|
-
# @param
|
|
63
|
+
# @param note [String, nil] Body param: Additional notes or comments for the invoice
|
|
64
64
|
#
|
|
65
|
-
# @param
|
|
65
|
+
# @param payment_details [Array<EInvoiceAPI::Models::PaymentDetailCreate>, nil] Body param
|
|
66
66
|
#
|
|
67
|
-
# @param
|
|
67
|
+
# @param payment_term [String, nil] Body param: The payment terms (e.g., 'Net 30', 'Due on receipt', '2/10 Net 30')
|
|
68
68
|
#
|
|
69
|
-
# @param
|
|
69
|
+
# @param previous_unpaid_balance [Float, String, nil] Body param: The previous unpaid balance from prior invoices, if any. Must be pos
|
|
70
70
|
#
|
|
71
|
-
# @param
|
|
71
|
+
# @param purchase_order [String, nil] Body param: The purchase order reference number
|
|
72
72
|
#
|
|
73
|
-
# @param
|
|
73
|
+
# @param remittance_address [String, nil] Body param: The address where payment should be sent or remitted to
|
|
74
74
|
#
|
|
75
|
-
# @param
|
|
75
|
+
# @param remittance_address_recipient [String, nil] Body param: The recipient name at the remittance address
|
|
76
76
|
#
|
|
77
|
-
# @param
|
|
77
|
+
# @param service_address [String, nil] Body param: The address where services were performed or goods were delivered
|
|
78
78
|
#
|
|
79
|
-
# @param
|
|
79
|
+
# @param service_address_recipient [String, nil] Body param: The recipient name at the service address
|
|
80
80
|
#
|
|
81
|
-
# @param
|
|
81
|
+
# @param service_end_date [Date, nil] Body param: The end date of the service period or delivery period
|
|
82
82
|
#
|
|
83
|
-
# @param
|
|
83
|
+
# @param service_start_date [Date, nil] Body param: The start date of the service period or delivery period
|
|
84
84
|
#
|
|
85
|
-
# @param
|
|
85
|
+
# @param shipping_address [String, nil] Body param: The shipping/delivery address
|
|
86
86
|
#
|
|
87
|
-
# @param
|
|
87
|
+
# @param shipping_address_recipient [String, nil] Body param: The recipient name at the shipping address
|
|
88
88
|
#
|
|
89
|
-
# @param
|
|
89
|
+
# @param state [Symbol, EInvoiceAPI::Models::DocumentState] Body param: The current state of the document: DRAFT, TRANSIT, FAILED, SENT, or
|
|
90
90
|
#
|
|
91
|
-
# @param
|
|
91
|
+
# @param subtotal [Float, String, nil] Body param: The taxable base of the invoice. Should be the sum of all line items
|
|
92
92
|
#
|
|
93
|
-
# @param
|
|
93
|
+
# @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
|
|
94
94
|
#
|
|
95
|
-
# @param
|
|
95
|
+
# @param tax_details [Array<EInvoiceAPI::Models::DocumentCreate::TaxDetail>, nil] Body param
|
|
96
96
|
#
|
|
97
|
-
# @param
|
|
97
|
+
# @param total_discount [Float, String, nil] Body param: The net financial discount/charge of the invoice (non-VAT charges mi
|
|
98
98
|
#
|
|
99
|
-
# @param
|
|
99
|
+
# @param total_tax [Float, String, nil] Body param: The total tax amount of the invoice. Must be positive and rounded to
|
|
100
100
|
#
|
|
101
|
-
# @param
|
|
101
|
+
# @param vatex [Symbol, EInvoiceAPI::Models::DocumentCreate::Vatex, nil] Body param: VATEX code list for VAT exemption reasons
|
|
102
102
|
#
|
|
103
|
-
# @param
|
|
103
|
+
# @param vatex_note [String, nil] Body param: Textual explanation for VAT exemption
|
|
104
104
|
#
|
|
105
|
-
# @param
|
|
105
|
+
# @param vendor_address [String, nil] Body param: The address of the vendor/seller
|
|
106
106
|
#
|
|
107
|
-
# @param
|
|
107
|
+
# @param vendor_address_recipient [String, nil] Body param: The recipient name at the vendor address
|
|
108
108
|
#
|
|
109
|
-
# @param
|
|
109
|
+
# @param vendor_company_id [String, nil] Body param: Vendor company ID. For Belgium this is the CBE number or their EUID
|
|
110
110
|
#
|
|
111
|
-
# @param
|
|
111
|
+
# @param vendor_email [String, nil] Body param: The email address of the vendor
|
|
112
112
|
#
|
|
113
|
-
# @param
|
|
113
|
+
# @param vendor_name [String, nil] Body param: The name of the vendor/seller/supplier
|
|
114
|
+
#
|
|
115
|
+
# @param vendor_tax_id [String, nil] Body param: Vendor tax ID. For Belgium this is the VAT number. Must include the
|
|
114
116
|
#
|
|
115
117
|
# @param request_options [EInvoiceAPI::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
116
118
|
#
|
|
@@ -119,10 +121,12 @@ module EInvoiceAPI
|
|
|
119
121
|
# @see EInvoiceAPI::Models::DocumentCreateParams
|
|
120
122
|
def create(params = {})
|
|
121
123
|
parsed, options = EInvoiceAPI::DocumentCreateParams.dump_request(params)
|
|
124
|
+
query_params = [:construct_pdf]
|
|
122
125
|
@client.request(
|
|
123
126
|
method: :post,
|
|
124
127
|
path: "api/documents/",
|
|
125
|
-
|
|
128
|
+
query: parsed.slice(*query_params),
|
|
129
|
+
body: parsed.except(*query_params),
|
|
126
130
|
model: EInvoiceAPI::DocumentResponse,
|
|
127
131
|
options: options
|
|
128
132
|
)
|
|
@@ -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
|
|
@@ -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:
|
|
@@ -75,110 +76,123 @@ module EInvoiceAPI
|
|
|
75
76
|
).returns(EInvoiceAPI::DocumentResponse)
|
|
76
77
|
end
|
|
77
78
|
def create(
|
|
79
|
+
# Query param: If true, generate a constructed PDF from the document and include
|
|
80
|
+
# it both as document attachment and embedded in the UBL.
|
|
81
|
+
construct_pdf: nil,
|
|
82
|
+
# Body param
|
|
78
83
|
allowances: nil,
|
|
79
|
-
# The amount due for payment. Must be positive and rounded to maximum
|
|
84
|
+
# Body param: The amount due for payment. Must be positive and rounded to maximum
|
|
85
|
+
# 2 decimals
|
|
80
86
|
amount_due: nil,
|
|
87
|
+
# Body param
|
|
81
88
|
attachments: nil,
|
|
82
|
-
# The billing address (if different from customer address)
|
|
89
|
+
# Body param: The billing address (if different from customer address)
|
|
83
90
|
billing_address: nil,
|
|
84
|
-
# The recipient name at the billing address
|
|
91
|
+
# Body param: The recipient name at the billing address
|
|
85
92
|
billing_address_recipient: nil,
|
|
93
|
+
# Body param
|
|
86
94
|
charges: nil,
|
|
87
|
-
# Currency of the invoice (ISO 4217 currency code)
|
|
95
|
+
# Body param: Currency of the invoice (ISO 4217 currency code)
|
|
88
96
|
currency: nil,
|
|
89
|
-
# The address of the customer/buyer
|
|
97
|
+
# Body param: The address of the customer/buyer
|
|
90
98
|
customer_address: nil,
|
|
91
|
-
# The recipient name at the customer address
|
|
99
|
+
# Body param: The recipient name at the customer address
|
|
92
100
|
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
|
|
101
|
+
# Body param: Customer company ID. For Belgium this is the CBE number or their
|
|
102
|
+
# EUID (European Unique Identifier) number. In the Netherlands this is the KVK
|
|
103
|
+
# number.
|
|
95
104
|
customer_company_id: nil,
|
|
96
|
-
# The email address of the customer
|
|
105
|
+
# Body param: The email address of the customer
|
|
97
106
|
customer_email: nil,
|
|
98
|
-
# The unique identifier for the customer in your system
|
|
107
|
+
# Body param: The unique identifier for the customer in your system
|
|
99
108
|
customer_id: nil,
|
|
100
|
-
# The company name of the customer/buyer
|
|
109
|
+
# Body param: The company name of the customer/buyer
|
|
101
110
|
customer_name: nil,
|
|
102
|
-
# Customer tax ID. For Belgium this is the VAT number. Must include
|
|
103
|
-
# prefix
|
|
111
|
+
# Body param: Customer tax ID. For Belgium this is the VAT number. Must include
|
|
112
|
+
# the country prefix
|
|
104
113
|
customer_tax_id: nil,
|
|
105
|
-
# The direction of the document: INBOUND (purchases) or OUTBOUND
|
|
114
|
+
# Body param: The direction of the document: INBOUND (purchases) or OUTBOUND
|
|
115
|
+
# (sales)
|
|
106
116
|
direction: nil,
|
|
107
|
-
# The type of document: INVOICE, CREDIT_NOTE, or DEBIT_NOTE
|
|
117
|
+
# Body param: The type of document: INVOICE, CREDIT_NOTE, or DEBIT_NOTE
|
|
108
118
|
document_type: nil,
|
|
109
|
-
# The date when payment is due
|
|
119
|
+
# Body param: The date when payment is due
|
|
110
120
|
due_date: nil,
|
|
111
|
-
# The date when the invoice was issued
|
|
121
|
+
# Body param: The date when the invoice was issued
|
|
112
122
|
invoice_date: nil,
|
|
113
|
-
# The unique invoice identifier/number
|
|
123
|
+
# Body param: The unique invoice identifier/number
|
|
114
124
|
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
|
|
125
|
+
# Body param: The total amount of the invoice including tax (invoice_total =
|
|
126
|
+
# subtotal + total_tax + total_discount). Must be positive and rounded to maximum
|
|
127
|
+
# 2 decimals
|
|
117
128
|
invoice_total: nil,
|
|
118
|
-
# At least one line item is required
|
|
129
|
+
# Body param: At least one line item is required
|
|
119
130
|
items: nil,
|
|
120
|
-
# Additional notes or comments for the invoice
|
|
131
|
+
# Body param: Additional notes or comments for the invoice
|
|
121
132
|
note: nil,
|
|
133
|
+
# Body param
|
|
122
134
|
payment_details: nil,
|
|
123
|
-
# The payment terms (e.g., 'Net 30', 'Due on receipt', '2/10 Net 30')
|
|
135
|
+
# Body param: The payment terms (e.g., 'Net 30', 'Due on receipt', '2/10 Net 30')
|
|
124
136
|
payment_term: nil,
|
|
125
|
-
# The previous unpaid balance from prior invoices, if any. Must be
|
|
126
|
-
# rounded to maximum 2 decimals
|
|
137
|
+
# Body param: The previous unpaid balance from prior invoices, if any. Must be
|
|
138
|
+
# positive and rounded to maximum 2 decimals
|
|
127
139
|
previous_unpaid_balance: nil,
|
|
128
|
-
# The purchase order reference number
|
|
140
|
+
# Body param: The purchase order reference number
|
|
129
141
|
purchase_order: nil,
|
|
130
|
-
# The address where payment should be sent or remitted to
|
|
142
|
+
# Body param: The address where payment should be sent or remitted to
|
|
131
143
|
remittance_address: nil,
|
|
132
|
-
# The recipient name at the remittance address
|
|
144
|
+
# Body param: The recipient name at the remittance address
|
|
133
145
|
remittance_address_recipient: nil,
|
|
134
|
-
# The address where services were performed or goods were delivered
|
|
146
|
+
# Body param: The address where services were performed or goods were delivered
|
|
135
147
|
service_address: nil,
|
|
136
|
-
# The recipient name at the service address
|
|
148
|
+
# Body param: The recipient name at the service address
|
|
137
149
|
service_address_recipient: nil,
|
|
138
|
-
# The end date of the service period or delivery period
|
|
150
|
+
# Body param: The end date of the service period or delivery period
|
|
139
151
|
service_end_date: nil,
|
|
140
|
-
# The start date of the service period or delivery period
|
|
152
|
+
# Body param: The start date of the service period or delivery period
|
|
141
153
|
service_start_date: nil,
|
|
142
|
-
# The shipping/delivery address
|
|
154
|
+
# Body param: The shipping/delivery address
|
|
143
155
|
shipping_address: nil,
|
|
144
|
-
# The recipient name at the shipping address
|
|
156
|
+
# Body param: The recipient name at the shipping address
|
|
145
157
|
shipping_address_recipient: nil,
|
|
146
|
-
# The current state of the document: DRAFT, TRANSIT, FAILED, SENT, or
|
|
158
|
+
# Body param: The current state of the document: DRAFT, TRANSIT, FAILED, SENT, or
|
|
159
|
+
# RECEIVED
|
|
147
160
|
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
|
|
161
|
+
# Body param: The taxable base of the invoice. Should be the sum of all line
|
|
162
|
+
# items - allowances (for example commercial discounts) + charges with impact on
|
|
163
|
+
# VAT. Must be positive and rounded to maximum 2 decimals
|
|
151
164
|
subtotal: nil,
|
|
152
|
-
# Tax category code of the invoice (e.g., S for standard rate, Z for
|
|
153
|
-
# for exempt)
|
|
165
|
+
# Body param: Tax category code of the invoice (e.g., S for standard rate, Z for
|
|
166
|
+
# zero rate, E for exempt)
|
|
154
167
|
tax_code: nil,
|
|
168
|
+
# Body param
|
|
155
169
|
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
|
|
170
|
+
# Body param: The net financial discount/charge of the invoice (non-VAT charges
|
|
171
|
+
# minus non-VAT allowances). Can be positive (net charge), negative (net
|
|
172
|
+
# discount), or zero. Must be rounded to maximum 2 decimals
|
|
159
173
|
total_discount: nil,
|
|
160
|
-
# The total tax amount of the invoice. Must be positive and rounded to
|
|
161
|
-
# decimals
|
|
174
|
+
# Body param: The total tax amount of the invoice. Must be positive and rounded to
|
|
175
|
+
# maximum 2 decimals
|
|
162
176
|
total_tax: nil,
|
|
163
|
-
# VATEX code list for VAT exemption reasons
|
|
177
|
+
# Body param: VATEX code list for VAT exemption reasons
|
|
164
178
|
#
|
|
165
179
|
# Agency: CEF Identifier: vatex
|
|
166
180
|
vatex: nil,
|
|
167
|
-
# Textual explanation for VAT exemption
|
|
181
|
+
# Body param: Textual explanation for VAT exemption
|
|
168
182
|
vatex_note: nil,
|
|
169
|
-
# The address of the vendor/seller
|
|
183
|
+
# Body param: The address of the vendor/seller
|
|
170
184
|
vendor_address: nil,
|
|
171
|
-
# The recipient name at the vendor address
|
|
185
|
+
# Body param: The recipient name at the vendor address
|
|
172
186
|
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.
|
|
187
|
+
# Body param: Vendor company ID. For Belgium this is the CBE number or their EUID
|
|
188
|
+
# (European Unique Identifier) number. In the Netherlands this is the KVK number.
|
|
175
189
|
vendor_company_id: nil,
|
|
176
|
-
# The email address of the vendor
|
|
190
|
+
# Body param: The email address of the vendor
|
|
177
191
|
vendor_email: nil,
|
|
178
|
-
# The name of the vendor/seller/supplier
|
|
192
|
+
# Body param: The name of the vendor/seller/supplier
|
|
179
193
|
vendor_name: nil,
|
|
180
|
-
# Vendor tax ID. For Belgium this is the VAT number. Must include the
|
|
181
|
-
# prefix
|
|
194
|
+
# Body param: Vendor tax ID. For Belgium this is the VAT number. Must include the
|
|
195
|
+
# country prefix
|
|
182
196
|
vendor_tax_id: nil,
|
|
183
197
|
request_options: {}
|
|
184
198
|
)
|
|
@@ -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
|
|
@@ -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]?,
|
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.21.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-09 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
name: cgi
|