@beliq/sdk 0.1.1 → 0.2.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.
Files changed (12) hide show
  1. package/README.md +35 -5
  2. package/dist/{constants-bWOXCmJD.d.cts → constants-D3j_o7th.d.cts} +19 -1
  3. package/dist/{constants-bWOXCmJD.d.ts → constants-D3j_o7th.d.ts} +19 -1
  4. package/dist/helpers.cjs +11 -1
  5. package/dist/helpers.d.cts +6 -2
  6. package/dist/helpers.d.ts +6 -2
  7. package/dist/helpers.js +10 -1
  8. package/dist/index.cjs +81 -7
  9. package/dist/index.d.cts +188 -27
  10. package/dist/index.d.ts +188 -27
  11. package/dist/index.js +80 -7
  12. package/package.json +2 -1
package/dist/index.d.cts CHANGED
@@ -1,5 +1,5 @@
1
- import { P as PlainObject, a as DocumentInput } from './constants-bWOXCmJD.cjs';
2
- export { D as DEFAULT_BASE_URL, L as LIVE_CONVERT_SOURCE_FORMATS, b as LIVE_CONVERT_TARGET_FORMATS, c as LIVE_GENERATE_STANDARDS, d as LIVE_PARSE_FORMATS, e as LIVE_PROFILES, f as LIVE_VALIDATE_FORMATS } from './constants-bWOXCmJD.cjs';
1
+ import { P as PlainObject, a as DocumentInput } from './constants-D3j_o7th.cjs';
2
+ export { D as DEFAULT_BASE_URL, G as GeneratePreset, L as LIVE_CONVERT_SOURCE_FORMATS, b as LIVE_CONVERT_TARGET_FORMATS, c as LIVE_GENERATE_PRESETS, d as LIVE_GENERATE_STANDARDS, e as LIVE_PARSE_FORMATS, f as LIVE_PROFILES, g as LIVE_VALIDATE_FORMATS } from './constants-D3j_o7th.cjs';
3
3
 
4
4
  interface components {
5
5
  schemas: {
@@ -46,6 +46,7 @@ interface operations {
46
46
  org: {
47
47
  id: string;
48
48
  name: string;
49
+ rulesetChannel: "latest" | "previous";
49
50
  };
50
51
  plan: {
51
52
  id: number | null;
@@ -60,11 +61,13 @@ interface operations {
60
61
  };
61
62
  };
62
63
  error?: {
63
- code: "VALIDATION_ERROR" | "INVALID_INVOICE" | "UNSUPPORTED_FORMAT" | "PROFILE_STANDARD_MISMATCH" | "DOCUMENT_TYPE_STANDARD_MISMATCH" | "PARSE_FAILED" | "INVALID_XML" | "AUTHENTICATION_REQUIRED" | "INVALID_API_KEY" | "QUOTA_EXCEEDED" | "RATE_LIMITED" | "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";
64
+ code: "VALIDATION_ERROR" | "INVALID_INVOICE" | "UNSUPPORTED_FORMAT" | "PROFILE_STANDARD_MISMATCH" | "DOCUMENT_TYPE_STANDARD_MISMATCH" | "PARSE_FAILED" | "INVALID_XML" | "AUTHENTICATION_REQUIRED" | "INVALID_API_KEY" | "QUOTA_EXCEEDED" | "RATE_LIMITED" | "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" | "IDEMPOTENCY_KEY_REUSED" | "INVALID_IDEMPOTENCY_KEY" | "INBOX_UNKNOWN_PROVIDER" | "INBOX_VERIFICATION_FAILED";
64
65
  message: string;
65
66
  details?: {
66
67
  [key: string]: unknown;
67
68
  };
69
+ /** @description Support correlation ID, present on 5xx responses only. Quote it when contacting support. */
70
+ incidentId?: string;
68
71
  };
69
72
  };
70
73
  };
@@ -79,11 +82,13 @@ interface operations {
79
82
  /** @enum {boolean} */
80
83
  success: false;
81
84
  error: {
82
- code: "VALIDATION_ERROR" | "INVALID_INVOICE" | "UNSUPPORTED_FORMAT" | "PROFILE_STANDARD_MISMATCH" | "DOCUMENT_TYPE_STANDARD_MISMATCH" | "PARSE_FAILED" | "INVALID_XML" | "AUTHENTICATION_REQUIRED" | "INVALID_API_KEY" | "QUOTA_EXCEEDED" | "RATE_LIMITED" | "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";
85
+ code: "VALIDATION_ERROR" | "INVALID_INVOICE" | "UNSUPPORTED_FORMAT" | "PROFILE_STANDARD_MISMATCH" | "DOCUMENT_TYPE_STANDARD_MISMATCH" | "PARSE_FAILED" | "INVALID_XML" | "AUTHENTICATION_REQUIRED" | "INVALID_API_KEY" | "QUOTA_EXCEEDED" | "RATE_LIMITED" | "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" | "IDEMPOTENCY_KEY_REUSED" | "INVALID_IDEMPOTENCY_KEY" | "INBOX_UNKNOWN_PROVIDER" | "INBOX_VERIFICATION_FAILED";
83
86
  message: string;
84
87
  details?: {
85
88
  [key: string]: unknown;
86
89
  };
90
+ /** @description Support correlation ID, present on 5xx responses only. Quote it when contacting support. */
91
+ incidentId?: string;
87
92
  };
88
93
  };
89
94
  };
