FacturaScripts

BusinessDocument extends ModelClass

in package

• Application

uses CompanyRelationTrait, CurrencyRelationTrait, ExerciseRelationTrait, PaymentRelationTrait, SerieRelationTrait, IntracomunitariaTrait

Documento de negocio base (presupuestos, pedidos, albaranes, facturas).

Table of Contents

Properties

$cifnif  : string

CIF/NIF del cliente o proveedor.

$codalmacen  : string

Almacén del documento.

$coddivisa  : string

Código de la divisa utilizada en el documento.

$codejercicio  : string

Código del ejercicio contable asociado.

$codigo  : string

Identificador único para humanos.

$codpago  : mixed

Código de la forma de pago asociada.

$codserie  : mixed

Código de la serie asociada.

$dtopor1  : float

Primer porcentaje de descuento global del documento.

$dtopor2  : float

Segundo porcentaje de descuento global del documento.

$fecha  : string

Fecha del documento.

$femail  : string

Fecha en la que se envió el documento por email.

$hora  : string

Hora del documento.

$idempresa  : mixed

Identificador de la empresa asociada.

$irpf  : float|int

Retención por defecto del documento. Cada línea puede tener una retención diferente.

$neto  : float|int

Suma del pvptotal de las líneas. Total del documento antes de impuestos.

$netosindto  : float|int

Suma del pvptotal de las líneas. Total del documento antes de impuestos y descuentos globales.

$nick  : string

Usuario que creó este documento. Modelo User.

$numdocs  : int

Número de documentos adjuntos.

$numero  : string

Número del documento. Único dentro de la serie.

$observaciones  : string

Observaciones del documento.

$operacion  : string

Tipo de operación fiscal del documento, por ejemplo intracomunitaria.

$tasaconv  : float|int

Tasa de conversión a euros de la divisa seleccionada.

$total  : float|int

Suma total del documento, con impuestos.

$totaleuros  : float|int

Total expresado en euros, si no fuera la divisa del documento.

$totalirpf  : float|int

Suma total de las retenciones de IRPF de las líneas.

$totaliva  : float|int

Suma del IVA de las líneas.

$totalrecargo  : float|int

Suma total del recargo de equivalencia de las líneas.

$totalsuplidos  : float|int

Suma total de las líneas de suplidos.

$attributes  : array<string|int, mixed>

The model's attributes.

$dataBase  : DataBase

It provides direct access to the database.

$dont_copy_fields  : mixed

Campos que no se deben copiar al duplicar o transformar el documento.

$original  : array<string|int, mixed>

The model's original attributes.

Methods

__construct()  : mixed

Inicializa el modelo, comprueba su tabla y carga los datos proporcionados.

__get()  : mixed

Devuelve el valor de un atributo dinámico.

__isset()  : bool

Comprueba si existe un atributo dinámico con valor no nulo.

__set()  : void

Asigna el valor de un atributo dinámico.

__unset()  : void

Elimina un atributo dinámico.

addApiFieldToHide()  : void

Añade un campo a la lista de campos que no deben exponerse en la API.

addExtension()  : void

Añade una extensión al modelo con la prioridad indicada.

all()  : array<string|int, mixed>

Devuelve los registros que cumplen las condiciones especificadas.

allWhereEq()  : array<string|int, mixed>

Devuelve los registros cuyo campo coincide con el valor indicado.

changeId()  : bool

Cambia el valor de la clave primaria del registro.

changePrimaryColumnValue()  : bool

Cambia el valor de la clave primaria del registro.

clear()  : void

Restablece los valores de todas las propiedades del modelo.

clearCache()  : void

Elimina de la caché los datos relacionados con el modelo y su tabla.

count()  : int

Cuenta los registros que cumplen las condiciones especificadas.

countWhereEq()  : int

Cuenta los registros cuyo campo coincide con el valor indicado.

create()  : static|null

Crea y guarda un nuevo registro con los datos proporcionados.

delete()  : bool

Elimina el registro actual de la base de datos.

deleteWhere()  : bool

Elimina los registros que cumplen las condiciones especificadas.

dontCopyField()  : void

dontCopyFields()  : array<string|int, mixed>

exists()  : bool

Comprueba si el registro actual existe en la base de datos.

find()  : static|null

Busca un registro mediante su clave primaria.

findOrCreate()  : static|null

Busca un registro o lo crea cuando no existe.

findWhere()  : static|null

Busca el primer registro que cumple las condiciones especificadas.

get()  : static|false

Busca un registro mediante su clave primaria y devuelve una nueva instancia.

getApiFieldsToHide()  : array<string|int, string>

Devuelve los nombres de campos que no deben exponerse en la API (ni en GET, ni en el schema). Los modelos con datos sensibles deben sobrescribir este método fusionando con parent::getApiFieldsToHide().

getAttachedFiles()  : array<string|int, mixed>

getAuditChannel()  : string

getCompany()  : Empresa

getDirty()  : array<string|int, mixed>

