View Source

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.

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.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.defontana.com/swagger/index.html

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

Día	Inicio	Fin
Lunes	08:00	20:00
Martes	08:00	20:00
Miércoles	08:00	20:00
Jueves	08:00	20:00
Viernes	08:00	20:00
Sábado	-	-
Domingo	-	-

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.

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
ACCOUNTING
SALE
INVENTORY
PURCHASE
PURCHASEORDER
DISPATCH
ORDER
PRICING

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.

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

Sale: agrupa métodos para administrar las ventas, artículos, clientes, etc. de las empresas en el ERP.

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

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

Purchaseorder: agrupa métodos para administrar las ordenes de compra de las empresas en el ERP.

Dispatch: agrupa métodos para administrar los despachos de las empresas en el ERP.

Order: agrupa métodos para administrar los pedidos de las empresas en el ERP.

Pricing: (pendiente)

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.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.

Centro de ayuda Defontana > API REST INTEGRACIÓN 1.0.0 - LIVE > imagen-20200604-221143.png

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
POST	Creación
PUT	Actualización/Reemplazo
PATCH	Actualización/Reemplazo Parcial
DELETE	Eliminación

AUTH

Obtiene el token de autenticación de un usuario en particular, mediante las “credenciales tradicionales” de acceso al sistema.

Centro de ayuda Defontana > API REST INTEGRACIÓN 1.0.0 - LIVE > imagen-20200608-155210.png

Ambientes

Ámbito	URL
Pruebas	https://replapi.defontana.com/api/auth
Productivo	https://api.defontana.com/api/auth

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

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

Obtiene el token de autenticación de un usuario en particular, mediante las credenciales de acceso al sistema a través de correo y contraseña.

Centro de ayuda Defontana > API REST INTEGRACIÓN 1.0.0 - LIVE > imagen-20200608-160641.png

Ambientes

Ámbito	URL
Pruebas	https://replapi.defontana.com/api/auth/emailLogin
Producción	https://api.defontana.com/api/auth/emailLogin

Verbo HTTP: GET

Parámetros

Campo	Descripción	Requerido
Email	Email de acceso	Sí
Password	Contraseña del email	Sí
Client	Campo para indicar el id de cliente con el cual se requiere iniciar sesión (solo requerido si el correo está asociado a más de un cliente en el ERP)	No
Company	Campo para indicar el id de empresa con la cual se requiere iniciar sesión (solo requerido si el correo está asociado a más de una empresa)	No
User	Campo para indicar el usuario con el cual se requiere iniciar sesión (solo requerido si el correo está asociado a clientes de distintos servicios)	No

De retorno, en caso de haber ingresado los datos de acceso en forma correcta y no tener más de una empresa y/o usuarios asociados al correo, nos aparecerá un mensaje similar al siguiente. El token de acceso vendrá en el campo “access_token”.

Respuesta

{
  "success": true,
  "message": null,
  "jumpUsers": [
  {
    "client": "empresas defontana",
    "company": "dfchile",
    "user": "gpuellestorres",
    "service": "international"
  } ],
    "authResult":
    {
      "success": true,
      "message": null,
      "access_token": "eyJ0eXAKV1J9.eyJuWJBRD...jMjYy0fQ.pi3hW7cPBs",
      "expires_in": 378604799,
      "token_type": "bearer"
  }
}

Se puede dar el caso de que nos llegue una respuesta similar a lo siguiente:

{ 
  "success": true, 
  "message": "Debe indicar un cliente/empresa/usuario a utilizar", 
  "jumpUsers": [ 
  { 
    "client": "client1",
    "company": "company1", 
    "user": "user1", 
    "service": "international" 
  }, 
{ 
    "client": "client1",
    "company": "company2", 
    "user": "user2", 
    "service": "international" 
  }, 
{ 
    "client": "client2", 
    "company": "company2", 
    "user": "user1", 
    "service": "pyme" 
  }
]
}

En este tipo de casos debemos ingresar un id de cliente, empresa y/o usuario, para indicar con cuáles deseamos obtener un token. Para el ejemplo anterior, bastaría con indicar el “client2” de id de cliente (ya que no tenemos más de una empresa o usuario asociados a aquel cliente) y el método nos entregaría un token de acceso para la combinación [client2, company2, user1].

Obtiene un token de acceso a partir de una sesión ya existente

Ambientes

Ámbito	URL
Pruebas	https://replapi.defontana.com/api/auth/regaintoken
Producción	https://api.defontana.com/api/auth/regaintoken

Verbo HTTP: GET

Headers

Tipo	Valor	Requerido
Content-Type	“application/json“	Sí
Autorization	Token de autenticación del usuario de Integración. Debe ingresarse con el siguiente formato “bearer TOKEN”	Sí

Parámetros

Campo	Descripción	Requerido
Client	Campo para indicar el id de cliente con el cual se requiere iniciar sesión (solo requerido si el correo está asociado a más de un cliente en el ERP)	Sí
Company	Campo para indicar el id de empresa con la cual se requiere iniciar sesión (solo requerido si el correo está asociado a más de una empresa)	Sí
User	Identificador del usuario	Sí
Session	Identificador de la sesión	Sí

Respuesta

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

ACCOUNTING

Permite obtener los datos de un comprobante contable.

Ambientes

Ámbito
Pruebas	https://replapi.defontana.com/api/Accounting/GetVoucher
Producción	https://api.defontana.com/api/Accounting/GetVoucher

Verbo HTTP: GET

Headers

Tipo	Valor	Requerido
Content-Type	“application/json“	Sí
Autorization	Token de autenticación del usuario de Integración. Debe ingresarse con el siguiente formato “bearer TOKEN”	Sí

Parámetros

Campo	Descripción	Requerido
VoucherType	Tipo de comprobante	Sí
Number	Número de comprobante	Sí
fiscalYear	Año fiscal del comprobante	Sí

Respuesta

{
  "header": {
    "fiscalYear": 2020,
    "voucherType": "EGRESO",
    "voucherTypeName": "EGRESO",
    "isOpening": false,
    "companyId": "dfchile",
    "companyName": "DEFONTANA CHILE SPA.",
    "number": 1,
    "date": "2020-01-02T00:00:00",
    "comment": "Cancelo Nomina Chile FXR 30-12",
    "state": "A",
    "entryUser": "mrus",
    "entryDate": "2020-01-03T11:46:35.05",
    "affectedPlan": 1
},
  "detail": [
    {
      "accountCode": "110602",
      "debit": 19605,
      "credit": 0,
      "secondaryDebit": 0,
      "secondaryCredit": 0,
      "exchangeRate": 0,
      "comment": "Cancelo Rendicion R. Garcia",
      "fileId": "13.176.789-7",
      "documentType": "",
      "documentSeries": "",
      "documentNumber": 0,
      "documentExpirationDate": "1900-01-01T00:00:00",
      "originDocumentData": "",
      "bussinessCenterId": "",
      "classifier1Id": "",
      "classifier2Id": "",
      "movementTypeId": "",
      "movementSeries": "",
      "movementNumber": ""
  },
  ...
  {
      "accountCode": "110103",
      "debit": 0,
      "credit": 616836,
      "secondaryDebit": 0,
      "secondaryCredit": 0,
      "exchangeRate": 0,
      "comment": "Cancelo Nomina Chile FXR 30-12",
      "fileId": "",
      "documentType": "",
      "documentSeries": "",
      "documentNumber": 0,
      "documentExpirationDate": "1900-01-01T00:00:00",
      "originDocumentData": "",
      "bussinessCenterId": "",
      "classifier1Id": "",
      "classifier2Id": "",
      "movementTypeId": "CB",
      "movementSeries": "",
      "movementNumber": ""
    }
  ]
}

Permite obtener los datos de un listado de comprobantes contables.

Ambientes

Ámbito	URL
Pruebas	https://replapi.defontana.com/api/Accounting/GetVoucherList
Producción	https://api.defontana.com/api/Accounting/GetVoucherList

Verbo HTTP: GET

Headers

Tipo	Valor	Requerido
Content-Type	“application/json”	Sí
Autorization	Token de autenticación del usuario de Integración. Debe ingresarse con el siguiente formato “bearer TOKEN”	Sí

Parámetros

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