@@ -98,11 +103,13 @@ interface operations {
98
103
  /** @enum {boolean} */
99
104
  success: false;
100
105
  error: {
101
- code: "VALIDATION_ERROR" | "INVALID_INVOICE" | "UNSUPPORTED_FORMAT" | "PROFILE_STANDARD_MISMATCH" | "DOCUMENT_TYPE_STANDARD_MISMATCH" | "PARSE_FAILED" | "INVALID_XML" | "AUTHENTICATION_REQUIRED" | "INVALID_API_KEY" | "QUOTA_EXCEEDED" | "RATE_LIMITED" | "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";
106
+ code: "VALIDATION_ERROR" | "INVALID_INVOICE" | "UNSUPPORTED_FORMAT" | "PROFILE_STANDARD_MISMATCH" | "DOCUMENT_TYPE_STANDARD_MISMATCH" | "PARSE_FAILED" | "INVALID_XML" | "AUTHENTICATION_REQUIRED" | "INVALID_API_KEY" | "QUOTA_EXCEEDED" | "RATE_LIMITED" | "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" | "IDEMPOTENCY_KEY_REUSED" | "INVALID_IDEMPOTENCY_KEY" | "INBOX_UNKNOWN_PROVIDER" | "INBOX_VERIFICATION_FAILED";
102
107
  message: string;
103
108
  details?: {
104
109
  [key: string]: unknown;
105
110
  };
111
+ /** @description Support correlation ID, present on 5xx responses only. Quote it when contacting support. */
112
+ incidentId?: string;
106
113
  };
107
114
  };
108
115
  };
