InvManage.models.objects

Module Contents

Classes

Dashboard

Model of the dashboard.

Company

Model of the company.

Vendor

Model of the vendor.

Consumer

Model of the consumer.

PurchaseOrder

Model of the purchase order.

GoodsReceiptNote

Model of the goods receipt note (GRN).

SalesOrder

Model of the sales order.

Product

Model of the product.

ProductPurchaseEntry

Model of the product purchase entry.

GRNEntry

Model of the goods receipt note entry (GRNE).

ProductSalesEntry

Model of the product sales entry.

PurchaseInvoice

Model for the purchase invoice.

GRNInvoice

Model for the goods receipt note invoice.

SalesInvoice

Model for the sales order invoice.

class InvManage.models.objects.Dashboard

Bases: django.db.models.Model

Model of the dashboard.

class InvManage.models.objects.Company

Bases: django.db.models.Model

Model of the company.

name

Name of the company.

Type

str

owner

Owner of the company.

Type

str

gstin

GSTIN number of the company.

Type

str

phone

Contact number.

Type

str

address

Postal address.

Type

str

email

E-mail address of the contact person.

Type

str

location

City of the company.

Type

str

image

Photo/logo of the company.

Type

ImageField

shippingaddress

Primary key of the ShippingAddress instance associated with the company.

Type

ShippingAddress

Returns

String representation of the company name.

Return type

str

name
owner
gstin
phone
address
email
location
image
shippingaddress
__str__(self)
class InvManage.models.objects.Vendor

Bases: django.db.models.Model

Model of the vendor.

name

Name of the vendor.

Type

str

identifier

Unique identifier of the vendor.

Type

str

gstin

GSTIN number of the vendor.

Type

str

address

Primary key of the ShippingAddress instance associated with the vendor.

Type

ShippingAddress

communication

Primary key of the Communication instance associated with the vendor.

Type

Communication

backaccount

Primary key of the BankAccount instance associated with the vendor.

Type

BankAccount

purchasedata

Primary key of the PurchaseData instance associated with the vendor.

Type

PurchaseData

Returns

String representation of the vendor name.

Return type

str

name
identifier
gstin
address
communication
bankaccount
purchasedata
__str__(self)
class InvManage.models.objects.Consumer

Bases: django.db.models.Model

Model of the consumer.

name

Name of the consumer.

Type

str

identifier

Unique identifier of the consumer.

Type

str

gstin

GSTIN number of the consumer.

Type

str

phone

Contact number.

Type

str

address

Address of the consumer.

Type

str

email

E-mail address of the consumer.

Type

str

location

City of the consumer.

Type

str

Returns

[description]

Return type

[type]

name
identifier
gstin
phone
address
email
location
__str__(self)
class InvManage.models.objects.PurchaseOrder

Bases: django.db.models.Model

Model of the purchase order.

vendor

Vendor associated with the purchase order.

Type

Vendor

date

Date and time of the purchase order creation.

Type

DateField

po

Purchase order number.

Type

int

discount

Percentage discount.

Type

float

tax

Percentage of tax applicable for the purchase.

Type

float

paid

Amount paid against the PO.

Type

float

balance

Amount balance which remains to be paid.

Type

float

subtotal

Total of all the product purchase entries associated with the purchase order.

Type

float

taxtotal

Total tax applicable on the subtotal.

Type

float

ordertotal

Total price of the purchase order including taxtotal.

Type

float

is_complete()

Returns the completion status (boolean).

pending_ppes()

Returns list of product purchase entries which are not completed.

vendor
date
po
discount
tax
paid
balance
subtotal
taxtotal
ordertotal
is_complete(self)
pending_ppes(self)
class InvManage.models.objects.GoodsReceiptNote

Bases: django.db.models.Model

Model of the goods receipt note (GRN).

vendor

Vendor associated with the goods receipt note.

Type

ModelChoiceField

poRef

List of identifiers of the purchase orders from which the goods receipt note is derived.

Type

MultipleChoiceField

identifier

Unique identifier of the goods receipt note.

Type

str

date

Date of GRN creation.

Type

DateField

grnType

Type of GRN (auto or manual).

Type

ChoiceField

amendNumber

Amendment number of the GRN.

Type

int

amendDate

Amendment date.

Type

DateField

transporter

Name of the transport/shipping service.

Type

str

vehicleNumber

Vehicle number using which the products are shipped.

Type

str

gateInwardNumber

Gate inward number of the vehicle.

Type

str

preparedBy

Name/identifier of the person who created the goods receipt note.

Type

str

checkedBy

Name/identifier of the person who validated the goods receipt note.

Type

str

checkedBy

Name/identifier of the person who inspected the physical products in the goods receipt note.

Type

str

approvedBy

Name/identifier of the authority who approved the goods receipt note.

Type

str

TYPE_CHOICES = [['manual', 'Blank'], ['auto', 'PO Reference']]
vendor
poRef
identifier
date
grnType
amendNumber
amendDate
transporter
vehicleNumber
gateInwardNumber
preparedBy
checkedBy
inspectedBy
approvedBy
class InvManage.models.objects.SalesOrder

