@facturino/node 1.0.0

package/dist/cjs/index.d.ts

@@ -0,0 +1,59 @@
+import { Webhooks } from './webhooks.js';
+import { Invoices } from './resources/invoices.js';
+import { Payments } from './resources/payments.js';
+import { Customers } from './resources/customers.js';
+import { Products } from './resources/products.js';
+import { Quotes } from './resources/quotes.js';
+import { CreditNotes } from './resources/creditNotes.js';
+import { Events } from './resources/events.js';
+import { WebhookEndpoints } from './resources/webhookEndpoints.js';
+import { RecurringInvoices } from './resources/recurringInvoices.js';
+import { Companies } from './resources/companies.js';
+import { Exports } from './resources/exports.js';
+import { EReportingResource } from './resources/ereporting.js';
+import { Jobs } from './resources/jobs.js';
+import { Sandbox } from './resources/sandbox.js';
+import { ReceivedInvoices } from './resources/received-invoices.js';
+import { Reporting } from './resources/reporting.js';
+import { AccountResource } from './resources/account.js';
+import { Billing } from './resources/billing.js';
+import { Usage } from './resources/usage.js';
+import { Validate } from './resources/validate.js';
+import { Reference } from './resources/reference.js';
+import { Archives } from './resources/archives.js';
+import { Health } from './resources/health.js';
+import type { FacturinoConfig } from './types.js';
+/** Facturino API client for French e-invoicing — initialize with your API key to access all resources. */
+declare class Facturino {
+    readonly account: AccountResource;
+    readonly billing: Billing;
+    readonly invoices: Invoices;
+    readonly payments: Payments;
+    readonly customers: Customers;
+    readonly products: Products;
+    readonly quotes: Quotes;
+    readonly creditNotes: CreditNotes;
+    readonly events: Events;
+    readonly webhookEndpoints: WebhookEndpoints;
+    readonly recurringInvoices: RecurringInvoices;
+    readonly companies: Companies;
+    readonly exports: Exports;
+    readonly ereporting: EReportingResource;
+    readonly jobs: Jobs;
+    readonly reference: Reference;
+    readonly sandbox: Sandbox;
+    readonly usage: Usage;
+    readonly validate: Validate;
+    readonly webhooks: Webhooks;
+    readonly receivedInvoices: ReceivedInvoices;
+    readonly reporting: Reporting;
+    readonly archives: Archives;
+    readonly health: Health;
+    constructor(apiKey: string, config?: FacturinoConfig);
+}
+export default Facturino;
+export { Facturino };
+export type { FacturinoConfig, RequestOptions, PaginationParams, PaginatedResponse, ApiErrorBody, Address, Contact, ContactRole, LineItem, VatBreakdown, Totals, CustomerRef, CustomerSnapshot, LifecycleEntry, Currency, Unit, VatCode, VatexCode, PaymentMethod, InvoiceType, InvoiceStatus, InvoiceDates, InvoicePaymentTerms, InvoiceEinvoicing, InvoicePortal, InvoiceArchive, InvoiceFiles, Invoice, InvoiceExpandField, InvoiceExpanded, InvoiceRetrieveParams, InvoiceBuyerParam, InvoiceCreateDates, InvoiceCreateParams, InvoiceLineItemParam, InvoiceUpdateParams, InvoiceListParams, IncomingInvoiceCreateParams, InvoiceStatusResponse, InvoiceVerifyResponse, DocumentUrlResponse, JobResponse, PaymentLinkResponse, PaymentLinkCreateParams, PaymentTokenResponse, Payment, PaymentCreateParams, Customer, CustomerCreateParams, CustomerUpdateParams, CustomerListParams, CustomerLookupParams, SireneLookupResponse, SireneCompany, Product, PriceHistoryEntry, ProductCreateParams, ProductUpdateParams, ProductListParams, QuoteStatus, QuoteDates, QuoteSignature, Quote, QuoteCreateParams, QuoteUpdateParams, QuoteListParams, CreditNoteType, CreditNoteStatus, CreditNoteReasonCode, CreditNote, CreditNoteCreateParams, CreditNoteUpdateParams, CreditNoteListParams, WebhookEventType, WebhookEvent, EventListParams, WebhookEndpoint, WebhookEndpointCreateParams, WebhookEndpointUpdateParams, RecurringFrequency, RecurringInvoice, RecurringInvoiceCreateParams, RecurringInvoiceUpdateParams, RecurringInvoiceListParams, BankDetails, InvoiceSettings, CreditNoteSettings, CreditNoteNumberingMode, Company, CompanyUpdateParams, CgvResponse, FecExportParams, EReportingType, EReportingStatus, EReportingLine, EReportingLineResponse, EReporting, EReportingCreateParams, EReportingListParams, JobType, JobStatus, Job, SandboxResetResponse, SimulateStatusParams, SimulateStatusResponse, ReceivedInvoiceStatus, ReceivedInvoice, ReceivedInvoiceListParams, ReceivedInvoiceRefuseParams, ReceivedInvoiceRecordPaymentParams, ReceivedInvoiceActionResponse, VatReportParams, VatReportBreakdown, VatReport, RevenueReportParams, RevenueReportBreakdownItem, RevenueReport, AccountPlan, Account, BillingCycle, BillingSubscription, PlatformInvoice, UsageMeter, UsageSummary, ValidateParams, ValidateResponse, LegalForm, NafCode, LegalFormInput, NafCodeInput, PaProvider, HealthStatus, } from './types.js';
+export { FacturinoError, ApiError, InvalidRequestError, ValidationError, AuthenticationError, PermissionError, NotFoundError, ConflictError, RateLimitError, PlanLimitError, ApiInternalError, ConnectionError, } from './errors.js';
+export { Webhooks } from './webhooks.js';
+export { AutoPaginatingList } from './pagination.js';

