{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/debit-notes/:id","auth":"required","settings":"","results":{"codes":[{"name":"Nota de débito completa","code":"{\n    \"number\": \"1919\",\n    \"prefix\": null,\n    \"date\": \"2020-04-29\",\n    \"observations\": \"\",\n    \"termsConditions\": null,\n    \"client\": {\n\t    \"id\": \"13\"\n\t  },\n\t \"warehouse\": {\n\t    \"id\": \"1\"\n\t  },\n    \"currency\": {\n        \"code\": \"USD\"\n    },\n    \"items\": [\n        {\n            \"id\": 3,\n            \"price\": 2400,\n            \"quantity\": \"1.00\",\n            \"tax\": [\n\t\t        {\n\t\t          \"id\": \"2\"\n\t\t        }\n\t\t      ]\n        }\n    ],\n    \"categories\": [\n        {\n            \"id\": \"5072\",\n            \"observations\": \"\",\n            \"price\": \"100.0000\",\n            \"quantity\": \"2.00\",\n            \"tax\": [\n\t\t        {\n\t\t          \"id\": \"2\"\n\t\t        }\n\t\t      ]\n        }\n    ],\n    \"refunds\": [\n        {\n            \"date\": \"2020-04-29\",\n            \"account\": {\n                \"id\": \"1\"\n            },\n            \"amount\": 300,\n            \"observations\": \"123\"\n        }\n    ],\n    \"bills\": [\n        {\n            \"id\": \"64\",\n            \"amount\": 920\n        }\n    ]\n    \n}","language":"json","status":200}]},"params":[{"name":"date","type":"yyyy-mm-dd","default":"","desc":"Fecha de la nota débito. Formato yyyy-MM-dd.","required":false,"in":"body","ref":"","_id":"5eb1e742a39cc9024da2873d"},{"name":"number (Chile, Colombia, Costa Rica, España, México, Panamá, Perú, USA, Internacional)","type":"string","default":"","desc":"Número del folio la nota débito. Es obligatorio para las siguientes versiones: Chile, Colombia, Costa Rica, España, México, Panamá, Perú, USA, Internacional.","required":false,"in":"body","ref":"","_id":"5ec82c0c4e4ad50012ef2738"},{"name":"prefix (Chile, Colombia, Costa Rica, España, México, Panamá, Perú, USA, Internacional)","type":"string","default":"","desc":"Prefijo del folio de la nota débito","required":false,"in":"body","ref":"","_id":"5ecd11a7c735590020cb1e4c"},{"name":"resolution (Argentina, República Dominicana)","type":"mixed","default":"","desc":"Objecto que contiene el id de la numeración asociada a la nota débito. Se puede enviar directamente el id de la numeración en este atributo. Es obligatorio para las siguientes versiones: Argentina, República Dominicana.","required":false,"in":"body","ref":"","_id":"5ecd11a7c735590020cb1e4b"},{"name":"observations","type":"string","default":"","desc":"Observaciones de la nota débito. Longitud máxima permitida: 500.","required":false,"in":"body","ref":"","_id":"5eb1e742a39cc9024da2873b"},{"name":"termsConditions","type":"string","default":"","desc":"Términos y condiciones de la nota débito. Longitud máxima permitida: 500.","required":false,"in":"body","ref":"","_id":"5eb1e742a39cc9024da28739"},{"name":"client","type":"mixed","default":"","desc":"Objecto que contiene el id del cliente asociado a la nota débito. Se puede enviar directamente el id del cliente en este atributo.","required":true,"in":"body","ref":"","_id":"5eb1e742a39cc9024da28738"},{"name":"warehouse","type":"mixed","default":"","desc":"Objeto que indica el id de la bodega/almacén asociada a la nota débito. Se puede enviar directamente el id de la bodega/almacén en este atributo. Si no se envía este parámetro la nota débito queda asociada a la bodega/almacén Principal. Todos los items que se envíen asociados a la nota débito deben al menos un item existente en el almacén/bodega indicado.","required":false,"in":"body","ref":"","_id":"5eb1e742a39cc9024da28733"},{"name":"currency","type":"object","default":"","desc":"Objecto que incluye la información de la moneda y tasa de cambio asociada a la nota débito. Solo se debe incluir si la compañía tiene activa la funcionalidad de multimoneda y tiene configurada la moneda seleccionada. Debe incluir el código de la moneda (de tres letras según ISO). Si no se envía, se tomará como moneda la moneda principal de la empresa de acuerdo a la versión de Alegra utilizada.","required":false,"in":"body","ref":"","_id":"5eb1e742a39cc9024da28734"},{"name":"items","type":"array_object","default":"","desc":"Array de objetos item (productos/servicios) asociados a la nota débito. Cada objeto debe incluir: `id (number, obligatorio)`: identificador del producto o servicio que se devuelve; `price (double, obligatorio)`: precio del producto devuelto; `tax (objeto)` : array de objetos tax que indican la información del impuesto; `quantity (obligatorio)`: cantidad devuelta del producto o servicio. El precio del producto/servicio no debe incluir impuestos ni descuentos. Cada item enviado debe ser de tipo \"Inventariable\" y tener existencia en el almacén/bodega indicado. Se debe enviar al menos un item si no se envía ninguna categoría.","required":false,"in":"body","ref":"","_id":"5eb1e742a39cc9024da28736"},{"name":"categories","type":"array_object","default":"","desc":"Array de objetos category (categorías) asociadas a la nota débito. Cada objeto debe incluir: `id (number, obligatorio)`: identificador de la categoría; `price (double, obligatorio)`: precio de la categoría; `tax (objeto)` : array de objetos tax que indican la información del impuesto; `quantity (obligatorio)`: cantidad de la categoría. El precio de la categoría no debe incluir impuestos ni descuentos. Cada categoría enviada debe ser de tipo \"expense\" (gasto) o \"asset\" (activo) y debe estar habilitada. Se debe enviar al menos una categoría si no se envía ningún item.","required":false,"in":"body","ref":"","_id":"5eb1e742a39cc9024da28737"},{"name":"refunds","type":"array_object","default":"","desc":"Array de objetos con la información de las devoluciones asociadas a la nota débito, los campos que se deben enviar en cada objeto son: `date (obligatorio)` Fecha de la devolución, `account (int, obligatorio)` id de la cuenta bancaria,  `amount (int, obligatorio)` monto de la devolución y `observations (string)` observaciones de la devolución.","required":false,"in":"body","ref":"","_id":"5eb1e742a39cc9024da28725"},{"name":"bills","type":"array_object","default":"","desc":"Array de objetos con la información de las facturas de proveedor que se desean asociar a la nota débito. Cada factura de proveedor debe tener los siguientes datos: `id (int, obligatorio)` id de la factura de proveedor y `amount (int, obligatorio)` monto asociado. El factura de proveedor debe tener saldo pendiente por pagar y este debe ser mayor o igual al atributo \"amount\" ingresado. La factura de proveedor no puede haber sido conciliada. Cada factura de proveedor enviada debe estar asociada al mismo cliente al que va dirigida la nota débito.","required":false,"in":"body","ref":"","_id":"5eb1e742a39cc9024da28724"}],"examples":{"codes":[]},"method":"put"},"next":{"description":"","pages":[]},"title":"Editar nota débito","type":"endpoint","slug":"editar-nota-débito","excerpt":"Endpoint que permite editar una nota débito existente.","body":"[block:callout]\n{\n  \"type\": \"warning\",\n  \"body\": \"Únicamente se modifican los atributos que se envían en el request, los otros atributos del objeto que no se envían quedan intactos.\",\n  \"title\": \"Atención\"\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"warning\",\n  \"title\": \"Atención\",\n  \"body\": \"No se podrá editar una nota débito que tenga facturas de proveedor conciliadas asociadas.\"\n}\n[/block]\nPor ejemplo para editar la fecha de creación de una nota débito se debe enviar el siguiente JSON:\n\n```\n{\n    \"date\" : \"2016-06-27\"\n}\n```\n\nPara eliminar algún dato de la nota débito enviar el atributo en null, así:\n```\n{\n    \"observations\" : null\n}\n```\nEn lo que se refiere a items, categories, refunds y bills, si quieren eliminar, debe enviarse el objeto como un array vacio, de lo contrario, no se modificarán las asociaciones. Así:\n{\n    \"items\" : []\n}\n\nCada vez que se editen las entidades asociadas se llevarán a cabo las validaciones de los totales para verificar que siga siendo una nota débito válida.\n\nSe retorna la nota débito que se ha modificado con los datos actualizados.","updates":[],"order":5,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5ecd12051d702000395f2926","createdAt":"2020-05-26T12:56:37.627Z","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":1,"parentDoc":null}