@@ -119,8 +126,8 @@ interface operations {
119
126
  requestBody: {
120
127
  content: {
121
128
  "application/json": {
122
- 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";
129
+ standard: "xrechnung" | "zugferd" | "facturx" | "peppol-bis" | "fatturapa" | "facturae" | "eslog" | "ksef";
130
+ profile?: "minimum" | "basicwl" | "basic" | "en16931" | "extended" | "extended-ctc-fr" | "xrechnung" | "peppol" | "romania-ro-cius" | "netherlands-nlcius" | "ordinaria" | "eracun" | "fa3";
124
131
  facturxProfile?: "minimum" | "basicwl" | "basic" | "en16931" | "extended" | "extended-ctc-fr";
125
132
  output: "xml" | "pdf";
126
133
  invoice: {
@@ -201,6 +208,8 @@ interface operations {
201
208
  vatRate: number;
202
209
  taxableAmount: number;
203
210
  taxAmount: number;
211
+ exemptionReasonText?: string;
212
+ exemptionReasonCode?: string;
204
213
  }[];
205
214
  paymentMeans?: {
206
215
  typeCode: string;
@@ -273,7 +282,16 @@ interface operations {
273
282
  profile: string;
274
283
  validationResult: {
275
284
  valid: boolean;
276
- format: "cii" | "ubl" | "fatturapa" | "facturae" | "eslog" | "sdi_messaggio" | "unknown";
285
+ format: "cii" | "ubl" | "fatturapa" | "facturae" | "eslog" | "sdi_messaggio" | "poland_ksef_fa2" | "poland_ksef_fa3" | "unknown";
286
+ sha256?: string;
287
+ rulesetSha256?: string;
288
+ rulesetArtifacts?: {
289
+ key: string;
290
+ version: string;
291
+ fileSha256: string;
292
+ }[];
293
+ /** Format: date-time */
294
+ driftCheckedAt?: string;
277
295
  profileDetected?: string;
278
296
  schematronVersion?: string;
279
297
  ciusVersion?: string;
@@ -292,6 +310,8 @@ interface operations {
292
310
  sloveniaEslogRuntimeVersion?: string;
293
311
  romaniaRoCiusVersion?: string;
294
312
  netherlandsNlciusVersion?: string;
313
+ rulesetChannel?: "latest" | "previous";
314
+ rulesetFellBack?: boolean;
295
315
  errors: {
296
316
  ruleId: string;
297
317
  severity: "fatal" | "error" | "warning" | "info";
@@ -305,13 +325,20 @@ interface operations {
305
325
  message: string;
306
326
  }[];
307
327
  };
328
+ output?: string;
329
+ outputFormat?: string;
330
+ contentType?: string;
331
+ sha256?: string;
332
+ pdfKind?: string;
308
333
  };
309
334
  error?: {
310
- code: "VALIDATION_ERROR" | "INVALID_INVOICE" | "UNSUPPORTED_FORMAT" | "PROFILE_STANDARD_MISMATCH" | "DOCUMENT_TYPE_STANDARD_MISMATCH" | "PARSE_FAILED" | "INVALID_XML" | "AUTHENTICATION_REQUIRED" | "INVALID_API_KEY" | "QUOTA_EXCEEDED" | "RATE_LIMITED" | "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";
335
+ code: "VALIDATION_ERROR" | "INVALID_INVOICE" | "UNSUPPORTED_FORMAT" | "PROFILE_STANDARD_MISMATCH" | "DOCUMENT_TYPE_STANDARD_MISMATCH" | "PARSE_FAILED" | "INVALID_XML" | "AUTHENTICATION_REQUIRED" | "INVALID_API_KEY" | "QUOTA_EXCEEDED" | "RATE_LIMITED" | "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" | "IDEMPOTENCY_KEY_REUSED" | "INVALID_IDEMPOTENCY_KEY" | "INBOX_UNKNOWN_PROVIDER" | "INBOX_VERIFICATION_FAILED";
311
336
  message: string;
312
337
  details?: {
313
338
  [key: string]: unknown;
314
339
  };
340
+ /** @description Support correlation ID, present on 5xx responses only. Quote it when contacting support. */
341
+ incidentId?: string;
315
342
  };
316
343
  };
317
344
  };
@@ -326,11 +353,13 @@ interface operations {
326
353
  /** @enum {boolean} */
327
354
  success: false;
328
355
  error: {
329
- code: "VALIDATION_ERROR" | "INVALID_INVOICE" | "UNSUPPORTED_FORMAT" | "PROFILE_STANDARD_MISMATCH" | "DOCUMENT_TYPE_STANDARD_MISMATCH" | "PARSE_FAILED" | "INVALID_XML" | "AUTHENTICATION_REQUIRED" | "INVALID_API_KEY" | "QUOTA_EXCEEDED" | "RATE_LIMITED" | "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";
356
+ code: "VALIDATION_ERROR" | "INVALID_INVOICE" | "UNSUPPORTED_FORMAT" | "PROFILE_STANDARD_MISMATCH" | "DOCUMENT_TYPE_STANDARD_MISMATCH" | "PARSE_FAILED" | "INVALID_XML" | "AUTHENTICATION_REQUIRED" | "INVALID_API_KEY" | "QUOTA_EXCEEDED" | "RATE_LIMITED" | "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" | "IDEMPOTENCY_KEY_REUSED" | "INVALID_IDEMPOTENCY_KEY" | "INBOX_UNKNOWN_PROVIDER" | "INBOX_VERIFICATION_FAILED";
330
357
  message: string;
331
358
  details?: {
332
359
  [key: string]: unknown;
333
360
  };
361
+ /** @description Support correlation ID, present on 5xx responses only. Quote it when contacting support. */
362
+ incidentId?: string;
334
363
  };
335
364
  };
336
365
  };
@@ -345,11 +374,13 @@ interface operations {
345
374
  /** @enum {boolean} */
346
375
  success: false;
347
376
  error: {
348
- code: "VALIDATION_ERROR" | "INVALID_INVOICE" | "UNSUPPORTED_FORMAT" | "PROFILE_STANDARD_MISMATCH" | "DOCUMENT_TYPE_STANDARD_MISMATCH" | "PARSE_FAILED" | "INVALID_XML" | "AUTHENTICATION_REQUIRED" | "INVALID_API_KEY" | "QUOTA_EXCEEDED" | "RATE_LIMITED" | "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";
377
+ code: "VALIDATION_ERROR" | "INVALID_INVOICE" | "UNSUPPORTED_FORMAT" | "PROFILE_STANDARD_MISMATCH" | "DOCUMENT_TYPE_STANDARD_MISMATCH" | "PARSE_FAILED" | "INVALID_XML" | "AUTHENTICATION_REQUIRED" | "INVALID_API_KEY" | "QUOTA_EXCEEDED" | "RATE_LIMITED" | "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" | "IDEMPOTENCY_KEY_REUSED" | "INVALID_IDEMPOTENCY_KEY" | "INBOX_UNKNOWN_PROVIDER" | "INBOX_VERIFICATION_FAILED";
349
378
  message: string;
350
379
  details?: {
351
380
  [key: string]: unknown;
352
381
  };
382
+ /** @description Support correlation ID, present on 5xx responses only. Quote it when contacting support. */
383
+ incidentId?: string;
353
384
  };
354
385
  };
355
386
  };
@@ -364,11 +395,13 @@ interface operations {
364
395
  /** @enum {boolean} */
365
396
  success: false;
366
397
  error: {
367
- code: "VALIDATION_ERROR" | "INVALID_INVOICE" | "UNSUPPORTED_FORMAT" | "PROFILE_STANDARD_MISMATCH" | "DOCUMENT_TYPE_STANDARD_MISMATCH" | "PARSE_FAILED" | "INVALID_XML" | "AUTHENTICATION_REQUIRED" | "INVALID_API_KEY" | "QUOTA_EXCEEDED" | "RATE_LIMITED" | "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";
398
+ code: "VALIDATION_ERROR" | "INVALID_INVOICE" | "UNSUPPORTED_FORMAT" | "PROFILE_STANDARD_MISMATCH" | "DOCUMENT_TYPE_STANDARD_MISMATCH" | "PARSE_FAILED" | "INVALID_XML" | "AUTHENTICATION_REQUIRED" | "INVALID_API_KEY" | "QUOTA_EXCEEDED" | "RATE_LIMITED" | "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" | "IDEMPOTENCY_KEY_REUSED" | "INVALID_IDEMPOTENCY_KEY" | "INBOX_UNKNOWN_PROVIDER" | "INBOX_VERIFICATION_FAILED";
368
399
  message: string;
369
400
  details?: {
370
401
  [key: string]: unknown;
371
402
  };
403
+ /** @description Support correlation ID, present on 5xx responses only. Quote it when contacting support. */
404
+ incidentId?: string;
372
405
  };
373
406
  };
374
407
  };
@@ -383,11 +416,13 @@ interface operations {
383
416
  /** @enum {boolean} */
384
417
  success: false;
385
418
  error: {
386
- code: "VALIDATION_ERROR" | "INVALID_INVOICE" | "UNSUPPORTED_FORMAT" | "PROFILE_STANDARD_MISMATCH" | "DOCUMENT_TYPE_STANDARD_MISMATCH" | "PARSE_FAILED" | "INVALID_XML" | "AUTHENTICATION_REQUIRED" | "INVALID_API_KEY" | "QUOTA_EXCEEDED" | "RATE_LIMITED" | "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";
419
+ code: "VALIDATION_ERROR" | "INVALID_INVOICE" | "UNSUPPORTED_FORMAT" | "PROFILE_STANDARD_MISMATCH" | "DOCUMENT_TYPE_STANDARD_MISMATCH" | "PARSE_FAILED" | "INVALID_XML" | "AUTHENTICATION_REQUIRED" | "INVALID_API_KEY" | "QUOTA_EXCEEDED" | "RATE_LIMITED" | "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" | "IDEMPOTENCY_KEY_REUSED" | "INVALID_IDEMPOTENCY_KEY" | "INBOX_UNKNOWN_PROVIDER" | "INBOX_VERIFICATION_FAILED";
387
420
  message: string;
388
421
  details?: {
389
422
  [key: string]: unknown;
390
423
  };
424
+ /** @description Support correlation ID, present on 5xx responses only. Quote it when contacting support. */
425
+ incidentId?: string;
391
426
  };
392
427
  };
393
428
  };
@@ -400,7 +435,10 @@ interface operations {
400
435
  format?: "auto" | "cii" | "ubl" | "fatturapa" | "sdi_messaggio" | "facturae" | "eslog";
401
436
  franceCtc?: boolean;
402
437
  };
403
- header?: never;
438
+ header?: {
439
+ /** @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. */
440
+ "Beliq-Ruleset"?: string;
441
+ };
404
442
  path?: never;
405
443
  cookie?: never;
406
444
  };
@@ -420,7 +458,16 @@ interface operations {
420
458
  success: boolean;
421
459
  data?: {
422
460
  valid: boolean;
423
- format: "cii" | "ubl" | "fatturapa" | "facturae" | "eslog" | "sdi_messaggio" | "unknown";
461
+ format: "cii" | "ubl" | "fatturapa" | "facturae" | "eslog" | "sdi_messaggio" | "poland_ksef_fa2" | "poland_ksef_fa3" | "unknown";
462
+ sha256?: string;
463
+ rulesetSha256?: string;
464
+ rulesetArtifacts?: {
465
+ key: string;
466
+ version: string;
467
+ fileSha256: string;
468
+ }[];
469
+ /** Format: date-time */
470
+ driftCheckedAt?: string;
424
471
  profileDetected?: string;
425
472
  schematronVersion?: string;
426
473
  ciusVersion?: string;
@@ -439,6 +486,8 @@ interface operations {
439
486
  sloveniaEslogRuntimeVersion?: string;
440
487
  romaniaRoCiusVersion?: string;
441
488
  netherlandsNlciusVersion?: string;
489
+ rulesetChannel?: "latest" | "previous";
490
+ rulesetFellBack?: boolean;
442
491
  errors: {
443
492
  ruleId: string;
444
493
  severity: "fatal" | "error" | "warning" | "info";
@@ -453,11 +502,13 @@ interface operations {
453
502
  }[];
454
503
  };
455
504
  error?: {
456
- code: "VALIDATION_ERROR" | "INVALID_INVOICE" | "UNSUPPORTED_FORMAT" | "PROFILE_STANDARD_MISMATCH" | "DOCUMENT_TYPE_STANDARD_MISMATCH" | "PARSE_FAILED" | "INVALID_XML" | "AUTHENTICATION_REQUIRED" | "INVALID_API_KEY" | "QUOTA_EXCEEDED" | "RATE_LIMITED" | "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";
505
+ code: "VALIDATION_ERROR" | "INVALID_INVOICE" | "UNSUPPORTED_FORMAT" | "PROFILE_STANDARD_MISMATCH" | "DOCUMENT_TYPE_STANDARD_MISMATCH" | "PARSE_FAILED" | "INVALID_XML" | "AUTHENTICATION_REQUIRED" | "INVALID_API_KEY" | "QUOTA_EXCEEDED" | "RATE_LIMITED" | "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" | "IDEMPOTENCY_KEY_REUSED" | "INVALID_IDEMPOTENCY_KEY" | "INBOX_UNKNOWN_PROVIDER" | "INBOX_VERIFICATION_FAILED";
457
506
  message: string;
458
507
  details?: {
459
508
  [key: string]: unknown;
460
509
  };
510
+ /** @description Support correlation ID, present on 5xx responses only. Quote it when contacting support. */
511
+ incidentId?: string;
461
512
  };
462
513
  };
463
514
  };
@@ -472,11 +523,13 @@ interface operations {
472
523
  /** @enum {boolean} */
473
524
  success: false;
474
525
  error: {
475
- code: "VALIDATION_ERROR" | "INVALID_INVOICE" | "UNSUPPORTED_FORMAT" | "PROFILE_STANDARD_MISMATCH" | "DOCUMENT_TYPE_STANDARD_MISMATCH" | "PARSE_FAILED" | "INVALID_XML" | "AUTHENTICATION_REQUIRED" | "INVALID_API_KEY" | "QUOTA_EXCEEDED" | "RATE_LIMITED" | "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";
526
+ code: "VALIDATION_ERROR" | "INVALID_INVOICE" | "UNSUPPORTED_FORMAT" | "PROFILE_STANDARD_MISMATCH" | "DOCUMENT_TYPE_STANDARD_MISMATCH" | "PARSE_FAILED" | "INVALID_XML" | "AUTHENTICATION_REQUIRED" | "INVALID_API_KEY" | "QUOTA_EXCEEDED" | "RATE_LIMITED" | "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" | "IDEMPOTENCY_KEY_REUSED" | "INVALID_IDEMPOTENCY_KEY" | "INBOX_UNKNOWN_PROVIDER" | "INBOX_VERIFICATION_FAILED";
476
527
  message: string;
477
528
  details?: {
478
529
  [key: string]: unknown;
479
530
  };
531
+ /** @description Support correlation ID, present on 5xx responses only. Quote it when contacting support. */
532
+ incidentId?: string;
480
533
  };
481
534
  };
482
535
  };
@@ -491,11 +544,13 @@ interface operations {
491
544
  /** @enum {boolean} */
492
545
  success: false;
493
546
  error: {
494
- code: "VALIDATION_ERROR" | "INVALID_INVOICE" | "UNSUPPORTED_FORMAT" | "PROFILE_STANDARD_MISMATCH" | "DOCUMENT_TYPE_STANDARD_MISMATCH" | "PARSE_FAILED" | "INVALID_XML" | "AUTHENTICATION_REQUIRED" | "INVALID_API_KEY" | "QUOTA_EXCEEDED" | "RATE_LIMITED" | "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";
547
+ code: "VALIDATION_ERROR" | "INVALID_INVOICE" | "UNSUPPORTED_FORMAT" | "PROFILE_STANDARD_MISMATCH" | "DOCUMENT_TYPE_STANDARD_MISMATCH" | "PARSE_FAILED" | "INVALID_XML" | "AUTHENTICATION_REQUIRED" | "INVALID_API_KEY" | "QUOTA_EXCEEDED" | "RATE_LIMITED" | "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" | "IDEMPOTENCY_KEY_REUSED" | "INVALID_IDEMPOTENCY_KEY" | "INBOX_UNKNOWN_PROVIDER" | "INBOX_VERIFICATION_FAILED";
495
548
  message: string;
496
549
  details?: {
497
550
  [key: string]: unknown;
498
551
  };
552
+ /** @description Support correlation ID, present on 5xx responses only. Quote it when contacting support. */
553
+ incidentId?: string;
499
554
  };
500
555
  };
501
556
  };
