factpulse 4.4.0 → 4.5.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.
Files changed (63) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +8 -7
  3. data/Gemfile.lock +9 -9
  4. data/docs/Amount3.md +15 -0
  5. data/docs/ChorusProDestination.md +1 -1
  6. data/docs/ClientManagementApi.md +152 -0
  7. data/docs/CreateCDARRequest.md +5 -1
  8. data/docs/ElectronicSignatureApi.md +6 -6
  9. data/docs/EncaisseAmountByRate.md +20 -0
  10. data/docs/EncaisseeRequest.md +7 -3
  11. data/docs/FacturXConversionApi.md +2 -2
  12. data/docs/FacturXPDFXMLVerificationApi.md +4 -4
  13. data/docs/FacturXValidationApi.md +4 -4
  14. data/docs/FactureElectroniqueRestApiSchemasEreportingInvoiceTypeCode.md +15 -0
  15. data/docs/{ChorusProCredentials.md → FactureElectroniqueRestApiSchemasProcessingChorusProCredentials.md} +2 -2
  16. data/docs/{ValidationErrorResponse.md → FactureElectroniqueRestApiSchemasValidationValidationErrorResponse.md} +2 -2
  17. data/docs/Flux10EReportingApi.md +4 -4
  18. data/docs/Flux6InvoiceLifecycleCDARApi.md +8 -4
  19. data/docs/InvoiceGenerationApi.md +4 -4
  20. data/docs/InvoiceInput.md +1 -1
  21. data/docs/LifecycleResponse.md +9 -1
  22. data/docs/ParseApi.md +4 -4
  23. data/docs/PaymentAmountByRate.md +1 -1
  24. data/docs/SubmitCDARRequest.md +4 -0
  25. data/docs/SuperPDPVatRegimeResponse.md +20 -0
  26. data/docs/SuperPDPVatRegimeUpdateRequest.md +20 -0
  27. data/docs/ValidateCDARRequest.md +3 -1
  28. data/docs/ValidationApi.md +3 -3
  29. data/docs/ValidationError.md +5 -1
  30. data/lib/factpulse/api/client_management_api.rb +137 -0
  31. data/lib/factpulse/api/electronic_signature_api.rb +6 -6
  32. data/lib/factpulse/api/factur_x_conversion_api.rb +2 -2
  33. data/lib/factpulse/api/factur_x_validation_api.rb +4 -4
  34. data/lib/factpulse/api/factur_xpdfxml_verification_api.rb +4 -4
  35. data/lib/factpulse/api/flux10_e_reporting_api.rb +4 -4
  36. data/lib/factpulse/api/flux6_invoice_lifecycle_cdar_api.rb +10 -4
  37. data/lib/factpulse/api/invoice_generation_api.rb +2 -2
  38. data/lib/factpulse/api/parse_api.rb +4 -4
  39. data/lib/factpulse/api/validation_api.rb +4 -4
  40. data/lib/factpulse/models/amount1.rb +1 -1
  41. data/lib/factpulse/models/amount2.rb +1 -1
  42. data/lib/factpulse/models/amount3.rb +104 -0
  43. data/lib/factpulse/models/chorus_pro_destination.rb +1 -1
  44. data/lib/factpulse/models/create_cdar_request.rb +56 -4
  45. data/lib/factpulse/models/encaisse_amount_by_rate.rb +192 -0
  46. data/lib/factpulse/models/encaisseamount.rb +1 -1
  47. data/lib/factpulse/models/encaissee_request.rb +43 -24
  48. data/lib/factpulse/models/facture_electronique_rest_api_schemas_ereporting_invoice_type_code.rb +43 -0
  49. data/lib/factpulse/models/{chorus_pro_credentials.rb → facture_electronique_rest_api_schemas_processing_chorus_pro_credentials.rb} +3 -3
  50. data/lib/factpulse/models/{validation_error_response.rb → facture_electronique_rest_api_schemas_validation_validation_error_response.rb} +3 -3
  51. data/lib/factpulse/models/invoice_input.rb +1 -1
  52. data/lib/factpulse/models/invoice_type_code.rb +17 -6
  53. data/lib/factpulse/models/lifecycle_response.rb +48 -4
  54. data/lib/factpulse/models/payment_amount_by_rate.rb +1 -1
  55. data/lib/factpulse/models/payment_means.rb +2 -1
  56. data/lib/factpulse/models/submit_cdar_request.rb +53 -1
  57. data/lib/factpulse/models/super_pdp_vat_regime_response.rb +195 -0
  58. data/lib/factpulse/models/super_pdp_vat_regime_update_request.rb +200 -0
  59. data/lib/factpulse/models/validate_cdar_request.rb +17 -5
  60. data/lib/factpulse/models/validation_error.rb +23 -4
  61. data/lib/factpulse/version.rb +1 -1
  62. data/lib/factpulse.rb +7 -2
  63. metadata +16 -6
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 8e91a9cd95bd9eeaec05db8f0d6ab028416a8835117ac9f5c16e3e498d208276
4
- data.tar.gz: e3ad8680dda6a7e76353ef070a0824ae0b4e53131742379948049e86f3bfa18d
3
+ metadata.gz: 6c1b73a97cfccb385cb4d1183123f8fda8a4d7abe0c54b287fc39289cd6ae11b
4
+ data.tar.gz: 7534c7ee23444260115978a626c773ab8223236f002707d6b94f827a85b0c2c9
5
5
  SHA512:
