mirror of
https://github.com/bigcapitalhq/bigcapital.git
synced 2026-02-16 04:40:32 +00:00
hotbug(saleInvoices): sale invoice model.
This commit is contained in:
@@ -7,14 +7,14 @@ export default class SaleInvoice extends TenantModel {
|
|||||||
* Table name
|
* Table name
|
||||||
*/
|
*/
|
||||||
static get tableName() {
|
static get tableName() {
|
||||||
return "sales_invoices";
|
return 'sales_invoices';
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Timestamps columns.
|
* Timestamps columns.
|
||||||
*/
|
*/
|
||||||
get timestamps() {
|
get timestamps() {
|
||||||
return ["created_at", "updated_at"];
|
return ['created_at', 'updated_at'];
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -22,14 +22,14 @@ export default class SaleInvoice extends TenantModel {
|
|||||||
*/
|
*/
|
||||||
static get virtualAttributes() {
|
static get virtualAttributes() {
|
||||||
return [
|
return [
|
||||||
"dueAmount",
|
'dueAmount',
|
||||||
"isDelivered",
|
'isDelivered',
|
||||||
"isOverdue",
|
'isOverdue',
|
||||||
"isPartiallyPaid",
|
'isPartiallyPaid',
|
||||||
"isFullyPaid",
|
'isFullyPaid',
|
||||||
"isPaid",
|
'isPaid',
|
||||||
"remainingDays",
|
'remainingDays',
|
||||||
"overdueDays",
|
'overdueDays',
|
||||||
];
|
];
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -95,7 +95,7 @@ export default class SaleInvoice extends TenantModel {
|
|||||||
const date = moment();
|
const date = moment();
|
||||||
const dueDate = moment(this.dueDate);
|
const dueDate = moment(this.dueDate);
|
||||||
|
|
||||||
return Math.max(dueDate.diff(date, "days"), 0);
|
return Math.max(dueDate.diff(date, 'days'), 0);
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -114,7 +114,7 @@ export default class SaleInvoice extends TenantModel {
|
|||||||
*
|
*
|
||||||
* @param {*} asDate
|
* @param {*} asDate
|
||||||
*/
|
*/
|
||||||
getOverdueDays(asDate = moment().format("YYYY-MM-DD")) {
|
getOverdueDays(asDate = moment().format('YYYY-MM-DD')) {
|
||||||
// Can't continue in case due date not defined.
|
// Can't continue in case due date not defined.
|
||||||
if (!this.dueDate) {
|
if (!this.dueDate) {
|
||||||
return null;
|
return null;
|
||||||
@@ -123,7 +123,7 @@ export default class SaleInvoice extends TenantModel {
|
|||||||
const date = moment(asDate);
|
const date = moment(asDate);
|
||||||
const dueDate = moment(this.dueDate);
|
const dueDate = moment(this.dueDate);
|
||||||
|
|
||||||
return Math.max(date.diff(dueDate, "days"), 0);
|
return Math.max(date.diff(dueDate, 'days'), 0);
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -135,65 +135,65 @@ export default class SaleInvoice extends TenantModel {
|
|||||||
* Filters the due invoices.
|
* Filters the due invoices.
|
||||||
*/
|
*/
|
||||||
dueInvoices(query) {
|
dueInvoices(query) {
|
||||||
query.where(raw("BALANCE - PAYMENT_AMOUNT > 0"));
|
query.where(raw('BALANCE - PAYMENT_AMOUNT > 0'));
|
||||||
},
|
},
|
||||||
/**
|
/**
|
||||||
* Filters the invoices between the given date range.
|
* Filters the invoices between the given date range.
|
||||||
*/
|
*/
|
||||||
filterDateRange(query, startDate, endDate, type = "day") {
|
filterDateRange(query, startDate, endDate, type = 'day') {
|
||||||
const dateFormat = "YYYY-MM-DD HH:mm:ss";
|
const dateFormat = 'YYYY-MM-DD HH:mm:ss';
|
||||||
const fromDate = moment(startDate).startOf(type).format(dateFormat);
|
const fromDate = moment(startDate).startOf(type).format(dateFormat);
|
||||||
const toDate = moment(endDate).endOf(type).format(dateFormat);
|
const toDate = moment(endDate).endOf(type).format(dateFormat);
|
||||||
|
|
||||||
if (startDate) {
|
if (startDate) {
|
||||||
query.where("invoice_date", ">=", fromDate);
|
query.where('invoice_date', '>=', fromDate);
|
||||||
}
|
}
|
||||||
if (endDate) {
|
if (endDate) {
|
||||||
query.where("invoice_date", "<=", toDate);
|
query.where('invoice_date', '<=', toDate);
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
/**
|
/**
|
||||||
* Filters the invoices in draft status.
|
* Filters the invoices in draft status.
|
||||||
*/
|
*/
|
||||||
draft(query) {
|
draft(query) {
|
||||||
query.where("delivered_at", null);
|
query.where('delivered_at', null);
|
||||||
},
|
},
|
||||||
/**
|
/**
|
||||||
* Filters the delivered invoices.
|
* Filters the delivered invoices.
|
||||||
*/
|
*/
|
||||||
delivered(query) {
|
delivered(query) {
|
||||||
query.whereNot("delivered_at", null);
|
query.whereNot('delivered_at', null);
|
||||||
},
|
},
|
||||||
/**
|
/**
|
||||||
* Filters the unpaid invoices.
|
* Filters the unpaid invoices.
|
||||||
*/
|
*/
|
||||||
unpaid(query) {
|
unpaid(query) {
|
||||||
query.where(raw("PAYMENT_AMOUNT = 0"));
|
query.where(raw('PAYMENT_AMOUNT = 0'));
|
||||||
},
|
},
|
||||||
/**
|
/**
|
||||||
* Filters the overdue invoices.
|
* Filters the overdue invoices.
|
||||||
*/
|
*/
|
||||||
overdue(query, asDate = moment().format("YYYY-MM-DD")) {
|
overdue(query, asDate = moment().format('YYYY-MM-DD')) {
|
||||||
query.where("due_date", "<", asDate);
|
query.where('due_date', '<', asDate);
|
||||||
},
|
},
|
||||||
/**
|
/**
|
||||||
* Filters the not overdue invoices.
|
* Filters the not overdue invoices.
|
||||||
*/
|
*/
|
||||||
notOverdue(query, asDate = moment().format("YYYY-MM-DD")) {
|
notOverdue(query, asDate = moment().format('YYYY-MM-DD')) {
|
||||||
query.where("due_date", ">=", asDate);
|
query.where('due_date', '>=', asDate);
|
||||||
},
|
},
|
||||||
/**
|
/**
|
||||||
* Filters the partially invoices.
|
* Filters the partially invoices.
|
||||||
*/
|
*/
|
||||||
partiallyPaid(query) {
|
partiallyPaid(query) {
|
||||||
query.whereNot("payment_amount", 0);
|
query.whereNot('payment_amount', 0);
|
||||||
query.whereNot(raw("`PAYMENT_AMOUNT` = `BALANCE`"));
|
query.whereNot(raw('`PAYMENT_AMOUNT` = `BALANCE`'));
|
||||||
},
|
},
|
||||||
/**
|
/**
|
||||||
* Filters the paid invoices.
|
* Filters the paid invoices.
|
||||||
*/
|
*/
|
||||||
paid(query) {
|
paid(query) {
|
||||||
query.where(raw("PAYMENT_AMOUNT = BALANCE"));
|
query.where(raw('PAYMENT_AMOUNT = BALANCE'));
|
||||||
},
|
},
|
||||||
/**
|
/**
|
||||||
* Filters the sale invoices from the given date.
|
* Filters the sale invoices from the given date.
|
||||||
@@ -219,9 +219,7 @@ export default class SaleInvoice extends TenantModel {
|
|||||||
*/
|
*/
|
||||||
maxInvoiceNo(query, prefix, number) {
|
maxInvoiceNo(query, prefix, number) {
|
||||||
query
|
query
|
||||||
.select(
|
.select(raw(`REPLACE(INVOICE_NO, "${prefix}", "") AS INV_NUMBER`))
|
||||||
raw(`REPLACE(INVOICE_NO, "${prefix}", "") AS INV_NUMBER`)
|
|
||||||
)
|
|
||||||
.havingRaw('CHAR_LENGTH(INV_NUMBER) = ??', [number.length])
|
.havingRaw('CHAR_LENGTH(INV_NUMBER) = ??', [number.length])
|
||||||
.orderBy('invNumber', 'DESC')
|
.orderBy('invNumber', 'DESC')
|
||||||
.limit(1)
|
.limit(1)
|
||||||
@@ -229,8 +227,8 @@ export default class SaleInvoice extends TenantModel {
|
|||||||
},
|
},
|
||||||
|
|
||||||
byPrefixAndNumber(query, prefix, number) {
|
byPrefixAndNumber(query, prefix, number) {
|
||||||
query.where('invoice_no', `${prefix}${number}`)
|
query.where('invoice_no', `${prefix}${number}`);
|
||||||
}
|
},
|
||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -238,22 +236,22 @@ export default class SaleInvoice extends TenantModel {
|
|||||||
* Relationship mapping.
|
* Relationship mapping.
|
||||||
*/
|
*/
|
||||||
static get relationMappings() {
|
static get relationMappings() {
|
||||||
const AccountTransaction = require("models/AccountTransaction");
|
const AccountTransaction = require('models/AccountTransaction');
|
||||||
const ItemEntry = require("models/ItemEntry");
|
const ItemEntry = require('models/ItemEntry');
|
||||||
const Contact = require("models/Contact");
|
const Contact = require('models/Contact');
|
||||||
const InventoryCostLotTracker = require("models/InventoryCostLotTracker");
|
const InventoryCostLotTracker = require('models/InventoryCostLotTracker');
|
||||||
const PaymentReceiveEntry = require("models/PaymentReceiveEntry");
|
const PaymentReceiveEntry = require('models/PaymentReceiveEntry');
|
||||||
|
|
||||||
return {
|
return {
|
||||||
entries: {
|
entries: {
|
||||||
relation: Model.HasManyRelation,
|
relation: Model.HasManyRelation,
|
||||||
modelClass: ItemEntry.default,
|
modelClass: ItemEntry.default,
|
||||||
join: {
|
join: {
|
||||||
from: "sales_invoices.id",
|
from: 'sales_invoices.id',
|
||||||
to: "items_entries.referenceId",
|
to: 'items_entries.referenceId',
|
||||||
},
|
},
|
||||||
filter(builder) {
|
filter(builder) {
|
||||||
builder.where("reference_type", "SaleInvoice");
|
builder.where('reference_type', 'SaleInvoice');
|
||||||
},
|
},
|
||||||
},
|
},
|
||||||
|
|
||||||
@@ -261,8 +259,8 @@ export default class SaleInvoice extends TenantModel {
|
|||||||
relation: Model.BelongsToOneRelation,
|
relation: Model.BelongsToOneRelation,
|
||||||
modelClass: Contact.default,
|
modelClass: Contact.default,
|
||||||
join: {
|
join: {
|
||||||
from: "sales_invoices.customerId",
|
from: 'sales_invoices.customerId',
|
||||||
to: "contacts.id",
|
to: 'contacts.id',
|
||||||
},
|
},
|
||||||
filter(query) {
|
filter(query) {
|
||||||
query.where('contact_service', 'Customer');
|
query.where('contact_service', 'Customer');
|
||||||
@@ -275,14 +273,32 @@ export default class SaleInvoice extends TenantModel {
|
|||||||
join: {
|
join: {
|
||||||
from: 'sales_invoices.id',
|
from: 'sales_invoices.id',
|
||||||
to: 'accounts_transactions.referenceId',
|
to: 'accounts_transactions.referenceId',
|
||||||
|
},
|
||||||
|
filter(builder) {
|
||||||
|
builder.where('reference_type', 'SaleInvoice');
|
||||||
|
},
|
||||||
},
|
},
|
||||||
|
|
||||||
|
costTransactions: {
|
||||||
|
relation: Model.HasManyRelation,
|
||||||
|
modelClass: InventoryCostLotTracker.default,
|
||||||
join: {
|
join: {
|
||||||
from: 'sales_invoices.id',
|
from: 'sales_invoices.id',
|
||||||
to: 'inventory_cost_lot_tracker.transactionId',
|
to: 'inventory_cost_lot_tracker.transactionId',
|
||||||
},
|
},
|
||||||
filter(builder) {
|
filter(builder) {
|
||||||
|
builder.where('transaction_type', 'SaleInvoice');
|
||||||
|
},
|
||||||
},
|
},
|
||||||
|
|
||||||
|
paymentEntries: {
|
||||||
|
relation: Model.HasManyRelation,
|
||||||
|
modelClass: PaymentReceiveEntry.default,
|
||||||
join: {
|
join: {
|
||||||
|
from: 'sales_invoices.id',
|
||||||
|
to: 'payment_receives_entries.invoice_id',
|
||||||
|
},
|
||||||
|
},
|
||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -292,7 +308,7 @@ export default class SaleInvoice extends TenantModel {
|
|||||||
* @param {Numeric} amount
|
* @param {Numeric} amount
|
||||||
*/
|
*/
|
||||||
static async changePaymentAmount(invoiceId, amount) {
|
static async changePaymentAmount(invoiceId, amount) {
|
||||||
const changeMethod = amount > 0 ? "increment" : "decrement";
|
const changeMethod = amount > 0 ? 'increment' : 'decrement';
|
||||||
|
|
||||||
await this.query()
|
await this.query()
|
||||||
.where('id', invoiceId)
|
.where('id', invoiceId)
|
||||||
@@ -305,86 +321,86 @@ export default class SaleInvoice extends TenantModel {
|
|||||||
static get fields() {
|
static get fields() {
|
||||||
return {
|
return {
|
||||||
customer: {
|
customer: {
|
||||||
label: "Customer",
|
label: 'Customer',
|
||||||
column: "customer_id",
|
column: 'customer_id',
|
||||||
relation: "contacts.id",
|
relation: 'contacts.id',
|
||||||
relationColumn: "contacts.displayName",
|
relationColumn: 'contacts.displayName',
|
||||||
|
|
||||||
fieldType: "options",
|
fieldType: 'options',
|
||||||
optionsResource: "customers",
|
optionsResource: 'customers',
|
||||||
optionsKey: "id",
|
optionsKey: 'id',
|
||||||
optionsLable: "displayName",
|
optionsLable: 'displayName',
|
||||||
},
|
},
|
||||||
invoice_date: {
|
invoice_date: {
|
||||||
label: "Invoice date",
|
label: 'Invoice date',
|
||||||
column: "invoice_date",
|
column: 'invoice_date',
|
||||||
columnType: "date",
|
columnType: 'date',
|
||||||
fieldType: "date",
|
fieldType: 'date',
|
||||||
},
|
},
|
||||||
due_date: {
|
due_date: {
|
||||||
label: "Due date",
|
label: 'Due date',
|
||||||
column: "due_date",
|
column: 'due_date',
|
||||||
columnType: "date",
|
columnType: 'date',
|
||||||
fieldType: "date",
|
fieldType: 'date',
|
||||||
},
|
},
|
||||||
invoice_no: {
|
invoice_no: {
|
||||||
label: "Invoice No.",
|
label: 'Invoice No.',
|
||||||
column: "invoice_no",
|
column: 'invoice_no',
|
||||||
columnType: "number",
|
columnType: 'number',
|
||||||
fieldType: "number",
|
fieldType: 'number',
|
||||||
},
|
},
|
||||||
reference_no: {
|
reference_no: {
|
||||||
label: "Reference No.",
|
label: 'Reference No.',
|
||||||
column: "reference_no",
|
column: 'reference_no',
|
||||||
columnType: "number",
|
columnType: 'number',
|
||||||
fieldType: "number",
|
fieldType: 'number',
|
||||||
},
|
},
|
||||||
invoice_message: {
|
invoice_message: {
|
||||||
label: "Invoice message",
|
label: 'Invoice message',
|
||||||
column: "invoice_message",
|
column: 'invoice_message',
|
||||||
columnType: "text",
|
columnType: 'text',
|
||||||
fieldType: "text",
|
fieldType: 'text',
|
||||||
},
|
},
|
||||||
terms_conditions: {
|
terms_conditions: {
|
||||||
label: "Terms & conditions",
|
label: 'Terms & conditions',
|
||||||
column: "terms_conditions",
|
column: 'terms_conditions',
|
||||||
columnType: "text",
|
columnType: 'text',
|
||||||
fieldType: "text",
|
fieldType: 'text',
|
||||||
},
|
},
|
||||||
invoice_amount: {
|
invoice_amount: {
|
||||||
label: "Invoice amount",
|
label: 'Invoice amount',
|
||||||
column: "invoice_amount",
|
column: 'invoice_amount',
|
||||||
columnType: "number",
|
columnType: 'number',
|
||||||
fieldType: "number",
|
fieldType: 'number',
|
||||||
},
|
},
|
||||||
payment_amount: {
|
payment_amount: {
|
||||||
label: "Payment amount",
|
label: 'Payment amount',
|
||||||
column: "payment_amount",
|
column: 'payment_amount',
|
||||||
columnType: "number",
|
columnType: 'number',
|
||||||
fieldType: "number",
|
fieldType: 'number',
|
||||||
},
|
},
|
||||||
balance: {
|
balance: {
|
||||||
label: "Balance",
|
label: 'Balance',
|
||||||
column: "balance",
|
column: 'balance',
|
||||||
columnType: "number",
|
columnType: 'number',
|
||||||
fieldType: "number",
|
fieldType: 'number',
|
||||||
},
|
},
|
||||||
due_amount: {
|
due_amount: {
|
||||||
label: "Due amount",
|
label: 'Due amount',
|
||||||
column: "due_amount",
|
column: 'due_amount',
|
||||||
columnType: "number",
|
columnType: 'number',
|
||||||
fieldType: "number",
|
fieldType: 'number',
|
||||||
sortQuery(query, role) {
|
sortQuery(query, role) {
|
||||||
query.modify('sortByDueAmount', role.order);
|
query.modify('sortByDueAmount', role.order);
|
||||||
},
|
},
|
||||||
},
|
},
|
||||||
created_at: {
|
created_at: {
|
||||||
label: "Created at",
|
label: 'Created at',
|
||||||
column: "created_at",
|
column: 'created_at',
|
||||||
columnType: "date",
|
columnType: 'date',
|
||||||
},
|
},
|
||||||
status: {
|
status: {
|
||||||
label: "Status",
|
label: 'Status',
|
||||||
options: [
|
options: [
|
||||||
{ key: 'draft', label: 'Draft' },
|
{ key: 'draft', label: 'Draft' },
|
||||||
{ key: 'delivered', label: 'Delivered' },
|
{ key: 'delivered', label: 'Delivered' },
|
||||||
@@ -398,20 +414,20 @@ export default class SaleInvoice extends TenantModel {
|
|||||||
case 'draft':
|
case 'draft':
|
||||||
query.modify('draft');
|
query.modify('draft');
|
||||||
break;
|
break;
|
||||||
case "delivered":
|
case 'delivered':
|
||||||
query.modify("delivered");
|
query.modify('delivered');
|
||||||
break;
|
break;
|
||||||
case "unpaid":
|
case 'unpaid':
|
||||||
query.modify("unpaid");
|
query.modify('unpaid');
|
||||||
break;
|
break;
|
||||||
case "overdue":
|
case 'overdue':
|
||||||
query.modify("overdue");
|
query.modify('overdue');
|
||||||
break;
|
break;
|
||||||
case "partially-paid":
|
case 'partially-paid':
|
||||||
query.modify("partiallyPaid");
|
query.modify('partiallyPaid');
|
||||||
break;
|
break;
|
||||||
case "paid":
|
case 'paid':
|
||||||
query.modify("paid");
|
query.modify('paid');
|
||||||
break;
|
break;
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
|
|||||||
Reference in New Issue
Block a user