@factpulse/sdk 3.0.19 → 3.0.24
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 +6 -4
- package/CHANGELOG.md +3 -3
- package/dist/{models/facture-electronique-rest-api-schemas-ereporting-validation-error.d.ts → esm/models/ereporting-validation-error.d.ts} +2 -2
- 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/index.d.ts +3 -2
- package/dist/esm/models/index.js +3 -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/schematron-validation-error.d.ts +33 -0
- package/dist/esm/models/schematron-validation-error.js +14 -0
- package/dist/esm/models/simplified-invoice-data.d.ts +2 -2
- package/dist/esm/models/validate-ereporting-response.d.ts +3 -3
- package/dist/esm/models/validation-info.d.ts +2 -2
- package/dist/esm/src/helpers/client.d.ts +16 -3
- package/dist/esm/src/helpers/client.js +23 -6
- package/dist/{esm/models/facture-electronique-rest-api-schemas-ereporting-validation-error.d.ts → models/ereporting-validation-error.d.ts} +2 -2
- 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/index.d.ts +3 -2
- package/dist/models/index.js +3 -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/schematron-validation-error.d.ts +33 -0
- package/dist/models/schematron-validation-error.js +15 -0
- package/dist/models/simplified-invoice-data.d.ts +2 -2
- package/dist/models/validate-ereporting-response.d.ts +3 -3
- package/dist/models/validation-info.d.ts +2 -2
- package/dist/src/helpers/client.d.ts +16 -3
- package/dist/src/helpers/client.js +23 -6
- package/docs/{FactureElectroniqueRestApiSchemasEreportingValidationError.md → EReportingValidationError.md} +4 -4
- package/docs/FactureElectroniqueRestApiSchemasEreportingInvoiceTypeCode.md +17 -0
- package/docs/InvoiceInput.md +1 -1
- package/docs/InvoiceTypeCode.md +28 -6
- package/docs/SchematronValidationError.md +35 -0
- package/docs/SimplifiedInvoiceData.md +1 -1
- package/docs/ValidateEReportingResponse.md +2 -2
- package/docs/ValidationInfo.md +1 -1
- package/models/{facture-electronique-rest-api-schemas-ereporting-validation-error.ts → ereporting-validation-error.ts} +2 -2
- package/models/facture-electronique-rest-api-schemas-ereporting-invoice-type-code.ts +32 -0
- package/models/index.ts +3 -2
- package/models/invoice-input.ts +2 -2
- package/models/invoice-type-code.ts +65 -6
- package/models/schematron-validation-error.ts +39 -0
- package/models/simplified-invoice-data.ts +2 -2
- package/models/validate-ereporting-response.ts +3 -3
- package/models/validation-info.ts +2 -2
- package/package.json +1 -1
- package/src/helpers/client.ts +25 -6
- 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/models/facture-electronique-models-invoice-type-code.ts +0 -91
- /package/dist/esm/models/{facture-electronique-rest-api-schemas-ereporting-validation-error.js → ereporting-validation-error.js} +0 -0
- /package/dist/models/{facture-electronique-rest-api-schemas-ereporting-validation-error.js → ereporting-validation-error.js} +0 -0
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/* tslint:disable */
|
|
3
|
+
/* eslint-disable */
|
|
4
|
+
/**
|
|
5
|
+
* FactPulse REST API
|
|
6
|
+
* 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/
|
|
7
|
+
*
|
|
8
|
+
* The version of the OpenAPI document: 1.0.0
|
|
9
|
+
* Contact: contact@factpulse.fr
|
|
10
|
+
*
|
|
11
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
12
|
+
* https://openapi-generator.tech
|
|
13
|
+
* Do not edit the class manually.
|
|
14
|
+
*/
|
|
15
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
16
|
+
exports.FactureElectroniqueRestApiSchemasEreportingInvoiceTypeCode = void 0;
|
|
17
|
+
/**
|
|
18
|
+
* Invoice type codes (UNTDID 1001).
|
|
19
|
+
*/
|
|
20
|
+
exports.FactureElectroniqueRestApiSchemasEreportingInvoiceTypeCode = {
|
|
21
|
+
_380: '380',
|
|
22
|
+
_381: '381',
|
|
23
|
+
_384: '384',
|
|
24
|
+
_389: '389',
|
|
25
|
+
_386: '386'
|
|
26
|
+
};
|
package/dist/models/index.d.ts
CHANGED
|
@@ -132,6 +132,7 @@ export * from './directory-line-include';
|
|
|
132
132
|
export * from './doc-type';
|
|
133
133
|
export * from './document-type-info';
|
|
134
134
|
export * from './ereporting-flow-type';
|
|
135
|
+
export * from './ereporting-validation-error';
|
|
135
136
|
export * from './electronic-address';
|
|
136
137
|
export * from './enriched-invoice-info';
|
|
137
138
|
export * from './error-level';
|
|
@@ -139,8 +140,7 @@ export * from './error-source';
|
|
|
139
140
|
export * from './extraction-info';
|
|
140
141
|
export * from './factur-xinvoice';
|
|
141
142
|
export * from './factur-xpdfinfo';
|
|
142
|
-
export * from './facture-electronique-
|
|
143
|
-
export * from './facture-electronique-rest-api-schemas-ereporting-validation-error';
|
|
143
|
+
export * from './facture-electronique-rest-api-schemas-ereporting-invoice-type-code';
|
|
144
144
|
export * from './facture-electronique-rest-api-schemas-processing-chorus-pro-credentials';
|
|
145
145
|
export * from './field-status';
|
|
146
146
|
export * from './file-info';
|
|
@@ -212,6 +212,7 @@ export * from './report-period';
|
|
|
212
212
|
export * from './report-sender';
|
|
213
213
|
export * from './rounding-amount';
|
|
214
214
|
export * from './routing-code-include';
|
|
215
|
+
export * from './schematron-validation-error';
|
|
215
216
|
export * from './scheme-id';
|
|
216
217
|
export * from './search-flow-request';
|
|
217
218
|
export * from './search-flow-response';
|
package/dist/models/index.js
CHANGED
|
@@ -148,6 +148,7 @@ __exportStar(require("./directory-line-include"), exports);
|
|
|
148
148
|
__exportStar(require("./doc-type"), exports);
|
|
149
149
|
__exportStar(require("./document-type-info"), exports);
|
|
150
150
|
__exportStar(require("./ereporting-flow-type"), exports);
|
|
151
|
+
__exportStar(require("./ereporting-validation-error"), exports);
|
|
151
152
|
__exportStar(require("./electronic-address"), exports);
|
|
152
153
|
__exportStar(require("./enriched-invoice-info"), exports);
|
|
153
154
|
__exportStar(require("./error-level"), exports);
|
|
@@ -155,8 +156,7 @@ __exportStar(require("./error-source"), exports);
|
|
|
155
156
|
__exportStar(require("./extraction-info"), exports);
|
|
156
157
|
__exportStar(require("./factur-xinvoice"), exports);
|
|
157
158
|
__exportStar(require("./factur-xpdfinfo"), exports);
|
|
158
|
-
__exportStar(require("./facture-electronique-
|
|
159
|
-
__exportStar(require("./facture-electronique-rest-api-schemas-ereporting-validation-error"), exports);
|
|
159
|
+
__exportStar(require("./facture-electronique-rest-api-schemas-ereporting-invoice-type-code"), exports);
|
|
160
160
|
__exportStar(require("./facture-electronique-rest-api-schemas-processing-chorus-pro-credentials"), exports);
|
|
161
161
|
__exportStar(require("./field-status"), exports);
|
|
162
162
|
__exportStar(require("./file-info"), exports);
|
|
@@ -228,6 +228,7 @@ __exportStar(require("./report-period"), exports);
|
|
|
228
228
|
__exportStar(require("./report-sender"), exports);
|
|
229
229
|
__exportStar(require("./rounding-amount"), exports);
|
|
230
230
|
__exportStar(require("./routing-code-include"), exports);
|
|
231
|
+
__exportStar(require("./schematron-validation-error"), exports);
|
|
231
232
|
__exportStar(require("./scheme-id"), exports);
|
|
232
233
|
__exportStar(require("./search-flow-request"), exports);
|
|
233
234
|
__exportStar(require("./search-flow-response"), exports);
|
|
@@ -11,7 +11,7 @@
|
|
|
11
11
|
*/
|
|
12
12
|
import type { Buyercountry } from './buyercountry';
|
|
13
13
|
import type { Currency } from './currency';
|
|
14
|
-
import type {
|
|
14
|
+
import type { FactureElectroniqueRestApiSchemasEreportingInvoiceTypeCode } from './facture-electronique-rest-api-schemas-ereporting-invoice-type-code';
|
|
15
15
|
import type { Sellercountry } from './sellercountry';
|
|
16
16
|
import type { TaxBreakdownInput } from './tax-breakdown-input';
|
|
17
17
|
import type { Taxamount1 } from './taxamount1';
|
|
@@ -31,7 +31,7 @@ export interface InvoiceInput {
|
|
|
31
31
|
/**
|
|
32
32
|
* Invoice type code
|
|
33
33
|
*/
|
|
34
|
-
'typeCode'?:
|
|
34
|
+
'typeCode'?: FactureElectroniqueRestApiSchemasEreportingInvoiceTypeCode;
|
|
35
35
|
'currency'?: Currency;
|
|
36
36
|
'dueDate'?: string | null;
|
|
37
37
|
/**
|
|
@@ -10,13 +10,72 @@
|
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
12
|
/**
|
|
13
|
-
*
|
|
13
|
+
* 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 |
|
|
14
14
|
*/
|
|
15
15
|
export declare const InvoiceTypeCode: {
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
readonly
|
|
20
|
-
|
|
16
|
+
/**
|
|
17
|
+
* Commercial Invoice
|
|
18
|
+
*/
|
|
19
|
+
readonly INVOICE: "380";
|
|
20
|
+
/**
|
|
21
|
+
* Self-billed Invoice
|
|
22
|
+
*/
|
|
23
|
+
readonly SELF_BILLED_INVOICE: "389";
|
|
24
|
+
/**
|
|
25
|
+
* Factored Invoice
|
|
26
|
+
*/
|
|
27
|
+
readonly FACTORED_INVOICE: "393";
|
|
28
|
+
/**
|
|
29
|
+
* Self-billed Factored Invoice
|
|
30
|
+
*/
|
|
31
|
+
readonly SELF_BILLED_FACTORED_INVOICE: "501";
|
|
32
|
+
/**
|
|
33
|
+
* Prepayment Invoice
|
|
34
|
+
*/
|
|
35
|
+
readonly PREPAYMENT_INVOICE: "386";
|
|
36
|
+
/**
|
|
37
|
+
* Self-billed Prepayment Invoice
|
|
38
|
+
*/
|
|
39
|
+
readonly SELF_BILLED_PREPAYMENT_INVOICE: "500";
|
|
40
|
+
/**
|
|
41
|
+
* Corrective Invoice
|
|
42
|
+
*/
|
|
43
|
+
readonly CORRECTIVE_INVOICE: "384";
|
|
44
|
+
/**
|
|
45
|
+
* Self-billed Corrective Invoice
|
|
46
|
+
*/
|
|
47
|
+
readonly SELF_BILLED_CORRECTIVE_INVOICE: "471";
|
|
48
|
+
/**
|
|
49
|
+
* Factored Corrective Invoice
|
|
50
|
+
*/
|
|
51
|
+
readonly FACTORED_CORRECTIVE_INVOICE: "472";
|
|
52
|
+
/**
|
|
53
|
+
* Self-billed Factored Corrective Invoice
|
|
54
|
+
*/
|
|
55
|
+
readonly SELF_BILLED_FACTORED_CORRECTIVE_INVOICE: "473";
|
|
56
|
+
/**
|
|
57
|
+
* Credit Note
|
|
58
|
+
*/
|
|
59
|
+
readonly CREDIT_NOTE: "381";
|
|
60
|
+
/**
|
|
61
|
+
* Self-billed Credit Note
|
|
62
|
+
*/
|
|
63
|
+
readonly SELF_BILLED_CREDIT_NOTE: "261";
|
|
64
|
+
/**
|
|
65
|
+
* Global Allowance Credit Note
|
|
66
|
+
*/
|
|
67
|
+
readonly GLOBAL_ALLOWANCE_CREDIT_NOTE: "262";
|
|
68
|
+
/**
|
|
69
|
+
* Factored Credit Note
|
|
70
|
+
*/
|
|
71
|
+
readonly FACTORED_CREDIT_NOTE: "396";
|
|
72
|
+
/**
|
|
73
|
+
* Self-billed Factored Credit Note
|
|
74
|
+
*/
|
|
75
|
+
readonly SELF_BILLED_FACTORED_CREDIT_NOTE: "502";
|
|
76
|
+
/**
|
|
77
|
+
* Prepayment Credit Note
|
|
78
|
+
*/
|
|
79
|
+
readonly PREPAYMENT_CREDIT_NOTE: "503";
|
|
21
80
|
};
|
|
22
81
|
export type InvoiceTypeCode = typeof InvoiceTypeCode[keyof typeof InvoiceTypeCode];
|
|
@@ -15,12 +15,71 @@
|
|
|
15
15
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
16
16
|
exports.InvoiceTypeCode = void 0;
|
|
17
17
|
/**
|
|
18
|
-
*
|
|
18
|
+
* 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 |
|
|
19
19
|
*/
|
|
20
20
|
exports.InvoiceTypeCode = {
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
21
|
+
/**
|
|
22
|
+
* Commercial Invoice
|
|
23
|
+
*/
|
|
24
|
+
INVOICE: '380',
|
|
25
|
+
/**
|
|
26
|
+
* Self-billed Invoice
|
|
27
|
+
*/
|
|
28
|
+
SELF_BILLED_INVOICE: '389',
|
|
29
|
+
/**
|
|
30
|
+
* Factored Invoice
|
|
31
|
+
*/
|
|
32
|
+
FACTORED_INVOICE: '393',
|
|
33
|
+
/**
|
|
34
|
+
* Self-billed Factored Invoice
|
|
35
|
+
*/
|
|
36
|
+
SELF_BILLED_FACTORED_INVOICE: '501',
|
|
37
|
+
/**
|
|
38
|
+
* Prepayment Invoice
|
|
39
|
+
*/
|
|
40
|
+
PREPAYMENT_INVOICE: '386',
|
|
41
|
+
/**
|
|
42
|
+
* Self-billed Prepayment Invoice
|
|
43
|
+
*/
|
|
44
|
+
SELF_BILLED_PREPAYMENT_INVOICE: '500',
|
|
45
|
+
/**
|
|
46
|
+
* Corrective Invoice
|
|
47
|
+
*/
|
|
48
|
+
CORRECTIVE_INVOICE: '384',
|
|
49
|
+
/**
|
|
50
|
+
* Self-billed Corrective Invoice
|
|
51
|
+
*/
|
|
52
|
+
SELF_BILLED_CORRECTIVE_INVOICE: '471',
|
|
53
|
+
/**
|
|
54
|
+
* Factored Corrective Invoice
|
|
55
|
+
*/
|
|
56
|
+
FACTORED_CORRECTIVE_INVOICE: '472',
|
|
57
|
+
/**
|
|
58
|
+
* Self-billed Factored Corrective Invoice
|
|
59
|
+
*/
|
|
60
|
+
SELF_BILLED_FACTORED_CORRECTIVE_INVOICE: '473',
|
|
61
|
+
/**
|
|
62
|
+
* Credit Note
|
|
63
|
+
*/
|
|
64
|
+
CREDIT_NOTE: '381',
|
|
65
|
+
/**
|
|
66
|
+
* Self-billed Credit Note
|
|
67
|
+
*/
|
|
68
|
+
SELF_BILLED_CREDIT_NOTE: '261',
|
|
69
|
+
/**
|
|
70
|
+
* Global Allowance Credit Note
|
|
71
|
+
*/
|
|
72
|
+
GLOBAL_ALLOWANCE_CREDIT_NOTE: '262',
|
|
73
|
+
/**
|
|
74
|
+
* Factored Credit Note
|
|
75
|
+
*/
|
|
76
|
+
FACTORED_CREDIT_NOTE: '396',
|
|
77
|
+
/**
|
|
78
|
+
* Self-billed Factored Credit Note
|
|
79
|
+
*/
|
|
80
|
+
SELF_BILLED_FACTORED_CREDIT_NOTE: '502',
|
|
81
|
+
/**
|
|
82
|
+
* Prepayment Credit Note
|
|
83
|
+
*/
|
|
84
|
+
PREPAYMENT_CREDIT_NOTE: '503'
|
|
26
85
|
};
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* FactPulse REST API
|
|
3
|
+
* 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/
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 1.0.0
|
|
6
|
+
* Contact: contact@factpulse.fr
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
/**
|
|
13
|
+
* Erreur de validation Schematron avec suggestion de correction.
|
|
14
|
+
*/
|
|
15
|
+
export interface SchematronValidationError {
|
|
16
|
+
/**
|
|
17
|
+
* Code de la regle (BR-XX, BR-FR-XX)
|
|
18
|
+
*/
|
|
19
|
+
'rule': string;
|
|
20
|
+
'bt_code'?: string | null;
|
|
21
|
+
/**
|
|
22
|
+
* Gravite: error, warning
|
|
23
|
+
*/
|
|
24
|
+
'severity': string;
|
|
25
|
+
/**
|
|
26
|
+
* Message d\'erreur
|
|
27
|
+
*/
|
|
28
|
+
'message': string;
|
|
29
|
+
'suggested_value'?: string | null;
|
|
30
|
+
'suggested_field'?: string | null;
|
|
31
|
+
'explanation'?: string | null;
|
|
32
|
+
'confidence'?: number | null;
|
|
33
|
+
}
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/* tslint:disable */
|
|
3
|
+
/* eslint-disable */
|
|
4
|
+
/**
|
|
5
|
+
* FactPulse REST API
|
|
6
|
+
* 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/
|
|
7
|
+
*
|
|
8
|
+
* The version of the OpenAPI document: 1.0.0
|
|
9
|
+
* Contact: contact@factpulse.fr
|
|
10
|
+
*
|
|
11
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
12
|
+
* https://openapi-generator.tech
|
|
13
|
+
* Do not edit the class manually.
|
|
14
|
+
*/
|
|
15
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
@@ -9,7 +9,7 @@
|
|
|
9
9
|
* https://openapi-generator.tech
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
|
-
import type {
|
|
12
|
+
import type { InvoiceTypeCode } from './invoice-type-code';
|
|
13
13
|
import type { InvoicingFrameworkCode } from './invoicing-framework-code';
|
|
14
14
|
import type { OperationNature } from './operation-nature';
|
|
15
15
|
/**
|
|
@@ -49,7 +49,7 @@ export interface SimplifiedInvoiceData {
|
|
|
49
49
|
/**
|
|
50
50
|
* Document type (UNTDID 1001). Default: 380 (Invoice).
|
|
51
51
|
*/
|
|
52
|
-
'invoiceType'?:
|
|
52
|
+
'invoiceType'?: InvoiceTypeCode;
|
|
53
53
|
'precedingInvoiceReference'?: string | null;
|
|
54
54
|
'operationNature'?: OperationNature | null;
|
|
55
55
|
'invoicingFramework'?: InvoicingFrameworkCode | null;
|
|
@@ -9,7 +9,7 @@
|
|
|
9
9
|
* https://openapi-generator.tech
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
|
-
import type {
|
|
12
|
+
import type { EReportingValidationError } from './ereporting-validation-error';
|
|
13
13
|
/**
|
|
14
14
|
* Response after validating e-reporting data.
|
|
15
15
|
*/
|
|
@@ -29,11 +29,11 @@ export interface ValidateEReportingResponse {
|
|
|
29
29
|
/**
|
|
30
30
|
* List of validation errors (if any)
|
|
31
31
|
*/
|
|
32
|
-
'errors'?: Array<
|
|
32
|
+
'errors'?: Array<EReportingValidationError>;
|
|
33
33
|
/**
|
|
34
34
|
* List of validation warnings (if any)
|
|
35
35
|
*/
|
|
36
|
-
'warnings'?: Array<
|
|
36
|
+
'warnings'?: Array<EReportingValidationError>;
|
|
37
37
|
/**
|
|
38
38
|
* Status message
|
|
39
39
|
*/
|
|
@@ -9,7 +9,7 @@
|
|
|
9
9
|
* https://openapi-generator.tech
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
|
-
import type {
|
|
12
|
+
import type { SchematronValidationError } from './schematron-validation-error';
|
|
13
13
|
/**
|
|
14
14
|
* Informations sur la validation.
|
|
15
15
|
*/
|
|
@@ -34,5 +34,5 @@ export interface ValidationInfo {
|
|
|
34
34
|
* XML embarque dans PDF
|
|
35
35
|
*/
|
|
36
36
|
'xml_embedded'?: boolean;
|
|
37
|
-
'errors'?: Array<
|
|
37
|
+
'errors'?: Array<SchematronValidationError>;
|
|
38
38
|
}
|
|
@@ -147,9 +147,22 @@ export declare class FactPulseClient {
|
|
|
147
147
|
* IMPORTANT: This method uses the AFNOR OAuth token, NOT the FactPulse JWT!
|
|
148
148
|
*/
|
|
149
149
|
private makeAfnorRequest;
|
|
150
|
-
|
|
151
|
-
|
|
152
|
-
|
|
150
|
+
/** Gets a facility by SIRET in the AFNOR directory. */
|
|
151
|
+
getSiretAfnor(siret: string): Promise<Record<string, unknown>>;
|
|
152
|
+
/** Gets a legal unit by SIREN in the AFNOR directory. */
|
|
153
|
+
getSirenAfnor(siren: string): Promise<Record<string, unknown>>;
|
|
154
|
+
/** Searches for legal units (SIREN) in the AFNOR directory. */
|
|
155
|
+
searchSirenAfnor(options?: {
|
|
156
|
+
filters?: Record<string, unknown>;
|
|
157
|
+
limit?: number;
|
|
158
|
+
}): Promise<Record<string, unknown>>;
|
|
159
|
+
/** Searches for routing codes in the AFNOR directory. */
|
|
160
|
+
searchRoutingCodesAfnor(options?: {
|
|
161
|
+
filters?: Record<string, unknown>;
|
|
162
|
+
limit?: number;
|
|
163
|
+
}): Promise<Record<string, unknown>>;
|
|
164
|
+
/** Gets a routing code by SIRET and routing identifier. */
|
|
165
|
+
getRoutingCodeAfnor(siret: string, routingIdentifier: string): Promise<Record<string, unknown>>;
|
|
153
166
|
/**
|
|
154
167
|
* Submits an invoice to a PDP via the AFNOR API.
|
|
155
168
|
* Authentication uses the AFNOR OAuth token (obtained automatically),
|
|
@@ -551,19 +551,36 @@ class FactPulseClient {
|
|
|
551
551
|
});
|
|
552
552
|
}
|
|
553
553
|
// ==================== AFNOR Directory ====================
|
|
554
|
-
|
|
554
|
+
/** Gets a facility by SIRET in the AFNOR directory. */
|
|
555
|
+
getSiretAfnor(siret) {
|
|
555
556
|
return __awaiter(this, void 0, void 0, function* () {
|
|
556
|
-
return this.makeAfnorRequest('GET', `/directory/siret
|
|
557
|
+
return this.makeAfnorRequest('GET', `/directory/v1/siret/code-insee:${siret}`);
|
|
557
558
|
});
|
|
558
559
|
}
|
|
559
|
-
|
|
560
|
+
/** Gets a legal unit by SIREN in the AFNOR directory. */
|
|
561
|
+
getSirenAfnor(siren) {
|
|
560
562
|
return __awaiter(this, void 0, void 0, function* () {
|
|
561
|
-
return this.makeAfnorRequest('GET', `/directory/siren
|
|
563
|
+
return this.makeAfnorRequest('GET', `/directory/v1/siren/code-insee:${siren}`);
|
|
562
564
|
});
|
|
563
565
|
}
|
|
564
|
-
|
|
566
|
+
/** Searches for legal units (SIREN) in the AFNOR directory. */
|
|
567
|
+
searchSirenAfnor() {
|
|
568
|
+
return __awaiter(this, arguments, void 0, function* (options = {}) {
|
|
569
|
+
const { filters = {}, limit = 25 } = options;
|
|
570
|
+
return this.makeAfnorRequest('POST', '/directory/v1/siren/search', { data: { filters, limit } });
|
|
571
|
+
});
|
|
572
|
+
}
|
|
573
|
+
/** Searches for routing codes in the AFNOR directory. */
|
|
574
|
+
searchRoutingCodesAfnor() {
|
|
575
|
+
return __awaiter(this, arguments, void 0, function* (options = {}) {
|
|
576
|
+
const { filters = {}, limit = 25 } = options;
|
|
577
|
+
return this.makeAfnorRequest('POST', '/directory/v1/routing-code/search', { data: { filters, limit } });
|
|
578
|
+
});
|
|
579
|
+
}
|
|
580
|
+
/** Gets a routing code by SIRET and routing identifier. */
|
|
581
|
+
getRoutingCodeAfnor(siret, routingIdentifier) {
|
|
565
582
|
return __awaiter(this, void 0, void 0, function* () {
|
|
566
|
-
return this.makeAfnorRequest('GET', `/directory/
|
|
583
|
+
return this.makeAfnorRequest('GET', `/directory/v1/routing-code/siret:${siret}/code:${routingIdentifier}`);
|
|
567
584
|
});
|
|
568
585
|
}
|
|
569
586
|
// ==================== AFNOR Flow ====================
|
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
#
|
|
1
|
+
# EReportingValidationError
|
|
2
2
|
|
|
3
|
-
Validation error detail.
|
|
3
|
+
Validation error detail for E-Reporting.
|
|
4
4
|
|
|
5
5
|
## Properties
|
|
6
6
|
|
|
@@ -13,9 +13,9 @@ Name | Type | Description | Notes
|
|
|
13
13
|
## Example
|
|
14
14
|
|
|
15
15
|
```typescript
|
|
16
|
-
import {
|
|
16
|
+
import { EReportingValidationError } from '@factpulse/sdk';
|
|
17
17
|
|
|
18
|
-
const instance:
|
|
18
|
+
const instance: EReportingValidationError = {
|
|
19
19
|
field,
|
|
20
20
|
message,
|
|
21
21
|
code,
|
|
@@ -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)
|
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,35 @@
|
|
|
1
|
+
# SchematronValidationError
|
|
2
|
+
|
|
3
|
+
Erreur de validation Schematron avec suggestion de correction.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**rule** | **string** | Code de la regle (BR-XX, BR-FR-XX) | [default to undefined]
|
|
10
|
+
**bt_code** | **string** | | [optional] [default to undefined]
|
|
11
|
+
**severity** | **string** | Gravite: error, warning | [default to undefined]
|
|
12
|
+
**message** | **string** | Message d\'erreur | [default to undefined]
|
|
13
|
+
**suggested_value** | **string** | | [optional] [default to undefined]
|
|
14
|
+
**suggested_field** | **string** | | [optional] [default to undefined]
|
|
15
|
+
**explanation** | **string** | | [optional] [default to undefined]
|
|
16
|
+
**confidence** | **number** | | [optional] [default to undefined]
|
|
17
|
+
|
|
18
|
+
## Example
|
|
19
|
+
|
|
20
|
+
```typescript
|
|
21
|
+
import { SchematronValidationError } from '@factpulse/sdk';
|
|
22
|
+
|
|
23
|
+
const instance: SchematronValidationError = {
|
|
24
|
+
rule,
|
|
25
|
+
bt_code,
|
|
26
|
+
severity,
|
|
27
|
+
message,
|
|
28
|
+
suggested_value,
|
|
29
|
+
suggested_field,
|
|
30
|
+
explanation,
|
|
31
|
+
confidence,
|
|
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)
|
|
@@ -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]
|
|
@@ -9,8 +9,8 @@ Name | Type | Description | Notes
|
|
|
9
9
|
**valid** | **boolean** | Whether the data is valid | [default to undefined]
|
|
10
10
|
**reportId** | **string** | Report identifier | [default to undefined]
|
|
11
11
|
**flowType** | **string** | Flux type | [default to undefined]
|
|
12
|
-
**errors** | [**Array<
|
|
13
|
-
**warnings** | [**Array<
|
|
12
|
+
**errors** | [**Array<EReportingValidationError>**](EReportingValidationError.md) | List of validation errors (if any) | [optional] [default to undefined]
|
|
13
|
+
**warnings** | [**Array<EReportingValidationError>**](EReportingValidationError.md) | List of validation warnings (if any) | [optional] [default to undefined]
|
|
14
14
|
**message** | **string** | Status message | [default to undefined]
|
|
15
15
|
|
|
16
16
|
## Example
|
package/docs/ValidationInfo.md
CHANGED
|
@@ -11,7 +11,7 @@ Name | Type | Description | Notes
|
|
|
11
11
|
**schematron_rules_total** | **number** | Total regles | [default to undefined]
|
|
12
12
|
**pdfa_compliant** | **boolean** | PDF/A-3 conforme | [optional] [default to true]
|
|
13
13
|
**xml_embedded** | **boolean** | XML embarque dans PDF | [optional] [default to true]
|
|
14
|
-
**errors** | [**Array<
|
|
14
|
+
**errors** | [**Array<SchematronValidationError>**](SchematronValidationError.md) | | [optional] [default to undefined]
|
|
15
15
|
|
|
16
16
|
## Example
|
|
17
17
|
|
|
@@ -15,9 +15,9 @@
|
|
|
15
15
|
|
|
16
16
|
|
|
17
17
|
/**
|
|
18
|
-
* Validation error detail.
|
|
18
|
+
* Validation error detail for E-Reporting.
|
|
19
19
|
*/
|
|
20
|
-
export interface
|
|
20
|
+
export interface EReportingValidationError {
|
|
21
21
|
/**
|
|
22
22
|
* Field path with error
|
|
23
23
|
*/
|