@scell/sdk 1.5.0 → 1.7.0

package/README.md

@@ -204,9 +204,29 @@ const apiClient = new ScellApiClient(apiKey, {
 // Resources
 apiClient.invoices          // Create, download, convert invoices
 apiClient.signatures        // Create, download, remind, cancel signatures
-apiClient.tenantCreditNotes // Create, send, download tenant credit notes
+apiClient.creditNotes       // Create, send, download tenant credit notes
+apiClient.subTenants        // Sub-tenant management
+apiClient.fiscal            // NF525 fiscal compliance
+apiClient.stats             // Platform statistics
+apiClient.billing           // Usage, top-up, transactions
+apiClient.tenantInvoices    // Tenant invoice operations
+apiClient.incomingInvoices  // Incoming invoice operations
 ```
 
+#### ScellApiClient API Reference
+
+| Resource | Methods |
+|----------|---------|
+| `.invoices` | `create(params)`, `list(filters?)`, `get(id)`, `download(id, format?)`, `auditTrail(id)`, `convert(params)`, `incoming(filters?)`, `accept(id, input)`, `reject(id, input)`, `dispute(id, input)`, `markPaid(id, input)`, `downloadFile(id, format?)` |
+| `.signatures` | `create(params)`, `list(filters?)`, `get(id)`, `download(id, type)`, `remind(id)`, `cancel(id)` |
+| `.creditNotes` | `list(subTenantId, options?)`, `create(subTenantId, input)`, `get(id)`, `send(id)`, `download(id)`, `delete(id)`, `remainingCreditable(invoiceId)` |
+| `.subTenants` | `list()`, `create(input)`, `get(id)`, `update(id, input)`, `delete(id)`, `findByExternalId(externalId)` |
+| `.fiscal` | 23 methods (see ScellTenantClient reference) |
+| `.stats` | `overview(options?)`, `monthly(options?)`, `subTenantOverview(subTenantId, options?)` |
+| `.billing` | `invoices(options?)`, `showInvoice(id)`, `downloadInvoice(id)`, `usage(options?)`, `topUp(input)`, `confirmTopUp(input)`, `transactions(options?)` |
+| `.tenantInvoices` | `create(params)`, `list(filters?)`, `get(id)`, `update(id, params)`, `delete(id)`, `validate(id)`, `send(id)`, `download(id)`, `downloadXml(id)`, `bulkCreate(invoices)`, `bulkSubmit(ids)`, `bulkStatus(ids)` |
+| `.incomingInvoices` | `create(subTenantId, params)`, `listForSubTenant(subTenantId)`, `get(id)`, `accept(id)`, `reject(id, reason)`, `markPaid(id)`, `download(id)` |
+
 ### Companies
 
 ```typescript
@@ -341,7 +361,7 @@ await apiClient.signatures.cancel(signatureId);
 
 ```typescript
 // List credit notes for a sub-tenant
-const { data, meta } = await apiClient.tenantCreditNotes.list('sub-tenant-uuid', {
+const { data, meta } = await apiClient.creditNotes.list('sub-tenant-uuid', {
   status: 'sent',
   date_from: '2024-01-01',
   per_page: 50,
@@ -349,14 +369,14 @@ const { data, meta } = await apiClient.tenantCreditNotes.list('sub-tenant-uuid',
 console.log(`Found ${meta.total} credit notes`);
 
 // Check remaining creditable amount for an invoice
-const remaining = await apiClient.tenantCreditNotes.remainingCreditable('invoice-uuid');
+const remaining = await apiClient.creditNotes.remainingCreditable('invoice-uuid');
 console.log('Remaining to credit:', remaining.remaining_total);
 remaining.lines.forEach(line => {
   console.log(`${line.description}: ${line.remaining_quantity} items remaining`);
 });
 
 // Create a partial credit note
-const { data: creditNote } = await apiClient.tenantCreditNotes.create('sub-tenant-uuid', {
+const { data: creditNote } = await apiClient.creditNotes.create('sub-tenant-uuid', {
   invoice_id: 'invoice-uuid',
   reason: 'Product returned - damaged item',
   type: 'partial',
@@ -366,27 +386,27 @@ const { data: creditNote } = await apiClient.tenantCreditNotes.create('sub-tenan
 });
 
 // Create a total credit note
-const { data: totalCreditNote } = await apiClient.tenantCreditNotes.create('sub-tenant-uuid', {
+const { data: totalCreditNote } = await apiClient.creditNotes.create('sub-tenant-uuid', {
   invoice_id: 'invoice-uuid',
   reason: 'Order cancelled',
   type: 'total'
 });
 
 // Get credit note details
-const { data: details } = await apiClient.tenantCreditNotes.get('credit-note-uuid');
+const { data: details } = await apiClient.creditNotes.get('credit-note-uuid');
 console.log('Credit note number:', details.credit_note_number);
 
 // Send a credit note (changes status from draft to sent)
-const { data: sent } = await apiClient.tenantCreditNotes.send('credit-note-uuid');
+const { data: sent } = await apiClient.creditNotes.send('credit-note-uuid');
 
 // Download credit note as PDF
-const pdfBuffer = await apiClient.tenantCreditNotes.download('credit-note-uuid');
+const pdfBuffer = await apiClient.creditNotes.download('credit-note-uuid');
 // In Node.js:
 import { writeFileSync } from 'fs';
 writeFileSync('credit-note.pdf', Buffer.from(pdfBuffer));
 
 // Delete a draft credit note
-await apiClient.tenantCreditNotes.delete('credit-note-uuid');
+await apiClient.creditNotes.delete('credit-note-uuid');
 ```
 
 ### Balance
@@ -447,6 +467,69 @@ const { data: logs } = await client.webhooks.logs(webhookId);
 await client.webhooks.delete(webhookId);
 ```
 
+### ScellTenantClient (Multi-Tenant Partner)
+
+For multi-tenant operations with X-Tenant-Key authentication.
+
+```typescript
+import { ScellTenantClient } from '@scell/sdk';
+
+const tenant = new ScellTenantClient({
+  tenantKey: 'tk_live_...',
+  baseUrl: 'https://api.scell.io/api/v1', // optional
+});
+
+// Profile
+const profile = await tenant.me();
+await tenant.updateProfile({ company_name: 'New Name' });
+const balance = await tenant.balance();
+const stats = await tenant.quickStats();
+await tenant.regenerateKey();
+
+// Sub-Tenants
+const subTenants = await tenant.subTenants.list();
+const sub = await tenant.subTenants.create({ ... });
+
+// Direct Invoices (without sub-tenant)
+const invoices = await tenant.directInvoices.list();
+const invoice = await tenant.directInvoices.create({ ... });
+await tenant.directInvoices.bulkCreate([...]);
+await tenant.directInvoices.bulkSubmit([id1, id2]);
+
+// Direct Credit Notes
+const notes = await tenant.directCreditNotes.list();
+const note = await tenant.directCreditNotes.create({ ... });
+
+// Incoming Invoices
+const incoming = await tenant.incomingInvoices.listForSubTenant(subId);
+await tenant.incomingInvoices.accept(invoiceId);
+
+// Fiscal Compliance
+const compliance = await tenant.fiscal.compliance();
+const integrity = await tenant.fiscal.integrity();
+
+// Billing
+const billingInvoices = await tenant.billing.invoices();
+const usage = await tenant.billing.usage();
+
+// Stats
+const overview = await tenant.stats.overview();
+```
+
+#### ScellTenantClient API Reference
+
+| Resource | Methods |
+|----------|---------|
+| Direct methods | `me()`, `updateProfile(input)`, `balance()`, `quickStats()`, `regenerateKey()` |
+| `.subTenants` | `list()`, `create(input)`, `get(id)`, `update(id, input)`, `delete(id)`, `findByExternalId(externalId)` |
+| `.directInvoices` | `create(params)`, `list(filters?)`, `get(id)`, `update(id, params)`, `delete(id)`, `validate(id)`, `send(id)`, `download(id)`, `downloadXml(id)`, `bulkCreate(invoices)`, `bulkSubmit(ids)`, `bulkStatus(ids)` |
+| `.directCreditNotes` | `create(params)`, `list(filters?)`, `get(id)`, `update(id, params)`, `send(id)`, `download(id)`, `remainingCreditable(invoiceId)` |
+| `.subTenantCreditNotes` | `list(subTenantId, options?)`, `create(subTenantId, input)`, `get(id)`, `update(id, input)`, `send(id)`, `download(id)`, `remainingCreditable(invoiceId)` |
+| `.incomingInvoices` | `create(subTenantId, params)`, `listForSubTenant(subTenantId, filters?)`, `get(id)`, `accept(id, input?)`, `reject(id, reason, code?)`, `markPaid(id, input?)`, `download(id)` |
+| `.fiscal` | `compliance()`, `integrity()`, `integrityHistory()`, `integrityForDate(date)`, `closings()`, `performDailyClosing(input?)`, `fecExport(options)`, `fecDownload(options)`, `attestation(year)`, `attestationDownload(year)`, `entries()`, `killSwitchStatus()`, `killSwitchActivate(input)`, `killSwitchDeactivate()`, `anchors()`, `rules()`, `ruleDetail(key)`, `ruleHistory(key)`, `createRule(input)`, `updateRule(id, input)`, `exportRules(options)`, `replayRules(input)`, `forensicExport(options)` |
+| `.billing` | `invoices(options?)`, `showInvoice(id)`, `downloadInvoice(id)`, `usage(options?)`, `topUp(input)`, `confirmTopUp(input)`, `transactions(options?)` |
+| `.stats` | `overview(options?)`, `monthly(options?)`, `subTenantOverview(subTenantId, options?)` |
+
 ## Error Handling
 
 ```typescript

package/dist/index.d.mts

@@ -3303,6 +3303,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 +3758,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 +4752,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 +4840,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.d.ts

@@ -3303,6 +3303,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 +3758,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 +4752,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 +4840,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 };