6
- metadata.gz: 93c0eb9a212ca7e5565663bf39a936fdf6909b844c5255446564b04e383da470a0ec95e25e665f03c2a752acb7581dde4141aeed7a2106e4a0593ef7332fc955
7
- data.tar.gz: 9ff66f529cdac0512833a50d462145979cff82f58f627fbfd2c1baec9268b2ebe5d042c89b56fdb8516bdabf124fd3d8f7732f2e615ba035fe10bedb07aa801c
6
+ metadata.gz: 3288fb201dda2784f52dfd838418b97f885643fa6ffca281b129b3544eab19b708f17bc81207011570f594c3c5bf2a19e55cdfabb299bd3617a946b3a15633ba
7
+ data.tar.gz: 4a16be1037c6051f6e348765b41eba7244e41f2515a8219a8e900633b836f8909444136c52984c53196f2b7c86f733fbf0fa026fbdca19f538cc0a394db4c39d
data/CHANGELOG.md CHANGED
@@ -7,16 +7,17 @@ et ce projet adhère au [Semantic Versioning](https://semver.org/spec/v2.0.0.htm
7
7
 
8
8
  ## [Unreleased]
9
9
 
10
- ## [4.4.0] - 2026-10-10
10
+ ## [4.5.0] - 2026-11-21
11
11
 
12
12
  ### Added
13
- - Endpoint /cdar/lifecycle : paramètre flowDirection (In, Out, All ; défaut All) et champ flowDirection sur chaque événement
13
+ - /cdar/lifecycle : lecture de toutes les pages de statuts (réponse complète sur longue période), paramètres dateFrom / dateTo, champs totalFlows, truncated, dateFrom et dateTo dans la réponse
14
+ - Routes GET / PATCH /clients/{uid}/superpdp/vat-regime : consultation et mise à jour du régime de TVA SuperPDP
15
+ - CDAR encaissée multi-taux : amountsByRate sur /cdar/encaissee, encaisseAmountsByRate sur /cdar/generate, /cdar/submit et /cdar/validate, champ comment ; amount et invoiceBuyerElectronicAddress deviennent optionnels sur /cdar/encaissee
16
+ - PaymentMeans : valeur CARTE
14
17
 
15
18
  ### Fixed
16
- - Go : le chemin du module suit désormais la version majeure (github.com/factpulse/sdk-go/v4). Les versions v4.x n'étaient pas installables via /v3 : mettre à jour les imports de sdk-go/v3 vers sdk-go/v4
17
- - Ruby : FactPulse::Client.new accepte les arguments nommés (email:, password:, client_uid:) comme indiqué dans le README
18
- - CDAR : vatRate / encaisseVatRate typés en nombre (défaut 20)
19
+ - /cdar/lifecycle : erreurs 502 intermittentes sur les longues périodes (corrigé côté API)
19
20
 
20
21
 
21
- [Unreleased]: https://github.com/factpulse/sdk-ruby/compare/v4.4.0...HEAD
22
- [4.4.0]: https://github.com/factpulse/sdk-ruby/releases/tag/v4.4.0
22
+ [Unreleased]: https://github.com/factpulse/sdk-ruby/compare/v4.5.0...HEAD
23
+ [4.5.0]: https://github.com/factpulse/sdk-ruby/releases/tag/v4.5.0
data/Gemfile.lock CHANGED
@@ -1,7 +1,7 @@
1
1
  PATH
2
2
  remote: .
3
3
  specs:
4
- factpulse (4.4.0)
4
+ factpulse (4.5.0)
5
5
  typhoeus (~> 1.0, >= 1.0.1)
6
6
 
7
7
  GEM
@@ -12,7 +12,7 @@ GEM
12
12
  coderay (1.1.3)
13
13
  date (3.6.0)
14
14
  diff-lcs (1.6.2)
15
- ethon (0.18.0)
15
+ ethon (0.19.2)
16
16
  ffi (>= 1.15.0)
17
17
  logger
18
18
  ffi (1.17.4)
@@ -20,7 +20,7 @@ GEM
20
20
  logger (1.7.0)
21
21
  method_source (1.1.0)
22
22
  parallel (1.28.0)
23
- parser (3.3.12.0)
23
+ parser (3.3.14.0)
24
24
  ast (~> 2.4.1)
25
25
  racc
26
26
  pry (0.14.2)
@@ -39,15 +39,15 @@ GEM
39
39
  rspec-core (~> 3.13.0)
40
40
  rspec-expectations (~> 3.13.0)
41
41
  rspec-mocks (~> 3.13.0)
42
- rspec-core (3.13.6)
42
+ rspec-core (3.13.7)
43
43
  rspec-support (~> 3.13.0)
44
- rspec-expectations (3.13.5)
44
+ rspec-expectations (3.13.6)
45
45
  diff-lcs (>= 1.2.0, < 2.0)
46
46
  rspec-support (~> 3.13.0)
47
- rspec-mocks (3.13.8)
47
+ rspec-mocks (3.13.9)
48
48
  diff-lcs (>= 1.2.0, < 2.0)
49
49
  rspec-support (~> 3.13.0)
50
- rspec-support (3.13.7)
50
+ rspec-support (3.13.8)
51
51
  rubocop (0.66.0)
52
52
  jaro_winkler (~> 1.5.1)
53
53
  parallel (~> 1.10)
@@ -58,8 +58,8 @@ GEM
58
58
  unicode-display_width (>= 1.4.0, < 1.6)
59
59
  ruby-progressbar (1.13.0)
60
60
  stringio (3.2.0)
61
- typhoeus (1.6.0)
62
- ethon (>= 0.18.0)
61
+ typhoeus (1.8.0)
62
+ ethon (>= 0.19.2, < 0.20.0)
63
63
  unicode-display_width (1.5.0)
64
64
 
65
65
  PLATFORMS
data/docs/Amount3.md ADDED
@@ -0,0 +1,15 @@
1
+ # FactPulse::Amount3
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+
8
+ ## Example
9
+
10
+ ```ruby
11
+ require 'factpulse'
12
+
13
+ instance = FactPulse::Amount3.new()
14
+ ```
15
+
@@ -5,7 +5,7 @@
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **type** | **String** | | [optional][default to &#39;chorus_pro&#39;] |
8
- | **credentials** | [**ChorusProCredentials**](ChorusProCredentials.md) | | [optional] |
8
+ | **credentials** | [**FactureElectroniqueRestApiSchemasProcessingChorusProCredentials**](FactureElectroniqueRestApiSchemasProcessingChorusProCredentials.md) | | [optional] |
9
9
 
10
10
  ## Example
11
11
 
@@ -14,11 +14,13 @@ All URIs are relative to *https://factpulse.fr*
14
14
  | [**get_pdp_config_api_v1_clients_uid_pdp_config_get**](ClientManagementApi.md#get_pdp_config_api_v1_clients_uid_pdp_config_get) | **GET** /api/v1/clients/{uid}/pdp-config | Get client PDP configuration |
15
15
  | [**get_superpdp_connect_url_api_v1_clients_uid_superpdp_connect_url_post**](ClientManagementApi.md#get_superpdp_connect_url_api_v1_clients_uid_superpdp_connect_url_post) | **POST** /api/v1/clients/{uid}/superpdp/connect-url | Get SuperPDP connection URL |
16
16
  | [**get_superpdp_status_api_v1_clients_uid_superpdp_status_get**](ClientManagementApi.md#get_superpdp_status_api_v1_clients_uid_superpdp_status_get) | **GET** /api/v1/clients/{uid}/superpdp/status | Get SuperPDP connection status |
17
+ | [**get_superpdp_vat_regime_api_v1_clients_uid_superpdp_vat_regime_get**](ClientManagementApi.md#get_superpdp_vat_regime_api_v1_clients_uid_superpdp_vat_regime_get) | **GET** /api/v1/clients/{uid}/superpdp/vat-regime | Get the SuperPDP VAT regime |
17
18
  | [**get_webhook_secret_status_api_v1_clients_uid_webhook_secret_status_get**](ClientManagementApi.md#get_webhook_secret_status_api_v1_clients_uid_webhook_secret_status_get) | **GET** /api/v1/clients/{uid}/webhook-secret/status | Get webhook secret status |
18
19
  | [**list_clients_api_v1_clients_get**](ClientManagementApi.md#list_clients_api_v1_clients_get) | **GET** /api/v1/clients | List clients |
19
20
  | [**rotate_encryption_key_api_v1_clients_uid_rotate_encryption_key_post**](ClientManagementApi.md#rotate_encryption_key_api_v1_clients_uid_rotate_encryption_key_post) | **POST** /api/v1/clients/{uid}/rotate-encryption-key | Rotate client encryption key |
20
21
  | [**update_client_api_v1_clients_uid_patch**](ClientManagementApi.md#update_client_api_v1_clients_uid_patch) | **PATCH** /api/v1/clients/{uid} | Update a client |
21
22
  | [**update_pdp_config_api_v1_clients_uid_pdp_config_put**](ClientManagementApi.md#update_pdp_config_api_v1_clients_uid_pdp_config_put) | **PUT** /api/v1/clients/{uid}/pdp-config | Configure client PDP |
23
+ | [**update_superpdp_vat_regime_api_v1_clients_uid_superpdp_vat_regime_patch**](ClientManagementApi.md#update_superpdp_vat_regime_api_v1_clients_uid_superpdp_vat_regime_patch) | **PATCH** /api/v1/clients/{uid}/superpdp/vat-regime | Set the SuperPDP VAT regime |
22
24
 
23
25
 
24
26
  ## activate_client_api_v1_clients_uid_activer_post
@@ -767,6 +769,80 @@ end
767
769
  - **Accept**: application/json
768
770
 
769
771
 
772
+ ## get_superpdp_vat_regime_api_v1_clients_uid_superpdp_vat_regime_get
773
+
774
+ > <SuperPDPVatRegimeResponse> get_superpdp_vat_regime_api_v1_clients_uid_superpdp_vat_regime_get(uid)
775
+
776
+ Get the SuperPDP VAT regime
777
+
778
+ Read the VAT regime of the client's company at SuperPDP (`vatRegime` is null when not set). SuperPDP refuses e-reporting (\"The VAT regime needs to be setup at the company level\") until the VAT regime of the company is set: it defines the e-reporting transmission periods, and the Flux 10 file does not carry it. This setting is not part of the AFNOR API; FactPulse sets it with the client's SuperPDP connection. **Scope**: Client level (JWT with client_uid that must match {uid}) **Errors**: - `404 not_connected`: the client has not connected its SuperPDP account - `400 superpdp_error`: SuperPDP refused the request (`superpdp_status`, `message`) - `502`: SuperPDP unreachable, or the SuperPDP connection must be redone
779
+
780
+ ### Examples
781
+
782
+ ```ruby
783
+ require 'time'
784
+ require 'factpulse'
785
+ # setup authorization
786
+ FactPulse.configure do |config|
787
+ # Configure API key authorization: APIKeyHeader
788
+ config.api_key['X-API-Key'] = 'YOUR API KEY'
789
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
790
+ # config.api_key_prefix['X-API-Key'] = 'Bearer'
791
+
792
+ # Configure Bearer authorization: HTTPBearer
793
+ config.access_token = 'YOUR_BEARER_TOKEN'
794
+ end
795
+
796
+ api_instance = FactPulse::ClientManagementApi.new
797
+ uid = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | Client unique identifier (UUID)
798
+
799
+ begin
800
+ # Get the SuperPDP VAT regime
801
+ result = api_instance.get_superpdp_vat_regime_api_v1_clients_uid_superpdp_vat_regime_get(uid)
802
+ p result
803
+ rescue FactPulse::ApiError => e
804
+ puts "Error when calling ClientManagementApi->get_superpdp_vat_regime_api_v1_clients_uid_superpdp_vat_regime_get: #{e}"
805
+ end
806
+ ```
807
+
808
+ #### Using the get_superpdp_vat_regime_api_v1_clients_uid_superpdp_vat_regime_get_with_http_info variant
809
+
810
+ This returns an Array which contains the response data, status code and headers.
811
+
812
+ > <Array(<SuperPDPVatRegimeResponse>, Integer, Hash)> get_superpdp_vat_regime_api_v1_clients_uid_superpdp_vat_regime_get_with_http_info(uid)
813
+
814
+ ```ruby
815
+ begin
816
+ # Get the SuperPDP VAT regime
817
+ data, status_code, headers = api_instance.get_superpdp_vat_regime_api_v1_clients_uid_superpdp_vat_regime_get_with_http_info(uid)
818
+ p status_code # => 2xx
819
+ p headers # => { ... }
820
+ p data # => <SuperPDPVatRegimeResponse>
821
+ rescue FactPulse::ApiError => e
822
+ puts "Error when calling ClientManagementApi->get_superpdp_vat_regime_api_v1_clients_uid_superpdp_vat_regime_get_with_http_info: #{e}"
823
+ end
824
+ ```
825
+
826
+ ### Parameters
827
+
828
+ | Name | Type | Description | Notes |
829
+ | ---- | ---- | ----------- | ----- |
830
+ | **uid** | **String** | Client unique identifier (UUID) | |
831
+
832
+ ### Return type
833
+
834
+ [**SuperPDPVatRegimeResponse**](SuperPDPVatRegimeResponse.md)
835
+
836
+ ### Authorization
837
+
838
+ [APIKeyHeader](../README.md#APIKeyHeader), [HTTPBearer](../README.md#HTTPBearer)
839
+
840
+ ### HTTP request headers
841
+
842
+ - **Content-Type**: Not defined
843
+ - **Accept**: application/json
844
+
845
+
770
846
  ## get_webhook_secret_status_api_v1_clients_uid_webhook_secret_status_get
771
847
 
772
848
  > <WebhookSecretStatusResponse> get_webhook_secret_status_api_v1_clients_uid_webhook_secret_status_get(uid)
@@ -1150,3 +1226,79 @@ end
1150
1226
  - **Content-Type**: application/json
1151
1227
  - **Accept**: application/json
1152
1228
 
1229
+
1230
+ ## update_superpdp_vat_regime_api_v1_clients_uid_superpdp_vat_regime_patch
1231
+
1232
+ > <SuperPDPVatRegimeResponse> update_superpdp_vat_regime_api_v1_clients_uid_superpdp_vat_regime_patch(uid, super_pdp_vat_regime_update_request)
1233
+
1234
+ Set the SuperPDP VAT regime
1235
+
1236
+ Set the VAT regime of the client's company at SuperPDP. When `hasVatOnDebits` is omitted, its current value is kept. SuperPDP refuses e-reporting (\"The VAT regime needs to be setup at the company level\") until the VAT regime of the company is set: it defines the e-reporting transmission periods, and the Flux 10 file does not carry it. This setting is not part of the AFNOR API; FactPulse sets it with the client's SuperPDP connection. **Scope**: Client level (JWT with client_uid that must match {uid}) **Errors**: - `404 not_connected`: the client has not connected its SuperPDP account - `400 superpdp_error`: SuperPDP refused the request (`superpdp_status`, `message`) - `502`: SuperPDP unreachable, or the SuperPDP connection must be redone
1237
+
1238
+ ### Examples
1239
+
1240
+ ```ruby
1241
+ require 'time'
1242
+ require 'factpulse'
1243
+ # setup authorization
1244
+ FactPulse.configure do |config|
1245
+ # Configure API key authorization: APIKeyHeader
1246
+ config.api_key['X-API-Key'] = 'YOUR API KEY'
1247
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1248
+ # config.api_key_prefix['X-API-Key'] = 'Bearer'
1249
+
1250
+ # Configure Bearer authorization: HTTPBearer
1251
+ config.access_token = 'YOUR_BEARER_TOKEN'
1252
+ end
1253
+
1254
+ api_instance = FactPulse::ClientManagementApi.new
1255
+ uid = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | Client unique identifier (UUID)
1256
+ super_pdp_vat_regime_update_request = FactPulse::SuperPDPVatRegimeUpdateRequest.new({vat_regime: 'monthly'}) # SuperPDPVatRegimeUpdateRequest |
1257
+
1258
+ begin
1259
+ # Set the SuperPDP VAT regime
1260
+ result = api_instance.update_superpdp_vat_regime_api_v1_clients_uid_superpdp_vat_regime_patch(uid, super_pdp_vat_regime_update_request)
1261
+ p result
1262
+ rescue FactPulse::ApiError => e
1263
+ puts "Error when calling ClientManagementApi->update_superpdp_vat_regime_api_v1_clients_uid_superpdp_vat_regime_patch: #{e}"
1264
+ end
1265
+ ```
1266
+
1267
+ #### Using the update_superpdp_vat_regime_api_v1_clients_uid_superpdp_vat_regime_patch_with_http_info variant
1268
+
1269
+ This returns an Array which contains the response data, status code and headers.
1270
+
1271
+ > <Array(<SuperPDPVatRegimeResponse>, Integer, Hash)> update_superpdp_vat_regime_api_v1_clients_uid_superpdp_vat_regime_patch_with_http_info(uid, super_pdp_vat_regime_update_request)
1272
+
1273
+ ```ruby
1274
+ begin
1275
+ # Set the SuperPDP VAT regime
1276
+ data, status_code, headers = api_instance.update_superpdp_vat_regime_api_v1_clients_uid_superpdp_vat_regime_patch_with_http_info(uid, super_pdp_vat_regime_update_request)
1277
+ p status_code # => 2xx
1278
+ p headers # => { ... }
1279
+ p data # => <SuperPDPVatRegimeResponse>
1280
+ rescue FactPulse::ApiError => e
1281
+ puts "Error when calling ClientManagementApi->update_superpdp_vat_regime_api_v1_clients_uid_superpdp_vat_regime_patch_with_http_info: #{e}"
1282
+ end
1283
+ ```
1284
+
1285
+ ### Parameters
1286
+
1287
+ | Name | Type | Description | Notes |
1288
+ | ---- | ---- | ----------- | ----- |
1289
+ | **uid** | **String** | Client unique identifier (UUID) | |
1290
+ | **super_pdp_vat_regime_update_request** | [**SuperPDPVatRegimeUpdateRequest**](SuperPDPVatRegimeUpdateRequest.md) | | |
1291
+
1292
+ ### Return type
1293
+
1294
+ [**SuperPDPVatRegimeResponse**](SuperPDPVatRegimeResponse.md)
1295
+
1296
+ ### Authorization
1297
+
1298
+ [APIKeyHeader](../README.md#APIKeyHeader), [HTTPBearer](../README.md#HTTPBearer)
1299
+
1300
+ ### HTTP request headers
1301
+
1302
+ - **Content-Type**: application/json
1303
+ - **Accept**: application/json
1304
+
@@ -23,6 +23,8 @@
23
23
  | **action_code** | **String** | | [optional] |
24
24
  | **encaisse_amount** | [**Encaisseamount**](Encaisseamount.md) | | [optional] |
25
25
  | **encaisse_vat_rate** | **Float** | Taux de TVA du montant encaissé en % (MDT-224, requis par BR-FR-CDV-14 pour le statut 212 ; défaut 20) | [optional][default to 20] |
26
+ | **encaisse_amounts_by_rate** | [**Array&lt;EncaisseAmountByRate&gt;**](EncaisseAmountByRate.md) | | [optional] |
27
+ | **comment** | **String** | | [optional] |
26
28
 
27
29
  ## Example
28
30
 
@@ -48,7 +50,9 @@ instance = FactPulse::CreateCDARRequest.new(
48
50
  reason_text: null,
49
51
  action_code: null,
50
52
  encaisse_amount: null,
51
- encaisse_vat_rate: null
53
+ encaisse_vat_rate: null,
54
+ encaisse_amounts_by_rate: null,
55
+ comment: null
52
56
  )
53
57
  ```
54
58
 
@@ -109,7 +109,7 @@ FactPulse.configure do |config|
109
109
  end
110
110
 
111
111
  api_instance = FactPulse::ElectronicSignatureApi.new
112
- pdf_file = File.new('/path/to/some/file') # File | PDF file to sign (will be processed and returned signed in base64)
112
+ pdf_file = 'pdf_file_example' # String | PDF file to sign (will be processed and returned signed in base64)
113
113
  opts = {
114
114
  reason: 'reason_example', # String |
115
115
  location: 'location_example', # String |
@@ -150,7 +150,7 @@ end
150
150
 
151
151
  | Name | Type | Description | Notes |
152
152
  | ---- | ---- | ----------- | ----- |
153
- | **pdf_file** | **File** | PDF file to sign (will be processed and returned signed in base64) | |
153
+ | **pdf_file** | **String** | PDF file to sign (will be processed and returned signed in base64) | |
154
154
  | **reason** | **String** | | [optional] |
155
155
  | **location** | **String** | | [optional] |
156
156
  | **contact** | **String** | | [optional] |
@@ -197,7 +197,7 @@ FactPulse.configure do |config|
197
197
  end
198
198
 
199
199
  api_instance = FactPulse::ElectronicSignatureApi.new
200
- pdf_file = File.new('/path/to/some/file') # File | PDF file to sign (processed asynchronously)
200
+ pdf_file = 'pdf_file_example' # String | PDF file to sign (processed asynchronously)
201
201
  opts = {
202
202
  callback_url: 'callback_url_example', # String |
203
203
  webhook_mode: 'webhook_mode_example', # String | Webhook content delivery: 'inline' (base64 in payload) or 'download_url' (temporary URL, 1h TTL)
@@ -240,7 +240,7 @@ end
240
240
 
241
241
  | Name | Type | Description | Notes |
242
242
  | ---- | ---- | ----------- | ----- |
243
- | **pdf_file** | **File** | PDF file to sign (processed asynchronously) | |
243
+ | **pdf_file** | **String** | PDF file to sign (processed asynchronously) | |
244
244
  | **callback_url** | **String** | | [optional] |
245
245
  | **webhook_mode** | **String** | Webhook content delivery: &#39;inline&#39; (base64 in payload) or &#39;download_url&#39; (temporary URL, 1h TTL) | [optional][default to &#39;inline&#39;] |
246
246
  | **reason** | **String** | | [optional] |
@@ -289,7 +289,7 @@ FactPulse.configure do |config|
289
289
  end
290
290
 
291
291
  api_instance = FactPulse::ElectronicSignatureApi.new
292
- pdf_file = File.new('/path/to/some/file') # File | PDF file to validate (will be analyzed to detect and validate signatures)
292
+ pdf_file = 'pdf_file_example' # String | PDF file to validate (will be analyzed to detect and validate signatures)
293
293
 
294
294
  begin
295
295
  # Validate electronic signatures of a PDF
@@ -322,7 +322,7 @@ end
322
322
 
323
323
  | Name | Type | Description | Notes |
324
324
  | ---- | ---- | ----------- | ----- |
325
- | **pdf_file** | **File** | PDF file to validate (will be analyzed to detect and validate signatures) | |
325
+ | **pdf_file** | **String** | PDF file to validate (will be analyzed to detect and validate signatures) | |
326
326
 
327
327
  ### Return type
328
328
 
@@ -0,0 +1,20 @@
1
+ # FactPulse::EncaisseAmountByRate
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **rate** | **Float** | Taux de TVA applicable au montant encaissé, en % (MDT-224) | |
8
+ | **amount** | [**Amount1**](Amount1.md) | | |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'factpulse'
14
+
15
+ instance = FactPulse::EncaisseAmountByRate.new(
16
+ rate: 20,
17
+ amount: null
18
+ )
19
+ ```
20
+
@@ -7,9 +7,11 @@
7
7
  | **invoice_id** | **String** | Identifiant de la facture (BT-1) | |
8
8
  | **invoice_issue_date** | **Date** | Date d&#39;émission de la facture (YYYY-MM-DD) | |
9
9
  | **invoice_buyer_siren** | **String** | SIREN de l&#39;acheteur (destinataire du statut) | |
10
- | **invoice_buyer_electronic_address** | **String** | Adresse électronique de l&#39;acheteur (MDT-73) | |
11
- | **amount** | [**Amount1**](Amount1.md) | | |
12
- | **vat_rate** | **Float** | Taux de TVA du montant encaissé en % (MDT-224, requis par BR-FR-CDV-14 ; défaut 20) | [optional][default to 20] |
10
+ | **invoice_buyer_electronic_address** | **String** | | [optional] |
11
+ | **amount** | [**Amount2**](Amount2.md) | | [optional] |
12
+ | **vat_rate** | **Float** | Taux de TVA du montant encaissé en % (MDT-224, requis par BR-FR-CDV-14 ; défaut 20). Ignoré avec amountsByRate | [optional][default to 20] |
13
+ | **amounts_by_rate** | [**Array&lt;EncaisseAmountByRate&gt;**](EncaisseAmountByRate.md) | | [optional] |
14
+ | **comment** | **String** | | [optional] |
13
15
  | **currency** | **String** | Code devise ISO 4217 | [optional][default to &#39;EUR&#39;] |
14
16
  | **sender_siren** | **String** | | [optional] |
15
17
  | **flow_type** | **String** | Type de flux (CustomerInvoiceLC pour facture émise) | [optional][default to &#39;CustomerInvoiceLC&#39;] |
@@ -30,6 +32,8 @@ instance = FactPulse::EncaisseeRequest.new(
30
32
  invoice_buyer_electronic_address: null,
31
33
  amount: null,
32
34
  vat_rate: null,
35
+ amounts_by_rate: null,
36
+ comment: null,
33
37
  currency: null,
34
38
  sender_siren: null,
35
39
  flow_type: null,
@@ -37,7 +37,7 @@ FactPulse.configure do |config|
37
37
  end
38
38
 
39
39
  api_instance = FactPulse::FacturXConversionApi.new
40
- file = File.new('/path/to/some/file') # File | Document to convert (PDF, DOCX, XLSX, JPG, PNG)
40
+ file = 'file_example' # String | Document to convert (PDF, DOCX, XLSX, JPG, PNG)
41
41
  opts = {
42
42
  output: 'output_example', # String | Output format: pdf, xml, both
43
43
  callback_url: 'callback_url_example', # String |
@@ -75,7 +75,7 @@ end
75
75
 
76
76
  | Name | Type | Description | Notes |
77
77
  | ---- | ---- | ----------- | ----- |
78
- | **file** | **File** | Document to convert (PDF, DOCX, XLSX, JPG, PNG) | |
78
+ | **file** | **String** | Document to convert (PDF, DOCX, XLSX, JPG, PNG) | |
79
79
  | **output** | **String** | Output format: pdf, xml, both | [optional][default to &#39;pdf&#39;] |
80
80
  | **callback_url** | **String** | | [optional] |
81
81
  | **webhook_mode** | **String** | Content delivery mode: &#39;inline&#39; (base64 in webhook) or &#39;download_url&#39; (temporary URL, 1h TTL) | [optional][default to &#39;inline&#39;] |
@@ -183,7 +183,7 @@ FactPulse.configure do |config|
183
183
  end
184
184
 
185
185
  api_instance = FactPulse::FacturXPDFXMLVerificationApi.new
186
- pdf_file = File.new('/path/to/some/file') # File | Factur-X PDF file to verify
186
+ pdf_file = 'pdf_file_example' # String | Factur-X PDF file to verify
187
187
  opts = {
188
188
  force_ocr: true, # Boolean | Force OCR usage even if PDF contains native text
189
189
  callback_url: 'callback_url_example', # String |
@@ -221,7 +221,7 @@ end
221
221
 
222
222
  | Name | Type | Description | Notes |
223
223
  | ---- | ---- | ----------- | ----- |
224
- | **pdf_file** | **File** | Factur-X PDF file to verify | |
224
+ | **pdf_file** | **String** | Factur-X PDF file to verify | |
225
225
  | **force_ocr** | **Boolean** | Force OCR usage even if PDF contains native text | [optional][default to false] |
226
226
  | **callback_url** | **String** | | [optional] |
227
227
  | **webhook_mode** | **String** | Webhook content delivery: &#39;inline&#39; (base64 in payload) or &#39;download_url&#39; (temporary URL, 1h TTL) | [optional][default to &#39;inline&#39;] |
@@ -265,7 +265,7 @@ FactPulse.configure do |config|
265
265
  end
266
266
 
267
267
  api_instance = FactPulse::FacturXPDFXMLVerificationApi.new
268
- pdf_file = File.new('/path/to/some/file') # File | Factur-X PDF file to verify
268
+ pdf_file = 'pdf_file_example' # String | Factur-X PDF file to verify
269
269
 
270
270
  begin
271
271
  # Verify PDF/XML Factur-X compliance (synchronous)
@@ -298,7 +298,7 @@ end
298
298
 
299
299
  | Name | Type | Description | Notes |
300
300
  | ---- | ---- | ----------- | ----- |
301
- | **pdf_file** | **File** | Factur-X PDF file to verify | |
301
+ | **pdf_file** | **String** | Factur-X PDF file to verify | |
302
302
 
303
303
  ### Return type
304
304
 
@@ -33,7 +33,7 @@ FactPulse.configure do |config|
33
33
  end
34
34
 
35
35
  api_instance = FactPulse::FacturXValidationApi.new
36
- pdf_file = File.new('/path/to/some/file') # File | Factur-X PDF file to validate (.pdf format).
36
+ pdf_file = 'pdf_file_example' # String | Factur-X PDF file to validate (.pdf format).
37
37
  opts = {
38
38
  profile: FactPulse::APIProfile::MINIMUM, # APIProfile |
39
39
  use_verapdf: true, # Boolean | Enable strict PDF/A validation with VeraPDF (recommended for production). If False, uses basic metadata validation.
@@ -71,7 +71,7 @@ end
71
71
 
72
72
  | Name | Type | Description | Notes |
73
73
  | ---- | ---- | ----------- | ----- |
74
- | **pdf_file** | **File** | Factur-X PDF file to validate (.pdf format). | |
74
+ | **pdf_file** | **String** | Factur-X PDF file to validate (.pdf format). | |
75
75
  | **profile** | [**APIProfile**](APIProfile.md) | | [optional] |
76
76
  | **use_verapdf** | **Boolean** | Enable strict PDF/A validation with VeraPDF (recommended for production). If False, uses basic metadata validation. | [optional][default to false] |
77
77
  | **skip_br_fr** | **Boolean** | | [optional] |
@@ -115,7 +115,7 @@ FactPulse.configure do |config|
115
115
  end
116
116
 
117
117
  api_instance = FactPulse::FacturXValidationApi.new
118
- pdf_file = File.new('/path/to/some/file') # File | Factur-X PDF file to validate (.pdf format).
118
+ pdf_file = 'pdf_file_example' # String | Factur-X PDF file to validate (.pdf format).
119
119
  opts = {
120
120
  profile: FactPulse::APIProfile::MINIMUM, # APIProfile |
121
121
  use_verapdf: true, # Boolean | Enable strict PDF/A validation with VeraPDF (recommended for production). May take several seconds.
@@ -154,7 +154,7 @@ end
154
154
 
155
155
  | Name | Type | Description | Notes |
156
156
  | ---- | ---- | ----------- | ----- |
157
- | **pdf_file** | **File** | Factur-X PDF file to validate (.pdf format). | |
157
+ | **pdf_file** | **String** | Factur-X PDF file to validate (.pdf format). | |
158
158
  | **profile** | [**APIProfile**](APIProfile.md) | | [optional] |
159
159
  | **use_verapdf** | **Boolean** | Enable strict PDF/A validation with VeraPDF (recommended for production). May take several seconds. | [optional][default to false] |
160
160
  | **callback_url** | **String** | | [optional] |
@@ -0,0 +1,15 @@
1
+ # FactPulse::FactureElectroniqueRestApiSchemasEreportingInvoiceTypeCode
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+
8
+ ## Example
9
+
10
+ ```ruby
11
+ require 'factpulse'
12
+
13
+ instance = FactPulse::FactureElectroniqueRestApiSchemasEreportingInvoiceTypeCode.new()
14
+ ```
15
+
@@ -1,4 +1,4 @@
1
- # FactPulse::ChorusProCredentials
1
+ # FactPulse::FactureElectroniqueRestApiSchemasProcessingChorusProCredentials
2
2
 
3
3
  ## Properties
4
4
 
@@ -15,7 +15,7 @@
15
15
  ```ruby
16
16
  require 'factpulse'
17
17
 
18
- instance = FactPulse::ChorusProCredentials.new(
18
+ instance = FactPulse::FactureElectroniqueRestApiSchemasProcessingChorusProCredentials.new(
19
19
  piste_client_id: null,
20
20
  piste_client_secret: null,
21
21
  chorus_login: null,
@@ -1,4 +1,4 @@
1
- # FactPulse::ValidationErrorResponse
1
+ # FactPulse::FactureElectroniqueRestApiSchemasValidationValidationErrorResponse
2
2
 
3
3
  ## Properties
4
4
 
@@ -11,7 +11,7 @@
11
11
  ```ruby
12
12
  require 'factpulse'
13
13
 
14
- instance = FactPulse::ValidationErrorResponse.new(
14
+ instance = FactPulse::FactureElectroniqueRestApiSchemasValidationValidationErrorResponse.new(
15
15
  detail: null
16
16
  )
17
17
  ```
@@ -530,7 +530,7 @@ FactPulse.configure do |config|
530
530
  end
531
531
 
532
532
  api_instance = FactPulse::Flux10EReportingApi.new
533
- xml_file = File.new('/path/to/some/file') # File | E-reporting XML file
533
+ xml_file = 'xml_file_example' # String | E-reporting XML file
534
534
  opts = {
535
535
  organization_id: 'organization_id_example', # String | Organization ID relayed to the PDP (AFNOR XP Z12-013 delegation / multi-tenancy). Required by some PDPs to select the client space.
536
536
  tracking_id: 'tracking_id_example', # String |
@@ -572,7 +572,7 @@ end
572
572
 
573
573
  | Name | Type | Description | Notes |
574
574
  | ---- | ---- | ----------- | ----- |
575
- | **xml_file** | **File** | E-reporting XML file | |
575
+ | **xml_file** | **String** | E-reporting XML file | |
576
576
  | **organization_id** | **String** | Organization ID relayed to the PDP (AFNOR XP Z12-013 delegation / multi-tenancy). Required by some PDPs to select the client space. | [optional] |
577
577
  | **tracking_id** | **String** | | [optional] |
578
578
  | **skip_validation** | **Boolean** | Skip XSD validation | [optional][default to false] |
@@ -768,7 +768,7 @@ FactPulse.configure do |config|
768
768
  end
769
769
 
770
770
  api_instance = FactPulse::Flux10EReportingApi.new
771
- xml_file = File.new('/path/to/some/file') # File | E-reporting XML file to validate
771
+ xml_file = 'xml_file_example' # String | E-reporting XML file to validate
772
772
  opts = {
773
773
  validate_coherence: true, # Boolean | Validate data coherence (REJ_COH)
774
774
  validate_period: true # Boolean | Validate period coherence (REJ_PER)
@@ -805,7 +805,7 @@ end
805
805
 
806
806
  | Name | Type | Description | Notes |
807
807
  | ---- | ---- | ----------- | ----- |
808
- | **xml_file** | **File** | E-reporting XML file to validate | |
808
+ | **xml_file** | **String** | E-reporting XML file to validate | |
809
809
  | **validate_coherence** | **Boolean** | Validate data coherence (REJ_COH) | [optional][default to true] |
810
810
  | **validate_period** | **Boolean** | Validate period coherence (REJ_PER) | [optional][default to true] |
811
811
 
@@ -158,7 +158,7 @@ No authorization required
158
158
 
159
159
  [Simplified] Get lifecycle events for invoices
160
160
 
161
- Returns lifecycle events (CDAR) grouped by invoice reference. **How it works (AFNOR XP Z12-013 compliant):** 1. Searches lifecycle flows on the PDP by flowType + flowDirection + date range 2. Downloads and parses each CDAR XML to extract the invoice reference 3. Groups events by invoice, sorted chronologically **Parameters:** - `days`: Number of days to look back (default: 7) - `invoiceId`: Optional filter on a specific invoice reference - `flowDirection`: `All` (default), `In` (statuses received from the counterparty) or `Out` (statuses issued by you or your PA, e.g. 202/203) **Authentication:** JWT Bearer (recommended) or PDP credentials as query parameters.
161
+ Returns lifecycle events (CDAR) grouped by invoice reference. **How it works (AFNOR XP Z12-013 compliant):** 1. Searches lifecycle flows on the PDP by flowType + flowDirection + date range, following the cursor pagination (all pages are read) 2. Downloads and parses each CDAR XML to extract the invoice reference 3. Groups events by invoice, sorted chronologically **Parameters:** - `days`: Number of days to look back (default: 7). Ignored when `dateFrom` is set. - `dateFrom` / `dateTo`: Explicit time window (ISO 8601, UTC if no offset). `dateTo` defaults to now. - `invoiceId`: Optional filter on a specific invoice reference. The filter is applied after reading the window: prefer one call per synchronisation over one call per invoice. **Limits:** at most 1000 status flows are read per call. When the limit is reached, `truncated` is `true` and the response is incomplete: split the window with `dateFrom` / `dateTo`. For incremental synchronisation, request the period since your last successful sync (plus a small margin). - `flowDirection`: `All` (default), `In` (statuses received from the counterparty) or `Out` (statuses issued by you or your PA, e.g. 202/203) **Authentication:** JWT Bearer (recommended) or PDP credentials as query parameters.
162
162
 
163
163
  ### Examples
164
164
 
@@ -174,6 +174,8 @@ end
174
174
  api_instance = FactPulse::Flux6InvoiceLifecycleCDARApi.new
175
175
  opts = {
176
176
  days: 56, # Integer | Number of days to look back
177
+ date_from: Time.parse('2013-10-20T19:20:30+01:00'), # Time | Window start (ISO 8601, UTC if no offset). Overrides days.
178
+ date_to: Time.parse('2013-10-20T19:20:30+01:00'), # Time | Window end (ISO 8601, UTC if no offset). Default: now
177
179
  invoice_id: 'invoice_id_example', # String | Filter by invoice reference
178
180
  flow_direction: 'In', # String | All (default), In (received statuses) or Out (issued statuses)
179
181
  pdp_flow_service_url: 'pdp_flow_service_url_example', # String | PDP Flow Service URL
@@ -215,6 +217,8 @@ end
215
217
  | Name | Type | Description | Notes |
216
218
  | ---- | ---- | ----------- | ----- |
217
219
  | **days** | **Integer** | Number of days to look back | [optional][default to 7] |
220
+ | **date_from** | **Time** | Window start (ISO 8601, UTC if no offset). Overrides days. | [optional] |
221
+ | **date_to** | **Time** | Window end (ISO 8601, UTC if no offset). Default: now | [optional] |
218
222
  | **invoice_id** | **String** | Filter by invoice reference | [optional] |
219
223
  | **flow_direction** | **String** | All (default), In (received statuses) or Out (issued statuses) | [optional][default to &#39;All&#39;] |
220
224
  | **pdp_flow_service_url** | **String** | PDP Flow Service URL | [optional] |
@@ -525,7 +529,7 @@ FactPulse.configure do |config|
525
529
  end
526
530
 
527
531
  api_instance = FactPulse::Flux6InvoiceLifecycleCDARApi.new
528
- encaissee_request = FactPulse::EncaisseeRequest.new({invoice_id: 'invoice_id_example', invoice_issue_date: Date.today, invoice_buyer_siren: 'invoice_buyer_siren_example', invoice_buyer_electronic_address: 'invoice_buyer_electronic_address_example', amount: FactPulse::Amount1.new}) # EncaisseeRequest |
532
+ encaissee_request = FactPulse::EncaisseeRequest.new({invoice_id: 'invoice_id_example', invoice_issue_date: Date.today, invoice_buyer_siren: 'invoice_buyer_siren_example'}) # EncaisseeRequest |
529
533
  opts = {
530
534
  organization_id: 'organization_id_example' # String | Organization ID relayed to the PDP (AFNOR XP Z12-013 delegation / multi-tenancy). Required by some PDPs to select the client space.
531
535
  }
@@ -750,7 +754,7 @@ FactPulse.configure do |config|
750
754
  end
751
755
 
752
756
  api_instance = FactPulse::Flux6InvoiceLifecycleCDARApi.new
753
- xml_file = File.new('/path/to/some/file') # File | CDAR XML file to validate
757
+ xml_file = 'xml_file_example' # String | CDAR XML file to validate
754
758
 
755
759
  begin
756
760
  # Validate CDAR XML against XSD and Schematron BR-FR-CDV
@@ -783,7 +787,7 @@ end
783
787
 
784
788
  | Name | Type | Description | Notes |
785
789
  | ---- | ---- | ----------- | ----- |
786
- | **xml_file** | **File** | CDAR XML file to validate | |
790
+ | **xml_file** | **String** | CDAR XML file to validate | |
787
791
 
788
792
  ### Return type
789
793