BoletaAfecta
extends AbstractDocumento
in package
Clase que representa una boleta afecta electrónica.
Table of Contents
Properties
- $codigo : int
- Código del tipo de documento tributario al que está asociada esta instancia de un documento.
- $data : array<string|int, mixed>
- Arreglo con los datos del documento tributario.
- $dataProvider : DataProviderInterface
- Proveedor de datos.
- $xmlDocument : XmlDocument
- Instancia del documento XML asociado a los datos.
- $emisor : Contribuyente
- Contribuyente emisor del documento.
- $receptor : Contribuyente
- Contribuyente receptor del documento.
- $tipo : DocumentoTipo
- Instancia del tipo de documento tributario, según el código, asociado a esta instancia de un documento.
Methods
- __construct() : mixed
- Constructor de la clase.
- firmar() : string
- Realiza la firma del documento.
- getCodigo() : int
- Entrega el código del tipo de documento tributario.
- getData() : array<string|int, mixed>
- Obtiene los datos del documento.
- getDetalle() : array<string|int, mixed>
- Entrega el detalle del documento.
- getEmisor() : Contribuyente
- Obtiene el contribuyente emisor del documento.
- getFechaEmision() : string
- Entrega la fecha de emisión asignada al documento tributario.
- getFolio() : int
- Entrega el folio del documento tributario.
- getId() : string
- Entrega el ID que LibreDTE asigna al documento.
- getMontoTotal() : int|float
- Entrega el monto total del documento.
- getReceptor() : Contribuyente
- Obtiene el contribuyente receptor del documento.
- getTipo() : DocumentoTipo
- Entrega la instancia del tipo de documento asociado a este documento.
- getTotales() : array<string|int, mixed>
- Entrega todos los valores del tag "Totales".
- getXml() : string
- Entrega el string XML del documento XML.
- getXmlDocument() : XmlDocument
- Obtiene la instancia del documento XML asociada al documento tributario.
- getXmlSignatureNode() : XmlSignatureNode
- Obtiene una instancia del nodo de la firma.
- loadXML() : self
- Carga el XML completo de un documento para crear la instancia del documento XML asociada a este documento.
- saveXml() : string
- Entrega el string XML del documento XML.
- setData() : self
- Asigna los datos del documento.
- timbrar() : void
- Realiza el timbrado del documento.
- validateSchema() : void
- Valida el esquema del XML del DTE.
- validateSignature() : void
- Valida la firma electrónica del documento XML del DTE.
Properties
$codigo
Código del tipo de documento tributario al que está asociada esta instancia de un documento.
protected
int
$codigo
= 39
$data
Arreglo con los datos del documento tributario.
protected
array<string|int, mixed>
$data
Estos datos podrían o no haber sido normalizados. Sin embargo, si no fueron normalizados, se espera que se hayan asignados según lo que el SII requiere (o sea, como si se hubiesen "normalizado").
$dataProvider
Proveedor de datos.
protected
DataProviderInterface
$dataProvider
$xmlDocument
Instancia del documento XML asociado a los datos.
protected
XmlDocument
$xmlDocument
$emisor
Contribuyente emisor del documento.
private
Contribuyente
$emisor
Este objeto representa al contribuyente que emitió el documento.
$receptor
Contribuyente receptor del documento.
private
Contribuyente
$receptor
Este objeto representa al contribuyente que recibió el documento.
$tipo
Instancia del tipo de documento tributario, según el código, asociado a esta instancia de un documento.
private
DocumentoTipo
$tipo
Methods
__construct()
Constructor de la clase.
public
__construct([DataProviderInterface|null $dataProvider = null ]) : mixed
Parameters
- $dataProvider : DataProviderInterface|null = null
-
Proveedor de datos.
firmar()
Realiza la firma del documento.
public
firmar(Certificate $certificate[, string $timestamp = null ]) : string
Parameters
- $certificate : Certificate
-
Instancia que representa la firma electrónica.
- $timestamp : string = null
-
Marca de tiempo a utilizar en la firma.
Tags
Return values
string —String con el XML firmado.
getCodigo()
Entrega el código del tipo de documento tributario.
public
getCodigo() : int
Return values
intgetData()
Obtiene los datos del documento.
public
getData() : array<string|int, mixed>
Return values
array<string|int, mixed>getDetalle()
Entrega el detalle del documento.
public
getDetalle([int|null $index = null ]) : array<string|int, mixed>
Se puede solicitar todo el detalle o el detalle de una línea en específico.
Parameters
- $index : int|null = null
-
Índice de la línea de detalle solicitada o
null
(por defecto) para obtener todas las líneas.
Return values
array<string|int, mixed>getEmisor()
Obtiene el contribuyente emisor del documento.
public
getEmisor() : Contribuyente
Return values
Contribuyente —Instancia de Contribuyente que representa al emisor.
getFechaEmision()
Entrega la fecha de emisión asignada al documento tributario.
public
getFechaEmision() : string
Esta es la fecha de emisión informada al SII del documento, no es la fecha de creación real del documento en LibreDTE.
Return values
stringgetFolio()
Entrega el folio del documento tributario.
public
getFolio() : int
Return values
intgetId()
Entrega el ID que LibreDTE asigna al documento.
public
getId() : string
Return values
stringgetMontoTotal()
Entrega el monto total del documento.
public
getMontoTotal() : int|float
El monto estará en la moneda del documento.
Return values
int|float —Monto total del documento.
getReceptor()
Obtiene el contribuyente receptor del documento.
public
getReceptor() : Contribuyente
Return values
Contribuyente —Instancia de Contribuyente que representa al receptor.
getTipo()
Entrega la instancia del tipo de documento asociado a este documento.
public
getTipo() : DocumentoTipo
Return values
DocumentoTipogetTotales()
Entrega todos los valores del tag "Totales".
public
getTotales() : array<string|int, mixed>
Return values
array<string|int, mixed>getXml()
Entrega el string XML del documento XML.
public
getXml() : string
Es un wrapper de XmlDocument::getXML();
Return values
stringgetXmlDocument()
Obtiene la instancia del documento XML asociada al documento tributario.
public
getXmlDocument() : XmlDocument
Return values
XmlDocumentgetXmlSignatureNode()
Obtiene una instancia del nodo de la firma.
public
getXmlSignatureNode() : XmlSignatureNode
Tags
Return values
XmlSignatureNodeloadXML()
Carga el XML completo de un documento para crear la instancia del documento XML asociada a este documento.
public
loadXML(string $xml) : self
Parameters
- $xml : string
Return values
selfsaveXml()
Entrega el string XML del documento XML.
public
saveXml() : string
Es un wrapper de XmlDocument::saveXML();
Return values
stringsetData()
Asigna los datos del documento.
public
setData(array<string|int, mixed> $data) : self
Parameters
- $data : array<string|int, mixed>
Return values
selftimbrar()
Realiza el timbrado del documento.
public
timbrar(Caf $caf[, string $timestamp = null ]) : void
Parameters
- $caf : Caf
-
Instancia del CAF con el que se desea timbrar.
- $timestamp : string = null
-
Marca de tiempo a utilizar en el timbre.
Tags
validateSchema()
Valida el esquema del XML del DTE.
public
validateSchema() : void
Tags
validateSignature()
Valida la firma electrónica del documento XML del DTE.
public
validateSignature() : void