package/dist/cjs/index.js

@@ -0,0 +1,77 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AutoPaginatingList = exports.Webhooks = exports.ConnectionError = exports.ApiInternalError = exports.PlanLimitError = exports.RateLimitError = exports.ConflictError = exports.NotFoundError = exports.PermissionError = exports.AuthenticationError = exports.ValidationError = exports.InvalidRequestError = exports.ApiError = exports.FacturinoError = exports.Facturino = void 0;
+const client_js_1 = require("./client.js");
+const webhooks_js_1 = require("./webhooks.js");
+const invoices_js_1 = require("./resources/invoices.js");
+const payments_js_1 = require("./resources/payments.js");
+const customers_js_1 = require("./resources/customers.js");
+const products_js_1 = require("./resources/products.js");
+const quotes_js_1 = require("./resources/quotes.js");
+const creditNotes_js_1 = require("./resources/creditNotes.js");
+const events_js_1 = require("./resources/events.js");
+const webhookEndpoints_js_1 = require("./resources/webhookEndpoints.js");
+const recurringInvoices_js_1 = require("./resources/recurringInvoices.js");
+const companies_js_1 = require("./resources/companies.js");
+const exports_js_1 = require("./resources/exports.js");
+const ereporting_js_1 = require("./resources/ereporting.js");
+const jobs_js_1 = require("./resources/jobs.js");
+const sandbox_js_1 = require("./resources/sandbox.js");
+const received_invoices_js_1 = require("./resources/received-invoices.js");
+const reporting_js_1 = require("./resources/reporting.js");
+const account_js_1 = require("./resources/account.js");
+const billing_js_1 = require("./resources/billing.js");
+const usage_js_1 = require("./resources/usage.js");
+const validate_js_1 = require("./resources/validate.js");
+const reference_js_1 = require("./resources/reference.js");
+const archives_js_1 = require("./resources/archives.js");
+const health_js_1 = require("./resources/health.js");
+/** Facturino API client for French e-invoicing — initialize with your API key to access all resources. */
+class Facturino {
+    constructor(apiKey, config) {
+        const client = new client_js_1.HttpClient(apiKey, config);
+        this.account = new account_js_1.AccountResource(client);
+        this.billing = new billing_js_1.Billing(client);
+        this.invoices = new invoices_js_1.Invoices(client);
+        this.payments = new payments_js_1.Payments(client);
+        this.customers = new customers_js_1.Customers(client);
+        this.products = new products_js_1.Products(client);
+        this.quotes = new quotes_js_1.Quotes(client);
+        this.creditNotes = new creditNotes_js_1.CreditNotes(client);
+        this.events = new events_js_1.Events(client);
+        this.webhookEndpoints = new webhookEndpoints_js_1.WebhookEndpoints(client);
+        this.recurringInvoices = new recurringInvoices_js_1.RecurringInvoices(client);
+        this.companies = new companies_js_1.Companies(client);
+        this.exports = new exports_js_1.Exports(client);
+        this.ereporting = new ereporting_js_1.EReportingResource(client);
+        this.jobs = new jobs_js_1.Jobs(client);
+        this.reference = new reference_js_1.Reference(client);
+        this.sandbox = new sandbox_js_1.Sandbox(client);
+        this.usage = new usage_js_1.Usage(client);
+        this.validate = new validate_js_1.Validate(client);
+        this.webhooks = new webhooks_js_1.Webhooks();
+        this.receivedInvoices = new received_invoices_js_1.ReceivedInvoices(client);
+        this.reporting = new reporting_js_1.Reporting(client);
+        this.archives = new archives_js_1.Archives(client);
+        this.health = new health_js_1.Health(client);
+    }
+}
+exports.Facturino = Facturino;
+exports.default = Facturino;
+var errors_js_1 = require("./errors.js");
+Object.defineProperty(exports, "FacturinoError", { enumerable: true, get: function () { return errors_js_1.FacturinoError; } });
+Object.defineProperty(exports, "ApiError", { enumerable: true, get: function () { return errors_js_1.ApiError; } });
+Object.defineProperty(exports, "InvalidRequestError", { enumerable: true, get: function () { return errors_js_1.InvalidRequestError; } });
+Object.defineProperty(exports, "ValidationError", { enumerable: true, get: function () { return errors_js_1.ValidationError; } });
+Object.defineProperty(exports, "AuthenticationError", { enumerable: true, get: function () { return errors_js_1.AuthenticationError; } });
+Object.defineProperty(exports, "PermissionError", { enumerable: true, get: function () { return errors_js_1.PermissionError; } });
+Object.defineProperty(exports, "NotFoundError", { enumerable: true, get: function () { return errors_js_1.NotFoundError; } });
+Object.defineProperty(exports, "ConflictError", { enumerable: true, get: function () { return errors_js_1.ConflictError; } });
+Object.defineProperty(exports, "RateLimitError", { enumerable: true, get: function () { return errors_js_1.RateLimitError; } });
+Object.defineProperty(exports, "PlanLimitError", { enumerable: true, get: function () { return errors_js_1.PlanLimitError; } });
+Object.defineProperty(exports, "ApiInternalError", { enumerable: true, get: function () { return errors_js_1.ApiInternalError; } });
+Object.defineProperty(exports, "ConnectionError", { enumerable: true, get: function () { return errors_js_1.ConnectionError; } });
+var webhooks_js_2 = require("./webhooks.js");
+Object.defineProperty(exports, "Webhooks", { enumerable: true, get: function () { return webhooks_js_2.Webhooks; } });
+var pagination_js_1 = require("./pagination.js");
+Object.defineProperty(exports, "AutoPaginatingList", { enumerable: true, get: function () { return pagination_js_1.AutoPaginatingList; } });

