Page Comparison

...

Expand

title	Glosario y Acronimos

API: Es un conjunto de funciones y procedimientos que cumplen una o muchas funciones con el fin de ser utilizadas por otro software. Las siglas API provienen del inglés Application Programming Interface. En español sería interfaz de programación de aplicaciones. Básicamente, una API ofrece un conjunto de métodos para: consultar, agregar, modificar y eliminar información de un sistema. Estos métodos permiten que otros programas se conecten al sistema y ejecuten sus operaciones según los requerimientos de cada integración particular.

Token de autenticación: En el caso de la API, los tokens de acceso corresponden al estándar de Internet Json Web Token (JWT). Cada token corresponde a una cadena de texto que contiene información encriptada, asociada a una identidad de usuario del sistema. El token de autenticación es obligatorio para poder utilizar cada método del sistema, con excepción de aquellos que permiten su obtención a través de la ruta /Auth.

URL de documentación técnica Swagger: Consiste en una definición y herramienta de testeo de los métodos ofrecidos por la API de Integración, aplicando el estándar swagger. Se encuentra disponible en la siguiente dirección:

https://api-v2.defontana.com/swagger/index.html

Si usted se encuentra en etapa de pruebas o implementación de su integración, se recomienda utilizar la documentación del sitio de pruebas. Esta documentación es igual a la del sitio real, pero apunta a las bases de datos del sitio de replicación del sistema, lo cual permite hacer pruebas evitando cambiar la información de su empresa en el sitio real del ERP:

https://replapi-v2.defontana.com/swagger/index.html

Expand

title	Acerca de los Ambientes de Pruebas

Los ambientes de prueba mantienen una disponibilidad en los siguientes horarios:

Día

Estado

Inicio

Fin

Lunes

Status

colour	Green
title	Disponible

08:00

20:00

Martes

Status

colour	Green
title	Disponible

08:00

20:00

Miércoles

Status

colour	Green
title	Disponible

08:00

20:00

Jueves

Status

colour	Green
title	Disponible

08:00

20:00

Viernes

Status

colour	Green
title	Disponible

08:00

20:00

Sábado

Status

colour	Red
title	No disponible

-

Domingo

Status

colour	Red
title	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.

Expand

title	Resumen de Metodos

Las operaciones ofrecidas por el sistema están separadas en módulos. Cada módulo de la API agrupa métodos para poder realizar operaciones dentro de un módulo de ERP. Los módulos que actualmente se encuentran desarrollados son los siguientes:

AUTH
VOUCHER
ACCOUNT
CLIENT
PRODUCT
SERVICE
INVENTORY
SALE

Auth: agrupa métodos para obtener tokens de acceso. Para poder utilizar los métodos de los demás módulos es obligatorio obtener previamente un token mediante el cual el usuario valida que posee una sesión vigente en el sistema. Cada token obtenido invalida inmediatamente a todos los que hayan sido obtenidos previamente para el mismo usuario. Debido a esto, si se establece un proceso de ejecuciones paralelas en la API (por ejemplo, ingresar varias ventas al mismo tiempo), se debe establecer desde el lado del cliente un mecanismo de centralización de tokens para evitar invalidaciones.

Voucher: agrupa métodos para administrar la contabilidad de las empresas en el ERP.

Account: agrupa métodos para administrar la contabilidad de las empresas en el ERP.

Client: agrupa métodos para administrar los clientes de las empresas en el ERP.

Product: agrupa métodos para administrar los artículos de las empresas en el ERP.

Service: agrupa métodos para administrar los servicios de las empresas en el ERP.

Inventory: agrupa métodos para administrar los movimientos de Inventario de las empresas en el ERP.

Sale: agrupa métodos para administrar los movimientos de ventas de las empresas en el ERP.

Para poder apreciar un listado de los métodos ofrecidos por la API, se recomienda acceder a la documentación swagger de la misma, a través del siguiente enlace:

https://replapi-v2.defontana.com/swagger

En la interfaz disponible en el enlace podemos ver todos los métodos disponibles, junto a sus datos de entrada y de retorno. También podemos simular las llamadas de cada método para realizar pruebas y aprender cómo funciona cada uno.

Contactos

Equipo Comercial
Nombre y Apellido	Opciones	Detalles
Salomón Carmi	Email	scarmi@defontana.com

Equipo Ingeniería

Nombre y Apellido

Opciones

Detalles

Luis Lopez

Skype

Email

live:.cid.caa2fee512fc856c
luislopezv@defontana.com

Ignacio Olivares

Skype

Email

live:iolivares_19
iolivares@defontana.com

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

GET

Lectura

Status

colour	Green
title	disponible

POST

Creación

Status

colour	Green
title	disponible

PUT

Actualización/Reemplazo

Status

colour	Red
title	no disponible

PATCH

Actualización/Reemplazo Parcial

Status

colour	Red
title	no disponible

DELETE

Eliminación

Status

colour

Red

title
Green

no

disponible

AUTH

Expand

title	Login

Obtiene un nuevo token de acceso (crea una nueva sesión de usuario)

Ambientes
Ámbito	URL
Pruebas	https://replapi-v2.defontana.com/api/Auth/Login
Productivo	https://api-v2.defontana.com/api/Auth/Login

Tip
Verbo HTTP: GET

Parámetros
Campo	Descripción	Requerido
Client	Identificador del cliente	Si
Company	Identificador de la empresa	Si
User	Identificador del usuario	Si
Password	Contraseña del usuario	Si

De retorno, en caso de haber ingresado los datos de acceso en forma correcta, nos aparecerá un mensaje similar al siguiente. El token de acceso vendrá en el campo “access_token”

Respuesta

Code Block

language	json

{
  "access_token": "eyJ0eXAiOiJLCJh1NiJ9.ey...iZiDAwMzAX0.TR39EE6gtrk",
  "expires_in": 378604799,
  "token_type": "bearer",
  "success": true,
  "message": null
}

De retorno en caso de haber ingresado los datos de acceso en forma incorrecta, nos aparecerá un mensaje similar al siguiente. El mensaje de error vendrá en el campo “message“ como “Login failed“

Respuesta

Code Block

language	json

{
  "access_token": null,
  "expires_in": 0,
  "token_type": null,
  "success": false,
  "message": "Login failed"
}

...

Expand

title	Update

Permite modificar un comprobante contable