{
  "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 plan de cuentas de una empresa del ERP.

Ambientes

Ámbito	URL
Pruebas	https://replapi.defontana.com/api/Accounting/GetAccountPlan
Producción	https://api.defontana.com/api/Accounting/GetAccountPlan

Verbo HTTP: GET

Headers

Tipo	Valor	Requerido
Content-Type	“application/json”	Sí
Authorization	Token de autenticación del usuario de Integración. Debe ingresarse con el siguiente formato “bearer TOKEN”	Sí

Parámetros

(ninguno)

Respuesta

{
  "items": [
    {
      "code": "100000",
      "description": "ACTIVO",
      "ifrsRelatedAccountCode": "0100000",
      "ifrsRelatedAccountDescription": "ACTIVO",
      "childs": [
        {
          "code": "110000",
          "description": "ACTIVO CIRCULANTE",
          "ifrsRelatedAccountCode": "0110000",
          "ifrsRelatedAccountDescription": "ACTIVO CIRCULANTE",
          "childs": [
          {
            "code": "110100",
            "description": "Disponible",
            "ifrsRelatedAccountCode": "0110100",
            "ifrsRelatedAccountDescription": "Disponible",
            "childs": [
            {
              "code": "110101",
              "description": "Caja",
              "ifrsRelatedAccountCode": "0110101",
              "ifrsRelatedAccountDescription": "Caja",
              "childs": null
              },
              ...
            {
              "code": "110115",
              "description": "Banco Santander Dolar",
              "ifrsRelatedAccountCode": "0110115",
              "ifrsRelatedAccountDescription": "Banco Santander Dolar",
              "childs": null
            }
            ]
            },
            ...
            ]
            },
            ...
            {
              "code": "400000",
              "description": "PÉRDIDAS",
              "ifrsRelatedAccountCode": "0400000",
              "ifrsRelatedAccountDescription": "PÉRDIDAS",
              "childs": [...]
            },
            ...
        ]
    }
],
"success": true,
"message": null
}

Permite obtener el análisis de una cuenta.

Ambientes

Ámbito	URL
Pruebas	https://replapi.defontana.com/api/Accounting/GetAccountAnalisys
Producción	https://api.defontana.com/api/Accounting/GetAccountAnalisys

Verbo HTTP: POST

Headers

Tipo	Descripción	Requerido
Content-Type	“application/json”	Sí
Authorization	Token de autenticación del usuario de Integración. Debe ingresarse con el siguiente formato “bearer TOKEN”	Sí

Parámetros

Campo	Descripción	Requerido
account	Código de la cuenta a consultar	Sí

Respuesta

{
  "usesClassifier2Analysis": false,
  "usesClassifier1Analysis": false,
  "usesReferenceCurrencyAnalysis": true,
  "usesDocumentAnalysis": false,
  "usesFileAnalysis": false,
  "usesBussinessCenterAnalysis": false,
  "usesBankAnalysis": true,
  "success": true,
  "message": ""
}

Permite ingresar un comprobante contable.

Ambientes

Ámbito	URL
Pruebas	https://replapi.defontana.com/api/Accounting/InsertVoucher
Producción	https://api.defontana.com/api/Accounting/InsertVoucher

Verbo HTTP: GET

Headers

Tipo	Valor	Requerido
Content-Type	“application/json”	Sí
Authorization	Token de autenticación del usuario de Integración. Debe ingresarse con el siguiente formato “bearer TOKEN”	Sí

Parámetros

Campo	Descripción	Requerido
(header) fiscalYear	Año fiscal del comprobante	Sí
(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	Sí
(header) voucherType	Id de Tipo de Comprobante	Sí
(header) date	Fecha del comprobante	Sí
(header) comment	Comentario/glosa del comprobante	Sí
(detail) accountCode	Código de cuenta	Sí
(detail) debit	Valor debe en la línea de detalle	Sí
(detail) credit	Valor haber en la línea de detalle	Sí
(detail) secondaryDebit	Valor debe de la moneda secundaria en la línea de detalle	No
(detail) secondaryCredit	Valor debe de la moneda secundaria en la línea de detalle	No
(detail) exchangeRate	Tasa de cambio entre los valores principales y de moneda secundaria	No
(detail) comment	Comentario/glosa de la línea de detalle	Sí
(detail) fileId	Id de ficha asignada al comprobante (análisis de ficha)	Depende del análisis
(detail) documentSeries	Serie de documento (análisis de documento)	Depende del análisis
(detail) documentNumber	Número de documento (análisis de documento)	Depende del análisis
(detail) documentExpirationDate	Fecha de expiración de documento (análisis de documento)	Depende del análisis
(detail) bussinessCenterId	Código de centro de negocios (análisis de centro de negocios)	Depende del análisis
(detail) classifier1Id	Código de clasificador 1 (análisis de clasificador 1)	Depende del análisis
(detail) classifier2Id	Código de clasificador 2 (análisis de clasificador 2)	Depende del análisis
(detail) referenceCurrencyId	Id de moneda de referencia, si corresponde	No
(detail) referenceExchangeRate	Tasa de moneda de referencia, si corresponde	No
(detail) movementTypeId	Código de tipo de movimiento (análisis de banco)	Depende del análisis
(detail) movementSeries	Serie de movimiento (análisis de banco)	Depende del análisis
(detail) movementNumber	Número de movimiento (análisis de banco)	Depende del análisis
(detail) accountAmountRate	Monto de movimiento (análisis de banco)	Depende del análisis
(detail) ctaCreditOrDebitAmount	Monto asignado a valor debe o haber de cuenta de banco asociada a cuenta, si corresponde	No
automaticFoliation	Indica si al comprobante se le debe asignar un número automáticamente. Si se envía un valor “false” se ocupará el valor enviado en el campo (header) number	Sí

Respuesta

{
  "voucherType": "Egreso",
  "number": 101,
  "fiscalYear": 2020,
  "success": true,
  "message": ""
}

Permite ingresar un comprobante contable.

Ambientes

Ámbito	URL
Pruebas	https://replapi.defontana.com/api/Accounting/UpdateVoucher
Producción	https://api.defontana.com/api/Accounting/UpdateVoucher

Verbo HTTP: POST

Headers

Tipo	Valor	Requerido
Content-Type	“application/json”	Sí
Authorization	Token de autenticación del usuario de Integración. Debe ingresarse con el siguiente formato “bearer TOKEN”	Sí

Parámetros

(se envían los mismos parámetros indicados en el método InsertVoucher)

Respuesta

{
  "voucherType": "Egreso",
  "number": 101,
  "fiscalYear": 2020,
  "success": true,
  "message": ""
}

Permite eliminar un comprobante contable.

Ambientes

Ámbito	URL
Pruebas	https://replapi.defontana.com/api/Accounting/DeleteVoucher
Producción	https://api.defontana.com/api/Accounting/DeleteVoucher

Verbo HTTP: GET

Headers

Tipo	Valor	Requerido
Content-Type	“application/json”	Sí
Authorization	Token de autenticación del usuario de Integración. Debe ingresarse con el siguiente formato “bearer TOKEN”	Sí

Parámetros

Campo	Descripción	Requerido
voucherType	Id del tipo del comprobante a eliminar	Sí
number	Número del comprobante	Sí
fiscalYear	Año fiscal del comprobante	Sí

Respuesta

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

Permite obtener las opciones de valores a ingresar para cuentas con análisis de tipo clasificador 1.

Ambientes

Ámbito	URL
Pruebas	https://replapi.defontana.com/api/Accounting/Analysis/GetClassifier1AnalysisItems
Producción	https://api.defontana.com/api/Accounting/Analysis/GetClassifier1AnalysisItems

Verbo HTTP: GET

Headers

Tipo	Valor	Requerido
Content-Type	“application/json”	Sí
Authorization	Token de autenticación del usuario de Integración. Debe ingresarse con el siguiente formato “bearer TOKEN”	Sí

Parámetros

Campo	Descripción	Requerido
account	Código de cuenta contable para la que se desean consultar las opciones de análisis	Sí
filter	Filtro opcional de resultados a obtener. El valor ingresado se busca tanto en códigos de ítems como en sus descripciones	No

Respuesta

{
  "items": [
    {
      "code": "08.713.530-8",
      "descripction": "Hernán Pérez Villaseca"
    },
    {
      "code": "08.715.870-6",
      "descripction": "Brian Herrera Contreras"
    },
    ...
    {
      "code": "Y_Sevilla",
      "descripction": "Yurisa Danisa Sevilla"
    }
],
"success": true,
"message": null
}

Permite obtener las opciones de valores a ingresar para cuentas con análisis de tipo clasificador 2.

Ambientes

Ámbito	URL
Pruebas	https://replapi.defontana.com/api/Accounting/Analysis/GetClassifier2AnalysisItems
Producción	https://api.defontana.com/api/Accounting/Analysis/GetClassifier2AnalysisItems

Verbo HTTP: GET

Headers

Tipo	Valor	Requerido
Content-Type	“application/json”	Sí
Authorization	Token de autenticación del usuario de Integración. Debe ingresarse con el siguiente formato “bearer TOKEN”	Sí

Parámetros

Campo	Descripción	Requerido
account	Código de cuenta contable para la que se desean consultar las opciones de análisis	Sí
filter	Filtro opcional de resultados a obtener. El valor ingresado se busca tanto en códigos de ítems como en sus descripciones	No

Respuesta

{
  "items": [
    {
      "code": "01",
      "descripction": "FACT 01"
    },
    ...
    {
      "code": "06",
      "descripction": "Tanner Servicios Financieros"
    }
],
"success": true,
"message": null
}

Permite obtener las opciones de valores a ingresar para cuentas con análisis de tipo Ficha.

Ambientes

Ámbito	URL
Pruebas	https://replapi.defontana.com/api/Accounting/Analysis/GetFileAnalysisItems
Producción	https://api.defontana.com/api/Accounting/Analysis/GetFileAnalysisItems

Verbo HTTP: GET

Headers

Tipo	Valor	Requerido
Content-Type	“application/json”	Sí
Authorization	Token de autenticación del usuario de Integración. Debe ingresarse con el siguiente formato “bearer TOKEN”	Sí

Parámetros

Campo	Descripción	Requerido
account	Código de cuenta contable para la que se desean consultar las opciones de análisis	Sí
filter	Filtro opcional de resultados a obtener. El valor ingresado se busca tanto en códigos de ítems como en sus descripciones	No

Respuesta

{
  "items": [
    {
      "code": "20514876584",
      "descripction": "AND PERU S.A.C."
    },
    ...
    {
      "code": "08.491.435-0",
      "descripction": "CARLOS ZAPATA GARCÉS"
    }
  ],
"success": true,
"message": null
}

Permite obtener las opciones de valores a ingresar para cuentas con análisis de tipo Centro de Negocios.

Ambientes

Ámbito	URL
Prueba	https://replapi.defontana.com/api/Accounting/Analysis/GetBusinessCenterAnalysisItems
Producción	https://api.defontana.com/api/Accounting/Analysis/GetBusinessCenterAnalysisItems

Verbo HTTP: GET

Headers

Tipo	Valor	Requerido
Content-Type	“application/json”	Sí
Authorization	Token de autenticación del usuario de Integración. Debe ingresarse con el siguiente formato “bearer TOKEN”	Sí

Parámetros

Campo	Descripción	Requerido
account	Código de cuenta contable para la que se desean consultar las opciones de análisis	Sí
filter	Filtro opcional de resultados a obtener. El valor ingresado se busca tanto en códigos de ítems como en sus descripciones	No

Respuesta

{
  "items": [
    {
      "code": "DCMADMADM000000",
      "descripction": "ADMINISTRACIÓN"
    },
    {
      "code": "DCMADMFEL000000",
      "descripction": "FINANCIA EN LINEA"
    },
    ...
    {
      "code": "DCMOPESOP000000",
      "descripction": "SOPORTE"
    }
  ],
"success": true,
"message": null
}

Permite obtener las opciones de valores a ingresar para cuentas con análisis de Documento.

Ambientes

Ámbito	URL
Prueba	https://replapi.defontana.com/api/Accounting/Analysis/GetDocumentAnalysisItems
Producción	https://api.defontana.com/api/Accounting/Analysis/GetDocumentAnalysisItems

Verbo HTTP: GET

Headers

Tipo	Valor	Requerido
Content-Type	“application/json”	Sí
Authorization	Token de autenticación del usuario de Integración. Debe ingresarse con el siguiente formato “bearer TOKEN”	Sí

Parámetros

Campo	Descripción	Requerido
account	Código de cuenta contable para la que se desean consultar las opciones de análisis	Sí
filter	Filtro opcional de resultados a obtener. El valor ingresado se busca tanto en códigos de ítems como en sus descripciones	No

Respuesta

{
  "items": [
    {
      "documentSeries": null,
      "documentNumber": null,
      "code": "BLCD",
      "descripction": "BOLETA DE COMPRA DETALLE"
    }, ...
    {
      "documentSeries": null,
      "documentNumber": null,
      "code": "VALE_VISTA",
      "descripction": "VALE VISTA"
    }
  ],
"success": true,
"message": null
}

Permite obtener las opciones de valores a ingresar para cuentas con análisis de Documento.

Ambientes

Ámbito	URL
Prueba	https://replapi.defontana.com/api/Accounting/Analysis/GetBankAnalysisItems
Producción	https://api.defontana.com/api/Accounting/Analysis/GetBankAnalysisItems

Verbo HTTP: GET

Headers

Tipo	Valor	Requerido
Content-Type	“application/json”	Sí
Authorization	Token de autenticación del usuario de Integración. Debe ingresarse con el siguiente formato “bearer TOKEN”	Sí

Parámetros

Campo	Descripción	Requerido
account	Código de cuenta contable para la que se desean consultar las opciones de análisis	Sí
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.	Sí

Respuesta

{
  "numberLenght": 0,
  "items": [
    {
      "usesSeries": false,
      "usesDocumentNumber": true,
      "usesDetraction": false,
      "code": "ABONO",
      "descripction": "ABONO"
    },
    ...
    {
      "usesSeries": false,
      "usesDocumentNumber": true,
      "usesDetraction": false,
      "code": "VALEVISTA",
      "descripction": "VALE VISTA"
    }
  ],
"success": true,
"message": null
}

Permite centralizar o contabilizar una venta

Ambientes

Ámbito	URL
Prueba	https://replapi.defontana.com/api/Accounting/CentralizeSale
Producción	https://api.defontana.com/api/Accounting/CentralizeSale

Verbo HTTP: GET

Headers

Tipo	Valor	Requerido
Content-Type	“application/json”	Sí
Authorization	Token de autenticación del usuario de Integración. Debe ingresarse con el siguiente formato “bearer TOKEN”	Sí

Parámetros

Campo	Descripción	Requerido
DocumentType	Código del Tipo de Documento de Venta	Sí
Number	Número de Documento de Venta	Sí

Respuesta

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

Permite obtener la información crediticia de un cliente

Ambientes

Ámbito	URL
Prueba	https://replapi.defontana.com/api/Accounting/GetClientCredit
Producción	https://api.defontana.com/api/Accounting/GetClientCredit

Verbo HTTP: GET

Headers

Tipo	Valor	Requerido
Content-Type	“application/json”	Sí
Authorization	Token de autenticación del usuario de Integración. Debe ingresarse con el siguiente formato “bearer TOKEN”	Sí

Parámetros

Campo	Descripción	Requerido
LegalCode	Código legal del cliente	Sí

Respuesta

{
legalCode: string
limiteMontoMoroso: int
montoCredito: int
saldoPendiente: int
success: bool
message: string
exceptionMessage: string
}

Permite obtener los documentos pendientes de pago para un cliente en particular.

Ambientes

Ámbito	URL
Pruebas	https://replapi.defontana.com/api/Accounting/GetDocumentsToPay
Producción	https://api.defontana.com/api/Accounting/GetDocumentsToPay

Verbo HTTP: GET

Headers

Tipo	Valor	Requerido
Content-Type	“application/json”	Sí
Authorization	Token de autenticación del usuario de Integración. Debe ingresarse con el siguiente formato “bearer TOKEN”	Sí

Parámetros

Campo	Descripción	Requerido
FileID	Identificador	Sí
ItemsPerPage	Documentos por página	Sí
PageNumber	Página de búsqueda (inicia en 0)

Respuesta

{
  "totalItems": 0,
  "page": 0,
  "itemsPerPage": 0,
  "success": true,
  "documents": [
    {
      "idTipoDocumento": "string",
      "idCuenta": "string",
      "series": "string",
      "number": 0,
      "bussinessCenter": "string",
      "expirationDate": "2021-11-30T13:26:43.474Z",
      "amount": 0,
      "alphaSeries": "string",
      "alphaNumber": "string",
      "codelect": "string",
      "documentType": "string"
    }
  ]
}

Permite obtener los documentos de pago asociados a un documento de ventas

Ambientes

Ámbito	URL
Pruebas	https://replapi.defontana.com/api/Accounting/GetPaymentDocuments
Producción	https://api.defontana.com/api/Accounting/GetPaymentDocuments

Verbo HTTP: GET

Headers

Tipo	Valor	Requerido
Content-Type	“application/json”	Sí
Authorization	Token de autenticación del usuario de Integración. Debe ingresarse con el siguiente formato “bearer TOKEN”	Sí

Parámetros

Campo	Descripción	Requerido
DocumentType	Tipo de documento de ventas	Sí
Folio	Folio de documento de ventas	Sí

Respuesta

{
  "success": true,
  "message": "string",
  "exceptionMessage": "string",
  "totalItems": 0,
  "items": [
    {
      "voucherType": "string",
      "number": 0,
      "fiscalYear": "string",
      "date": "2021-12-07T18:44:50.948Z",
      "entryDate": "2021-12-07T18:44:50.948Z",
      "gloss": "string",
      "coinID": "string",
      "entryUserName": "string"
    }
  ]
}

Permite consultar por un número de cuenta contable en específico

Ambientes

Ámbito	URL
Pruebas	https://replapi.defontana.com/api/Accounting/GetAccountNumber
Producción	https://api.defontana.com/api/Accounting/GetAccountNumber

Verbo HTTP: GET

Headers

Tipo	Valor	Requerido
Content-Type	“application/json”	Sí
Authorization	Token de autenticación del usuario de Integración. Debe ingresarse con el siguiente formato “bearer TOKEN”	Sí

Parámetros

Campo	Descripción	Requerido
AccountNumber	Identificador de la cuenta contable	Sí

Respuesta

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

Permite consultar por centro de negocio en especifico

Ambientes

Ámbito	URL
Pruebas	https://replapi.defontana.com/api/Accounting/GetBusinessCenter
Producción	https://api.defontana.com/api/Accounting/GetBusinessCenter

Verbo HTTP: GET

Headers

Tipo	Valor	Requerido
Content-Type	“application/json”	Sí
Authorization	Token de autenticación del usuario de Integración. Debe ingresarse con el siguiente formato “bearer TOKEN”	Sí

Parámetros

Campo	Descripión	Requerido
BusinessCenter	Código de centro de negocios por el cual se quiere consultar	Sí

Respuesta

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

SALE

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

Ambientes

Ámbito	URL
Prueba	https://replapi.defontana.com/api/sale/GetProducts
Producción	https://api.defontana.com/api/sale/GetProducts

Verbo HTTP: GET

Headers

Tipo	Valor	Requerido
Content-Type	“application/json”	Sí
Authorization	Token de autenticación del usuario de Integración. Debe ingresarse con el siguiente formato “bearer TOKEN”	Sí

Parámetros

Campo	Descripción	Requerido
code	Código del producto	No
description	Descripción del producto	No
status	Indica si el producto está activo o no (0/1/2)	Sí
itemsPerPage	Cantidad de registros por página.	Sí
pageNumber	Número de la página actual.	Sí

Respuesta

{
  "totalItems": 2415,
  "pageNumber": 1,
  "itemsPerPage": 1,
  "productList": [
    {
      "active": "S",
      "code": "10",
      "externalCode": "",
      "internalCode": "",
      "name": "VINO",
      "detailedDescription": null,
      "companyID": "20180808202443996002",
      "coinID": "PESO",
      "sellPrice": 0,
      "stock": 0,
      "type": null,
      "unit": "UN",
      "priceListDetail": [],
      "stockDetail": []
   }
  ]
}

Permite crear un Artículo con los datos necesarios y su respectiva información.

Ambientes

Ámbito	URL
Prueba	https://replapi.defontana.com/api/sale/SaveProducts
Producción	https://api.defontana.com/api/sale/SaveProducts

Verbo HTTP: POST

Headers

Tipo	Valor	Requerido
Content-Type	“application/json”	Sí
Authorization	Token de autenticación del usuario de Integración. Debe ingresarse con el siguiente formato “bearer TOKEN”	Sí

Parámetros

Campo	Descripción	Requerido
code	Código del producto o servicio.	Sí
name	Nombre del producto o servicio	Sí
unit	Unidad de medida del producto o servicio	No
price	Precio base del producto o servicio.	Sí
description	Descripción del producto o servicio	Sí
isService	Indica si es servicio o artículo (true/false)	Sí

Respuesta

{
  "success": true,
  "message": "Producto Guardado Exitosamente"
}

Permite obtener un listado de los clientes asociados a la empresa.

Ambientes

Ámbito	URL
Prueba	https://replapi.defontana.com/api/sale/GetClients
Producción	https://api.defontana.com/api/sale/GetClients

Verbo HTTP: GET

Headers

Tipo	Valor	Requerido
Content-Type	“application/json”	Sí
Authorization	Token de autenticación del usuario de Integración. Debe ingresarse con el siguiente formato “bearer TOKEN”	Sí

Parámetros

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)	Sí
itemsPerPage	Cantidad de registros por página	Sí
pageNumber	Número de la página actual.	Sí

Respuesta

{
  "totalItems": 10207,
  "pageNumber": 1,
  "itemsPerPage": 1,
  "clientList": [
    {
      "active": "S",
      "isProvider": "S",
      "lastName1": null,
      "lastName2": null,
      "city": "",
      "client": "S",
      "legalCode": "00.000.000-0",
      "agreedDiscount": 0,
      "address": "",
      "district": "",
      "email": "",
      "sendEmailDTE": "",
      "state": "",
      "fax": "",
      "business": "",
      "companyID": "20180808202443996002",
      "fileID": "00.000.000-0",
      "localID": "AW",
      "coinID": "PESO",
      "paymentID": "CONTADO",
      "productID": null,
      "rubroId": "POR DEFINIR",
      "docTypeID": "XBVTAFEC",
      "sellerID": "SGN",
      "priceList": "3",
      "name": "CLIENTES ACUMULADOS HASTA EL 2018",
      "country": "",
      "poBox": "",
      "provider": "S",
      "phone": "",
      "productType": "S",
      "tipRcgoDctoDocVta": "P",
      "usaRcgoDctoDocVta": "",
      "webSite": "",
      "zipCode": ""
    }
  ]
}

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

Ambientes

Ámbito	URL
Prueba	https://replapi.defontana.com/api/sale/SaveClient
Producción	https://api.defontana.com/api/sale/SaveClient

Verbo HTTP: POST

Headers

Tipo	Valor	Requerido
Content-Type	“application/json”	Sí
Authorization	Token de autenticación del usuario de Integración. Debe ingresarse con el siguiente formato “bearer TOKEN”	Sí

Parámetros

Campo	Descripción	Requerido
legalCode	Código legal del cliente	Sí
name	Nombre del cliente	Sí
address	Dirección del cliente	Sí
district	Distrito del cliente	Sí
email	Email del cliente.	No
business	Negocio del cliente	Sí
rubroId	Rubro del cliente	Sí
giro	Giro del cliente	Sí

Respuesta

{
  "success": true,
  "message": "Cliente Guardado Exitosamente"
}

Permite obtener la información de los vendedores asociados a la empresa.

Ambientes

Ámbito	URL
Prueba	https://replapi.defontana.com/api/sale/GetSellers
Producción	https://api.defontana.com/api/sale/GetSellers

Verbo HTTP: GET

Headers

Tipo	Valor	Requerido
Content-Type	“application/json”	Sí
Authorization	Token de autenticación del usuario de Integración. Debe ingresarse con el siguiente formato “bearer TOKEN”	Sí

Parámetros

Campo	Descripción	Requerido
code	Identificador del vendedor	No
ItemsPerPage	Cantidad de registros por página	Sí
PageNumber	Número de página	Sí

Respuesta

{
  "totalItems": 28,
  "pageNumber": 1,
  "itemsPerPage": 1,
  "sellerList": [
    {
      "code": "APS",
      "name": "NOMBRE VENDEDOR"
    }
  ]
}

Permite obtener la información de los locales asociados a la empresa.

Ambientes

Ámbito	URL
Prueba	https://replapi.defontana.com/api/sale/GetShops
Producción	https://api.defontana.com/api/sale/GetShops

Verbo HTTP: GET

Headers

Tipo	Valor	Requerido
Content-Type	“application/json”	Sí
Authorization	Token de autenticación del usuario de Integración. Debe ingresarse con el siguiente formato “bearer TOKEN”	Sí

Parámetros

Campo	Descripción	Requerido
code	Identificador del local de venta	No
ItemsPerPage	Cantidad de registros por página	Sí
PageNumber	Número de página	Sí

Respuesta

{
  "totalItems": 6,
  "pageNumber": 1,
  "itemsPerPage": 1,
  "shopList": [
    {
      "code": "000001",
      "description": "LOCAL01",
      "address": "DIRECCIÓN, 2000",
      "bussinessCode": "001001001001000",
      "storage": "BODEGACENTRAL"
    }
  ]
}

Permite obtener la información de los locales asociados a la empresa.

Ambientes

Ámbito	URL
Prueba	https://replapi.defontana.com/api/sale/GetStorages
Producción	https://api.defontana.com/api/sale/GetStorages

Verbo HTTP: GET

Headers

Tipo	Valor	Requerido
Content-Type	“application/json”	Sí
Authorization	Token de autenticación del usuario de Integración. Debe ingresarse con el siguiente formato “bearer TOKEN”	Sí

Parámetros

Campo	Descripción	Requerido
code	Identificador de la bodega.	No
ItemsPerPage	Cantidad de registros por página	Sí
PageNumber	Número de página.	Sí

Respuesta

{
  "totalItems": 22,
  "pageNumber": 1,
  "itemsPerPage": 1,
  "storageList": [
    {
      "code": "BODEGACENTRAL",
      "description": "BODEGA CENTRAL",
      "saleAvailable": "S",
      "active": "S"
    }
  ]
}

Permite obtener la información de los documentos configurados en la empresa.

Ambientes

Ámbito	URL
Prueba	https://replapi.defontana.com/api/sale/GetDocumentInfo
Producción	https://api.defontana.com/api/sale/GetDocumentInfo

Verbo HTTP: GET

Headers

Tipo	Valor	Requerido
Content-Type	“application/json”	Sí
Authorization	Token de autenticación del usuario de Integración. Debe ingresarse con el siguiente formato “bearer TOKEN”	Sí

Parámetros

Campo	Descripción	Requerido
code	Identificador de la bodega.	No
ItemsPerPage	Cantidad de registros por página.	Sí
PageNumber	Número de página.	Sí

Respuesta

{
  "totalItems": 37,
  "pageNumber": 1,
  "itemsPerPage": 1,
  "documentList": [
    {
      "code": "BVTAFEC",
      "electronicCode": "35",
      "name": "BOLETA DE VENTA AFECTA",
      "voucherInfo": "Vta_BVTAFEC"
    }
  ]
}

Permite obtener la información de centralización de los documentos configurados en la empresa.

Ambientes

Ámbito	URL
Prueba	https://replapi.defontana.com/api/sale/GetDocumentAnalysis
Producción	https://api.defontana.com/api/sale/GetDocumentAnalysis

Verbo HTTP: GET

Headers

Tipo	Valor	Requerido
Content-Type	“application/json”	Sí
Authorization	Token de autenticación del usuario de Integración. Debe ingresarse con el siguiente formato “bearer TOKEN”	Sí

Parámetros

Campo	Descripción	Requerido
code	Identificador de la bodega.	No
ItemsPerPage	Cantidad de registros por página.	Sí
PageNumber	Número de página.	Sí

Respuesta

{
  "totalItems": 18,
  "pageNumber": 1,
  "itemsPerPage": 1,
  "documentList": [
  {
    "documentId": "BVTAFEC",
    "analysisDetail": [
    {
      "analysisType": "CLT",
      "analysisCode": "Unico",
      "accountNumber": "1212121221",
      "unico": "S"
    },
    {
      "analysisType": "IMP",
      "analysisCode": "IVA",
      "accountNumber": "1313131313",
      "unico": "N"
    },
    {
      "analysisType": "VTA",
      "analysisCode": "Unico",
      "accountNumber": "1414141414",
      "unico": "S"
    }
  ]
}

Permite consultar el id del distrito (Comuna) del cliente para el posterior guardado del mismo.

Ambientes

Ámbito	URL
Prueba	https://replapi.defontana.com/api/sale/GetDistricts
Producción	https://api.defontana.com/api/sale/GetDistricts

Verbo HTTP: GET

Headers

Tipo	Valor	Requerido
Content-Type	“application/json”	Sí
Authorization	Token de autenticación del usuario de Integración. Debe ingresarse con el siguiente formato “bearer TOKEN”	Sí

Parámetros

Campo	Descripción	Requerido
State	Indica la región del cliente	No

Respuesta

{
  "totalItems": 1,
  "districtList": [
    {
      "country": "CL",
      "stateListDetail": [
      {
        "stateName": "I REGION DE TARAPACA",
        "districtListDetail": [
        {
          "districtCode": "CAMINA",
          "districtName": "CAMINA"
        },
        {
          "districtCode": "COLCHANE",
          "districtName": "COLCHANE"
        }, 
        …
        {
          "districtCode": "POZO ALMONTE",
          "districtName": "POZO ALMONTE"
        }
      ]
    }
  ]
}
]
}

Permite insertar un movimiento de ventas para una empresa.

Ambientes

Ámbito	URL
Prueba	https://replapi.defontana.com/api/sale/SaveSale
Producción	https://api.defontana.com/api/sale/SaveSale

Verbo HTTP: POST

Headers

Tipo	Valor	Requerido
Content-Type	“application/json”	Sí
Authorization	Token de autenticación del usuario de Integración. Debe ingresarse con el siguiente formato “bearer TOKEN”	Sí

Parámetros

Campo	Descripción	Requerido
documentType	Indica el identificador del tipo de documento	Sí
firstFolio	Indica el folio del documento, al ser electrónico debe ingresarse con valor 0 ya que es automático	Sí
lastFolio	Indica el último folio a utilizar, al ser electrónico debe ingresarse con valor 0 ya que es automático.	Sí
emissionDate	Indica la fecha de emisión del documento bajo el siguiente formato: "emissionDate": { "day": 0, "month": 0, "year": 0 },	Sí
firstFeePaid	Indica la fecha del primer pago del documento bajo el siguiente formato: " firstFeePaid ": { "day": 0, "month": 0, "year": 0 },	Sí
clientFile	Indica el rut del cliente.	Sí
contactIndex	Indica la dirección del cliente.	Sí
paymentCondition	Indica la condición de pago	Sí
sellerFileId	Indica el identificador del vendedor	Sí
clientAnalysis	Análisis por cliente bajo el siguiente formato: "clientAnalysis": { "accountNumber": "1110401001", "businessCenter": "", "classifier01": "", "classifier02": "" },	Sí
saleAnalysis	Análisis por venta bajo el siguiente formato: "saleAnalysis": { "accountNumber": "1110401001", "businessCenter": "", "classifier01": "", "classifier02": "" },	Sí
billingCoin	Indica la moneda de ingreso	Sí
billingRate	Indica la taza de monda de ingreso (PESO = 1)	Sí
shopId	Indica el identificador del local de venta	Sí
priceList	Indica la lista de precio.	Sí
giro	Indica el giro del documento	Sí
district	Indica el distrito	Sí
contact	Indica el contacto	Sí
attachedDocuments	Indica los documentos asociados bajo el siguiente formato: "attachedDocuments": [ { "date": { "day": 10, "month": 4, "year": 2020 }, "documentTypeId": "801", "folio": "135", "reason": "Orden de compra" } ],	No
storage	Indica la bodega de venta para la rebaja de inventario bajo el siguiente formato: "storage": { "code": "BODEGACENTRAL", "motive": "MOTIVO DE VENTA", "storageAnalysis": { "accountNumber": "4110101001", "businessCenter": "", "classifier01": "", "classifier02": "" } },	Sí
details	Indica los detalles de la venta bajo el siguiente formato: "details": [ { "type": "A", "code": "10001TIBL001", "count": 1, "productName": "PRODUCTO", "productNameBarCode": "PRODUCTO01", "price": 1000, "unit": "UN", "analysis": { "accountNumber": "1110401001", "businessCenter": "", "classifier01": "", "classifier02": "" } }	Sí
saleTaxes	Indica los impuestos asociados a la venta bajo el siguiente formato: "saleTaxes": [ { "code": "IVA", "value": 19 } ],	Sí
ventaRecDesGlobal	Indica los recargos y/o descuentos globales de la venta bajo el siguiente formato: "ventaRecDesGlobal": [ { "amount": 0, "modifierClass": "PV", "name": "string", "percentage": 0, "value": 0 } ],	Sí
gloss	Indica la glosa o comentario del documento	Sí
isTransferDocument	Indica si es un documento de traspaso o no (true/false). Si el valor se envía como “true”, el documento ingresado no será enviado al SII, sino que solamente se almacenará en el ERP	Sí

Respuesta

{
  "firstFolio": 130,
  "lastFolio": 0,
  "success": true,
  "message": "Documento guardado exitosamente"
}

Permite obtener la información una venta en específico.

Ambientes

Ámbito	URL
Prueba	https://replapi.defontana.com/api/sale/GetSale
Producción	https://api.defontana.com/api/sale/GetSale

Verbo HTTP: GET

Headers

Tipo	Valor	Requerido
Content-Type	“application/json”	Sí
Authorization	Token de autenticación del usuario de Integración. Debe ingresarse con el siguiente formato “bearer TOKEN”	Sí

Parámetros

Campo	Descripción	Requerido
documentType	Identificador del tipo de documento.	Sí
number	Folio del documento	Sí

Respuesta

[
{
  "documentType": "XFVAELECT",
  "firstFolio": 4359,
  "lastFolio": 0,
  "emissionDate": "2020-05-25T00:00:00",
  "clientFile": "11.111.111-1",
  "contactIndex": "Mariano Sánchez Fontecilla 348",
  "paymentCondition": "CONTADO",
  "sellerFileId": "VENDEDOR",
  "billingCoin": "PESO",
  "billingRate": 1,
  "shopId": "Local",
  "priceList": "1",
  "giro": "PARTICULAR",
  "district": "DISTRITO",
  "contact": 1,
  "attachedDocuments": [],
  "details": [
    {
      "detailLine": 1,
      "type": "A",
      "code": "10001TIBL001",
      "count": 1,
      "price": 1000,
      "discountType": "M",
      "discountValue": 0,
      "analysis": "Unico",
      "total": 1000,
      "priceList": 17000
    },
    {
      "detailLine": 2,
      "type": "A",
      "code": "10001TIBL001",
      "count": 2,
      "price": 1000,
      "discountType": "M",
      "discountValue": 0,
      "analysis": "Unico",
      "total": 2000,
      "priceList": 17000
    }
    ],
      "gloss": "GLOSA",
      "affectableTotal": 3000,
      "exemptTotal": 0,
      "taxeCode": "IVA",
      "taxeValue": 570,
      "total": 3570,
      "voucherInfo": [
    {
      "folio": 4359,
      "year": "2020",
      "type": "Vta_XFVAELECT"
    }
    ],
      "isTransferDocument": "N"
  }
]

Permite obtener la información de las ventas por un periodo de tiempo.

Ambientes

Ámbito	URL
Prueba	https://replapi.defontana.com/api/sale/GetSale
Producción	https://api.defontana.com/api/sale/GetSale

Verbo HTTP: GET

Headers

Tipo	Valor	Requerido
Content-Type	“application/json”	Sí
Authorization	Token de autenticación del usuario de Integración. Debe ingresarse con el siguiente formato “bearer TOKEN”	Sí

Parámetros

Campo	Descripción	Requerido
initialDate	Fecha inicial de búsqueda (yyyy-mm-dd)	Sí
endingDate	Fecha final de búsqueda (yyyy-mm-dd)	Sí
documentType	Tipo de documento	No
itemsPerPage	Cantidad de registros por página	Sí
pageNumber	Número de página.	Sí

Respuesta

{
  "totalItems": 521,
  "pageNumber": 1,
  "itemsPerPage": 1,
  "saleList": [
    {
      "documentType": "BOLETAVTAFEC",
      "firstFolio": 1159,
      "lastFolio": 0,
      "emissionDate": "2020-01-02T00:00:00",
      "clientFile": "11.111.111-1",
      "contactIndex": "DIRECCION 67",
      "paymentCondition": "CONTADO",
      "sellerFileId": "IDVENDEDOR",
      "billingCoin": "PESO",
      "billingRate": 1,
      "shopId": "IDLOCAL",
      "priceList": "3",
      "giro": "Particular",
      "district": "SANTIAGO",
      "contact": -1,
      "attachedDocuments": [
        {
          "date": "2019-10-16T00:00:00",
          "attachedDocumentType": "XBVTAFEC",
          "attachedDocumentName": "BOLETA ELECTRONICA",
          "attachedDocumentTotal": 35340,
          "documentTypeId": "NCBOLETAVTAFEC",
          "folio": 1159,
          "reason": null,
          "gloss": ""
        }
        ],
          "details": [
        {
          "detailLine": 1,
          "type": "A",
          "code": "11111",
          "count": 5,
          "price": 5590,
          "discountType": "P",
          "discountValue": 0,
          "analysis": "Unico",
          "total": 27950,
          "priceList": 5590
        }
        ],
          "gloss": "",
          "affectableTotal": 23487,
          "exemptTotal": 0,
          "taxeCode": "IVA",
          "taxeValue": 4463,
          "total": 27950,
          "voucherInfo": [
        {
          "folio": 1159,
          "year": "2020",
          "type": "Vta_NCBOLETAVTAFEC"
        }
      ],
      "isTransferDocument": "N"
    }
  ]
}

Permite la grabación de boletas o facturas simples

Condiciones Preliminares

Al ser una venta simplificada, es necesario que el usuario tenga configurados los siguientes parámetros en ERP:

Parámetro	Valor	Requerido
Vendedor	“VENDEDOR”	Sí
Local de venta	“LOCAL”	Sí
Bodega de stock	“BODEGACENTRAL”	Sí
Impuesto	“IVA”	Sí
Condición de pago	“CONTADO”	Si
Análisis del documento	“UNICO”	Sí
Moneda de ingreso	“PESO”	Sí
Tipo de documento	“XFVAELECT” “XBVTAFECT”	Sí

Headers

Tipo	Valor	Requeridos
Content-Type	“application/json”	Sí
Authorization	Token de autenticación del usuario de Integración. Debe ingresarse con el siguiente formato “bearer TOKEN”	Sí

Parámetros

Campo	Descripción	Requerido
electronicCode	Código electrónico del documento	Sí
firstFolio	Indica el folio del documento, al ser electrónico debe ingresarse con valor 0 ya que es automático	Sí
emissionDate	Indica la fecha de emisión del documento bajo el siguiente formato: "emissionDate": { "day": 0, "month": 0, "year": 0 },	Sí
clientFile	Indica el rut del cliente	Sí
district	Indica el distrito	Sí
details	Indica los detalles de la venta bajo el siguiente formato: "details": [ { "type": "A", "code": "10001TIBL001", "count": 1, "price": 1000, } ]	Sí
ventaRecDesGlobal	Indica los recargos y/o descuentos globales de la venta bajo el siguiente formato: "ventaRecDesGlobal": [ { "amount": 0, "modifierClass": "PV", "name": "string", "percentage": 0, "value": 0 } ],	Sí
gloss	Indica la glosa o comentario del documento	Sí
isTransferDocument	Indica si es un documento de traspaso o no (true/false). Si el valor se envía como “true”, el documento ingresado no será enviado al SII, sino que solamente se almacenará en el ERP	Sí

Respuesta

{
  "firstFolio": 130,
  "lastFolio": 0,
  "success": true,
  "message": "Documento guardado exitosamente"
}

Permite guardar una nota de crédito.

Ambientes

Ámbito	URL
Prueba	https://replapi.defontana.com/api/sale/SaveCreditNote
Producción	https://api.defontana.com/api/sale/SaveCreditNote

Verbo HTTP: POST

Headers

Tipo	Valor	Requerido
Content-Type	“application/json”	Sí
Authorization	Token de autenticación del usuario de Integración. Debe ingresarse con el siguiente formato “bearer TOKEN”	Sí

Parámetros

Campo	Descripción	Requerido
creditNoteTypeId	Indica el identificador del tipo de documento para la nota de crédito	Sí
documentType	Indica el identificador del tipo de documento a ser anulado	Sí
folio	Indica el folio del documento a ser anulado	Sí
gloss	Breve comentario sobre el documento	Sí
emissionDate	Indica la fecha de emisión del documento bajo el siguiente formato: "emissionDate": { "day": 0, "month": 0, "year": 0 },	Sí
isTransferDocument	Indica si es un documento de traspaso o no (true/false). Si el valor se envía como “true”, el documento ingresado no será enviado al SII, sino que solamente se almacenará en el ERP.	Sí

Respuesta

{
  "firstFolio": 130,
  "lastFolio": 0,
  "success": true,
  "message": "Documento guardado exitosamente"
}

Permite obtener la información de los locales asociados a la empresa.

Ambientes

Ámbito	URL
Pruebas	https://replapi.defontana.com/api/sale/GetPDFDocumentBase64
Producción	https://api.defontana.com/api/sale/GetPDFDocumentBase64

Verbo HTTP: GET

Headers

Tipo	Valor	Requerido
Content-Type	“application/json”	Sí
Authorization	Token de autenticación del usuario de Integración. Debe ingresarse con el siguiente formato “bearer TOKEN”	Sí

Parámetros

Campo	Descripción	Requerido
documentType	Identificador del local de venta.	Sí
folio	Cantidad de registros por página.	Sí

Respuesta

"document": "JVBERi0xLjINCg0KMyAwIG9iag0KPDwNCi9FIDIzNTIxDQovSCBbIDExNzAgMTU3IF0NCi
9MIDIzNzUzDQovTGluZWFyaXplZCAxDQovTiAxDQovTyA2DQovVCAyMzY0Mw0KPj4gICAgICAgICAgICAgI
CAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgDQplbmRv
YmoNCg0KeHJlZg0KMyAxMQ0KMDAwMDAwMDAxMiAwMDAwMCBuDQowMDAwMDAxMDQ3IDAwMDAwIG4NCjAwMDA
wMDExNzAgMDAwMDAgbg0KMDAwMDAwMTMyOCAwMDAwMCBuDQowMDAwMDAxNjIyIDAwMDAwIG4NCjAwMDAwMD
E3MzEgMDAwMDAgbg0KMDAwMDAwMTg0MyAwMDAwMCBuDQowMDAwMDAxOTUwIDAwMDAwIG4NCjAwMDAwMTM2M
TkgMDAwMDAgbg0KMDAwMDAxMzg4OCAwMDAwMCBuDQowMDAwMDIwNjQ5IDAwMDAwIG4NCnRyYWlsZXINCjw8
DQovQUJDcGR….}

Permite guardar una nueva lista de precios

Ambientes

Ámbito	URL
Pruebas	https://replapi.defontana.com/api/sale/SavePriceList
Producción	https://api.defontana.com/api/sale/SavePriceList

Verbo HTTP: POST

Headers

Tipo	Valor	Requerido
Content-Type	“application/json”	Sí
Authorization	Token de autenticación del usuario de Integración. Debe ingresarse con el siguiente formato “bearer TOKEN”	Sí

Parámetros

Campo	Descripción	Requerido
PriceListId	Identificador de la lista de precios	Sí
Description	Descripción de la lista de precios	Sí

Respuesta

{
  "success": true,
  "message": "Lista de precio 10 Guardada Exitosamente",
  "exceptionMessage": null
}

Permite agregar un artículo a una lista de precios

Ambientes

Ámbitos	URL
Prueba	https://replapi.defontana.com/api/sale/SaveProductPriceList
Producción	https://api.defontana.com/api/sale/SaveProductPriceList

Verbo HTTP: POST

Headers

Tipo	Valor	Requerido
Content-Type	“application/json”	Sí
Authorization	Token de autenticación del usuario de Integración. Debe ingresarse con el siguiente formato “bearer TOKEN”	Sí

Parámetros

Campo	Descripción	Requerido
PriceListInput	Información del producto a ingresar	Sí

Respuesta

{
  "success": true,
  "message": "Producto 10003TICS003 Guardado Exitosamente",
  "exceptionMessage": null
}

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

Ambientes

Ámbito	URL
Pruebas	https://replapi.defontana.com/api/Sale/GetServices
Producción	https://api.defontana.com/api/Sale/GetServices

Verbo HTTP: Get

Headers

Tipo	Valor	Requerido
Content-Type	“application/json”	Sí
Authorization	Token de autenticación del usuario de Integración. Debe ingresarse con el siguiente formato “bearer TOKEN”	Sí

Parámetros

Campo	Descripción	Requerido
Code	Código del servicio	No
Description	Descripción del servicio	No
itemPerPage	Registros por página	Sí
PageNumber	Número de página	Sí

Respuesta

{
  "totalItems": 38,
  "pageNumber": 1,
  "itemsPerPage": 1,
  "serviceList": [
    {
      "code": "1",
      "description": "SERVICIOS",
      "detailedDescription": null,
      "sellPrice": 0,
      "unit": "",
      "unitCost": 0,
      "useOT": null
    }
  ]
}

Permite generar una nota de crédito o débito para facturas de exportación

Ambientes

Ámbito	URL
Pruebas	https://replapi.defontana.com/api/Sale/SaveExportCreditNote
Producción	https://api.defontana.com/api/Sale/SaveExportCreditNote

Verbo HTTP: POST

Headers

Tipo	Valor	Requerido
Content-Type	“application/json“	Sí
Authorization	Token de autenticación del usuario de Integración. Debe ingresarse con el siguiente formato “bearer TOKEN”	Sí

Parámetros

Campo	Descipción	Requerido
		Sí

Respuesta

{
  "documentType": "string",
  "firstFolio": 0,
  "lastFolio": 0,
  "success": true,
  "message": "string",
  "exceptionMessage": "string"
}

Permite registrar un documento de exportación

Ambientes

Ámbito	URL
Pruebas	https://replapi.defontana.com/api/Sale/SaveExportSale
Producción	https://api.defontana.com/api/Sale/SaveExportSale

Verbo HTTP: POST

Headers

Tipo	Valor	Requerido
Content-Type	“application/json“	Sí
Authorization	Token de autenticación del usuario de Integración. Debe ingresarse con el siguiente formato “bearer TOKEN”	Sí

Parámetros

Campo	Descripción	Requerido
documentType		Sí
firstFolio		Sí
lastFolio
externalDocumentID
emissionDate	day, month, year
firstFeePaid	day, month, year
clientFile
clientInfo	fileID, name, address, city, district, giro, phone
contactIndex
paymentCondition
sellerFileId
clientAnalysis	accountNumber, businessCenter, classifier01, classifier02
saleAnalysis	accountNumber, businessCenter, classifier01, classifier02
billingCoin
billingRate
shopId
priceList
giro
district
contact
attachedDocuments	Date: day, month, year. documentTypeId, folio, reason
storage	code, motive. storageAnalysis: accountNumber, businessCenter, classifier01, classifier02
details	type, code, count, productName, productNameBarCode, comment, price, unit, analysis: accountNumber, businessCenter, classifier01, classifier02
ventaRecDesGlobal	amount, modifierClass, name, percentage, value
gloss
exportdata	destinationCountry, destinationMerchandise grossWeight: value, unit landingPort, package: value, unit paymentMethod, saleClause, saleMode, serviceIndicator, shipmentPort tareMeasure: value, unit totalClause, transportWay weight: value, unit
isTransferDocument	Si corresponde a un movimiento de traspaso	No

Respuesta

{
  "documentType": "string",
  "firstFolio": 0,
  "lastFolio": 0,
  "success": true,
  "message": "string",
  "exceptionMessage": "string"
}

Permite ingresar notas de crédito de anulación sin centralización

Ambientes

Ámbito	URL
Pruebas	https://replapi.defontana.com/api/Sale/SaveCreditNoteSkipCentralization
Producción	https://api.defontana.com/api/Sale/SaveCreditNoteSkipCentralization

Verbo HTTP: POST

Headers

Tipo	Valor	Requerido
Content-Type	“application/json“	Sí
Authorization	Token de autenticación del usuario de Integración. Debe ingresarse con el siguiente formato “bearer TOKEN”	Sí

Parámetros

Campo	Descripción	Requerido
creditNoteTypeId	Código del documento	Sí
documentType	Tipo de documento	Sí
folio	Número del documento	Sí
externalDocumentID	Identificador del documento de referencia	Sí
gloss	Glosa	Sí
emissionDate	Fecha de emisióndel documento	Sí
isTransferDocument	Es un documento de transferencia, S o N	No

Respuesta

{
  "documentType": "string",
  "firstFolio": 0,
  "lastFolio": 0,
  "success": true,
  "message": "string",
  "exceptionMessage": "string"
}

Permite actualizar un producto

Ambientes

Ámbitos	URL
Pruebas	https://replapi.defontana.com/api/Sale/UpdateProduct
Producción	https://api.defontana.com/api/Sale/UpdateProduct

Verbo HTTP: GET

Headers

Tipo	Valor	Requerido
Content-Type	“application/json”	Sí
Authorization	Token de autenticación del usuario de Integración. Debe ingresarse con el siguiente formato “bearer TOKEN”	Sí

Parámetros

Campo	Descripción	Requerido
code	Código del artículo o servicio	Sí
externalCode	Código externo del artículo o servicio	No
internalCode	Código interno del artículo o servicio	No
name	Nombre del artículo o servicio	No
unit	Unidad de medida del artículo o servicio	No
price	Precio unitario del artículo o servicio	No
description	Descripción del artículo o servicio	No
isService	Si corresponde a un servicio, S o N	Sí

Respuesta

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

Permite guardar un producto con el código externo e interno

Ambientes

Ámbito	URL
Pruebas	https://replapi.defontana.com/api/Sale/SaveProductExtended
Producción	https://api.defontana.com/api/Sale/SaveProductExtended

Verbo HTTP: POST

Headers

Tipo	Valor	Requerido
Content-Type	“application/json”	Sí
Authorization	Token de autenticación del usuario de Integración. Debe ingresarse con el siguiente formato “bearer TOKEN”	Sí

Parámetros

Campo	Descripción	Requerido
Code	Código del artículo/servicio	Sí
ExternalCode	Código externo del artículo/servicio	Sí
InternalCode	Código interno del artículo/servicio	Sí
Name	Nombre breve del artículo/servicio	Sí
Price	Precio del artículo/servicio	Sí
Description	Nombre largo o descriptivo del artículo/servicio	No
isService	Si corresponde a un servicio, S o N o Vacío	No

Respuestas

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

Permite dejar inactivo un artículo o servicio

Ambientes

Ámbito	URL
Pruebas	https://replapi.defontana.com/api/Sale/RemoveProduct
Producción	https://api.defontana.com/api/Sale/RemoveProduct

Verbo HTTP: POST

Headers

Tipo	Valor	Requerido
Content-Type	“application/json”	Sí
Authorization	Token de autenticación del usuario de Integración. Debe ingresarse con el siguiente formato “bearer TOKEN”	Sí

Parámetros

Campo	Descripción	Requerido
code	Código del artículo o servicio	Sí
isService	Si corresponde a un servicio, S o N	Sí

Respuesta

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

Permite la consulta de multiples articulos mediante su codigo de barra.

Ambientes

Ámbito	URL
Pruebas	https://replapi.defontana.com/api/Sale/GetProductsPOSByBarCode
Producción	https://api.defontana.com/api/Sale/GetProductsPOSByBarCode

Verbo HTTP: POST

Headers

Tipo	Valor	Requerido
Content-Type	“application/json”	Sí
Authorization	Token de autenticación del usuario de Integración. Debe ingresarse con el siguiente formato “bearer TOKEN”	Sí

Parámetros

Campo	Descripción	Requerido
code	Código del producto	Sí

Respuesta

{
  "success": true,
  "message": "string",
  "totalItems": 0,
  "pageNumber": 0,
  "itemsPerPage": 0,
  "productList": [
    {
      "active": "string",
      "code": "string",
      "externalCode": "string",
      "internalCode": "string",
      "name": "string",
      "detailedDescription": "string",
      "companyID": "string",
      "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
        }
      ]
    }
  ]
}

Permite la consulta de múltiples productos mediante su código.

Ambientes

Ámbito	URL
Pruebas	https://replapi.defontana.com/api/Sale/GetProductsPOSByCode
Producción	https://api.defontana.com/api/Sale/GetProductsPOSByCode

Verbo HTTP: POST

Headers

Tipo	Valor	Requerido
Content-Type	“application/json”	Sí
Authorization	Token de autenticación del usuario de Integración. Debe ingresarse con el siguiente formato “bearer TOKEN”	Sí

Parámetros

Campo	Descripción	Requerido
code	Código del producto	Sí

Respuesta

{
  "success": true,
  "message": "string",
  "totalItems": 0,
  "pageNumber": 0,
  "itemsPerPage": 0,
  "productList": [
    {
      "active": "string",
      "code": "string",
      "externalCode": "string",
      "internalCode": "string",
      "name": "string",
      "detailedDescription": "string",
      "companyID": "string",
      "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
        }
      ]
    }
  ]
}