package/dist/cjs/package.json

@@ -0,0 +1,3 @@
+{
+  "type": "commonjs"
+}

package/dist/cjs/pagination.d.ts

@@ -0,0 +1,24 @@
+import type { HttpClient } from './client.js';
+import type { PaginatedResponse, PaginationParams } from './types.js';
+/**
+ * Async-iterable list with auto-pagination.
+ *
+ * ```ts
+ * for await (const inv of facturino.invoices.list()) { ... }
+ * // or: const page = await facturino.invoices.list()
+ * ```
+ */
+export declare class AutoPaginatingList<T extends {
+    id: string;
+}> implements AsyncIterable<T>, PromiseLike<PaginatedResponse<T>> {
+    private readonly client;
+    private readonly path;
+    private readonly params;
+    private firstPagePromise;
+    constructor(client: HttpClient, path: string, params?: PaginationParams);
+    /** Await resolves to the first page. */
+    then<TResult1 = PaginatedResponse<T>, TResult2 = never>(onfulfilled?: ((value: PaginatedResponse<T>) => TResult1 | PromiseLike<TResult1>) | null, onrejected?: ((reason: unknown) => TResult2 | PromiseLike<TResult2>) | null): Promise<TResult1 | TResult2>;
+    /** Yields items across all pages. */
+    [Symbol.asyncIterator](): AsyncIterator<T>;
+    private getFirstPage;
+}

package/dist/cjs/pagination.js