AMBIENTES
Ámbito	URL
Pruebas	https://certapireplapi-v2.defontana.com/api/Voucher/Update
Productivo	https://api-v2.defontana.com/api/Voucher/Update

Tip
Verbo HTTP: POST

HEADERS
Tipo	Valor	Requerido
Content-Type	“application / JSON“	Si
Autorización	Token de autorización del usuario de integración, y se debe ingresar con el siguiente formato “Bearer TOKEN“	Si

PARAMETROS
Campo	Descripción	Requerido
(header) fiscalYear	Año fiscal del comprobante	Si
(header) number	Número a asignar al comprobante. Si el campo automaticFoliation se envía como true, será reemplazado automáticamente por el siguiente número a utilizar para el tipo de comprobante ingresado	Si
(header) voucherType	Código del tipo de comprobante a utilizar	Si
(header) date	Fecha de emisión del comprobante	Si
(header) comment	Comentario / glosa del documento	Si
(detail) accountCode	El numero de cuenta contable	Si
(detail) debit	Valor debe en la linea de detalle	Si
(detail) credit	Valor haber en la linea de detalle	Si
(detail) secondaryDebit	Valor debe secundario en caso de ocupar una moneda secundaria	No
(detail) secondaryCredit	Valor haber secundario en caso de ocupar una moneda secundaria	No
(detail) exchangeRate	Tasa de cambio entre los valores principales y de moneda secundaria	No
(detail) comment	Comentario / glosa de la linea de detalle	Si
(detail) fileId	Codigo del cliente “id de ficha” (análisis de ficha)	Depende de análisis
(detail) documentType	El tipo de documento en caso de hacer referencia a una factura o boleta (análisis de documento)	Depende de análisis
(detail) documentSeries	La serie del documento a referenciar (análisis de documento)	Depende de análisis
(detail) documentNumber	El numero de documento a referenciar (análisis de documento)	Depende de análisis
(detail) documentExpirationDate	La fecha de vencimiento del documento a referenciar (análisis de documento)	Depende de análisis
(detail) bussinessCenterId	El centro de negocio (si la cuenta contable esta configurada para usar centros de negocios/costos)	Depende de análisis
(detail) classifier1Id	El tipo de clasificador 1 (Si la cuenta contable esta configurada para usar clasificadores)	Depende de análisis
(detail) classifier2Id	El tipo de clasificador 2 (Si la cuenta contable esta configurada para usar clasificadores)	Depende de análisis
(detail) referenceCurrencyId	El código de moneda de referencia (si corresponde)	No
(detail) referenceExchangeRate	El cambio de moneda de referencia (si corresponde)	No
(detail) movementTypeId	El tipo de movimiento (análisis de banco)	Depende de análisis
(detail) movementSeries	El numero de Serie del movimiento (análisis de banco)	Depende de análisis
(detail) movementNumber	El numero del movimiento (análisis de banco)	Depende de análisis
(detail) accountAmountRate	El monto de movimiento (análisis de banco)	Depende de análisis
(detail) ctaCreditOrDebitAmount	Monto asignado a valor debe o haber de cuenta de banco asociada a cuenta, si corresponde	No
automaticFoliation	Número a asignar al comprobante. Si el campo automaticFoliation se envía como true, será reemplazado automáticamente por el siguiente número a utilizar para el tipo de comprobante ingresado	Si

De retorno, en caso de haber ingresado los datos de forma correcta, nos aparecerá un mensaje similar al siguiente.

Respuesta

Code Block

language	json

{
  "success": true,
  "message": "string",
  "exceptionMessage": "string",
  "voucherType": "string",
  "number": 0,
  "fiscalYear": 0
}

De retorno en caso de haber ingresado los datos de forma incorrecta, nos aparecerá un mensaje similar al siguiente.

Respuesta

Code Block

language	json

Expand

title	List

Permite obtener el listado de comprobantes contables

AMBIENTES
Ámbito	URL
Pruebas	https://certapireplapi-v2.defontana.com/api/Voucher/List
Productivo	https://api-v2.defontana.com/api/Voucher/List

Tip
Verbo HTTP: GET

HEADERS
Tipo	Valor	Requerido
Content-Type	“application / JSON“	Si
Autorización	Token de autorización del usuario de integración, y se debe ingresar con el siguiente formato “Bearer TOKEN“	Si

PARAMETROS
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	Si
Page	Indica la página a consultar, para obtener la primera página se debe ingresar el valor 0	Si

De retorno, en caso de haber ingresado los datos de forma correcta, nos aparecerá un mensaje similar al siguiente.

Respuesta

Code Block

language	json

{
  "totalItems": 0,
  "page": 0,
  "itemsPerPage": 0,
  "success": true,
  "message": "string",
  "exceptionMessage": "string",
  "items": [
    {
      "voucherType": "string",
      "fiscalYear": 0,
      "date": "2023-02-05T21:45:01.777Z",
      "entryDate": "2023-02-05T21:45:01.777Z",
      "entryUserName": "string",
      "number": 0,
      "voucherTypeName": "string"
    }
  ]
}

De retorno en caso de haber ingresado los datos de forma incorrecta, nos aparecerá un mensaje similar al siguiente.

Respuesta

Code Block

language	json

...

Expand

title	Plan

Permite obtener el plan de cuentas de una empresa configurado en el ERP

AMBIENTES
Ámbito	URL
Pruebas	https://certapireplapi-v2.defontana.com/api/Account/Plan
Productivo	https://api-v2.defontana.com/api/Account/Plan

Tip
Verbo HTTP: GET

HEADERS
Tipo	Valor	Requerido
Content-Type	“application / JSON“	Si
Autorización	Token de autorización del usuario de integración, y se debe ingresar con el siguiente formato “Bearer TOKEN“	Si

PARAMETROS
Campo	Descripción	Requerido

De retorno, en caso de haber ingresado los datos de forma correcta, nos aparecerá un mensaje similar al siguiente.

Respuesta

Code Block

language	json

{
  "success": true,
  "message": "string",
  "exceptionMessage": "string",
  "items": [
    {
      "code": "string",
      "description": "string",
      "ifrsRelatedAccountCode": "string",
      "ifrsRelatedAccountDescription": "string",
      "childs": [
        null
      ]
    }
  ]
}

De retorno en caso de haber ingresado los datos de forma incorrecta, nos aparecerá un mensaje similar al siguiente.

Respuesta

Code Block

language	json

Expand

title	Get

Permite obtener los detalles de una cuenta contable en especifico