Devuelve un array asociativo con los campos modificados y sus valores actuales.

getEUDiscount()  : float

Devuelve el Descuento Unificado Equivalente.

getExercise()  : Ejercicio

getLines()  : array<string|int, mixed>

Devuelve las líneas asociadas al documento.

getModelFields()  : array<string|int, mixed>

Devuelve la definición de los campos del modelo.

getNewLine()  : mixed

Devuelve una nueva línea para este documento.

getNewProductLine()  : mixed

Devuelve una nueva línea para este documento completada con los datos del producto.

getOriginal()  : mixed|null

Devuelve el valor original de un campo, si no se indica campo devuelve todo el array original

getPaymentMethod()  : FormaPago

getSerie()  : Serie

getSubject()  : mixed

Devuelve el sujeto de este documento.

getTotalDiscounts()  : float

Devuelve el descuento total de todo el documento.

hasChanged()  : bool

hasColumn()  : bool

Comprueba si el modelo contiene la columna indicada.

hasExtension()  : bool

Comprueba si el modelo tiene registrada la extensión indicada.

id()  : mixed

Devuelve el valor de la clave primaria del modelo.

install()  : string

Esta función se ejecuta al crear la tabla del modelo. Devuelve el SQL que se ejecutará después de la creación de la tabla. Útil para insertar valores por defecto.

isDirty()  : bool

Comprueba si los campos del modelo han sido modificados.

load()  : bool

Carga un modelo dada su primary key

loadFromCode()  : bool

Carga un registro del modelo utilizando un código y opcionalmente condiciones adicionales.

loadFromData()  : void

Carga los campos y atributos del modelo desde un array.

loadWhere()  : bool

Carga el primer registro que coincida con las condiciones especificadas.

loadWhereEq()  : bool

Carga el primer registro cuyo campo coincide con el valor indicado.

maxLength()  : int

Devuelve la longitud máxima de un campo de texto, o 0 si no tiene límite o no es un campo de texto.

modelClassName()  : string

Devuelve el nombre de la clase del modelo sin el espacio de nombres.

newCode()  : int

Calcula el siguiente código numérico disponible para un campo.

paid()  : bool

pipe()  : mixed

Ejecuta las extensiones asociadas al punto indicado y devuelve su resultado.

pipeFalse()  : bool

Ejecuta las extensiones y devuelve false si alguna cancela la operación.

primaryColumn()  : string

Devuelve el nombre de la columna que actúa como clave primaria.

primaryColumnValue()  : mixed

Devuelve el valor de la clave primaria del modelo.

primaryDescription()  : mixed

Devuelve la descripción principal del registro.

primaryDescriptionColumn()  : string

Devuelve la descripción de la columna que es la clave primaria del modelo.

reload()  : bool

Vuelve a cargar desde la base de datos el registro actual.

save()  : bool

Guarda los datos del modelo en la base de datos.

setAuthor()  : bool

Establece el autor de este documento.

setCurrency()  : void

setDate()  : bool

Asigna la fecha y busca un ejercicio contable.

setIntracomunitaria()  : bool

setSubject()  : bool

Establece el sujeto de este documento.

setWarehouse()  : bool

Establece el almacén y la empresa de este documento.

subjectColumn()  : mixed

Devuelve el nombre de la columna del sujeto.

subjectColumnValue()  : string

syncOriginal()  : void

Sincroniza los valores actuales con la copia original del modelo.

table()  : DbQuery

Devuelve el constructor de consultas asociado a la tabla del modelo.

tableName()  : string

Devuelve el nombre de la tabla asociada al modelo.

test()  : bool

Devuelve True si no hay errores en los valores de las propiedades.

toArray()  : array<string|int, mixed>

Devuelve un array con los campos y valores del modelo.

totalSum()  : float

Suma los valores de un campo para los registros que cumplen las condiciones.

update()  : bool

Actualiza el modelo con los valores proporcionados en el array

updateOrCreate()  : static|null

Actualiza el registro coincidente o crea uno nuevo.

updateSubject()  : bool

Actualiza los datos del sujeto en este documento.

url()  : string

Genera una URL para el modelo según el tipo especificado.

belongsTo()  : object|null

Define una relación uno a uno.

db()  : DataBase

Devuelve la instancia de la base de datos actual.

hasMany()  : array<string|int, mixed>

Define una relación uno a muchos.

loadModelFields()  : void

Carga la definición de los campos del modelo.

onChange()  : bool

Comprueba los campos modificados antes de actualizar la base de datos.

onDelete()  : void

Este método se llama al eliminar un registro de la base de datos.

onInsert()  : void

Este método se llama al insertar un nuevo registro en la base de datos (saveInsert).

onUpdate()  : void

Este método se llama al actualizar un registro en la base de datos.

saveInsert()  : bool

Inserta un nuevo registro en la base de datos.

saveUpdate()  : bool

Este método se llama al actualizar un registro existente en la base de datos.