DebitNotes

Notas de débito electrónicas (/debit_notes).

No tienen /kude en la API v2.

Extends

• Note

Constructors

Constructor

new DebitNotes(transport, config): DebitNotes;

Parameters

Parameter	Type
transport	Transport
config	IssuerConfig

Returns

DebitNotes

Inherited from

Note.constructor

Properties

documentType

readonly documentType: "electronic_debit_note" = DocumentType.DEBIT_NOTE;

El tipo de documento que emite este recurso.

Overrides

Note.documentType

Methods

get()

get(id): Promise<Document>;

Un recurso por su id.

Parameters

Parameter	Type
id	number

Returns

Promise<Document>

Inherited from

Note.get

---

list()

list(params?): Promise<Page<Document>>;

Una página de resultados.

Para recorrer todo sin escribir el bucle del cursor:

for await (const factura of (await sd.invoices.list()).autoPaging()) { ... }

Parameters

Parameter	Type
params	ListParams

Returns

Promise<Page<Document>>

Inherited from

Note.list

---

delete()

delete(id): Promise<void>;

Borra el recurso.

Parameters

Parameter	Type
id	number

Returns

Promise<void>

Inherited from

Note.delete

---

cancel()

cancel(id, reason): Promise<void>;

Anula el documento ante la DNIT.

Solo se puede anular un documento aprobado, y el motivo es obligatorio. La anulación es asíncrona: el documento pasa a cancellation_requested y termina en cancelled.

No devuelve el documento porque la API no lo manda —responde el id de la anulación—; para ver cómo quedó hay que releerlo con Resource.get o esperarlo con waitUntilFinal.

Parameters

Parameter	Type
id	number
reason	string

Returns

Promise<void>

Inherited from

Note.cancel

---

resendEmail()

resendEmail(id): Promise<void>;

Reenvía el documento por correo al receptor.

Parameters

Parameter	Type
id	number

Returns

Promise<void>

Inherited from

Note.resendEmail

---

resendToSet()

resendToSet(id): Promise<void>;

Reenvía a la DNIT un documento que quedó en error.

Como cancel, no devuelve el documento: hay que releerlo.

Parameters

Parameter	Type
id	number

Returns

Promise<void>

Inherited from

Note.resendToSet

---

kudeUrl()

kudeUrl(id): Promise<string>;

URL temporal del KuDE en PDF.

Está disponible recién cuando el documento se generó. Antes, la API responde 404.

Parameters

Parameter	Type
id	number

Returns

Promise<string>

Inherited from

Note.kudeUrl

---

waitUntilFinal()

waitUntilFinal(id, options?): Promise<Document>;

Consulta el documento hasta que llegue a un estado final.

Sirve para el flujo "emito y necesito el CDC ahora". Si se puede escuchar webhooks, es mejor eso: esto consume cuota del límite de 5 solicitudes por segundo.

El plazo por omisión es holgado a propósito: un documento pasa por varios estados intermedios antes de quedar aprobado, y cada salto lo da el servidor por su cuenta, así que el recorrido completo puede llevar minutos. Agotar la espera no cancela nada: el documento sigue su curso.

Ojo con los estados intermedios que parecen finales: recoverable_errorno corta la espera, porque SmartDoc lo reintenta solo.

Parameters

Parameter	Type
id	number
options	WaitOptions

Returns

Promise<Document>

Throws

si se agota el tiempo.

Inherited from

Note.waitUntilFinal

---

create()

create(options): Promise<Document>;

Emite la nota.

Parameters

Parameter	Type
options	CreateNoteOptions

Returns

Promise<Document>

Inherited from

Note.create

---

update()

update(id, options): Promise<Document>;

Reemplaza la nota. Como en facturas, no es un parche.

Parameters

Parameter	Type
id	number
options	UpdateNoteOptions

Returns

Promise<Document>

Inherited from

Note.update