AMBIENTES
Ámbito	URL
Pruebas	https://certapireplapi-v2.defontana.com/api/Account/Get
Productivo	https://api-v2.defontana.com/api/Account/Get

Tip
Verbo HTTP: GET

HEADERS
Tipo	Valor	Requerido
Content-Type	“application / JSON“	Si
Autorización	Token de autorización del usuario de integración, y se debe ingresar con el siguiente formato “Bearer TOKEN“	Si

PARAMETROS
Campo	Descripción	Requerido
Account	Código de cuenta contable de la que se desea consultar	Si

De retorno, en caso de haber ingresado los datos de forma correcta, nos aparecerá un mensaje similar al siguiente.

Respuesta

Code Block

language	json

{
  "success": true,
  "message": "string",
  "exceptionMessage": "string",
  "item": {
    "code": "string",
    "description": "string",
    "active": "string",
    "imputable": "string"
  }
}

De retorno en caso de haber ingresado los datos de forma incorrecta, nos aparecerá un mensaje similar al siguiente.

Respuesta

Code Block

language	json

Expand

title	AnalysisBusinessCenterGet

Permite obtener las opciones de centros de negocio configurado para una cuenta contable

AMBIENTES
Ámbito	URL
Pruebas	https://certapireplapi-v2.defontana.com/api/Account/Analysis/BusinessCenter/Get
Productivo	https://api-v2.defontana.com/api/Account/Analysis/BusinessCenter/Get

Tip
Verbo HTTP: GET

HEADERS
Tipo	Valor	Requerido
Content-Type	“application / JSON“	Si
Autorización	Token de autorización del usuario de integración, y se debe ingresar con el siguiente formato “Bearer TOKEN“	Si

PARAMETROS
Campo	Descripción	Requerido
Account	Código de cuenta contable para la que se desean consultar las opciones de analisis	Si
Fiilter	Filtro opcional de resultados a obtener. El valor ingresado se busca tanto en códigos de ítems como en sus descripciones	No

De retorno, en caso de haber ingresado los datos de forma correcta, nos aparecerá un mensaje similar al siguiente.

Respuesta

Code Block

language	json

{
  "success": true,
  "message": "string",
  "exceptionMessage": "string",
  "items": [
    {
      "code": "string",
      "description": "string"
    }
  ]
}

De retorno en caso de haber ingresado los datos de forma incorrecta, nos aparecerá un mensaje similar al siguiente.

Respuesta

Code Block

language	json

Expand

title	AnalysisClassifier1Get

Permite obtener el análisis de clasificador 1 configurado para una cuenta contable

AMBIENTES
Ámbito	URL
Pruebas	https://certapireplapi-v2.defontana.com/api/Account/Analysis/Classifier1/Get
Productivo	https://api-v2.defontana.com/api/Account/Analysis/Classifier1/Get

Tip
Verbo HTTP: GET

HEADERS
Tipo	Valor	Requerido
Content-Type	“application / JSON“	Si
Autorización	Token de autorización del usuario de integración, y se debe ingresar con el siguiente formato “Bearer TOKEN“	Si

PARAMETROS
Campo	Descripción	Requerido
Account	Código de cuenta contable para la que se desean consultar las opciones de analisis	Si
Fiilter	Filtro opcional de resultados a obtener. El valor ingresado se busca tanto en códigos de ítems como en sus descripciones	No

De retorno, en caso de haber ingresado los datos de forma correcta, nos aparecerá un mensaje similar al siguiente.

Respuesta

Code Block

language	json

{
  "success": true,
  "message": "string",
  "exceptionMessage": "string",
  "items": [
    {
      "code": "string",
      "description": "string"
    }
  ]
}

De retorno en caso de haber ingresado los datos de forma incorrecta, nos aparecerá un mensaje similar al siguiente.

Respuesta

Code Block

language	json

Expand

title	AnalysisClassifier2Get

Permite obtener el análisis de clasificador 2 configurado para una cuenta contable

AMBIENTES
Ámbito	URL
Pruebas	https://certapireplapi-v2.defontana.com/api/Account/Analysis/Classifier2/Get
Productivo	https://api-v2.defontana.com/api/Account/Analysis/Classifier2/Get

Tip
Verbo HTTP: GET

HEADERS
Tipo	Valor	Requerido
Content-Type	“application / JSON“	Si
Autorización	Token de autorización del usuario de integración, y se debe ingresar con el siguiente formato “Bearer TOKEN“	Si

PARAMETROS
Campo	Descripción	Requerido
Account	Código de cuenta contable para la que se desean consultar las opciones de analisis	Si
Fiilter	Filtro opcional de resultados a obtener. El valor ingresado se busca tanto en códigos de ítems como en sus descripciones	No

De retorno, en caso de haber ingresado los datos de forma correcta, nos aparecerá un mensaje similar al siguiente.

Respuesta

Code Block

language	json

{
  "success": true,
  "message": "string",
  "exceptionMessage": "string",
  "items": [
    {
      "code": "string",
      "description": "string"
    }
  ]
}

De retorno en caso de haber ingresado los datos de forma incorrecta, nos aparecerá un mensaje similar al siguiente.

Respuesta

Code Block

language	json

Expand

title	AnalysisFileGet

Permite obtener el análisis de ficha configurado para una cuenta contable

AMBIENTES
Ámbito	URL
Pruebas	https://certapireplapi-v2.defontana.com/api/Account/Analysis/File/Get
Productivo	https://api-v2.defontana.com/api/Account/Analysis/File/Get

Tip
Verbo HTTP: GET

HEADERS
Tipo	Valor	Requerido
Content-Type	“application / JSON“	Si
Autorización	Token de autorización del usuario de integración, y se debe ingresar con el siguiente formato “Bearer TOKEN“	Si

PARAMETROS
Campo	Descripción	Requerido
Account	Código de cuenta contable para la que se desean consultar las opciones de analisis	Si
Fiilter	Filtro opcional de resultados a obtener. El valor ingresado se busca tanto en códigos de ítems como en sus descripciones	No

De retorno, en caso de haber ingresado los datos de forma correcta, nos aparecerá un mensaje similar al siguiente.

Respuesta

Code Block

language	json

{
  "success": true,
  "message": "string",
  "exceptionMessage": "string",
  "items": [
    {
      "code": "string",
      "description": "string"
    }
  ]
}

