Uecko_ERP/modules/customer-invoices/src/api/infrastructure/sequelize/models/customer-invoice.model.ts

458 lines
12 KiB
TypeScript
Raw Normal View History

2025-11-14 15:48:09 +00:00
import type { CustomerModel } from "@erp/customers/api";
2025-04-01 14:26:15 +00:00
import {
2025-11-14 15:48:09 +00:00
type CreationOptional,
2025-04-01 14:26:15 +00:00
DataTypes,
2025-11-14 15:48:09 +00:00
type InferAttributes,
type InferCreationAttributes,
2025-04-01 14:26:15 +00:00
Model,
2025-11-14 15:48:09 +00:00
type NonAttribute,
type Sequelize,
2025-04-01 14:26:15 +00:00
} from "sequelize";
2025-10-30 18:26:57 +00:00
2025-11-14 15:48:09 +00:00
import type {
2025-06-12 06:55:17 +00:00
CustomerInvoiceItemCreationAttributes,
CustomerInvoiceItemModel,
} from "./customer-invoice-item.model";
2025-11-14 15:48:09 +00:00
import type {
2025-09-09 15:48:12 +00:00
CustomerInvoiceTaxCreationAttributes,
CustomerInvoiceTaxModel,
} from "./customer-invoice-tax.model";
2025-11-17 17:20:18 +00:00
import type { VerifactuRecordModel } from "./verifactu-record.model";
2025-09-09 15:48:12 +00:00
2025-06-12 06:55:17 +00:00
export type CustomerInvoiceCreationAttributes = InferCreationAttributes<
CustomerInvoiceModel,
2025-09-09 18:13:54 +00:00
{ omit: "items" | "taxes" | "current_customer" }
2025-06-12 06:55:17 +00:00
> & {
2025-06-11 15:13:44 +00:00
items?: CustomerInvoiceItemCreationAttributes[];
2025-09-09 15:48:12 +00:00
taxes?: CustomerInvoiceTaxCreationAttributes[];
2025-04-22 08:11:50 +00:00
};
2025-04-01 14:26:15 +00:00
2025-06-11 15:13:44 +00:00
export class CustomerInvoiceModel extends Model<
InferAttributes<CustomerInvoiceModel>,
2025-09-09 15:48:12 +00:00
InferCreationAttributes<CustomerInvoiceModel, { omit: "items" | "taxes" }>
2025-05-02 21:43:51 +00:00
> {
2025-10-03 19:01:38 +00:00
// Version
// declare version: CreationOptional<number>;
2025-04-01 14:26:15 +00:00
declare id: string;
2025-09-03 10:41:12 +00:00
declare company_id: string;
2025-04-01 14:26:15 +00:00
// status === issued <- (si is_proforma === true) => Es una proforma (histórica)
// status === issued <- (si is_proforma === false) => Factura y enviada a Veri*Factu
2025-09-09 15:48:12 +00:00
declare is_proforma: boolean;
2025-09-03 10:41:12 +00:00
declare status: string;
declare proforma_id: CreationOptional<string | null>; // ID de la proforma origen de la factura
2025-09-26 18:09:14 +00:00
declare series: CreationOptional<string | null>;
declare invoice_number: CreationOptional<string>;
2025-09-26 18:09:14 +00:00
declare invoice_date: CreationOptional<string>;
declare operation_date: CreationOptional<string | null>;
declare language_code: CreationOptional<string>;
declare currency_code: CreationOptional<string>;
2025-04-01 14:26:15 +00:00
2025-09-26 18:09:14 +00:00
declare reference: CreationOptional<string | null>;
2025-09-30 10:59:32 +00:00
declare description: CreationOptional<string | null>;
2025-09-26 18:09:14 +00:00
declare notes: CreationOptional<string | null>;
// Método de pago
declare payment_method_id: CreationOptional<string | null>;
declare payment_method_description: CreationOptional<string | null>;
2025-09-04 17:57:04 +00:00
2025-04-01 14:26:15 +00:00
// Subtotal
2025-09-03 18:04:09 +00:00
declare subtotal_amount_value: number;
declare subtotal_amount_scale: number;
// Discount percentage
declare discount_percentage_value: number;
declare discount_percentage_scale: number;
// Discount amount
declare discount_amount_value: number;
declare discount_amount_scale: number;
// Taxable amount (base imponible)
declare taxable_amount_value: number;
declare taxable_amount_scale: number;
2025-09-09 15:48:12 +00:00
// Total taxes amount / taxes total
declare taxes_amount_value: number;
declare taxes_amount_scale: number;
2025-04-01 14:26:15 +00:00
// Total
2025-09-03 18:04:09 +00:00
declare total_amount_value: number;
declare total_amount_scale: number;
2025-04-01 14:26:15 +00:00
2025-09-08 17:24:38 +00:00
// Customer
declare customer_id: string;
2025-09-26 18:09:14 +00:00
declare customer_tin: CreationOptional<string | null>;
declare customer_name: CreationOptional<string | null>;
declare customer_street: CreationOptional<string | null>;
declare customer_street2: CreationOptional<string | null>;
declare customer_city: CreationOptional<string | null>;
declare customer_province: CreationOptional<string | null>;
declare customer_postal_code: CreationOptional<string | null>;
declare customer_country: CreationOptional<string | null>;
2025-09-22 17:31:49 +00:00
// FactuGES
declare factuges_id: CreationOptional<string | null>;
2025-05-02 21:43:51 +00:00
// Relaciones
2025-06-11 15:13:44 +00:00
declare items: NonAttribute<CustomerInvoiceItemModel[]>;
2025-09-09 15:48:12 +00:00
declare taxes: NonAttribute<CustomerInvoiceTaxModel[]>;
2025-09-09 18:13:54 +00:00
declare current_customer: NonAttribute<CustomerModel>;
2025-11-17 17:20:18 +00:00
declare verifactu: NonAttribute<VerifactuRecordModel>;
2025-05-02 21:43:51 +00:00
static associate(database: Sequelize) {
2025-10-30 18:26:57 +00:00
const models = database.models;
const requiredModels = [
"CustomerInvoiceModel",
"CustomerInvoiceItemModel",
"CustomerModel",
"CustomerInvoiceTaxModel",
2025-11-17 17:20:18 +00:00
"VerifactuRecordModel",
2025-10-30 18:26:57 +00:00
];
// Comprobamos que los modelos existan
for (const name of requiredModels) {
if (!models[name]) {
throw new Error(`[CustomerInvoiceModel.associate] Missing model: ${name}`);
}
}
// Los modelos existen
2025-09-09 15:48:12 +00:00
const {
CustomerInvoiceModel,
CustomerInvoiceItemModel,
CustomerModel,
CustomerInvoiceTaxModel,
2025-11-17 17:20:18 +00:00
VerifactuRecordModel,
2025-10-30 18:26:57 +00:00
} = models;
2025-09-09 15:48:12 +00:00
2025-11-17 17:20:18 +00:00
CustomerInvoiceModel.hasOne(VerifactuRecordModel, {
as: "verifactu",
foreignKey: "invoice_id",
});
2025-09-09 15:48:12 +00:00
CustomerInvoiceModel.belongsTo(CustomerModel, {
2025-09-09 18:13:54 +00:00
as: "current_customer",
2025-09-09 15:48:12 +00:00
foreignKey: "customer_id",
constraints: false,
});
2025-05-02 21:43:51 +00:00
2025-06-11 15:13:44 +00:00
CustomerInvoiceModel.hasMany(CustomerInvoiceItemModel, {
2025-05-02 21:43:51 +00:00
as: "items",
2025-06-12 06:55:17 +00:00
foreignKey: "invoice_id",
sourceKey: "id",
2025-09-09 15:48:12 +00:00
constraints: true,
2025-05-02 21:43:51 +00:00
onDelete: "CASCADE",
2025-09-09 15:48:12 +00:00
onUpdate: "CASCADE",
});
CustomerInvoiceModel.hasMany(CustomerInvoiceTaxModel, {
as: "taxes",
foreignKey: "invoice_id",
sourceKey: "id",
constraints: true,
2025-09-09 15:48:12 +00:00
onDelete: "CASCADE",
onUpdate: "CASCADE",
});
}
2025-11-17 17:20:18 +00:00
static hooks(_database: Sequelize) {
//
}
2025-04-01 14:26:15 +00:00
}
2025-05-02 21:43:51 +00:00
export default (database: Sequelize) => {
2025-06-11 15:13:44 +00:00
CustomerInvoiceModel.init(
2025-04-01 14:26:15 +00:00
{
2025-10-03 19:01:38 +00:00
/*version: {
type: DataTypes.INTEGER.UNSIGNED,
allowNull: false,
defaultValue: 0,
},*/
2025-04-01 14:26:15 +00:00
id: {
2025-09-09 15:48:12 +00:00
type: DataTypes.UUID,
2025-04-01 14:26:15 +00:00
primaryKey: true,
},
2025-09-03 10:41:12 +00:00
company_id: {
type: DataTypes.UUID,
allowNull: false,
},
2025-09-09 15:48:12 +00:00
is_proforma: {
type: DataTypes.BOOLEAN,
allowNull: false,
2025-09-30 15:58:04 +00:00
defaultValue: true,
2025-09-09 15:48:12 +00:00
},
proforma_id: {
type: DataTypes.UUID,
allowNull: true,
defaultValue: null,
},
2025-09-03 10:41:12 +00:00
status: {
2025-04-01 14:26:15 +00:00
type: new DataTypes.STRING(),
allowNull: false,
2025-09-03 10:41:12 +00:00
defaultValue: "draft",
2025-04-01 14:26:15 +00:00
},
2025-09-03 10:41:12 +00:00
series: {
type: new DataTypes.STRING(10),
2025-04-01 14:26:15 +00:00
allowNull: true,
defaultValue: null,
},
2025-06-12 06:55:17 +00:00
invoice_number: {
type: new DataTypes.STRING(12),
2025-04-01 14:26:15 +00:00
allowNull: true,
defaultValue: null,
},
2025-09-04 17:57:04 +00:00
invoice_date: {
2025-04-01 15:32:53 +00:00
type: new DataTypes.DATEONLY(),
2025-09-26 18:09:14 +00:00
allowNull: false,
2025-04-01 14:26:15 +00:00
},
operation_date: {
2025-04-01 15:32:53 +00:00
type: new DataTypes.DATEONLY(),
2025-04-01 14:26:15 +00:00
allowNull: true,
defaultValue: null,
},
2025-09-03 10:41:12 +00:00
language_code: {
type: DataTypes.STRING(2),
2025-04-01 14:26:15 +00:00
allowNull: false,
2025-09-03 10:41:12 +00:00
defaultValue: "es",
2025-04-01 14:26:15 +00:00
},
2025-09-03 10:41:12 +00:00
currency_code: {
type: new DataTypes.STRING(3),
2025-04-01 14:26:15 +00:00
allowNull: false,
2025-09-26 18:09:14 +00:00
defaultValue: "EUR",
},
reference: {
type: new DataTypes.STRING(),
allowNull: true,
defaultValue: null,
2025-04-01 14:26:15 +00:00
},
2025-09-30 10:59:32 +00:00
description: {
type: new DataTypes.STRING(),
allowNull: true,
defaultValue: null,
},
2025-09-04 17:57:04 +00:00
notes: {
type: new DataTypes.TEXT(),
2025-09-03 18:04:09 +00:00
allowNull: true,
defaultValue: null,
},
2025-09-04 17:57:04 +00:00
2025-09-22 17:31:49 +00:00
payment_method_id: {
type: DataTypes.UUID,
allowNull: true,
defaultValue: null,
},
payment_method_description: {
type: new DataTypes.STRING(),
allowNull: true,
defaultValue: null,
},
2025-09-04 17:57:04 +00:00
subtotal_amount_value: {
type: new DataTypes.BIGINT(), // importante: evita problemas de precisión con valores grandes
allowNull: false,
defaultValue: 0,
},
2025-09-26 18:09:14 +00:00
2025-09-03 18:04:09 +00:00
subtotal_amount_scale: {
type: new DataTypes.SMALLINT(),
2025-09-04 17:57:04 +00:00
allowNull: false,
defaultValue: 2,
2025-09-03 18:04:09 +00:00
},
discount_percentage_value: {
type: new DataTypes.SMALLINT(),
2025-09-26 18:09:14 +00:00
allowNull: false,
defaultValue: 0,
2025-09-03 18:04:09 +00:00
},
discount_percentage_scale: {
type: new DataTypes.SMALLINT(),
2025-09-04 17:57:04 +00:00
allowNull: false,
defaultValue: 2,
2025-09-03 18:04:09 +00:00
},
discount_amount_value: {
type: new DataTypes.BIGINT(),
2025-09-26 18:09:14 +00:00
allowNull: false,
defaultValue: 0,
2025-09-03 18:04:09 +00:00
},
discount_amount_scale: {
type: new DataTypes.SMALLINT(),
2025-09-04 17:57:04 +00:00
allowNull: false,
defaultValue: 2,
2025-09-03 18:04:09 +00:00
},
taxable_amount_value: {
2025-04-01 14:26:15 +00:00
type: new DataTypes.BIGINT(), // importante: evita problemas de precisión con valores grandes
2025-09-26 18:09:14 +00:00
allowNull: false,
defaultValue: 0,
2025-04-01 14:26:15 +00:00
},
2025-09-03 18:04:09 +00:00
taxable_amount_scale: {
2025-04-01 14:26:15 +00:00
type: new DataTypes.SMALLINT(),
2025-09-04 17:57:04 +00:00
allowNull: false,
defaultValue: 2,
2025-04-01 14:26:15 +00:00
},
2025-09-09 15:48:12 +00:00
taxes_amount_value: {
2025-04-01 14:26:15 +00:00
type: new DataTypes.BIGINT(), // importante: evita problemas de precisión con valores grandes
2025-09-26 18:09:14 +00:00
allowNull: false,
defaultValue: 0,
2025-04-01 14:26:15 +00:00
},
2025-09-09 15:48:12 +00:00
taxes_amount_scale: {
2025-09-03 18:04:09 +00:00
type: new DataTypes.SMALLINT(),
2025-09-04 17:57:04 +00:00
allowNull: false,
defaultValue: 2,
2025-09-03 18:04:09 +00:00
},
total_amount_value: {
type: new DataTypes.BIGINT(), // importante: evita problemas de precisión con valores grandes
2025-09-26 18:09:14 +00:00
allowNull: false,
defaultValue: 0,
2025-09-03 18:04:09 +00:00
},
total_amount_scale: {
2025-04-01 14:26:15 +00:00
type: new DataTypes.SMALLINT(),
2025-09-04 17:57:04 +00:00
allowNull: false,
defaultValue: 2,
2025-04-01 14:26:15 +00:00
},
2025-09-08 17:24:38 +00:00
customer_id: {
type: DataTypes.UUID,
allowNull: false,
},
2025-09-09 15:48:12 +00:00
2025-09-08 17:24:38 +00:00
customer_tin: {
type: DataTypes.STRING,
allowNull: true,
defaultValue: null,
},
2025-09-09 15:48:12 +00:00
2025-09-08 17:24:38 +00:00
customer_name: {
type: DataTypes.STRING,
allowNull: true,
defaultValue: null,
},
2025-09-09 15:48:12 +00:00
2025-09-08 17:24:38 +00:00
customer_street: {
type: DataTypes.STRING,
allowNull: true,
defaultValue: null,
},
2025-09-09 15:48:12 +00:00
2025-09-08 17:24:38 +00:00
customer_street2: {
type: DataTypes.STRING,
allowNull: true,
defaultValue: null,
},
2025-09-09 15:48:12 +00:00
2025-09-08 17:24:38 +00:00
customer_city: {
type: DataTypes.STRING,
allowNull: true,
defaultValue: null,
},
2025-09-09 15:48:12 +00:00
2025-09-08 17:24:38 +00:00
customer_province: {
type: DataTypes.STRING,
allowNull: true,
defaultValue: null,
},
2025-09-09 15:48:12 +00:00
2025-09-08 17:24:38 +00:00
customer_postal_code: {
type: DataTypes.STRING,
allowNull: true,
defaultValue: null,
},
2025-09-09 15:48:12 +00:00
2025-09-08 17:24:38 +00:00
customer_country: {
type: DataTypes.STRING,
allowNull: true,
defaultValue: null,
},
factuges_id: {
type: DataTypes.STRING,
allowNull: true,
defaultValue: null,
},
2025-04-01 14:26:15 +00:00
},
{
2025-05-02 21:43:51 +00:00
sequelize: database,
2025-10-30 18:26:57 +00:00
modelName: "CustomerInvoiceModel",
2025-06-12 06:55:17 +00:00
tableName: "customer_invoices",
2025-04-01 14:26:15 +00:00
underscored: true,
2025-04-01 14:26:15 +00:00
paranoid: true, // softs deletes
timestamps: true,
createdAt: "created_at",
updatedAt: "updated_at",
deletedAt: "deleted_at",
2025-10-24 11:01:51 +00:00
indexes: [
{
name: "idx_invoices_company_date",
fields: ["company_id", "deleted_at", { name: "invoice_date", order: "DESC" }],
},
{
name: "idx_invoice_company_series_number",
fields: ["company_id", "series", "invoice_number"],
unique: true,
}, // <- para consulta get
2025-10-24 11:01:51 +00:00
{ name: "idx_invoice_date", fields: ["invoice_date"] }, // <- para ordenación
{ name: "idx_invoice_company_id", fields: ["id", "company_id"], unique: true }, // <- para consulta get
{ name: "idx_invoice_proforma_id", fields: ["proforma_id"], unique: false }, // <- para localizar factura por medio de proforma
{ name: "idx_invoice_factuges", fields: ["factuges_id"], unique: false }, // <- para el proceso python
// Para búsquedas simples
2025-10-24 11:01:51 +00:00
{
name: "ft_customer_invoice",
type: "FULLTEXT",
fields: ["invoice_number", "reference", "description"],
},
],
2025-04-01 14:26:15 +00:00
whereMergeStrategy: "and", // <- cómo tratar el merge de un scope
defaultScope: {},
scopes: {},
2025-10-03 19:01:38 +00:00
/*hooks: {
// Incrementa la versión en cada update exitoso (OCC).
beforeUpdate: (instance) => {
const current = instance.get("version") as number;
instance.set("version", current + 1);
},
},*/
2025-04-01 14:26:15 +00:00
}
);
2025-06-11 15:13:44 +00:00
return CustomerInvoiceModel;
2025-04-01 14:26:15 +00:00
};