Documentation

BillingInvoiceItem
in package
implements ModelInterface, ArrayAccess

BillingInvoiceItem Class Doc Comment

Tags
category

Class

description

Contains information about an item on a billing invoice.

author

Swagger Codegen team apihelp@docusign.com

license

The Docusign PHP Client SDK is licensed under the MIT License.

link
https://github.com/swagger-api/swagger-codegen

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
getChargeAmount()  : string|null
Gets charge_amount
getChargeName()  : string|null
Gets charge_name
getInvoiceItemId()  : string|null
Gets invoice_item_id
getModelName()  : string
The original name of the model.
getQuantity()  : string|null
Gets quantity
getTaxAmount()  : string|null
Gets tax_amount
getTaxExemptAmount()  : string|null
Gets tax_exempt_amount
getters()  : array<string|int, mixed>
Array of attributes to getter functions (for serialization of requests)
getUnitPrice()  : string|null
Gets unit_price
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.
setChargeAmount()  : $this
Sets charge_amount
setChargeName()  : $this
Sets charge_name
setInvoiceItemId()  : $this
Sets invoice_item_id
setQuantity()  : $this
Sets quantity
setTaxAmount()  : $this
Sets tax_amount
setTaxExemptAmount()  : $this
Sets tax_exempt_amount
setters()  : array<string|int, mixed>
Array of attributes to setter functions (for deserialization of responses)
setUnitPrice()  : $this
Sets unit_price
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

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 = ['charge_amount' => 'chargeAmount', 'charge_name' => 'chargeName', 'invoice_item_id' => 'invoiceItemId', 'quantity' => 'quantity', 'tax_amount' => 'taxAmount', 'tax_exempt_amount' => 'taxExemptAmount', 'unit_price' => 'unitPrice']

$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 = ['charge_amount' => 'getChargeAmount', 'charge_name' => 'getChargeName', 'invoice_item_id' => 'getInvoiceItemId', 'quantity' => 'getQuantity', 'tax_amount' => 'getTaxAmount', 'tax_exempt_amount' => 'getTaxExemptAmount', 'unit_price' => 'getUnitPrice']

$setters

Array of attributes to setter functions (for deserialization of responses)

protected static array<string|int, string> $setters = ['charge_amount' => 'setChargeAmount', 'charge_name' => 'setChargeName', 'invoice_item_id' => 'setInvoiceItemId', 'quantity' => 'setQuantity', 'tax_amount' => 'setTaxAmount', 'tax_exempt_amount' => 'setTaxExemptAmount', 'unit_price' => 'setUnitPrice']

$swaggerFormats

Array of property to format mappings. Used for (de)serialization

protected static array<string|int, string> $swaggerFormats = ['charge_amount' => null, 'charge_name' => null, 'invoice_item_id' => null, 'quantity' => null, 'tax_amount' => null, 'tax_exempt_amount' => null, 'unit_price' => null]

$swaggerModelName

The original name of the model.

protected static string $swaggerModelName = 'billingInvoiceItem'

$swaggerTypes

Array of property to type mappings. Used for (de)serialization

protected static array<string|int, string> $swaggerTypes = ['charge_amount' => '?string', 'charge_name' => '?string', 'invoice_item_id' => '?string', 'quantity' => '?string', 'tax_amount' => '?string', 'tax_exempt_amount' => '?string', 'unit_price' => '?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>

getChargeAmount()

Gets charge_amount

public getChargeAmount() : string|null
Return values
string|null

getChargeName()

Gets charge_name

public getChargeName() : string|null
Return values
string|null

getInvoiceItemId()

Gets invoice_item_id

public getInvoiceItemId() : string|null
Return values
string|null

getModelName()

The original name of the model.

public getModelName() : string
Return values
string

getQuantity()

Gets quantity

public getQuantity() : string|null
Return values
string|null

getTaxAmount()

Gets tax_amount

public getTaxAmount() : string|null
Return values
string|null

getTaxExemptAmount()

Gets tax_exempt_amount

public getTaxExemptAmount() : 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>

getUnitPrice()

Gets unit_price

public getUnitPrice() : string|null
Return values
string|null

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

setChargeAmount()

Sets charge_amount

public setChargeAmount(string|null $charge_amount) : $this
Parameters
$charge_amount : string|null

Reserved: TBD

Return values
$this

setChargeName()

Sets charge_name

public setChargeName(string|null $charge_name) : $this
Parameters
$charge_name : string|null

Reserved: TBD

Return values
$this

setInvoiceItemId()

Sets invoice_item_id

public setInvoiceItemId(string|null $invoice_item_id) : $this
Parameters
$invoice_item_id : string|null

Reserved: TBD

Return values
$this

setQuantity()

Sets quantity

public setQuantity(string|null $quantity) : $this
Parameters
$quantity : string|null
Return values
$this

setTaxAmount()

Sets tax_amount

public setTaxAmount(string|null $tax_amount) : $this
Parameters
$tax_amount : string|null
Return values
$this

setTaxExemptAmount()

Sets tax_exempt_amount

public setTaxExemptAmount(string|null $tax_exempt_amount) : $this
Parameters
$tax_exempt_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>

setUnitPrice()

Sets unit_price

public setUnitPrice(string|null $unit_price) : $this
Parameters
$unit_price : string|null

Reserved: TBD

Return values
$this

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

Search results