Permite obtener el último folio utilizado

Ambientes

Ámbito	URL
Pruebas	https://replapi.defontana.com/api/Sale/GetLastUsedFolio
Producción	https://api.defontana.com/api/Sale/GetLastUsedFolio

Verbo HTTP: GET

Headers

Tipo	Valor	Requerido
Content-Type	“application/json”	Sí
Authorization	Token de autenticación del usuario de Integración. Debe ingresarse con el siguiente formato “bearer TOKEN”	Sí

Parámetros

Campo	Descripción	Requerido
documentType	Código del tipo de documento	Sí

Respuesta

{
  "success": true,
  "documentType": "string",
  "electronicCode": "string",
  "folio": 0,
  "message": "string",
  "exceptionMessage": "string"
}

Permite guardar una nota de débito de Ventas

Ambientes

Ámbito	URL
Pruebas	https://replapi.defontana.com/api/Sale/SaveDebitNote
Producción	https://api.defontana.com/api/Sale/SaveDebitNote

Verbo HTTP: POST

Headers

Tipo	Valor	Requerido
Content-Type	“application/json”	Sí
Authorization	Token de autenticación del usuario de Integración. Debe ingresarse con el siguiente formato “bearer TOKEN”	Sí

Parámetros

Campo	Descripción	Requerido
debitNoteTypeId
debitNoteType
documentType
clientAnalysis	accountNumber, businessCenter, classifier01, classifier02
folio
gloss
emissionDate	day, month, year
details	type, isExempt, code, count, productName, productNameBarCode, price, unit, analysis: accountNumber, businessCenter, classifier01, classifier02
saleTaxes	code, value, taxeAnalysis: accountNumber, businessCenter, classifier01, classifier02
storage
code
motive
storageAnalysis	accountNumber, businessCenter, classifier01, classifier02
isTransferDocument