@@ -510,11 +565,13 @@ interface operations {
510
565
  /** @enum {boolean} */
511
566
  success: false;
512
567
  error: {
513
- code: "VALIDATION_ERROR" | "INVALID_INVOICE" | "UNSUPPORTED_FORMAT" | "PROFILE_STANDARD_MISMATCH" | "DOCUMENT_TYPE_STANDARD_MISMATCH" | "PARSE_FAILED" | "INVALID_XML" | "AUTHENTICATION_REQUIRED" | "INVALID_API_KEY" | "QUOTA_EXCEEDED" | "RATE_LIMITED" | "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";
568
+ code: "VALIDATION_ERROR" | "INVALID_INVOICE" | "UNSUPPORTED_FORMAT" | "PROFILE_STANDARD_MISMATCH" | "DOCUMENT_TYPE_STANDARD_MISMATCH" | "PARSE_FAILED" | "INVALID_XML" | "AUTHENTICATION_REQUIRED" | "INVALID_API_KEY" | "QUOTA_EXCEEDED" | "RATE_LIMITED" | "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" | "IDEMPOTENCY_KEY_REUSED" | "INVALID_IDEMPOTENCY_KEY" | "INBOX_UNKNOWN_PROVIDER" | "INBOX_VERIFICATION_FAILED";
514
569
  message: string;
515
570
  details?: {
516
571
  [key: string]: unknown;
517
572
  };
573
+ /** @description Support correlation ID, present on 5xx responses only. Quote it when contacting support. */
574
+ incidentId?: string;
518
575
  };
519
576
  };
