@beliq/sdk 0.3.1 → 0.4.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 CHANGED
@@ -26,13 +26,33 @@ const account = await beliq.me();
26
26
  const generated = await beliq.generate({
27
27
  standard: 'xrechnung',
28
28
  verify: true,
29
+ // The XRechnung CIUS asks for more than plain EN 16931: a seller contact
30
+ // (BR-DE-2), payment instructions (BR-DE-1), a VAT breakdown (BR-CO-18) and an
31
+ // electronic address for each party. examples/invoice.json is this same shape.
29
32
  invoice: {
30
33
  number: 'INV-2026-001',
31
34
  issueDate: '2026-01-15',
32
35
  currencyCode: 'EUR',
33
- seller: { name: 'Seller GmbH', address: { city: 'Berlin', postalCode: '10115', countryCode: 'DE' } },
34
- buyer: { name: 'Buyer GmbH', address: { city: 'Munich', postalCode: '80331', countryCode: 'DE' } },
36
+ buyerReference: '04011000-12345-06',
37
+ seller: {
38
+ name: 'Seller GmbH',
39
+ vatId: 'DE123456789',
40
+ contactName: 'Anna Muster',
41
+ email: 'billing@seller.example',
42
+ phone: '+49 30 1234567',
43
+ address: { street: 'Hauptstr. 1', city: 'Berlin', postalCode: '10115', countryCode: 'DE' },
44
+ peppol: { schemeId: '9930', id: 'DE123456789' },
45
+ },
46
+ buyer: {
47
+ name: 'Buyer GmbH',
48
+ vatId: 'DE987654321',
49
+ email: 'ap@buyer.example',
50
+ address: { street: 'Marktweg 2', city: 'Munich', postalCode: '80331', countryCode: 'DE' },
51
+ peppol: { schemeId: '9930', id: 'DE987654321' },
52
+ },
35
53
  lines: [{ description: 'Consulting', quantity: 10, unitCode: 'HUR', unitPrice: 100, lineTotal: 1000, vatRate: 19, vatCategoryCode: 'S' }],
54
+ taxSummary: [{ vatCategoryCode: 'S', vatRate: 19, taxableAmount: 1000, taxAmount: 190 }],
55
+ paymentMeans: { typeCode: '58', iban: 'DE89370400440532013000' },
36
56
  totalNetAmount: 1000,
37
57
  totalTaxAmount: 190,
38
58
  totalGrossAmount: 1190,
@@ -165,6 +185,7 @@ npm install
165
185
  npm run build # tsup: dual ESM + CJS + d.ts
166
186
  npm run typecheck
167
187
  npm run lint
188
+ npm run scrub:check # no em-dash in any tracked file
168
189
  npm test # unit tests (no network)
169
190
  BELIQ_API_KEY=blq_xxx npm run test:integration # hits the live API; draws quota
170
191
  ```