@@ -0,0 +1,68 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AutoPaginatingList = void 0;
+/**
+ * Async-iterable list with auto-pagination.
+ *
+ * ```ts
+ * for await (const inv of facturino.invoices.list()) { ... }
+ * // or: const page = await facturino.invoices.list()
+ * ```
+ */
+class AutoPaginatingList {
+    constructor(client, path, params) {
+        this.firstPagePromise = null;
+        this.client = client;
+        this.path = path;
+        this.params = { ...(params ?? {}) };
+    }
+    /** Await resolves to the first page. */
+    then(onfulfilled, onrejected) {
+        return this.getFirstPage().then(onfulfilled, onrejected);
+    }
+    /** Yields items across all pages. */
+    async *[Symbol.asyncIterator]() {
+        let cursor = this.params.starting_after;
+        const limit = this.params.limit ?? 25;
+        for (;;) {
+            const queryParams = {};
+            if (limit)
+                queryParams.limit = String(limit);
+            if (cursor)
+                queryParams.starting_after = cursor;
+            // Forward filter params (status, type, active, etc.)
+            for (const [key, value] of Object.entries(this.params)) {
+                if (key === 'limit' || key === 'starting_after')
+                    continue;
+                if (value !== undefined && value !== null) {
+                    queryParams[key] = String(value);
+                }
+            }
+            const qs = new URLSearchParams(queryParams).toString();
+            const url = qs ? `${this.path}?${qs}` : this.path;
+            const page = await this.client.get(url);
+            for (const item of page.data) {
+                yield item;
+            }
+            if (!page.has_more || page.data.length === 0) {
+                break;
+            }
+            cursor = page.next_cursor ?? page.data[page.data.length - 1].id;
+        }
+    }
+    getFirstPage() {
+        if (!this.firstPagePromise) {
+            const queryParams = {};
+            for (const [key, value] of Object.entries(this.params)) {
+                if (value !== undefined && value !== null) {
+                    queryParams[key] = String(value);
+                }
+            }
+            const qs = new URLSearchParams(queryParams).toString();
+            const url = qs ? `${this.path}?${qs}` : this.path;
+            this.firstPagePromise = this.client.get(url);
+        }
+        return this.firstPagePromise;
+    }
+}
+exports.AutoPaginatingList = AutoPaginatingList;

package/dist/cjs/resources/account.d.ts

@@ -0,0 +1,58 @@
+import type { HttpClient } from '../client.js';
+import type { Account } from '../types.js';
+/**
+ * Result of `POST /v1/account/export` (202 Accepted). The export runs
+ * asynchronously — poll `exports.getExportStatus(id)` until the job exposes
+ * `download_url`.
+ */
+export interface AccountExportResponse {
+    object: 'job';
+    /** Job id (`job_…`) — poll it via `exports.getExportStatus`. */
+    id: string;
+    type: 'rgpd_export';
+    status: string;
+}
+/** Short-lived (5 min) signed-URL response for a prepared RGPD export. */
+export interface AccountExportDownloadResponse {
+    object: 'export_url';
+    url: string;
+    /** ISO 8601 expiry of the signed URL (5 minutes). */
+    expires_at: string;
+}
+/**
+ * Account introspection — returns the authenticated user, the active
+ * company, the current plan and the scopes attached to the API key in
+ * use. Every integration should expose this on a "Connected to
+ * Facturino" surface so users can confirm which company and which
+ * environment (`fac_test_` vs `fac_live_`) their requests target.
+ *
+ * Also exposes the RGPD data-export endpoints (article 20): request a
+ * full export and download it once prepared.
+ */
+export declare class AccountResource {
+    private readonly client;
+    constructor(client: HttpClient);
+    /**
+     * Return the account context (user, company, plan, livemode, scopes)
+     * associated with the API key used by this client. Equivalent to
+     * Stripe's `accounts.retrieve('me')` — no path parameter, the key
+     * implicitly identifies "self".
+     */
+    retrieve(): Promise<Account>;
+    /**
+     * Request a full export of the account's data (RGPD article 20).
+     * Returns 202 with a job id; the file is prepared asynchronously.
+     * Poll `exports.getExportStatus(id)` until the job carries a
+     * `download_url` (the user also receives an in-app notification).
+     */
+    requestExport(): Promise<AccountExportResponse>;
+    /**
+     * Return a short-lived (5 minutes) signed URL for a prepared RGPD
+     * export. Takes the `rgpdexp_…` export id delivered by the
+     * `export_ready` notification — NOT the `job_…` id returned by
+     * {@link requestExport} (poll that one via `exports.getExportStatus`).
+     * The export metadata is keyed under the authenticated user —
+     * cross-user access is impossible.
+     */
+    downloadExport(exportId: string): Promise<AccountExportDownloadResponse>;
+}

