FacturaScripts

BusinessDocument extends BusinessDocument

in package

• Application

Class created by Core/Internal/PluginsDeploy

Table of Contents

Properties

$cifnif  : string

CIF/NIF del cliente o proveedor.

$codalmacen  : string

Almacén del documento.

$coddivisa  : string

Currency of the document.

$codejercicio  : string

Exercise code.

$codigo  : string

Identificador único para humanos.

$codpago  : string

$codserie  : string

$dtopor1  : float

Porcentaje de descuento.

$dtopor2  : float

Porcentaje de descuento.

$fecha  : string

Fecha del documento.

$femail  : string

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

$hora  : string

Hora del documento.

$idempresa  : int

$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

Indicates the type of document operation, example: intra-community

$tasaconv  : float|int

Rate of conversion to Euros of the selected currency.

$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  : array<string|int, mixed>

$original  : array<string|int, mixed>

The model's original attributes.

Methods

__construct()  : mixed

__get()  : mixed

__isset()  : bool

__set()  : void

__unset()  : void

addExtension()  : void

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

changeId()  : bool

changePrimaryColumnValue()  : bool

clear()  : void

Restablece los valores de todas las propiedades del modelo.

clearCache()  : void

count()  : int

create()  : static|null

delete()  : bool

deleteWhere()  : bool

dontCopyField()  : void

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

exists()  : bool

find()  : static|null

findOrCreate()  : static|null

findWhere()  : static|null

get()  : mixed

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.

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>

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

hasExtension()  : bool

id()  : mixed

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

loadWhere()  : bool

Carga el primer registro que coincida con las condiciones especificadas.

loadWhereEq()  : bool

modelClassName()  : string

newCode()  : mixed

paid()  : bool

pipe()  : mixed

pipeFalse()  : bool

primaryColumn()  : string

primaryColumnValue()  : mixed

primaryDescription()  : mixed

primaryDescriptionColumn()  : string

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

reload()  : bool

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

table()  : DbQuery

tableName()  : string

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

update()  : bool

Actualiza el modelo con los valores proporcionados en el array

updateOrCreate()  : static|null

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 a one-to-many relationship.

loadModelFields()  : void

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 insertar un nuevo registro en la base de datos (saveUpdate).

saveInsert()  : bool

saveUpdate()  : bool

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