{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/credit-notes/:id","auth":"required","settings":"","results":{"codes":[{"name":"","code":"{\n  \"date\": \"2015-11-15\",\n  \"client\":  2,\n  \"items\" : [\n    {\n      \"id\": 1,\n      \"price\" : 120,\n      \"quantity\" : 5\n    },\n    {\n      \"id\": 2,\n      \"description\": \"Cartera de cuero color café\",\n      \"price\": 85,\n      \"discount\" : 10,\n      \"tax\" : [\n        {\n          \"id\" : 6,\n          }\n        ],\n      \"quantity\" : 1\n      }\n    ]\n}","language":"json","status":200}]},"params":[{"name":"id","type":"int","default":"","desc":"Identificador de la nota de crédito que se desea editar.","required":true,"in":"path","ref":"","_id":"5ed01cf81637010018bcc63f"},{"name":"date","type":"yyyy-mm-dd","default":"","desc":"Fecha de la nota de crédito. Formato yyyy-MM-dd.","required":false,"in":"body","ref":"","_id":"5ed01cf81637010018bcc63e"},{"name":"dueDate","type":"yyyy-mm-dd","default":"","desc":"Fecha de vencimiento de la nota de crédito. Formato yyyy-MM-dd.","required":false,"in":"body","ref":"","_id":"5ed01cf81637010018bcc63d"},{"name":"observations","type":"string","default":"","desc":"Observaciones de la nota de crédito (no visibles en el pdf o documento impreso). Longitud máxima permitida: 500.","required":false,"in":"body","ref":"","_id":"5ed01cf81637010018bcc63c"},{"name":"anotation","type":"string","default":"","desc":"Notas de la nota de crédito, visibles en el PDF o documento impreso. Longitud máxima permitida: 500.","required":false,"in":"body","ref":"","_id":"5ed01cf81637010018bcc63b"},{"name":"termsConditions","type":"string","default":"","desc":"Términos y condiciones de la nota de crédito. Longitud máxima permitida: 500.","required":false,"in":"body","ref":"","_id":"5ed01cf81637010018bcc63a"},{"name":"client","type":"mixed","default":"","desc":"Objecto que contiene el id del cliente asociado a la nota de crédito. Se puede enviar directamente el id del cliente en este atributo.","required":false,"in":"body","ref":"","_id":"5ed01cf81637010018bcc639"},{"name":"items","type":"array_object","default":"","desc":"Array de objetos item (productos/servicios) asociados a la nota de crédito. Cada objeto debe incluir: `id (number, obligatorio)`: identificador del producto o servicio que se vende; `price (double, obligatorio)`: precio de venta; `reference (string)` : referencia del producto/servicio; `description (string)`: descripción del producto/servicio; `tax (objeto)` : array de objetos tax que indican la información del impuesto; `quantity (obligatorio)`: cantidad vendida del producto o servicio; `discount (decimal)`: porcentaje de descuento aplicado al producto, éste no debe incluir el símbolo %, únicamente su tasa. Para costa rica, el atributo `discount` pasa a ser un objeto compuesto por los atributos: `nature` (indica la naturaleza del descuento) y `discount` (indica la tasa del descuento). El precio del producto/servicio no debe incluir impuestos ni descuentos.","required":false,"in":"body","ref":"","_id":"5ed01cf81637010018bcc638"},{"name":"numberTemplate","type":"object","default":"","desc":"Objeto que contiene la información de la numeración de la nota de crédito. Para numeraciones automáticas solo debe incluir el id de la numeración, para numeraciones manuales se debe enviar como mínimo el id de la numeración y el número de la nota de crédito. Si no se envía este atributo la aplicación intenta crear la nota de crédito con la numeración preferida que tiene configurada la empresa. Si no es posible retorna error.","required":false,"in":"body","ref":"","_id":"5ed01cf81637010018bcc637"},{"name":"priceList","type":"mixed","default":"","desc":"Objeto que indica el id de la lista de precios asociada a la nota de crédito. Se puede enviar directamente el id de la lista de precios en este atributo.","required":false,"in":"body","ref":"","_id":"5ed01cf81637010018bcc636"},{"name":"currency","type":"object","default":"","desc":"Objecto que incluye la información de la moneda y tasa de cambio asociada a la nota de crédito. 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) y la tasa de cambio. No es posible actualizar la moneda si ya se tienen facturas o devoluciones asociadas.","required":false,"in":"body","ref":"","_id":"5ed01cf81637010018bcc635"},{"name":"warehouse","type":"mixed","default":"","desc":"Objeto que indica el id de la bodega/almacén asociada a la nota de crédito. Se puede enviar directamente el id de la bodega/almacén en este atributo. Si no se envía este parámetro la nota de crédito queda asociada a la bodega/almacén Principal.","required":false,"in":"body","ref":"","_id":"5ed01cf81637010018bcc634"},{"name":"paymentMethod (Costa Rica)","type":"string","default":"","desc":"Para Costa Rica, indica el método de pago de la nota de crédito. Las opciones posibles son: `cash`  Efectivo,  `card` Tarjeta débito/crédito,  `check` Cheque,  `transfer` Transferencia - depósito bancario,  `collection-by-third` Recaudo por teceros,  `other` Otros métodos de pago. Si se desea emitir la nota de crédito, este atributo se vuelve obligatorio.","required":false,"in":"body","ref":"","_id":"5ed01cf81637010018bcc633"},{"name":"paymentForm (Chile)","type":"string","default":"","desc":"Para Chile, el objeto paymentForm indica la forma de pago de la nta de crédito, este objeto puede contener atributos:  * `id (string)` código de la forma de pago y * `value(string)` nombre de la forma de pago. Si se desea emitir la nota de crédito, este atributo se vuelve obligatorio. Las opciones disponibles las encuentras [aquí](https://developer.alegra.com/docs/chile).","required":false,"in":"body","ref":"","_id":"5ed01cf81637010018bcc632"},{"name":"type (Colombia, Costa Rica y Perú)","type":"string","default":"","desc":"Para Colombia, Costa Rica y Perú, indica el tipo de la nota de crédito. Las opciones disponibles las encuentras aquí: [colombia](https://developer.alegra.com/docs/colombia), [costaRica](https://developer.alegra.com/docs/costaRica) y [perú](https://developer.alegra.com/docs/peru).","required":false,"in":"body","ref":"","_id":"5ed01cf81637010018bcc631"},{"name":"saleCondition (Costa Rica)","type":"string","default":"","desc":"Para Costa Rica, indica la condición de la venta. Consulta el catálogo de parámetros correspondiente a cada país haciendo clic [aquí](https://developer.alegra.com/docs/costa-rica). Si se desea emitir la nota de crédito, este atributo se vuelve obligatorio.","required":false,"in":"body","ref":"","_id":"5ed01cf81637010018bcc630"},{"name":"saleCondition (Argentina)","type":"string","default":"","desc":"Para Argentina, indica la condición de la venta.  Las opciones posibles son: `CASH` Efectivo, `DEBIT_CARD` Tarjeta Debito, `CREDIT_CARD` Tarjeta Crédito, `DEPOSIT` Depósito,  `TRANSFER` Transferencia. Si se desea emitir la nota de crédito, este atributo se vuelve obligatorio.","required":false,"in":"body","ref":"","_id":"5ed01cf81637010018bcc62f"},{"name":"economicActivity (Costa Rica)","type":"string","default":"","desc":"Para Costa Rica, indica el código de la actividad económica asociada a la nota de crédito. Si no se envía, se asignará por defecto el código de la actividad económica de la compañía.","required":false,"in":"body","ref":"","_id":"5ed01cf81637010018bcc62e"},{"name":"saleConcept (Argentina)","type":"string","default":"","desc":"Para Argentina, indica el concepto de venta asociado a la nota de crédito. Las opciones posibles son:  `PRODUCTS` Productos, `SERVICES` Servicios, `PRODUCTS_SERVICES` Productos y Servicios. Si se desea emitir la nota de crédito, este atributo se vuelve obligatorio.","required":false,"in":"body","ref":"","_id":"5ed01cf81637010018bcc62d"},{"name":"cause (Costa Rica, Perú y Colombia)","type":"string","default":"","desc":"Para Costa Rica, Perú y Colombia, indica la descripción de la razón y/o naturaleza por la cual se genera la nota de crédito. Este parámetro es obligatorio cuando se desea emitir la nota de crédito.","required":false,"in":"body","ref":"","_id":"5ed01cf81637010018bcc62c"},{"name":"refunds","type":"array_object","default":"","desc":"Array de objetos con la información de las devoluciones asociadas a la nota de crédito, 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. Si envias este parámetro se reemplazarán todas las devoluciones con las nuevas. Si lo envias en `null` se borrarán todas las devoluciones.","required":false,"in":"body","ref":"","_id":"5ed01cf81637010018bcc62b"},{"name":"invoices","type":"array_object","default":"","desc":"Array de objetos con la información de las facturas de venta que se desean asociar a la nota de crédito. Cada factura debe tener los siguientes datos: `id (int, obligatorio)` id de la factura de venta y `amount (int, obligatorio)` monto asociado. Si se desea timbrar la nota de crédito este valor este campo es oblihgatorio y la suma del valor total de cada una de las facturas de venta debe ser igual al total de la nota de crédito. Si envias este parámetro se reemplazarán todas las facturas de venta con las nuevas. Si lo envias en `null` se borrarán todas las facturas asociadas..","required":false,"in":"body","ref":"","_id":"5ed01cf81637010018bcc62a"},{"name":"costCenter","type":"mixed","default":"","desc":"Objeto que indica el id del centro de costos que se desea asociar a la nota de crédito. Se puede enviar directamente el id del centro de costos en este atributo.","required":false,"in":"body","ref":"","_id":"5ed928902c82ea03e0500b48"}],"examples":{"codes":[{"code":"{\n  \"date\": \"2015-11-15\",\n  \"client\":  2,\n  \"items\" : [\n    {\n      \"id\": 1,\n      \"price\" : 120,\n      \"quantity\" : 5\n    },\n    {\n      \"id\": 2,\n      \"description\": \"Cartera de cuero color café\",\n      \"price\": 85,\n      \"discount\" : 10,\n      \"tax\" : [\n        {\n          \"id\" : 6\n        }\n      ],\n      \"quantity\" : 1\n      }\n    ]\n}","language":"json","name":"Editar nota de crédito"}]},"method":"put"},"next":{"description":"","pages":[]},"title":"Editar nota crédito","type":"endpoint","slug":"editar-nota-credito","excerpt":"","body":"Por ejemplo para editar la fecha de creación de una nota de crédito se debe enviar el siguiente JSON:\n\n```\n{\n\"date\" : \"2016-06-27\"\n}```\n\nPara eliminar algún dato de la nota de crédito enviar el atributo en null, así:\n```\n{\n\"observations\" : null\n}```\n\nSe retorna la nota de crédito que se ha modificado.","updates":[],"order":6,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5ed01cf81637010018bcc629","createdAt":"2020-05-28T20:20:08.506Z","user":"56abd213d4432d1900eed227","category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"Notas Crédito","slug":"notas-crédito","order":22,"from_sync":false,"reference":false,"_id":"5e8ca028538a310018ccd2df","createdAt":"2020-04-07T15:45:44.192Z","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":3,"parentDoc":null}

