LibreDTE

AbstractDocumento
in package

AbstractYes

Clase abstracta (base) de la representación de un documento.

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

$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").

$receptor

Contribuyente receptor del documento.

private Contribuyente $receptor

Este objeto representa al contribuyente que recibió el documento.

Methods

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
throws
SignatureException

Si existe algún problema al firmar el documento.

Return values
string —

String con el XML firmado.

getCodigo()

Entrega el código del tipo de documento tributario.

public getCodigo() : int
Return values
int

getData()

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>

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
string

getFolio()

Entrega el folio del documento tributario.

public getFolio() : int
Return values
int

getId()

Entrega el ID que LibreDTE asigna al documento.

public getId() : string
Return values
string

getMontoTotal()

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.

getTotales()

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
string

loadXML()

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
self

saveXml()

Entrega el string XML del documento XML.

public saveXml() : string

Es un wrapper de XmlDocument::saveXML();

Return values
string

setData()

Asigna los datos del documento.

public setData(array<string|int, mixed> $data) : self
Parameters
$data : array<string|int, mixed>
Return values
self

timbrar()

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
throws
CafException

Si existe algún problema al timbrar el documento.

validateSchema()

Valida el esquema del XML del DTE.

public validateSchema() : void
Tags
throws
XmlException

Si la validación del esquema falla.

validateSignature()

Valida la firma electrónica del documento XML del DTE.

public validateSignature() : void
Tags
throws
SignatureException

Si la validación del esquema falla.


        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results