{"info":{"_postman_id":"d38130f4-6401-4aa5-b405-e9c53809c6ee","name":"API documentation","description":"

📄 Inicio

\n

A continuación se detalla la API de ruka

\n

Autenticación Básica

\n

La autenticación básica es un método de seguridad en el protocolo HTTP donde los usuarios envían un nombre de usuario y una contraseña para acceder a recursos protegidos. Las credenciales se envían con cada solicitud en un encabezado Authorization, codificadas en Base64. Por ejemplo:

\n
Authorization: Basic <TOKEN_GENERADO>\n\n

Python (usando requests)

\n

Para realizar una solicitud con autenticación básica en Python, puedes usar la biblioteca requests, que simplifica el manejo de HTTP:

\n
pythonCopy codeimport requests\nfrom requests.auth import HTTPBasicAuth\nurl = 'https://api.example.com/data'\nusername = \"<CLIENT_ID>\";\npassword = \"<CLIENT_SECRET>\";\nresponse = requests.get(url, auth=HTTPBasicAuth(username, password))\nprint(response.text)\n\n
\n

Ruby (usando net/http)

\n

En Ruby, puedes usar la biblioteca estándar net/http para manejar la autenticación básica:

\n
rubyCopy coderequire 'net/http'\nrequire 'uri'\nuri = URI('https://api.example.com/data')\nusername = \"<CLIENT_ID>\";\npassword = \"<CLIENT_SECRET>\";\nrequest = Net::HTTP::Get.new(uri)\nrequest.basic_auth(username, password)\nresponse = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|\n  http.request(request)\nend\nputs response.body\n\n
\n

JavaScript (usando fetch)

\n

Para hacer solicitudes HTTP con autenticación básica en JavaScript en el lado del cliente, puedes usar la API fetch:

\n
javascriptCopy codeconst url = 'https://api.example.com/data';\nconst username = \"<CLIENT_ID>\";\nconst password = \"<CLIENT_SECRET>\";\nconst headers = new Headers();\nheaders.set('Authorization', 'Basic ' + btoa(username + \":\" + password));\nfetch(url, { method: 'GET', headers: headers })\n  .then(response => response.json())\n  .then(data => console.log(data))\n  .catch(error => console.error('Error:', error));\n\n
\n

C# (usando HttpClient)

\n

En C#, puedes usar la clase HttpClient para realizar solicitudes HTTP con autenticación básica:

\n
csharpCopy codeusing System;\nusing System.Net.Http;\nusing System.Text;\nusing System.Threading.Tasks;\npublic class HttpClientExample\n{\n    public static async Task Main(string[] args)\n    {\n        var url = \"https://api.example.com/data\";\n        var username = \"<CLIENT_ID>\";\n        var password = \"<CLIENT_SECRET>\";\n        using (var httpClient = new HttpClient())\n        {\n            var credentials = Convert.ToBase64String(Encoding.ASCII.GetBytes($\"{username}:{password}\"));\n            httpClient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Basic\", credentials);\n            var response = await httpClient.GetAsync(url);\n            var data = await response.Content.ReadAsStringAsync();\n            Console.WriteLine(data);\n        }\n    }\n}\n\n
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"📄 Inicio","slug":"inicio"}],"owner":"38410061","collectionId":"d38130f4-6401-4aa5-b405-e9c53809c6ee","publishedId":"2sAXqqci5N","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"5367e2"},"publishDate":"2024-09-17T20:31:36.000Z"},"item":[{"name":"Reports","item":[{"name":"purchases","id":"345f2115-009f-49c4-9722-46524099d14b","protocolProfileBehavior":{"disabledSystemHeaders":{"accept-encoding":true,"connection":true,"accept":true,"user-agent":true},"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"http://labiferia.ruka.ai/api_v2/reports/purchases?start_date=01-02-2024&end_date=02-02-2024","description":"

Endpoint: Obtener Compras en Formato JSON

\n

Descripción:
Este endpoint devuelve un objeto JSON que representa las compras realizadas en un periodo especificado. Cada factura (DTE) y sus productos asociados son representados como objetos dentro de un arreglo data, facilitando su procesamiento y visualización.

\n

URL: /api/v2/purchases

\n

Método: GET

\n

Parámetros de Query:

\n\n

Validaciones:

\n\n

Respuesta:
La respuesta es un objeto JSON con un solo atributo data, que es un arreglo de objetos. Cada objeto representa una factura o un producto de la factura, con claves que describen cada aspecto relevante del DTE o del producto:

\n
{\n  \"data\": [\n    {\n      \"Folio\": \"12345\",\n      \"Fecha Emisión\": \"01-01-2024\",\n      \"Forma Pago\": \"Efectivo\",\n      \"Comprador\": \"Empresa X\",\n      \"Rut Comprador\": \"76.123.456-7\",\n      \"Tipo DTE\": \"33\",\n      \"Monto Neto\": 100000,\n      \"Monto Total\": 119000,\n      \"Tasa IVA\": 19,\n      \"IVA\": 19000,\n      \"IVA Activo Fijo\": 0,\n      \"Monto IVA No Recuperable\": 0,\n      \"IVA Uso Común\": 0,\n      \"Tipo Documento\": \"Factura\",\n      \"Estado de pago\": \"Pagado\",\n      \"Fecha Recepción\": \"02-01-2024\",\n      \"Fecha Acuse\": \"03-01-2024\",\n      \"Estado Factura\": \"Aceptada\",\n      \"Centro de Costo\": \"Ventas\",\n      \"Fecha Creación\": \"01-01-2024\",\n      \"Fecha Actualización\": \"01-01-2024\",\n      \"Proveedor\": \"Proveedor Z\",\n      \"Rut proveedor\": \"77.123.456-K\",\n      \"Producto\": \"\",\n      \"Estilo\": \"\",\n      \"Descripción proveedor\": \"\",\n      \"Cantidad\": \"\",\n      \"Precio\": \"\",\n      \"Descuento\": \"\",\n      \"Tipo impuesto adicional\": \"\",\n      \"Impuesto adicional\": \"\",\n      \"Monto\": \"\"\n    },\n    {\n      \"Folio\": \"12345\",\n      \"Producto\": \"Producto A\",\n      // más atributos del producto...\n    }\n    // más objetos...\n  ]\n}\n\n
\n

Ejemplo de Uso:
Para obtener las compras desde el 1 de enero de 2024 hasta el 31 de enero de 2024:

\n
GET /api/v2/purchases?start_date=01-01-2024&end_date=31-01-2024\n\n
\n

Errores Comunes:

\n\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"d38130f4-6401-4aa5-b405-e9c53809c6ee","id":"d38130f4-6401-4aa5-b405-e9c53809c6ee","name":"API documentation","type":"collection"}},"urlObject":{"protocol":"http","path":["api_v2","reports","purchases"],"host":["labiferia","ruka","ai"],"query":[{"key":"start_date","value":"01-02-2024"},{"key":"end_date","value":"02-02-2024"}],"variable":[]}},"response":[],"_postman_id":"345f2115-009f-49c4-9722-46524099d14b"},{"name":"purchases_v3","id":"0e2e4dd4-9b75-410a-8875-e67f4c3a5076","protocolProfileBehavior":{"disabledSystemHeaders":{"accept-encoding":true,"connection":true,"accept":true,"user-agent":true},"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"http://labiferia.ruka.ai/api_v2/reports/purchases_v3?start_date=01-05-2025&end_date=04-05-2025","description":"

Endpoint: Obtener Compras en Formato JSON

\n

Descripción:
Este endpoint devuelve un objeto JSON que representa las compras realizadas en un periodo especificado. Cada factura (DTE) y sus productos asociados son representados como objetos dentro de un arreglo data, facilitando su procesamiento y visualización.

\n

URL: /api/v2/purchases

\n

Método: GET

\n

Parámetros de Query:

\n\n

Validaciones:

\n\n

Respuesta:
La respuesta es un objeto JSON con un solo atributo data, que es un arreglo de objetos. Cada objeto representa una factura o un producto de la factura, con claves que describen cada aspecto relevante del DTE o del producto:

\n
{\n  \"data\": [\n    {\n      \"Folio\": \"12345\",\n      \"Fecha Emisión\": \"01-01-2024\",\n      \"Forma Pago\": \"Efectivo\",\n      \"Comprador\": \"Empresa X\",\n      \"Rut Comprador\": \"76.123.456-7\",\n      \"Tipo DTE\": \"33\",\n      \"Monto Neto\": 100000,\n      \"Monto Total\": 119000,\n      \"Tasa IVA\": 19,\n      \"IVA\": 19000,\n      \"IVA Activo Fijo\": 0,\n      \"Monto IVA No Recuperable\": 0,\n      \"IVA Uso Común\": 0,\n      \"Tipo Documento\": \"Factura\",\n      \"Estado de pago\": \"Pagado\",\n      \"Fecha Recepción\": \"02-01-2024\",\n      \"Fecha Acuse\": \"03-01-2024\",\n      \"Estado Factura\": \"Aceptada\",\n      \"Centro de Costo\": \"Ventas\",\n      \"Fecha Creación\": \"01-01-2024\",\n      \"Fecha Actualización\": \"01-01-2024\",\n      \"Proveedor\": \"Proveedor Z\",\n      \"Rut proveedor\": \"77.123.456-K\",\n      \"Producto\": \"\",\n      \"Estilo\": \"\",\n      \"Descripción proveedor\": \"\",\n      \"Cantidad\": \"\",\n      \"Precio\": \"\",\n      \"Descuento\": \"\",\n      \"Tipo impuesto adicional\": \"\",\n      \"Impuesto adicional\": \"\",\n      \"Monto\": \"\"\n    },\n    {\n      \"Folio\": \"12345\",\n      \"Producto\": \"Producto A\",\n      // más atributos del producto...\n    }\n    // más objetos...\n  ]\n}\n\n
\n

Ejemplo de Uso:
Para obtener las compras desde el 1 de enero de 2024 hasta el 31 de enero de 2024:

\n
GET /api/v2/purchases?start_date=01-01-2024&end_date=31-01-2024\n\n
\n

Errores Comunes:

\n\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"d38130f4-6401-4aa5-b405-e9c53809c6ee","id":"d38130f4-6401-4aa5-b405-e9c53809c6ee","name":"API documentation","type":"collection"}},"urlObject":{"protocol":"http","path":["api_v2","reports","purchases_v3"],"host":["labiferia","ruka","ai"],"query":[{"key":"start_date","value":"01-05-2025"},{"key":"end_date","value":"04-05-2025"}],"variable":[]}},"response":[],"_postman_id":"0e2e4dd4-9b75-410a-8875-e67f4c3a5076"},{"name":"product_categories","id":"e331b9f5-b6fe-4fb4-b683-df2910711615","protocolProfileBehavior":{"disabledSystemHeaders":{"accept-encoding":true,"connection":true,"accept":true,"user-agent":true},"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"http://labiferia.ruka.ai/api_v2/reports/product_categories/32","description":"

Endpoint: Obtener Compras en Formato JSON

\n

Descripción:
Este endpoint devuelve un objeto JSON que representa las compras realizadas en un periodo especificado. Cada factura (DTE) y sus productos asociados son representados como objetos dentro de un arreglo data, facilitando su procesamiento y visualización.

\n

URL: /api/v2/purchases

\n

Método: GET

\n

Parámetros de Query:

\n
    \n
  • start_date: Fecha de inicio del periodo de consulta (formato dd-mm-YYYY).
    • \n
  • end_date: Fecha de fin del periodo de consulta (formato dd-mm-YYYY).
    • \n
\n

Validaciones:

\n
    \n
  • Los parámetros start_date y end_date son obligatorios para la consulta.
    • \n
  • La fecha de término (end_date) no debe exceder en más de un mes a la fecha de inicio (start_date).
    • \n
\n

Respuesta:
La respuesta es un objeto JSON con un solo atributo data, que es un arreglo de objetos. Cada objeto representa una factura o un producto de la factura, con claves que describen cada aspecto relevante del DTE o del producto:

\n
{\n  \"data\": [\n    {\n      \"Folio\": \"12345\",\n      \"Fecha Emisión\": \"01-01-2024\",\n      \"Forma Pago\": \"Efectivo\",\n      \"Comprador\": \"Empresa X\",\n      \"Rut Comprador\": \"76.123.456-7\",\n      \"Tipo DTE\": \"33\",\n      \"Monto Neto\": 100000,\n      \"Monto Total\": 119000,\n      \"Tasa IVA\": 19,\n      \"IVA\": 19000,\n      \"IVA Activo Fijo\": 0,\n      \"Monto IVA No Recuperable\": 0,\n      \"IVA Uso Común\": 0,\n      \"Tipo Documento\": \"Factura\",\n      \"Estado de pago\": \"Pagado\",\n      \"Fecha Recepción\": \"02-01-2024\",\n      \"Fecha Acuse\": \"03-01-2024\",\n      \"Estado Factura\": \"Aceptada\",\n      \"Centro de Costo\": \"Ventas\",\n      \"Fecha Creación\": \"01-01-2024\",\n      \"Fecha Actualización\": \"01-01-2024\",\n      \"Proveedor\": \"Proveedor Z\",\n      \"Rut proveedor\": \"77.123.456-K\",\n      \"Producto\": \"\",\n      \"Estilo\": \"\",\n      \"Descripción proveedor\": \"\",\n      \"Cantidad\": \"\",\n      \"Precio\": \"\",\n      \"Descuento\": \"\",\n      \"Tipo impuesto adicional\": \"\",\n      \"Impuesto adicional\": \"\",\n      \"Monto\": \"\"\n    },\n    {\n      \"Folio\": \"12345\",\n      \"Producto\": \"Producto A\",\n      // más atributos del producto...\n    }\n    // más objetos...\n  ]\n}\n\n
\n

Ejemplo de Uso:
Para obtener las compras desde el 1 de enero de 2024 hasta el 31 de enero de 2024:

\n
GET /api/v2/purchases?start_date=01-01-2024&end_date=31-01-2024\n\n
\n

Errores Comunes:

\n
    \n
  • 400 Bad Request si algún parámetro falta o es inválido.
    • \n
  • 400 Bad Request si el intervalo entre las fechas excede un mes.
    • \n
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"d38130f4-6401-4aa5-b405-e9c53809c6ee","id":"d38130f4-6401-4aa5-b405-e9c53809c6ee","name":"API documentation","type":"collection"}},"urlObject":{"protocol":"http","path":["api_v2","reports","product_categories","32"],"host":["labiferia","ruka","ai"],"query":[],"variable":[]}},"response":[],"_postman_id":"e331b9f5-b6fe-4fb4-b683-df2910711615"},{"name":"all_documents","id":"0fa6a12a-75ff-465f-a97f-f15dd6e5c03b","protocolProfileBehavior":{"disabledSystemHeaders":{"accept-encoding":true,"connection":true,"accept":true,"user-agent":true},"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://meltingcook.ruka.ai/api_v2/reports/all_documents?start_date=23-02-2025&end_date=28-02-2025&folio=376483","description":"

Authorization

\n

Basic Auth

\n

Obtener Todos los productos de los documentos de compra

\n

Descripción: Este endpoint permite obtener un reporte de los productos comprados en el período especificado. El reporte incluye detalles como la cantidad de productos, el precio unitario, el IVA, y otras métricas relacionadas con la compra de productos. Además, permite la opción de incluir notas de crédito y realizar la consulta con paginación.

\n

URL

\n
POST /api/v2/reports/all_documents\n\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParámetroTipoRequeridoDescripción
start_dateStringSíFecha de inicio en formato dd-mm-YYYY. Ej: 01-09-2024.
end_dateStringSíFecha de término en formato dd-mm-YYYY. Ej: 30-09-2024.
include_credit_notesBooleanNoIndica si se deben incluir notas de crédito. Valores posibles: true o false (por defecto false).
pageIntegerNoNúmero de la página para la paginación. El valor por defecto es 1.
per_pageIntegerNoNúmero de registros por página. El valor por defecto es 50.
\n

Restricciones

\n

• El rango de fechas (start_date y end_date) no debe exceder los 31 días.

\n

• Ambos parámetros de fecha (start_date y end_date) son obligatorios.

\n

Ejemplo request:

\n

Formato : JSON

\n
{\n  \"start_date\": \"01-09-2024\",\n  \"end_date\": \"30-09-2024\",\n  \"include_credit_notes\": \"false\",\n  \"page\": 1,\n  \"per_page\": 2\n}\n\n
\n

Respuesta

\n

Formato : JSON

\n

La respuesta contendrá un listado de productos y sus detalles, junto con la información de paginación.

\n

Ejemplo de Respuesta:

\n
{\n    \"data\": [\n        {\n            \"fecha\": \"2024-01-24\",\n            \"tipo_dte\": 33,\n            \"proveedor\": \"VICTOR MANUEL LOPEZ RODRIGUEZ\",\n            \"rut_proveedor\": \"8409260-6\",\n            \"folio\": 63639,\n            \"cantidad\": 5.0,\n            \"estilo\": \"Frutas y Verduras Cocina\",\n            \"tipo_producto\": \"ALIMENTO\",\n            \"unidad\": \"KG\",\n            \"nombre_producto\": \"REPOLLO MORADO PROCESADO\",\n            \"precio_unitario\": 2550.0,\n            \"subtotal\": 12750.0,\n            \"iva\": \"2422.5\",\n            \"ila\": 0,\n            \"valor_facturado\": \"15172.5\",\n            \"neto_ila\": 12750.0,\n            \"codigo_producto\": null,\n            \"cuenta_contable\": \"11821029\",\n            \"centro_costo\": \"CLY Vitacura\"\n        },\n        {\n            \"fecha\": \"2024-01-24\",\n            \"tipo_dte\": 33,\n            \"proveedor\": \"VICTOR MANUEL LOPEZ RODRIGUEZ\",\n            \"rut_proveedor\": \"8409260-6\",\n            \"folio\": 63639,\n            \"cantidad\": 5.0,\n            \"estilo\": \"Frutas y Verduras Cocina\",\n            \"tipo_producto\": \"ALIMENTO\",\n            \"unidad\": \"KG\",\n            \"nombre_producto\": \"REPOLLO VERDE PROCESADO\",\n            \"precio_unitario\": 2180.0,\n            \"subtotal\": 10900.0,\n            \"iva\": \"2071.0\",\n            \"ila\": 0,\n            \"valor_facturado\": \"12971.0\",\n            \"neto_ila\": 10900.0,\n            \"codigo_producto\": null,\n            \"cuenta_contable\": \"11821029\",\n            \"centro_costo\": \"CLY Vitacura\"\n        }\n    ],\n    \"pagination\": {\n        \"page\": 1,\n        \"per_page\": 2,\n        \"total_pages\": 599\n    }\n}\n\n
\n

Campos de la respuesta:

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
CampoTipoDescripción
FechaStringFecha de emisión del documento. Formato YYYY-MM-DD.
Tipo DTEStringTipo de Documento Tributario Electrónico. Ej: 33 (Factura).
ProveedorStringNombre del proveedor que emitió la factura.
RutStringRUT del proveedor.
FolioStringNúmero de folio de la factura.
CantidadIntegerCantidad de productos comprados.
EstiloStringEstilo del producto. Si no aplica, devuelve \"sin estilo\".
TipoStringTipo del producto. Si no aplica, devuelve sin tipo.
UnidadStringUnidad de medida del producto.
Nombre del productoStringNombre del producto comprado.
P/UFloatPrecio unitario del producto.
SubtotalFloatSubtotal antes de impuestos.
IVAFloatImpuesto al Valor Agregado (IVA) correspondiente.
ILAFloatImpuesto adicional si aplica.
Valor FacturadoFloatTotal facturado (incluye IVA y ILA).
Neto + ILAFloatTotal neto más el ILA (si aplica).
CódigoStringCódigo del producto.
Cuenta contableStringCuenta contable asociada al producto. Si no aplica, devuelve sin cuenta.
CCStringCentro de costo asociado a la compra. Si no aplica, devuelve sin centro de costo.
\n
","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"d38130f4-6401-4aa5-b405-e9c53809c6ee","id":"d38130f4-6401-4aa5-b405-e9c53809c6ee","name":"API documentation","type":"collection"}},"urlObject":{"protocol":"https","path":["api_v2","reports","all_documents"],"host":["meltingcook","ruka","ai"],"query":[{"key":"start_date","value":"23-02-2025"},{"key":"end_date","value":"28-02-2025"},{"key":"folio","value":"376483"}],"variable":[]}},"response":[],"_postman_id":"0fa6a12a-75ff-465f-a97f-f15dd6e5c03b"},{"name":"flat_purchases","id":"3d0a974c-7337-4383-9dce-e6f331f6e156","protocolProfileBehavior":{"disabledSystemHeaders":{"accept-encoding":true,"connection":true,"accept":true,"user-agent":true},"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://meltingcook.ruka.ai/api_v2/reports/flat_purchases?start_date=10-02-2025&end_date=10-02-2025","description":"

Endpoint: Obtener Compras en Formato Tabla

\n

Descripción:
Este endpoint retorna un arreglo de arreglos que representan las compras en formato de tabla. Cada elemento del arreglo principal representa una fila de la tabla. El primer elemento del arreglo contiene los encabezados de la tabla, describiendo cada columna de los datos que siguen. Cada factura (DTE) se muestra con sus respectivos productos (items) listados bajo ella, formando filas consecutivas en la tabla.

\n

URL: /api/v2/purchases

\n

Método: GET

\n

Parámetros de Query:

\n
    \n

  • start_date: Fecha de inicio del periodo de consulta (formato dd-mm-YYYY).

    \n
    • \n

  • end_date: Fecha de fin del periodo de consulta (formato dd-mm-YYYY).

    \n
    • \n
\n

Validaciones:

\n
    \n

  • Ambos parámetros start_date y end_date son obligatorios.

    \n
    • \n

  • La fecha de término no debe exceder en más de un mes a la fecha de inicio.

    \n
    • \n
\n

Respuesta:
La respuesta será un arreglo de arreglos. El primer arreglo contiene los encabezados de las columnas:

\n
jsonCopy code[\n  \"Folio\",\n  \"Fecha Emisión\",\n  \"Forma Pago\",\n  \"Comprador\",\n  \"Rut Comprador\",\n  \"Tipo DTE\",\n  \"Monto Neto\",\n  \"Monto Total\",\n  \"Tasa IVA\",\n  \"IVA\",\n  \"IVA Activo Fijo\",\n  \"Monto IVA No Recuperable\",\n  \"IVA Uso Común\",\n  \"Tipo Documento\",\n  \"Estado de pago\",\n  \"Fecha Recepción\",\n  \"Fecha Acuse\",\n  \"Estado Factura\",\n  \"Centro de Costo\",\n  \"Fecha Creación\",\n  \"Fecha Actualización\",\n  \"Proveedor\",\n  \"Rut proveedor\",\n  \"Producto\",\n  \"Estilo\",\n  \"Descripción proveedor\",\n  \"Cantidad\",\n  \"Precio\",\n  \"Descuento\",\n  \"Tipo impuesto adicional\",\n  \"Impuesto adicional\",\n  \"Monto\"\n]\n\n

Cada fila subsiguiente representa una factura o un producto asociado a una factura, con los valores correspondientes a cada encabezado. Los detalles de los productos se listan inmediatamente después de su factura asociada, con montos financieros ajustados según sea necesario.

\n

Ejemplo de Respuesta:

\n
[\n  [\n    \"Folio\",\n    \"Fecha Emisión\",\n    // más encabezados...\n  ],\n  [\n    \"12345\",\n    \"01-01-2024\",\n    // más datos de la factura...\n  ],\n  [\n    \"12345\",\n    \"01-01-2024\",\n    // datos del producto asociado...\n  ]\n  // más filas...\n]\n\n
\n

Errores Comunes:

\n
    \n

  • 400 Bad Request si falta algún parámetro o los parámetros de fecha son inválidos.

    \n
    • \n

  • 400 Bad Request si el rango de fechas excede el límite de un mes.

    \n
    • \n
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"d38130f4-6401-4aa5-b405-e9c53809c6ee","id":"d38130f4-6401-4aa5-b405-e9c53809c6ee","name":"API documentation","type":"collection"}},"urlObject":{"protocol":"https","path":["api_v2","reports","flat_purchases"],"host":["meltingcook","ruka","ai"],"query":[{"key":"start_date","value":"10-02-2025"},{"key":"end_date","value":"10-02-2025"}],"variable":[]}},"response":[],"_postman_id":"3d0a974c-7337-4383-9dce-e6f331f6e156"},{"name":"all_invoices","id":"d27283fb-bd12-4fa1-861a-e4625f8b6f9d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"description":"

GET

\n

all_invoices

\n
https://subdominio.ruka.ai/api_v2/reports/all_invoices?start_date=23-02-2025&end_date=28-02-2025&supplier=99999999-9\n
\n

Authorization

\n

Basic Auth

\n
\n

Obtener todas las facturas del período

\n

Descripción:
Este endpoint genera un reporte de facturas dentro del rango de fechas indicado. Permite filtrar por proveedor, tipo de DTE, centros de costo, incluir o no notas de crédito y elegir si solo se muestran facturas marcadas como revisadas. La respuesta puede paginarse.

\n
\n

URL

\n

Plain Text

\n
GET /api/v2/reports/all_invoices\n
\n
\n

Parámetros

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParámetroTipoRequeridoDescripción
start_dateStringSíFecha de inicio en formato dd-mm-YYYY. Ej: 01-09-2024.
end_dateStringSíFecha de término en formato dd-mm-YYYY. Ej: 30-09-2024.
supplierStringNoRUT del proveedor (sin puntos, con guion).
include_credit_notesBooleanNoIncluir notas de crédito (tipo DTE 61). Por defecto: false.
only_checkedBooleanNoSi es true, solo devuelve facturas con fecha de revisión.
include_g_admBooleanNoIncluir facturas de administración general. Por defecto: false.
cost_centersStringNoLista de centros de costo separados por coma.
tipo_dteIntegerNoFiltra por tipo de DTE (por ejemplo 33, 34, 61, etc.).
pageIntegerNoNúmero de página. Por defecto: 1.
per_pageIntegerNoRegistros por página. Por defecto: 50.
\n
\n

Restricciones

\n
    \n
  • El rango de fechas (start_date y end_date) no debe exceder los 31 días.
    • \n
  • Ambos parámetros de fecha son obligatorios.
    • \n
\n
\n

Ejemplo request

\n

Formato : JSON

\n
{\n  \"start_date\": \"01-09-2024\",\n  \"end_date\": \"30-09-2024\",\n  \"supplier\": \"99999999-9\",\n  \"include_credit_notes\": \"false\",\n  \"only_checked\": \"false\",\n  \"page\": 1,\n  \"per_page\": 2\n}\n
\n
\n

Respuesta

\n

Formato : JSON
La respuesta contendrá un listado de facturas y datos asociados, junto con la información de paginación.

\n

Ejemplo de Respuesta:

\n
{\n  \"data\": [\n    {\n      \"id_invoice\": 123,\n      \"tipo_compra\": \"Del giro\",\n      \"fecha_emision\": \"2024-01-24\",\n      \"fecha_acuse\": \"2024-01-25\",\n      \"fecha_reporte\": \"2024-01-26\",\n      \"fecha_revision\": null,\n      \"fecha_recepcion\": \"2024-01-24\",\n      \"tipo_dte\": 33,\n      \"proveedor\": \"PROVEEDOR SPA\",\n      \"rut_proveedor\": \"99999999-9\",\n      \"categoria\": \"Alimentos\",\n      \"folio\": 45678,\n      \"estilo\": \"General\",\n      \"tipo_producto\": \"ALIMENTO\",\n      \"comprador\": \"Comercial XYZ\",\n      \"centro_de_costo\": \"CLY Vitacura\",\n      \"estado_de_pago\": \"pendiente\",\n      \"cuenta_bancaria\": \"CTA CORRIENTE 123\",\n      \"fecha_pago\": null,\n      \"comentario_pago\": null,\n      \"monto_exento\": 0.0,\n      \"monto_neto\": 10000.0,\n      \"iva\": 1900.0,\n      \"otros_impuestos\": 0.0,\n      \"monto_total\": 11900.0,\n      \"chequeada\": \"false\"\n    }\n  ],\n  \"pagination\": {\n    \"page\": 1,\n    \"per_page\": 2,\n    \"total_pages\": 10\n  }\n}\n
\n
\n

Campos de la respuesta

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
CampoTipoDescripción
id_invoiceIntegerIdentificador interno de la factura.
tipo_compraStringTipo de compra (en esta consulta, \"Del giro\").
fecha_emisionStringFecha de emisión del documento. Formato dd-mm-YYYY.
fecha_acuseStringFecha de acuse recibo. Formato dd-mm-YYYY.
fecha_reporteStringMes contable de reporte. Formato dd-mm-YYYY.
fecha_revisionStringFecha en que fue revisada la factura (si existe).
fecha_recepcionStringFecha de recepción.
tipo_dteIntegerTipo de Documento Tributario Electrónico.
proveedorStringNombre o razón social del proveedor.
rut_proveedorStringRUT del proveedor.
categoriaStringCategoría asociada al proveedor.
folioStringFolio de la factura.
estiloStringEstilo principal deducido de los productos.
tipo_productoStringTipo de producto asociado.
compradorStringNombre del comprador.
centro_de_costoStringCentro de costo asignado.
estado_de_pagoStringEstado de pago de la factura.
cuenta_bancariaStringCuenta bancaria asociada al pago (si existe).
fecha_pagoStringFecha de pago (si existe).
comentario_pagoStringComentario ingresado al registrar el pago (opcional).
monto_exentoFloatMonto exento de IVA.
monto_netoFloatMonto neto.
ivaFloatIVA de la factura.
otros_impuestosFloatOtros impuestos aplicados.
monto_totalFloatTotal facturado.
chequeadaString\"true\" si la factura fue revisada; en caso contrario, \"false\".
\n

Paginación

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
CampoTipoDescripción
pageIntegerPágina actual.
per_pageIntegerRegistros por página.
total_pagesIntegerNúmero total de páginas disponibles.
\n
","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"d38130f4-6401-4aa5-b405-e9c53809c6ee","id":"d38130f4-6401-4aa5-b405-e9c53809c6ee","name":"API documentation","type":"collection"}},"urlObject":{"query":[],"variable":[]},"url":""},"response":[],"_postman_id":"d27283fb-bd12-4fa1-861a-e4625f8b6f9d"}],"id":"434a7c66-2169-4965-b198-c2731679fa98","description":"