Respuesta

{
  "documentType": "string",
  "firstFolio": 0,
  "lastFolio": 0,
  "success": true,
  "message": "string",
  "exceptionMessage": "string"
}

Permite la consulta de un grupo de artículos divididos por su código

Ambientes

Ámbito	URL
Pruebas	https://replapi.defontana.com/api/Sale/GetProductsGroup
Producción	https://api.defontana.com/api/Sale/GetProductsGroup

Verbo HTTP: GET

Headers

Tipo	Valor	Requerido
Content-Type	“application/json”	Sí
Authorization	Token de autenticación del usuario de Integración. Debe ingresarse con el siguiente formato “bearer TOKEN”	Sí

Parámetros

Campo	Descripción	Requerido
code	Código del producto	Sí

Respuesta

{
  "success": true,
  "message": "string",
  "totalItems": 0,
  "pageNumber": 0,
  "itemsPerPage": 0,
  "productList": [
    {
      "active": "string",
      "code": "string",
      "externalCode": "string",
      "internalCode": "string",
      "name": "string",
      "detailedDescription": "string",
      "companyID": "string",
      "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
        }
      ]
    }
  ]
}

Permite la consulta de artículos para POS

Ambientes

Ámbito	URL
Pruebas	https://replapi.defontana.com/api/Sale/GetProductsPOS
Producción	https://api.defontana.com/api/Sale/GetProductsPOS

Verbo HTTP: Get

Headers

Tipo	Valor	Requerido
Content-Type	“application/json”	Sí
Authorization	Token de autenticación del usuario de Integración. Debe ingresarse con el siguiente formato “bearer TOKEN”	Sí

Parámetros

Campo	Descripción	Requerido
code	Código del producto	No
description	Descripción del producto	No
status	Estado del producto, S o N	Sí
itemsPerPage	Cantidad de resultados por página	Sí
pageNumber	Número de página	Sí

Respuesta

{
  "success": true,
  "message": "string",
  "totalItems": 0,
  "pageNumber": 0,
  "itemsPerPage": 0,
  "productList": [
    {
      "active": "string",
      "code": "string",
      "externalCode": "string",
      "internalCode": "string",
      "name": "string",
      "detailedDescription": "string",
      "companyID": "string",
      "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
        }
      ]
    }
  ]
}

Permite consultar las condiciones de pago que posee la empresa

Ambientes

Ámbito	URL
Prueba	https://replapi.defontana.com/api/Sale/GetPaymentConditions
Producción	https://api.defontana.com/api/Sale/GetPaymentConditions

Verbo HTTP: GET

Headers

Tipo	Valor	Requerido
Content-Type	“application/json”	Sí
Authorization	Token de autenticación del usuario de Integración. Debe ingresarse con el siguiente formato “bearer TOKEN”	Sí

Parámetros

(no aplica)

Respuesta

{
  "success": true,
  "message": "string",
  "exceptionMessage": "string",
  "items": [
    {
      "code": "string",
      "name": "string",
      "type": "string",
      "duesAmount": 0,
      "daysBetweenPayments": 0
    }
  ]
}

Permite consultar los impuestos que posee la empresa

Ambientes

Ámbito	URL
Pruebas	https://replapi.defontana.com/api/Sale/GetTaxes
Producción	https://api.defontana.com/api/Sale/GetTaxes

Verbo HTTP: GET

Headers

Tipo	Valor	Requerido
Content-Type	“application/json”	Sí
Authorization	Token de autenticación del usuario de Integración. Debe ingresarse con el siguiente formato “bearer TOKEN”	Sí

Parámetros

(no aplica)

Respuesta

{
  "success": true,
  "message": "string",
  "exceptionMessage": "string",
  "taxes": [
    {
      "code": "string",
      "name": "string",
      "value": 0,
      "type": "string",
      "isFixedValue": true
    }
  ]
}

Permite consultar los tipos de moneda, tasa de cambio y su fecha

Ambientes

Ámbito	URL
Pruebas	https://replapi.defontana.com/api/Sale/GetCoinsId
Producción	https://api.defontana.com/api/Sale/GetCoinsId

Verbo HTTP: GET

Headers

Tipo	Valor	Requerrido
Content-Type	“application/json”	Sí
Authorization	Token de autenticación del usuario de Integración. Debe ingresarse con el siguiente formato “bearer TOKEN”	Sí

Parámetros

Campo	Descripción	Requerido
coinId	Identificador de la moneda	Sí
rateDate	Rango de fechas	No

Respuesta

{
  "totalItems": 0,
  "coinList": [
    {
      "coinID": "string",
      "name": "string",
      "rateList": [
        {
          "rate": 0,
          "date": "2021-04-09T14:05:32.615Z"
        }
      ]
    }
  ]
}

Permite obtener el listado de lista de precios asociadas a la empresa

Ambientes

Ámbito	URL
Pruebas	https://replapi.defontana.com/api/Sale/GetPriceList
Producción	https://api.defontana.com/api/Sale/GetPriceList

Verbo HTTP: GET

Headers

Tipo	Valor	Requerido
Content-Type	“application/json”	Sí
Authorization	Token de autenticación del usuario de Integración. Debe ingresarse con el siguiente formato “bearer TOKEN”	Sí

Parámetros

Campo	Descripción	Requerido
PriceListId	Código de la lista de precio	Sí
itemsPerPage	Ítemes por página	Sí
pageNumber	Número de página	Sí

Respuesta

{
  "totalItems": 0,
  "pageNumber": 0,
  "itemsPerPage": 0,
  "priceList": [
    {
      "priceListID": 0,
      "description": "string"
    }
  ]
}

Permite obtener los productos y sus precios de una lista de precios en especifico

Ambientes

Ámbito	URL
Pruebas	https://replapi.defontana.com/api/Sale/GetPriceListDetail
Producción	https://api.defontana.com/api/Sale/GetPriceListDetail

Verbo HTTP: GET

Headers

Tipo	Valor	Requerido
Content-Type	“application/json”	Sí
Authorization	Token de autenticación del usuario de Integración. Debe ingresarse con el siguiente formato “bearer TOKEN”	Sí

Parámetros

Campo	Descripción	Requerido
PriceListId	Código de la lista de precio	Sí
pagePerNumber	Ítemes por página	Sí
pageNumber	Número de página	Sí

Respuesta

{
  "totalItems": 0,
  "pageNumber": 0,
  "itemsPerPage": 0,
  "priceListID": 0,
  "priceListDetail": [
    {
      "productID": "string",
      "productPrice": 0
    }
  ]
}

Permite obtener un listado de los rubros

Ambientes

Ámbito	URL
Pruebas	https://replapi.defontana.com/api/Sale/GetRubro
Producción	https://api.defontana.com/api/Sale/GetRubro

Verbo HTTP: GET

Headers

Tipo	Valor	Requerido
Content-Type	“application/json”	Sí
Authorization	Token de autenticación del usuario de Integración. Debe ingresarse con el siguiente formato “bearer TOKEN”	Sí

Parámetros

Campo	Descripción	Requerido
rubroId	Código del rubro	Sí
itemsPerPage	Ítemes por página	Sí
pageNumber	Número de página	Sí

Respuesta

{
  "totalItems": 0,
  "pageNumber": 0,
  "itemsPerPage": 0,
  "success": true,
  "rubroList": [
    {
      "rubroID": 0,
      "description": "string",
      "subRubroList": [
        {
          "subRubroID": 0,
          "description": "string"
        }
      ]
    }
  ]
}

Permite activar un artículo o servicio

Ambientes

Ámbito	URL
Pruebas	https://replapi.defontana.com/api/Sale/ActivateProduct
Producción	https://api.defontana.com/api/Sale/ActivateProduct

Verbo HTTP: POST

Headers

Tipo	Valor	Requerido
Content-Type	“application/json”	Sí
Authorization	Token de autenticación del usuario de Integración. Debe ingresarse con el siguiente formato “bearer TOKEN”	Sí

Parámetros

(no aplica)

Respuesta

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

Permite obtener información sobre los campos personalizables de un tipo de documento.

Ambientes

Ámbito	URL
Pruebas	https://replapi.defontana.com/api/Sale/GetCustomFields
Producción	https://api.defontana.com/api/Sale/GetCustomFields

Headers

Tipo	Valor	Requerido
Content-Type	“application/json”	Sí
Authorization	Token de autenticación del usuario de Integración. Debe ingresarse con el siguiente formato “bearer TOKEN”	Sí

Parámetros

Campo	Descripción	Requerido
documentID	Código del tipo de documento	Sí

Respuesta

{
  "success": true,
  "message": "string",
  "documentID": "string",
  "customFieldList": [
    {
      "number": 0,
      "name": "string",
      "size": 0,
      "type": "string"
    }
  ]
}

Permite obtener las propiedades configurables de un producto

Ambientes

Ámbito	URL
Pruebas	https://replapi.defontana.com/api/Sale/GetProductProperties
Producción	https://api.defontana.com/api/Sale/GetProductProperties

Verbo HTTP: GET

Headers

Tipo	Valor	Requerido
Content-Type	“application/json”	Sí
Authorization	Token de autenticación del usuario de Integración. Debe ingresarse con el siguiente formato “bearer TOKEN”	Sí

Parámetros

Campo	Descripción	Requerido
Code	Código del producto	No
Description	Descripción del producto	No
Status	Estado del producto, valores 0, 1 y 2	Sí
itemsPerPage	Cantidad de elementos por página (máximo 100)	Sí
PageNumber	Número de página	Sí

Respuesta

{
  "success": true,
  "message": "string",
  "totalItems": 0,
  "pageNumber": 0,
  "itemsPerPage": 0,URL
  "productList": [
    {
      "code": "string",
      "productPropierties": [
        {
          "className": "string",
          "classValue": "string"
        }
      ]
    }
  ]
}

Permite obtener los productos por categoría registrados en la empresa

Ambientes

