Documentation

BillingPaymentItem
in package
implements ModelInterface, ArrayAccess

BillingPaymentItem Class Doc Comment

Tags
category

Class

description

Defines a billing payment request object.

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
getAmount()  : string|null
Gets amount
getDescription()  : string|null
Gets description
getModelName()  : string
The original name of the model.
getPaymentDate()  : string|null
Gets payment_date
getPaymentId()  : string|null
Gets payment_id
getPaymentNumber()  : string|null
Gets payment_number
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
setDescription()  : $this
Sets description
setPaymentDate()  : $this
Sets payment_date
setPaymentId()  : $this
Sets payment_id
setPaymentNumber()  : $this
Sets payment_number
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

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', 'description' => 'description', 'payment_date' => 'paymentDate', 'payment_id' => 'paymentId', 'payment_number' => 'paymentNumber']

$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', 'description' => 'getDescription', 'payment_date' => 'getPaymentDate', 'payment_id' => 'getPaymentId', 'payment_number' => 'getPaymentNumber']

$setters

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

protected static array<string|int, string> $setters = ['amount' => 'setAmount', 'description' => 'setDescription', 'payment_date' => 'setPaymentDate', 'payment_id' => 'setPaymentId', 'payment_number' => 'setPaymentNumber']

$swaggerFormats

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

protected static array<string|int, string> $swaggerFormats = ['amount' => null, 'description' => null, 'payment_date' => null, 'payment_id' => null, 'payment_number' => null]

$swaggerModelName

The original name of the model.

protected static string $swaggerModelName = 'billingPaymentItem'

$swaggerTypes

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

protected static array<string|int, string> $swaggerTypes = ['amount' => '?string', 'description' => '?string', 'payment_date' => '?string', 'payment_id' => '?string', 'payment_number' => '?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

getDescription()

Gets description

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

getModelName()

The original name of the model.

public getModelName() : string
Return values
string

getPaymentDate()

Gets payment_date

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

getPaymentId()

Gets payment_id

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

getPaymentNumber()

Gets payment_number

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

setDescription()

Sets description

public setDescription(string|null $description) : $this
Parameters
$description : string|null
Return values
$this

setPaymentDate()

Sets payment_date

public setPaymentDate(string|null $payment_date) : $this
Parameters
$payment_date : string|null
Return values
$this

setPaymentId()

Sets payment_id

public setPaymentId(string|null $payment_id) : $this
Parameters
$payment_id : string|null
Return values
$this

setPaymentNumber()

Sets payment_number

public setPaymentNumber(string|null $payment_number) : $this
Parameters
$payment_number : string|null

When set to true, a PDF version of the invoice is available. To get the PDF, make the call again and change "Accept:" in the header to "Accept: application/pdf".

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

Search results