JournalReference
extends Model
in package
Uses
CommonResponseProperties, HasFactory, HasRevisions, UuidPrimaryKey
Link to an external account entity (customer, vendor, etc.).
Tags
Table of Contents
- $code : string
- $created_at : Carbon
- $domainUuid : string
- $extra : string
- $incrementing : mixed
- $journalReferenceUuid : string
- $revision : Carbon
- $updated_at : Carbon
- __get() : HigherOrderCollectionProxy|mixed|string|null
- The revision Hash is computationally expensive, only calculated when required.
- checkRevision() : mixed
- Throw a Breaker exception if the request revision doesn't match the stored value.
- clearRevisionCache() : void
- createFromMessage() : self
- findWith() : Builder
- getRevisionHash() : mixed
- refresh() : mixed
- toResponse() : array<string|int, mixed>
Properties
$code
public
string
$code
External identifier.
$created_at
public
Carbon
$created_at
$domainUuid
public
string
$domainUuid
The domain this reference exists in.
$extra
public
string
$extra
Application specific information.
$incrementing
public
mixed
$incrementing
= false
$journalReferenceUuid
public
string
$journalReferenceUuid
UUID primary key.
$revision
public
Carbon
$revision
Revision timestamp to detect race condition on update.
$updated_at
public
Carbon
$updated_at
Methods
__get()
The revision Hash is computationally expensive, only calculated when required.
public
__get( $key) : HigherOrderCollectionProxy|mixed|string|null
Parameters
Tags
Return values
HigherOrderCollectionProxy|mixed|string|null —checkRevision()
Throw a Breaker exception if the request revision doesn't match the stored value.
public
checkRevision(string|null $revision) : mixed
Parameters
- $revision : string|null
Tags
Return values
mixed —clearRevisionCache()
public
clearRevisionCache() : void
Return values
void —createFromMessage()
public
static createFromMessage(Reference $message) : self
Parameters
- $message : Reference
Tags
Return values
self —findWith()
public
static findWith(Reference $reference) : Builder
Parameters
- $reference : Reference
Tags
Return values
Builder —getRevisionHash()
public
getRevisionHash() : mixed
Return values
mixed —refresh()
public
refresh() : mixed
Return values
mixed —toResponse()
public
toResponse() : array<string|int, mixed>