520
577
  };
@@ -625,6 +682,8 @@ interface operations {
625
682
  vatRate: number;
626
683
  taxableAmount: number;
627
684
  taxAmount: number;
685
+ exemptionReasonText?: string;
686
+ exemptionReasonCode?: string;
628
687
  }[];
629
688
  paymentMeans?: {
630
689
  typeCode: string;
@@ -676,11 +735,13 @@ interface operations {
676
735
  };
677
736
  };
678
737
  error?: {
679
- code: "VALIDATION_ERROR" | "INVALID_INVOICE" | "UNSUPPORTED_FORMAT" | "PROFILE_STANDARD_MISMATCH" | "DOCUMENT_TYPE_STANDARD_MISMATCH" | "PARSE_FAILED" | "INVALID_XML" | "AUTHENTICATION_REQUIRED" | "INVALID_API_KEY" | "QUOTA_EXCEEDED" | "RATE_LIMITED" | "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";
738
+ code: "VALIDATION_ERROR" | "INVALID_INVOICE" | "UNSUPPORTED_FORMAT" | "PROFILE_STANDARD_MISMATCH" | "DOCUMENT_TYPE_STANDARD_MISMATCH" | "PARSE_FAILED" | "INVALID_XML" | "AUTHENTICATION_REQUIRED" | "INVALID_API_KEY" | "QUOTA_EXCEEDED" | "RATE_LIMITED" | "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" | "IDEMPOTENCY_KEY_REUSED" | "INVALID_IDEMPOTENCY_KEY" | "INBOX_UNKNOWN_PROVIDER" | "INBOX_VERIFICATION_FAILED";
680
739
  message: string;
681
740
  details?: {
682
741
  [key: string]: unknown;
683
742
  };
743
+ /** @description Support correlation ID, present on 5xx responses only. Quote it when contacting support. */
744
+ incidentId?: string;
684
745
  };
