SettlementLedgerEntry
in package
Tags
Table of Contents
Properties
- $amount : float|null
- $code : int|null
- $description : string|null
- $invoiceData : InvoiceData
- $invoiceId : string|null
- $reference : string|null
- $timestamp : string|null
Methods
- __construct() : mixed
- getAmount() : float|null
- Gets amount
- getCode() : int|null
- Gets code
- getDescription() : string|null
- Gets Ledger entry description.
- getInvoiceData() : InvoiceData
- Gets Invoice Data
- getInvoiceId() : string|null
- Gets BitPay invoice Id
- getReference() : string|null
- Gets reference
- getTimestamp() : string|null
- Gets Date and time of the ledger entry (UTC). ISO-8601 format yyyy-mm-ddThh:mm:ssZ
- setAmount() : void
- Sets amount
- setCode() : void
- Sets code
- setDescription() : void
- Sets Ledger entry description.
- setInvoiceData() : void
- Sets Invoice Data
- setInvoiceId() : void
- Sets BitPay invoice Id
- setReference() : void
- Sets reference
- setTimestamp() : void
- Sets Date and time of the ledger entry (UTC). ISO-8601 format yyyy-mm-ddThh:mm:ssZ
- toArray() : array<string|int, mixed>
- Gets SettlementLedgerEntry as array
Properties
$amount
protected
float|null
$amount
= null
$code
protected
int|null
$code
= null
$description
protected
string|null
$description
= null
$invoiceData
protected
InvoiceData
$invoiceData
$invoiceId
protected
string|null
$invoiceId
= null
$reference
protected
string|null
$reference
= null
$timestamp
protected
string|null
$timestamp
= null
Methods
__construct()
public
__construct() : mixed
getAmount()
Gets amount
public
getAmount() : float|null
Amount for the ledger entry. Can be positive of negative depending on the type of entry (debit or credit)
Return values
float|null —the amount
getCode()
Gets code
public
getCode() : int|null
Contains the Ledger entry code
Return values
int|null —the code
getDescription()
Gets Ledger entry description.
public
getDescription() : string|null
This field often contains an id depending on the type of entry (for instance payout id, settlement id, invoice orderId etc...)
Return values
string|null —the description
getInvoiceData()
Gets Invoice Data
public
getInvoiceData() : InvoiceData
Object containing relevant information from the paid invoice
Return values
InvoiceDatagetInvoiceId()
Gets BitPay invoice Id
public
getInvoiceId() : string|null
Return values
string|null —BitPay invoice Id
getReference()
Gets reference
public
getReference() : string|null
Return values
string|null —the reference
getTimestamp()
Gets Date and time of the ledger entry (UTC). ISO-8601 format yyyy-mm-ddThh:mm:ssZ
public
getTimestamp() : string|null
Return values
string|null —the timestamp
setAmount()
Sets amount
public
setAmount(float $amount) : void
Amount for the ledger entry. Can be positive of negative depending on the type of entry (debit or credit)
Parameters
- $amount : float
-
the amount
setCode()
Sets code
public
setCode(int $code) : void
Contains the Ledger entry code
Parameters
- $code : int
-
the code
setDescription()
Sets Ledger entry description.
public
setDescription(string $description) : void
This field often contains an id depending on the type of entry (for instance payout id, settlement id, invoice orderId etc...)
Parameters
- $description : string
-
the description
setInvoiceData()
Sets Invoice Data
public
setInvoiceData(InvoiceData $invoiceData) : void
Object containing relevant information from the paid invoice
Parameters
- $invoiceData : InvoiceData
-
information from the paid invoice
setInvoiceId()
Sets BitPay invoice Id
public
setInvoiceId(string $invoiceId) : void
Parameters
- $invoiceId : string
-
BitPay invoice Id
setReference()
Sets reference
public
setReference(string $reference) : void
Parameters
- $reference : string
-
the reference
setTimestamp()
Sets Date and time of the ledger entry (UTC). ISO-8601 format yyyy-mm-ddThh:mm:ssZ
public
setTimestamp(string $timestamp) : void
Parameters
- $timestamp : string
-
the timestamp
toArray()
Gets SettlementLedgerEntry as array
public
toArray() : array<string|int, mixed>
Return values
array<string|int, mixed> —SettlementLedgerEntry as array