Endpoints para obtener reportes relacionadas a las compras de un comercio

\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","packages":{},"exec":[""],"id":"1287ea8c-f9f8-4f19-b86d-acbb25120565"}},{"listen":"test","script":{"type":"text/javascript","packages":{},"exec":[""],"id":"2f8c1b58-4c06-4a9f-a6e2-8229f7a47c37"}}],"_postman_id":"434a7c66-2169-4965-b198-c2731679fa98","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"d38130f4-6401-4aa5-b405-e9c53809c6ee","id":"d38130f4-6401-4aa5-b405-e9c53809c6ee","name":"API documentation","type":"collection"}}},{"name":"test_login","id":"2e582879-89e1-436a-9477-f9a9d7d70e63","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":false},"method":"GET","header":[],"url":"https://altojapon.ruka.ai/api_v2/test_login","description":"

Endpoint para probar las credenciales

\n","urlObject":{"protocol":"https","path":["api_v2","test_login"],"host":["altojapon","ruka","ai"],"query":[],"variable":[]}},"response":[],"_postman_id":"2e582879-89e1-436a-9477-f9a9d7d70e63"}],"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]}},"event":[{"listen":"prerequest","script":{"id":"3201e9d2-3044-4c84-b210-c3124e3ec69c","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"7a97d237-e120-48dc-a6bf-923df5b2d151","type":"text/javascript","exec":[""]}}],"variable":[{"key":"URL","value":""},{"key":"client_id","value":"","type":"string"},{"key":"client_secret","value":"","type":"string"}]}