@scell/sdk 1.5.0 → 1.8.0

package/dist/index.d.ts

@@ -183,7 +183,7 @@ interface Address {
     line2?: string | undefined;
     postal_code: string;
     city: string;
-    country?: string | undefined;
+    country: string;
 }
 /**
  * Pagination metadata
@@ -276,7 +276,11 @@ interface InvoiceLine {
  * Invoice party (seller or buyer)
  */
 interface InvoiceParty {
-    siret: Siret;
+    siret?: Siret;
+    vat_number?: string;
+    legal_id?: string;
+    legal_id_scheme?: string;
+    country: string;
     name: string;
     address: Address;
 }
@@ -351,13 +355,29 @@ interface CreateInvoiceInput {
     /** Total including tax */
     total_ttc: number;
     /** Seller SIRET (14 digits) */
-    seller_siret: Siret;
+    seller_siret?: Siret;
+    /** Seller VAT number */
+    seller_vat_number?: string;
+    /** Seller country (ISO 3166-1 alpha-2) */
+    seller_country: string;
+    /** Seller legal identifier */
+    seller_legal_id?: string;
+    /** Seller legal identifier scheme */
+    seller_legal_id_scheme?: string;
     /** Seller company name */
     seller_name: string;
     /** Seller address */
     seller_address: Address;
     /** Buyer SIRET (14 digits) */
-    buyer_siret: Siret;
+    buyer_siret?: Siret;
+    /** Buyer VAT number */
+    buyer_vat_number?: string;
+    /** Buyer country (ISO 3166-1 alpha-2) */
+    buyer_country: string;
+    /** Buyer legal identifier */
+    buyer_legal_id?: string;
+    /** Buyer legal identifier scheme */
+    buyer_legal_id_scheme?: string;
     /** Buyer company name */
     buyer_name: string;
     /** Buyer address */
@@ -3091,6 +3111,8 @@ interface Company {
     siret: Siret;
     siren: Siren | null;
     vat_number: string | null;
+    legal_id: string | null;
+    legal_id_scheme: string | null;
     legal_form: string | null;
     address_line1: string;
     address_line2: string | null;
@@ -3111,7 +3133,9 @@ interface Company {
  */
 interface CreateCompanyInput {
     name: string;
-    siret: Siret;
+    siret?: Siret;
+    legal_id?: string;
+    legal_id_scheme?: string;
     vat_number?: string | undefined;
     legal_form?: string | undefined;
     address_line1: string;
@@ -3303,6 +3327,176 @@ declare class CompaniesResource {
     kycStatus(id: string, requestOptions?: RequestOptions): Promise<KycStatusResponse>;
 }
 
+/**
+ * Credit Notes types (direct user / dashboard)
+ *
+ * @packageDocumentation
+ */
+
+/**
+ * Credit note item
+ */
+interface CreditNoteItem {
+    description: string;
+    quantity: number;
+    unit_price: number;
+    tax_rate: number;
+    total: number;
+}
+/**
+ * Credit Note (direct user)
+ */
+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
+ */
+interface CreateCreditNoteInput {
+    invoice_id: UUID;
+    reason: string;
+    items: CreditNoteItem[];
+}
+/**
+ * List options for credit notes
+ */
+interface CreditNoteListOptions extends PaginationOptions {
+    sort?: string | undefined;
+    order?: 'asc' | 'desc' | undefined;
+}
+
+/**
+ * Credit Notes Resource (direct user / dashboard)
+ *
+ * Note: Deletion is forbidden by NF525 fiscal compliance.
+ *
+ * @packageDocumentation
+ */
+
+/**
+ * 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 }]
+ * });
+ * ```
+ */
+declare class CreditNotesResource {
+    private readonly http;
+    constructor(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`);
+     * ```
+     */
+    list(options?: CreditNoteListOptions, requestOptions?: RequestOptions): Promise<PaginatedResponse<CreditNote>>;
+    /**
+     * 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);
+     * ```
+     */
+    get(id: string, requestOptions?: RequestOptions): Promise<SingleResponse<CreditNote>>;
+    /**
+     * 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 }
+     *   ]
+     * });
+     * ```
+     */
+    create(input: CreateCreditNoteInput, requestOptions?: RequestOptions): Promise<SingleResponse<CreditNote>>;
+    /**
+     * 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');
+     * ```
+     */
+    send(id: string, requestOptions?: RequestOptions): Promise<MessageResponse>;
+    /**
+     * 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));
+     * ```
+     */
+    download(id: string, requestOptions?: RequestOptions): Promise<ArrayBuffer>;
+    /**
+     * 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);
+     * ```
+     */
+    remainingCreditable(invoiceId: string, requestOptions?: RequestOptions): Promise<SingleResponse<Record<string, unknown>>>;
+}
+
 /**
  * Invoices Resource
  *
@@ -3588,6 +3782,19 @@ declare class InvoicesResource {
      * ```
      */
     markPaid(id: string, data?: MarkPaidInput, requestOptions?: RequestOptions): Promise<SingleResponse<Invoice>>;
+    /**
+     * Submit an invoice for processing
+     *
+     * @param id - Invoice UUID
+     * @param requestOptions - Request options
+     * @returns Success message
+     *
+     * @example
+     * ```typescript
+     * await client.invoices.submit('invoice-uuid');
+     * ```
+     */
+    submit(id: string, requestOptions?: RequestOptions): Promise<MessageResponse>;
     /**
      * Download invoice source file as binary content
      *
@@ -4569,6 +4776,8 @@ declare class ScellClient {
     readonly invoices: InvoicesResource;
     /** Signature listing (read-only via dashboard) */
     readonly signatures: SignaturesResource;
+    /** Credit notes management */
+    readonly creditNotes: CreditNotesResource;
     /**
      * Create a new Scell Dashboard Client
      *
@@ -4655,4 +4864,4 @@ declare class ScellApiClient {
     constructor(apiKey: string, config?: ClientConfig);
 }
 
-export { type AcceptInvoiceInput, type Address, type ApiErrorResponse, type ApiKey, type ApiKeyWithSecret, type AuditTrailEntry, type AuditTrailResponse, type AuthResponse, type Balance, type BalanceWebhookData, type BillingInvoice, type BillingInvoiceLine, type BillingInvoiceListOptions, type BillingTopUpConfirmInput, type BillingTopUpInput, type BillingTransaction, type BillingTransactionListOptions, type BillingUsage, type BillingUsageOptions, type ClientConfig, type Company, type CompanyStatus, type ConvertInvoiceInput, type CreateApiKeyInput, type CreateCompanyInput, type CreateIncomingInvoiceParams, type CreateInvoiceInput, type CreateSignatureInput, type CreateSubTenantInput, type CreateTenantCreditNoteInput, type CreateTenantDirectCreditNoteParams, type CreateTenantDirectInvoiceParams, type CreateWebhookInput, type CurrencyCode, type DateRangeOptions, type DateString, type DateTimeString, type DisputeInvoiceInput, type DisputeType, type Environment, type FiscalAnchor, type FiscalAnchorsOptions, type FiscalAttestation, type FiscalAttestationStatus, type FiscalClosing, type FiscalClosingsOptions, type FiscalComplianceData, type FiscalComplianceStatus, type FiscalCreateRuleInput, type FiscalDailyClosingInput, type FiscalEntriesOptions, type FiscalEntry, type FiscalExportRulesOptions, type FiscalFecExportOptions, type FiscalFecExportResult, type FiscalForensicExportOptions, type FiscalForensicExportType, type FiscalIncident, type FiscalIntegrityCheck, type FiscalIntegrityHistoryOptions, type FiscalIntegrityOptions, type FiscalIntegrityReport, type FiscalKillSwitch, type FiscalKillSwitchActivateInput, type FiscalKillSwitchStatus, type FiscalReplayRulesInput, type FiscalRule, type FiscalRuleCategory, type FiscalRulesOptions, type FiscalUpdateRuleInput, type ForgotPasswordInput, type IncomingInvoiceParams, type Invoice, type InvoiceDirection, type InvoiceDownloadResponse, type InvoiceDownloadType, type InvoiceFileFormat, type InvoiceFormat, type InvoiceIncomingPaidPayload, type InvoiceLine, type InvoiceLineInput, type InvoiceListOptions, type InvoiceParty, type InvoiceStatus, type InvoiceWebhookData, type KycInitiateResponse, type KycStatusResponse, type LoginCredentials, type MarkPaidInput, type MessageResponse, type MessageWithDataResponse, type PaginatedResponse, type PaginationMeta, type PaginationOptions, type RegenerateKeyResult, type RegisterInput, type RejectInvoiceInput, type RejectionCode, type ReloadBalanceInput, type ReloadBalanceResponse, type RemainingCreditable, type RemainingCreditableLine, type ResetPasswordInput, type RetryOptions, ScellApiClient, ScellAuth, ScellAuthenticationError, ScellAuthorizationError, ScellClient, ScellError, ScellInsufficientBalanceError, ScellNetworkError, ScellNotFoundError, ScellRateLimitError, ScellServerError, ScellTenantClient, ScellTimeoutError, ScellValidationError, ScellWebhooks, type Signature, type SignatureDownloadResponse, type SignatureDownloadType, type SignatureListOptions, type SignaturePosition, type SignatureRemindResponse, type SignatureStatus, type SignatureUIConfig, type SignatureWebhookData, type Signer, type SignerAuthMethod, type SignerInput, type SignerStatus, type SingleResponse, type Siren, type Siret, type StatsMonthly, type StatsMonthlyOptions, type StatsOverview, type StatsOverviewOptions, type SubTenant, type SubTenantAddress, type SubTenantListOptions, type TenantAddress, type TenantBalance, type TenantCreditNote, type TenantCreditNoteFilters, type TenantCreditNoteItem, type TenantCreditNoteItemInput, type TenantCreditNoteListOptions, type TenantCreditNoteStatus, type TenantCreditNoteType, type TenantInvoice, type TenantInvoiceBuyer, type TenantInvoiceDirection, type TenantInvoiceFilters, type TenantInvoiceSeller, type TenantProfile, type TenantQuickStats, type Transaction, type TransactionListOptions, type TransactionService, type TransactionType, type UUID, type UpdateBalanceSettingsInput, type UpdateCompanyInput, type UpdateSubTenantInput, type UpdateTenantCreditNoteInput, type UpdateTenantCreditNoteParams, type UpdateTenantInvoiceParams, type UpdateTenantProfileInput, type UpdateWebhookInput, type User, type VerifySignatureOptions, type Webhook, type WebhookEvent, type WebhookListOptions, type WebhookLog, type WebhookPayload, type WebhookTestResponse, type WebhookWithSecret, createRetryWrapper, withRetry };
+export { type AcceptInvoiceInput, type Address, type ApiErrorResponse, type ApiKey, type ApiKeyWithSecret, type AuditTrailEntry, type AuditTrailResponse, type AuthResponse, type Balance, type BalanceWebhookData, type BillingInvoice, type BillingInvoiceLine, type BillingInvoiceListOptions, type BillingTopUpConfirmInput, type BillingTopUpInput, type BillingTransaction, type BillingTransactionListOptions, type BillingUsage, type BillingUsageOptions, type ClientConfig, type Company, type CompanyStatus, type ConvertInvoiceInput, type CreateApiKeyInput, type CreateCompanyInput, type CreateCreditNoteInput, type CreateIncomingInvoiceParams, type CreateInvoiceInput, type CreateSignatureInput, type CreateSubTenantInput, type CreateTenantCreditNoteInput, type CreateTenantDirectCreditNoteParams, type CreateTenantDirectInvoiceParams, type CreateWebhookInput, type CreditNote, type CreditNoteItem, type CreditNoteListOptions, type CurrencyCode, type DateRangeOptions, type DateString, type DateTimeString, type DisputeInvoiceInput, type DisputeType, type Environment, type FiscalAnchor, type FiscalAnchorsOptions, type FiscalAttestation, type FiscalAttestationStatus, type FiscalClosing, type FiscalClosingsOptions, type FiscalComplianceData, type FiscalComplianceStatus, type FiscalCreateRuleInput, type FiscalDailyClosingInput, type FiscalEntriesOptions, type FiscalEntry, type FiscalExportRulesOptions, type FiscalFecExportOptions, type FiscalFecExportResult, type FiscalForensicExportOptions, type FiscalForensicExportType, type FiscalIncident, type FiscalIntegrityCheck, type FiscalIntegrityHistoryOptions, type FiscalIntegrityOptions, type FiscalIntegrityReport, type FiscalKillSwitch, type FiscalKillSwitchActivateInput, type FiscalKillSwitchStatus, type FiscalReplayRulesInput, type FiscalRule, type FiscalRuleCategory, type FiscalRulesOptions, type FiscalUpdateRuleInput, type ForgotPasswordInput, type IncomingInvoiceParams, type Invoice, type InvoiceDirection, type InvoiceDownloadResponse, type InvoiceDownloadType, type InvoiceFileFormat, type InvoiceFormat, type InvoiceIncomingPaidPayload, type InvoiceLine, type InvoiceLineInput, type InvoiceListOptions, type InvoiceParty, type InvoiceStatus, type InvoiceWebhookData, type KycInitiateResponse, type KycStatusResponse, type LoginCredentials, type MarkPaidInput, type MessageResponse, type MessageWithDataResponse, type PaginatedResponse, type PaginationMeta, type PaginationOptions, type RegenerateKeyResult, type RegisterInput, type RejectInvoiceInput, type RejectionCode, type ReloadBalanceInput, type ReloadBalanceResponse, type RemainingCreditable, type RemainingCreditableLine, type ResetPasswordInput, type RetryOptions, ScellApiClient, ScellAuth, ScellAuthenticationError, ScellAuthorizationError, ScellClient, ScellError, ScellInsufficientBalanceError, ScellNetworkError, ScellNotFoundError, ScellRateLimitError, ScellServerError, ScellTenantClient, ScellTimeoutError, ScellValidationError, ScellWebhooks, type Signature, type SignatureDownloadResponse, type SignatureDownloadType, type SignatureListOptions, type SignaturePosition, type SignatureRemindResponse, type SignatureStatus, type SignatureUIConfig, type SignatureWebhookData, type Signer, type SignerAuthMethod, type SignerInput, type SignerStatus, type SingleResponse, type Siren, type Siret, type StatsMonthly, type StatsMonthlyOptions, type StatsOverview, type StatsOverviewOptions, type SubTenant, type SubTenantAddress, type SubTenantListOptions, type TenantAddress, type TenantBalance, type TenantCreditNote, type TenantCreditNoteFilters, type TenantCreditNoteItem, type TenantCreditNoteItemInput, type TenantCreditNoteListOptions, type TenantCreditNoteStatus, type TenantCreditNoteType, type TenantInvoice, type TenantInvoiceBuyer, type TenantInvoiceDirection, type TenantInvoiceFilters, type TenantInvoiceSeller, type TenantProfile, type TenantQuickStats, type Transaction, type TransactionListOptions, type TransactionService, type TransactionType, type UUID, type UpdateBalanceSettingsInput, type UpdateCompanyInput, type UpdateSubTenantInput, type UpdateTenantCreditNoteInput, type UpdateTenantCreditNoteParams, type UpdateTenantInvoiceParams, type UpdateTenantProfileInput, type UpdateWebhookInput, type User, type VerifySignatureOptions, type Webhook, type WebhookEvent, type WebhookListOptions, type WebhookLog, type WebhookPayload, type WebhookTestResponse, type WebhookWithSecret, createRetryWrapper, withRetry };

package/dist/index.js

@@ -1575,7 +1575,7 @@ var FiscalResource = class {
     return this.http.post("/tenant/fiscal/rules", input, requestOptions);
   }
   async updateRule(id, input, requestOptions) {
-    return this.http.post(`/tenant/fiscal/rules/${id}`, input, requestOptions);
+    return this.http.put(`/tenant/fiscal/rules/${id}`, input, requestOptions);
   }
   async exportRules(options, requestOptions) {
     return this.http.get("/tenant/fiscal/rules/export", options, requestOptions);
@@ -2275,6 +2275,140 @@ var CompaniesResource = class {
   }
 };
 
+// src/resources/credit-notes.ts
+var CreditNotesResource = class {
+  constructor(http) {
+    this.http = http;
+  }
+  /**
+   * 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 = {}, requestOptions) {
+    return this.http.get(
+      "/credit-notes",
+      options,
+      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, requestOptions) {
+    return this.http.get(
+      `/credit-notes/${id}`,
+      void 0,
+      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, requestOptions) {
+    return this.http.post(
+      "/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, requestOptions) {
+    return this.http.post(
+      `/credit-notes/${id}/send`,
+      void 0,
+      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, requestOptions) {
+    return this.http.getRaw(
+      `/credit-notes/${id}/download`,
+      void 0,
+      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, requestOptions) {
+    return this.http.get(
+      `/invoices/${invoiceId}/remaining-creditable`,
+      void 0,
+      requestOptions
+    );
+  }
+};
+
 // src/resources/invoices.ts
 var InvoicesResource = class {
   constructor(http) {
@@ -2590,6 +2724,25 @@ var InvoicesResource = class {
       requestOptions
     );
   }
+  /**
+   * 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, requestOptions) {
+    return this.http.post(
+      `/invoices/${id}/submit`,
+      void 0,
+      requestOptions
+    );
+  }
   /**
    * Download invoice source file as binary content
    *
@@ -3210,6 +3363,8 @@ var ScellClient = class {
   invoices;
   /** Signature listing (read-only via dashboard) */
   signatures;
+  /** Credit notes management */
+  creditNotes;
   /**
    * Create a new Scell Dashboard Client
    *
@@ -3234,6 +3389,7 @@ var ScellClient = class {
     this.webhooks = new WebhooksResource(this.http);
     this.invoices = new InvoicesResource(this.http);
     this.signatures = new SignaturesResource(this.http);
+    this.creditNotes = new CreditNotesResource(this.http);
   }
 };
 var ScellApiClient = class {