Todos los endpoints de esta API utilizan paginación exceptuando Login. A continuación se detallan algunas consideraciones importantes para interactuar con los endpoints de manera efectiva:
\nParametros
\npagina: Obligatorio en solicitudes subsiguientes. Indica el número de la página que se desea consultar. Por ejemplo, para solicitar la tercera página, deberías añadir este header: pagina: 3.
cantidadPaginas: Opcional. Permite al usuario especificar la cantidad de resultados por página. El valor por defecto es 100. Si desea cambiar la cantidad de resultados por página, incluya este header, por ejemplo: cantidadPaginas: 50.
Token de Autenticación: Todos los endpoints, excepto Login, requieren un token de autenticación que se recibe después de un proceso de autenticación. Asegúrese de incluir este token en el header de cada solicitud para autenticarse correctamente.
\nHeader X-ClientId: Todos los endpoints, excepto Login, requieren un header adicional llamado X-ClientId, que es obligatorio en cada solicitud. Asegúrese de incluir este header en cada solicitud.
La API devuelve respuestas estructuradas para los errores.
A continuación se detalla el formato estándar utilizado para las respuestas de error y cómo se proporciona información adicional en caso de errores de validación.
Cuando ocurre un error, la API responde en el siguiente formato:
\n{\n \"error\": true,\n \"message\": \"Mensaje descriptivo del error\",\n \"code\": 400,\n \"result\": null\n}\n\nerror: Un valor booleano que siempre es true para las respuestas de error.
Tipo: Boolean
\nDescripción: Indica si la respuesta corresponde a un error.
\nmessage: Descripción clara del error que ha ocurrido.
\nTipo: String
\nDescripción: Mensaje descriptivo que explica la naturaleza del error.
\ncode: Código de estado HTTP que indica el tipo de error.
\nTipo: Integer
\nDescripción: Representa el código de estado HTTP asociado con el error. Ejemplos comunes incluyen 400 para Bad Request, 401 para Unauthorized, 404 para Not Found, etc.
result: Usualmente null a menos que se proporcione información adicional sobre errores de validación.
Tipo: Object o null
\nDescripción: Campo utilizado para proporcionar detalles adicionales sobre el error, especialmente en casos de errores de validación. Contiene un diccionario donde las claves son los nombres de los campos que fallaron la validación y los valores son listas de mensajes de error asociados a esos campos.
\ncantidadPaginas: Este header se incluirá en los headers de la respuesta para informar al usuario sobre el número total de páginas disponibles. para las subsiguientes solicitudes si aplicaEste endpoint permite al usuario autenticarse en el sistema proporcionando su dirección de correo electrónico y contraseña. las cuales fueron brindandas por SmartBIT
\nEl cuerpo de la solicitud debe contener los siguientes parámetros:
\nemail: Obligatorio. La dirección de correo electrónico del usuario.
password: Obligatorio. La contraseña del usuario.
token: Sera el token de autorización que debe agregar en los enpoints a consultar.
expiration: la fecha de expiración del token en formato ISO 8601.
{\n \"token\": \"\",\n \"expiration\": \"\"\n}\n\nEste endpoint permite al usuario obtener información sobre los articulos. Aplica paginación
\n","urlObject":{"path":["api","v1","Articulo","Productos"],"host":["{{base_url}}"],"query":[{"disabled":true,"key":"pagina","value":"{{pagina}}"},{"disabled":true,"key":"cantidadRegistroPagina","value":"{{cantidadRegistroPagina}}"}],"variable":[]}},"response":[{"id":"aafbd365-3c2e-4b2d-823d-460b415822ca","name":"{{base_url}}/api/v1/Articulo/Productos","originalRequest":{"method":"GET","header":[{"key":"X-ClientId","value":""}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url}}/api/v1/Articulo/Productos","host":["{{base_url}}"],"path":["api","v1","Articulo","Productos"],"query":[{"key":"pagina","value":"","disabled":true},{"key":"cantidadRegistroPagina","value":"","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""},{"key":"cantidadPaginas","value":"0","description":""},{"key":"X-Rate-Limit-Limit","value":"1m","description":""},{"key":"X-Rate-Limit-Remaining","value":"59","description":""},{"key":"X-Rate-Limit-Reset","value":"2024-06-05T22:26:37.2575200Z","description":""}],"cookie":[],"responseTime":null,"body":"[\r\n {\r\n \"referencia\": \"PRUEBA\",\r\n \"codigoBarra\": \"PRUEBA\",\r\n \"descripcion\": \"articulo de prueba\",\r\n \"clasificadores\": [\r\n {\r\n \"agrupador\": \"Grupo\",\r\n \"descripcion\": \"No Asignado\"\r\n },\r\n {\r\n \"agrupador\": \"Tipo\",\r\n \"descripcion\": \"No Asignado\"\r\n },\r\n {\r\n \"agrupador\": \"Linea\",\r\n \"descripcion\": \"No Asignado\"\r\n },\r\n {\r\n \"agrupador\": \"Marca\",\r\n \"descripcion\": \"No Asignado\"\r\n }\r\n ],\r\n \"existencia\": 0,\r\n \"sigla\": \"U\"\r\n },\r\n {\r\n \"referencia\": \"referencia\",\r\n \"codigoBarra\": \"CodigoBarra\",\r\n \"descripcion\": \"Descripcion\",\r\n \"clasificadores\": [\r\n {\r\n \"agrupador\": \"Grupo\",\r\n \"descripcion\": \"\"\r\n },\r\n {\r\n \"agrupador\": \"Tipo\",\r\n \"descripcion\": \"\"\r\n },\r\n {\r\n \"agrupador\": \"Linea\",\r\n \"descripcion\": \"\"\r\n },\r\n {\r\n \"agrupador\": \"Marca\",\r\n \"descripcion\": \"\"\r\n }\r\n ],\r\n \"existencia\": 0,\r\n \"sigla\": \"U\" //Sigla unidad de medida\r\n }]"}],"_postman_id":"25303ccb-b9ab-40ae-969d-f0fb1dff2b62"},{"name":"{{base_url}}/api/v1/Articulo/Fecha","id":"d399805e-901b-4977-9eae-2d5e5b1a5c90","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"X-ClientId","value":"{{Cliente_id}}"}],"body":{"mode":"raw","raw":"{\r\n \"fechaInicial\": \"2024-06-05\",\r\n \"fechaFinal\": \"2024-06-05\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/api/v1/Articulo/Fecha","description":"Este endpoint permite al usuario obtener información del articulo por fecha de edición.Aplica paginación
\nEl cuerpo de la solicitud debe contener los siguientes parámetros:
\nfechaInicial: Obligatorio. La fecha inicial para el rango de búsqueda en formato \"YYYY-MM-DD\".
fechaFinal: Obligatorio. La fecha final para el rango de búsqueda en formato \"YYYY-MM-DD\".
Este endpoint permite al usuario obtener información sobre la existencia del producto
por sucursal.Aplica paginación
aplican unicamente para filtros enviar por defecto {}
\nidSucursal: Opcional. ID de la sucursal para filtrar la búsqueda del producto. Si se omite, se considerarán todas las sucursales.
referencia: Opcional. Referencia del artículo a buscar. Utilizar este parámetro para limitar la búsqueda a productos que coincidan con la referencia dada.
V2
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"event":[{"listen":"prerequest","script":{"id":"8b60b2b1-b37d-41f3-a392-e5fb48b4bfda","type":"text/javascript","packages":{},"exec":[""]}},{"listen":"test","script":{"id":"3c762a58-a4c9-4e77-9207-8695c08edecb","type":"text/javascript","packages":{},"exec":[""]}}],"_postman_id":"aaf268a6-c8c5-4901-ac63-e79a9d3604af"},{"name":"Cliente","item":[{"name":"{{base_url}}/api/v1/Cliente/Clientes","id":"7de279f9-b687-4d52-8ff1-f4d78883814d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"X-ClientId","value":"{{Cliente_id}}"}],"url":"{{base_url}}/api/v1/Cliente/Clientes","description":"Este endpoint permite al usuario obtener información sobre los Clientes. La información se pagina. Los usuarios pueden controlar el número de resultados por página a través de parámetros en el encabezado. Validar parametros generales
\n","urlObject":{"path":["api","v1","Cliente","Clientes"],"host":["{{base_url}}"],"query":[{"disabled":true,"key":"pagina","value":"{{pagina}}"},{"disabled":true,"key":"cantidadRegistroPagina","value":"{{cantidadRegistroPagina}}"}],"variable":[]}},"response":[{"id":"b59de3a7-6bc4-47f1-b419-f43cf7681bb5","name":"{{base_url}}/api/v1/Cliente/Clientes","originalRequest":{"method":"GET","header":[{"key":"X-ClientId","value":"{{Cliente_id}}"}],"url":{"raw":"{{base_url}}/api/v1/Cliente/Clientes","host":["{{base_url}}"],"path":["api","v1","Cliente","Clientes"],"query":[{"key":"pagina","value":"{{pagina}}","disabled":true},{"key":"cantidadRegistroPagina","value":"{{cantidadRegistroPagina}}","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""},{"key":"cantidadPaginas","value":"10","description":""},{"key":"X-Rate-Limit-Limit","value":"1m","description":""},{"key":"X-Rate-Limit-Remaining","value":"59","description":""},{"key":"X-Rate-Limit-Reset","value":"2024-06-05T22:26:37.2575200Z","description":""}],"cookie":[],"responseTime":null,"body":"[\r\n {\r\n \"codigo\": \"N/A\",\r\n \"codigoAlterno\": \"\",\r\n \"razonSocial\": \"No Asignado\",\r\n \"nombre\": \"No Asignado\",\r\n \"telefono\": \"\",\r\n \"contacto\": \"\",\r\n \"eMail\": \"\",\r\n \"tipoCliente\": \"No Asignado\"\r\n },\r\n {\r\n \"codigo\": \"C/F\",\r\n \"codigoAlterno\": \"\",\r\n \"razonSocial\": \"Consumidor Final\",\r\n \"nombre\": \"Consumidor Final\",\r\n \"telefono\": \"\",\r\n \"contacto\": \"\",\r\n \"eMail\": \"\",\r\n \"tipoCliente\": \"No Asignado\"\r\n }\r\n]"}],"_postman_id":"7de279f9-b687-4d52-8ff1-f4d78883814d"},{"name":"{{base_url}}/api/v1/Cliente/Fecha","id":"ce830481-f654-440a-84c0-1f8b634077e6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"X-ClientId","value":"{{Cliente_id}}"}],"body":{"mode":"raw","raw":"{\r\n \"fechaInicial\": \"2024-06-05\",\r\n \"fechaFinal\": \"2024-06-05\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/api/v1/Cliente/Fecha","description":"Este endpoint permite al usuario obtener información de clientes por fecha de creacion
\nEl cuerpo de la solicitud debe contener los siguientes parámetros:
\nfechaInicial: Obligatorio. La fecha inicial para el rango de búsqueda en formato \"YYYY-MM-DD\".
fechaFinal: Obligatorio. La fecha final para el rango de búsqueda en formato \"YYYY-MM-DD\".
Este endpoint permite al usuario obtener información de los proveedores.Aplica paginación
\n","urlObject":{"path":["api","v1","Proveedor","Proveedores"],"host":["{{base_url}}"],"query":[{"disabled":true,"key":"pagina","value":"{{pagina}}"},{"disabled":true,"key":"cantidadRegistroPagina","value":"{{cantidadRegistroPagina}}"}],"variable":[]}},"response":[{"id":"fab36ce6-29ce-42d3-8433-0ede3cf7bb22","name":"{{base_url}}/api/v1/Proveedor/Proveedores","originalRequest":{"method":"GET","header":[{"key":"X-ClientId","value":"{{Cliente_id}}"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url}}/api/v1/Proveedor/Proveedores","host":["{{base_url}}"],"path":["api","v1","Proveedor","Proveedores"],"query":[{"key":"pagina","value":"{{pagina}}","disabled":true},{"key":"cantidadRegistroPagina","value":"{{cantidadRegistroPagina}}","disabled":true}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""},{"key":"cantidadPaginas","value":"113","description":""},{"key":"X-Rate-Limit-Limit","value":"1m","description":""},{"key":"X-Rate-Limit-Remaining","value":"59","description":""},{"key":"X-Rate-Limit-Reset","value":"2024-06-06T06:10:05.7776265Z","description":""}],"cookie":[],"responseTime":null,"body":"[\r\n {\r\n \"codigo\": \"N/A\",\r\n \"codigoAlterno\": \"\",\r\n \"nombre\": \"No Asignado\",\r\n \"razonSocial\": \"No Asignado\",\r\n \"telefono\": \"\",\r\n \"eMail\": \"\",\r\n \"contacto\": \"\",\r\n \"tipo\": \"No Asignado\"\r\n }\r\n]"}],"_postman_id":"c1a0a831-d15c-445d-9e7d-f2805b8df78d"},{"name":"{{base_url}}/api/v1/Proveedor/Fecha","id":"33cc5670-966b-4fa8-9a18-8e013457bbe2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"X-ClientId","value":"{{Cliente_id}}"}],"body":{"mode":"raw","raw":"{\r\n \"fechaInicial\": \"2024-06-05\",\r\n \"fechaFinal\": \"2024-06-05\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/api/v1/Proveedor/Fecha","description":"Este endpoint permite al usuario obtener información del proveedor por fecha de creacion.Aplica paginación
\nEl cuerpo de la solicitud debe contener los siguientes parámetros:
\nfechaInicial: Obligatorio. La fecha inicial para el rango de búsqueda en formato \"YYYY-MM-DD\".
fechaFinal: Obligatorio. La fecha final para el rango de búsqueda en formato \"YYYY-MM-DD\".
Version V1
\n","_postman_id":"ccba0a4d-8a5d-4b6e-a67f-66ee33de57fa"},{"name":"V2","item":[{"name":"Cliente","item":[{"name":"Clientes","id":"984955ee-8878-4b35-aa6e-61d8142097db","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"X-ClientId","value":"{{Cliente_id}}","type":"text"}],"url":"{{vault:base_url}}/api/v2/Cliente/Clientes","description":"Este endpoint permite al usuario obtener el listado de clientes Aplica paginación
\nCada objeto en el arreglo incluye:
\ncodigo (string): Identificador único.
codigoAlterno (String): Identificacion o codigo tributario.
razonSocial (String): Razon Social.
nombre (String): Nombre Comercial.
telefono (String):Número de teléfono.
contacto (String): información de contacto.
eMail (String): email.
tipoCliente (String): Tipo de cliente.
diasPlazo (Objeto): Objeto.
agrupador (Objeto): Objeto.
clasificador (Objeto): Objeto.
diasPlazoId (short): Identificador único.
descripcion (string): Descripción de los días plazo.
codigo (short): Cantidad de dias plazo.
agrupadorClienteId (short): Identificador único.
descripcion (string): Descripción del agrupador de cliente.
clasificadorClienteId (short): Identificador único.
descripcion (string): Descripción del clasificador de cliente.
Este endpoint permite al usuario obtener el listado de clientes en base a su fecha de creación Aplica paginación
\nCada objeto en el arreglo incluye:
\ncodigo (string): Identificador único.
codigoAlterno (String): Identificacion o codigo tributario.
razonSocial (String): Razon Social.
nombre (String): Nombre Comercial.
telefono (String):Número de teléfono.
contacto (String): información de contacto.
eMail (String): email.
tipoCliente (String): Tipo de cliente.
diasPlazo (Objeto): Objeto.
agrupador (Objeto): Objeto.
clasificador (Objeto): Objeto.
diasPlazoId (short): Identificador único.
descripcion (string): Descripción de los días plazo.
codigo (short): Cantidad de dias plazo.
agrupadorClienteId (short): Identificador único.
descripcion (string): Descripción del agrupador de cliente.
clasificadorClienteId (short): Identificador único.
descripcion (string): Descripción del clasificador de cliente.
Los endpoints en esta carpeta permiten a los usuarios del sistema manejar la información de clientes, incluyendo datos básicos, contactos, ubicaciones y detalles comerciales.EndFragment
\n","_postman_id":"40c42002-b5a8-4ced-95c5-396410793f90"},{"name":"Articulo","item":[{"name":"Productos","id":"47b07587-db19-46a0-9ed9-7ef61ec7bc99","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"X-ClientId","value":"{{Cliente_id}}","type":"text"}],"url":"{{vault:base_url}}/api/v2/Articulo/Productos","description":"Este endpoint permite al usuario obtener el listado de productos Aplica paginación
\nCada objeto en el arreglo incluye:
\nreferencia (string): Identificador único.
codigoBarra (String): Codigo de barra del producto.
descripcion (String): Descripción de producto.
clasificadores (Objeto Array Clasificador): Arreglo de clasificadores de producto.
existencia (double):Existencia general del producto.
sigla (String): Sigla de la unidad de medida asignada al producto.
costoPresentacion (String): Costo del producto en la unidad de medida asignada.
costoUnitario (String): Costo unitario de producto CostoPresentacion / conversionUnidadMedida.
proveedor (Objeto Proveedor):Información del proveedor
agrupador (string): Nombre general del agrupador.
descripcion (String): Descripción del agrupador.
codigo (string):Identificador unico de proveedor.
nombre (String):Nombre proveedor.
Este endpoint permite al usuario obtener el listado de productos en base a su fecha de creación. Aplica paginación
\nCada objeto en el arreglo incluye:
\nreferencia (string): Identificador único.
codigoBarra (String): Codigo de barra del producto.
descripcion (String): Descripción de producto.
clasificadores (Objeto Array Clasificador): Arreglo de clasificadores de producto.
existencia (double):Existencia general del producto.
sigla (String): Sigla de la unidad de medida asignada al producto.
costoPresentacion (String): Costo del producto en la unidad de medida asignada.
costoUnitario (String): Costo unitario de producto CostoPresentacion / conversionUnidadMedida.
proveedor (Objeto Proveedor):Información del proveedor
agrupador (string): Nombre general del agrupador.
descripcion (String): Descripción del agrupador.
codigo (string):Identificador unico de proveedor.
nombre (String):Nombre proveedor.
Estos enpoints le permitiran obtener la informacion de productos
\n","_postman_id":"a071cdcc-6dce-4044-bb1e-bee1869e72e3"}],"id":"2f159eb3-c516-4abd-a182-a917c6cb1d9b","description":"Version V2
\n","_postman_id":"2f159eb3-c516-4abd-a182-a917c6cb1d9b"}],"id":"816d32bd-ee8b-407b-b18d-844255a01a04","description":"fichasEsta carpeta contiene los catálogos utilizados
\nContenidos de la carpeta:
\narticulos: Catálogo de artículos disponibles en el sistema. Enpoints disponibles proveedores: Catálogo de proveedores.Enpoints disponibles clientes: Catálogo de clientes.Enpoints disponiblesEste endpoint permite al usuario obtener información de las transacciones de inventario por fecha de documento. Aplica paginación
\nObligatorios:
\nfechaInicial: La fecha inicial para el rango de búsqueda en formato \"YYYY-MM-DD\".
fechaFinal: La fecha final para el rango de búsqueda en formato \"YYYY-MM-DD\".
Opcionales:
\nstatus: Estado de la transacción, donde:
1 = Activo
2 = cerrado
3 = Autorizado
4 = Anulado
7 = Operado parcial
8 = Operado completo
numeroTransaccion: indica el tipo de transacción:
esto es una lista de transacciones
1 = Factura de Venta
2 = Factura de Compra
4 = Exporta a Sucursal
5 = Importa de Sucursal
6 = Ajustes (+)
7 = Ajustes (-)
10 = Nota de credito cliente
11 = Nota de Credito Proveedor
30 = Cotizacion
31 = Pedido
32 = Preparar Picking
33 = Nota de Debito
50 = Orden de Compra
51 = Importacion (Calculo de CIF)
70 = Despacho
idSucursal: ID de la sucursal
{ \n \"fecha\":{ \n \"fechaInicial\": \"2024-03-01\", \n \"fechaFinal\": \"2024-05-30\" \n } \n}\n\n{ \n \"status\": 8, \n \"fecha\": { \n \"fechaInicial\": \"2024-01-06T06:18:30.814Z\", \n \"fechaFinal\": \"2024-06-06T06:18:30.814Z\" \n }, \n \"idSucursal\":1 \n}\n\n{ \n \"status\": 8, \n \"numeroTransaccion\": [\n 1,10\n ], \n \"fecha\": { \n \"fechaInicial\": \"2024-06-06T06:18:30.814Z\", \n \"fechaFinal\": \"2024-06-06T06:18:30.814Z\" \n }, \n \"idSucursal\": 1 \n}\n\nEsta carpeta agrupa todos los endpoints relacionados con los movimientos de inventario
\n","_postman_id":"46ee903c-3768-4460-bc2a-52582f89476a"},{"name":"Configuracion","item":[{"name":"{{base_url}}/api/v1/Sucursal/Sucursales","id":"4fb03095-c6ef-4661-a09c-77f63def942a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"X-ClientId","value":"{{Cliente_id}}","type":"text"}],"url":"{{base_url}}/api/v1/Sucursal/Sucursales","description":"Este endpoint permite al usuario obtener información sobre las Sucursales activas Aplica paginación
\nCada objeto en el arreglo incluye:
\nidSucursal (Integer): Identificador único de la sucursal.
nombre (String): descripcion de la sucursal.
status (Boolean): true si está activo false si no.
sigla (String): Sigla de la sucursal.
[\n {\n \"idSucursal\": 1,\n \"nombre\": \"Principal\",\n \"status\": true,\n \"sigla\": \"PR\"\n },\n {\n \"idSucursal\": 2,\n \"nombre\": \"Show room\",\n \"status\": true,\n \"sigla\": \"VE\"\n }\n]\n\nPermite crear una transacción de inventario
\ntipoTransaccion(int): El número de transacción a crear dentro de SmartBIT las cuales son:
30 = Cotizacion -- Esta transacción no afecta inventario
31 = Pedido -- Esta transacción reserva inventario
10 = Nota de credito cliente -- Esta transacción aplica para anular un documento de factura el doctoRef es obligatorio
codigoCliente (String): Código de cliente que afecta el documento
doctoRef (String): Número de documento de referencia si aplica (obligatorio si es Nota de credito)
observacion (String): Observacion general del documento
idSucursal (int): Número que identifica la sucursal donde se guardara el registro si viene vacio se tomara de la configuracion general
detalle(array): Lista de articulos que afectarán la transacción
codigo (string): Codigo de producto a registrar
serie (String): Serie de producto (obligatorio si aplica serie si no aplica enviar null)
cantidad (double): Cantidad del producto a registrar
precio (double): Precio a asignar si se envia 0 se tomara del precio principal y si existe relacion con el documento de referencia se tomara el precio del documento al que hace referencia
numero (String): número asignado al documento creado.
fecha (Datetime): Fecha de creación del documento en formato ISO 8601.
status (String): Descripcion del estado del documento :
Activo
Autorizado
Operado Completo
Anulado
transaccion (String): Descripcion de la transaccion creada
Enpoints donde permiten registrar o crear transacciones de inventario
\n","_postman_id":"6ab7a645-4812-453a-b9df-ee93e7dca945"},{"name":"Consulta","item":[{"name":"Ventas","item":[{"name":"Ventas","id":"fd31b377-dff9-44e8-a528-37af00e0537a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"X-ClientId","value":"{{Cliente_id}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"idSucursal\": 0,\r\n \"agrupaSucursal\": false,\r\n \"agrupaCliente\": false,\r\n \"agrupaAgrupadores\": false,\r\n \"agruparVendedor\": false,\r\n \"agrupaArticulo\": false,\r\n \"fecha\": {\r\n \"fechaInicial\": \"2026-02-16T18:37:33.595Z\",\r\n \"fechaFinal\": \"2026-03-20T18:37:33.595Z\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/api/v1/MovimientoInventario/Ventas?pagina={{pagina}}&cantidadRegistroPagina={{cantidadRegistroPagina}}","description":"Permite obtener el registro de las ventas , notas de credito y notas de debito y aplicar filtros dentro del proceso aplica paginacion
\nEl cuerpo de la solicitud puede contener los siguientes parámetros:
\nfechaLa respuesta retorna un arreglo de objetos con la siguiente estructura:
\ndetalleCada objeto dentro de detalle incluye los siguientes campos:
clasificadoresCada objeto dentro de clasificadores incluye los siguientes campos:
Estos enpoints retornaran informacion relacionada a ventas
\n","_postman_id":"503aaade-de19-4acb-b839-6f319bae2dec"},{"name":"ConsultaDocto","id":"beda712d-bb0b-40c1-8980-8bd9b5f38878","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"X-ClientId","value":"{{Cliente_id}}"}],"body":{"mode":"raw","raw":"{\r\n \"numero\": \"string\",\r\n \"tipoTransaccion\": 10,\r\n \"muestraDetalle\": true\r\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/api/v1/ConsultaInventario/ConsultaDocto","description":"Este endpoint permite consultar un documento de inventario por su numero de documento y tipo de transacccion
\nnúmero(string): numero que identifica el documento a consultar
tipoTransaccion(int): indica el tipo de transacción:
esto es una lista de transacciones
1 = Factura de Venta
2 = Factura de Compra
4 = Exporta a Sucursal
5 = Importa de Sucursal
6 = Ajustes (+)
7 = Ajustes (-)
10 = Nota de credito cliente
11 = Nota de Credito Proveedor
30 = Cotizacion
31 = Pedido
32 = Preparar Picking
33 = Nota de Debito
50 = Orden de Compra
51 = Importacion (Calculo de CIF)
70 = Despacho
muestraDetalle(bool): por defecto false si se envia true se enviara una lista de los articulos asignados en el documento
Cada objeto en la respuesta contiene los siguientes campos:
\nidSucursal (int): Identificador único de la sucursal.
numero (string): Número de transaccion.
transaccion (string): Tipo de transacción realizada.
fecha (string): Fecha y hora de la transacción en formato ISO 8601.
rucCliente (string): RUC del cliente.
esAgenteRetenedor (boolean): Indica si el cliente es un agente retenedor.
nombreCliente (string): Nombre del cliente.
tipo (int): Tipo de operación, donde -1 1 si la transaccion suma inventario sera positvo si resta inventario sera negativo
detalle (array): Lista de productos involucrados en la transaccion.
Cada objeto en el arreglo detalle incluye:
codigo (string): Código del producto.
producto (string): Descripción del producto.
um (string): Unidad de medida del producto.
cantidadPresentacion (string): Cantidad de producto por presentación.
precioConDescuento (decimal): Precio del producto con descuento aplicado.
descuento (decimal): Valor del descuento aplicado al producto.
cantidad (int): Cantidad de producto despachado, donde -1 1 si suma inventario sera positvo si resta inventario sera negativo
precio (decimal): Precio del producto sin descuento.
serial (string): Serial del producto.
Este endpoint permite al usuario obtener información sobre el inventario de los articulos. Aplica paginación
\nEl cuerpo de la solicitud puede contener los siguientes parámetros:
\ncodigo: Opcional. Lista de códigos a consultar. Puede enviarse como un arreglo de cadenas o como null.
idSucursal: Opcional. Identificador de la sucursal. Puede enviarse como un número entero o como null.
incluirSinExistencia: Opcional. Indica si se deben incluir registros sin existencia. Puede enviarse como true, false o como null.
agrupadores: Opcional. Lista de agrupadores para filtrar la consulta. Puede enviarse como un arreglo de objetos o como null.
Cada objeto dentro de agrupadores debe cumplir:
numeroAgrupador: Condicionalmente obligatorio. Debe enviarse si se incluye agrupadorId. Puede enviarse como un entero o como null solo si no se envía agrupadorId.
agrupadorId: Condicionalmente obligatorio. Debe enviarse si se incluye numeroAgrupador. Puede enviarse como un arreglo de enteros o como null solo si no se envía numeroAgrupador.
> **Nota**: Si uno de los dos campos (`numeroAgrupador` o `agrupadorId`) es enviado, el otro también se vuelve obligatorio. \n\nproveedorId: Opcional. Lista de identificadores de proveedores. Puede enviarse como un arreglo de enteros o como null.
siglaPresentacion: Opcional. Lista de siglas de presentación. Puede enviarse como un arreglo de cadenas o como null.
Cada objeto en el arreglo incluye los siguientes campos:
\nclasificadoresCada objeto dentro de clasificadores incluye los siguientes campos:
Esta carpeta agrupa las diferentes consultas aplicadas a los movimientos de inventario
\n","_postman_id":"e2507535-2cad-4658-8634-4e3f9da7316d"}],"id":"2aa71db9-b819-44b2-9d3b-3db238827c71","description":"Esta carpeta agrupa los procesos relacionados con las transacciones de inventario
\n","_postman_id":"2aa71db9-b819-44b2-9d3b-3db238827c71"}]}