putEditar nota crédito


Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

id:
required
integer
Identificador de la nota de crédito que se desea editar.

Body Params

date:
yyyy-mm-dd
Fecha de la nota de crédito. Formato yyyy-MM-dd.
dueDate:
yyyy-mm-dd
Fecha de vencimiento de la nota de crédito. Formato yyyy-MM-dd.
observations:
string
Observaciones de la nota de crédito (no visibles en el pdf o documento impreso). Longitud máxima permitida: 500.
anotation:
string
Notas de la nota de crédito, visibles en el PDF o documento impreso. Longitud máxima permitida: 500.
termsConditions:
string
Términos y condiciones de la nota de crédito. Longitud máxima permitida: 500.
client:
mixed
Objecto que contiene el id del cliente asociado a la nota de crédito. Se puede enviar directamente el id del cliente en este atributo.
items:
array of objects
Array de objetos item (productos/servicios) asociados a la nota de crédito. Cada objeto debe incluir: `id (number, obligatorio)`: identificador del producto o servicio que se vende; `price (double, obligatorio)`: precio de venta; `reference (string)` : referencia del producto/servicio; `description (string)`: descripción del producto/servicio; `tax (objeto)` : array de objetos tax que indican la información del impuesto; `quantity (obligatorio)`: cantidad vendida del producto o servicio; `discount (decimal)`: porcentaje de descuento aplicado al producto, éste no debe incluir el símbolo %, únicamente su tasa. Para costa rica, el atributo `discount` pasa a ser un objeto compuesto por los atributos: `nature` (indica la naturaleza del descuento) y `discount` (indica la tasa del descuento). El precio del producto/servicio no debe incluir impuestos ni descuentos.
numberTemplate:
object
Objeto que contiene la información de la numeración de la nota de crédito. Para numeraciones automáticas solo debe incluir el id de la numeración, para numeraciones manuales se debe enviar como mínimo el id de la numeración y el número de la nota de crédito. Si no se envía este atributo la aplicación intenta crear la nota de crédito con la numeración preferida que tiene configurada la empresa. Si no es posible retorna error.
priceList:
mixed
Objeto que indica el id de la lista de precios asociada a la nota de crédito. Se puede enviar directamente el id de la lista de precios en este atributo.
currency:
object
Objecto que incluye la información de la moneda y tasa de cambio asociada a la nota de crédito. 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) y la tasa de cambio. No es posible actualizar la moneda si ya se tienen facturas o devoluciones asociadas.
warehouse:
mixed
Objeto que indica el id de la bodega/almacén asociada a la nota de crédito. Se puede enviar directamente el id de la bodega/almacén en este atributo. Si no se envía este parámetro la nota de crédito queda asociada a la bodega/almacén Principal.
paymentMethod:
string
Para Costa Rica, indica el método de pago de la nota de crédito. Las opciones posibles son: `cash` Efectivo, `card` Tarjeta débito/crédito, `check` Cheque, `transfer` Transferencia - depósito bancario, `collection-by-third` Recaudo por teceros, `other` Otros métodos de pago. Si se desea emitir la nota de crédito, este atributo se vuelve obligatorio.
paymentForm:
string
Para Chile, el objeto paymentForm indica la forma de pago de la nta de crédito, este objeto puede contener atributos: * `id (string)` código de la forma de pago y * `value(string)` nombre de la forma de pago. Si se desea emitir la nota de crédito, este atributo se vuelve obligatorio. Las opciones disponibles las encuentras [aquí](https://developer.alegra.com/docs/chile).
type:
string
Para Colombia, Costa Rica y Perú, indica el tipo de la nota de crédito. Las opciones disponibles las encuentras aquí: [colombia](https://developer.alegra.com/docs/colombia), [costaRica](https://developer.alegra.com/docs/costaRica) y [perú](https://developer.alegra.com/docs/peru).
saleCondition:
string
Para Costa Rica, indica la condición de la venta. Consulta el catálogo de parámetros correspondiente a cada país haciendo clic [aquí](https://developer.alegra.com/docs/costa-rica). Si se desea emitir la nota de crédito, este atributo se vuelve obligatorio.
saleCondition:
string
Para Argentina, indica la condición de la venta. Las opciones posibles son: `CASH` Efectivo, `DEBIT_CARD` Tarjeta Debito, `CREDIT_CARD` Tarjeta Crédito, `DEPOSIT` Depósito, `TRANSFER` Transferencia. Si se desea emitir la nota de crédito, este atributo se vuelve obligatorio.
economicActivity:
string
Para Costa Rica, indica el código de la actividad económica asociada a la nota de crédito. Si no se envía, se asignará por defecto el código de la actividad económica de la compañía.
saleConcept:
string
Para Argentina, indica el concepto de venta asociado a la nota de crédito. Las opciones posibles son: `PRODUCTS` Productos, `SERVICES` Servicios, `PRODUCTS_SERVICES` Productos y Servicios. Si se desea emitir la nota de crédito, este atributo se vuelve obligatorio.
cause:
string
Para Costa Rica, Perú y Colombia, indica la descripción de la razón y/o naturaleza por la cual se genera la nota de crédito. Este parámetro es obligatorio cuando se desea emitir la nota de crédito.
refunds:
array of objects
Array de objetos con la información de las devoluciones asociadas a la nota de crédito, 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. Si envias este parámetro se reemplazarán todas las devoluciones con las nuevas. Si lo envias en `null` se borrarán todas las devoluciones.
invoices:
array of objects
Array de objetos con la información de las facturas de venta que se desean asociar a la nota de crédito. Cada factura debe tener los siguientes datos: `id (int, obligatorio)` id de la factura de venta y `amount (int, obligatorio)` monto asociado. Si se desea timbrar la nota de crédito este valor este campo es oblihgatorio y la suma del valor total de cada una de las facturas de venta debe ser igual al total de la nota de crédito. Si envias este parámetro se reemplazarán todas las facturas de venta con las nuevas. Si lo envias en `null` se borrarán todas las facturas asociadas..
costCenter:
mixed
Objeto que indica el id del centro de costos que se desea asociar a la nota de crédito. Se puede enviar directamente el id del centro de costos en este atributo.

Examples


Result Format


Documentation

Por ejemplo para editar la fecha de creación de una nota de crédito se debe enviar el siguiente JSON: ``` { "date" : "2016-06-27" }``` Para eliminar algún dato de la nota de crédito enviar el atributo en null, así: ``` { "observations" : null }``` Se retorna la nota de crédito que se ha modificado.

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