@beliq/sdk 0.2.0 → 0.3.0
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/README.md +30 -0
- package/dist/constants-BZuNzqbV.d.cts +85 -0
- package/dist/constants-BZuNzqbV.d.ts +85 -0
- package/dist/helpers.cjs +19 -0
- package/dist/helpers.d.cts +2 -2
- package/dist/helpers.d.ts +2 -2
- package/dist/helpers.js +16 -0
- package/dist/index.cjs +80 -11
- package/dist/index.d.cts +642 -27
- package/dist/index.d.ts +642 -27
- package/dist/index.js +74 -10
- package/package.json +11 -6
- package/dist/constants-D3j_o7th.d.cts +0 -40
- package/dist/constants-D3j_o7th.d.ts +0 -40
package/dist/index.d.ts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
import { P as PlainObject, a as DocumentInput } from './constants-
|
|
2
|
-
export { D as DEFAULT_BASE_URL, G as GeneratePreset, L as LIVE_CONVERT_SOURCE_FORMATS, b as LIVE_CONVERT_TARGET_FORMATS, c as LIVE_GENERATE_PRESETS, d as LIVE_GENERATE_STANDARDS, e as LIVE_PARSE_FORMATS, f as LIVE_PROFILES, g as LIVE_VALIDATE_FORMATS } from './constants-
|
|
1
|
+
import { P as PlainObject, a as DocumentInput } from './constants-BZuNzqbV.js';
|
|
2
|
+
export { D as DEFAULT_BASE_URL, n as DEFAULT_MAX_RETRIES, o as DEFAULT_TIMEOUT_MS, G as GeneratePreset, L as LIVE_CONVERT_SOURCE_FORMATS, b as LIVE_CONVERT_TARGET_FORMATS, c as LIVE_GENERATE_PRESETS, d as LIVE_GENERATE_STANDARDS, e as LIVE_PARSE_FORMATS, f as LIVE_PROFILES, g as LIVE_PROFILES_BY_STANDARD, h as LIVE_VALIDATE_FORMATS, l as isProfileAllowedForStandard, p as profilesForStandard } from './constants-BZuNzqbV.js';
|
|
3
3
|
|
|
4
4
|
interface components {
|
|
5
5
|
schemas: {
|
|
@@ -35,6 +35,10 @@ interface operations {
|
|
|
35
35
|
/** @description Default Response */
|
|
36
36
|
200: {
|
|
37
37
|
headers: {
|
|
38
|
+
/** @description "true" for a live key, "false" for a test key. Test-mode documents are watermarked and do not draw on the live monthly quota. */
|
|
39
|
+
"x-beliq-livemode"?: string;
|
|
40
|
+
/** @description Correlation id for this request. Quote it in a support request; it is the key the API, the engine, and error tracking all record. */
|
|
41
|
+
"x-request-id"?: string;
|
|
38
42
|
[name: string]: unknown;
|
|
39
43
|
};
|
|
40
44
|
content: {
|
|
@@ -43,25 +47,30 @@ interface operations {
|
|
|
43
47
|
data?: {
|
|
44
48
|
keyId: string | null;
|
|
45
49
|
keyPrefix: string | null;
|
|
50
|
+
/** @description False for a blq_test_ key, true otherwise. Selects which allowance the quota block below describes: a live key spends the plan quota over a window anchored on the organization billing day, a test key the flat sandbox allowance over the UTC calendar month. Mirrors the x-beliq-livemode response header, for callers that only see a parsed body. */
|
|
51
|
+
livemode: boolean;
|
|
46
52
|
org: {
|
|
47
53
|
id: string;
|
|
48
54
|
name: string;
|
|
49
55
|
rulesetChannel: "latest" | "previous";
|
|
50
56
|
};
|
|
51
57
|
plan: {
|
|
58
|
+
/** @description The subscription_plans row the organization references, or null when it references none, which is every organization on the free tier. */
|
|
52
59
|
id: number | null;
|
|
53
|
-
|
|
60
|
+
/** @description Never null. An organization that references no plan row is on the free tier and reads back under the free tier name. */
|
|
61
|
+
name: string;
|
|
54
62
|
};
|
|
55
63
|
rateLimitPerMinute: number;
|
|
56
64
|
quota: {
|
|
57
65
|
limit: number;
|
|
58
66
|
used: number;
|
|
59
67
|
remaining: number;
|
|
68
|
+
/** @description ISO 8601 UTC. The end of the window limit and used were counted over. On a live key that window is one month anchored on the organization billing day, so only an organization billed on the 1st resets at the turn of the month; on a test key it is the turn of the UTC month. */
|
|
60
69
|
resetsAt: string;
|
|
61
70
|
};
|
|
62
71
|
};
|
|
63
72
|
error?: {
|
|
64
|
-
code: "VALIDATION_ERROR" | "INVALID_INVOICE" | "
|
|
73
|
+
code: "VALIDATION_ERROR" | "INVALID_INVOICE" | "PROFILE_STANDARD_MISMATCH" | "DOCUMENT_TYPE_STANDARD_MISMATCH" | "PARSE_FAILED" | "AUTHENTICATION_REQUIRED" | "INVALID_API_KEY" | "QUOTA_EXCEEDED" | "RATE_LIMITED" | "ACCOUNT_THROTTLED" | "ENGINE_UNAVAILABLE" | "INTERNAL_ERROR" | "NOT_FOUND" | "CONVERSION_UNSUPPORTED_PAIR" | "CONVERSION_LOSSY_FAILCLOSED" | "CONVERSION_TOOL_UNAVAILABLE" | "CONVERSION_TOOL_ERROR" | "PDF_TEMPLATE_AUTH_REQUIRED" | "PDF_TEMPLATE_NOT_FOUND" | "PDF_TEMPLATE_INVALID" | "TRANSMISSION_DISABLED" | "TRANSMISSION_NO_PROVIDER" | "IDEMPOTENCY_KEY_REUSED" | "INVALID_IDEMPOTENCY_KEY" | "SENDER_NOT_REGISTERED" | "CONTENT_ALREADY_SENT" | "INBOX_UNKNOWN_PROVIDER" | "INBOX_VERIFICATION_FAILED" | "INBOX_SIGNATURE_EXPIRED" | "RECIPIENT_NOT_ROUTABLE" | "SENDER_COUNTRY_MISSING" | "DOCUMENT_PARTY_MISMATCH" | "FRENCH_DOMESTIC_FLOW" | "UNSUPPORTED_SYNTAX" | "MALFORMED_DOCUMENT" | "EMPTY_DOCUMENT" | "MISSING_CUSTOMIZATION_ID" | "MISSING_PROCESS_ID";
|
|
65
74
|
message: string;
|
|
66
75
|
details?: {
|
|
67
76
|
[key: string]: unknown;
|
|
@@ -82,7 +91,7 @@ interface operations {
|
|
|
82
91
|
/** @enum {boolean} */
|
|
83
92
|
success: false;
|
|
84
93
|
error: {
|
|
85
|
-
code: "VALIDATION_ERROR" | "INVALID_INVOICE" | "
|
|
94
|
+
code: "VALIDATION_ERROR" | "INVALID_INVOICE" | "PROFILE_STANDARD_MISMATCH" | "DOCUMENT_TYPE_STANDARD_MISMATCH" | "PARSE_FAILED" | "AUTHENTICATION_REQUIRED" | "INVALID_API_KEY" | "QUOTA_EXCEEDED" | "RATE_LIMITED" | "ACCOUNT_THROTTLED" | "ENGINE_UNAVAILABLE" | "INTERNAL_ERROR" | "NOT_FOUND" | "CONVERSION_UNSUPPORTED_PAIR" | "CONVERSION_LOSSY_FAILCLOSED" | "CONVERSION_TOOL_UNAVAILABLE" | "CONVERSION_TOOL_ERROR" | "PDF_TEMPLATE_AUTH_REQUIRED" | "PDF_TEMPLATE_NOT_FOUND" | "PDF_TEMPLATE_INVALID" | "TRANSMISSION_DISABLED" | "TRANSMISSION_NO_PROVIDER" | "IDEMPOTENCY_KEY_REUSED" | "INVALID_IDEMPOTENCY_KEY" | "SENDER_NOT_REGISTERED" | "CONTENT_ALREADY_SENT" | "INBOX_UNKNOWN_PROVIDER" | "INBOX_VERIFICATION_FAILED" | "INBOX_SIGNATURE_EXPIRED" | "RECIPIENT_NOT_ROUTABLE" | "SENDER_COUNTRY_MISSING" | "DOCUMENT_PARTY_MISMATCH" | "FRENCH_DOMESTIC_FLOW" | "UNSUPPORTED_SYNTAX" | "MALFORMED_DOCUMENT" | "EMPTY_DOCUMENT" | "MISSING_CUSTOMIZATION_ID" | "MISSING_PROCESS_ID";
|
|
86
95
|
message: string;
|
|
87
96
|
details?: {
|
|
88
97
|
[key: string]: unknown;
|
|
@@ -103,7 +112,28 @@ interface operations {
|
|
|
103
112
|
/** @enum {boolean} */
|
|
104
113
|
success: false;
|
|
105
114
|
error: {
|
|
106
|
-
code: "VALIDATION_ERROR" | "INVALID_INVOICE" | "
|
|
115
|
+
code: "VALIDATION_ERROR" | "INVALID_INVOICE" | "PROFILE_STANDARD_MISMATCH" | "DOCUMENT_TYPE_STANDARD_MISMATCH" | "PARSE_FAILED" | "AUTHENTICATION_REQUIRED" | "INVALID_API_KEY" | "QUOTA_EXCEEDED" | "RATE_LIMITED" | "ACCOUNT_THROTTLED" | "ENGINE_UNAVAILABLE" | "INTERNAL_ERROR" | "NOT_FOUND" | "CONVERSION_UNSUPPORTED_PAIR" | "CONVERSION_LOSSY_FAILCLOSED" | "CONVERSION_TOOL_UNAVAILABLE" | "CONVERSION_TOOL_ERROR" | "PDF_TEMPLATE_AUTH_REQUIRED" | "PDF_TEMPLATE_NOT_FOUND" | "PDF_TEMPLATE_INVALID" | "TRANSMISSION_DISABLED" | "TRANSMISSION_NO_PROVIDER" | "IDEMPOTENCY_KEY_REUSED" | "INVALID_IDEMPOTENCY_KEY" | "SENDER_NOT_REGISTERED" | "CONTENT_ALREADY_SENT" | "INBOX_UNKNOWN_PROVIDER" | "INBOX_VERIFICATION_FAILED" | "INBOX_SIGNATURE_EXPIRED" | "RECIPIENT_NOT_ROUTABLE" | "SENDER_COUNTRY_MISSING" | "DOCUMENT_PARTY_MISMATCH" | "FRENCH_DOMESTIC_FLOW" | "UNSUPPORTED_SYNTAX" | "MALFORMED_DOCUMENT" | "EMPTY_DOCUMENT" | "MISSING_CUSTOMIZATION_ID" | "MISSING_PROCESS_ID";
|
|
116
|
+
message: string;
|
|
117
|
+
details?: {
|
|
118
|
+
[key: string]: unknown;
|
|
119
|
+
};
|
|
120
|
+
/** @description Support correlation ID, present on 5xx responses only. Quote it when contacting support. */
|
|
121
|
+
incidentId?: string;
|
|
122
|
+
};
|
|
123
|
+
};
|
|
124
|
+
};
|
|
125
|
+
};
|
|
126
|
+
/** @description Default Response */
|
|
127
|
+
429: {
|
|
128
|
+
headers: {
|
|
129
|
+
[name: string]: unknown;
|
|
130
|
+
};
|
|
131
|
+
content: {
|
|
132
|
+
"application/json": {
|
|
133
|
+
/** @enum {boolean} */
|
|
134
|
+
success: false;
|
|
135
|
+
error: {
|
|
136
|
+
code: "VALIDATION_ERROR" | "INVALID_INVOICE" | "PROFILE_STANDARD_MISMATCH" | "DOCUMENT_TYPE_STANDARD_MISMATCH" | "PARSE_FAILED" | "AUTHENTICATION_REQUIRED" | "INVALID_API_KEY" | "QUOTA_EXCEEDED" | "RATE_LIMITED" | "ACCOUNT_THROTTLED" | "ENGINE_UNAVAILABLE" | "INTERNAL_ERROR" | "NOT_FOUND" | "CONVERSION_UNSUPPORTED_PAIR" | "CONVERSION_LOSSY_FAILCLOSED" | "CONVERSION_TOOL_UNAVAILABLE" | "CONVERSION_TOOL_ERROR" | "PDF_TEMPLATE_AUTH_REQUIRED" | "PDF_TEMPLATE_NOT_FOUND" | "PDF_TEMPLATE_INVALID" | "TRANSMISSION_DISABLED" | "TRANSMISSION_NO_PROVIDER" | "IDEMPOTENCY_KEY_REUSED" | "INVALID_IDEMPOTENCY_KEY" | "SENDER_NOT_REGISTERED" | "CONTENT_ALREADY_SENT" | "INBOX_UNKNOWN_PROVIDER" | "INBOX_VERIFICATION_FAILED" | "INBOX_SIGNATURE_EXPIRED" | "RECIPIENT_NOT_ROUTABLE" | "SENDER_COUNTRY_MISSING" | "DOCUMENT_PARTY_MISMATCH" | "FRENCH_DOMESTIC_FLOW" | "UNSUPPORTED_SYNTAX" | "MALFORMED_DOCUMENT" | "EMPTY_DOCUMENT" | "MISSING_CUSTOMIZATION_ID" | "MISSING_PROCESS_ID";
|
|
107
137
|
message: string;
|
|
108
138
|
details?: {
|
|
109
139
|
[key: string]: unknown;
|
|
@@ -126,7 +156,7 @@ interface operations {
|
|
|
126
156
|
requestBody: {
|
|
127
157
|
content: {
|
|
128
158
|
"application/json": {
|
|
129
|
-
standard: "xrechnung" | "zugferd" | "facturx" | "peppol-bis" | "fatturapa" | "facturae" | "eslog"
|
|
159
|
+
standard: "xrechnung" | "zugferd" | "facturx" | "peppol-bis" | "fatturapa" | "facturae" | "eslog";
|
|
130
160
|
profile?: "minimum" | "basicwl" | "basic" | "en16931" | "extended" | "extended-ctc-fr" | "xrechnung" | "peppol" | "romania-ro-cius" | "netherlands-nlcius" | "ordinaria" | "eracun" | "fa3";
|
|
131
161
|
facturxProfile?: "minimum" | "basicwl" | "basic" | "en16931" | "extended" | "extended-ctc-fr";
|
|
132
162
|
output: "xml" | "pdf";
|
|
@@ -160,6 +190,7 @@ interface operations {
|
|
|
160
190
|
state?: string;
|
|
161
191
|
region?: string;
|
|
162
192
|
province?: string;
|
|
193
|
+
countrySubentity?: string;
|
|
163
194
|
};
|
|
164
195
|
contactName?: string;
|
|
165
196
|
peppol?: {
|
|
@@ -184,6 +215,7 @@ interface operations {
|
|
|
184
215
|
state?: string;
|
|
185
216
|
region?: string;
|
|
186
217
|
province?: string;
|
|
218
|
+
countrySubentity?: string;
|
|
187
219
|
};
|
|
188
220
|
contactName?: string;
|
|
189
221
|
peppol?: {
|
|
@@ -270,9 +302,31 @@ interface operations {
|
|
|
270
302
|
/** @description Default Response */
|
|
271
303
|
200: {
|
|
272
304
|
headers: {
|
|
305
|
+
/** @description Document syntax the engine detected: "ubl" or "cii". */
|
|
306
|
+
"x-syntax"?: string;
|
|
307
|
+
/** @description CIUS/profile the engine matched, e.g. "xrechnung_3.0". */
|
|
308
|
+
"x-profile-detected"?: string;
|
|
309
|
+
/** @description Version of the Schematron ruleset that produced the verdict. */
|
|
310
|
+
"x-schematron-version"?: string;
|
|
311
|
+
/** @description SHA-256 fingerprint of the rule artifacts the engine ran. Reproduce it from x-ruleset-artifacts to confirm the ruleset that judged you is the one beliq publicly pins (see GET /v1/rulesets). */
|
|
312
|
+
"x-ruleset-sha256"?: string;
|
|
313
|
+
/** @description One-line verdict, e.g. "pass · 0 err · 1 warn". */
|
|
314
|
+
"x-validation"?: string;
|
|
315
|
+
/** @description Compact JSON naming the ruleset/artifact versions pinned for the produced format. Descriptive only; conversion runs no validation over its output. */
|
|
316
|
+
"x-version-block"?: string;
|
|
317
|
+
/** @description The component rows x-ruleset-sha256 is built from, as "<key>@<version>=<fileSha256>" entries. Sort, join with newlines, and SHA-256 to reproduce the seal from published values alone. */
|
|
318
|
+
"x-ruleset-artifacts"?: string;
|
|
319
|
+
/** @description How the returned PDF was built: "hybrid" (PDF/A-3 with the XML embedded) or "visual" (rendered pages only). */
|
|
320
|
+
"x-pdf-kind"?: string;
|
|
321
|
+
/** @description "true" for a live key, "false" for a test key. Test-mode documents are watermarked and do not draw on the live monthly quota. */
|
|
322
|
+
"x-beliq-livemode"?: string;
|
|
323
|
+
/** @description Correlation id for this request. Quote it in a support request; it is the key the API, the engine, and error tracking all record. */
|
|
324
|
+
"x-request-id"?: string;
|
|
273
325
|
[name: string]: unknown;
|
|
274
326
|
};
|
|
275
327
|
content: {
|
|
328
|
+
"application/xml": string;
|
|
329
|
+
"application/pdf": string;
|
|
276
330
|
"application/json": {
|
|
277
331
|
success: boolean;
|
|
278
332
|
data?: {
|
|
@@ -281,7 +335,10 @@ interface operations {
|
|
|
281
335
|
standard: string;
|
|
282
336
|
profile: string;
|
|
283
337
|
validationResult: {
|
|
338
|
+
/** @description Whether the document was verified as valid. Read together with `verified`: `valid: false` with `verified: false` means no ruleset ran, not that the document failed. */
|
|
284
339
|
valid: boolean;
|
|
340
|
+
/** @description Whether a ruleset actually executed. `false` only when `verify: false` skipped validation, in which case `errors` and `warnings` are empty because nothing looked at the document. */
|
|
341
|
+
verified?: boolean;
|
|
285
342
|
format: "cii" | "ubl" | "fatturapa" | "facturae" | "eslog" | "sdi_messaggio" | "poland_ksef_fa2" | "poland_ksef_fa3" | "unknown";
|
|
286
343
|
sha256?: string;
|
|
287
344
|
rulesetSha256?: string;
|
|
@@ -293,6 +350,8 @@ interface operations {
|
|
|
293
350
|
/** Format: date-time */
|
|
294
351
|
driftCheckedAt?: string;
|
|
295
352
|
profileDetected?: string;
|
|
353
|
+
verificationTier?: "conformance-verified" | "builder-round-trip" | "reconstructed-rules" | "xsd-structural";
|
|
354
|
+
verificationBadge?: "authority-verified" | "independently-rule-checked" | "structure-checked";
|
|
296
355
|
schematronVersion?: string;
|
|
297
356
|
ciusVersion?: string;
|
|
298
357
|
peppolVersion?: string;
|
|
@@ -312,6 +371,11 @@ interface operations {
|
|
|
312
371
|
netherlandsNlciusVersion?: string;
|
|
313
372
|
rulesetChannel?: "latest" | "previous";
|
|
314
373
|
rulesetFellBack?: boolean;
|
|
374
|
+
/**
|
|
375
|
+
* Format: date
|
|
376
|
+
* @description ISO date the retained ruleset serving this request stops being served. Present only when a retained ruleset ran (never on a default request); the earliest date when several ran. After it, `previous` falls back to `latest` and an exact pin 422s.
|
|
377
|
+
*/
|
|
378
|
+
rulesetSunsetsOn?: string;
|
|
315
379
|
errors: {
|
|
316
380
|
ruleId: string;
|
|
317
381
|
severity: "fatal" | "error" | "warning" | "info";
|
|
@@ -332,7 +396,7 @@ interface operations {
|
|
|
332
396
|
pdfKind?: string;
|
|
333
397
|
};
|
|
334
398
|
error?: {
|
|
335
|
-
code: "VALIDATION_ERROR" | "INVALID_INVOICE" | "
|
|
399
|
+
code: "VALIDATION_ERROR" | "INVALID_INVOICE" | "PROFILE_STANDARD_MISMATCH" | "DOCUMENT_TYPE_STANDARD_MISMATCH" | "PARSE_FAILED" | "AUTHENTICATION_REQUIRED" | "INVALID_API_KEY" | "QUOTA_EXCEEDED" | "RATE_LIMITED" | "ACCOUNT_THROTTLED" | "ENGINE_UNAVAILABLE" | "INTERNAL_ERROR" | "NOT_FOUND" | "CONVERSION_UNSUPPORTED_PAIR" | "CONVERSION_LOSSY_FAILCLOSED" | "CONVERSION_TOOL_UNAVAILABLE" | "CONVERSION_TOOL_ERROR" | "PDF_TEMPLATE_AUTH_REQUIRED" | "PDF_TEMPLATE_NOT_FOUND" | "PDF_TEMPLATE_INVALID" | "TRANSMISSION_DISABLED" | "TRANSMISSION_NO_PROVIDER" | "IDEMPOTENCY_KEY_REUSED" | "INVALID_IDEMPOTENCY_KEY" | "SENDER_NOT_REGISTERED" | "CONTENT_ALREADY_SENT" | "INBOX_UNKNOWN_PROVIDER" | "INBOX_VERIFICATION_FAILED" | "INBOX_SIGNATURE_EXPIRED" | "RECIPIENT_NOT_ROUTABLE" | "SENDER_COUNTRY_MISSING" | "DOCUMENT_PARTY_MISMATCH" | "FRENCH_DOMESTIC_FLOW" | "UNSUPPORTED_SYNTAX" | "MALFORMED_DOCUMENT" | "EMPTY_DOCUMENT" | "MISSING_CUSTOMIZATION_ID" | "MISSING_PROCESS_ID";
|
|
336
400
|
message: string;
|
|
337
401
|
details?: {
|
|
338
402
|
[key: string]: unknown;
|
|
@@ -353,7 +417,49 @@ interface operations {
|
|
|
353
417
|
/** @enum {boolean} */
|
|
354
418
|
success: false;
|
|
355
419
|
error: {
|
|
356
|
-
code: "VALIDATION_ERROR" | "INVALID_INVOICE" | "
|
|
420
|
+
code: "VALIDATION_ERROR" | "INVALID_INVOICE" | "PROFILE_STANDARD_MISMATCH" | "DOCUMENT_TYPE_STANDARD_MISMATCH" | "PARSE_FAILED" | "AUTHENTICATION_REQUIRED" | "INVALID_API_KEY" | "QUOTA_EXCEEDED" | "RATE_LIMITED" | "ACCOUNT_THROTTLED" | "ENGINE_UNAVAILABLE" | "INTERNAL_ERROR" | "NOT_FOUND" | "CONVERSION_UNSUPPORTED_PAIR" | "CONVERSION_LOSSY_FAILCLOSED" | "CONVERSION_TOOL_UNAVAILABLE" | "CONVERSION_TOOL_ERROR" | "PDF_TEMPLATE_AUTH_REQUIRED" | "PDF_TEMPLATE_NOT_FOUND" | "PDF_TEMPLATE_INVALID" | "TRANSMISSION_DISABLED" | "TRANSMISSION_NO_PROVIDER" | "IDEMPOTENCY_KEY_REUSED" | "INVALID_IDEMPOTENCY_KEY" | "SENDER_NOT_REGISTERED" | "CONTENT_ALREADY_SENT" | "INBOX_UNKNOWN_PROVIDER" | "INBOX_VERIFICATION_FAILED" | "INBOX_SIGNATURE_EXPIRED" | "RECIPIENT_NOT_ROUTABLE" | "SENDER_COUNTRY_MISSING" | "DOCUMENT_PARTY_MISMATCH" | "FRENCH_DOMESTIC_FLOW" | "UNSUPPORTED_SYNTAX" | "MALFORMED_DOCUMENT" | "EMPTY_DOCUMENT" | "MISSING_CUSTOMIZATION_ID" | "MISSING_PROCESS_ID";
|
|
421
|
+
message: string;
|
|
422
|
+
details?: {
|
|
423
|
+
[key: string]: unknown;
|
|
424
|
+
};
|
|
425
|
+
/** @description Support correlation ID, present on 5xx responses only. Quote it when contacting support. */
|
|
426
|
+
incidentId?: string;
|
|
427
|
+
};
|
|
428
|
+
};
|
|
429
|
+
};
|
|
430
|
+
};
|
|
431
|
+
/** @description Default Response */
|
|
432
|
+
401: {
|
|
433
|
+
headers: {
|
|
434
|
+
[name: string]: unknown;
|
|
435
|
+
};
|
|
436
|
+
content: {
|
|
437
|
+
"application/json": {
|
|
438
|
+
/** @enum {boolean} */
|
|
439
|
+
success: false;
|
|
440
|
+
error: {
|
|
441
|
+
code: "VALIDATION_ERROR" | "INVALID_INVOICE" | "PROFILE_STANDARD_MISMATCH" | "DOCUMENT_TYPE_STANDARD_MISMATCH" | "PARSE_FAILED" | "AUTHENTICATION_REQUIRED" | "INVALID_API_KEY" | "QUOTA_EXCEEDED" | "RATE_LIMITED" | "ACCOUNT_THROTTLED" | "ENGINE_UNAVAILABLE" | "INTERNAL_ERROR" | "NOT_FOUND" | "CONVERSION_UNSUPPORTED_PAIR" | "CONVERSION_LOSSY_FAILCLOSED" | "CONVERSION_TOOL_UNAVAILABLE" | "CONVERSION_TOOL_ERROR" | "PDF_TEMPLATE_AUTH_REQUIRED" | "PDF_TEMPLATE_NOT_FOUND" | "PDF_TEMPLATE_INVALID" | "TRANSMISSION_DISABLED" | "TRANSMISSION_NO_PROVIDER" | "IDEMPOTENCY_KEY_REUSED" | "INVALID_IDEMPOTENCY_KEY" | "SENDER_NOT_REGISTERED" | "CONTENT_ALREADY_SENT" | "INBOX_UNKNOWN_PROVIDER" | "INBOX_VERIFICATION_FAILED" | "INBOX_SIGNATURE_EXPIRED" | "RECIPIENT_NOT_ROUTABLE" | "SENDER_COUNTRY_MISSING" | "DOCUMENT_PARTY_MISMATCH" | "FRENCH_DOMESTIC_FLOW" | "UNSUPPORTED_SYNTAX" | "MALFORMED_DOCUMENT" | "EMPTY_DOCUMENT" | "MISSING_CUSTOMIZATION_ID" | "MISSING_PROCESS_ID";
|
|
442
|
+
message: string;
|
|
443
|
+
details?: {
|
|
444
|
+
[key: string]: unknown;
|
|
445
|
+
};
|
|
446
|
+
/** @description Support correlation ID, present on 5xx responses only. Quote it when contacting support. */
|
|
447
|
+
incidentId?: string;
|
|
448
|
+
};
|
|
449
|
+
};
|
|
450
|
+
};
|
|
451
|
+
};
|
|
452
|
+
/** @description Default Response */
|
|
453
|
+
403: {
|
|
454
|
+
headers: {
|
|
455
|
+
[name: string]: unknown;
|
|
456
|
+
};
|
|
457
|
+
content: {
|
|
458
|
+
"application/json": {
|
|
459
|
+
/** @enum {boolean} */
|
|
460
|
+
success: false;
|
|
461
|
+
error: {
|
|
462
|
+
code: "VALIDATION_ERROR" | "INVALID_INVOICE" | "PROFILE_STANDARD_MISMATCH" | "DOCUMENT_TYPE_STANDARD_MISMATCH" | "PARSE_FAILED" | "AUTHENTICATION_REQUIRED" | "INVALID_API_KEY" | "QUOTA_EXCEEDED" | "RATE_LIMITED" | "ACCOUNT_THROTTLED" | "ENGINE_UNAVAILABLE" | "INTERNAL_ERROR" | "NOT_FOUND" | "CONVERSION_UNSUPPORTED_PAIR" | "CONVERSION_LOSSY_FAILCLOSED" | "CONVERSION_TOOL_UNAVAILABLE" | "CONVERSION_TOOL_ERROR" | "PDF_TEMPLATE_AUTH_REQUIRED" | "PDF_TEMPLATE_NOT_FOUND" | "PDF_TEMPLATE_INVALID" | "TRANSMISSION_DISABLED" | "TRANSMISSION_NO_PROVIDER" | "IDEMPOTENCY_KEY_REUSED" | "INVALID_IDEMPOTENCY_KEY" | "SENDER_NOT_REGISTERED" | "CONTENT_ALREADY_SENT" | "INBOX_UNKNOWN_PROVIDER" | "INBOX_VERIFICATION_FAILED" | "INBOX_SIGNATURE_EXPIRED" | "RECIPIENT_NOT_ROUTABLE" | "SENDER_COUNTRY_MISSING" | "DOCUMENT_PARTY_MISMATCH" | "FRENCH_DOMESTIC_FLOW" | "UNSUPPORTED_SYNTAX" | "MALFORMED_DOCUMENT" | "EMPTY_DOCUMENT" | "MISSING_CUSTOMIZATION_ID" | "MISSING_PROCESS_ID";
|
|
357
463
|
message: string;
|
|
358
464
|
details?: {
|
|
359
465
|
[key: string]: unknown;
|
|
@@ -374,7 +480,28 @@ interface operations {
|
|
|
374
480
|
/** @enum {boolean} */
|
|
375
481
|
success: false;
|
|
376
482
|
error: {
|
|
377
|
-
code: "VALIDATION_ERROR" | "INVALID_INVOICE" | "
|
|
483
|
+
code: "VALIDATION_ERROR" | "INVALID_INVOICE" | "PROFILE_STANDARD_MISMATCH" | "DOCUMENT_TYPE_STANDARD_MISMATCH" | "PARSE_FAILED" | "AUTHENTICATION_REQUIRED" | "INVALID_API_KEY" | "QUOTA_EXCEEDED" | "RATE_LIMITED" | "ACCOUNT_THROTTLED" | "ENGINE_UNAVAILABLE" | "INTERNAL_ERROR" | "NOT_FOUND" | "CONVERSION_UNSUPPORTED_PAIR" | "CONVERSION_LOSSY_FAILCLOSED" | "CONVERSION_TOOL_UNAVAILABLE" | "CONVERSION_TOOL_ERROR" | "PDF_TEMPLATE_AUTH_REQUIRED" | "PDF_TEMPLATE_NOT_FOUND" | "PDF_TEMPLATE_INVALID" | "TRANSMISSION_DISABLED" | "TRANSMISSION_NO_PROVIDER" | "IDEMPOTENCY_KEY_REUSED" | "INVALID_IDEMPOTENCY_KEY" | "SENDER_NOT_REGISTERED" | "CONTENT_ALREADY_SENT" | "INBOX_UNKNOWN_PROVIDER" | "INBOX_VERIFICATION_FAILED" | "INBOX_SIGNATURE_EXPIRED" | "RECIPIENT_NOT_ROUTABLE" | "SENDER_COUNTRY_MISSING" | "DOCUMENT_PARTY_MISMATCH" | "FRENCH_DOMESTIC_FLOW" | "UNSUPPORTED_SYNTAX" | "MALFORMED_DOCUMENT" | "EMPTY_DOCUMENT" | "MISSING_CUSTOMIZATION_ID" | "MISSING_PROCESS_ID";
|
|
484
|
+
message: string;
|
|
485
|
+
details?: {
|
|
486
|
+
[key: string]: unknown;
|
|
487
|
+
};
|
|
488
|
+
/** @description Support correlation ID, present on 5xx responses only. Quote it when contacting support. */
|
|
489
|
+
incidentId?: string;
|
|
490
|
+
};
|
|
491
|
+
};
|
|
492
|
+
};
|
|
493
|
+
};
|
|
494
|
+
/** @description Default Response */
|
|
495
|
+
413: {
|
|
496
|
+
headers: {
|
|
497
|
+
[name: string]: unknown;
|
|
498
|
+
};
|
|
499
|
+
content: {
|
|
500
|
+
"application/json": {
|
|
501
|
+
/** @enum {boolean} */
|
|
502
|
+
success: false;
|
|
503
|
+
error: {
|
|
504
|
+
code: "VALIDATION_ERROR" | "INVALID_INVOICE" | "PROFILE_STANDARD_MISMATCH" | "DOCUMENT_TYPE_STANDARD_MISMATCH" | "PARSE_FAILED" | "AUTHENTICATION_REQUIRED" | "INVALID_API_KEY" | "QUOTA_EXCEEDED" | "RATE_LIMITED" | "ACCOUNT_THROTTLED" | "ENGINE_UNAVAILABLE" | "INTERNAL_ERROR" | "NOT_FOUND" | "CONVERSION_UNSUPPORTED_PAIR" | "CONVERSION_LOSSY_FAILCLOSED" | "CONVERSION_TOOL_UNAVAILABLE" | "CONVERSION_TOOL_ERROR" | "PDF_TEMPLATE_AUTH_REQUIRED" | "PDF_TEMPLATE_NOT_FOUND" | "PDF_TEMPLATE_INVALID" | "TRANSMISSION_DISABLED" | "TRANSMISSION_NO_PROVIDER" | "IDEMPOTENCY_KEY_REUSED" | "INVALID_IDEMPOTENCY_KEY" | "SENDER_NOT_REGISTERED" | "CONTENT_ALREADY_SENT" | "INBOX_UNKNOWN_PROVIDER" | "INBOX_VERIFICATION_FAILED" | "INBOX_SIGNATURE_EXPIRED" | "RECIPIENT_NOT_ROUTABLE" | "SENDER_COUNTRY_MISSING" | "DOCUMENT_PARTY_MISMATCH" | "FRENCH_DOMESTIC_FLOW" | "UNSUPPORTED_SYNTAX" | "MALFORMED_DOCUMENT" | "EMPTY_DOCUMENT" | "MISSING_CUSTOMIZATION_ID" | "MISSING_PROCESS_ID";
|
|
378
505
|
message: string;
|
|
379
506
|
details?: {
|
|
380
507
|
[key: string]: unknown;
|
|
@@ -395,7 +522,28 @@ interface operations {
|
|
|
395
522
|
/** @enum {boolean} */
|
|
396
523
|
success: false;
|
|
397
524
|
error: {
|
|
398
|
-
code: "VALIDATION_ERROR" | "INVALID_INVOICE" | "
|
|
525
|
+
code: "VALIDATION_ERROR" | "INVALID_INVOICE" | "PROFILE_STANDARD_MISMATCH" | "DOCUMENT_TYPE_STANDARD_MISMATCH" | "PARSE_FAILED" | "AUTHENTICATION_REQUIRED" | "INVALID_API_KEY" | "QUOTA_EXCEEDED" | "RATE_LIMITED" | "ACCOUNT_THROTTLED" | "ENGINE_UNAVAILABLE" | "INTERNAL_ERROR" | "NOT_FOUND" | "CONVERSION_UNSUPPORTED_PAIR" | "CONVERSION_LOSSY_FAILCLOSED" | "CONVERSION_TOOL_UNAVAILABLE" | "CONVERSION_TOOL_ERROR" | "PDF_TEMPLATE_AUTH_REQUIRED" | "PDF_TEMPLATE_NOT_FOUND" | "PDF_TEMPLATE_INVALID" | "TRANSMISSION_DISABLED" | "TRANSMISSION_NO_PROVIDER" | "IDEMPOTENCY_KEY_REUSED" | "INVALID_IDEMPOTENCY_KEY" | "SENDER_NOT_REGISTERED" | "CONTENT_ALREADY_SENT" | "INBOX_UNKNOWN_PROVIDER" | "INBOX_VERIFICATION_FAILED" | "INBOX_SIGNATURE_EXPIRED" | "RECIPIENT_NOT_ROUTABLE" | "SENDER_COUNTRY_MISSING" | "DOCUMENT_PARTY_MISMATCH" | "FRENCH_DOMESTIC_FLOW" | "UNSUPPORTED_SYNTAX" | "MALFORMED_DOCUMENT" | "EMPTY_DOCUMENT" | "MISSING_CUSTOMIZATION_ID" | "MISSING_PROCESS_ID";
|
|
526
|
+
message: string;
|
|
527
|
+
details?: {
|
|
528
|
+
[key: string]: unknown;
|
|
529
|
+
};
|
|
530
|
+
/** @description Support correlation ID, present on 5xx responses only. Quote it when contacting support. */
|
|
531
|
+
incidentId?: string;
|
|
532
|
+
};
|
|
533
|
+
};
|
|
534
|
+
};
|
|
535
|
+
};
|
|
536
|
+
/** @description Default Response */
|
|
537
|
+
429: {
|
|
538
|
+
headers: {
|
|
539
|
+
[name: string]: unknown;
|
|
540
|
+
};
|
|
541
|
+
content: {
|
|
542
|
+
"application/json": {
|
|
543
|
+
/** @enum {boolean} */
|
|
544
|
+
success: false;
|
|
545
|
+
error: {
|
|
546
|
+
code: "VALIDATION_ERROR" | "INVALID_INVOICE" | "PROFILE_STANDARD_MISMATCH" | "DOCUMENT_TYPE_STANDARD_MISMATCH" | "PARSE_FAILED" | "AUTHENTICATION_REQUIRED" | "INVALID_API_KEY" | "QUOTA_EXCEEDED" | "RATE_LIMITED" | "ACCOUNT_THROTTLED" | "ENGINE_UNAVAILABLE" | "INTERNAL_ERROR" | "NOT_FOUND" | "CONVERSION_UNSUPPORTED_PAIR" | "CONVERSION_LOSSY_FAILCLOSED" | "CONVERSION_TOOL_UNAVAILABLE" | "CONVERSION_TOOL_ERROR" | "PDF_TEMPLATE_AUTH_REQUIRED" | "PDF_TEMPLATE_NOT_FOUND" | "PDF_TEMPLATE_INVALID" | "TRANSMISSION_DISABLED" | "TRANSMISSION_NO_PROVIDER" | "IDEMPOTENCY_KEY_REUSED" | "INVALID_IDEMPOTENCY_KEY" | "SENDER_NOT_REGISTERED" | "CONTENT_ALREADY_SENT" | "INBOX_UNKNOWN_PROVIDER" | "INBOX_VERIFICATION_FAILED" | "INBOX_SIGNATURE_EXPIRED" | "RECIPIENT_NOT_ROUTABLE" | "SENDER_COUNTRY_MISSING" | "DOCUMENT_PARTY_MISMATCH" | "FRENCH_DOMESTIC_FLOW" | "UNSUPPORTED_SYNTAX" | "MALFORMED_DOCUMENT" | "EMPTY_DOCUMENT" | "MISSING_CUSTOMIZATION_ID" | "MISSING_PROCESS_ID";
|
|
399
547
|
message: string;
|
|
400
548
|
details?: {
|
|
401
549
|
[key: string]: unknown;
|
|
@@ -416,7 +564,7 @@ interface operations {
|
|
|
416
564
|
/** @enum {boolean} */
|
|
417
565
|
success: false;
|
|
418
566
|
error: {
|
|
419
|
-
code: "VALIDATION_ERROR" | "INVALID_INVOICE" | "
|
|
567
|
+
code: "VALIDATION_ERROR" | "INVALID_INVOICE" | "PROFILE_STANDARD_MISMATCH" | "DOCUMENT_TYPE_STANDARD_MISMATCH" | "PARSE_FAILED" | "AUTHENTICATION_REQUIRED" | "INVALID_API_KEY" | "QUOTA_EXCEEDED" | "RATE_LIMITED" | "ACCOUNT_THROTTLED" | "ENGINE_UNAVAILABLE" | "INTERNAL_ERROR" | "NOT_FOUND" | "CONVERSION_UNSUPPORTED_PAIR" | "CONVERSION_LOSSY_FAILCLOSED" | "CONVERSION_TOOL_UNAVAILABLE" | "CONVERSION_TOOL_ERROR" | "PDF_TEMPLATE_AUTH_REQUIRED" | "PDF_TEMPLATE_NOT_FOUND" | "PDF_TEMPLATE_INVALID" | "TRANSMISSION_DISABLED" | "TRANSMISSION_NO_PROVIDER" | "IDEMPOTENCY_KEY_REUSED" | "INVALID_IDEMPOTENCY_KEY" | "SENDER_NOT_REGISTERED" | "CONTENT_ALREADY_SENT" | "INBOX_UNKNOWN_PROVIDER" | "INBOX_VERIFICATION_FAILED" | "INBOX_SIGNATURE_EXPIRED" | "RECIPIENT_NOT_ROUTABLE" | "SENDER_COUNTRY_MISSING" | "DOCUMENT_PARTY_MISMATCH" | "FRENCH_DOMESTIC_FLOW" | "UNSUPPORTED_SYNTAX" | "MALFORMED_DOCUMENT" | "EMPTY_DOCUMENT" | "MISSING_CUSTOMIZATION_ID" | "MISSING_PROCESS_ID";
|
|
420
568
|
message: string;
|
|
421
569
|
details?: {
|
|
422
570
|
[key: string]: unknown;
|
|
@@ -444,20 +592,42 @@ interface operations {
|
|
|
444
592
|
};
|
|
445
593
|
requestBody: {
|
|
446
594
|
content: {
|
|
447
|
-
"application/
|
|
595
|
+
"application/xml": unknown;
|
|
596
|
+
"text/xml": unknown;
|
|
597
|
+
"application/octet-stream": unknown;
|
|
598
|
+
"application/pdf": unknown;
|
|
448
599
|
};
|
|
449
600
|
};
|
|
450
601
|
responses: {
|
|
451
602
|
/** @description Default Response */
|
|
452
603
|
200: {
|
|
453
604
|
headers: {
|
|
605
|
+
/** @description Document syntax the engine detected: "ubl" or "cii". */
|
|
606
|
+
"x-syntax"?: string;
|
|
607
|
+
/** @description CIUS/profile the engine matched, e.g. "xrechnung_3.0". */
|
|
608
|
+
"x-profile-detected"?: string;
|
|
609
|
+
/** @description Version of the Schematron ruleset that produced the verdict. */
|
|
610
|
+
"x-schematron-version"?: string;
|
|
611
|
+
/** @description SHA-256 fingerprint of the rule artifacts the engine ran. Reproduce it from x-ruleset-artifacts to confirm the ruleset that judged you is the one beliq publicly pins (see GET /v1/rulesets). */
|
|
612
|
+
"x-ruleset-sha256"?: string;
|
|
613
|
+
/** @description One-line verdict, e.g. "pass · 0 err · 1 warn". */
|
|
614
|
+
"x-validation"?: string;
|
|
615
|
+
/** @description The ruleset selection that actually applied, echoed back when the request carried a Beliq-Ruleset header. Reveals a "previous"→"latest" fallback. */
|
|
616
|
+
"beliq-ruleset-resolved"?: string;
|
|
617
|
+
/** @description "true" for a live key, "false" for a test key. Test-mode documents are watermarked and do not draw on the live monthly quota. */
|
|
618
|
+
"x-beliq-livemode"?: string;
|
|
619
|
+
/** @description Correlation id for this request. Quote it in a support request; it is the key the API, the engine, and error tracking all record. */
|
|
620
|
+
"x-request-id"?: string;
|
|
454
621
|
[name: string]: unknown;
|
|
455
622
|
};
|
|
456
623
|
content: {
|
|
457
624
|
"application/json": {
|
|
458
625
|
success: boolean;
|
|
459
626
|
data?: {
|
|
627
|
+
/** @description Whether the document was verified as valid. Read together with `verified`: `valid: false` with `verified: false` means no ruleset ran, not that the document failed. */
|
|
460
628
|
valid: boolean;
|
|
629
|
+
/** @description Whether a ruleset actually executed. `false` only when `verify: false` skipped validation, in which case `errors` and `warnings` are empty because nothing looked at the document. */
|
|
630
|
+
verified?: boolean;
|
|
461
631
|
format: "cii" | "ubl" | "fatturapa" | "facturae" | "eslog" | "sdi_messaggio" | "poland_ksef_fa2" | "poland_ksef_fa3" | "unknown";
|
|
462
632
|
sha256?: string;
|
|
463
633
|
rulesetSha256?: string;
|
|
@@ -469,6 +639,8 @@ interface operations {
|
|
|
469
639
|
/** Format: date-time */
|
|
470
640
|
driftCheckedAt?: string;
|
|
471
641
|
profileDetected?: string;
|
|
642
|
+
verificationTier?: "conformance-verified" | "builder-round-trip" | "reconstructed-rules" | "xsd-structural";
|
|
643
|
+
verificationBadge?: "authority-verified" | "independently-rule-checked" | "structure-checked";
|
|
472
644
|
schematronVersion?: string;
|
|
473
645
|
ciusVersion?: string;
|
|
474
646
|
peppolVersion?: string;
|
|
@@ -488,6 +660,11 @@ interface operations {
|
|
|
488
660
|
netherlandsNlciusVersion?: string;
|
|
489
661
|
rulesetChannel?: "latest" | "previous";
|
|
490
662
|
rulesetFellBack?: boolean;
|
|
663
|
+
/**
|
|
664
|
+
* Format: date
|
|
665
|
+
* @description ISO date the retained ruleset serving this request stops being served. Present only when a retained ruleset ran (never on a default request); the earliest date when several ran. After it, `previous` falls back to `latest` and an exact pin 422s.
|
|
666
|
+
*/
|
|
667
|
+
rulesetSunsetsOn?: string;
|
|
491
668
|
errors: {
|
|
492
669
|
ruleId: string;
|
|
493
670
|
severity: "fatal" | "error" | "warning" | "info";
|
|
@@ -502,7 +679,7 @@ interface operations {
|
|
|
502
679
|
}[];
|
|
503
680
|
};
|
|
504
681
|
error?: {
|
|
505
|
-
code: "VALIDATION_ERROR" | "INVALID_INVOICE" | "
|
|
682
|
+
code: "VALIDATION_ERROR" | "INVALID_INVOICE" | "PROFILE_STANDARD_MISMATCH" | "DOCUMENT_TYPE_STANDARD_MISMATCH" | "PARSE_FAILED" | "AUTHENTICATION_REQUIRED" | "INVALID_API_KEY" | "QUOTA_EXCEEDED" | "RATE_LIMITED" | "ACCOUNT_THROTTLED" | "ENGINE_UNAVAILABLE" | "INTERNAL_ERROR" | "NOT_FOUND" | "CONVERSION_UNSUPPORTED_PAIR" | "CONVERSION_LOSSY_FAILCLOSED" | "CONVERSION_TOOL_UNAVAILABLE" | "CONVERSION_TOOL_ERROR" | "PDF_TEMPLATE_AUTH_REQUIRED" | "PDF_TEMPLATE_NOT_FOUND" | "PDF_TEMPLATE_INVALID" | "TRANSMISSION_DISABLED" | "TRANSMISSION_NO_PROVIDER" | "IDEMPOTENCY_KEY_REUSED" | "INVALID_IDEMPOTENCY_KEY" | "SENDER_NOT_REGISTERED" | "CONTENT_ALREADY_SENT" | "INBOX_UNKNOWN_PROVIDER" | "INBOX_VERIFICATION_FAILED" | "INBOX_SIGNATURE_EXPIRED" | "RECIPIENT_NOT_ROUTABLE" | "SENDER_COUNTRY_MISSING" | "DOCUMENT_PARTY_MISMATCH" | "FRENCH_DOMESTIC_FLOW" | "UNSUPPORTED_SYNTAX" | "MALFORMED_DOCUMENT" | "EMPTY_DOCUMENT" | "MISSING_CUSTOMIZATION_ID" | "MISSING_PROCESS_ID";
|
|
506
683
|
message: string;
|
|
507
684
|
details?: {
|
|
508
685
|
[key: string]: unknown;
|
|
@@ -523,7 +700,91 @@ interface operations {
|
|
|
523
700
|
/** @enum {boolean} */
|
|
524
701
|
success: false;
|
|
525
702
|
error: {
|
|
526
|
-
code: "VALIDATION_ERROR" | "INVALID_INVOICE" | "
|
|
703
|
+
code: "VALIDATION_ERROR" | "INVALID_INVOICE" | "PROFILE_STANDARD_MISMATCH" | "DOCUMENT_TYPE_STANDARD_MISMATCH" | "PARSE_FAILED" | "AUTHENTICATION_REQUIRED" | "INVALID_API_KEY" | "QUOTA_EXCEEDED" | "RATE_LIMITED" | "ACCOUNT_THROTTLED" | "ENGINE_UNAVAILABLE" | "INTERNAL_ERROR" | "NOT_FOUND" | "CONVERSION_UNSUPPORTED_PAIR" | "CONVERSION_LOSSY_FAILCLOSED" | "CONVERSION_TOOL_UNAVAILABLE" | "CONVERSION_TOOL_ERROR" | "PDF_TEMPLATE_AUTH_REQUIRED" | "PDF_TEMPLATE_NOT_FOUND" | "PDF_TEMPLATE_INVALID" | "TRANSMISSION_DISABLED" | "TRANSMISSION_NO_PROVIDER" | "IDEMPOTENCY_KEY_REUSED" | "INVALID_IDEMPOTENCY_KEY" | "SENDER_NOT_REGISTERED" | "CONTENT_ALREADY_SENT" | "INBOX_UNKNOWN_PROVIDER" | "INBOX_VERIFICATION_FAILED" | "INBOX_SIGNATURE_EXPIRED" | "RECIPIENT_NOT_ROUTABLE" | "SENDER_COUNTRY_MISSING" | "DOCUMENT_PARTY_MISMATCH" | "FRENCH_DOMESTIC_FLOW" | "UNSUPPORTED_SYNTAX" | "MALFORMED_DOCUMENT" | "EMPTY_DOCUMENT" | "MISSING_CUSTOMIZATION_ID" | "MISSING_PROCESS_ID";
|
|
704
|
+
message: string;
|
|
705
|
+
details?: {
|
|
706
|
+
[key: string]: unknown;
|
|
707
|
+
};
|
|
708
|
+
/** @description Support correlation ID, present on 5xx responses only. Quote it when contacting support. */
|
|
709
|
+
incidentId?: string;
|
|
710
|
+
};
|
|
711
|
+
};
|
|
712
|
+
};
|
|
713
|
+
};
|
|
714
|
+
/** @description Default Response */
|
|
715
|
+
401: {
|
|
716
|
+
headers: {
|
|
717
|
+
[name: string]: unknown;
|
|
718
|
+
};
|
|
719
|
+
content: {
|
|
720
|
+
"application/json": {
|
|
721
|
+
/** @enum {boolean} */
|
|
722
|
+
success: false;
|
|
723
|
+
error: {
|
|
724
|
+
code: "VALIDATION_ERROR" | "INVALID_INVOICE" | "PROFILE_STANDARD_MISMATCH" | "DOCUMENT_TYPE_STANDARD_MISMATCH" | "PARSE_FAILED" | "AUTHENTICATION_REQUIRED" | "INVALID_API_KEY" | "QUOTA_EXCEEDED" | "RATE_LIMITED" | "ACCOUNT_THROTTLED" | "ENGINE_UNAVAILABLE" | "INTERNAL_ERROR" | "NOT_FOUND" | "CONVERSION_UNSUPPORTED_PAIR" | "CONVERSION_LOSSY_FAILCLOSED" | "CONVERSION_TOOL_UNAVAILABLE" | "CONVERSION_TOOL_ERROR" | "PDF_TEMPLATE_AUTH_REQUIRED" | "PDF_TEMPLATE_NOT_FOUND" | "PDF_TEMPLATE_INVALID" | "TRANSMISSION_DISABLED" | "TRANSMISSION_NO_PROVIDER" | "IDEMPOTENCY_KEY_REUSED" | "INVALID_IDEMPOTENCY_KEY" | "SENDER_NOT_REGISTERED" | "CONTENT_ALREADY_SENT" | "INBOX_UNKNOWN_PROVIDER" | "INBOX_VERIFICATION_FAILED" | "INBOX_SIGNATURE_EXPIRED" | "RECIPIENT_NOT_ROUTABLE" | "SENDER_COUNTRY_MISSING" | "DOCUMENT_PARTY_MISMATCH" | "FRENCH_DOMESTIC_FLOW" | "UNSUPPORTED_SYNTAX" | "MALFORMED_DOCUMENT" | "EMPTY_DOCUMENT" | "MISSING_CUSTOMIZATION_ID" | "MISSING_PROCESS_ID";
|
|
725
|
+
message: string;
|
|
726
|
+
details?: {
|
|
727
|
+
[key: string]: unknown;
|
|
728
|
+
};
|
|
729
|
+
/** @description Support correlation ID, present on 5xx responses only. Quote it when contacting support. */
|
|
730
|
+
incidentId?: string;
|
|
731
|
+
};
|
|
732
|
+
};
|
|
733
|
+
};
|
|
734
|
+
};
|
|
735
|
+
/** @description Default Response */
|
|
736
|
+
403: {
|
|
737
|
+
headers: {
|
|
738
|
+
[name: string]: unknown;
|
|
739
|
+
};
|
|
740
|
+
content: {
|
|
741
|
+
"application/json": {
|
|
742
|
+
/** @enum {boolean} */
|
|
743
|
+
success: false;
|
|
744
|
+
error: {
|
|
745
|
+
code: "VALIDATION_ERROR" | "INVALID_INVOICE" | "PROFILE_STANDARD_MISMATCH" | "DOCUMENT_TYPE_STANDARD_MISMATCH" | "PARSE_FAILED" | "AUTHENTICATION_REQUIRED" | "INVALID_API_KEY" | "QUOTA_EXCEEDED" | "RATE_LIMITED" | "ACCOUNT_THROTTLED" | "ENGINE_UNAVAILABLE" | "INTERNAL_ERROR" | "NOT_FOUND" | "CONVERSION_UNSUPPORTED_PAIR" | "CONVERSION_LOSSY_FAILCLOSED" | "CONVERSION_TOOL_UNAVAILABLE" | "CONVERSION_TOOL_ERROR" | "PDF_TEMPLATE_AUTH_REQUIRED" | "PDF_TEMPLATE_NOT_FOUND" | "PDF_TEMPLATE_INVALID" | "TRANSMISSION_DISABLED" | "TRANSMISSION_NO_PROVIDER" | "IDEMPOTENCY_KEY_REUSED" | "INVALID_IDEMPOTENCY_KEY" | "SENDER_NOT_REGISTERED" | "CONTENT_ALREADY_SENT" | "INBOX_UNKNOWN_PROVIDER" | "INBOX_VERIFICATION_FAILED" | "INBOX_SIGNATURE_EXPIRED" | "RECIPIENT_NOT_ROUTABLE" | "SENDER_COUNTRY_MISSING" | "DOCUMENT_PARTY_MISMATCH" | "FRENCH_DOMESTIC_FLOW" | "UNSUPPORTED_SYNTAX" | "MALFORMED_DOCUMENT" | "EMPTY_DOCUMENT" | "MISSING_CUSTOMIZATION_ID" | "MISSING_PROCESS_ID";
|
|
746
|
+
message: string;
|
|
747
|
+
details?: {
|
|
748
|
+
[key: string]: unknown;
|
|
749
|
+
};
|
|
750
|
+
/** @description Support correlation ID, present on 5xx responses only. Quote it when contacting support. */
|
|
751
|
+
incidentId?: string;
|
|
752
|
+
};
|
|
753
|
+
};
|
|
754
|
+
};
|
|
755
|
+
};
|
|
756
|
+
/** @description Default Response */
|
|
757
|
+
413: {
|
|
758
|
+
headers: {
|
|
759
|
+
[name: string]: unknown;
|
|
760
|
+
};
|
|
761
|
+
content: {
|
|
762
|
+
"application/json": {
|
|
763
|
+
/** @enum {boolean} */
|
|
764
|
+
success: false;
|
|
765
|
+
error: {
|
|
766
|
+
code: "VALIDATION_ERROR" | "INVALID_INVOICE" | "PROFILE_STANDARD_MISMATCH" | "DOCUMENT_TYPE_STANDARD_MISMATCH" | "PARSE_FAILED" | "AUTHENTICATION_REQUIRED" | "INVALID_API_KEY" | "QUOTA_EXCEEDED" | "RATE_LIMITED" | "ACCOUNT_THROTTLED" | "ENGINE_UNAVAILABLE" | "INTERNAL_ERROR" | "NOT_FOUND" | "CONVERSION_UNSUPPORTED_PAIR" | "CONVERSION_LOSSY_FAILCLOSED" | "CONVERSION_TOOL_UNAVAILABLE" | "CONVERSION_TOOL_ERROR" | "PDF_TEMPLATE_AUTH_REQUIRED" | "PDF_TEMPLATE_NOT_FOUND" | "PDF_TEMPLATE_INVALID" | "TRANSMISSION_DISABLED" | "TRANSMISSION_NO_PROVIDER" | "IDEMPOTENCY_KEY_REUSED" | "INVALID_IDEMPOTENCY_KEY" | "SENDER_NOT_REGISTERED" | "CONTENT_ALREADY_SENT" | "INBOX_UNKNOWN_PROVIDER" | "INBOX_VERIFICATION_FAILED" | "INBOX_SIGNATURE_EXPIRED" | "RECIPIENT_NOT_ROUTABLE" | "SENDER_COUNTRY_MISSING" | "DOCUMENT_PARTY_MISMATCH" | "FRENCH_DOMESTIC_FLOW" | "UNSUPPORTED_SYNTAX" | "MALFORMED_DOCUMENT" | "EMPTY_DOCUMENT" | "MISSING_CUSTOMIZATION_ID" | "MISSING_PROCESS_ID";
|
|
767
|
+
message: string;
|
|
768
|
+
details?: {
|
|
769
|
+
[key: string]: unknown;
|
|
770
|
+
};
|
|
771
|
+
/** @description Support correlation ID, present on 5xx responses only. Quote it when contacting support. */
|
|
772
|
+
incidentId?: string;
|
|
773
|
+
};
|
|
774
|
+
};
|
|
775
|
+
};
|
|
776
|
+
};
|
|
777
|
+
/** @description Default Response */
|
|
778
|
+
415: {
|
|
779
|
+
headers: {
|
|
780
|
+
[name: string]: unknown;
|
|
781
|
+
};
|
|
782
|
+
content: {
|
|
783
|
+
"application/json": {
|
|
784
|
+
/** @enum {boolean} */
|
|
785
|
+
success: false;
|
|
786
|
+
error: {
|
|
787
|
+
code: "VALIDATION_ERROR" | "INVALID_INVOICE" | "PROFILE_STANDARD_MISMATCH" | "DOCUMENT_TYPE_STANDARD_MISMATCH" | "PARSE_FAILED" | "AUTHENTICATION_REQUIRED" | "INVALID_API_KEY" | "QUOTA_EXCEEDED" | "RATE_LIMITED" | "ACCOUNT_THROTTLED" | "ENGINE_UNAVAILABLE" | "INTERNAL_ERROR" | "NOT_FOUND" | "CONVERSION_UNSUPPORTED_PAIR" | "CONVERSION_LOSSY_FAILCLOSED" | "CONVERSION_TOOL_UNAVAILABLE" | "CONVERSION_TOOL_ERROR" | "PDF_TEMPLATE_AUTH_REQUIRED" | "PDF_TEMPLATE_NOT_FOUND" | "PDF_TEMPLATE_INVALID" | "TRANSMISSION_DISABLED" | "TRANSMISSION_NO_PROVIDER" | "IDEMPOTENCY_KEY_REUSED" | "INVALID_IDEMPOTENCY_KEY" | "SENDER_NOT_REGISTERED" | "CONTENT_ALREADY_SENT" | "INBOX_UNKNOWN_PROVIDER" | "INBOX_VERIFICATION_FAILED" | "INBOX_SIGNATURE_EXPIRED" | "RECIPIENT_NOT_ROUTABLE" | "SENDER_COUNTRY_MISSING" | "DOCUMENT_PARTY_MISMATCH" | "FRENCH_DOMESTIC_FLOW" | "UNSUPPORTED_SYNTAX" | "MALFORMED_DOCUMENT" | "EMPTY_DOCUMENT" | "MISSING_CUSTOMIZATION_ID" | "MISSING_PROCESS_ID";
|
|
527
788
|
message: string;
|
|
528
789
|
details?: {
|
|
529
790
|
[key: string]: unknown;
|
|
@@ -544,7 +805,28 @@ interface operations {
|
|
|
544
805
|
/** @enum {boolean} */
|
|
545
806
|
success: false;
|
|
546
807
|
error: {
|
|
547
|
-
code: "VALIDATION_ERROR" | "INVALID_INVOICE" | "
|
|
808
|
+
code: "VALIDATION_ERROR" | "INVALID_INVOICE" | "PROFILE_STANDARD_MISMATCH" | "DOCUMENT_TYPE_STANDARD_MISMATCH" | "PARSE_FAILED" | "AUTHENTICATION_REQUIRED" | "INVALID_API_KEY" | "QUOTA_EXCEEDED" | "RATE_LIMITED" | "ACCOUNT_THROTTLED" | "ENGINE_UNAVAILABLE" | "INTERNAL_ERROR" | "NOT_FOUND" | "CONVERSION_UNSUPPORTED_PAIR" | "CONVERSION_LOSSY_FAILCLOSED" | "CONVERSION_TOOL_UNAVAILABLE" | "CONVERSION_TOOL_ERROR" | "PDF_TEMPLATE_AUTH_REQUIRED" | "PDF_TEMPLATE_NOT_FOUND" | "PDF_TEMPLATE_INVALID" | "TRANSMISSION_DISABLED" | "TRANSMISSION_NO_PROVIDER" | "IDEMPOTENCY_KEY_REUSED" | "INVALID_IDEMPOTENCY_KEY" | "SENDER_NOT_REGISTERED" | "CONTENT_ALREADY_SENT" | "INBOX_UNKNOWN_PROVIDER" | "INBOX_VERIFICATION_FAILED" | "INBOX_SIGNATURE_EXPIRED" | "RECIPIENT_NOT_ROUTABLE" | "SENDER_COUNTRY_MISSING" | "DOCUMENT_PARTY_MISMATCH" | "FRENCH_DOMESTIC_FLOW" | "UNSUPPORTED_SYNTAX" | "MALFORMED_DOCUMENT" | "EMPTY_DOCUMENT" | "MISSING_CUSTOMIZATION_ID" | "MISSING_PROCESS_ID";
|
|
809
|
+
message: string;
|
|
810
|
+
details?: {
|
|
811
|
+
[key: string]: unknown;
|
|
812
|
+
};
|
|
813
|
+
/** @description Support correlation ID, present on 5xx responses only. Quote it when contacting support. */
|
|
814
|
+
incidentId?: string;
|
|
815
|
+
};
|
|
816
|
+
};
|
|
817
|
+
};
|
|
818
|
+
};
|
|
819
|
+
/** @description Default Response */
|
|
820
|
+
429: {
|
|
821
|
+
headers: {
|
|
822
|
+
[name: string]: unknown;
|
|
823
|
+
};
|
|
824
|
+
content: {
|
|
825
|
+
"application/json": {
|
|
826
|
+
/** @enum {boolean} */
|
|
827
|
+
success: false;
|
|
828
|
+
error: {
|
|
829
|
+
code: "VALIDATION_ERROR" | "INVALID_INVOICE" | "PROFILE_STANDARD_MISMATCH" | "DOCUMENT_TYPE_STANDARD_MISMATCH" | "PARSE_FAILED" | "AUTHENTICATION_REQUIRED" | "INVALID_API_KEY" | "QUOTA_EXCEEDED" | "RATE_LIMITED" | "ACCOUNT_THROTTLED" | "ENGINE_UNAVAILABLE" | "INTERNAL_ERROR" | "NOT_FOUND" | "CONVERSION_UNSUPPORTED_PAIR" | "CONVERSION_LOSSY_FAILCLOSED" | "CONVERSION_TOOL_UNAVAILABLE" | "CONVERSION_TOOL_ERROR" | "PDF_TEMPLATE_AUTH_REQUIRED" | "PDF_TEMPLATE_NOT_FOUND" | "PDF_TEMPLATE_INVALID" | "TRANSMISSION_DISABLED" | "TRANSMISSION_NO_PROVIDER" | "IDEMPOTENCY_KEY_REUSED" | "INVALID_IDEMPOTENCY_KEY" | "SENDER_NOT_REGISTERED" | "CONTENT_ALREADY_SENT" | "INBOX_UNKNOWN_PROVIDER" | "INBOX_VERIFICATION_FAILED" | "INBOX_SIGNATURE_EXPIRED" | "RECIPIENT_NOT_ROUTABLE" | "SENDER_COUNTRY_MISSING" | "DOCUMENT_PARTY_MISMATCH" | "FRENCH_DOMESTIC_FLOW" | "UNSUPPORTED_SYNTAX" | "MALFORMED_DOCUMENT" | "EMPTY_DOCUMENT" | "MISSING_CUSTOMIZATION_ID" | "MISSING_PROCESS_ID";
|
|
548
830
|
message: string;
|
|
549
831
|
details?: {
|
|
550
832
|
[key: string]: unknown;
|
|
@@ -565,7 +847,7 @@ interface operations {
|
|
|
565
847
|
/** @enum {boolean} */
|
|
566
848
|
success: false;
|
|
567
849
|
error: {
|
|
568
|
-
code: "VALIDATION_ERROR" | "INVALID_INVOICE" | "
|
|
850
|
+
code: "VALIDATION_ERROR" | "INVALID_INVOICE" | "PROFILE_STANDARD_MISMATCH" | "DOCUMENT_TYPE_STANDARD_MISMATCH" | "PARSE_FAILED" | "AUTHENTICATION_REQUIRED" | "INVALID_API_KEY" | "QUOTA_EXCEEDED" | "RATE_LIMITED" | "ACCOUNT_THROTTLED" | "ENGINE_UNAVAILABLE" | "INTERNAL_ERROR" | "NOT_FOUND" | "CONVERSION_UNSUPPORTED_PAIR" | "CONVERSION_LOSSY_FAILCLOSED" | "CONVERSION_TOOL_UNAVAILABLE" | "CONVERSION_TOOL_ERROR" | "PDF_TEMPLATE_AUTH_REQUIRED" | "PDF_TEMPLATE_NOT_FOUND" | "PDF_TEMPLATE_INVALID" | "TRANSMISSION_DISABLED" | "TRANSMISSION_NO_PROVIDER" | "IDEMPOTENCY_KEY_REUSED" | "INVALID_IDEMPOTENCY_KEY" | "SENDER_NOT_REGISTERED" | "CONTENT_ALREADY_SENT" | "INBOX_UNKNOWN_PROVIDER" | "INBOX_VERIFICATION_FAILED" | "INBOX_SIGNATURE_EXPIRED" | "RECIPIENT_NOT_ROUTABLE" | "SENDER_COUNTRY_MISSING" | "DOCUMENT_PARTY_MISMATCH" | "FRENCH_DOMESTIC_FLOW" | "UNSUPPORTED_SYNTAX" | "MALFORMED_DOCUMENT" | "EMPTY_DOCUMENT" | "MISSING_CUSTOMIZATION_ID" | "MISSING_PROCESS_ID";
|
|
569
851
|
message: string;
|
|
570
852
|
details?: {
|
|
571
853
|
[key: string]: unknown;
|
|
@@ -589,13 +871,30 @@ interface operations {
|
|
|
589
871
|
};
|
|
590
872
|
requestBody: {
|
|
591
873
|
content: {
|
|
592
|
-
"application/
|
|
874
|
+
"application/xml": unknown;
|
|
875
|
+
"text/xml": unknown;
|
|
876
|
+
"application/octet-stream": unknown;
|
|
877
|
+
"application/pdf": unknown;
|
|
593
878
|
};
|
|
594
879
|
};
|
|
595
880
|
responses: {
|
|
596
881
|
/** @description Default Response */
|
|
597
882
|
200: {
|
|
598
883
|
headers: {
|
|
884
|
+
/** @description Document syntax the engine detected: "ubl" or "cii". */
|
|
885
|
+
"x-syntax"?: string;
|
|
886
|
+
/** @description CIUS/profile the engine matched, e.g. "xrechnung_3.0". */
|
|
887
|
+
"x-profile-detected"?: string;
|
|
888
|
+
/** @description Version of the Schematron ruleset that produced the verdict. */
|
|
889
|
+
"x-schematron-version"?: string;
|
|
890
|
+
/** @description SHA-256 fingerprint of the rule artifacts the engine ran. Reproduce it from x-ruleset-artifacts to confirm the ruleset that judged you is the one beliq publicly pins (see GET /v1/rulesets). */
|
|
891
|
+
"x-ruleset-sha256"?: string;
|
|
892
|
+
/** @description One-line verdict, e.g. "pass · 0 err · 1 warn". */
|
|
893
|
+
"x-validation"?: string;
|
|
894
|
+
/** @description "true" for a live key, "false" for a test key. Test-mode documents are watermarked and do not draw on the live monthly quota. */
|
|
895
|
+
"x-beliq-livemode"?: string;
|
|
896
|
+
/** @description Correlation id for this request. Quote it in a support request; it is the key the API, the engine, and error tracking all record. */
|
|
897
|
+
"x-request-id"?: string;
|
|
599
898
|
[name: string]: unknown;
|
|
600
899
|
};
|
|
601
900
|
content: {
|
|
@@ -634,6 +933,7 @@ interface operations {
|
|
|
634
933
|
state?: string;
|
|
635
934
|
region?: string;
|
|
636
935
|
province?: string;
|
|
936
|
+
countrySubentity?: string;
|
|
637
937
|
};
|
|
638
938
|
contactName?: string;
|
|
639
939
|
peppol?: {
|
|
@@ -658,6 +958,7 @@ interface operations {
|
|
|
658
958
|
state?: string;
|
|
659
959
|
region?: string;
|
|
660
960
|
province?: string;
|
|
961
|
+
countrySubentity?: string;
|
|
661
962
|
};
|
|
662
963
|
contactName?: string;
|
|
663
964
|
peppol?: {
|
|
@@ -735,7 +1036,7 @@ interface operations {
|
|
|
735
1036
|
};
|
|
736
1037
|
};
|
|
737
1038
|
error?: {
|
|
738
|
-
code: "VALIDATION_ERROR" | "INVALID_INVOICE" | "
|
|
1039
|
+
code: "VALIDATION_ERROR" | "INVALID_INVOICE" | "PROFILE_STANDARD_MISMATCH" | "DOCUMENT_TYPE_STANDARD_MISMATCH" | "PARSE_FAILED" | "AUTHENTICATION_REQUIRED" | "INVALID_API_KEY" | "QUOTA_EXCEEDED" | "RATE_LIMITED" | "ACCOUNT_THROTTLED" | "ENGINE_UNAVAILABLE" | "INTERNAL_ERROR" | "NOT_FOUND" | "CONVERSION_UNSUPPORTED_PAIR" | "CONVERSION_LOSSY_FAILCLOSED" | "CONVERSION_TOOL_UNAVAILABLE" | "CONVERSION_TOOL_ERROR" | "PDF_TEMPLATE_AUTH_REQUIRED" | "PDF_TEMPLATE_NOT_FOUND" | "PDF_TEMPLATE_INVALID" | "TRANSMISSION_DISABLED" | "TRANSMISSION_NO_PROVIDER" | "IDEMPOTENCY_KEY_REUSED" | "INVALID_IDEMPOTENCY_KEY" | "SENDER_NOT_REGISTERED" | "CONTENT_ALREADY_SENT" | "INBOX_UNKNOWN_PROVIDER" | "INBOX_VERIFICATION_FAILED" | "INBOX_SIGNATURE_EXPIRED" | "RECIPIENT_NOT_ROUTABLE" | "SENDER_COUNTRY_MISSING" | "DOCUMENT_PARTY_MISMATCH" | "FRENCH_DOMESTIC_FLOW" | "UNSUPPORTED_SYNTAX" | "MALFORMED_DOCUMENT" | "EMPTY_DOCUMENT" | "MISSING_CUSTOMIZATION_ID" | "MISSING_PROCESS_ID";
|
|
739
1040
|
message: string;
|
|
740
1041
|
details?: {
|
|
741
1042
|
[key: string]: unknown;
|
|
@@ -756,7 +1057,133 @@ interface operations {
|
|
|
756
1057
|
/** @enum {boolean} */
|
|
757
1058
|
success: false;
|
|
758
1059
|
error: {
|
|
759
|
-
code: "VALIDATION_ERROR" | "INVALID_INVOICE" | "
|
|
1060
|
+
code: "VALIDATION_ERROR" | "INVALID_INVOICE" | "PROFILE_STANDARD_MISMATCH" | "DOCUMENT_TYPE_STANDARD_MISMATCH" | "PARSE_FAILED" | "AUTHENTICATION_REQUIRED" | "INVALID_API_KEY" | "QUOTA_EXCEEDED" | "RATE_LIMITED" | "ACCOUNT_THROTTLED" | "ENGINE_UNAVAILABLE" | "INTERNAL_ERROR" | "NOT_FOUND" | "CONVERSION_UNSUPPORTED_PAIR" | "CONVERSION_LOSSY_FAILCLOSED" | "CONVERSION_TOOL_UNAVAILABLE" | "CONVERSION_TOOL_ERROR" | "PDF_TEMPLATE_AUTH_REQUIRED" | "PDF_TEMPLATE_NOT_FOUND" | "PDF_TEMPLATE_INVALID" | "TRANSMISSION_DISABLED" | "TRANSMISSION_NO_PROVIDER" | "IDEMPOTENCY_KEY_REUSED" | "INVALID_IDEMPOTENCY_KEY" | "SENDER_NOT_REGISTERED" | "CONTENT_ALREADY_SENT" | "INBOX_UNKNOWN_PROVIDER" | "INBOX_VERIFICATION_FAILED" | "INBOX_SIGNATURE_EXPIRED" | "RECIPIENT_NOT_ROUTABLE" | "SENDER_COUNTRY_MISSING" | "DOCUMENT_PARTY_MISMATCH" | "FRENCH_DOMESTIC_FLOW" | "UNSUPPORTED_SYNTAX" | "MALFORMED_DOCUMENT" | "EMPTY_DOCUMENT" | "MISSING_CUSTOMIZATION_ID" | "MISSING_PROCESS_ID";
|
|
1061
|
+
message: string;
|
|
1062
|
+
details?: {
|
|
1063
|
+
[key: string]: unknown;
|
|
1064
|
+
};
|
|
1065
|
+
/** @description Support correlation ID, present on 5xx responses only. Quote it when contacting support. */
|
|
1066
|
+
incidentId?: string;
|
|
1067
|
+
};
|
|
1068
|
+
};
|
|
1069
|
+
};
|
|
1070
|
+
};
|
|
1071
|
+
/** @description Default Response */
|
|
1072
|
+
401: {
|
|
1073
|
+
headers: {
|
|
1074
|
+
[name: string]: unknown;
|
|
1075
|
+
};
|
|
1076
|
+
content: {
|
|
1077
|
+
"application/json": {
|
|
1078
|
+
/** @enum {boolean} */
|
|
1079
|
+
success: false;
|
|
1080
|
+
error: {
|
|
1081
|
+
code: "VALIDATION_ERROR" | "INVALID_INVOICE" | "PROFILE_STANDARD_MISMATCH" | "DOCUMENT_TYPE_STANDARD_MISMATCH" | "PARSE_FAILED" | "AUTHENTICATION_REQUIRED" | "INVALID_API_KEY" | "QUOTA_EXCEEDED" | "RATE_LIMITED" | "ACCOUNT_THROTTLED" | "ENGINE_UNAVAILABLE" | "INTERNAL_ERROR" | "NOT_FOUND" | "CONVERSION_UNSUPPORTED_PAIR" | "CONVERSION_LOSSY_FAILCLOSED" | "CONVERSION_TOOL_UNAVAILABLE" | "CONVERSION_TOOL_ERROR" | "PDF_TEMPLATE_AUTH_REQUIRED" | "PDF_TEMPLATE_NOT_FOUND" | "PDF_TEMPLATE_INVALID" | "TRANSMISSION_DISABLED" | "TRANSMISSION_NO_PROVIDER" | "IDEMPOTENCY_KEY_REUSED" | "INVALID_IDEMPOTENCY_KEY" | "SENDER_NOT_REGISTERED" | "CONTENT_ALREADY_SENT" | "INBOX_UNKNOWN_PROVIDER" | "INBOX_VERIFICATION_FAILED" | "INBOX_SIGNATURE_EXPIRED" | "RECIPIENT_NOT_ROUTABLE" | "SENDER_COUNTRY_MISSING" | "DOCUMENT_PARTY_MISMATCH" | "FRENCH_DOMESTIC_FLOW" | "UNSUPPORTED_SYNTAX" | "MALFORMED_DOCUMENT" | "EMPTY_DOCUMENT" | "MISSING_CUSTOMIZATION_ID" | "MISSING_PROCESS_ID";
|
|
1082
|
+
message: string;
|
|
1083
|
+
details?: {
|
|
1084
|
+
[key: string]: unknown;
|
|
1085
|
+
};
|
|
1086
|
+
/** @description Support correlation ID, present on 5xx responses only. Quote it when contacting support. */
|
|
1087
|
+
incidentId?: string;
|
|
1088
|
+
};
|
|
1089
|
+
};
|
|
1090
|
+
};
|
|
1091
|
+
};
|
|
1092
|
+
/** @description Default Response */
|
|
1093
|
+
403: {
|
|
1094
|
+
headers: {
|
|
1095
|
+
[name: string]: unknown;
|
|
1096
|
+
};
|
|
1097
|
+
content: {
|
|
1098
|
+
"application/json": {
|
|
1099
|
+
/** @enum {boolean} */
|
|
1100
|
+
success: false;
|
|
1101
|
+
error: {
|
|
1102
|
+
code: "VALIDATION_ERROR" | "INVALID_INVOICE" | "PROFILE_STANDARD_MISMATCH" | "DOCUMENT_TYPE_STANDARD_MISMATCH" | "PARSE_FAILED" | "AUTHENTICATION_REQUIRED" | "INVALID_API_KEY" | "QUOTA_EXCEEDED" | "RATE_LIMITED" | "ACCOUNT_THROTTLED" | "ENGINE_UNAVAILABLE" | "INTERNAL_ERROR" | "NOT_FOUND" | "CONVERSION_UNSUPPORTED_PAIR" | "CONVERSION_LOSSY_FAILCLOSED" | "CONVERSION_TOOL_UNAVAILABLE" | "CONVERSION_TOOL_ERROR" | "PDF_TEMPLATE_AUTH_REQUIRED" | "PDF_TEMPLATE_NOT_FOUND" | "PDF_TEMPLATE_INVALID" | "TRANSMISSION_DISABLED" | "TRANSMISSION_NO_PROVIDER" | "IDEMPOTENCY_KEY_REUSED" | "INVALID_IDEMPOTENCY_KEY" | "SENDER_NOT_REGISTERED" | "CONTENT_ALREADY_SENT" | "INBOX_UNKNOWN_PROVIDER" | "INBOX_VERIFICATION_FAILED" | "INBOX_SIGNATURE_EXPIRED" | "RECIPIENT_NOT_ROUTABLE" | "SENDER_COUNTRY_MISSING" | "DOCUMENT_PARTY_MISMATCH" | "FRENCH_DOMESTIC_FLOW" | "UNSUPPORTED_SYNTAX" | "MALFORMED_DOCUMENT" | "EMPTY_DOCUMENT" | "MISSING_CUSTOMIZATION_ID" | "MISSING_PROCESS_ID";
|
|
1103
|
+
message: string;
|
|
1104
|
+
details?: {
|
|
1105
|
+
[key: string]: unknown;
|
|
1106
|
+
};
|
|
1107
|
+
/** @description Support correlation ID, present on 5xx responses only. Quote it when contacting support. */
|
|
1108
|
+
incidentId?: string;
|
|
1109
|
+
};
|
|
1110
|
+
};
|
|
1111
|
+
};
|
|
1112
|
+
};
|
|
1113
|
+
/** @description Default Response */
|
|
1114
|
+
413: {
|
|
1115
|
+
headers: {
|
|
1116
|
+
[name: string]: unknown;
|
|
1117
|
+
};
|
|
1118
|
+
content: {
|
|
1119
|
+
"application/json": {
|
|
1120
|
+
/** @enum {boolean} */
|
|
1121
|
+
success: false;
|
|
1122
|
+
error: {
|
|
1123
|
+
code: "VALIDATION_ERROR" | "INVALID_INVOICE" | "PROFILE_STANDARD_MISMATCH" | "DOCUMENT_TYPE_STANDARD_MISMATCH" | "PARSE_FAILED" | "AUTHENTICATION_REQUIRED" | "INVALID_API_KEY" | "QUOTA_EXCEEDED" | "RATE_LIMITED" | "ACCOUNT_THROTTLED" | "ENGINE_UNAVAILABLE" | "INTERNAL_ERROR" | "NOT_FOUND" | "CONVERSION_UNSUPPORTED_PAIR" | "CONVERSION_LOSSY_FAILCLOSED" | "CONVERSION_TOOL_UNAVAILABLE" | "CONVERSION_TOOL_ERROR" | "PDF_TEMPLATE_AUTH_REQUIRED" | "PDF_TEMPLATE_NOT_FOUND" | "PDF_TEMPLATE_INVALID" | "TRANSMISSION_DISABLED" | "TRANSMISSION_NO_PROVIDER" | "IDEMPOTENCY_KEY_REUSED" | "INVALID_IDEMPOTENCY_KEY" | "SENDER_NOT_REGISTERED" | "CONTENT_ALREADY_SENT" | "INBOX_UNKNOWN_PROVIDER" | "INBOX_VERIFICATION_FAILED" | "INBOX_SIGNATURE_EXPIRED" | "RECIPIENT_NOT_ROUTABLE" | "SENDER_COUNTRY_MISSING" | "DOCUMENT_PARTY_MISMATCH" | "FRENCH_DOMESTIC_FLOW" | "UNSUPPORTED_SYNTAX" | "MALFORMED_DOCUMENT" | "EMPTY_DOCUMENT" | "MISSING_CUSTOMIZATION_ID" | "MISSING_PROCESS_ID";
|
|
1124
|
+
message: string;
|
|
1125
|
+
details?: {
|
|
1126
|
+
[key: string]: unknown;
|
|
1127
|
+
};
|
|
1128
|
+
/** @description Support correlation ID, present on 5xx responses only. Quote it when contacting support. */
|
|
1129
|
+
incidentId?: string;
|
|
1130
|
+
};
|
|
1131
|
+
};
|
|
1132
|
+
};
|
|
1133
|
+
};
|
|
1134
|
+
/** @description Default Response */
|
|
1135
|
+
415: {
|
|
1136
|
+
headers: {
|
|
1137
|
+
[name: string]: unknown;
|
|
1138
|
+
};
|
|
1139
|
+
content: {
|
|
1140
|
+
"application/json": {
|
|
1141
|
+
/** @enum {boolean} */
|
|
1142
|
+
success: false;
|
|
1143
|
+
error: {
|
|
1144
|
+
code: "VALIDATION_ERROR" | "INVALID_INVOICE" | "PROFILE_STANDARD_MISMATCH" | "DOCUMENT_TYPE_STANDARD_MISMATCH" | "PARSE_FAILED" | "AUTHENTICATION_REQUIRED" | "INVALID_API_KEY" | "QUOTA_EXCEEDED" | "RATE_LIMITED" | "ACCOUNT_THROTTLED" | "ENGINE_UNAVAILABLE" | "INTERNAL_ERROR" | "NOT_FOUND" | "CONVERSION_UNSUPPORTED_PAIR" | "CONVERSION_LOSSY_FAILCLOSED" | "CONVERSION_TOOL_UNAVAILABLE" | "CONVERSION_TOOL_ERROR" | "PDF_TEMPLATE_AUTH_REQUIRED" | "PDF_TEMPLATE_NOT_FOUND" | "PDF_TEMPLATE_INVALID" | "TRANSMISSION_DISABLED" | "TRANSMISSION_NO_PROVIDER" | "IDEMPOTENCY_KEY_REUSED" | "INVALID_IDEMPOTENCY_KEY" | "SENDER_NOT_REGISTERED" | "CONTENT_ALREADY_SENT" | "INBOX_UNKNOWN_PROVIDER" | "INBOX_VERIFICATION_FAILED" | "INBOX_SIGNATURE_EXPIRED" | "RECIPIENT_NOT_ROUTABLE" | "SENDER_COUNTRY_MISSING" | "DOCUMENT_PARTY_MISMATCH" | "FRENCH_DOMESTIC_FLOW" | "UNSUPPORTED_SYNTAX" | "MALFORMED_DOCUMENT" | "EMPTY_DOCUMENT" | "MISSING_CUSTOMIZATION_ID" | "MISSING_PROCESS_ID";
|
|
1145
|
+
message: string;
|
|
1146
|
+
details?: {
|
|
1147
|
+
[key: string]: unknown;
|
|
1148
|
+
};
|
|
1149
|
+
/** @description Support correlation ID, present on 5xx responses only. Quote it when contacting support. */
|
|
1150
|
+
incidentId?: string;
|
|
1151
|
+
};
|
|
1152
|
+
};
|
|
1153
|
+
};
|
|
1154
|
+
};
|
|
1155
|
+
/** @description Default Response */
|
|
1156
|
+
422: {
|
|
1157
|
+
headers: {
|
|
1158
|
+
[name: string]: unknown;
|
|
1159
|
+
};
|
|
1160
|
+
content: {
|
|
1161
|
+
"application/json": {
|
|
1162
|
+
/** @enum {boolean} */
|
|
1163
|
+
success: false;
|
|
1164
|
+
error: {
|
|
1165
|
+
code: "VALIDATION_ERROR" | "INVALID_INVOICE" | "PROFILE_STANDARD_MISMATCH" | "DOCUMENT_TYPE_STANDARD_MISMATCH" | "PARSE_FAILED" | "AUTHENTICATION_REQUIRED" | "INVALID_API_KEY" | "QUOTA_EXCEEDED" | "RATE_LIMITED" | "ACCOUNT_THROTTLED" | "ENGINE_UNAVAILABLE" | "INTERNAL_ERROR" | "NOT_FOUND" | "CONVERSION_UNSUPPORTED_PAIR" | "CONVERSION_LOSSY_FAILCLOSED" | "CONVERSION_TOOL_UNAVAILABLE" | "CONVERSION_TOOL_ERROR" | "PDF_TEMPLATE_AUTH_REQUIRED" | "PDF_TEMPLATE_NOT_FOUND" | "PDF_TEMPLATE_INVALID" | "TRANSMISSION_DISABLED" | "TRANSMISSION_NO_PROVIDER" | "IDEMPOTENCY_KEY_REUSED" | "INVALID_IDEMPOTENCY_KEY" | "SENDER_NOT_REGISTERED" | "CONTENT_ALREADY_SENT" | "INBOX_UNKNOWN_PROVIDER" | "INBOX_VERIFICATION_FAILED" | "INBOX_SIGNATURE_EXPIRED" | "RECIPIENT_NOT_ROUTABLE" | "SENDER_COUNTRY_MISSING" | "DOCUMENT_PARTY_MISMATCH" | "FRENCH_DOMESTIC_FLOW" | "UNSUPPORTED_SYNTAX" | "MALFORMED_DOCUMENT" | "EMPTY_DOCUMENT" | "MISSING_CUSTOMIZATION_ID" | "MISSING_PROCESS_ID";
|
|
1166
|
+
message: string;
|
|
1167
|
+
details?: {
|
|
1168
|
+
[key: string]: unknown;
|
|
1169
|
+
};
|
|
1170
|
+
/** @description Support correlation ID, present on 5xx responses only. Quote it when contacting support. */
|
|
1171
|
+
incidentId?: string;
|
|
1172
|
+
};
|
|
1173
|
+
};
|
|
1174
|
+
};
|
|
1175
|
+
};
|
|
1176
|
+
/** @description Default Response */
|
|
1177
|
+
429: {
|
|
1178
|
+
headers: {
|
|
1179
|
+
[name: string]: unknown;
|
|
1180
|
+
};
|
|
1181
|
+
content: {
|
|
1182
|
+
"application/json": {
|
|
1183
|
+
/** @enum {boolean} */
|
|
1184
|
+
success: false;
|
|
1185
|
+
error: {
|
|
1186
|
+
code: "VALIDATION_ERROR" | "INVALID_INVOICE" | "PROFILE_STANDARD_MISMATCH" | "DOCUMENT_TYPE_STANDARD_MISMATCH" | "PARSE_FAILED" | "AUTHENTICATION_REQUIRED" | "INVALID_API_KEY" | "QUOTA_EXCEEDED" | "RATE_LIMITED" | "ACCOUNT_THROTTLED" | "ENGINE_UNAVAILABLE" | "INTERNAL_ERROR" | "NOT_FOUND" | "CONVERSION_UNSUPPORTED_PAIR" | "CONVERSION_LOSSY_FAILCLOSED" | "CONVERSION_TOOL_UNAVAILABLE" | "CONVERSION_TOOL_ERROR" | "PDF_TEMPLATE_AUTH_REQUIRED" | "PDF_TEMPLATE_NOT_FOUND" | "PDF_TEMPLATE_INVALID" | "TRANSMISSION_DISABLED" | "TRANSMISSION_NO_PROVIDER" | "IDEMPOTENCY_KEY_REUSED" | "INVALID_IDEMPOTENCY_KEY" | "SENDER_NOT_REGISTERED" | "CONTENT_ALREADY_SENT" | "INBOX_UNKNOWN_PROVIDER" | "INBOX_VERIFICATION_FAILED" | "INBOX_SIGNATURE_EXPIRED" | "RECIPIENT_NOT_ROUTABLE" | "SENDER_COUNTRY_MISSING" | "DOCUMENT_PARTY_MISMATCH" | "FRENCH_DOMESTIC_FLOW" | "UNSUPPORTED_SYNTAX" | "MALFORMED_DOCUMENT" | "EMPTY_DOCUMENT" | "MISSING_CUSTOMIZATION_ID" | "MISSING_PROCESS_ID";
|
|
760
1187
|
message: string;
|
|
761
1188
|
details?: {
|
|
762
1189
|
[key: string]: unknown;
|
|
@@ -777,7 +1204,7 @@ interface operations {
|
|
|
777
1204
|
/** @enum {boolean} */
|
|
778
1205
|
success: false;
|
|
779
1206
|
error: {
|
|
780
|
-
code: "VALIDATION_ERROR" | "INVALID_INVOICE" | "
|
|
1207
|
+
code: "VALIDATION_ERROR" | "INVALID_INVOICE" | "PROFILE_STANDARD_MISMATCH" | "DOCUMENT_TYPE_STANDARD_MISMATCH" | "PARSE_FAILED" | "AUTHENTICATION_REQUIRED" | "INVALID_API_KEY" | "QUOTA_EXCEEDED" | "RATE_LIMITED" | "ACCOUNT_THROTTLED" | "ENGINE_UNAVAILABLE" | "INTERNAL_ERROR" | "NOT_FOUND" | "CONVERSION_UNSUPPORTED_PAIR" | "CONVERSION_LOSSY_FAILCLOSED" | "CONVERSION_TOOL_UNAVAILABLE" | "CONVERSION_TOOL_ERROR" | "PDF_TEMPLATE_AUTH_REQUIRED" | "PDF_TEMPLATE_NOT_FOUND" | "PDF_TEMPLATE_INVALID" | "TRANSMISSION_DISABLED" | "TRANSMISSION_NO_PROVIDER" | "IDEMPOTENCY_KEY_REUSED" | "INVALID_IDEMPOTENCY_KEY" | "SENDER_NOT_REGISTERED" | "CONTENT_ALREADY_SENT" | "INBOX_UNKNOWN_PROVIDER" | "INBOX_VERIFICATION_FAILED" | "INBOX_SIGNATURE_EXPIRED" | "RECIPIENT_NOT_ROUTABLE" | "SENDER_COUNTRY_MISSING" | "DOCUMENT_PARTY_MISMATCH" | "FRENCH_DOMESTIC_FLOW" | "UNSUPPORTED_SYNTAX" | "MALFORMED_DOCUMENT" | "EMPTY_DOCUMENT" | "MISSING_CUSTOMIZATION_ID" | "MISSING_PROCESS_ID";
|
|
781
1208
|
message: string;
|
|
782
1209
|
details?: {
|
|
783
1210
|
[key: string]: unknown;
|
|
@@ -804,10 +1231,43 @@ interface operations {
|
|
|
804
1231
|
};
|
|
805
1232
|
requestBody: {
|
|
806
1233
|
content: {
|
|
807
|
-
"application/
|
|
1234
|
+
"application/xml": unknown;
|
|
1235
|
+
"text/xml": unknown;
|
|
1236
|
+
"application/octet-stream": unknown;
|
|
1237
|
+
"application/pdf": unknown;
|
|
808
1238
|
};
|
|
809
1239
|
};
|
|
810
1240
|
responses: {
|
|
1241
|
+
/** @description Default Response */
|
|
1242
|
+
200: {
|
|
1243
|
+
headers: {
|
|
1244
|
+
/** @description Format the engine read. */
|
|
1245
|
+
"x-source-format"?: string;
|
|
1246
|
+
/** @description Format the engine produced. */
|
|
1247
|
+
"x-target-format"?: string;
|
|
1248
|
+
/** @description CIUS/profile the engine matched, e.g. "xrechnung_3.0". */
|
|
1249
|
+
"x-profile-detected"?: string;
|
|
1250
|
+
/** @description How many source elements had no target equivalent. "0" means the conversion was lossless at the element level. */
|
|
1251
|
+
"x-lost-elements-count"?: string;
|
|
1252
|
+
/** @description JSON array naming the source elements that had no target equivalent, so a caller can decide whether the loss matters for their use. */
|
|
1253
|
+
"x-lost-elements"?: string;
|
|
1254
|
+
/** @description Toolchain that performed the conversion, for audit purposes. */
|
|
1255
|
+
"x-conversion-tools"?: string;
|
|
1256
|
+
/** @description Envelope the produced document is wrapped in, when it has one. */
|
|
1257
|
+
"x-output-envelope"?: string;
|
|
1258
|
+
/** @description Compact JSON naming the ruleset/artifact versions pinned for the produced format. Descriptive only; conversion runs no validation over its output. */
|
|
1259
|
+
"x-version-block"?: string;
|
|
1260
|
+
/** @description "true" for a live key, "false" for a test key. Test-mode documents are watermarked and do not draw on the live monthly quota. */
|
|
1261
|
+
"x-beliq-livemode"?: string;
|
|
1262
|
+
/** @description Correlation id for this request. Quote it in a support request; it is the key the API, the engine, and error tracking all record. */
|
|
1263
|
+
"x-request-id"?: string;
|
|
1264
|
+
[name: string]: unknown;
|
|
1265
|
+
};
|
|
1266
|
+
content: {
|
|
1267
|
+
"application/xml": string;
|
|
1268
|
+
"application/pdf": string;
|
|
1269
|
+
};
|
|
1270
|
+
};
|
|
811
1271
|
/** @description Default Response */
|
|
812
1272
|
400: {
|
|
813
1273
|
headers: {
|
|
@@ -818,7 +1278,91 @@ interface operations {
|
|
|
818
1278
|
/** @enum {boolean} */
|
|
819
1279
|
success: false;
|
|
820
1280
|
error: {
|
|
821
|
-
code: "VALIDATION_ERROR" | "INVALID_INVOICE" | "
|
|
1281
|
+
code: "VALIDATION_ERROR" | "INVALID_INVOICE" | "PROFILE_STANDARD_MISMATCH" | "DOCUMENT_TYPE_STANDARD_MISMATCH" | "PARSE_FAILED" | "AUTHENTICATION_REQUIRED" | "INVALID_API_KEY" | "QUOTA_EXCEEDED" | "RATE_LIMITED" | "ACCOUNT_THROTTLED" | "ENGINE_UNAVAILABLE" | "INTERNAL_ERROR" | "NOT_FOUND" | "CONVERSION_UNSUPPORTED_PAIR" | "CONVERSION_LOSSY_FAILCLOSED" | "CONVERSION_TOOL_UNAVAILABLE" | "CONVERSION_TOOL_ERROR" | "PDF_TEMPLATE_AUTH_REQUIRED" | "PDF_TEMPLATE_NOT_FOUND" | "PDF_TEMPLATE_INVALID" | "TRANSMISSION_DISABLED" | "TRANSMISSION_NO_PROVIDER" | "IDEMPOTENCY_KEY_REUSED" | "INVALID_IDEMPOTENCY_KEY" | "SENDER_NOT_REGISTERED" | "CONTENT_ALREADY_SENT" | "INBOX_UNKNOWN_PROVIDER" | "INBOX_VERIFICATION_FAILED" | "INBOX_SIGNATURE_EXPIRED" | "RECIPIENT_NOT_ROUTABLE" | "SENDER_COUNTRY_MISSING" | "DOCUMENT_PARTY_MISMATCH" | "FRENCH_DOMESTIC_FLOW" | "UNSUPPORTED_SYNTAX" | "MALFORMED_DOCUMENT" | "EMPTY_DOCUMENT" | "MISSING_CUSTOMIZATION_ID" | "MISSING_PROCESS_ID";
|
|
1282
|
+
message: string;
|
|
1283
|
+
details?: {
|
|
1284
|
+
[key: string]: unknown;
|
|
1285
|
+
};
|
|
1286
|
+
/** @description Support correlation ID, present on 5xx responses only. Quote it when contacting support. */
|
|
1287
|
+
incidentId?: string;
|
|
1288
|
+
};
|
|
1289
|
+
};
|
|
1290
|
+
};
|
|
1291
|
+
};
|
|
1292
|
+
/** @description Default Response */
|
|
1293
|
+
401: {
|
|
1294
|
+
headers: {
|
|
1295
|
+
[name: string]: unknown;
|
|
1296
|
+
};
|
|
1297
|
+
content: {
|
|
1298
|
+
"application/json": {
|
|
1299
|
+
/** @enum {boolean} */
|
|
1300
|
+
success: false;
|
|
1301
|
+
error: {
|
|
1302
|
+
code: "VALIDATION_ERROR" | "INVALID_INVOICE" | "PROFILE_STANDARD_MISMATCH" | "DOCUMENT_TYPE_STANDARD_MISMATCH" | "PARSE_FAILED" | "AUTHENTICATION_REQUIRED" | "INVALID_API_KEY" | "QUOTA_EXCEEDED" | "RATE_LIMITED" | "ACCOUNT_THROTTLED" | "ENGINE_UNAVAILABLE" | "INTERNAL_ERROR" | "NOT_FOUND" | "CONVERSION_UNSUPPORTED_PAIR" | "CONVERSION_LOSSY_FAILCLOSED" | "CONVERSION_TOOL_UNAVAILABLE" | "CONVERSION_TOOL_ERROR" | "PDF_TEMPLATE_AUTH_REQUIRED" | "PDF_TEMPLATE_NOT_FOUND" | "PDF_TEMPLATE_INVALID" | "TRANSMISSION_DISABLED" | "TRANSMISSION_NO_PROVIDER" | "IDEMPOTENCY_KEY_REUSED" | "INVALID_IDEMPOTENCY_KEY" | "SENDER_NOT_REGISTERED" | "CONTENT_ALREADY_SENT" | "INBOX_UNKNOWN_PROVIDER" | "INBOX_VERIFICATION_FAILED" | "INBOX_SIGNATURE_EXPIRED" | "RECIPIENT_NOT_ROUTABLE" | "SENDER_COUNTRY_MISSING" | "DOCUMENT_PARTY_MISMATCH" | "FRENCH_DOMESTIC_FLOW" | "UNSUPPORTED_SYNTAX" | "MALFORMED_DOCUMENT" | "EMPTY_DOCUMENT" | "MISSING_CUSTOMIZATION_ID" | "MISSING_PROCESS_ID";
|
|
1303
|
+
message: string;
|
|
1304
|
+
details?: {
|
|
1305
|
+
[key: string]: unknown;
|
|
1306
|
+
};
|
|
1307
|
+
/** @description Support correlation ID, present on 5xx responses only. Quote it when contacting support. */
|
|
1308
|
+
incidentId?: string;
|
|
1309
|
+
};
|
|
1310
|
+
};
|
|
1311
|
+
};
|
|
1312
|
+
};
|
|
1313
|
+
/** @description Default Response */
|
|
1314
|
+
403: {
|
|
1315
|
+
headers: {
|
|
1316
|
+
[name: string]: unknown;
|
|
1317
|
+
};
|
|
1318
|
+
content: {
|
|
1319
|
+
"application/json": {
|
|
1320
|
+
/** @enum {boolean} */
|
|
1321
|
+
success: false;
|
|
1322
|
+
error: {
|
|
1323
|
+
code: "VALIDATION_ERROR" | "INVALID_INVOICE" | "PROFILE_STANDARD_MISMATCH" | "DOCUMENT_TYPE_STANDARD_MISMATCH" | "PARSE_FAILED" | "AUTHENTICATION_REQUIRED" | "INVALID_API_KEY" | "QUOTA_EXCEEDED" | "RATE_LIMITED" | "ACCOUNT_THROTTLED" | "ENGINE_UNAVAILABLE" | "INTERNAL_ERROR" | "NOT_FOUND" | "CONVERSION_UNSUPPORTED_PAIR" | "CONVERSION_LOSSY_FAILCLOSED" | "CONVERSION_TOOL_UNAVAILABLE" | "CONVERSION_TOOL_ERROR" | "PDF_TEMPLATE_AUTH_REQUIRED" | "PDF_TEMPLATE_NOT_FOUND" | "PDF_TEMPLATE_INVALID" | "TRANSMISSION_DISABLED" | "TRANSMISSION_NO_PROVIDER" | "IDEMPOTENCY_KEY_REUSED" | "INVALID_IDEMPOTENCY_KEY" | "SENDER_NOT_REGISTERED" | "CONTENT_ALREADY_SENT" | "INBOX_UNKNOWN_PROVIDER" | "INBOX_VERIFICATION_FAILED" | "INBOX_SIGNATURE_EXPIRED" | "RECIPIENT_NOT_ROUTABLE" | "SENDER_COUNTRY_MISSING" | "DOCUMENT_PARTY_MISMATCH" | "FRENCH_DOMESTIC_FLOW" | "UNSUPPORTED_SYNTAX" | "MALFORMED_DOCUMENT" | "EMPTY_DOCUMENT" | "MISSING_CUSTOMIZATION_ID" | "MISSING_PROCESS_ID";
|
|
1324
|
+
message: string;
|
|
1325
|
+
details?: {
|
|
1326
|
+
[key: string]: unknown;
|
|
1327
|
+
};
|
|
1328
|
+
/** @description Support correlation ID, present on 5xx responses only. Quote it when contacting support. */
|
|
1329
|
+
incidentId?: string;
|
|
1330
|
+
};
|
|
1331
|
+
};
|
|
1332
|
+
};
|
|
1333
|
+
};
|
|
1334
|
+
/** @description Default Response */
|
|
1335
|
+
413: {
|
|
1336
|
+
headers: {
|
|
1337
|
+
[name: string]: unknown;
|
|
1338
|
+
};
|
|
1339
|
+
content: {
|
|
1340
|
+
"application/json": {
|
|
1341
|
+
/** @enum {boolean} */
|
|
1342
|
+
success: false;
|
|
1343
|
+
error: {
|
|
1344
|
+
code: "VALIDATION_ERROR" | "INVALID_INVOICE" | "PROFILE_STANDARD_MISMATCH" | "DOCUMENT_TYPE_STANDARD_MISMATCH" | "PARSE_FAILED" | "AUTHENTICATION_REQUIRED" | "INVALID_API_KEY" | "QUOTA_EXCEEDED" | "RATE_LIMITED" | "ACCOUNT_THROTTLED" | "ENGINE_UNAVAILABLE" | "INTERNAL_ERROR" | "NOT_FOUND" | "CONVERSION_UNSUPPORTED_PAIR" | "CONVERSION_LOSSY_FAILCLOSED" | "CONVERSION_TOOL_UNAVAILABLE" | "CONVERSION_TOOL_ERROR" | "PDF_TEMPLATE_AUTH_REQUIRED" | "PDF_TEMPLATE_NOT_FOUND" | "PDF_TEMPLATE_INVALID" | "TRANSMISSION_DISABLED" | "TRANSMISSION_NO_PROVIDER" | "IDEMPOTENCY_KEY_REUSED" | "INVALID_IDEMPOTENCY_KEY" | "SENDER_NOT_REGISTERED" | "CONTENT_ALREADY_SENT" | "INBOX_UNKNOWN_PROVIDER" | "INBOX_VERIFICATION_FAILED" | "INBOX_SIGNATURE_EXPIRED" | "RECIPIENT_NOT_ROUTABLE" | "SENDER_COUNTRY_MISSING" | "DOCUMENT_PARTY_MISMATCH" | "FRENCH_DOMESTIC_FLOW" | "UNSUPPORTED_SYNTAX" | "MALFORMED_DOCUMENT" | "EMPTY_DOCUMENT" | "MISSING_CUSTOMIZATION_ID" | "MISSING_PROCESS_ID";
|
|
1345
|
+
message: string;
|
|
1346
|
+
details?: {
|
|
1347
|
+
[key: string]: unknown;
|
|
1348
|
+
};
|
|
1349
|
+
/** @description Support correlation ID, present on 5xx responses only. Quote it when contacting support. */
|
|
1350
|
+
incidentId?: string;
|
|
1351
|
+
};
|
|
1352
|
+
};
|
|
1353
|
+
};
|
|
1354
|
+
};
|
|
1355
|
+
/** @description Default Response */
|
|
1356
|
+
415: {
|
|
1357
|
+
headers: {
|
|
1358
|
+
[name: string]: unknown;
|
|
1359
|
+
};
|
|
1360
|
+
content: {
|
|
1361
|
+
"application/json": {
|
|
1362
|
+
/** @enum {boolean} */
|
|
1363
|
+
success: false;
|
|
1364
|
+
error: {
|
|
1365
|
+
code: "VALIDATION_ERROR" | "INVALID_INVOICE" | "PROFILE_STANDARD_MISMATCH" | "DOCUMENT_TYPE_STANDARD_MISMATCH" | "PARSE_FAILED" | "AUTHENTICATION_REQUIRED" | "INVALID_API_KEY" | "QUOTA_EXCEEDED" | "RATE_LIMITED" | "ACCOUNT_THROTTLED" | "ENGINE_UNAVAILABLE" | "INTERNAL_ERROR" | "NOT_FOUND" | "CONVERSION_UNSUPPORTED_PAIR" | "CONVERSION_LOSSY_FAILCLOSED" | "CONVERSION_TOOL_UNAVAILABLE" | "CONVERSION_TOOL_ERROR" | "PDF_TEMPLATE_AUTH_REQUIRED" | "PDF_TEMPLATE_NOT_FOUND" | "PDF_TEMPLATE_INVALID" | "TRANSMISSION_DISABLED" | "TRANSMISSION_NO_PROVIDER" | "IDEMPOTENCY_KEY_REUSED" | "INVALID_IDEMPOTENCY_KEY" | "SENDER_NOT_REGISTERED" | "CONTENT_ALREADY_SENT" | "INBOX_UNKNOWN_PROVIDER" | "INBOX_VERIFICATION_FAILED" | "INBOX_SIGNATURE_EXPIRED" | "RECIPIENT_NOT_ROUTABLE" | "SENDER_COUNTRY_MISSING" | "DOCUMENT_PARTY_MISMATCH" | "FRENCH_DOMESTIC_FLOW" | "UNSUPPORTED_SYNTAX" | "MALFORMED_DOCUMENT" | "EMPTY_DOCUMENT" | "MISSING_CUSTOMIZATION_ID" | "MISSING_PROCESS_ID";
|
|
822
1366
|
message: string;
|
|
823
1367
|
details?: {
|
|
824
1368
|
[key: string]: unknown;
|
|
@@ -839,7 +1383,28 @@ interface operations {
|
|
|
839
1383
|
/** @enum {boolean} */
|
|
840
1384
|
success: false;
|
|
841
1385
|
error: {
|
|
842
|
-
code: "VALIDATION_ERROR" | "INVALID_INVOICE" | "
|
|
1386
|
+
code: "VALIDATION_ERROR" | "INVALID_INVOICE" | "PROFILE_STANDARD_MISMATCH" | "DOCUMENT_TYPE_STANDARD_MISMATCH" | "PARSE_FAILED" | "AUTHENTICATION_REQUIRED" | "INVALID_API_KEY" | "QUOTA_EXCEEDED" | "RATE_LIMITED" | "ACCOUNT_THROTTLED" | "ENGINE_UNAVAILABLE" | "INTERNAL_ERROR" | "NOT_FOUND" | "CONVERSION_UNSUPPORTED_PAIR" | "CONVERSION_LOSSY_FAILCLOSED" | "CONVERSION_TOOL_UNAVAILABLE" | "CONVERSION_TOOL_ERROR" | "PDF_TEMPLATE_AUTH_REQUIRED" | "PDF_TEMPLATE_NOT_FOUND" | "PDF_TEMPLATE_INVALID" | "TRANSMISSION_DISABLED" | "TRANSMISSION_NO_PROVIDER" | "IDEMPOTENCY_KEY_REUSED" | "INVALID_IDEMPOTENCY_KEY" | "SENDER_NOT_REGISTERED" | "CONTENT_ALREADY_SENT" | "INBOX_UNKNOWN_PROVIDER" | "INBOX_VERIFICATION_FAILED" | "INBOX_SIGNATURE_EXPIRED" | "RECIPIENT_NOT_ROUTABLE" | "SENDER_COUNTRY_MISSING" | "DOCUMENT_PARTY_MISMATCH" | "FRENCH_DOMESTIC_FLOW" | "UNSUPPORTED_SYNTAX" | "MALFORMED_DOCUMENT" | "EMPTY_DOCUMENT" | "MISSING_CUSTOMIZATION_ID" | "MISSING_PROCESS_ID";
|
|
1387
|
+
message: string;
|
|
1388
|
+
details?: {
|
|
1389
|
+
[key: string]: unknown;
|
|
1390
|
+
};
|
|
1391
|
+
/** @description Support correlation ID, present on 5xx responses only. Quote it when contacting support. */
|
|
1392
|
+
incidentId?: string;
|
|
1393
|
+
};
|
|
1394
|
+
};
|
|
1395
|
+
};
|
|
1396
|
+
};
|
|
1397
|
+
/** @description Default Response */
|
|
1398
|
+
429: {
|
|
1399
|
+
headers: {
|
|
1400
|
+
[name: string]: unknown;
|
|
1401
|
+
};
|
|
1402
|
+
content: {
|
|
1403
|
+
"application/json": {
|
|
1404
|
+
/** @enum {boolean} */
|
|
1405
|
+
success: false;
|
|
1406
|
+
error: {
|
|
1407
|
+
code: "VALIDATION_ERROR" | "INVALID_INVOICE" | "PROFILE_STANDARD_MISMATCH" | "DOCUMENT_TYPE_STANDARD_MISMATCH" | "PARSE_FAILED" | "AUTHENTICATION_REQUIRED" | "INVALID_API_KEY" | "QUOTA_EXCEEDED" | "RATE_LIMITED" | "ACCOUNT_THROTTLED" | "ENGINE_UNAVAILABLE" | "INTERNAL_ERROR" | "NOT_FOUND" | "CONVERSION_UNSUPPORTED_PAIR" | "CONVERSION_LOSSY_FAILCLOSED" | "CONVERSION_TOOL_UNAVAILABLE" | "CONVERSION_TOOL_ERROR" | "PDF_TEMPLATE_AUTH_REQUIRED" | "PDF_TEMPLATE_NOT_FOUND" | "PDF_TEMPLATE_INVALID" | "TRANSMISSION_DISABLED" | "TRANSMISSION_NO_PROVIDER" | "IDEMPOTENCY_KEY_REUSED" | "INVALID_IDEMPOTENCY_KEY" | "SENDER_NOT_REGISTERED" | "CONTENT_ALREADY_SENT" | "INBOX_UNKNOWN_PROVIDER" | "INBOX_VERIFICATION_FAILED" | "INBOX_SIGNATURE_EXPIRED" | "RECIPIENT_NOT_ROUTABLE" | "SENDER_COUNTRY_MISSING" | "DOCUMENT_PARTY_MISMATCH" | "FRENCH_DOMESTIC_FLOW" | "UNSUPPORTED_SYNTAX" | "MALFORMED_DOCUMENT" | "EMPTY_DOCUMENT" | "MISSING_CUSTOMIZATION_ID" | "MISSING_PROCESS_ID";
|
|
843
1408
|
message: string;
|
|
844
1409
|
details?: {
|
|
845
1410
|
[key: string]: unknown;
|
|
@@ -860,7 +1425,7 @@ interface operations {
|
|
|
860
1425
|
/** @enum {boolean} */
|
|
861
1426
|
success: false;
|
|
862
1427
|
error: {
|
|
863
|
-
code: "VALIDATION_ERROR" | "INVALID_INVOICE" | "
|
|
1428
|
+
code: "VALIDATION_ERROR" | "INVALID_INVOICE" | "PROFILE_STANDARD_MISMATCH" | "DOCUMENT_TYPE_STANDARD_MISMATCH" | "PARSE_FAILED" | "AUTHENTICATION_REQUIRED" | "INVALID_API_KEY" | "QUOTA_EXCEEDED" | "RATE_LIMITED" | "ACCOUNT_THROTTLED" | "ENGINE_UNAVAILABLE" | "INTERNAL_ERROR" | "NOT_FOUND" | "CONVERSION_UNSUPPORTED_PAIR" | "CONVERSION_LOSSY_FAILCLOSED" | "CONVERSION_TOOL_UNAVAILABLE" | "CONVERSION_TOOL_ERROR" | "PDF_TEMPLATE_AUTH_REQUIRED" | "PDF_TEMPLATE_NOT_FOUND" | "PDF_TEMPLATE_INVALID" | "TRANSMISSION_DISABLED" | "TRANSMISSION_NO_PROVIDER" | "IDEMPOTENCY_KEY_REUSED" | "INVALID_IDEMPOTENCY_KEY" | "SENDER_NOT_REGISTERED" | "CONTENT_ALREADY_SENT" | "INBOX_UNKNOWN_PROVIDER" | "INBOX_VERIFICATION_FAILED" | "INBOX_SIGNATURE_EXPIRED" | "RECIPIENT_NOT_ROUTABLE" | "SENDER_COUNTRY_MISSING" | "DOCUMENT_PARTY_MISMATCH" | "FRENCH_DOMESTIC_FLOW" | "UNSUPPORTED_SYNTAX" | "MALFORMED_DOCUMENT" | "EMPTY_DOCUMENT" | "MISSING_CUSTOMIZATION_ID" | "MISSING_PROCESS_ID";
|
|
864
1429
|
message: string;
|
|
865
1430
|
details?: {
|
|
866
1431
|
[key: string]: unknown;
|
|
@@ -881,7 +1446,7 @@ interface operations {
|
|
|
881
1446
|
/** @enum {boolean} */
|
|
882
1447
|
success: false;
|
|
883
1448
|
error: {
|
|
884
|
-
code: "VALIDATION_ERROR" | "INVALID_INVOICE" | "
|
|
1449
|
+
code: "VALIDATION_ERROR" | "INVALID_INVOICE" | "PROFILE_STANDARD_MISMATCH" | "DOCUMENT_TYPE_STANDARD_MISMATCH" | "PARSE_FAILED" | "AUTHENTICATION_REQUIRED" | "INVALID_API_KEY" | "QUOTA_EXCEEDED" | "RATE_LIMITED" | "ACCOUNT_THROTTLED" | "ENGINE_UNAVAILABLE" | "INTERNAL_ERROR" | "NOT_FOUND" | "CONVERSION_UNSUPPORTED_PAIR" | "CONVERSION_LOSSY_FAILCLOSED" | "CONVERSION_TOOL_UNAVAILABLE" | "CONVERSION_TOOL_ERROR" | "PDF_TEMPLATE_AUTH_REQUIRED" | "PDF_TEMPLATE_NOT_FOUND" | "PDF_TEMPLATE_INVALID" | "TRANSMISSION_DISABLED" | "TRANSMISSION_NO_PROVIDER" | "IDEMPOTENCY_KEY_REUSED" | "INVALID_IDEMPOTENCY_KEY" | "SENDER_NOT_REGISTERED" | "CONTENT_ALREADY_SENT" | "INBOX_UNKNOWN_PROVIDER" | "INBOX_VERIFICATION_FAILED" | "INBOX_SIGNATURE_EXPIRED" | "RECIPIENT_NOT_ROUTABLE" | "SENDER_COUNTRY_MISSING" | "DOCUMENT_PARTY_MISMATCH" | "FRENCH_DOMESTIC_FLOW" | "UNSUPPORTED_SYNTAX" | "MALFORMED_DOCUMENT" | "EMPTY_DOCUMENT" | "MISSING_CUSTOMIZATION_ID" | "MISSING_PROCESS_ID";
|
|
885
1450
|
message: string;
|
|
886
1451
|
details?: {
|
|
887
1452
|
[key: string]: unknown;
|
|
@@ -906,6 +1471,8 @@ interface operations {
|
|
|
906
1471
|
/** @description Default Response */
|
|
907
1472
|
200: {
|
|
908
1473
|
headers: {
|
|
1474
|
+
/** @description Correlation id for this request. Quote it in a support request; it is the key the API, the engine, and error tracking all record. */
|
|
1475
|
+
"x-request-id"?: string;
|
|
909
1476
|
[name: string]: unknown;
|
|
910
1477
|
};
|
|
911
1478
|
content: {
|
|
@@ -934,6 +1501,18 @@ interface operations {
|
|
|
934
1501
|
label: string;
|
|
935
1502
|
description: string;
|
|
936
1503
|
}[];
|
|
1504
|
+
scheduledChanges: {
|
|
1505
|
+
versionKey: string;
|
|
1506
|
+
formats: string[];
|
|
1507
|
+
from: string;
|
|
1508
|
+
to: string;
|
|
1509
|
+
/** @description ISO 8601 date (YYYY-MM-DD). When `latest` moves from `from` to `to`. */
|
|
1510
|
+
effectiveOn: string;
|
|
1511
|
+
/** @description ISO 8601 date (YYYY-MM-DD) the change was announced in the public ruleset changelog, or null when it has not been recorded yet. */
|
|
1512
|
+
noticePublishedOn: string | null;
|
|
1513
|
+
/** @description ISO 8601 date (YYYY-MM-DD) after which `from` is no longer served at all, or null when nothing retires it. Later than `effectiveOn`, and the date to act on: it is when a `Beliq-Ruleset: previous` pin stops resolving to `from` and an exact pin on it starts returning a 422. */
|
|
1514
|
+
retiredOn: string | null;
|
|
1515
|
+
}[];
|
|
937
1516
|
artifacts: {
|
|
938
1517
|
key: string;
|
|
939
1518
|
version: string;
|
|
@@ -941,7 +1520,28 @@ interface operations {
|
|
|
941
1520
|
}[];
|
|
942
1521
|
};
|
|
943
1522
|
error?: {
|
|
944
|
-
code: "VALIDATION_ERROR" | "INVALID_INVOICE" | "
|
|
1523
|
+
code: "VALIDATION_ERROR" | "INVALID_INVOICE" | "PROFILE_STANDARD_MISMATCH" | "DOCUMENT_TYPE_STANDARD_MISMATCH" | "PARSE_FAILED" | "AUTHENTICATION_REQUIRED" | "INVALID_API_KEY" | "QUOTA_EXCEEDED" | "RATE_LIMITED" | "ACCOUNT_THROTTLED" | "ENGINE_UNAVAILABLE" | "INTERNAL_ERROR" | "NOT_FOUND" | "CONVERSION_UNSUPPORTED_PAIR" | "CONVERSION_LOSSY_FAILCLOSED" | "CONVERSION_TOOL_UNAVAILABLE" | "CONVERSION_TOOL_ERROR" | "PDF_TEMPLATE_AUTH_REQUIRED" | "PDF_TEMPLATE_NOT_FOUND" | "PDF_TEMPLATE_INVALID" | "TRANSMISSION_DISABLED" | "TRANSMISSION_NO_PROVIDER" | "IDEMPOTENCY_KEY_REUSED" | "INVALID_IDEMPOTENCY_KEY" | "SENDER_NOT_REGISTERED" | "CONTENT_ALREADY_SENT" | "INBOX_UNKNOWN_PROVIDER" | "INBOX_VERIFICATION_FAILED" | "INBOX_SIGNATURE_EXPIRED" | "RECIPIENT_NOT_ROUTABLE" | "SENDER_COUNTRY_MISSING" | "DOCUMENT_PARTY_MISMATCH" | "FRENCH_DOMESTIC_FLOW" | "UNSUPPORTED_SYNTAX" | "MALFORMED_DOCUMENT" | "EMPTY_DOCUMENT" | "MISSING_CUSTOMIZATION_ID" | "MISSING_PROCESS_ID";
|
|
1524
|
+
message: string;
|
|
1525
|
+
details?: {
|
|
1526
|
+
[key: string]: unknown;
|
|
1527
|
+
};
|
|
1528
|
+
/** @description Support correlation ID, present on 5xx responses only. Quote it when contacting support. */
|
|
1529
|
+
incidentId?: string;
|
|
1530
|
+
};
|
|
1531
|
+
};
|
|
1532
|
+
};
|
|
1533
|
+
};
|
|
1534
|
+
/** @description Default Response */
|
|
1535
|
+
429: {
|
|
1536
|
+
headers: {
|
|
1537
|
+
[name: string]: unknown;
|
|
1538
|
+
};
|
|
1539
|
+
content: {
|
|
1540
|
+
"application/json": {
|
|
1541
|
+
/** @enum {boolean} */
|
|
1542
|
+
success: false;
|
|
1543
|
+
error: {
|
|
1544
|
+
code: "VALIDATION_ERROR" | "INVALID_INVOICE" | "PROFILE_STANDARD_MISMATCH" | "DOCUMENT_TYPE_STANDARD_MISMATCH" | "PARSE_FAILED" | "AUTHENTICATION_REQUIRED" | "INVALID_API_KEY" | "QUOTA_EXCEEDED" | "RATE_LIMITED" | "ACCOUNT_THROTTLED" | "ENGINE_UNAVAILABLE" | "INTERNAL_ERROR" | "NOT_FOUND" | "CONVERSION_UNSUPPORTED_PAIR" | "CONVERSION_LOSSY_FAILCLOSED" | "CONVERSION_TOOL_UNAVAILABLE" | "CONVERSION_TOOL_ERROR" | "PDF_TEMPLATE_AUTH_REQUIRED" | "PDF_TEMPLATE_NOT_FOUND" | "PDF_TEMPLATE_INVALID" | "TRANSMISSION_DISABLED" | "TRANSMISSION_NO_PROVIDER" | "IDEMPOTENCY_KEY_REUSED" | "INVALID_IDEMPOTENCY_KEY" | "SENDER_NOT_REGISTERED" | "CONTENT_ALREADY_SENT" | "INBOX_UNKNOWN_PROVIDER" | "INBOX_VERIFICATION_FAILED" | "INBOX_SIGNATURE_EXPIRED" | "RECIPIENT_NOT_ROUTABLE" | "SENDER_COUNTRY_MISSING" | "DOCUMENT_PARTY_MISMATCH" | "FRENCH_DOMESTIC_FLOW" | "UNSUPPORTED_SYNTAX" | "MALFORMED_DOCUMENT" | "EMPTY_DOCUMENT" | "MISSING_CUSTOMIZATION_ID" | "MISSING_PROCESS_ID";
|
|
945
1545
|
message: string;
|
|
946
1546
|
details?: {
|
|
947
1547
|
[key: string]: unknown;
|
|
@@ -1023,6 +1623,21 @@ interface BeliqOptions {
|
|
|
1023
1623
|
auth?: 'header' | 'bearer';
|
|
1024
1624
|
/** Inject a fetch implementation (tests, custom agents). Defaults to global fetch. */
|
|
1025
1625
|
fetch?: typeof fetch;
|
|
1626
|
+
/**
|
|
1627
|
+
* Per-attempt deadline in ms (default 90000). Generous on purpose: beliq runs
|
|
1628
|
+
* the full Schematron rule set over a document, so a generate or validate can
|
|
1629
|
+
* take tens of seconds legitimately. Set well above the latency you expect —
|
|
1630
|
+
* a deadline shorter than the server's own means giving up on work that is
|
|
1631
|
+
* still running, which is the one case a retry can duplicate a document.
|
|
1632
|
+
* 0 disables the deadline.
|
|
1633
|
+
*/
|
|
1634
|
+
timeoutMs?: number;
|
|
1635
|
+
/**
|
|
1636
|
+
* Extra attempts after the first (default 3). Retries only 429, 502 and 503,
|
|
1637
|
+
* honouring `Retry-After`; beliq refunds the quota unit on a 503, so a retry
|
|
1638
|
+
* costs nothing. 0 disables retrying.
|
|
1639
|
+
*/
|
|
1640
|
+
maxRetries?: number;
|
|
1026
1641
|
}
|
|
1027
1642
|
interface GenerateInput {
|
|
1028
1643
|
standard: Standard;
|