Ámbito	URL
Pruebas	https://replapi.defontana.com/api/Sale/GetProductsByCategory
Producción	https://api.defontana.com/api/Sale/GetProductsByCategory

Verbo HTTP: GET

Headers

Tipo	Valor	Requerido
Content-Type	“application/json”	Sí
Authorization	Token de autenticación del usuario de Integración. Debe ingresarse con el siguiente formato “bearer TOKEN”	Sí

Parámetros

Campo	Descripción	Requerido
categoryID	Identificador de la categoría	Sí
itemsPertPage	Cantidad de elementos por página (máximo 100)	Sí
PageNumber	Número de página	Sí

Respuesta

{
  "success": true,
  "message": "string",
  "totalItems": 0,
  "pageNumber": 0,
  "itemsPerPage": 0,
  "categoryID": "string",
  "productList": [
    {
      "active": "string",
      "code": "string",
      "externalCode": "string",
      "internalCode": "string",
      "name": "string"
    }
  ]
}

Obtiene la información de los clientes asociados a la empresa con el filtro por ID de ficha.

Ambientes

Ámbito	URL
Pruebas	https://replapi.defontana.com/api/Sale/GetClientsByFileID
Producción	https://api.defontana.com/api/Sale/GetClientsByFileID

Verbo HTTP: GET

Headers

Tipo	Valor	Requerido
Content-Type	“application/json”	Sí
Authorization	Token de autenticación del usuario de Integración. Debe ingresarse con el siguiente formato “bearer TOKEN”	Sí

Parámetros

Campo	Descripción	Requerido
fileID	Código de la ficha	No
description	Nombre de la ficha	No
status	Estado de la ficha, valores 0, 1, 2	Sí
itemsPerPage	Registros por página	Sí
PageNumber	Número de página	Sí

Respuesta

{
  "success": true,
  "message": "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",
      "customFields": [
        {
          "classDescription": "string",
          "classValue": "string"
        }
      ]
    }
  ]
}

Permite activar un cliente de la empresa

Ambientes

Ámbito	URL
Pruebas	https://replapi.defontana.com/api/Sale/ActivateClient
Producción	https://api.defontana.com/api/Sale/ActivateClient

Verbo HTTP: GET

Headers

Tipo	Valor	Requerido
Content-Type	“application/json”	Sí
Authorization	Token de autenticación del usuario de Integración. Debe ingresarse con el siguiente formato “bearer TOKEN”	Sí

Parámetros

Campo	Descripción	Requerido
FileID	Identificador del cliente	Sí

Respuesta

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

Permite eliminar un cliente

Ambientes

Ámbito	URL
Pruebas	https://replapi.defontana.com/api/Sale/RemoveClient
Producción	https://api.defontana.com/api/Sale/RemoveClient

Verbo HTTP: GET

Headers

Tipo	Valor	Requerido
Content-Type	“application/json”	Sí
Authorization	Token de autenticación del usuario de Integración. Debe ingresarse con el siguiente formato “bearer TOKEN”	Sí

Parámetros

Campo	Descripción	Requerido
ClientID	ID de Ficha del Cliente	Sí

Respuesta

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

Permite obtener el código de los productos y stock asociados a una bodega.

Ambientes

Ámbito	URL
Pruebas	https://replapi.defontana.com/api/Sale/GetStorageStock
Producción	https://api.defontana.com/api/Sale/GetStorageStock

Verbo HTTP: GET

Headers

Tipo	Valor	Requerido
Content-Type	“application/json”	Sí
Authorization	Token de autenticación del usuario de Integración. Debe ingresarse con el siguiente formato “bearer TOKEN”	Sí

Parámetros

Campo	Descripción	Requerido
storageID	Código de la bodega a consultar	Sí
itemsPerPage	Registros por página	Sí
pageNumber	Número de página	Sí

Respuesta

{
  "success": true,
  "message": "string",
  "exceptionMessage": "string",
  "totalItems": 0,
  "pageNumber": 0,
  "itemsPerPage": 0,
  "productList": [
    {
      "productID": "string",
      "active": "string",
      "stock": 0,
      "priceListDetail": [
        {
          "priceList": {
            "companyID": "string",
            "priceListID": 0,
            "description": "string",
            "factor": 0,
            "range": 0
          },
          "priceListID": 0,
          "productID": "string",
          "unitPrice": 0
        }
      ]
    }
  ]
}

Permite obtener las familias de categorías Legacy de artículos

Ambientes

Ámbito	URL
Pruebas	https://replapi.defontana.com/api/Sale/GetLegacyCategories
Producción	https://api.defontana.com/api/Sale/GetLegacyCategories

Verbo HTTP: GET

Headers

Tipo	Valor	Requerido
Content-Type	“application/json”	Sí
Authorization	Token de autenticación del usuario de Integración. Debe ingresarse con el siguiente formato “bearer TOKEN”	Sí

Parámetros

Respuesta

Permite obtener las categorías registradas de una empresa

Ambientes

Ámbito	URL
Pruebas	https://replapi.defontana.com/api/Sale/GetCategories
Producción	https://api.defontana.com/api/Sale/GetCategories

Verbo HTTP: GET

Headers

Tipo	Valor	Requerido
Content-Type	“application/json”	Sí
Authorization	Token de autenticación del usuario de Integración. Debe ingresarse con el siguiente formato “bearer TOKEN”	Sí

Parámetros

Campo	Descripción	Requerido
itemsPerPage	Registros por página	Sí
pageNumber	Número de página	Sí

Respuesta

{
  "success": true,
  "message": "string",
  "exceptionMessage": "string",
  "itemsPerPage": 0,
  "pageNumber": 0,
  "totalItems": 0,
  "categoriesList": [
    {
      "categoryID": 0,
      "description": "string",
      "subCategories": [
        {
          "subCategoryID": 0,
          "description": "string"
        }
      ]
    }
  ]
}

Permite obtener los productos por categoría registrados en la empresa

Ambientes

Ámbito	URL
Pruebas	https://replapi.defontana.com/api/Sale/GetProductsByCategory
Producción	https://api.defontana.com/api/Sale/GetProductsByCategory

Verbo HTTP:

Headers

Tipo	Valor	Requerido
Content-Type	“application/json”
Authorization	Token de autenticación del usuario de Integración. Debe ingresarse con el siguiente formato “bearer TOKEN”	Sí

Parámetros

Respuesta

Permite obtener un documento de venta en base a un documento asociado a la misma

Ambientes

Ámbito	URL
Pruebas	https://replapi.defontana.com/api/Sale/GetSaleByAssociatedDocument
Producción	https://api.defontana.com/api/Sale/GetSaleByAssociatedDocument

Verbo HTTP:

Headers

Tipo	Valor	Requerido
Content-Type	“application/json”
Authorization	Token de autenticación del usuario de Integración. Debe ingresarse con el siguiente formato “bearer TOKEN”	Sí

Parámetros

Campo	Descripción	Requerido
associatedDocumentType	Código de tipo de documento asociado (52 = guía de despacho electrónica, 801 = orden de compra, 802 = pedido, etc.)	Sí
number	Número de documento asociado	Sí

Respuesta

{
  "success": true,
  "message": "string",
  "exceptionMessage": "string",
  "sale": {
    "documentType": "string",
    "firstFolio": 0,
    "lastFolio": 0,
    "status": "string",
    "emissionDate": "2021-12-21T19:41:49.073Z",
    "dateTime": "2021-12-21T19:41:49.073Z",
    "expirationDate": "2021-12-21T19:41:49.073Z",
    "clientFile": "string",
    "contactIndex": "string",
    "paymentCondition": "string",
    "sellerFileId": "string",
    "billingCoin": "string",
    "billingRate": 0,
    "shopId": "string",
    "priceList": "string",
    "giro": "string",
    "city": "string",
    "district": "string",
    "contact": 0,
    "attachedDocuments": [
      {
        "date": "2021-12-21T19:41:49.073Z",
        "attachedDocumentType": "string",
        "attachedDocumentName": "string",
        "attachedDocumentNumber": "string",
        "attachedDocumentTotal": 0,
        "documentTypeId": "string",
        "folio": 0,
        "reason": "string",
        "gloss": "string"
      }
    ],
    "details": [
      {
        "detailLine": 0,
        "type": "string",
        "code": "string",
        "count": 0,
        "price": 0,
        "isExempt": "string",
        "discountType": "string",
        "discountValue": 0,
        "analysis": "string",
        "total": 0,
        "priceList": 0,
        "infAnalysis": {
          "accountNumber": "string",
          "businessCenter": "string",
          "classifier01": "string",
          "classifier02": "string"
        }
      }
    ],
    "gloss": "string",
    "affectableTotal": 0,
    "exemptTotal": 0,
    "taxeCode": "string",
    "taxeValue": 0,
    "documentTaxes": [
      {
        "taxeCode1": "string",
        "taxePercentaje1": 0,
        "taxeValue1": 0,
        "taxeCode2": "string",
        "taxePercentaje2": 0,
        "taxeValue2": 0,
        "taxeCode3": "string",
        "taxePercentaje3": 0,
        "taxeValue3": 0,
        "taxeCode4": "string",
        "taxePercentaje4": 0,
        "taxeValue4": 0,
        "taxeCode5": "string",
        "taxePercentaje5": 0,
        "taxeValue5": 0
      }
    ],
    "ventaRecDesGlobal": [
      {
        "amount": 0,
        "modifierClass": "string",
        "name": "string",
        "percentage": 0,
        "value": 0
      }
    ],
    "total": 0,
    "voucherInfo": [
      {
        "folio": 0,
        "year": "string",
        "type": "string"
      }
    ],
    "inventoryInfo": [
      {
        "folio": 0,
        "fiscalYear": "string",
        "documentType": "string"
      }
    ],
    "customFields": [
      {
        "classDescription": "string",
        "classValue": "string"
      }
    ],
    "exportData": [
      {
        "exportBillingRate": 0,
        "exportBillingCoinID": "string",
        "totalExport": 0,
        "exemptExport": 0,
        "destinationCountry": "string",
        "destinationMerchandise": "string",
        "landingPort": "string",
        "saleClause": "string",
        "saleMode": "string",
        "shipmentPort": "string",
        "totalClause": 0,
        "transportWay": "string"
      }
    ],
    "isTransferDocument": "string",
    "timestamp": "2021-12-21T19:41:49.074Z"
  }
}

Permite obtener el costo vigente de un producto

Ambientes

Ámbito	URL
Pruebas	https://replapi.defontana.com/api/Sale/GetCurrentCost
Producción	https://api.defontana.com/api/Sale/GetCurrentCost

Verbo HTTP: GET

Headers

Tipo	Valor	Requerido
Content-Type	“application/json”	Sí
Authorization	Token de autenticación del usuario de Integración. Debe ingresarse con el siguiente formato “bearer TOKEN”	Sí

Parámetros

Campo	Descripción	Requerido
Code	Id de artículo a consultar	Sí
Date	Fecha en la que se quiere consultar el valor del costo vigente	Sí

Respuesta

{
  "success": true,
  "message": "string",
  "exceptionMessage": "string",
  "code": "string",
  "date": "2021-12-21T19:34:05.612Z",
  "cost": 0
}

Permite obtener costo de reposicion de un producto

Ambientes

Ámbito	URL
Pruebas	https://replapi.defontana.com/api/Sale/GetReplacementCost
Producción	https://api.defontana.com/api/Sale/GetReplacementCost

Verbo HTTP: GET

Headers

Tipo	Valor	Requerido
Content-Type	“application/json”	Sí
Authorization	Token de autenticación del usuario de Integración. Debe ingresarse con el siguiente formato “bearer TOKEN”	Sí

Parámetros

Campo	Descripción	Requerido
Code	Id de artículo a consultar	Sí

Respuesta

{
  "success": true,
  "message": "string",
  "exceptionMessage": "string",
  "replacementCost": 0,
  "code": "string"
}

Permite consultar los documentos asociados a una venta.

Ambientes

Ámbito	URL
Pruebas	https://replapi.defontana.com/api/Sale/GetAssociatedDocumentsBySale
Producción	https://api.defontana.com/api/Sale/GetAssociatedDocumentsBySale

Verbo HTTP: GET

Headers

Tipo	Valor	Requerido
Content-Type	“application/json”	Sí
Authorization	Token de autenticación del usuario de Integración. Debe ingresarse con el siguiente formato “bearer TOKEN”	Sí

Parámetros

Campo	Descripción	Requerido
documentType	Especifica el id del tipo de documento a consultar	Sí
number	Especifica el folio del documento a consultar	Sí

Respuesta

{
  "success": true,
  "message": "string",
  "exceptionMessage": "string",
  "saleList": [
    {
      "number": 0,
      "documentType": "string"
    }
  ]
}

PURCHASEORDER

Permite obtener un listado de órdenes de compra ingresadas al sistema

Ambientes

Ámbito	URL
Prueba	https://replapi.defontana.com/api/PurchaseOrder/List
Producción	https://api.defontana.com/api/PurchaseOrder/List

Verbo HTTP: GET

Headers

Tipo	Valor	Requerido
Content-Type	“application/json”	Sí
Authorization	Token de autenticación del usuario de Integración. Debe ingresarse con el siguiente formato “bearer TOKEN”	Sí

Parámetros

Campo	Descripción	Requerido
FromDate	Fecha mínima desde la que se desea filtrar resultados	Sí
ToDate	Fecha máxima hasta la que se desea filtrar resultados	Sí
ItemsPerPage	Cantidad de elementos por página (máximo 100)	Sí
Page	Página a consultar (comienza en 0)	Sí
ProviderNameOrLegalCode	Rut o nombre de proveedor	No
Status	0 = TODOS 1 = INGRESADO 2 = APROBADO 3 = PARCIALMENTE RECEPCIONADO 4 = COMPLETAMENTE RECEPCIONADO 5 = CERRADO 6 = ANULADO 7 = APROBADO o PARCIALMENTE RECEPCIONADO	No

Respuesta

{
  "data": [
    {
      "providerId": "string",
      "status": "string",
      "emissionDate": "2020-06-26T20:21:14.994Z",
      "totalLocalCurrency": "string",
      "totalEntryCurrency": "string",
      "documentSerie": "string",
      "number": 0,
      "providerName": "string",
      "providerLegalCode": "string"
    }
  ],
  "totalItems": 0,
  "page": 0,
  "itemsPerPage": 0,
  "success": true,
  "message": "string",
  "exceptionMessage": "string"
}

Permite obtener los datos en detalle de una orden de compra

Ambientes

Ámbito	URL
Prueba	https://replapi.defontana.com/api/PurchaseOrder/Get
Producción	https://api.defontana.com/api/PurchaseOrder/Get

Verbo HTTP: GET

Headers

Tipo	Valor	Requerido
Content-Type	“application/json”	Sí
Authorization	Token de autenticación del usuario de Integración. Debe ingresarse con el siguiente formato “bearer TOKEN”	Sí

Parámetros

Campo	Descripción	Requerido
Series	Serie de la Orden de Compra	No
Number	Número de la Orden de Compra	Sí

Respuesta

{
  "purchaseOrderData": {
    "dispatchState": "string",
    "dispatchDistrict": "string",
    "dispatchAddress": "string",
    "dispatchContact": "string",
    "approveState": "string",
    "billingState": "string",
    "receiptState": "string",
    "emissionState": "string",
    "amountTotalInputCurrency": 0,
    "taxesInputCurrency": 0,
    "modifiersInputCurrency": 0,
    "amoutExemptInputCurrency": 0,
    "amountBeforeTaxesInputCurrency": 0,
    "amountTotal": 0,
    "taxes": 0,
    "modifiers": 0,
    "amoutExempt": 0,
    "amountBeforeTaxes": 0,
    "exchangeRate": 0,
    "entryCurrencyData": {
      "id": "string",
      "description": "string",
      "entryDecimals": 0,
      "simbol": "string",
      "usesDecimals": true,
      "siiId": "string"
    },
    "comment": "string",
    "purchaseOrderDetail": [
      {
        "productId": "string",
        "quantity": 0,
        "receivedQuantity": 0,
        "amount": 0,
        "price": 0,
        "amountInputCurrency": 0,
        "comment": "string",
        "receivedAmount": 0,
        "line": 0,
        "discount": 0,
        "discountEntry": 0,
        "discountType": 0,
        "product": {
          "usesLotes": true,
          "usesSeries": true,
          "isArticle": true,
          "isService": true,
          "productId": "string",
          "description": "string",
          "purchaseCurrencyId": "string",
          "inventoryMeasureUnitId": "string",
          "isActive": true
        }
      }
    ],
    "businessCenterData": {
      "businessCenterId": "string",
      "name": "string"
    },
    "receiptDate": "2020-06-26T20:23:28.644Z",
    "expirationDate": "2020-06-26T20:23:28.644Z",
    "emissionDate": "2020-06-26T20:23:28.644Z",
    "providerInfo": {
      "phone": "string",
      "email": "string",
      "district": "string",
      "state": "string",
      "city": "string",
      "providerTypeId": "string",
      "country": "string",
      "businessDescription": "string",
      "name": "string",
      "legalCode": "string",
      "fileId": "string",
      "address": "string",
      "shopId": "string"
    },
    "number": 0,
    "series": "string",
    "dispatchCity": "string",
    "dispatchCountry": "string"
  },
  "success": true,
  "message": "string",
  "exceptionMessage": "string"
}

Permite ingresar un documento de recepción

Ambientes

Ámbito	URL
Prueba	https://replapi.defontana.com/api/PurchaseOrder/InsertReceptionDocument
Producción	https://api.defontana.com/api/PurchaseOrder/InsertReceptionDocument

Verbo HTTP: POST

Headers

Tipo	Valor	Requerido
Content-Type	“application/json”	Sí
Authorization	Token de autenticación del usuario de Integración. Debe ingresarse con el siguiente formato “bearer TOKEN”	Sí

Parámetros

Campo	Descripción	Requerido
providerId	Identificador del proveedor	Sí
purchaseOrderNumber	Número de la orden de compra	Sí
series	SErie de la orden de compra	No
storageCode	Código de barra	No
line	Número de la línea de detalle	Sí
productId	Identificador del producto	Sí
quantity	Cantidad	Sí
total	Total de la línea	Sí
isService	Si es servicio (S o N)	No

Obtiene la información de los proveedores asociados a la empresa

Ambientes

Ámbito	URL
Prueba	https://replapi.defontana.com/api/PurchaseOrder/GetProviders
Producción	https://api.defontana.com/api/PurchaseOrder/GetProviders

Verbo HTTP: GET

Headers

