@scell/sdk 1.0.0 → 1.4.0

package/README.md

@@ -202,8 +202,9 @@ const apiClient = new ScellApiClient(apiKey, {
 });
 
 // Resources
-apiClient.invoices    // Create, download, convert invoices
-apiClient.signatures  // Create, download, remind, cancel signatures
+apiClient.invoices          // Create, download, convert invoices
+apiClient.signatures        // Create, download, remind, cancel signatures
+apiClient.tenantCreditNotes // Create, send, download tenant credit notes
 ```
 
 ### Companies
@@ -259,6 +260,57 @@ const { data: trail, integrity_valid } = await apiClient.invoices.auditTrail(inv
 await apiClient.invoices.convert({ invoice_id: invoiceId, target_format: 'ubl' });
 ```
 
+### Incoming Invoices (Supplier Invoices)
+
+```typescript
+// List incoming invoices
+const { data: incoming, meta } = await apiClient.invoices.incoming({
+  status: 'pending',
+  seller_siret: '12345678901234',
+  from: '2024-01-01',
+  min_amount: 100,
+  per_page: 50,
+});
+
+console.log(`Found ${meta.total} incoming invoices`);
+
+// Accept an incoming invoice
+const { data: accepted } = await apiClient.invoices.accept(invoiceId, {
+  payment_date: '2024-02-15',
+  note: 'Approved by accounting department',
+});
+
+// Reject an incoming invoice
+const { data: rejected } = await apiClient.invoices.reject(invoiceId, {
+  reason: 'Invoice amount does not match purchase order #PO-2024-001',
+  reason_code: 'incorrect_amount',
+});
+
+// Dispute an incoming invoice
+const { data: disputed } = await apiClient.invoices.dispute(invoiceId, {
+  reason: 'Billed amount exceeds agreed price by 50 EUR',
+  dispute_type: 'amount_dispute',
+  expected_amount: 950.00,
+});
+
+// Mark an invoice as paid (mandatory in French e-invoicing lifecycle)
+const { data: paidInvoice } = await apiClient.invoices.markPaid(invoiceId, {
+  payment_reference: 'VIR-2026-0124',
+  paid_at: '2026-01-24T10:30:00Z',
+  note: 'Payment received via bank transfer',
+});
+
+// Download invoice file as PDF (Factur-X with embedded XML)
+const pdfBuffer = await apiClient.invoices.downloadFile(invoiceId);
+// In Node.js:
+import { writeFileSync } from 'fs';
+writeFileSync('invoice.pdf', Buffer.from(pdfBuffer));
+
+// Download XML version (UBL/CII standalone)
+const xmlBuffer = await apiClient.invoices.downloadFile(invoiceId, 'xml');
+writeFileSync('invoice.xml', Buffer.from(xmlBuffer));
+```
+
 ### Signatures
 
 ```typescript
@@ -285,6 +337,58 @@ const { signers_reminded } = await apiClient.signatures.remind(signatureId);
 await apiClient.signatures.cancel(signatureId);
 ```
 
+### Tenant Credit Notes
+
+```typescript
+// List credit notes for a sub-tenant
+const { data, meta } = await apiClient.tenantCreditNotes.list('sub-tenant-uuid', {
+  status: 'sent',
+  date_from: '2024-01-01',
+  per_page: 50,
+});
+console.log(`Found ${meta.total} credit notes`);
+
+// Check remaining creditable amount for an invoice
+const remaining = await apiClient.tenantCreditNotes.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', {
+  invoice_id: 'invoice-uuid',
+  reason: 'Product returned - damaged item',
+  type: 'partial',
+  items: [
+    { invoice_line_id: 'line-uuid-1', quantity: 2 }
+  ]
+});
+
+// Create a total credit note
+const { data: totalCreditNote } = await apiClient.tenantCreditNotes.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');
+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');
+
+// Download credit note as PDF
+const pdfBuffer = await apiClient.tenantCreditNotes.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');
+```
+
 ### Balance
 
 ```typescript
@@ -412,6 +516,12 @@ const result = await withRetry(
 | `invoice.accepted` | Invoice accepted |
 | `invoice.rejected` | Invoice rejected |
 | `invoice.error` | Invoice processing error |
+| `invoice.incoming.received` | Incoming invoice received from supplier |
+| `invoice.incoming.validated` | Incoming invoice validated |
+| `invoice.incoming.accepted` | Incoming invoice accepted |
+| `invoice.incoming.rejected` | Incoming invoice rejected |
+| `invoice.incoming.disputed` | Incoming invoice disputed |
+| `invoice.incoming.paid` | Incoming invoice marked as paid |
 | `signature.created` | Signature request created |
 | `signature.waiting` | Waiting for signers |
 | `signature.signed` | A signer has signed |
@@ -431,17 +541,36 @@ import type {
   Invoice,
   InvoiceStatus,
   InvoiceDirection,
+  InvoiceFileFormat,
   CreateInvoiceInput,
+  // Incoming invoices
+  IncomingInvoiceParams,
+  AcceptInvoiceInput,
+  RejectInvoiceInput,
+  DisputeInvoiceInput,
+  MarkPaidInput,
+  RejectionCode,
+  DisputeType,
+  // Signatures
   Signature,
   SignatureStatus,
   CreateSignatureInput,
   Signer,
-  Company,
-  Balance,
-  Transaction,
+  // Tenant Credit Notes
+  TenantCreditNote,
+  TenantCreditNoteStatus,
+  TenantCreditNoteType,
+  CreateTenantCreditNoteInput,
+  RemainingCreditable,
+  // Webhooks
   Webhook,
   WebhookEvent,
   WebhookPayload,
+  InvoiceIncomingPaidPayload,
+  // Other
+  Company,
+  Balance,
+  Transaction,
 } from '@scell/sdk';
 ```