685
746
  };
686
747
  };
@@ -695,11 +756,13 @@ interface operations {
695
756
  /** @enum {boolean} */
696
757
  success: false;
697
758
  error: {
698
- code: "VALIDATION_ERROR" | "INVALID_INVOICE" | "UNSUPPORTED_FORMAT" | "PROFILE_STANDARD_MISMATCH" | "DOCUMENT_TYPE_STANDARD_MISMATCH" | "PARSE_FAILED" | "INVALID_XML" | "AUTHENTICATION_REQUIRED" | "INVALID_API_KEY" | "QUOTA_EXCEEDED" | "RATE_LIMITED" | "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";
759
+ code: "VALIDATION_ERROR" | "INVALID_INVOICE" | "UNSUPPORTED_FORMAT" | "PROFILE_STANDARD_MISMATCH" | "DOCUMENT_TYPE_STANDARD_MISMATCH" | "PARSE_FAILED" | "INVALID_XML" | "AUTHENTICATION_REQUIRED" | "INVALID_API_KEY" | "QUOTA_EXCEEDED" | "RATE_LIMITED" | "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" | "IDEMPOTENCY_KEY_REUSED" | "INVALID_IDEMPOTENCY_KEY" | "INBOX_UNKNOWN_PROVIDER" | "INBOX_VERIFICATION_FAILED";
699
760
  message: string;
700
761
  details?: {
701
762
  [key: string]: unknown;
702
763
  };
764
+ /** @description Support correlation ID, present on 5xx responses only. Quote it when contacting support. */
765
+ incidentId?: string;
703
766
  };
704
767
  };
705
768
  };
@@ -714,11 +777,13 @@ interface operations {
714
777
  /** @enum {boolean} */
715
778
  success: false;
716
779
  error: {
717
- code: "VALIDATION_ERROR" | "INVALID_INVOICE" | "UNSUPPORTED_FORMAT" | "PROFILE_STANDARD_MISMATCH" | "DOCUMENT_TYPE_STANDARD_MISMATCH" | "PARSE_FAILED" | "INVALID_XML" | "AUTHENTICATION_REQUIRED" | "INVALID_API_KEY" | "QUOTA_EXCEEDED" | "RATE_LIMITED" | "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";
780
+ code: "VALIDATION_ERROR" | "INVALID_INVOICE" | "UNSUPPORTED_FORMAT" | "PROFILE_STANDARD_MISMATCH" | "DOCUMENT_TYPE_STANDARD_MISMATCH" | "PARSE_FAILED" | "INVALID_XML" | "AUTHENTICATION_REQUIRED" | "INVALID_API_KEY" | "QUOTA_EXCEEDED" | "RATE_LIMITED" | "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" | "IDEMPOTENCY_KEY_REUSED" | "INVALID_IDEMPOTENCY_KEY" | "INBOX_UNKNOWN_PROVIDER" | "INBOX_VERIFICATION_FAILED";
718
781
  message: string;
719
782
  details?: {
720
783
  [key: string]: unknown;
721
784
  };
785
+ /** @description Support correlation ID, present on 5xx responses only. Quote it when contacting support. */
786
+ incidentId?: string;
722
787
  };
723
788
  };
724
789
  };
@@ -753,11 +818,13 @@ interface operations {
753
818
  /** @enum {boolean} */
754
819
  success: false;
755
820
  error: {
756
- code: "VALIDATION_ERROR" | "INVALID_INVOICE" | "UNSUPPORTED_FORMAT" | "PROFILE_STANDARD_MISMATCH" | "DOCUMENT_TYPE_STANDARD_MISMATCH" | "PARSE_FAILED" | "INVALID_XML" | "AUTHENTICATION_REQUIRED" | "INVALID_API_KEY" | "QUOTA_EXCEEDED" | "RATE_LIMITED" | "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";
821
+ code: "VALIDATION_ERROR" | "INVALID_INVOICE" | "UNSUPPORTED_FORMAT" | "PROFILE_STANDARD_MISMATCH" | "DOCUMENT_TYPE_STANDARD_MISMATCH" | "PARSE_FAILED" | "INVALID_XML" | "AUTHENTICATION_REQUIRED" | "INVALID_API_KEY" | "QUOTA_EXCEEDED" | "RATE_LIMITED" | "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" | "IDEMPOTENCY_KEY_REUSED" | "INVALID_IDEMPOTENCY_KEY" | "INBOX_UNKNOWN_PROVIDER" | "INBOX_VERIFICATION_FAILED";
757
822
  message: string;
758
823
  details?: {
759
824
  [key: string]: unknown;
760
825
  };
826
+ /** @description Support correlation ID, present on 5xx responses only. Quote it when contacting support. */
827
+ incidentId?: string;
761
828
  };
762
829
  };
763
830
  };
