FacturaScripts

ApiEditDocument extends ApiEditDocument

in package

• Application

uses ExtensionsTrait

Class created by Core/Internal/PluginsDeploy

Table of Contents

Constants

API_VERSION  : mixed = 3

INCIDENT_EXPIRATION_TIME  : mixed = 600

IP_LIST  : mixed = 'api-ip-list'

MAX_INCIDENT_COUNT  : mixed = 5

Properties

$apiKey  : ApiKey

$extensionCache  : array<string|int, mixed>

Cache for extension lookups by method name.

$extensions  : array<string|int, mixed>

Stores class extensions.

$model  : string

$request  : Request

$response  : Response

$url  : string

Methods

__call()  : mixed

Executes the first matched extension.

__construct()  : mixed

Inicializa el controlador asociado a una ruta.

addExtension()  : void

clearExtensions()  : void

Clears all registered extensions.

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

Returns a list of all registered extension names.

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

Devuelve los metadatos de la página, como el nombre, título, icono y ubicación en el menú.

hasExtension()  : bool

pipe()  : mixed

pipeFalse()  : bool

removeExtension()  : bool

Removes all extensions with the specified name.

run()  : void

Ejecuta el ciclo principal del controlador para procesar la petición actual.

applyLineFields()  : void

Asigna a la línea los campos recibidos en el array de datos.

checkCompany()  : bool

Comprueba que la empresa (idempresa) no se cambia, porque rompería la numeración, la contabilidad y el stock asociado al documento.

checkSubject()  : bool

Comprueba que el sujeto (codcliente / codproveedor) no se cambia.

checkWarehouse()  : bool

Comprueba que el almacén (codalmacen) no se cambia, porque descuadraría el stock de las líneas existentes.

db()  : DataBase

decodeLines()  : array<string|int, mixed>|null

Decodifica y valida la lista de líneas recibida por la API.

editDocument()  : bool

editLockedDocument()  : bool

Edita un documento no editable: solo se permiten los campos desbloqueados (femail, idestado, idestado_ant, numdocs, pagada). Cualquier intento de modificar la cabecera o las líneas se rechaza con 422.

getUriParam()  : string

loadModel()  : bool

processInvoicePaid()  : void

runResource()  : void

syncLines()  : bool

Sincroniza las líneas del documento (full sync): las líneas con idlinea existente se modifican, las que no traen idlinea se crean y las líneas existentes ausentes del payload se borran (revirtiendo el stock).

toBool()  : bool

Convierte un valor a booleano.

updateHeader()  : bool

Actualiza la cabecera del documento con los campos permitidos. No toca el sujeto ni el almacén (ya validados como inmutables), ni la clave primaria, la numeración (numero, codigo, codejercicio) ni el estado (idestado), que deben cambiarse por sus mecanismos propios y no por asignación directa.

buildExtensionCache()  : void

Builds and caches sorted extensions for a method name.