@scell/sdk 1.5.0 → 1.7.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@scell/sdk",
-  "version": "1.5.0",
+  "version": "1.7.0",
   "description": "Official TypeScript SDK for Scell.io - Electronic invoicing (Factur-X) and signatures (eIDAS) API",
   "author": "Scell.io <contact@scell.io>",
   "license": "MIT",

package/src/index.ts

@@ -40,6 +40,7 @@ import { AuthResource, ScellAuth } from './resources/auth.js';
 import { BalanceResource } from './resources/balance.js';
 import { BillingResource } from './resources/billing.js';
 import { CompaniesResource } from './resources/companies.js';
+import { CreditNotesResource } from './resources/credit-notes.js';
 import { FiscalResource } from './resources/fiscal.js';
 import { InvoicesResource } from './resources/invoices.js';
 import { SignaturesResource } from './resources/signatures.js';
@@ -94,6 +95,8 @@ export class ScellClient {
   public readonly invoices: InvoicesResource;
   /** Signature listing (read-only via dashboard) */
   public readonly signatures: SignaturesResource;
+  /** Credit notes management */
+  public readonly creditNotes: CreditNotesResource;
 
   /**
    * Create a new Scell Dashboard Client
@@ -120,6 +123,7 @@ export class ScellClient {
     this.webhooks = new WebhooksResource(this.http);
     this.invoices = new InvoicesResource(this.http);
     this.signatures = new SignaturesResource(this.http);
+    this.creditNotes = new CreditNotesResource(this.http);
   }
 }
 

package/src/resources/credit-notes.ts

@@ -0,0 +1,192 @@
+/**
+ * Credit Notes Resource (direct user / dashboard)
+ *
+ * Note: Deletion is forbidden by NF525 fiscal compliance.
+ *
+ * @packageDocumentation
+ */
+
+import type { HttpClient, RequestOptions } from '../client.js';
+import type {
+  MessageResponse,
+  PaginatedResponse,
+  SingleResponse,
+} from '../types/common.js';
+import type {
+  CreditNote,
+  CreateCreditNoteInput,
+  CreditNoteListOptions,
+} from '../types/credit-notes.js';
+
+/**
+ * Credit Notes API resource
+ *
+ * Manage credit notes for the authenticated dashboard user.
+ *
+ * @example
+ * ```typescript
+ * // List credit notes
+ * const { data, meta } = await client.creditNotes.list({ per_page: 50 });
+ *
+ * // Create a credit note
+ * const creditNote = await client.creditNotes.create({
+ *   invoice_id: 'invoice-uuid',
+ *   reason: 'Product returned',
+ *   items: [{ description: 'Item', quantity: 1, unit_price: 100, tax_rate: 20, total: 120 }]
+ * });
+ * ```
+ */
+export class CreditNotesResource {
+  constructor(private readonly http: HttpClient) {}
+
+  /**
+   * List credit notes with optional filtering
+   *
+   * @param options - Filter and pagination options
+   * @param requestOptions - Request options
+   * @returns Paginated list of credit notes
+   *
+   * @example
+   * ```typescript
+   * const { data, meta } = await client.creditNotes.list({ per_page: 50 });
+   * console.log(`Found ${meta.total} credit notes`);
+   * ```
+   */
+  async list(
+    options: CreditNoteListOptions = {},
+    requestOptions?: RequestOptions
+  ): Promise<PaginatedResponse<CreditNote>> {
+    return this.http.get<PaginatedResponse<CreditNote>>(
+      '/credit-notes',
+      options as Record<string, string | number | boolean | undefined>,
+      requestOptions
+    );
+  }
+
+  /**
+   * Get a specific credit note by ID
+   *
+   * @param id - Credit note UUID
+   * @param requestOptions - Request options
+   * @returns Credit note details
+   *
+   * @example
+   * ```typescript
+   * const { data: creditNote } = await client.creditNotes.get('credit-note-uuid');
+   * console.log('Credit note number:', creditNote.number);
+   * ```
+   */
+  async get(
+    id: string,
+    requestOptions?: RequestOptions
+  ): Promise<SingleResponse<CreditNote>> {
+    return this.http.get<SingleResponse<CreditNote>>(
+      `/credit-notes/${id}`,
+      undefined,
+      requestOptions
+    );
+  }
+
+  /**
+   * Create a new credit note
+   *
+   * @param input - Credit note creation data
+   * @param requestOptions - Request options
+   * @returns Created credit note
+   *
+   * @example
+   * ```typescript
+   * const { data: creditNote } = await client.creditNotes.create({
+   *   invoice_id: 'invoice-uuid',
+   *   reason: 'Product returned',
+   *   items: [
+   *     { description: 'Item A', quantity: 1, unit_price: 100, tax_rate: 20, total: 120 }
+   *   ]
+   * });
+   * ```
+   */
+  async create(
+    input: CreateCreditNoteInput,
+    requestOptions?: RequestOptions
+  ): Promise<SingleResponse<CreditNote>> {
+    return this.http.post<SingleResponse<CreditNote>>(
+      '/credit-notes',
+      input,
+      requestOptions
+    );
+  }
+
+  /**
+   * Send a credit note
+   *
+   * @param id - Credit note UUID
+   * @param requestOptions - Request options
+   * @returns Success message
+   *
+   * @example
+   * ```typescript
+   * await client.creditNotes.send('credit-note-uuid');
+   * ```
+   */
+  async send(
+    id: string,
+    requestOptions?: RequestOptions
+  ): Promise<MessageResponse> {
+    return this.http.post<MessageResponse>(
+      `/credit-notes/${id}/send`,
+      undefined,
+      requestOptions
+    );
+  }
+
+  /**
+   * Download credit note as PDF
+   *
+   * @param id - Credit note UUID
+   * @param requestOptions - Request options
+   * @returns ArrayBuffer containing the PDF file
+   *
+   * @example
+   * ```typescript
+   * const pdfBuffer = await client.creditNotes.download('credit-note-uuid');
+   *
+   * // In Node.js, save to file:
+   * import { writeFileSync } from 'fs';
+   * writeFileSync('credit-note.pdf', Buffer.from(pdfBuffer));
+   * ```
+   */
+  async download(
+    id: string,
+    requestOptions?: RequestOptions
+  ): Promise<ArrayBuffer> {
+    return this.http.getRaw(
+      `/credit-notes/${id}/download`,
+      undefined,
+      requestOptions
+    );
+  }
+
+  /**
+   * Get remaining creditable amount for an invoice
+   *
+   * @param invoiceId - Invoice UUID
+   * @param requestOptions - Request options
+   * @returns Remaining creditable information
+   *
+   * @example
+   * ```typescript
+   * const { data } = await client.creditNotes.remainingCreditable('invoice-uuid');
+   * console.log('Remaining:', data);
+   * ```
+   */
+  async remainingCreditable(
+    invoiceId: string,
+    requestOptions?: RequestOptions
+  ): Promise<SingleResponse<Record<string, unknown>>> {
+    return this.http.get<SingleResponse<Record<string, unknown>>>(
+      `/invoices/${invoiceId}/remaining-creditable`,
+      undefined,
+      requestOptions
+    );
+  }
+}

package/src/resources/fiscal.ts

@@ -111,7 +111,7 @@ export class FiscalResource {
   }
 
   async updateRule(id: string, input: FiscalUpdateRuleInput, requestOptions?: RequestOptions): Promise<SingleResponse<FiscalRule>> {
-    return this.http.post<SingleResponse<FiscalRule>>(`/tenant/fiscal/rules/${id}`, input, requestOptions);
+    return this.http.put<SingleResponse<FiscalRule>>(`/tenant/fiscal/rules/${id}`, input, requestOptions);
   }
 
   async exportRules(options: FiscalExportRulesOptions, requestOptions?: RequestOptions): Promise<SingleResponse<Record<string, unknown>>> {

package/src/resources/invoices.ts

@@ -6,6 +6,7 @@
 
 import type { HttpClient, RequestOptions } from '../client.js';
 import type {
+  MessageResponse,
   MessageWithDataResponse,
   PaginatedResponse,
   SingleResponse,
@@ -416,6 +417,29 @@ export class InvoicesResource {
     );
   }
 
+  /**
+   * Submit an invoice for processing
+   *
+   * @param id - Invoice UUID
+   * @param requestOptions - Request options
+   * @returns Success message
+   *
+   * @example
+   * ```typescript
+   * await client.invoices.submit('invoice-uuid');
+   * ```
+   */
+  async submit(
+    id: string,
+    requestOptions?: RequestOptions
+  ): Promise<MessageResponse> {
+    return this.http.post<MessageResponse>(
+      `/invoices/${id}/submit`,
+      undefined,
+      requestOptions
+    );
+  }
+
   /**
    * Download invoice source file as binary content
    *

package/src/types/credit-notes.ts

@@ -0,0 +1,57 @@
+/**
+ * Credit Notes types (direct user / dashboard)
+ *
+ * @packageDocumentation
+ */
+
+import type {
+  CurrencyCode,
+  DateTimeString,
+  PaginationOptions,
+  UUID,
+} from './common.js';
+
+/**
+ * Credit note item
+ */
+export interface CreditNoteItem {
+  description: string;
+  quantity: number;
+  unit_price: number;
+  tax_rate: number;
+  total: number;
+}
+
+/**
+ * Credit Note (direct user)
+ */
+export interface CreditNote {
+  id: UUID;
+  invoice_id: UUID;
+  number: string;
+  status: string;
+  total_amount: number;
+  tax_amount: number;
+  currency: CurrencyCode;
+  reason: string;
+  items: CreditNoteItem[];
+  created_at: DateTimeString;
+  updated_at: DateTimeString;
+}
+
+/**
+ * Input for creating a credit note
+ */
+export interface CreateCreditNoteInput {
+  invoice_id: UUID;
+  reason: string;
+  items: CreditNoteItem[];
+}
+
+/**
+ * List options for credit notes
+ */
+export interface CreditNoteListOptions extends PaginationOptions {
+  sort?: string | undefined;
+  order?: 'asc' | 'desc' | undefined;
+}

package/src/types/index.ts

@@ -123,6 +123,14 @@ export type {
   User,
 } from './auth.js';
 
+// Credit Notes types (direct user)
+export type {
+  CreditNote,
+  CreditNoteItem,
+  CreateCreditNoteInput,
+  CreditNoteListOptions,
+} from './credit-notes.js';
+
 // Tenant Credit Notes types
 export type {
   CreateTenantCreditNoteInput,