@orvello/sdk 0.2.4 → 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/CONTRACT_SHA256 +1 -1
- package/README.md +7 -0
- package/dist/contract.cjs +13 -0
- package/dist/contract.cjs.map +1 -1
- package/dist/contract.d.cts +59 -1
- package/dist/contract.d.ts +59 -1
- package/dist/contract.js +13 -0
- package/dist/contract.js.map +1 -1
- package/dist/index.cjs +9 -3
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +6 -4
- package/dist/index.d.ts +6 -4
- package/dist/index.js +9 -3
- package/dist/index.js.map +1 -1
- package/dist/openapi.json +232 -0
- package/package.json +1 -1
package/dist/openapi.json
CHANGED
|
@@ -8486,6 +8486,238 @@
|
|
|
8486
8486
|
]
|
|
8487
8487
|
}
|
|
8488
8488
|
},
|
|
8489
|
+
"/invoices/external/:invoiceId/payment-evidence": {
|
|
8490
|
+
"get": {
|
|
8491
|
+
"operationId": "invoices_payment_evidence_external",
|
|
8492
|
+
"tags": [
|
|
8493
|
+
"invoices-external"
|
|
8494
|
+
],
|
|
8495
|
+
"summary": "Read bank payment evidence for an invoice",
|
|
8496
|
+
"description": "Consistent read-only snapshot of imported bank payments and refunds. Separates cash from discounts, writeoffs and manual paid marks. Decimal amounts are strings. bankPaymentConfirmed requires full matching-account/currency bank coverage without unresolved issues. revision is a content digest, not an ordered event version. No bank import or payment is initiated.",
|
|
8497
|
+
"responses": {
|
|
8498
|
+
"200": {
|
|
8499
|
+
"description": "JSON response",
|
|
8500
|
+
"content": {
|
|
8501
|
+
"application/json": {
|
|
8502
|
+
"schema": {
|
|
8503
|
+
"type": "object",
|
|
8504
|
+
"properties": {
|
|
8505
|
+
"success": {
|
|
8506
|
+
"type": "boolean"
|
|
8507
|
+
},
|
|
8508
|
+
"message": {
|
|
8509
|
+
"anyOf": [
|
|
8510
|
+
{
|
|
8511
|
+
"type": "string"
|
|
8512
|
+
},
|
|
8513
|
+
{
|
|
8514
|
+
"type": "null"
|
|
8515
|
+
}
|
|
8516
|
+
]
|
|
8517
|
+
},
|
|
8518
|
+
"code": {
|
|
8519
|
+
"anyOf": [
|
|
8520
|
+
{
|
|
8521
|
+
"type": "string"
|
|
8522
|
+
},
|
|
8523
|
+
{
|
|
8524
|
+
"type": "null"
|
|
8525
|
+
}
|
|
8526
|
+
]
|
|
8527
|
+
},
|
|
8528
|
+
"data": {
|
|
8529
|
+
"anyOf": [
|
|
8530
|
+
{
|
|
8531
|
+
"type": "object",
|
|
8532
|
+
"properties": {
|
|
8533
|
+
"invoiceId": {
|
|
8534
|
+
"type": "integer",
|
|
8535
|
+
"exclusiveMinimum": 0
|
|
8536
|
+
},
|
|
8537
|
+
"invoiceNumber": {
|
|
8538
|
+
"type": "string"
|
|
8539
|
+
},
|
|
8540
|
+
"currency": {
|
|
8541
|
+
"type": "string"
|
|
8542
|
+
},
|
|
8543
|
+
"invoiceStatus": {
|
|
8544
|
+
"type": "string"
|
|
8545
|
+
},
|
|
8546
|
+
"paidSource": {
|
|
8547
|
+
"anyOf": [
|
|
8548
|
+
{
|
|
8549
|
+
"type": "string"
|
|
8550
|
+
},
|
|
8551
|
+
{
|
|
8552
|
+
"type": "null"
|
|
8553
|
+
}
|
|
8554
|
+
]
|
|
8555
|
+
},
|
|
8556
|
+
"receivingAccountId": {
|
|
8557
|
+
"anyOf": [
|
|
8558
|
+
{
|
|
8559
|
+
"type": "integer",
|
|
8560
|
+
"exclusiveMinimum": 0
|
|
8561
|
+
},
|
|
8562
|
+
{
|
|
8563
|
+
"type": "null"
|
|
8564
|
+
}
|
|
8565
|
+
]
|
|
8566
|
+
},
|
|
8567
|
+
"invoiceAmount": {
|
|
8568
|
+
"type": "string"
|
|
8569
|
+
},
|
|
8570
|
+
"bankReceivedAmount": {
|
|
8571
|
+
"type": "string"
|
|
8572
|
+
},
|
|
8573
|
+
"bankRefundedAmount": {
|
|
8574
|
+
"type": "string"
|
|
8575
|
+
},
|
|
8576
|
+
"bankNetAmount": {
|
|
8577
|
+
"type": "string"
|
|
8578
|
+
},
|
|
8579
|
+
"nonCashSettlementAmount": {
|
|
8580
|
+
"type": "string"
|
|
8581
|
+
},
|
|
8582
|
+
"outstandingBankAmount": {
|
|
8583
|
+
"type": "string"
|
|
8584
|
+
},
|
|
8585
|
+
"overpaidBankAmount": {
|
|
8586
|
+
"type": "string"
|
|
8587
|
+
},
|
|
8588
|
+
"state": {
|
|
8589
|
+
"type": "string",
|
|
8590
|
+
"enum": [
|
|
8591
|
+
"unpaid",
|
|
8592
|
+
"partial",
|
|
8593
|
+
"covered",
|
|
8594
|
+
"overpaid",
|
|
8595
|
+
"review_required",
|
|
8596
|
+
"ineligible"
|
|
8597
|
+
]
|
|
8598
|
+
},
|
|
8599
|
+
"bankPaymentConfirmed": {
|
|
8600
|
+
"type": "boolean"
|
|
8601
|
+
},
|
|
8602
|
+
"issues": {
|
|
8603
|
+
"type": "array",
|
|
8604
|
+
"items": {
|
|
8605
|
+
"type": "string",
|
|
8606
|
+
"enum": [
|
|
8607
|
+
"missing_receiving_account",
|
|
8608
|
+
"invalid_invoice_amount",
|
|
8609
|
+
"ineligible_invoice",
|
|
8610
|
+
"missing_payment",
|
|
8611
|
+
"wrong_account",
|
|
8612
|
+
"currency_mismatch",
|
|
8613
|
+
"invalid_amount",
|
|
8614
|
+
"unsupported_source",
|
|
8615
|
+
"invalid_direction",
|
|
8616
|
+
"payment_overallocated",
|
|
8617
|
+
"non_cash_settlement",
|
|
8618
|
+
"status_without_bank_evidence",
|
|
8619
|
+
"negative_bank_balance"
|
|
8620
|
+
]
|
|
8621
|
+
}
|
|
8622
|
+
},
|
|
8623
|
+
"bankAllocationIds": {
|
|
8624
|
+
"type": "array",
|
|
8625
|
+
"items": {
|
|
8626
|
+
"type": "integer",
|
|
8627
|
+
"exclusiveMinimum": 0
|
|
8628
|
+
}
|
|
8629
|
+
},
|
|
8630
|
+
"excludedAllocationIds": {
|
|
8631
|
+
"type": "array",
|
|
8632
|
+
"items": {
|
|
8633
|
+
"type": "integer",
|
|
8634
|
+
"exclusiveMinimum": 0
|
|
8635
|
+
}
|
|
8636
|
+
},
|
|
8637
|
+
"reversedAllocationCount": {
|
|
8638
|
+
"type": "integer",
|
|
8639
|
+
"minimum": 0
|
|
8640
|
+
},
|
|
8641
|
+
"revision": {
|
|
8642
|
+
"type": "string",
|
|
8643
|
+
"pattern": "^[a-f0-9]{64}$"
|
|
8644
|
+
},
|
|
8645
|
+
"observedAt": {
|
|
8646
|
+
"type": "string",
|
|
8647
|
+
"format": "date-time"
|
|
8648
|
+
}
|
|
8649
|
+
},
|
|
8650
|
+
"required": [
|
|
8651
|
+
"invoiceId",
|
|
8652
|
+
"invoiceNumber",
|
|
8653
|
+
"currency",
|
|
8654
|
+
"invoiceStatus",
|
|
8655
|
+
"paidSource",
|
|
8656
|
+
"receivingAccountId",
|
|
8657
|
+
"invoiceAmount",
|
|
8658
|
+
"bankReceivedAmount",
|
|
8659
|
+
"bankRefundedAmount",
|
|
8660
|
+
"bankNetAmount",
|
|
8661
|
+
"nonCashSettlementAmount",
|
|
8662
|
+
"outstandingBankAmount",
|
|
8663
|
+
"overpaidBankAmount",
|
|
8664
|
+
"state",
|
|
8665
|
+
"bankPaymentConfirmed",
|
|
8666
|
+
"issues",
|
|
8667
|
+
"bankAllocationIds",
|
|
8668
|
+
"excludedAllocationIds",
|
|
8669
|
+
"reversedAllocationCount",
|
|
8670
|
+
"revision",
|
|
8671
|
+
"observedAt"
|
|
8672
|
+
],
|
|
8673
|
+
"additionalProperties": false
|
|
8674
|
+
},
|
|
8675
|
+
{
|
|
8676
|
+
"type": "null"
|
|
8677
|
+
}
|
|
8678
|
+
]
|
|
8679
|
+
}
|
|
8680
|
+
},
|
|
8681
|
+
"required": [
|
|
8682
|
+
"success",
|
|
8683
|
+
"data"
|
|
8684
|
+
],
|
|
8685
|
+
"additionalProperties": false
|
|
8686
|
+
}
|
|
8687
|
+
}
|
|
8688
|
+
}
|
|
8689
|
+
}
|
|
8690
|
+
},
|
|
8691
|
+
"parameters": [
|
|
8692
|
+
{
|
|
8693
|
+
"name": "invoiceId",
|
|
8694
|
+
"in": "path",
|
|
8695
|
+
"required": true,
|
|
8696
|
+
"schema": {
|
|
8697
|
+
"type": "integer",
|
|
8698
|
+
"exclusiveMinimum": 0
|
|
8699
|
+
}
|
|
8700
|
+
}
|
|
8701
|
+
],
|
|
8702
|
+
"security": [
|
|
8703
|
+
{
|
|
8704
|
+
"oauth2Bearer": []
|
|
8705
|
+
},
|
|
8706
|
+
{
|
|
8707
|
+
"companyApiKeyBearer": []
|
|
8708
|
+
}
|
|
8709
|
+
],
|
|
8710
|
+
"x-auth": {
|
|
8711
|
+
"allowOAuth2": true,
|
|
8712
|
+
"allowApiKey": true,
|
|
8713
|
+
"allowUserSession": false,
|
|
8714
|
+
"requireRole": "viewer"
|
|
8715
|
+
},
|
|
8716
|
+
"x-scopes": [
|
|
8717
|
+
"invoices:read"
|
|
8718
|
+
]
|
|
8719
|
+
}
|
|
8720
|
+
},
|
|
8489
8721
|
"/invoices/external": {
|
|
8490
8722
|
"get": {
|
|
8491
8723
|
"operationId": "invoices_search_external",
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@orvello/sdk",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.3.0",
|
|
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",
|