@factpulse/sdk 3.0.9 → 3.0.13

package/docs/FactureElectroniqueModelsInvoiceTypeCode.md

@@ -0,0 +1,39 @@
+# FactureElectroniqueModelsInvoiceTypeCode
+
+Document type according to BR-FR-04 (UNTDID 1001 codes).  | Code | Name | Description | |------|------|-------------| | 380 | INVOICE | Commercial invoice | | 389 | SELF_BILLED_INVOICE | Self-billed invoice | | 393 | FACTORED_INVOICE | Factored invoice | | 501 | SELF_BILLED_FACTORED_INVOICE | Self-billed factored invoice | | 386 | PREPAYMENT_INVOICE | Prepayment invoice | | 500 | SELF_BILLED_PREPAYMENT_INVOICE | Self-billed prepayment invoice | | 384 | CORRECTIVE_INVOICE | Corrective invoice | | 471 | SELF_BILLED_CORRECTIVE_INVOICE | Self-billed corrective invoice | | 472 | FACTORED_CORRECTIVE_INVOICE | Factored corrective invoice | | 473 | SELF_BILLED_FACTORED_CORRECTIVE_INVOICE | Self-billed factored corrective invoice | | 381 | CREDIT_NOTE | Credit note | | 261 | SELF_BILLED_CREDIT_NOTE | Self-billed credit note | | 262 | GLOBAL_ALLOWANCE_CREDIT_NOTE | Credit note for global allowance | | 396 | FACTORED_CREDIT_NOTE | Factored credit note | | 502 | SELF_BILLED_FACTORED_CREDIT_NOTE | Self-billed factored credit note | | 503 | PREPAYMENT_CREDIT_NOTE | Credit note for prepayment invoice |
+
+## Enum
+
+* `INVOICE` (value: `'380'`)
+
+* `SELF_BILLED_INVOICE` (value: `'389'`)
+
+* `FACTORED_INVOICE` (value: `'393'`)
+
+* `SELF_BILLED_FACTORED_INVOICE` (value: `'501'`)
+
+* `PREPAYMENT_INVOICE` (value: `'386'`)
+
+* `SELF_BILLED_PREPAYMENT_INVOICE` (value: `'500'`)
+
+* `CORRECTIVE_INVOICE` (value: `'384'`)
+
+* `SELF_BILLED_CORRECTIVE_INVOICE` (value: `'471'`)
+
+* `FACTORED_CORRECTIVE_INVOICE` (value: `'472'`)
+
+* `SELF_BILLED_FACTORED_CORRECTIVE_INVOICE` (value: `'473'`)
+
+* `CREDIT_NOTE` (value: `'381'`)
+
+* `SELF_BILLED_CREDIT_NOTE` (value: `'261'`)
+
+* `GLOBAL_ALLOWANCE_CREDIT_NOTE` (value: `'262'`)
+
+* `FACTORED_CREDIT_NOTE` (value: `'396'`)
+
+* `SELF_BILLED_FACTORED_CREDIT_NOTE` (value: `'502'`)
+
+* `PREPAYMENT_CREDIT_NOTE` (value: `'503'`)
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/FactureElectroniqueRestApiSchemasConvertValidationError.md