Tipo	Valor	Requerido
Content-Type	“application/json”	Sí
Authorization	Token de autenticación del usuario de Integración. Debe ingresarse con el siguiente formato “bearer TOKEN”	Sí

Parámetros

Campo	Descripción	Requerido
legalCode	Código legal	No
description	Descripción	No
status	Estado 0 = Todos 1 = Activos 2 = Inactivos	Sí
itemsPerPage	Registros por página	Sí
PageNumber	Número de página	Sí

Permite modificar el estado de una orden de compra

Ambientes

Ámbito	URL
Pruebas	https://replapi.defontana.com/api/PurchaseOrder/UpdateState
Producción	https://api.defontana.com/api/PurchaseOrder/UpdateState

Verbo HTTP: POST

Headers

Tipo	Valor	Requerido
Content-Type	“application/json”	Sí
Authorization	Token de autenticación del usuario de Integración. Debe ingresarse con el siguiente formato “bearer TOKEN”	Sí

Parámetros

Campo

Descripción

Requerido

Series

Serie de la OC

No

Number

Número de la OC

Sí

Status

Estado

2 = APROBADO
3 = PARCIALMENTE RECEPCIONADO
4 = COMPLETAMENTE RECEPCIONADO
5 = CERRADO
6 = ANULADO

Sí

Permite eliminar un proveedor

Ambientes

Ámbito	URL
Pruebas	https://replapi.defontana.com/api/PurchaseOrder/RemoveProvider
Producción	https://api.defontana.com/api/PurchaseOrder/RemoveProvider

Verbo HTTP: POST

Headers

Tipo	Valor	Requesito
Content-Type	“application/json”	Sí
Authorization	Token de autenticación del usuario de Integración. Debe ingresarse con el siguiente formato “bearer TOKEN”	Sí

Parámetros

Campo	Descripción	Requerido
code	Código del proveedor	Sí

Respuesta

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

Permite actualizar los datos de un proveedor

Ambientes

Ámbito	URL
Pruebas	https://replapi.defontana.com/api/PurchaseOrder/UpdateProvider
Producción	https://api.defontana.com/api/PurchaseOrder/UpdateProvider

Verbo HTTP: POST

Headers

Tipo	Valor	Requerido
Content-Type	“application/json”	Sí
Authorization	Token de autenticación del usuario de Integración. Debe ingresarse con el siguiente formato “bearer TOKEN”	Sí

Parámetros

Campo	Descripción	Requerido
legalCode	Código legal del proveedor	Sí
name	Nombre del proveedor	Sí
address	Dirección del proveedor	No
district	Comuna del proveedor	No
email	Email del proveedor	No
business	Negocio del proveedor	No
rubroId	Rubro del proveedor	No
giro	Giro del proveedor	No
city	Ciudad del proveedor	No
phone	Teléfono del proveedor	No

Respuesta

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

Permite guardar un proveedor

Ambientes

Ámbito	URL
Pruebas	https://replapi.defontana.com/api/PurchaseOrder/SaveProvider
Producción	https://api.defontana.com/api/PurchaseOrder/SaveProvider

Verbo HTTP: POST

Headers

Tipo	Valor	Requerido
Content-Type	“application/json”	Sí
Authorization	Token de autenticación del usuario de Integración. Debe ingresarse con el siguiente formato “bearer TOKEN”	Sí

Parámetros

Campo	Descripción	Requerido
legalCode	Código legal del proveedor	Sí
name	Nombre del proveedor	Sí
address	Dirección del proveedor	No
district	Comuna del proveedor	No
email	Email del proveedor	No
business	Negocio del proveedor	No
rubroId	Rubro del proveedor	No
giro	Giro del proveedor	No
city	Ciudad del proveedor	No
phone	Teléfono del proveedor	No

Respuesta

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

Permite insertar ordenes de compra

Ambientes

Ámbito	URL
Pruebas	https://replapi.defontana.com/api/PurchaseOrder/InsertPurchaseOrder
Producción	https://api.defontana.com/api/PurchaseOrder/InsertPurchaseOrder

Verbo HTTP: POST

Headers

Tipo	Valor	Requerido
Content-Type	“application-json“	Sí
Authorization	Token de autenticación del usuario de Integración. Debe ingresarse con el siguiente formato “bearer TOKEN”	Sí

Parámetros

(no aplica)

Respuesta

Permite obtener los documento de inventario asociados a una orden de compra.

Ambientes

Ámbito	URL
Pruebas	https://replapi.defontana.com/api/PurchaseOrder/GetReceptionDocuments
Producción	https://api.defontana.com/api/PurchaseOrder/GetReceptionDocuments

Headers

Tipo	Valor	Requerido
Content-Type	“application/json”	Sí
Authorization	Token de autenticación del usuario de Integración. Debe ingresarse con el siguiente formato “bearer TOKEN”	Sí

Parámetros

Campo	Descripción	Requerido
Number	Número de orden de compra	Sí

Respuesta

{
  "success": true,
  "message": "string",
  "exceptionMessage": "string",
  "receptionDocumentList": [
    {
      "receptionDocumentNumber": 0,
      "providerID": "string",
      "inventoryDocumentList": [
        {
          "numberDocInv": "string",
          "docTypeInv": "string",
          "storageID": "string",
          "fiscalYear": "string",
          "voucherType": "string",
          "voucherNumber": "string"
        }
      ]
    }
  ]
}

Obtiene la información de los proveedores asociados a la empresa con el filtro por ID de ficha

Ambientes

Ámbito	URL
Pruebas	https://replapi/PurchaseOrder/GetProvidersByFileID
Producción	https://api/PurchaseOrder/GetProvidersByFileID

Verbo HTTP: GET

Headers

Tipo	Valor	Requerido
Content-Type	“application-json“	Sí
Authorization	Token de autenticación del usuario de Integración. Debe ingresarse con el siguiente formato “bearer TOKEN”	Sí

Parámetros

Campo	Descripción	Requerido
FileID	Código de la ficha	No
Description	Nombre de la ficha	No
Status	Estado de la ficha (0=Todos, 1=Activos, 2=Inactivos)	Sí
ItemsPerPage	Registros por página	Sí
PageNumber	Número de página	Sí

Respuesta

{
  "success": true,
  "message": "string",
  "exceptionMessage": "string",
  "totalItems": 0,
  "pageNumber": 0,
  "itemsPerPage": 0,
  "providersList": [
    {
      "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"
    }
  ]
}

INVENTORY

Permite ingresar un documento de inventario

Ambientes

Ámbito	URL
Pruebas	https://replapi.defontana.com/api/Inventory/InsertDocument
Producción	https://api.defontana.com/api/Inventory/InsertDocument

Verbo HTTP: POST

Headers

Tipo	Valor	Requerido
Content-Type	“application-json“	Sí
Authorization	Token de autenticación del usuario de Integración. Debe ingresarse con el siguiente formato “bearer TOKEN”	Sí

Parámetros

Campo	Descripción	Requerido
total	Total del movimiento	Sí
gloss	Glosa del movimiento	No
dispatchAddress	Dirección de despacho	Sí
correlative	Correlativo del movimiento	Sí
order	Orden del movimiento	Sí
isNew	Corresponde a un producto nuevo, S o N	Sí
counterExistence	Contador de existencia	Sí
intType	Tipo de entero
from	Desde
integrate	Integrado
isCentralizable	Corresponde centralizar, S o N
isProgressDisabled	El progreso del movimiento está deshabilitado, S o N	Sí
isAutoCentralizable	Si corresponde su centralización automática, S o N	Sí
isFromEdit	Si el movimiento es editable, S o N	Sí
accountingDefinitionCode	El código de la cuenta contable correspondiente a la definición de centralización	Sí
analysis	businessCenter, clasifier1, clasifier2	Sí
referenceDocumentFolio	Folio del documento de referencia	No
serial	Serie del documento de referencia	No
userId	Identificador del usuario	No
clientId	Identificador del cliente	Sí
companyId	Identificador de la empresa	Sí
sessionId	Identificador la sesión
serviceId	Identificador del servicio
fiscalYear	Año fiscal del movimiento
referenceDocumentType	Código del tipo de documento de referencia
documentTypeId	Identificador del tipo de documento
providerId	identificador del proveedor
customerId	Identificador del cliente
originStowageId	Identificador del almacenamiento de origen
destinationStowageId	Identificador del almacenamiento de destino
reasonId	Identificador del motivo
date	Fecha del movimiento
folio	Folio del movimiento
details	lote, loteExpirationDate, lotes: batchNumber, amount, expirationDate
tasa	Tasa de la moneda del movimiento
coinId	Identificador del código
headerFileId
fileId
comment
attribute1
attribute2
attribute3
attribute4
attribute5
serialPrefix
serialSufix
serialStart
infAnCtaCtble
serials
analysis	{ "businessCenter": "string", "clasifier1": "string", "clasifier2": "string", "file": "string", "fileFieldName": "string" }
decimals
factor
count
height
articleId
receivedCount
dispatchedCount
unitaryCount
currentCost
balance
tasaDate
serviceProjectId
summary
analysisInfo	{ "businessCenter": "string", "clasifier1": "string", "clasifier2": "string", "file": "string", "fileFieldName": "string" }
workOrderNumber
serieOC
description
price
accountingDefinitionCode
tipoCentDet
destinationLocalization
originLocalization
length
width
orderNumber
properties

Respuesta

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

Permite obtener los datos de un documento de inventario

Ambientes

Ámbito	URL
Pruebas	https://replapi.defontana.com/api/Inventory/GetDocument
Producción	https://api.defontana.com/api/Inventory/GetDocument

Verbo HTTP: GET

Headers

Tipo	Valor	Requerido
Content-Type	“application-json“	Sí
Authorization	Token de autenticación del usuario de Integración. Debe ingresarse con el siguiente formato “bearer TOKEN”	Sí

Parámetros

Campo	Descripción	Requerido
DocumentTypeId	Código de tipo de documento a consultar	No
Folio	Número del documento a consultar	No
FiscalYear	Año fiscal del documento	No

Respuesta

{
  "stockLoadOutputData": {
    "details": [
      {
        "decimals": 0,
        "lote": "string",
        "loteExpirationDate": "string",
        "lotes": [
          {
            "batchNumber": "string",
            "amount": 0,
            "expirationDate": "2021-02-04T20:26:52.909Z"
          }
        ],
        "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": "2021-02-04T20:26:52.909Z",
        "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
      }
    ],
    "company": {
      "id": "string",
      "name": "string",
      "rut": "string",
      "phone": "string",
      "rubro": 0,
      "giro": "string",
      "address": "string",
      "usesOT": true,
      "usesLotes": true,
      "usesSerial": true,
      "resolutionNumber": 0,
      "usesDispatch": true,
      "usesTransferDocument": true,
      "usesOrder": true,
      "usesBarCode": "string"
    },
    "userId": "string",
    "documentTypeId": "string",
    "documentName": "string",
    "number": 0,
    "fiscalYear": "string",
    "correlative": 0,
    "moveType": "string",
    "adjustmentMovementType": "string",
    "affectsCost": true,
    "date": "2021-02-04T20:26:52.909Z",
    "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",
    "analysis": {
      "businessCenter": "string",
      "clasifier1": "string",
      "clasifier2": "string",
      "file": "string",
      "fileFieldName": "string"
    },
    "state": "string",
    "reversed": "string",
    "integrate": "string",
    "infoCentralization": {
      "existencia": "string",
      "contraExistencia": "string"
    }
  },
  "success": true,
  "message": "string",
  "exceptionMessage": "string"
}

Permite obtener un listado de documentos de inventario

Ambientes

Ámbito	URL
Pruebas	https://replapi.defontana.com/api/Inventory/List
Producción	https://api.defontana.com/api/Inventory/List

Verbo HTTP: POST

Headers

Tipo	Valor	Requerido
Content-Type	“application-json“	Sí
Authorization	Token de autenticación del usuario de Integración. Debe ingresarse con el siguiente formato “bearer TOKEN”	Sí

Parámetros

Campo	Descripción	Requerido
itemsPerPage	Cantidad de resultados por página	Sí
pageNumber	Número de la página	No
documentName	Nombre del documento	Sí
documentNumber	Número del documento	No
startDate	Fecha de inicio	No
finishDate	Fecha final	No

Respuesta

{
  "data": {
    "draw": 0,
    "recordsTotal": 0,
    "recordsFiltered": 0,
    "data": [
      {
        "folio": 0,
        "correlative": 0,
        "date": "string",
        "realDate": "2021-02-04T20:29:52.121Z",
        "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"
  },
  "success": true,
  "message": "string",
  "exceptionMessage": "string"
}

Permite obtener la información de los lotes de la empresa.

Ambientes

Ámbito	URL
Pruebas	https://replapi.defontana.com/api/Inventory/GetBatchesInfo
Producción	https://api.defontana.com/api/Inventory/GetBatchesInfo

Verbo HTTP: GET

Headers

Tipo	Valor	Requerido
Content-Type	“application/json”	Sí
Authorization	Token de autenticación del usuario de Integración. Debe ingresarse con el siguiente formato “bearer TOKEN”	Sí

Parámetros

Campo	Descripción	Requerido
batchNumber	Número de lote a consultar	Sí
productID	Código del artículo a consultar	Sí
storageID	Código de la bodega a consultar	Sí
itemsPerPage	Items por página	Sí
pageNumber	Número de página (inicia en 0)	Sí

Respuesta

{
  "success": true,
  "message": "string",
  "totalItems": 0,
  "pageNumber": 0,
  "itemsPerPage": 0,
  "productDetail": [
    {
      "active": "string",
      "code": "string",
      "externalCode": "string",
      "internalCode": "string",
      "name": "string",
      "detailedDescription": "string",
      "companyID": "string",
      "coinID": "string",
      "sellPrice": 0,
      "stock": 0,
      "type": "string",
      "unit": "string",
      "imptoAd": "string",
      "idImptoAd": "string",
      "usesLotes": true,
      "usesSeries": true,
      "storageDetail": [
        {
          "storageID": "string",
          "stock": 0,
          "batchDetail": [
            {
              "batchNumber": "string",
              "stock": 0,
              "expirationDate": "2021-04-12T16:33:36.133Z",
              "storageID": "string"
            }
          ]
        }
      ]
    }
  ]
}

Permite ingresar un documento de inventario (metodo simplificado)

Ambientes

Ámbito	URL
Pruebas	https://replapi.defontana.com/api/Inventory/Insert
Producción	https://api.defontana.com/api/Inventory/Insert

Verbo HTTP: PUT

Headers

Tipo	Valor	Requerido
Content-Type	“application/json”	Sí
Authorization	Token de autenticación del usuario de Integración. Debe ingresarse con el siguiente formato “bearer TOKEN”	Sí

Parámetros

(no aplica)

Respuesta

{
  "folio": 0,
  "documentTypeId": "string",
  "fiscalYear": "string",
  "clientId": "string",
  "providerId": "string",
  "gloss": "string",
  "originStowageId": "string",
  "destinationStowageId": "string",
  "reasonId": "string",
  "total": 0,
  "isCentralizable": true,
  "analysis": {
    "businessCenter": "string",
    "clasifier1": "string",
    "clasifier2": "string",
    "file": "string",
    "fileFieldName": "string"
  },
  "referenceDocumentFolio": 0,
  "referenceDocumentType": "string",
  "date": "2021-12-14T20:25:24.634Z",
  "externalDocumentID": "string",
  "details": [
    {
      "articleId": "string",
      "description": "string",
      "count": 0,
      "coinId": "string",
      "comment": "string",
      "price": 0,
      "serialPrefix": "string",
      "serialSufix": "string",
      "serialStart": "string",
      "serials": [
        "string"
      ],
      "lotes": [
        {
          "batchNumber": "string",
          "amount": 0,
          "expirationDate": "2021-12-14T20:25:24.634Z"
        }
      ],
      "analysis": {
        "businessCenter": "string",
        "clasifier1": "string",
        "clasifier2": "string",
        "file": "string",
        "fileFieldName": "string"
      },
      "ocDetails": {
        "number": 0,
        "serie": "string",
        "line": 0
      }
    }
  ]
}

Permite eliminar los datos de un documento de inventario

Ambientes

Ámbito	URL
Pruebas	https://replapi.defontana.com/api/Inventory/Delete
Producción	https://api.defontana.com/api/Inventory/Delete

Verbo HTTP: GET

Headers

Tipo	Valor	Requerido
Content-Type	“application/json”	Sí
Authorization	Token de autenticación del usuario de Integración. Debe ingresarse con el siguiente formato “bearer TOKEN”	Sí

Parámetros

Campo	Descripción	Requerido
DocumentTypeId	Código de tipo de documento	Sí
Folio	Número del documento a consultar	Sí
FiscalYear	Año fiscal del documento	Sí

Respuesta

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

Permite modificar un documento de inventario

Ambientes

Ámbito	URL
Pruebas	https://replapi.defontana.com/api/Inventory/UpdateDocument
Producción	https://api.defontana.com/api/Inventory/UpdateDocument

Verbo HTTP: POST

Headers

Tipo	Valor	Requerido
Content-Type	“application/json”	Sí
Authorization	Token de autenticación del usuario de Integración. Debe ingresarse con el siguiente formato “bearer TOKEN”	Sí

Parámetros

(no aplica)

Respuesta

{
  "folio": 0,
  "documentTypeId": "string",
  "fiscalYear": "string",
  "clientId": "string",
  "providerId": "string",
  "gloss": "string",
  "originStowageId": "string",
  "destinationStowageId": "string",
  "reasonId": "string",
  "total": 0,
  "isCentralizable": true,
  "analysis": {
    "businessCenter": "string",
    "clasifier1": "string",
    "clasifier2": "string",
    "file": "string",
    "fileFieldName": "string"
  },
  "referenceDocumentFolio": 0,
  "referenceDocumentType": "string",
  "date": "2021-12-15T12:46:29.357Z",
  "externalDocumentID": "string",
  "details": [
    {
      "articleId": "string",
      "description": "string",
      "count": 0,
      "comment": "string",
      "price": 0,
      "serialPrefix": "string",
      "serialSufix": "string",
      "serialStart": "string",
      "serials": [
        "string"
      ],
      "lotes": [
        {
          "batchNumber": "string",
          "amount": 0,
          "expirationDate": "2021-12-15T12:46:29.357Z"
        }
      ],
      "analysis": {
        "businessCenter": "string",
        "clasifier1": "string",
        "clasifier2": "string",
        "file": "string",
        "fileFieldName": "string"
      }
    }
  ]
}

Permite obtener los datos de un documento de inventario a través de su ID de documento externo

Ambientes

Ámbito	URL
Pruebas	https://replapi.defontana.com/api/Inventory/GetDocumentByExternalDocumentID
Producción	https://api.defontana.com/api/Inventory/GetDocumentByExternalDocumentID

Verbo HTTP: GET

Headers

Tipo	Valor	Requerido
Content-Type	“application/json”	Sí
Authorization	Token de autenticación del usuario de Integración. Debe ingresarse con el siguiente formato “bearer TOKEN”	Sí

Parámetros

Campo	Descripción	Requerido
ExternalDocumentID	ID de documento externo a consultar	Sí

Respuesta

{
  "success": true,
  "message": "string",
  "exceptionMessage": "string",
  "stockLoadOutputData": {
    "company": {
      "id": "string",
      "name": "string",
      "rut": "string",
      "phone": "string",
      "rubro": 0,
      "giro": "string",
      "address": "string",
      "usesOT": true,
      "usesLotes": true,
      "usesSerial": true,
      "resolutionNumber": 0,
      "usesDispatch": true,
      "usesTransferDocument": true,
      "usesOrder": true,
      "usesBarCode": "string"
    },
    "userId": "string",
    "documentTypeId": "string",
    "documentName": "string",
    "number": 0,
    "fiscalYear": "string",
    "correlative": 0,
    "moveType": "string",
    "adjustmentMovementType": "string",
    "affectsCost": true,
    "date": "2021-12-15T12:50:38.565Z",
    "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": "2021-12-15T12:50:38.566Z"
          }
        ],
        "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": "2021-12-15T12:50:38.566Z",
        "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"
    }
  }
}

