factpulse 2.0.42 → 3.0.1

data/docs/GetStructureResponse.md

@@ -0,0 +1,34 @@
+# FactPulse::GetStructureResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **return_code** | **Integer** |  |  |
+| **message** | **String** |  |  |
+| **structure_id** | **Integer** |  | [optional] |
+| **structure_identifier** | **String** |  | [optional] |
+| **structure_label** | **String** |  | [optional] |
+| **company_name** | **String** |  | [optional] |
+| **vat_number** | **String** |  | [optional] |
+| **structure_email** | **String** |  | [optional] |
+| **parameters** | [**StructureParameters**](StructureParameters.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'factpulse'
+
+instance = FactPulse::GetStructureResponse.new(
+  return_code: null,
+  message: null,
+  structure_id: null,
+  structure_identifier: null,
+  structure_label: null,
+  company_name: null,
+  vat_number: null,
+  structure_email: null,
+  parameters: null
+)
+```
+

data/docs/GlobalAllowanceAmount.md

@@ -0,0 +1,15 @@
+# FactPulse::GlobalAllowanceAmount
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+
+## Example
+
+```ruby
+require 'factpulse'
+
+instance = FactPulse::GlobalAllowanceAmount.new()
+```
+

data/docs/{SantApi.md → HealthApi.md}

@@ -1,20 +1,20 @@
-# FactPulse::SantApi
+# FactPulse::HealthApi
 
 All URIs are relative to *http://localhost*
 
 | Method | HTTP request | Description |
 | ------ | ------------ | ----------- |
-| [**healthcheck_healthcheck_get**](SantApi.md#healthcheck_healthcheck_get) | **GET** /healthcheck | Endpoint de healthcheck pour Docker |
-| [**racine_get**](SantApi.md#racine_get) | **GET** / | Vérifier l'état de l'API |
+| [**healthcheck_healthcheck_get**](HealthApi.md#healthcheck_healthcheck_get) | **GET** /healthcheck | Docker healthcheck endpoint |
+| [**root_get**](HealthApi.md#root_get) | **GET** / | Check API status |
 
 
 ## healthcheck_healthcheck_get
 
 > Object healthcheck_healthcheck_get
 
-Endpoint de healthcheck pour Docker
+Docker healthcheck endpoint
 
-Endpoint de healthcheck pour Docker et les load balancers.  Utile pour : - Docker healthcheck - Kubernetes liveness/readiness probes - Load balancers (Nginx, HAProxy) - Monitoring de disponibilité - Déploiement zero downtime  Retourne un code 200 si l'API est opérationnelle.
+Healthcheck endpoint for Docker and load balancers.  Useful for: - Docker healthcheck - Kubernetes liveness/readiness probes - Load balancers (Nginx, HAProxy) - Availability monitoring - Zero downtime deployment  Returns a 200 code if the API is operational.
 
 ### Examples
 
@@ -22,14 +22,14 @@ Endpoint de healthcheck pour Docker et les load balancers.  Utile pour : - Docke
 require 'time'
 require 'factpulse'
 
-api_instance = FactPulse::SantApi.new
+api_instance = FactPulse::HealthApi.new
 
 begin
-  # Endpoint de healthcheck pour Docker
+  # Docker healthcheck endpoint
   result = api_instance.healthcheck_healthcheck_get
   p result
 rescue FactPulse::ApiError => e
-  puts "Error when calling SantApi->healthcheck_healthcheck_get: #{e}"
+  puts "Error when calling HealthApi->healthcheck_healthcheck_get: #{e}"
 end
 ```
 
@@ -41,13 +41,13 @@ This returns an Array which contains the response data, status code and headers.
 
 ```ruby
 begin
-  # Endpoint de healthcheck pour Docker
+  # Docker healthcheck endpoint
   data, status_code, headers = api_instance.healthcheck_healthcheck_get_with_http_info
   p status_code # => 2xx
   p headers # => { ... }
   p data # => Object
 rescue FactPulse::ApiError => e
-  puts "Error when calling SantApi->healthcheck_healthcheck_get_with_http_info: #{e}"
+  puts "Error when calling HealthApi->healthcheck_healthcheck_get_with_http_info: #{e}"
 end
 ```
 
@@ -69,13 +69,13 @@ No authorization required
 - **Accept**: application/json
 
 
-## racine_get
+## root_get
 
-> Object racine_get
+> Object root_get
 
-Vérifier l'état de l'API
+Check API status
 
-Endpoint de health check pour vérifier que l'API répond.  Utile pour : - Monitoring de disponibilité - Tests d'intégration - Load balancers
+Health check endpoint to verify the API is responding.  Useful for: - Availability monitoring - Integration tests - Load balancers
 
 ### Examples
 
@@ -83,32 +83,32 @@ Endpoint de health check pour vérifier que l'API répond.  Utile pour : - Monit
 require 'time'
 require 'factpulse'
 
-api_instance = FactPulse::SantApi.new
+api_instance = FactPulse::HealthApi.new
 
 begin
-  # Vérifier l'état de l'API
-  result = api_instance.racine_get
+  # Check API status
+  result = api_instance.root_get
   p result
 rescue FactPulse::ApiError => e
-  puts "Error when calling SantApi->racine_get: #{e}"
+  puts "Error when calling HealthApi->root_get: #{e}"
 end
 ```
 
-#### Using the racine_get_with_http_info variant
+#### Using the root_get_with_http_info variant
 
 This returns an Array which contains the response data, status code and headers.
 
-> <Array(Object, Integer, Hash)> racine_get_with_http_info
+> <Array(Object, Integer, Hash)> root_get_with_http_info
 
 ```ruby
 begin
-  # Vérifier l'état de l'API
-  data, status_code, headers = api_instance.racine_get_with_http_info
+  # Check API status
+  data, status_code, headers = api_instance.root_get_with_http_info
   p status_code # => 2xx
   p headers # => { ... }
   p data # => Object
 rescue FactPulse::ApiError => e
-  puts "Error when calling SantApi->racine_get_with_http_info: #{e}"
+  puts "Error when calling HealthApi->root_get_with_http_info: #{e}"
 end
 ```
 

data/docs/IncomingInvoice.md

@@ -0,0 +1,54 @@
+# FactPulse::IncomingInvoice
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **flow_id** | **String** |  | [optional] |
+| **source_format** | [**InvoiceFormat**](InvoiceFormat.md) | Invoice source format |  |
+| **supplier_reference** | **String** | Invoice number issued by the supplier (BT-1) |  |
+| **document_type** | [**DocumentType**](DocumentType.md) | Document type (BT-3) | [optional] |
+| **supplier** | [**IncomingSupplier**](IncomingSupplier.md) | Invoice issuer (SellerTradeParty) |  |
+| **billing_site_name** | **String** | Recipient name / your company (BT-44) |  |
+| **billing_site_siret** | **String** |  | [optional] |
+| **issue_date** | **String** | Invoice date (BT-2) - YYYY-MM-DD |  |
+| **due_date** | **String** |  | [optional] |
+| **currency** | **String** | ISO currency code (BT-5) | [optional][default to 'EUR'] |
+| **net_amount** | **String** | Total net amount (BT-109) |  |
+| **vat_amount** | **String** | Total VAT amount (BT-110) |  |
+| **gross_amount** | **String** | Total gross amount (BT-112) |  |
+| **purchase_order_number** | **String** |  | [optional] |
+| **contract_reference** | **String** |  | [optional] |
+| **invoice_subject** | **String** |  | [optional] |
+| **document_base64** | **String** |  | [optional] |
+| **document_content_type** | **String** |  | [optional] |
+| **document_filename** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'factpulse'
+
+instance = FactPulse::IncomingInvoice.new(
+  flow_id: null,
+  source_format: null,
+  supplier_reference: null,
+  document_type: null,
+  supplier: null,
+  billing_site_name: null,
+  billing_site_siret: null,
+  issue_date: null,
+  due_date: null,
+  currency: null,
+  net_amount: null,
+  vat_amount: null,
+  gross_amount: null,
+  purchase_order_number: null,
+  contract_reference: null,
+  invoice_subject: null,
+  document_base64: null,
+  document_content_type: null,
+  document_filename: null
+)
+```
+

data/docs/IncomingSupplier.md

@@ -0,0 +1,32 @@
+# FactPulse::IncomingSupplier
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | Supplier business name (BT-27) |  |
+| **siren** | **String** |  | [optional] |
+| **siret** | **String** |  | [optional] |
+| **vat_number** | **String** |  | [optional] |
+| **postal_address** | [**PostalAddress**](PostalAddress.md) |  | [optional] |
+| **electronic_address** | [**ElectronicAddress**](ElectronicAddress.md) |  | [optional] |
+| **email** | **String** |  | [optional] |
+| **phone** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'factpulse'
+
+instance = FactPulse::IncomingSupplier.new(
+  name: null,
+  siren: null,
+  siret: null,
+  vat_number: null,
+  postal_address: null,
+  electronic_address: null,
+  email: null,
+  phone: null
+)
+```
+

data/docs/{FormatFacture.md → InvoiceFormat.md}

@@ -1,4 +1,4 @@
-# FactPulse::FormatFacture
+# FactPulse::InvoiceFormat
 
 ## Properties
 
@@ -10,6 +10,6 @@
 ```ruby
 require 'factpulse'
 
-instance = FactPulse::FormatFacture.new()
+instance = FactPulse::InvoiceFormat.new()
 ```
 

data/docs/InvoiceLine.md

@@ -0,0 +1,46 @@
+# FactPulse::InvoiceLine
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **line_number** | **Integer** |  |  |
+| **reference** | **String** |  | [optional] |
+| **item_name** | **String** |  |  |
+| **quantity** | [**Quantity**](Quantity.md) |  |  |
+| **unit** | [**UnitOfMeasure**](UnitOfMeasure.md) |  |  |
+| **unit_net_price** | [**UnitNetPrice**](UnitNetPrice.md) |  |  |
+| **allowance_amount** | [**InvoiceLineAllowanceAmount**](InvoiceLineAllowanceAmount.md) |  | [optional] |
+| **line_net_amount** | [**LineNetAmount**](LineNetAmount.md) |  | [optional] |
+| **vat_rate** | **String** |  | [optional] |
+| **manual_vat_rate** | [**ManualVatRate**](ManualVatRate.md) |  | [optional] |
+| **vat_category** | [**VATCategory**](VATCategory.md) |  | [optional] |
+| **period_start_date** | **String** |  | [optional] |
+| **period_end_date** | **String** |  | [optional] |
+| **allowance_reason_code** | [**AllowanceReasonCode**](AllowanceReasonCode.md) |  | [optional] |
+| **allowance_reason** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'factpulse'
+
+instance = FactPulse::InvoiceLine.new(
+  line_number: null,
+  reference: null,
+  item_name: null,
+  quantity: null,
+  unit: null,
+  unit_net_price: null,
+  allowance_amount: null,
+  line_net_amount: null,
+  vat_rate: null,
+  manual_vat_rate: null,
+  vat_category: null,
+  period_start_date: null,
+  period_end_date: null,
+  allowance_reason_code: null,
+  allowance_reason: null
+)
+```
+

data/docs/InvoiceLineAllowanceAmount.md

@@ -0,0 +1,15 @@
+# FactPulse::InvoiceLineAllowanceAmount
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+
+## Example
+
+```ruby
+require 'factpulse'
+
+instance = FactPulse::InvoiceLineAllowanceAmount.new()
+```
+

data/docs/InvoiceNote.md

@@ -0,0 +1,20 @@
+# FactPulse::InvoiceNote
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **subject_code** | **String** |  | [optional] |
+| **content** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'factpulse'
+
+instance = FactPulse::InvoiceNote.new(
+  subject_code: null,
+  content: null
+)
+```
+