@@ -772,11 +839,13 @@ interface operations {
772
839
  /** @enum {boolean} */
773
840
  success: false;
774
841
  error: {
775
- code: "VALIDATION_ERROR" | "INVALID_INVOICE" | "UNSUPPORTED_FORMAT" | "PROFILE_STANDARD_MISMATCH" | "DOCUMENT_TYPE_STANDARD_MISMATCH" | "PARSE_FAILED" | "INVALID_XML" | "AUTHENTICATION_REQUIRED" | "INVALID_API_KEY" | "QUOTA_EXCEEDED" | "RATE_LIMITED" | "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";
842
+ code: "VALIDATION_ERROR" | "INVALID_INVOICE" | "UNSUPPORTED_FORMAT" | "PROFILE_STANDARD_MISMATCH" | "DOCUMENT_TYPE_STANDARD_MISMATCH" | "PARSE_FAILED" | "INVALID_XML" | "AUTHENTICATION_REQUIRED" | "INVALID_API_KEY" | "QUOTA_EXCEEDED" | "RATE_LIMITED" | "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" | "IDEMPOTENCY_KEY_REUSED" | "INVALID_IDEMPOTENCY_KEY" | "INBOX_UNKNOWN_PROVIDER" | "INBOX_VERIFICATION_FAILED";
776
843
  message: string;
777
844
  details?: {
778
845
  [key: string]: unknown;
779
846
  };
847
+ /** @description Support correlation ID, present on 5xx responses only. Quote it when contacting support. */
848
+ incidentId?: string;
780
849
  };
781
850
  };
782
851
  };
@@ -791,11 +860,13 @@ interface operations {
791
860
  /** @enum {boolean} */
792
861
  success: false;
793
862
  error: {
794
- code: "VALIDATION_ERROR" | "INVALID_INVOICE" | "UNSUPPORTED_FORMAT" | "PROFILE_STANDARD_MISMATCH" | "DOCUMENT_TYPE_STANDARD_MISMATCH" | "PARSE_FAILED" | "INVALID_XML" | "AUTHENTICATION_REQUIRED" | "INVALID_API_KEY" | "QUOTA_EXCEEDED" | "RATE_LIMITED" | "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";
863
+ code: "VALIDATION_ERROR" | "INVALID_INVOICE" | "UNSUPPORTED_FORMAT" | "PROFILE_STANDARD_MISMATCH" | "DOCUMENT_TYPE_STANDARD_MISMATCH" | "PARSE_FAILED" | "INVALID_XML" | "AUTHENTICATION_REQUIRED" | "INVALID_API_KEY" | "QUOTA_EXCEEDED" | "RATE_LIMITED" | "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" | "IDEMPOTENCY_KEY_REUSED" | "INVALID_IDEMPOTENCY_KEY" | "INBOX_UNKNOWN_PROVIDER" | "INBOX_VERIFICATION_FAILED";
795
864
  message: string;
796
865
  details?: {
797
866
  [key: string]: unknown;
798
867
  };
868
+ /** @description Support correlation ID, present on 5xx responses only. Quote it when contacting support. */
869
+ incidentId?: string;
799
870
  };
800
871
  };
801
872
  };