putEditar nota débito

Endpoint que permite editar una nota débito existente.

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Body Params

date:
yyyy-mm-dd
Fecha de la nota débito. Formato yyyy-MM-dd.
number:
string
Número del folio la nota débito. Es obligatorio para las siguientes versiones: Chile, Colombia, Costa Rica, España, México, Panamá, Perú, USA, Internacional.
prefix:
string
Prefijo del folio de la nota débito
resolution:
mixed
Objecto que contiene el id de la numeración asociada a la nota débito. Se puede enviar directamente el id de la numeración en este atributo. Es obligatorio para las siguientes versiones: Argentina, República Dominicana.
observations:
string
Observaciones de la nota débito. Longitud máxima permitida: 500.
termsConditions:
string
Términos y condiciones de la nota débito. Longitud máxima permitida: 500.
client:
required
mixed
Objecto que contiene el id del cliente asociado a la nota débito. Se puede enviar directamente el id del cliente en este atributo.
warehouse:
mixed
Objeto que indica el id de la bodega/almacén asociada a la nota débito. Se puede enviar directamente el id de la bodega/almacén en este atributo. Si no se envía este parámetro la nota débito queda asociada a la bodega/almacén Principal. Todos los items que se envíen asociados a la nota débito deben al menos un item existente en el almacén/bodega indicado.
currency:
object
Objecto que incluye la información de la moneda y tasa de cambio asociada a la nota débito. Solo se debe incluir si la compañía tiene activa la funcionalidad de multimoneda y tiene configurada la moneda seleccionada. Debe incluir el código de la moneda (de tres letras según ISO). Si no se envía, se tomará como moneda la moneda principal de la empresa de acuerdo a la versión de Alegra utilizada.
items:
array of objects
Array de objetos item (productos/servicios) asociados a la nota débito. Cada objeto debe incluir: `id (number, obligatorio)`: identificador del producto o servicio que se devuelve; `price (double, obligatorio)`: precio del producto devuelto; `tax (objeto)` : array de objetos tax que indican la información del impuesto; `quantity (obligatorio)`: cantidad devuelta del producto o servicio. El precio del producto/servicio no debe incluir impuestos ni descuentos. Cada item enviado debe ser de tipo "Inventariable" y tener existencia en el almacén/bodega indicado. Se debe enviar al menos un item si no se envía ninguna categoría.
categories:
array of objects
Array de objetos category (categorías) asociadas a la nota débito. Cada objeto debe incluir: `id (number, obligatorio)`: identificador de la categoría; `price (double, obligatorio)`: precio de la categoría; `tax (objeto)` : array de objetos tax que indican la información del impuesto; `quantity (obligatorio)`: cantidad de la categoría. El precio de la categoría no debe incluir impuestos ni descuentos. Cada categoría enviada debe ser de tipo "expense" (gasto) o "asset" (activo) y debe estar habilitada. Se debe enviar al menos una categoría si no se envía ningún item.
refunds:
array of objects
Array de objetos con la información de las devoluciones asociadas a la nota débito, los campos que se deben enviar en cada objeto son: `date (obligatorio)` Fecha de la devolución, `account (int, obligatorio)` id de la cuenta bancaria, `amount (int, obligatorio)` monto de la devolución y `observations (string)` observaciones de la devolución.
bills:
array of objects
Array de objetos con la información de las facturas de proveedor que se desean asociar a la nota débito. Cada factura de proveedor debe tener los siguientes datos: `id (int, obligatorio)` id de la factura de proveedor y `amount (int, obligatorio)` monto asociado. El factura de proveedor debe tener saldo pendiente por pagar y este debe ser mayor o igual al atributo "amount" ingresado. La factura de proveedor no puede haber sido conciliada. Cada factura de proveedor enviada debe estar asociada al mismo cliente al que va dirigida la nota débito.

Result Format


Documentation

[block:callout] { "type": "warning", "body": "Únicamente se modifican los atributos que se envían en el request, los otros atributos del objeto que no se envían quedan intactos.", "title": "Atención" } [/block] [block:callout] { "type": "warning", "title": "Atención", "body": "No se podrá editar una nota débito que tenga facturas de proveedor conciliadas asociadas." } [/block] Por ejemplo para editar la fecha de creación de una nota débito se debe enviar el siguiente JSON: ``` { "date" : "2016-06-27" } ``` Para eliminar algún dato de la nota débito enviar el atributo en null, así: ``` { "observations" : null } ``` En lo que se refiere a items, categories, refunds y bills, si quieren eliminar, debe enviarse el objeto como un array vacio, de lo contrario, no se modificarán las asociaciones. Así: { "items" : [] } Cada vez que se editen las entidades asociadas se llevarán a cabo las validaciones de los totales para verificar que siga siendo una nota débito válida. Se retorna la nota débito que se ha modificado con los datos actualizados.

User Information

Try It Out

put
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}