Skip to content

Item ​

Un ítem de un documento.

La descripción se puede pasar suelta o dentro de las opciones:

ts
new Item('Consultoría de octubre', { quantity: 1, unitAmount: 1_100_000 });
new Item({ description: 'Consultoría', quantity: 1, unitAmount: 1_100_000 });

Constructors ​

Constructor ​

ts
new Item(options): Item;

Parameters ​

ParameterType
optionsItemOptions

Returns ​

Item

Constructor ​

ts
new Item(description, details): Item;

Parameters ​

ParameterType
descriptionstring
detailsItemDetails

Returns ​

Item

Properties ​

description ​

ts
readonly description: string;

quantity ​

ts
readonly quantity: Decimal;

unitAmount ​

ts
readonly unitAmount: Decimal;

iva ​

ts
readonly iva: 
  | "10_percent"
  | "5_percent"
  | "exempt"
  | "mixed_10_percent"
  | "mixed_5_percent";

code ​

ts
readonly code: string | undefined;

measureUnit ​

ts
readonly measureUnit: 
  | 77
  | 79
  | 83
  | 86
  | 87
  | 88
  | 89
  | 90
  | 91
  | 92
  | 93
  | 94
  | 95
  | 96
  | 97
  | 98
  | 99
  | 100
  | 101
  | 102
  | 103
  | 104
  | 108
  | 109
  | 110
  | 569
  | 625
  | 660
  | 666
  | 869
  | 885
  | 891
  | 2329
  | 2366;

discount ​

ts
readonly discount: Decimal;

ivaBase ​

ts
readonly ivaBase: Decimal | undefined;

obs ​

ts
readonly obs: string | undefined;

totalAmount ​

ts
readonly totalAmount: Decimal | undefined;

dncpLevelCodeGeneral ​

ts
readonly dncpLevelCodeGeneral: string | undefined;

dncpLevelCodeSpecific ​

ts
readonly dncpLevelCodeSpecific: string | undefined;

Accessors ​

isMixed ​

Get Signature ​

ts
get isMixed(): boolean;

Si el tipo de IVA de este ítem exige ivaBase.

Returns ​

boolean


rate ​

Get Signature ​

ts
get rate(): number;

La tasa de IVA como fracción: 0.10, 0.05 o 0.

Returns ​

number


lineTotal ​

Get Signature ​

ts
get lineTotal(): Decimal;

Total de la línea, antes de descuentos.

Returns ​

Decimal


lineDiscount ​

Get Signature ​

ts
get lineDiscount(): Decimal;

Descuento total de la línea: el unitario por la cantidad.

Returns ​

Decimal


net ​

Get Signature ​

ts
get net(): Decimal;

Lo que la línea aporta al total del documento.

Returns ​

Decimal


taxableShare ​

Get Signature ​

ts
get taxableShare(): Decimal;

Fracción de la línea que está gravada.

Es 1 salvo en los tipos mixtos, donde la define ivaBase.

Returns ​

Decimal


ivaAmount ​

Get Signature ​

ts
get ivaAmount(): Decimal;

IVA contenido en la línea.

El precio ya lo incluye: al 10% se divide por 11, al 5% por 21.

Returns ​

Decimal

Methods ​

toApi() ​

ts
toApi(position?): {
[key: string]: unknown;
};

El ítem en el formato que espera la API.

Parameters ​

ParameterTypeDefault value
positionnumber1

Returns ​

ts
{
[key: string]: unknown;
}