Bill
in package
Tags
Table of Contents
Properties
- $address1 : string|null
- $address2 : string|null
- $cc : array<string|int, mixed>|null
- $city : string|null
- $country : string|null
- $createDate : string|null
- $currency : string|null
- $dueDate : string|null
- $email : string|null
- $id : string|null
- $items : array<string|int, mixed>
- $merchant : string|null
- $name : string|null
- $number : string|null
- $passProcessingFee : bool|null
- $phone : string|null
- $state : string|null
- $status : string|null
- $token : string|null
- $url : string|null
- $zip : string|null
Methods
- __construct() : mixed
- Constructor, create a minimal request Bill object.
- getAddress1() : string|null
- Gets Bill recipient's address
- getAddress2() : string|null
- Gets Bill recipient's address
- getCc() : array<string|int, mixed>|null
- Gets Bill cc
- getCity() : string|null
- Gets Bill recipient's city
- getCountry() : string|null
- Gets Bill recipient's country
- getCreateDate() : string|null
- Gets bill create date
- getCurrency() : string|null
- Gets bill currency
- getDueDate() : string|null
- Gets Bill due date
- getEmail() : string|null
- Gets bill email
- getId() : string|null
- Gets bill id
- getItems() : array<string|int, mixed>
- Gets items from bill
- getItemsAsArray() : array<string|int, mixed>|null
- Gets items as array from bill
- getMerchant() : string|null
- Gets bill merchant
- getName() : string|null
- Gets Bill recipient's name
- getNumber() : string|null
- Gets bill number
- getPassProcessingFee() : bool|null
- Gets bill pass processing fee
- getPhone() : string|null
- Gets Bill recipient's phone number
- getState() : string|null
- Gets Bill recipient's state or province
- getStatus() : string|null
- Gets bill status
- getToken() : string|null
- Gets token
- getUrl() : string|null
- Gets bill url
- getZip() : string|null
- Gets Bill recipient's ZIP code
- setAddress1() : void
- Sets Bill recipient's address
- setAddress2() : void
- Sets Bill recipient's address
- setCc() : void
- Sets Bill's cc
- setCity() : void
- Sets Bill recipient's city
- setCountry() : void
- Sets Bill recipient's country
- setCreateDate() : void
- Sets Bill's create date
- setCurrency() : void
- Sets Bill's currency
- setDueDate() : void
- Sets Bill's due date
- setEmail() : void
- Sets Bill's email
- setId() : void
- Sets Bill's id
- setItems() : void
- Sets Bill's items
- setMerchant() : void
- Sets Bill's merchant
- setName() : void
- Sets Bill recipient's name
- setNumber() : void
- Sets Bill's number
- setPassProcessingFee() : void
- Sets Bill's pass processing fee
- setPhone() : void
- Sets Bill recipient's phone number
- setState() : void
- Sets Bill recipient's state or province
- setStatus() : void
- Sets Bill's status
- setToken() : void
- Sets Bill's token
- setUrl() : void
- Sets Bill's url
- setZip() : void
- Sets Bill recipient's ZIP code
- toArray() : array<string|int, mixed>
- Get bill data as array
Properties
$address1
protected
string|null
$address1
= null
$address2
protected
string|null
$address2
= null
$cc
protected
array<string|int, mixed>|null
$cc
= null
$city
protected
string|null
$city
= null
$country
protected
string|null
$country
= null
$createDate
protected
string|null
$createDate
= null
$currency
protected
string|null
$currency
= null
$dueDate
protected
string|null
$dueDate
= null
protected
string|null
$email
= null
$id
protected
string|null
$id
= null
$items
protected
array<string|int, mixed>
$items
= []
$merchant
protected
string|null
$merchant
= null
$name
protected
string|null
$name
= null
$number
protected
string|null
$number
= null
$passProcessingFee
protected
bool|null
$passProcessingFee
= null
$phone
protected
string|null
$phone
= null
$state
protected
string|null
$state
= null
$status
protected
string|null
$status
= null
$token
protected
string|null
$token
= null
$url
protected
string|null
$url
= null
$zip
protected
string|null
$zip
= null
Methods
__construct()
Constructor, create a minimal request Bill object.
public
__construct([string|null $number = null ][, string|null $currency = null ][, string|null $email = null ][, array<string|int, mixed>|null $items = null ]) : mixed
Parameters
- $number : string|null = null
-
string A string for tracking purposes.
- $currency : string|null = null
-
string The three digit currency type used to compute the bill's amount.
- $email : string|null = null
-
string The email address of the receiver for this bill.
- $items : array<string|int, mixed>|null = null
-
array The list of items to add to this bill.
getAddress1()
Gets Bill recipient's address
public
getAddress1() : string|null
Return values
string|null —the address1
getAddress2()
Gets Bill recipient's address
public
getAddress2() : string|null
Return values
string|null —the address2
getCc()
Gets Bill cc
public
getCc() : array<string|int, mixed>|null
Email addresses to which a copy of the bill must be sent
Return values
array<string|int, mixed>|null —the cc
getCity()
Gets Bill recipient's city
public
getCity() : string|null
Return values
string|null —the city
getCountry()
Gets Bill recipient's country
public
getCountry() : string|null
Return values
string|null —the country
getCreateDate()
Gets bill create date
public
getCreateDate() : string|null
Date and time of Bill creation, ISO-8601 format yyyy-mm-ddThh:mm:ssZ. (UTC)
Return values
string|null —the creation date
getCurrency()
Gets bill currency
public
getCurrency() : string|null
ISO 4217 3-character currency code. This is the currency associated with the price field
Return values
string|null —the bill currency
getDueDate()
Gets Bill due date
public
getDueDate() : string|null
Date and time at which a bill is due, ISO-8601 format yyyy-mm-ddThh:mm:ssZ. (UTC)
Return values
string|null —the number
getEmail()
Gets bill email
public
getEmail() : string|null
Return values
string|null —the email
getId()
Gets bill id
public
getId() : string|null
Bill resource id
Return values
string|null —the id
getItems()
Gets items from bill
public
getItems() : array<string|int, mixed>
Return values
array<string|int, mixed> —Item[]
getItemsAsArray()
Gets items as array from bill
public
getItemsAsArray() : array<string|int, mixed>|null
Return values
array<string|int, mixed>|null —items as array from bill
getMerchant()
Gets bill merchant
public
getMerchant() : string|null
Internal identifier for BitPay, this field can be ignored by the merchants.
Return values
string|null —the merchant
getName()
Gets Bill recipient's name
public
getName() : string|null
Return values
string|null —the name
getNumber()
Gets bill number
public
getNumber() : string|null
Bill identifier, specified by merchant
Return values
string|null —the number
getPassProcessingFee()
Gets bill pass processing fee
public
getPassProcessingFee() : bool|null
Return values
bool|null —the pass processing fee
getPhone()
Gets Bill recipient's phone number
public
getPhone() : string|null
Return values
string|null —the phone
getState()
Gets Bill recipient's state or province
public
getState() : string|null
Return values
string|null —the state
getStatus()
Gets bill status
public
getStatus() : string|null
Can "draft", "sent", "new", "paid", or "complete"
Return values
string|null —the status
getToken()
Gets token
public
getToken() : string|null
API token for bill resource. This token is actually derived from the API token used to create the bill and is tied to the specific resource id created.
Return values
string|null —the token
getUrl()
Gets bill url
public
getUrl() : string|null
Web address of bill
Return values
string|null —the url
getZip()
Gets Bill recipient's ZIP code
public
getZip() : string|null
Return values
string|null —the zip
setAddress1()
Sets Bill recipient's address
public
setAddress1(string $address1) : void
Parameters
- $address1 : string
-
Bill recipient's address
setAddress2()
Sets Bill recipient's address
public
setAddress2(string $address2) : void
Parameters
- $address2 : string
-
Bill recipient's address
setCc()
Sets Bill's cc
public
setCc(array<string|int, mixed> $cc) : void
Email addresses to which a copy of the bill must be sent
Parameters
- $cc : array<string|int, mixed>
-
Email addresses to which a copy of the bill must be sent
setCity()
Sets Bill recipient's city
public
setCity(string $city) : void
Parameters
- $city : string
-
Bill recipient's city
setCountry()
Sets Bill recipient's country
public
setCountry(string $country) : void
Parameters
- $country : string
-
Bill recipient's country
setCreateDate()
Sets Bill's create date
public
setCreateDate(string $createDate) : void
Date and time of Bill creation, ISO-8601 format yyyy-mm-ddThh:mm:ssZ. (UTC)
Parameters
- $createDate : string
-
Bill's create date
setCurrency()
Sets Bill's currency
public
setCurrency(string $currency) : void
ISO 4217 3-character currency code. This is the currency associated with the price field
Parameters
- $currency : string
-
3-character currency code
Tags
setDueDate()
Sets Bill's due date
public
setDueDate(string $dueDate) : void
Date and time at which a bill is due, ISO-8601 format yyyy-mm-ddThh:mm:ssZ. (UTC)
Parameters
- $dueDate : string
-
Date and time at which a bill is due
setEmail()
Sets Bill's email
public
setEmail(string $email) : void
Parameters
- $email : string
-
Bill's email
setId()
Sets Bill's id
public
setId(string $id) : void
Bill resource id
Parameters
- $id : string
-
Bill resource id
setItems()
Sets Bill's items
public
setItems(array<string|int, mixed> $items) : void
Parameters
- $items : array<string|int, mixed>
-
Item[]
setMerchant()
Sets Bill's merchant
public
setMerchant(string $merchant) : void
Internal identifier for BitPay, this field can be ignored by the merchants.
Parameters
- $merchant : string
-
Internal identifier for BitPay
setName()
Sets Bill recipient's name
public
setName(string $name) : void
Parameters
- $name : string
-
Bill recipient's name
setNumber()
Sets Bill's number
public
setNumber(string $number) : void
Bill identifier, specified by merchant
Parameters
- $number : string
-
Bill identifier, specified by merchant
setPassProcessingFee()
Sets Bill's pass processing fee
public
setPassProcessingFee(bool $passProcessingFee) : void
If set to true, BitPay's processing fee will be included in the amount charged on the invoice
Parameters
- $passProcessingFee : bool
-
Bill's pass processing fee
setPhone()
Sets Bill recipient's phone number
public
setPhone(string $phone) : void
Parameters
- $phone : string
-
Bill recipient's phone number
setState()
Sets Bill recipient's state or province
public
setState(string $state) : void
Parameters
- $state : string
-
Bill recipient's state or province
setStatus()
Sets Bill's status
public
setStatus(string $status) : void
Can "draft", "sent", "new", "paid", or "complete"
Parameters
- $status : string
-
Bill's status
setToken()
Sets Bill's token
public
setToken(string $token) : void
API token for bill resource. This token is actually derived from the API token used to create the bill and is tied to the specific resource id created.
Parameters
- $token : string
-
API token for bill resource
setUrl()
Sets Bill's url
public
setUrl(string $url) : void
Web address of bill
Parameters
- $url : string
-
Web address of bill
setZip()
Sets Bill recipient's ZIP code
public
setZip(string $zip) : void
Parameters
- $zip : string
-
Bill recipient's ZIP code
toArray()
Get bill data as array
public
toArray() : array<string|int, mixed>
Return values
array<string|int, mixed> —bill data as array