De retorno en caso de haber ingresado los datos de forma incorrecta, nos aparecerá un mensaje similar al siguiente.

Respuesta

Code Block

language	json

Expand

title	AnalysisBankGet

Permite obtener el análisis de banco configurado para una cuenta contable

AMBIENTES
Ámbito	URL
Pruebas	https://certapireplapi-v2.defontana.com/api/Account/Analysis/Bank/Get
Productivo	https://api-v2.defontana.com/api/Account/Analysis/Bank/Get

Tip
Verbo HTTP: GET

HEADERS
Tipo	Valor	Requerido
Content-Type	“application / JSON“	Si
Autorización	Token de autorización del usuario de integración, y se debe ingresar con el siguiente formato “Bearer TOKEN“	Si

PARAMETROS
Campo	Descripción	Requerido
Account	Código de cuenta contable para la que se desean consultar las opciones de análisis	Si
Amount	Valor que indica el monto que se asignará a la línea de detalle en donde irá la cuenta indicada en account. Si el valor es por ejemplo 100 pesos al debe, ser debe ingresar el valor 100; mientras que, si el valor fuese 100 pesos al haber, se debe ingresar el valor –100	Si

De retorno, en caso de haber ingresado los datos de forma correcta, nos aparecerá un mensaje similar al siguiente.

Respuesta

Code Block

language	json

{
  "success": true,
  "message": "string",
  "exceptionMessage": "string",
  "numberLenght": 0,
  "items": [
    {
      "code": "string",
      "description": "string",
      "usesSeries": true,
      "usesDocumentNumber": true,
      "usesDetraction": true
    }
  ]
}

De retorno en caso de haber ingresado los datos de forma incorrecta, nos aparecerá un mensaje similar al siguiente.

Respuesta

Code Block

language	json

Expand

title	AnalysisDocumentGet

Permite obtener el análisis de documento para una cuenta contable

AMBIENTES
Ámbito	URL
Pruebas	https://certapireplapi-v2.defontana.com/api/Account/Analysis/Document/Get
Productivo	https://api-v2.defontana.com/api/Account/Analysis/Document/Get

Tip
Verbo HTTP: GET

HEADERS
Tipo	Valor	Requerido
Content-Type	“application / JSON“	Si
Autorización	Token de autorización del usuario de integración, y se debe ingresar con el siguiente formato “Bearer TOKEN“	Si

PARAMETROS
Campo	Descripción	Requerido
Account	Código de cuenta contable para la que se desean consultar las opciones de analisis	Si
Fiilter	Filtro opcional de resultados a obtener. El valor ingresado se busca tanto en códigos de ítems como en sus descripciones	No

De retorno, en caso de haber ingresado los datos de forma correcta, nos aparecerá un mensaje similar al siguiente.

Respuesta

Code Block

language	json

{
  "success": true,
  "message": "string",
  "exceptionMessage": "string",
  "items": [
    {
      "code": "string",
      "description": "string",
      "documentSeries": "string",
      "documentNumber": 0
    }
  ]
}

De retorno en caso de haber ingresado los datos de forma incorrecta, nos aparecerá un mensaje similar al siguiente.

Respuesta

Code Block

language	json

Expand

title	AnalysisGet

Permite obtener el análisis de una cuenta contable

AMBIENTES
Ámbito	URL
Pruebas	https://certapireplapi-v2.defontana.com/api/Account/Analysis/Get
Productivo	https://api-v2.defontana.com/api/Account/Analysis/Get

Tip
Verbo HTTP: GET

HEADERS
Tipo	Valor	Requerido
Content-Type	“application / JSON“	Si
Autorización	Token de autorización del usuario de integración, y se debe ingresar con el siguiente formato “Bearer TOKEN“	Si

PARAMETROS
Campo	Descripción	Requerido
Account	Código de cuenta contable para la que se desean consultar las opciones de analisis	Si

De retorno, en caso de haber ingresado los datos de forma correcta, nos aparecerá un mensaje similar al siguiente.

Respuesta

Code Block

language	json

{
  "success": true,
  "message": "string",
  "exceptionMessage": "string",
  "items": [
    {
      "code": "string",
      "description": "string"
    }
  ]
}

De retorno en caso de haber ingresado los datos de forma incorrecta, nos aparecerá un mensaje similar al siguiente.

Respuesta

Code Block

language	json

...

Expand

title	Get

Permite obtener un listado de los clientes asociados a la empresa

AMBIENTES
Ámbito	URL
Pruebas	https://certapireplapi-v2.defontana.com/api/Clients/Get
Productivo	https://api-v2.defontana.com/api/Clients/Get

Tip
Verbo HTTP: GET

HEADERS
Tipo	Valor	Requerido
Content-Type	“application / JSON“	Si
Autorización	Token de autorización del usuario de integración, y se debe ingresar con el siguiente formato “Bearer TOKEN“	Si

PARAMETROS
Campo	Descripción	Requerido
legalCode	Código legal del cliente	No
description	Nombre o descripción del cliente	No
status	Estado actual del cliente (0/1/2 = Todos / Activos / Inactivos)	Si
itemsPerPage	Cantidad de items por pagina	Si
pageNumber	Numero de la pagina (empezar desde 0)	Si

De retorno, en caso de haber ingresado los datos de forma correcta, nos aparecerá un mensaje similar al siguiente.

Respuesta

Code Block

language	json

{
  "success": true,
  "message": "string",
  "exceptionMessage": "string",
  "totalItems": 0,
  "pageNumber": 0,
  "itemsPerPage": 0,
  "clientList": [
    {
      "active": "string",
      "isProvider": "string",
      "lastName1": "string",
      "lastName2": "string",
      "city": "string",
      "client": "string",
      "legalCode": "string",
      "agreedDiscount": 0,
      "address": "string",
      "district": "string",
      "email": "string",
      "sendEmailDTE": "string",
      "state": "string",
      "fax": "string",
      "business": "string",
      "companyID": "string",
      "fileID": "string",
      "localID": "string",
      "coinID": "string",
      "paymentID": "string",
      "productID": "string",
      "rubroId": "string",
      "docTypeID": "string",
      "sellerID": "string",
      "priceList": "string",
      "name": "string",
      "country": "string",
      "poBox": "string",
      "provider": "string",
      "phone": "string",
      "productType": "string",
      "tipRcgoDctoDocVta": "string",
      "usaRcgoDctoDocVta": "string",
      "webSite": "string",
      "zipCode": "string"
    }
  ]
}