Bases: django.db.models.Model

Model of the sales order.

consumer

Consumer associated with the sales order.

Type

ModelChoiceField

date

Date of the sales order creation.

Type

DateField

so

Sales order number.

Type

int

discount

Percentage discount associated with the sales order.

Type

float

tax

Percentage of tax applicable.

Type

float

paid

Amount received from the consumer.

Type

float

balance

Amount balance with the consumer.

Type

float

subtotal

Total of all the product sales entries associated with the sales order.

Type

float

taxtotal

Total tax applicable on the subtotal.

Type

float

ordertotal

Total price of the sales order including taxtotal.

Type

float

consumer
date
so
discount
tax
paid
balance
subtotal
taxtotal
ordertotal
class InvManage.models.objects.Product

Bases: django.db.models.Model

Model of the product.

name

Name of the product.

Type

str

category

Product category.

Type

str

item_type

Type of the product.

Type

str

description

Short description of the product.

Type

str

price

Price of the product.

Type

float

quantity

Stock quantity of the product.

Type

int

identifier

Unique identifier of the product.

Type

str

location

Physical location of the product.

Type

str

length

Length of the product.

Type

str

width

Width of the product.

Type

str

height

Height of the product.

Type

str

weight

Weight of the product.

Type

str

discount

Default discount percentage on the product.

Type

float

barcode

Barcode of the product.

Type

str

expiry

Expiry date of the product.

Type

DateField

image

Image of the product.

Type

ImageField

name
category
item_type
description
price
quantity
identifier
location
length
width
height
weight
discount
barcode
expiry
image
__str__(self)
class InvManage.models.objects.ProductPurchaseEntry

Bases: django.db.models.Model

Model of the product purchase entry.

product

Product associated wit the product purchase entry.

Type

ModelChoiceField

quantity

Quantity of the product to be ordered.

Type

int

price

Price of the product.

Type

float

discount

Percentage discount on the product purchase.

Type

float

order

Referenced purchase order.

Type

PurchaseOrder

receivedQty

Quantity of product received against the ordered quantity.

Type

str

acceptedQty

Quantity of product accepted as OK.

Type

str

rejectedQty

Quantity of product rejected (not OK, on HOLD, extra delivery, etc.)

Type

str

is_complete()

Returns the completion status (boolean).

pending_quantity()

Returns the pending quantity against the entry (int).

product
quantity
price
discount
order
receivedQty
acceptedQty
rejectedQty
is_complete(self)
property pending_quantity(self)
class InvManage.models.objects.GRNEntry

Bases: django.db.models.Model

Model of the goods receipt note entry (GRNE).

product

Primary key of the Product instance associated with the goods receipt note entry.

Type

Product

quantity

Ordered quantity of product with reference to product purchase entry.

Type

int

grne

Primary key of the GoodsReceiptNote instance.

Type

int

ppe

Primary key of the ProductPurchaseEntry instance associated with the GRNE.

Type

int

remark

Remarks of the quality engineer or the GRN creator about status of products received.

Type

str

receivedQty

Quantity of product received against the ordered quantity.

Type

str

acceptedQty

Quantity of product accepted as OK.

Type

str

rejectedQty

Quantity of product rejected (not OK, on HOLD, extra delivery, etc.)

Type

str

product
quantity
grn
ppes
remark
receivedQty
acceptedQty
rejectedQty
class InvManage.models.objects.ProductSalesEntry

Bases: django.db.models.Model

Model of the product sales entry.

product

Primary key of the Product associated with the product sales entry.

Type

Product

quantity

Quantity of the product.

Type

int

price

Price of the product.

Type

float

discount

Percentage discount on the product.

Type

float

order

Primary key of the SalesOrder referenced by the entry.

Type

SalesOrder

product
quantity
price
discount
order
class InvManage.models.objects.PurchaseInvoice

Bases: django.db.models.Model

Model for the purchase invoice.

company

Primary key of the Company.

Type

Company

po

Primary key of the PurchaseOrder.

Type

PurchaseOrder

shippingaddress

Primary key of the ShippingAddress.

Type

ShippingAddress

communication

Primary key of the Communication.

Type

Communication

company
po
shippingaddress
communication
class InvManage.models.objects.GRNInvoice

Bases: django.db.models.Model

Model for the goods receipt note invoice.

company

Primary key of the Company.

Type

Company

grn

Primary key of the GoodsReceiptNote.

Type

GoodsReceiptNote

shippingaddress

Primary key of the ShippingAddress.

Type

ShippingAddress

communication

Primary key of the Communication.

Type

Communication

company
grn
shippingaddress
communication
class InvManage.models.objects.SalesInvoice

Bases: django.db.models.Model

Model for the sales order invoice.

company

Primary key of the Company.

Type

Company

so

Primary key of the SalesOrder.

Type

SalesOrder

shippingaddress

Primary key of the ShippingAddress.

Type

ShippingAddress

company
so
shippingaddress