@@ -0,0 +1,35 @@
+# FactureElectroniqueRestApiSchemasConvertValidationError
+
+Erreur de validation Schematron avec suggestion de correction.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**rule** | **string** | Code de la regle (BR-XX, BR-FR-XX) | [default to undefined]
+**bt_code** | **string** |  | [optional] [default to undefined]
+**severity** | **string** | Gravite: error, warning | [default to undefined]
+**message** | **string** | Message d\'erreur | [default to undefined]
+**suggested_value** | **string** |  | [optional] [default to undefined]
+**suggested_field** | **string** |  | [optional] [default to undefined]
+**explanation** | **string** |  | [optional] [default to undefined]
+**confidence** | **number** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { FactureElectroniqueRestApiSchemasConvertValidationError } from '@factpulse/sdk';
+
+const instance: FactureElectroniqueRestApiSchemasConvertValidationError = {
+    rule,
+    bt_code,
+    severity,
+    message,
+    suggested_value,
+    suggested_field,
+    explanation,
+    confidence,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/FlowSummary.md

@@ -6,9 +6,9 @@ Summary of a flow in search results.
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**flow_id** | **string** |  | [default to undefined]
+**flow_id** | **string** | Unique flow identifier | [default to undefined]
 **tracking_id** | **string** |  | [optional] [default to undefined]
-**name** | **string** |  | [default to undefined]
+**name** | **string** | Flow name | [default to undefined]
 **flow_type** | **string** |  | [optional] [default to undefined]
 **flow_direction** | **string** |  | [optional] [default to undefined]
 **acknowledgment_status** | **string** |  | [optional] [default to undefined]

package/docs/FlowType.md

@@ -1,6 +1,6 @@
 # FlowType
 
-Invoice flow types.
+AFNOR XP Z12-013 FlowType enum.  Values from swagger specification v1.1.0: - Invoice flows (factures) - Lifecycle flows (cycle de vie) - E-reporting flows (transactions/paiements)
 
 ## Enum
 
@@ -8,10 +8,26 @@ Invoice flow types.
 
 * `SupplierInvoice` (value: `'SupplierInvoice'`)
 
+* `StateInvoice` (value: `'StateInvoice'`)
+
 * `CustomerInvoiceLc` (value: `'CustomerInvoiceLC'`)
 
 * `SupplierInvoiceLc` (value: `'SupplierInvoiceLC'`)
 
-* `EReporting` (value: `'eReporting'`)
+* `StateCustomerInvoiceLc` (value: `'StateCustomerInvoiceLC'`)
+
+* `StateSupplierInvoiceLc` (value: `'StateSupplierInvoiceLC'`)
+
+* `UnitaryCustomerTransactionReport` (value: `'UnitaryCustomerTransactionReport'`)
+
+* `AggregatedCustomerTransactionReport` (value: `'AggregatedCustomerTransactionReport'`)
+
+* `UnitarySupplierTransactionReport` (value: `'UnitarySupplierTransactionReport'`)
+
+* `UnitaryCustomerPaymentReport` (value: `'UnitaryCustomerPaymentReport'`)
+
+* `AggregatedCustomerPaymentReport` (value: `'AggregatedCustomerPaymentReport'`)
+
+* `MultiFlowReport` (value: `'MultiFlowReport'`)
 
 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/GenerateAggregatedReportResponse.md

@@ -0,0 +1,33 @@
+# GenerateAggregatedReportResponse
+
+Response after generating an aggregated e-reporting XML.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**reportId** | **string** | Report identifier | [default to undefined]
+**transmissionType** | **string** | Transmission type (IN or RE) | [default to undefined]
+**flowType** | **string** | AFNOR FlowType determined from content | [default to undefined]
+**xml** | **string** | Generated XML content | [default to undefined]
+**xmlSize** | **number** | XML size in bytes | [default to undefined]
+**contentSummary** | **{ [key: string]: any; }** | Summary of content (counts by flux type) | [default to undefined]
+**message** | **string** | Status message | [default to undefined]
+
+## Example
+
+```typescript
+import { GenerateAggregatedReportResponse } from '@factpulse/sdk';
+
+const instance: GenerateAggregatedReportResponse = {
+    reportId,
+    transmissionType,
+    flowType,
+    xml,
+    xmlSize,
+    contentSummary,
+    message,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/GenerateEReportingResponse.md

@@ -0,0 +1,29 @@
+# GenerateEReportingResponse
+
+Response after generating e-reporting XML.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**reportId** | **string** | Report identifier | [default to undefined]
+**flowType** | **string** | Flux type | [default to undefined]
+**xml** | **string** | Generated XML content | [default to undefined]
+**xmlSize** | **number** | XML size in bytes | [default to undefined]
+**message** | **string** | Status message | [default to undefined]
+
+## Example
+
+```typescript
+import { GenerateEReportingResponse } from '@factpulse/sdk';
+
+const instance: GenerateEReportingResponse = {
+    reportId,
+    flowType,
+    xml,
+    xmlSize,
+    message,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/GetChorusProIdRequest.md

@@ -6,7 +6,7 @@ Get Chorus Pro ID from SIRET.
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**credentials** | [**FactureElectroniqueRestApiSchemasChorusProChorusProCredentials**](FactureElectroniqueRestApiSchemasChorusProChorusProCredentials.md) |  | [optional] [default to undefined]
+**credentials** | [**ChorusProCredentials**](ChorusProCredentials.md) |  | [optional] [default to undefined]
 **siret** | **string** | Structure SIRET (14 digits) | [default to undefined]
 **identifierType** | **string** | Identifier type (SIRET, SIREN, UE_HORS_FRANCE, etc.) | [optional] [default to 'SIRET']
 

package/docs/GetInvoiceRequest.md

@@ -6,7 +6,7 @@ Get an invoice.
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**credentials** | [**FactureElectroniqueRestApiSchemasChorusProChorusProCredentials**](FactureElectroniqueRestApiSchemasChorusProChorusProCredentials.md) |  | [optional] [default to undefined]
+**credentials** | [**ChorusProCredentials**](ChorusProCredentials.md) |  | [optional] [default to undefined]
 **chorusInvoiceId** | **number** | Chorus Pro invoice ID | [default to undefined]
 
 ## Example

package/docs/GetInvoiceResponse.md

@@ -6,8 +6,8 @@ Invoice details.
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**returnCode** | **number** |  | [default to undefined]
-**message** | **string** |  | [default to undefined]
+**returnCode** | **number** | Return code (0 = success) | [default to undefined]
+**message** | **string** | Response message | [default to undefined]
 **chorusInvoiceId** | **number** |  | [optional] [default to undefined]
 **invoiceNumber** | **string** |  | [optional] [default to undefined]
 **invoiceDate** | **string** |  | [optional] [default to undefined]

package/docs/GetStructureRequest.md

@@ -6,7 +6,7 @@ Get structure details.
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**credentials** | [**FactureElectroniqueRestApiSchemasChorusProChorusProCredentials**](FactureElectroniqueRestApiSchemasChorusProChorusProCredentials.md) |  | [optional] [default to undefined]
+**credentials** | [**ChorusProCredentials**](ChorusProCredentials.md) |  | [optional] [default to undefined]
 **structureId** | **number** | Chorus Pro structure ID | [default to undefined]
 **languageCode** | **string** | Language code (fr, en) | [optional] [default to 'fr']
 

package/docs/GetStructureResponse.md

@@ -6,8 +6,8 @@ Structure details.
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**returnCode** | **number** |  | [default to undefined]
-**message** | **string** |  | [default to undefined]
+**returnCode** | **number** | Return code (0 = success) | [default to undefined]
+**message** | **string** | Response message | [default to undefined]
 **structureId** | **number** |  | [optional] [default to undefined]
 **structureIdentifier** | **string** |  | [optional] [default to undefined]
 **structureLabel** | **string** |  | [optional] [default to undefined]

package/docs/HealthApi.md

@@ -1,6 +1,6 @@
 # HealthApi
 
-All URIs are relative to *http://localhost*
+All URIs are relative to *https://factpulse.fr*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|
@@ -48,6 +48,7 @@ No authorization required
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
 |**200** | API is healthy |  -  |
+|**500** | Internal server error |  -  |
 
 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
 
@@ -92,6 +93,7 @@ No authorization required
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
 |**200** | API is operational |  -  |
+|**500** | Internal server error |  -  |
 
 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
 

package/docs/IncomingInvoice.md

@@ -9,7 +9,7 @@ Name | Type | Description | Notes
 **flowId** | **string** |  | [optional] [default to undefined]
 **sourceFormat** | [**InvoiceFormat**](InvoiceFormat.md) | Invoice source format | [default to undefined]
 **supplierReference** | **string** | Invoice number issued by the supplier (BT-1) | [default to undefined]
-**documentType** | [**InvoiceTypeCode**](InvoiceTypeCode.md) | Document type (BT-3) | [optional] [default to undefined]
+**documentType** | [**InvoiceTypeCodeOutput**](InvoiceTypeCodeOutput.md) | Document type (BT-3) | [optional] [default to undefined]
 **supplier** | [**IncomingSupplier**](IncomingSupplier.md) | Invoice issuer (SellerTradeParty) | [default to undefined]
 **billingSiteName** | **string** | Recipient name / your company (BT-44) | [default to undefined]
 **billingSiteSiret** | **string** |  | [optional] [default to undefined]

package/docs/InvoiceInput.md

@@ -0,0 +1,51 @@
+# InvoiceInput
+
+Invoice for B2B international reporting (flux 10.1).  Used for unitary declaration of international B2B invoices.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**invoiceId** | **string** | Invoice identifier | [default to undefined]
+**issueDate** | **string** | Invoice issue date | [default to undefined]
+**typeCode** | [**InvoiceTypeCode**](InvoiceTypeCode.md) | Invoice type code | [optional] [default to undefined]
+**currency** | [**Currency**](Currency.md) |  | [optional] [default to undefined]
+**dueDate** | **string** |  | [optional] [default to undefined]
+**sellerSiren** | **string** | Seller SIREN/SIRET | [default to undefined]
+**sellerVatId** | **string** |  | [optional] [default to undefined]
+**sellerCountry** | [**Sellercountry**](Sellercountry.md) |  | [optional] [default to undefined]
+**buyerId** | **string** |  | [optional] [default to undefined]
+**buyerVatId** | **string** |  | [optional] [default to undefined]
+**buyerCountry** | [**Buyercountry**](Buyercountry.md) |  | [default to undefined]
+**taxExclusiveAmount** | [**Taxexclusiveamount1**](Taxexclusiveamount1.md) |  | [default to undefined]
+**taxAmount** | [**Taxamount1**](Taxamount1.md) |  | [default to undefined]
+**taxBreakdown** | [**Array<TaxBreakdownInput>**](TaxBreakdownInput.md) | VAT breakdown | [default to undefined]
+**referencedInvoiceId** | **string** |  | [optional] [default to undefined]
+**referencedInvoiceDate** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { InvoiceInput } from '@factpulse/sdk';
+
+const instance: InvoiceInput = {
+    invoiceId,
+    issueDate,
+    typeCode,
+    currency,
+    dueDate,
+    sellerSiren,
+    sellerVatId,
+    sellerCountry,
+    buyerId,
+    buyerVatId,
+    buyerCountry,
+    taxExclusiveAmount,
+    taxAmount,
+    taxBreakdown,
+    referencedInvoiceId,
+    referencedInvoiceDate,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/InvoiceLine.md

@@ -8,6 +8,8 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **line_number** | **number** | Invoice line identifier (BT-126). | [default to undefined]
 **line_note** | **string** |  | [optional] [default to undefined]
+**parent_line_id** | **string** |  | [optional] [default to undefined]
+**line_sub_type** | [**LineSubType**](LineSubType.md) |  | [optional] [default to undefined]
 **reference** | **string** |  | [optional] [default to undefined]
 **buyer_assigned_id** | **string** |  | [optional] [default to undefined]
 **product_global_id** | **string** |  | [optional] [default to undefined]
@@ -47,6 +49,8 @@ import { InvoiceLine } from '@factpulse/sdk';
 const instance: InvoiceLine = {
     line_number,
     line_note,
+    parent_line_id,
+    line_sub_type,
     reference,
     buyer_assigned_id,
     product_global_id,

package/docs/InvoiceNote.md

@@ -7,7 +7,7 @@ Invoice note (IncludedNote in Factur-X).  Mandatory notes for BR-FR-05 are: - PM
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **subject_code** | **string** |  | [optional] [default to undefined]
-**content** | **string** |  | [default to undefined]
+**content** | **string** | Note content | [default to undefined]
 
 ## Example
 

package/docs/InvoicePaymentInput.md

@@ -0,0 +1,29 @@
+# InvoicePaymentInput
+
+Payment linked to a specific invoice (flux 10.2).  Used for B2B international invoice payments.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**invoiceId** | **string** | Invoice identifier | [default to undefined]
+**invoiceDate** | **string** | Original invoice date | [default to undefined]
+**paymentDate** | **string** | Payment date | [default to undefined]
+**currency** | [**Currency**](Currency.md) |  | [optional] [default to undefined]
+**amountsByRate** | [**Array<PaymentAmountByRate>**](PaymentAmountByRate.md) | Payment amounts by VAT rate | [default to undefined]
+
+## Example
+
+```typescript
+import { InvoicePaymentInput } from '@factpulse/sdk';
+
+const instance: InvoicePaymentInput = {
+    invoiceId,
+    invoiceDate,
+    paymentDate,
+    currency,
+    amountsByRate,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)