Menu

## InvoiceData
in package

InvoiceData.php : 19

Object containing relevant information from the paid invoice.

##### Tags

author

  BitPay Integrations integrations@bitpay.com

license

  http://www.opensource.org/licenses/mit-license.php MIT

see
  https://bitpay.readme.io/reference/settlements

  Settlements

### Table of Contents

#### Properties

$currency : string|null
$date : string|null
$orderId : string|null
$overPaidAmount : float|null
$payoutPercentage : float|null
$price : float|null
$refundInfo : RefundInfo|null
$transactionCurrency : string|null

#### Methods

__construct() : mixed
getCurrency() : string|null
  Gets Invoice currency
getDate() : string|null
  Gets Date at which the invoice was created (UTC). ISO-8601 format yyyy-mm-ddThh:mm:ssZ
getOrderId() : string|null
  Gets Invoice orderId provided during invoice creation.
getOverPaidAmount() : float|null
  Gets over paid amount
getPayoutPercentage() : float|null
  Gets The payout percentage defined by the merchant on his BitPay account settings
getPrice() : float|null
  Gets Invoice price in the invoice original currency
getRefundInfo() : RefundInfo|null
  Gets Object containing information about the refund executed for the invoice
getTransactionCurrency() : string|null
  Gets Cryptocurrency selected by the consumer when paying the invoice.
setCurrency() : void
  Sets Invoice currency
setDate() : void
  Sets Date at which the invoice was created (UTC). ISO-8601 format yyyy-mm-ddThh:mm:ssZ
setOrderId() : void
  Sets Invoice orderId provided during invoice creation.
setOverPaidAmount() : void
  Sets over paid amount
setPayoutPercentage() : void
  Sets The payout percentage defined by the merchant on his BitPay account settings
setPrice() : void
  Sets Invoice price in the invoice original currency
setRefundInfo() : void
  Sets Object containing information about the refund executed for the invoice
setTransactionCurrency() : void
  Sets Cryptocurrency selected by the consumer when paying the invoice.
toArray() : array<string|int, mixed>
  Gets InvoiceData as array

### Properties

#### $currency

InvoiceData.php : 24
`protected string|null $currency = null`

#### $date

InvoiceData.php : 22
`protected string|null $date = null`

#### $orderId

InvoiceData.php : 21
`protected string|null $orderId = null`

#### $overPaidAmount

InvoiceData.php : 26
`protected float|null $overPaidAmount = null`

#### $payoutPercentage

InvoiceData.php : 27
`protected float|null $payoutPercentage = null`

#### $price

InvoiceData.php : 23
`protected float|null $price = null`

#### $refundInfo

InvoiceData.php : 28
`protected RefundInfo|null $refundInfo = null`

#### $transactionCurrency

InvoiceData.php : 25
`protected string|null $transactionCurrency = null`

### Methods

#### __construct()

InvoiceData.php : 30
`public __construct() : mixed`

#### getCurrency()

InvoiceData.php : 99

Gets Invoice currency

`public getCurrency() : string|null`

##### Return values

string|null —

the Invoice currency

#### getDate()

InvoiceData.php : 59

Gets Date at which the invoice was created (UTC). ISO-8601 format yyyy-mm-ddThh:mm:ssZ

`public getDate() : string|null`

##### Return values

string|null —

the date

#### getOrderId()

InvoiceData.php : 39

Gets Invoice orderId provided during invoice creation.

`public getOrderId() : string|null`

##### Return values

string|null —

the order id

#### getOverPaidAmount()

InvoiceData.php : 139

Gets over paid amount

`public getOverPaidAmount() : float|null`

##### Return values

float|null —

the over paid amount

#### getPayoutPercentage()

InvoiceData.php : 159

Gets The payout percentage defined by the merchant on his BitPay account settings

`public getPayoutPercentage() : float|null`

##### Return values

float|null —

the payout percentage

#### getPrice()

InvoiceData.php : 79

Gets Invoice price in the invoice original currency

`public getPrice() : float|null`

##### Return values

float|null —

the price

#### getRefundInfo()

InvoiceData.php : 179

Gets Object containing information about the refund executed for the invoice

`public getRefundInfo() : RefundInfo|null`

##### Return values

RefundInfo|null

#### getTransactionCurrency()

InvoiceData.php : 119

Gets Cryptocurrency selected by the consumer when paying the invoice.

`public getTransactionCurrency() : string|null`

##### Return values

string|null —

the transaction currency

#### setCurrency()

InvoiceData.php : 109

Sets Invoice currency

`public setCurrency(string $currency) : void`

##### Parameters

$currency : string

  the Invoice currency

#### setDate()

InvoiceData.php : 69

Sets Date at which the invoice was created (UTC). ISO-8601 format yyyy-mm-ddThh:mm:ssZ

`public setDate(string $date) : void`

##### Parameters

$date : string

  the date

#### setOrderId()

InvoiceData.php : 49

Sets Invoice orderId provided during invoice creation.

`public setOrderId(string $orderId) : void`

##### Parameters

$orderId : string

  the order id

#### setOverPaidAmount()

InvoiceData.php : 149

Sets over paid amount

`public setOverPaidAmount(float $overPaidAmount) : void`

##### Parameters

$overPaidAmount : float

  the over paid amount

#### setPayoutPercentage()

InvoiceData.php : 169

Sets The payout percentage defined by the merchant on his BitPay account settings

`public setPayoutPercentage(float $payoutPercentage) : void`

##### Parameters

$payoutPercentage : float

  the payout percentage

#### setPrice()

InvoiceData.php : 89

Sets Invoice price in the invoice original currency

`public setPrice(float $price) : void`

##### Parameters

$price : float

  the price

#### setRefundInfo()

InvoiceData.php : 189

Sets Object containing information about the refund executed for the invoice

`public setRefundInfo(RefundInfo $refundInfo) : void`

##### Parameters

$refundInfo : RefundInfo

#### setTransactionCurrency()

InvoiceData.php : 129

Sets Cryptocurrency selected by the consumer when paying the invoice.

`public setTransactionCurrency(string $transactionCurrency) : void`

##### Parameters

$transactionCurrency : string

  the transaction currency

#### toArray()

InvoiceData.php : 199

Gets InvoiceData as array

`public toArray() : array<string|int, mixed>`

##### Return values

array<string|int, mixed> —

InvoiceData as array

## Search results