Finanzas

Línea de documento

Línea de documento de venta: qué se facturó, cuánto y a qué precio.

Esquemas: DocumentLineDto

{
  "id": "id_8f2a1c",
  "resourceType": "item",
  "transactionType": "rental",
  "position": 1,
  "itemId": "string",
  "itemName": "Example",
  "variantId": "string",
  "variantName": "Example",
  "quantity": 1,
  "orderId": "string",
  "orderNumber": "string",
  "startDate": "2026-09-01T08:00:00Z",
  "endDate": "2026-09-01T08:00:00Z",
  "rentalDays": 1,
  "unitPrice": "1234.50",
  "linePrice": "1234.50",
  "free": true,
  "notes": "string"
}

Generado a partir del esquema

Una línea de un documento de venta: qué se facturó o presupuestó, cuánto y a qué precio. Las facturas y los presupuestos comparten esta forma, y las líneas de un documento se leen con GET /api/v1/invoices/{invoiceId}/lines o GET /api/v1/quotes/{quoteId}/lines. Las líneas pertenecen a su documento y no existe una colección independiente de ellas.

Atributos

idstring

Identificador único de la línea dentro del documento.

resourceTypestring

Tipo de recurso de la línea. Las líneas de tipo section y type_group son agrupaciones de presentación sin recurso asociado.

Opciones disponibles: item, kit, space, vehicle, personnel, service, custom, section, type_group

transactionTypestring

Naturaleza de la línea: rental o sale.

Opciones disponibles: rental, sale

positioninteger

Posición de visualización de la línea dentro del documento, empezando en 0.

itemIdstring | null

Identificador del artículo del catálogo; null si la línea no es de tipo artículo.

itemNamestring | null

Nombre del artículo tal como era CUANDO SE EMITIÓ EL DOCUMENTO. Puede diferir del nombre actual del artículo en el catálogo: el documento es una instantánea.

variantIdstring | null

Identificador de la variante; null si no aplica.

variantNamestring | null

Nombre de la variante congelado en la instantánea; null si no aplica.

quantitynumber

Unidades facturadas o presupuestadas en la línea.

orderIdstring | null

Pedido del que procede la línea; null si se añadió directamente al documento.

orderNumberstring | null

Número de ese pedido; null si la línea no procede de uno.

startDatestring<date-time> | null

Inicio del periodo facturado en ISO 8601 UTC; null si la línea no tiene periodo.

endDatestring<date-time> | null

Fin del periodo facturado en ISO 8601 UTC; null si la línea no tiene periodo.

rentalDaysnumber | null

Días de alquiler facturados; null si no aplica.

unitPricestring | null

Precio unitario neto como cadena decimal "1234.50"; null si la línea no tiene precio propio.

Límites: patrón ^-?\d+\.\d{2}$

linePricestring | null

Importe neto de la línea como cadena decimal "1234.50"; null si no se ha calculado.

Límites: patrón ^-?\d+\.\d{2}$

freeboolean

true si la línea se factura explícitamente a cero.

notesstring | null

Notas de la línea; null si no hay.

Valores

resourceType: item, kit, space, vehicle, personnel, service, custom, section, type_group
transactionType: rental, sale

Lo devuelven

GET /api/v1/invoices/{invoiceId}/lines — Listar las líneas de una factura
GET /api/v1/quotes/{quoteId}/lines — Listar las líneas de un presupuesto

Lo modifican

Ninguna operación.

¿Te ha resultado útil esta página?

Ejemplo

Atributos

Valores

Lo devuelven

Lo modifican