@orvello/sdk 0.7.4 → 0.7.6

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 (15) hide show
  1. package/CONTRACT_SHA256 +1 -1
  2. package/dist/contract.cjs +30 -3
  3. package/dist/contract.cjs.map +1 -1
  4. package/dist/contract.d.cts +217 -13
  5. package/dist/contract.d.ts +217 -13
  6. package/dist/contract.js +30 -3
  7. package/dist/contract.js.map +1 -1
  8. package/dist/index.cjs +5 -3
  9. package/dist/index.cjs.map +1 -1
  10. package/dist/index.d.cts +2 -2
  11. package/dist/index.d.ts +2 -2
  12. package/dist/index.js +5 -3
  13. package/dist/index.js.map +1 -1
  14. package/dist/openapi.json +421 -7
  15. package/package.json +1 -1
package/dist/openapi.json CHANGED
@@ -12711,6 +12711,9 @@
12711
12711
  "type": "string",
12712
12712
  "maxLength": 500
12713
12713
  },
12714
+ "acknowledgeSection14cLiability": {
12715
+ "type": "boolean"
12716
+ },
12714
12717
  "lineItems": {
12715
12718
  "type": "array",
12716
12719
  "items": {
@@ -14067,6 +14070,9 @@
14067
14070
  "type": "string",
14068
14071
  "maxLength": 500
14069
14072
  },
14073
+ "acknowledgeSection14cLiability": {
14074
+ "type": "boolean"
14075
+ },
14070
14076
  "lineItems": {
14071
14077
  "type": "array",
14072
14078
  "items": {
@@ -15210,6 +15216,9 @@
15210
15216
  "type": "string",
15211
15217
  "maxLength": 500
15212
15218
  },
15219
+ "acknowledgeSection14cLiability": {
15220
+ "type": "boolean"
15221
+ },
15213
15222
  "lineItems": {
15214
15223
  "type": "array",
15215
15224
  "items": {
@@ -15330,7 +15339,7 @@
15330
15339
  "invoices-external"
15331
15340
  ],
15332
15341
  "summary": "Update invoice status (external API)",
15333
- "description": "Changes invoice status (e.g., mark as paid). State machine rules are enforced server-side. GoBD-safe: issued invoices cannot be cancelled directly; use credit note/cancellation endpoints instead.",
15342
+ "description": "Changes invoice status (e.g., mark as paid). State machine rules are enforced server-side. GoBD-safe: issued invoices cannot be cancelled directly; use credit note/cancellation endpoints instead. A paid status set here is stored with paidSource \"external\"; the optional source (api, sync, webhook) is kept in the audit log only.",
15334
15343
  "responses": {
15335
15344
  "200": {
15336
15345
  "description": "JSON response",
@@ -15786,6 +15795,11 @@
15786
15795
  "cancellation"
15787
15796
  ]
15788
15797
  },
15798
+ "idempotencyKey": {
15799
+ "type": "string",
15800
+ "minLength": 1,
15801
+ "maxLength": 200
15802
+ },
15789
15803
  "lineItems": {
15790
15804
  "type": "array",
15791
15805
  "items": {
@@ -15870,7 +15884,7 @@
15870
15884
  "invoices-external"
15871
15885
  ],
15872
15886
  "summary": "Issue credit note (external API)",
15873
- "description": "Issues a GoBD-compliant credit note or cancellation invoice. Generates PDF and creates an immutable document. Returns the new correction invoice.",
15887
+ "description": "Issues a GoBD-compliant credit note or cancellation invoice. Generates PDF and creates an immutable document. Returns the new correction invoice. Optional idempotencyKey (max 200, e.g. the refund id): a retry with the same key on the same invoice returns the correction already issued (201, replayed: true) instead of booking a second one; the same key with a different body returns 409 IDEMPOTENCY_CONFLICT. Keys do not expire.",
15874
15888
  "responses": {
15875
15889
  "201": {
15876
15890
  "description": "JSON response",
@@ -15962,6 +15976,11 @@
15962
15976
  "cancellation"
15963
15977
  ]
15964
15978
  },
15979
+ "idempotencyKey": {
15980
+ "type": "string",
15981
+ "minLength": 1,
15982
+ "maxLength": 200
15983
+ },
15965
15984
  "lineItems": {
15966
15985
  "type": "array",
15967
15986
  "items": {
@@ -16545,6 +16564,9 @@
16545
16564
  "type": "string",
16546
16565
  "maxLength": 500
16547
16566
  },
16567
+ "acknowledgeSection14cLiability": {
16568
+ "type": "boolean"
16569
+ },
16548
16570
  "lineItems": {
16549
16571
  "type": "array",
16550
16572
  "items": {
@@ -17403,6 +17425,11 @@
17403
17425
  "cancellation"
17404
17426
  ]
17405
17427
  },
17428
+ "idempotencyKey": {
17429
+ "type": "string",
17430
+ "minLength": 1,
17431
+ "maxLength": 200
17432
+ },
17406
17433
  "lineItems": {
17407
17434
  "type": "array",
17408
17435
  "items": {
@@ -17571,6 +17598,11 @@
17571
17598
  "cancellation"
17572
17599
  ]
17573
17600
  },
17601
+ "idempotencyKey": {
17602
+ "type": "string",
17603
+ "minLength": 1,
17604
+ "maxLength": 200
17605
+ },
17574
17606
  "lineItems": {
17575
17607
  "type": "array",
17576
17608
  "items": {
@@ -30940,7 +30972,8 @@
30940
30972
  "bank",
30941
30973
  "cash",
30942
30974
  "paypal",
30943
- "sumup"
30975
+ "sumup",
30976
+ "stripe"
30944
30977
  ]
30945
30978
  },
30946
30979
  "name": {
@@ -31231,7 +31264,8 @@
31231
31264
  "bank",
31232
31265
  "cash",
31233
31266
  "paypal",
31234
- "sumup"
31267
+ "sumup",
31268
+ "stripe"
31235
31269
  ]
31236
31270
  },
31237
31271
  "name": {
@@ -32637,6 +32671,15 @@
32637
32671
  "feeVatRate": {
32638
32672
  "type": "string",
32639
32673
  "pattern": "^\\d+(\\.\\d{1,4})?$"
32674
+ },
32675
+ "provider": {
32676
+ "type": "string",
32677
+ "enum": [
32678
+ "sumup",
32679
+ "paypal",
32680
+ "stripe",
32681
+ "klarna"
32682
+ ]
32640
32683
  }
32641
32684
  },
32642
32685
  "required": [
@@ -33386,7 +33429,7 @@
33386
33429
  "payments-external"
33387
33430
  ],
33388
33431
  "summary": "Settle invoice via external API",
33389
- "description": "One-shot settlement for shop/payment-provider flows: creates payment, allocates it to the invoice, and can auto-close shortfall as discount so no manual allocation step remains.",
33432
+ "description": "One-shot settlement for shop/payment-provider flows. Preferred contract: grossAmount (customer payment, settles the invoice), feeAmount + feeProvider + feeReference (provider fee, booked as expense, never as customer discount), paidAt (actual payment time) and, for a payment currency other than the invoice currency, originalAmount/originalCurrency (documented gross in invoice currency; realized FX difference is recorded). Legacy contract (payoutAmount + bookedAt, optional closeGapStrategy=discount) keeps working unchanged; existing discounts are not reinterpreted. A changed fee for an already used reference is rejected with 409: use /settle-invoice/fee-correction.",
33390
33433
  "responses": {
33391
33434
  "200": {
33392
33435
  "description": "JSON response",
@@ -33504,6 +33547,10 @@
33504
33547
  "type": "string",
33505
33548
  "minLength": 1
33506
33549
  },
33550
+ "paidAt": {
33551
+ "type": "string",
33552
+ "minLength": 1
33553
+ },
33507
33554
  "valueAt": {
33508
33555
  "type": "string"
33509
33556
  },
@@ -33517,6 +33564,54 @@
33517
33564
  }
33518
33565
  ]
33519
33566
  },
33567
+ "grossAmount": {
33568
+ "anyOf": [
33569
+ {
33570
+ "type": "string"
33571
+ },
33572
+ {
33573
+ "type": "number"
33574
+ }
33575
+ ]
33576
+ },
33577
+ "feeAmount": {
33578
+ "anyOf": [
33579
+ {
33580
+ "type": "string"
33581
+ },
33582
+ {
33583
+ "type": "number"
33584
+ }
33585
+ ]
33586
+ },
33587
+ "feeProvider": {
33588
+ "type": "string",
33589
+ "enum": [
33590
+ "sumup",
33591
+ "paypal",
33592
+ "stripe",
33593
+ "klarna"
33594
+ ]
33595
+ },
33596
+ "feeReference": {
33597
+ "type": "string",
33598
+ "maxLength": 200
33599
+ },
33600
+ "originalAmount": {
33601
+ "anyOf": [
33602
+ {
33603
+ "type": "string"
33604
+ },
33605
+ {
33606
+ "type": "number"
33607
+ }
33608
+ ]
33609
+ },
33610
+ "originalCurrency": {
33611
+ "type": "string",
33612
+ "minLength": 3,
33613
+ "maxLength": 3
33614
+ },
33520
33615
  "currency": {
33521
33616
  "type": "string",
33522
33617
  "minLength": 3,
@@ -33561,11 +33656,197 @@
33561
33656
  },
33562
33657
  "raw": {}
33563
33658
  },
33659
+ "required": [
33660
+ "invoiceId",
33661
+ "paymentAccountId"
33662
+ ],
33663
+ "additionalProperties": false
33664
+ }
33665
+ }
33666
+ }
33667
+ },
33668
+ "security": [
33669
+ {
33670
+ "oauth2Bearer": []
33671
+ },
33672
+ {
33673
+ "companyApiKeyBearer": []
33674
+ }
33675
+ ],
33676
+ "x-auth": {
33677
+ "allowOAuth2": true,
33678
+ "allowApiKey": true,
33679
+ "allowUserSession": false,
33680
+ "requireRole": "editor"
33681
+ },
33682
+ "x-scopes": [
33683
+ "payments:write",
33684
+ "invoices:write"
33685
+ ]
33686
+ }
33687
+ },
33688
+ "/bookkeeping/payments/external/settle-invoice/fee-correction": {
33689
+ "post": {
33690
+ "operationId": "bookkeeping_payments_settlement_fee_correction_external",
33691
+ "tags": [
33692
+ "bookkeeping",
33693
+ "payments-external"
33694
+ ],
33695
+ "summary": "Correct the provider fee of an external settlement",
33696
+ "description": "Later provider fee change (e.g. fee refund) on a settlement made with grossAmount/feeAmount. The original payment stays unchanged; the difference is booked on correctedAt as its own account movement with a signed fee receipt. Idempotent per correctionRef. Legacy net-payout settlements are refused (422): their fee was never documented.",
33697
+ "responses": {
33698
+ "200": {
33699
+ "description": "JSON response",
33700
+ "content": {
33701
+ "application/json": {
33702
+ "schema": {
33703
+ "type": "object",
33704
+ "properties": {
33705
+ "success": {
33706
+ "type": "boolean"
33707
+ },
33708
+ "message": {
33709
+ "anyOf": [
33710
+ {
33711
+ "type": "string"
33712
+ },
33713
+ {
33714
+ "type": "null"
33715
+ }
33716
+ ]
33717
+ },
33718
+ "code": {
33719
+ "anyOf": [
33720
+ {
33721
+ "type": "string"
33722
+ },
33723
+ {
33724
+ "type": "null"
33725
+ }
33726
+ ]
33727
+ },
33728
+ "data": {
33729
+ "anyOf": [
33730
+ {},
33731
+ {
33732
+ "type": "null"
33733
+ }
33734
+ ]
33735
+ }
33736
+ },
33737
+ "required": [
33738
+ "success",
33739
+ "data"
33740
+ ],
33741
+ "additionalProperties": false
33742
+ }
33743
+ }
33744
+ }
33745
+ },
33746
+ "201": {
33747
+ "description": "JSON response",
33748
+ "content": {
33749
+ "application/json": {
33750
+ "schema": {
33751
+ "type": "object",
33752
+ "properties": {
33753
+ "success": {
33754
+ "type": "boolean"
33755
+ },
33756
+ "message": {
33757
+ "anyOf": [
33758
+ {
33759
+ "type": "string"
33760
+ },
33761
+ {
33762
+ "type": "null"
33763
+ }
33764
+ ]
33765
+ },
33766
+ "code": {
33767
+ "anyOf": [
33768
+ {
33769
+ "type": "string"
33770
+ },
33771
+ {
33772
+ "type": "null"
33773
+ }
33774
+ ]
33775
+ },
33776
+ "data": {
33777
+ "anyOf": [
33778
+ {},
33779
+ {
33780
+ "type": "null"
33781
+ }
33782
+ ]
33783
+ }
33784
+ },
33785
+ "required": [
33786
+ "success",
33787
+ "data"
33788
+ ],
33789
+ "additionalProperties": false
33790
+ }
33791
+ }
33792
+ }
33793
+ }
33794
+ },
33795
+ "requestBody": {
33796
+ "required": true,
33797
+ "content": {
33798
+ "application/json": {
33799
+ "schema": {
33800
+ "type": "object",
33801
+ "properties": {
33802
+ "invoiceId": {
33803
+ "type": "integer",
33804
+ "exclusiveMinimum": 0
33805
+ },
33806
+ "paymentAccountId": {
33807
+ "type": "integer",
33808
+ "exclusiveMinimum": 0
33809
+ },
33810
+ "externalRef": {
33811
+ "type": "string",
33812
+ "minLength": 3,
33813
+ "maxLength": 120
33814
+ },
33815
+ "feeAmount": {
33816
+ "anyOf": [
33817
+ {
33818
+ "type": "string"
33819
+ },
33820
+ {
33821
+ "type": "number"
33822
+ }
33823
+ ]
33824
+ },
33825
+ "correctedAt": {
33826
+ "type": "string",
33827
+ "minLength": 1
33828
+ },
33829
+ "correctionRef": {
33830
+ "type": "string",
33831
+ "minLength": 3,
33832
+ "maxLength": 120
33833
+ },
33834
+ "feeReference": {
33835
+ "type": "string",
33836
+ "maxLength": 200
33837
+ },
33838
+ "reason": {
33839
+ "type": "string",
33840
+ "maxLength": 500
33841
+ }
33842
+ },
33564
33843
  "required": [
33565
33844
  "invoiceId",
33566
33845
  "paymentAccountId",
33567
- "bookedAt",
33568
- "payoutAmount"
33846
+ "externalRef",
33847
+ "feeAmount",
33848
+ "correctedAt",
33849
+ "correctionRef"
33569
33850
  ],
33570
33851
  "additionalProperties": false
33571
33852
  }
@@ -56062,6 +56343,9 @@
56062
56343
  "type": "string",
56063
56344
  "maxLength": 500
56064
56345
  },
56346
+ "acknowledgeSection14cLiability": {
56347
+ "type": "boolean"
56348
+ },
56065
56349
  "lineItems": {
56066
56350
  "type": "array",
56067
56351
  "items": {
@@ -60515,6 +60799,136 @@
60515
60799
  ]
60516
60800
  }
60517
60801
  },
60802
+ "/managing-companies/:id/owner": {
60803
+ "put": {
60804
+ "operationId": "managing_companies_transfer_owner",
60805
+ "tags": [
60806
+ "managing-companies"
60807
+ ],
60808
+ "summary": "Besitz einer Firma uebergeben",
60809
+ "description": "Uebergibt den Besitz einer Managing Company an einen anderen Admin. Die Firma zaehlt nur gegen den Plan ihres Besitzers (Firmenzahl, Rechnungen je Monat, Speicher). Nur der jetzige Besitzer (oder ein Plattform-Admin) darf uebergeben; der neue Besitzer muss unbefristeter Admin sein und Platz in seinem Plan haben (sonst 403 PLAN_LIMIT_REACHED). Fehler: 403 COMPANY_OWNERSHIP_FORBIDDEN, 404 COMPANY_NOT_FOUND, 422 COMPANY_OWNER_MUST_BE_ADMIN. Erfordert `bookkeeping_access`.",
60810
+ "responses": {
60811
+ "200": {
60812
+ "description": "JSON response",
60813
+ "content": {
60814
+ "application/json": {
60815
+ "schema": {
60816
+ "type": "object",
60817
+ "properties": {
60818
+ "success": {
60819
+ "type": "boolean"
60820
+ },
60821
+ "message": {
60822
+ "anyOf": [
60823
+ {
60824
+ "type": "string"
60825
+ },
60826
+ {
60827
+ "type": "null"
60828
+ }
60829
+ ]
60830
+ },
60831
+ "code": {
60832
+ "anyOf": [
60833
+ {
60834
+ "type": "string"
60835
+ },
60836
+ {
60837
+ "type": "null"
60838
+ }
60839
+ ]
60840
+ },
60841
+ "data": {
60842
+ "anyOf": [
60843
+ {
60844
+ "type": "object",
60845
+ "properties": {
60846
+ "managingCompanyId": {
60847
+ "type": "integer"
60848
+ },
60849
+ "previousOwnerUserId": {
60850
+ "anyOf": [
60851
+ {
60852
+ "type": "integer"
60853
+ },
60854
+ {
60855
+ "type": "null"
60856
+ }
60857
+ ]
60858
+ },
60859
+ "ownerUserId": {
60860
+ "type": "integer"
60861
+ },
60862
+ "changed": {
60863
+ "type": "boolean"
60864
+ }
60865
+ },
60866
+ "required": [
60867
+ "managingCompanyId",
60868
+ "previousOwnerUserId",
60869
+ "ownerUserId",
60870
+ "changed"
60871
+ ],
60872
+ "additionalProperties": false
60873
+ },
60874
+ {
60875
+ "type": "null"
60876
+ }
60877
+ ]
60878
+ }
60879
+ },
60880
+ "required": [
60881
+ "success",
60882
+ "data"
60883
+ ],
60884
+ "additionalProperties": false
60885
+ }
60886
+ }
60887
+ }
60888
+ }
60889
+ },
60890
+ "parameters": [
60891
+ {
60892
+ "name": "id",
60893
+ "in": "path",
60894
+ "required": true,
60895
+ "schema": {
60896
+ "type": "integer",
60897
+ "exclusiveMinimum": 0
60898
+ }
60899
+ }
60900
+ ],
60901
+ "requestBody": {
60902
+ "required": true,
60903
+ "content": {
60904
+ "application/json": {
60905
+ "schema": {
60906
+ "type": "object",
60907
+ "properties": {
60908
+ "userId": {
60909
+ "type": "integer",
60910
+ "exclusiveMinimum": 0
60911
+ }
60912
+ },
60913
+ "required": [
60914
+ "userId"
60915
+ ],
60916
+ "additionalProperties": false
60917
+ }
60918
+ }
60919
+ }
60920
+ },
60921
+ "security": [
60922
+ {
60923
+ "frontendBearer": []
60924
+ }
60925
+ ],
60926
+ "x-transport": "http",
60927
+ "x-permissions": [
60928
+ "bookkeeping_access"
60929
+ ]
60930
+ }
60931
+ },
60518
60932
  "/admin/vat/system-settings": {
60519
60933
  "get": {
60520
60934
  "operationId": "admin_vat_get_system_settings",
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@orvello/sdk",
3
- "version": "0.7.4",
3
+ "version": "0.7.6",
4
4
  "description": "Typed, zero-dependency SDK for integrating Node and Next.js applications with orvello - the accounting & invoicing platform. Sends the credential each route demands, and can prove a call would work without making it.",
5
5
  "keywords": [
6
6
  "orvello",