Skip to content

Document ​

Un documento electrónico: factura, recibo, nota o autofactura.

Extends ​

Constructors ​

Constructor ​

ts
new Document(data?, documentType?): Document;

Parameters ​

ParameterType
data| { [key: string]: unknown; } | null | undefined
documentType?| "electronic_invoice" | "electronic_credit_note" | "electronic_debit_note" | "electronic_remission_note" | "electronic_auto_invoice" | "electronic_receipt" | "electronic_disablement"

Returns ​

Document

Overrides ​

Record.constructor

Properties ​

raw ​

ts
readonly raw: Readonly<{
[key: string]: unknown;
}>;

El JSON completo tal como lo devolvió la API.

Inherited from ​

Record.raw


documentType ​

ts
readonly documentType: 
  | "electronic_invoice"
  | "electronic_credit_note"
  | "electronic_debit_note"
  | "electronic_remission_note"
  | "electronic_auto_invoice"
  | "electronic_receipt"
  | "electronic_disablement"
  | undefined;

Accessors ​

id ​

Get Signature ​

ts
get id(): number;
Returns ​

number


status ​

Get Signature ​

ts
get status(): string;

Estado actual. Devuelve el valor crudo si SmartDoc agregó uno nuevo.

Returns ​

string


cdc ​

Get Signature ​

ts
get cdc(): string | undefined;

Código de Control de 44 caracteres.

Es undefined mientras el documento no se generó, y no existe en los recibos, que no se envían a la DNIT.

Returns ​

string | undefined


isTerminal ​

Get Signature ​

ts
get isTerminal(): boolean;

Si el documento ya no se mueve solo.

Returns ​

boolean


isApproved ​

Get Signature ​

ts
get isApproved(): boolean;

Si quedó válido fiscalmente.

Para un recibo, alcanza con estar generado: no pasa por la DNIT.

Returns ​

boolean


isError ​

Get Signature ​

ts
get isError(): boolean;
Returns ​

boolean


errorCode ​

Get Signature ​

ts
get errorCode(): string | undefined;

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

Puede ser undefined aun con el documento en error, según de dónde venga el rechazo; errorMessage trae el detalle en todos los casos. Para ramificar conviene isError.

Returns ​

string | undefined


errorMessage ​

Get Signature ​

ts
get errorMessage(): string | undefined;

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

Returns ​

string | undefined


amount ​

Get Signature ​

ts
get amount(): number | undefined;

Monto total. Las notas de remisión no tienen.

Returns ​

number | undefined


items ​

Get Signature ​

ts
get items(): {
[key: string]: unknown;
}[];
Returns ​

{ [key: string]: unknown; }[]

Methods ​

get() ​

ts
get<T>(key, fallback?): T | undefined;

El valor de un campo que el SDK no modela.

Type Parameters ​

Type ParameterDefault type
Tunknown

Parameters ​

ParameterType
keystring
fallback?T

Returns ​

T | undefined

Inherited from ​

Record.get


has() ​

ts
has(key): boolean;

Si el campo vino en la respuesta.

Parameters ​

ParameterType
keystring

Returns ​

boolean

Inherited from ​

Record.has


toJSON() ​

ts
toJSON(): {
[key: string]: unknown;
};

Returns ​

ts
{
[key: string]: unknown;
}

Inherited from ​

Record.toJSON