@factpulse/sdk 3.0.9 → 3.0.13

package/docs/CountryCode.md

@@ -0,0 +1,347 @@
+# CountryCode
+
+ISO 3166-1 alpha-2 country codes.  Complete list of country codes used in e-reporting and invoicing. Includes all EU member states, major trading partners, and territories.
+
+## Enum
+
+* `At` (value: `'AT'`)
+
+* `Be` (value: `'BE'`)
+
+* `Bg` (value: `'BG'`)
+
+* `Hr` (value: `'HR'`)
+
+* `Cy` (value: `'CY'`)
+
+* `Cz` (value: `'CZ'`)
+
+* `Dk` (value: `'DK'`)
+
+* `Ee` (value: `'EE'`)
+
+* `Fi` (value: `'FI'`)
+
+* `Fr` (value: `'FR'`)
+
+* `De` (value: `'DE'`)
+
+* `Gr` (value: `'GR'`)
+
+* `Hu` (value: `'HU'`)
+
+* `Ie` (value: `'IE'`)
+
+* `It` (value: `'IT'`)
+
+* `Lv` (value: `'LV'`)
+
+* `Lt` (value: `'LT'`)
+
+* `Lu` (value: `'LU'`)
+
+* `Mt` (value: `'MT'`)
+
+* `Nl` (value: `'NL'`)
+
+* `Pl` (value: `'PL'`)
+
+* `Pt` (value: `'PT'`)
+
+* `Ro` (value: `'RO'`)
+
+* `Sk` (value: `'SK'`)
+
+* `Si` (value: `'SI'`)
+
+* `Es` (value: `'ES'`)
+
+* `Se` (value: `'SE'`)
+
+* `Is` (value: `'IS'`)
+
+* `Li` (value: `'LI'`)
+
+* `No` (value: `'NO'`)
+
+* `Ch` (value: `'CH'`)
+
+* `Gb` (value: `'GB'`)
+
+* `Ad` (value: `'AD'`)
+
+* `Mc` (value: `'MC'`)
+
+* `Sm` (value: `'SM'`)
+
+* `Va` (value: `'VA'`)
+
+* `Al` (value: `'AL'`)
+
+* `Ba` (value: `'BA'`)
+
+* `By` (value: `'BY'`)
+
+* `Md` (value: `'MD'`)
+
+* `Me` (value: `'ME'`)
+
+* `Mk` (value: `'MK'`)
+
+* `Rs` (value: `'RS'`)
+
+* `Ru` (value: `'RU'`)
+
+* `Ua` (value: `'UA'`)
+
+* `Xk` (value: `'XK'`)
+
+* `Tr` (value: `'TR'`)
+
+* `Gp` (value: `'GP'`)
+
+* `Mq` (value: `'MQ'`)
+
+* `Gf` (value: `'GF'`)
+
+* `Re` (value: `'RE'`)
+
+* `Yt` (value: `'YT'`)
+
+* `Pm` (value: `'PM'`)
+
+* `Bl` (value: `'BL'`)
+
+* `Mf` (value: `'MF'`)
+
+* `Wf` (value: `'WF'`)
+
+* `Pf` (value: `'PF'`)
+
+* `Nc` (value: `'NC'`)
+
+* `Tf` (value: `'TF'`)
+
+* `Us` (value: `'US'`)
+
+* `Ca` (value: `'CA'`)
+
+* `Mx` (value: `'MX'`)
+
+* `Br` (value: `'BR'`)
+
+* `Ar` (value: `'AR'`)
+
+* `Cl` (value: `'CL'`)
+
+* `Co` (value: `'CO'`)
+
+* `Pe` (value: `'PE'`)
+
+* `Ve` (value: `'VE'`)
+
+* `Ec` (value: `'EC'`)
+
+* `Bo` (value: `'BO'`)
+
+* `Py` (value: `'PY'`)
+
+* `Uy` (value: `'UY'`)
+
+* `Cr` (value: `'CR'`)
+
+* `Pa` (value: `'PA'`)
+
+* `Do` (value: `'DO'`)
+
+* `Cu` (value: `'CU'`)
+
+* `Pr` (value: `'PR'`)
+
+* `Jm` (value: `'JM'`)
+
+* `Ht` (value: `'HT'`)
+
+* `Tt` (value: `'TT'`)
+
+* `Cn` (value: `'CN'`)
+
+* `Jp` (value: `'JP'`)
+
+* `Kr` (value: `'KR'`)
+
+* `Kp` (value: `'KP'`)
+
+* `Tw` (value: `'TW'`)
+
+* `Hk` (value: `'HK'`)
+
+* `Mo` (value: `'MO'`)
+
+* `In` (value: `'IN'`)
+
+* `Pk` (value: `'PK'`)
+
+* `Bd` (value: `'BD'`)
+
+* `Lk` (value: `'LK'`)
+
+* `Np` (value: `'NP'`)
+
+* `Th` (value: `'TH'`)
+
+* `Vn` (value: `'VN'`)
+
+* `My` (value: `'MY'`)
+
+* `Sg` (value: `'SG'`)
+
+* `Id` (value: `'ID'`)
+
+* `Ph` (value: `'PH'`)
+
+* `Mm` (value: `'MM'`)
+
+* `Kh` (value: `'KH'`)
+
+* `La` (value: `'LA'`)
+
+* `Bn` (value: `'BN'`)
+
+* `Tl` (value: `'TL'`)
+
+* `Ae` (value: `'AE'`)
+
+* `Sa` (value: `'SA'`)
+
+* `Qa` (value: `'QA'`)
+
+* `Kw` (value: `'KW'`)
+
+* `Bh` (value: `'BH'`)
+
+* `Om` (value: `'OM'`)
+
+* `Ye` (value: `'YE'`)
+
+* `Il` (value: `'IL'`)
+
+* `Ps` (value: `'PS'`)
+
+* `Jo` (value: `'JO'`)
+
+* `Lb` (value: `'LB'`)
+
+* `Sy` (value: `'SY'`)
+
+* `Iq` (value: `'IQ'`)
+
+* `Ir` (value: `'IR'`)
+
+* `Af` (value: `'AF'`)
+
+* `Za` (value: `'ZA'`)
+
+* `Eg` (value: `'EG'`)
+
+* `Ma` (value: `'MA'`)
+
+* `Dz` (value: `'DZ'`)
+
+* `Tn` (value: `'TN'`)
+
+* `Ly` (value: `'LY'`)
+
+* `Ng` (value: `'NG'`)
+
+* `Ke` (value: `'KE'`)
+
+* `Gh` (value: `'GH'`)
+
+* `Ci` (value: `'CI'`)
+
+* `Sn` (value: `'SN'`)
+
+* `Cm` (value: `'CM'`)
+
+* `Et` (value: `'ET'`)
+
+* `Tz` (value: `'TZ'`)
+
+* `Ug` (value: `'UG'`)
+
+* `Rw` (value: `'RW'`)
+
+* `Mu` (value: `'MU'`)
+
+* `Mg` (value: `'MG'`)
+
+* `Ao` (value: `'AO'`)
+
+* `Mz` (value: `'MZ'`)
+
+* `Zw` (value: `'ZW'`)
+
+* `Bw` (value: `'BW'`)
+
+* `Na` (value: `'NA'`)
+
+* `Ga` (value: `'GA'`)
+
+* `Cg` (value: `'CG'`)
+
+* `Cd` (value: `'CD'`)
+
+* `Ml` (value: `'ML'`)
+
+* `Bf` (value: `'BF'`)
+
+* `Ne` (value: `'NE'`)
+
+* `Td` (value: `'TD'`)
+
+* `Sd` (value: `'SD'`)
+
+* `Ss` (value: `'SS'`)
+
+* `Er` (value: `'ER'`)
+
+* `Dj` (value: `'DJ'`)
+
+* `So` (value: `'SO'`)
+
+* `Au` (value: `'AU'`)
+
+* `Nz` (value: `'NZ'`)
+
+* `Fj` (value: `'FJ'`)
+
+* `Pg` (value: `'PG'`)
+
+* `Sb` (value: `'SB'`)
+
+* `Vu` (value: `'VU'`)
+
+* `Ws` (value: `'WS'`)
+
+* `To` (value: `'TO'`)
+
+* `Kz` (value: `'KZ'`)
+
+* `Uz` (value: `'UZ'`)
+
+* `Tm` (value: `'TM'`)
+
+* `Kg` (value: `'KG'`)
+
+* `Tj` (value: `'TJ'`)
+
+* `Az` (value: `'AZ'`)
+
+* `Am` (value: `'AM'`)
+
+* `Ge` (value: `'GE'`)
+
+* `Mn` (value: `'MN'`)
+
+[[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/CreateAggregatedReportRequest.md

@@ -0,0 +1,37 @@
+# CreateAggregatedReportRequest
+
+Request to create a PPF-compliant aggregated e-reporting submission.  This schema allows creating a SINGLE report file containing multiple flux types, as expected by the PPF and PA platforms: - TransactionsReport: Contains both Invoice (10.1) and Transactions (10.3) - PaymentsReport: Contains both Invoice payments (10.2) and Transaction payments (10.4)  Source: Specifications externes v3.1, XSD ereporting.xsd
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**reportId** | **string** | Report identifier (generated by caller) | [default to undefined]
+**reportName** | **string** |  | [optional] [default to undefined]
+**transmissionType** | [**TransmissionTypeCode**](TransmissionTypeCode.md) | Transmission type: IN=Initial, RE=Rectificative (TT-4) | [optional] [default to undefined]
+**sender** | [**ReportSender**](ReportSender.md) | Report sender/declarant | [default to undefined]
+**period** | [**ReportPeriod**](ReportPeriod.md) | Reporting period | [default to undefined]
+**invoices** | [**Array<InvoiceInput>**](InvoiceInput.md) |  | [optional] [default to undefined]
+**transactions** | [**Array<AggregatedTransactionInput>**](AggregatedTransactionInput.md) |  | [optional] [default to undefined]
+**invoicePayments** | [**Array<InvoicePaymentInput>**](InvoicePaymentInput.md) |  | [optional] [default to undefined]
+**transactionPayments** | [**Array<AggregatedPaymentInput>**](AggregatedPaymentInput.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { CreateAggregatedReportRequest } from '@factpulse/sdk';
+
+const instance: CreateAggregatedReportRequest = {
+    reportId,
+    reportName,
+    transmissionType,
+    sender,
+    period,
+    invoices,
+    transactions,
+    invoicePayments,
+    transactionPayments,
+};
+```
+
+[[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/CreateEReportingRequest.md

@@ -0,0 +1,39 @@
+# CreateEReportingRequest
+
+Request to create an e-reporting submission.  Supports all four flux types: - 10.1: B2B international invoices (use `invoices` field) - 10.2: B2B international payments (use `invoicePayments` field) - 10.3: B2C aggregated transactions (use `transactions` field) - 10.4: B2C aggregated payments (use `aggregatedPayments` field)
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**reportId** | **string** | Report identifier (generated by caller) | [default to undefined]
+**reportName** | **string** |  | [optional] [default to undefined]
+**flowType** | [**EReportingFlowType**](EReportingFlowType.md) | E-Reporting flux type (for internal routing) | [default to undefined]
+**transmissionType** | [**TransmissionTypeCode**](TransmissionTypeCode.md) | Transmission type (TT-4 TypeCode): IN=Initial, RE=Rectificative | [optional] [default to undefined]
+**sender** | [**ReportSender**](ReportSender.md) | Report sender (declarant) | [default to undefined]
+**period** | [**ReportPeriod**](ReportPeriod.md) | Reporting period | [default to undefined]
+**invoices** | [**Array<InvoiceInput>**](InvoiceInput.md) |  | [optional] [default to undefined]
+**transactions** | [**Array<AggregatedTransactionInput>**](AggregatedTransactionInput.md) |  | [optional] [default to undefined]
+**invoicePayments** | [**Array<InvoicePaymentInput>**](InvoicePaymentInput.md) |  | [optional] [default to undefined]
+**aggregatedPayments** | [**Array<AggregatedPaymentInput>**](AggregatedPaymentInput.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { CreateEReportingRequest } from '@factpulse/sdk';
+
+const instance: CreateEReportingRequest = {
+    reportId,
+    reportName,
+    flowType,
+    transmissionType,
+    sender,
+    period,
+    invoices,
+    transactions,
+    invoicePayments,
+    aggregatedPayments,
+};
+```
+
+[[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/Currency.md

@@ -0,0 +1,19 @@
+# Currency
+
+Currency code (ISO 4217). See CurrencyCode enum for valid values.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+
+## Example
+
+```typescript
+import { Currency } from '@factpulse/sdk';
+
+const instance: Currency = {
+};
+```
+
+[[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/CurrencyCode.md

@@ -0,0 +1,113 @@
+# CurrencyCode
+
+ISO 4217 currency codes.  Most common currencies used in e-reporting and invoicing. This is not an exhaustive list but covers all practical use cases for French e-reporting (EUR zone + major trading partners).
+
+## Enum
+
+* `Eur` (value: `'EUR'`)
+
+* `Usd` (value: `'USD'`)
+
+* `Gbp` (value: `'GBP'`)
+
+* `Jpy` (value: `'JPY'`)
+
+* `Chf` (value: `'CHF'`)
+
+* `Cad` (value: `'CAD'`)
+
+* `Aud` (value: `'AUD'`)
+
+* `Nzd` (value: `'NZD'`)
+
+* `Cny` (value: `'CNY'`)
+
+* `Hkd` (value: `'HKD'`)
+
+* `Sgd` (value: `'SGD'`)
+
+* `Dkk` (value: `'DKK'`)
+
+* `Sek` (value: `'SEK'`)
+
+* `Nok` (value: `'NOK'`)
+
+* `Pln` (value: `'PLN'`)
+
+* `Czk` (value: `'CZK'`)
+
+* `Huf` (value: `'HUF'`)
+
+* `Ron` (value: `'RON'`)
+
+* `Bgn` (value: `'BGN'`)
+
+* `Hrk` (value: `'HRK'`)
+
+* `Isk` (value: `'ISK'`)
+
+* `Rsd` (value: `'RSD'`)
+
+* `Rub` (value: `'RUB'`)
+
+* `Uah` (value: `'UAH'`)
+
+* `Try` (value: `'TRY'`)
+
+* `Mxn` (value: `'MXN'`)
+
+* `Brl` (value: `'BRL'`)
+
+* `Ars` (value: `'ARS'`)
+
+* `Clp` (value: `'CLP'`)
+
+* `Cop` (value: `'COP'`)
+
+* `Pen` (value: `'PEN'`)
+
+* `Inr` (value: `'INR'`)
+
+* `Krw` (value: `'KRW'`)
+
+* `Twd` (value: `'TWD'`)
+
+* `Thb` (value: `'THB'`)
+
+* `Myr` (value: `'MYR'`)
+
+* `Idr` (value: `'IDR'`)
+
+* `Php` (value: `'PHP'`)
+
+* `Vnd` (value: `'VND'`)
+
+* `Aed` (value: `'AED'`)
+
+* `Sar` (value: `'SAR'`)
+
+* `Ils` (value: `'ILS'`)
+
+* `Zar` (value: `'ZAR'`)
+
+* `Egp` (value: `'EGP'`)
+
+* `Mad` (value: `'MAD'`)
+
+* `Tnd` (value: `'TND'`)
+
+* `Dzd` (value: `'DZD'`)
+
+* `Ngn` (value: `'NGN'`)
+
+* `Kes` (value: `'KES'`)
+
+* `Xpf` (value: `'XPF'`)
+
+* `Xaf` (value: `'XAF'`)
+
+* `Xof` (value: `'XOF'`)
+
+* `Xdr` (value: `'XDR'`)
+
+[[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/Destination.md

@@ -8,8 +8,9 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **type** | **string** |  | [optional] [default to TypeEnum_ChorusPro]
 **credentials** | [**AFNORCredentials**](AFNORCredentials.md) |  | [optional] [default to undefined]
-**flowSyntax** | **string** | Flow syntax to send | [optional] [default to FlowSyntaxEnum_FacturX]
+**flowSyntax** | [**FlowSyntax**](FlowSyntax.md) | Flow syntax (AFNOR XP Z12-013) | [optional] [default to undefined]
 **trackingId** | **string** |  | [optional] [default to undefined]
+**processingRule** | [**ProcessingRule**](ProcessingRule.md) |  | [optional] [default to undefined]
 
 ## Example
 
@@ -21,6 +22,7 @@ const instance: Destination = {
     credentials,
     flowSyntax,
     trackingId,
+    processingRule,
 };
 ```
 

package/docs/DirectoryLineInclude.md

@@ -0,0 +1,15 @@
+# DirectoryLineInclude
+
+Relations to include for directory-line responses.
+
+## Enum
+
+* `Siren` (value: `'siren'`)
+
+* `Siret` (value: `'siret'`)
+
+* `RoutingCode` (value: `'routingCode'`)
+
+* `Platform` (value: `'platform'`)
+
+[[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/DocType.md

@@ -0,0 +1,15 @@
+# DocType
+
+AFNOR docType parameter for GET /flows/{flowId}.
+
+## Enum
+
+* `Metadata` (value: `'Metadata'`)
+
+* `Original` (value: `'Original'`)
+
+* `Converted` (value: `'Converted'`)
+
+* `ReadableView` (value: `'ReadableView'`)
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)