package/dist/cjs/resources/account.js

@@ -0,0 +1,48 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AccountResource = void 0;
+/**
+ * Account introspection — returns the authenticated user, the active
+ * company, the current plan and the scopes attached to the API key in
+ * use. Every integration should expose this on a "Connected to
+ * Facturino" surface so users can confirm which company and which
+ * environment (`fac_test_` vs `fac_live_`) their requests target.
+ *
+ * Also exposes the RGPD data-export endpoints (article 20): request a
+ * full export and download it once prepared.
+ */
+class AccountResource {
+    constructor(client) {
+        this.client = client;
+    }
+    /**
+     * Return the account context (user, company, plan, livemode, scopes)
+     * associated with the API key used by this client. Equivalent to
+     * Stripe's `accounts.retrieve('me')` — no path parameter, the key
+     * implicitly identifies "self".
+     */
+    async retrieve() {
+        return this.client.get('/v1/account');
+    }
+    /**
+     * Request a full export of the account's data (RGPD article 20).
+     * Returns 202 with a job id; the file is prepared asynchronously.
+     * Poll `exports.getExportStatus(id)` until the job carries a
+     * `download_url` (the user also receives an in-app notification).
+     */
+    async requestExport() {
+        return this.client.post('/v1/account/export');
+    }
+    /**
+     * Return a short-lived (5 minutes) signed URL for a prepared RGPD
+     * export. Takes the `rgpdexp_…` export id delivered by the
+     * `export_ready` notification — NOT the `job_…` id returned by
+     * {@link requestExport} (poll that one via `exports.getExportStatus`).
+     * The export metadata is keyed under the authenticated user —
+     * cross-user access is impossible.
+     */
+    async downloadExport(exportId) {
+        return this.client.get(`/v1/account/exports/${exportId}/download`);
+    }
+}
+exports.AccountResource = AccountResource;

package/dist/cjs/resources/archives.d.ts

@@ -0,0 +1,16 @@
+import type { HttpClient } from '../client.js';
+import { AutoPaginatingList } from '../pagination.js';
+import type { PaginationParams } from '../types.js';
+/** Archive retrieval — access legally archived invoices and verify integrity. */
+export declare class Archives {
+    private readonly client;
+    constructor(client: HttpClient);
+    list(params?: PaginationParams): AutoPaginatingList<{
+        id: string;
+        [key: string]: unknown;
+    }>;
+    get(invoiceId: string): Promise<{
+        id: string;
+        [key: string]: unknown;
+    }>;
+}

package/dist/cjs/resources/archives.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Archives = void 0;
+const pagination_js_1 = require("../pagination.js");
+/** Archive retrieval — access legally archived invoices and verify integrity. */
+class Archives {
+    constructor(client) {
+        this.client = client;
+    }
+    list(params) {
+        return new pagination_js_1.AutoPaginatingList(this.client, '/v1/archives', params);
+    }
+    async get(invoiceId) {
+        return this.client.get(`/v1/archives/${invoiceId}`);
+    }
+}
+exports.Archives = Archives;

package/dist/cjs/resources/billing.d.ts

@@ -0,0 +1,30 @@
+import type { HttpClient } from '../client.js';
+import type { BillingSubscription, PaginatedResponse, PlatformInvoice } from '../types.js';
+/**
+ * Billing — read-only access to the current subscription and the
+ * Facturino → user platform-invoice history.
+ *
+ * Plan changes, checkout and the Stripe Customer Portal are handled
+ * through the Facturino dashboard, not the API.
+ */
+export declare class Billing {
+    private readonly client;
+    constructor(client: HttpClient);
+    /** Current subscription (plan, status, period). */
+    retrieveSubscription(): Promise<BillingSubscription>;
+    /** Paginated list of platform invoices (Facturino → user) for the current account. */
+    listInvoices(params?: {
+        limit?: number;
+        starting_after?: string;
+    }): Promise<PaginatedResponse<PlatformInvoice>>;
+    /**
+     * Short-lived signed URL for a platform-invoice PDF. The URL expires
+     * within minutes — fetch it just-in-time when the user clicks
+     * "Download", do not store it.
+     */
+    getInvoicePdf(invoiceId: string): Promise<{
+        object: 'file_url';
+        url: string;
+        expires_in: number;
+    }>;
+}

