@factpulse/sdk 3.0.31 → 3.0.33
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.
- package/.openapi-generator/FILES +44 -4
- package/CHANGELOG.md +9 -17
- package/api/afnorpdppaapi.ts +1 -1
- package/api/afnorpdppadirectory-service-api.ts +1 -1
- package/api/afnorpdppaflow-service-api.ts +1 -1
- package/api/cdarcycle-de-vie-api.ts +603 -0
- package/api/chorus-pro-api.ts +1 -1
- package/api/document-conversion-api.ts +1 -1
- package/api/downloads-api.ts +1 -1
- package/api/ereporting-api.ts +1 -1
- package/api/health-api.ts +1 -1
- package/api/invoice-processing-api.ts +3 -3
- package/api/pdfxmlverification-api.ts +1 -1
- package/api/user-api.ts +1 -1
- package/api.ts +1 -0
- package/dist/api/cdarcycle-de-vie-api.d.ts +280 -0
- package/dist/api/cdarcycle-de-vie-api.js +569 -0
- package/dist/api.d.ts +1 -0
- package/dist/api.js +1 -0
- package/dist/esm/api/cdarcycle-de-vie-api.d.ts +280 -0
- package/dist/esm/api/cdarcycle-de-vie-api.js +559 -0
- package/dist/esm/api.d.ts +1 -0
- package/dist/esm/api.js +1 -0
- package/dist/{models/facture-electronique-rest-api-schemas-processing-chorus-pro-credentials.d.ts → esm/models/action-code-info.d.ts} +12 -8
- package/dist/esm/models/{facture-electronique-rest-api-schemas-processing-chorus-pro-credentials.d.ts → action-codes-response.d.ts} +13 -8
- package/dist/esm/models/action-codes-response.js +14 -0
- package/dist/esm/models/body-submit-cdar-api-v1-cdar-submit-post.d.ts +17 -0
- package/dist/esm/models/body-submit-cdar-api-v1-cdar-submit-post.js +14 -0
- package/dist/esm/models/body-submit-cdar-xml-api-v1-cdar-submit-xml-post.d.ts +17 -0
- package/dist/esm/models/body-submit-cdar-xml-api-v1-cdar-submit-xml-post.js +14 -0
- package/dist/esm/models/chorus-pro-credentials.d.ts +7 -19
- package/dist/esm/models/chorus-pro-destination.d.ts +2 -2
- package/dist/esm/models/create-cdarrequest.d.ts +66 -0
- package/dist/esm/models/create-cdarrequest.js +14 -0
- package/dist/esm/models/encaisseamount.d.ts +16 -0
- package/dist/esm/models/encaisseamount.js +14 -0
- package/dist/esm/models/encaisseamount1.d.ts +13 -0
- package/dist/esm/models/encaisseamount1.js +14 -0
- package/dist/esm/models/facture-electronique-rest-api-schemas-chorus-pro-chorus-pro-credentials.d.ts +36 -0
- package/dist/esm/models/facture-electronique-rest-api-schemas-chorus-pro-chorus-pro-credentials.js +14 -0
- package/dist/esm/models/facture-electronique-rest-api-schemas-ereporting-invoice-type-code.d.ts +22 -0
- package/dist/esm/models/facture-electronique-rest-api-schemas-ereporting-invoice-type-code.js +23 -0
- package/dist/esm/models/facture-electronique-rest-api-schemas-validation-validation-error-response.d.ts +20 -0
- package/dist/esm/models/facture-electronique-rest-api-schemas-validation-validation-error-response.js +14 -0
- package/dist/esm/models/generate-cdarresponse.d.ts +33 -0
- package/dist/esm/models/generate-cdarresponse.js +14 -0
- package/dist/esm/models/get-chorus-pro-id-request.d.ts +2 -2
- package/dist/esm/models/get-invoice-request.d.ts +2 -2
- package/dist/esm/models/get-structure-request.d.ts +2 -2
- package/dist/esm/models/index.d.ts +21 -2
- package/dist/esm/models/index.js +21 -2
- package/dist/esm/models/invoice-input.d.ts +2 -2
- package/dist/esm/models/invoice-type-code.d.ts +65 -6
- package/dist/esm/models/invoice-type-code.js +65 -6
- package/dist/esm/models/reason-code-info.d.ts +28 -0
- package/dist/esm/models/reason-code-info.js +14 -0
- package/dist/esm/models/reason-codes-response.d.ts +29 -0
- package/dist/esm/models/reason-codes-response.js +14 -0
- package/dist/esm/models/recipient-input.d.ts +24 -0
- package/dist/esm/models/recipient-input.js +14 -0
- package/dist/esm/models/search-structure-request.d.ts +2 -2
- package/dist/esm/models/simplified-invoice-data.d.ts +2 -2
- package/dist/esm/models/status-code-info.d.ts +28 -0
- package/dist/esm/models/status-code-info.js +14 -0
- package/dist/esm/models/status-codes-response.d.ts +29 -0
- package/dist/esm/models/status-codes-response.js +14 -0
- package/dist/esm/models/submit-cdarrequest.d.ts +70 -0
- package/dist/esm/models/submit-cdarrequest.js +14 -0
- package/dist/esm/models/submit-cdarresponse.d.ts +26 -0
- package/dist/esm/models/submit-cdarresponse.js +14 -0
- package/dist/esm/models/submit-cdarxmlrequest.d.ts +25 -0
- package/dist/esm/models/submit-cdarxmlrequest.js +14 -0
- package/dist/esm/models/submit-invoice-request.d.ts +2 -2
- package/dist/esm/models/validate-cdarrequest.d.ts +25 -0
- package/dist/esm/models/validate-cdarrequest.js +14 -0
- package/dist/esm/models/validate-cdarresponse.d.ts +29 -0
- package/dist/esm/models/validate-cdarresponse.js +14 -0
- package/dist/esm/models/validation-error-response.d.ts +12 -3
- package/dist/esm/src/helpers/client.js +3 -0
- package/dist/models/action-code-info.d.ts +28 -0
- package/dist/models/action-codes-response.d.ts +29 -0
- package/dist/models/action-codes-response.js +15 -0
- package/dist/models/body-submit-cdar-api-v1-cdar-submit-post.d.ts +17 -0
- package/dist/models/body-submit-cdar-api-v1-cdar-submit-post.js +15 -0
- package/dist/models/body-submit-cdar-xml-api-v1-cdar-submit-xml-post.d.ts +17 -0
- package/dist/models/body-submit-cdar-xml-api-v1-cdar-submit-xml-post.js +15 -0
- package/dist/models/chorus-pro-credentials.d.ts +7 -19
- package/dist/models/chorus-pro-destination.d.ts +2 -2
- package/dist/models/create-cdarrequest.d.ts +66 -0
- package/dist/models/create-cdarrequest.js +15 -0
- package/dist/models/encaisseamount.d.ts +16 -0
- package/dist/models/encaisseamount.js +15 -0
- package/dist/models/encaisseamount1.d.ts +13 -0
- package/dist/models/encaisseamount1.js +15 -0
- package/dist/models/facture-electronique-rest-api-schemas-chorus-pro-chorus-pro-credentials.d.ts +36 -0
- package/dist/models/facture-electronique-rest-api-schemas-chorus-pro-chorus-pro-credentials.js +15 -0
- package/dist/models/facture-electronique-rest-api-schemas-ereporting-invoice-type-code.d.ts +22 -0
- package/dist/models/facture-electronique-rest-api-schemas-ereporting-invoice-type-code.js +26 -0
- package/dist/models/facture-electronique-rest-api-schemas-validation-validation-error-response.d.ts +20 -0
- package/dist/models/facture-electronique-rest-api-schemas-validation-validation-error-response.js +15 -0
- package/dist/models/generate-cdarresponse.d.ts +33 -0
- package/dist/models/generate-cdarresponse.js +15 -0
- package/dist/models/get-chorus-pro-id-request.d.ts +2 -2
- package/dist/models/get-invoice-request.d.ts +2 -2
- package/dist/models/get-structure-request.d.ts +2 -2
- package/dist/models/index.d.ts +21 -2
- package/dist/models/index.js +21 -2
- package/dist/models/invoice-input.d.ts +2 -2
- package/dist/models/invoice-type-code.d.ts +65 -6
- package/dist/models/invoice-type-code.js +65 -6
- package/dist/models/reason-code-info.d.ts +28 -0
- package/dist/models/reason-code-info.js +15 -0
- package/dist/models/reason-codes-response.d.ts +29 -0
- package/dist/models/reason-codes-response.js +15 -0
- package/dist/models/recipient-input.d.ts +24 -0
- package/dist/models/recipient-input.js +15 -0
- package/dist/models/search-structure-request.d.ts +2 -2
- package/dist/models/simplified-invoice-data.d.ts +2 -2
- package/dist/models/status-code-info.d.ts +28 -0
- package/dist/models/status-code-info.js +15 -0
- package/dist/models/status-codes-response.d.ts +29 -0
- package/dist/models/status-codes-response.js +15 -0
- package/dist/models/submit-cdarrequest.d.ts +70 -0
- package/dist/models/submit-cdarrequest.js +15 -0
- package/dist/models/submit-cdarresponse.d.ts +26 -0
- package/dist/models/submit-cdarresponse.js +15 -0
- package/dist/models/submit-cdarxmlrequest.d.ts +25 -0
- package/dist/models/submit-cdarxmlrequest.js +15 -0
- package/dist/models/submit-invoice-request.d.ts +2 -2
- package/dist/models/validate-cdarrequest.d.ts +25 -0
- package/dist/models/validate-cdarrequest.js +15 -0
- package/dist/models/validate-cdarresponse.d.ts +29 -0
- package/dist/models/validate-cdarresponse.js +15 -0
- package/dist/models/validation-error-response.d.ts +12 -3
- package/dist/src/helpers/client.js +3 -0
- package/docs/ActionCodeInfo.md +25 -0
- package/docs/ActionCodesResponse.md +25 -0
- package/docs/BodySubmitCdarApiV1CdarSubmitPost.md +22 -0
- package/docs/BodySubmitCdarXmlApiV1CdarSubmitXmlPost.md +22 -0
- package/docs/CDARCycleDeVieApi.md +397 -0
- package/docs/ChorusProCredentials.md +9 -9
- package/docs/ChorusProDestination.md +1 -1
- package/docs/CreateCDARRequest.md +55 -0
- package/docs/Encaisseamount.md +19 -0
- package/docs/Encaisseamount1.md +18 -0
- package/docs/FactureElectroniqueRestApiSchemasChorusProChorusProCredentials.md +29 -0
- package/docs/FactureElectroniqueRestApiSchemasEreportingInvoiceTypeCode.md +17 -0
- package/docs/FactureElectroniqueRestApiSchemasValidationValidationErrorResponse.md +21 -0
- package/docs/GenerateCDARResponse.md +29 -0
- package/docs/GetChorusProIdRequest.md +1 -1
- package/docs/GetInvoiceRequest.md +1 -1
- package/docs/GetStructureRequest.md +1 -1
- package/docs/InvoiceInput.md +1 -1
- package/docs/InvoiceTypeCode.md +28 -6
- package/docs/ReasonCodeInfo.md +25 -0
- package/docs/ReasonCodesResponse.md +25 -0
- package/docs/RecipientInput.md +29 -0
- package/docs/SearchStructureRequest.md +1 -1
- package/docs/SimplifiedInvoiceData.md +1 -1
- package/docs/StatusCodeInfo.md +25 -0
- package/docs/StatusCodesResponse.md +25 -0
- package/docs/SubmitCDARRequest.md +57 -0
- package/docs/SubmitCDARResponse.md +27 -0
- package/docs/SubmitCDARXMLRequest.md +25 -0
- package/docs/SubmitInvoiceRequest.md +1 -1
- package/docs/ValidateCDARRequest.md +35 -0
- package/docs/ValidateCDARResponse.md +25 -0
- package/docs/ValidationErrorResponse.md +9 -3
- package/models/{facture-electronique-rest-api-schemas-processing-chorus-pro-credentials.ts → action-code-info.ts} +12 -8
- package/models/action-codes-response.ts +37 -0
- package/models/body-submit-cdar-api-v1-cdar-submit-post.ts +27 -0
- package/models/body-submit-cdar-xml-api-v1-cdar-submit-xml-post.ts +27 -0
- package/models/chorus-pro-credentials.ts +7 -19
- package/models/chorus-pro-destination.ts +2 -2
- package/models/create-cdarrequest.ts +76 -0
- package/models/encaisseamount.ts +22 -0
- package/models/encaisseamount1.ts +19 -0
- package/models/facture-electronique-rest-api-schemas-chorus-pro-chorus-pro-credentials.ts +42 -0
- package/models/facture-electronique-rest-api-schemas-ereporting-invoice-type-code.ts +32 -0
- package/models/facture-electronique-rest-api-schemas-validation-validation-error-response.ts +26 -0
- package/models/generate-cdarresponse.ts +39 -0
- package/models/get-chorus-pro-id-request.ts +2 -2
- package/models/get-invoice-request.ts +2 -2
- package/models/get-structure-request.ts +2 -2
- package/models/index.ts +21 -2
- package/models/invoice-input.ts +2 -2
- package/models/invoice-type-code.ts +65 -6
- package/models/reason-code-info.ts +34 -0
- package/models/reason-codes-response.ts +37 -0
- package/models/recipient-input.ts +30 -0
- package/models/search-structure-request.ts +2 -2
- package/models/simplified-invoice-data.ts +2 -2
- package/models/status-code-info.ts +34 -0
- package/models/status-codes-response.ts +37 -0
- package/models/submit-cdarrequest.ts +80 -0
- package/models/submit-cdarresponse.ts +32 -0
- package/models/submit-cdarxmlrequest.ts +31 -0
- package/models/submit-invoice-request.ts +2 -2
- package/models/validate-cdarrequest.ts +33 -0
- package/models/validate-cdarresponse.ts +37 -0
- package/models/validation-error-response.ts +12 -3
- package/package.json +1 -1
- package/src/helpers/client.ts +3 -0
- package/dist/esm/models/facture-electronique-models-invoice-type-code.d.ts +0 -81
- package/dist/esm/models/facture-electronique-models-invoice-type-code.js +0 -82
- package/dist/models/facture-electronique-models-invoice-type-code.d.ts +0 -81
- package/dist/models/facture-electronique-models-invoice-type-code.js +0 -85
- package/docs/FactureElectroniqueModelsInvoiceTypeCode.md +0 -39
- package/docs/FactureElectroniqueRestApiSchemasProcessingChorusProCredentials.md +0 -29
- package/models/facture-electronique-models-invoice-type-code.ts +0 -91
- /package/dist/esm/models/{facture-electronique-rest-api-schemas-processing-chorus-pro-credentials.js → action-code-info.js} +0 -0
- /package/dist/models/{facture-electronique-rest-api-schemas-processing-chorus-pro-credentials.js → action-code-info.js} +0 -0
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# Encaisseamount1
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
|
|
9
|
+
## Example
|
|
10
|
+
|
|
11
|
+
```typescript
|
|
12
|
+
import { Encaisseamount1 } from '@factpulse/sdk';
|
|
13
|
+
|
|
14
|
+
const instance: Encaisseamount1 = {
|
|
15
|
+
};
|
|
16
|
+
```
|
|
17
|
+
|
|
18
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
# FactureElectroniqueRestApiSchemasChorusProChorusProCredentials
|
|
2
|
+
|
|
3
|
+
Chorus Pro credentials for Zero-Trust mode. **Zero-Trust Mode**: Credentials are passed in each request and are NEVER stored. **Security**: - Credentials are never persisted in the database - They are used only for the duration of the request - Secure transmission via HTTPS **Use cases**: - High-security environments (banks, administrations) - Strict GDPR compliance - Tests with temporary credentials - Users who don\'t want to store their credentials
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**pisteClientId** | **string** | PISTE Client ID (government API portal) | [default to undefined]
|
|
10
|
+
**pisteClientSecret** | **string** | PISTE Client Secret | [default to undefined]
|
|
11
|
+
**chorusProLogin** | **string** | Chorus Pro login | [default to undefined]
|
|
12
|
+
**chorusProPassword** | **string** | Chorus Pro password | [default to undefined]
|
|
13
|
+
**sandbox** | **boolean** | Use sandbox environment (true) or production (false) | [optional] [default to true]
|
|
14
|
+
|
|
15
|
+
## Example
|
|
16
|
+
|
|
17
|
+
```typescript
|
|
18
|
+
import { FactureElectroniqueRestApiSchemasChorusProChorusProCredentials } from '@factpulse/sdk';
|
|
19
|
+
|
|
20
|
+
const instance: FactureElectroniqueRestApiSchemasChorusProChorusProCredentials = {
|
|
21
|
+
pisteClientId,
|
|
22
|
+
pisteClientSecret,
|
|
23
|
+
chorusProLogin,
|
|
24
|
+
chorusProPassword,
|
|
25
|
+
sandbox,
|
|
26
|
+
};
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# FactureElectroniqueRestApiSchemasEreportingInvoiceTypeCode
|
|
2
|
+
|
|
3
|
+
Invoice type codes (UNTDID 1001).
|
|
4
|
+
|
|
5
|
+
## Enum
|
|
6
|
+
|
|
7
|
+
* `_380` (value: `'380'`)
|
|
8
|
+
|
|
9
|
+
* `_381` (value: `'381'`)
|
|
10
|
+
|
|
11
|
+
* `_384` (value: `'384'`)
|
|
12
|
+
|
|
13
|
+
* `_389` (value: `'389'`)
|
|
14
|
+
|
|
15
|
+
* `_386` (value: `'386'`)
|
|
16
|
+
|
|
17
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
# FactureElectroniqueRestApiSchemasValidationValidationErrorResponse
|
|
2
|
+
|
|
3
|
+
Response for validation errors.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**detail** | **Array<string>** | List of detected validation errors. | [default to undefined]
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { FactureElectroniqueRestApiSchemasValidationValidationErrorResponse } from '@factpulse/sdk';
|
|
15
|
+
|
|
16
|
+
const instance: FactureElectroniqueRestApiSchemasValidationValidationErrorResponse = {
|
|
17
|
+
detail,
|
|
18
|
+
};
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
# GenerateCDARResponse
|
|
2
|
+
|
|
3
|
+
Réponse de génération de message CDAR.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**documentId** | **string** | | [default to undefined]
|
|
10
|
+
**xml** | **string** | XML CDAR généré | [default to undefined]
|
|
11
|
+
**xmlSize** | **number** | Taille du XML en octets | [default to undefined]
|
|
12
|
+
**sha256** | **string** | Hash SHA256 du XML | [default to undefined]
|
|
13
|
+
**message** | **string** | Message de succès | [default to undefined]
|
|
14
|
+
|
|
15
|
+
## Example
|
|
16
|
+
|
|
17
|
+
```typescript
|
|
18
|
+
import { GenerateCDARResponse } from '@factpulse/sdk';
|
|
19
|
+
|
|
20
|
+
const instance: GenerateCDARResponse = {
|
|
21
|
+
documentId,
|
|
22
|
+
xml,
|
|
23
|
+
xmlSize,
|
|
24
|
+
sha256,
|
|
25
|
+
message,
|
|
26
|
+
};
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -6,7 +6,7 @@ Get Chorus Pro ID from SIRET.
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**credentials** | [**
|
|
9
|
+
**credentials** | [**FactureElectroniqueRestApiSchemasChorusProChorusProCredentials**](FactureElectroniqueRestApiSchemasChorusProChorusProCredentials.md) | | [optional] [default to undefined]
|
|
10
10
|
**siret** | **string** | Structure SIRET (14 digits) | [default to undefined]
|
|
11
11
|
**identifierType** | **string** | Identifier type (SIRET, SIREN, UE_HORS_FRANCE, etc.) | [optional] [default to 'SIRET']
|
|
12
12
|
|
|
@@ -6,7 +6,7 @@ Get an invoice.
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**credentials** | [**
|
|
9
|
+
**credentials** | [**FactureElectroniqueRestApiSchemasChorusProChorusProCredentials**](FactureElectroniqueRestApiSchemasChorusProChorusProCredentials.md) | | [optional] [default to undefined]
|
|
10
10
|
**chorusInvoiceId** | **number** | Chorus Pro invoice ID | [default to undefined]
|
|
11
11
|
|
|
12
12
|
## Example
|
|
@@ -6,7 +6,7 @@ Get structure details.
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**credentials** | [**
|
|
9
|
+
**credentials** | [**FactureElectroniqueRestApiSchemasChorusProChorusProCredentials**](FactureElectroniqueRestApiSchemasChorusProChorusProCredentials.md) | | [optional] [default to undefined]
|
|
10
10
|
**structureId** | **number** | Chorus Pro structure ID | [default to undefined]
|
|
11
11
|
**languageCode** | **string** | Language code (fr, en) | [optional] [default to 'fr']
|
|
12
12
|
|
package/docs/InvoiceInput.md
CHANGED
|
@@ -8,7 +8,7 @@ Name | Type | Description | Notes
|
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
9
|
**invoiceId** | **string** | Invoice identifier | [default to undefined]
|
|
10
10
|
**issueDate** | **string** | Invoice issue date | [default to undefined]
|
|
11
|
-
**typeCode** | [**
|
|
11
|
+
**typeCode** | [**FactureElectroniqueRestApiSchemasEreportingInvoiceTypeCode**](FactureElectroniqueRestApiSchemasEreportingInvoiceTypeCode.md) | Invoice type code | [optional] [default to undefined]
|
|
12
12
|
**currency** | [**Currency**](Currency.md) | | [optional] [default to undefined]
|
|
13
13
|
**dueDate** | **string** | | [optional] [default to undefined]
|
|
14
14
|
**sellerSiren** | **string** | Seller SIREN/SIRET | [default to undefined]
|
package/docs/InvoiceTypeCode.md
CHANGED
|
@@ -1,17 +1,39 @@
|
|
|
1
1
|
# InvoiceTypeCode
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
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 |
|
|
4
4
|
|
|
5
5
|
## Enum
|
|
6
6
|
|
|
7
|
-
* `
|
|
7
|
+
* `INVOICE` (value: `'380'`)
|
|
8
8
|
|
|
9
|
-
* `
|
|
9
|
+
* `SELF_BILLED_INVOICE` (value: `'389'`)
|
|
10
10
|
|
|
11
|
-
* `
|
|
11
|
+
* `FACTORED_INVOICE` (value: `'393'`)
|
|
12
12
|
|
|
13
|
-
* `
|
|
13
|
+
* `SELF_BILLED_FACTORED_INVOICE` (value: `'501'`)
|
|
14
14
|
|
|
15
|
-
* `
|
|
15
|
+
* `PREPAYMENT_INVOICE` (value: `'386'`)
|
|
16
|
+
|
|
17
|
+
* `SELF_BILLED_PREPAYMENT_INVOICE` (value: `'500'`)
|
|
18
|
+
|
|
19
|
+
* `CORRECTIVE_INVOICE` (value: `'384'`)
|
|
20
|
+
|
|
21
|
+
* `SELF_BILLED_CORRECTIVE_INVOICE` (value: `'471'`)
|
|
22
|
+
|
|
23
|
+
* `FACTORED_CORRECTIVE_INVOICE` (value: `'472'`)
|
|
24
|
+
|
|
25
|
+
* `SELF_BILLED_FACTORED_CORRECTIVE_INVOICE` (value: `'473'`)
|
|
26
|
+
|
|
27
|
+
* `CREDIT_NOTE` (value: `'381'`)
|
|
28
|
+
|
|
29
|
+
* `SELF_BILLED_CREDIT_NOTE` (value: `'261'`)
|
|
30
|
+
|
|
31
|
+
* `GLOBAL_ALLOWANCE_CREDIT_NOTE` (value: `'262'`)
|
|
32
|
+
|
|
33
|
+
* `FACTORED_CREDIT_NOTE` (value: `'396'`)
|
|
34
|
+
|
|
35
|
+
* `SELF_BILLED_FACTORED_CREDIT_NOTE` (value: `'502'`)
|
|
36
|
+
|
|
37
|
+
* `PREPAYMENT_CREDIT_NOTE` (value: `'503'`)
|
|
16
38
|
|
|
17
39
|
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
# ReasonCodeInfo
|
|
2
|
+
|
|
3
|
+
Information sur un code motif.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**code** | **string** | Code | [default to undefined]
|
|
10
|
+
**name** | **string** | Nom Python de l\'enum | [default to undefined]
|
|
11
|
+
**description** | **string** | Description | [default to undefined]
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import { ReasonCodeInfo } from '@factpulse/sdk';
|
|
17
|
+
|
|
18
|
+
const instance: ReasonCodeInfo = {
|
|
19
|
+
code,
|
|
20
|
+
name,
|
|
21
|
+
description,
|
|
22
|
+
};
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
# ReasonCodesResponse
|
|
2
|
+
|
|
3
|
+
Liste des codes motif disponibles.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**codes** | [**Array<ReasonCodeInfo>**](ReasonCodeInfo.md) | Liste des codes motif | [default to undefined]
|
|
10
|
+
**count** | **number** | Nombre de codes | [default to undefined]
|
|
11
|
+
**source** | **string** | Règle source | [optional] [default to 'BR-FR-CDV-CL-09']
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import { ReasonCodesResponse } from '@factpulse/sdk';
|
|
17
|
+
|
|
18
|
+
const instance: ReasonCodesResponse = {
|
|
19
|
+
codes,
|
|
20
|
+
count,
|
|
21
|
+
source,
|
|
22
|
+
};
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
# RecipientInput
|
|
2
|
+
|
|
3
|
+
Destinataire du message CDAR.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**siren** | **string** | | [optional] [default to undefined]
|
|
10
|
+
**siret** | **string** | | [optional] [default to undefined]
|
|
11
|
+
**name** | **string** | | [optional] [default to undefined]
|
|
12
|
+
**role** | **string** | Code rôle (BY, SE, WK, etc.) | [optional] [default to 'BY']
|
|
13
|
+
**email** | **string** | | [optional] [default to undefined]
|
|
14
|
+
|
|
15
|
+
## Example
|
|
16
|
+
|
|
17
|
+
```typescript
|
|
18
|
+
import { RecipientInput } from '@factpulse/sdk';
|
|
19
|
+
|
|
20
|
+
const instance: RecipientInput = {
|
|
21
|
+
siren,
|
|
22
|
+
siret,
|
|
23
|
+
name,
|
|
24
|
+
role,
|
|
25
|
+
email,
|
|
26
|
+
};
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -6,7 +6,7 @@ Search structures by criteria.
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**credentials** | [**
|
|
9
|
+
**credentials** | [**FactureElectroniqueRestApiSchemasChorusProChorusProCredentials**](FactureElectroniqueRestApiSchemasChorusProChorusProCredentials.md) | | [optional] [default to undefined]
|
|
10
10
|
**structureIdentifier** | **string** | | [optional] [default to undefined]
|
|
11
11
|
**structureIdentifierType** | **string** | | [optional] [default to undefined]
|
|
12
12
|
**companyName** | **string** | | [optional] [default to undefined]
|
|
@@ -15,7 +15,7 @@ Name | Type | Description | Notes
|
|
|
15
15
|
**comment** | **string** | | [optional] [default to undefined]
|
|
16
16
|
**purchaseOrderReference** | **string** | | [optional] [default to undefined]
|
|
17
17
|
**contractReference** | **string** | | [optional] [default to undefined]
|
|
18
|
-
**invoiceType** | [**
|
|
18
|
+
**invoiceType** | [**InvoiceTypeCode**](InvoiceTypeCode.md) | Document type (UNTDID 1001). Default: 380 (Invoice). | [optional] [default to undefined]
|
|
19
19
|
**precedingInvoiceReference** | **string** | | [optional] [default to undefined]
|
|
20
20
|
**operationNature** | [**OperationNature**](OperationNature.md) | | [optional] [default to undefined]
|
|
21
21
|
**invoicingFramework** | [**InvoicingFrameworkCode**](InvoicingFrameworkCode.md) | | [optional] [default to undefined]
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
# StatusCodeInfo
|
|
2
|
+
|
|
3
|
+
Information sur un code statut.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**code** | **string** | Code numérique | [default to undefined]
|
|
10
|
+
**name** | **string** | Nom Python de l\'enum | [default to undefined]
|
|
11
|
+
**description** | **string** | Description | [default to undefined]
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import { StatusCodeInfo } from '@factpulse/sdk';
|
|
17
|
+
|
|
18
|
+
const instance: StatusCodeInfo = {
|
|
19
|
+
code,
|
|
20
|
+
name,
|
|
21
|
+
description,
|
|
22
|
+
};
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
# StatusCodesResponse
|
|
2
|
+
|
|
3
|
+
Liste des codes statut disponibles.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**codes** | [**Array<StatusCodeInfo>**](StatusCodeInfo.md) | Liste des codes statut | [default to undefined]
|
|
10
|
+
**count** | **number** | Nombre de codes | [default to undefined]
|
|
11
|
+
**source** | **string** | Règle source | [optional] [default to 'BR-FR-CDV-CL-06']
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import { StatusCodesResponse } from '@factpulse/sdk';
|
|
17
|
+
|
|
18
|
+
const instance: StatusCodesResponse = {
|
|
19
|
+
codes,
|
|
20
|
+
count,
|
|
21
|
+
source,
|
|
22
|
+
};
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,57 @@
|
|
|
1
|
+
# SubmitCDARRequest
|
|
2
|
+
|
|
3
|
+
Requête de soumission CDAR (génération + envoi).
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**documentId** | **string** | Identifiant unique du message CDAR | [default to undefined]
|
|
10
|
+
**businessProcess** | **string** | Code processus métier (REGULATED, B2C, B2BINT, etc.) | [optional] [default to 'REGULATED']
|
|
11
|
+
**typeCode** | **string** | Type de message (23=Traitement, 305=Transmission) | [optional] [default to '23']
|
|
12
|
+
**senderSiren** | **string** | SIREN de l\'émetteur (9 chiffres) | [default to undefined]
|
|
13
|
+
**senderRole** | **string** | Rôle de l\'émetteur (WK, SE, BY, etc.) | [optional] [default to 'WK']
|
|
14
|
+
**senderName** | **string** | | [optional] [default to undefined]
|
|
15
|
+
**senderEmail** | **string** | | [optional] [default to undefined]
|
|
16
|
+
**recipients** | [**Array<RecipientInput>**](RecipientInput.md) | Liste des destinataires | [optional] [default to undefined]
|
|
17
|
+
**invoiceId** | **string** | Identifiant de la facture (BT-1) | [default to undefined]
|
|
18
|
+
**invoiceIssueDate** | **string** | Date d\'émission de la facture (YYYY-MM-DD) | [default to undefined]
|
|
19
|
+
**invoiceTypeCode** | **string** | Type de document (380=Facture, 381=Avoir) | [optional] [default to '380']
|
|
20
|
+
**invoiceSellerSiren** | **string** | | [optional] [default to undefined]
|
|
21
|
+
**invoiceBuyerSiren** | **string** | | [optional] [default to undefined]
|
|
22
|
+
**status** | **string** | Code statut de la facture (200-601) | [default to undefined]
|
|
23
|
+
**reasonCode** | **string** | | [optional] [default to undefined]
|
|
24
|
+
**reasonText** | **string** | | [optional] [default to undefined]
|
|
25
|
+
**actionCode** | **string** | | [optional] [default to undefined]
|
|
26
|
+
**encaisseAmount** | [**Encaisseamount**](Encaisseamount.md) | | [optional] [default to undefined]
|
|
27
|
+
**flowType** | **string** | Type de flux AFNOR (CustomerInvoiceLC, SupplierInvoiceLC, etc.) | [optional] [default to 'CustomerInvoiceLC']
|
|
28
|
+
|
|
29
|
+
## Example
|
|
30
|
+
|
|
31
|
+
```typescript
|
|
32
|
+
import { SubmitCDARRequest } from '@factpulse/sdk';
|
|
33
|
+
|
|
34
|
+
const instance: SubmitCDARRequest = {
|
|
35
|
+
documentId,
|
|
36
|
+
businessProcess,
|
|
37
|
+
typeCode,
|
|
38
|
+
senderSiren,
|
|
39
|
+
senderRole,
|
|
40
|
+
senderName,
|
|
41
|
+
senderEmail,
|
|
42
|
+
recipients,
|
|
43
|
+
invoiceId,
|
|
44
|
+
invoiceIssueDate,
|
|
45
|
+
invoiceTypeCode,
|
|
46
|
+
invoiceSellerSiren,
|
|
47
|
+
invoiceBuyerSiren,
|
|
48
|
+
status,
|
|
49
|
+
reasonCode,
|
|
50
|
+
reasonText,
|
|
51
|
+
actionCode,
|
|
52
|
+
encaisseAmount,
|
|
53
|
+
flowType,
|
|
54
|
+
};
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
# SubmitCDARResponse
|
|
2
|
+
|
|
3
|
+
Réponse de soumission CDAR.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**flowId** | **string** | Identifiant du flux AFNOR | [default to undefined]
|
|
10
|
+
**status** | **string** | Statut de la soumission | [default to undefined]
|
|
11
|
+
**message** | **string** | | [optional] [default to undefined]
|
|
12
|
+
**documentId** | **string** | | [optional] [default to undefined]
|
|
13
|
+
|
|
14
|
+
## Example
|
|
15
|
+
|
|
16
|
+
```typescript
|
|
17
|
+
import { SubmitCDARResponse } from '@factpulse/sdk';
|
|
18
|
+
|
|
19
|
+
const instance: SubmitCDARResponse = {
|
|
20
|
+
flowId,
|
|
21
|
+
status,
|
|
22
|
+
message,
|
|
23
|
+
documentId,
|
|
24
|
+
};
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
# SubmitCDARXMLRequest
|
|
2
|
+
|
|
3
|
+
Requête de soumission d\'un XML CDAR pré-généré.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**xml** | **string** | XML CDAR à soumettre | [default to undefined]
|
|
10
|
+
**flowType** | **string** | Type de flux AFNOR | [optional] [default to 'CustomerInvoiceLC']
|
|
11
|
+
**filename** | **string** | | [optional] [default to undefined]
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import { SubmitCDARXMLRequest } from '@factpulse/sdk';
|
|
17
|
+
|
|
18
|
+
const instance: SubmitCDARXMLRequest = {
|
|
19
|
+
xml,
|
|
20
|
+
flowType,
|
|
21
|
+
filename,
|
|
22
|
+
};
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -6,7 +6,7 @@ Submit an invoice to Chorus Pro.
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**credentials** | [**
|
|
9
|
+
**credentials** | [**FactureElectroniqueRestApiSchemasChorusProChorusProCredentials**](FactureElectroniqueRestApiSchemasChorusProChorusProCredentials.md) | | [optional] [default to undefined]
|
|
10
10
|
**invoiceNumber** | **string** | Invoice number | [default to undefined]
|
|
11
11
|
**invoiceDate** | **string** | Invoice date (ISO format: YYYY-MM-DD) | [default to undefined]
|
|
12
12
|
**paymentDueDate** | **string** | | [optional] [default to undefined]
|
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
# ValidateCDARRequest
|
|
2
|
+
|
|
3
|
+
Requête de validation CDAR.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**documentId** | **string** | | [optional] [default to undefined]
|
|
10
|
+
**senderSiren** | **string** | | [optional] [default to undefined]
|
|
11
|
+
**senderRole** | **string** | | [optional] [default to undefined]
|
|
12
|
+
**invoiceId** | **string** | | [optional] [default to undefined]
|
|
13
|
+
**invoiceIssueDate** | **string** | | [optional] [default to undefined]
|
|
14
|
+
**status** | **string** | | [optional] [default to undefined]
|
|
15
|
+
**reasonCode** | **string** | | [optional] [default to undefined]
|
|
16
|
+
**encaisseAmount** | [**Encaisseamount1**](Encaisseamount1.md) | | [optional] [default to undefined]
|
|
17
|
+
|
|
18
|
+
## Example
|
|
19
|
+
|
|
20
|
+
```typescript
|
|
21
|
+
import { ValidateCDARRequest } from '@factpulse/sdk';
|
|
22
|
+
|
|
23
|
+
const instance: ValidateCDARRequest = {
|
|
24
|
+
documentId,
|
|
25
|
+
senderSiren,
|
|
26
|
+
senderRole,
|
|
27
|
+
invoiceId,
|
|
28
|
+
invoiceIssueDate,
|
|
29
|
+
status,
|
|
30
|
+
reasonCode,
|
|
31
|
+
encaisseAmount,
|
|
32
|
+
};
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
# ValidateCDARResponse
|
|
2
|
+
|
|
3
|
+
Réponse de validation CDAR.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**valid** | **boolean** | Résultat de validation | [default to undefined]
|
|
10
|
+
**errors** | [**Array<ValidationErrorResponse>**](ValidationErrorResponse.md) | Liste des erreurs | [optional] [default to undefined]
|
|
11
|
+
**warnings** | [**Array<ValidationErrorResponse>**](ValidationErrorResponse.md) | Liste des avertissements | [optional] [default to undefined]
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import { ValidateCDARResponse } from '@factpulse/sdk';
|
|
17
|
+
|
|
18
|
+
const instance: ValidateCDARResponse = {
|
|
19
|
+
valid,
|
|
20
|
+
errors,
|
|
21
|
+
warnings,
|
|
22
|
+
};
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -1,12 +1,15 @@
|
|
|
1
1
|
# ValidationErrorResponse
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Erreur de validation.
|
|
4
4
|
|
|
5
5
|
## Properties
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**
|
|
9
|
+
**field** | **string** | Champ concerné | [default to undefined]
|
|
10
|
+
**message** | **string** | Message d\'erreur | [default to undefined]
|
|
11
|
+
**rule** | **string** | | [optional] [default to undefined]
|
|
12
|
+
**severity** | **string** | Sévérité (error/warning) | [optional] [default to 'error']
|
|
10
13
|
|
|
11
14
|
## Example
|
|
12
15
|
|
|
@@ -14,7 +17,10 @@ Name | Type | Description | Notes
|
|
|
14
17
|
import { ValidationErrorResponse } from '@factpulse/sdk';
|
|
15
18
|
|
|
16
19
|
const instance: ValidationErrorResponse = {
|
|
17
|
-
|
|
20
|
+
field,
|
|
21
|
+
message,
|
|
22
|
+
rule,
|
|
23
|
+
severity,
|
|
18
24
|
};
|
|
19
25
|
```
|
|
20
26
|
|
|
@@ -15,16 +15,20 @@
|
|
|
15
15
|
|
|
16
16
|
|
|
17
17
|
/**
|
|
18
|
-
*
|
|
18
|
+
* Information sur un code action.
|
|
19
19
|
*/
|
|
20
|
-
export interface
|
|
21
|
-
'pisteClientId'?: string | null;
|
|
22
|
-
'pisteClientSecret'?: string | null;
|
|
23
|
-
'chorusLogin'?: string | null;
|
|
24
|
-
'chorusPassword'?: string | null;
|
|
20
|
+
export interface ActionCodeInfo {
|
|
25
21
|
/**
|
|
26
|
-
*
|
|
22
|
+
* Code
|
|
27
23
|
*/
|
|
28
|
-
'
|
|
24
|
+
'code': string;
|
|
25
|
+
/**
|
|
26
|
+
* Nom Python de l\'enum
|
|
27
|
+
*/
|
|
28
|
+
'name': string;
|
|
29
|
+
/**
|
|
30
|
+
* Description
|
|
31
|
+
*/
|
|
32
|
+
'description': string;
|
|
29
33
|
}
|
|
30
34
|
|
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* FactPulse REST API
|
|
5
|
+
* REST API for electronic invoicing in France: Factur-X, AFNOR PDP/PA, electronic signatures. ## 🎯 Main Features ### 📄 Factur-X Invoice Generation - **Formats**: XML only or PDF/A-3 with embedded XML - **Profiles**: MINIMUM, BASIC, EN16931, EXTENDED - **Standards**: EN 16931 (EU directive 2014/55), ISO 19005-3 (PDF/A-3), CII (UN/CEFACT) - **🆕 Simplified Format**: Generation from SIRET + auto-enrichment (Chorus Pro API + Business Search) ### ✅ Validation and Compliance - **XML Validation**: Schematron (45 to 210+ rules depending on profile) - **PDF Validation**: PDF/A-3, Factur-X XMP metadata, electronic signatures - **VeraPDF**: Strict PDF/A validation (146+ ISO 19005-3 rules) - **Asynchronous Processing**: Celery support for heavy validations (VeraPDF) ### 📡 AFNOR PDP/PA Integration (XP Z12-013) - **Flow Submission**: Send invoices to Partner Dematerialization Platforms - **Flow Search**: View submitted invoices - **Download**: Retrieve PDF/A-3 with XML - **Directory Service**: Company search (SIREN/SIRET) - **Multi-client**: Support for multiple PDP configs per user (stored credentials or zero-storage) ### ✍️ PDF Electronic Signature - **Standards**: PAdES-B-B, PAdES-B-T (RFC 3161 timestamping), PAdES-B-LT (long-term archival) - **eIDAS Levels**: SES (self-signed), AdES (commercial CA), QES (QTSP) - **Validation**: Cryptographic integrity and certificate verification - **Certificate Generation**: Self-signed X.509 certificates for testing ### 🔄 Asynchronous Processing - **Celery**: Asynchronous generation, validation and signing - **Polling**: Status tracking via `/tasks/{task_id}/status` - **No timeout**: Ideal for large files or heavy validations ## 🔒 Authentication All requests require a **JWT token** in the Authorization header: ``` Authorization: Bearer YOUR_JWT_TOKEN ``` ### How to obtain a JWT token? #### 🔑 Method 1: `/api/token/` API (Recommended) **URL:** `https://factpulse.fr/api/token/` This method is **recommended** for integration in your applications and CI/CD workflows. **Prerequisites:** Having set a password on your account **For users registered via email/password:** - You already have a password, use it directly **For users registered via OAuth (Google/GitHub):** - You must first set a password at: https://factpulse.fr/accounts/password/set/ - Once the password is created, you can use the API **Request example:** ```bash curl -X POST https://factpulse.fr/api/token/ \\ -H \"Content-Type: application/json\" \\ -d \'{ \"username\": \"your_email@example.com\", \"password\": \"your_password\" }\' ``` **Optional `client_uid` parameter:** To select credentials for a specific client (PA/PDP, Chorus Pro, signing certificates), add `client_uid`: ```bash curl -X POST https://factpulse.fr/api/token/ \\ -H \"Content-Type: application/json\" \\ -d \'{ \"username\": \"your_email@example.com\", \"password\": \"your_password\", \"client_uid\": \"550e8400-e29b-41d4-a716-446655440000\" }\' ``` The `client_uid` will be included in the JWT and allow the API to automatically use: - AFNOR/PDP credentials configured for this client - Chorus Pro credentials configured for this client - Electronic signature certificates configured for this client **Response:** ```json { \"access\": \"eyJ0eXAiOiJKV1QiLCJhbGc...\", // Access token (validity: 30 min) \"refresh\": \"eyJ0eXAiOiJKV1QiLCJhbGc...\" // Refresh token (validity: 7 days) } ``` **Advantages:** - ✅ Full automation (CI/CD, scripts) - ✅ Programmatic token management - ✅ Refresh token support for automatic access renewal - ✅ Easy integration in any language/tool #### 🖥️ Method 2: Dashboard Generation (Alternative) **URL:** https://factpulse.fr/api/dashboard/ This method is suitable for quick tests or occasional use via the graphical interface. **How it works:** - Log in to the dashboard - Use the \"Generate Test Token\" or \"Generate Production Token\" buttons - Works for **all** users (OAuth and email/password), without requiring a password **Token types:** - **Test Token**: 24h validity, 1000 calls/day quota (free) - **Production Token**: 7 days validity, quota based on your plan **Advantages:** - ✅ Quick for API testing - ✅ No password required - ✅ Simple visual interface **Disadvantages:** - ❌ Requires manual action - ❌ No refresh token - ❌ Less suited for automation ### 📚 Full Documentation For more information on authentication and API usage: https://factpulse.fr/documentation-api/
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: 1.0.0
|
|
8
|
+
* Contact: contact@factpulse.fr
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
|
|
15
|
+
|
|
16
|
+
// May contain unused imports in some cases
|
|
17
|
+
// @ts-ignore
|
|
18
|
+
import type { ActionCodeInfo } from './action-code-info';
|
|
19
|
+
|
|
20
|
+
/**
|
|
21
|
+
* Liste des codes action disponibles.
|
|
22
|
+
*/
|
|
23
|
+
export interface ActionCodesResponse {
|
|
24
|
+
/**
|
|
25
|
+
* Liste des codes action
|
|
26
|
+
*/
|
|
27
|
+
'codes': Array<ActionCodeInfo>;
|
|
28
|
+
/**
|
|
29
|
+
* Nombre de codes
|
|
30
|
+
*/
|
|
31
|
+
'count': number;
|
|
32
|
+
/**
|
|
33
|
+
* Règle source
|
|
34
|
+
*/
|
|
35
|
+
'source'?: string;
|
|
36
|
+
}
|
|
37
|
+
|