@beliq/sdk 0.1.1 → 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 +65 -5
- package/dist/constants-BZuNzqbV.d.cts +85 -0
- package/dist/constants-BZuNzqbV.d.ts +85 -0
- package/dist/helpers.cjs +30 -1
- package/dist/helpers.d.cts +6 -2
- package/dist/helpers.d.ts +6 -2
- package/dist/helpers.js +26 -1
- package/dist/index.cjs +161 -18
- package/dist/index.d.cts +806 -30
- package/dist/index.d.ts +806 -30
- package/dist/index.js +154 -17
- package/package.json +12 -6
- package/dist/constants-bWOXCmJD.d.cts +0 -22
- package/dist/constants-bWOXCmJD.d.ts +0 -22
package/dist/index.d.cts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
import { P as PlainObject, a as DocumentInput } from './constants-
|
|
2
|
-
export { D as DEFAULT_BASE_URL, L as LIVE_CONVERT_SOURCE_FORMATS, b as LIVE_CONVERT_TARGET_FORMATS, c as
|
|
1
|
+
import { P as PlainObject, a as DocumentInput } from './constants-BZuNzqbV.cjs';
|
|
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.cjs';
|
|
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,28 +47,36 @@ 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;
|
|
55
|
+
rulesetChannel: "latest" | "previous";
|
|
49
56
|
};
|
|
50
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. */
|
|
51
59
|
id: number | null;
|
|
52
|
-
|
|
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;
|
|
53
62
|
};
|
|
54
63
|
rateLimitPerMinute: number;
|
|
55
64
|
quota: {
|
|
56
65
|
limit: number;
|
|
57
66
|
used: number;
|
|
58
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. */
|
|
59
69
|
resetsAt: string;
|
|
60
70
|
};
|
|
61
71
|
};
|
|
62
72
|
error?: {
|
|
63
|
-
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";
|
|
64
74
|
message: string;
|
|
65
75
|
details?: {
|
|
66
76
|
[key: string]: unknown;
|
|
67
77
|
};
|
|
78
|
+
/** @description Support correlation ID, present on 5xx responses only. Quote it when contacting support. */
|
|
79
|
+
incidentId?: string;
|
|
68
80
|
};
|
|
69
81
|
};
|
|
70
82
|
};
|
|
@@ -79,11 +91,13 @@ interface operations {
|
|
|
79
91
|
/** @enum {boolean} */
|
|
80
92
|
success: false;
|
|
81
93
|
error: {
|
|
82
|
-
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";
|
|
83
95
|
message: string;
|
|
84
96
|
details?: {
|
|
85
97
|
[key: string]: unknown;
|
|
86
98
|
};
|
|
99
|
+
/** @description Support correlation ID, present on 5xx responses only. Quote it when contacting support. */
|
|
100
|
+
incidentId?: string;
|
|
87
101
|
};
|
|
88
102
|
};
|
|
89
103
|
};
|
|
@@ -98,11 +112,34 @@ interface operations {
|
|
|
98
112
|
/** @enum {boolean} */
|
|
99
113
|
success: false;
|
|
100
114
|
error: {
|
|
101
|
-
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";
|
|
102
116
|
message: string;
|
|
103
117
|
details?: {
|
|
104
118
|
[key: string]: unknown;
|
|
105
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";
|
|
137
|
+
message: string;
|
|
138
|
+
details?: {
|
|
139
|
+
[key: string]: unknown;
|
|
140
|
+
};
|
|
141
|
+
/** @description Support correlation ID, present on 5xx responses only. Quote it when contacting support. */
|
|
142
|
+
incidentId?: string;
|
|
106
143
|
};
|
|
107
144
|
};
|
|
108
145
|
};
|
|
@@ -120,7 +157,7 @@ interface operations {
|
|
|
120
157
|
content: {
|
|
121
158
|
"application/json": {
|
|
122
159
|
standard: "xrechnung" | "zugferd" | "facturx" | "peppol-bis" | "fatturapa" | "facturae" | "eslog";
|
|
123
|
-
profile?: "minimum" | "basicwl" | "basic" | "en16931" | "extended" | "extended-ctc-fr" | "xrechnung" | "peppol" | "romania-ro-cius" | "netherlands-nlcius" | "ordinaria" | "eracun";
|
|
160
|
+
profile?: "minimum" | "basicwl" | "basic" | "en16931" | "extended" | "extended-ctc-fr" | "xrechnung" | "peppol" | "romania-ro-cius" | "netherlands-nlcius" | "ordinaria" | "eracun" | "fa3";
|
|
124
161
|
facturxProfile?: "minimum" | "basicwl" | "basic" | "en16931" | "extended" | "extended-ctc-fr";
|
|
125
162
|
output: "xml" | "pdf";
|
|
126
163
|
invoice: {
|
|
@@ -153,6 +190,7 @@ interface operations {
|
|
|
153
190
|
state?: string;
|
|
154
191
|
region?: string;
|
|
155
192
|
province?: string;
|
|
193
|
+
countrySubentity?: string;
|
|
156
194
|
};
|
|
157
195
|
contactName?: string;
|
|
158
196
|
peppol?: {
|
|
@@ -177,6 +215,7 @@ interface operations {
|
|
|
177
215
|
state?: string;
|
|
178
216
|
region?: string;
|
|
179
217
|
province?: string;
|
|
218
|
+
countrySubentity?: string;
|
|
180
219
|
};
|
|
181
220
|
contactName?: string;
|
|
182
221
|
peppol?: {
|
|
@@ -201,6 +240,8 @@ interface operations {
|
|
|
201
240
|
vatRate: number;
|
|
202
241
|
taxableAmount: number;
|
|
203
242
|
taxAmount: number;
|
|
243
|
+
exemptionReasonText?: string;
|
|
244
|
+
exemptionReasonCode?: string;
|
|
204
245
|
}[];
|
|
205
246
|
paymentMeans?: {
|
|
206
247
|
typeCode: string;
|
|
@@ -261,9 +302,31 @@ interface operations {
|
|
|
261
302
|
/** @description Default Response */
|
|
262
303
|
200: {
|
|
263
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;
|
|
264
325
|
[name: string]: unknown;
|
|
265
326
|
};
|
|
266
327
|
content: {
|
|
328
|
+
"application/xml": string;
|
|
329
|
+
"application/pdf": string;
|
|
267
330
|
"application/json": {
|
|
268
331
|
success: boolean;
|
|
269
332
|
data?: {
|
|
@@ -272,9 +335,23 @@ interface operations {
|
|
|
272
335
|
standard: string;
|
|
273
336
|
profile: string;
|
|
274
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. */
|
|
275
339
|
valid: boolean;
|
|
276
|
-
|
|
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;
|
|
342
|
+
format: "cii" | "ubl" | "fatturapa" | "facturae" | "eslog" | "sdi_messaggio" | "poland_ksef_fa2" | "poland_ksef_fa3" | "unknown";
|
|
343
|
+
sha256?: string;
|
|
344
|
+
rulesetSha256?: string;
|
|
345
|
+
rulesetArtifacts?: {
|
|
346
|
+
key: string;
|
|
347
|
+
version: string;
|
|
348
|
+
fileSha256: string;
|
|
349
|
+
}[];
|
|
350
|
+
/** Format: date-time */
|
|
351
|
+
driftCheckedAt?: string;
|
|
277
352
|
profileDetected?: string;
|
|
353
|
+
verificationTier?: "conformance-verified" | "builder-round-trip" | "reconstructed-rules" | "xsd-structural";
|
|
354
|
+
verificationBadge?: "authority-verified" | "independently-rule-checked" | "structure-checked";
|
|
278
355
|
schematronVersion?: string;
|
|
279
356
|
ciusVersion?: string;
|
|
280
357
|
peppolVersion?: string;
|
|
@@ -292,6 +369,13 @@ interface operations {
|
|
|
292
369
|
sloveniaEslogRuntimeVersion?: string;
|
|
293
370
|
romaniaRoCiusVersion?: string;
|
|
294
371
|
netherlandsNlciusVersion?: string;
|
|
372
|
+
rulesetChannel?: "latest" | "previous";
|
|
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;
|
|
295
379
|
errors: {
|
|
296
380
|
ruleId: string;
|
|
297
381
|
severity: "fatal" | "error" | "warning" | "info";
|
|
@@ -305,13 +389,20 @@ interface operations {
|
|
|
305
389
|
message: string;
|
|
306
390
|
}[];
|
|
307
391
|
};
|
|
392
|
+
output?: string;
|
|
393
|
+
outputFormat?: string;
|
|
394
|
+
contentType?: string;
|
|
395
|
+
sha256?: string;
|
|
396
|
+
pdfKind?: string;
|
|
308
397
|
};
|
|
309
398
|
error?: {
|
|
310
|
-
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";
|
|
311
400
|
message: string;
|
|
312
401
|
details?: {
|
|
313
402
|
[key: string]: unknown;
|
|
314
403
|
};
|
|
404
|
+
/** @description Support correlation ID, present on 5xx responses only. Quote it when contacting support. */
|
|
405
|
+
incidentId?: string;
|
|
315
406
|
};
|
|
316
407
|
};
|
|
317
408
|
};
|
|
@@ -326,11 +417,55 @@ interface operations {
|
|
|
326
417
|
/** @enum {boolean} */
|
|
327
418
|
success: false;
|
|
328
419
|
error: {
|
|
329
|
-
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";
|
|
330
463
|
message: string;
|
|
331
464
|
details?: {
|
|
332
465
|
[key: string]: unknown;
|
|
333
466
|
};
|
|
467
|
+
/** @description Support correlation ID, present on 5xx responses only. Quote it when contacting support. */
|
|
468
|
+
incidentId?: string;
|
|
334
469
|
};
|
|
335
470
|
};
|
|
336
471
|
};
|
|
@@ -345,11 +480,34 @@ interface operations {
|
|
|
345
480
|
/** @enum {boolean} */
|
|
346
481
|
success: false;
|
|
347
482
|
error: {
|
|
348
|
-
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";
|
|
349
484
|
message: string;
|
|
350
485
|
details?: {
|
|
351
486
|
[key: string]: unknown;
|
|
352
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";
|
|
505
|
+
message: string;
|
|
506
|
+
details?: {
|
|
507
|
+
[key: string]: unknown;
|
|
508
|
+
};
|
|
509
|
+
/** @description Support correlation ID, present on 5xx responses only. Quote it when contacting support. */
|
|
510
|
+
incidentId?: string;
|
|
353
511
|
};
|
|
354
512
|
};
|
|
355
513
|
};
|
|
@@ -364,11 +522,34 @@ interface operations {
|
|
|
364
522
|
/** @enum {boolean} */
|
|
365
523
|
success: false;
|
|
366
524
|
error: {
|
|
367
|
-
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";
|
|
368
547
|
message: string;
|
|
369
548
|
details?: {
|
|
370
549
|
[key: string]: unknown;
|
|
371
550
|
};
|
|
551
|
+
/** @description Support correlation ID, present on 5xx responses only. Quote it when contacting support. */
|
|
552
|
+
incidentId?: string;
|
|
372
553
|
};
|
|
373
554
|
};
|
|
374
555
|
};
|
|
@@ -383,11 +564,13 @@ interface operations {
|
|
|
383
564
|
/** @enum {boolean} */
|
|
384
565
|
success: false;
|
|
385
566
|
error: {
|
|
386
|
-
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";
|
|
387
568
|
message: string;
|
|
388
569
|
details?: {
|
|
389
570
|
[key: string]: unknown;
|
|
390
571
|
};
|
|
572
|
+
/** @description Support correlation ID, present on 5xx responses only. Quote it when contacting support. */
|
|
573
|
+
incidentId?: string;
|
|
391
574
|
};
|
|
392
575
|
};
|
|
393
576
|
};
|
|
@@ -400,28 +583,64 @@ interface operations {
|
|
|
400
583
|
format?: "auto" | "cii" | "ubl" | "fatturapa" | "sdi_messaggio" | "facturae" | "eslog";
|
|
401
584
|
franceCtc?: boolean;
|
|
402
585
|
};
|
|
403
|
-
header?:
|
|
586
|
+
header?: {
|
|
587
|
+
/** @description Pin the validation ruleset for this request. A channel ("latest" or "previous"), or a comma-separated list of exact per-format pins as "<artifactKey>:<version>" (e.g. "xrechnung_schematron:2.4.0"). The two forms are mutually exclusive. Default (no header) uses "latest". Effective on this route only — parse/generate/convert accept but ignore it. The applied ruleset is echoed in the Beliq-Ruleset-Resolved response header; see GET /v1/rulesets for selectable channels. */
|
|
588
|
+
"Beliq-Ruleset"?: string;
|
|
589
|
+
};
|
|
404
590
|
path?: never;
|
|
405
591
|
cookie?: never;
|
|
406
592
|
};
|
|
407
593
|
requestBody: {
|
|
408
594
|
content: {
|
|
409
|
-
"application/
|
|
595
|
+
"application/xml": unknown;
|
|
596
|
+
"text/xml": unknown;
|
|
597
|
+
"application/octet-stream": unknown;
|
|
598
|
+
"application/pdf": unknown;
|
|
410
599
|
};
|
|
411
600
|
};
|
|
412
601
|
responses: {
|
|
413
602
|
/** @description Default Response */
|
|
414
603
|
200: {
|
|
415
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;
|
|
416
621
|
[name: string]: unknown;
|
|
417
622
|
};
|
|
418
623
|
content: {
|
|
419
624
|
"application/json": {
|
|
420
625
|
success: boolean;
|
|
421
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. */
|
|
422
628
|
valid: boolean;
|
|
423
|
-
|
|
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;
|
|
631
|
+
format: "cii" | "ubl" | "fatturapa" | "facturae" | "eslog" | "sdi_messaggio" | "poland_ksef_fa2" | "poland_ksef_fa3" | "unknown";
|
|
632
|
+
sha256?: string;
|
|
633
|
+
rulesetSha256?: string;
|
|
634
|
+
rulesetArtifacts?: {
|
|
635
|
+
key: string;
|
|
636
|
+
version: string;
|
|
637
|
+
fileSha256: string;
|
|
638
|
+
}[];
|
|
639
|
+
/** Format: date-time */
|
|
640
|
+
driftCheckedAt?: string;
|
|
424
641
|
profileDetected?: string;
|
|
642
|
+
verificationTier?: "conformance-verified" | "builder-round-trip" | "reconstructed-rules" | "xsd-structural";
|
|
643
|
+
verificationBadge?: "authority-verified" | "independently-rule-checked" | "structure-checked";
|
|
425
644
|
schematronVersion?: string;
|
|
426
645
|
ciusVersion?: string;
|
|
427
646
|
peppolVersion?: string;
|
|
@@ -439,6 +658,13 @@ interface operations {
|
|
|
439
658
|
sloveniaEslogRuntimeVersion?: string;
|
|
440
659
|
romaniaRoCiusVersion?: string;
|
|
441
660
|
netherlandsNlciusVersion?: string;
|
|
661
|
+
rulesetChannel?: "latest" | "previous";
|
|
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;
|
|
442
668
|
errors: {
|
|
443
669
|
ruleId: string;
|
|
444
670
|
severity: "fatal" | "error" | "warning" | "info";
|
|
@@ -453,11 +679,13 @@ interface operations {
|
|
|
453
679
|
}[];
|
|
454
680
|
};
|
|
455
681
|
error?: {
|
|
456
|
-
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";
|
|
457
683
|
message: string;
|
|
458
684
|
details?: {
|
|
459
685
|
[key: string]: unknown;
|
|
460
686
|
};
|
|
687
|
+
/** @description Support correlation ID, present on 5xx responses only. Quote it when contacting support. */
|
|
688
|
+
incidentId?: string;
|
|
461
689
|
};
|
|
462
690
|
};
|
|
463
691
|
};
|
|
@@ -472,11 +700,97 @@ interface operations {
|
|
|
472
700
|
/** @enum {boolean} */
|
|
473
701
|
success: false;
|
|
474
702
|
error: {
|
|
475
|
-
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";
|
|
476
704
|
message: string;
|
|
477
705
|
details?: {
|
|
478
706
|
[key: string]: unknown;
|
|
479
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";
|
|
788
|
+
message: string;
|
|
789
|
+
details?: {
|
|
790
|
+
[key: string]: unknown;
|
|
791
|
+
};
|
|
792
|
+
/** @description Support correlation ID, present on 5xx responses only. Quote it when contacting support. */
|
|
793
|
+
incidentId?: string;
|
|
480
794
|
};
|
|
481
795
|
};
|
|
482
796
|
};
|
|
@@ -491,11 +805,34 @@ interface operations {
|
|
|
491
805
|
/** @enum {boolean} */
|
|
492
806
|
success: false;
|
|
493
807
|
error: {
|
|
494
|
-
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";
|
|
495
809
|
message: string;
|
|
496
810
|
details?: {
|
|
497
811
|
[key: string]: unknown;
|
|
498
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";
|
|
830
|
+
message: string;
|
|
831
|
+
details?: {
|
|
832
|
+
[key: string]: unknown;
|
|
833
|
+
};
|
|
834
|
+
/** @description Support correlation ID, present on 5xx responses only. Quote it when contacting support. */
|
|
835
|
+
incidentId?: string;
|
|
499
836
|
};
|
|
500
837
|
};
|
|
501
838
|
};
|
|
@@ -510,11 +847,13 @@ interface operations {
|
|
|
510
847
|
/** @enum {boolean} */
|
|
511
848
|
success: false;
|
|
512
849
|
error: {
|
|
513
|
-
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";
|
|
514
851
|
message: string;
|
|
515
852
|
details?: {
|
|
516
853
|
[key: string]: unknown;
|
|
517
854
|
};
|
|
855
|
+
/** @description Support correlation ID, present on 5xx responses only. Quote it when contacting support. */
|
|
856
|
+
incidentId?: string;
|
|
518
857
|
};
|
|
519
858
|
};
|
|
520
859
|
};
|
|
@@ -532,13 +871,30 @@ interface operations {
|
|
|
532
871
|
};
|
|
533
872
|
requestBody: {
|
|
534
873
|
content: {
|
|
535
|
-
"application/
|
|
874
|
+
"application/xml": unknown;
|
|
875
|
+
"text/xml": unknown;
|
|
876
|
+
"application/octet-stream": unknown;
|
|
877
|
+
"application/pdf": unknown;
|
|
536
878
|
};
|
|
537
879
|
};
|
|
538
880
|
responses: {
|
|
539
881
|
/** @description Default Response */
|
|
540
882
|
200: {
|
|
541
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;
|
|
542
898
|
[name: string]: unknown;
|
|
543
899
|
};
|
|
544
900
|
content: {
|
|
@@ -577,6 +933,7 @@ interface operations {
|
|
|
577
933
|
state?: string;
|
|
578
934
|
region?: string;
|
|
579
935
|
province?: string;
|
|
936
|
+
countrySubentity?: string;
|
|
580
937
|
};
|
|
581
938
|
contactName?: string;
|
|
582
939
|
peppol?: {
|
|
@@ -601,6 +958,7 @@ interface operations {
|
|
|
601
958
|
state?: string;
|
|
602
959
|
region?: string;
|
|
603
960
|
province?: string;
|
|
961
|
+
countrySubentity?: string;
|
|
604
962
|
};
|
|
605
963
|
contactName?: string;
|
|
606
964
|
peppol?: {
|
|
@@ -625,6 +983,8 @@ interface operations {
|
|
|
625
983
|
vatRate: number;
|
|
626
984
|
taxableAmount: number;
|
|
627
985
|
taxAmount: number;
|
|
986
|
+
exemptionReasonText?: string;
|
|
987
|
+
exemptionReasonCode?: string;
|
|
628
988
|
}[];
|
|
629
989
|
paymentMeans?: {
|
|
630
990
|
typeCode: string;
|
|
@@ -676,11 +1036,13 @@ interface operations {
|
|
|
676
1036
|
};
|
|
677
1037
|
};
|
|
678
1038
|
error?: {
|
|
679
|
-
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";
|
|
680
1040
|
message: string;
|
|
681
1041
|
details?: {
|
|
682
1042
|
[key: string]: unknown;
|
|
683
1043
|
};
|
|
1044
|
+
/** @description Support correlation ID, present on 5xx responses only. Quote it when contacting support. */
|
|
1045
|
+
incidentId?: string;
|
|
684
1046
|
};
|
|
685
1047
|
};
|
|
686
1048
|
};
|
|
@@ -695,11 +1057,139 @@ interface operations {
|
|
|
695
1057
|
/** @enum {boolean} */
|
|
696
1058
|
success: false;
|
|
697
1059
|
error: {
|
|
698
|
-
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";
|
|
699
1103
|
message: string;
|
|
700
1104
|
details?: {
|
|
701
1105
|
[key: string]: unknown;
|
|
702
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";
|
|
1187
|
+
message: string;
|
|
1188
|
+
details?: {
|
|
1189
|
+
[key: string]: unknown;
|
|
1190
|
+
};
|
|
1191
|
+
/** @description Support correlation ID, present on 5xx responses only. Quote it when contacting support. */
|
|
1192
|
+
incidentId?: string;
|
|
703
1193
|
};
|
|
704
1194
|
};
|
|
705
1195
|
};
|
|
@@ -714,11 +1204,13 @@ interface operations {
|
|
|
714
1204
|
/** @enum {boolean} */
|
|
715
1205
|
success: false;
|
|
716
1206
|
error: {
|
|
717
|
-
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";
|
|
718
1208
|
message: string;
|
|
719
1209
|
details?: {
|
|
720
1210
|
[key: string]: unknown;
|
|
721
1211
|
};
|
|
1212
|
+
/** @description Support correlation ID, present on 5xx responses only. Quote it when contacting support. */
|
|
1213
|
+
incidentId?: string;
|
|
722
1214
|
};
|
|
723
1215
|
};
|
|
724
1216
|
};
|
|
@@ -739,10 +1231,43 @@ interface operations {
|
|
|
739
1231
|
};
|
|
740
1232
|
requestBody: {
|
|
741
1233
|
content: {
|
|
742
|
-
"application/
|
|
1234
|
+
"application/xml": unknown;
|
|
1235
|
+
"text/xml": unknown;
|
|
1236
|
+
"application/octet-stream": unknown;
|
|
1237
|
+
"application/pdf": unknown;
|
|
743
1238
|
};
|
|
744
1239
|
};
|
|
745
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
|
+
};
|
|
746
1271
|
/** @description Default Response */
|
|
747
1272
|
400: {
|
|
748
1273
|
headers: {
|
|
@@ -753,11 +1278,97 @@ interface operations {
|
|
|
753
1278
|
/** @enum {boolean} */
|
|
754
1279
|
success: false;
|
|
755
1280
|
error: {
|
|
756
|
-
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";
|
|
757
1366
|
message: string;
|
|
758
1367
|
details?: {
|
|
759
1368
|
[key: string]: unknown;
|
|
760
1369
|
};
|
|
1370
|
+
/** @description Support correlation ID, present on 5xx responses only. Quote it when contacting support. */
|
|
1371
|
+
incidentId?: string;
|
|
761
1372
|
};
|
|
762
1373
|
};
|
|
763
1374
|
};
|
|
@@ -772,11 +1383,34 @@ interface operations {
|
|
|
772
1383
|
/** @enum {boolean} */
|
|
773
1384
|
success: false;
|
|
774
1385
|
error: {
|
|
775
|
-
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";
|
|
776
1387
|
message: string;
|
|
777
1388
|
details?: {
|
|
778
1389
|
[key: string]: unknown;
|
|
779
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";
|
|
1408
|
+
message: string;
|
|
1409
|
+
details?: {
|
|
1410
|
+
[key: string]: unknown;
|
|
1411
|
+
};
|
|
1412
|
+
/** @description Support correlation ID, present on 5xx responses only. Quote it when contacting support. */
|
|
1413
|
+
incidentId?: string;
|
|
780
1414
|
};
|
|
781
1415
|
};
|
|
782
1416
|
};
|
|
@@ -791,11 +1425,13 @@ interface operations {
|
|
|
791
1425
|
/** @enum {boolean} */
|
|
792
1426
|
success: false;
|
|
793
1427
|
error: {
|
|
794
|
-
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";
|
|
795
1429
|
message: string;
|
|
796
1430
|
details?: {
|
|
797
1431
|
[key: string]: unknown;
|
|
798
1432
|
};
|
|
1433
|
+
/** @description Support correlation ID, present on 5xx responses only. Quote it when contacting support. */
|
|
1434
|
+
incidentId?: string;
|
|
799
1435
|
};
|
|
800
1436
|
};
|
|
801
1437
|
};
|
|
@@ -810,11 +1446,108 @@ interface operations {
|
|
|
810
1446
|
/** @enum {boolean} */
|
|
811
1447
|
success: false;
|
|
812
1448
|
error: {
|
|
813
|
-
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";
|
|
1450
|
+
message: string;
|
|
1451
|
+
details?: {
|
|
1452
|
+
[key: string]: unknown;
|
|
1453
|
+
};
|
|
1454
|
+
/** @description Support correlation ID, present on 5xx responses only. Quote it when contacting support. */
|
|
1455
|
+
incidentId?: string;
|
|
1456
|
+
};
|
|
1457
|
+
};
|
|
1458
|
+
};
|
|
1459
|
+
};
|
|
1460
|
+
};
|
|
1461
|
+
};
|
|
1462
|
+
getRulesets: {
|
|
1463
|
+
parameters: {
|
|
1464
|
+
query?: never;
|
|
1465
|
+
header?: never;
|
|
1466
|
+
path?: never;
|
|
1467
|
+
cookie?: never;
|
|
1468
|
+
};
|
|
1469
|
+
requestBody?: never;
|
|
1470
|
+
responses: {
|
|
1471
|
+
/** @description Default Response */
|
|
1472
|
+
200: {
|
|
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;
|
|
1476
|
+
[name: string]: unknown;
|
|
1477
|
+
};
|
|
1478
|
+
content: {
|
|
1479
|
+
"application/json": {
|
|
1480
|
+
success: boolean;
|
|
1481
|
+
data?: {
|
|
1482
|
+
rulesets: {
|
|
1483
|
+
format: string;
|
|
1484
|
+
label: string;
|
|
1485
|
+
standard: string;
|
|
1486
|
+
authority: string;
|
|
1487
|
+
region: string;
|
|
1488
|
+
specVersion: string;
|
|
1489
|
+
rulesetVersion: string;
|
|
1490
|
+
rulesetArtefact: string;
|
|
1491
|
+
versionKey: string;
|
|
1492
|
+
verificationTier: "conformance-verified" | "builder-round-trip" | "reconstructed-rules" | "xsd-structural" | null;
|
|
1493
|
+
rulesProvenance: "authority-conformance" | "authority-artifact" | "community" | "beliq-authored" | "none";
|
|
1494
|
+
verificationBadge: "authority-verified" | "independently-rule-checked" | "structure-checked";
|
|
1495
|
+
releaseDate: string | null;
|
|
1496
|
+
repo: string | null;
|
|
1497
|
+
tag: string | null;
|
|
1498
|
+
}[];
|
|
1499
|
+
channels: {
|
|
1500
|
+
id: "latest" | "previous";
|
|
1501
|
+
label: string;
|
|
1502
|
+
description: string;
|
|
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
|
+
}[];
|
|
1516
|
+
artifacts: {
|
|
1517
|
+
key: string;
|
|
1518
|
+
version: string;
|
|
1519
|
+
fileSha256: string;
|
|
1520
|
+
}[];
|
|
1521
|
+
};
|
|
1522
|
+
error?: {
|
|
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";
|
|
814
1545
|
message: string;
|
|
815
1546
|
details?: {
|
|
816
1547
|
[key: string]: unknown;
|
|
817
1548
|
};
|
|
1549
|
+
/** @description Support correlation ID, present on 5xx responses only. Quote it when contacting support. */
|
|
1550
|
+
incidentId?: string;
|
|
818
1551
|
};
|
|
819
1552
|
};
|
|
820
1553
|
};
|
|
@@ -862,6 +1595,10 @@ type Severity = ValidationIssue['severity'];
|
|
|
862
1595
|
type ValidationFormat = ValidationResult['format'];
|
|
863
1596
|
/** Structured invoice extracted from a document (POST /v1/parse). */
|
|
864
1597
|
type ParseResult = Json200Data<'parseInvoice'>;
|
|
1598
|
+
/** The JSON-mode generate envelope (Accept: application/json): the seal. */
|
|
1599
|
+
type GenerateResponse = Json200Data<'generateInvoice'>;
|
|
1600
|
+
/** One row of the ruleset fingerprint (key, version, file hash). */
|
|
1601
|
+
type RulesetArtifact = NonNullable<ValidationResult['rulesetArtifacts']>[number];
|
|
865
1602
|
/** The EN 16931 invoice generate accepts, and every option it carries. */
|
|
866
1603
|
type GenerateBody = RequestJson<'generateInvoice'>;
|
|
867
1604
|
type Invoice = GenerateBody['invoice'];
|
|
@@ -886,6 +1623,21 @@ interface BeliqOptions {
|
|
|
886
1623
|
auth?: 'header' | 'bearer';
|
|
887
1624
|
/** Inject a fetch implementation (tests, custom agents). Defaults to global fetch. */
|
|
888
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;
|
|
889
1641
|
}
|
|
890
1642
|
interface GenerateInput {
|
|
891
1643
|
standard: Standard;
|
|
@@ -900,6 +1652,12 @@ interface GenerateInput {
|
|
|
900
1652
|
template?: 'standard';
|
|
901
1653
|
/** Render the PDF from a saved dashboard template. */
|
|
902
1654
|
pdfTemplateId?: string;
|
|
1655
|
+
/**
|
|
1656
|
+
* Return the verify-it-yourself seal: the response carries the document
|
|
1657
|
+
* `sha256` and the full `validationResult` alongside the decoded bytes.
|
|
1658
|
+
* `sha256(bytes)` reproduces the returned hash.
|
|
1659
|
+
*/
|
|
1660
|
+
seal?: boolean;
|
|
903
1661
|
/** Raw JSON deep-merged into the request body. */
|
|
904
1662
|
advanced?: PlainObject;
|
|
905
1663
|
}
|
|
@@ -928,12 +1686,22 @@ interface GenerateMeta {
|
|
|
928
1686
|
schematronVersion?: string;
|
|
929
1687
|
pdfKind?: string;
|
|
930
1688
|
outputEnvelope?: string;
|
|
1689
|
+
/** Combined ruleset fingerprint the document was checked against. */
|
|
1690
|
+
rulesetSha256?: string;
|
|
1691
|
+
/** Per-artifact rows behind {@link rulesetSha256}. */
|
|
1692
|
+
rulesetArtifacts?: RulesetArtifact[];
|
|
1693
|
+
/** True for a live key, false for a blq_test_ sandbox key. */
|
|
1694
|
+
livemode?: boolean;
|
|
931
1695
|
}
|
|
932
1696
|
interface GenerateResult {
|
|
933
1697
|
contentType: string;
|
|
934
1698
|
bytes: Uint8Array;
|
|
935
1699
|
/** UTF-8 decoded body, present only for an XML output. */
|
|
936
1700
|
xml?: string;
|
|
1701
|
+
/** SHA-256 of the returned bytes. Present only when `seal` was requested. */
|
|
1702
|
+
sha256?: string;
|
|
1703
|
+
/** Validation verdict for the generated document. Present only when `seal` was requested. */
|
|
1704
|
+
validationResult?: ValidationResult;
|
|
937
1705
|
meta: GenerateMeta;
|
|
938
1706
|
}
|
|
939
1707
|
/** Header metadata returned alongside a converted document. */
|
|
@@ -944,6 +1712,8 @@ interface ConvertMeta {
|
|
|
944
1712
|
lostElementsCount?: number;
|
|
945
1713
|
lostElements?: string[];
|
|
946
1714
|
conversionTools?: string;
|
|
1715
|
+
/** True for a live key, false for a blq_test_ sandbox key. */
|
|
1716
|
+
livemode?: boolean;
|
|
947
1717
|
}
|
|
948
1718
|
interface ConvertResult {
|
|
949
1719
|
contentType: string;
|
|
@@ -953,6 +1723,12 @@ interface ConvertResult {
|
|
|
953
1723
|
/** Typed client for the beliq e-invoicing compliance API. */
|
|
954
1724
|
declare class Beliq {
|
|
955
1725
|
#private;
|
|
1726
|
+
/**
|
|
1727
|
+
* True for a live key, false for a blq_test_ sandbox key, derived from the key
|
|
1728
|
+
* prefix (the same rule the server applies). Available before any request; the
|
|
1729
|
+
* per-response x-beliq-livemode header is surfaced on generate/convert meta.
|
|
1730
|
+
*/
|
|
1731
|
+
readonly livemode: boolean;
|
|
956
1732
|
constructor(options: BeliqOptions);
|
|
957
1733
|
/** Account, plan, and quota context for the key. Does not consume quota. */
|
|
958
1734
|
me(): Promise<AccountInfo>;
|
|
@@ -982,4 +1758,4 @@ declare class BeliqApiError extends Error {
|
|
|
982
1758
|
});
|
|
983
1759
|
}
|
|
984
1760
|
|
|
985
|
-
export { type AccountInfo, type ApiError, type ApiErrorCode, Beliq, BeliqApiError, type BeliqOptions, type ConvertMeta, type ConvertOptions, type ConvertResult, type ConvertSourceFormat, type ConvertTargetFormat, DocumentInput, type DocumentOptions, type FacturxProfile, type GenerateBody, type GenerateInput, type GenerateMeta, type GenerateProfile, type GenerateResult, type Invoice, type ParseFormat, type ParseOptions, type ParseResult, type Severity, type Standard, type ValidateFormat, type ValidateOptions, type ValidationFormat, type ValidationIssue, type ValidationResult };
|
|
1761
|
+
export { type AccountInfo, type ApiError, type ApiErrorCode, Beliq, BeliqApiError, type BeliqOptions, type ConvertMeta, type ConvertOptions, type ConvertResult, type ConvertSourceFormat, type ConvertTargetFormat, DocumentInput, type DocumentOptions, type FacturxProfile, type GenerateBody, type GenerateInput, type GenerateMeta, type GenerateProfile, type GenerateResponse, type GenerateResult, type Invoice, type ParseFormat, type ParseOptions, type ParseResult, type RulesetArtifact, type Severity, type Standard, type ValidateFormat, type ValidateOptions, type ValidationFormat, type ValidationIssue, type ValidationResult };
|