package/dist/cjs/resources/billing.js

@@ -0,0 +1,45 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Billing = void 0;
+/** Encode a flat object as a `?k=v&…` query string (skips undefined/null). */
+function buildQuery(params) {
+    const entries = [];
+    for (const [k, v] of Object.entries(params)) {
+        if (v === undefined || v === null)
+            continue;
+        entries.push([k, String(v)]);
+    }
+    if (entries.length === 0)
+        return '';
+    return `?${new URLSearchParams(entries).toString()}`;
+}
+/**
+ * Billing — read-only access to the current subscription and the
+ * Facturino → user platform-invoice history.
+ *
+ * Plan changes, checkout and the Stripe Customer Portal are handled
+ * through the Facturino dashboard, not the API.
+ */
+class Billing {
+    constructor(client) {
+        this.client = client;
+    }
+    /** Current subscription (plan, status, period). */
+    async retrieveSubscription() {
+        return this.client.get('/v1/billing/subscription');
+    }
+    /** Paginated list of platform invoices (Facturino → user) for the current account. */
+    async listInvoices(params) {
+        const qs = params ? buildQuery(params) : '';
+        return this.client.get(`/v1/billing/invoices${qs}`);
+    }
+    /**
+     * Short-lived signed URL for a platform-invoice PDF. The URL expires
+     * within minutes — fetch it just-in-time when the user clicks
+     * "Download", do not store it.
+     */
+    async getInvoicePdf(invoiceId) {
+        return this.client.get(`/v1/billing/invoices/${invoiceId}/pdf`);
+    }
+}
+exports.Billing = Billing;

package/dist/cjs/resources/companies.d.ts

@@ -0,0 +1,47 @@
+import type { HttpClient } from '../client.js';
+import type { Address, BankDetails, Company, CompanyUpdateParams, CgvResponse, LegalFormInput, NafCodeInput, PaginatedResponse, RequestOptions } from '../types.js';
+/** Body for `POST /v1/companies` — create a new company under the authenticated user. */
+export interface CompanyCreateParams {
+    name: string;
+    siret: string;
+    address: Address;
+    vatNumber?: string;
+    legalForm?: LegalFormInput;
+    naf?: NafCodeInput;
+    tvaIntracom?: string;
+    rcs?: string;
+    capitalSocial?: string;
+    vatRegime?: 'normal' | 'franchise' | 'simplified' | 'debit';
+    email?: string;
+    phone?: string;
+    website?: string;
+    bankDetails?: BankDetails;
+}
+/** Company profile and settings — legal information, bank details, and CGV documents. */
+export declare class Companies {
+    private readonly client;
+    constructor(client: HttpClient);
+    list(): Promise<PaginatedResponse<Company>>;
+    /**
+     * Create a new company under the authenticated user. Subject to the
+     * per-plan company quota (free: 1, essential: 1, pro: 3, cabinet_*: 50+);
+     * exceeding the quota returns a `402 plan_limit_error`.
+     */
+    create(params: CompanyCreateParams, options?: RequestOptions): Promise<Company>;
+    get(id: string): Promise<Company>;
+    update(id: string, params: CompanyUpdateParams): Promise<Company>;
+    /**
+     * Mark an onboarding milestone as reached (e.g. `first_invoice_sent`,
+     * `pa_connected`, `bank_added`). Used by the dashboard to compute the
+     * onboarding progress and surface remaining steps.
+     */
+    addMilestone(id: string, milestone: string): Promise<{
+        object: 'company_milestone';
+        milestone: string;
+        reachedAt: string;
+    }>;
+    /** Base64-encoded PDF, max 5 MB. */
+    uploadCgv(companyId: string, content: string, options?: RequestOptions): Promise<CgvResponse>;
+    getCgv(companyId: string): Promise<CgvResponse>;
+    deleteCgv(companyId: string): Promise<CgvResponse>;
+}

package/dist/cjs/resources/companies.js

