1. class
  2. IFRS
  3. \
  4. Transactions
  5. \
  6. JournalEntry

JournalEntry

class JournalEntry extends Transaction implements Assignable, Clearable, Fetchable

Class JournalEntry

Traits

Assigning
Clearing
Fetching
HasParent
Segragating
SoftDeletes
Recycling
Clearing
Assigning
ModelTablePrefix

Constants

MODELNAME

Transaction Model Name
CS

Transaction Types
IN

CN

RC

CP

BL

DN

PY

CE

JN

PREFIX

Transaction Number prefix

Properties

protected array $fillable The attributes that are mass assignable. from Transaction
Entity $entity
ExchangeRate $exchangeRate
Account $account
Currency $currency
Carbon $transaction_date from Transaction
string $reference
string $transaction_no
string $transaction_type
string $narration
bool $credited
float $amount
Carbon $destroyed_at
Carbon $deleted_at
Carbon $date

Methods

static null
bootSegragating()

Register EntityScope for Model.

from Segragating
HasOne
entity()

Model's Parent Entity.

from Segragating
static void
bootRecycling()

Model recycling events.

from Recycling
MorphMany
recycled()

Recycled Model records.

from Recycling
clearedAmount()

Cleared Transaction amount.

from Clearing
MorphMany
clearances()

Cleared Model records.

from Clearing
balance()

Balance Remaining on Transaction.

from Assigning
getTable()

Determine the model table name

from ModelTablePrefix
__construct($attributes = [])

Construct new JournalEntry

static string
getType(string $type)

Get Human Readable Transaction type

from Transaction
static array
getTypes(array $types)

Get Human Readable Transaction types

from Transaction
static string
transactionNo(string $type, Carbon $transaction_date = null)

The next Transaction number for the transaction type and transaction_date.

from Transaction
HasMany
lineItems()

Transaction Saved Line Items.

from Transaction
HasMany
ledgers()

Transaction Ledgers.

from Transaction
BelongsTo
currency()

Transaction Currency.

from Transaction
BelongsTo
account()

Transaction Account.

from Transaction
BelongsTo
exchangeRate()

Transaction Exchange Rate.

from Transaction
HasMany
assignments()

Transaction Assignments.

from Transaction
bool
isPosted()

isPosted analog for Assignment model.

from Transaction
bool
isCredited()

isCredited analog for Assignment model.

from Transaction
string
getClearedType()

Cleared Object type.

from Transaction
float
getAmount()

getAmount analog for Assignment model.

from Transaction
object
attributes()

Transaction attributes.

from Transaction
array
getLineItems()

Get Transaction LineItems.

from Transaction
void
addLineItem(LineItem $lineItem)

Add LineItem to Transaction LineItems.

from Transaction
void
removeLineItem(LineItem $lineItem)

Remove LineItem from Transaction LineItems.

from Transaction
bool
save(array $options = [])

Relate LineItems to Transaction.

from Transaction
void
post()

Post Transaction to the Ledger.

from Transaction
bool
delete()

Check Transaction Relationships.

from Transaction
bool
checkIntegrity()

Check Transaction Integrity.

from Transaction
static Collection
fetch(Carbon $startTime = null, Carbon $endTime = null, Account $account = null, Currency $currency = null)

Fetch Transactions given the filters

from Fetching

Details

in Segragating at line 29
static null bootSegragating()

Register EntityScope for Model.

Return Value

null

in Segragating at line 54
HasOne entity()

Model's Parent Entity.

Return Value

HasOne

in Recycling at line 26
static void bootRecycling()

Model recycling events.

Return Value

void

in Recycling at line 69
MorphMany recycled()

Recycled Model records.

Return Value

MorphMany

in Clearing at line 21
clearedAmount()

Cleared Transaction amount.

in Clearing at line 35
MorphMany clearances()

Cleared Model records.

Return Value

MorphMany

in Assigning at line 21
balance()

Balance Remaining on Transaction.

in ModelTablePrefix at line 20
getTable()

Determine the model table name

at line 61
__construct($attributes = [])

Construct new JournalEntry

Parameters

$attributes

in Transaction at line 171
static string getType(string $type)

Get Human Readable Transaction type

Parameters

string $type

Return Value

string

in Transaction at line 183
static array getTypes(array $types)

Get Human Readable Transaction types

Parameters

array $types

Return Value

array

in Transaction at line 201
static string transactionNo(string $type, Carbon $transaction_date = null)

The next Transaction number for the transaction type and transaction_date.

Parameters

string $type
Carbon $transaction_date

Return Value

string

in Transaction at line 221
HasMany lineItems()

Transaction Saved Line Items.

Return Value

HasMany

in Transaction at line 231
HasMany ledgers()

Transaction Ledgers.

Return Value

HasMany

in Transaction at line 241
BelongsTo currency()

Transaction Currency.

Return Value

BelongsTo

in Transaction at line 251
BelongsTo account()

Transaction Account.

Return Value

BelongsTo

in Transaction at line 261
BelongsTo exchangeRate()

Transaction Exchange Rate.

Return Value

BelongsTo

in Transaction at line 271
HasMany assignments()

Transaction Assignments.

Return Value

HasMany

in Transaction at line 279
bool isPosted()

isPosted analog for Assignment model.

Return Value

bool

in Transaction at line 289
bool isCredited()

isCredited analog for Assignment model.

Return Value

bool

in Transaction at line 299
string getClearedType()

Cleared Object type.

Return Value

string

in Transaction at line 309
float getAmount()

getAmount analog for Assignment model.

Return Value

float

in Transaction at line 331
object attributes()

Transaction attributes.

Return Value

object

in Transaction at line 341
array getLineItems()

Get Transaction LineItems.

Return Value

array

in Transaction at line 354
void addLineItem(LineItem $lineItem)

Add LineItem to Transaction LineItems.

Parameters

LineItem $lineItem

Return Value

void

in Transaction at line 374
void removeLineItem(LineItem $lineItem)

Remove LineItem from Transaction LineItems.

Parameters

LineItem $lineItem

Return Value

void

in Transaction at line 396
bool save(array $options = [])

Relate LineItems to Transaction.

Parameters

array $options

Return Value

bool

in Transaction at line 425
void post()

Post Transaction to the Ledger.

Return Value

void

in Transaction at line 439
bool delete()

Check Transaction Relationships.

Return Value

bool

in Transaction at line 460
bool checkIntegrity()

Check Transaction Integrity.

Return Value

bool

in Fetching at line 37
static Collection fetch(Carbon $startTime = null, Carbon $endTime = null, Account $account = null, Currency $currency = null)

Fetch Transactions given the filters

Parameters

Carbon $startTime
Carbon $endTime
Account $account
Currency $currency

Return Value

Collection