facturapi
Version:
Librería oficial de Facturapi. Crea CFDIs timbrados y enviados al SAT, XML y PDF
57 lines (56 loc) • 2.1 kB
TypeScript
import Customers from './resources/customers';
import Products from './resources/products';
import Invoices from './resources/invoices';
import Organizations from './resources/organizations';
import Catalogs from './tools/catalogs';
import Receipts from './resources/receipts';
import Retentions from './resources/retentions';
import Webhooks from './tools/webhooks';
import Tools from './tools/tools';
import * as enums from './enums';
import CartaPorteCatalogs from './tools/cartaPorteCatalogs';
export * from './enums';
export * from './types';
export type ApiVersion = 'v1' | 'v2';
export interface FacturapiOptions {
apiVersion?: ApiVersion;
}
/**
* Get an instance of the Facturapi library
* @class
* @param {string} apiKey Test or Live key.
* @returns {Facturapi} Instance of this library
*/
export default class Facturapi {
apiVersion: ApiVersion;
private _wrapper;
customers: Customers;
products: Products;
invoices: Invoices;
organizations: Organizations;
catalogs: Catalogs;
cartaPorteCatalogs: CartaPorteCatalogs;
receipts: Receipts;
retentions: Retentions;
tools: Tools;
webhooks: Webhooks;
/**
* Get or set the base URL used for API requests.
* Allows overriding the default API host, e.g. for testing.
* Usage: facturapi.BASE_URL = 'http://localhost:3000/v2'
*/
get BASE_URL(): string;
set BASE_URL(url: string);
static get TaxType(): typeof enums.TaxType;
static get TaxFactor(): typeof enums.TaxFactor;
static get IepsMode(): typeof enums.IepsMode;
static get PaymentForm(): typeof enums.PaymentForm;
static get PaymentMethod(): typeof enums.PaymentMethod;
static get InvoiceType(): typeof enums.InvoiceType;
static get InvoiceUse(): typeof enums.InvoiceUse;
static get InvoiceRelation(): typeof enums.InvoiceRelation;
static get TaxSystem(): typeof enums.TaxSystem;
static get InvoiceStatus(): typeof enums.InvoiceStatus;
static get CancellationMotive(): typeof enums.CancellationMotive;
constructor(apiKey: string, options?: FacturapiOptions);
}