De retorno en caso de haber ingresado los datos de forma incorrecta, nos aparecerá un mensaje similar al siguiente.

Respuesta

Code Block

language	json

Expand

title	Delete

Permite eliminar un cliente

AMBIENTES
Ámbito	URL
Pruebas	https://certapireplapi-v2.defontana.com/api/Clients/Delete
Productivo	https://api-v2.defontana.com/api/Clients/Delete

Tip
Verbo HTTP: GET

HEADERS
Tipo	Valor	Requerido
Content-Type	“application / JSON“	Si
Autorización	Token de autorización del usuario de integración, y se debe ingresar con el siguiente formato “Bearer TOKEN“	Si

PARAMETROS
Campo	Descripción	Requerido
fileID	ID de ficha del cliente	Si

De retorno, en caso de haber ingresado los datos de forma correcta, nos aparecerá un mensaje similar al siguiente.

Respuesta

Code Block

language	json

{
  "success": true,
  "message": "string",
  "exceptionMessage": "string"
}

De retorno en caso de haber ingresado los datos de forma incorrecta, nos aparecerá un mensaje similar al siguiente.

Respuesta

Code Block

language	json

Expand

title	Update

Permite actualizar los campos de un cliente

AMBIENTES
Ámbito	URL
Pruebas	https://certapireplapi-v2.defontana.com/api/Clients/Update
Productivo	https://api-v2.defontana.com/api/Clients/Update

Tip
Verbo HTTP: POST

HEADERS
Tipo	Valor	Requerido
Content-Type	“application / JSON“	Si
Autorización	Token de autorización del usuario de integración, y se debe ingresar con el siguiente formato “Bearer TOKEN“	Si

PARAMETROS
Campo	Descripción	Requerido
legalCode	Código Legal del cliente	Si
fileid	Código único del cliente	Si
name	Nombre del cliente	Si
address	Dirección del cliente	Si
district	Distrito del cliente	Si
email	Email del cliente	No
business	Centro de negocio del cliente (si esta configurado para utilizar)	No
rubroId	Rubro del cliente	No
giro	Giro del cliente	Si
city	Ciudad del cliente	Si
maxDiscount	Descuentos asociados a un cliente	No
phone	Teléfono del cliente	No

De retorno, en caso de haber ingresado los datos de forma correcta, nos aparecerá un mensaje similar al siguiente.

Respuesta

Code Block

language	json

{
  "success": true,
  "message": "string",
  "exceptionMessage": "string"
}

De retorno en caso de haber ingresado los datos de forma incorrecta, nos aparecerá un mensaje similar al siguiente.

Respuesta

Code Block

language	json

Expand

title	Save

Permite guardar la información de un cliente de la empresa

AMBIENTES
Ámbito	URL
Pruebas	https://certapireplapi-v2.defontana.com/api/Clients/Save
Productivo	https://api-v2.defontana.com/api/Clients/Save

Tip
Verbo HTTP: POST

HEADERS
Tipo	Valor	Requerido
Content-Type	“application / JSON“	Si
Autorización	Token de autorización del usuario de integración, y se debe ingresar con el siguiente formato “Bearer TOKEN“	Si

PARAMETROS
Campo	Descripción	Requerido
legalCode	Código Legal del cliente	Si
fileid	Código único del cliente	Si
name	Nombre del cliente	Si
address	Dirección del cliente	Si
district	Distrito del cliente	Si
email	Email del cliente	No
business	Centro de negocio del cliente (si esta configurado para utilizar)	No
rubroId	Rubro del cliente	No
giro	Giro del cliente	Si
city	Ciudad del cliente	Si
maxDiscount	Descuentos asociados a un cliente	No
phone	Teléfono del cliente	No

De retorno, en caso de haber ingresado los datos de forma correcta, nos aparecerá un mensaje similar al siguiente.

Respuesta

Code Block

language	json

{
  "success": true,
  "message": "string",
  "exceptionMessage": "string"
}

De retorno en caso de haber ingresado los datos de forma incorrecta, nos aparecerá un mensaje similar al siguiente.

Respuesta

Code Block

language	json

...

Expand

title	Get

Permite obtener la información de los productos ingresados en la empresa

AMBIENTES
Ámbito	URL
Pruebas	https://certapireplapi-v2.defontana.com/api/Products/Get
Productivo	https://api-v2.defontana.com/api/Products/Get

Tip
Verbo HTTP: GET

HEADERS
Tipo	Valor	Requerido
Content-Type	“application / JSON“	Si
Autorización	Token de autorización del usuario de integración, y se debe ingresar con el siguiente formato “Bearer TOKEN“	Si

PARAMETROS
Campo	Descripción	Requerido
code	Código del articulo	No
descripción	Descripción de articulo	No
status	Estado actual del articulo (0/1/2 = Todos / Activos / Inactivos)	Si
itemsPerPage	Cantidad de ítems por pagina	Si
pageNumber	Numero de la pagina (empezar desde 0)	Si

De retorno, en caso de haber ingresado los datos de forma correcta, nos aparecerá un mensaje similar al siguiente.

Respuesta

Code Block

language	json

{
  "success": true,
  "message": "string",
  "exceptionMessage": "string",
  "totalItems": 0,
  "pageNumber": 0,
  "itemsPerPage": 0,
  "productList": [
    {
      "active": "string",
      "code": "string",
      "externalCode": "string",
      "internalCode": "string",
      "name": "string",
      "detailedDescription": "string",
      "comment": "string",
      "companyID": "string",
      "categoryID": 0,
      "coinID": "string",
      "sellPrice": 0,
      "stock": 0,
      "type": "string",
      "unit": "string",
      "imptoAd": "string",
      "idImptoAd": "string",
      "usesLotes": true,
      "usesSeries": true,
      "priceListDetail": [
        {
          "priceList": {
            "companyID": "string",
            "priceListID": 0,
            "description": "string",
            "factor": 0,
            "range": 0
          },
          "priceListID": 0,
          "productID": "string",
          "unitPrice": 0
        }
      ],
      "stockDetail": [
        {
          "companyID": "string",
          "productID": "string",
          "storageID": "string",
          "stock": 0,
          "totalReservedStock": 0
        }
      ],
      "reservedStock": [
        {
          "orderNumber": 0,
          "shopID": "string",
          "storageID": "string",
          "reservedStock": 0
        }
      ]
    }
  ]
}

