@billkit-eu/sdk 0.3.0 → 0.4.0

package/CHANGELOG.md

@@ -8,6 +8,21 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 Versioning is independent of the Python SDK; the two ship on their own cadence,
 so the numbers will diverge after this first release.
 
+## [0.4.0]
+
+### Added
+- **`creditNotes`** — `retrieve`, `list`, `iter` and `retrievePdf`. A credit
+  note is the document that reverses an issued invoice; one is created for you
+  when a refund settles, so there is no `create` here. `list` takes
+  `invoice_id` to answer "was this sale credited, and by how much".
+- **`invoices.void(id)`** — records that an invoice was never owed. It keeps
+  its number and stays readable; it just stops being a receivable.
+
+  A **paid** invoice is refused with a `ConflictError` whose `code` is
+  `"invoice_not_voidable"`. Once the money has moved, "never owed" is not
+  true — refund the payment instead, and a credit note is issued when the
+  refund settles. Voiding twice is a no-op.
+
 ## [0.3.0]
 
 ### Added

package/dist/index.cjs

@@ -620,6 +620,46 @@ var Invoices = class extends BaseResource {
   iter(options = {}) {
     return paginate((p) => this.get("/v1/invoices", p), { pageSize: options.pageSize });
   }
+  /**
+   * Void an invoice: state that the sale was never owed.
+   *
+   * The invoice keeps its number and stays readable — a gapless series
+   * cannot lose a row — and stops being a receivable. Use it for an
+   * invoice that should not have been issued.
+   *
+   * A **paid** invoice is refused with a `ConflictError` whose `code` is
+   * `"invoice_not_voidable"`. That is deliberate rather than a
+   * limitation: once the money has moved, "never owed" is false, and the
+   * document that reverses a real sale is a credit note — refund the
+   * payment and one is issued when the refund settles.
+   *
+   * Idempotent: re-voiding an already-void invoice returns it unchanged.
+   */
+  void(id, params = {}) {
+    return this.post(`/v1/invoices/${id}/void`, params);
+  }
+};
+var CreditNotes = class extends BaseResource {
+  retrieve(id) {
+    return this.get(`/v1/credit_notes/${id}`);
+  }
+  /**
+   * Download the rendered credit note PDF as raw bytes. Same storage
+   * split as {@link Invoices.retrievePdf}: bytes inline or a followed
+   * `302`, and `501 rendering_pending` on a deployment with no renderer.
+   */
+  retrievePdf(id) {
+    return this.t.requestBinary({ method: "GET", path: `/v1/credit_notes/${id}/pdf` });
+  }
+  list(params = {}) {
+    return this.get("/v1/credit_notes", params);
+  }
+  iter(options = {}) {
+    return paginate((p) => this.get("/v1/credit_notes", p), {
+      pageSize: options.pageSize,
+      filters: { invoice_id: options.invoice_id, customer_id: options.customer_id }
+    });
+  }
 };
 var AuditLogs = class extends BaseResource {
   retrieve(id) {
@@ -797,7 +837,7 @@ function sleep(ms) {
 }
 
 // src/version.ts
-var VERSION = "0.3.0";
+var VERSION = "0.4.0";
 
 // src/transport.ts
 var DEFAULT_BASE_URL = "https://api.billkit.eu";
@@ -1031,6 +1071,7 @@ var BillKit = class {
   coupons;
   taxRates;
   invoices;
+  creditNotes;
   auditLogs;
   payments;
   billingPortalSessions;
@@ -1053,6 +1094,7 @@ var BillKit = class {
     this.coupons = new Coupons(transport);
     this.taxRates = new TaxRates(transport);
     this.invoices = new Invoices(transport);
+    this.creditNotes = new CreditNotes(transport);
     this.auditLogs = new AuditLogs(transport);
     this.payments = new Payments(transport);
     this.billingPortalSessions = new BillingPortalSessions(transport);