Obtener nota de crédito de venta

Herramienta MCP: creditNotes_getCreditNote.

Obtiene una nota de crédito de venta por su ID local de Alegra y devuelve el documento completo: fecha, estado de Alegra, tipo de nota de crédito, cliente, numeración, ítems con sus impuestos, total, saldo no aplicado, monto ya aplicado, las facturas de venta que acredita (con el monto aplicado a cada una) y los reembolsos registrados contra la nota.

Úsala cuando ya conoces el ID de la nota de crédito; si solo conoces el cliente, una fecha, un número o una factura, usa creditNotes_listCreditNotes para encontrar el ID. No devuelve una factura de venta: para consultar la factura usa las herramientas de facturas de venta de Alegra (por ejemplo invoice_getInvoiceById). Con includeComments: true la respuesta incluye además el arreglo comments del documento. Este endpoint no ofrece URLs de PDF ni XML.

El id es el ID interno de Alegra, no la numeración impresa (por ejemplo "NC-12") ni el identificador fiscal del timbre (UUID del SAT en México, CUFE en Colombia, clave de Hacienda en Costa Rica).

Notas por país (el catálogo documenta una variante por país; las reglas y el esquema de parámetros son los mismos): en México el tipo de nota usa los códigos SAT ("01" = anulaciones, descuentos y bonificaciones; "03" = devolución de mercancía sobre facturas o traslados previos). En Colombia el tipo toma valores DIAN como PARTIALL_DEVOLUTION, VOID_ELECTRONIC_INVOICE, REDUCTION_DISCOUNT_PARTIAL_TOTAL, PRICE_ADJUSTMENT u OTHER. En Panamá el tipo es CREDIT_NOTE_FE (nota de crédito referente a una FE) o CREDIT_NOTE (nota genérica), y además incluye la forma de pago. En Costa Rica la respuesta no incluye el campo de tipo.

Solo lectura.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required
length ≥ 1

ID de la nota de crédito a consultar, tal como aparece en el campo id que devuelve creditNotes_listCreditNotes (por ejemplo "1"). Es el ID interno de Alegra, no la numeración impresa ("NC-12") ni el identificador fiscal del timbre (UUID del SAT en México, CUFE en Colombia, clave de Hacienda en Costa Rica).

boolean

Si es true, la nota de crédito incluye además su arreglo comments. Por defecto false.

Responses

401

No autorizado

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json