@@ -0,0 +1,45 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Companies = void 0;
+/** Company profile and settings — legal information, bank details, and CGV documents. */
+class Companies {
+    constructor(client) {
+        this.client = client;
+    }
+    async list() {
+        return this.client.get('/v1/companies');
+    }
+    /**
+     * Create a new company under the authenticated user. Subject to the
+     * per-plan company quota (free: 1, essential: 1, pro: 3, cabinet_*: 50+);
+     * exceeding the quota returns a `402 plan_limit_error`.
+     */
+    async create(params, options) {
+        return this.client.post('/v1/companies', params, options);
+    }
+    async get(id) {
+        return this.client.get(`/v1/companies/${id}`);
+    }
+    async update(id, params) {
+        return this.client.patch(`/v1/companies/${id}`, params);
+    }
+    /**
+     * Mark an onboarding milestone as reached (e.g. `first_invoice_sent`,
+     * `pa_connected`, `bank_added`). Used by the dashboard to compute the
+     * onboarding progress and surface remaining steps.
+     */
+    async addMilestone(id, milestone) {
+        return this.client.post(`/v1/companies/${id}/milestones`, { milestone });
+    }
+    /** Base64-encoded PDF, max 5 MB. */
+    async uploadCgv(companyId, content, options) {
+        return this.client.post(`/v1/companies/${companyId}/cgv`, { content }, options);
+    }
+    async getCgv(companyId) {
+        return this.client.get(`/v1/companies/${companyId}/cgv`);
+    }
+    async deleteCgv(companyId) {
+        return this.client.del(`/v1/companies/${companyId}/cgv`);
+    }
+}
+exports.Companies = Companies;

package/dist/cjs/resources/creditNotes.d.ts

@@ -0,0 +1,64 @@
+import type { HttpClient } from '../client.js';
+import { AutoPaginatingList } from '../pagination.js';
+import type { CreditNote, CreditNoteCreateParams, CreditNoteUpdateParams, CreditNoteListParams, DocumentUrlResponse, JobResponse, PaymentMethod, RequestOptions } from '../types.js';
+/** Credit note operations — the legal way to correct or cancel a finalized invoice. */
+export declare class CreditNotes {
+    private readonly client;
+    constructor(client: HttpClient);
+    create(params: CreditNoteCreateParams, options?: RequestOptions): Promise<CreditNote>;
+    list(params?: CreditNoteListParams): AutoPaginatingList<CreditNote>;
+    get(id: string): Promise<CreditNote>;
+    update(id: string, params: CreditNoteUpdateParams): Promise<CreditNote>;
+    del(id: string): Promise<void>;
+    /** Assign number and lock. Irreversible. */
+    finalize(id: string, options?: RequestOptions): Promise<CreditNote>;
+    /** Submit to PA. */
+    send(id: string, options?: RequestOptions): Promise<{
+        id: string;
+        object: 'credit_note';
+        status: string;
+    }>;
+    /**
+     * Send the credit note to its customer by email with the PDF (and optional
+     * Factur-X XML) attached. Returns `{status: 'sent'}` on success or
+     * `{status: 'pending'}` if the PDF is still being generated.
+     */
+    email(id: string, params?: {
+        recipientEmail?: string;
+        customMessage?: string;
+        includeXml?: boolean;
+        customSubject?: string;
+    }, options?: RequestOptions): Promise<{
+        status: 'sent';
+        creditNoteId: string;
+        recipient: string;
+        sentAt: string;
+    } | {
+        status: 'pending';
+        creditNoteId: string;
+        jobId: string;
+        pollUrl: string;
+        reason: string;
+    }>;
+    /**
+     * Record the disbursement of a finalized credit note back to the customer.
+     * Writes a negative `refund` payment on the linked invoice (mirrors the app).
+     * `amount` is in integer centimes and defaults to the full credit-note total.
+     */
+    refund(id: string, params?: {
+        amount?: number;
+        method?: PaymentMethod;
+        refundedAt?: string;
+    }, options?: RequestOptions): Promise<{
+        id: string;
+        object: 'refund';
+        creditNoteId: string;
+        invoiceId: string;
+        amount: number;
+    }>;
+    getPdf(id: string): Promise<DocumentUrlResponse | JobResponse>;
+    /** Factur-X PDF/A-3 with embedded XML. URL or async job. */
+    getFacturx(id: string): Promise<DocumentUrlResponse | JobResponse>;
+    /** Raw CII or UBL XML. */
+    getXml(id: string, format?: 'cii' | 'ubl'): Promise<string>;
+}