BillingInvoice
in package
implements
ModelInterface, ArrayAccess
BillingInvoice Class Doc Comment
Tags
Interfaces, Classes, Traits and Enums
- ModelInterface
- Interface abstracting model access.
- ArrayAccess
Table of Contents
- DISCRIMINATOR = null
- $attributeMap : array<string|int, string>
- Array of attributes where the key is the local name, and the value is the original name
- $container : array<string|int, mixed>
- Associative array for storing property values
- $getters : array<string|int, string>
- Array of attributes to getter functions (for serialization of requests)
- $setters : array<string|int, string>
- Array of attributes to setter functions (for deserialization of responses)
- $swaggerFormats : array<string|int, string>
- Array of property to format mappings. Used for (de)serialization
- $swaggerModelName : string
- The original name of the model.
- $swaggerTypes : array<string|int, string>
- Array of property to type mappings. Used for (de)serialization
- __construct() : mixed
- Constructor
- __toString() : string
- Gets the string presentation of the object
- attributeMap() : array<string|int, mixed>
- Array of attributes where the key is the local name, and the value is the original name
- getAmount() : string|null
- Gets amount
- getBalance() : string|null
- Gets balance
- getDueDate() : string|null
- Gets due_date
- getInvoiceId() : string|null
- Gets invoice_id
- getInvoiceItems() : array<string|int, BillingInvoiceItem>
- Gets invoice_items
- getInvoiceNumber() : string|null
- Gets invoice_number
- getInvoiceUri() : string|null
- Gets invoice_uri
- getModelName() : string
- The original name of the model.
- getNonTaxableAmount() : string|null
- Gets non_taxable_amount
- getPdfAvailable() : string|null
- Gets pdf_available
- getTaxableAmount() : string|null
- Gets taxable_amount
- getters() : array<string|int, mixed>
- Array of attributes to getter functions (for serialization of requests)
- listInvalidProperties() : array<string|int, mixed>
- Show all the invalid properties with reasons.
- offsetExists() : bool
- Returns true if offset exists. False otherwise.
- offsetGet() : mixed
- Gets offset.
- offsetSet() : void
- Sets value based on offset.
- offsetUnset() : void
- Unsets offset.
- setAmount() : $this
- Sets amount
- setBalance() : $this
- Sets balance
- setDueDate() : $this
- Sets due_date
- setInvoiceId() : $this
- Sets invoice_id
- setInvoiceItems() : $this
- Sets invoice_items
- setInvoiceNumber() : $this
- Sets invoice_number
- setInvoiceUri() : $this
- Sets invoice_uri
- setNonTaxableAmount() : $this
- Sets non_taxable_amount
- setPdfAvailable() : $this
- Sets pdf_available
- setTaxableAmount() : $this
- Sets taxable_amount
- setters() : array<string|int, mixed>
- Array of attributes to setter functions (for deserialization of responses)
- swaggerFormats() : array<string|int, mixed>
- Array of property to format mappings. Used for (de)serialization
- swaggerTypes() : array<string|int, mixed>
- Array of property to type mappings. Used for (de)serialization
- valid() : bool
- Validate all the properties in the model return true if all passed
Constants
DISCRIMINATOR
public
mixed
DISCRIMINATOR
= null
Properties
$attributeMap
Array of attributes where the key is the local name, and the value is the original name
protected
static array<string|int, string>
$attributeMap
= ['amount' => 'amount', 'balance' => 'balance', 'due_date' => 'dueDate', 'invoice_id' => 'invoiceId', 'invoice_items' => 'invoiceItems', 'invoice_number' => 'invoiceNumber', 'invoice_uri' => 'invoiceUri', 'non_taxable_amount' => 'nonTaxableAmount', 'pdf_available' => 'pdfAvailable', 'taxable_amount' => 'taxableAmount']
$container
Associative array for storing property values
protected
array<string|int, mixed>
$container
= []
$getters
Array of attributes to getter functions (for serialization of requests)
protected
static array<string|int, string>
$getters
= ['amount' => 'getAmount', 'balance' => 'getBalance', 'due_date' => 'getDueDate', 'invoice_id' => 'getInvoiceId', 'invoice_items' => 'getInvoiceItems', 'invoice_number' => 'getInvoiceNumber', 'invoice_uri' => 'getInvoiceUri', 'non_taxable_amount' => 'getNonTaxableAmount', 'pdf_available' => 'getPdfAvailable', 'taxable_amount' => 'getTaxableAmount']
$setters
Array of attributes to setter functions (for deserialization of responses)
protected
static array<string|int, string>
$setters
= ['amount' => 'setAmount', 'balance' => 'setBalance', 'due_date' => 'setDueDate', 'invoice_id' => 'setInvoiceId', 'invoice_items' => 'setInvoiceItems', 'invoice_number' => 'setInvoiceNumber', 'invoice_uri' => 'setInvoiceUri', 'non_taxable_amount' => 'setNonTaxableAmount', 'pdf_available' => 'setPdfAvailable', 'taxable_amount' => 'setTaxableAmount']
$swaggerFormats
Array of property to format mappings. Used for (de)serialization
protected
static array<string|int, string>
$swaggerFormats
= ['amount' => null, 'balance' => null, 'due_date' => null, 'invoice_id' => null, 'invoice_items' => null, 'invoice_number' => null, 'invoice_uri' => null, 'non_taxable_amount' => null, 'pdf_available' => null, 'taxable_amount' => null]
$swaggerModelName
The original name of the model.
protected
static string
$swaggerModelName
= 'billingInvoice'
$swaggerTypes
Array of property to type mappings. Used for (de)serialization
protected
static array<string|int, string>
$swaggerTypes
= ['amount' => '?string', 'balance' => '?string', 'due_date' => '?string', 'invoice_id' => '?string', 'invoice_items' => '\\DocuSign\\eSign\\Model\\BillingInvoiceItem[]', 'invoice_number' => '?string', 'invoice_uri' => '?string', 'non_taxable_amount' => '?string', 'pdf_available' => '?string', 'taxable_amount' => '?string']
Methods
__construct()
Constructor
public
__construct([array<string|int, mixed> $data = null ]) : mixed
Parameters
- $data : array<string|int, mixed> = null
-
Associated array of property values initializing the model
Return values
mixed —__toString()
Gets the string presentation of the object
public
__toString() : string
Return values
string —attributeMap()
Array of attributes where the key is the local name, and the value is the original name
public
static attributeMap() : array<string|int, mixed>
Return values
array<string|int, mixed> —getAmount()
Gets amount
public
getAmount() : string|null
Return values
string|null —getBalance()
Gets balance
public
getBalance() : string|null
Return values
string|null —getDueDate()
Gets due_date
public
getDueDate() : string|null
Return values
string|null —getInvoiceId()
Gets invoice_id
public
getInvoiceId() : string|null
Return values
string|null —getInvoiceItems()
Gets invoice_items
public
getInvoiceItems() : array<string|int, BillingInvoiceItem>
Return values
array<string|int, BillingInvoiceItem> —getInvoiceNumber()
Gets invoice_number
public
getInvoiceNumber() : string|null
Return values
string|null —getInvoiceUri()
Gets invoice_uri
public
getInvoiceUri() : string|null
Return values
string|null —getModelName()
The original name of the model.
public
getModelName() : string
Return values
string —getNonTaxableAmount()
Gets non_taxable_amount
public
getNonTaxableAmount() : string|null
Return values
string|null —getPdfAvailable()
Gets pdf_available
public
getPdfAvailable() : string|null
Return values
string|null —getTaxableAmount()
Gets taxable_amount
public
getTaxableAmount() : string|null
Return values
string|null —getters()
Array of attributes to getter functions (for serialization of requests)
public
static getters() : array<string|int, mixed>
Return values
array<string|int, mixed> —listInvalidProperties()
Show all the invalid properties with reasons.
public
listInvalidProperties() : array<string|int, mixed>
Return values
array<string|int, mixed> —invalid properties with reasons
offsetExists()
Returns true if offset exists. False otherwise.
public
offsetExists(int $offset) : bool
Parameters
- $offset : int
-
Offset
Return values
bool —offsetGet()
Gets offset.
public
offsetGet(int $offset) : mixed
Parameters
- $offset : int
-
Offset
Return values
mixed —offsetSet()
Sets value based on offset.
public
offsetSet(int $offset, mixed $value) : void
Parameters
- $offset : int
-
Offset
- $value : mixed
-
Value to be set
Return values
void —offsetUnset()
Unsets offset.
public
offsetUnset(int $offset) : void
Parameters
- $offset : int
-
Offset
Return values
void —setAmount()
Sets amount
public
setAmount(string|null $amount) : $this
Parameters
- $amount : string|null
-
Reserved: TBD
Return values
$this —setBalance()
Sets balance
public
setBalance(string|null $balance) : $this
Parameters
- $balance : string|null
-
Reserved: TBD
Return values
$this —setDueDate()
Sets due_date
public
setDueDate(string|null $due_date) : $this
Parameters
- $due_date : string|null
-
Reserved: TBD
Return values
$this —setInvoiceId()
Sets invoice_id
public
setInvoiceId(string|null $invoice_id) : $this
Parameters
- $invoice_id : string|null
-
Reserved: TBD
Return values
$this —setInvoiceItems()
Sets invoice_items
public
setInvoiceItems(array<string|int, BillingInvoiceItem> $invoice_items) : $this
Parameters
- $invoice_items : array<string|int, BillingInvoiceItem>
-
Reserved: TBD
Return values
$this —setInvoiceNumber()
Sets invoice_number
public
setInvoiceNumber(string|null $invoice_number) : $this
Parameters
- $invoice_number : string|null
-
Reserved: TBD
Return values
$this —setInvoiceUri()
Sets invoice_uri
public
setInvoiceUri(string|null $invoice_uri) : $this
Parameters
- $invoice_uri : string|null
-
Contains a URI for an endpoint that you can use to retrieve invoice information.
Return values
$this —setNonTaxableAmount()
Sets non_taxable_amount
public
setNonTaxableAmount(string|null $non_taxable_amount) : $this
Parameters
- $non_taxable_amount : string|null
Return values
$this —setPdfAvailable()
Sets pdf_available
public
setPdfAvailable(string|null $pdf_available) : $this
Parameters
- $pdf_available : string|null
Return values
$this —setTaxableAmount()
Sets taxable_amount
public
setTaxableAmount(string|null $taxable_amount) : $this
Parameters
- $taxable_amount : string|null
Return values
$this —setters()
Array of attributes to setter functions (for deserialization of responses)
public
static setters() : array<string|int, mixed>
Return values
array<string|int, mixed> —swaggerFormats()
Array of property to format mappings. Used for (de)serialization
public
static swaggerFormats() : array<string|int, mixed>
Return values
array<string|int, mixed> —swaggerTypes()
Array of property to type mappings. Used for (de)serialization
public
static swaggerTypes() : array<string|int, mixed>
Return values
array<string|int, mixed> —valid()
Validate all the properties in the model return true if all passed
public
valid() : bool
Return values
bool —True if all properties are valid