Overview
  • Package
  • Class
  • Tree
  • Todo

Packages

  • AddonValue
    • Interfaces
  • AdminHttpViewControllers
  • ApiV2Controllers
  • Authentication
    • Collections
    • Entities
    • Factories
    • Interfaces
    • Strategies
  • Category
    • Collections
    • Entities
    • Factories
    • Interfaces
    • Providers
    • Repositories
    • Storages
  • Customer
    • Address
    • Country
    • CountryZone
    • Interfaces
    • Storages
    • Validation
    • ValueObjects
  • Email
    • Collections
    • Entities
    • Exceptions
    • Interfaces
    • Repository
    • ValueObjects
  • Extensions
    • Customers
    • Emails
    • Helpers
    • Invoices
    • Orders
    • Serializers
    • Templates
  • Http
    • Collections
    • Exceptions
    • Factories
    • Interfaces
    • ValueObjects
  • HttpViewControllers
  • InfoBox
    • Collections
    • Entities
    • Factories
    • Interfaces
    • Repositories
  • Invoice
    • Interfaces
    • ValueObjects
  • Loaders
    • CrossCuttingLoader
    • GXCoreLoader
    • Interfaces
  • Modules
    • Collections
    • Controllers
    • Interfaces
  • None
  • Order
    • Collections
    • Entities
    • Factories
    • Interfaces
    • Repositories
    • Storages
    • ValueObjects
  • Precheck
  • Product
    • Collections
    • Entities
    • Factories
    • Interfaces
    • Providers
    • Repositories
    • Storages
  • ProductModule
    • Collections
    • Deleter
    • Entities
    • Factories
    • Interface
    • Interfaces
    • Reader
    • Repositories
    • Writer
  • Shared
    • ClassFinder
    • Exceptions
    • FileSystem
    • Interfaces
    • Storage
    • Types
  • SharedShoppingCart
    • Interfaces
  • Slider
    • Collections
    • Entities
    • Factories
    • Interfaces
    • Repositories
    • Storages
  • Statistics
    • Interfaces
  • UserConfiguration
    • Interfaces
    • Repository

Classes

  • AbstractInvoiceServiceFactory
  • InvoiceArchiveReadService
  • InvoiceArchiveWriteService
  • InvoiceFileEntitler
  • InvoiceListGenerator
  • InvoiceListItem
  • InvoiceListItemCollection
  • InvoiceRepository
  • InvoiceServiceFactory

Class InvoiceListItem

Class InvoiceListItem

Package: Invoice
Category: System
Located at Services/Core/Invoice/InvoiceListItem.inc.php

Methods summary

public integer
# getInvoiceId( )

Invoice ID Getter

Invoice ID Getter

Returns

integer
public InvoiceListItem
# setInvoiceId( IdType $invoiceId )

Invoice ID Setter

Invoice ID Setter

Parameters

$invoiceId

Returns

InvoiceListItem
Returns same instance for chained method calls.
public string
# getInvoiceNumber( )

Invoice Number Getter

Invoice Number Getter

Returns

string
public InvoiceListItem
# setInvoiceNumber( StringType $invoiceNumber )

Invoice Number Setter

Invoice Number Setter

Parameters

$invoiceNumber

Returns

InvoiceListItem
Returns same instance for chained method calls.
public string
# getInvoiceFilename( )

Invoice Filename Getter

Invoice Filename Getter

Returns

string
public InvoiceListItem
# setInvoiceFilename( FilenameStringType $invoiceFilename )

Invoice Filename Setter

Invoice Filename Setter

Parameters

$invoiceFilename

Returns

InvoiceListItem
Returns same instance for chained method calls.
public DateTime
# getInvoiceDate( )

Invoice Date Getter

Invoice Date Getter

Returns

DateTime
public InvoiceListItem
# setInvoiceDate( DateTime $invoiceDate )

Invoice Date Setter

Invoice Date Setter

Parameters

$invoiceDate

Returns

InvoiceListItem
Returns same instance for chained method calls.
public float
# getTotalSum( )

Total Sum Getter

Total Sum Getter

Returns

float
public InvoiceListItem
# setTotalSum( DecimalType $totalSum )

Total Sum Setter

Total Sum Setter

Parameters

$totalSum

Returns

InvoiceListItem
Returns same instance for chained method calls.
public CurrencyCode
# getCurrency( )

Currency Getter

Currency Getter

Returns

CurrencyCode
public InvoiceListItem
# setCurrency( CurrencyCode $currency )

Currency Setter

Currency Setter

Parameters

$currency

Returns

InvoiceListItem
Returns same instance for chained method calls.
public integer
# getCustomerId( )

Customer ID Getter

Customer ID Getter

Returns

integer
public InvoiceListItem
# setCustomerId( IdType $customerId )

Customer ID Setter

Customer ID Setter

Parameters

$customerId

Returns

