API REST INTERNACIONAL - DOCUMENTACIÓN
- Ignacio
La API Defontana está organizada en torno a REST. Nuestra API tiene URLs predecibles orientadas a los recursos, acepta cuerpos de solicitud codificados por formulario, devuelve respuestas codificadas por JSON y utiliza códigos de respuesta HTTP, autenticación y verbos estándar.
Puede usar la API Defontana en modo de prueba, que no afecta sus datos productivos ni interactúa con las redes bancarias u otro subsistema funcional. La URL API que usa para ingresar peticiones determinará si la solicitud es en modo en vivo o en modo de prueba.
El cliente debe existir en el sistema ERP Defontana.
El acceso a cada módulo debe ser solicitado a través del área de Post-Venta o al adquirir los servicios del ERP si se trata de un nuevo cliente del sistema.
Es recomendable contar con un equipo desarrollador para implementar la integración entre su sistema y el ERP Defontana.
Los ambientes de prueba mantienen una disponibilidad en los siguientes horarios:
Día | Estado | Inicio | Fin |
---|
Día | Estado | Inicio | Fin |
---|---|---|---|
Lunes | DISPONIBLE | 08:00 | 19:00 |
Martes | DISPONIBLE | 08:00 | 19:00 |
Miercoles | DISPONIBLE | 08:00 | 19:00 |
Jueves | DISPONIBLE | 08:00 | 19:00 |
Viernes | DISPONIBLE | 08:00 | 19:00 |
Sabado | no DISPONIBLE | - | - |
Domingo | no DISPONIBLE | - | - |
Así mismo, estos ambientes se actualizan semanalmente para tener la información en línea contra producción, esto quiere decir que los cambios realizados, documentos emitidos, configuraciones, etc. realizadas durante el transcurso de la semana en el ambiente de replicación NO estarán disponibles a la siguiente semana.
Se recomienda que todas las configuraciones sean realizadas en el ambiente productivo, para evitar pérdida de información.
Contactos
Equipo de Ingeniería |
---|
Equipo de Ingeniería | |
---|---|
Nombre y apellido | Contacto |
Ignacio Olivares | |
Luis Lopez | |
Daniel Salinas | |
Sebastián Morgado |
Métodos
A continuación se detallan los métodos disponibles en la API Defontana, pero antes un pequeño recordatorio:
HTTP | CRUD | OBSERVACIÓN |
---|
HTTP | CRUD | OBSERVACIÓN |
---|---|---|
GET | Lectura | disponible |
POST | Creación | disponible |
PUT | Actualización/Reemplazo | disponible |
PATCH | Actualización/Reemplazo Parcial | disponible |
DELETE | Eliminación | disponible |
Modulo de contabilidad
Voucher
Permite obtener el listado de los comprobantes contables
Verbo HTTP: GET
Ambiente | URL |
---|
Ambiente | URL |
---|---|
Pruebas | |
Producción |
Headers
Tipo | Valor | Requerido |
---|
Tipo | Valor | Requerido |
---|---|---|
apikey | Api key del usuario de la integración. | Sí |
Parámetros
Campo | Descripción | Requerido |
---|
Campo | Descripción | Requerido |
---|---|---|
VoucherType | Permite filtrar comprobantes de un único tipo | No |
fiscalYear | Permite filtrar los comprobantes por su año fiscal | No |
fromDate | Permite filtrar comprobantes según la fecha de cada uno (los comprobantes entregados tendrán una fecha mayor o igual a la ingresada) | No |
toDate | Permite filtrar comprobantes según la fecha de cada uno (los comprobantes entregados tendrán una fecha menor o igual a la ingresada) | No |
fromEntryDate | Permite filtrar comprobantes según la fecha de ingreso de cada uno (los comprobantes entregados tendrán una fecha menor o igual a la ingresada) | No |
toEntryDate | Permite filtrar comprobantes según la fecha de ingreso de cada uno (los comprobantes entregados tendrán una fecha mayor o igual a la ingresada) | No |
user | Permite filtrar comprobantes por el usuario que hizo el ingreso del mismo | No |
fromNumber | Permite filtrar comprobantes por su número (los comprobantes entregados tendrán un número mayor o igual al ingresado) | No |
toNumber | Permite filtrar comprobantes por su número (los comprobantes entregados tendrán un número menor o igual al ingresado) | No |
itemsPerPage | Indica cuántos comprobantes se desean obtener por página. Los resultados a obtener siempre vendrán paginados, y se permite como valor máximo 100 comprobantes por página | Sí |
page | Indica la página a consultar, para obtener la primera página se debe ingresar el valor 0 | Sí |
Respuesta
De retorno, en caso de haber ingresado los parámetros de forma correcta, nos retornara una respuesta de la siguiente manera
{
"totalItems": 109759,
"page": 0,
"itemsPerPage": 10,
"items": [
{
"voucherType": "VENTASELEC",
"fiscalYear": 2020,
"date": "2020-05-06T00:00:00",
"entryDate": "2020-05-06T16:45:39",
"entryUserName": "Ali Ruiz",
"number": 35356,
"voucherTypeName": "VENTAS ELECTRONICAS"
},
…
{
"voucherType": "VENTASELEC",
"fiscalYear": 2020,
"date": "2020-05-06T00:00:00",
"entryDate": "2020-05-06T12:10:59",
"entryUserName": "USUARIO ECOMMERCE",
"number": 35350,
"voucherTypeName": "VENTAS ELECTRONICAS"
}
]
}
Permite obtener el listado de los comprobantes contables
Verbo HTTP: GET
Ambiente | URL |
---|
Ambiente | URL |
---|---|
Pruebas | |
Producción |
Headers
Tipo | Valor | Requerido |
---|
Tipo | Valor | Requerido |
---|---|---|
apikey | Api key del usuario de la integración. | Sí |
Parámetros
Campo | Descripción | Requerido |
---|
Campo | Descripción | Requerido |
---|---|---|
VoucherType | Permite filtrar comprobantes de un único tipo | No |
fiscalYear | Permite filtrar los comprobantes por su año fiscal | No |
fromDate | Permite filtrar comprobantes según la fecha de cada uno (los comprobantes entregados tendrán una fecha mayor o igual a la ingresada) | No |
toDate | Permite filtrar comprobantes según la fecha de cada uno (los comprobantes entregados tendrán una fecha menor o igual a la ingresada) | No |
fromEntryDate | Permite filtrar comprobantes según la fecha de ingreso de cada uno (los comprobantes entregados tendrán una fecha menor o igual a la ingresada) | No |
toEntryDate | Permite filtrar comprobantes según la fecha de ingreso de cada uno (los comprobantes entregados tendrán una fecha mayor o igual a la ingresada) | No |
user | Permite filtrar comprobantes por el usuario que hizo el ingreso del mismo | No |
fromNumber | Permite filtrar comprobantes por su número (los comprobantes entregados tendrán un número mayor o igual al ingresado) | No |
toNumber | Permite filtrar comprobantes por su número (los comprobantes entregados tendrán un número menor o igual al ingresado) | No |
itemsPerPage | Indica cuántos comprobantes se desean obtener por página. Los resultados a obtener siempre vendrán paginados, y se permite como valor máximo 100 comprobantes por página | Sí |
page | Indica la página a consultar, para obtener la primera página se debe ingresar el valor 0 | Sí |
Respuesta
De retorno, en caso de haber ingresado los parámetros de forma correcta, nos retornara una respuesta de la siguiente manera
{
"totalItems": 109759,
"page": 0,
"itemsPerPage": 10,
"items": [
{
"voucherType": "VENTASELEC",
"fiscalYear": 2020,
"date": "2020-05-06T00:00:00",
"entryDate": "2020-05-06T16:45:39",
"entryUserName": "Ali Ruiz",
"number": 35356,
"voucherTypeName": "VENTAS ELECTRONICAS"
},
…
{
"voucherType": "VENTASELEC",
"fiscalYear": 2020,
"date": "2020-05-06T00:00:00",
"entryDate": "2020-05-06T12:10:59",
"entryUserName": "USUARIO ECOMMERCE",
"number": 35350,
"voucherTypeName": "VENTAS ELECTRONICAS"
}
]
}
Permite obtener el listado de los comprobantes contables
Verbo HTTP: GET
Ambiente | URL |
---|
Ambiente | URL |
---|---|
Pruebas | |
Producción |
Headers
Tipo | Valor | Requerido |
---|
Tipo | Valor | Requerido |
---|---|---|
apikey | Api key del usuario de la integración. | Sí |
Parámetros
Campo | Descripción | Requerido |
---|
Campo | Descripción | Requerido |
---|---|---|
VoucherType | Permite filtrar comprobantes de un único tipo | No |
fiscalYear | Permite filtrar los comprobantes por su año fiscal | No |
fromDate | Permite filtrar comprobantes según la fecha de cada uno (los comprobantes entregados tendrán una fecha mayor o igual a la ingresada) | No |
toDate | Permite filtrar comprobantes según la fecha de cada uno (los comprobantes entregados tendrán una fecha menor o igual a la ingresada) | No |
fromEntryDate | Permite filtrar comprobantes según la fecha de ingreso de cada uno (los comprobantes entregados tendrán una fecha menor o igual a la ingresada) | No |
toEntryDate | Permite filtrar comprobantes según la fecha de ingreso de cada uno (los comprobantes entregados tendrán una fecha mayor o igual a la ingresada) | No |
user | Permite filtrar comprobantes por el usuario que hizo el ingreso del mismo | No |
fromNumber | Permite filtrar comprobantes por su número (los comprobantes entregados tendrán un número mayor o igual al ingresado) | No |
toNumber | Permite filtrar comprobantes por su número (los comprobantes entregados tendrán un número menor o igual al ingresado) | No |
itemsPerPage | Indica cuántos comprobantes se desean obtener por página. Los resultados a obtener siempre vendrán paginados, y se permite como valor máximo 100 comprobantes por página | Sí |
page | Indica la página a consultar, para obtener la primera página se debe ingresar el valor 0 | Sí |
Respuesta
De retorno, en caso de haber ingresado los parámetros de forma correcta, nos retornara una respuesta de la siguiente manera
{
"totalItems": 109759,
"page": 0,
"itemsPerPage": 10,
"items": [
{
"voucherType": "VENTASELEC",
"fiscalYear": 2020,
"date": "2020-05-06T00:00:00",
"entryDate": "2020-05-06T16:45:39",
"entryUserName": "Ali Ruiz",
"number": 35356,
"voucherTypeName": "VENTAS ELECTRONICAS"
},
…
{
"voucherType": "VENTASELEC",
"fiscalYear": 2020,
"date": "2020-05-06T00:00:00",
"entryDate": "2020-05-06T12:10:59",
"entryUserName": "USUARIO ECOMMERCE",
"number": 35350,
"voucherTypeName": "VENTAS ELECTRONICAS"
}
]
}
Account
Business Center