WebhookEvent

Una entrega de webhook, ya verificada y parseada.

Los campos del sobre son estables. Los de data no todos: SmartDoc garantiza un subconjunto —id, status, los datos del emisor, el timbrado, el establecimiento y el punto de expedición— y agrega otros propios de cada tipo de documento que pueden cambiar sin aviso.

Por eso la recomendación es tratar el evento como un disparador y, si hace falta el detalle completo y estable, traerlo con WebhookEvent.fetch.

Constructors

Constructor

new WebhookEvent(fields): WebhookEvent;

Parameters

Parameter	Type
fields	{ id: number; eventType: string; entityType: string; entityId: number; taxPayerId: number; timestamp: Date; data?: EventPayload; raw?: EventPayload; }
fields.id	number
fields.eventType	string
fields.entityType	string
fields.entityId	number
fields.taxPayerId	number
fields.timestamp	Date
fields.data?	EventPayload
fields.raw?	EventPayload

Returns

WebhookEvent

Properties

id

readonly id: number;

Id de la entrega. Es lo que se usa para deduplicar.

---

eventType

readonly eventType: string;

---

entityType

readonly entityType: string;

---

entityId

readonly entityId: number;

---

taxPayerId

readonly taxPayerId: number;

---

timestamp

readonly timestamp: Date;

---

data

readonly data: EventPayload;

---

raw

readonly raw: EventPayload;

El cuerpo crudo, por si hace falta algo que el SDK no modela.

Accessors

status

Get Signature

get status(): string;

Estado del documento al momento del evento.

Returns

string

---

cdc

Get Signature

get cdc(): string | undefined;

CDC del documento. Siempre undefined en recibos, que no tienen.

Returns

string | undefined

---

subtype

Get Signature

get subtype(): string;

approved, cancelled, pending o error.

Returns

string

---

documentKey

Get Signature

get documentKey(): [string, number];

Identifica al documento sin ambigüedad: [entidad, id].

entityId no es único por sí solo. Se numera por tipo de documento, así que el recibo 20 y la nota de débito 20 conviven. Guardar solo el número y buscar por él cruza documentos distintos.

Returns

[string, number]

---

isError

Get Signature

get isError(): boolean;

Si el documento quedó en error.

El motivo está en errorCode y errorMessage.

Returns

boolean

---

isApproved

Get Signature

get isApproved(): boolean;

Si el documento quedó válido.

Para un recibo, esto es cierto con el documento en generated: no pasa por la DNIT.

Returns

boolean

---

isFinal

Get Signature

get isFinal(): boolean;

Si el documento ya no va a cambiar de estado por su cuenta.

Returns

boolean

---

errorCode

Get Signature

get errorCode(): string | undefined;

Código del error, o undefined si el documento no está en error.

Para ramificar conviene isError.

Returns

string | undefined

---

errorMessage

Get Signature

get errorMessage(): string | undefined;

Descripción del error, o undefined si el documento no está en error.

Returns

string | undefined

---

documentType

Get Signature

get documentType(): 
  | "electronic_invoice"
  | "electronic_credit_note"
  | "electronic_debit_note"
  | "electronic_remission_note"
  | "electronic_auto_invoice"
  | "electronic_receipt"
  | "electronic_disablement"
  | undefined;

El tipo de documento al que corresponde la entidad del evento.

Returns

| "electronic_invoice" | "electronic_credit_note" | "electronic_debit_note" | "electronic_remission_note" | "electronic_auto_invoice" | "electronic_receipt" | "electronic_disablement" | undefined

Methods

fetch()

fetch(client): Promise<Document>;

Trae el documento completo desde la API.

Sirve cuando hace falta un campo que no está garantizado en data.

Parameters

Parameter	Type
client	Client

Returns

Promise<Document>

---

fromPayload()

static fromPayload(payload): WebhookEvent;

Construye el evento desde el cuerpo ya parseado.

Parameters

Parameter	Type
payload	EventPayload

Returns

WebhookEvent