De retorno en caso de haber ingresado los datos de forma incorrecta, nos aparecerá un mensaje similar al siguiente.

Respuesta

Code Block

language	json

Expand

title	Save

Permite crear un articulo con los datos necesarios y su respectiva información

AMBIENTES
Ámbito	URL
Pruebas	https://certapireplapi-v2.defontana.com/api/Products/Save
Productivo	https://api-v2.defontana.com/api/Products/Save

Tip
Verbo HTTP: POST

HEADERS
Tipo	Valor	Requerido
Content-Type	“application / JSON“	Si
Autorización	Token de autorización del usuario de integración, y se debe ingresar con el siguiente formato “Bearer TOKEN“	Si

PARAMETROS
Campo	Descripción	Requerido
code	Código del articulo	Si
externalCode		No
internalCode		No
name	Nombre del articulo	Si
unit	Unidad de medida del articulo	Si
price	Precio base del articulo	Si
description	Descripción del articulo	Si
categoryID	Código de categoría que va pertenecer el articulo	Si

De retorno, en caso de haber ingresado los datos de forma correcta, nos aparecerá un mensaje similar al siguiente.

Respuesta

Code Block

language	json

{
  "success": true,
  "message": "string",
  "exceptionMessage": "string"
}

De retorno en caso de haber ingresado los datos de forma incorrecta, nos aparecerá un mensaje similar al siguiente.

Respuesta

Code Block

language	json

Expand

title	Update

Permite actualizar un articulo

AMBIENTES
Ámbito	URL
Pruebas	https://certapireplapi-v2.defontana.com/api/Products/Update
Productivo	https://api-v2.defontana.com/api/Products/Update

Tip
Verbo HTTP: POST

HEADERS
Tipo	Valor	Requerido
Content-Type	“application / JSON“	Si
Autorización	Token de autorización del usuario de integración, y se debe ingresar con el siguiente formato “Bearer TOKEN“	Si

PARAMETROS
Campo	Descripción	Requerido
code	Código del articulo	Si
externalCode		No
internalCode		No
name	Nombre del articulo	Si
unit	Unidad de medida del articulo	Si
price	Precio base del produarticulocto	Si
description	Descripción del articulo	Si
categoryID	Código de categoría que va pertenecer el articulo	Si

De retorno, en caso de haber ingresado los datos de forma correcta, nos aparecerá un mensaje similar al siguiente.

Respuesta

Code Block

language	json

{
  "success": true,
  "message": "string",
  "exceptionMessage": "string"
}

De retorno en caso de haber ingresado los datos de forma incorrecta, nos aparecerá un mensaje similar al siguiente.

Respuesta

Code Block

language	json

Expand

title	Remove

Permite dejar inactivo un articulo

AMBIENTES
Ámbito	URL
Pruebas	https://certapireplapi-v2.defontana.com/api/Products/Remove
Productivo	https://api-v2.defontana.com/api/Products/Remove

Tip
Verbo HTTP: GET

HEADERS
Tipo	Valor	Requerido
Content-Type	“application / JSON“	Si
Autorización	Token de autorización del usuario de integración, y se debe ingresar con el siguiente formato “Bearer TOKEN“	Si

PARAMETROS
Campo	Descripción	Requerido
Code	Código de articulo	Si

De retorno, en caso de haber ingresado los datos de forma correcta, nos aparecerá un mensaje similar al siguiente.

Respuesta

Code Block

language	json

{
  "success": true,
  "message": "string",
  "exceptionMessage": "string"
}

De retorno en caso de haber ingresado los datos de forma incorrecta, nos aparecerá un mensaje similar al siguiente.

Respuesta

Code Block

language	json

...

Expand

title	Get

Permite obtener información sobre los servicios asociados a la empresa

AMBIENTES
Ámbito	URL
Pruebas	https://certapireplapi-v2.defontana.com/api/Services/Get
Productivo	https://api-v2.defontana.com/api/Services/Get

Tip
Verbo HTTP: GET

HEADERS
Tipo	Valor	Requerido
Content-Type	“application / JSON“	Si
Autorización	Token de autorización del usuario de integración, y se debe ingresar con el siguiente formato “Bearer TOKEN“	Si

PARAMETROS
Campo	Descripción	Requerido
code	Código del articulo	No
descripción	Descripción de articulo	No
status	Estado actual del articulo (0/1/2 = Todos / Activos / Inactivos)	Si
itemsPerPage	Cantidad de ítems por pagina	Si
pageNumber	Numero de la pagina (empezar desde 0)	Si

De retorno, en caso de haber ingresado los datos de forma correcta, nos aparecerá un mensaje similar al siguiente.

Respuesta

Code Block

language	json

{
  "success": true,
  "message": "string",
  "exceptionMessage": "string",
  "totalItems": 0,
  "pageNumber": 0,
  "itemsPerPage": 0,
  "serviceList": [
    {
      "type": "string",
      "active": "string",
      "code": "string",
      "description": "string",
      "detailedDescription": "string",
      "sellPrice": 0,
      "unit": "string",
      "unitCost": 0,
      "categoryID": 0,
      "useOT": "string"
    }
  ]
}

De retorno en caso de haber ingresado los datos de forma incorrecta, nos aparecerá un mensaje similar al siguiente.

Respuesta

Code Block

language	json

Expand

title	Save

Permite crear un servicio con los datos necesarios y su respectiva información

AMBIENTES
Ámbito	URL
Pruebas	https://certapireplapi-v2.defontana.com/api/Services/Save
Productivo	https://api-v2.defontana.com/api/Services/Save

Tip
Verbo HTTP: POST

HEADERS
Tipo	Valor	Requerido
Content-Type	“application / JSON“	Si
Autorización	Token de autorización del usuario de integración, y se debe ingresar con el siguiente formato “Bearer TOKEN“	Si

PARAMETROS
Campo	Descripción	Requerido
code	Código del servicio	Si
externalCode		No
internalCode		No
name	Nombre del servicio	Si
unit	Unidad de medida del servicio	Si
price	Precio base del servicio	Si
description	Descripción del servicio	Si

De retorno, en caso de haber ingresado los datos de forma correcta, nos aparecerá un mensaje similar al siguiente.

Respuesta

Code Block

language	json

{
  "success": true,
  "message": "string",
  "exceptionMessage": "string"
}

De retorno en caso de haber ingresado los datos de forma incorrecta, nos aparecerá un mensaje similar al siguiente.

