Catalogs
CATALOGOS Y TARIFARIOS: Catalogo de las tablas de informacion para la generacion de documentos electronicos.
| Método API | Descripción |
|---|---|
| GET catalogs/contributor-types |
TABLA: TIPOS DE CONTRIBUYENTES |
| GET catalogs/document-types |
TABLA: TIPOS DE DOCUMENTOS |
| GET catalogs/ice-rates |
TARIFARIO: IMPUESTO A LOS CONSUMOS ESPECIALES (ICE) VIGENTE |
| GET catalogs/id-types |
TABLA: TIPOS DE IDENTIFICACION |
| GET catalogs/payment-methods |
TABLA: METODOS DE PAGO |
| GET catalogs/product-types |
TABLA: TIPOS DE PRODUCTO O SERVICIO |
| GET catalogs/tax-types |
TABLA: TIPOS DE IMPUESTOS |
| GET catalogs/vat-rates |
TARIFARIO: IMPUESTO AL VALOR AGREGADO (IVA) VIGENTE |
Contributors
CONTRIBUYENTES
| Método API | Descripción |
|---|---|
| GET Contributors |
Obtiene una lista completa de todos los contribuyentes |
| GET Contributors/{id} |
Obtiene los datos de un contribuyente por ID. |
| GET Contributors;q={searchTerms} |
Realiza la busqueda de uno o varios contribuyentes por una serie de datos especificos |
| GET Contributors?search={search}&contributorType={contributorType}&pageNumber={pageNumber}&pageSize={pageSize} |
Busca clientes que cumplan con los datos enviados |
| GET Customers |
Devuelve una lista de los clientes |
| GET Customers;q={filter} |
Busca clientes que cumplan con los datos enviados |
| GET Drivers |
Devuelve una lista de los transportistas |
| GET Drivers;q={filter} |
Busca Transportistas que cumplan con los datos enviados |
| GET Suppliers |
Devuelve una lista de los proveedores |
| GET Suppliers;q={filter} |
Busca Proveedores que cumplan con los datos enviados |
| POST Contributors |
Agrega un nuevo contribuyente para el emisor actual |
| PUT Contributors/{id} |
Actualizar el contribuyente especificado. |
CreditNote
NOTA DE CREDITO: Servicio API para la administracion de Notas de Crédito.
| Método API | Descripción |
|---|---|
| GET CreditNote/{id} |
Obtener notas de credito por Id |
| GET CreditNote?documentNumber={documentNumber} |
Obtiene una nota de credito |
| GET CreditNote?search={search}&startDate={startDate}&endDate={endDate}&status={status}&page={page}&pageSize={pageSize} |
Realiza la busqueda de las notas de credito usando una serie de filtros |
| GET CreditNote?status={status} |
Devuelve las facturas por una serie de filtros |
| POST CreditNote |
Crea una nueva nota de credito |
Documents
DOCUMENTOS: Proceso para generar documentos electronicos genericos
| Método API | Descripción |
|---|---|
| GET Documents?search={search}&startDate={startDate}&endDate={endDate}&documentType={documentType}&status={status}&page={page}&pageSize={pageSize} |
Realiza la busqueda de documentos basado en los datos especificados |
| POST Documents |
Enviar un nuevo documento |
| POST IssueDocument?id={id}&reason={reason} |
Enviar Documento al SRI (Emision de Documentos) |
Invoice
FACTURAS: Servicio API para la administracion de Facturas Electronicas.
| Método API | Descripción |
|---|---|
| GET Invoice/{id} |
Obtener facturas por Id |
| GET Invoice?contributorId={contributorId}&search={search} |
Devuelve las facturas por una serie de filtros |
| GET Invoice?documentNumber={documentNumber} |
Get a invoice of an Issuer by id |
| GET Invoice?search={search}&startDate={startDate}&endDate={endDate}&status={status}&page={page}&pageSize={pageSize} |
Realiza la busqueda de las facturas usando una serie de filtros |
| GET Invoice?status={status} |
Devuelve las facturas por una serie de filtros |
| POST Invoice |
Add a new Invoice |
Issuers
| Método API | Descripción |
|---|---|
| GET Issuers |
Informacion del Emisor Actual |
| GET Issuers/{id} |
Obtener informacion de un emisor por ID Unico |
| GET Issuers?ruc={ruc} |
Obtener informacion de un emisor por el Numero de RUC |
Products
| Método API | Descripción |
|---|---|
| GET Products |
Get Issuer Products |
| GET Products/{id} |
Get a product of Issuer by Id |
| GET Products;q={searchTerm} |
Get Issuer products by search term that maybe by MainCode or ProductName |
| POST Products |
Add a new product for the Issuer |
| PUT Products/{id} |
Update a product of Issuer |
Reports
Reportes de informacion consolidada del Sistema
| Método API | Descripción |
|---|---|
| GET PurchasesReport?search={search}&startDate={startDate}&endDate={endDate} |
Reporte de ventas |
| GET SalesReport?search={search}&startDate={startDate}&endDate={endDate} |
Reporte de ventas |
ReferralGuide
GUIAS DE REMISION: Servicio API para la administracion de Guias de Remision.
| Método API | Descripción |
|---|---|
| GET ReferralGuide/{id} |
Obtener retencions por Id |
| GET ReferralGuide?documentNumber={documentNumber} |
Devuelve una guia de remision por numero de documento. (Formato: XXX-XXX-XXXXXXXXX) |
| GET ReferralGuide?search={search}&startDate={startDate}&endDate={endDate}&status={status}&page={page}&pageSize={pageSize} |
Realiza la busqueda de las guias de remision usando una serie de filtros |
| GET ReferralGuide?status={status} |
Devuelve las retencions por una serie de filtros |
| POST ReferralGuide |
Add a new ReferralGuide |
Retention
COMPROBANTES DE RENTENCION: Servicio API para la administracion de Retenciones.
| Método API | Descripción |
|---|---|
| GET Retention/{id} |
Obtener retencions por Id |
| GET Retention?documentNumber={documentNumber} |
Get a Retention of an Issuer by id |
| GET Retention?search={search}&startDate={startDate}&endDate={endDate}&status={status}&page={page}&pageSize={pageSize} |
Realiza la busqueda de las retenciones usando una serie de filtros |
| GET Retention?status={status} |
Devuelve las retencions por una serie de filtros |
| POST Retention |
Add a new Retention |
Taxes
IMPUESTOS
| Método API | Descripción |
|---|---|
| GET Taxes |
Devuelve todos los impuestos existentes |
| GET Taxes/{id} |
Get a tax of Issuer by Id |
| GET Taxes/{id}?q={q} |
Get Issuer taxes by search term that maybe by MainCode or TaxName |
| GET Taxes;q={searchTerm} |
Get Issuer taxes by search term that maybe by MainCode or TaxName |
| POST Taxes |
Add a new tax for the Issuer |
| PUT Taxes/{id} |
Update a tax of Issuer |
Session
| Método API | Descripción |
|---|---|
| POST Authenticate |
Proceso de autenticacion para utilizar los servicios, se requiere un token pre-establecido anteriormente. Se requiere el parametro -Authentication- para verificar la seguridad con el token encriptado de autenticacion. |
| POST RequestSession?id={id} |
Obtiene la sesion requerida para el emisor del usuario autorizado. Se requiere el parametro -Authentication- para verificar la seguridad con el token provisto por el servicio de autenticacion. |
| POST ValidateToken |
Validacion del token generado por el cliente autenticado. Se requiere el parametro -Authentication- para verificar la seguridad con el token de seguridad. |
InvoiceCustom
Envio de Documentos personalizados [OBSOLETO]
| Método API | Descripción |
|---|---|
| POST InvoiceCustom |
Envio de Documentos personalizados [OBSOLETO] |