DocumentPaymentsRelation
Document payments relation table trait
Table of Contents
Properties
- $NOT_PAID : mixed
- $PAID : mixed
- $PARTIAL_PAID : mixed
Methods
- getDocumentPaymentsClass() : string|null
- Get document payments model class
- getPaymentsDue() : float
- Get payment due amount
- getPaymentStatusColumn() : string
- Get payment status column name
- getTotalPaid() : float
- Get total payments
- getTotalPaidAttribute() : float
- total_paid attribute
- isPaid() : bool
- Return true if doc is paid
- NOT_PAID() : int
- Not paid status trait constant
- PAID() : int
- Full paid status trait constant
- PARTIAL_PAID() : int
- Partial paid status trait constant
- payments() : Relation|null
- Document payments relation
- setPaymentStatus() : bool
- Set payment status
Properties
$NOT_PAID
public
static mixed
$NOT_PAID
= 0
$PAID
public
static mixed
$PAID
= 2
$PARTIAL_PAID
public
static mixed
$PARTIAL_PAID
= 1
Methods
getDocumentPaymentsClass()
Get document payments model class
public
getDocumentPaymentsClass() : string|null
Return values
string|nullgetPaymentsDue()
Get payment due amount
public
getPaymentsDue() : float
Return values
floatgetPaymentStatusColumn()
Get payment status column name
public
getPaymentStatusColumn() : string
Return values
stringgetTotalPaid()
Get total payments
public
getTotalPaid() : float
Return values
floatgetTotalPaidAttribute()
total_paid attribute
public
getTotalPaidAttribute() : float
Return values
floatisPaid()
Return true if doc is paid
public
isPaid() : bool
Return values
boolNOT_PAID()
Not paid status trait constant
public
NOT_PAID() : int
Return values
int —0
PAID()
Full paid status trait constant
public
static PAID() : int
Return values
int —2
PARTIAL_PAID()
Partial paid status trait constant
public
PARTIAL_PAID() : int
Return values
int —1
payments()
Document payments relation
public
payments() : Relation|null
Return values
Relation|nullsetPaymentStatus()
Set payment status
public
setPaymentStatus(int $status) : bool
Parameters
- $status : int