Permite obtener información sobre el stock futuro de los productos de una empresa

Ambientes

Ámbito	URL
Pruebas	https://replapi.defontana.com/api/Inventory/GetFutureStockInfo
Producción	https://api.defontana.com/api/Inventory/GetFutureStockInfo

Verbo HTTP: GET

Headers

Tipo	Valor	Requerido
Content-Type	“application/json”	Sí
Authorization	Token de autenticación del usuario de Integración. Debe ingresarse con el siguiente formato “bearer TOKEN”	Sí

Parámetros

Campos	Descripción	Requerido
ItemsPerPage	Ítems por página	Sí
Page	Número de página	Sí
ProductCode	Código del producto	No

Respuesta

{
  "success": true,
  "message": "string",
  "exceptionMessage": "string",
  "productsDetail": [
    {
      "productCode": "string",
      "description": "string",
      "currentStock": 0,
      "reservedStock": 0,
      "stockToReceive": 0,
      "futureStock": 0,
      "storageInfo": [
        {
          "storageCode": "string",
          "productCode": "string",
          "currentStock": 0,
          "reservedStock": 0,
          "maximumStockToReceive": 0,
          "maximumFutureStock": 0,
          "minimumFutureStock": 0
        }
      ]
    }
  ],
  "page": 0,
  "itemsPerPage": 0,
  "totalItems": 0
}

DISPATCH

Permite ingresar guías de despacho (método no recomendado)

Ambientes

Ámbito	URL
Pruebas	https://replapi.defontana.com/api/Dispatch/InsertDocument
Producción	https://api.defontana.com/api/Dispatch/InsertDocument

Verbo HTTP: POST

Headers

Tipo	Valor	Requerido
Content-Type	“application/json”	Sí
Authorization	Token de autenticación del usuario de Integración. Debe ingresarse con el siguiente formato “bearer TOKEN”	Sí

Parámetros

Campo	Descripción	Requerido
action
userId
clientId
companyId
sessionId
serviceId
shopId
clientFileId
sellerFileId
documentTypeId
paymentConditionId
priceListId
contactId
giro
district
billingCoinId
billingRate
incomeCoinId
incomeRate
contactIndex
gloss
creditDebitNoteType
realCreditDebitNoteType
serie
serieAlfa
firstFolio
lastFolio
isTransferDocument
dispatchType
assetsType
transactionType
originStorage	code, motive, analysis: accountNumber, file, businessCenter, classifier01, classifier02, nameTypeInv
destinationStorage	code, motive, analysis: accountNumber, file, businessCenter, classifier01, classifier02, nameTypeInv
isTransferDispatch
clientAnalysis	accountNumber, file, businessCenter, classifier01, classifier02, nameTypeInv
firstFeePaid	day, month, year
dueDate	day, month, year
emissionDate	day, month, year
exportData	transportWay, destinationCountry, destinationMerchandise, salesMode, paymentMethod, serviceIndicator, saleClause, totalClause, shipmentPort, landingPort, tareMeasure: value, unit weight: value, unit package: value, unit grossWeight: value, unit
(details) stockData	lotes: batchNumber, amount, expirationDate
(details) serials	serialStart, serialSufix, serialPrefix, destinationLocalization
(details) analysis	accountNumber, file, businessCenter, classifier01, classifier02, nameTypeInv
(details) analysisInv	accountNumber, file, businessCenter, classifier01, classifier02, nameTypeInv
(details) type
(details) isExempt
(details) code
(details) count
(details) price
(details) comment
(details) attachedLine
(details) attachedFolio
(details) tax	code, value
(details) discount	type, value
(details) taxes	analysis: accountNumber, file, businessCenter, classifier01, classifier02, nameTypeInv code, value
(details) modifiers	type, value, class, percentage, name, number, amount
attachedDocuments	documentTypeId, folio, reason, date: day, month, year documentTypeCode
customFields	id, name, value

Respuesta

{
  "firstFolio": 0,
  "lastFolio": 0,
  "success": true,
  "message": "string",
  "exceptionMessage": "string"
}

Permite ingresar guías de despacho (método recomendado)

Ambientes

Ámbito	URL
Pruebas	https://replapi.defontana.com/api/Dispatch/Save
Producción	https://api.defontana.com/api/Dispatch/Save

Verbo HTTP: POST

Headers

Tipo	Valor	Requerido
Content-Type	“application/json”	Sí
Authorization	Token de autenticación del usuario de Integración. Debe ingresarse con el siguiente formato “bearer TOKEN”	Sí

Parámetros

Campo	Descripción	Requerido
documentType
firstFolio
lastFolio
externalDocumentID
emissionDate	day, month, year
firstFeePaid	day, month, year
clientFile
contactIndex
paymentCondition
sellerFileId
clientAnalysis	accountNumber, businessCenter, classifier01, classifier02, nameTypeInv
billingCoin
billingRate
shopId
priceList
giro
district
city
contact
attachedDocuments	date: day, month, year documentTypeId, folio, reason
originStorage	code, motive storageAnalysis: accountNumber, businessCenter, classifier01, classifier02
destinationStorage	code, motive storageAnalysis: accountNumber, businessCenter, classifier01, classifier02
dispatchInfo	assetsType, dispatchType, transactionType, isTransferDispatch
(details) type
(details) isExempt
(details) code
(details) count
(details) productName
(details) productNameBarCode
(details) price
(details) unit
(details) analysis	accountNumber, businessCenter, classifier01, classifier02
(details) useBatch
(details) batchInfo	amount, batchNumber
saleTaxes	code, value taxAnalysis: accountNumber, businessCenter, classifier01, classifier02
ventaRecDesGlobal	amount, modifierClass, name, percentage, value
gloss
isTransferDocument

Respuesta

{
  "success": true,
  "firstFolio": 0,
  "lastFolio": 0,
  "message": "string"
}

Permite ingresar guías de despacho, generando en forma asíncrona (y sin manejo de errores) su documento de inventario

Ambientes

Ámbito	URL
Pruebas	https://replapi.defontana.com/api/Dispatch/SaveAsyncStockMovement
Producción	https://api.defontana.com/api/Dispatch/SaveAsyncStockMovement

Verbo HTTP: POST

Headers

Tipo	Valor	Requerido
Content-Type	“application/json”	Sí
Authorization	Token de autenticación del usuario de Integración. Debe ingresarse con el siguiente formato “bearer TOKEN”	Sí

Parámetros

Campo	Descripción	Requerido
documentType
firstFolio
lastFolio
externalDocumentID
emissionDate	day, month, year
firstFeePaid	day, month, year
clientFile
contactIndex
paymentCondition
sellerFileId
clientAnalysis	accountNumber, businessCenter, classifier01, classifier02
billingCoin
billingRate
shopId
priceList
giro
district
city
contact
attachedDocuments	date: day, month, year
documentTypeId
folio
reason
originStorage	code, motive, storageAnalysis: accountNumber, businessCenter, classifier01, classifier02
destinationStorage	code, motive, storageAnalysis: accountNumber, businessCenter, classifier01, classifier02
dispatchInfo	assetsType, dispatchType, transactionType, isTransferDispatch
(details) type
(details) isExempt
(details) code
(details) count
(details) productName
(details) productNameBarCode
(details) price
(details) unit
(details) analysis	accountNumber, businessCenter, classifier01, classifier02
(details) useBatch
(details) batchInfo	amount, batchNumber
(saleTaxes) code
(saleTaxes) value
(saleTaxes) taxAnalysis	accountNumber, businessCenter, classifier01, classifier02
(ventaRecDesGlobal) amount
(ventaRecDesGlobal) modifierClass
(ventaRecDesGlobal) name
(ventaRecDesGlobal) percentage
(ventaRecDesGlobal) value
gloss
isTransferDocument

Respuesta

{
  "success": true,
  "firstFolio": 0,
  "lastFolio": 0,
  "message": "string"
}

ORDER

Permite consultar información sobre un pedido

Ambientes

Ámbito	URL
Pruebas	https://replapi.defontana.com/api/Oder/Get
Producción	https://api.defontana.com/api/Order/Get

Verbo HTTP: GET

Headers

Tipo	Valor	Requerido
Content-Type	“application/json”	Sí
Authorization	Token de autenticación del usuario de Integración. Debe ingresarse con el siguiente formato “bearer TOKEN”	Sí

Parámetros

Campo	Descripción	Requerido
number	Número de pedido	Sí

Respuesta

{
  "success": true,
  "message": "string",
  "exceptionMessage": "string",
  "orderData": {
    "documentTypeID": "string",
    "number": 0,
    "client": {
      "fileId": "string",
      "legalCode": "string",
      "name": "string",
      "giro": "string",
      "address": "string",
      "country": "string",
      "city": "string",
      "region": "string",
      "district": "string",
      "email": "string",
      "phone": "string"
    },
    "creationDate": "2021-05-20T19:35:47.933Z",
    "shopID": "string",
    "billingCoindID": "string",
    "billingRate": 0,
    "sellerID": "string",
    "expirationDate": "2021-05-20T19:35:47.933Z",
    "comment": "string",
    "billingComment": "string",
    "dispatchComment": "string",
    "details": [
      {
        "total": 0,
        "discountType": "string",
        "discountValue": 0,
        "isExempt": true,
        "detailedDescription": "string",
        "comment": "string",
        "count": 0,
        "unit": "string",
        "name": "string",
        "code": "string",
        "isService": true,
        "price": 0
      }
    ],
    "modifiers": [
      {
        "name": "string",
        "class": "string",
        "number": 0,
        "value": 0,
        "percentage": 0
      }
    ],
    "taxes": [
      {
        "name": "string",
        "symbol": "string",
        "percentage": 0,
        "code": "string",
        "value": 0
      }
    ],
    "totals": {
      "exempt": 0,
      "affectable": 0,
      "linealDiscount": 0,
      "linealSurcharge": 0,
      "totalWithoutLinealDiscount": 0,
      "totalDiscountSurcharge": 0,
      "total": 0
    }
  }
}

Permite consultar un listado de pedidos

Ambientes

Ámbito	URL
Pruebas	https://replapi.defontana.com/api/Oder/List
Producción	https://api.defontana.com/api/Order/List

Verbo HTTP: Get

Headers

Tipo	Valor	Requerido
Content-Type	“application/json”	Sí
Authorization	Token de autenticación del usuario de Integración. Debe ingresarse con el siguiente formato “bearer TOKEN”	Sí

Parámetros

Campo	Descripción	Requerido
FromDate	Fecha desde la cual se consultarán resultados	Sí
ToDate	Fecha hasta la cual se consultarán resultados	Sí
ItemsPerPage	Cantidad de resultados por página	Sí
Página a consultar (comienza en 0)	Página a consultar (comienza en 0)	Sí
fromNumber	Número desde el cual consultar pedidos (opcional)	No

Respuesta

{
  "success": true,
  "message": "string",
  "exceptionMessage": "string",
  "items": [
    {
      "number": 0,
      "creationDate": "2021-05-20T19:47:29.743Z",
      "clientFileId": "string"
    }
  ]
}

Permite guardar pedidos asociados a la empresa.

Ambientes

Ámbito	URL
Pruebas	https://replapi.defontana.com/api/Order/SaveOrder
Producción	https://api.defontana.com/api/Order/SaveOrder

Verbo HTTP: POST

Headers

Tipo	Valor	Requerido
Content-Type	“application/json”	Sí
Authorization	Token de autenticación del usuario de Integración. Debe ingresarse con el siguiente formato “bearer TOKEN”	Sí

Parámetros

(no aplica)

Respuesta

{
  "documentTypeId": "string",
  "number": 0,
  "pricingId": "string",
  "clientFileId": "string",
  "sellerFileId": "string",
  "paymentConditionId": "string",
  "billingCoinId": "string",
  "billingRate": 0,
  "shopId": "string",
  "priceListId": "string",
  "billingType": "string",
  "giro": "string",
  "district": "string",
  "orderDetails": [
    {
      "type": "string",
      "isExempt": true,
      "isService": true,
      "code": "string",
      "unit": "string",
      "count": 0,
      "price": 0,
      "deliveryTime": {
        "hour": 0,
        "minute": 0
      },
      "discount": {
        "value": 0,
        "type": 0
      },
      "tax": {
        "value": 0,
        "code": "string"
      },
      "comment": "string",
      "productName": "string",
      "deliveryDate": {
        "day": 0,
        "month": 0,
        "year": 0
      }
    }
  ],
  "taxes": [
    {
      "code": "string",
      "value": 0
    }
  ],
  "creationDate": {
    "day": 0,
    "month": 0,
    "year": 0
  },
  "expirationDate": {
    "day": 0,
    "month": 0,
    "year": 0
  },
  "glossGeneral": "string",
  "glossDispatch": "string",
  "glossBill": "string",
  "glossPresentation": "string"
}

Permite aprobar comercialmente un pedido

Ambientes

Ámbito	URL
Pruebas	https://replapi.defontana.com/api/Order/ApproveCommercially
Producción	https://api.defontana.com/api/Order/ApproveCommercially

Verbo HTTP: POST

Headers

Tipo	Valor	Requerido
Content-Type	“application/json”	Sí
Authorization	Token de autenticación del usuario de Integración. Debe ingresarse con el siguiente formato “bearer TOKEN”	Sí

Parámetros

Campo	Descripción	Requerido
OrderNumber	Número del pedido	Sí

Respuesta

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

Permite generar una guia de despacho asociada a un pedido

Ambientes

Ámbito	URL
Pruebas	https://replapi.defontana.com/api/Order/DispatchOrder
Producción	https://api.defontana.com/api/Order/DispatchOrder

Verbo HTTP: POST

Headers

Tipo	Valor	Requerido
Content-Type	“application/json”	Sí
Authorization	Token de autenticación del usuario de Integración. Debe ingresarse con el siguiente formato “bearer TOKEN”	Sí

Parámetros

(no aplica)

Respuesta

{
  "orderNumber": 0,
  "clientAnalysis": {
    "accountNumber": "string",
    "businessCenter": "string",
    "classifier01": "string",
    "classifier02": "string"
  },
  "emissionDate": {
    "day": 0,
    "month": 0,
    "year": 0
  },
  "firstFeePaid": {
    "day": 0,
    "month": 0,
    "year": 0
  },
  "dispatchInfo": {
    "assetsType": "string",
    "dispatchType": "string",
    "transactionType": "string",
    "isTransferDispatch": true
  },
  "originStorageInfo": {
    "code": "string",
    "motive": "string",
    "storageAnalysis": {
      "accountNumber": "string",
      "businessCenter": "string",
      "classifier01": "string",
      "classifier02": "string"
    }
  },
  "destinationStorageInfo": {
    "code": "string",
    "motive": "string",
    "storageAnalysis": {
      "accountNumber": "string",
      "businessCenter": "string",
      "classifier01": "string",
      "classifier02": "string"
    }
  },
  "orderDetailAnalysis": [
    {
      "line": 0,
      "isExempt": true,
      "discount": {
        "type": 0,
        "value": 0
      },
      "detailAnalysis": {
        "accountNumber": "string",
        "businessCenter": "string",
        "classifier01": "string",
        "classifier02": "string"
      }
    }
  ],
  "dispatchTaxes": [
    {
      "code": "string",
      "value": 0,
      "taxAnalysis": {
        "accountNumber": "string",
        "businessCenter": "string",
        "classifier01": "string",
        "classifier02": "string"
      }
    }
  ],
  "gloss": "string",
  "isTransferDocument": true
}

{
  "orderNumber": 0,
  "clientAnalysis": {
    "accountNumber": "string",
    "businessCenter": "string",
    "classifier01": "string",
    "classifier02": "string"
  },
  "emissionDate": {
    "day": 0,
    "month": 0,
    "year": 0
  },
  "firstFeePaid": {
    "day": 0,
    "month": 0,
    "year": 0
  },
  "dispatchInfo": {
    "assetsType": "string",
    "dispatchType": "string",
    "transactionType": "string",
    "isTransferDispatch": true
  },
  "originStorageInfo": {
    "code": "string",
    "motive": "string",
    "storageAnalysis": {
      "accountNumber": "string",
      "businessCenter": "string",
      "classifier01": "string",
      "classifier02": "string"
    }
  },
  "destinationStorageInfo": {
    "code": "string",
    "motive": "string",
    "storageAnalysis": {
      "accountNumber": "string",
      "businessCenter": "string",
      "classifier01": "string",
      "classifier02": "string"
    }
  },
  "orderDetailAnalysis": [
    {
      "line": 0,
      "isExempt": true,
      "discount": {
        "type": 0,
        "value": 0
      },
      "detailAnalysis": {
        "accountNumber": "string",
        "businessCenter": "string",
        "classifier01": "string",
        "classifier02": "string"
      }
    }
  ],
  "dispatchTaxes": [
    {
      "code": "string",
      "value": 0,
      "taxAnalysis": {
        "accountNumber": "string",
        "businessCenter": "string",
        "classifier01": "string",
        "classifier02": "string"
      }
    }
  ],
  "gloss": "string",
  "isTransferDocument": true
}