Respuesta

Code Block

language	json

Expand

title	Update

Permite actualizar un servicio

AMBIENTES
Ámbito	URL
Pruebas	https://certapireplapi-v2.defontana.com/api/Services/Update
Productivo	https://api-v2.defontana.com/api/Services/Update

Tip
Verbo HTTP: POST

HEADERS
Tipo	Valor	Requerido
Content-Type	“application / JSON“	Si
Autorización	Token de autorización del usuario de integración, y se debe ingresar con el siguiente formato “Bearer TOKEN“	Si

PARAMETROS
Campo	Descripción	Requerido
code	Código del servicio	Si
externalCode		No
internalCode		No
name	Nombre del servicio	Si
unit	Unidad de medida del servicio	Si
price	Precio base del servicio	Si
description	Descripción del servicio	Si

De retorno, en caso de haber ingresado los datos de forma correcta, nos aparecerá un mensaje similar al siguiente.

Respuesta

Code Block

language	json

{
  "success": true,
  "message": "string",
  "exceptionMessage": "string"
}

De retorno en caso de haber ingresado los datos de forma incorrecta, nos aparecerá un mensaje similar al siguiente.

Respuesta

Code Block

language	json

Expand

title	Remove

Permite dejar inactivo un servicio

AMBIENTES
Ámbito	URL
Pruebas	https://certapireplapi-v2.defontana.com/api/Services/Remove
Productivo	https://api-v2.defontana.com/api/Services/Remove

Tip
Verbo HTTP: GET

HEADERS
Tipo	Valor	Requerido
Content-Type	“application / JSON“	Si
Autorización	Token de autorización del usuario de integración, y se debe ingresar con el siguiente formato “Bearer TOKEN“	Si

PARAMETROS
Campo	Descripción	Requerido
Code	Código de servicio	Si

De retorno, en caso de haber ingresado los datos de forma correcta, nos aparecerá un mensaje similar al siguiente.

Respuesta

Code Block

language	json

{
  "success": true,
  "message": "string",
  "exceptionMessage": "string"
}

De retorno en caso de haber ingresado los datos de forma incorrecta, nos aparecerá un mensaje similar al siguiente.

Respuesta

Code Block

language	json

...

Expand

title	Get

Permite obtener los detalles de un documento de inventario

AMBIENTES
Ámbito	URL
Pruebas	https://certapireplapi-v2.defontana.com/api/Inventory/Get
Productivo	https://api-v2.defontana.com/api/Inventory/Get

Tip
Verbo HTTP: GET

HEADERS
Tipo	Valor	Requerido
Content-Type	“application / JSON“	Si
Autorización	Token de autorización del usuario de integración, y se debe ingresar con el siguiente formato “Bearer TOKEN“	Si

PARAMETROS
Campo	Descripción	Requerido
DocumentTypeId	Código de tipo de documento de inventario	No
Folio	Numero del documento	No
FiscalYear	Año fiscal del documento	No

De retorno, en caso de haber ingresado los datos de forma correcta, nos aparecerá un mensaje similar al siguiente.

Respuesta

Code Block

language	json

{
  "success": true,
  "message": "string",
  "exceptionMessage": "string",
  "data": {
    "documentTypeId": "string",
    "documentName": "string",
    "number": 0,
    "fiscalYear": "string",
    "correlative": 0,
    "moveType": "string",
    "adjustmentMovementType": "string",
    "affectsCost": true,
    "date": "2023-02-06T01:15:53.220Z",
    "dateInput": {
      "day": 0,
      "month": 0,
      "year": 0
    },
    "clientId": {
      "priceList": "string",
      "paymentType": "string",
      "paymentTypeId": "string",
      "phones": [
        "string"
      ],
      "emails": [
        "string"
      ],
      "districts": [
        "string"
      ],
      "regions": [
        "string"
      ],
      "seller": {
        "code": "string",
        "name": "string"
      },
      "cities": [
        "string"
      ],
      "addresses": [
        "string"
      ],
      "isMiningCompany": true,
      "web": "string",
      "giro": "string",
      "name": "string",
      "rut": "string",
      "fileId": "string",
      "countries": [
        "string"
      ],
      "documentTypeId": "string"
    },
    "tClientId": {
      "id": "string",
      "country": "string"
    },
    "accountingDefinitionType": "string",
    "accountingDefinitionCode": "string",
    "businessCenterId": "string",
    "businessName": "string",
    "destinationStowageId": "string",
    "originStowageId": "string",
    "providerId": "string",
    "providerName": "string",
    "reasonId": "string",
    "referenceDocumentFolio": 0,
    "referenceDocumentType": "string",
    "dispatchAddress": "string",
    "gloss": "string",
    "details": [
      {
        "decimals": 0,
        "lote": "string",
        "loteExpirationDate": "string",
        "lotes": [
          {
            "batchNumber": "string",
            "amount": 0,
            "expirationDate": "2023-02-06T01:15:53.220Z"
          }
        ],
        "tasa": "string",
        "coinId": "string",
        "headerFileId": "string",
        "fileId": "string",
        "factor": 0,
        "attribute1": "string",
        "attribute3": "string",
        "attribute4": "string",
        "attribute5": "string",
        "serialPrefix": "string",
        "serialSufix": "string",
        "serialStart": "string",
        "serials": [
          "string"
        ],
        "analysis": {
          "businessCenter": "string",
          "clasifier1": "string",
          "clasifier2": "string",
          "file": "string",
          "fileFieldName": "string"
        },
        "attribute2": "string",
        "count": 0,
        "height": 0,
        "width": 0,
        "articleId": "string",
        "receivedCount": 0,
        "dispatchedCount": 0,
        "unitaryCount": 0,
        "currentCost": 0,
        "balance": 0,
        "tasaDate": "2023-02-06T01:15:53.220Z",
        "serviceProjectId": "string",
        "summary": "string",
        "workOrderNumber": 0,
        "orderNumber": 0,
        "serieOC": "string",
        "description": "string",
        "price": 0,
        "accountingDefinitionCode": "string",
        "tipoCentDet": "string",
        "destinationLocalization": "string",
        "originLocalization": "string",
        "length": 0,
        "analysisInfo": {
          "businessCenter": "string",
          "clasifier1": "string",
          "clasifier2": "string",
          "file": "string",
          "fileFieldName": "string"
        },
        "properties": [
          {
            "values": [
              "string"
            ]
          }
        ],
        "productName": "string",
        "unitOfMeasurement": "string",
        "stock": 0
      }
    ],
    "analysis": {
      "businessCenter": "string",
      "clasifier1": "string",
      "clasifier2": "string",
      "file": "string",
      "fileFieldName": "string"
    },
    "state": "string",
    "reversed": "string",
    "integrate": "string",
    "infoCentralization": {
      "existencia": "string",
      "contraExistencia": "string"
    }
  }
}

