factuplan 0.5.0 → 0.7.0

package/dist/index.d.mts

@@ -103,6 +103,13 @@ interface InvoiceItem {
     /** Tax rate override for IVA_RATE. Valid: 0, 5, 8, 12, 14, 15. Default: 15 */
     tax?: number;
 }
+type PaymentTimeUnit = 'dias' | 'meses' | 'anios';
+interface InvoicePayment {
+    method: string;
+    amount: number;
+    term?: number;
+    timeUnit?: PaymentTimeUnit;
+}
 interface CreateInvoiceInput {
     /** UUID of the emission point. Optional if using establishment + emissionPoint codes, or if the taxpayer has a single active emission point. */
     emissionPointId?: string;
@@ -112,7 +119,8 @@ interface CreateInvoiceInput {
     emissionPoint?: string;
     customer: InvoiceCustomer;
     items: InvoiceItem[];
-    paymentMethod?: string;
+    /** List of payment methods for multi-payment support. */
+    payments?: InvoicePayment[];
     additionalInfo?: Record<string, string>;
 }
 interface ImportByAccessKeyInput {
@@ -134,8 +142,13 @@ interface InvoiceStatus {
     authorizationDate?: string;
 }
 interface DownloadUrlResponse {
+    /** URL pre-firmada de S3 — expira en 5 minutos */
     url: string;
-    s3Key?: string;
+    /**
+     * URL permanente de visualización del comprobante en Factuplan.
+     * No expira. Formato: https://app.factuplan.com.ec/verify?clave={accessKey}
+     */
+    previewUrl?: string;
 }
 interface SignAndAuthorizeInput {
     /** Unsigned XML string */
@@ -205,11 +218,35 @@ interface WebhookReceiptData {
     customerIdentification: string;
 }
 interface FactuplanOptions {
-    /** Base URL of the API (default: https://api.factuplan.com/api/v1) */
+    /** Base URL of the API (default: https://api-rest.factuplan.com.ec/v1) */
     baseUrl?: string;
     /** Request timeout in milliseconds (default: 30000) */
     timeout?: number;
 }
+interface QueryExternalByAccessKeyInput {
+    /** Clave de acceso de 49 dígitos del comprobante en el SRI */
+    accessKey: string;
+    /**
+     * Si es true (por defecto), guarda el contribuyente, documento, XML y PDF.
+     * Si es false, solo verifica el comprobante y descuenta el contador sin guardar registros.
+     * @default true
+     */
+    save?: boolean;
+}
+interface QueryExternalByAccessKeyResponse {
+    /** ID del comprobante guardado en Factuplan; null cuando save=false */
+    id: string | null;
+    /** Clave de acceso de 49 dígitos */
+    accessKey: string;
+    /** Número secuencial del comprobante (ej: '000000001') */
+    sequential: string;
+    /** Estado del comprobante ('AUTHORIZED') */
+    status: string;
+    /** Total del comprobante */
+    total: number;
+    /** XML completo autorizado del SRI (envelope <autorizacion>) en base64 */
+    xmlBase64: string;
+}
 
 type Requester$3 = (method: string, path: string, body?: unknown, params?: Record<string, string | number | undefined>) => Promise<unknown>;
 declare class CustomersResource {
@@ -236,6 +273,7 @@ declare class InvoicesResource {
     downloadXml(id: string): Promise<DownloadUrlResponse>;
     downloadPdf(id: string): Promise<DownloadUrlResponse>;
     importByAccessKey(input: ImportByAccessKeyInput): Promise<Invoice>;
+    queryExternalByAccessKey(input: QueryExternalByAccessKeyInput): Promise<QueryExternalByAccessKeyResponse>;
 }
 
 type Requester$1 = (method: string, path: string, body?: unknown, params?: Record<string, string | number | undefined>) => Promise<unknown>;

package/dist/index.d.ts

@@ -103,6 +103,13 @@ interface InvoiceItem {
     /** Tax rate override for IVA_RATE. Valid: 0, 5, 8, 12, 14, 15. Default: 15 */
     tax?: number;
 }
+type PaymentTimeUnit = 'dias' | 'meses' | 'anios';
+interface InvoicePayment {
+    method: string;
+    amount: number;
+    term?: number;
+    timeUnit?: PaymentTimeUnit;
+}
 interface CreateInvoiceInput {
     /** UUID of the emission point. Optional if using establishment + emissionPoint codes, or if the taxpayer has a single active emission point. */
     emissionPointId?: string;
@@ -112,7 +119,8 @@ interface CreateInvoiceInput {
     emissionPoint?: string;
     customer: InvoiceCustomer;
     items: InvoiceItem[];
-    paymentMethod?: string;
+    /** List of payment methods for multi-payment support. */
+    payments?: InvoicePayment[];
     additionalInfo?: Record<string, string>;
 }
 interface ImportByAccessKeyInput {
@@ -134,8 +142,13 @@ interface InvoiceStatus {
     authorizationDate?: string;
 }
 interface DownloadUrlResponse {
+    /** URL pre-firmada de S3 — expira en 5 minutos */
     url: string;
-    s3Key?: string;
+    /**
+     * URL permanente de visualización del comprobante en Factuplan.
+     * No expira. Formato: https://app.factuplan.com.ec/verify?clave={accessKey}
+     */
+    previewUrl?: string;
 }
 interface SignAndAuthorizeInput {
     /** Unsigned XML string */
@@ -205,11 +218,35 @@ interface WebhookReceiptData {
     customerIdentification: string;
 }
 interface FactuplanOptions {
-    /** Base URL of the API (default: https://api.factuplan.com/api/v1) */
+    /** Base URL of the API (default: https://api-rest.factuplan.com.ec/v1) */
     baseUrl?: string;
     /** Request timeout in milliseconds (default: 30000) */
     timeout?: number;
 }
+interface QueryExternalByAccessKeyInput {
+    /** Clave de acceso de 49 dígitos del comprobante en el SRI */
+    accessKey: string;
+    /**
+     * Si es true (por defecto), guarda el contribuyente, documento, XML y PDF.
+     * Si es false, solo verifica el comprobante y descuenta el contador sin guardar registros.
+     * @default true
+     */
+    save?: boolean;
+}
+interface QueryExternalByAccessKeyResponse {
+    /** ID del comprobante guardado en Factuplan; null cuando save=false */
+    id: string | null;
+    /** Clave de acceso de 49 dígitos */
+    accessKey: string;
+    /** Número secuencial del comprobante (ej: '000000001') */
+    sequential: string;
+    /** Estado del comprobante ('AUTHORIZED') */
+    status: string;
+    /** Total del comprobante */
+    total: number;
+    /** XML completo autorizado del SRI (envelope <autorizacion>) en base64 */
+    xmlBase64: string;
+}
 
 type Requester$3 = (method: string, path: string, body?: unknown, params?: Record<string, string | number | undefined>) => Promise<unknown>;
 declare class CustomersResource {
@@ -236,6 +273,7 @@ declare class InvoicesResource {
     downloadXml(id: string): Promise<DownloadUrlResponse>;
     downloadPdf(id: string): Promise<DownloadUrlResponse>;
     importByAccessKey(input: ImportByAccessKeyInput): Promise<Invoice>;
+    queryExternalByAccessKey(input: QueryExternalByAccessKeyInput): Promise<QueryExternalByAccessKeyResponse>;
 }
 
 type Requester$1 = (method: string, path: string, body?: unknown, params?: Record<string, string | number | undefined>) => Promise<unknown>;

package/dist/index.js

@@ -107,6 +107,13 @@ var InvoicesResource = class {
   async importByAccessKey(input) {
     return this.request("POST", "/developer/invoices/import", input);
   }
+  async queryExternalByAccessKey(input) {
+    return this.request(
+      "POST",
+      "/developer/receipts/query",
+      input
+    );
+  }
 };
 
 // src/resources/products.ts
@@ -154,7 +161,7 @@ var WebhooksResource = class {
 };
 
 // src/client.ts
-var DEFAULT_BASE_URL = "https://api-rest.factuplan.com.ec/api/v1";
+var DEFAULT_BASE_URL = "https://api-rest.factuplan.com.ec/v1";
 var DEFAULT_TIMEOUT = 3e4;
 var Factuplan = class {
   constructor(apiKey, options) {

package/dist/index.mjs

@@ -78,6 +78,13 @@ var InvoicesResource = class {
   async importByAccessKey(input) {
     return this.request("POST", "/developer/invoices/import", input);
   }
+  async queryExternalByAccessKey(input) {
+    return this.request(
+      "POST",
+      "/developer/receipts/query",
+      input
+    );
+  }
 };
 
 // src/resources/products.ts
@@ -125,7 +132,7 @@ var WebhooksResource = class {
 };
 
 // src/client.ts
-var DEFAULT_BASE_URL = "https://api-rest.factuplan.com.ec/api/v1";
+var DEFAULT_BASE_URL = "https://api-rest.factuplan.com.ec/v1";
 var DEFAULT_TIMEOUT = 3e4;
 var Factuplan = class {
   constructor(apiKey, options) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "factuplan",
-  "version": "0.5.0",
+  "version": "0.7.0",
   "description": "Official Factuplan SDK for JavaScript & TypeScript — Create electronic invoices for Ecuador (SRI)",
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",