Permite aprobar financieramente un pedido

Ambientes

Ámbito	URL
Pruebas	https://replapi.defontana.com/api/Order/ApproveFinancially
Producción	https://api.defontana.com/api/Order/ApproveFinancially

Verbo HTTP: POST

Headers

Tipo	Valor	Requerido
Content-Type	“application/json”	Sí
Authorization	Token de autenticación del usuario de Integración. Debe ingresarse con el siguiente formato “bearer TOKEN”	Sí

Parámetros

Campo	Descripción	Requerido
OrderNumber	Número del pedido	Sí

Respuesta

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

Permite facturar un pedido despachado previamente

Ambientes

Ámbito	URL
Pruebas	https://replapi.defontana.com/api/Order/InvoiceOrder
Producción	https://api.defontana.com/api/Order/InvoiceOrder

Verbo HTTP: POST

Headers

Tipo	Valor	Requerido
Content-Type	“application/json”	Sí
Authorization	Token de autenticación del usuario de Integración. Debe ingresarse con el siguiente formato “bearer TOKEN”	Sí

Parámetros

(no aplica)

Respuesta

{
  "orderNumber": 0,
  "documentId": "string",
  "externalDocumentID": "string",
  "clientAnalysis": {
    "accountNumber": "string",
    "businessCenter": "string",
    "classifier01": "string",
    "classifier02": "string"
  },
  "emissionDate": {
    "day": 0,
    "month": 0,
    "year": 0
  },
  "firstFeePaid": {
    "day": 0,
    "month": 0,
    "year": 0
  },
  "orderDetailAnalysis": [
    {
      "line": 0,
      "isExempt": true,
      "discount": {
        "type": 0,
        "value": 0
      },
      "detailAnalysis": {
        "accountNumber": "string",
        "businessCenter": "string",
        "classifier01": "string",
        "classifier02": "string"
      }
    }
  ],
  "invoiceTaxes": [
    {
      "code": "string",
      "value": 0,
      "taxAnalysis": {
        "accountNumber": "string",
        "businessCenter": "string",
        "classifier01": "string",
        "classifier02": "string"
      }
    }
  ],
  "gloss": "string",
  "isTransferDocument": true
}

PRICING

Permite guardar cotizaciones asociadas a la empresa.

Ambiente

Ámbito	URL
Pruebas	https://replapi.defontana.com/api/Pricing/SavePricing
Producción	https://api.defontana.com/api/Pricing/SavePricing

Verbo HTTP: POST

Headers

Tipo	Valor	Requerido
Content-Type	“application/json”	Sí
Authorization	Token de autenticación del usuario de Integración. Debe ingresarse con el siguiente formato “bearer TOKEN”	Sí

Parámetros

(no aplica)

Respuesta

{
  "clientFileId": "string",
  "sellerFileId": "string",
  "documentTypeId": "string",
  "paymentConditionId": "string",
  "priceListId": "string",
  "giro": "string",
  "district": "string",
  "billingCoinId": "string",
  "billingRate": 0,
  "gloss": "string",
  "description": "string",
  "folio": 0,
  "templateId": 0,
  "closingProbability": "string",
  "emissionDate": {
    "day": 0,
    "month": 0,
    "year": 0
  },
  "dueDate": {
    "day": 0,
    "month": 0,
    "year": 0
  },
  "closingDate": {
    "day": 0,
    "month": 0,
    "year": 0
  },
  "details": [
    {
      "isService": true,
      "isExempt": true,
      "code": "string",
      "type": "string",
      "unit": "string",
      "count": 0,
      "price": 0,
      "comment": "string",
      "discount": {
        "type": 0,
        "value": 0
      },
      "deliveryDate": {
        "day": 0,
        "month": 0,
        "year": 0
      },
      "deliveryDateInput": "2021-12-16T16:15:02.780Z"
    }
  ],
  "taxes": [
    {
      "code": "string",
      "value": 0
    }
  ],
  "modifiers": [
    {
      "type": 0,
      "value": 0,
      "class": "string",
      "percentage": 0,
      "name": "string",
      "number": 0,
      "amount": 0
    }
  ],
  "customFields": [
    {
      "name": "string",
      "value": "string"
    }
  ],
  "isTemplate": true
}

Permite consultar los detalles de una cotización

Ambientes

Ámbito	URL
Pruebas	https://replapi.defontana.com/api/Pricing/GetPricing
Producción	https://api.defontana.com/api/Pricing/GetPricing

Verbo HTTP: GET

Headers

Tipo	Valor	Requerido
Content-Type	“application/json”	Sí
Authorization	Token de autenticación del usuario de Integración. Debe ingresarse con el siguiente formato “bearer TOKEN”	Sí

Parámetros

Campo	Descripción	Requerido
Number	Número de la cotización	Sí

Respuesta

{
  "success": true,
  "message": "string",
  "exceptionMessage": "string",
  "pricingData": {
    "documentType": "string",
    "clientId": "string",
    "priceListId": "string",
    "gloss": "string",
    "billingCoinId": "string",
    "billingRate": 0,
    "contactId": 0,
    "sellerFileId": "string",
    "paymentCondition": "string",
    "state": "string",
    "folio": 0,
    "templateId": 0,
    "closingProbability": "string",
    "dueDate": "2021-12-20T14:33:59.564Z",
    "pricingDate": "2021-12-20T14:33:59.564Z",
    "closingDate": "2021-12-20T14:33:59.564Z",
    "details": [
      {
        "code": "string",
        "type": "string",
        "unit": "string",
        "count": 0,
        "price": 0,
        "comment": "string",
        "discount": {
          "type": "string",
          "value": 0
        },
        "deliveryDate": "2021-12-20T14:33:59.564Z",
        "total": 0,
        "idDetailGroup": 0
      }
    ],
    "taxes": [
      {
        "taxeCode1": "string",
        "taxePercentaje1": 0,
        "taxeValue1": 0,
        "taxeCode2": "string",
        "taxePercentaje2": 0,
        "taxeValue2": 0,
        "taxeCode3": "string",
        "taxePercentaje3": 0,
        "taxeValue3": 0,
        "taxeCode4": "string",
        "taxePercentaje4": 0,
        "taxeValue4": 0,
        "taxeCode5": "string",
        "taxePercentaje5": 0,
        "taxeValue5": 0
      }
    ],
    "customFields": [
      {
        "id": 0,
        "name": "string",
        "value": "string"
      }
    ],
    "totals": [
      {
        "exempt": 0,
        "affectable": 0,
        "totalDiscountSurcharge": 0,
        "total": 0,
        "subTotal": 0
      }
    ]
  }
}

Permite consultar un listado de cotizaciones

Ambientes

Ámbito	URL
Pruebas	https://replapi.defontana.com/api/Pricing/List
Producción	https://api.defontana.com/api/Pricing/List

Verbo HTTP: GET

Headers

Tipo	Valor	Requerido
Content-Type	“application/json”	Sí
Authorization	Token de autenticación del usuario de Integración. Debe ingresarse con el siguiente formato “bearer TOKEN”	Sí

Parámetros

Campo	Deswcripción	Requerido
FromDate	Fecha desde la cual se consultarán resultados	Sí
ToDate	Fecha hasta la cual se consultarán resultados	Sí
ItemsPerPage	Cantidad de resultados por página	Sí
PageNumber	Página a consultar (comienza en 0)	Sí
fromNumber	Número desde el cual consultar cotización (opcional)	No

Respuesta

{
  "success": true,
  "message": "string",
  "exceptionMessage": "string",
  "items": [
    {
      "number": 0,
      "documentTypeID": "string",
      "pricingDate": "2021-12-20T14:37:40.948Z",
      "clientFileId": "string"
    }
  ]
}

PURCHASE

Permite consultar un listado de documentos de compra de la empresa

Ambientes

Ámbito	URL
Pruebas	https://replapi.defontana.com/api/Purchase/List
Producción	https://api.defontana.com/api/Purchase/List

Verbo HTTP: GET

Headers

Tipo	Valor	Requerido
Content-Type	“application/json”	Sí
Authorization	Token de autenticación del usuario de Integración. Debe ingresarse con el siguiente formato “bearer TOKEN”	Sí

Parámetros

Campo	Descripción	Requerido
StartDate	Filtro de fecha de inicio	Sí
FinishDate	Filtro de fecha de término	Sí
ItemsPerPage	Elementos por página (recomendado 10)	Sí
Page	Página a consultar (comienza en 0)	Sí
SiiDocumentCode	Código de documento del SII (33, 34...)	No

Respuesta

{
  "success": true,
  "message": "string",
  "exceptionMessage": "string",
  "data": {
    "draw": 0,
    "recordsTotal": 0,
    "recordsFiltered": 0,
    "data": [
      {
        "origin": 1,
        "companyId": "string",
        "providerLegalCode": "string",
        "providerName": "string",
        "documentNumber": "string",
        "documentType": "string",
        "documentTotal": "string",
        "documentEmissionDate": "2021-12-17T13:39:57.895Z",
        "documentEntryType": 0,
        "documentPlatformId": "string",
        "siiReceiptDate": "2021-12-17T13:39:57.895Z",
        "lastStatus": "string",
        "isIntegrated": true,
        "isDigital": true,
        "isReceived": true,
        "providerId": "string",
        "siiDocumentType": "string",
        "documentTypeId": "string",
        "fiscalYear": "string",
        "voucherTypeId": "string",
        "voucherNumber": 0,
        "accoutingBalance": 0,
        "key": "string",
        "canEdit": true,
        "canRemove": true,
        "deleteFailCondition": "string",
        "canFix": true,
        "canCancel": true,
        "canReceive": true,
        "canReject": true,
        "canLey19983": true,
        "canGenericView": true,
        "canPreview": true,
        "canPrint": true,
        "canReceipt": true,
        "hasStockDocumentsRelated": true,
        "hasMenu": true,
        "originDescription": "string"
      }
    ],
    "error": "string"
  }
}

Permite obtener los detalles de un documento de compra

Ambientes

Ámbito	URL
Pruebas	https://replapi.defontana.com/api/Purchase/Get
Producción	https://api.defontana.com/api/Purchase/Get

Verbo HTTP: GET

Headers

Tipo	Valor	Requerido
Content-Type	“application/json”	Sí
Authorization	Token de autenticación del usuario de Integración. Debe ingresarse con el siguiente formato “bearer TOKEN”	Sí

Parámetros

Campo	Descripción	Requerido
Provider	Código del proveedor	Sí
DocumentType	Código del documento	Sí
Number	Número del documento	Sí

Respuesta

{
  "success": true,
  "message": "string",
  "exceptionMessage": "string",
  "data": {
    "company": {
      "id": "string",
      "name": "string",
      "rut": "string",
      "phone": "string",
      "rubro": 0,
      "giro": "string",
      "address": "string",
      "district": "string",
      "usesOT": true,
      "usesLotes": true,
      "usesSerial": true,
      "resolutionNumber": 0,
      "usesDispatch": true,
      "usesTransferDocument": true,
      "usesOrder": true,
      "usesBarCode": "string"
    },
    "providerId": "string",
    "provider": {
      "file": {
        "id": "string",
        "companyId": "string",
        "isClient": true,
        "isProvider": true,
        "isEmployee": true,
        "isPerson": true,
        "legalCode": "string",
        "name": "string",
        "lastName1": "string",
        "lastName2": "string",
        "nickname": "string",
        "business": "string",
        "initials": "string",
        "postalBox": "string",
        "zipCode": "string",
        "webSite": "string",
        "rubroId": "string",
        "companyType": "string",
        "priceList": "string",
        "sellerFileId": "string",
        "paymentType": "string"
      },
      "analysis": {
        "accountId": "string",
        "documentTypeId": "string",
        "documentNumber": 0,
        "documentDueDate": "2021-12-17T13:32:47.849Z",
        "file": {
          "code": "string",
          "name": "string",
          "iso": "string"
        },
        "classifier01": {
          "code": "string",
          "name": "string",
          "iso": "string"
        },
        "classifier02": {
          "code": "string",
          "name": "string",
          "iso": "string"
        },
        "businessCenter": {
          "code": "string",
          "name": "string",
          "iso": "string"
        }
      },
      "providerTypeId": "string",
      "providerTypeAccount": "string",
      "providerTypeAccountDescription": "string"
    },
    "documentTypeId": "string",
    "documentType": {
      "id": "string",
      "siiId": "string",
      "isDigital": true,
      "isBill": true,
      "isTicket": true,
      "modifiesStock": true,
      "isExempt": true,
      "handleUntaxed": true,
      "increaseBook": true,
      "initials": "string",
      "isExportBill": true,
      "isCreditNote": true,
      "isDebitNote": true,
      "isDispatchGuide": true,
      "modifiers": [
        {
          "type": 0,
          "value": 0,
          "class": "string",
          "percentage": 0,
          "name": "string",
          "number": 0,
          "amount": 0
        }
      ],
      "taxes": [
        {
          "type": "string",
          "code": "string",
          "name": "string",
          "id": "string",
          "isEspecific": true,
          "siiCode": "string",
          "taxPercent": 0
        }
      ]
    },
    "documentNumber": 0,
    "address": "string",
    "comment": "string",
    "shopId": "string",
    "shop": {
      "code": "string",
      "name": "string",
      "store": "string",
      "address": "string",
      "businessCode": "string",
      "businessName": "string"
    },
    "documentEmissionDate": "2021-12-17T13:32:47.849Z",
    "accountingDate": "2021-12-17T13:32:47.849Z",
    "amountBeforeTaxes": 0,
    "amountExempt": 0,
    "taxes": [
      {
        "code": "string",
        "name": "string",
        "percent": 0,
        "value": 0,
        "analysis": {
          "accountId": "string",
          "documentTypeId": "string",
          "documentNumber": 0,
          "documentDueDate": "2021-12-17T13:32:47.849Z",
          "file": {
            "code": "string",
            "name": "string",
            "iso": "string"
          },
          "classifier01": {
            "code": "string",
            "name": "string",
            "iso": "string"
          },
          "classifier02": {
            "code": "string",
            "name": "string",
            "iso": "string"
          },
          "businessCenter": {
            "code": "string",
            "name": "string",
            "iso": "string"
          }
        }
      }
    ],
    "amountTotal": 0,
    "documentDueDate": "2021-12-17T13:32:47.849Z",
    "paymentCondition": {
      "code": "string",
      "name": "string",
      "iso": "string"
    },
    "paymentDetail": [
      {
        "line": 0,
        "amount": 0,
        "date": "2021-12-17T13:32:47.850Z"
      }
    ],
    "modifier": 0,
    "nonRecoverableTaxAnalysis": {
      "accountId": "string",
      "documentTypeId": "string",
      "documentNumber": 0,
      "documentDueDate": "2021-12-17T13:32:47.850Z",
      "file": {
        "code": "string",
        "name": "string",
        "iso": "string"
      },
      "classifier01": {
        "code": "string",
        "name": "string",
        "iso": "string"
      },
      "classifier02": {
        "code": "string",
        "name": "string",
        "iso": "string"
      },
      "businessCenter": {
        "code": "string",
        "name": "string",
        "iso": "string"
      }
    },
    "nonRecoverableTaxCode": 0,
    "customFields": [
      {
        "id": 0,
        "name": "string",
        "value": "string",
        "type": 0
      }
    ],
    "purchaseDetails": [
      {
        "line": 0,
        "account": {
          "code": "string",
          "name": "string",
          "iso": "string"
        },
        "expenseAmount": 0,
        "comment": "string",
        "itemId": "string",
        "nameItem": "string",
        "isService": true,
        "quantity": 0,
        "detailAnalysis": {
          "accountId": "string",
          "documentTypeId": "string",
          "documentNumber": 0,
          "documentDueDate": "2021-12-17T13:32:47.850Z",
          "file": {
            "code": "string",
            "name": "string",
            "iso": "string"
          },
          "classifier01": {
            "code": "string",
            "name": "string",
            "iso": "string"
          },
          "classifier02": {
            "code": "string",
            "name": "string",
            "iso": "string"
          },
          "businessCenter": {
            "code": "string",
            "name": "string",
            "iso": "string"
          }
        }
      }
    ],
    "purchaseOrderDetails": [
      {
        "line": 0,
        "quantity": 0,
        "modifiers": 0,
        "modifierType": "string",
        "total": 0,
        "isInventoriable": true,
        "receptionNumber": 0,
        "receptionLine": 0,
        "purchaseOrderSerie": "string",
        "purchaseOrderNumber": 0,
        "purchaseOrderLine": 0,
        "detailType": "string",
        "itemId": "string"
      }
    ],
    "purchaseProductDetails": [
      {
        "line": 0,
        "detailType": "string",
        "itemId": "string",
        "requestedQuantity": 0,
        "measureUnitId": "string",
        "originUnitPrice": 0,
        "unitPrice": 0,
        "modifiers": 0,
        "modifierType": "string",
        "receivedQuantity": 0,
        "returnedQuantity": 0,
        "invoicedQuantity": 0,
        "netAmount": 0,
        "centralizationType": "string",
        "accountId": "string"
      }
    ],
    "relatedDocuments": [
      {
        "line": 0,
        "documentTypeId": "string",
        "documentNumber": 0,
        "totalAmount": 0,
        "documentTypeDescription": "string",
        "documentDate": "2021-12-17T13:32:47.850Z",
        "providerTypeId": "string",
        "relationType": "string"
      }
    ]
  }
}

Permite obtener la orden de compra asociada a un documento de compra

Ambientes

Ámbito	URL
Pruebas	https://replapi.defontana.com/api/Purchase/GetAssociatedPurchaseOrder
Producción	https://api.defontana.com/api/Purchase/GetAssociatedPurchaseOrder

Headers

Tipo	Valor	Requerido
Content-Type	"application/json"	Sí
Authorization	Token de autenticación del usuario de Integración. Debe ingresarse con el siguiente formato “bearer TOKEN”	Sí

Parámetros

Campo	Descripción	Requerido
Provider	Identificador del proveedor	Sí
DocumentType	Tipo de documento	Sí
Number	Número del documento	Sí

Respuesta

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

Highlight important information in a panel like this one. To edit this panel's color or style, select one of the options in the menu below.

Contactos

Métodos

AUTH

ACCOUNTING

SALE

PURCHASEORDER

INVENTORY

DISPATCH

ORDER

PRICING

PURCHASE

Artículos Relacionados