De retorno en caso de haber ingresado los datos de forma incorrecta, nos aparecerá un mensaje similar al siguiente.

Respuesta

Code Block

language	json

Expand

title	Insert

Permite ingresar un documento de inventario

AMBIENTES
Ámbito	URL
Pruebas	https://certapireplapi-v2.defontana.com/api/Inventory/Insert
Productivo	https://api-v2.defontana.com/api/Inventory/Insert

Tip
Verbo HTTP: GET

HEADERS
Tipo	Valor	Requerido
Content-Type	“application / JSON“	Si
Autorización	Token de autorización del usuario de integración, y se debe ingresar con el siguiente formato “Bearer TOKEN“	Si

PARAMETROS
Campo	Descripción	Requerido
folio	Folio del documento (enviar en 0 para tomar el correlativo)	SI
documentTypeId	Código del tipo de documento	Si
fiscalYear	Año fiscal del documento	Si
clientId	Cod Legal del cliente	Si
providerId	Cod Legal del proveedor	Si
gloss	Comentario / Glosa del documento	Si
originStowageId	Código de bodega de origen	Si
destinationStowageId	Código de bodega de destino	Si
reasonId	Motivo del movimiento de inventario	Si
total	Valor total del documento	Si
isCentralizable	Se define si es un documento centraliza o no centraliza	Si
(analysis) businessCenter	Código del centro de negocio	Si
(analysis) clasifier1	Código del clasificador 1	Si
(analysis) clasifier2	Código del clasificador 2	Si
(analysis) file	Análisis del cliente	Si
(analysis) fileFieldName	Análisis del cliente	Si
referenceDocumentFolio	Folio del documento de referencia	Si
referenceDocumentType	Código del documento de referencia	Si
date	Fecha del documento	Si
externalDocumentID	Código externo de un documento si se maneja	Si
(details) articleId	Código del articulo	Si
(details) description	Descripción del articulo	Si
(details) count	Cantidad de articulo	Si
(details) coinId	Código de moneda	Si
(details) comment	Comentario de linea de detalle	Si
(details) price	Precio unitario de la linea de detalle	Si
(details) serialPrefix	Código de serial (Solo si se utiliza serial enviar dato de lo contrario enviarlo vacío)	Si
(details) serialSufix	Código de serial (Solo si se utiliza serial enviar dato de lo contrario enviarlo vacío)	Si
(details) serialStart	Código de serial (Solo si se utiliza serial enviar dato de lo contrario enviarlo vacío)	Si
(details) serials	Código de serial (Solo si se utiliza serial enviar dato de lo contrario enviarlo vacío)	Si
(lotes) batchNumber	Numero de lote	Si
(lotes) amount	Cantidad	Si
(lotes) expirationDate	Fecha de expiracion	Si
(analysis) businessCenter	Código del centro de negocio	Si
(analysis) clasifier1	Código del clasificador 1	Si
(analysis) clasifier2	Código del clasificador 2	Si
(analysis) file	Análisis del cliente	Si
(analysis) fileFieldName	Análisis del cliente	Si
(ocDetails) number	Numero de orden de compra	Si
(ocDetails) serie	Serie de orden de compra	Si
(ocDetails) line	líneas de detalle de la orden de compra	Si

De retorno, en caso de haber ingresado los datos de forma correcta, nos aparecerá un mensaje similar al siguiente.

Respuesta

Code Block

language	json

{
  "success": true,
  "message": "string",
  "exceptionMessage": "string",
  "number": 0,
  "documentType": "string",
  "fiscalYear": "string"
}

De retorno en caso de haber ingresado los datos de forma incorrecta, nos aparecerá un mensaje similar al siguiente.

Respuesta

Code Block

language	json

Expand

title	List

Permite obtener un listado de documentos de inventario

AMBIENTES
Ámbito	URL
Pruebas	https://certapireplapi-v2.defontana.com/api/Inventory/List
Productivo	https://api-v2.defontana.com/api/Inventory/List

Tip
Verbo HTTP: GET

HEADERS
Tipo	Valor	Requerido
Content-Type	“application / JSON“	Si
Autorización	Token de autorización del usuario de integración, y se debe ingresar con el siguiente formato “Bearer TOKEN“	Si

PARAMETROS
Campo	Descripción	Requerido
DocumentName	Nombre de documento	No
DocumentNumber	Numero de documento	No
StartDate	Fecha de inicio	No
FinishDate	Fecha final	No
ItemsPerPage	Cantidad de ítems por pagina	No
PageNumber	Numero de la pagina (empezar desde 0)	No

De retorno, en caso de haber ingresado los datos de forma correcta, nos aparecerá un mensaje similar al siguiente.

Respuesta

Code Block

language	json

{
  "success": true,
  "message": "string",
  "exceptionMessage": "string",
  "data": {
    "draw": 0,
    "recordsTotal": 0,
    "recordsFiltered": 0,
    "data": [
      {
        "folio": 0,
        "correlative": 0,
        "date": "string",
        "realDate": "2023-02-06T01:36:46.170Z",
        "documentTypeId": "string",
        "documentTypeName": "string",
        "originStowageId": "string",
        "destinationStowageId": "string",
        "total": "string",
        "tipoMov": "string",
        "consistent": "string",
        "status": "string",
        "fiscalYear": "string",
        "voucherStatus": "string",
        "voucherType": "string",
        "voucherFiscalYear": "string",
        "voucherFolio": 0,
        "voucherFolioProperty": 0,
        "isDispatchGuide": true,
        "isOpeningMovement": "string",
        "debit": "string",
        "credit": "string",
        "reversed": "string",
        "statusApproved": "string",
        "totalRows": 0,
        "origin": "string"
      }
    ],
    "error": "string"
  }
}

De retorno en caso de haber ingresado los datos de forma incorrecta, nos aparecerá un mensaje similar al siguiente.

Respuesta

Code Block

language	json

...

Versions Compared

Old Version 14

New Version Current

Key

Contactos

Métodos

AUTH