LibroGuiasInterface
extends
BookInterface
in
Interfaz para el Libro de Guías de Despacho.
Producido por LibroGuiasWorker. El resumen del período distingue entre
guías de venta (TpoOper=1) y guías de traslado (TpoOper>1).
Table of Contents
Methods
- countDetalle() : int
- Entrega la cantidad de registros de detalle del libro.
- getCaratula() : array<string, mixed>
- Entrega la carátula del libro.
- getDetalle() : array<string|int, array<string|int, mixed>>
- Entrega los registros de detalle del libro.
- getFolioNotificacion() : int|null
- Entrega el folio de notificación asignado por el SII al libro.
- getId() : string
- Entrega el identificador único del documento de envío del libro.
- getResumen() : array<string, mixed>
- Entrega el resumen del período del libro de guías.
- getSchema() : string
- Entrega el nombre del archivo XSD que valida este libro.
- getSignatureNamespace() : string|null
- Entrega el namespace XML que debe usarse en el elemento `Signature`.
- getTipo() : TipoLibro
- Entrega el tipo de libro.
- getXml() : string
- Entrega el XML del libro.
- getXmlDocument() : XmlDocumentInterface
- Entrega el documento XML del libro.
- isSimplificado() : bool
- Indica si el libro está en formato simplificado.
- toArray() : array<string|int, mixed>
- Entrega los datos del libro como un arreglo.
Methods
countDetalle()
Entrega la cantidad de registros de detalle del libro.
public
countDetalle() : int
Return values
intgetCaratula()
Entrega la carátula del libro.
public
getCaratula() : array<string, mixed>
Return values
array<string, mixed>getDetalle()
Entrega los registros de detalle del libro.
public
getDetalle() : array<string|int, array<string|int, mixed>>
Return values
array<string|int, array<string|int, mixed>>getFolioNotificacion()
Entrega el folio de notificación asignado por el SII al libro.
public
getFolioNotificacion() : int|null
Solo aplica cuando TipoEnvio = 'ESPECIAL'. En los demás casos
retorna null.
Return values
int|nullgetId()
Entrega el identificador único del documento de envío del libro.
public
getId() : string
Este ID se usa como referencia en la firma XML y en el envío al SII.
Return values
stringgetResumen()
Entrega el resumen del período del libro de guías.
public
getResumen() : array<string, mixed>
Incluye contadores y montos de guías de venta, guías anuladas (folio
anulado y guía anulada) y guías de traslado agrupadas por TpoOper.
Return values
array<string, mixed>getSchema()
Entrega el nombre del archivo XSD que valida este libro.
public
getSchema() : string
Por defecto delega en TipoLibro::getSchema(). Las subclases que usen
un esquema diferente según su estado (p. ej. LibroComprasVentas con
formato simplificado) deben sobrescribir este método.
Return values
string —Nombre del archivo XSD (sin ruta).
getSignatureNamespace()
Entrega el namespace XML que debe usarse en el elemento `Signature`.
public
getSignatureNamespace() : string|null
La mayoría de los libros usa el namespace estándar XML DSIG. Los libros
que requieran un namespace diferente (p. ej. el Libro de Boletas que usa
http://www.sii.cl/SiiDte) deben sobrescribir este método.
Return values
string|null —Namespace URI, o null para usar el estándar.
getTipo()
Entrega el tipo de libro.
public
getTipo() : TipoLibro
Return values
TipoLibrogetXml()
Entrega el XML del libro.
public
getXml() : string
El XML estará codificado en ISO-8859-1.
Return values
string —XML del libro.
getXmlDocument()
Entrega el documento XML del libro.
public
getXmlDocument() : XmlDocumentInterface
Return values
XmlDocumentInterfaceisSimplificado()
Indica si el libro está en formato simplificado.
public
isSimplificado() : bool
Esto afecta a los libros de compras/ventas, cambiando su esquema a
LibroCVS_v10.xsd. Si bien no afecta a otros libros, por simplicidad
se incluye este método en la interfaz base de todos los libros.
Return values
booltoArray()
Entrega los datos del libro como un arreglo.
public
toArray() : array<string|int, mixed>