@@ -810,11 +881,73 @@ interface operations {
810
881
  /** @enum {boolean} */
811
882
  success: false;
812
883
  error: {
813
- code: "VALIDATION_ERROR" | "INVALID_INVOICE" | "UNSUPPORTED_FORMAT" | "PROFILE_STANDARD_MISMATCH" | "DOCUMENT_TYPE_STANDARD_MISMATCH" | "PARSE_FAILED" | "INVALID_XML" | "AUTHENTICATION_REQUIRED" | "INVALID_API_KEY" | "QUOTA_EXCEEDED" | "RATE_LIMITED" | "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";
884
+ code: "VALIDATION_ERROR" | "INVALID_INVOICE" | "UNSUPPORTED_FORMAT" | "PROFILE_STANDARD_MISMATCH" | "DOCUMENT_TYPE_STANDARD_MISMATCH" | "PARSE_FAILED" | "INVALID_XML" | "AUTHENTICATION_REQUIRED" | "INVALID_API_KEY" | "QUOTA_EXCEEDED" | "RATE_LIMITED" | "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" | "IDEMPOTENCY_KEY_REUSED" | "INVALID_IDEMPOTENCY_KEY" | "INBOX_UNKNOWN_PROVIDER" | "INBOX_VERIFICATION_FAILED";
885
+ message: string;
886
+ details?: {
887
+ [key: string]: unknown;
888
+ };
889
+ /** @description Support correlation ID, present on 5xx responses only. Quote it when contacting support. */
890
+ incidentId?: string;
891
+ };
892
+ };
893
+ };
894
+ };
895
+ };
896
+ };
897
+ getRulesets: {
898
+ parameters: {
899
+ query?: never;
900
+ header?: never;
901
+ path?: never;
902
+ cookie?: never;
903
+ };
904
+ requestBody?: never;
905
+ responses: {
906
+ /** @description Default Response */
907
+ 200: {
908
+ headers: {
909
+ [name: string]: unknown;
910
+ };
911
+ content: {
912
+ "application/json": {
913
+ success: boolean;
914
+ data?: {
915
+ rulesets: {
916
+ format: string;
917
+ label: string;
918
+ standard: string;
919
+ authority: string;
920
+ region: string;
921
+ specVersion: string;
922
+ rulesetVersion: string;
923
+ rulesetArtefact: string;
924
+ versionKey: string;
925
+ verificationTier: "conformance-verified" | "builder-round-trip" | "reconstructed-rules" | "xsd-structural" | null;
926
+ rulesProvenance: "authority-conformance" | "authority-artifact" | "community" | "beliq-authored" | "none";
927
+ verificationBadge: "authority-verified" | "independently-rule-checked" | "structure-checked";
928
+ releaseDate: string | null;
929
+ repo: string | null;
930
+ tag: string | null;
931
+ }[];
932
+ channels: {
933
+ id: "latest" | "previous";
934
+ label: string;
935
+ description: string;
936
+ }[];
937
+ artifacts: {
938
+ key: string;
939
+ version: string;
940
+ fileSha256: string;
941
+ }[];
942
+ };
943
+ error?: {
944
+ code: "VALIDATION_ERROR" | "INVALID_INVOICE" | "UNSUPPORTED_FORMAT" | "PROFILE_STANDARD_MISMATCH" | "DOCUMENT_TYPE_STANDARD_MISMATCH" | "PARSE_FAILED" | "INVALID_XML" | "AUTHENTICATION_REQUIRED" | "INVALID_API_KEY" | "QUOTA_EXCEEDED" | "RATE_LIMITED" | "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" | "IDEMPOTENCY_KEY_REUSED" | "INVALID_IDEMPOTENCY_KEY" | "INBOX_UNKNOWN_PROVIDER" | "INBOX_VERIFICATION_FAILED";
814
945
  message: string;
815
946
  details?: {
816
947
  [key: string]: unknown;
817
948
  };
949
+ /** @description Support correlation ID, present on 5xx responses only. Quote it when contacting support. */
950
+ incidentId?: string;
818
951
  };
819
952
  };
820
953
  };
@@ -862,6 +995,10 @@ type Severity = ValidationIssue['severity'];
862
995
  type ValidationFormat = ValidationResult['format'];
863
996
  /** Structured invoice extracted from a document (POST /v1/parse). */
864
997
  type ParseResult = Json200Data<'parseInvoice'>;
998
+ /** The JSON-mode generate envelope (Accept: application/json): the seal. */
999
+ type GenerateResponse = Json200Data<'generateInvoice'>;
1000
+ /** One row of the ruleset fingerprint (key, version, file hash). */
1001
+ type RulesetArtifact = NonNullable<ValidationResult['rulesetArtifacts']>[number];
865
1002
  /** The EN 16931 invoice generate accepts, and every option it carries. */
866
1003
  type GenerateBody = RequestJson<'generateInvoice'>;
867
1004
  type Invoice = GenerateBody['invoice'];
@@ -900,6 +1037,12 @@ interface GenerateInput {
900
1037
  template?: 'standard';
901
1038
  /** Render the PDF from a saved dashboard template. */
902
1039
  pdfTemplateId?: string;
1040
+ /**
1041
+ * Return the verify-it-yourself seal: the response carries the document
1042
+ * `sha256` and the full `validationResult` alongside the decoded bytes.
1043
+ * `sha256(bytes)` reproduces the returned hash.
1044
+ */
1045
+ seal?: boolean;
903
1046
  /** Raw JSON deep-merged into the request body. */
904
1047
  advanced?: PlainObject;
905
1048
  }
@@ -928,12 +1071,22 @@ interface GenerateMeta {
928
1071
  schematronVersion?: string;
929
1072
  pdfKind?: string;
930
1073
  outputEnvelope?: string;
1074
+ /** Combined ruleset fingerprint the document was checked against. */
1075
+ rulesetSha256?: string;
1076
+ /** Per-artifact rows behind {@link rulesetSha256}. */
1077
+ rulesetArtifacts?: RulesetArtifact[];
1078
+ /** True for a live key, false for a blq_test_ sandbox key. */
1079
+ livemode?: boolean;
931
1080
  }
932
1081
  interface GenerateResult {
933
1082
  contentType: string;
934
1083
  bytes: Uint8Array;
935
1084
  /** UTF-8 decoded body, present only for an XML output. */
936
1085
  xml?: string;
1086
+ /** SHA-256 of the returned bytes. Present only when `seal` was requested. */
1087
+ sha256?: string;
1088
+ /** Validation verdict for the generated document. Present only when `seal` was requested. */
1089
+ validationResult?: ValidationResult;
937
1090
  meta: GenerateMeta;
938
1091
  }
939
1092
  /** Header metadata returned alongside a converted document. */
@@ -944,6 +1097,8 @@ interface ConvertMeta {
944
1097
  lostElementsCount?: number;
945
1098
  lostElements?: string[];
946
1099
  conversionTools?: string;
1100
+ /** True for a live key, false for a blq_test_ sandbox key. */
1101
+ livemode?: boolean;
947
1102
  }
948
1103
  interface ConvertResult {
949
1104
  contentType: string;
@@ -953,6 +1108,12 @@ interface ConvertResult {
953
1108
  /** Typed client for the beliq e-invoicing compliance API. */
954
1109
  declare class Beliq {
955
1110
  #private;
1111
+ /**
1112
+ * True for a live key, false for a blq_test_ sandbox key, derived from the key
1113
+ * prefix (the same rule the server applies). Available before any request; the
1114
+ * per-response x-beliq-livemode header is surfaced on generate/convert meta.
1115
+ */
1116
+ readonly livemode: boolean;
956
1117
  constructor(options: BeliqOptions);
957
1118
  /** Account, plan, and quota context for the key. Does not consume quota. */
958
1119
  me(): Promise<AccountInfo>;
@@ -982,4 +1143,4 @@ declare class BeliqApiError extends Error {
982
1143
  });
983
1144
  }
984
1145
 
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 };
1146
+ 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 };