{"metadata":{"image":[],"title":"","description":""},"api":{"url":"","auth":"required","settings":"","results":{"codes":[]},"params":[],"examples":{"codes":[]}},"next":{"description":"","pages":[]},"title":"Descripción general","type":"basic","slug":"debit-notes","excerpt":"Endpoint /debit-notes","body":"Las notas débito son documentos que te permiten registrar devoluciones de inventarios que realices a tus proveedores, así como la disminución de gastos o la devolución por completo de una factura de compra. Si tu proveedor te entrega una nota de crédito, puedes registrarla como una nota débito en Alegra.\n\nUna nota débito contiene los siguientes atributos:\n\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Nombre\",\n    \"h-1\": \"Tipo\",\n    \"h-2\": \"Descripción\",\n    \"h-3\": \"Ejemplo\",\n    \"0-0\": \"id\",\n    \"0-1\": \"Integer\",\n    \"0-2\": \"Identificador único que representa una nota débito específica. La aplicación lo asigna automáticamente.\",\n    \"0-3\": \"10\",\n    \"1-0\": \"date\",\n    \"1-1\": \"String.  Formato yyyy-MM-dd\",\n    \"1-2\": \"Fecha de la nota débito\",\n    \"1-3\": \"2019-09-11\",\n    \"2-0\": \"observations\",\n    \"2-1\": \"String\",\n    \"2-2\": \"Observaciones de la nota débito. No visibles en el documento impreso o PDF.\",\n    \"2-3\": \"Se han modificado los precios de los items de la nota de crédito.\",\n    \"3-0\": \"termsConditions\",\n    \"3-1\": \"String\",\n    \"3-2\": \"Términos y condiciones aplicables a la nota de crédito.  Visibles en el documento impreso o PDF.\",\n    \"3-3\": \"Limite garantía de 1 año.\",\n    \"4-0\": \"client\",\n    \"4-1\": \"Object\",\n    \"4-2\": \"Objeto que contiene la información del cliente asociado a la nota débito.\",\n    \"4-3\": \"```\\n{\\n\\\"id\\\": 1,\\n\\\"name\\\": \\\"Coorporación Alegrate\\\",                        \\\"identification\\\": \\\"159.549.847\\\",\\n\\\"email\\\": \\\"prueba:::at:::alegra.com\\\",                      \\\"phonePrimary\\\": \\\"999-99-99\\\",\\n\\\"phoneSecondary\\\": \\\"\\\",\\n\\\"fax\\\": \\\"\\\",\\n\\\"mobile\\\": \\\"(333) 555-55-55\\\",\\n\\\"address\\\" : {\\n   \\\"address\\\" : \\\"Calle principal #45\\\",\\n    \\\"city\\\" : \\\"Barcelona\\\"\\n  }\\n}\\n```\",\n    \"5-0\": \"numberTemplate\",\n    \"5-1\": \"Object\",\n    \"5-2\": \"Objeto que contiene la información de la numeración de la nota débito.  Contiene los siguientes atributos:\\n* id : Identificador del numberTemplate.\\n* prefix : Prefijo de la nota débito.\\n* number: Número de la nota débito.\\n* documentType: Tipo del document.\",\n    \"5-3\": \"```\\n{\\n\\\"id\\\" : 1,\\n\\\"prefix\\\" : \\\"A-\\\",\\n\\\"number\\\" : 520,\\n\\\"documentType\\\" : \\\"debitNote\\\"\\n}\\n```\",\n    \"6-0\": \"warehouse\",\n    \"6-1\": \"Object\",\n    \"6-2\": \"Objeto que contiene la información de la bodega de la nota débito.  Contiene los siguientes atributos:\\n* id: Identificador de la bodega.\\n* name: Nombre de la bodega.\\n* observations: Observaciones de la bodega.\\n* isDefault: True, si es la bodega predeterminada.\\n* address: Dirección fisica de la bodega.\\n* status: Estado de la bodega.\",\n    \"6-3\": \"```\\n\\\"warehouse\\\": {\\n     \\\"id\\\": \\\"1\\\",\\n      \\\"name\\\": \\\"Principal\\\",\\n      \\\"observations\\\": null,\\n      \\\"isDefault\\\": true,\\n       \\\"address\\\": \\\"Carrera 1 \\n                         #2-40,\\n       \\\"status\\\": \\\"active\\\"\\n}\\n```\",\n    \"7-0\": \"total\",\n    \"7-1\": \"Double\",\n    \"7-2\": \"Total de la nota débito. Se debe tener en cuenta que el total de la nota débito es calculado según la precisión decimal que tenga configurada la empresa al momento de crear la nota débito y conforma la suma de los items y categorías asociados a la nota débito.\",\n    \"7-3\": \"12500.45\",\n    \"8-0\": \"balance\",\n    \"8-1\": \"Double\",\n    \"8-2\": \"Saldo pendiente por aplicar a la nota débito. Es la resta del total menos el totalApplied.\",\n    \"8-3\": \"12000.45\",\n    \"9-0\": \"totalApplied\",\n    \"9-1\": \"Double\",\n    \"9-2\": \"Total aplicado a la nota débito. Esta conformado por la sumatoria de todos los reembolsos y facturas de proveedor asociados a la nota débito.\",\n    \"9-3\": \"500.00\",\n    \"10-0\": \"decimalPrecision\",\n    \"10-1\": \"Integer\",\n    \"10-2\": \"Precisión decimal de la nota de crédito.\",\n    \"10-3\": \"2\",\n    \"11-0\": \"items\",\n    \"11-1\": \"Array\",\n    \"11-2\": \"Array de objetos Item, que contiene los productos asociados a la nota débito. Estos solamente pueden ser productos inventariables.\\nCada objeto contiene los siguientes atributos:\\n* id: Identificador del producto o servicio vendido. \\n* name: Nombre del producto o servicio.\\n* description: Descripción del producto o servicio.\\n* reference: Referencia del producto o servicio\\n* discount: Porcentaje de descuento aplicado al producto.\\n* tax: Array de objetos tax que indican los impuestos aplicados al producto o servicio al momento de la venta.\\n* price: Precio de venta del producto o servicio.\\n* quantity: Cantidad vendida del producto o servicio.\\n* total: Total del producto (no incluye impuestos).\",\n    \"11-3\": \"```\\n[\\n{\\n\\\"id\\\": 1,\\n\\\"name\\\": \\\"Billetera\\\",\\n\\\"description\\\": \\\"Billetera de cuero negro\\\",\\n\\\"reference\\\": \\\"REF-005\\\",\\n\\\"discount\\\" : 10,\\n\\\"tax\\\" : [\\n{\\n\\\"id\\\" : 6,\\n\\\"name\\\" : \\\"IVA\\\",\\n\\\"percentage\\\" : 16,\\n\\\"description\\\" : \\\"Impuesto de valor agregado\\\",\\n\\\"type\\\": \\\"IVA\\\",\\n\\\"status\\\": \\\"active\\\"\\n}\\n],\\n\\\"price\\\" : 80,\\n\\\"quantity\\\" : 5\\n},\\n\\\"total\\\" : 360\\n```\",\n    \"13-0\": \"refunds\",\n    \"13-1\": \"Array\",\n    \"13-2\": \"Array que contiene los desembolsos realizados en la nota débito. Cada reembolso representa un transacción con los siguientes datos:\\n* id: Identificador de la transacción asociada al reembolso.\\n* number: número de la transacción asociada al reembolso.\\n* date: fecha de la transacción asociada al reembolso.\\n* bankAccount: cuenta bancaria de la transacción asociada al reembolso.\\n* amount: monto del reembolso reembolso. \\n* observations: observaciones asociadas al reembolso.\\n* anotation: anotación transacción asociada al reembolso.\\n* type: tipo transacción asociada al reembolso. Siempre sera \\\"in\\\" para este caso.\\n* paymentMethod: método de pago de la transacción asociada al reembolso.\",\n    \"13-3\": \"```\\n\\\"refunds\\\": [\\n{\\n\\\"id\\\": \\\"8\\\",\\n\\\"number\\\": \\\"4\\\",\\n\\\"date\\\": \\\"2020-04-01\\\",\\n\\\"bankAccount\\\": {\\n\\\"id\\\": \\\"2\\\",\\n\\\"name\\\": \\\"Banco 1\\\"\\n},\\n\\\"amount\\\": 100,\\n\\\"observations\\\": \\\"dslkjs dlkjsdkj dsds\\\",\\n\\\"anotation\\\": null,\\n \\\"type\\\": \\\"in\\\",\\n\\\"paymentMethod\\\": \\\"\\\",\\n\\\"status\\\": \\\"open\\\",\\n}\\n]\\n```\",\n    \"14-0\": \"bills\",\n    \"14-1\": \"Array\",\n    \"14-2\": \"Array que contiene las facturas de proveedor asociadas a la nota débito.\",\n    \"14-3\": \"```\\n\\\"bills\\\": [\\n{\\n\\\"id\\\": \\\"64\\\",\\n\\\"prefix\\\": \\\"\\\",\\n\\\"number\\\": \\\"\\\",\\n\\\"date\\\": \\\"2019-11-01\\\",\\n\\\"dueDate\\\": \\\"2019-11-01\\\",\\n\\\"observations\\\": \\\"\\\",\\n\\\"termsConditions\\\": null,\\n\\\"status\\\": \\\"open\\\",\\n\\\"amount\\\": 920,\\n\\\"total\\\": 6000,\\n\\\"balance\\\": 4080\\n}\\n]\\n```\",\n    \"15-0\": \"currency\",\n    \"15-1\": \"Object\",\n    \"15-2\": \"Objeto que incluye la información de la moneda asociada a la nota débito.\\n** Solo se incluye si la compañía tiene activo multimoneda y la factura está en una moneda diferente de la principal de la compañía.\\n**\\nEste objeto contiene:\\n* code : Código ISO de la moneda asociada a la empresa.\\n* exchangeRate: Tasa de cambio.\\n* symbol: Simbolo de la moneda.\",\n    \"15-3\": \"````\\n\\\"currency\\\": {\\n\\\"code\\\": \\\"EUR\\\",\\n\\\"symbol\\\": \\\"€\\\",\\n\\\"exchangeRate\\\": \\\"300.00000000\\\"\\n}\\n```\",\n    \"12-0\": \"categories\",\n    \"12-1\": \"Array\",\n    \"12-2\": \"Array de objetos Category, que contiene las categorías asociadas a la nota débito. Estas solamente pueden ser de tipo \\\"expense\\\" (Egreso) o \\\"asset\\\" (Activo).\\nCada objeto contiene los siguientes atributos:\\n* id: Identificador de la categoría. \\n* name: Nombre de la categoría.\\n* observations: Observaciones sobre la la categoría.\\n* tax: Array de objetos tax que indican los impuestos aplicados a la categoría al momento del débito.\\n* price: Precio de venta de la categoría.\\n* quantity: Cantidad de la categoría.\\n* subtotal: Subtotal de la categoría (no incluye impuestos)\\n* total: Total de la categoría\",\n    \"12-3\": \"```\\n[\\n{\\n\\\"id\\\": 5072,\\n\\\"name\\\": \\\"Costos de ventas y operación\\\",\\n\\\"observations\\\": \\\"\\\",\\n\\\"tax\\\" : [\\n{\\n\\\"id\\\" : 6,\\n\\\"name\\\" : \\\"IVA\\\",\\n\\\"percentage\\\" : 16,\\n\\\"description\\\" : \\\"Impuesto de valor agregado\\\",\\n\\\"type\\\": \\\"IVA\\\",\\n\\\"status\\\": \\\"active\\\"\\n}\\n],\\n\\\"price\\\" : 80,\\n\\\"quantity\\\" : 5,\\n\\\"subtotal\\\": 400,\\n\\\"total\\\": 928\\n},\\n```\"\n  },\n  \"cols\": 4,\n  \"rows\": 16\n}\n[/block]","updates":[],"order":0,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5ec7f549ff8757007254b8b0","createdAt":"2020-05-22T15:52:41.641Z","user":"56abd213d4432d1900eed227","category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"Notas Débito","slug":"notas-débito","order":23,"from_sync":false,"reference":false,"_id":"5ec7defc6aa2be001e7504f5","createdAt":"2020-05-22T14:17:32.848Z","version":"56abd2434e4b730d009eb10d","project":"56abd2434e4b730d009eb10a","__v":0},"version":{"version":"1","version_clean":"1.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["56abd2444e4b730d009eb10e","56abd4c8f25f160d00e17f81","56abd72ff25f160d00e17f84","56b3b8ea9f97020d0012d936","56b3b91ac25dea2b00b0cac9","56b4b2faeed075230097d688","56b4b32deed075230097d689","56b4b37327d9c00d005d6bc4","56b4b3bf3d5f130d00dad120","56b4b3d9eed075230097d68a","56b4b3eb7bccae0d00e9a12e","56b4b4085997532100bc6b61","56fbce6e2885e80e006c855f","5739ed9aad40e23200f674b6","573dd672b3f88f0e00dcae1c","58ad0922e570c62500512a82","58ad092b55018f1900218fda","58e412a5aa544d1b0005f7da","59e62c2a3ccab100263e800a","59e63126b4f8b0002edbe92c","5b5bbc98eaf71700031c2fda","5bedb529a56934002ee522b9","5c3e39454d3006001420f73e","5c4f5c0e1555130014796daa","5c6ac741acb04f003f927fa7","5c7e9c7c412d4c003f750162","5d055915910ab30020e5bc06","5d76e2018e0ce7006c82dbe1","5d9ca92eac34370012872d08","5d9f8149103b9f006c1421e0","5e3098aba5919200612d0c33","5e8ca028538a310018ccd2df","5e9f0d4c720ad8006c6c7dc1","5ea9c2f382fcd2003df9f412","5ec7defc6aa2be001e7504f5","5ed8f716a8308c0412b5473a","5ed9274fe5a9b8041fd1df43","5ed92afa0d09d60253220b3f","5efcff9cd7e1be00118e8272"],"_id":"56abd2434e4b730d009eb10d","project":"56abd2434e4b730d009eb10a","releaseDate":"2016-01-29T20:57:39.712Z","__v":39,"createdAt":"2016-01-29T20:57:39.712Z"},"project":"56abd2434e4b730d009eb10a","__v":0,"parentDoc":null}

Descripción general

Endpoint /debit-notes

Las notas débito son documentos que te permiten registrar devoluciones de inventarios que realices a tus proveedores, así como la disminución de gastos o la devolución por completo de una factura de compra. Si tu proveedor te entrega una nota de crédito, puedes registrarla como una nota débito en Alegra. Una nota débito contiene los siguientes atributos: [block:parameters] { "data": { "h-0": "Nombre", "h-1": "Tipo", "h-2": "Descripción", "h-3": "Ejemplo", "0-0": "id", "0-1": "Integer", "0-2": "Identificador único que representa una nota débito específica. La aplicación lo asigna automáticamente.", "0-3": "10", "1-0": "date", "1-1": "String. Formato yyyy-MM-dd", "1-2": "Fecha de la nota débito", "1-3": "2019-09-11", "2-0": "observations", "2-1": "String", "2-2": "Observaciones de la nota débito. No visibles en el documento impreso o PDF.", "2-3": "Se han modificado los precios de los items de la nota de crédito.", "3-0": "termsConditions", "3-1": "String", "3-2": "Términos y condiciones aplicables a la nota de crédito. Visibles en el documento impreso o PDF.", "3-3": "Limite garantía de 1 año.", "4-0": "client", "4-1": "Object", "4-2": "Objeto que contiene la información del cliente asociado a la nota débito.", "4-3": "```\n{\n\"id\": 1,\n\"name\": \"Coorporación Alegrate\", \"identification\": \"159.549.847\",\n\"email\": \"[email protected]\", \"phonePrimary\": \"999-99-99\",\n\"phoneSecondary\": \"\",\n\"fax\": \"\",\n\"mobile\": \"(333) 555-55-55\",\n\"address\" : {\n \"address\" : \"Calle principal #45\",\n \"city\" : \"Barcelona\"\n }\n}\n```", "5-0": "numberTemplate", "5-1": "Object", "5-2": "Objeto que contiene la información de la numeración de la nota débito. Contiene los siguientes atributos:\n* id : Identificador del numberTemplate.\n* prefix : Prefijo de la nota débito.\n* number: Número de la nota débito.\n* documentType: Tipo del document.", "5-3": "```\n{\n\"id\" : 1,\n\"prefix\" : \"A-\",\n\"number\" : 520,\n\"documentType\" : \"debitNote\"\n}\n```", "6-0": "warehouse", "6-1": "Object", "6-2": "Objeto que contiene la información de la bodega de la nota débito. Contiene los siguientes atributos:\n* id: Identificador de la bodega.\n* name: Nombre de la bodega.\n* observations: Observaciones de la bodega.\n* isDefault: True, si es la bodega predeterminada.\n* address: Dirección fisica de la bodega.\n* status: Estado de la bodega.", "6-3": "```\n\"warehouse\": {\n \"id\": \"1\",\n \"name\": \"Principal\",\n \"observations\": null,\n \"isDefault\": true,\n \"address\": \"Carrera 1 \n #2-40,\n \"status\": \"active\"\n}\n```", "7-0": "total", "7-1": "Double", "7-2": "Total de la nota débito. Se debe tener en cuenta que el total de la nota débito es calculado según la precisión decimal que tenga configurada la empresa al momento de crear la nota débito y conforma la suma de los items y categorías asociados a la nota débito.", "7-3": "12500.45", "8-0": "balance", "8-1": "Double", "8-2": "Saldo pendiente por aplicar a la nota débito. Es la resta del total menos el totalApplied.", "8-3": "12000.45", "9-0": "totalApplied", "9-1": "Double", "9-2": "Total aplicado a la nota débito. Esta conformado por la sumatoria de todos los reembolsos y facturas de proveedor asociados a la nota débito.", "9-3": "500.00", "10-0": "decimalPrecision", "10-1": "Integer", "10-2": "Precisión decimal de la nota de crédito.", "10-3": "2", "11-0": "items", "11-1": "Array", "11-2": "Array de objetos Item, que contiene los productos asociados a la nota débito. Estos solamente pueden ser productos inventariables.\nCada objeto contiene los siguientes atributos:\n* id: Identificador del producto o servicio vendido. \n* name: Nombre del producto o servicio.\n* description: Descripción del producto o servicio.\n* reference: Referencia del producto o servicio\n* discount: Porcentaje de descuento aplicado al producto.\n* tax: Array de objetos tax que indican los impuestos aplicados al producto o servicio al momento de la venta.\n* price: Precio de venta del producto o servicio.\n* quantity: Cantidad vendida del producto o servicio.\n* total: Total del producto (no incluye impuestos).", "11-3": "```\n[\n{\n\"id\": 1,\n\"name\": \"Billetera\",\n\"description\": \"Billetera de cuero negro\",\n\"reference\": \"REF-005\",\n\"discount\" : 10,\n\"tax\" : [\n{\n\"id\" : 6,\n\"name\" : \"IVA\",\n\"percentage\" : 16,\n\"description\" : \"Impuesto de valor agregado\",\n\"type\": \"IVA\",\n\"status\": \"active\"\n}\n],\n\"price\" : 80,\n\"quantity\" : 5\n},\n\"total\" : 360\n```", "13-0": "refunds", "13-1": "Array", "13-2": "Array que contiene los desembolsos realizados en la nota débito. Cada reembolso representa un transacción con los siguientes datos:\n* id: Identificador de la transacción asociada al reembolso.\n* number: número de la transacción asociada al reembolso.\n* date: fecha de la transacción asociada al reembolso.\n* bankAccount: cuenta bancaria de la transacción asociada al reembolso.\n* amount: monto del reembolso reembolso. \n* observations: observaciones asociadas al reembolso.\n* anotation: anotación transacción asociada al reembolso.\n* type: tipo transacción asociada al reembolso. Siempre sera \"in\" para este caso.\n* paymentMethod: método de pago de la transacción asociada al reembolso.", "13-3": "```\n\"refunds\": [\n{\n\"id\": \"8\",\n\"number\": \"4\",\n\"date\": \"2020-04-01\",\n\"bankAccount\": {\n\"id\": \"2\",\n\"name\": \"Banco 1\"\n},\n\"amount\": 100,\n\"observations\": \"dslkjs dlkjsdkj dsds\",\n\"anotation\": null,\n \"type\": \"in\",\n\"paymentMethod\": \"\",\n\"status\": \"open\",\n}\n]\n```", "14-0": "bills", "14-1": "Array", "14-2": "Array que contiene las facturas de proveedor asociadas a la nota débito.", "14-3": "```\n\"bills\": [\n{\n\"id\": \"64\",\n\"prefix\": \"\",\n\"number\": \"\",\n\"date\": \"2019-11-01\",\n\"dueDate\": \"2019-11-01\",\n\"observations\": \"\",\n\"termsConditions\": null,\n\"status\": \"open\",\n\"amount\": 920,\n\"total\": 6000,\n\"balance\": 4080\n}\n]\n```", "15-0": "currency", "15-1": "Object", "15-2": "Objeto que incluye la información de la moneda asociada a la nota débito.\n** Solo se incluye si la compañía tiene activo multimoneda y la factura está en una moneda diferente de la principal de la compañía.\n**\nEste objeto contiene:\n* code : Código ISO de la moneda asociada a la empresa.\n* exchangeRate: Tasa de cambio.\n* symbol: Simbolo de la moneda.", "15-3": "````\n\"currency\": {\n\"code\": \"EUR\",\n\"symbol\": \"€\",\n\"exchangeRate\": \"300.00000000\"\n}\n```", "12-0": "categories", "12-1": "Array", "12-2": "Array de objetos Category, que contiene las categorías asociadas a la nota débito. Estas solamente pueden ser de tipo \"expense\" (Egreso) o \"asset\" (Activo).\nCada objeto contiene los siguientes atributos:\n* id: Identificador de la categoría. \n* name: Nombre de la categoría.\n* observations: Observaciones sobre la la categoría.\n* tax: Array de objetos tax que indican los impuestos aplicados a la categoría al momento del débito.\n* price: Precio de venta de la categoría.\n* quantity: Cantidad de la categoría.\n* subtotal: Subtotal de la categoría (no incluye impuestos)\n* total: Total de la categoría", "12-3": "```\n[\n{\n\"id\": 5072,\n\"name\": \"Costos de ventas y operación\",\n\"observations\": \"\",\n\"tax\" : [\n{\n\"id\" : 6,\n\"name\" : \"IVA\",\n\"percentage\" : 16,\n\"description\" : \"Impuesto de valor agregado\",\n\"type\": \"IVA\",\n\"status\": \"active\"\n}\n],\n\"price\" : 80,\n\"quantity\" : 5,\n\"subtotal\": 400,\n\"total\": 928\n},\n```" }, "cols": 4, "rows": 16 } [/block]