InvoiceListItem
Returns same instance for chained method calls.
public string
# getCustomerName( )

Customer Name Getter

Customer Name Getter

Returns

string
public InvoiceListItem
# setCustomerName( StringType $customerName )

Customer Name Setter

Customer Name Setter

Parameters

$customerName

Returns

InvoiceListItem
Returns same instance for chained method calls.
public integer
# getCustomerStatusId( )

Customer Status ID Getter

Customer Status ID Getter

Returns

integer
public InvoiceListItem
# setCustomerStatusId( IdType $customerStatusId )

Customer Status ID Setter

Customer Status ID Setter

Parameters

$customerStatusId

Returns

InvoiceListItem
Returns same instance for chained method calls.
public string
# getCustomerStatusName( )

Customer Status Name Getter

Customer Status Name Getter

Returns

string
public InvoiceListItem
# setCustomerStatusName( StringType $customerStatusName )

Customer Status Name Setter

Customer Status Name Setter

Parameters

$customerStatusName

Returns

InvoiceListItem
Returns same instance for chained method calls.
public CustomerMemoCollection
# getCustomerMemos( )

Customer Memos Getter

Customer Memos Getter

Returns

CustomerMemoCollection
public InvoiceListItem
# setCustomerMemos( CustomerMemoCollection $customerMemos )

Customer Memos Setter

Customer Memos Setter

Parameters

$customerMemos

Returns

InvoiceListItem
Returns same instance for chained method calls.
public OrderAddressBlock
# getPaymentAddress( )

Payment Address Getter

Payment Address Getter

Returns

OrderAddressBlock
public InvoiceListItem
# setPaymentAddress( OrderAddressBlock $paymentAddress )

Payment Address Setter

Payment Address Setter

Parameters

$paymentAddress

Returns

InvoiceListItem
Returns same instance for chained method calls.
public OrderAddressBlock
# getShippingAddress( )

Shipping Address Getter

Shipping Address Getter

Returns

OrderAddressBlock
public InvoiceListItem
# setShippingAddress( OrderAddressBlock $shippingAddress )

Shipping Address Setter

Shipping Address Setter

Parameters

$shippingAddress

Returns

InvoiceListItem
Returns same instance for chained method calls.
public integer
# getOrderId( )

Order ID Getter

Order ID Getter

Returns

integer
public InvoiceListItem
# setOrderId( IdType $orderId )

Order ID Setter

Order ID Setter

Parameters

$orderId

Returns

InvoiceListItem
Returns same instance for chained method calls.
public DateTime
# getOrderDatePurchased( )

Order Date Purchased Getter

Order Date Purchased Getter

Returns

DateTime
public InvoiceListItem
# setOrderDatePurchased( DateTime $orderDatePurchased )

Order Date Purchased Setter

Order Date Purchased Setter

Parameters

$orderDatePurchased

Returns

InvoiceListItem
Returns same instance for chained method calls.
public OrderPaymentType
# getPaymentType( )

Payment Type Getter

Payment Type Getter

Returns

OrderPaymentType
public InvoiceListItem
# setPaymentType( OrderPaymentType $paymentType )

Payment Type Setter

Payment Type Setter

Parameters

$paymentType

Returns

InvoiceListItem
Returns same instance for chained method calls.
public integer
# getOrderStatusId( )

Order Status ID Getter

Order Status ID Getter

Returns

integer
public InvoiceListItem
# setOrderStatusId( IdType $orderStatusId )

Order Status ID Setter

Order Status ID Setter

Parameters

$orderStatusId

Returns

InvoiceListItem
Returns same instance for chained method calls.
public string
# getOrderStatusName( )

Order Status Name Setter

Order Status Name Setter

Returns

string
public InvoiceListItem
# setOrderStatusName( StringType $orderStatusName )

Order Status Name Setter

Order Status Name Setter

Parameters

$orderStatusName

Returns

InvoiceListItem
Returns same instance for chained method calls.
public boolean
# isCancellationInvoice( )

Check if invoice is a cancellation invoice.

Check if invoice is a cancellation invoice.

Returns

boolean

Properties summary

protected integer $invoiceId
# 0
protected string $invoiceNumber
# ''
protected string $invoiceFilename

Filename of the invoice

Filename of the invoice

# ''
protected DateTime $invoiceDate
#
protected float $totalSum
# 0
protected CurrencyCode $currency
#
protected integer $customerId
# 0
protected string $customerName
# ''
protected integer $customerStatusId
# 0
protected string $customerStatusName
# ''
protected CustomerMemoCollection $customerMemos
#
protected OrderAddressBlock $paymentAddress
#
protected OrderAddressBlock $shippingAddress
#
protected integer $orderId
# 0
protected DateTime $orderDatePurchased
#
protected OrderPaymentType $paymentType
#
protected integer $orderStatusId
# 0
protected string $orderStatusName
# ''
API documentation generated by ApiGen