API Documentation
Back to top  

InvoiceListItem

Class InvoiceListItem

category

System
package

Invoice

Methods

Currency Getter

getCurrency() : \CurrencyCode

Response

\CurrencyCode

Customer ID Getter

getCustomerId() : integer

Response

integer

Customer Memos Getter

getCustomerMemos() : \CustomerMemoCollection

Response

\CustomerMemoCollection

Customer Name Getter

getCustomerName() : string

Response

string

Customer Status ID Getter

getCustomerStatusId() : integer

Response

integer

Customer Status Name Getter

getCustomerStatusName() : string

Response

string

Invoice Date Getter

getInvoiceDate() : \DateTime

Response

\DateTime

Invoice Filename Getter

getInvoiceFilename() : string

Response

string

Invoice ID Getter

getInvoiceId() : integer

Response

integer

Invoice Number Getter

getInvoiceNumber() : string

Response

string

Order Date Purchased Getter

getOrderDatePurchased() : \DateTime

Response

\DateTime

Order ID Getter

getOrderId() : integer

Response

integer

Order Status ID Getter

getOrderStatusId() : integer

Response

integer

Order Status Name Setter

getOrderStatusName() : string

Response

string

Payment Address Getter

getPaymentAddress() : \OrderAddressBlock

Response

\OrderAddressBlock

Payment Type Getter

getPaymentType() : \OrderPaymentType

Response

\OrderPaymentType

Shipping Address Getter

getShippingAddress() : \OrderAddressBlock

Response

\OrderAddressBlock

Total Sum Getter

getTotalSum() : float

Response

float

Check if invoice is a cancellation invoice.

isCancellationInvoice() : boolean

Response

boolean

Currency Setter

setCurrency(\CurrencyCode $currency) : \InvoiceListItem

Arguments

$currency

\CurrencyCode

Response

\InvoiceListItem

Returns same instance for chained method calls.

Customer ID Setter

setCustomerId(\IdType $customerId) : \InvoiceListItem

Arguments

$customerId

\IdType

Response

\InvoiceListItem

Returns same instance for chained method calls.

Customer Memos Setter

setCustomerMemos(\CustomerMemoCollection $customerMemos) : \InvoiceListItem

Arguments

$customerMemos

\CustomerMemoCollection

Response

\InvoiceListItem

Returns same instance for chained method calls.

Customer Name Setter

setCustomerName(\StringType $customerName) : \InvoiceListItem

Arguments

$customerName

\StringType

Response

\InvoiceListItem

Returns same instance for chained method calls.

Customer Status ID Setter

setCustomerStatusId(\IdType $customerStatusId) : \InvoiceListItem

Arguments

$customerStatusId

\IdType

Response

\InvoiceListItem

Returns same instance for chained method calls.

Customer Status Name Setter

setCustomerStatusName(\StringType $customerStatusName) : \InvoiceListItem

Arguments

$customerStatusName

\StringType

Response

\InvoiceListItem

Returns same instance for chained method calls.

Invoice Date Setter

setInvoiceDate(\DateTime $invoiceDate) : \InvoiceListItem

Arguments

$invoiceDate

\DateTime

Response

\InvoiceListItem

Returns same instance for chained method calls.

Invoice Filename Setter

setInvoiceFilename(\FilenameStringType $invoiceFilename) : \InvoiceListItem

Arguments

$invoiceFilename

\FilenameStringType

Response

\InvoiceListItem

Returns same instance for chained method calls.

Invoice ID Setter

setInvoiceId(\IdType $invoiceId) : \InvoiceListItem

Arguments

$invoiceId

\IdType

Response

\InvoiceListItem

Returns same instance for chained method calls.

Invoice Number Setter

setInvoiceNumber(\StringType $invoiceNumber) : \InvoiceListItem

Arguments

$invoiceNumber

\StringType

Response

\InvoiceListItem

Returns same instance for chained method calls.

Order Date Purchased Setter

setOrderDatePurchased(\DateTime $orderDatePurchased) : \InvoiceListItem

Arguments

$orderDatePurchased

\DateTime

Response

\InvoiceListItem

Returns same instance for chained method calls.

Order ID Setter

setOrderId(\IdType $orderId) : \InvoiceListItem

Arguments

$orderId

\IdType

Response

\InvoiceListItem

Returns same instance for chained method calls.

Order Status ID Setter

setOrderStatusId(\IdType $orderStatusId) : \InvoiceListItem

Arguments

$orderStatusId

\IdType

Response

\InvoiceListItem

Returns same instance for chained method calls.

Order Status Name Setter

setOrderStatusName(\StringType $orderStatusName) : \InvoiceListItem

Arguments

$orderStatusName

\StringType

Response

\InvoiceListItem

Returns same instance for chained method calls.

Payment Address Setter

setPaymentAddress(\OrderAddressBlock $paymentAddress) : \InvoiceListItem

Arguments

$paymentAddress

\OrderAddressBlock

Response

\InvoiceListItem

Returns same instance for chained method calls.

Payment Type Setter

setPaymentType(\OrderPaymentType $paymentType) : \InvoiceListItem

Arguments

$paymentType

\OrderPaymentType

Response

\InvoiceListItem

Returns same instance for chained method calls.

Shipping Address Setter

setShippingAddress(\OrderAddressBlock $shippingAddress) : \InvoiceListItem

Arguments

$shippingAddress

\OrderAddressBlock

Response

\InvoiceListItem

Returns same instance for chained method calls.

Total Sum Setter

setTotalSum(\DecimalType $totalSum) : \InvoiceListItem

Arguments

$totalSum

\DecimalType

Response

\InvoiceListItem

Returns same instance for chained method calls.

Properties

invoiceId

invoiceId : integer
var

Type(s)

integer

invoiceNumber

invoiceNumber : string
var

Type(s)

string

Filename of the invoice

invoiceFilename : string
var

Type(s)

string

invoiceDate

invoiceDate : \DateTime
var

Type(s)

\DateTime

totalSum

totalSum : float
var

Type(s)

float

currency

currency : \CurrencyCode
var

Type(s)

\CurrencyCode

customerId

customerId : integer
var

Type(s)

integer

customerName

customerName : string
var

Type(s)

string

customerStatusId

customerStatusId : integer
var

Type(s)

integer

customerStatusName

customerStatusName : string
var

Type(s)

string

customerMemos

customerMemos : \CustomerMemoCollection
var

Type(s)

\CustomerMemoCollection

paymentAddress

paymentAddress : \OrderAddressBlock
var

Type(s)

\OrderAddressBlock

shippingAddress

shippingAddress : \OrderAddressBlock
var

Type(s)

\OrderAddressBlock

orderId

orderId : integer
var

Type(s)

integer

orderDatePurchased

orderDatePurchased : \DateTime
var

Type(s)

\DateTime

paymentType

paymentType : \OrderPaymentType
var

Type(s)

\OrderPaymentType

orderStatusId

orderStatusId : integer
var

Type(s)

integer

orderStatusName

orderStatusName : string
var

Type(s)

string